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.

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)

Generates a set of responses from the model.

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)

Gets an interaction.

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

VoicesService

VoicesService defines typed RPCs for future SDK generation. NOTE: No handlers are currently registered for these RPCs. All traffic is served via VoicesHttpService (the HttpBody-wrapping service). When handlers are added, the scaffolding_registration_test in labs/language/genai/Voices/ must be updated to include "VoicesService" in its services argument.

Because this service ships in the same proto_library as VoicesHttpService, both are registered into the live ESF config together. A method here must therefore NOT declare a method_http_map matching one of VoicesHttpService's REST templates: ESF resolves on (path, verb), and two methods claiming one route make it reject every request to that route as ambiguous rather than pick one. Every method below uses a distinct custom-verb suffix (":create", ":get", ":list", ":delete") so its REST template never matches VoicesHttpService's bare-path templates, mirroring the convention InteractionsService's typed RPCs use for the same reason (e.g. ListInteractions -> "interactions:list").