## Index

- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentService` (interface)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.SessionService` (interface)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ToolService` (interface)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.WidgetService` (interface)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Action` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Action.EntityOperation` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Action.EntityOperation.OperationType` (enum)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Agent` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Agent.AgentToolset` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Agent.LlmAgent` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Agent.RemoteA2aAgent` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Agent.RemoteDialogflowAgent` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentCard` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentInterface` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentRegistryDeployment` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentSkill` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentTool` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentTransfer` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AmbientSoundConfig` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AmbientSoundConfig.PrebuiltAmbientNoise` (enum)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ApiAuthentication` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ApiKeyConfig` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ApiKeyConfig.RequestLocation` (enum)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.App` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.App.ToolExecutionMode` (enum)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.App.VariableDeclaration` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AppSnapshot` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AppVersion` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ArtifactChunk` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ArtifactChunk.State` (enum)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AssistantConfirmationRequest` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AssistantConfirmationRequest.Target` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AssistantConfirmationResponse` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AssistantSuggestion` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AssistantSuggestion.Icon` (enum)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AssistantSuggestion.LoadSession` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AssistantSuggestion.Source` (enum)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AudioEncoding` (enum)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AudioProcessingConfig` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AudioRecordingConfig` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.BargeInConfig` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.BatchDeleteConversationsRequest` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.BatchDeleteConversationsResponse` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.BearerTokenConfig` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.BidiSessionClientMessage` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.BidiSessionServerMessage` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.BigQueryExportSettings` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Blob` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Callback` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.CancelAssistantTurnRequest` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.CancelAssistantTurnResponse` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Changelog` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ChannelProfile` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ChannelProfile.ChannelType` (enum)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ChannelProfile.InstagramConfig` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ChannelProfile.PersonaProperty` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ChannelProfile.PersonaProperty.Persona` (enum)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ChannelProfile.WebWidgetConfig` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ChannelProfile.WebWidgetConfig.Modality` (enum)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ChannelProfile.WebWidgetConfig.SecuritySettings` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ChannelProfile.WebWidgetConfig.Theme` (enum)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ChannelProfile.WhatsAppConfig` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Chunk` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Citations` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Citations.CitedChunk` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Citations.InlineCitation` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ClientCertificateSettings` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ClientFunction` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.CloudLoggingSettings` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.CodeBlock` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ConnectorTool` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ConnectorToolset` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Conversation` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Conversation.ChannelType` (enum)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Conversation.InputType` (enum)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Conversation.Source` (enum)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Conversation.Turn` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ConversationLoggingSettings` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.CreateAgentRequest` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.CreateAppRequest` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.CreateAppVersionRequest` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.CreateDeploymentRequest` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.CreateExampleRequest` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.CreateGuardrailRequest` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.CreateToolRequest` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.CreateToolsetRequest` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.CustomVoiceSample` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.CustomVoiceSample.VoiceInstructionMode` (enum)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.CustomVoiceSample.Warning` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.CustomVoiceSample.Warning.WarningType` (enum)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.DashboardSettings` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.DataStore` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.DataStore.ConnectorConfig` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.DataStore.DataStoreType` (enum)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.DataStore.DocumentProcessingMode` (enum)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.DataStoreSettings` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.DataStoreSettings.Engine` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.DataStoreSettings.Engine.Type` (enum)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.DataStoreTool` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.DataStoreTool.BoostSpec` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.DataStoreTool.BoostSpec.ConditionBoostSpec` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType` (enum)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.InterpolationType` (enum)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.DataStoreTool.BoostSpecs` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.DataStoreTool.DataStoreSource` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.DataStoreTool.EngineSource` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.DataStoreTool.FilterParameterBehavior` (enum)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.DataStoreTool.GroundingConfig` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.DataStoreTool.ModalityConfig` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.DataStoreTool.ModalityConfig.ModalityType` (enum)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.DataStoreTool.RewriterConfig` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.DataStoreTool.SnippetsConfig` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.DataStoreTool.SummarizationConfig` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.DeleteAgentRequest` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.DeleteAppRequest` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.DeleteAppVersionRequest` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.DeleteConversationRequest` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.DeleteDeploymentRequest` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.DeleteExampleRequest` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.DeleteGuardrailRequest` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.DeleteToolRequest` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.DeleteToolsetRequest` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.DeployChannelResponse` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Deployment` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Deployment.Modality` (enum)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.EndSession` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.EndUserAuthConfig` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.EndUserAuthConfig.Oauth2AuthCodeConfig` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.EndUserAuthConfig.Oauth2JwtBearerConfig` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.EndpointControlPolicy` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.EndpointControlPolicy.EnforcementScope` (enum)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ErrorHandlingSettings` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ErrorHandlingSettings.EndSessionConfig` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ErrorHandlingSettings.ErrorHandlingStrategy` (enum)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ErrorHandlingSettings.FallbackResponseConfig` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.EvaluationMetricsThresholds` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.ExpectationLevelMetricsThresholds` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds.SemanticSimilarityChannel` (enum)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.EvaluationMetricsThresholds.HallucinationMetricBehavior` (enum)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.EvaluationMetricsThresholds.ToolMatchingSettings` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.EvaluationMetricsThresholds.ToolMatchingSettings.ExtraToolCallBehavior` (enum)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Event` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Example` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ExecuteToolRequest` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ExecuteToolResponse` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ExecutionType` (enum)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ExperimentConfig` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ExperimentConfig.State` (enum)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ExperimentConfig.VersionRelease` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ExperimentConfig.VersionRelease.TrafficAllocation` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ExportAppRequest` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ExportAppRequest.ExportFormat` (enum)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ExportAppResponse` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ExpressionCondition` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.FileSearchTool` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.FileSearchTool.CorpusType` (enum)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.GenerateChatTokenRequest` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.GenerateChatTokenResponse` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.GenerateOnboardingSuggestionsRequest` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.GenerateOnboardingSuggestionsResponse` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.GenerateOnboardingSuggestionsResponse.UserProfile` (enum)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.GetAgentRequest` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.GetAppRequest` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.GetAppVersionRequest` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.GetChangelogRequest` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.GetConversationRequest` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.GetDeploymentRequest` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.GetExampleRequest` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.GetGuardrailRequest` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.GetToolRequest` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.GetToolsetRequest` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.GoAway` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.GoogleSearchSuggestions` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.GoogleSearchTool` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.GoogleSearchTool.PromptConfig` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Guardrail` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Guardrail.CodeCallback` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Guardrail.ContentFilter` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Guardrail.ContentFilter.MatchType` (enum)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Guardrail.LlmPolicy` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Guardrail.LlmPolicy.PolicyScope` (enum)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Guardrail.LlmPromptSecurity` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Guardrail.LlmPromptSecurity.DefaultSecuritySettings` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Guardrail.ModelSafety` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Guardrail.ModelSafety.HarmBlockThreshold` (enum)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Guardrail.ModelSafety.HarmCategory` (enum)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Guardrail.ModelSafety.SafetySetting` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Guardrail.Supervisor` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Guardrail.Supervisor.DetectionMode` (enum)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Guardrail.Supervisor.Type` (enum)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Image` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ImportAppRequest` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ImportAppRequest.ImportOptions` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ImportAppRequest.ImportOptions.ConflictResolutionStrategy` (enum)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ImportAppResponse` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.InputAudioConfig` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.InstagramCredentials` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.InterruptionSignal` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.LanguageSettings` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ListAgentsRequest` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ListAgentsResponse` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ListAppVersionsRequest` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ListAppVersionsResponse` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ListAppsRequest` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ListAppsResponse` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ListChangelogsRequest` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ListChangelogsResponse` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ListConversationsRequest` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ListConversationsResponse` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ListDeploymentsRequest` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ListDeploymentsResponse` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ListExamplesRequest` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ListExamplesResponse` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ListGuardrailsRequest` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ListGuardrailsResponse` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ListToolsRequest` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ListToolsResponse` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ListToolsetsRequest` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ListToolsetsResponse` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.LoggingSettings` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.McpTool` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.McpTool.State` (enum)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.McpToolDefinition` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.McpToolOverride` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.McpToolset` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Message` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.MetricAnalysisSettings` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.MockConfig` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.MockConfig.UnmatchedToolCallBehavior` (enum)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.MockedToolCall` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ModelSettings` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ModelSettings.ThinkingLevel` (enum)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.OAuthConfig` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.OAuthConfig.OauthGrantType` (enum)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.OpenApiTool` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.OpenApiToolset` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.OperationCompletedEvent` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.OperationMetadata` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.OptionQuestionsChunk` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.OptionQuestionsChunk.Option` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.OptionQuestionsChunk.Question` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.OutputAudioConfig` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.PythonCodeCondition` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.PythonFunction` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.RecognitionResult` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.RedactionConfig` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.RemoteA2aConfig` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.RemoteAgentTool` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.RestoreAppVersionRequest` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.RestoreAppVersionResponse` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.RetrieveToolSchemaRequest` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.RetrieveToolSchemaResponse` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.RetrieveToolsRequest` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.RetrieveToolsResponse` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.RunSessionRequest` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.RunSessionResponse` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Schema` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Schema.Type` (enum)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.SecuritySettings` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ServiceAccountAuthConfig` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ServiceAgentIdTokenAuthConfig` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ServiceDirectoryConfig` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.SessionCheckpoint` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.SessionConfig` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.SessionConfig.RemoteDialogflowQueryParameters` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.SessionInput` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.SessionInput.RecordingControl` (enum)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.SessionOutput` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.SessionOutput.DiagnosticInfo` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Span` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.StreamChatAiAssistantRequest` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.StreamChatAiAssistantRequest.ClientCapability` (enum)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.StreamChatAiAssistantResponse` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.SynthesizeSpeechConfig` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.SystemTool` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.TimeZoneSettings` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.TlsConfig` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.TlsConfig.CaCert` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Tool` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ToolCall` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ToolCalls` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ToolFakeConfig` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ToolResponse` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ToolResponses` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Toolset` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ToolsetTool` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.TransferRule` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.TransferRule.DeterministicTransfer` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.TransferRule.Direction` (enum)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.TransferRule.DisablePlannerTransfer` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.TriggerAction` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.TriggerAction.GenerativeAnswer` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.TriggerAction.RespondImmediately` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.TriggerAction.Response` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.TriggerAction.TransferAgent` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.TurnCompletedEvent` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.TurnCompletedEvent.Reason` (enum)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.TurnHandoffEvent` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.TurnHandoffEvent.Reason` (enum)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.TurnMetadata` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.TurnMetadata.ContractStreamingPhase` (enum)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.TurnResumeSnapshot` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.UiEvent` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.UpdateAgentRequest` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.UpdateAppRequest` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.UpdateAppVersionRequest` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.UpdateDeploymentRequest` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.UpdateExampleRequest` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.UpdateGuardrailRequest` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.UpdateToolRequest` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.UpdateToolsetRequest` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.VpcScSettings` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.WebSearchQuery` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.WhatsAppCredentials` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.WidgetTool` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.WidgetTool.DataMapping` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.WidgetTool.DataMapping.Mode` (enum)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.WidgetTool.TextResponseConfig` (message)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.WidgetTool.TextResponseConfig.Type` (enum)
- `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.WidgetTool.WidgetType` (enum)

## AgentService

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

| BatchDeleteConversations |
|---|
| `` rpc BatchDeleteConversations(`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.BatchDeleteConversationsRequest`) returns (`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.longrunning#google.longrunning.Operation`) `` Batch deletes the specified conversations. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - ` https://www.googleapis.com/auth/ces` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `ces.conversations.delete` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| CreateAgent |
|---|
| `` rpc CreateAgent(`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.CreateAgentRequest`) returns (`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Agent`) `` Creates a new agent in the given app. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - ` https://www.googleapis.com/auth/ces` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `ces.agents.create` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| CreateApp |
|---|
| `` rpc CreateApp(`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.CreateAppRequest`) returns (`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.longrunning#google.longrunning.Operation`) `` Creates a new app in the given project and location. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - ` https://www.googleapis.com/auth/ces` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `ces.apps.create` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| CreateAppVersion |
|---|
| `` rpc CreateAppVersion(`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.CreateAppVersionRequest`) returns (`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AppVersion`) `` Creates a new app version in the given app. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - ` https://www.googleapis.com/auth/ces` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `ces.appVersions.create` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| CreateDeployment |
|---|
| `` rpc CreateDeployment(`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.CreateDeploymentRequest`) returns (`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Deployment`) `` Creates a new deployment in the given app. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - ` https://www.googleapis.com/auth/ces` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `ces.deployments.create` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| CreateExample |
|---|
| `` rpc CreateExample(`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.CreateExampleRequest`) returns (`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Example`) `` Creates a new example in the given app. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - ` https://www.googleapis.com/auth/ces` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `ces.examples.create` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| CreateGuardrail |
|---|
| `` rpc CreateGuardrail(`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.CreateGuardrailRequest`) returns (`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Guardrail`) `` Creates a new guardrail in the given app. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - ` https://www.googleapis.com/auth/ces` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `ces.guardrails.create` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| CreateTool |
|---|
| `` rpc CreateTool(`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.CreateToolRequest`) returns (`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Tool`) `` Creates a new tool in the given app. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - ` https://www.googleapis.com/auth/ces` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `ces.tools.create` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| CreateToolset |
|---|
| `` rpc CreateToolset(`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.CreateToolsetRequest`) returns (`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Toolset`) `` Creates a new toolset in the given app. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - ` https://www.googleapis.com/auth/ces` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `ces.toolsets.create` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| DeleteAgent |
|---|
| `` rpc DeleteAgent(`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.DeleteAgentRequest`) returns (`https://protobuf.dev/reference/protobuf/google.protobuf#empty`) `` Deletes the specified agent. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - ` https://www.googleapis.com/auth/ces` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `ces.agents.delete` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| DeleteApp |
|---|
| `` rpc DeleteApp(`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.DeleteAppRequest`) returns (`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.longrunning#google.longrunning.Operation`) `` Deletes the specified app. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - ` https://www.googleapis.com/auth/ces` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `ces.apps.delete` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| DeleteAppVersion |
|---|
| `` rpc DeleteAppVersion(`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.DeleteAppVersionRequest`) returns (`https://protobuf.dev/reference/protobuf/google.protobuf#empty`) `` Deletes the specified app version. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - ` https://www.googleapis.com/auth/ces` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `ces.appVersions.delete` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| DeleteConversation |
|---|
| `` rpc DeleteConversation(`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.DeleteConversationRequest`) returns (`https://protobuf.dev/reference/protobuf/google.protobuf#empty`) `` Deletes the specified conversation. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - ` https://www.googleapis.com/auth/ces` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `ces.conversations.delete` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| DeleteDeployment |
|---|
| `` rpc DeleteDeployment(`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.DeleteDeploymentRequest`) returns (`https://protobuf.dev/reference/protobuf/google.protobuf#empty`) `` Deletes the specified deployment. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - ` https://www.googleapis.com/auth/ces` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `ces.deployments.delete` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| DeleteExample |
|---|
| `` rpc DeleteExample(`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.DeleteExampleRequest`) returns (`https://protobuf.dev/reference/protobuf/google.protobuf#empty`) `` Deletes the specified example. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - ` https://www.googleapis.com/auth/ces` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `ces.examples.delete` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| DeleteGuardrail |
|---|
| `` rpc DeleteGuardrail(`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.DeleteGuardrailRequest`) returns (`https://protobuf.dev/reference/protobuf/google.protobuf#empty`) `` Deletes the specified guardrail. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - ` https://www.googleapis.com/auth/ces` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `ces.guardrails.delete` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| DeleteTool |
|---|
| `` rpc DeleteTool(`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.DeleteToolRequest`) returns (`https://protobuf.dev/reference/protobuf/google.protobuf#empty`) `` Deletes the specified tool. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - ` https://www.googleapis.com/auth/ces` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `ces.tools.delete` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| DeleteToolset |
|---|
| `` rpc DeleteToolset(`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.DeleteToolsetRequest`) returns (`https://protobuf.dev/reference/protobuf/google.protobuf#empty`) `` Deletes the specified toolset. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - ` https://www.googleapis.com/auth/ces` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `ces.toolsets.delete` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| ExportApp |
|---|
| `` rpc ExportApp(`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ExportAppRequest`) returns (`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.longrunning#google.longrunning.Operation`) `` Exports the specified app. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - ` https://www.googleapis.com/auth/ces` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `ces.apps.export` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| GetAgent |
|---|
| `` rpc GetAgent(`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.GetAgentRequest`) returns (`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Agent`) `` Gets details of the specified agent. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - ` https://www.googleapis.com/auth/ces` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `ces.agents.get` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| GetApp |
|---|
| `` rpc GetApp(`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.GetAppRequest`) returns (`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.App`) `` Gets details of the specified app. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - ` https://www.googleapis.com/auth/ces` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `ces.apps.get` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| GetAppVersion |
|---|
| `` rpc GetAppVersion(`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.GetAppVersionRequest`) returns (`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AppVersion`) `` Gets details of the specified app version. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - ` https://www.googleapis.com/auth/ces` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `ces.appVersions.get` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| GetChangelog |
|---|
| `` rpc GetChangelog(`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.GetChangelogRequest`) returns (`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Changelog`) `` Gets the specified changelog. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - ` https://www.googleapis.com/auth/ces` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `ces.changelogs.get` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| GetConversation |
|---|
| `` rpc GetConversation(`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.GetConversationRequest`) returns (`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Conversation`) `` Gets details of the specified conversation. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - ` https://www.googleapis.com/auth/ces` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `ces.conversations.get` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| GetDeployment |
|---|
| `` rpc GetDeployment(`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.GetDeploymentRequest`) returns (`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Deployment`) `` Gets details of the specified deployment. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - ` https://www.googleapis.com/auth/ces` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `ces.deployments.get` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| GetExample |
|---|
| `` rpc GetExample(`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.GetExampleRequest`) returns (`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Example`) `` Gets details of the specified example. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - ` https://www.googleapis.com/auth/ces` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `ces.examples.get` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| GetGuardrail |
|---|
| `` rpc GetGuardrail(`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.GetGuardrailRequest`) returns (`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Guardrail`) `` Gets details of the specified guardrail. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - ` https://www.googleapis.com/auth/ces` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `ces.guardrails.get` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| GetTool |
|---|
| `` rpc GetTool(`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.GetToolRequest`) returns (`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Tool`) `` Gets details of the specified tool. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - ` https://www.googleapis.com/auth/ces` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `ces.tools.get` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| GetToolset |
|---|
| `` rpc GetToolset(`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.GetToolsetRequest`) returns (`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Toolset`) `` Gets details of the specified toolset. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - ` https://www.googleapis.com/auth/ces` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `ces.toolsets.get` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| ImportApp |
|---|
| `` rpc ImportApp(`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ImportAppRequest`) returns (`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.longrunning#google.longrunning.Operation`) `` Imports the specified app. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - ` https://www.googleapis.com/auth/ces` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `ces.apps.import` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| ListAgents |
|---|
| `` rpc ListAgents(`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ListAgentsRequest`) returns (`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ListAgentsResponse`) `` Lists agents in the given app. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - ` https://www.googleapis.com/auth/ces` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `ces.agents.list` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| ListAppVersions |
|---|
| `` rpc ListAppVersions(`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ListAppVersionsRequest`) returns (`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ListAppVersionsResponse`) `` Lists all app versions in the given app. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - ` https://www.googleapis.com/auth/ces` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `ces.appVersions.list` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| ListApps |
|---|
| `` rpc ListApps(`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ListAppsRequest`) returns (`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ListAppsResponse`) `` Lists apps in the given project and location. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - ` https://www.googleapis.com/auth/ces` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `ces.apps.list` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| ListChangelogs |
|---|
| `` rpc ListChangelogs(`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ListChangelogsRequest`) returns (`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ListChangelogsResponse`) `` Lists the changelogs of the specified app. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - ` https://www.googleapis.com/auth/ces` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `ces.changelogs.list` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| ListConversations |
|---|
| `` rpc ListConversations(`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ListConversationsRequest`) returns (`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ListConversationsResponse`) `` Lists conversations in the given app. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - ` https://www.googleapis.com/auth/ces` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `ces.conversations.list` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| ListDeployments |
|---|
| `` rpc ListDeployments(`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ListDeploymentsRequest`) returns (`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ListDeploymentsResponse`) `` Lists deployments in the given app. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - ` https://www.googleapis.com/auth/ces` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `ces.deployments.list` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| ListExamples |
|---|
| `` rpc ListExamples(`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ListExamplesRequest`) returns (`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ListExamplesResponse`) `` Lists examples in the given app. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - ` https://www.googleapis.com/auth/ces` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `ces.examples.list` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| ListGuardrails |
|---|
| `` rpc ListGuardrails(`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ListGuardrailsRequest`) returns (`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ListGuardrailsResponse`) `` Lists guardrails in the given app. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - ` https://www.googleapis.com/auth/ces` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `ces.guardrails.list` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| ListTools |
|---|
| `` rpc ListTools(`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ListToolsRequest`) returns (`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ListToolsResponse`) `` Lists tools in the given app. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - ` https://www.googleapis.com/auth/ces` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `ces.tools.list` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| ListToolsets |
|---|
| `` rpc ListToolsets(`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ListToolsetsRequest`) returns (`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ListToolsetsResponse`) `` Lists toolsets in the given app. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - ` https://www.googleapis.com/auth/ces` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `ces.toolsets.list` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| RestoreAppVersion |
|---|
| `` rpc RestoreAppVersion(`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.RestoreAppVersionRequest`) returns (`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.longrunning#google.longrunning.Operation`) `` Restores the specified app version. This will create a new app version from the current draft app and overwrite the current draft with the specified app version. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - ` https://www.googleapis.com/auth/ces` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `ces.appVersions.restore` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| UpdateAgent |
|---|
| `` rpc UpdateAgent(`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.UpdateAgentRequest`) returns (`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Agent`) `` Updates the specified agent. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - ` https://www.googleapis.com/auth/ces` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `ces.agents.update` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| UpdateApp |
|---|
| `` rpc UpdateApp(`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.UpdateAppRequest`) returns (`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.App`) `` Updates the specified app. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - ` https://www.googleapis.com/auth/ces` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `ces.apps.update` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| UpdateAppVersion |
|---|
| `` rpc UpdateAppVersion(`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.UpdateAppVersionRequest`) returns (`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AppVersion`) `` Updates the specified app version. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - ` https://www.googleapis.com/auth/ces` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| UpdateDeployment |
|---|
| `` rpc UpdateDeployment(`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.UpdateDeploymentRequest`) returns (`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Deployment`) `` Updates the specified deployment. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - ` https://www.googleapis.com/auth/ces` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `ces.deployments.update` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| UpdateExample |
|---|
| `` rpc UpdateExample(`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.UpdateExampleRequest`) returns (`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Example`) `` Updates the specified example. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - ` https://www.googleapis.com/auth/ces` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `ces.examples.update` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| UpdateGuardrail |
|---|
| `` rpc UpdateGuardrail(`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.UpdateGuardrailRequest`) returns (`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Guardrail`) `` Updates the specified guardrail. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - ` https://www.googleapis.com/auth/ces` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `ces.guardrails.update` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| UpdateTool |
|---|
| `` rpc UpdateTool(`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.UpdateToolRequest`) returns (`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Tool`) `` Updates the specified tool. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - ` https://www.googleapis.com/auth/ces` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `ces.tools.update` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| UpdateToolset |
|---|
| `` rpc UpdateToolset(`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.UpdateToolsetRequest`) returns (`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Toolset`) `` Updates the specified toolset. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - ` https://www.googleapis.com/auth/ces` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `ces.toolsets.update` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

## SessionService

Session service provides APIs for interacting with CES agents.

