Package google.learning.vertex.api.interactions.v1beta1

Index

InteractionsService

API that allows users to interact with models and agents.

CancelInteraction

rpc CancelInteraction(CancelInteractionRequest) returns (Interaction)

Cancels an interaction.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • aiplatform.interactions.cancel

For more information, see the IAM documentation.
CancelInteractionHttp

rpc CancelInteractionHttp(CancelInteractionRequest) returns (HttpBody)

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

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
CreateInteraction

rpc CreateInteraction(CreateInteractionRequest) returns (Interaction)

Creates an interaction.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • aiplatform.interactions.create

For more information, see the IAM documentation.
CreateInteractionHttp

rpc CreateInteractionHttp(CreateInteractionHttpRequest) returns (HttpBody)

Creates a new interaction.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • aiplatform.interactions.create

For more information, see the IAM documentation.
CreateInteractionStream

rpc CreateInteractionStream(CreateInteractionRequest) returns (InteractionStreamingEvent)

Creates an interaction and streams the response.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • aiplatform.interactions.create

For more information, see the IAM documentation.
DeleteInteraction

rpc DeleteInteraction(DeleteInteractionRequest) returns (DeleteInteractionResponse)

Deletes an interaction.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • aiplatform.interactions.delete

For more information, see the IAM documentation.
GetInteraction

rpc GetInteraction(GetInteractionRequest) returns (Interaction)

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

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • aiplatform.interactions.get

For more information, see the IAM documentation.
GetInteractionHttp

rpc GetInteractionHttp(GetInteractionRequest) returns (HttpBody)

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

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.
GetInteractionStream

rpc GetInteractionStream(GetInteractionRequest) returns (InteractionStreamingEvent)

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

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • aiplatform.interactions.get

For more information, see the IAM documentation.
ListInteractions

rpc ListInteractions(ListInteractionsRequest) returns (ListInteractionsResponse)

List interactions.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • aiplatform.interactions.list

For more information, see the IAM documentation.
ListInteractionsHttp

rpc ListInteractionsHttp(ListInteractionsRequest) returns (HttpBody)

List interactions.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • aiplatform.interactions.list

For more information, see the IAM documentation.

VoicesHttpService

HTTP transcoder service for managing custom voices and listing available voices for Gemini TTS.

VoicesService

Manages custom voices and lists available voices for Gemini TTS.

A voice is created either by replication from a reference audio recording or by prompting with a natural-language description. Created voices are referenced at synthesis time via GenerationConfig.speech_config.voice_config.voice (in GenerateContent / BidiGenerateContent) or GenerationConfig.speech_config.voice (in CreateInteraction).