Package types (0.3.0)

API documentation for ces_v1beta.types package.

Classes

Action

Configuration of an Action for the tool to use. Note: This can be either an Action or an Operation. See https://cloud.google.com/integration-connectors/docs/entities-operation-action for details.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Agent

An agent acts as the fundamental building block that provides instructions to the Large Language Model (LLM) for executing specific tasks.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

AgentTool

Represents a tool that allows the agent to call another agent.

AgentTransfer

Represents an event indicating the transfer of a conversation to a different agent.

AggregatedMetrics

Aggregated metrics for an evaluation or evaluation dataset.

AmbientSoundConfig

Configuration for the ambient sound to be played with the synthesized agent response, to enhance the naturalness of the conversation.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ApiAuthentication

Authentication information required for API calls.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ApiKeyConfig

Configurations for authentication with API key.

App

An app serves as a top-level container for a group of agents, including the root agent and its sub-agents, along with their associated configurations. These agents work together to achieve specific goals within the app's context.

AppSnapshot

A snapshot of the app.

AppVersion

In Customer Engagement Suite (CES), an app version is a snapshot of the app at a specific point in time. It is immutable and cannot be modified once created.

AudioEncoding

AudioEncoding specifies the encoding format for audio data.

AudioProcessingConfig

Configuration for how the input and output audio should be processed and delivered.

AudioRecordingConfig

Configuration for how the audio interactions should be recorded.

BargeInConfig

Configuration for how the user barge-in activities should be handled.

BatchDeleteConversationsRequest

Request message for AgentService.BatchDeleteConversations.

BatchDeleteConversationsResponse

Response message for AgentService.BatchDeleteConversations.

BearerTokenConfig

Configurations for authentication with a bearer token.

BidiSessionClientMessage

The top-level message sent by the client for the SessionService.BidiRunSession method.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

BidiSessionServerMessage

The top-level message returned from SessionService.BidiRunSession method.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

BigQueryExportSettings

Settings to describe the BigQuery export behaviors for the app.

Blob

Represents a blob input or output in the conversation.

Callback

A callback defines the custom logic to be executed at various stages of agent interaction.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Changelog

Changelogs represent a change made to the app or to an resource within the app.

ChannelProfile

A ChannelProfile configures the agent's behavior for a specific communication channel, such as web UI or telephony.

Chunk

A chunk of content within a message.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Citations

Citations associated with the agent response.

ClientCertificateSettings

Settings for custom client certificates.

ClientFunction

Represents a client-side function that the agent can invoke. When the tool is chosen by the agent, control is handed off to the client. The client is responsible for executing the function and returning the result as a ToolResponse to continue the interaction with the agent.

CloudLoggingSettings

Settings to describe the Cloud Logging behaviors for the app.

CodeBlock

A code block to be executed instead of a real tool call.

ConnectorTool

A ConnectorTool allows connections to different integrations. See: https://cloud.google.com/integration-connectors/docs/overview.

ConnectorToolset

A toolset that generates tools from an Integration Connectors Connection.

Conversation

A conversation represents an interaction between an end user and the CES app.

ConversationLoggingSettings

Settings to describe the conversation logging behaviors for the app.

CreateAgentRequest

Request message for AgentService.CreateAgent.

CreateAppRequest

Request message for AgentService.CreateApp.

CreateAppVersionRequest

Request message for AgentService.CreateAppVersion

CreateDeploymentRequest

Request message for AgentService.CreateDeployment.

CreateEvaluationDatasetRequest

Request message for EvaluationService.CreateEvaluationDataset.

CreateEvaluationExpectationRequest

Request message for EvaluationService.CreateEvaluationExpectation.

CreateEvaluationRequest

Request message for EvaluationService.CreateEvaluation.

CreateExampleRequest

Request message for AgentService.CreateExample.

CreateGuardrailRequest

Request message for AgentService.CreateGuardrail.

CreateScheduledEvaluationRunRequest

Request message for EvaluationService.CreateScheduledEvaluationRun.

CreateToolRequest

Request message for AgentService.CreateTool.

CreateToolsetRequest

Request message for AgentService.CreateToolset.

DataStore

A DataStore resource in Vertex AI Search.

DataStoreSettings

Data store related settings for the app.

DataStoreTool

Tool to retrieve from Vertex AI Search datastore or engine for grounding. Accepts either a datastore or an engine, but not both. See Vertex AI Search:

https://cloud.google.com/generative-ai-app-builder/docs/enterprise-search-introduction.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

DeleteAgentRequest

Request message for AgentService.DeleteAgent.

DeleteAppRequest

Request message for AgentService.DeleteApp.

DeleteAppVersionRequest

Request message for AgentService.DeleteAppVersion.

DeleteConversationRequest

Request message for AgentService.DeleteConversation.

DeleteDeploymentRequest