| BidiRunSession |
|---|
| `` rpc BidiRunSession(`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.BidiSessionClientMessage`) returns (`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.BidiSessionServerMessage`) `` Establishes a bidirectional streaming connection with the CES agent. The agent processes continuous multimodal inputs (e.g., text, audio) and generates real-time multimodal output streams. --- Client Request Stream --- The client streams requests in the following order: 1. Initialization: The first message must contain `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.BidiSessionClientMessage.FIELDS.google.cloud.ces.v1.SessionConfig.google.cloud.ces.v1.BidiSessionClientMessage.config`. For audio sessions, this should also include `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.SessionConfig.FIELDS.google.cloud.ces.v1.InputAudioConfig.google.cloud.ces.v1.SessionConfig.input_audio_config` and `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.SessionConfig.FIELDS.google.cloud.ces.v1.OutputAudioConfig.google.cloud.ces.v1.SessionConfig.output_audio_config` to define audio processing and synthesis parameters. 2. Interaction: Subsequent messages stream `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.BidiSessionClientMessage.FIELDS.google.cloud.ces.v1.SessionInput.google.cloud.ces.v1.BidiSessionClientMessage.realtime_input` containing real-time user input data. 3. Termination: The client should half-close the stream when there is no more user input. It should also half-close upon receiving `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.BidiSessionServerMessage.FIELDS.google.cloud.ces.v1.EndSession.google.cloud.ces.v1.BidiSessionServerMessage.end_session` or `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.BidiSessionServerMessage.FIELDS.google.cloud.ces.v1.GoAway.google.cloud.ces.v1.BidiSessionServerMessage.go_away` from the agent. --- Server Response Stream --- For each interaction turn, the agent streams messages in the following sequence: 1. Speech Recognition (First N messages): Contains `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.BidiSessionServerMessage.FIELDS.google.cloud.ces.v1.RecognitionResult.google.cloud.ces.v1.BidiSessionServerMessage.recognition_result` representing the concatenated user speech segments captured so far. This is only populated for audio sessions. 2. Response (Next M messages): Contains `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.BidiSessionServerMessage.FIELDS.google.cloud.ces.v1.SessionOutput.google.cloud.ces.v1.BidiSessionServerMessage.session_output` delivering the agent's response in various modalities (e.g., text, audio). 3. Turn Completion (Final message of the turn): Contains `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.BidiSessionServerMessage.FIELDS.google.cloud.ces.v1.SessionOutput.google.cloud.ces.v1.BidiSessionServerMessage.session_output` with `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.SessionOutput.FIELDS.bool.google.cloud.ces.v1.SessionOutput.turn_completed` set to true. This signals the end of the current turn and includes `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.SessionOutput.FIELDS.google.cloud.ces.v1.SessionOutput.DiagnosticInfo.google.cloud.ces.v1.SessionOutput.diagnostic_info` with execution details. --- Audio Best Practices --- 1. Streaming: Stream `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.SessionInput.FIELDS.bytes.google.cloud.ces.v1.SessionInput.audio` **CONTINUOUSLY**, even during silence. Recommended chunk size: 40-120ms (balances latency vs. efficiency). 1. Playback \& Interruption: Play `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.SessionOutput.FIELDS.bytes.google.cloud.ces.v1.SessionOutput.audio` upon receipt. Stop playback immediately if an `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.BidiSessionServerMessage.FIELDS.google.cloud.ces.v1.InterruptionSignal.google.cloud.ces.v1.BidiSessionServerMessage.interruption_signal` is received (e.g., user barge-in or new agent response). Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - ` https://www.googleapis.com/auth/ces` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `session` resource: - `ces.sessions.bidiRunSession` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| CancelAssistantTurn |
|---|
| `` rpc CancelAssistantTurn(`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.CancelAssistantTurnRequest`) returns (`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.CancelAssistantTurnResponse`) `` Cancels the assistant session's in-flight turn, if any: the explicit user stop for a turn running detached from any stream. A cancel landing on a task that does not host the turn preempts it through the session turn epoch instead, ending it within one lease renewal. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - ` https://www.googleapis.com/auth/ces` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `ces.assistantSessions.get` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| GenerateOnboardingSuggestions |
|---|
| `` rpc GenerateOnboardingSuggestions(`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.GenerateOnboardingSuggestionsRequest`) returns (`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.GenerateOnboardingSuggestionsResponse`) `` Generates personalized onboarding suggestions for the Arc zero state: classifies the requesting user (new / exploring / returning) from their assistant-session history in the app and returns suggestion chips (resume a session, continue work, or start something new) to render before any message is sent. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - ` https://www.googleapis.com/auth/ces` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `ces.assistantSessions.list` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| RunSession |
|---|
| `` rpc RunSession(`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.RunSessionRequest`) returns (`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.RunSessionResponse`) `` Initiates a single-turn interaction with the CES agent within a session. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - ` https://www.googleapis.com/auth/ces` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `session` resource: - `ces.sessions.runSession` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| StreamChatAiAssistant |
|---|
| `` rpc StreamChatAiAssistant(`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.StreamChatAiAssistantRequest`) returns (`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.StreamChatAiAssistantResponse`) `` Runs Arc, the AI assistant, for the specified assistant session in a streaming fashion. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - ` https://www.googleapis.com/auth/ces` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `name` resource: - `ces.assistantSessions.get` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| StreamRunSession |
|---|
| `` rpc StreamRunSession(`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.RunSessionRequest`) returns (`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.RunSessionResponse`) `` Initiates a single-turn interaction with the CES agent. Uses server-side streaming to deliver incremental results and partial responses as they are generated. By default, complete responses (e.g., messages from callbacks or full LLM responses) are sent to the client as soon as they are available. To enable streaming individual text chunks directly from the model, set `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.SessionConfig.FIELDS.bool.google.cloud.ces.v1.SessionConfig.enable_text_streaming` to true. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - ` https://www.googleapis.com/auth/ces` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `session` resource: - `ces.sessions.runSession` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

## ToolService

Tool service provides APIs for interacting with CES tools.

| ExecuteTool |
|---|
| `` rpc ExecuteTool(`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ExecuteToolRequest`) returns (`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ExecuteToolResponse`) `` Executes the given tool with the given arguments. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - ` https://www.googleapis.com/auth/ces` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `ces.tools.execute` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| RetrieveToolSchema |
|---|
| `` rpc RetrieveToolSchema(`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.RetrieveToolSchemaRequest`) returns (`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.RetrieveToolSchemaResponse`) `` Retrieve the schema of the given tool. The schema is computed on the fly for the given instance of the tool. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - ` https://www.googleapis.com/auth/ces` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource: - `ces.tools.get` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

