GOgoogle
interactions

GET /v1/interactions/{interactionsId}:poll

Fully typed proto, unary version of GetInteraction that returns Interaction proto.

Request

  • Base URL
    https://aiplatform.googleapis.com
  • Auth
    OAuth 2 and OAuth 2
    Implicithttps://accounts.google.com/o/oauth2/auth
    Scopeshttps://www.googleapis.com/auth/cloud-platform
    Authorization codehttps://accounts.google.com/o/oauth2/auth
    Token URLhttps://accounts.google.com/o/oauth2/token
    Scopeshttps://www.googleapis.com/auth/cloud-platform
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

interactionsIdstring required

Query parameters

lastEventIdstring

If set, resumes the interaction stream from the chunk after the event marked by the event id. Can only be used if stream is true.

streamboolean

If true, streams the interaction events as Server-Sent Events.

Response

Successful response

createdstring

Required. Output only. The time at which the response was created in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).

envIdstring

The environment ID for the interaction. Can be 'remote' for default environment.

environmentIdstring

Output only. The environment ID for the interaction. Only populated if environment config is set in the request.

idstring

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

labelsobject

The labels with user-defined metadata for the request. 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.

previousInteractionIdstring

The ID of the previous interaction, if any.

serviceTier'SERVICE_TIER_UNSPECIFIED' | 'SERVICE_TIER_FLEX' | 'SERVICE_TIER_STANDARD' | 'SERVICE_TIER_PRIORITY' | 'SERVICE_TIER_DEFERRED'

The service tier for the interaction.

status'UNSPECIFIED' | 'IN_PROGRESS' | 'REQUIRES_ACTION' | 'COMPLETED' | 'FAILED' | 'CANCELLED' | 'INCOMPLETE' | 'QUEUED' | 'REQUIRES_CONTINUATION'

Required. Output only. The status of the interaction.

stringContentstring

A string input for the interaction, it will be processed as a single text input.

systemInstructionstring

System instruction for the interaction.

updatedstring

Required. Output only. The time at which the response was last updated in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).

Changes

No recorded changes to this operation across all 8 revisions of this API.