Request message for AgentService.DeleteDeployment.

DeleteEvaluationDatasetRequest

Request message for EvaluationService.DeleteEvaluationDataset.

DeleteEvaluationExpectationRequest

Request message for EvaluationService.DeleteEvaluationExpectation.

DeleteEvaluationRequest

Request message for EvaluationService.DeleteEvaluation.

DeleteEvaluationResultRequest

Request message for EvaluationService.DeleteEvaluationResult.

DeleteEvaluationRunOperationMetadata

Operation metadata for EvaluationService.DeleteEvaluationRun.

DeleteEvaluationRunRequest

Request message for EvaluationService.DeleteEvaluationRun.

DeleteExampleRequest

Request message for AgentService.DeleteExample.

DeleteGuardrailRequest

Request message for AgentService.DeleteGuardrail.

DeleteScheduledEvaluationRunRequest

Request message for EvaluationService.DeleteScheduledEvaluationRun.

DeleteToolRequest

Request message for AgentService.DeleteTool.

DeleteToolsetRequest

Request message for AgentService.DeleteToolset.

Deployment

A deployment represents an immutable, queryable version of the app. It is used to deploy an app version with a specific channel profile.

EndSession

Indicates the session has terminated, due to either successful completion (e.g. user says "Good bye!" ) or an agent escalation.

The agent will not process any further inputs after session is terminated and the client should half-close and disconnect after receiving all remaining responses from the agent.

EndUserAuthConfig

End-user authentication configuration used for Connection calls. The field values must be the names of context variables in the format $context.variables.<name_of_variable>.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

EndpointControlPolicy

Defines project/location level endpoint control policy.

ErrorHandlingSettings

Settings to describe how errors should be handled in the app.

Evaluation

An evaluation represents all of the information needed to simulate and evaluate an agent.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

EvaluationConfig

EvaluationConfig configures settings for running the evaluation.

EvaluationDataset

An evaluation dataset represents a set of evaluations that are grouped together basaed on shared tags.

EvaluationErrorInfo

Information about an error encountered during an evaluation execution.

EvaluationExpectation

An evaluation expectation represents a specific criteria to evaluate against.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

EvaluationMetricsThresholds

Threshold settings for metrics in an Evaluation.

EvaluationPersona

A persona represents an end user in an evaluation.

EvaluationResult

An evaluation result represents the output of running an Evaluation.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

EvaluationRun

An evaluation run represents an all the evaluation results from an evaluation execution.

EvaluationSettings

Settings for evaluation.

EvaluationToolCallBehaviour

Configures the tool call behaviour for evaluation runs.

Event

Event input.

Example

An example represents a sample conversation between the user and the agent(s).

ExecuteToolRequest

Request message for ToolService.ExecuteTool.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ExecuteToolResponse

Response message for ToolService.ExecuteTool.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ExecutionType

The execution type of the tool or toolset.

ExportAppRequest

Request message for AgentService.ExportApp.

ExportAppResponse

Response message for AgentService.ExportApp.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ExpressionCondition

Expression condition based on session state.

FileSearchTool

The file search tool allows the agent to search across the files uploaded by the app/agent developer. It has presets to give relatively good quality search over the uploaded files and summarization of the retrieved results.

GenerateAppResourceResponse

Response message for AgentService.GenerateAppResource.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

GenerateChatTokenRequest

Request message for WidgetService.GenerateChatToken.

GenerateChatTokenResponse

Response message for WidgetService.GenerateChatToken.

GenerateEvaluationOperationMetadata

Operation metadata for EvaluationService.GenerateEvaluation.

GenerateEvaluationRequest

Request message for EvaluationService.GenerateEvaluation.

GetAgentRequest

Request message for AgentService.GetAgent.

GetAppRequest

Request message for AgentService.GetApp.

GetAppVersionRequest

Request message for AgentService.GetAppVersion.

GetChangelogRequest

Request message for AgentService.GetChangelog.

GetConversationRequest

Request message for AgentService.GetConversation.

GetDeploymentRequest

Request message for AgentService.GetDeployment.

GetEvaluationDatasetRequest

Request message for EvaluationService.GetEvaluationDataset.

GetEvaluationExpectationRequest

Request message for EvaluationService.GetEvaluationExpectation.

GetEvaluationRequest

Request message for EvaluationService.GetEvaluation.

GetEvaluationResultRequest

Request message for EvaluationService.GetEvaluationResult.

GetEvaluationRunRequest

Request message for EvaluationService.GetEvaluationRun.

GetExampleRequest

Request message for AgentService.GetExample.

GetGuardrailRequest

Request message for AgentService.GetGuardrail.

GetScheduledEvaluationRunRequest

Request message for EvaluationService.GetScheduledEvaluationRun.

GetSecuritySettingsRequest