| RetrieveTools |
|---|
| `` rpc RetrieveTools(`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.RetrieveToolsRequest`) returns (`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.RetrieveToolsResponse`) `` Retrieve the list of tools included in the specified toolset. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - ` https://www.googleapis.com/auth/ces` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). IAM Permissions :   Requires the following [IAM](https://cloud.google.com/iam/docs) permission on the `toolset` resource: - `ces.toolsets.get` For more information, see the [IAM documentation](https://cloud.google.com/iam/docs). |

## WidgetService

Provides APIs for widgets to interact with CES APIs.

| GenerateChatToken |
|---|
| `` rpc GenerateChatToken(`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.GenerateChatTokenRequest`) returns (`https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.GenerateChatTokenResponse`) `` Generates a session scoped token for chat widget to authenticate with Session APIs. Authorization scopes :   Requires one of the following OAuth scopes: - `https://www.googleapis.com/auth/cloud-platform` - ` https://www.googleapis.com/auth/ces` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

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

| Fields ||
|---|---|
| `input_fields[]` | `string` Optional. Entity fields to use as inputs for the operation. If no fields are specified, all fields of the Entity will be used. |
| `output_fields[]` | `string` Optional. Entity fields to return from the operation. If no fields are specified, all fields of the Entity will be returned. |
| Union field `action_spec`. Specification for an action to configure for the tool to use. `action_spec` can be only one of the following: ||
| `connection_action_id` | `string` ID of a Connection action for the tool to use. |
| `entity_operation` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Action.EntityOperation` Entity operation configuration for the tool to use. |

## EntityOperation

Entity CRUD operation specification.

| Fields ||
|---|---|
| `entity_id` | `string` Required. ID of the entity. |
| `operation` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Action.EntityOperation.OperationType` Required. Operation to perform on the entity. |

## OperationType

The operation to perform on the entity.

| Enums ||
|---|---|
| `OPERATION_TYPE_UNSPECIFIED` | Operation type unspecified. Invalid, ConnectorTool create/update will fail. |
| `LIST` | List operation. |
| `GET` | Get operation. |
| `CREATE` | Create operation. |
| `UPDATE` | Update operation. |
| `DELETE` | Delete operation. |

## Agent

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

| Fields ||
|---|---|
| `name` | `string` Identifier. The unique identifier of the agent. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` |
| `display_name` | `string` Required. Display name of the agent. |
| `description` | `string` Optional. Human-readable description of the agent. |
| `model_settings` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ModelSettings` Optional. Configurations for the LLM model. |
| `instruction` | `string` Optional. Instructions for the LLM model to guide the agent's behavior. |
| `tools[]` | `string` Optional. List of available tools for the agent. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` |
| `child_agents[]` | `string` Optional. List of child agents in the agent tree. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` |
| `before_agent_callbacks[]` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Callback` Optional. The callbacks to execute before the agent is called. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped. |
| `after_agent_callbacks[]` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Callback` Optional. The callbacks to execute after the agent is called. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped. |
| `before_model_callbacks[]` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Callback` Optional. The callbacks to execute before the model is called. If there are multiple calls to the model, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped. |
| `after_model_callbacks[]` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Callback` Optional. The callbacks to execute after the model is called. If there are multiple calls to the model, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped. |
| `before_tool_callbacks[]` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Callback` Optional. The callbacks to execute before the tool is invoked. If there are multiple tool invocations, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped. |
| `after_tool_callbacks[]` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Callback` Optional. The callbacks to execute after the tool is invoked. If there are multiple tool invocations, the callback will be executed multiple times. The provided callbacks are executed sequentially in the exact order they are given in the list. If a callback returns an overridden response, execution stops and any remaining callbacks are skipped. |
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. Timestamp when the agent was created. |
| `update_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. Timestamp when the agent was last updated. |
| `guardrails[]` | `string` Optional. List of guardrails for the agent. Format: `projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}` |
| `etag` | `string` Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes. |
| `toolsets[]` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Agent.AgentToolset` Optional. List of toolsets for the agent. |
| `generated_summary` | `string` Output only. If the agent is generated by the LLM assistant, this field contains a descriptive summary of the generation. |
| `transfer_rules[]` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.TransferRule` Optional. Agent transfer rules. If multiple rules match, the first one in the list will be used. |
| `validation_errors[]` | `string` Output only. Misconfigurations or errors in the agent that may affect agent quality. |
| Union field `agent_type`. The type of agent. `agent_type` can be only one of the following: ||
| `llm_agent` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Agent.LlmAgent` Optional. The default agent type. |
| `remote_dialogflow_agent` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Agent.RemoteDialogflowAgent` Optional. The remote [Dialogflow](https://cloud.google.com/dialogflow/cx/docs/concept/console-conversational-agents) agent to be used for the agent execution. If this field is set, all other agent level properties will be ignored. Note: If the Dialogflow agent is in a different project from the app, you should grant `roles/dialogflow.client` to the CES service agent `service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com`. |
| `remote_a2a_agent` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Agent.RemoteA2aAgent` Optional. The remote [A2A](https://github.com/a2aproject/A2A) agent to be used for the agent execution. |

## AgentToolset

A toolset with a selection of its tools.

| Fields ||
|---|---|
| `toolset` | `string` Required. The resource name of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` |
| `tool_ids[]` | `string` Optional. The tools IDs to filter the toolset. |

## LlmAgent

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

## RemoteA2aAgent

The agent which will transfer execution to a remote [A2A](https://github.com/a2aproject/A2A) agent.

| Fields ||
|---|---|
| `a2a_config` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.RemoteA2aConfig` Required. The A2A connection configuration. |

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

| Fields ||
|---|---|
| `agent` | `string` Required. The [Dialogflow](https://docs.cloud.google.com/dialogflow/cx/docs/concept/agent) agent resource name. Format: `projects/{project}/locations/{location}/agents/{agent}` |
| `flow_id` | `string` Optional. The flow ID of the flow in the Dialogflow agent. |
| `environment_id` | `string` Optional. The environment ID of the Dialogflow agent to be used for the agent execution. If not specified, the draft environment will be used. |
| `input_variable_mapping` | `map<string, string>` Optional. The mapping of the app variables names to the Dialogflow session parameters names to be sent to the Dialogflow agent as input. |
| `output_variable_mapping` | `map<string, string>` Optional. The mapping of the Dialogflow session parameters names to the app variables names to be sent back to the CES agent after the Dialogflow agent execution ends. |
| `respect_response_interruption_settings` | `bool` Optional. Indicates whether to respect the message-level interruption settings configured in the Dialogflow agent. - If false: all response messages from the Dialogflow agent follow the app-level barge-in settings. - If true: only response messages with [`allow_playback_interruption`](https://docs.cloud.google.com/dialogflow/cx/docs/reference/rpc/google.cloud.dialogflow.cx.v3#text) set to true will be interruptable, all other messages follow the app-level barge-in settings. |
| `language_code_variable` | `string` Optional. The name of the variable that contains the language code to be used for the Dialogflow session. If unspecified, the default language code of the Dialogflow agent will be used. |

## AgentCard

AgentCard conveys key information about a remote agent. It is a trimmed version of the AgentCard defined in the A2A protocol <https://a2a-protocol.org/dev/specification/#441-agentcard>

| Fields ||
|---|---|
| `name` | `string` Required. A human-readable name for the agent. |
| `description` | `string` Required. A description of the agent's domain of action/solution space. |
| `supported_interfaces[]` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentInterface` Required. Ordered list of supported interfaces. The first entry is preferred. |
| `version` | `string` Required. The version of the agent. |
| `skills[]` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentSkill` Required. Skills represent a unit of ability an agent can perform. This may somewhat abstract but represents a more focused set of actions that the agent is highly likely to succeed at. |

## AgentInterface

Declares a combination of a target URL, transport and protocol version for interacting with the agent. This allows agents to expose the same functionality over multiple protocol binding mechanisms.

| Fields ||
|---|---|
| `url` | `string` Required. The URL where this interface is available. Must be a valid absolute HTTPS URL in production. Example: "https://api.example.com/a2a/v1", "https://grpc.example.com/a2a" |
| `protocol_binding` | `string` Required. The protocol binding supported at this URL. This is an open form string, to be easily extended for other protocol bindings. The core ones officially supported are `JSONRPC`, `GRPC` and `HTTP+JSON`. |
| `tenant` | `string` Tenant ID to be used in the request when calling the agent. |
| `protocol_version` | `string` Required. The version of the A2A protocol this interface exposes. Use the latest supported minor version per major version. Examples: "0.3", "1.0" |

## AgentRegistryDeployment

Configuration and status for Agent Registry deployment.

| Fields ||
|---|---|
| `agent_registry_service_name` | `string` Optional. Output only. The resource name of the deployed Agent Registry service. Format: `projects/{project}/locations/{location}/services/{service}` |

## AgentSkill

Represents a distinct capability or function that an agent can perform.

| Fields ||
|---|---|
| `id` | `string` Required. A unique identifier for the agent's skill. |
| `name` | `string` Required. A human-readable name for the skill. |
| `description` | `string` Required. A detailed description of the skill. |
| `tags[]` | `string` Required. A set of keywords describing the skill's capabilities. |
| `examples[]` | `string` Example prompts or scenarios that this skill can handle. |
| `input_modes[]` | `string` The set of supported input media types for this skill, overriding the agent's defaults. |
| `output_modes[]` | `string` The set of supported output media types for this skill, overriding the agent's defaults. |

## AgentTool

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

| Fields ||
|---|---|
| `name` | `string` Required. The name of the agent tool. |
| `description` | `string` Optional. Description of the tool's purpose. |
| `agent` | `string` Optional. The resource name of the agent that is the entry point of the tool. Format: `projects/{project}/locations/{location}/agents/{agent}` |

## AgentTransfer

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

| Fields ||
|---|---|
| `target_agent` | `string` Required. The agent to which the conversation is being transferred. The agent will handle the conversation from this point forward. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` |
| `display_name` | `string` Output only. Display name of the agent. |

## AmbientSoundConfig

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

| Fields ||
|---|---|
| `volume_gain_db` | `double` Optional. Volume gain (in dB) of the normal native volume supported by ambient noise, in the range \[-96.0, 16.0\]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. We strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that. |
| Union field `source`. Ambient noise to be played with the synthesized agent response, to enhance the naturalness of the conversation. `source` can be only one of the following: ||
| `prebuilt_ambient_noise (deprecated)` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AmbientSoundConfig.PrebuiltAmbientNoise` > [!WARNING] > This item is deprecated! Optional. Deprecated: `prebuilt_ambient_noise` is deprecated in favor of `prebuilt_ambient_sound`. |
| `gcs_uri` | `string` Optional. Ambient noise as a mono-channel, 16kHz WAV file stored in [Cloud Storage](https://cloud.google.com/storage). Note: Please make sure the CES service agent `service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com` has `storage.objects.get` permission to the Cloud Storage object. |
| `prebuilt_ambient_sound` | `string` Optional. Name of the prebuilt ambient sound. Valid values are: - "coffee_shop" - "keyboard" - "keypad" - "hum" - "office_1" - "office_2" - "office_3" - "room_1" - "room_2" - "room_3" - "room_4" - "room_5" - "air_conditioner" |

## PrebuiltAmbientNoise

Prebuilt ambient noise.

| Enums ||
|---|---|
| `PREBUILT_AMBIENT_NOISE_UNSPECIFIED` | Not specified. |
| `RETAIL_STORE` | Ambient noise of a retail store. |
| `CONVENTION_HALL` | Ambient noise of a convention hall. |
| `OUTDOOR` | Ambient noise of a street. |

## ApiAuthentication

Authentication information required for API calls.

| Fields ||
|---|---|
| Union field `auth_config`. The auth configuration. `auth_config` can be only one of the following: ||
| `api_key_config` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ApiKeyConfig` Optional. Config for API key auth. |
| `oauth_config` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.OAuthConfig` Optional. Config for OAuth. |
| `service_agent_id_token_auth_config` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ServiceAgentIdTokenAuthConfig` Optional. Config for ID token auth generated from CES service agent. |
| `service_account_auth_config` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ServiceAccountAuthConfig` Optional. Config for service account authentication. |
| `bearer_token_config` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.BearerTokenConfig` Optional. Config for bearer token auth. |

## ApiKeyConfig

Configurations for authentication with API key.

| Fields ||
|---|---|
| `key_name` | `string` Required. The parameter name or the header name of the API key. E.g., If the API request is "https://example.com/act?X-Api-Key=", "X-Api-Key" would be the parameter name. |
| `api_key_secret_version` | `string` Required. The name of the SecretManager secret version resource storing the API key. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com`. |
| `request_location` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ApiKeyConfig.RequestLocation` Required. Key location in the request. |

## RequestLocation

The location of the API key in the request.

| Enums ||
|---|---|
| `REQUEST_LOCATION_UNSPECIFIED` | Unspecified. This value should not be used. |
| `HEADER` | Represents the key in http header. |
| `QUERY_STRING` | Represents the key in query string. |

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

| Fields ||
|---|---|
| `name` | `string` Identifier. The unique identifier of the app. Format: `projects/{project}/locations/{location}/apps/{app}` |
| `display_name` | `string` Required. Display name of the app. |
| `description` | `string` Optional. Human-readable description of the app. |
| `pinned` | `bool` Optional. Whether the app is pinned in the app list. |
| `root_agent` | `string` Optional. The root agent is the entry point of the app. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` |
| `language_settings` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.LanguageSettings` Optional. Language settings of the app. |
| `time_zone_settings` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.TimeZoneSettings` Optional. TimeZone settings of the app. |
| `audio_processing_config` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AudioProcessingConfig` Optional. Audio processing configuration of the app. |
| `logging_settings` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.LoggingSettings` Optional. Logging settings of the app. |
| `error_handling_settings` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ErrorHandlingSettings` Optional. Error handling settings of the app. |
| `model_settings` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ModelSettings` Optional. The default LLM model settings for the app. Individual resources (e.g. agents, guardrails) can override these configurations as needed. |
| `tool_execution_mode` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.App.ToolExecutionMode` Optional. The tool execution mode for the app. If not provided, will default to PARALLEL. |
| `evaluation_metrics_thresholds` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.EvaluationMetricsThresholds` Optional. The evaluation thresholds for the app. |
| `variable_declarations[]` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.App.VariableDeclaration` Optional. The declarations of the variables. |
| `predefined_variable_declarations[]` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.App.VariableDeclaration` Output only. The declarations of predefined variables for the app. |
| `global_instruction` | `string` Optional. Instructions for all the agents in the app. You can use this instruction to set up a stable identity or personality across all the agents. |
| `guardrails[]` | `string` Optional. List of guardrails for the app. Format: `projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}` |
| `data_store_settings` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.DataStoreSettings` Optional. The data store settings for the app. |
| `default_channel_profile` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ChannelProfile` Optional. The default channel profile used by the app. |
| `metadata` | `map<string, string>` Optional. Metadata about the app. This field can be used to store additional information relevant to the app's details or intended usages. |
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. Timestamp when the app was created. |
| `update_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. Timestamp when the app was last updated. |
| `etag` | `string` Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes. |
| `deployment_count` | `int32` Output only. Number of deployments in the app. |
| `client_certificate_settings` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ClientCertificateSettings` Optional. The default client certificate settings for the app. |
| `vpc_sc_settings` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.VpcScSettings` Optional. VPC-SC settings for the app. |
| `locked` | `bool` Optional. Indicates whether the app is locked for changes. If the app is locked, modifications to the app resources will be rejected. |
| `validation_errors[]` | `string` Output only. Misconfigurations or warnings in the app. |
| `dashboard_settings` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.DashboardSettings` Optional. App-specific dashboard settings for linking and configuring Contact Center Insights dashboards. |

## ToolExecutionMode

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

| Enums ||
|---|---|
| `TOOL_EXECUTION_MODE_UNSPECIFIED` | Unspecified tool execution mode. Default to PARALLEL. |
| `PARALLEL` | If there are multiple tools being selected, they will be executed in parallel, with the same [ToolContext](https://google.github.io/adk-docs/context/#the-different-types-of-context). |
| `SEQUENTIAL` | If there are multiple tools being selected, they will be executed sequentially. The next tool will only be executed after the previous tool completes and it can see updated [ToolContext](https://google.github.io/adk-docs/context/#the-different-types-of-context) from the previous tool. |

## VariableDeclaration

Defines the structure and metadata for a variable.

| Fields ||
|---|---|
| `name` | `string` Required. The name of the variable. The name must start with a letter or underscore and contain only letters, numbers, or underscores. |
| `description` | `string` Required. The description of the variable. |
| `schema` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Schema` Required. The schema of the variable. |

## AppSnapshot

A snapshot of the app.

| Fields ||
|---|---|
| `app` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.App` Optional. The basic settings for the app. |
| `agents[]` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Agent` Optional. List of agents in the app. |
| `tools[]` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Tool` Optional. List of tools in the app. |
| `examples[]` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Example` Optional. List of examples in the app. |
| `guardrails[]` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Guardrail` Optional. List of guardrails in the app. |
| `toolsets[]` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Toolset` Optional. List of toolsets in 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.

| Fields ||
|---|---|
| `name` | `string` Identifier. The unique identifier of the app version. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}` |
| `display_name` | `string` Optional. The display name of the app version. |
| `description` | `string` Optional. The description of the app version. |
| `creator` | `string` Output only. Email of the user who created the app version. |
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. Timestamp when the app version was created. |
| `update_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. Timestamp when the app version was last updated. |
| `snapshot` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AppSnapshot` Output only. The snapshot of the app when the version is created. |
| `etag` | `string` Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes. |

## ArtifactChunk

A streamed fragment of a document artifact (e.g. a markdown TDD) that the assistant is generating. Content deltas stream while the document is being written so clients can render a live preview; the FINALIZED chunk carries the Cloud Storage URI once the file has been persisted.

| Fields ||
|---|---|
| `artifact_id` | `string` Identifier of the artifact, stable across all chunks of one artifact within the stream. |
| `display_name` | `string` The file name shown to the user, e.g. "hotel_booking_tdd.md". Set on STARTED (and repeated on FINALIZED). |
| `mime_type` | `string` The IANA media type of the artifact content, e.g. "text/markdown". |
| `content_delta` | `string` Incremental artifact content. Set on DELTA chunks. |
| `gcs_uri` | `string` The Cloud Storage object the artifact was persisted to. Set on FINALIZED chunks. |
| `state` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ArtifactChunk.State` Lifecycle position of this chunk. |
| `target_app` | `string` Output only. The app this artifact was produced for, when it was produced for one. Format: `projects/{project}/locations/{location}/apps/{app}` |

## State

Lifecycle position of this chunk within the artifact's stream.

| Enums ||
|---|---|
| `STATE_UNSPECIFIED` | Unused default. |
| `STARTED` | The assistant started generating the artifact. |
| `DELTA` | A content increment; content_delta is set. |
| `FINALIZED` | The artifact was persisted; gcs_uri is set. |
| `FAILED` | Generation or persistence failed; the artifact was not saved. |
| `CLOSED` | The document finished streaming: its content was fully delivered via content_delta chunks. Persistence may still follow; a FINALIZED chunk with a gcs_uri is sent if and when the artifact is saved. |

## AssistantConfirmationRequest

A blocking question or confirmation the assistant needs answered before an agent action can proceed. The requesting agent is paused and resumes only when the answer arrives on a later `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.StreamChatAiAssistantRequest.FIELDS.google.cloud.ces.v1.AssistantConfirmationResponse.google.cloud.ces.v1.StreamChatAiAssistantRequest.confirmation_response`.

| Fields ||
|---|---|
| `confirmation_id` | `string` Identifier correlating this request with its response. Opaque to clients; must be echoed verbatim on the answering request. |
| `context` | `string` Context describing what is being confirmed (e.g. the action the agent wants to take, or the question it needs answered). Rendered as plain text, not Markdown. |
| `positive_label` | `string` Label for the approving action of a binary confirmation (e.g. "Publish"). Unset when `questions` is populated. |
| `negative_label` | `string` Label for the declining action of a binary confirmation (e.g. "Not yet"). Unset when `questions` is populated. |
| `questions[]` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.OptionQuestionsChunk.Question` Multi-choice form of the confirmation. When populated, the card renders a selectable option list and the chosen option's submit_text (or free-form user text) is returned as `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AssistantConfirmationResponse.FIELDS.string.google.cloud.ces.v1.AssistantConfirmationResponse.answer_text`. |
| `tool` | `string` Name of the tool call the agent paused on (e.g. "update_app"), for the card header. Unset for pure questions. |
| `agent_name` | `string` Display label of the agent that raised the confirmation (e.g. `"Contract Architect"`), for the card header. |
| `expire_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Time after which this confirmation can no longer be answered. An expired card renders as inactive, and the server declines the confirmation on the next turn so the paused agent does not wait indefinitely. |
| `targets[]` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AssistantConfirmationRequest.Target` Everything the confirmed action will change, so the console can render "Update 2 apps" and one badge per app. Empty for legacy single-target cards. |

## Target

One resource the confirmed action will change.

| Fields ||
|---|---|
| `resource` | `string` The resource that will change, as a full resource name. |
| `display_name` | `string` Display name of the resource or app, for the card. |
| `action` | `string` The action, e.g. `CREATE`, `UPDATE`, `DELETE`, `COPY`, `LINK`. |
| `target_app` | `string` The app the resource belongs to, or empty for a location-scoped action such as creating an app. Format: `projects/{project}/locations/{location}/apps/{app}` |

## AssistantConfirmationResponse

The user's answer to an `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AssistantConfirmationRequest`, sent on the next `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.SessionService.StreamChatAiAssistant` call to resume the paused agent.

| Fields ||
|---|---|
| `confirmation_id` | `string` The `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AssistantConfirmationRequest.FIELDS.string.google.cloud.ces.v1.AssistantConfirmationRequest.confirmation_id` being answered. |
| Union field `response`. The user's answer. `response` can be only one of the following: ||
| `confirmed` | `bool` Binary answer: true approves the paused action, false declines it. |
| `answer_text` | `string` The chosen option's submit_text, or free-form user text. The paused action is cancelled and the text is handed to the agent to act on. |

## AssistantSuggestion

A single personalized onboarding suggestion chip for Arc's zero state.

| Fields ||
|---|---|
| `suggestion_id` | `string` Stable identifier for this suggestion, round-tripped by clients in interaction logging. |
| `label` | `string` Chip label shown to the user (at most 60 characters). |
| `rationale` | `string` Optional short explanation of why this suggestion is shown (tooltip / rationale popover). |
| `icon` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AssistantSuggestion.Icon` Icon hint for the chip. |
| `source` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AssistantSuggestion.Source` How this suggestion was produced. |
| `candidate_type` | `string` Rule-table candidate type in kebab-case (e.g. "resume-pending-review"), for metrics. |
| Union field `action`. What activating the chip does. `action` can be only one of the following: ||
| `seed_prompt` | `string` Prefill the composer with this text; the user reviews and sends. |
| `load_session` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AssistantSuggestion.LoadSession` Open an existing assistant session. |
| `send_message` | `string` Prefill the composer with this text and submit immediately. Only used for quick-reply chips inside an active onboarding conversation. |

## Icon

Icon hint for the chip.

| Enums ||
|---|---|
| `ICON_UNSPECIFIED` | Unspecified icon. |
| `RESUME` | Resume a previous session. |
| `BUILD` | Build something new. |
| `EVALUATE` | Evaluation-related suggestion. |
| `DEPLOY` | Deployment-related suggestion. |
| `EXPLORE` | Exploration / discovery suggestion. |
| `FIX` | Fix an error or failing state. |

## LoadSession

Parameters for the load_session action.

| Fields ||
|---|---|
| `assistant_session_id` | `string` Identifier of the assistant session to open (the final segment of the AssistantSession resource name). |

## Source

How this suggestion was produced.

| Enums ||
|---|---|
| `SOURCE_UNSPECIFIED` | Unspecified source. |
| `RULE` | Deterministic rule-table candidate with template phrasing. |
| `LLM_RANKED` | Rule-table candidate re-ranked and phrased by the LLM phrasing step. |

## AudioEncoding

AudioEncoding specifies the encoding format for audio data.

| Enums ||
|---|---|
| `AUDIO_ENCODING_UNSPECIFIED` | Unspecified audio encoding. |
| `LINEAR16` | 16-bit linear PCM audio encoding. |
| `MULAW` | 8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law. |
| `ALAW` | 8-bit samples that compand 14-bit audio samples using G.711 PCMU/A-law. |

## AudioProcessingConfig

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

| Fields ||
|---|---|
| `synthesize_speech_configs` | ``map<string, `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.SynthesizeSpeechConfig`>`` Optional. Configuration of how the agent response should be synthesized, mapping from the language code to `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.SynthesizeSpeechConfig`. If the configuration for the specified language code is not found, the configuration for the root language code will be used. For example, if the map contains "en-us" and "en", and the specified language code is "en-gb", then "en" configuration will be used. Note: Language code is case-insensitive. |
| `barge_in_config` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.BargeInConfig` Optional. Configures the agent behavior for the user barge-in activities. |
| `inactivity_timeout` | `https://protobuf.dev/reference/protobuf/google.protobuf#duration` Optional. The duration of user inactivity (no speech or interaction) before the agent prompts the user for reengagement. If not set, the agent will not prompt the user for reengagement. |
| `ambient_sound_config` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AmbientSoundConfig` Optional. Configuration for the ambient sound to be played with the synthesized agent response, to enhance the naturalness of the conversation. |
| `custom_voice_samples[]` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.CustomVoiceSample` Optional. Configures custom voice samples for voice cloning. |

## AudioRecordingConfig

Configuration for how the audio interactions should be recorded.

| Fields ||
|---|---|
| `gcs_bucket` | `string` Optional. The [Cloud Storage](https://cloud.google.com/storage) bucket to store the session audio recordings. The URI must start with "gs://". Please choose a bucket location that meets your data residency requirements. Note: If the Cloud Storage bucket is in a different project from the app, you should grant `storage.objects.create` permission to the CES service agent `service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com`. |
| `gcs_path_prefix` | `string` Optional. The Cloud Storage path prefix for audio recordings. This prefix can include the following placeholders, which will be dynamically substituted at serving time: - $project: project ID - $location: app location - $app: app ID - $date: session date in YYYY-MM-DD format - $session: session ID If the path prefix is not specified, the default prefix `$project/$location/$app/$date/$session/` will be used. |

## BargeInConfig

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

| Fields ||
|---|---|
| `disable_barge_in (deprecated)` | `bool` > [!WARNING] > This item is deprecated! Optional. Deprecated: `disable_barge_in` is deprecated in favor of `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ChannelProfile.FIELDS.bool.google.cloud.ces.v1.ChannelProfile.disable_barge_in_control` in ChannelProfile. Disables user barge-in while the agent is speaking. If true, user input during agent response playback will be ignored. |
| `barge_in_awareness` | `bool` Optional. If enabled, the agent will adapt its next response based on the assumption that the user hasn't heard the full preceding agent message. This should not be used in scenarios where agent responses are displayed visually. |

## BatchDeleteConversationsRequest

Request message for `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentService.BatchDeleteConversations`.

| Fields ||
|---|---|
| `parent` | `string` Required. The resource name of the app to delete conversations from. Format: `projects/{project}/locations/{location}/apps/{app}` |
| `conversations[]` | `string` Required. The resource names of the conversations to delete. |

## BatchDeleteConversationsResponse

Response message for `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentService.BatchDeleteConversations`.

| Fields ||
|---|---|
| `deleted_conversations[]` | `string` The list of conversations that were successfully deleted. |
| `failed_conversations[]` | `string` The list of conversations that failed to be deleted. |
| `error_messages[]` | `string` Optional. A list of error messages associated with conversations that failed to be deleted. |

## BearerTokenConfig

Configurations for authentication with a bearer token.

| Fields ||
|---|---|
| `token` | `string` Required. The bearer token. Must be in the format `$context.variables.<name_of_variable>`. |

## BidiSessionClientMessage

The top-level message sent by the client for the `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.SessionService.BidiRunSession` method.

| Fields ||
|---|---|
| Union field `message_type`. The type of the message. `message_type` can be only one of the following: ||
| `config` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.SessionConfig` Optional. The initial config message for the session. |
| `realtime_input` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.SessionInput` Optional. Realtime input for the session. |

## BidiSessionServerMessage

The top-level message returned from `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.SessionService.BidiRunSession` method.

| Fields ||
|---|---|
| Union field `message_type`. The type of the message. `message_type` can be only one of the following: ||
| `session_output` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.SessionOutput` Optional. Processing result from the CES agent. |
| `recognition_result` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.RecognitionResult` Optional. Realtime speech recognition result for the audio input. |
| `interruption_signal` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.InterruptionSignal` Optional. Indicates the agent's audio response has been interrupted. |
| `end_session` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.EndSession` Optional. Indicates that the session has ended. |
| `go_away` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.GoAway` Optional. Indicates that the server will disconnect soon and the client should half-close and restart the connection. |

## BigQueryExportSettings

Settings to describe the BigQuery export behaviors for the app.

| Fields ||
|---|---|
| `enabled` | `bool` Optional. Indicates whether the BigQuery export is enabled. |
| `project` | `string` Optional. The **project ID** of the BigQuery dataset to export the data to. Note: If the BigQuery dataset is in a different project from the app, you should grant `roles/bigquery.admin` role to the CES service agent `service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com`. |
| `dataset` | `string` Optional. The BigQuery **dataset ID** to export the data to. |

## Blob

Represents a blob input or output in the conversation.

| Fields ||
|---|---|
| `mime_type` | `string` Required. The IANA standard MIME type of the source data. |
| `data` | `bytes` Required. Raw bytes of the blob. |

## Callback

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

| Fields ||
|---|---|
| `description` | `string` Optional. Human-readable description of the callback. |
| `disabled` | `bool` Optional. Whether the callback is disabled. Disabled callbacks are ignored by the agent. |
| `proactive_execution_enabled` | `bool` Optional. If enabled, the callback will also be executed on intermediate model outputs. This setting only affects after model callback. **ENABLE WITH CAUTION**. Typically after model callback only needs to be executed after receiving all model responses. Enabling proactive execution may have negative implication on the execution cost and latency, and should only be enabled in rare situations. |
| Union field `callback`. The callback to execute. `callback` can be only one of the following: ||
| `python_code` | `string` Required. The python code to execute for the callback. |

## CancelAssistantTurnRequest

Request to cancel an assistant session's in-flight turn.

| Fields ||
|---|---|
| `name` | `string` Required. The assistant session whose in-flight turn to cancel. |
| `turn_id` | `string` Optional. The turn to cancel; empty cancels whichever turn is running. A cancel naming a turn that is no longer the running one is a no-op. |

## CancelAssistantTurnResponse

Response for CancelAssistantTurn.

| Fields ||
|---|---|
| `cancelled` | `bool` Whether an in-flight turn was found and asked to stop (directly on this task, or through an epoch preemption for a turn hosted elsewhere). |

## Changelog

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

| Fields ||
|---|---|
| `name` | `string` Identifier. The unique identifier of the changelog. Format: `projects/{project}/locations/{location}/apps/{app}/changelogs/{changelog}` |
| `author` | `string` Output only. Email address of the change author. |
| `display_name` | `string` Output only. Display name of the change. It typically should be the display name of the resource that was changed. |
| `description` | `string` Output only. Description of the change. which typically captures the changed fields in the resource. |
| `resource` | `string` Output only. The resource that was changed. |
| `resource_type` | `string` Output only. The type of the resource that was changed. |
| `action` | `string` Output only. The action that was performed on the resource. |
| `original_resource` | `https://protobuf.dev/reference/protobuf/google.protobuf#struct` Output only. The original resource before the change. |
| `new_resource` | `https://protobuf.dev/reference/protobuf/google.protobuf#struct` Output only. The new resource after the change. |
| `dependent_resources[]` | `https://protobuf.dev/reference/protobuf/google.protobuf#struct` Output only. The dependent resources that were changed. |
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. The time when the change was made. |
| `sequence_number` | `int64` Output only. The monotonically increasing sequence number of the changelog. |

## ChannelProfile

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

| Fields ||
|---|---|
| `profile_id` | `string` Optional. The unique identifier of the channel profile. |
| `channel_type` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ChannelProfile.ChannelType` Optional. The type of the channel profile. |
| `persona_property` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ChannelProfile.PersonaProperty` Optional. The persona property of the channel profile. |
| `web_widget_config` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ChannelProfile.WebWidgetConfig` Optional. The configuration for the web widget. |
| `whatsapp_config` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ChannelProfile.WhatsAppConfig` Optional. Configuration specific to WhatsApp deployments. |
| `instagram_config` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ChannelProfile.InstagramConfig` Optional. Configuration specific to Instagram deployments. |
| `disable_dtmf` | `bool` Optional. Whether to disable DTMF (dual-tone multi-frequency). |
| `disable_barge_in_control` | `bool` Optional. Whether to disable user barge-in control in the conversation. - **true** : User interruptions are disabled while the agent is speaking. - **false**: The agent retains automatic control over when the user can interrupt. |
| `noise_suppression_level` | `string` Optional. The noise suppression level of the channel profile. Available values are "low", "moderate", "high", "very_high". |

## ChannelType

The type of the channel profile.

| Enums ||
|---|---|
| `UNKNOWN` | Unknown channel type. |
| `WEB_UI` | Web UI channel. |
| `API` | API channel. |
| `TWILIO` | Twilio channel. |
| `GOOGLE_TELEPHONY_PLATFORM` | Google Telephony Platform channel. |
| `CONTACT_CENTER_AS_A_SERVICE` | Contact Center as a Service (CCaaS) channel. |
| `CONTACT_CENTER_AS_A_SERVICE_CHAT` | Contact Center as a Service (CCaaS Chat) channel. |
| `FIVE9` | Five9 channel. |
| `CONTACT_CENTER_INTEGRATION` | Third party contact center integration channel. |
| `WHATSAPP` | WhatsApp channel. |
| `INSTAGRAM` | Instagram channel. |

## InstagramConfig

Configuration specific to Instagram deployments.

| Fields ||
|---|---|
| `instagram_account_id` | `string` Required. The Instagram Account ID. |
| `display_name` | `string` Output only. The fetched Meta business page name. |
| `thumbnail_url` | `string` Output only. The fetched Meta business profile thumbnail URL. |
| `description` | `string` Output only. The description of the Meta business page or profile. |

## PersonaProperty

Represents the persona property of a channel.

| Fields ||
|---|---|
| `persona` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ChannelProfile.PersonaProperty.Persona` Optional. The persona of the channel. |

## Persona

The persona of the channel.

| Enums ||
|---|---|
| `UNKNOWN` | UNKNOWN persona. |
| `CONCISE` | The agent keeps the responses concise and to the point |
| `CHATTY` | The agent provides additional context, explanations, and details |

## WebWidgetConfig

Message for configuration for the web widget.

| Fields ||
|---|---|
| `modality` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ChannelProfile.WebWidgetConfig.Modality` Optional. The modality of the web widget. |
| `theme` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ChannelProfile.WebWidgetConfig.Theme` Optional. The theme of the web widget. |
| `web_widget_title` | `string` Optional. The title of the web widget. |
| `security_settings` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ChannelProfile.WebWidgetConfig.SecuritySettings` Optional. The security settings of the web widget. |

## Modality

Modality of the web widget.

| Enums ||
|---|---|
| `MODALITY_UNSPECIFIED` | Unknown modality. |
| `CHAT_AND_VOICE` | Widget supports both chat and voice input. |
| `VOICE_ONLY` | Widget supports only voice input. |
| `CHAT_ONLY` | Widget supports only chat input. |
| `CHAT_VOICE_AND_VIDEO` | Widget supports chat, voice, and video input. |

## SecuritySettings

Security settings for the web widget.

| Fields ||
|---|---|
| `enable_public_access` | `bool` Optional. Indicates whether public access to the web widget is enabled. If `true`, the web widget will be publicly accessible. If `false`, the web widget must be integrated with your own authentication and authorization system to return valid credentials for accessing the CES agent. |
| `enable_origin_check` | `bool` Optional. Indicates whether origin check for the web widget is enabled. If `true`, the web widget will check the origin of the website that loads the web widget and only allow it to be loaded in the same origin or any of the allowed origins. |
| `allowed_origins[]` | `string` Optional. The origins that are allowed to host the web widget. An origin is defined by RFC 6454. If empty, all origins are allowed. A maximum of 100 origins is allowed. Example: "https://example.com" |
| `enable_recaptcha` | `bool` Optional. Indicates whether reCAPTCHA verification for the web widget is enabled. |

## Theme

Theme of the web widget.

| Enums ||
|---|---|
| `THEME_UNSPECIFIED` | Unknown theme. |
| `LIGHT` | Light theme. |
| `DARK` | Dark theme. |

## WhatsAppConfig

Configuration specific to WhatsApp deployments.

| Fields ||
|---|---|
| `waba_id` | `string` Required. The WhatsApp Business Account ID. |
| `phone_number_id` | `string` Required. The Meta phone number ID. |
| `phone_number` | `string` Optional. The phone number in E.164 format. |
| `display_name` | `string` Output only. The fetched Meta business page name. |
| `thumbnail_url` | `string` Output only. The fetched Meta business profile thumbnail URL. |
| `description` | `string` Output only. The description of the Meta business page or profile. |

## Chunk

A chunk of content within a message.

| Fields ||
|---|---|
| Union field `data`. Chunk data. `data` can be only one of the following: ||
| `text` | `string` Optional. Text data. |
| `transcript` | `string` Optional. Transcript associated with the audio. |
| `blob` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Blob` Optional. Blob data. |
| `payload` | `https://protobuf.dev/reference/protobuf/google.protobuf#struct` Optional. Custom payload data. |
| `image` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Image` Optional. Image data. |
| `tool_call` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ToolCall` Optional. Tool execution request. |
| `tool_response` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ToolResponse` Optional. Tool execution response. |
| `agent_transfer` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentTransfer` Optional. Agent transfer event. |
| `updated_variables` | `https://protobuf.dev/reference/protobuf/google.protobuf#struct` A struct represents variables that were updated in the conversation, keyed by variable names. |
| `default_variables` | `https://protobuf.dev/reference/protobuf/google.protobuf#struct` A struct represents default variables at the start of the conversation, keyed by variable names. |

## Citations

Citations associated with the agent response.

| Fields ||
|---|---|
| `cited_chunks[]` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Citations.CitedChunk` List of cited pieces of information. |
| `inline_citations[]` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Citations.InlineCitation` Optional. List of inline citations in the agent response. |

## CitedChunk

Piece of cited information.

| Fields ||
|---|---|
| `uri` | `string` URI used for citation. |
| `title` | `string` Title of the cited document. |
| `text` | `string` Text used for citation. |
| `requires_attribution` | `bool` Whether this citation requires attribution to be shown to the end users. |

## InlineCitation

An inline citation in the response text.

| Fields ||
|---|---|
| `start_index` | `int32` The starting index (in bytes) of the text segment in the agent response. |
| `end_index` | `int32` The ending index (in bytes) of the text segment in the agent response. |
| `cited_chunk_indices[]` | `int32` The indices of the cited chunks that back this text segment. Indices refer to the elements in `cited_chunks`. |

## ClientCertificateSettings

Settings for custom client certificates.

| Fields ||
|---|---|
| `tls_certificate` | `string` Required. The TLS certificate encoded in PEM format. This string must include the begin header and end footer lines. |
| `private_key` | `string` Required. The name of the SecretManager secret version resource storing the private key encoded in PEM format. Format: `projects/{project}/secrets/{secret}/versions/{version}` |
| `passphrase` | `string` Optional. The name of the SecretManager secret version resource storing the passphrase to decrypt the private key. Should be left unset if the private key is not encrypted. Format: `projects/{project}/secrets/{secret}/versions/{version}` |

## 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 `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ToolResponse` to continue the interaction with the agent.

| Fields ||
|---|---|
| `name` | `string` Required. The function name. |
| `description` | `string` Optional. The function description. |
| `parameters` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Schema` Optional. The schema of the function parameters. |
| `response` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Schema` Optional. The schema of the function response. |

## CloudLoggingSettings

Settings to describe the Cloud Logging behaviors for the app.

| Fields ||
|---|---|
| `enable_cloud_logging` | `bool` Optional. Whether to enable Cloud Logging for the sessions. |

## CodeBlock

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

| Fields ||
|---|---|
| `python_code` | `string` Required. Python code which will be invoked in tool fake mode. Expected Python function signature - To catch all tool calls: def fake_tool_call(tool: Tool, input: dict\[str, Any\], callback_context: CallbackContext) -\> Optional\[dict\[str, Any\]\]: To catch a specific tool call: def fake_{tool_id}(tool: Tool, input: dict\[str, Any\], callback_context: CallbackContext) -\> Optional\[dict\[str, Any\]\]: If the function returns None, the real tool will be invoked instead. |

## ConnectorTool

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

| Fields ||
|---|---|
| `connection` | `string` Required. The full resource name of the referenced Integration Connectors Connection. Format: `projects/{project}/locations/{location}/connections/{connection}` |
| `action` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Action` Required. Action for the tool to use. |
| `auth_config` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.EndUserAuthConfig` Optional. Configures how authentication is handled in Integration Connectors. By default, an admin authentication is passed in the Integration Connectors API requests. You can override it with a different end-user authentication config. **Note** : The Connection must have authentication override enabled in order to specify an EUC configuration here - otherwise, the ConnectorTool creation will fail. See <https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override> for details. |
| `name` | `string` Optional. The name of the tool that can be used by the Agent to decide whether to call this ConnectorTool. |
| `description` | `string` Optional. The description of the tool that can be used by the Agent to decide whether to call this ConnectorTool. |

## ConnectorToolset

A toolset that generates tools from an Integration Connectors Connection.

| Fields ||
|---|---|
| `connection` | `string` Required. The full resource name of the referenced Integration Connectors Connection. Format: `projects/{project}/locations/{location}/connections/{connection}` |
| `auth_config` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.EndUserAuthConfig` Optional. Configures how authentication is handled in Integration Connectors. By default, an admin authentication is passed in the Integration Connectors API requests. You can override it with a different end-user authentication config. **Note** : The Connection must have authentication override enabled in order to specify an EUC configuration here - otherwise, the Toolset creation will fail. See: <https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override> |
| `connector_actions[]` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Action` Required. The list of connector actions/entity operations to generate tools for. |

## Conversation

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

| Fields ||
|---|---|
| `name` | `string` Identifier. The unique identifier of the conversation. Format: `projects/{project}/locations/{location}/apps/{app}/conversations/{conversation}` |
| `start_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. Timestamp when the conversation was created. |
| `end_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. Timestamp when the conversation was completed. |
| `turns[]` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Conversation.Turn` Required. The turns in the conversation. |
| `turn_count` | `int32` Output only. The number of turns in the conversation. |
| `channel_type (deprecated)` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Conversation.ChannelType` > [!WARNING] > This item is deprecated! DEPRECATED. Please use `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Conversation.FIELDS.repeated.google.cloud.ces.v1.Conversation.InputType.google.cloud.ces.v1.Conversation.input_types` instead. |
| `source` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Conversation.Source` Output only. Indicate the source of the conversation. |
| `input_types[]` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Conversation.InputType` Output only. The input types of the conversation. |
| `entry_agent` | `string` Output only. The agent that initially handles the conversation. If not specified, the conversation is handled by the root agent. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` |
| `deployment` | `string` Output only. The deployment of the app used for processing the conversation. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}` |
| `app_version` | `string` Output only. The version of the app used for processing the conversation. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}` |
| `language_code` | `string` Output only. The language code of the conversation. |
| `messages[] (deprecated)` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Message` > [!WARNING] > This item is deprecated! Deprecated. Use turns instead. |

## ChannelType

The channel type of the conversation.

| Enums ||
|---|---|
| `CHANNEL_TYPE_UNSPECIFIED` | Unspecified channel type. |
| `TEXT` | The conversation only contains text messages between the end user and the agent. |
| `AUDIO` | The conversation contains audio messages between the end user and the agent. |
| `MULTIMODAL` | The conversation multi-modal messages (e.g. image) between the end user and the agent. |

## InputType

Type of the input message.

| Enums ||
|---|---|
| `INPUT_TYPE_UNSPECIFIED` | Unspecified input type. |
| `INPUT_TYPE_TEXT` | Text input. |
| `INPUT_TYPE_EVENT` | Event input. |
| `INPUT_TYPE_AUDIO` | Audio input. |
| `INPUT_TYPE_IMAGE` | Image input. |
| `INPUT_TYPE_BLOB` | Blob input. |
| `INPUT_TYPE_TOOL_RESPONSE` | Client function tool response input. |
| `INPUT_TYPE_VARIABLES` | Variables input. |

## Source

The source of the conversation.

| Enums ||
|---|---|
| `SOURCE_UNSPECIFIED` | Unspecified source. |
| `LIVE` | The conversation is from the live end user. |
| `SIMULATOR` | The conversation is from the simulator. |
| `EVAL` | The conversation is from the evaluation. |
| `AGENT_TOOL` | The conversation is from an agent tool. Agent tool runs the agent in a separate session, which is persisted for testing and debugging purposes. |

## Turn

All information about a single turn in the conversation.

| Fields ||
|---|---|
| `messages[]` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Message` Optional. List of messages in the conversation turn, including user input, agent responses and intermediate events during the processing. |
| `root_span` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Span` Optional. The root span of the action processing. |
| `user_intended_text` | `string` Optional. The intended ground-truth text from the Simulated Caller (Polysynth). Only populated when word error rate metrics are enabled. |

## ConversationLoggingSettings

Settings to describe the conversation logging behaviors for the app.

| Fields ||
|---|---|
| `disable_conversation_logging` | `bool` Optional. Whether to disable conversation logging for the sessions. |
| `retention_window` | `https://protobuf.dev/reference/protobuf/google.protobuf#duration` Optional. Controls the retention window for the conversation. If not set, the conversation will be retained for 365 days. |

## CreateAgentRequest

Request message for `AgentService.CreateAgent`.

| Fields ||
|---|---|
| `parent` | `string` Required. The resource name of the app to create an agent in. |
| `agent_id` | `string` Optional. The ID to use for the agent, which will become the final component of the agent's resource name. If not provided, a unique ID will be automatically assigned for the agent. |
| `agent` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Agent` Required. The agent to create. |

## CreateAppRequest

Request message for `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentService.CreateApp`.

| Fields ||
|---|---|
| `parent` | `string` Required. The resource name of the location to create an app in. |
| `app_id` | `string` Optional. The ID to use for the app, which will become the final component of the app's resource name. If not provided, a unique ID will be automatically assigned for the app. |
| `app` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.App` Required. The app to create. |

## CreateAppVersionRequest

Request message for `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentService.CreateAppVersion`

| Fields ||
|---|---|
| `parent` | `string` Required. The resource name of the app to create an app version in. |
| `app_version_id` | `string` Optional. The ID to use for the app version, which will become the final component of the app version's resource name. If not provided, a unique ID will be automatically assigned for the app version. |
| `app_version` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AppVersion` Required. The app version to create. |

## CreateDeploymentRequest

Request message for `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentService.CreateDeployment`.

| Fields ||
|---|---|
| `parent` | `string` Required. The parent app. Format: `projects/{project}/locations/{location}/apps/{app}` |
| `deployment_id` | `string` Optional. The ID to use for the deployment, which will become the final component of the deployment's resource name. If not provided, a unique ID will be automatically assigned for the deployment. |
| `deployment` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Deployment` Required. The deployment to create. |

## CreateExampleRequest

Request message for `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentService.CreateExample`.

| Fields ||
|---|---|
| `parent` | `string` Required. The resource name of the app to create an example in. |
| `example_id` | `string` Optional. The ID to use for the example, which will become the final component of the example's resource name. If not provided, a unique ID will be automatically assigned for the example. |
| `example` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Example` Required. The example to create. |

## CreateGuardrailRequest

Request message for `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentService.CreateGuardrail`.

| Fields ||
|---|---|
| `parent` | `string` Required. The resource name of the app to create a guardrail in. |
| `guardrail_id` | `string` Optional. The ID to use for the guardrail, which will become the final component of the guardrail's resource name. If not provided, a unique ID will be automatically assigned for the guardrail. |
| `guardrail` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Guardrail` Required. The guardrail to create. |

## CreateToolRequest

Request message for `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentService.CreateTool`.

| Fields ||
|---|---|
| `parent` | `string` Required. The resource name of the app to create a tool in. |
| `tool_id` | `string` Optional. The ID to use for the tool, which will become the final component of the tool's resource name. If not provided, a unique ID will be automatically assigned for the tool. |
| `tool` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Tool` Required. The tool to create. |

## CreateToolsetRequest

Request message for `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentService.CreateToolset`.

| Fields ||
|---|---|
| `parent` | `string` Required. The resource name of the app to create a toolset in. |
| `toolset_id` | `string` Optional. The ID to use for the toolset, which will become the final component of the toolset's resource name. If not provided, a unique ID will be automatically assigned for the toolset. |
| `toolset` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Toolset` Required. The toolset to create. |

## CustomVoiceSample

Configuration for a custom voice sample used for voice cloning.

| Fields ||
|---|---|
| `name` | `string` Optional. The user-defined name for the custom voice sample. |
| `voice_sample_gcs_uri` | `string` Optional. The Cloud Storage URI to the audio sample for voice cloning. The audio sample should be a mono-channel, 24kHz WAV file. |
| `consent_audio_gcs_uri` | `string` Optional. Consent audio for voice cloning. |
| `voice_instruction` | `string` Optional. Natural language instructions for voice style, tone, pacing, or pronunciation. |
| `preview_audio_content` | `bytes` Output only. Synthesized preview audio for custom voice, formatted as canonical WAV (LINEAR16, 24kHz, 16-bit, mono). |
| `preview_text` | `string` Optional. Text for synthesizing preview audio for custom voice. |
| `warnings[]` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.CustomVoiceSample.Warning` Output only. Warning messages encountered during voice clone processing (e.g. low audio level). |
| `voice_instruction_mode` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.CustomVoiceSample.VoiceInstructionMode` Optional. Instruction mode for the voice sample. If unspecified, defaults to NO_INSTRUCTION. |

## VoiceInstructionMode

Instruction mode for the voice sample.

| Enums ||
|---|---|
| `VOICE_INSTRUCTION_MODE_UNSPECIFIED` | Unspecified instruction mode. Defaults to NO_INSTRUCTION. |
| `NO_INSTRUCTION` | No voice instruction will be used. |
| `GENERATE_INSTRUCTION` | Voice instruction will be automatically generated by AI from the audio sample. |
| `CUSTOM_INSTRUCTION` | Custom voice instruction provided by the user. |

## Warning

A warning message encountered during voice sample processing.

| Fields ||
|---|---|
| `message` | `string` Output only. A human-readable description of the warning. |
| `type` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.CustomVoiceSample.Warning.WarningType` Output only. The type of the warning. |

## WarningType

Type of warning encountered during voice sample processing.

| Enums ||
|---|---|
| `WARNING_TYPE_UNSPECIFIED` | Unspecified warning type. |
| `LOW_AUDIO_LEVEL` | The audio level of the voice sample is too low (e.g. low RMS amplitude). |

## DashboardSettings

Settings for dashboards associated with the app, that show up in the Monitoring view.

| Fields ||
|---|---|
| `default_dashboard` | `string` Optional. The resource name of the default Contact Center Insights dashboard associated with the app. This is the dashboard that will be displayed when users navigate to the Monitoring view for the app. Format: `projects/{project}/locations/{location}/dashboards/{dashboard}` |

## DataStore

A DataStore resource in Vertex AI Search.

| Fields ||
|---|---|
| `name` | `string` Required. Full resource name of the DataStore. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` |
| `type` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.DataStore.DataStoreType` Output only. The type of the data store. This field is readonly and populated by the server. |
| `document_processing_mode` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.DataStore.DocumentProcessingMode` Output only. The document processing mode for the data store connection. Only set for PUBLIC_WEB and UNSTRUCTURED data stores. |
| `display_name` | `string` Output only. The display name of the data store. |
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. Timestamp when the data store was created. |
| `connector_config` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.DataStore.ConnectorConfig` Output only. The connector config for the data store connection. |

## ConnectorConfig

The connector config for the data store connection.

| Fields ||
|---|---|
| `collection` | `string` Resource name of the collection the data store belongs to. |
| `collection_display_name` | `string` Display name of the collection the data store belongs to. |
| `data_source` | `string` The name of the data source. Example: `salesforce`, `jira`, `confluence`, `bigquery`. |

## DataStoreType

The type of the data store.

| Enums ||
|---|---|
| `DATA_STORE_TYPE_UNSPECIFIED` | Not specified. This value indicates that the data store type is not specified, so it will not be used during search. |
| `PUBLIC_WEB` | A data store that contains public web content. |
| `UNSTRUCTURED` | A data store that contains unstructured private data. |
| `FAQ` | A data store that contains structured data used as FAQ. |
| `CONNECTOR` | A data store that is a connector to a first-party or a third-party service. |

## DocumentProcessingMode

The document processing mode of the data store.

| Enums ||
|---|---|
| `DOCUMENT_PROCESSING_MODE_UNSPECIFIED` | Not specified. |
| `DOCUMENTS` | Documents are processed as documents. |
| `CHUNKS` | Documents are converted to chunks. |

## DataStoreSettings

Data store related settings for the app.

| Fields ||
|---|---|
| `engines[]` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.DataStoreSettings.Engine` Output only. The engines 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>.

| Fields ||
|---|---|
| `name` | `string` Output only. The resource name of the engine. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` |
| `type` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.DataStoreSettings.Engine.Type` Output only. The type of the engine. |

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

| Enums ||
|---|---|
| `TYPE_UNSPECIFIED` | Unspecified engine type. |
| `ENGINE_TYPE_SEARCH` | The SOLUTION_TYPE_SEARCH engine for the app. All connector data stores added to the app will be added to this engine. |
| `ENGINE_TYPE_CHAT` | Chat engine type. The SOLUTION_TYPE_CHAT engine for the app. All connector data stores added to the app will be added to this engine. |

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

| Fields ||
|---|---|
| `name` | `string` Required. The data store tool name. |
| `description` | `string` Optional. The tool description. |
| `boost_specs[]` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.DataStoreTool.BoostSpecs` Optional. Boost specification to boost certain documents. |
| `modality_configs[]` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.DataStoreTool.ModalityConfig` Optional. The modality configs for the data store. |
| `filter_parameter_behavior` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.DataStoreTool.FilterParameterBehavior` Optional. The filter parameter behavior. |
| Union field `search_source`. Defines the search source, either a single DataStore or an Engine. `search_source` can be only one of the following: ||
| `data_store_source` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.DataStoreTool.DataStoreSource` Optional. Search within a single specific DataStore. |
| `engine_source` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.DataStoreTool.EngineSource` Optional. Search within an Engine (potentially across multiple DataStores). |

## BoostSpec

Boost specification to boost certain documents.

| Fields ||
|---|---|
| `condition_boost_specs[]` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.DataStoreTool.BoostSpec.ConditionBoostSpec` Required. A list of boosting specifications. |

## ConditionBoostSpec

Boost specification for a condition.

| Fields ||
|---|---|
| `condition` | `string` Required. An expression which specifies a boost condition. The syntax is the same as filter expression syntax. Currently, the only supported condition is a list of BCP-47 lang codes. Example: To boost suggestions in languages en or fr: (lang_code: ANY("en", "fr")) |
| `boost` | `float` Optional. Strength of the boost, which should be in \[-1, 1\]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the suggestions a big promotion. However, it does not necessarily mean that the top result will be a boosted suggestion. Setting to -1.0 gives the suggestions a big demotion. However, other suggestions that are relevant might still be shown. Setting to 0.0 means no boost applied. The boosting condition is ignored. |
| `boost_control_spec` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec` Optional. Complex specification for custom ranking based on customer defined attribute value. |

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

| Fields ||
|---|---|
| `field_name` | `string` Optional. The name of the field whose value will be used to determine the boost amount. |
| `attribute_type` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType` Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value). |
| `interpolation_type` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.InterpolationType` Optional. The interpolation type to be applied to connect the control points listed below. |
| `control_points[]` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint` Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. |

## AttributeType

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

| Enums ||
|---|---|
| `ATTRIBUTE_TYPE_UNSPECIFIED` | Unspecified AttributeType. |
| `NUMERICAL` | The value of the numerical field will be used to dynamically update the boost amount. In this case, the attribute_value (the x value) of the control point will be the actual value of the numerical field for which the boost_amount is specified. |
| `FRESHNESS` | For the freshness use case the attribute value will be the duration between the current time and the date in the datetime field specified. The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `[nD][T[nH][nM][nS]]`. E.g. `5D`, `3DT12H30M`, `T24H`. |

## 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).

| Fields ||
|---|---|
| `attribute_value` | `string` Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `[nD][T[nH][nM][nS]]`. |
| `boost_amount` | `float` Optional. The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above. |

## InterpolationType

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

| Enums ||
|---|---|
| `INTERPOLATION_TYPE_UNSPECIFIED` | Interpolation type is unspecified. In this case, it defaults to Linear. |
| `LINEAR` | Piecewise linear interpolation will be applied. |

## BoostSpecs

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

| Fields ||
|---|---|
| `data_stores[]` | `string` Required. The Data Store where the boosting configuration is applied. Full resource name of DataStore, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}. |
| `spec[]` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.DataStoreTool.BoostSpec` Required. A list of boosting specifications. |

## DataStoreSource

Configuration for searching within a specific DataStore.

| Fields ||
|---|---|
| `filter` | `string` Optional. Filter specification for the DataStore. See: <https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata> |
| `data_store` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.DataStore` Optional. The data store. |

## EngineSource

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

| Fields ||
|---|---|
| `engine` | `string` Required. Full resource name of the Engine. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}` |
| `data_store_sources[]` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.DataStoreTool.DataStoreSource` Optional. Use to target specific DataStores within the Engine. If empty, the search applies to all DataStores associated with the Engine. |
| `filter` | `string` Optional. A filter applied to the search across the Engine. Not relevant and not used if 'data_store_sources' is provided. See: <https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata> |

## FilterParameterBehavior

Filter parameter behavior.

| Enums ||
|---|---|
| `FILTER_PARAMETER_BEHAVIOR_UNSPECIFIED` | Default filter behavior. Include filter parameter for connector datastores. For the rest of the datastore types, the filter input parameter is omitted. |
| `ALWAYS_INCLUDE` | Always include filter parameter for all datastore types. |
| `NEVER_INCLUDE` | The filter parameter is never included in the list of tool parameters, regardless of the datastore type. |

## GroundingConfig

Grounding configuration.

| Fields ||
|---|---|
| `grounding_level` | `float` Optional. The groundedness threshold of the answer based on the retrieved sources. The value has a configurable range of \[1, 5\]. The level is used to threshold the groundedness of the answer, meaning that all responses with a groundedness score below the threshold will fall back to returning relevant snippets only. For example, a level of 3 means that the groundedness score must be 3 or higher for the response to be returned. |
| `disabled` | `bool` Optional. Whether grounding is disabled. |

## ModalityConfig

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

| Fields ||
|---|---|
| `modality_type` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.DataStoreTool.ModalityConfig.ModalityType` Required. The modality type. |
| `rewriter_config` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.DataStoreTool.RewriterConfig` Optional. The rewriter config. |
| `summarization_config` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.DataStoreTool.SummarizationConfig` Optional. The summarization config. |
| `grounding_config` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.DataStoreTool.GroundingConfig` Optional. The grounding configuration. |
| `snippets_config` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.DataStoreTool.SnippetsConfig` Optional. The snippets configuration. |

## ModalityType

The modality type.

| Enums ||
|---|---|
| `MODALITY_TYPE_UNSPECIFIED` | Unspecified modality type. |
| `TEXT` | Text modality. |
| `AUDIO` | Audio modality. |

## RewriterConfig

Rewriter configuration.

| Fields ||
|---|---|
| `model_settings` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ModelSettings` Required. Configurations for the LLM model. |
| `prompt` | `string` Optional. The prompt definition. If not set, default prompt will be used. |
| `disabled` | `bool` Optional. Whether the rewriter is disabled. |

## SnippetsConfig

Snippets configuration.

| Fields ||
|---|---|
| `enable_snippets` | `bool` Optional. Whether snippets are enabled. |
| `max_snippets` | `int32` Optional. Number of snippets to return per query. If unset, returns all snippets from the service by default. |

## SummarizationConfig

Summarization configuration.

| Fields ||
|---|---|
| `model_settings` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ModelSettings` Optional. Configurations for the LLM model. |
| `prompt` | `string` Optional. The prompt definition. If not set, default prompt will be used. |
| `disabled` | `bool` Optional. Whether summarization is disabled. |

## DeleteAgentRequest

Request message for `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentService.DeleteAgent`.

| Fields ||
|---|---|
| `name` | `string` Required. The resource name of the agent to delete. |
| `force` | `bool` Optional. Indicates whether to forcefully delete the agent, even if it is still referenced by other app/agents/examples. - If `force = false`, the deletion fails if other agents/examples reference it. - If `force = true`, delete the agent and remove it from all referencing apps/agents/examples. |
| `etag` | `string` Optional. The current etag of the agent. If an etag is not provided, the deletion will overwrite any concurrent changes. If an etag is provided and does not match the current etag of the agent, deletion will be blocked and an ABORTED error will be returned. |

## DeleteAppRequest

Request message for `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentService.DeleteApp`.

| Fields ||
|---|---|
| `name` | `string` Required. The resource name of the app to delete. |
| `etag` | `string` Optional. The current etag of the app. If an etag is not provided, the deletion will overwrite any concurrent changes. If an etag is provided and does not match the current etag of the app, deletion will be blocked and an ABORTED error will be returned. |

## DeleteAppVersionRequest

Request message for `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentService.DeleteAppVersion`.

| Fields ||
|---|---|
| `name` | `string` Required. The resource name of the app version to delete. |
| `etag` | `string` Optional. The current etag of the app version. If an etag is not provided, the deletion will overwrite any concurrent changes. If an etag is provided and does not match the current etag of the app version, deletion will be blocked and an ABORTED error will be returned. |

## DeleteConversationRequest

Request message for `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentService.DeleteConversation`.

| Fields ||
|---|---|
| `name` | `string` Required. The resource name of the conversation to delete. |
| `source (deprecated)` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Conversation.Source` > [!WARNING] > This item is deprecated! Optional. Indicate the source of the conversation. If not set, Source.Live will be applied by default. |

## DeleteDeploymentRequest

Request message for `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentService.DeleteDeployment`.

| Fields ||
|---|---|
| `name` | `string` Required. The name of the deployment to delete. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}` |
| `etag` | `string` Optional. The etag of the deployment. If an etag is provided and does not match the current etag of the deployment, deletion will be blocked and an ABORTED error will be returned. |

## DeleteExampleRequest

Request message for `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentService.DeleteExample`.

| Fields ||
|---|---|
| `name` | `string` Required. The resource name of the example to delete. |
| `etag` | `string` Optional. The current etag of the example. If an etag is not provided, the deletion will overwrite any concurrent changes. If an etag is provided and does not match the current etag of the example, deletion will be blocked and an ABORTED error will be returned. |

## DeleteGuardrailRequest

Request message for `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentService.DeleteGuardrail`.

| Fields ||
|---|---|
| `name` | `string` Required. The resource name of the guardrail to delete. |
| `force` | `bool` Optional. Indicates whether to forcefully delete the guardrail, even if it is still referenced by app/agents. - If `force = false`, the deletion fails if any apps/agents still reference the guardrail. - If `force = true`, all existing references from apps/agents will be removed and the guardrail will be deleted. |
| `etag` | `string` Optional. The current etag of the guardrail. If an etag is not provided, the deletion will overwrite any concurrent changes. If an etag is provided and does not match the current etag of the guardrail, deletion will be blocked and an ABORTED error will be returned. |

## DeleteToolRequest

Request message for `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentService.DeleteTool`.

| Fields ||
|---|---|
| `name` | `string` Required. The resource name of the tool to delete. |
| `force` | `bool` Optional. Indicates whether to forcefully delete the tool, even if it is still referenced by agents/examples. - If `force = false`, the deletion will fail if any agents still reference the tool. - If `force = true`, all existing references from agents will be removed and the tool will be deleted. |
| `etag` | `string` Optional. The current etag of the tool. If an etag is not provided, the deletion will overwrite any concurrent changes. If an etag is provided and does not match the current etag of the tool, deletion will be blocked and an ABORTED error will be returned. |

## DeleteToolsetRequest

Request message for `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentService.DeleteToolset`.

| Fields ||
|---|---|
| `name` | `string` Required. The resource name of the toolset to delete. |
| `force` | `bool` Optional. Indicates whether to forcefully delete the toolset, even if it is still referenced by app/agents. - If `force = false`, the deletion fails if any agents still reference the toolset. - If `force = true`, all existing references from agents will be removed and the toolset will be deleted. |
| `etag` | `string` Optional. The current etag of the toolset. If an etag is not provided, the deletion will overwrite any concurrent changes. If an etag is provided and does not match the current etag of the toolset, deletion will be blocked and an ABORTED error will be returned. |

## DeployChannelResponse

Response message for `AgentService.DeployChannel`.

| Fields ||
|---|---|
| `deployment` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Deployment` The created deployment. |

## Deployment

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

| Fields ||
|---|---|
| `name` | `string` Identifier. The resource name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}` |
| `display_name` | `string` Required. Display name of the deployment. |
| `app_version` | `string` Optional. The resource name of the app version to deploy. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}` Use `projects/{project}/locations/{location}/apps/{app}/versions/-` to use the draft app. |
| `channel_profile` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ChannelProfile` Required. The channel profile used in the deployment. |
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. Timestamp when this deployment was created. |
| `update_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. Timestamp when this deployment was last updated. |
| `etag` | `string` Output only. Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes. |
| `experiment_config` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ExperimentConfig` Optional. Experiment configuration for the deployment. |
| `whatsapp_credentials` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.WhatsAppCredentials` Optional. Input only. Ephemeral WhatsApp credentials required when configuring a WhatsApp channel profile. |
| `instagram_credentials` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.InstagramCredentials` Optional. Input only. Ephemeral Instagram credentials required when configuring a Instagram channel profile. |
| `model_settings` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ModelSettings` Optional. Model settings for the deployment. Overrides model settings configured at the app/agent levels. Note: Deployment-level model settings override is gated behind an allowlist. Contact the CXAS team to enable this field. |
| `modality` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Deployment.Modality` Optional. The modality of the deployment. Note: Deployment-level modality override is gated behind an allowlist. Contact the CXAS team to enable this field. |
| `agent_registry_deployment` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentRegistryDeployment` Optional. Configuration for deploying this deployment to Agent Registry. If present, this deployment will be published to Agent Registry. |

## Modality

The modality of the deployment.

| Enums ||
|---|---|
| `MODALITY_UNSPECIFIED` | Unknown modality. |
| `MODALITY_TEXT` | Text modality. |
| `MODALITY_VOICE` | Voice modality. |
| `MODALITY_VIDEO` | Video modality. |

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

| Fields ||
|---|---|
| `metadata` | `https://protobuf.dev/reference/protobuf/google.protobuf#struct` Optional. Provides additional information about the end session signal, such as the reason for ending the session. |

## 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>`.

| Fields ||
|---|---|
| Union field `auth_config`. The auth configuration. `auth_config` can be only one of the following: ||
| `oauth2_auth_code_config` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.EndUserAuthConfig.Oauth2AuthCodeConfig` Oauth 2.0 Authorization Code authentication. |
| `oauth2_jwt_bearer_config` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.EndUserAuthConfig.Oauth2JwtBearerConfig` JWT Profile Oauth 2.0 Authorization Grant authentication. |

## Oauth2AuthCodeConfig

Oauth 2.0 Authorization Code authentication configuration.

| Fields ||
|---|---|
| `oauth_token` | `string` Required. Oauth token parameter name to pass through. Must be in the format `$context.variables.<name_of_variable>`. |

## Oauth2JwtBearerConfig

JWT Profile Oauth 2.0 Authorization Grant authentication configuration.

| Fields ||
|---|---|
| `issuer` | `string` Required. Issuer parameter name to pass through. Must be in the format `$context.variables.<name_of_variable>`. |
| `subject` | `string` Required. Subject parameter name to pass through. Must be in the format `$context.variables.<name_of_variable>`. |
| `client_key` | `string` Required. Client parameter name to pass through. Must be in the format `$context.variables.<name_of_variable>`. |

## EndpointControlPolicy

Defines project/location level endpoint control policy.

| Fields ||
|---|---|
| `enforcement_scope` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.EndpointControlPolicy.EnforcementScope` Optional. The scope in which this policy's allowed_origins list is enforced. |
| `allowed_origins[]` | `string` Optional. The allowed HTTP(s) origins that tools in the App are able to directly call. The enforcement depends on the value of enforcement_scope and the VPC-SC status of the project. If a port number is not provided, all ports will be allowed. Otherwise, the port number must match exactly. For example, "https://example.com" will match "https://example.com:443" and any other port. "https://example.com:443" will only match "https://example.com:443". |

## EnforcementScope

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

| Enums ||
|---|---|
| `ENFORCEMENT_SCOPE_UNSPECIFIED` | Unspecified. This policy will be treated as VPCSC_ONLY. |
| `VPCSC_ONLY` | This policy applies only when VPC-SC is active. |
| `ALWAYS` | This policy ALWAYS applies, regardless of VPC-SC status. |

## ErrorHandlingSettings

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

| Fields ||
|---|---|
| `error_handling_strategy` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ErrorHandlingSettings.ErrorHandlingStrategy` Optional. The strategy to use for error handling. |
| `fallback_response_config` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ErrorHandlingSettings.FallbackResponseConfig` Optional. Configuration for handling fallback responses. |
| `end_session_config` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ErrorHandlingSettings.EndSessionConfig` Optional. Configuration for ending the session in case of system errors (e.g. LLM errors). |

## EndSessionConfig

Configuration for ending the session in case of system errors (e.g. LLM errors).

| Fields ||
|---|---|
| `escalate_session` | `bool` Optional. Whether to escalate the session in `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.EndSession`. If session is escalated, `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.EndSession.FIELDS.google.protobuf.Struct.google.cloud.ces.v1.EndSession.metadata` will contain `session_escalated = true`. See <https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/deploy/google-telephony-platform#transfer_a_call_to_a_human_agent> for details. |

## ErrorHandlingStrategy

Defines the strategy for handling errors.

| Enums ||
|---|---|
| `ERROR_HANDLING_STRATEGY_UNSPECIFIED` | Unspecified error handling strategy. |
| `NONE` | No specific handling is enabled. |
| `FALLBACK_RESPONSE` | A fallback message will be returned to the user in case of system errors (e.g. LLM errors). |
| `END_SESSION` | An `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.EndSession` signal will be emitted in case of system errors (e.g. LLM errors). |

## FallbackResponseConfig

Configuration for handling fallback responses.

| Fields ||
|---|---|
| `custom_fallback_messages` | `map<string, string>` Optional. The fallback messages in case of system errors (e.g. LLM errors), mapped by [supported language code](https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/reference/language). |
| `max_fallback_attempts` | `int32` Optional. The maximum number of fallback attempts to make before the agent emitting `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.EndSession` Signal. |

## EvaluationMetricsThresholds

Threshold settings for metrics in an Evaluation.

| Fields ||
|---|---|
| `golden_evaluation_metrics_thresholds` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds` Optional. The golden evaluation metrics thresholds. |
| `hallucination_metric_behavior (deprecated)` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.EvaluationMetricsThresholds.HallucinationMetricBehavior` > [!WARNING] > This item is deprecated! Optional. Deprecated: Use `golden_hallucination_metric_behavior` instead. The hallucination metric behavior is currently used for golden evaluations. |
| `golden_hallucination_metric_behavior` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.EvaluationMetricsThresholds.HallucinationMetricBehavior` Optional. The hallucination metric behavior for golden evaluations. |
| `scenario_hallucination_metric_behavior` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.EvaluationMetricsThresholds.HallucinationMetricBehavior` Optional. The hallucination metric behavior for scenario evaluations. |

## GoldenEvaluationMetricsThresholds

Settings for golden evaluations.

| Fields ||
|---|---|
| `turn_level_metrics_thresholds` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds` Optional. The turn level metrics thresholds. |
| `expectation_level_metrics_thresholds` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.ExpectationLevelMetricsThresholds` Optional. The expectation level metrics thresholds. |
| `tool_matching_settings` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.EvaluationMetricsThresholds.ToolMatchingSettings` Optional. The tool matching settings. 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. |

## ExpectationLevelMetricsThresholds

Expectation level metrics thresholds.

| Fields ||
|---|---|
| `tool_invocation_parameter_correctness_threshold` | `float` Optional. The success threshold for individual tool invocation parameter correctness. Must be a float between 0 and 1. Default is 1.0. |

## TurnLevelMetricsThresholds

Turn level metrics thresholds.

| Fields ||
|---|---|
| `semantic_similarity_channel` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds.SemanticSimilarityChannel` Optional. The semantic similarity channel to use for evaluation. |
| `semantic_similarity_success_threshold` | `int32` Optional. The success threshold for semantic similarity. Must be an integer between 0 and 4. Default is \>= 3. |
| `overall_tool_invocation_correctness_threshold` | `float` Optional. The success threshold for overall tool invocation correctness. Must be a float between 0 and 1. Default is 1.0. |

## SemanticSimilarityChannel

Semantic similarity channel to use.

| Enums ||
|---|---|
| `SEMANTIC_SIMILARITY_CHANNEL_UNSPECIFIED` | Metric unspecified. Defaults to TEXT. |
| `TEXT` | Use text semantic similarity. |
| `AUDIO` | Use audio semantic similarity. |

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

| Enums ||
|---|---|
| `HALLUCINATION_METRIC_BEHAVIOR_UNSPECIFIED` | Unspecified hallucination metric behavior. |
| `DISABLED` | Disable hallucination metric. |
| `ENABLED` | Enable hallucination metric. |

## ToolMatchingSettings

Settings for matching tool calls.

| Fields ||
|---|---|
| `extra_tool_call_behavior` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.EvaluationMetricsThresholds.ToolMatchingSettings.ExtraToolCallBehavior` Optional. Behavior for extra tool calls. Defaults to FAIL. |

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

| Enums ||
|---|---|
| `EXTRA_TOOL_CALL_BEHAVIOR_UNSPECIFIED` | Unspecified behavior. Defaults to FAIL. |
| `FAIL` | Fail the evaluation if an extra tool call is encountered. |
| `ALLOW` | Allow the extra tool call. |

## Event

Event input.

| Fields ||
|---|---|
| `event` | `string` Required. The name of the event. |
| `variables` | `https://protobuf.dev/reference/protobuf/google.protobuf#struct` Optional. Additional variables associated with the event. |

## Example

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

| Fields ||
|---|---|
| `name` | `string` Identifier. The unique identifier of the example. Format: `projects/{project}/locations/{location}/apps/{app}/examples/{example}` |
| `display_name` | `string` Required. Display name of the example. |
| `description` | `string` Optional. Human-readable description of the example. |
| `entry_agent` | `string` Optional. The agent that initially handles the conversation. If not specified, the example represents a conversation that is handled by the root agent. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` |
| `messages[]` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Message` Optional. The collection of messages that make up the conversation. |
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. Timestamp when the example was created. |
| `update_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. Timestamp when the example was last updated. |
| `invalid` | `bool` Output only. The example may become invalid if referencing resources are deleted. Invalid examples will not be used as few-shot examples. |
| `etag` | `string` Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes. |

## ExecuteToolRequest

Request message for `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ToolService.ExecuteTool`.

| Fields ||
|---|---|
| `parent` | `string` Required. The resource name of the app which the tool/toolset belongs to. Format: `projects/{project}/locations/{location}/apps/{app}` |
| `args` | `https://protobuf.dev/reference/protobuf/google.protobuf#struct` Optional. The input parameters and values for the tool in JSON object format. |
| `mock_config` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.MockConfig` Optional. Mock configuration for the tool execution. If this field is set, tools that call other tools will be mocked based on the provided patterns and responses. |
| Union field `tool_identifier`. The identifier of the tool to execute. It could be either a persisted tool or a tool from a toolset. `tool_identifier` can be only one of the following: ||
| `tool` | `string` Optional. The name of the tool to execute. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool} |
| `toolset_tool` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ToolsetTool` Optional. The toolset tool to execute. Only one tool should match the predicate from the toolset. Otherwise, an error will be returned. |
| Union field `tool_execution_context`. Additional context to be provided for the tool execution `tool_execution_context` can be only one of the following: ||
| `variables` | `https://protobuf.dev/reference/protobuf/google.protobuf#struct` Optional. The variables that are available for the tool execution. |
| `context` | `https://protobuf.dev/reference/protobuf/google.protobuf#struct` Optional. The \[ToolCallContext\](<https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/python#environment> for details) to be passed to the Python tool. |

## ExecuteToolResponse

Response message for `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ToolService.ExecuteTool`.

| Fields ||
|---|---|
| `response` | `https://protobuf.dev/reference/protobuf/google.protobuf#struct` The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. |
| `variables` | `https://protobuf.dev/reference/protobuf/google.protobuf#struct` The variable values at the end of the tool execution. |
| `citations` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Citations` Citations that provide the source information for the tool's execution. |
| `google_search_suggestions` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.GoogleSearchSuggestions` The suggestions returned from Google Search as a result of invoking the Google Search Tool during the tool execution. |
| Union field `tool_identifier`. The identifier of the tool that got executed. `tool_identifier` can be only one of the following: ||
| `tool` | `string` The name of the tool that got executed. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` |
| `toolset_tool` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ToolsetTool` The toolset tool that got executed. |

## ExecutionType

The execution type of the tool or toolset.

| Enums ||
|---|---|
| `EXECUTION_TYPE_UNSPECIFIED` | The execution type is unspecified. Defaults to `SYNCHRONOUS` if unspecified. |
| `SYNCHRONOUS` | The tool is executed synchronously. The session is blocked until the tool returns. |
| `ASYNCHRONOUS` | The tool is executed asynchronously. The session will continue while the tool is executing. |

## ExperimentConfig

Experiment for the deployment.

| Fields ||
|---|---|
| `version_release` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ExperimentConfig.VersionRelease` Optional. Version release for the experiment. |

## State

State of the experiment.

| Enums ||
|---|---|
| `STATE_UNSPECIFIED` | Unspecified state. |
| `PENDING` | Deprecated: This state is no longer used. |
| `RUNNING` | Running state. Experiment is running and valid. |
| `DONE` | Deprecated: This state is no longer used. |
| `EXPIRED` | Deprecated: This state is no longer used. |

## VersionRelease

Version release for the experiment.

| Fields ||
|---|---|
| `state` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ExperimentConfig.State` Optional. State of the version release. |
| `traffic_allocations[]` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ExperimentConfig.VersionRelease.TrafficAllocation` Optional. Traffic allocations for the version release. |

## TrafficAllocation

Traffic allocation for the version release.

| Fields ||
|---|---|
| `id` | `string` Optional. Id of the traffic allocation. Free format string, up to 128 characters. |
| `traffic_percentage` | `int32` Optional. Traffic percentage of the traffic allocation. Must be between 0 and 100. |
| `app_version` | `string` Optional. App version of the traffic allocation. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}` |

## ExportAppRequest

Request message for `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentService.ExportApp`.

| Fields ||
|---|---|
| `name` | `string` Required. The resource name of the app to export. |
| `export_format` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ExportAppRequest.ExportFormat` Required. The format to export the app in. |
| `gcs_uri` | `string` Optional. The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to which to export the app. The format of this URI must be `gs://<bucket-name>/<object-name>`. The exported app archive will be written directly to the specified Cloud Storage object. |
| `app_version` | `string` Optional. The resource name of the app version to export. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}`. |

## ExportFormat

Export format for the app.

| Enums ||
|---|---|
| `EXPORT_FORMAT_UNSPECIFIED` | The export format is unspecified. |
| `JSON` | The export format is JSON. |
| `YAML` | The export format is YAML. |

## ExportAppResponse

Response message for `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentService.ExportApp`.

| Fields ||
|---|---|
| Union field `app`. The exported app. `app` can be only one of the following: ||
| `app_content` | `bytes` App folder compressed as a zip file. |
| `app_uri` | `string` The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to which the app was exported. |

## ExpressionCondition

Expression condition based on session state.

| Fields ||
|---|---|
| `expression` | `string` Required. The string representation of cloud.api.Expression condition. |

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

| Fields ||
|---|---|
| `corpus_type` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.FileSearchTool.CorpusType` Optional. The type of the corpus. Default is FULLY_MANAGED. |
| `name` | `string` Required. The tool name. |
| `description` | `string` Optional. The tool description. |
| `file_corpus` | `string` Optional. The corpus where files are stored. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus} |

