• Preparing search index...
  • The search index is not available
@google/genai
  • @google/genai
  • gaos/funcs/interactions-cancel
  • interactionsCancel

Function interactionsCancel

  • interactionsCancel(
        client: GoogleGenAICore,
        id: string,
        api_version?: string,
        options?: Omit<RequestOptions, "extra_body">,
    ): APIPromise<
        Result<
            Interaction,
            | UnexpectedClientError
            | InvalidRequestError
            | RequestAbortedError
            | RequestTimeoutError
            | ConnectionError
            | GoogleGenAiError
            | CancelInteractionByIdServerError
            | CancelInteractionByIdClientError,
        >,
    >

    Canceling an interaction

    Parameters

    • client: GoogleGenAICore
    • id: string
    • Optionalapi_version: string
    • Optionaloptions: Omit<RequestOptions, "extra_body">

    Returns APIPromise<
        Result<
            Interaction,
            | UnexpectedClientError
            | InvalidRequestError
            | RequestAbortedError
            | RequestTimeoutError
            | ConnectionError
            | GoogleGenAiError
            | CancelInteractionByIdServerError
            | CancelInteractionByIdClientError,
        >,
    >

    Remarks

    Cancels an interaction by id. This only applies to background interactions that are still running.

    • Defined in src/gaos/funcs/interactions-cancel.ts:41

Settings

@google/genai
  • Loading...

Generated using TypeDoc