Request message for AgentService.GetSecuritySettings.

GetToolRequest

Request message for AgentService.GetTool.

GetToolsetRequest

Request message for AgentService.GetToolset.

GoAway

Indicates that the server will disconnect soon and the client should half-close and restart the connection.

GoldenRunMethod

The method used to run the evaluation.

GoogleSearchSuggestions

Search suggestions from [Google Search Tool][google.cloud.ces.v1beta.GoogleSearchTool].

GoogleSearchTool

Represents a tool to perform Google web searches for grounding. See https://cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool#google-search.

Guardrail

Guardrail contains a list of checks and balances to keep the agents safe and secure.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Image

Represents an image input or output in the conversation.

ImportAppRequest

Request message for AgentService.ImportApp.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ImportAppResponse

Response message for AgentService.ImportApp.

ImportEvaluationsOperationMetadata

Represents the metadata of the long-running operation for EvaluationService.ImportEvaluations.

ImportEvaluationsRequest

Request message for EvaluationService.ImportEvaluations.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ImportEvaluationsResponse

Response message for EvaluationService.ImportEvaluations.

InputAudioConfig

InputAudioConfig configures how the CES agent should interpret the incoming audio data.

InterruptionSignal

Indicates the agent's audio response has been interrupted. The client should immediately stop any current audio playback (e.g., due to user barge-in or a new agent response being generated).

LanguageSettings

Language settings of the app.

LatencyReport

Latency report for the evaluation run.

ListAgentsRequest

Request message for AgentService.ListAgents.

ListAgentsResponse

Response message for AgentService.ListAgents.

ListAppVersionsRequest

Request message for AgentService.ListAppVersions.

ListAppVersionsResponse

Response message for AgentService.ListAppVersions.

ListAppsRequest

Request message for AgentService.ListApps.

ListAppsResponse

Response message for AgentService.ListApps.

ListChangelogsRequest

Request message for AgentService.ListChangelogs.

ListChangelogsResponse

Response message for AgentService.ListChangelogs.

ListConversationsRequest

Request message for AgentService.ListConversations.

ListConversationsResponse

Response message for AgentService.ListConversations.

ListDeploymentsRequest

Request message for AgentService.ListDeployments.

ListDeploymentsResponse

Response message for AgentService.ListDeployments.

ListEvaluationDatasetsRequest

Request message for EvaluationService.ListEvaluationDatasets.

ListEvaluationDatasetsResponse

Response message for EvaluationService.ListEvaluationDatasets.

ListEvaluationExpectationsRequest

Request message for EvaluationService.ListEvaluationExpectations.

ListEvaluationExpectationsResponse

Response message for EvaluationService.ListEvaluationExpectations.

ListEvaluationResultsRequest

Request message for EvaluationService.ListEvaluationResults.

ListEvaluationResultsResponse

Response message for EvaluationService.ListEvaluationResults.

ListEvaluationRunsRequest

Request message for EvaluationService.ListEvaluationRuns.

ListEvaluationRunsResponse

Response message for EvaluationService.ListEvaluationRuns.

ListEvaluationsRequest

Request message for EvaluationService.ListEvaluations.

ListEvaluationsResponse

Response message for EvaluationService.ListEvaluations.

ListExamplesRequest

Request message for AgentService.ListExamples.

ListExamplesResponse

Response message for AgentService.ListExamples.

ListGuardrailsRequest

Request message for AgentService.ListGuardrails.

ListGuardrailsResponse

Response message for AgentService.ListGuardrails.

ListScheduledEvaluationRunsRequest

Request message for EvaluationService.ListScheduledEvaluationRuns.

ListScheduledEvaluationRunsResponse

Response message for EvaluationService.ListScheduledEvaluationRuns.

ListToolsRequest

Request message for AgentService.ListTools.

ListToolsResponse

Response message for AgentService.ListTools.

ListToolsetsRequest

Request message for AgentService.ListToolsets.

ListToolsetsResponse

Response message for AgentService.ListToolsets.

LoggingSettings

Settings to describe the logging behaviors for the app.

McpTool

An MCP tool. See https://modelcontextprotocol.io/specification/2025-06-18/server/tools for more details.

McpToolset

A toolset that contains a list of tools that are offered by the MCP server.

Message

A message within a conversation.

MetricAnalysisSettings

Settings to describe the conversation data collection behaviors for LLM analysis metrics pipeline.

ModelSettings

Model settings contains various configurations for the LLM model.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

OAuthConfig

Configurations for authentication with OAuth.

Omnichannel

Represents an Omnichannel resource.

OmnichannelIntegrationConfig

OmnichannelIntegrationConfig contains all App integration configs.

OmnichannelOperationMetadata

Represents the metadata of the long-running operation.

OpenApiTool

A remote API tool defined by an OpenAPI schema.

