Type Alias Interaction

Interaction: {
    agent?: AgentOption;
    agent_config?:
        | AntigravityAgentConfig
        | CodeMenderAgentConfig
        | DeepResearchAgentConfig
        | DynamicAgentConfig;
    cached_content?: string;
    continuation_token?: string;
    created?: string;
    environment?: Environment
    | string;
    environment_id?: string;
    errors?: ErrorT[];
    generation_config?: GenerationConfig;
    id: string;
    input?: InteractionsInput;
    labels?: { [k: string]: string };
    model?: Model;
    output_audio?: AudioContent;
    output_image?: ImageContent;
    output_text?: string;
    output_video?: VideoContent;
    previous_interaction_id?: string;
    response_format?: ResponseFormat | ResponseFormat[];
    response_mime_type?: string;
    response_modalities?: ResponseModality[];
    safety_settings?: SafetySetting[];
    service_tier?: ServiceTier;
    status: InteractionStatus;
    steps?: Step[];
    system_instruction?: string;
    tools?: Tool[];
    updated?: string;
    usage?: Usage;
    webhook_config?: WebhookConfig;
}

The Interaction resource.

Type declaration

  • Optionalagent?: AgentOption

    The agent to interact with.

  • Optionalagent_config?:
        | AntigravityAgentConfig
        | CodeMenderAgentConfig
        | DeepResearchAgentConfig
        | DynamicAgentConfig

    Configuration parameters for the agent interaction.

  • Optionalcached_content?: string

    The name of the cached content used as context to serve the prediction. Note: only used in explicit caching, where users can have control over caching (e.g. what content to cache) and enjoy guaranteed cost savings. Format: cachedContents/{cachedContent}

    Deprecated

    field: This will be removed in a future release, please migrate away from it as soon as possible.

  • Optionalcontinuation_token?: string

    Opaque token to resume a long decode. Output: set when status is

    Remarks

    INCOMPLETE and decoding can be resumed. Input: pass the latest token back unchanged in CreateInteraction to continue decoding.

  • Optionalcreated?: string

    Required. Output only. The time at which the response was created in ISO 8601 format

    Remarks

    (YYYY-MM-DDThh:mm:ssZ).

  • Optionalenvironment?: Environment | string

    The environment configuration for the interaction. Can be an object

    Remarks

    specifying remote environment sources or a string referencing an existing environment ID.

  • Optionalenvironment_id?: string

    Output only. The environment ID for the interaction. Only populated if environment

    Remarks

    config is set in the request.

  • Optionalerrors?: ErrorT[]

    Output only. Diagnostic faults / platform errors recorded on the interaction.

  • Optionalgeneration_config?: GenerationConfig

    Configuration parameters for model interactions.

  • id: string

    Required. Output only. A unique identifier for the interaction completion.

  • Optionalinput?: InteractionsInput

    The input for the interaction.

  • Optionallabels?: { [k: string]: string }

    The labels with user-defined metadata for the request.

    Remarks

    Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.

  • Optionalmodel?: Model

    The model that will complete your prompt.\n\nSee models for additional details.

  • Optionaloutput_audio?: AudioContent

    An audio content block.

  • Optionaloutput_image?: ImageContent

    An image content block.

  • Optionaloutput_text?: string

    Concatenated text from the last model output in response to the current request.

    Remarks

    Note: this is added by the SDK.

  • Optionaloutput_video?: VideoContent

    A video content block.

  • Optionalprevious_interaction_id?: string

    The ID of the previous interaction, if any.

  • Optionalresponse_format?: ResponseFormat | ResponseFormat[]

    Enforces that the generated response is a JSON object that complies with

    Remarks

    the JSON schema specified in this field.

  • Optionalresponse_mime_type?: string

    The mime type of the response. This is required if response_format is set.

    Deprecated

    field: This will be removed in a future release, please migrate away from it as soon as possible.

  • Optionalresponse_modalities?: ResponseModality[]

    The requested modalities of the response (TEXT, IMAGE, AUDIO).

    Deprecated

    field: This will be removed in a future release, please migrate away from it as soon as possible.

  • Optionalsafety_settings?: SafetySetting[]

    Safety settings for the interaction.

  • Optionalservice_tier?: ServiceTier
  • status: InteractionStatus

    Required. Output only. The status of the interaction.

  • Optionalsteps?: Step[]

    Required. Output only. The steps that make up the interaction, when included in the response.

  • Optionalsystem_instruction?: string

    System instruction for the interaction.

  • Optionaltools?: Tool[]

    A list of tool declarations the model may call during interaction.

  • Optionalupdated?: string

    Required. Output only. The time at which the response was last updated in ISO 8601 format

    Remarks

    (YYYY-MM-DDThh:mm:ssZ).

  • Optionalusage?: Usage

    Statistics on the interaction request's token usage.

  • Optionalwebhook_config?: WebhookConfig

    Message for configuring webhook events for a request.

Settings