## CorpusType

The type of the Vertex RAG corpus.

| Enums ||
|---|---|
| `CORPUS_TYPE_UNSPECIFIED` | Unspecified corpus type. |
| `USER_OWNED` | The corpus is created and owned by the user. |
| `FULLY_MANAGED` | The corpus is created by the agent. |

## GenerateChatTokenRequest

Request message for `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.WidgetService.GenerateChatToken`.

| Fields ||
|---|---|
| `name` | `string` Required. The session name to generate the chat token for. Format: projects/{project}/locations/{location}/apps/{app}/sessions/{session} |
| `deployment` | `string` Required. The deployment of the app to use for the session. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment} |
| `recaptcha_token` | `string` Optional. The reCAPTCHA token generated by the client-side chat widget. |
| `live_handoff_enabled` | `bool` Optional. Indicates if live handoff is enabled for the session. |

## GenerateChatTokenResponse

Response message for `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.WidgetService.GenerateChatToken`.

| Fields ||
|---|---|
| `chat_token` | `string` The session scoped token for chat widget to authenticate with Session APIs. |
| `expire_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` The time at which the chat token expires. |

## GenerateOnboardingSuggestionsRequest

Request message for `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.SessionService.GenerateOnboardingSuggestions`.

| Fields ||
|---|---|
| `name` | `string` Required. The app whose zero state is being rendered. Format: `projects/{project}/locations/{location}/apps/{app}` |
| `max_suggestions` | `int32` Optional. Maximum number of suggestions to return. Defaults to 4 when unset. |

