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

Function interactionsGet

  • interactionsGet(
        client: GoogleGenAICore,
        id: string,
        stream?: false,
        last_event_id?: string,
        include_input?: boolean,
        api_version?: string,
        options?: Omit<RequestOptions, "extra_body">,
    ): APIPromise<
        Result<
            GetInteractionByIdResponse,
            | UnexpectedClientError
            | InvalidRequestError
            | RequestAbortedError
            | RequestTimeoutError
            | ConnectionError
            | GoogleGenAiError
            | GetInteractionByIdServerError
            | GetInteractionByIdClientError,
        >,
    >

    Retrieving an interaction

    Parameters

    • client: GoogleGenAICore
    • id: string
    • Optionalstream: false
    • Optionallast_event_id: string
    • Optionalinclude_input: boolean
    • Optionalapi_version: string
    • Optionaloptions: Omit<RequestOptions, "extra_body">

    Returns APIPromise<
        Result<
            GetInteractionByIdResponse,
            | UnexpectedClientError
            | InvalidRequestError
            | RequestAbortedError
            | RequestTimeoutError
            | ConnectionError
            | GoogleGenAiError
            | GetInteractionByIdServerError
            | GetInteractionByIdClientError,
        >,
    >

    Remarks

    Retrieves the full details of a single interaction based on its Interaction.id.

    • Defined in src/gaos/funcs/interactions-get.ts:40
  • interactionsGet(
        client: GoogleGenAICore,
        id: string,
        stream?: true,
        last_event_id?: string,
        include_input?: boolean,
        api_version?: string,
        options?: Omit<RequestOptions, "extra_body">,
    ): APIPromise<
        Result<
            GetInteractionByIdResponse,
            | UnexpectedClientError
            | InvalidRequestError
            | RequestAbortedError
            | RequestTimeoutError
            | ConnectionError
            | GoogleGenAiError
            | GetInteractionByIdServerError
            | GetInteractionByIdClientError,
        >,
    >

    Retrieving an interaction

    Parameters

    • client: GoogleGenAICore
    • id: string
    • Optionalstream: true
    • Optionallast_event_id: string
    • Optionalinclude_input: boolean
    • Optionalapi_version: string
    • Optionaloptions: Omit<RequestOptions, "extra_body">

    Returns APIPromise<
        Result<
            GetInteractionByIdResponse,
            | UnexpectedClientError
            | InvalidRequestError
            | RequestAbortedError
            | RequestTimeoutError
            | ConnectionError
            | GoogleGenAiError
            | GetInteractionByIdServerError
            | GetInteractionByIdClientError,
        >,
    >

    Remarks

    Retrieves the full details of a single interaction based on its Interaction.id.

    • Defined in src/gaos/funcs/interactions-get.ts:61
  • interactionsGet(
        client: GoogleGenAICore,
        id: string,
        stream?: boolean,
        last_event_id?: string,
        include_input?: boolean,
        api_version?: string,
        options?: Omit<RequestOptions, "extra_body">,
    ): APIPromise<
        Result<
            GetInteractionByIdResponse,
            | UnexpectedClientError
            | InvalidRequestError
            | RequestAbortedError
            | RequestTimeoutError
            | ConnectionError
            | GoogleGenAiError
            | GetInteractionByIdServerError
            | GetInteractionByIdClientError,
        >,
    >

    Retrieving an interaction

    Parameters

    • client: GoogleGenAICore
    • id: string
    • Optionalstream: boolean
    • Optionallast_event_id: string
    • Optionalinclude_input: boolean
    • Optionalapi_version: string
    • Optionaloptions: Omit<RequestOptions, "extra_body">

    Returns APIPromise<
        Result<
            GetInteractionByIdResponse,
            | UnexpectedClientError
            | InvalidRequestError
            | RequestAbortedError
            | RequestTimeoutError
            | ConnectionError
            | GoogleGenAiError
            | GetInteractionByIdServerError
            | GetInteractionByIdClientError,
        >,
    >

    Remarks

    Retrieves the full details of a single interaction based on its Interaction.id.

    • Defined in src/gaos/funcs/interactions-get.ts:82

Settings

@google/genai
  • Loading...

Generated using TypeDoc