GOgoogle
projects

POST /v1/projects/{projectsId}/locations/{locationsId}/interactions:create

Changed on

Creates an interaction.

Request

Path parameters

projectsIdstring required
locationsIdstring required

Request body

backgroundboolean

Input only. Whether to run the model interaction in the background.

storeboolean

Input only. Whether to store the response and request for later retrieval.

streamboolean

Input only. Whether the interaction will be streamed.

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