## GenerateOnboardingSuggestionsResponse

Response message for `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.SessionService.GenerateOnboardingSuggestions`.

| Fields ||
|---|---|
| `user_profile` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.GenerateOnboardingSuggestionsResponse.UserProfile` Classification of the requesting user's history. |
| `suggestions[]` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AssistantSuggestion` Personalized suggestions, ranked most relevant first. |
| `context_token` | `string` Opaque token capturing the onboarding snapshot used to generate these suggestions. Clients echo it on the first `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.StreamChatAiAssistantRequest` so the server can reuse the snapshot. |

## UserProfile

Classification of the requesting user's history with the assistant in this app.

| Enums ||
|---|---|
| `USER_PROFILE_UNSPECIFIED` | Unspecified profile. |
| `NEW` | No assistant sessions containing messages. |
| `EXPLORING` | One or two assistant sessions containing messages. |
| `RETURNING` | More than two assistant sessions containing messages. |

## GetAgentRequest

Request message for `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentService.GetAgent`.

| Fields ||
|---|---|
| `name` | `string` Required. The resource name of the agent to retrieve. |

## GetAppRequest

Request message for `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentService.GetApp`.

| Fields ||
|---|---|
| `name` | `string` Required. The resource name of the app to retrieve. |

## GetAppVersionRequest

Request message for `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentService.GetAppVersion`.

| Fields ||
|---|---|
| `name` | `string` Required. The resource name of the app version to retrieve. |

## GetChangelogRequest

Request message for `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentService.GetChangelog`.

| Fields ||
|---|---|
| `name` | `string` Required. The resource name of the changelog to retrieve. |

## GetConversationRequest

Request message for `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentService.GetConversation`.

| Fields ||
|---|---|
| `name` | `string` Required. The resource name of the conversation to retrieve. |
| `source (deprecated)` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Conversation.Source` > [!WARNING] > This item is deprecated! Optional. Indicate the source of the conversation. If not set, all source will be searched. |

## GetDeploymentRequest

Request message for `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentService.GetDeployment`.

| Fields ||
|---|---|
| `name` | `string` Required. The name of the deployment. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}` |

## GetExampleRequest

Request message for `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentService.GetExample`.

| Fields ||
|---|---|
| `name` | `string` Required. The resource name of the example to retrieve. |

## GetGuardrailRequest

Request message for `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentService.GetGuardrail`.

| Fields ||
|---|---|
| `name` | `string` Required. The resource name of the guardrail to retrieve. |

## GetToolRequest

Request message for `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentService.GetTool`.

| Fields ||
|---|---|
| `name` | `string` Required. The resource name of the tool to retrieve. |

## GetToolsetRequest

Request message for `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentService.GetToolset`.

| Fields ||
|---|---|
| `name` | `string` Required. The resource name of the toolset to retrieve. |

## GoAway

This type has no fields.
Indicates that the server will disconnect soon and the client should half-close and restart the connection.

## GoogleSearchSuggestions

Search suggestions from `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.GoogleSearchTool`.

| Fields ||
|---|---|
| `htmls[]` | `string` Compliant HTML and CSS styling for search suggestions. The provided HTML and CSS automatically adapts to your device settings, displaying in either light or dark mode indicated by `@media(prefers-color-scheme)`. |
| `web_search_queries[]` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.WebSearchQuery` List of queries used to perform the google search along with the search result URIs forming the search suggestions. |

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

| Fields ||
|---|---|
| `name` | `string` Required. The name of the tool. |
| `description` | `string` Optional. Description of the tool's purpose. |
| `context_urls[]` | `string` Optional. Content will be fetched directly from these URLs for context and grounding. Example: "https://example.com/path.html". A maximum of 20 URLs are allowed. |
| `preferred_domains[]` | `string` Optional. Specifies domains to restrict search results to. Example: "example.com", "another.site". A maximum of 20 domains can be specified. |
| `exclude_domains[]` | `string` Optional. List of domains to be excluded from the search results. Example: "example.com". A maximum of 2000 domains can be excluded. |
| `prompt_config` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.GoogleSearchTool.PromptConfig` Optional. Prompt instructions passed to planner on how the search results should be processed for text and voice. |

## PromptConfig

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

| Fields ||
|---|---|
| `text_prompt` | `string` Optional. Defines the prompt used for the system instructions when interacting with the agent in chat conversations. If not set, default prompt will be used. |
| `voice_prompt` | `string` Optional. Defines the prompt used for the system instructions when interacting with the agent in voice conversations. If not set, default prompt will be used. |

## Guardrail

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

| Fields ||
|---|---|
| `name` | `string` Identifier. The unique identifier of the guardrail. Format: `projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}` |
| `display_name` | `string` Required. Display name of the guardrail. |
| `description` | `string` Optional. Description of the guardrail. |
| `enabled` | `bool` Optional. Whether the guardrail is enabled. |
| `action` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.TriggerAction` Optional. Action to take when the guardrail is triggered. |
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. Timestamp when the guardrail was created. |
| `update_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. Timestamp when the guardrail was last updated. |
| `etag` | `string` Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes. |
| Union field `guardrail_type`. Guardrail type. `guardrail_type` can be only one of the following: ||
| `content_filter` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Guardrail.ContentFilter` Optional. Guardrail that bans certain content from being used in the conversation. |
| `llm_prompt_security` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Guardrail.LlmPromptSecurity` Optional. Guardrail that blocks the conversation if the prompt is considered unsafe based on the LLM classification. |
| `llm_policy` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Guardrail.LlmPolicy` Optional. Guardrail that blocks the conversation if the LLM response is considered violating the policy based on the LLM classification. |
| `model_safety` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Guardrail.ModelSafety` Optional. Guardrail that blocks the conversation if the LLM response is considered unsafe based on the model safety settings. |
| `code_callback` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Guardrail.CodeCallback` Optional. Guardrail that potentially blocks the conversation based on the result of the callback execution. |
| `supervisor` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Guardrail.Supervisor` Optional. Guardrail that runs supervisor intervention. |

## CodeCallback

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

| Fields ||
|---|---|
| `before_agent_callback` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Callback` Optional. The callback to execute before the agent is called. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing. |
| `after_agent_callback` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Callback` Optional. The callback to execute after the agent is called. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing. |
| `before_model_callback` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Callback` Optional. The callback to execute before the model is called. If there are multiple calls to the model, the callback will be executed multiple times. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing. |
| `after_model_callback` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Callback` Optional. The callback to execute after the model is called. If there are multiple calls to the model, the callback will be executed multiple times. Each callback function is expected to return a structure (e.g., a dict or object) containing at least: - 'decision': Either 'OK' or 'TRIGGER'. - 'reason': A string explaining the decision. A 'TRIGGER' decision may halt further processing. |

## ContentFilter

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

| Fields ||
|---|---|
| `banned_contents[]` | `string` Optional. List of banned phrases. Applies to both user inputs and agent responses. |
| `banned_contents_in_user_input[]` | `string` Optional. List of banned phrases. Applies only to user inputs. |
| `banned_contents_in_agent_response[]` | `string` Optional. List of banned phrases. Applies only to agent responses. |
| `match_type` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Guardrail.ContentFilter.MatchType` Required. Match type for the content filter. |
| `disregard_diacritics` | `bool` Optional. If true, diacritics are ignored during matching. |
| `sensitive_words_exemptions[]` | `string` Optional. Entries of the sensitive words list that this guardrail allows. Only valid when match_type is SENSITIVE_WORDS. Each value must equal a list entry (case-insensitive, surrounding whitespace ignored); other values have no effect. Applies to this guardrail only. At most 1000 entries of up to 256 characters each. |

## MatchType

Match type for the content filter.

| Enums ||
|---|---|
| `MATCH_TYPE_UNSPECIFIED` | Match type is not specified. |
| `SIMPLE_STRING_MATCH` | Content is matched for substrings character by character. |
| `WORD_BOUNDARY_STRING_MATCH` | Content only matches if the pattern found in the text is surrounded by word delimiters. Banned phrases can also contain word delimiters. |
| `REGEXP_MATCH` | Content is matched using regular expression syntax. |
| `SENSITIVE_WORDS` | Content is matched against a system-managed list of sensitive words and phrases. Attaching a guardrail with this match type to an app or agent replaces the default sensitive words filter for the affected agents; disable the guardrail to opt out of the default filter. |

## LlmPolicy

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

| Fields ||
|---|---|
| `max_conversation_messages` | `int32` Optional. When checking this policy, consider the last 'n' messages in the conversation. When not set a default value of 10 will be used. |
| `model_settings` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ModelSettings` Optional. Model settings. |
| `prompt` | `string` Required. Policy prompt. Supports session variable placeholders (`{var}`) as well as `{agent_system_instruction}` to inject the agent's resolved system instructions. |
| `policy_scope` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Guardrail.LlmPolicy.PolicyScope` Required. Defines when to apply the policy check during the conversation. If set to `POLICY_SCOPE_UNSPECIFIED`, the policy will be applied to the user input. When applying the policy to the agent response, additional latency will be introduced before the agent can respond. |
| `fail_open` | `bool` Optional. If an error occurs during the policy check, fail open and do not trigger the guardrail. |
| `allow_short_utterance` | `bool` Optional. By default, the LLM policy check is bypassed for short utterances. Enabling this setting applies the policy check to all utterances, including those that would normally be skipped. |

## PolicyScope

Defines when to apply the policy check during the conversation.

| Enums ||
|---|---|
| `POLICY_SCOPE_UNSPECIFIED` | Policy scope is not specified. |
| `USER_QUERY` | Policy check is triggered on user input. |
| `AGENT_RESPONSE` | Policy check is triggered on agent response. Applying this policy scope will introduce additional latency before the agent can respond. |
| `USER_QUERY_AND_AGENT_RESPONSE` | Policy check is triggered on both user input and agent response. Applying this policy scope will introduce additional latency before the agent can respond. |

## LlmPromptSecurity

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

| Fields ||
|---|---|
| `fail_open` | `bool` Optional. Determines the behavior when the guardrail encounters an LLM error. - If true: the guardrail is bypassed. - If false (default): the guardrail triggers/blocks. Note: If a custom policy is provided, this field is ignored in favor of the policy's 'fail_open' configuration. |
| Union field `security_config`. Defines the security configuration mode. The user must choose one of the following configurations. `security_config` can be only one of the following: ||
| `default_settings` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Guardrail.LlmPromptSecurity.DefaultSecuritySettings` Optional. Use the system's predefined default security settings. To select this mode, include an empty 'default_settings' message in the request. The 'default_prompt_template' field within will be populated by the server in the response. |
| `custom_policy` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Guardrail.LlmPolicy` Optional. Use a user-defined LlmPolicy to configure the security guardrail. |

## DefaultSecuritySettings

Configuration for default system security settings.

| Fields ||
|---|---|
| `default_prompt_template` | `string` Output only. The default prompt template used by the system. This field is for display purposes to show the user what prompt the system uses by default. It is OUTPUT_ONLY. |

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

| Fields ||
|---|---|
| `safety_settings[]` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Guardrail.ModelSafety.SafetySetting` Required. List of safety settings. |

## HarmBlockThreshold

Probability based thresholds levels for blocking.

| Enums ||
|---|---|
| `HARM_BLOCK_THRESHOLD_UNSPECIFIED` | Unspecified harm block threshold. |
| `BLOCK_LOW_AND_ABOVE` | Block low threshold and above (i.e. block more). |
| `BLOCK_MEDIUM_AND_ABOVE` | Block medium threshold and above. |
| `BLOCK_ONLY_HIGH` | Block only high threshold (i.e. block less). |
| `BLOCK_NONE` | Block none. |
| `OFF` | Turn off the safety filter. |

## HarmCategory

Harm category.

| Enums ||
|---|---|
| `HARM_CATEGORY_UNSPECIFIED` | The harm category is unspecified. |
| `HARM_CATEGORY_HATE_SPEECH` | The harm category is hate speech. |
| `HARM_CATEGORY_DANGEROUS_CONTENT` | The harm category is dangerous content. |
| `HARM_CATEGORY_HARASSMENT` | The harm category is harassment. |
| `HARM_CATEGORY_SEXUALLY_EXPLICIT` | The harm category is sexually explicit content. |
| `HARM_CATEGORY_PROFANITY` | The harm category is profanity. |
| `HARM_CATEGORY_TOXIC` | The harm category is toxic. |

## SafetySetting

Safety setting.

| Fields ||
|---|---|
| `category` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Guardrail.ModelSafety.HarmCategory` Required. The harm category. |
| `threshold` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Guardrail.ModelSafety.HarmBlockThreshold` Required. The harm block threshold. |

## Supervisor

Guardrail that runs supervisor intervention.

| Fields ||
|---|---|
| `type` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Guardrail.Supervisor.Type` Optional. The type of the supervisor. |
| `detection_mode` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Guardrail.Supervisor.DetectionMode` Optional. The detection mode of the supervisor. |

## DetectionMode

Detection mode of the supervisor.

| Enums ||
|---|---|
| `DETECTION_MODE_UNSPECIFIED` | Detection mode is unspecified. Default to NON_BLOCKING. |
| `NON_BLOCKING` | Non blocking detection mode. Response is not blocked when the supervisor detection is ongoing. |
| `BLOCKING` | Blocking detection mode. Response is blocked when the supervisor detection is ongoing. |

## Type

Type of supervisor.

| Enums ||
|---|---|
| `TYPE_UNSPECIFIED` | Type is unspecified. |
| `INVALID_TEXT` | Invalid text issue type. |
| `LANGUAGE_SHIFT` | Language shift issue type. |
| `SPEAKER_SHIFT` | Speaker shift issue type. |
| `AUDIO_MISMATCH` | Audio mismatch issue type. |
| `MISSING_TOOL_CALL` | Missing tool call issue type. |
| `CUSTOM` | Custom issue type. |
| `CHOPPY_AUDIO` | Choppy audio issue type. |
| `PROFANITY` | Agent profanity issue type. |

## Image

Represents an image input or output in the conversation.

| Fields ||
|---|---|
| `mime_type` | `string` Required. The IANA standard MIME type of the source data. Supported image types includes: \* image/png \* image/jpeg \* image/webp |
| `data` | `bytes` Required. Raw bytes of the image. |
| `alt_text` | `string` Optional. The alternative text for the image. |

## ImportAppRequest

Request message for `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentService.ImportApp`.

| Fields ||
|---|---|
| `parent` | `string` Required. The parent resource name with the location of the app to import. |
| `display_name` | `string` Optional. The display name of the app to import. \* If the app is created on import, and the display name is specified, the imported app will use this display name. If a conflict is detected with an existing app, a timestamp will be appended to the display name to make it unique. \* If the app is a reimport, this field should not be set. Providing a display name during reimport will result in an INVALID_ARGUMENT error. |
| `app_id` | `string` Optional. The ID to use for the imported app. \* If not specified, a unique ID will be automatically assigned for the app. \* Otherwise, the imported app will use this ID as the final component of its resource name. If an app with the same ID already exists at the specified location in the project, the content of the existing app will be replaced. |
| `import_options` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ImportAppRequest.ImportOptions` Optional. Options governing the import process for the app. |
| `ignore_app_lock` | `bool` Optional. Flag for overriding the app lock during import. If set to true, the import process will ignore the app lock. |
| Union field `app`. The app to import. `app` can be only one of the following: ||
| `gcs_uri` | `string` The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI from which to import app. The format of this URI must be `gs://<bucket-name>/<object-name>`. |
| `app_content` | `bytes` Raw bytes representing the compressed zip file with the app folder structure. |
| Union field `json_patch`. The JSON patches to apply to the imported app. `json_patch` can be only one of the following: ||
| `json_patch_content` | `string` Optional. Patch content as a JSON string. |
| `json_patch_gcs_uri` | `string` Optional. A Cloud Storage URI pointing to a JSON file containing the patches. |

## ImportOptions

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

| Fields ||
|---|---|
| `conflict_resolution_strategy` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ImportAppRequest.ImportOptions.ConflictResolutionStrategy` Optional. The strategy to use when resolving conflicts during import. |
| `validate_only` | `bool` Optional. Flag for dry-running the import process. If set to true, the import process will only perform validations and will not make any changes to the existing app or create a new one. |

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

| Enums ||
|---|---|
| `CONFLICT_RESOLUTION_STRATEGY_UNSPECIFIED` | The conflict resolution strategy is unspecified. |
| `REPLACE` | Replace existing data with imported data. If an app with the same `app_id` already exists, its content will be updated based on the imported 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` | 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 `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentService.ImportApp`.

| Fields ||
|---|---|
| `name` | `string` The resource name of the app that was imported. |
| `warnings[]` | `string` Warning messages generated during the import process. If errors occur for specific resources, they will not be included in the imported app and the error will be mentioned here. |

## InputAudioConfig

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

| Fields ||
|---|---|
| `audio_encoding` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AudioEncoding` Required. The encoding of the input audio data. |
| `sample_rate_hertz` | `int32` Required. The sample rate (in Hertz) of the input audio data. |
| `noise_suppression_level` | `string` Optional. Whether to enable noise suppression on the input audio. Available values are "low", "moderate", "high", "very_high". |

## InstagramCredentials

Ephemeral Meta credentials for Instagram native integration.

| Fields ||
|---|---|
| `auth_code` | `string` Required. The Meta auth code provided by the embedded signup flow. |
| `conversation_profile_id` | `string` Optional. The Conversation Profile ID to use for the deployment. |

## 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).

| Fields ||
|---|---|
| `barge_in` | `bool` Whether the interruption is caused by a user barge-in event. |

## LanguageSettings

Language settings of the app.

| Fields ||
|---|---|
| `default_language_code` | `string` Optional. The default language code of the app. |
| `supported_language_codes[]` | `string` Optional. List of languages codes supported by the app, in addition to the `default_language_code`. |
| `enable_multilingual_support` | `bool` Optional. Enables multilingual support. If `true`, agents in the app will use pre-built instructions to improve handling of multilingual input. |
| `fallback_action (deprecated)` | `string` > [!WARNING] > This item is deprecated! Optional. Deprecated: This feature is no longer supported. Use `enable_multilingual_support` instead to improve handling of multilingual input. The action to perform when an agent receives input in an unsupported language. This can be a predefined action or a custom tool call. Valid values are: - A tool's full resource name, which triggers a specific tool execution. - A predefined system action, such as "escalate" or "exit", which triggers an `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.EndSession` signal with corresponding `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.EndSession.FIELDS.google.protobuf.Struct.google.cloud.ces.v1.EndSession.metadata` to terminate the conversation. |

## ListAgentsRequest

Request message for `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentService.ListAgents`.

| Fields ||
|---|---|
| `parent` | `string` Required. The resource name of the app to list agents from. |
| `page_size` | `int32` Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. |
| `page_token` | `string` Optional. The `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ListAgentsResponse.FIELDS.string.google.cloud.ces.v1.ListAgentsResponse.next_page_token` value returned from a previous list `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentService.ListAgents` call. |
| `filter` | `string` Optional. Filter to be applied when listing the agents. See <https://google.aip.dev/160> for more details. |
| `order_by` | `string` Optional. Field to sort by. Only "name" and "create_time" is supported. See <https://google.aip.dev/132#ordering> for more details. |

## ListAgentsResponse

Response message for `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentService.ListAgents`.

| Fields ||
|---|---|
| `agents[]` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Agent` The list of agents. |
| `next_page_token` | `string` A token that can be sent as `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ListAgentsRequest.FIELDS.string.google.cloud.ces.v1.ListAgentsRequest.page_token` to retrieve the next page. Absence of this field indicates there are no subsequent pages. |

## ListAppVersionsRequest

Request message for `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentService.ListAppVersions`.

| Fields ||
|---|---|
| `parent` | `string` Required. The resource name of the app to list app versions from. |
| `page_size` | `int32` Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. |
| `page_token` | `string` Optional. The `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ListAppVersionsResponse.FIELDS.string.google.cloud.ces.v1.ListAppVersionsResponse.next_page_token` value returned from a previous list `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentService.ListAppVersions` call. |
| `filter` | `string` Optional. Filter to be applied when listing the app versions. See <https://google.aip.dev/160> for more details. |
| `order_by` | `string` Optional. Field to sort by. Only "name" and "create_time" is supported. See <https://google.aip.dev/132#ordering> for more details. |

## ListAppVersionsResponse

Response message for `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentService.ListAppVersions`.

| Fields ||
|---|---|
| `app_versions[]` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AppVersion` The list of app versions. |
| `next_page_token` | `string` A token that can be sent as `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ListAppVersionsRequest.FIELDS.string.google.cloud.ces.v1.ListAppVersionsRequest.page_token` to retrieve the next page. Absence of this field indicates there are no subsequent pages. |

## ListAppsRequest

Request message for `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentService.ListApps`.

| Fields ||
|---|---|
| `parent` | `string` Required. The resource name of the location to list apps from. |
| `page_size` | `int32` Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. |
| `page_token` | `string` Optional. The `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ListAppsResponse.FIELDS.string.google.cloud.ces.v1.ListAppsResponse.next_page_token` value returned from a previous list `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentService.ListApps` call. |
| `filter` | `string` Optional. Filter to be applied when listing the apps. See <https://google.aip.dev/160> for more details. |
| `order_by` | `string` Optional. Field to sort by. Only "name" and "create_time" is supported. See <https://google.aip.dev/132#ordering> for more details. |

## ListAppsResponse

Response message for `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentService.ListApps`.

| Fields ||
|---|---|
| `apps[]` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.App` The list of apps. |
| `next_page_token` | `string` A token that can be sent as `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ListAppsRequest.FIELDS.string.google.cloud.ces.v1.ListAppsRequest.page_token` to retrieve the next page. Absence of this field indicates there are no subsequent pages. |
| `unreachable[]` | `string` Unordered list. Locations that could not be reached. |

## ListChangelogsRequest

Request message for `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentService.ListChangelogs`.

| Fields ||
|---|---|
| `parent` | `string` Required. The resource name of the app to list changelogs from. |
| `page_size` | `int32` Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. |
| `page_token` | `string` Optional. The `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ListChangelogsResponse.FIELDS.string.google.cloud.ces.v1.ListChangelogsResponse.next_page_token` value returned from a previous list `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentService.ListChangelogs` call. |
| `filter` | `string` Optional. Filter to be applied when listing the changelogs. See <https://google.aip.dev/160> for more details. The filter string can be used to filter by `action`, `resource_type`, `resource_name`, `author`, and `create_time`. The `:` comparator can be used for case-insensitive partial matching on string fields, while `=` performs an exact case-sensitive match. Examples: \* `action:update` (case-insensitive partial match) \* `action="Create"` (case-sensitive exact match) \* `resource_type:agent` \* `resource_name:my-agent` \* `author:me@example.com` \* `create_time > "2025-01-01T00:00:00Z"` \* `create_time <= "2025-01-01T00:00:00Z" AND resource_type:tool` |
| `order_by` | `string` Optional. Field to sort by. Only "name" and "create_time" is supported. See <https://google.aip.dev/132#ordering> for more details. |

## ListChangelogsResponse

Response message for `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentService.ListChangelogs`.

| Fields ||
|---|---|
| `changelogs[]` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Changelog` The list of changelogs. |
| `next_page_token` | `string` A token that can be sent as `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ListChangelogsRequest.FIELDS.string.google.cloud.ces.v1.ListChangelogsRequest.page_token` to retrieve the next page. Absence of this field indicates there are no subsequent pages. |

## ListConversationsRequest

Request message for `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentService.ListConversations`.

| Fields ||
|---|---|
| `parent` | `string` Required. The resource name of the app to list conversations from. |
| `page_size` | `int32` Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. |
| `page_token` | `string` Optional. The `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ListConversationsResponse.FIELDS.string.google.cloud.ces.v1.ListConversationsResponse.next_page_token` value returned from a previous list `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentService.ListConversations` call. |
| `filter` | `string` Optional. Filter to be applied when listing the conversations. See <https://google.aip.dev/160> for more details. |
| `source` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Conversation.Source` Optional. Indicate the source of the conversation. If not set, Source.Live will be applied by default. Will be deprecated in favor of `sources` field. |
| `sources[]` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Conversation.Source` Optional. Indicate the sources of the conversations. If not set, all available sources will be applied by default. |

## ListConversationsResponse

Response message for `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentService.ListConversations`.

| Fields ||
|---|---|
| `conversations[]` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Conversation` The list of conversations. |
| `next_page_token` | `string` A token that can be sent as `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ListConversationsRequest.FIELDS.string.google.cloud.ces.v1.ListConversationsRequest.page_token` to retrieve the next page. Absence of this field indicates there are no subsequent pages. |

## ListDeploymentsRequest

Request message for `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentService.ListDeployments`.

| Fields ||
|---|---|
| `parent` | `string` Required. The parent app. Format: `projects/{project}/locations/{location}/apps/{app}` |
| `page_size` | `int32` Optional. The maximum number of deployments to return. The service may return fewer than this value. If unspecified, at most 50 deployments will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
| `page_token` | `string` Optional. A page token, received from a previous `ListDeployments` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDeployments` must match the call that provided the page token. |
| `order_by` | `string` Optional. Field to sort by. Only "name" and "create_time" is supported. See <https://google.aip.dev/132#ordering> for more details. |

## ListDeploymentsResponse

Response message for `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentService.ListDeployments`.

| Fields ||
|---|---|
| `deployments[]` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Deployment` The list of deployments. |
| `next_page_token` | `string` A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |

## ListExamplesRequest

Request message for `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentService.ListExamples`.

| Fields ||
|---|---|
| `parent` | `string` Required. The resource name of the app to list examples from. |
| `page_size` | `int32` Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. |
| `page_token` | `string` Optional. The `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ListExamplesResponse.FIELDS.string.google.cloud.ces.v1.ListExamplesResponse.next_page_token` value returned from a previous list `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentService.ListExamples` call. |
| `filter` | `string` Optional. Filter to be applied when listing the examples. See <https://google.aip.dev/160> for more details. |
| `order_by` | `string` Optional. Field to sort by. Only "name" and "create_time" is supported. See <https://google.aip.dev/132#ordering> for more details. |

## ListExamplesResponse

Response message for `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentService.ListExamples`.

| Fields ||
|---|---|
| `examples[]` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Example` The list of examples. |
| `next_page_token` | `string` A token that can be sent as `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ListExamplesRequest.FIELDS.string.google.cloud.ces.v1.ListExamplesRequest.page_token` to retrieve the next page. Absence of this field indicates there are no subsequent pages. |

## ListGuardrailsRequest

Request message for `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentService.ListGuardrails`.

| Fields ||
|---|---|
| `parent` | `string` Required. The resource name of the app to list guardrails from. |
| `page_size` | `int32` Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. |
| `page_token` | `string` Optional. The `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ListGuardrailsResponse.FIELDS.string.google.cloud.ces.v1.ListGuardrailsResponse.next_page_token` value returned from a previous list `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentService.ListGuardrails` call. |
| `filter` | `string` Optional. Filter to be applied when listing the guardrails. See <https://google.aip.dev/160> for more details. |
| `order_by` | `string` Optional. Field to sort by. Only "name" and "create_time" is supported. See <https://google.aip.dev/132#ordering> for more details. |

## ListGuardrailsResponse

Response message for `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentService.ListGuardrails`.

| Fields ||
|---|---|
| `guardrails[]` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Guardrail` The list of guardrails. |
| `next_page_token` | `string` A token that can be sent as `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ListGuardrailsRequest.FIELDS.string.google.cloud.ces.v1.ListGuardrailsRequest.page_token` to retrieve the next page. Absence of this field indicates there are no subsequent pages. |

## ListToolsRequest

Request message for `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentService.ListTools`.

| Fields ||
|---|---|
| `parent` | `string` Required. The resource name of the app to list tools from. |
| `page_size` | `int32` Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. |
| `page_token` | `string` Optional. The `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ListToolsResponse.FIELDS.string.google.cloud.ces.v1.ListToolsResponse.next_page_token` value returned from a previous list `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentService.ListTools` call. |
| `filter` | `string` Optional. Filter to be applied when listing the tools. Use "include_system_tools=true" to include system tools in the response. See <https://google.aip.dev/160> for more details. |
| `order_by` | `string` Optional. Field to sort by. Only "name" and "create_time" is supported. See <https://google.aip.dev/132#ordering> for more details. |

## ListToolsResponse

Response message for `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentService.ListTools`.

| Fields ||
|---|---|
| `tools[]` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Tool` The list of tools. |
| `next_page_token` | `string` A token that can be sent as `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ListToolsRequest.FIELDS.string.google.cloud.ces.v1.ListToolsRequest.page_token` to retrieve the next page. Absence of this field indicates there are no subsequent pages. |

## ListToolsetsRequest

Request message for `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentService.ListToolsets`.

| Fields ||
|---|---|
| `parent` | `string` Required. The resource name of the app to list toolsets from. |
| `page_size` | `int32` Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. |
| `page_token` | `string` Optional. The `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ListToolsetsResponse.FIELDS.string.google.cloud.ces.v1.ListToolsetsResponse.next_page_token` value returned from a previous list `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentService.ListToolsets` call. |
| `filter` | `string` Optional. Filter to be applied when listing the toolsets. See <https://google.aip.dev/160> for more details. |
| `order_by` | `string` Optional. Field to sort by. Only "name" and "create_time" is supported. See <https://google.aip.dev/132#ordering> for more details. |

## ListToolsetsResponse

Response message for `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentService.ListToolsets`.

| Fields ||
|---|---|
| `toolsets[]` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Toolset` The list of toolsets. |
| `next_page_token` | `string` A token that can be sent as `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ListToolsetsRequest.FIELDS.string.google.cloud.ces.v1.ListToolsetsRequest.page_token` to retrieve the next page. Absence of this field indicates there are no subsequent pages. |

## LoggingSettings

Settings to describe the logging behaviors for the app.

| Fields ||
|---|---|
| `redaction_config` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.RedactionConfig` Optional. Configuration for how sensitive data should be redacted. |
| `audio_recording_config` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AudioRecordingConfig` Optional. Configuration for how audio interactions should be recorded. The audio is subject to redaction as configured in `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.LoggingSettings.FIELDS.google.cloud.ces.v1.RedactionConfig.google.cloud.ces.v1.LoggingSettings.redaction_config`. |
| `unredacted_audio_recording_config` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AudioRecordingConfig` Optional. Configures an additional recording of unredacted audio. This can be used to maintain a raw audio copy when audio redaction is `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.RedactionConfig.FIELDS.bool.google.cloud.ces.v1.RedactionConfig.enable_redaction`, typically for auditing or monitoring purposes. |
| `bigquery_export_settings` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.BigQueryExportSettings` Optional. Configures the BigQuery export behaviors for the app. The conversation data is subject to redaction as configured in `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.LoggingSettings.FIELDS.google.cloud.ces.v1.RedactionConfig.google.cloud.ces.v1.LoggingSettings.redaction_config`. |
| `unredacted_bigquery_export_settings` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.BigQueryExportSettings` Optional. Configures the BigQuery export behaviors for the app. The unredacted conversation data will be exported to BigQuery tables if it is enabled. |
| `cloud_logging_settings` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.CloudLoggingSettings` Optional. Settings to describe the Cloud Logging behaviors for the app. |
| `conversation_logging_settings` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ConversationLoggingSettings` Optional. Settings to describe the conversation logging behaviors for the app. |
| `evaluation_audio_recording_config` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AudioRecordingConfig` Optional. Configuration for how audio interactions should be recorded for the evaluation. By default, audio recording is not enabled for evaluation sessions. |
| `metric_analysis_settings` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.MetricAnalysisSettings` Optional. Settings to describe the conversation data collection behaviors for the LLM analysis pipeline for the app. |
| `required_recording_consent` | `bool` Optional. Whether the app has to say what may be recorded before anything is kept. When true, a session starts with recording off and stays off until the client sends `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1main#google.cloud.ces.v1main.SessionInput.FIELDS.google.cloud.ces.v1main.SessionInput.RecordingControl.google.cloud.ces.v1main.SessionInput.recording_control`, which then decides every turn from that point on. This covers audio recording as well as conversation history, BigQuery export and Cloud Logging. When `false`, the default, the settings above decide on their own and the client does not have to send anything. |

## McpTool

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

| Fields ||
|---|---|
| `name` | `string` Required. The name of the MCP tool. |
| `name_override` | `string` Optional. The name override of the MCP tool. This is populated if the name was overridden by a Toolset override. |
| `description` | `string` Optional. The description of the MCP tool. |
| `input_schema` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Schema` Optional. The schema of the input arguments of the MCP tool. |
| `output_schema` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Schema` Optional. The schema of the output arguments of the MCP tool. |
| `server_address` | `string` Required. The server address of the MCP server, e.g., "https://example.com/mcp/". If the server is built with the MCP SDK, the url should be suffixed with "/mcp/". Only Streamable HTTP transport based servers are supported. This is the same as the server_address in the McpToolset. See <https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http> for more details. |
| `api_authentication` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ApiAuthentication` Optional. Authentication information required to execute the tool against the MCP server. For bearer token authentication, the token applies only to tool execution, not to listing tools. This requires that tools can be listed without authentication. |
| `tls_config` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.TlsConfig` Optional. The TLS configuration. Includes the custom server certificates that the client should trust. |
| `service_directory_config` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ServiceDirectoryConfig` Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter. |
| `custom_headers` | `map<string, string>` Optional. The custom headers to send in the request to the MCP server. The values must be in the format `$context.variables.<name_of_variable>` and can be set in the session variables. See <https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection> for more details. |
| `state` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.McpTool.State` Output only. The dynamic availability state of the tool on the external server. |

## State

Represents the dynamic availability state of the tool.

| Enums ||
|---|---|
| `STATE_UNSPECIFIED` | Default state. |
| `ACTIVE` | The tool is available and actively offered by the server. |
| `INACTIVE` | The tool is configured or pinned, but currently not offered by the server. |
| `STALE` | The tool exists on the server, but does not match the version on the server. |

## McpToolDefinition

Container for a tool's core definition elements that are snapshot. Schemas in the snapshot are used as-is and cannot be overridden.

| Fields ||
|---|---|
| `description` | `string` Output only. The description of the MCP tool. This can be overridden by `description_override` in `McpToolOverride`. |
| `input_schema` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Schema` Output only. The schema of the input arguments of the MCP tool. |
| `output_schema` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Schema` Output only. The schema of the output arguments of the MCP tool. |

## McpToolOverride

Overrides associated with a given tool in a Toolset. This enables "pinning" or "overriding" of tool definitions from the external dynamic server.

| Fields ||
|---|---|
| `tool` | `string` Required. The original name of the tool as it is emitted by the MCP server. |
| `name_override` | `string` Optional. If present, this tool uses this name in the Agent instead of the original name. This is primarily used as an alias if the MCP server offers poorly named tools. |
| `description_override` | `string` Optional. If present, this tool uses this description instead of the original description from the server. |
| `snapshot` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.McpToolDefinition` Output only. If present, this tool is "Pinned" and uses the snapshot values as fallbacks if the server becomes temporarily unavailable or if no Override is present. |

## McpToolset

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

| Fields ||
|---|---|
| `server_address` | `string` Required. The address of the MCP server, for example, "https://example.com/mcp/". If the server is built with the MCP SDK, the url should be suffixed with "/mcp/". Only Streamable HTTP transport based servers are supported. See <https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http> for more details. |
| `api_authentication` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ApiAuthentication` Optional. Authentication information required to access tools and execute a tool against the MCP server. For bearer token authentication, the token applies only to tool execution, not to listing tools. This requires that tools can be listed without authentication. |
| `service_directory_config` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ServiceDirectoryConfig` Optional. Service Directory configuration for VPC-SC, used to resolve service names within a perimeter. |
| `tls_config` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.TlsConfig` Optional. The TLS configuration. Includes the custom server certificates that the client should trust. |
| `custom_headers` | `map<string, string>` Optional. The custom headers to send in the request to the MCP server. The values must be in the format `$context.variables.<name_of_variable>` and can be set in the session variables. See <https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection> for more details. |
| `tool_overrides[]` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.McpToolOverride` Optional. Overrides for individual tools within this toolset. This allows overriding specific details like descriptions, names, or pinning the tools' states so they aren't fully dynamic. |

## Message

A message within a conversation.

| Fields ||
|---|---|
| `role` | `string` Optional. The role within the conversation, e.g., user, agent. |
| `chunks[]` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Chunk` Optional. Content of the message as a series of chunks. |
| `event_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Optional. Timestamp when the message was sent or received. Should not be used if the message is part of an `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Example`. |

## MetricAnalysisSettings

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

| Fields ||
|---|---|
| `llm_metrics_opted_out` | `bool` Optional. Whether to collect conversation data for llm analysis metrics. If true, conversation data will not be collected for llm analysis metrics; otherwise, conversation data will be collected. |

## MockConfig

Mock tool calls configuration for the session.

| Fields ||
|---|---|
| `mocked_tool_calls[]` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.MockedToolCall` Optional. All tool calls to mock for the duration of the session. |
| `unmatched_tool_call_behavior` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.MockConfig.UnmatchedToolCallBehavior` Required. Beavhior for tool calls that don't match any args patterns in mocked_tool_calls. |

## UnmatchedToolCallBehavior

What to do when a tool call doesn't match any mocked tool calls.

| Enums ||
|---|---|
| `UNMATCHED_TOOL_CALL_BEHAVIOR_UNSPECIFIED` | Default value. This value is unused. |
| `FAIL` | Throw an error for any tool calls that don't match a mock expected input pattern. |
| `PASS_THROUGH` | For unmatched tool calls, pass the tool call through to real tool. |

## MockedToolCall

A mocked tool call.

Expresses the target tool + a pattern to match against that tool's args / inputs. If the pattern matches, then the mock response will be returned.

| Fields ||
|---|---|
| `tool (deprecated)` | `string` > [!WARNING] > This item is deprecated! Optional. Deprecated. Use tool_identifier instead. |
| `expected_args_pattern` | `https://protobuf.dev/reference/protobuf/google.protobuf#struct` Required. A pattern to match against the args / inputs of all dispatched tool calls. If the tool call inputs match this pattern, then mock output will be returned. |
| `mock_response` | `https://protobuf.dev/reference/protobuf/google.protobuf#struct` Optional. The mock response / output to return if the tool call args / inputs match the pattern. |
| Union field `tool_identifier`. The identifier of the tool to mock. `tool_identifier` can be only one of the following: ||
| `tool_id` | `string` Optional. The name of the tool to mock. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` |
| `toolset` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ToolsetTool` Optional. The toolset to mock. |

## ModelSettings

Model settings contains various configurations for the LLM model.