OpenApiToolset

A toolset that contains a list of tools that are defined by an OpenAPI schema.

OperationMetadata

Represents the metadata of the long-running operation.

OptimizationConfig

Configuration for running the optimization step after the evaluation run.

OutputAudioConfig

OutputAudioConfig configures how the CES agent should synthesize outgoing audio responses.

PersonaRunConfig

Configuration for running an evaluation for a specific persona.

PythonCodeCondition

Python code block to evaluate the condition.

PythonFunction

A Python function tool.

QualityReport

The report describing any identified quality issues in the app.

RecognitionResult

Speech recognition result for the audio input.

RedactionConfig

Configuration to instruct how sensitive data should be handled.

RestoreAppVersionRequest

Request message for AgentService.RestoreAppVersion

RestoreAppVersionResponse

Response message for AgentService.RestoreAppVersion

RetrieveToolSchemaRequest

Request message for ToolService.RetrieveToolSchema.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

RetrieveToolSchemaResponse

Response message for ToolService.RetrieveToolSchema.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

RetrieveToolsRequest

Request message for ToolService.RetrieveTools.

RetrieveToolsResponse

Response message for ToolService.RetrieveTools.

RunEvaluationOperationMetadata

Operation metadata for EvaluationService.RunEvaluation.

RunEvaluationRequest

Request message for EvaluationService.RunEvaluation.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

RunEvaluationResponse

Response message for EvaluationService.RunEvaluation.

RunSessionRequest

Request message for SessionService.RunSession.

RunSessionResponse

Response message for SessionService.RunSession.

ScheduledEvaluationRun

Represents a scheduled evaluation run configuration.

Schema

Represents a select subset of an OpenAPI 3.0 schema object.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

SecuritySettings

Project/Location level security settings for CES.

ServiceAccountAuthConfig

Configurations for authentication using a custom service account.

ServiceAgentIdTokenAuthConfig

Configurations for authentication with ID token <https://cloud.google.com/docs/authentication/token-types#id>__ generated from service agent.

ServiceDirectoryConfig

Configuration for tools using Service Directory.

SessionConfig

The configuration for the session.

SessionInput

Input for the session.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

SessionOutput

Output for the session.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Span

A span is a unit of work or a single operation during the request processing.

SynthesizeSpeechConfig

Configuration for how the agent response should be synthesized.

SystemTool

Pre-defined system tool.

TestPersonaVoiceRequest

Request message for EvaluationService.TestPersonaVoice.

TestPersonaVoiceResponse

Response message for EvaluationService.TestPersonaVoice.

TimeZoneSettings

TimeZone settings of the app.

TlsConfig

The TLS configuration.

Tool

A tool represents an action that the CES agent can take to achieve certain goals.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ToolCall

Request for the client or the agent to execute the specified tool.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ToolCalls

Request for the client to execute the tools and return the execution results before continuing the session.

ToolFakeConfig

Configuration for tool behavior in fake mode.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ToolResponse

The execution result of a specific tool from the client or the agent.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ToolResponses

Execution results for the requested tool calls from the client.

Toolset

A toolset represents a group of dynamically managed tools that can be used by the agent.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ToolsetTool

A tool that is created from a toolset.

TransferRule

Rule for transferring to a specific agent.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

TriggerAction

Action that is taken when a certain precondition is met.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

UpdateAgentRequest

Request message for AgentService.UpdateAgent.

UpdateAppRequest

Request message for AgentService.UpdateApp.

UpdateDeploymentRequest

Request message for AgentService.UpdateDeployment.

UpdateEvaluationDatasetRequest

Request message for EvaluationService.UpdateEvaluationDataset.

UpdateEvaluationExpectationRequest

Request message for EvaluationService.UpdateEvaluationExpectation.

UpdateEvaluationRequest

Request message for EvaluationService.UpdateEvaluation.

UpdateExampleRequest

Request message for AgentService.UpdateExample.

UpdateGuardrailRequest

Request message for AgentService.UpdateGuardrail.

UpdateScheduledEvaluationRunRequest

Request message for EvaluationService.UpdateScheduledEvaluationRun.

UpdateSecuritySettingsRequest

Request message for AgentService.UpdateSecuritySettings.

UpdateToolRequest

Request message for AgentService.UpdateTool.

UpdateToolsetRequest

Request message for AgentService.UpdateToolset.

UploadEvaluationAudioRequest

Request message for EvaluationService.UploadEvaluationAudio.

UploadEvaluationAudioResponse

Response message for EvaluationService.UploadEvaluationAudio.

WebSearchQuery

Represents a single web search query and its associated search uri.

WidgetTool

Represents a widget tool that the agent can invoke. When the tool is chosen by the agent, agent will return the widget to the client. The client is responsible for processing the widget and generating the next user query to continue the interaction with the agent.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields