Package Classes (0.3.0)

Summary of entries of Classes for google-cloud-ces.

Classes

AgentServiceAsyncClient

The service that manages agent-related resources in Gemini Enterprise for Customer Engagement (CES).

AgentServiceClient

The service that manages agent-related resources in Gemini Enterprise for Customer Engagement (CES).

ListAgentsAsyncPager

A pager for iterating through list_agents requests.

This class thinly wraps an initial ListAgentsResponse object, and provides an __aiter__ method to iterate through its agents field.

If there are more pages, the __aiter__ method will make additional ListAgents requests and continue to iterate through the agents field on the corresponding responses.

All the usual ListAgentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListAgentsPager

A pager for iterating through list_agents requests.

This class thinly wraps an initial ListAgentsResponse object, and provides an __iter__ method to iterate through its agents field.

If there are more pages, the __iter__ method will make additional ListAgents requests and continue to iterate through the agents field on the corresponding responses.

All the usual ListAgentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListAppVersionsAsyncPager

A pager for iterating through list_app_versions requests.

This class thinly wraps an initial ListAppVersionsResponse object, and provides an __aiter__ method to iterate through its app_versions field.

If there are more pages, the __aiter__ method will make additional ListAppVersions requests and continue to iterate through the app_versions field on the corresponding responses.

All the usual ListAppVersionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListAppVersionsPager

A pager for iterating through list_app_versions requests.

This class thinly wraps an initial ListAppVersionsResponse object, and provides an __iter__ method to iterate through its app_versions field.

If there are more pages, the __iter__ method will make additional ListAppVersions requests and continue to iterate through the app_versions field on the corresponding responses.

All the usual ListAppVersionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListAppsAsyncPager

A pager for iterating through list_apps requests.

This class thinly wraps an initial ListAppsResponse object, and provides an __aiter__ method to iterate through its apps field.

If there are more pages, the __aiter__ method will make additional ListApps requests and continue to iterate through the apps field on the corresponding responses.

All the usual ListAppsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListAppsPager

A pager for iterating through list_apps requests.

This class thinly wraps an initial ListAppsResponse object, and provides an __iter__ method to iterate through its apps field.

If there are more pages, the __iter__ method will make additional ListApps requests and continue to iterate through the apps field on the corresponding responses.

All the usual ListAppsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListChangelogsAsyncPager

A pager for iterating through list_changelogs requests.

This class thinly wraps an initial ListChangelogsResponse object, and provides an __aiter__ method to iterate through its changelogs field.

If there are more pages, the __aiter__ method will make additional ListChangelogs requests and continue to iterate through the changelogs field on the corresponding responses.

All the usual ListChangelogsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListChangelogsPager

A pager for iterating through list_changelogs requests.

This class thinly wraps an initial ListChangelogsResponse object, and provides an __iter__ method to iterate through its changelogs field.

If there are more pages, the __iter__ method will make additional ListChangelogs requests and continue to iterate through the changelogs field on the corresponding responses.

All the usual ListChangelogsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListConversationsAsyncPager

A pager for iterating through list_conversations requests.

This class thinly wraps an initial ListConversationsResponse object, and provides an __aiter__ method to iterate through its conversations field.

If there are more pages, the __aiter__ method will make additional ListConversations requests and continue to iterate through the conversations field on the corresponding responses.

All the usual ListConversationsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListConversationsPager

A pager for iterating through list_conversations requests.

This class thinly wraps an initial ListConversationsResponse object, and provides an __iter__ method to iterate through its conversations field.

If there are more pages, the __iter__ method will make additional ListConversations requests and continue to iterate through the conversations field on the corresponding responses.

All the usual ListConversationsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListDeploymentsAsyncPager

A pager for iterating through list_deployments requests.

This class thinly wraps an initial ListDeploymentsResponse object, and provides an __aiter__ method to iterate through its deployments field.

If there are more pages, the __aiter__ method will make additional ListDeployments requests and continue to iterate through the deployments field on the corresponding responses.

All the usual ListDeploymentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListDeploymentsPager

A pager for iterating through list_deployments requests.

This class thinly wraps an initial ListDeploymentsResponse object, and provides an __iter__ method to iterate through its deployments field.

If there are more pages, the __iter__ method will make additional ListDeployments requests and continue to iterate through the deployments field on the corresponding responses.

All the usual ListDeploymentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListExamplesAsyncPager

A pager for iterating through list_examples requests.

This class thinly wraps an initial ListExamplesResponse object, and provides an __aiter__ method to iterate through its examples field.

If there are more pages, the __aiter__ method will make additional ListExamples requests and continue to iterate through the examples field on the corresponding responses.

All the usual ListExamplesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListExamplesPager

A pager for iterating through list_examples requests.

This class thinly wraps an initial ListExamplesResponse object, and provides an __iter__ method to iterate through its examples field.

If there are more pages, the __iter__ method will make additional ListExamples requests and continue to iterate through the examples field on the corresponding responses.

All the usual ListExamplesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListGuardrailsAsyncPager

A pager for iterating through list_guardrails requests.

This class thinly wraps an initial ListGuardrailsResponse object, and provides an __aiter__ method to iterate through its guardrails field.

If there are more pages, the __aiter__ method will make additional ListGuardrails requests and continue to iterate through the guardrails field on the corresponding responses.

All the usual ListGuardrailsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListGuardrailsPager

A pager for iterating through list_guardrails requests.

This class thinly wraps an initial ListGuardrailsResponse object, and provides an __iter__ method to iterate through its guardrails field.

If there are more pages, the __iter__ method will make additional ListGuardrails requests and continue to iterate through the guardrails field on the corresponding responses.

All the usual ListGuardrailsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListToolsAsyncPager

A pager for iterating through list_tools requests.

This class thinly wraps an initial ListToolsResponse object, and provides an __aiter__ method to iterate through its tools field.

If there are more pages, the __aiter__ method will make additional ListTools requests and continue to iterate through the tools field on the corresponding responses.

All the usual ListToolsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListToolsPager

A pager for iterating through list_tools requests.

This class thinly wraps an initial ListToolsResponse object, and provides an __iter__ method to iterate through its tools field.

If there are more pages, the __iter__ method will make additional ListTools requests and continue to iterate through the tools field on the corresponding responses.

All the usual ListToolsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListToolsetsAsyncPager

A pager for iterating through list_toolsets requests.

This class thinly wraps an initial ListToolsetsResponse object, and provides an __aiter__ method to iterate through its toolsets field.

If there are more pages, the __aiter__ method will make additional ListToolsets requests and continue to iterate through the toolsets field on the corresponding responses.

All the usual ListToolsetsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListToolsetsPager

A pager for iterating through list_toolsets requests.

This class thinly wraps an initial ListToolsetsResponse object, and provides an __iter__ method to iterate through its toolsets field.

If there are more pages, the __iter__ method will make additional ListToolsets requests and continue to iterate through the toolsets field on the corresponding responses.

All the usual ListToolsetsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

SessionServiceAsyncClient

Session service provides APIs for interacting with CES agents.

SessionServiceClient

Session service provides APIs for interacting with CES agents.

ToolServiceAsyncClient

Tool service provides APIs for interacting with CES tools.

ToolServiceClient

Tool service provides APIs for interacting with CES tools.

WidgetServiceAsyncClient

Provides APIs for widgets to interact with CES APIs.

WidgetServiceClient

Provides APIs for widgets to interact with CES APIs.

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

EntityOperation

Entity CRUD operation specification.

OperationType

The operation to perform on the entity.

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

AgentToolset

A toolset with a selection of its tools.

LlmAgent

Default agent type. The agent uses instructions and callbacks specified in the agent to perform the task using a large language model.

RemoteDialogflowAgent

The agent which will transfer execution to a remote Dialogflow CX <https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent>__ agent. The Dialogflow agent will process subsequent user queries until the session ends or flow ends, and the control is transferred back to the parent CES agent.

InputVariableMappingEntry

The abstract base class for a message.

OutputVariableMappingEntry

The abstract base class for a message.

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.

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

PrebuiltAmbientNoise

Prebuilt ambient noise.

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.

RequestLocation

The location of the API key in the request.

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.

MetadataEntry

The abstract base class for a message.

ToolExecutionMode

Defines the tool execution behavior if there are multiple tools being selected by the agent at the same time.

VariableDeclaration

Defines the structure and metadata for a variable.

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.

SynthesizeSpeechConfigsEntry

The abstract base class for a message.

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.

ChannelType

The type of the channel profile.

PersonaProperty

Represents the persona property of a channel.

Persona

The persona of the channel.

WebWidgetConfig

Message for configuration for the web widget.

Modality

Modality of the web widget.

SecuritySettings

Security settings for the web widget.

Theme

Theme of the web widget.

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.

CitedChunk

Piece of cited information.

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.

ChannelType

The channel type of the conversation.

InputType

Type of the input message.

Source

The source of the conversation.

Turn

All information about a single turn in the conversation.

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.

CreateExampleRequest

Request message for AgentService.CreateExample.

CreateGuardrailRequest

Request message for AgentService.CreateGuardrail.

CreateToolRequest

Request message for AgentService.CreateTool.

CreateToolsetRequest

Request message for AgentService.CreateToolset.

DataStore

A DataStore resource in Vertex AI Search.

ConnectorConfig

The connector config for the data store connection.

DataStoreType

The type of the data store.

DocumentProcessingMode

The document processing mode of the data store.

DataStoreSettings

Data store related settings for the app.

Engine

An engine to which the data stores are connected. See Vertex AI Search:

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

Type

The type of the engine. See the documentation available at https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1/SolutionType and https://cloud.google.com/generative-ai-app-builder/docs/create-datastore-ingest.

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

BoostSpec

Boost specification to boost certain documents.

ConditionBoostSpec

Boost specification for a condition.

BoostControlSpec

Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above.

AttributeType

The attribute(or function) for which the custom ranking is to be applied.

ControlPoint

The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).

InterpolationType

The interpolation type to be applied. Default will be linear (Piecewise Linear).

BoostSpecs

Boost specifications to boost certain documents. For more information, please refer to https://cloud.google.com/generative-ai-app-builder/docs/boosting.

DataStoreSource

Configuration for searching within a specific DataStore.

EngineSource

Configuration for searching within an Engine, potentially targeting specific DataStores.

FilterParameterBehavior

Filter parameter behavior.

GroundingConfig

Grounding configuration.

ModalityConfig

If specified, will apply the given configuration for the specified modality.

ModalityType

The modality type.

RewriterConfig

Rewriter configuration.

SummarizationConfig

Summarization configuration.

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.

DeleteExampleRequest

Request message for AgentService.DeleteExample.

DeleteGuardrailRequest

Request message for AgentService.DeleteGuardrail.

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

Oauth2AuthCodeConfig

Oauth 2.0 Authorization Code authentication configuration.

Oauth2JwtBearerConfig

JWT Profile Oauth 2.0 Authorization Grant authentication configuration.

EndpointControlPolicy

Defines project/location level endpoint control policy.

EnforcementScope

Defines the scope in which this policy's allowed_origins list is enforced.

ErrorHandlingSettings

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

ErrorHandlingStrategy

Defines the strategy for handling errors.

EvaluationMetricsThresholds

Threshold settings for metrics in an Evaluation.

GoldenEvaluationMetricsThresholds

Settings for golden evaluations.

ExpectationLevelMetricsThresholds

Expectation level metrics thresholds.

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

TurnLevelMetricsThresholds

Turn level metrics thresholds.

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

SemanticSimilarityChannel

Semantic similarity channel to use.

HallucinationMetricBehavior

The hallucination metric behavior. Regardless of the behavior, the metric will always be calculated. The difference is that when disabled, the metric is not used to calculate the overall evaluation score.

ToolMatchingSettings

Settings for matching tool calls.

ExtraToolCallBehavior

Defines the behavior when an extra tool call is encountered. An extra tool call is a tool call that is present in the execution but does not match any tool call in the golden expectation.

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.

ExportFormat

Export format for the app.

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.

CorpusType

The type of the Vertex RAG corpus.

GenerateChatTokenRequest

Request message for WidgetService.GenerateChatToken.

GenerateChatTokenResponse

Response message for WidgetService.GenerateChatToken.

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.

GetExampleRequest

Request message for AgentService.GetExample.

GetGuardrailRequest

Request message for AgentService.GetGuardrail.

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.

GoogleSearchSuggestions

Search suggestions from [Google Search Tool][google.cloud.ces.v1.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.

PromptConfig

Prompt settings used by the model when processing or summarizing the google search results.

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

CodeCallback

Guardrail that blocks the conversation based on the code callbacks provided.

ContentFilter

Guardrail that bans certain content from being used in the conversation.

MatchType

Match type for the content filter.

LlmPolicy

Guardrail that blocks the conversation if the LLM response is considered violating the policy based on the LLM classification.

PolicyScope

Defines when to apply the policy check during the conversation.

LlmPromptSecurity

Guardrail that blocks the conversation if the input is considered unsafe based on the LLM classification.

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

DefaultSecuritySettings

Configuration for default system security settings.

ModelSafety

Model safety settings overrides. When this is set, it will override the default settings and trigger the guardrail if the response is considered unsafe.

HarmBlockThreshold

Probability based thresholds levels for blocking.

HarmCategory

Harm category.

SafetySetting

Safety setting.

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

ImportOptions

Configuration options for the app import process. These options control how the import behaves, particularly when conflicts arise with existing app data.

ConflictResolutionStrategy

Defines the strategy for handling conflicts when an app with the same ID already exists, or when imported resources (like Agents, Tools, etc.) have the same display names as existing resources within that app.

    - Resources (App, Agents, Tools, Examples, Guardrails,
      Toolsets) in the imported app that have the same display
      name as existing resources will overwrite the existing
      ones.
    - Imported resources with new display names will be created.
    - Existing resources that do not have a matching display
      name in the imported app will remain untouched.
OVERWRITE (2):
    Overwrite existing data with imported data. If an app with
    the same `app_id` already exists, its content will be
    overwritten with the imported app.

    - Existing resources (Agents, Tools, Examples, Guardrails,
      Toolsets) in the app will be deleted.
    - Imported resources will be created as new resources.

ImportAppResponse

Response message for AgentService.ImportApp.

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.

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.

ListExamplesRequest

Request message for AgentService.ListExamples.

ListExamplesResponse

Response message for AgentService.ListExamples.

ListGuardrailsRequest

Request message for AgentService.ListGuardrails.

ListGuardrailsResponse

Response message for AgentService.ListGuardrails.

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.

CustomHeadersEntry

The abstract base class for a message.

McpToolset

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

CustomHeadersEntry

The abstract base class for a message.

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.

OauthGrantType

OAuth grant types. Only client credential grant <https://oauth.net/2/grant-types/client-credentials>__ is supported.

Omnichannel

Represents an Omnichannel resource.

OmnichannelIntegrationConfig

OmnichannelIntegrationConfig contains all App integration configs.

CesAppConfig

Configs for CES app.

ChannelConfig

ChannelConfig contains config for various of app integration.

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

ChannelConfigsEntry

The abstract base class for a message.

RoutingConfig

Routing config specify how/who to route app events to a subscriber.

RoutingConfigsEntry

The abstract base class for a message.

SubscriberConfig

Configs of subscribers.

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

SubscriberConfigsEntry

The abstract base class for a message.

WhatsappConfig

How Omnichannel should receive/reply events from WhatsApp.

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.

OutputAudioConfig

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

PythonCodeCondition

Python code block to evaluate the condition.

PythonFunction

A Python function tool.

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.

RunSessionRequest

Request message for SessionService.RunSession.

RunSessionResponse

Response message for SessionService.RunSession.

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

DefsEntry

The abstract base class for a message.

PropertiesEntry

The abstract base class for a message.

Type

OpenAPI data types.

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.

RemoteDialogflowQueryParameters

QueryParameters <https://cloud.google.com/dialogflow/cx/docs/reference/rpc/google.cloud.dialogflow.cx.v3#queryparameters> to send to the remote Dialogflow <https://cloud.google.com/dialogflow/cx/docs/concept/console-conversational-agents> agent when the session control is transferred to the remote agent.

WebhookHeadersEntry

The abstract base class for a message.

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

DiagnosticInfo

Contains execution details during the processing.

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.

TimeZoneSettings

TimeZone settings of the app.

TlsConfig

The TLS configuration.

CaCert

The CA certificate.

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

DeterministicTransfer

Deterministic transfer rule. When the condition evaluates to true, the transfer occurs.

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

Direction

The direction of the transfer.

DisablePlannerTransfer

A rule that prevents the planner from transferring to the target agent.

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

GenerativeAnswer

The agent will immediately respond with a generative answer.

RespondImmediately

The agent will immediately respond with a preconfigured response.

Response

Represents a response from the agent.

TransferAgent

The agent will transfer the conversation to a different agent.

UpdateAgentRequest

Request message for AgentService.UpdateAgent.

UpdateAppRequest

Request message for AgentService.UpdateApp.

UpdateDeploymentRequest

Request message for AgentService.UpdateDeployment.

UpdateExampleRequest

Request message for AgentService.UpdateExample.

UpdateGuardrailRequest

Request message for AgentService.UpdateGuardrail.

UpdateToolRequest

Request message for AgentService.UpdateTool.

UpdateToolsetRequest

Request message for AgentService.UpdateToolset.

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

DataMapping

Configuration for mapping data from a source tool to the widget's input parameters.

FieldMappingsEntry

The abstract base class for a message.

Mode

The strategy used to map data from the source tool to the widget.

WidgetType

All available widget types. New values may be added to this enum in the future.

AgentServiceAsyncClient

The service that manages agent-related resources in Gemini Enterprise for Customer Engagement (CES).

AgentServiceClient

The service that manages agent-related resources in Gemini Enterprise for Customer Engagement (CES).

ListAgentsAsyncPager

A pager for iterating through list_agents requests.

This class thinly wraps an initial ListAgentsResponse object, and provides an __aiter__ method to iterate through its agents field.

If there are more pages, the __aiter__ method will make additional ListAgents requests and continue to iterate through the agents field on the corresponding responses.

All the usual ListAgentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListAgentsPager

A pager for iterating through list_agents requests.

This class thinly wraps an initial ListAgentsResponse object, and provides an __iter__ method to iterate through its agents field.

If there are more pages, the __iter__ method will make additional ListAgents requests and continue to iterate through the agents field on the corresponding responses.

All the usual ListAgentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListAppVersionsAsyncPager

A pager for iterating through list_app_versions requests.

This class thinly wraps an initial ListAppVersionsResponse object, and provides an __aiter__ method to iterate through its app_versions field.

If there are more pages, the __aiter__ method will make additional ListAppVersions requests and continue to iterate through the app_versions field on the corresponding responses.

All the usual ListAppVersionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListAppVersionsPager

A pager for iterating through list_app_versions requests.

This class thinly wraps an initial ListAppVersionsResponse object, and provides an __iter__ method to iterate through its app_versions field.

If there are more pages, the __iter__ method will make additional ListAppVersions requests and continue to iterate through the app_versions field on the corresponding responses.

All the usual ListAppVersionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListAppsAsyncPager

A pager for iterating through list_apps requests.

This class thinly wraps an initial ListAppsResponse object, and provides an __aiter__ method to iterate through its apps field.

If there are more pages, the __aiter__ method will make additional ListApps requests and continue to iterate through the apps field on the corresponding responses.

All the usual ListAppsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListAppsPager

A pager for iterating through list_apps requests.

This class thinly wraps an initial ListAppsResponse object, and provides an __iter__ method to iterate through its apps field.

If there are more pages, the __iter__ method will make additional ListApps requests and continue to iterate through the apps field on the corresponding responses.

All the usual ListAppsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListChangelogsAsyncPager

A pager for iterating through list_changelogs requests.

This class thinly wraps an initial ListChangelogsResponse object, and provides an __aiter__ method to iterate through its changelogs field.

If there are more pages, the __aiter__ method will make additional ListChangelogs requests and continue to iterate through the changelogs field on the corresponding responses.

All the usual ListChangelogsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListChangelogsPager

A pager for iterating through list_changelogs requests.

This class thinly wraps an initial ListChangelogsResponse object, and provides an __iter__ method to iterate through its changelogs field.

If there are more pages, the __iter__ method will make additional ListChangelogs requests and continue to iterate through the changelogs field on the corresponding responses.

All the usual ListChangelogsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListConversationsAsyncPager

A pager for iterating through list_conversations requests.

This class thinly wraps an initial ListConversationsResponse object, and provides an __aiter__ method to iterate through its conversations field.

If there are more pages, the __aiter__ method will make additional ListConversations requests and continue to iterate through the conversations field on the corresponding responses.

All the usual ListConversationsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListConversationsPager

A pager for iterating through list_conversations requests.

This class thinly wraps an initial ListConversationsResponse object, and provides an __iter__ method to iterate through its conversations field.

If there are more pages, the __iter__ method will make additional ListConversations requests and continue to iterate through the conversations field on the corresponding responses.

All the usual ListConversationsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListDeploymentsAsyncPager

A pager for iterating through list_deployments requests.

This class thinly wraps an initial ListDeploymentsResponse object, and provides an __aiter__ method to iterate through its deployments field.

If there are more pages, the __aiter__ method will make additional ListDeployments requests and continue to iterate through the deployments field on the corresponding responses.

All the usual ListDeploymentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListDeploymentsPager

A pager for iterating through list_deployments requests.

This class thinly wraps an initial ListDeploymentsResponse object, and provides an __iter__ method to iterate through its deployments field.

If there are more pages, the __iter__ method will make additional ListDeployments requests and continue to iterate through the deployments field on the corresponding responses.

All the usual ListDeploymentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListExamplesAsyncPager

A pager for iterating through list_examples requests.

This class thinly wraps an initial ListExamplesResponse object, and provides an __aiter__ method to iterate through its examples field.

If there are more pages, the __aiter__ method will make additional ListExamples requests and continue to iterate through the examples field on the corresponding responses.

All the usual ListExamplesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListExamplesPager

A pager for iterating through list_examples requests.

This class thinly wraps an initial ListExamplesResponse object, and provides an __iter__ method to iterate through its examples field.

If there are more pages, the __iter__ method will make additional ListExamples requests and continue to iterate through the examples field on the corresponding responses.

All the usual ListExamplesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListGuardrailsAsyncPager

A pager for iterating through list_guardrails requests.

This class thinly wraps an initial ListGuardrailsResponse object, and provides an __aiter__ method to iterate through its guardrails field.

If there are more pages, the __aiter__ method will make additional ListGuardrails requests and continue to iterate through the guardrails field on the corresponding responses.

All the usual ListGuardrailsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListGuardrailsPager

A pager for iterating through list_guardrails requests.

This class thinly wraps an initial ListGuardrailsResponse object, and provides an __iter__ method to iterate through its guardrails field.

If there are more pages, the __iter__ method will make additional ListGuardrails requests and continue to iterate through the guardrails field on the corresponding responses.

All the usual ListGuardrailsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListToolsAsyncPager

A pager for iterating through list_tools requests.

This class thinly wraps an initial ListToolsResponse object, and provides an __aiter__ method to iterate through its tools field.

If there are more pages, the __aiter__ method will make additional ListTools requests and continue to iterate through the tools field on the corresponding responses.

All the usual ListToolsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListToolsPager

A pager for iterating through list_tools requests.

This class thinly wraps an initial ListToolsResponse object, and provides an __iter__ method to iterate through its tools field.

If there are more pages, the __iter__ method will make additional ListTools requests and continue to iterate through the tools field on the corresponding responses.

All the usual ListToolsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListToolsetsAsyncPager

A pager for iterating through list_toolsets requests.

This class thinly wraps an initial ListToolsetsResponse object, and provides an __aiter__ method to iterate through its toolsets field.

If there are more pages, the __aiter__ method will make additional ListToolsets requests and continue to iterate through the toolsets field on the corresponding responses.

All the usual ListToolsetsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListToolsetsPager

A pager for iterating through list_toolsets requests.

This class thinly wraps an initial ListToolsetsResponse object, and provides an __iter__ method to iterate through its toolsets field.

If there are more pages, the __iter__ method will make additional ListToolsets requests and continue to iterate through the toolsets field on the corresponding responses.

All the usual ListToolsetsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

EvaluationServiceAsyncClient

EvaluationService exposes methods to perform evaluation for the CES app.

EvaluationServiceClient

EvaluationService exposes methods to perform evaluation for the CES app.

ListEvaluationDatasetsAsyncPager

A pager for iterating through list_evaluation_datasets requests.

This class thinly wraps an initial ListEvaluationDatasetsResponse object, and provides an __aiter__ method to iterate through its evaluation_datasets field.

If there are more pages, the __aiter__ method will make additional ListEvaluationDatasets requests and continue to iterate through the evaluation_datasets field on the corresponding responses.

All the usual ListEvaluationDatasetsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListEvaluationDatasetsPager

A pager for iterating through list_evaluation_datasets requests.

This class thinly wraps an initial ListEvaluationDatasetsResponse object, and provides an __iter__ method to iterate through its evaluation_datasets field.

If there are more pages, the __iter__ method will make additional ListEvaluationDatasets requests and continue to iterate through the evaluation_datasets field on the corresponding responses.

All the usual ListEvaluationDatasetsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListEvaluationExpectationsAsyncPager

A pager for iterating through list_evaluation_expectations requests.

This class thinly wraps an initial ListEvaluationExpectationsResponse object, and provides an __aiter__ method to iterate through its evaluation_expectations field.

If there are more pages, the __aiter__ method will make additional ListEvaluationExpectations requests and continue to iterate through the evaluation_expectations field on the corresponding responses.

All the usual ListEvaluationExpectationsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListEvaluationExpectationsPager

A pager for iterating through list_evaluation_expectations requests.

This class thinly wraps an initial ListEvaluationExpectationsResponse object, and provides an __iter__ method to iterate through its evaluation_expectations field.

If there are more pages, the __iter__ method will make additional ListEvaluationExpectations requests and continue to iterate through the evaluation_expectations field on the corresponding responses.

All the usual ListEvaluationExpectationsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListEvaluationResultsAsyncPager

A pager for iterating through list_evaluation_results requests.

This class thinly wraps an initial ListEvaluationResultsResponse object, and provides an __aiter__ method to iterate through its evaluation_results field.

If there are more pages, the __aiter__ method will make additional ListEvaluationResults requests and continue to iterate through the evaluation_results field on the corresponding responses.

All the usual ListEvaluationResultsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListEvaluationResultsPager

A pager for iterating through list_evaluation_results requests.

This class thinly wraps an initial ListEvaluationResultsResponse object, and provides an __iter__ method to iterate through its evaluation_results field.

If there are more pages, the __iter__ method will make additional ListEvaluationResults requests and continue to iterate through the evaluation_results field on the corresponding responses.

All the usual ListEvaluationResultsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListEvaluationRunsAsyncPager

A pager for iterating through list_evaluation_runs requests.

This class thinly wraps an initial ListEvaluationRunsResponse object, and provides an __aiter__ method to iterate through its evaluation_runs field.

If there are more pages, the __aiter__ method will make additional ListEvaluationRuns requests and continue to iterate through the evaluation_runs field on the corresponding responses.

All the usual ListEvaluationRunsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListEvaluationRunsPager

A pager for iterating through list_evaluation_runs requests.

This class thinly wraps an initial ListEvaluationRunsResponse object, and provides an __iter__ method to iterate through its evaluation_runs field.

If there are more pages, the __iter__ method will make additional ListEvaluationRuns requests and continue to iterate through the evaluation_runs field on the corresponding responses.

All the usual ListEvaluationRunsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListEvaluationsAsyncPager

A pager for iterating through list_evaluations requests.

This class thinly wraps an initial ListEvaluationsResponse object, and provides an __aiter__ method to iterate through its evaluations field.

If there are more pages, the __aiter__ method will make additional ListEvaluations requests and continue to iterate through the evaluations field on the corresponding responses.

All the usual ListEvaluationsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListEvaluationsPager

A pager for iterating through list_evaluations requests.

This class thinly wraps an initial ListEvaluationsResponse object, and provides an __iter__ method to iterate through its evaluations field.

If there are more pages, the __iter__ method will make additional ListEvaluations requests and continue to iterate through the evaluations field on the corresponding responses.

All the usual ListEvaluationsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListScheduledEvaluationRunsAsyncPager

A pager for iterating through list_scheduled_evaluation_runs requests.

This class thinly wraps an initial ListScheduledEvaluationRunsResponse object, and provides an __aiter__ method to iterate through its scheduled_evaluation_runs field.

If there are more pages, the __aiter__ method will make additional ListScheduledEvaluationRuns requests and continue to iterate through the scheduled_evaluation_runs field on the corresponding responses.

All the usual ListScheduledEvaluationRunsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListScheduledEvaluationRunsPager

A pager for iterating through list_scheduled_evaluation_runs requests.

This class thinly wraps an initial ListScheduledEvaluationRunsResponse object, and provides an __iter__ method to iterate through its scheduled_evaluation_runs field.

If there are more pages, the __iter__ method will make additional ListScheduledEvaluationRuns requests and continue to iterate through the scheduled_evaluation_runs field on the corresponding responses.

All the usual ListScheduledEvaluationRunsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

SessionServiceAsyncClient

Session service provides APIs for interacting with CES agents.

SessionServiceClient

Session service provides APIs for interacting with CES agents.

ToolServiceAsyncClient

Tool service provides APIs for interacting with CES tools.

ToolServiceClient

Tool service provides APIs for interacting with CES tools.

WidgetServiceAsyncClient

Provides APIs for widgets to interact with CES APIs.

WidgetServiceClient

Provides APIs for widgets to interact with CES APIs.

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

EntityOperation

Entity CRUD operation specification.

OperationType

The operation to perform on the entity.

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

AgentToolset

A toolset with a selection of its tools.

LlmAgent

Default agent type. The agent uses instructions and callbacks specified in the agent to perform the task using a large language model.

RemoteDialogflowAgent

The agent which will transfer execution to a remote Dialogflow CX <https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent>__ agent. The Dialogflow agent will process subsequent user queries until the session ends or flow ends, and the control is transferred back to the parent CES agent.

InputVariableMappingEntry

The abstract base class for a message.

OutputVariableMappingEntry

The abstract base class for a message.

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.

HallucinationMetrics

Metrics for hallucination results.

MetricsByAppVersion

Metrics aggregated per app version.

MetricsByTurn

Metrics aggregated per turn.

SemanticSimilarityMetrics

Metrics for semantic similarity results.

ToolCallLatencyMetrics

Metrics for tool call latency.

ToolMetrics

Metrics for a single tool.

TurnLatencyMetrics

Metrics for turn latency.

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

PrebuiltAmbientNoise

Prebuilt ambient noise.

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.

RequestLocation

The location of the API key in the request.

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.

MetadataEntry

The abstract base class for a message.

ToolExecutionMode

Defines the tool execution behavior if there are multiple tools being selected by the agent at the same time.

VariableDeclaration

Defines the structure and metadata for a variable.

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.

SynthesizeSpeechConfigsEntry

The abstract base class for a message.

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.

ChannelType

The type of the channel profile.

PersonaProperty

Represents the persona property of a channel.

Persona

The persona of the channel.

WebWidgetConfig

Message for configuration for the web widget.

Modality

Modality of the web widget.

SecuritySettings

Security settings for the web widget.

Theme

Theme of the web widget.

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.

CitedChunk

Piece of cited information.

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.

ChannelType

The channel type of the conversation.

InputType

Type of the input message.

Source

The source of the conversation.

Turn

All information about a single turn in the conversation.

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.

ConnectorConfig

The connector config for the data store connection.

DataStoreType

The type of the data store.

DocumentProcessingMode

The document processing mode of the data store.

DataStoreSettings

Data store related settings for the app.

Engine

An engine to which the data stores are connected. See Vertex AI Search:

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

Type

The type of the engine. See the documentation available at https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1/SolutionType and https://cloud.google.com/generative-ai-app-builder/docs/create-datastore-ingest.

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

BoostSpec

Boost specification to boost certain documents.

ConditionBoostSpec

Boost specification for a condition.

BoostControlSpec

Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above.

AttributeType

The attribute(or function) for which the custom ranking is to be applied.

ControlPoint

The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).

InterpolationType

The interpolation type to be applied. Default will be linear (Piecewise Linear).

BoostSpecs

Boost specifications to boost certain documents. For more information, please refer to https://cloud.google.com/generative-ai-app-builder/docs/boosting.

DataStoreSource

Configuration for searching within a specific DataStore.

EngineSource

Configuration for searching within an Engine, potentially targeting specific DataStores.

FilterParameterBehavior

Filter parameter behavior.

GroundingConfig

Grounding configuration.

ModalityConfig

If specified, will apply the given configuration for the specified modality.

ModalityType

The modality type.

RewriterConfig

Rewriter configuration.

SummarizationConfig

Summarization configuration.

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

Oauth2AuthCodeConfig

Oauth 2.0 Authorization Code authentication configuration.

Oauth2JwtBearerConfig

JWT Profile Oauth 2.0 Authorization Grant authentication configuration.

EndpointControlPolicy

Defines project/location level endpoint control policy.

EnforcementScope

Defines the scope in which this policy's allowed_origins list is enforced.

ErrorHandlingSettings

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

ErrorHandlingStrategy

Defines the strategy for handling errors.

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

Golden

The steps required to replay a golden conversation.

GoldenExpectation

Represents a single, checkable requirement.

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

GoldenTurn

A golden turn defines a single turn in a golden conversation.

Scenario

The config for a scenario

TaskCompletionBehavior

The expected behavior of the user task. This is used to determine whether the scenario is successful.

UserFact

Facts about the user as a key value pair.

UserGoalBehavior

The expected behavior of the user goal. This is used to determine whether the scenario is successful.

ScenarioExpectation

The expectation to evaluate the conversation produced by the simulation.

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

ToolExpectation

The tool call and response pair to be evaluated.

Step

A step defines a singular action to happen during the 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

EvaluationConfig

EvaluationConfig configures settings for running the evaluation.

EvaluationChannel

The channel to evaluate.

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.

ErrorType

The type of error

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

LlmCriteria

Configuration for LLM-based evaluation criteria.

EvaluationMetricsThresholds

Threshold settings for metrics in an Evaluation.

GoldenEvaluationMetricsThresholds

Settings for golden evaluations.

ExpectationLevelMetricsThresholds

Expectation level metrics thresholds.

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

TurnLevelMetricsThresholds

Turn level metrics thresholds.

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

SemanticSimilarityChannel

Semantic similarity channel to use.

HallucinationMetricBehavior

The hallucination metric behavior. Regardless of the behavior, the metric will always be calculated. The difference is that when disabled, the metric is not used to calculate the overall evaluation score.

ToolMatchingSettings

Settings for matching tool calls.

ExtraToolCallBehavior

Defines the behavior when an extra tool call is encountered. An extra tool call is a tool call that is present in the execution but does not match any tool call in the golden expectation.

EvaluationPersona

A persona represents an end user in an evaluation.

SpeechConfig

Configuration for Text-to-Speech generation.

BackgroundEnvironment

Simulated audio environment.

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

EvaluationExpectationResult

The result of a single evaluation expectation.

ExecutionState

The state of the evaluation result execution.

GoldenExpectationOutcome

Specifies the expectation and the result of that expectation.

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

ToolInvocationResult

The result of the tool invocation check.

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

GoldenResult

The result of a golden evaluation.

TurnReplayResult

The result of running a single turn of the golden conversation.

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

HallucinationResult

The result of the hallucination check for a single turn.

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

Outcome

The outcome of the evaluation or expectation.

OverallToolInvocationResult

The result of the overall tool invocation check.

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

ScenarioExpectationOutcome

The outcome of a scenario expectation.

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

ObservedToolCall

The observed tool call and response.

ScenarioResult

The outcome of a scenario evaluation.

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

ScenarioRubricOutcome

The outcome of the evaluation against the rubric.

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

SemanticSimilarityResult

The result of the semantic similarity check.

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

SpanLatency

The latency of a span execution.

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

Type

The type of span. Additional values may be added in the future.

TaskCompletionResult

The result of the task completion check for the conversation.

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

ToolCallLatency

The latency of a tool call execution.

UserGoalSatisfactionResult

The result of a user goal satisfaction check for a conversation.

.. _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.

EvaluationRunState

The state of the evaluation run.

EvaluationRunSummariesEntry

The abstract base class for a message.

EvaluationRunSummary

Contains the summary of passed and failed result counts for a specific evaluation in an evaluation run.

EvaluationType

The type of the evaluations in this run. Additional values may be added in the future.

Progress

The progress of the evaluation run.

EvaluationSettings

Settings for evaluation.

ScenarioConversationInitiator

Determines who starts the conversation in a scenario evaluation session.

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.

ExportFormat

Export format for the app.

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.

CorpusType

The type of the Vertex RAG corpus.

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

AppResources

The list of app resources generated by the LLM assistant.

Evaluations

The list of evaluations generated by the LLM assistant.

GenerateResultInfo

This provides additional information about the generated result.

Tools

The list of tools generated by the LLM assistant.

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.

PromptConfig

Prompt settings used by the model when processing or summarizing the google search results.

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

CodeCallback

Guardrail that blocks the conversation based on the code callbacks provided.

ContentFilter

Guardrail that bans certain content from being used in the conversation.

MatchType

Match type for the content filter.

LlmPolicy

Guardrail that blocks the conversation if the LLM response is considered violating the policy based on the LLM classification.

PolicyScope

Defines when to apply the policy check during the conversation.

LlmPromptSecurity

Guardrail that blocks the conversation if the input is considered unsafe based on the LLM classification.

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

DefaultSecuritySettings

Configuration for default system security settings.

ModelSafety

Model safety settings overrides. When this is set, it will override the default settings and trigger the guardrail if the response is considered unsafe.

HarmBlockThreshold

Probability based thresholds levels for blocking.

HarmCategory

Harm category.

SafetySetting

Safety setting.

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

ImportOptions

Configuration options for the app import process. These options control how the import behaves, particularly when conflicts arise with existing app data.

ConflictResolutionStrategy

Defines the strategy for handling conflicts when an app with the same ID already exists, or when imported resources (like Agents, Tools, etc.) have the same display names as existing resources within that app.

    - Resources (App, Agents, Tools, Examples, Guardrails,
      Toolsets) in the imported app that have the same display
      name as existing resources will overwrite the existing
      ones.
    - Imported resources with new display names will be created.
    - Existing resources that do not have a matching display
      name in the imported app will remain untouched.
OVERWRITE (2):
    Overwrite existing data with imported data. If an app with
    the same `app_id` already exists, its content will be
    overwritten with the imported app.

    - Existing resources (Agents, Tools, Examples, Guardrails,
      Toolsets) in the app will be deleted.
    - Imported resources will be created as new resources.

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

ConversationList

A list of conversation resource names.

ImportOptions

Configuration options for the evaluation import process. These options control how the import behaves, particularly when conflicts arise with existing evaluations data.

ConflictResolutionStrategy

Defines the strategy for handling conflicts when an evaluation with the same evaluation ID already exists in the app.

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.

CallbackLatency

Latency metrics for a single callback.

GuardrailLatency

Latency metrics for a single guardrail.

LatencyMetrics

Latency metrics for a component.

LlmCallLatency

Latency metrics for a single LLM call.

ToolLatency

Latency metrics for a single 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

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.

CustomHeadersEntry

The abstract base class for a message.

McpToolset

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

CustomHeadersEntry

The abstract base class for a message.

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.

OauthGrantType

OAuth grant types. Only client credential grant <https://oauth.net/2/grant-types/client-credentials>__ is supported.

Omnichannel

Represents an Omnichannel resource.

OmnichannelIntegrationConfig

OmnichannelIntegrationConfig contains all App integration configs.

CesAppConfig

Configs for CES app.

ChannelConfig

ChannelConfig contains config for various of app integration.

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

ChannelConfigsEntry

The abstract base class for a message.

RoutingConfig

Routing config specify how/who to route app events to a subscriber.

RoutingConfigsEntry

The abstract base class for a message.

SubscriberConfig

Configs of subscribers.

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

SubscriberConfigsEntry

The abstract base class for a message.

WhatsappConfig

How Omnichannel should receive/reply events from WhatsApp.

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.

OptimizationStatus

The status of the optimization 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.

AgentIssues

Issues identified for a single agent.

Issue

The issue identified.

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.

SchedulingConfig

Eval scheduling configuration details

Frequency

The frequencies evals can be run at

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

DefsEntry

The abstract base class for a message.

PropertiesEntry

The abstract base class for a message.

Type

OpenAPI data types.

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.

RemoteDialogflowQueryParameters

QueryParameters <https://cloud.google.com/dialogflow/cx/docs/reference/rpc/google.cloud.dialogflow.cx.v3#queryparameters> to send to the remote Dialogflow <https://cloud.google.com/dialogflow/cx/docs/concept/console-conversational-agents> agent when the session control is transferred to the remote agent.

WebhookHeadersEntry

The abstract base class for a message.

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

DiagnosticInfo

Contains execution details during the processing.

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.

CaCert

The CA certificate.

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

DeterministicTransfer

Deterministic transfer rule. When the condition evaluates to true, the transfer occurs.

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

Direction

The direction of the transfer.

DisablePlannerTransfer

A rule that prevents the planner from transferring to the target agent.

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

GenerativeAnswer

The agent will immediately respond with a generative answer.

RespondImmediately

The agent will immediately respond with a preconfigured response.

Response

Represents a response from the agent.

TransferAgent

The agent will transfer the conversation to a different agent.

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

DataMapping

Configuration for mapping data from a source tool to the widget's input parameters.

FieldMappingsEntry

The abstract base class for a message.

Mode

The strategy used to map data from the source tool to the widget.

WidgetType

All available widget types. New values may be added to this enum in the future.

Modules

pagers

API documentation for ces_v1.services.agent_service.pagers module.

pagers

API documentation for ces_v1beta.services.agent_service.pagers module.

pagers

API documentation for ces_v1beta.services.evaluation_service.pagers module.