| Fields ||
|---|---|
| `model` | `string` Optional. The LLM model that the agent should use. If not set, the agent will inherit the model from its parent agent. |
| `thinking_level` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ModelSettings.ThinkingLevel` Optional. The thinking level of the model. |
| `temperature` | `double` Optional. If set, this temperature will be used for the LLM model. Temperature controls the randomness of the model's responses. Lower temperatures produce responses that are more predictable. Higher temperatures produce responses that are more creative. |

## ThinkingLevel

Thinking level configuration for the model.

| Enums ||
|---|---|
| `THINKING_LEVEL_UNSPECIFIED` | Thinking level is unspecified. |
| `DEFAULT` | Default thinking level. |
| `LOW` | Low thinking level. |
| `MEDIUM` | Medium thinking level. |
| `HIGH` | High thinking level. |

## OAuthConfig

Configurations for authentication with OAuth.

| Fields ||
|---|---|
| `oauth_grant_type` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.OAuthConfig.OauthGrantType` Required. OAuth grant types. |
| `client_id` | `string` Required. The client ID from the OAuth provider. |
| `client_secret_version` | `string` Required. The name of the SecretManager secret version resource storing the client secret. Format: `projects/{project}/secrets/{secret}/versions/{version}` Note: You should grant `roles/secretmanager.secretAccessor` role to the CES service agent `service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com`. |
| `token_endpoint` | `string` Required. The token endpoint in the OAuth provider to exchange for an access token. |
| `scopes[]` | `string` Optional. The OAuth scopes to grant. |

## OauthGrantType

OAuth grant types. Only [client credential grant](https://oauth.net/2/grant-types/client-credentials) is supported.

| Enums ||
|---|---|
| `OAUTH_GRANT_TYPE_UNSPECIFIED` | Unspecified. Defaults to CLIENT_CREDENTIAL. |
| `CLIENT_CREDENTIAL` | Represents the [client credential flow](https://oauth.net/2/grant-types/client-credentials). |

## OpenApiTool

A remote API tool defined by an OpenAPI schema.

| Fields ||
|---|---|
| `open_api_schema` | `string` Required. The OpenAPI schema in JSON or YAML format. |
| `name` | `string` Optional. The name of the tool. If not provided, the name of the tool will be derived from the OpenAPI schema, from `operation.operationId`. |
| `description` | `string` Optional. The description of the tool. If not provided, the description of the tool will be derived from the OpenAPI schema, from `operation.description` or `operation.summary`. |
| `api_authentication` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ApiAuthentication` Optional. Authentication information required by the API. |
| `tls_config` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.TlsConfig` Optional. The TLS configuration. Includes the custom server certificates that the client will trust. |
| `service_directory_config` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ServiceDirectoryConfig` Optional. Service Directory configuration. |
| `ignore_unknown_fields` | `bool` Optional. If true, the agent will ignore unknown fields in the API response. |
| `url` | `string` Optional. The server URL of the Open API schema. This field is only set in tools in the environment dependencies during the export process if the schema contains a server url. During the import process, if this url is present in the environment dependencies and the schema has the $env_var placeholder, it will replace the placeholder in the schema. |

## OpenApiToolset

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

| Fields ||
|---|---|
| `open_api_schema` | `string` Required. The OpenAPI schema of the toolset. |
| `api_authentication` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ApiAuthentication` Optional. Authentication information required by the API. |
| `tls_config` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.TlsConfig` Optional. The TLS configuration. Includes the custom server certificates |
| `service_directory_config` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ServiceDirectoryConfig` Optional. Service Directory configuration. |
| `ignore_unknown_fields` | `bool` Optional. If true, the agent will ignore unknown fields in the API response for all operations defined in the OpenAPI schema. |
| `url` | `string` Optional. The server URL of the Open API schema. This field is only set in toolsets in the environment dependencies during the export process if the schema contains a server url. During the import process, if this url is present in the environment dependencies and the schema has the $env_var placeholder, it will replace the placeholder in the schema. |

## OperationCompletedEvent

Event sent by the client or background worker to resume an assistant session after an asynchronous Long-Running Operation (LRO) completes.

| Fields ||
|---|---|
| `operation_name` | `string` The operation resource name (e.g. `operations/{op}`). |
| `target_resource_name` | `string` The primary resource targeted or produced by the operation (e.g. evaluation run ID, app ID, dataset ID). |
| `operation_type` | `string` The operation type or tool name (e.g. "run_evaluation", "copy_app", "export_app"). |
| `status` | `string` Status of the operation run (e.g. "SUCCEEDED", "FAILED", "CANCELLED"). |
| `deduplication_token` | `string` Optional deduplication token (e.g. UUID) to prevent duplicate turn execution from concurrent browser tabs. |
| `error` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.rpc#google.rpc.Status` Optional canonical error status if the operation failed. |
| `metadata` | `https://protobuf.dev/reference/protobuf/google.protobuf#struct` Optional structured result metadata (e.g. pass_rate, total_examples, export_uri). |

## OperationMetadata

Represents the metadata of the long-running operation.

| Fields ||
|---|---|
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. The time the operation was created. |
| `end_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. The time the operation finished running. |
| `status_message` | `string` Output only. Human-readable status of the operation, if any. |
| `requested_cancellation` | `bool` Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.longrunning#google.longrunning.Operation.FIELDS.google.rpc.Status.google.longrunning.Operation.error` value with a `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.rpc#google.rpc.Status.FIELDS.int32.google.rpc.Status.code` of `1`, corresponding to `Code.CANCELLED`. |

## OptionQuestionsChunk

Structured clarification options the assistant asks the user to choose among, transduced server-side out of the model's turn (the option block is stripped from the streamed and persisted text). The console renders a keyboard-navigable option list docked above the composer.

| Fields ||
|---|---|
| `questions[]` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.OptionQuestionsChunk.Question` The questions asked this turn. More than one entry drives the console's "1 of N" pager. |

## Option

A single selectable option.

| Fields ||
|---|---|
| `title` | `string` Short plain-text option title (no markdown, no numbering). |
| `details` | `string` Optional trade-off details shown as secondary text. |
| `submit_text` | `string` Optional message text to send when the option is chosen; defaults to `title` when empty. |

## Question

One question with its options.

| Fields ||
|---|---|
| `question` | `string` The question header text. |
| `options[]` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.OptionQuestionsChunk.Option` The selectable options, in presentation order. |

## OutputAudioConfig

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

| Fields ||
|---|---|
| `audio_encoding` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AudioEncoding` Required. The encoding of the output audio data. |
| `sample_rate_hertz` | `int32` Required. The sample rate (in Hertz) of the output audio data. |

## PythonCodeCondition

Python code block to evaluate the condition.

| Fields ||
|---|---|
| `python_code` | `string` Required. The python code to execute. |

## PythonFunction

A Python function tool.

| Fields ||
|---|---|
| `name` | `string` Optional. The name of the Python function to execute. Must match a Python function name defined in the python code. Case sensitive. If the name is not provided, the first function defined in the python code will be used. |
| `python_code` | `string` Optional. The Python code to execute for the tool. |
| `description` | `string` Output only. The description of the Python function, parsed from the python code's docstring. |
| `service_directory_config` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ServiceDirectoryConfig` Optional. Service Directory configuration for the tool. |

## RecognitionResult

Speech recognition result for the audio input.

| Fields ||
|---|---|
| `transcript` | `string` Optional. Concatenated user speech segments captured during the current turn. |

## RedactionConfig

Configuration to instruct how sensitive data should be handled.

| Fields ||
|---|---|
| `enable_redaction` | `bool` Optional. If `true`, redaction will be applied in various logging scenarios, including conversation history, Cloud Logging and audio recording. |
| `inspect_template` | `string` Optional. [DLP](https://cloud.google.com/dlp/docs) inspect template name to configure detection of sensitive data types. Format: `projects/{project}/locations/{location}/inspectTemplates/{inspect_template}` |
| `deidentify_template` | `string` Optional. [DLP](https://cloud.google.com/dlp/docs) deidentify template name to instruct on how to de-identify content. Format: `projects/{project}/locations/{location}/deidentifyTemplates/{deidentify_template}` |

## RemoteA2aConfig

Shared configuration for connecting to a remote [A2A](https://github.com/a2aproject/A2A) agent.

| Fields ||
|---|---|
| `api_authentication` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ApiAuthentication` Optional. Authentication configuration for calling the remote agent. Optional if the registry reference already handles authentication. |
| `input_variable_mapping` | `map<string, string>` Optional. Mapping of input variable names of remote agent to GECX variable names. |
| `output_variable_mapping` | `map<string, string>` Optional. Mapping of output variable names of remote agent to GECX variable names. |
| `streaming_enabled` | `bool` Optional. Whether streaming is enabled for the remote agent. |
| `context_id` | `string` Optional. If not empty, interactions with the remote A2A agent will use this context ID. This context_id field can refer to a session variable like `$context.variables.order_agent_session_id`. |
| Union field `agent_spec`. Specification of the remote agent. `agent_spec` can be only one of the following: ||
| `agent_card` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentCard` Optional. The full agent card defined inline. |
| `agent_registry` | `string` Optional. Reference to the agent in the Agent Registry. Format: `projects/{project}/locations/{location}/agents/{agent}` |

## RemoteAgentTool

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

| Fields ||
|---|---|
| `name` | `string` Required. The name of the tool. |
| `description` | `string` Required. The description of the tool. |
| `agent_card` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentCard` Required. The agent card of the remote agent that this tool invokes. |
| `api_authentication` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ApiAuthentication` Optional. Authentication configuration for calling the remote agent. |
| `stateful_agent` | `bool` Optional. When enabled, the interaction between the CXAS app and the remote agent will share the same context. If the remote agent returns a context_id, it will be persisted for the entirety of the session for this remote agent tool. |
| `input_variable_mapping` | `map<string, string>` Optional. Mapping of input variable names of remote agent to GECX variable names. |
| `output_variable_mapping` | `map<string, string>` Optional. Mapping of output variable names of remote agent to GECX variable names. |

## RestoreAppVersionRequest

Request message for `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentService.RestoreAppVersion`

| Fields ||
|---|---|
| `name` | `string` Required. The resource name of the app version to restore. |

## RestoreAppVersionResponse

This type has no fields.
Response message for `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentService.RestoreAppVersion`

## RetrieveToolSchemaRequest

Request message for `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ToolService.RetrieveToolSchema`.

| Fields ||
|---|---|
| `parent` | `string` Required. The resource name of the app which the tool/toolset belongs to. Format: `projects/{project}/locations/{location}/apps/{app}` |
| Union field `tool_identifier`. The identifier of the tool to retrieve the schema for. It could be either a persisted tool or a tool from a toolset. `tool_identifier` can be only one of the following: ||
| `tool` | `string` Optional. The name of the tool to retrieve the schema for. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool} |
| `toolset_tool` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ToolsetTool` Optional. The toolset tool to retrieve the schema for. Only one tool should match the predicate from the toolset. Otherwise, an error will be returned. |

## RetrieveToolSchemaResponse

Response message for `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ToolService.RetrieveToolSchema`.

| Fields ||
|---|---|
| `input_schema` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Schema` The schema of the tool input parameters. |
| `output_schema` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Schema` The schema of the tool output parameters. |
| Union field `tool_identifier`. The identifier of the tool that the schema is for. `tool_identifier` can be only one of the following: ||
| `tool` | `string` The name of the tool that the schema is for. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` |
| `toolset_tool` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ToolsetTool` The toolset tool that the schema is for. |

## RetrieveToolsRequest

Request message for `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ToolService.RetrieveTools`.

| Fields ||
|---|---|
| `toolset` | `string` Required. The name of the toolset to retrieve the tools for. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` |
| `tool_ids[]` | `string` Optional. The identifiers of the tools to retrieve from the toolset. If empty, all tools in the toolset will be returned. |
| `bypass_persistence_config` | `bool` Optional. If true, the returned tools will contain raw descriptions and schemas directly from the server, bypassing any stored persistence configurations (overrides/snapshots). |

## RetrieveToolsResponse

Response message for `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ToolService.RetrieveTools`.

| Fields ||
|---|---|
| `tools[]` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Tool` The list of tools that are included in the specified toolset. |

## RunSessionRequest

Request message for `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.SessionService.RunSession`.

| Fields ||
|---|---|
| `config` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.SessionConfig` Required. The configuration for the session. |
| `inputs[]` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.SessionInput` Required. Inputs for the session. |

## RunSessionResponse

Response message for `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.SessionService.RunSession`.

| Fields ||
|---|---|
| `outputs[]` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.SessionOutput` Outputs for the session. |

## Schema

Represents a select subset of an OpenAPI 3.0 schema object.

| Fields ||
|---|---|
| `type` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Schema.Type` Required. The type of the data. |
| `properties` | ``map<string, `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Schema`>`` Optional. Properties of Type.OBJECT. |
| `required[]` | `string` Optional. Required properties of Type.OBJECT. |
| `description` | `string` Optional. The description of the data. |
| `items` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Schema` Optional. Schema of the elements of Type.ARRAY. |
| `nullable` | `bool` Optional. Indicates if the value may be null. |
| `unique_items` | `bool` Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY. |
| `prefix_items[]` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Schema` Optional. Schemas of initial elements of Type.ARRAY. |
| `additional_properties` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Schema` Optional. Can either be a boolean or an object, controls the presence of additional properties. |
| `any_of[]` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Schema` Optional. The value should be validated against any (one or more) of the subschemas in the list. |
| `enum[]` | `string` Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:\["EAST", NORTH", "SOUTH", "WEST"\]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:\["101", "201", "301"\]} |
| `default` | `https://protobuf.dev/reference/protobuf/google.protobuf#value` Optional. Default value of the data. |
| `ref` | `string` Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in <https://json-schema.org/understanding-json-schema/structuring>. |
| `defs` | ``map<string, `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Schema`>`` Optional. A map of definitions for use by `ref`. Only allowed at the root of the schema. |
| `title` | `string` Optional. The title of the schema. |
| `min_items` | `int64` Optional. Minimum number of the elements for Type.ARRAY. |
| `max_items` | `int64` Optional. Maximum number of the elements for Type.ARRAY. |
| `minimum` | `double` Optional. Minimum value for Type.INTEGER and Type.NUMBER. |
| `maximum` | `double` Optional. Maximum value for Type.INTEGER and Type.NUMBER. |

## Type

OpenAPI data types.

| Enums ||
|---|---|
| `TYPE_UNSPECIFIED` | Type unspecified. |
| `STRING` | String type. |
| `INTEGER` | Integer type. |
| `NUMBER` | Number type. |
| `BOOLEAN` | Boolean type. |
| `OBJECT` | Object type. |
| `ARRAY` | Array type. |

## SecuritySettings

Project/Location level security settings for CES.

| Fields ||
|---|---|
| `name` | `string` Identifier. The unique identifier of the security settings. Format: `projects/{project}/locations/{location}/securitySettings` |
| `endpoint_control_policy` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.EndpointControlPolicy` Optional. Endpoint control related settings. |
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. Create time of the security settings. |
| `update_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. Last update time of the security settings. |
| `etag` | `string` Output only. Etag of the security settings. |

## ServiceAccountAuthConfig

Configurations for authentication using a custom service account.

| Fields ||
|---|---|
| `service_account` | `string` Required. The email address of the service account used for authentication. CES uses this service account to exchange an access token and the access token is then sent in the `Authorization` header of the request. The service account must have the `roles/iam.serviceAccountTokenCreator` role granted to the CES service agent `service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com`. |
| `scopes[]` | `string` Optional. The OAuth scopes to grant. If not specified, the default scope `https://www.googleapis.com/auth/cloud-platform` is used. |

## ServiceAgentIdTokenAuthConfig

This type has no fields.
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.

| Fields ||
|---|---|
| `service` | `string` Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}`. Location of the service directory must be the same as the location of the app. |

## SessionCheckpoint

Session checkpoint containing inferred user intent for session title and UI.

| Fields ||
|---|---|
| `user_intent` | `string` Inferred user goal or topic for the session (e.g. "Building E-Commerce Support Agent"). |

## SessionConfig

The configuration for the session.

| Fields ||
|---|---|
| `session` | `string` Required. The unique identifier of the session. Format: `projects/{project}/locations/{location}/apps/{app}/sessions/{session}` |
| `input_audio_config` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.InputAudioConfig` Optional. Configuration for processing the input audio. |
| `output_audio_config` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.OutputAudioConfig` Optional. Configuration for generating the output audio. |
| `historical_contexts[]` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Message` Optional. The historical context of the session, including user inputs, agent responses, and other messages. Typically, CES agent would manage session automatically so client doesn't need to explicitly populate this field. However, client can optionally override the historical contexts to force the session start from certain state. |
| `entry_agent` | `string` Optional. The entry agent to handle the session. If not specified, the session will be handled by the `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.App.FIELDS.string.google.cloud.ces.v1.App.root_agent` of the app. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` |
| `deployment` | `string` Optional. The deployment of the app to use for the session. Format: `projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}` |
| `time_zone` | `string` Optional. The time zone of the user. If provided, the agent will use the time zone for date and time related variables. Otherwise, the agent will use the time zone specified in the App.time_zone_settings. The format is the IANA Time Zone Database time zone, e.g. "America/Los_Angeles". |
| `use_tool_fakes` | `bool` Optional. Whether to use tool fakes for the session. If this field is set, the agent will attempt use tool fakes instead of calling the real tools. |
| `remote_dialogflow_query_parameters` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.SessionConfig.RemoteDialogflowQueryParameters` Optional. [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. |
| `enable_text_streaming` | `bool` Optional. Whether to stream text output from the model to the client incrementally as it is generated. Defaults to `false`. - When disabled, the model's text output is buffered, and each text output sent to the client is a complete sentence. Clients can render each text output on a new line. - When enabled, each text output may contain only part of a sentence. Clients should concatenate consecutive text outputs to render the complete response. NOTE: This is only supported for text (non-voice) sessions using `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.SessionService.StreamRunSession` or `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.SessionService.BidiRunSession`. |
| `include_llm_thought_summary` | `bool` Optional. Whether to include LLM thought summaries in the session outputs. |
| `exclude_diagnostic_info` | `bool` Optional. Whether to exclude diagnostic info from the session output. |
| `include_progress_update` | `bool` Optional. Whether to include intermediate processing update to the client. If enabled, the update will be sent back in `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.SessionOutput.FIELDS.string.google.cloud.ces.v1.SessionOutput.progress`. |

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

| Fields ||
|---|---|
| `webhook_headers` | `map<string, string>` Optional. The HTTP headers to be sent as webhook_headers in [QueryParameters](https://cloud.google.com/dialogflow/cx/docs/reference/rpc/google.cloud.dialogflow.cx.v3#queryparameters). |
| `payload` | `https://protobuf.dev/reference/protobuf/google.protobuf#struct` Optional. The payload to be sent in [QueryParameters](https://cloud.google.com/dialogflow/cx/docs/reference/rpc/google.cloud.dialogflow.cx.v3#queryparameters). |
| `end_user_metadata` | `https://protobuf.dev/reference/protobuf/google.protobuf#struct` Optional. The end user metadata to be sent in [QueryParameters](https://cloud.google.com/dialogflow/cx/docs/reference/rpc/google.cloud.dialogflow.cx.v3#queryparameters). |

## SessionInput

Input for the session.

| Fields ||
|---|---|
| `will_continue` | `bool` Optional. A flag to indicate if the current message is a fragment of a larger input in the bidi streaming session. When set to `true`, the agent defers processing until it receives a subsequent message where `will_continue` is `false`, or until the system detects an endpoint in the audio input. NOTE: This field does not apply to audio and DTMF inputs, as they are always processed automatically based on the endpointing signal. |
| `recording_control` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.SessionInput.RecordingControl` Optional. Whether the conversation may be recorded and logged from here on. Use this when the app, rather than the agent, decides what may be kept: for example when the end user has to consent to being recorded before anything about the call can be stored. The value stays in effect until the client sends a different one, so it only needs to be sent when the answer changes. Whatever is in effect when a turn completes decides that turn, both whether its audio reaches the recording bucket and whether its transcript reaches conversation history, BigQuery and Cloud Logging. It covers the agent's side of the turn as well as the end user's. Turns that complete before the client first sends this are recorded according to the app's logging settings, as though the field did not exist. If more than one input in the same request sets it, the last one wins. |
| Union field `input_type`. The type of the input. `input_type` can be only one of the following: ||
| `text` | `string` Optional. Text data from the end user. |
| `dtmf` | `string` Optional. DTMF digits from the end user. |
| `audio` | `bytes` Optional. Audio data from the end user. |
| `tool_responses` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ToolResponses` Optional. Execution results for the tool calls from the client. |
| `image` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Image` Optional. Image data from the end user. |
| `blob` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Blob` Optional. Blob data from the end user. |
| `variables` | `https://protobuf.dev/reference/protobuf/google.protobuf#struct` Optional. Contextual variables for the session, keyed by name. Only variables declared in the app will be used by the CES agent. Unrecognized variables will still be sent to the \[Dialogflow agent\]\[Agent.RemoteDialogflowAgent\] as additional session parameters. |
| `event` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Event` Optional. Event input. |

## RecordingControl

What the app has decided may be recorded and logged.

This enum is extensible; new values may be added in the future.

| Enums ||
|---|---|
| `RECORDING_CONTROL_UNSPECIFIED` | The app is not controlling recording. The app's logging settings decide, as they do for every session that never sets this field. |
| `RECORDING_ENABLED` | The conversation may be recorded and logged from here on. |
| `RECORDING_DISABLED` | The conversation may not be recorded or logged from here on. |

## SessionOutput

Output for the session.

| Fields ||
|---|---|
| `turn_index` | `int32` Indicates the sequential order of conversation turn to which this output belongs to, starting from 1. |
| `turn_completed` | `bool` If true, the CES agent has detected the end of the current conversation turn and will provide no further output for this turn. |
| `diagnostic_info` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.SessionOutput.DiagnosticInfo` Optional. Diagnostic information contains execution details during the processing of the input. Only populated in the last SessionOutput (with `turn_completed=true`) for each turn. |
| Union field `output_type`. The type of the output. `output_type` can be only one of the following: ||
| `text` | `string` Output text from the CES agent. |
| `audio` | `bytes` Output audio from the CES agent. |
| `tool_calls` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ToolCalls` Request for the client to execute the tools. |
| `citations` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Citations` Citations that provide the source information for the agent's generated text. |
| `google_search_suggestions` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.GoogleSearchSuggestions` The suggestions returned from Google Search as a result of invoking the `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.GoogleSearchTool`. |
| `end_session` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.EndSession` Indicates the session has ended. |
| `payload` | `https://protobuf.dev/reference/protobuf/google.protobuf#struct` Custom payload with structured output from the CES agent. |
| `image` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Image` Output image from the CES agent. |
| `progress` | `string` Intermediate progress update from the CES agent. |

## DiagnosticInfo

Contains execution details during the processing.

| Fields ||
|---|---|
| `messages[]` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Message` List of the messages that happened during the processing. |
| `root_span` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Span` A trace of the entire request processing, represented as a root span. This span can contain nested child spans for specific operations. |

## Span

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

| Fields ||
|---|---|
| `name` | `string` Output only. The name of the span. |
| `start_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. The start time of the span. |
| `end_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. The end time of the span. |
| `duration` | `https://protobuf.dev/reference/protobuf/google.protobuf#duration` Output only. The duration of the span. |
| `attributes` | `https://protobuf.dev/reference/protobuf/google.protobuf#struct` Output only. Key-value attributes associated with the span. |
| `child_spans[]` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Span` Output only. The child spans that are nested under this span. |

## StreamChatAiAssistantRequest

Request message for `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.SessionService.StreamChatAiAssistant`.

| Fields ||
|---|---|
| `name` | `string` Required. The assistant session to be used to run the assistant. Format: `projects/{project}/locations/{location}/apps/{app}/assistantSessions/{assistant_session}` |
| `message` | `string` Optional. The message to send to the assistant agent. May be empty when `confirmation_response` is set (answering a pending confirmation without adding a new message); at least one of the two must be provided. |
| `attached_gcs_uris[]` | `string` Optional. Cloud Storage URIs for files uploaded by the user during this turn. Example: "gs://cxas-transient-uploads/uuid/prd.pdf" |
| `context_token` | `string` Optional. Opaque onboarding context token returned by `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.SessionService.GenerateOnboardingSuggestions`. When set and still fresh, the server reuses the onboarding snapshot computed for the zero state instead of recomputing it for the first conversation turn. |
| `confirmation_response` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AssistantConfirmationResponse` Optional. The user's answer to a pending `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AssistantConfirmationRequest`. When set, the server resumes the paused agent with this answer instead of (or in addition to) starting a new prompt turn. |
| `client_capabilities[]` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.StreamChatAiAssistantRequest.ClientCapability` Optional. Response features this client can render. The server only emits events that need a capability (e.g. `confirmation_request`) when the capability is declared, so older clients never receive events they would silently drop. |
| `operation_completed_event` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.OperationCompletedEvent` Optional. Resumes an assistant session paused waiting for a client-managed long-running operation to complete. |
| `resume_from_sequence_number` | `int64` Optional. Optional cursor to resume and replay events from an in-flight or completed turn. |
| `attach_only` | `bool` Optional. Optional flag to attach to an existing in-flight turn without submitting a new message. |

## ClientCapability

Response features a client can declare.

| Enums ||
|---|---|
| `CLIENT_CAPABILITY_UNSPECIFIED` | Unspecified capability; ignored. |
| `CONFIRMATION_CARDS` | The client renders `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AssistantConfirmationRequest` cards and answers them via `confirmation_response`. |
| `CLIENT_MANAGED_LRO` | The client manages long-running operations out-of-band by polling the operation and sending `operation_completed_event` to resume the turn. If not declared, the server manages LRO polling and completes the turn inline. |
| `PROJECT_SCOPE` | The client renders project-scope events: `typed_payload` cards, `target_app` on tool calls and responses, `targets` on confirmation requests and `touched_apps` on turn completion. |

## StreamChatAiAssistantResponse

Response message for `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.SessionService.StreamChatAiAssistant`.

| Fields ||
|---|---|
| `event_id` | `string` Unique identifier for the event. |
| `event_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Timestamp when the event occurred. |
| `ui_event` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.UiEvent` Optional. UI event payload. |
| `turn_metadata` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.TurnMetadata` Optional. Turn-level metadata and intent categorization. |
| `sequence_number` | `int64` Optional. Monotonically increasing sequence number for this session turn. |
| `turn_in_progress` | `bool` Optional. Indicates whether the turn is still actively running in the background. |
| Union field `event`. The event payload. `event` can be only one of the following: ||
| `text_chunk` | `string` Text Token (for streaming Gemini responses word-by-word). |
| `status` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.rpc#google.rpc.Status` Simple status update. |
| `thought_chunk` | `string` Thought text chunk (agent's reasoning before generating response). |
| `tool_call` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ToolCall` Tool call execution event. |
| `tool_response` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ToolResponse` Tool call response event. |
| `artifact_chunk` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ArtifactChunk` Generated-document artifact event (live preview deltas + final Cloud Storage pointer). |
| `option_questions_chunk` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.OptionQuestionsChunk` Structured clarification options parsed out of the model turn. The console renders these as a selectable option list instead of raw text. |
| `confirmation_request` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AssistantConfirmationRequest` A blocking confirmation the agent paused on. The agent resumes when the answer arrives on a later request's `confirmation_response`. Only sent to clients that declared the CONFIRMATION_CARDS capability on the request. |
| `session_checkpoint` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.SessionCheckpoint` Session checkpoint/compaction recap event containing user intent and rolling summary. |
| `resume_snapshot` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.TurnResumeSnapshot` A compacted replay of an in-flight turn, sent as the first event of every attach or resume before any live event. The client replaces any locally rendered state for this turn with the snapshot's contents. |
| `handoff` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.TurnHandoffEvent` Tells the client to silently reconnect with resume_from_sequence_number: the task serving this stream is going away and the turn will continue elsewhere. Not an error; the stream completes normally after this event. |
| `turn_completed` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.TurnCompletedEvent` The turn has ended. Sent as the last event of every turn, on the original stream and on every attached or resumed stream, so clients can end the turn on an explicit signal instead of inferring it from stream closure. |

## SynthesizeSpeechConfig

Configuration for how the agent response should be synthesized.

| Fields ||
|---|---|
| `voice` | `string` Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code. For the list of available voices, please refer to [Supported voices and languages](https://cloud.google.com/text-to-speech/docs/voices) from Cloud Text-to-Speech. |
| `speaking_rate` | `double` Optional. The speaking rate/speed in the range \[0.25, 2.0\]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. Values outside of the range \[0.25, 2.0\] will return an error. |
| `model` | `string` Optional. The model used to synthesize audio. Currently supported values: - "gemini-3.1-flash-tts-preview" If empty, Chirp3-HD is used. |
| `instruction` | `string` Optional. The instruction used to synthesize speech when using a generative model. |

## SystemTool

Pre-defined system tool.

| Fields ||
|---|---|
| `name` | `string` Required. The name of the system tool. |
| `description` | `string` Output only. The description of the system tool. |

## TimeZoneSettings

TimeZone settings of the app.

| Fields ||
|---|---|
| `time_zone` | `string` Optional. The time zone of the app from the [time zone database](https://www.iana.org/time-zones), e.g., America/Los_Angeles, Europe/Paris. |

## TlsConfig

The TLS configuration.

| Fields ||
|---|---|
| `ca_certs[]` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.TlsConfig.CaCert` Required. Specifies a list of allowed custom CA certificates for HTTPS verification. |

## CaCert

The CA certificate.

| Fields ||
|---|---|
| `display_name` | `string` Required. The name of the allowed custom CA certificates. This can be used to disambiguate the custom CA certificates. |
| `cert` | `bytes` Required. The allowed custom CA certificates (in DER format) for HTTPS verification. This overrides the default SSL trust store. If this is empty or unspecified, CES will use Google's default trust store to verify certificates. N.B. Make sure the HTTPS server certificates are signed with "subject alt name". For instance a certificate can be self-signed using the following command: openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") |

## Tool

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

| Fields ||
|---|---|
| `name` | `string` Identifier. The resource name of the tool. Format: - `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` for standalone tools. - `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}` for tools retrieved from a toolset. These tools are dynamic and output-only; they cannot be referenced directly where a tool is expected. |
| `display_name` | `string` Output only. The display name of the tool, derived based on the tool's type. For example, display name of a \[ClientFunction\]\[Tool.ClientFunction\] is derived from its `name` property. |
| `execution_type` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ExecutionType` Optional. The execution type of the tool. |
| `timeout` | `https://protobuf.dev/reference/protobuf/google.protobuf#duration` Optional. The timeout for the tool execution. If not set, the default timeout is 30 seconds for `SYNCHRONOUS` tools and 60 seconds for `ASYNCHRONOUS` tools. |
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. Timestamp when the tool was created. |
| `update_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. Timestamp when the tool was last updated. |
| `etag` | `string` Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes. |
| `generated_summary` | `string` Output only. If the tool is generated by the LLM assistant, this field contains a descriptive summary of the generation. |
| `tool_fake_config` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ToolFakeConfig` Optional. Configuration for tool behavior in fake mode. |
| `read_only` | `bool` Output only. Indicates whether the tool is read-only. If true, the tool cannot be modified by the user. |
| Union field `tool_type`. The type of the tool. `tool_type` can be only one of the following: ||
| `client_function` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ClientFunction` Optional. The client function. |
| `open_api_tool` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.OpenApiTool` Optional. The open API tool. |
| `google_search_tool` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.GoogleSearchTool` Optional. The google search tool. |
| `connector_tool` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ConnectorTool` Optional. The Integration Connector tool. |
| `data_store_tool` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.DataStoreTool` Optional. The data store tool. |
| `python_function` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.PythonFunction` Optional. The python function tool. |
| `mcp_tool` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.McpTool` Optional. The MCP tool. An MCP tool cannot be created or updated directly and is managed by the MCP toolset. |
| `file_search_tool` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.FileSearchTool` Optional. The file search tool. |
| `system_tool` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.SystemTool` Optional. The system tool. |
| `agent_tool` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentTool` Optional. The agent tool. |
| `widget_tool` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.WidgetTool` Optional. The widget tool. |
| `remote_agent_tool` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.RemoteAgentTool` Optional. The remote agent tool. |

## ToolCall

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

| Fields ||
|---|---|
| `id` | `string` Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ToolResponse.FIELDS.string.google.cloud.ces.v1.ToolResponse.id`. |
| `display_name` | `string` Output only. Display name of the tool. |
| `args` | `https://protobuf.dev/reference/protobuf/google.protobuf#struct` Optional. The input parameters and values for the tool in JSON object format. |
| `parent_tool_call_id` | `string` Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. |
| `agent_name` | `string` Output only. Human-readable name of the agent that issued this call, e.g. "Contract Architect". Empty when the root agent issued it. |
| `target_app` | `string` Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. |
| Union field `tool_identifier`. The identifier of the tool to execute. It could be either a persisted tool or a tool from a toolset. `tool_identifier` can be only one of the following: ||
| `tool` | `string` Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` |
| `toolset_tool` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ToolsetTool` Optional. The toolset tool to execute. |

## ToolCalls

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

| Fields ||
|---|---|
| `tool_calls[]` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ToolCall` Optional. The list of tool calls to execute. |

## ToolFakeConfig

Configuration for tool behavior in fake mode.

| Fields ||
|---|---|
| `enable_fake_mode` | `bool` Optional. Whether the tool is using fake mode. |
| Union field `tool_response`. The response is either static or it is provided by a python function. `tool_response` can be only one of the following: ||
| `code_block` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.CodeBlock` Optional. Code block which will be executed instead of a real tool call. |

## ToolResponse

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

| Fields ||
|---|---|
| `id` | `string` Optional. The matching ID of the `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ToolCall` the response is for. |
| `display_name` | `string` Output only. Display name of the tool. |
| `response` | `https://protobuf.dev/reference/protobuf/google.protobuf#struct` Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. |
| `parent_tool_call_id` | `string` Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. |
| `agent_name` | `string` Output only. Human-readable name of the agent that issued this call, e.g. "Contract Architect". Empty when the root agent issued it. |
| `target_app` | `string` Output only. The app the executed tool targeted; mirrors `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ToolCall.FIELDS.string.google.cloud.ces.v1.ToolCall.target_app`. |
| Union field `tool_identifier`. The identifier of the tool that got executed. It could be either a persisted tool or a tool from a toolset. `tool_identifier` can be only one of the following: ||
| `tool` | `string` Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` |
| `toolset_tool` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ToolsetTool` Optional. The toolset tool that got executed. |

## ToolResponses

Execution results for the requested tool calls from the client.

| Fields ||
|---|---|
| `tool_responses[]` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ToolResponse` Optional. The list of tool execution results. |

## Toolset

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

| Fields ||
|---|---|
| `name` | `string` Identifier. The unique identifier of the toolset. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` |
| `display_name` | `string` Optional. The display name of the toolset. Must be unique within the same app. |
| `description` | `string` Optional. The description of the toolset. |
| `timeout` | `https://protobuf.dev/reference/protobuf/google.protobuf#duration` Optional. The timeout for the toolset execution. If not set, the default timeout is 30 seconds for `SYNCHRONOUS` toolsets and 60 seconds for `ASYNCHRONOUS` toolsets. |
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. Timestamp when the toolset was created. |
| `update_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. Timestamp when the toolset was last updated. |
| `etag` | `string` ETag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes. |
| `execution_type` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ExecutionType` Optional. The execution type of the tools in the toolset. |
| `tool_fake_config` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ToolFakeConfig` Optional. Configuration for tools behavior in fake mode. |
| Union field `toolset_type`. The type of the toolset. `toolset_type` can be only one of the following: ||
| `mcp_toolset` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.McpToolset` Optional. A toolset that contains a list of tools that are offered by the MCP server. |
| `open_api_toolset` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.OpenApiToolset` Optional. A toolset that contains a list of tools that are defined by an OpenAPI schema. |
| `connector_toolset` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ConnectorToolset` Optional. A toolset that generates tools from an Integration Connectors Connection. |

## ToolsetTool

A tool that is created from a toolset.

| Fields ||
|---|---|
| `toolset` | `string` Required. The resource name of the Toolset from which this tool is derived. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}` |
| `tool_id` | `string` Optional. The tool ID to filter the tools to retrieve the schema for. |

## TransferRule

Rule for transferring to a specific agent.

| Fields ||
|---|---|
| `child_agent` | `string` Required. The resource name of the child agent the rule applies to. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` |
| `direction` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.TransferRule.Direction` Required. The direction of the transfer. |
| Union field `rule_type`. The rule type. `rule_type` can be only one of the following: ||
| `deterministic_transfer` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.TransferRule.DeterministicTransfer` Optional. A rule that immediately transfers to the target agent when the condition is met. |
| `disable_planner_transfer` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.TransferRule.DisablePlannerTransfer` Optional. Rule that prevents the planner from transferring to the target agent. |

## DeterministicTransfer

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

| Fields ||
|---|---|
| Union field `condition_type`. The condition to evaluate. `condition_type` can be only one of the following: ||
| `expression_condition` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ExpressionCondition` Optional. A rule that evaluates a session state condition. If the condition evaluates to true, the transfer occurs. |
| `python_code_condition` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.PythonCodeCondition` Optional. A rule that uses Python code block to evaluate the conditions. If the condition evaluates to true, the transfer occurs. |

## Direction

The direction of the transfer.

| Enums ||
|---|---|
| `DIRECTION_UNSPECIFIED` | Unspecified direction. |
| `PARENT_TO_CHILD` | Transfer from the parent agent to the child agent. |
| `CHILD_TO_PARENT` | Transfer from the child agent to the parent agent. |

## DisablePlannerTransfer

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

| Fields ||
|---|---|
| `expression_condition` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.ExpressionCondition` Required. If the condition evaluates to true, planner will not be allowed to transfer to the target agent. |

## TriggerAction

Action that is taken when a certain precondition is met.

| Fields ||
|---|---|
| Union field `action`. The action to take. `action` can be only one of the following: ||
| `respond_immediately` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.TriggerAction.RespondImmediately` Optional. Immediately respond with a preconfigured response. |
| `transfer_agent` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.TriggerAction.TransferAgent` Optional. Transfer the conversation to a different agent. |
| `generative_answer` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.TriggerAction.GenerativeAnswer` Optional. Respond with a generative answer. |

## GenerativeAnswer

The agent will immediately respond with a generative answer.

| Fields ||
|---|---|
| `prompt` | `string` Required. The prompt to use for the generative answer. |

## RespondImmediately

The agent will immediately respond with a preconfigured response.

| Fields ||
|---|---|
| `responses[]` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.TriggerAction.Response` Required. The canned responses for the agent to choose from. The response is chosen randomly. |

## Response

Represents a response from the agent.

| Fields ||
|---|---|
| `text` | `string` Required. Text for the agent to respond with. |
| `disabled` | `bool` Optional. Whether the response is disabled. Disabled responses are not used by the agent. |

## TransferAgent

The agent will transfer the conversation to a different agent.

| Fields ||
|---|---|
| `agent` | `string` Required. The name of the agent to transfer the conversation to. The agent must be in the same app as the current agent. Format: `projects/{project}/locations/{location}/apps/{app}/agents/{agent}` |

## TurnCompletedEvent

Terminal event of a turn (see StreamChatAiAssistantResponse.turn_completed).

| Fields ||
|---|---|
| `turn_id` | `string` Identifier of the turn that ended; matches TurnResumeSnapshot.turn_id and ActiveTurnInfo.turn_id. |
| `reason` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.TurnCompletedEvent.Reason` Why the turn ended. |
| `final_sequence_number` | `int64` Sequence number of the last event the turn produced. A client whose cursor is lower missed content and should reload the session to see it. |
| `touched_apps[]` | `string` Apps this turn targeted or changed, so the console can refresh exactly those apps' stores. Project-scoped sessions only. Format: `projects/{project}/locations/{location}/apps/{app}` |

## Reason

Why the turn ended, so a client that attached late can word the outcome instead of guessing from an empty stream.

| Enums ||
|---|---|
| `REASON_UNSPECIFIED` | Unspecified. |
| `COMPLETED` | The turn ran to completion; the session holds its committed output. |
| `ABANDONED` | No task was driving the turn any more; it was sealed to a committed partial and cannot be continued. |
| `RESUME_UNAVAILABLE` | This server does not serve attach or resume for the session, so nothing was tailed; the client should reload the session instead. |

## TurnHandoffEvent

Emitted before this task stops serving the stream mid-turn (e.g. a server restart). The turn's state is persisted; a reconnect carrying resume_from_sequence_number continues it on another task.

| Fields ||
|---|---|
| `turn_id` | `string` Identifies the turn to resume. |
| `reason` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.TurnHandoffEvent.Reason` Why the stream is handing off. |

## Reason

Why the stream is handing off.

| Enums ||
|---|---|
| `REASON_UNSPECIFIED` | Unspecified. |
| `SERVER_RESTART` | The serving task is shutting down (release push or rescheduling). |

## TurnMetadata

Turn-level metadata and intent categorization.

| Fields ||
|---|---|
| `contract_related` | `bool` Indicates whether this assistant turn was contract-related (e.g. contract drafting, alignment, extraction, or revision). |
| `contract_finalized` | `bool` Set on the final artifact event of a turn whose contract draft was published (a revision was activated). Terminal for the clarification flow of this draft: contract_progress is authoritative and complete. |
| `contract_streaming_phase` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.TurnMetadata.ContractStreamingPhase` Set only on in-flight progress estimates emitted while a contract artifact fence is streaming, and on the revision-turn-start event. Unset on authoritative payloads. |
| `contract_draft_complete` | `bool` Set on the terminal event of a contract draft whose every placeholder is resolved (contract_progress is 100%), whether or not the draft was published. Clients complete and dismiss the contract progress display on it; publication is reported separately by contract_finalized. |

## ContractStreamingPhase

Streaming phase of the contract progress payload.

| Enums ||
|---|---|
| `CONTRACT_STREAMING_PHASE_UNSPECIFIED` | The payload is authoritative (computed from a complete contract document, a persisted snapshot, or the pre-draft state). Clients must replace any previously received progress with it. |
| `DRAFTING` | An initial contract draft is streaming. contract_progress is an in-flight estimate: non-decreasing within one artifact fence, capped below the authoritative range, with pillar_breakdowns carrying total_item_count == 0 to mark estimated pillar states. |
| `REVISING` | A revision of an existing contract is streaming (for example after an annotation submission). Same estimate semantics as DRAFTING. |

## TurnResumeSnapshot

A compacted replay of an in-flight turn: everything needed to render the turn's visible output so far, plus the position live events continue from.

| Fields ||
|---|---|
| `turn_id` | `string` Identifies the turn being attached to. |
| `resolved_sequence_number` | `int64` The position this snapshot represents. Live events follow with sequence_number strictly greater than this. When lower than the resume_from_sequence_number the client requested, flushed progress lags what the client already rendered: the client must discard its rendered content of this turn beyond this position before applying the snapshot. |
| `events[]` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.StreamChatAiAssistantResponse` Compacted events reconstructing the turn's visible output, in render order, using the same event shapes as live streaming. |
| `orphan_deadline_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` When the turn will be wound down if no client remains attached. |

## UiEvent

Represents a UI event payload.

| Fields ||
|---|---|
| `mime_type` | `string` The media type (MIME type) indicating the format of the UI event payload (e.g., "application/json+a2ui"). |
| `json_payload` | `string` The JSON payload representing the A2UI surface. |

## UpdateAgentRequest

Request message for `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentService.UpdateAgent`.

| Fields ||
|---|---|
| `agent` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Agent` Required. The agent to update. |
| `update_mask` | `https://protobuf.dev/reference/protobuf/google.protobuf#field-mask` Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated. |

## UpdateAppRequest

Request message for `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentService.UpdateApp`.

| Fields ||
|---|---|
| `app` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.App` Required. The app to update. |
| `update_mask` | `https://protobuf.dev/reference/protobuf/google.protobuf#field-mask` Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated. |

## UpdateAppVersionRequest

Request message for `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentService.UpdateAppVersion`.

| Fields ||
|---|---|
| `app_version` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AppVersion` Required. The app version to update. |
| `update_mask` | `https://protobuf.dev/reference/protobuf/google.protobuf#field-mask` Optional. The list of fields to update. If empty, fields `display_name` and `description` will be updated. |

## UpdateDeploymentRequest

Request message for `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentService.UpdateDeployment`.

| Fields ||
|---|---|
| `deployment` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Deployment` Required. The deployment to update. |
| `update_mask` | `https://protobuf.dev/reference/protobuf/google.protobuf#field-mask` Optional. The list of fields to update. |

## UpdateExampleRequest

Request message for `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentService.UpdateExample`.

| Fields ||
|---|---|
| `example` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Example` Required. The example to update. |
| `update_mask` | `https://protobuf.dev/reference/protobuf/google.protobuf#field-mask` Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated. |

## UpdateGuardrailRequest

Request message for `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentService.UpdateGuardrail`.

| Fields ||
|---|---|
| `guardrail` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Guardrail` Required. The guardrail to update. |
| `update_mask` | `https://protobuf.dev/reference/protobuf/google.protobuf#field-mask` Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated. |

## UpdateToolRequest

Request message for `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentService.UpdateTool`.

| Fields ||
|---|---|
| `tool` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Tool` Required. The tool to update. |
| `update_mask` | `https://protobuf.dev/reference/protobuf/google.protobuf#field-mask` Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated. |

## UpdateToolsetRequest

Request message for `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.AgentService.UpdateToolset`.

| Fields ||
|---|---|
| `toolset` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Toolset` Required. The toolset to update. |
| `update_mask` | `https://protobuf.dev/reference/protobuf/google.protobuf#field-mask` Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated. |

## VpcScSettings

VPC-SC settings for the app.

| Fields ||
|---|---|
| `allowed_origins[]` | `string` Optional. The allowed HTTP(s) origins that OpenAPI tools in the App are able to directly call when VPC Service Controls are enabled. These strings must match the origin exactly, including the port if specified. For example, "https://example.com" or "https://example.com:443". This list does not yet apply to Python tools that may make direct HTTP calls. |

## WebSearchQuery

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

| Fields ||
|---|---|
| `query` | `string` The search query text. |
| `uri` | `string` The URI to the Google Search results page for the query. |

## WhatsAppCredentials

Ephemeral Meta credentials for WhatsApp native integration.

| Fields ||
|---|---|
| `auth_code` | `string` Required. The Meta auth code provided by the embedded signup flow. |
| `pin` | `string` Required. The 6-digit PIN created by the user for two-step verification. |
| `phone_number` | `string` Required. The phone number to register with WhatsApp. |
| `business_account_id` | `string` Required. The Business Account ID to use for the phone number. |
| `waba_id` | `string` Required. The WhatsApp Business Account ID. |
| `conversation_profile_id` | `string` Optional. The Conversation Profile ID to use for the deployment. |

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

| Fields ||
|---|---|
| `name` | `string` Required. The display name of the widget tool. |
| `description` | `string` Optional. The description of the widget tool. |
| `widget_type` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.WidgetTool.WidgetType` Optional. The type of the widget tool. If not specified, the default type will be CUSTOMIZED. |
| `ui_config` | `https://protobuf.dev/reference/protobuf/google.protobuf#struct` Optional. Configuration for rendering the widget. |
| `data_mapping` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.WidgetTool.DataMapping` Optional. The mapping that defines how data from a source tool is mapped to the widget's input parameters. |
| `text_response_config` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.WidgetTool.TextResponseConfig` Optional. Configuration for always-included text responses. |
| Union field `input`. The input of the widget tool. `input` can be only one of the following: ||
| `parameters` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.Schema` Optional. The input parameters of the widget tool. |

## DataMapping

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

| Fields ||
|---|---|
| `source_tool_name` | `string` Optional. The resource name of the tool that provides the data for the widget (e.g., a search tool or a custom function). Format: `projects/{project}/locations/{location}/agents/{agent}/tools/{tool}` |
| `field_mappings` | `map<string, string>` Optional. A map of widget input parameter fields to the corresponding output fields of the source tool. |
| `python_function` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.PythonFunction` Optional. Configuration for a Python function used to transform the source tool's output into the widget's input format. |
| `mode` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.WidgetTool.DataMapping.Mode` Optional. The mode of the data mapping. |
| `python_script (deprecated)` | `string` > [!WARNING] > This item is deprecated! Deprecated: Use `python_function` instead. |

## Mode

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

| Enums ||
|---|---|
| `MODE_UNSPECIFIED` | Unspecified mode. |
| `FIELD_MAPPING` | Use the `field_mappings` map for data transformation. |
| `PYTHON_SCRIPT` | Use the `python_script` for data transformation. |

## TextResponseConfig

Configuration for the text response returned with the widget.

| Fields ||
|---|---|
| `type` | `https://docs.cloud.google.com/gemini-enterprise-cx/cx-agent-studio/reference/rpc/google.cloud.ces.v1#google.cloud.ces.v1.WidgetTool.TextResponseConfig.Type` Optional. The strategy for providing the text response. |
| `static_text` | `string` Optional. The static text response to return when type is STATIC. |
| `text_response_instruction` | `string` Optional. Instruction for the LLM on how to generate the text response. Used as the description for the text response parameter if type is LLM_GENERATED. |

## Type

Defines how the text response is produced.

| Enums ||
|---|---|
| `TYPE_UNSPECIFIED` | Unspecified type. |
| `NONE` | The LLM dynamically decides whether to generate a text response alongside the widget based on the conversation context. |
| `LLM_GENERATED` | The LLM is explicitly required to generate a text response. |
| `STATIC` | A pre-defined static text response is always used. |

## WidgetType

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

| Enums ||
|---|---|
| `WIDGET_TYPE_UNSPECIFIED` | Unspecified widget type. |
| `CUSTOM` | Custom widget type. |
| `PRODUCT_CAROUSEL` | Product carousel widget. |
| `PRODUCT_DETAILS` | Product details widget. |
| `QUICK_ACTIONS` | Quick actions widget. |
| `PRODUCT_COMPARISON` | Product comparison widget. |
| `ADVANCED_PRODUCT_DETAILS` | Advanced product details widget. |
| `SHORT_FORM` | Short form widget. |
| `OVERALL_SATISFACTION` | Overall satisfaction widget. |
| `ORDER_SUMMARY` | Order summary widget. |
| `APPOINTMENT_DETAILS` | Appointment details widget. |
| `APPOINTMENT_SCHEDULER` | Appointment scheduler widget. |
| `CONTACT_FORM` | Contact form widget. |