Package google.cloud.ces.v1

Index

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

AgentService

Service qui gère les ressources liées aux agents dans Gemini Enterprise for Customer Engagement (CES).

BatchDeleteConversations

rpc BatchDeleteConversations(BatchDeleteConversationsRequest) returns (Operation) Supprime par lot les conversations spécifiées. Niveaux d'accès des autorisations Nécessite l'un des niveaux d'accès OAuth suivants : https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Pour plus d'informations, consultez la page Authentication Overview. Autorisations IAM Nécessite l'autorisation IAM suivante sur la ressource parent : ces.conversations.delete Pour en savoir plus, consultez la documentation IAM.

CreateAgent

rpc CreateAgent(CreateAgentRequest) returns (Agent) Crée un agent dans l'application spécifiée. Niveaux d'accès des autorisations Nécessite l'un des niveaux d'accès OAuth suivants : https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Pour plus d'informations, consultez la page Authentication Overview. Autorisations IAM Nécessite l'autorisation IAM suivante sur la ressource parent : ces.agents.create Pour en savoir plus, consultez la documentation IAM.

CreateApp

rpc CreateApp(CreateAppRequest) returns (Operation) Crée une application dans le projet et l'emplacement indiqués. Niveaux d'accès des autorisations Nécessite l'un des niveaux d'accès OAuth suivants : https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Pour plus d'informations, consultez la page Authentication Overview. Autorisations IAM Nécessite l'autorisation IAM suivante sur la ressource parent : ces.apps.create Pour en savoir plus, consultez la documentation IAM.

CreateAppVersion

rpc CreateAppVersion(CreateAppVersionRequest) returns (AppVersion) Crée une version d'application dans l'application donnée. Niveaux d'accès des autorisations Nécessite l'un des niveaux d'accès OAuth suivants : https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Pour plus d'informations, consultez la page Authentication Overview. Autorisations IAM Nécessite l'autorisation IAM suivante sur la ressource parent : ces.appVersions.create Pour en savoir plus, consultez la documentation IAM.

CreateDeployment

rpc CreateDeployment(CreateDeploymentRequest) returns (Deployment) Crée un déploiement dans l'application spécifiée. Niveaux d'accès des autorisations Nécessite l'un des niveaux d'accès OAuth suivants : https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Pour plus d'informations, consultez la page Authentication Overview. Autorisations IAM Nécessite l'autorisation IAM suivante sur la ressource parent : ces.deployments.create Pour en savoir plus, consultez la documentation IAM.

CreateExample

rpc CreateExample(CreateExampleRequest) returns (Example) Crée un exemple dans l'application donnée. Niveaux d'accès des autorisations Nécessite l'un des niveaux d'accès OAuth suivants : https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Pour plus d'informations, consultez la page Authentication Overview. Autorisations IAM Nécessite l'autorisation IAM suivante sur la ressource parent : ces.examples.create Pour en savoir plus, consultez la documentation IAM.

CreateGuardrail

rpc CreateGuardrail(CreateGuardrailRequest) returns (Guardrail) Crée un garde-fou dans l'application spécifiée. Niveaux d'accès des autorisations Nécessite l'un des niveaux d'accès OAuth suivants : https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Pour plus d'informations, consultez la page Authentication Overview. Autorisations IAM Nécessite l'autorisation IAM suivante sur la ressource parent : ces.guardrails.create Pour en savoir plus, consultez la documentation IAM.

CreateTool

rpc CreateTool(CreateToolRequest) returns (Tool) Crée un outil dans l'application spécifiée. Niveaux d'accès des autorisations Nécessite l'un des niveaux d'accès OAuth suivants : https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Pour plus d'informations, consultez la page Authentication Overview. Autorisations IAM Nécessite l'autorisation IAM suivante sur la ressource parent : ces.tools.create Pour en savoir plus, consultez la documentation IAM.

CreateToolset

rpc CreateToolset(CreateToolsetRequest) returns (Toolset) Crée un ensemble d'outils dans l'application spécifiée. Niveaux d'accès des autorisations Nécessite l'un des niveaux d'accès OAuth suivants : https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Pour plus d'informations, consultez la page Authentication Overview. Autorisations IAM Nécessite l'autorisation IAM suivante sur la ressource parent : ces.toolsets.create Pour en savoir plus, consultez la documentation IAM.

DeleteAgent

rpc DeleteAgent(DeleteAgentRequest) returns (Empty) Supprime l'agent spécifié. Niveaux d'accès des autorisations Nécessite l'un des niveaux d'accès OAuth suivants : https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Pour plus d'informations, consultez la page Authentication Overview. Autorisations IAM Nécessite l'autorisation IAM suivante sur la ressource name : ces.agents.delete Pour en savoir plus, consultez la documentation IAM.

DeleteApp

rpc DeleteApp(DeleteAppRequest) returns (Operation) Supprime l'application spécifiée. Niveaux d'accès des autorisations Nécessite l'un des niveaux d'accès OAuth suivants : https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Pour plus d'informations, consultez la page Authentication Overview. Autorisations IAM Nécessite l'autorisation IAM suivante sur la ressource name : ces.apps.delete Pour en savoir plus, consultez la documentation IAM.

DeleteAppVersion

rpc DeleteAppVersion(DeleteAppVersionRequest) returns (Empty) Supprime la version de l'application spécifiée. Niveaux d'accès des autorisations Nécessite l'un des niveaux d'accès OAuth suivants : https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Pour plus d'informations, consultez la page Authentication Overview. Autorisations IAM Nécessite l'autorisation IAM suivante sur la ressource name : ces.appVersions.delete Pour en savoir plus, consultez la documentation IAM.

DeleteConversation

rpc DeleteConversation(DeleteConversationRequest) returns (Empty) Supprime la conversation spécifiée. Niveaux d'accès des autorisations Nécessite l'un des niveaux d'accès OAuth suivants : https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Pour plus d'informations, consultez la page Authentication Overview. Autorisations IAM Nécessite l'autorisation IAM suivante sur la ressource name : ces.conversations.delete Pour en savoir plus, consultez la documentation IAM.

DeleteDeployment

rpc DeleteDeployment(DeleteDeploymentRequest) returns (Empty) Supprime le déploiement spécifié. Niveaux d'accès des autorisations Nécessite l'un des niveaux d'accès OAuth suivants : https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Pour plus d'informations, consultez la page Authentication Overview. Autorisations IAM Nécessite l'autorisation IAM suivante sur la ressource name : ces.deployments.delete Pour en savoir plus, consultez la documentation IAM.

DeleteExample

rpc DeleteExample(DeleteExampleRequest) returns (Empty) Supprime l'exemple spécifié. Niveaux d'accès des autorisations Nécessite l'un des niveaux d'accès OAuth suivants : https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Pour plus d'informations, consultez la page Authentication Overview. Autorisations IAM Nécessite l'autorisation IAM suivante sur la ressource name : ces.examples.delete Pour en savoir plus, consultez la documentation IAM.

DeleteGuardrail

rpc DeleteGuardrail(DeleteGuardrailRequest) returns (Empty) Supprime la barrière de sécurité spécifiée. Niveaux d'accès des autorisations Nécessite l'un des niveaux d'accès OAuth suivants : https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Pour plus d'informations, consultez la page Authentication Overview. Autorisations IAM Nécessite l'autorisation IAM suivante sur la ressource name : ces.guardrails.delete Pour en savoir plus, consultez la documentation IAM.

DeleteTool

rpc DeleteTool(DeleteToolRequest) returns (Empty) Supprime l'outil spécifié. Niveaux d'accès des autorisations Nécessite l'un des niveaux d'accès OAuth suivants : https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Pour plus d'informations, consultez la page Authentication Overview. Autorisations IAM Nécessite l'autorisation IAM suivante sur la ressource name : ces.tools.delete Pour en savoir plus, consultez la documentation IAM.

DeleteToolset

rpc DeleteToolset(DeleteToolsetRequest) returns (Empty) Supprime l'ensemble d'outils spécifié. Niveaux d'accès des autorisations Nécessite l'un des niveaux d'accès OAuth suivants : https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Pour plus d'informations, consultez la page Authentication Overview. Autorisations IAM Nécessite l'autorisation IAM suivante sur la ressource name : ces.toolsets.delete Pour en savoir plus, consultez la documentation IAM.

ExportApp

rpc ExportApp(ExportAppRequest) returns (Operation) Exporte l'application spécifiée. Niveaux d'accès des autorisations Nécessite l'un des niveaux d'accès OAuth suivants : https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Pour plus d'informations, consultez la page Authentication Overview. Autorisations IAM Nécessite l'autorisation IAM suivante sur la ressource name : ces.apps.export Pour en savoir plus, consultez la documentation IAM.

GetAgent

rpc GetAgent(GetAgentRequest) returns (Agent) Récupère les détails de l'agent spécifié. Niveaux d'accès des autorisations Nécessite l'un des niveaux d'accès OAuth suivants : https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Pour plus d'informations, consultez la page Authentication Overview. Autorisations IAM Nécessite l'autorisation IAM suivante sur la ressource name : ces.agents.get Pour en savoir plus, consultez la documentation IAM.

GetApp

rpc GetApp(GetAppRequest) returns (App) Obtient les détails de l'application spécifiée. Niveaux d'accès des autorisations Nécessite l'un des niveaux d'accès OAuth suivants : https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Pour plus d'informations, consultez la page Authentication Overview. Autorisations IAM Nécessite l'autorisation IAM suivante sur la ressource name : ces.apps.get Pour en savoir plus, consultez la documentation IAM.

GetAppVersion

rpc GetAppVersion(GetAppVersionRequest) returns (AppVersion) Obtient les détails de la version d'application spécifiée. Niveaux d'accès des autorisations Nécessite l'un des niveaux d'accès OAuth suivants : https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Pour plus d'informations, consultez la page Authentication Overview. Autorisations IAM Nécessite l'autorisation IAM suivante sur la ressource name : ces.appVersions.get Pour en savoir plus, consultez la documentation IAM.

GetChangelog

rpc GetChangelog(GetChangelogRequest) returns (Changelog) Récupère le journal des modifications spécifié. Niveaux d'accès des autorisations Nécessite l'un des niveaux d'accès OAuth suivants : https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Pour plus d'informations, consultez la page Authentication Overview. Autorisations IAM Nécessite l'autorisation IAM suivante sur la ressource name : ces.changelogs.get Pour en savoir plus, consultez la documentation IAM.

GetConversation

rpc GetConversation(GetConversationRequest) returns (Conversation) Récupère les détails de la conversation spécifiée. Niveaux d'accès des autorisations Nécessite l'un des niveaux d'accès OAuth suivants : https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Pour plus d'informations, consultez la page Authentication Overview. Autorisations IAM Nécessite l'autorisation IAM suivante sur la ressource name : ces.conversations.get Pour en savoir plus, consultez la documentation IAM.

GetDeployment

rpc GetDeployment(GetDeploymentRequest) returns (Deployment) Obtient les détails du déploiement spécifié. Niveaux d'accès des autorisations Nécessite l'un des niveaux d'accès OAuth suivants : https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Pour plus d'informations, consultez la page Authentication Overview. Autorisations IAM Nécessite l'autorisation IAM suivante sur la ressource name : ces.deployments.get Pour en savoir plus, consultez la documentation IAM.

GetExample

rpc GetExample(GetExampleRequest) returns (Example) Accède aux détails de l'exemple spécifié. Niveaux d'accès des autorisations Nécessite l'un des niveaux d'accès OAuth suivants : https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Pour plus d'informations, consultez la page Authentication Overview. Autorisations IAM Nécessite l'autorisation IAM suivante sur la ressource name : ces.examples.get Pour en savoir plus, consultez la documentation IAM.

GetGuardrail

rpc GetGuardrail(GetGuardrailRequest) returns (Guardrail) Accède aux détails de la barrière de sécurité spécifiée. Niveaux d'accès des autorisations Nécessite l'un des niveaux d'accès OAuth suivants : https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Pour plus d'informations, consultez la page Authentication Overview. Autorisations IAM Nécessite l'autorisation IAM suivante sur la ressource name : ces.guardrails.get Pour en savoir plus, consultez la documentation IAM.

GetTool

rpc GetTool(GetToolRequest) returns (Tool) Obtient les détails de l'outil spécifié. Niveaux d'accès des autorisations Nécessite l'un des niveaux d'accès OAuth suivants : https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Pour plus d'informations, consultez la page Authentication Overview. Autorisations IAM Nécessite l'autorisation IAM suivante sur la ressource name : ces.tools.get Pour en savoir plus, consultez la documentation IAM.

GetToolset

rpc GetToolset(GetToolsetRequest) returns (Toolset) Obtient les détails de l'ensemble d'outils spécifié. Niveaux d'accès des autorisations Nécessite l'un des niveaux d'accès OAuth suivants : https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Pour plus d'informations, consultez la page Authentication Overview. Autorisations IAM Nécessite l'autorisation IAM suivante sur la ressource name : ces.toolsets.get Pour en savoir plus, consultez la documentation IAM.

ImportApp

rpc ImportApp(ImportAppRequest) returns (Operation) Importe l'application spécifiée. Niveaux d'accès des autorisations Nécessite l'un des niveaux d'accès OAuth suivants : https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Pour plus d'informations, consultez la page Authentication Overview. Autorisations IAM Nécessite l'autorisation IAM suivante sur la ressource parent : ces.apps.import Pour en savoir plus, consultez la documentation IAM.

ListAgents

rpc ListAgents(ListAgentsRequest) returns (ListAgentsResponse) Liste les agents dans l'application spécifiée. Niveaux d'accès des autorisations Nécessite l'un des niveaux d'accès OAuth suivants : https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Pour plus d'informations, consultez la page Authentication Overview. Autorisations IAM Nécessite l'autorisation IAM suivante sur la ressource parent : ces.agents.list Pour en savoir plus, consultez la documentation IAM.

ListAppVersions

rpc ListAppVersions(ListAppVersionsRequest) returns (ListAppVersionsResponse) Liste toutes les versions de l'application donnée. Niveaux d'accès des autorisations Nécessite l'un des niveaux d'accès OAuth suivants : https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Pour plus d'informations, consultez la page Authentication Overview. Autorisations IAM Nécessite l'autorisation IAM suivante sur la ressource parent : ces.appVersions.list Pour en savoir plus, consultez la documentation IAM.

ListApps

rpc ListApps(ListAppsRequest) returns (ListAppsResponse) Liste les applications du projet et de l'emplacement spécifiés. Niveaux d'accès des autorisations Nécessite l'un des niveaux d'accès OAuth suivants : https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Pour plus d'informations, consultez la page Authentication Overview. Autorisations IAM Nécessite l'autorisation IAM suivante sur la ressource parent : ces.apps.list Pour en savoir plus, consultez la documentation IAM.

ListChangelogs

rpc ListChangelogs(ListChangelogsRequest) returns (ListChangelogsResponse) Liste les journaux des modifications de l'application spécifiée. Niveaux d'accès des autorisations Nécessite l'un des niveaux d'accès OAuth suivants : https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Pour plus d'informations, consultez la page Authentication Overview. Autorisations IAM Nécessite l'autorisation IAM suivante sur la ressource parent : ces.changelogs.list Pour en savoir plus, consultez la documentation IAM.

ListConversations

rpc ListConversations(ListConversationsRequest) returns (ListConversationsResponse) Liste les conversations dans l'application spécifiée. Niveaux d'accès des autorisations Nécessite l'un des niveaux d'accès OAuth suivants : https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Pour plus d'informations, consultez la page Authentication Overview. Autorisations IAM Nécessite l'autorisation IAM suivante sur la ressource parent : ces.conversations.list Pour en savoir plus, consultez la documentation IAM.

ListDeployments

rpc ListDeployments(ListDeploymentsRequest) returns (ListDeploymentsResponse) Liste les déploiements dans l'application spécifiée. Niveaux d'accès des autorisations Nécessite l'un des niveaux d'accès OAuth suivants : https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Pour plus d'informations, consultez la page Authentication Overview. Autorisations IAM Nécessite l'autorisation IAM suivante sur la ressource parent : ces.deployments.list Pour en savoir plus, consultez la documentation IAM.

ListExamples

rpc ListExamples(ListExamplesRequest) returns (ListExamplesResponse) Liste les exemples dans l'application donnée. Niveaux d'accès des autorisations Nécessite l'un des niveaux d'accès OAuth suivants : https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Pour plus d'informations, consultez la page Authentication Overview. Autorisations IAM Nécessite l'autorisation IAM suivante sur la ressource parent : ces.examples.list Pour en savoir plus, consultez la documentation IAM.

ListGuardrails

rpc ListGuardrails(ListGuardrailsRequest) returns (ListGuardrailsResponse) Liste les garde-fous dans l'application donnée. Niveaux d'accès des autorisations Nécessite l'un des niveaux d'accès OAuth suivants : https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Pour plus d'informations, consultez la page Authentication Overview. Autorisations IAM Nécessite l'autorisation IAM suivante sur la ressource parent : ces.guardrails.list Pour en savoir plus, consultez la documentation IAM.

ListTools

rpc ListTools(ListToolsRequest) returns (ListToolsResponse) Liste les outils de l'application spécifiée. Niveaux d'accès des autorisations Nécessite l'un des niveaux d'accès OAuth suivants : https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Pour plus d'informations, consultez la page Authentication Overview. Autorisations IAM Nécessite l'autorisation IAM suivante sur la ressource parent : ces.tools.list Pour en savoir plus, consultez la documentation IAM.

ListToolsets

rpc ListToolsets(ListToolsetsRequest) returns (ListToolsetsResponse) Liste les ensembles d'outils dans l'application spécifiée. Niveaux d'accès des autorisations Nécessite l'un des niveaux d'accès OAuth suivants : https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Pour plus d'informations, consultez la page Authentication Overview. Autorisations IAM Nécessite l'autorisation IAM suivante sur la ressource parent : ces.toolsets.list Pour en savoir plus, consultez la documentation IAM.

RestoreAppVersion

rpc RestoreAppVersion(RestoreAppVersionRequest) returns (Operation) Restaure la version d'application spécifiée. Une version de l'application sera créée à partir de la version provisoire actuelle, qui sera remplacée par la version de l'application spécifiée. Niveaux d'accès des autorisations Nécessite l'un des niveaux d'accès OAuth suivants : https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Pour plus d'informations, consultez la page Authentication Overview. Autorisations IAM Nécessite l'autorisation IAM suivante sur la ressource name : ces.appVersions.restore Pour en savoir plus, consultez la documentation IAM.

UpdateAgent

rpc UpdateAgent(UpdateAgentRequest) returns (Agent) Met à jour l'agent spécifié. Niveaux d'accès des autorisations Nécessite l'un des niveaux d'accès OAuth suivants : https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Pour plus d'informations, consultez la page Authentication Overview. Autorisations IAM Nécessite l'autorisation IAM suivante sur la ressource name : ces.agents.update Pour en savoir plus, consultez la documentation IAM.

UpdateApp

rpc UpdateApp(UpdateAppRequest) returns (App) Met à jour l'application spécifiée. Niveaux d'accès des autorisations Nécessite l'un des niveaux d'accès OAuth suivants : https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Pour plus d'informations, consultez la page Authentication Overview. Autorisations IAM Nécessite l'autorisation IAM suivante sur la ressource name : ces.apps.update Pour en savoir plus, consultez la documentation IAM.

UpdateAppVersion
rpc UpdateAppVersion(UpdateAppVersionRequest) returns (AppVersion) Met à jour la version de l'application spécifiée. Niveaux d'accès des autorisations Nécessite l'un des niveaux d'accès OAuth suivants : https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Pour plus d'informations, consultez la Authentication Overview.

UpdateDeployment

rpc UpdateDeployment(UpdateDeploymentRequest) returns (Deployment) Met à jour le déploiement spécifié. Niveaux d'accès des autorisations Nécessite l'un des niveaux d'accès OAuth suivants : https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Pour plus d'informations, consultez la page Authentication Overview. Autorisations IAM Nécessite l'autorisation IAM suivante sur la ressource name : ces.deployments.update Pour en savoir plus, consultez la documentation IAM.

UpdateExample

rpc UpdateExample(UpdateExampleRequest) returns (Example) Met à jour l'exemple spécifié. Niveaux d'accès des autorisations Nécessite l'un des niveaux d'accès OAuth suivants : https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Pour plus d'informations, consultez la page Authentication Overview. Autorisations IAM Nécessite l'autorisation IAM suivante sur la ressource name : ces.examples.update Pour en savoir plus, consultez la documentation IAM.

UpdateGuardrail

rpc UpdateGuardrail(UpdateGuardrailRequest) returns (Guardrail) Met à jour le garde-fou spécifié. Niveaux d'accès des autorisations Nécessite l'un des niveaux d'accès OAuth suivants : https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Pour plus d'informations, consultez la page Authentication Overview. Autorisations IAM Nécessite l'autorisation IAM suivante sur la ressource name : ces.guardrails.update Pour en savoir plus, consultez la documentation IAM.

UpdateTool

rpc UpdateTool(UpdateToolRequest) returns (Tool) Met à jour l'outil spécifié. Niveaux d'accès des autorisations Nécessite l'un des niveaux d'accès OAuth suivants : https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Pour plus d'informations, consultez la page Authentication Overview. Autorisations IAM Nécessite l'autorisation IAM suivante sur la ressource name : ces.tools.update Pour en savoir plus, consultez la documentation IAM.

UpdateToolset

rpc UpdateToolset(UpdateToolsetRequest) returns (Toolset) Met à jour l'ensemble d'outils spécifié. Niveaux d'accès des autorisations Nécessite l'un des niveaux d'accès OAuth suivants : https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Pour plus d'informations, consultez la page Authentication Overview. Autorisations IAM Nécessite l'autorisation IAM suivante sur la ressource name : ces.toolsets.update Pour en savoir plus, consultez la documentation IAM.

SessionService

Le service de session fournit des API permettant d'interagir avec les agents CES.

BidiRunSession

rpc BidiRunSession(BidiSessionClientMessage) returns (BidiSessionServerMessage) Établit une connexion de streaming bidirectionnelle avec l'agent CES. L'agent traite les entrées multimodales continues (par exemple, texte, audio) et génère des flux de sortie multimodaux en temps réel. --- Flux de requêtes du client --- Le client diffuse les requêtes dans l'ordre suivant : Initialisation : le premier message doit contenir SessionConfig. Pour les sessions audio, cela doit également inclure InputAudioConfig et OutputAudioConfig pour définir les paramètres de traitement et de synthèse audio. Interaction : les messages suivants diffusent SessionInput contenant des données d'entrée utilisateur en temps réel. Résiliation : le client doit fermer le flux à moitié lorsqu'il n'y a plus d'entrée utilisateur. Il doit également se fermer à moitié lorsqu'il reçoit EndSession ou GoAway de l'agent. --- Flux de réponse du serveur --- À chaque tour d'interaction, l'agent diffuse les messages dans l'ordre suivant : Reconnaissance vocale (N premiers messages) : contient RecognitionResult représentant les segments vocaux de l'utilisateur capturés jusqu'à présent. Cette valeur n'est renseignée que pour les sessions audio. Réponse (prochains M messages) : contient SessionOutput, qui fournit la réponse de l'agent dans différentes modalités (par exemple, texte, audio). Fin du tour (message final du tour) : contient SessionOutput avec turn_completed défini sur "true". Cela indique la fin du tour actuel et inclut DiagnosticInfo avec les détails de l'exécution. --- Bonnes pratiques concernant l'audio --- 1. Streaming : diffusez audio data EN CONTINU, même pendant les silences. Taille de bloc recommandée : entre 40 et 120 ms (compromis entre latence et efficacité). Lecture et interruption : lire audio responses dès réception. Arrêtez immédiatement la lecture si un InterruptionSignal est reçu (par exemple, une intervention de l'utilisateur ou une nouvelle réponse de l'agent). Niveaux d'accès des autorisations Nécessite l'un des niveaux d'accès OAuth suivants : https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Pour plus d'informations, consultez la page Authentication Overview. Autorisations IAM Nécessite l'autorisation IAM suivante sur la ressource session : ces.sessions.bidiRunSession Pour en savoir plus, consultez la documentation IAM.

RunSession

rpc RunSession(RunSessionRequest) returns (RunSessionResponse) Lance une interaction unique avec l'agent CES au cours d'une session. Niveaux d'accès des autorisations Nécessite l'un des niveaux d'accès OAuth suivants : https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Pour plus d'informations, consultez la page Authentication Overview. Autorisations IAM Nécessite l'autorisation IAM suivante sur la ressource session : ces.sessions.runSession Pour en savoir plus, consultez la documentation IAM.

StreamRunSession

rpc StreamRunSession(RunSessionRequest) returns (RunSessionResponse) Lance une interaction d'un tour avec l'agent CES. Utilise le streaming côté serveur pour fournir des résultats incrémentaux et des réponses partielles au fur et à mesure de leur génération. Par défaut, les réponses complètes (par exemple, les messages provenant de rappels ou les réponses LLM complètes) sont envoyées au client dès qu'elles sont disponibles. Pour activer le streaming de blocs de texte individuels directement à partir du modèle, définissez enable_text_streaming sur "true". Niveaux d'accès des autorisations Nécessite l'un des niveaux d'accès OAuth suivants : https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Pour plus d'informations, consultez la page Authentication Overview. Autorisations IAM Nécessite l'autorisation IAM suivante sur la ressource session : ces.sessions.runSession Pour en savoir plus, consultez la documentation IAM.

ToolService

Le service d'outils fournit des API permettant d'interagir avec les outils CES.

ExecuteTool

rpc ExecuteTool(ExecuteToolRequest) returns (ExecuteToolResponse) Exécute l'outil donné avec les arguments donnés. Niveaux d'accès des autorisations Nécessite l'un des niveaux d'accès OAuth suivants : https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Pour plus d'informations, consultez la page Authentication Overview. Autorisations IAM Nécessite l'autorisation IAM suivante sur la ressource parent : ces.tools.execute Pour en savoir plus, consultez la documentation IAM.

RetrieveToolSchema

rpc RetrieveToolSchema(RetrieveToolSchemaRequest) returns (RetrieveToolSchemaResponse) Récupère le schéma de l'outil donné. Le schéma est calculé à la volée pour l'instance de l'outil donnée. Niveaux d'accès des autorisations Nécessite l'un des niveaux d'accès OAuth suivants : https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Pour plus d'informations, consultez la page Authentication Overview. Autorisations IAM Nécessite l'autorisation IAM suivante sur la ressource parent : ces.tools.get Pour en savoir plus, consultez la documentation IAM.

RetrieveTools

rpc RetrieveTools(RetrieveToolsRequest) returns (RetrieveToolsResponse) Récupérez la liste des outils inclus dans l'ensemble d'outils spécifié. Niveaux d'accès des autorisations Nécessite l'un des niveaux d'accès OAuth suivants : https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Pour plus d'informations, consultez la page Authentication Overview. Autorisations IAM Nécessite l'autorisation IAM suivante sur la ressource toolset : ces.toolsets.get Pour en savoir plus, consultez la documentation IAM.

WidgetService

Fournit des API permettant aux widgets d'interagir avec les API CES.

GenerateChatToken

rpc GenerateChatToken(GenerateChatTokenRequest) returns (GenerateChatTokenResponse) Génère un jeton à portée de session pour que le widget de chat s'authentifie auprès des API de session. Niveaux d'accès des autorisations Nécessite l'un des niveaux d'accès OAuth suivants : https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Pour plus d'informations, consultez la Authentication Overview.

Action

Configuration d'une action à utiliser par l'outil. Remarque : Il peut s'agir d'une action ou d'une opération. Pour en savoir plus, consultez https://cloud.google.com/integration-connectors/docs/entities-operation-action.

Champs
input_fields[]	string Facultatif. Champs d'entité à utiliser comme entrées pour l'opération. Si aucun champ n'est spécifié, tous les champs de l'entité seront utilisés.
output_fields[]	string Facultatif. Champs d'entité à renvoyer à partir de l'opération. Si aucun champ n'est spécifié, tous les champs de l'entité seront renvoyés.
Champ d'union action_spec. Spécification d'une action à configurer pour que l'outil puisse l'utiliser. action_spec ne peut être qu'un des éléments suivants :
connection_action_id	string ID d'une action de connexion à utiliser par l'outil.
entity_operation	Action.EntityOperation Configuration de l'opération d'entité à utiliser par l'outil.

EntityOperation

Spécification de l'opération CRUD de l'entité.

Champs
entity_id	string Obligatoire. ID de l'entité.
operation	Action.EntityOperation.OperationType Obligatoire. Opération à effectuer sur l'entité.

OperationType

Opération à effectuer sur l'entité.

Enums
OPERATION_TYPE_UNSPECIFIED	Type d'opération non spécifié. Non valide. La création ou la mise à jour de ConnectorTool échouera.
LIST	Opération de liste.
GET	Obtenir une opération.
CREATE	Opération de création.
UPDATE	Opération de mise à jour.
DELETE	Opération de suppression.

Agent

Un agent sert de composant de base fondamental qui fournit des instructions au grand modèle de langage (LLM) pour exécuter des tâches spécifiques.

Champs
name	string Identifiant. Identifiant unique de l'agent. Format : projects/{project}/locations/{location}/apps/{app}/agents/{agent}
display_name	string Obligatoire. Nom à afficher de l'agent.
description	string Facultatif. Description de l'agent lisible par l'humain.
model_settings	ModelSettings Facultatif. Configurations du modèle LLM.
instruction	string Facultatif. Instructions pour le modèle LLM afin de guider le comportement de l'agent.
tools[]	string Facultatif. Liste des outils disponibles pour l'agent. Format : projects/{project}/locations/{location}/apps/{app}/tools/{tool}
child_agents[]	string Facultatif. Liste des agents enfants dans l'arborescence des agents. Format : projects/{project}/locations/{location}/apps/{app}/agents/{agent}
before_agent_callbacks[]	Callback Facultatif. Rappels à exécuter avant l'appel de l'agent. Les rappels fournis sont exécutés de manière séquentielle dans l'ordre exact dans lequel ils sont fournis dans la liste. Si un rappel renvoie une réponse remplacée, l'exécution s'arrête et les rappels restants sont ignorés.
after_agent_callbacks[]	Callback Facultatif. Rappels à exécuter après l'appel de l'agent. Les rappels fournis sont exécutés de manière séquentielle dans l'ordre exact dans lequel ils sont fournis dans la liste. Si un rappel renvoie une réponse remplacée, l'exécution s'arrête et les rappels restants sont ignorés.
before_model_callbacks[]	Callback Facultatif. Rappels à exécuter avant l'appel du modèle. S'il existe plusieurs appels au modèle, le rappel sera exécuté plusieurs fois. Les rappels fournis sont exécutés de manière séquentielle dans l'ordre exact dans lequel ils sont fournis dans la liste. Si un rappel renvoie une réponse remplacée, l'exécution s'arrête et les rappels restants sont ignorés.
after_model_callbacks[]	Callback Facultatif. Rappels à exécuter après l'appel du modèle. S'il existe plusieurs appels au modèle, le rappel sera exécuté plusieurs fois. Les rappels fournis sont exécutés de manière séquentielle dans l'ordre exact dans lequel ils sont fournis dans la liste. Si un rappel renvoie une réponse remplacée, l'exécution s'arrête et les rappels restants sont ignorés.
before_tool_callbacks[]	Callback Facultatif. Rappels à exécuter avant l'appel de l'outil. Si plusieurs outils sont appelés, le rappel sera exécuté plusieurs fois. Les rappels fournis sont exécutés de manière séquentielle dans l'ordre exact dans lequel ils sont fournis dans la liste. Si un rappel renvoie une réponse remplacée, l'exécution s'arrête et les rappels restants sont ignorés.
after_tool_callbacks[]	Callback Facultatif. Rappels à exécuter après l'appel de l'outil. Si plusieurs outils sont appelés, le rappel sera exécuté plusieurs fois. Les rappels fournis sont exécutés de manière séquentielle dans l'ordre exact dans lequel ils sont fournis dans la liste. Si un rappel renvoie une réponse remplacée, l'exécution s'arrête et les rappels restants sont ignorés.
create_time	Timestamp Uniquement en sortie. Code temporel de création de l'agent.
update_time	Timestamp Uniquement en sortie. Code temporel de la dernière mise à jour de l'agent.
guardrails[]	string Facultatif. Liste des garde-fous pour l'agent. Format : projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}
etag	string Etag utilisé pour s'assurer que l'objet n'a pas été modifié lors d'une opération de lecture-modification-écriture. Si l'etag est vide, la mise à jour écrasera toutes les modifications simultanées.
toolsets[]	Agent.AgentToolset Facultatif. Liste des ensembles d'outils pour l'agent.
generated_summary	string Uniquement en sortie. Si l'agent est généré par l'assistant LLM, ce champ contient un résumé descriptif de la génération.
transfer_rules[]	TransferRule Facultatif. Règles de transfert d'agent. Si plusieurs règles correspondent, la première de la liste sera utilisée.
validation_errors[]	string Uniquement en sortie. Erreurs ou configurations incorrectes dans l'agent pouvant affecter sa qualité.
Champ d'union agent_type. Type d'agent. agent_type ne peut être qu'un des éléments suivants :
llm_agent	Agent.LlmAgent Facultatif. Type d'agent par défaut.
remote_dialogflow_agent	Agent.RemoteDialogflowAgent Facultatif. Agent Dialogflow distant à utiliser pour l'exécution de l'agent. Si ce champ est défini, toutes les autres propriétés au niveau de l'agent seront ignorées. Remarque : Si l'agent Dialogflow se trouve dans un projet différent de celui de l'application, vous devez accorder le rôle roles/dialogflow.client à l'agent de service CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
remote_a2a_agent	Agent.RemoteA2aAgent Facultatif. Agent A2A distant à utiliser pour l'exécution de l'agent.

AgentToolset

Ensemble d'outils avec une sélection de ses outils.

Champs
toolset	string Obligatoire. Nom de ressource de l'ensemble d'outils. Format : projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
tool_ids[]	string Facultatif. ID des outils permettant de filtrer l'ensemble d'outils.

LlmAgent

Ce type ne comporte aucun champ.

Type d'agent par défaut. L'agent utilise les instructions et les rappels spécifiés dans l'agent pour effectuer la tâche à l'aide d'un grand modèle de langage.

RemoteA2aAgent

Agent qui transférera l'exécution à un agent A2A distant.

Champs
a2a_config	RemoteA2aConfig Obligatoire. Configuration de la connexion A2A.

RemoteDialogflowAgent

Agent qui transférera l'exécution à un agent Dialogflow CX distant. L'agent Dialogflow traitera les requêtes utilisateur suivantes jusqu'à la fin de la session ou du flux, et le contrôle sera transféré à l'agent CES parent.

Champs
agent	string Obligatoire. Nom de ressource de l'agent Dialogflow. Format : projects/{project}/locations/{location}/agents/{agent}
flow_id	string Facultatif. ID du flux dans l'agent Dialogflow.
environment_id	string Facultatif. ID de l'environnement de l'agent Dialogflow à utiliser pour l'exécution de l'agent. Si aucun environnement n'est spécifié, l'environnement brouillon sera utilisé.
input_variable_mapping	map<string, string> Facultatif. Mappage des noms des variables d'application avec les noms des paramètres de session Dialogflow à envoyer à l'agent Dialogflow en tant qu'entrée.
output_variable_mapping	map<string, string> Facultatif. Mappage des noms de paramètres de session Dialogflow aux noms de variables d'application à renvoyer à l'agent CES une fois l'exécution de l'agent Dialogflow terminée.
respect_response_interruption_settings	bool Facultatif. Indique s'il faut respecter les paramètres d'interruption au niveau du message configurés dans l'agent Dialogflow. Si la valeur est "false", tous les messages de réponse de l'agent Dialogflow suivent les paramètres d'interruption au niveau de l'application. Si la valeur est "true", seuls les messages de réponse dont le champ allow_playback_interruption est défini sur "true" pourront être interrompus. Tous les autres messages suivront les paramètres d'interruption au niveau de l'application.
language_code_variable	string Facultatif. Nom de la variable contenant le code de langue à utiliser pour la session Dialogflow. Si aucune valeur n'est spécifiée, le code de langue par défaut de l'agent Dialogflow sera utilisé.

AgentCard

AgentCard transmet des informations clés sur un agent à distance. Il s'agit d'une version réduite de l'AgentCard définie dans le protocole A2A https://a2a-protocol.org/dev/specification/#441-agentcard.

Champs
name	string Obligatoire. Nom d'agent lisible par l'humain.
description	string Obligatoire. Description du domaine d'action/de l'espace de solution de l'agent.
supported_interfaces[]	AgentInterface Obligatoire. Liste ordonnée des interfaces compatibles. La première entrée est privilégiée.
version	string Obligatoire. Version de l'agent.
skills[]	AgentSkill Obligatoire. Les compétences représentent une unité de capacité qu'un agent peut effectuer. Cela peut sembler un peu abstrait, mais cela représente un ensemble d'actions plus ciblées que l'agent est très susceptible de réussir.

AgentInterface

Déclare une combinaison d'URL cible, de transport et de version de protocole pour interagir avec l'agent. Cela permet aux agents d'exposer la même fonctionnalité sur plusieurs mécanismes de liaison de protocole.

Champs
url	string Obligatoire. URL où cette interface est disponible. Vous devez saisir une URL HTTPS absolue valide en production. Exemple : "https://api.example.com/a2a/v1", "https://grpc.example.com/a2a"
protocol_binding	string Obligatoire. La liaison de protocole acceptée à cette URL. Il s'agit d'une chaîne de formulaire ouverte, qui peut être facilement étendue à d'autres liaisons de protocole. Les principaux officiellement acceptés sont JSONRPC, GRPC et HTTP+JSON.
tenant	string ID du locataire à utiliser dans la requête lors de l'appel de l'agent.
protocol_version	string Obligatoire. Version du protocole A2A que cette interface expose. Utilisez la dernière version mineure compatible pour chaque version majeure. Exemples : "0.3", "1.0"

AgentRegistryDeployment

Configuration et état du déploiement d'Agent Registry.

Champs
agent_registry_service_name	string Facultatif. Uniquement en sortie. Nom de ressource du service Agent Registry déployé. Format : projects/{project}/locations/{location}/services/{service}

AgentSkill

Représente une fonctionnalité ou une fonction distincte qu'un agent peut effectuer.

Champs
id	string Obligatoire. Identifiant unique de la compétence de l'agent.
name	string Obligatoire. Nom de la compétence lisible par l'humain.
description	string Obligatoire. Description détaillée de la compétence.
tags[]	string Obligatoire. Ensemble de mots clés décrivant les capacités de la compétence.
examples[]	string Exemples de requêtes ou de scénarios que cette compétence peut traiter.
input_modes[]	string Ensemble de types de supports d'entrée acceptés pour cette compétence, qui remplace les valeurs par défaut de l'agent.
output_modes[]	string Ensemble des types de supports de sortie acceptés pour cette compétence, qui remplacent les valeurs par défaut de l'agent.

AgentTool

Représente un outil qui permet à l'agent d'appeler un autre agent.

Champs
name	string Obligatoire. Nom de l'outil de l'agent.
description	string Facultatif. Description de l'objectif de l'outil.
agent	string Facultatif. Nom de ressource de l'agent qui est le point d'entrée de l'outil. Format : projects/{project}/locations/{location}/agents/{agent}

AgentTransfer

Représente un événement indiquant le transfert d'une conversation à un autre agent.

Champs
target_agent	string Obligatoire. Agent auquel la conversation est transférée. L'agent gérera la conversation à partir de ce moment. Format : projects/{project}/locations/{location}/apps/{app}/agents/{agent}
display_name	string Uniquement en sortie. Nom à afficher de l'agent.

AmbientSoundConfig

Configuration du son ambiant à lire avec la réponse de l'agent synthétisée, pour améliorer le naturel de la conversation.

Champs
volume_gain_db	double Facultatif. Gain de volume (en dB) du volume natif normal pris en charge par le bruit ambiant, dans la plage [-96.0, 16.0]. Si la valeur n'est pas définie ou si elle est définie sur une valeur de zéro (dB), elle est lue à une amplitude de signal natif normal. Une valeur de -6 (dB) est lue avec environ la moitié de l'amplitude du signal natif normal. Une valeur de +6 (dB) est lue avec environ deux fois plus d'amplitude que le signal natif normal. Nous vous recommandons vivement de ne pas dépasser +10 (dB), car il n'y a généralement pas d'augmentation efficace du volume pour une valeur supérieure à cette valeur.
Champ d'union source. Bruit ambiant à lire avec la réponse de l'agent synthétisée, pour rendre la conversation plus naturelle. source ne peut être qu'un des éléments suivants :
prebuilt_ambient_noise (deprecated)	AmbientSoundConfig.PrebuiltAmbientNoise Cet élément est obsolète. Facultatif. Obsolète : prebuilt_ambient_noise est obsolète et remplacé par prebuilt_ambient_sound.
gcs_uri	string Facultatif. Bruit ambiant sous forme de fichier WAV monophonique de 16 kHz stocké dans Cloud Storage. Remarque : Veuillez vous assurer que l'agent de service CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com dispose de l'autorisation storage.objects.get pour l'objet Cloud Storage.
prebuilt_ambient_sound	string Facultatif. Nom du son ambiant prédéfini. Les valeurs valides sont les suivantes : "coffee_shop", "keyboard", "keypad", "hum", "office_1", "office_2", "office_3", "room_1", "room_2", "room_3", "room_4", "room_5", "air_conditioner".

PrebuiltAmbientNoise

Bruit ambiant prédéfini.

Enums
PREBUILT_AMBIENT_NOISE_UNSPECIFIED	Non spécifié.
RETAIL_STORE	Bruit ambiant d'un magasin.
CONVENTION_HALL	Bruit ambiant d'une salle de congrès.
OUTDOOR	Bruit ambiant d'une rue.

ApiAuthentication

Informations d'authentification requises pour les appels d'API.

Champs
Champ d'union auth_config. Configuration de l'authentification. auth_config ne peut être qu'un des éléments suivants :
api_key_config	ApiKeyConfig Facultatif. Configuration pour l'authentification par clé API.
oauth_config	OAuthConfig Facultatif. Configuration pour OAuth.
service_agent_id_token_auth_config	ServiceAgentIdTokenAuthConfig Facultatif. Configuration pour l'authentification par jeton d'identité générée à partir de l'agent de service CES.
service_account_auth_config	ServiceAccountAuthConfig Facultatif. Configuration pour l'authentification du compte de service.
bearer_token_config	BearerTokenConfig Facultatif. Configuration pour l'authentification par jeton de support.

ApiKeyConfig

Configurations pour l'authentification avec une clé API.

Champs
key_name	string Obligatoire. Nom du paramètre ou de l'en-tête de la clé API. Exemple : Si la requête API est "https://example.com/act?X-Api-Key=", "X-Api-Key" est le nom du paramètre.
api_key_secret_version	string Obligatoire. Nom de la ressource de version secrète Secret Manager stockant la clé API. Format : projects/{project}/secrets/{secret}/versions/{version} Remarque : Vous devez attribuer le rôle roles/secretmanager.secretAccessor à l'agent de service CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
request_location	ApiKeyConfig.RequestLocation Obligatoire. Emplacement de la clé dans la requête.

RequestLocation

l'emplacement de la clé API dans la requête ;

Enums
REQUEST_LOCATION_UNSPECIFIED	Non spécifié. Cette valeur ne doit pas être utilisée.
HEADER	Représente la clé dans l'en-tête HTTP.
QUERY_STRING	Représente la clé dans la chaîne de requête.

Application

Une application sert de conteneur de premier niveau pour un groupe d'agents, y compris l'agent racine et ses sous-agents, ainsi que leurs configurations associées. Ces agents travaillent ensemble pour atteindre des objectifs spécifiques dans le contexte de l'application.

Champs
name	string Identifiant. Identifiant unique de l'application. Format : projects/{project}/locations/{location}/apps/{app}
display_name	string Obligatoire. Nom à afficher de l'application.
description	string Facultatif. Description de l'application, lisible par l'utilisateur.
pinned	bool Facultatif. Indique si l'application est épinglée dans la liste des applications.
root_agent	string Facultatif. L'agent racine est le point d'entrée de l'application. Format : projects/{project}/locations/{location}/apps/{app}/agents/{agent}
language_settings	LanguageSettings Facultatif. Paramètres de langue de l'application.
time_zone_settings	TimeZoneSettings Facultatif. Paramètres de fuseau horaire de l'application.
audio_processing_config	AudioProcessingConfig Facultatif. Configuration du traitement audio de l'application.
logging_settings	LoggingSettings Facultatif. Paramètres de journalisation de l'application.
error_handling_settings	ErrorHandlingSettings Facultatif. Paramètres de gestion des exceptions de l'application.
model_settings	ModelSettings Facultatif. Paramètres du modèle LLM par défaut pour l'application. Les ressources individuelles (par exemple, les agents et les garde-fous) peuvent remplacer ces configurations si nécessaire.
tool_execution_mode	App.ToolExecutionMode Facultatif. Mode d'exécution de l'outil pour l'application. Si aucune valeur n'est fournie, la valeur par défaut est PARALLEL.
evaluation_metrics_thresholds	EvaluationMetricsThresholds Facultatif. Seuils d'évaluation pour l'application.
variable_declarations[]	App.VariableDeclaration Facultatif. Déclarations des variables.
predefined_variable_declarations[]	App.VariableDeclaration Uniquement en sortie. Déclarations des variables prédéfinies pour l'application.
global_instruction	string Facultatif. Instructions pour tous les agents de l'application. Vous pouvez utiliser ces instructions pour définir une identité ou une personnalité stable pour tous les agents.
guardrails[]	string Facultatif. Liste des garde-fous pour l'application. Format : projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}
data_store_settings	DataStoreSettings Facultatif. Paramètres du data store pour l'application.
default_channel_profile	ChannelProfile Facultatif. Profil de canal par défaut utilisé par l'application.
metadata	map<string, string> Facultatif. Métadonnées sur l'application. Ce champ peut être utilisé pour stocker des informations supplémentaires concernant les détails ou les utilisations prévues de l'application.
create_time	Timestamp Uniquement en sortie. Code temporel de la création de l'application.
update_time	Timestamp Uniquement en sortie. Code temporel de la dernière mise à jour de l'application.
etag	string Uniquement en sortie. Etag utilisé pour s'assurer que l'objet n'a pas été modifié lors d'une opération de lecture-modification-écriture. Si l'etag est vide, la mise à jour écrasera toutes les modifications simultanées.
deployment_count	int32 Uniquement en sortie. Nombre de déploiements dans l'application.
client_certificate_settings	ClientCertificateSettings Facultatif. Paramètres par défaut du certificat client pour l'application.
vpc_sc_settings	VpcScSettings Facultatif. Paramètres VPC-SC pour l'application.
locked	bool Facultatif. Indique si l'application est verrouillée pour les modifications. Si l'application est verrouillée, les modifications apportées à ses ressources seront refusées.
validation_errors[]	string Uniquement en sortie. Mauvaise configuration ou avertissements dans l'application.
dashboard_settings	DashboardSettings Facultatif. Paramètres de tableau de bord spécifiques à l'application pour associer et configurer les tableaux de bord Contact Center Insights.

ToolExecutionMode

Définit le comportement d'exécution de l'outil si l'agent sélectionne plusieurs outils en même temps.

Enums
TOOL_EXECUTION_MODE_UNSPECIFIED	Mode d'exécution de l'outil non spécifié. La valeur par défaut est "PARALLEL".
PARALLEL	Si plusieurs outils sont sélectionnés, ils seront exécutés en parallèle, avec le même ToolContext.
SEQUENTIAL	Si plusieurs outils sont sélectionnés, ils seront exécutés séquentiellement. L'outil suivant ne sera exécuté qu'une fois l'outil précédent terminé. Il pourra voir le ToolContext mis à jour de l'outil précédent.

VariableDeclaration

Définit la structure et les métadonnées d'une variable.

Champs
name	string Obligatoire. Nom de la variable. Le nom doit commencer par une lettre ou un trait de soulignement, et ne peut contenir que des lettres, des chiffres ou des traits de soulignement.
description	string Obligatoire. Description de la variable.
schema	Schema Obligatoire. Schéma de la variable.

AppSnapshot

Instantané de l'application.

Champs
app	App Facultatif. Paramètres de base de l'application.
agents[]	Agent Facultatif. Liste des agents dans l'application.
tools[]	Tool Facultatif. Liste des outils de l'application.
examples[]	Example Facultatif. Liste d'exemples dans l'application.
guardrails[]	Guardrail Facultatif. Liste des garde-fous dans l'application.
toolsets[]	Toolset Facultatif. Liste des ensembles d'outils dans l'application.

AppVersion

Dans la Customer Engagement Suite (CES), une version d'application est un instantané de l'application à un moment précis. Il est immuable et ne peut pas être modifié une fois créé.

Champs
name	string Identifiant. Identifiant unique de la version de l'application. Format : projects/{project}/locations/{location}/apps/{app}/versions/{version}
display_name	string Facultatif. Nom à afficher de la version de l'application.
description	string Facultatif. Description de la version de l'application.
creator	string Uniquement en sortie. Adresse e-mail de l'utilisateur qui a créé la version de l'application.
create_time	Timestamp Uniquement en sortie. Code temporel de la création de la version de l'application.
update_time	Timestamp Uniquement en sortie. Code temporel de la dernière mise à jour de la version de l'application.
snapshot	AppSnapshot Uniquement en sortie. Instantané de l'application au moment de la création de la version.
etag	string Uniquement en sortie. Etag utilisé pour s'assurer que l'objet n'a pas été modifié lors d'une opération de lecture-modification-écriture. Si l'etag est vide, la mise à jour écrasera toutes les modifications simultanées.

AudioEncoding

AudioEncoding spécifie le format d'encodage des données audio.

Enums
AUDIO_ENCODING_UNSPECIFIED	Encodage audio non spécifié.
LINEAR16	Encodage audio PCM linéaire 16 bits.
MULAW	Échantillons de 8 bits compressant des échantillons audio 14 bits qui utilisent la norme G.711 PCMU/MULAW.
ALAW	Échantillons de 8 bits compressant des échantillons audio 14 bits qui utilisent la norme G.711 PCMU/A-law.

AudioProcessingConfig

Configuration du traitement et de la diffusion de l'audio d'entrée et de sortie.

Champs
synthesize_speech_configs	map<string, SynthesizeSpeechConfig> Facultatif. Configuration de la manière dont la réponse de l'agent doit être synthétisée, mappant le code de langue à SynthesizeSpeechConfig. Si la configuration pour le code de langue spécifié est introuvable, celle du code de langue racine sera utilisée. Par exemple, si la carte contient "en-us" et "en", et que le code de langue spécifié est "en-gb", la configuration "en" sera utilisée. Remarque : Le code de langue n'est pas sensible à la casse.
barge_in_config	BargeInConfig Facultatif. Configure le comportement de l'agent pour les activités d'interruption par l'utilisateur.
inactivity_timeout	Duration Facultatif. Durée d'inactivité de l'utilisateur (aucune parole ni interaction) avant que l'agent ne l'invite à réagir. Si cette option n'est pas définie, l'agent n'invite pas l'utilisateur à réinteragir.
ambient_sound_config	AmbientSoundConfig Facultatif. Configuration du son ambiant à lire avec la réponse de l'agent synthétisée, pour améliorer le naturel de la conversation.
custom_voice_samples[]	CustomVoiceSample Facultatif. Configure des exemples de voix personnalisés pour le clonage de voix.

AudioRecordingConfig

Configuration de l'enregistrement des interactions audio.

Champs
gcs_bucket	string Facultatif. Bucket Cloud Storage pour stocker les enregistrements audio des sessions. L'URI doit commencer par "gs://". Veuillez choisir un emplacement de bucket qui répond à vos exigences de résidence des données. Remarque : Si le bucket Cloud Storage se trouve dans un projet différent de celui de l'application, vous devez accorder l'autorisation storage.objects.create à l'agent de service CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
gcs_path_prefix	string Facultatif. Préfixe du chemin d'accès Cloud Storage pour les enregistrements audio. Ce préfixe peut inclure les espaces réservés suivants, qui seront remplacés de manière dynamique au moment de la diffusion : - $project : ID du projet - $location : emplacement de l'application - $app : ID de l'application - $date : date de la session au format AAAA-MM-JJ - $session : ID de la session Si le préfixe de chemin n'est pas spécifié, le préfixe par défaut $project/$location/$app/$date/$session/ sera utilisé.

BargeInConfig

Configuration de la façon dont les activités d'interruption de l'utilisateur doivent être gérées.

Champs
disable_barge_in (deprecated)	bool Cet élément est obsolète. Facultatif. Obsolète : disable_barge_in est obsolète et remplacé par disable_barge_in_control dans ChannelProfile. Désactive l'interruption de l'utilisateur pendant que l'agent parle. Si la valeur est "true", les entrées utilisateur pendant la lecture de la réponse de l'agent seront ignorées.
barge_in_awareness	bool Facultatif. Si cette option est activée, l'agent adaptera sa prochaine réponse en partant du principe que l'utilisateur n'a pas entendu l'intégralité du message précédent de l'agent. Cette méthode ne doit pas être utilisée dans les scénarios où les réponses de l'agent sont affichées visuellement.

BatchDeleteConversationsRequest

Message de requête pour AgentService.BatchDeleteConversations.

Champs
parent	string Obligatoire. Nom de ressource de l'application à partir de laquelle supprimer les conversations. Format : projects/{project}/locations/{location}/apps/{app}
conversations[]	string Obligatoire. Noms de ressources des conversations à supprimer.

BatchDeleteConversationsResponse

Message de réponse pour AgentService.BatchDeleteConversations.

Champs
deleted_conversations[]	string Liste des conversations qui ont été supprimées.
failed_conversations[]	string Liste des conversations qui n'ont pas pu être supprimées.
error_messages[]	string Facultatif. Liste des messages d'erreur associés aux conversations qui n'ont pas pu être supprimées.

BearerTokenConfig

Configurations pour l'authentification avec un jeton de support.

Champs
token	string Obligatoire. Jeton de support. Il doit respecter le format $context.variables.<name_of_variable>.

BidiSessionClientMessage

Message de premier niveau envoyé par le client pour la méthode SessionService.BidiRunSession.

Champs
Champ d'union message_type. Type du message. message_type ne peut être qu'un des éléments suivants :
config	SessionConfig Facultatif. Message de configuration initiale de la session.
realtime_input	SessionInput Facultatif. Saisie en temps réel pour la session.

BidiSessionServerMessage

Message de premier niveau renvoyé par la méthode SessionService.BidiRunSession.

Champs
Champ d'union message_type. Type du message. message_type ne peut être qu'un des éléments suivants :
session_output	SessionOutput Facultatif. Résultat du traitement de l'agent CES.
recognition_result	RecognitionResult Facultatif. Résultat de la reconnaissance vocale en temps réel pour l'entrée audio.
interruption_signal	InterruptionSignal Facultatif. Indique que la réponse audio de l'agent a été interrompue.
end_session	EndSession Facultatif. Indique que la session est terminée.
go_away	GoAway Facultatif. Indique que le serveur va bientôt se déconnecter et que le client doit fermer à moitié et redémarrer la connexion.

BigQueryExportSettings

Paramètres permettant de décrire les comportements d'exportation BigQuery pour l'application.

Champs
enabled	bool Facultatif. Indique si l'exportation BigQuery est activée.
project	string Facultatif. L'ID du projet de l'ensemble de données BigQuery vers lequel exporter les données. Remarque : Si l'ensemble de données BigQuery se trouve dans un projet différent de celui de l'application, vous devez attribuer le rôle roles/bigquery.admin à l'agent de service CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
dataset	string Facultatif. ID de l'ensemble de données BigQuery vers lequel exporter les données.

Blob

Représente une entrée ou une sortie de blob dans la conversation.

Champs
mime_type	string Obligatoire. Type MIME standard IANA des données sources.
data	bytes Obligatoire. Octets bruts de l'objet blob.

Rappel

Un rappel définit la logique personnalisée à exécuter à différentes étapes de l'interaction de l'agent.

Champs
description	string Facultatif. Description lisible du rappel.
disabled	bool Facultatif. Indique si le rappel est désactivé. Les rappels désactivés sont ignorés par l'agent.
proactive_execution_enabled	bool Facultatif. Si elle est activée, le rappel sera également exécuté sur les sorties de modèle intermédiaires. Ce paramètre n'affecte que le rappel "Après le modèle". ACTIVEZ CETTE FONCTIONNALITÉ AVEC PRÉCAUTION. En règle générale, le rappel "après le modèle" ne doit être exécuté qu'après avoir reçu toutes les réponses du modèle. L'activation de l'exécution proactive peut avoir des conséquences négatives sur le coût et la latence de l'exécution. Elle ne doit être activée que dans de rares cas.
Champ d'union callback. Rappel à exécuter. callback ne peut être qu'un des éléments suivants :
python_code	string Obligatoire. Code Python à exécuter pour le rappel.

Journal des modifications

Les journaux des modifications représentent une modification apportée à l'application ou à une ressource de l'application.

Champs
name	string Identifiant. Identifiant unique du journal des modifications. Format : projects/{project}/locations/{location}/apps/{app}/changelogs/{changelog}
author	string Uniquement en sortie. Adresse e-mail de l'auteur de la modification.
display_name	string Uniquement en sortie. Nom à afficher de la modification. Il s'agit généralement du nom à afficher de la ressource qui a été modifiée.
description	string Uniquement en sortie. Description de la modification, qui indique généralement les champs modifiés dans la ressource.
resource	string Uniquement en sortie. Ressource modifiée.
resource_type	string Uniquement en sortie. Type de ressource modifiée.
action	string Uniquement en sortie. Action effectuée sur la ressource.
original_resource	Struct Uniquement en sortie. Ressource d'origine avant la modification.
new_resource	Struct Uniquement en sortie. Nouvelle ressource après la modification.
dependent_resources[]	Struct Uniquement en sortie. Ressources dépendantes qui ont été modifiées.
create_time	Timestamp Uniquement en sortie. Heure à laquelle la modification a été apportée.
sequence_number	int64 Uniquement en sortie. Numéro de séquence du journal des modifications, qui augmente de façon monotone.

ChannelProfile

Un ChannelProfile configure le comportement de l'agent pour un canal de communication spécifique, tel que l'interface utilisateur Web ou la téléphonie.

Champs
profile_id	string Facultatif. Identifiant unique du profil de chaîne.
channel_type	ChannelProfile.ChannelType Facultatif. Type de profil de chaîne.
persona_property	ChannelProfile.PersonaProperty Facultatif. Propriété "persona" du profil de la chaîne.
web_widget_config	ChannelProfile.WebWidgetConfig Facultatif. Configuration du widget Web.
whatsapp_config	ChannelProfile.WhatsAppConfig Facultatif. Configuration spécifique aux déploiements WhatsApp.
instagram_config	ChannelProfile.InstagramConfig Facultatif. Configuration spécifique aux déploiements Instagram.
disable_dtmf	bool Facultatif. Indique s'il faut désactiver le DTMF (multifréquence à deux tonalités).
disable_barge_in_control	bool Facultatif. Indique si le contrôle de l'intrusion de l'utilisateur dans la conversation doit être désactivé. - true : les interruptions de l'utilisateur sont désactivées pendant que l'agent parle. - false : l'agent conserve le contrôle automatique sur le moment où l'utilisateur peut interrompre.
noise_suppression_level	string Facultatif. Niveau de suppression du bruit du profil de chaîne. Les valeurs disponibles sont "low", "moderate", "high" et "very_high".

ChannelType

Type de profil de chaîne.

Enums
UNKNOWN	Type de canal inconnu.
WEB_UI	Canal de l'UI Web.
API	Canal API
TWILIO	Canal Twilio.
GOOGLE_TELEPHONY_PLATFORM	Canal Google Telephony Platform.
CONTACT_CENTER_AS_A_SERVICE	Canal Contact Center as a Service (CCaaS).
CONTACT_CENTER_AS_A_SERVICE_CHAT	Canal Contact Center as a Service (CCaaS Chat).
FIVE9	Canal Five9
CONTACT_CENTER_INTEGRATION	Canal d'intégration de centre de contact tiers.
WHATSAPP	Canal WhatsApp.
INSTAGRAM	Chaîne Instagram.

InstagramConfig

Configuration spécifique aux déploiements Instagram.

Champs
instagram_account_id	string Obligatoire. ID du compte Instagram.
display_name	string Uniquement en sortie. Nom de la page d'entreprise Meta récupérée.
thumbnail_url	string Uniquement en sortie. URL de la vignette de la fiche d'établissement Meta récupérée.
description	string Uniquement en sortie. Description de la page ou du profil d'entreprise Meta.

PersonaProperty

Représente la propriété de persona d'une chaîne.

Champs
persona	ChannelProfile.PersonaProperty.Persona Facultatif. Personnalité de la chaîne.

Persona

Personnalité de la chaîne.

Enums
UNKNOWN	Persona INCONNU.
CONCISE	L'agent fournit des réponses concises et précises.
CHATTY	L'agent fournit du contexte, des explications et des détails supplémentaires.

WebWidgetConfig

Message de configuration du widget Web.

Champs
modality	ChannelProfile.WebWidgetConfig.Modality Facultatif. Modalité du widget Web.
theme	ChannelProfile.WebWidgetConfig.Theme Facultatif. Thème du widget Web.
web_widget_title	string Facultatif. Titre du widget Web.
security_settings	ChannelProfile.WebWidgetConfig.SecuritySettings Facultatif. Paramètres de sécurité du widget Web.

Modalité

Modalité du widget Web.

Enums
MODALITY_UNSPECIFIED	Modalité inconnue.
CHAT_AND_VOICE	Le widget est compatible avec la saisie par chat et vocale.
VOICE_ONLY	Le widget n'accepte que la saisie vocale.
CHAT_ONLY	Le widget n'accepte que les entrées de chat.
CHAT_VOICE_AND_VIDEO	Le widget accepte les entrées de chat, vocales et vidéo.

SecuritySettings

Paramètres de sécurité du widget Web.

Champs
enable_public_access	bool Facultatif. Indique si l'accès public au widget Web est activé. Si la valeur est true, le widget Web sera accessible au public. Si la valeur est false, le widget Web doit être intégré à votre propre système d'authentification et d'autorisation pour renvoyer des identifiants valides permettant d'accéder à l'agent CES.
enable_origin_check	bool Facultatif. Indique si la vérification de l'origine du widget Web est activée. Si la valeur est true, le widget Web vérifie l'origine du site Web qui le charge et n'autorise son chargement que dans la même origine ou dans l'une des origines autorisées.
allowed_origins[]	string Facultatif. Origines autorisées à héberger le widget Web. Une origine est définie par la RFC 6454. Si ce champ est vide, toutes les origines sont autorisées. Vous ne pouvez pas ajouter plus de 100 origines. Exemple : "https://example.com"
enable_recaptcha	bool Facultatif. Indique si la validation reCAPTCHA pour le widget Web est activée.

Thème

Thème du widget Web.

Enums
THEME_UNSPECIFIED	Thème inconnu.
LIGHT	Thème clair.
DARK	le thème sombre.

WhatsAppConfig

Configuration spécifique aux déploiements WhatsApp.

Champs
waba_id	string Obligatoire. ID du compte WhatsApp Business.
phone_number_id	string Obligatoire. ID du numéro de téléphone Meta.
phone_number	string Facultatif. Numéro de téléphone au format E.164.
display_name	string Uniquement en sortie. Nom de la page d'entreprise Meta récupérée.
thumbnail_url	string Uniquement en sortie. URL de la vignette de la fiche d'établissement Meta récupérée.
description	string Uniquement en sortie. Description de la page ou du profil d'entreprise Meta.

Chunk

Portion de contenu dans un message.

Champs
Champ d'union data. Regroupez les données. data ne peut être qu'un des éléments suivants :
text	string Facultatif. Données textuelles.
transcript	string Facultatif. Transcription associée au contenu audio.
blob	Blob Facultatif. Données blob.
payload	Struct Facultatif. Données de charge utile personnalisées.
image	Image Facultatif. Données d'image.
tool_call	ToolCall Facultatif. Requête d'exécution d'outil.
tool_response	ToolResponse Facultatif. Réponse à l'exécution de l'outil.
agent_transfer	AgentTransfer Facultatif. Événement de transfert d'agent.
updated_variables	Struct Une structure représente les variables qui ont été mises à jour dans la conversation, avec les noms de variables comme clés.
default_variables	Struct Une structure représente les variables par défaut au début de la conversation, avec les noms de variables comme clés.

Citations

Citations associées à la réponse de l'agent.

Champs
cited_chunks[]	Citations.CitedChunk Liste des informations citées.
inline_citations[]	Citations.InlineCitation Facultatif. Liste des citations intégrées dans la réponse de l'agent.

CitedChunk

Élément d'information cité.

Champs
uri	string URI utilisé pour la citation.
title	string Titre du document cité.
text	string Texte utilisé pour la citation.
requires_attribution	bool Indique si cette citation nécessite que l'attribution soit affichée aux utilisateurs finaux.

InlineCitation

Une citation intégrée dans le texte de la réponse.

Champs
start_index	int32 Index de début (en octets) du segment de texte dans la réponse de l'agent.
end_index	int32 Index de fin (en octets) du segment de texte dans la réponse de l'agent.
cited_chunk_indices[]	int32 Index des blocs cités qui soutiennent ce segment de texte. Les indices font référence aux éléments de cited_chunks.

ClientCertificateSettings

Paramètres pour les certificats client personnalisés.

Champs
tls_certificate	string Obligatoire. Certificat TLS encodé au format PEM. Cette chaîne doit inclure les lignes d'en-tête de début et de pied de page de fin.
private_key	string Obligatoire. Nom de la ressource de version du secret Secret Manager stockant la clé privée encodée au format PEM. Format : projects/{project}/secrets/{secret}/versions/{version}
passphrase	string Facultatif. Nom de la ressource de version du secret Secret Manager stockant la phrase secrète permettant de déchiffrer la clé privée. Doit être laissé vide si la clé privée n'est pas chiffrée. Format : projects/{project}/secrets/{secret}/versions/{version}

ClientFunction

Représente une fonction côté client que l'agent peut appeler. Lorsque l'agent choisit l'outil, le contrôle est transféré au client. Le client est responsable de l'exécution de la fonction et du renvoi du résultat sous la forme d'un ToolResponse pour poursuivre l'interaction avec l'agent.

Champs
name	string Obligatoire. Nom de la fonction.
description	string Facultatif. Description de la fonction.
parameters	Schema Facultatif. Schéma des paramètres de la fonction.
response	Schema Facultatif. Schéma de la réponse de la fonction.

CloudLoggingSettings

Paramètres permettant de décrire les comportements de Cloud Logging pour l'application.

Champs
enable_cloud_logging	bool Facultatif. Indique si Cloud Logging doit être activé pour les sessions.

CodeBlock

Bloc de code à exécuter au lieu d'un véritable appel d'outil.

Champs

python_code

string Obligatoire. Code Python qui sera appelé en mode factice de l'outil. Signature de la fonction Python attendue : pour intercepter tous les appels d'outil : def fake_tool_call(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: pour intercepter un appel d'outil spécifique : def fake_{tool_id}(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: si la fonction renvoie "None", le véritable outil sera appelé à la place.

ConnectorTool

Un ConnectorTool permet de se connecter à différentes intégrations. Consultez https://cloud.google.com/integration-connectors/docs/overview.

Champs
connection	string Obligatoire. Nom complet de la ressource de la connexion Integration Connectors référencée. Format : projects/{project}/locations/{location}/connections/{connection}
action	Action Obligatoire. Action à utiliser pour l'outil.
auth_config	EndUserAuthConfig Facultatif. Configure la façon dont l'authentification est gérée dans Integration Connectors. Par défaut, une authentification d'administrateur est transmise dans les requêtes API Integration Connectors. Vous pouvez le remplacer par une autre configuration d'authentification de l'utilisateur final. Remarque : La substitution de l'authentification doit être activée pour la connexion afin de pouvoir spécifier une configuration EUC ici. Sinon, la création de ConnectorTool échouera. Pour en savoir plus, consultez https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override.
name	string Facultatif. Nom de l'outil que l'agent peut utiliser pour déterminer s'il doit appeler ce ConnectorTool.
description	string Facultatif. Description de l'outil que l'agent peut utiliser pour décider d'appeler ou non ConnectorTool.

ConnectorToolset

Ensemble d'outils qui génère des outils à partir d'une connexion Integration Connectors.

Champs
connection	string Obligatoire. Nom complet de la ressource de la connexion Integration Connectors référencée. Format : projects/{project}/locations/{location}/connections/{connection}
auth_config	EndUserAuthConfig Facultatif. Configure la façon dont l'authentification est gérée dans Integration Connectors. Par défaut, une authentification d'administrateur est transmise dans les requêtes API Integration Connectors. Vous pouvez le remplacer par une autre configuration d'authentification de l'utilisateur final. Remarque : La substitution de l'authentification doit être activée pour la connexion afin de pouvoir spécifier une configuration EUC ici. Sinon, la création de l'ensemble d'outils échouera. Consultez https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override.
connector_actions[]	Action Obligatoire. Liste des actions/opérations d'entité du connecteur pour lesquelles générer des outils.

Conversation

Une conversation représente une interaction entre un utilisateur final et l'application CES.

Champs
name	string Identifiant. Identifiant unique de la conversation. Format : projects/{project}/locations/{location}/apps/{app}/conversations/{conversation}
start_time	Timestamp Uniquement en sortie. Code temporel de la création de la conversation.
end_time	Timestamp Uniquement en sortie. Horodatage de la fin de la conversation.
turns[]	Conversation.Turn Obligatoire. Les tours de parole dans la conversation.
turn_count	int32 Uniquement en sortie. Nombre de tours de parole dans la conversation.
channel_type (deprecated)	Conversation.ChannelType Cet élément est obsolète. OBSOLÈTE. Veuillez utiliser input_types à la place.
source	Conversation.Source Uniquement en sortie. Indiquez la source de la conversation.
input_types[]	Conversation.InputType Uniquement en sortie. Types d'entrées de la conversation.
entry_agent	string Uniquement en sortie. Agent qui gère initialement la conversation. Si aucune valeur n'est spécifiée, la conversation est gérée par l'agent racine. Format : projects/{project}/locations/{location}/apps/{app}/agents/{agent}
deployment	string Uniquement en sortie. Déploiement de l'application utilisée pour traiter la conversation. Format : projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
app_version	string Uniquement en sortie. Version de l'application utilisée pour traiter la conversation. Format : projects/{project}/locations/{location}/apps/{app}/versions/{version}
language_code	string Uniquement en sortie. Code de langue de la conversation.
messages[] (deprecated)	Message Cet élément est obsolète. Obsolète. Utilisez plutôt les tours.

ChannelType

Type de canal de la conversation.

Enums
CHANNEL_TYPE_UNSPECIFIED	Type de canal non spécifié.
TEXT	La conversation ne contient que des messages texte entre l'utilisateur final et l'agent.
AUDIO	La conversation contient des messages audio entre l'utilisateur final et l'agent.
MULTIMODAL	Messages multimodaux (image, par exemple) de la conversation entre l'utilisateur final et l'agent.

InputType

Type du message d'entrée.

Enums
INPUT_TYPE_UNSPECIFIED	Type d'entrée non spécifié.
INPUT_TYPE_TEXT	Saisie de texte.
INPUT_TYPE_EVENT	Entrée d'événement.
INPUT_TYPE_AUDIO	Entrée audio.
INPUT_TYPE_IMAGE	Image d'entrée.
INPUT_TYPE_BLOB	Entrée Blob.
INPUT_TYPE_TOOL_RESPONSE	Entrée de réponse de l'outil de fonction client.
INPUT_TYPE_VARIABLES	Variables d'entrée.

Source

Source de la conversation.

Enums
SOURCE_UNSPECIFIED	Source non spécifiée.
LIVE	La conversation provient de l'utilisateur final.
SIMULATOR	La conversation provient du simulateur.
EVAL	La conversation provient de l'évaluation.
AGENT_TOOL	La conversation provient d'un outil d'agent. L'outil Agent exécute l'agent dans une session distincte, qui est conservée à des fins de test et de débogage.

Tourner

Toutes les informations sur un seul tour de conversation.

Champs
messages[]	Message Facultatif. Liste des messages du tour de conversation, y compris l'entrée utilisateur, les réponses de l'agent et les événements intermédiaires lors du traitement.
root_span	Span Facultatif. Portée racine du traitement de l'action.
user_intended_text	string Facultatif. Texte de vérité terrain prévu de l'appelant simulé (Polysynth). N'est renseigné que lorsque les métriques sur le taux d'erreurs de mots sont activées.

ConversationLoggingSettings

Paramètres permettant de décrire les comportements de journalisation des conversations pour l'application.

Champs
disable_conversation_logging	bool Facultatif. Indique si la journalisation des conversations doit être désactivée pour les sessions.
retention_window	Duration Facultatif. Contrôle la période de conservation de la conversation. Si aucune valeur n'est définie, la conversation sera conservée pendant 365 jours.

CreateAgentRequest

Champs
parent	string Obligatoire. Nom de ressource de l'application dans laquelle créer un agent.
agent_id	string Facultatif. ID à utiliser pour l'agent, qui constituera le composant final du nom de ressource de l'agent. Si aucun ID n'est fourni, un ID unique sera automatiquement attribué à l'agent.
agent	Agent Obligatoire. Agent à créer.

CreateAppRequest

Message de requête pour AgentService.CreateApp.

Champs
parent	string Obligatoire. Nom de ressource de l'établissement dans lequel créer une application.
app_id	string Facultatif. ID à utiliser pour l'application, qui constituera le composant final du nom de ressource de l'application. Si aucun ID n'est fourni, un ID unique sera automatiquement attribué à l'application.
app	App Obligatoire. Application à créer.

CreateAppVersionRequest

Message de requête pour AgentService.CreateAppVersion

Champs
parent	string Obligatoire. Nom de ressource de l'application dans laquelle créer une version d'application.
app_version_id	string Facultatif. ID à utiliser pour la version de l'application, qui constituera le composant final du nom de ressource de la version de l'application. Si aucun ID n'est fourni, un ID unique est automatiquement attribué à la version de l'application.
app_version	AppVersion Obligatoire. Version de l'application à créer.

CreateDeploymentRequest

Message de requête pour AgentService.CreateDeployment.

Champs
parent	string Obligatoire. Application parente. Format : projects/{project}/locations/{location}/apps/{app}
deployment_id	string Facultatif. ID à utiliser pour le déploiement, qui constituera le composant final du nom de ressource du déploiement. Si aucun ID n'est fourni, un ID unique sera automatiquement attribué au déploiement.
deployment	Deployment Obligatoire. Déploiement à créer.

CreateExampleRequest

Message de requête pour AgentService.CreateExample.

Champs
parent	string Obligatoire. Nom de ressource de l'application dans laquelle créer un exemple.
example_id	string Facultatif. ID à utiliser pour l'exemple, qui constituera le composant final du nom de ressource de l'exemple. Si aucun ID n'est fourni, un ID unique est automatiquement attribué à l'exemple.
example	Example Obligatoire. Exemple à créer.

CreateGuardrailRequest

Message de requête pour AgentService.CreateGuardrail.

Champs
parent	string Obligatoire. Nom de ressource de l'application dans laquelle créer un garde-fou.
guardrail_id	string Facultatif. ID à utiliser pour le garde-fou, qui constituera le composant final du nom de ressource du garde-fou. Si aucun ID n'est fourni, un ID unique sera automatiquement attribué à la barrière de sécurité.
guardrail	Guardrail Obligatoire. Garde-fou à créer.

CreateToolRequest

Message de requête pour AgentService.CreateTool.

Champs
parent	string Obligatoire. Nom de ressource de l'application dans laquelle créer un outil.
tool_id	string Facultatif. ID à utiliser pour l'outil, qui constituera le composant final du nom de ressource de l'outil. Si aucun ID n'est fourni, un ID unique sera automatiquement attribué à l'outil.
tool	Tool Obligatoire. Outil à créer.

CreateToolsetRequest

Message de requête pour AgentService.CreateToolset.

Champs
parent	string Obligatoire. Nom de ressource de l'application dans laquelle créer un ensemble d'outils.
toolset_id	string Facultatif. ID à utiliser pour l'ensemble d'outils, qui constituera le composant final du nom de ressource de l'ensemble d'outils. Si aucun ID n'est fourni, un ID unique sera automatiquement attribué à l'ensemble d'outils.
toolset	Toolset Obligatoire. Ensemble d'outils à créer.

CustomVoiceSample

Configuration d'un échantillon de voix personnalisé utilisé pour le clonage de voix.

Champs
name	string Facultatif. Nom défini par l'utilisateur pour l'échantillon de voix personnalisée.
voice_sample_gcs_uri	string Facultatif. URI Cloud Storage de l'échantillon audio pour le clonage de voix. L'échantillon audio doit être un fichier WAV mono à 24 kHz.
consent_audio_gcs_uri	string Facultatif. Consentement audio pour le clonage vocal.
voice_instruction	string Facultatif. Instructions en langage naturel pour le style, le ton, le rythme ou la prononciation de la voix.
preview_audio_content	bytes Uniquement en sortie. Aperçu audio synthétisé pour la voix personnalisée, au format WAV canonique (LINEAR16, 24 kHz, 16 bits, mono).
preview_text	string Facultatif. Texte permettant de synthétiser un aperçu audio pour une voix personnalisée.
warnings[]	CustomVoiceSample.Warning Uniquement en sortie. Messages d'avertissement rencontrés lors du traitement du clone vocal (par exemple, niveau audio faible).
voice_instruction_mode	CustomVoiceSample.VoiceInstructionMode Facultatif. Mode d'instruction pour l'extrait de voix. Si aucune valeur n'est spécifiée, la valeur par défaut est NO_INSTRUCTION.

VoiceInstructionMode

Mode d'instruction pour l'extrait de voix.

Enums
VOICE_INSTRUCTION_MODE_UNSPECIFIED	Mode d'instruction non spécifié. La valeur par défaut est NO_INSTRUCTION.
NO_INSTRUCTION	Aucune instruction vocale ne sera utilisée.
GENERATE_INSTRUCTION	Les instructions vocales seront générées automatiquement par l'IA à partir de l'échantillon audio.
CUSTOM_INSTRUCTION	Instructions vocales personnalisées fournies par l'utilisateur.

Avertissement

Message d'avertissement rencontré lors du traitement de l'échantillon vocal.

Champs
message	string Uniquement en sortie. Description lisible de l'avertissement.
type	CustomVoiceSample.Warning.WarningType Uniquement en sortie. Type d'avertissement.

WarningType

Type d'avertissement rencontré lors du traitement de l'échantillon vocal.

Enums
WARNING_TYPE_UNSPECIFIED	Type d'avertissement non spécifié.
LOW_AUDIO_LEVEL	Le niveau audio de l'échantillon vocal est trop faible (par exemple, l'amplitude RMS est faible).

DashboardSettings

Paramètres des tableaux de bord associés à l'application, qui s'affichent dans la vue "Surveillance".

Champs
default_dashboard	string Facultatif. Nom de ressource du tableau de bord Contact Center Insights par défaut associé à l'application. Il s'agit du tableau de bord qui s'affiche lorsque les utilisateurs accèdent à la vue "Surveillance" de l'application. Format : projects/{project}/locations/{location}/dashboards/{dashboard}

DataStore

Ressource DataStore dans Vertex AI Search.

Champs
name	string Obligatoire. Nom complet de la ressource DataStore. Format : projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}
type	DataStore.DataStoreType Uniquement en sortie. Type de data store. Ce champ est en lecture seule et renseigné par le serveur.
document_processing_mode	DataStore.DocumentProcessingMode Uniquement en sortie. Mode de traitement des documents pour la connexion au data store. Défini uniquement pour les data stores PUBLIC_WEB et UNSTRUCTURED.
display_name	string Uniquement en sortie. Nom à afficher du data store.
create_time	Timestamp Uniquement en sortie. Code temporel de création du data store.
connector_config	DataStore.ConnectorConfig Uniquement en sortie. Configuration du connecteur pour la connexion au data store.

ConnectorConfig

Configuration du connecteur pour la connexion au data store.

Champs
collection	string Nom de ressource de la collection à laquelle appartient le data store.
collection_display_name	string Nom à afficher de la collection à laquelle appartient le data store.
data_source	string Nom de la source de données. Exemple : salesforce, jira, confluence, bigquery.

DataStoreType

Type de data store.

Enums
DATA_STORE_TYPE_UNSPECIFIED	Non spécifié. Cette valeur indique que le type de data store n'est pas spécifié. Il ne sera donc pas utilisé lors de la recherche.
PUBLIC_WEB	Datastore contenant du contenu Web public.
UNSTRUCTURED	Datastore contenant des données privées non structurées.
FAQ	Un data store contenant des données structurées utilisées comme questions fréquentes.
CONNECTOR	Datastore qui sert de connecteur à un service first party ou tiers.

DocumentProcessingMode

Mode de traitement des documents du data store.

Enums
DOCUMENT_PROCESSING_MODE_UNSPECIFIED	Non spécifié.
DOCUMENTS	Les documents sont traités en tant que documents.
CHUNKS	Les documents sont convertis en blocs.

DataStoreSettings

Paramètres liés au datastore pour l'application.

Champs
engines[]	DataStoreSettings.Engine Uniquement en sortie. Moteurs de l'application.

Moteur

Moteur auquel les data stores sont connectés. Consultez Vertex AI Search : https://cloud.google.com/generative-ai-app-builder/docs/enterprise-search-introduction.

Champs
name	string Uniquement en sortie. Nom de ressource du moteur. Format : projects/{project}/locations/{location}/collections/{collection}/engines/{engine}
type	DataStoreSettings.Engine.Type Uniquement en sortie. Type de moteur.

Type

Type de moteur. Consultez la documentation disponible sur https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1/SolutionType et https://cloud.google.com/generative-ai-app-builder/docs/create-datastore-ingest.

Enums
TYPE_UNSPECIFIED	Type de moteur non spécifié.
ENGINE_TYPE_SEARCH	Moteur SOLUTION_TYPE_SEARCH pour l'application. Tous les datastores de connecteurs ajoutés à l'application seront ajoutés à ce moteur.
ENGINE_TYPE_CHAT	Type de moteur de chat. Moteur SOLUTION_TYPE_CHAT pour l'application. Tous les datastores de connecteurs ajoutés à l'application seront ajoutés à ce moteur.

DataStoreTool

Outil permettant de récupérer des données à partir du data store ou du moteur Vertex AI Search pour l'ancrage. Accepte un datastore ou un moteur, mais pas les deux. Consultez Vertex AI Search : https://cloud.google.com/generative-ai-app-builder/docs/enterprise-search-introduction.

Champs
name	string Obligatoire. Nom de l'outil data store.
description	string Facultatif. Description de l'outil.
boost_specs[]	DataStoreTool.BoostSpecs Facultatif. Booster les spécifications pour mettre en avant certains documents.
modality_configs[]	DataStoreTool.ModalityConfig Facultatif. Configurations de modalité pour le data store.
filter_parameter_behavior	DataStoreTool.FilterParameterBehavior Facultatif. Comportement du paramètre de filtre.
Champ d'union search_source. Définit la source de recherche, qui peut être un seul DataStore ou un seul moteur. search_source ne peut être qu'un des éléments suivants :
data_store_source	DataStoreTool.DataStoreSource Facultatif. Recherchez dans un DataStore spécifique.
engine_source	DataStoreTool.EngineSource Facultatif. Recherchez dans un moteur (potentiellement dans plusieurs DataStores).

BoostSpec

Booster les spécifications pour mettre en avant certains documents.

Champs
condition_boost_specs[]	DataStoreTool.BoostSpec.ConditionBoostSpec Obligatoire. Liste des spécifications de l'amplification.

ConditionBoostSpec

Spécification de boost pour une condition.

Champs
condition	string Obligatoire. Expression qui spécifie une condition d'optimisation. La syntaxe est identique à celle des expressions de filtre. Pour le moment, la seule condition acceptée est une liste de codes de langue BCP-47. Exemple : Pour améliorer les suggestions dans les langues "en" ou "fr" : (lang_code: ANY("en", "fr"))
boost	float Facultatif. Intensité du boost, qui doit être comprise entre -1 et 1. Un boosting négatif correspond à une rétrogradation. La valeur par défaut est 0,0. Définir l'intensité sur 1.0 permet de promouvoir fortement les suggestions. Toutefois, cela ne signifie pas nécessairement que le premier résultat sera une suggestion boostée. Définir la valeur sur -1.0 permet de rétrograder fortement les suggestions. Toutefois, d'autres suggestions pertinentes peuvent toujours s'afficher. Si vous définissez la valeur sur 0,0, aucun boost n'est appliqué. La condition de boost est ignorée.
boost_control_spec	DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec Facultatif. Spécification complexe pour le classement personnalisé basé sur la valeur de l'attribut définie par le client.

BoostControlSpec

Spécification du classement personnalisé basé sur la valeur de l'attribut spécifié par le client. Elle offre plus de contrôles pour le classement personnalisé que la simple combinaison (condition, boost) ci-dessus.

Champs
field_name	string Facultatif. Nom du champ dont la valeur sera utilisée pour déterminer le montant du boost.
attribute_type	DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType Facultatif. Type d'attribut à utiliser pour déterminer le montant de l'augmentation. La valeur de l'attribut peut être dérivée de la valeur du champ field_name spécifié. Dans le cas d'une valeur numérique, c'est simple : attribute_value = numerical_field_value. Dans le cas de la fraîcheur, attribute_value = (time.now() - datetime_field_value).
interpolation_type	DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.InterpolationType Facultatif. Type d'interpolation à appliquer pour relier les points de contrôle listés ci-dessous.
control_points[]	DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint Facultatif. Points de contrôle utilisés pour définir la courbe. La fonction monotone (définie par le biais de l'interpolation_type ci-dessus) passe par les points de contrôle listés ici.

AttributeType

Attribut(ou fonction) auquel le classement personnalisé doit être appliqué.

Enums
ATTRIBUTE_TYPE_UNSPECIFIED	AttributeType non spécifié.
NUMERICAL	La valeur du champ numérique sera utilisée pour mettre à jour dynamiquement le montant du boost. Dans ce cas, la valeur attribute_value (valeur x) du point de contrôle sera la valeur réelle du champ numérique pour lequel boost_amount est spécifié.
FRESHNESS	Pour le cas d'utilisation de la fraîcheur, la valeur de l'attribut correspond à la durée entre l'heure actuelle et la date indiquée dans le champ "datetime". La valeur doit être formatée en tant que valeur XSD dayTimeDuration (sous-ensemble restreint d'une valeur de durée ISO 8601). Le format est le suivant : [nD][T[nH][nM][nS]]. Par exemple, 5D, 3DT12H30M, T24H.

ControlPoint

Points de contrôle utilisés pour définir la courbe. La courbe définie par ces points de contrôle ne peut qu'augmenter ou diminuer de manière monotone(les valeurs constantes sont acceptables).

Champs
attribute_value	string Facultatif. Peut être l'une des valeurs suivantes : 1. Valeur numérique du champ. 2. Spécification de la durée de fraîcheur : la valeur doit être au format XSD dayTimeDuration (un sous-ensemble restreint d'une valeur de durée ISO 8601). Le format est le suivant : [nD][T[nH][nM][nS]].
boost_amount	float Facultatif. Valeur comprise entre -1 et 1 permettant d'augmenter le score si la valeur de l'attribut correspond à la valeur spécifiée ci-dessus.

InterpolationType

Type d'interpolation à appliquer. La valeur par défaut est "linéaire" (linéaire par morceaux).

Enums
INTERPOLATION_TYPE_UNSPECIFIED	Le type d'interpolation n'est pas spécifié. Dans ce cas, la valeur par défaut est "Linear".
LINEAR	Une interpolation linéaire par morceaux sera appliquée.

BoostSpecs

Booster les spécifications pour booster certains documents. Pour en savoir plus, consultez https://cloud.google.com/generative-ai-app-builder/docs/boosting.

Champs
data_stores[]	string Obligatoire. Datastore auquel la configuration du boosting est appliquée. Nom complet de la ressource DataStore, par exemple projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}.
spec[]	DataStoreTool.BoostSpec Obligatoire. Liste des spécifications de l'amplification.

DataStoreSource

Configuration pour la recherche dans un DataStore spécifique.

Champs
filter	string Facultatif. Spécification du filtre pour DataStore. Consultez https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata.
data_store	DataStore Facultatif. Le data store.

EngineSource

Configuration pour la recherche dans un moteur, ciblant potentiellement des DataStores spécifiques.

Champs
engine	string Obligatoire. Nom complet de la ressource du moteur. Format : projects/{project}/locations/{location}/collections/{collection}/engines/{engine}
data_store_sources[]	DataStoreTool.DataStoreSource Facultatif. Permet de cibler des DataStores spécifiques dans le moteur. Si ce champ est vide, la recherche s'applique à tous les DataStores associés au moteur.
filter	string Facultatif. Filtre appliqué à la recherche dans le moteur. Non pertinent et non utilisé si "data_store_sources" est fourni. Consultez https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata.

FilterParameterBehavior

Comportement du paramètre de filtre.

Enums
FILTER_PARAMETER_BEHAVIOR_UNSPECIFIED	Comportement par défaut du filtre. Incluez le paramètre de filtre pour les data stores de connecteur. Pour les autres types de magasins de données, le paramètre d'entrée du filtre est omis.
ALWAYS_INCLUDE	Incluez toujours le paramètre de filtre pour tous les types de data stores.
NEVER_INCLUDE	Le paramètre de filtre n'est jamais inclus dans la liste des paramètres d'outil, quel que soit le type de data store.

GroundingConfig

Configuration de l'ancrage.

Champs
grounding_level	float Facultatif. Seuil d'ancrage de la réponse en fonction des sources récupérées. La valeur a une plage configurable de [1, 5]. Le niveau est utilisé pour définir le seuil d'ancrage de la réponse. Cela signifie que toutes les réponses dont le score d'ancrage est inférieur au seuil se contenteront de renvoyer des extraits pertinents. Par exemple, un niveau de 3 signifie que le score d'ancrage doit être supérieur ou égal à 3 pour que la réponse soit renvoyée.
disabled	bool Facultatif. Indique si l'ancrage est désactivé.

ModalityConfig

Si spécifié, applique la configuration donnée pour la modalité spécifiée.

Champs
modality_type	DataStoreTool.ModalityConfig.ModalityType Obligatoire. Type de modalité.
rewriter_config	DataStoreTool.RewriterConfig Facultatif. Configuration du réécriveur.
summarization_config	DataStoreTool.SummarizationConfig Facultatif. Configuration de la synthèse.
grounding_config	DataStoreTool.GroundingConfig Facultatif. Configuration de l'ancrage.
snippets_config	DataStoreTool.SnippetsConfig Facultatif. Configuration des extraits.

ModalityType

Type de modalité.

Enums
MODALITY_TYPE_UNSPECIFIED	Type de modalité non spécifié.
TEXT	Modalité textuelle.
AUDIO	Modalité audio.

RewriterConfig

Configuration du réécriveur.

Champs
model_settings	ModelSettings Obligatoire. Configurations du modèle LLM.
prompt	string Facultatif. Définition du prompt. Si aucune valeur n'est spécifiée, une requête par défaut sera utilisée.
disabled	bool Facultatif. Indique si le réécriveur est désactivé.

SnippetsConfig

Configuration des extraits.

Champs
enable_snippets	bool Facultatif. Indique si les extraits sont activés.
max_snippets	int32 Facultatif. Nombre d'extraits à renvoyer par requête. Si elle n'est pas définie, tous les extraits du service sont renvoyés par défaut.

SummarizationConfig

Configuration de la synthèse.

Champs
model_settings	ModelSettings Facultatif. Configurations du modèle LLM.
prompt	string Facultatif. Définition du prompt. Si aucune valeur n'est spécifiée, une requête par défaut sera utilisée.
disabled	bool Facultatif. Indique si la synthèse est désactivée.

DeleteAgentRequest

Message de requête pour AgentService.DeleteAgent.

Champs
name	string Obligatoire. Nom de ressource de l'agent à supprimer.
force	bool Facultatif. Indique s'il faut supprimer l'agent de force, même s'il est toujours référencé par d'autres applications, agents ou exemples. Si la valeur est force = false, la suppression échoue si d'autres agents/exemples y font référence. Si force = true, supprime l'agent et retire-le de toutes les applications/tous les agents/tous les exemples qui y font référence.
etag	string Facultatif. Etag actuel de l'agent. Si aucun etag n'est fourni, la suppression écrasera toutes les modifications simultanées. Si un etag est fourni et ne correspond pas à l'etag actuel de l'agent, la suppression sera bloquée et une erreur ABORTED sera renvoyée.

DeleteAppRequest

Message de requête pour AgentService.DeleteApp.

Champs
name	string Obligatoire. Nom de ressource de l'application à supprimer.
etag	string Facultatif. Etag actuel de l'application. Si aucun etag n'est fourni, la suppression écrasera toutes les modifications simultanées. Si un etag est fourni et ne correspond pas à l'etag actuel de l'application, la suppression est bloquée et une erreur ABORTED est renvoyée.

DeleteAppVersionRequest

Message de requête pour AgentService.DeleteAppVersion.

Champs
name	string Obligatoire. Nom de ressource de la version de l'application à supprimer.
etag	string Facultatif. Etag actuel de la version de l'application. Si aucun etag n'est fourni, la suppression écrasera toutes les modifications simultanées. Si un etag est fourni et ne correspond pas à l'etag actuel de la version de l'application, la suppression sera bloquée et une erreur ABORTED sera renvoyée.

DeleteConversationRequest

Message de requête pour AgentService.DeleteConversation.

Champs
name	string Obligatoire. Nom de ressource de la conversation à supprimer.
source (deprecated)	Conversation.Source Cet élément est obsolète. Facultatif. Indiquez la source de la conversation. Si aucune valeur n'est définie, Source.Live est appliqué par défaut.

DeleteDeploymentRequest

Message de requête pour AgentService.DeleteDeployment.

Champs
name	string Obligatoire. Nom du déploiement à supprimer. Format : projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
etag	string Facultatif. Etag du déploiement. Si un etag est fourni et ne correspond pas à l'etag actuel du déploiement, la suppression est bloquée et une erreur ABORTED est renvoyée.

DeleteExampleRequest

Message de requête pour AgentService.DeleteExample.

Champs
name	string Obligatoire. Nom de ressource de l'exemple à supprimer.
etag	string Facultatif. Etag actuel de l'exemple. Si aucun etag n'est fourni, la suppression écrasera toutes les modifications simultanées. Si un etag est fourni et ne correspond pas à l'etag actuel de l'exemple, la suppression est bloquée et une erreur ABORTED est renvoyée.

DeleteGuardrailRequest

Message de requête pour AgentService.DeleteGuardrail.

Champs
name	string Obligatoire. Nom de ressource de la barrière de sécurité à supprimer.
force	bool Facultatif. Indique s'il faut supprimer de force la barrière de sécurité, même si elle est toujours référencée par des applications ou des agents. Si la valeur est force = false, la suppression échoue si des applications ou des agents font encore référence au garde-fou. Si vous supprimez force = true, toutes les références existantes des applications/agents seront supprimées et la barrière de sécurité sera supprimée.
etag	string Facultatif. Etag actuel du garde-fou. Si aucun etag n'est fourni, la suppression écrasera toutes les modifications simultanées. Si un etag est fourni et ne correspond pas à l'etag actuel du garde-fou, la suppression sera bloquée et une erreur ABORTED sera renvoyée.

DeleteToolRequest

Message de requête pour AgentService.DeleteTool.

Champs
name	string Obligatoire. Nom de ressource de l'outil à supprimer.
force	bool Facultatif. Indique s'il faut supprimer l'outil de force, même s'il est toujours référencé par des agents/exemples. Si la valeur est force = false, la suppression échouera si des agents font encore référence à l'outil. Si vous supprimez force = true, toutes les références existantes des agents seront supprimées et l'outil sera supprimé.
etag	string Facultatif. Etag actuel de l'outil. Si aucun etag n'est fourni, la suppression écrasera toutes les modifications simultanées. Si un etag est fourni et ne correspond pas à l'etag actuel de l'outil, la suppression sera bloquée et une erreur ABORTED sera renvoyée.

DeleteToolsetRequest

Message de requête pour AgentService.DeleteToolset.

Champs
name	string Obligatoire. Nom de ressource de l'ensemble d'outils à supprimer.
force	bool Facultatif. Indique s'il faut supprimer de force l'ensemble d'outils, même s'il est toujours référencé par des applications ou des agents. Si la valeur est force = false, la suppression échoue si des agents font encore référence à l'ensemble d'outils. Si vous supprimez force = true, toutes les références existantes des agents seront supprimées et l'ensemble d'outils sera supprimé.
etag	string Facultatif. Etag actuel de l'ensemble d'outils. Si aucun etag n'est fourni, la suppression écrasera toutes les modifications simultanées. Si un etag est fourni et ne correspond pas à l'etag actuel de l'ensemble d'outils, la suppression sera bloquée et une erreur ABORTED sera renvoyée.

DeployChannelResponse

Message de réponse pour AgentService.DeployChannel.

Champs
deployment	Deployment Déploiement créé.

Déploiement

Un déploiement représente une version immuable et interrogeable de l'application. Il est utilisé pour déployer une version d'application avec un profil de canal spécifique.

Champs
name	string Identifiant. Nom de ressource du déploiement. Format : projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
display_name	string Obligatoire. Nom à afficher du déploiement.
app_version	string Facultatif. Nom de ressource de la version de l'application à déployer. Format : projects/{project}/locations/{location}/apps/{app}/versions/{version} Utilisez projects/{project}/locations/{location}/apps/{app}/versions/- pour utiliser l'application brouillon.
channel_profile	ChannelProfile Obligatoire. Profil de canal utilisé dans le déploiement.
create_time	Timestamp Uniquement en sortie. Code temporel de la création de ce déploiement.
update_time	Timestamp Uniquement en sortie. Code temporel de la dernière mise à jour de ce déploiement.
etag	string Uniquement en sortie. Etag utilisé pour s'assurer que l'objet n'a pas été modifié lors d'une opération de lecture-modification-écriture. Si l'etag est vide, la mise à jour écrasera toutes les modifications simultanées.
experiment_config	ExperimentConfig Facultatif. Configuration du test pour le déploiement.
whatsapp_credentials	WhatsAppCredentials Facultatif. Uniquement en entrée. Des identifiants WhatsApp éphémères sont requis lors de la configuration d'un profil de canal WhatsApp.
instagram_credentials	InstagramCredentials Facultatif. Uniquement en entrée. Des identifiants Instagram éphémères sont requis lors de la configuration d'un profil de chaîne Instagram.
model_settings	ModelSettings Facultatif. Paramètres du modèle pour le déploiement. Remplace les paramètres du modèle configurés au niveau de l'application/de l'agent. Remarque : Le remplacement des paramètres de modèle au niveau du déploiement est soumis à une liste d'autorisation. Contactez l'équipe CXAS pour activer ce champ.
modality	Deployment.Modality Facultatif. Modalité du déploiement. Remarque : La modification de la modalité au niveau du déploiement est limitée par une liste d'autorisation. Contactez l'équipe CXAS pour activer ce champ.
agent_registry_deployment	AgentRegistryDeployment Facultatif. Configuration pour déployer ce déploiement dans Agent Registry. Si elle est présente, cette version sera publiée dans Agent Registry.

Modalité

Modalité du déploiement.

Enums
MODALITY_UNSPECIFIED	Modalité inconnue.
MODALITY_TEXT	Modalité textuelle.
MODALITY_VOICE	Modalité vocale.
MODALITY_VIDEO	Modalité vidéo.

EndSession

Indique que la session est terminée, soit parce qu'elle a été menée à bien (par exemple, l'utilisateur dit "Au revoir !" ) ou une escalade d'agent.

L'agent ne traitera plus aucune entrée une fois la session terminée. Le client doit fermer la connexion à moitié et se déconnecter après avoir reçu toutes les réponses restantes de l'agent.

Champs
metadata	Struct Facultatif. Fournit des informations supplémentaires sur le signal de fin de session, comme le motif de la fin de la session.

EndUserAuthConfig

Configuration de l'authentification de l'utilisateur final utilisée pour les appels Connection. Les valeurs des champs doivent correspondre aux noms des variables de contexte au format $context.variables.<name_of_variable>.

Champs
Champ d'union auth_config. Configuration de l'authentification. auth_config ne peut être qu'un des éléments suivants :
oauth2_auth_code_config	EndUserAuthConfig.Oauth2AuthCodeConfig Authentification avec un code d'autorisation OAuth 2.0.
oauth2_jwt_bearer_config	EndUserAuthConfig.Oauth2JwtBearerConfig Authentification par autorisation OAuth 2.0 avec profil JWT.

Oauth2AuthCodeConfig

Configuration de l'authentification avec un code d'autorisation OAuth 2.0.

Champs
oauth_token	string Obligatoire. Nom du paramètre de jeton OAuth à transmettre. Il doit respecter le format $context.variables.<name_of_variable>.

Oauth2JwtBearerConfig

Configuration de l'authentification par octroi d'autorisation OAuth 2.0 du profil JWT.

Champs
issuer	string Obligatoire. Nom du paramètre de l'émetteur à transmettre. Il doit respecter le format $context.variables.<name_of_variable>.
subject	string Obligatoire. Nom du paramètre de sujet à transmettre. Il doit respecter le format $context.variables.<name_of_variable>.
client_key	string Obligatoire. Nom du paramètre client à transmettre. Il doit respecter le format $context.variables.<name_of_variable>.

EndpointControlPolicy

Définit la règle de contrôle des points de terminaison au niveau du projet/de l'emplacement.

Champs
enforcement_scope	EndpointControlPolicy.EnforcementScope Facultatif. Champ d'application dans lequel la liste allowed_origins de cette règle est appliquée.
allowed_origins[]	string Facultatif. Origines HTTP(s) autorisées que les outils de l'application peuvent appeler directement. L'application dépend de la valeur de enforcement_scope et de l'état du VPC-SC du projet. Si aucun numéro de port n'est fourni, tous les ports seront autorisés. Sinon, le numéro de port doit correspondre exactement. Par exemple, "https://example.com" correspondra à "https://example.com:443" et à tout autre port. "https://example.com:443" ne correspondra qu'à "https://example.com:443".

EnforcementScope

Définit le champ d'application dans lequel la liste allowed_origins de cette règle est appliquée.

Enums
ENFORCEMENT_SCOPE_UNSPECIFIED	Non spécifié. Cette règle sera traitée comme VPCSC_ONLY.
VPCSC_ONLY	Ce règlement ne s'applique que lorsque VPC-SC est actif.
ALWAYS	Cette règle s'applique TOUJOURS, quel que soit l'état de VPC-SC.

ErrorHandlingSettings

Paramètres décrivant la façon dont les erreurs doivent être gérées dans l'application.

Champs
error_handling_strategy	ErrorHandlingSettings.ErrorHandlingStrategy Facultatif. Stratégie à utiliser pour la gestion des exceptions.
fallback_response_config	ErrorHandlingSettings.FallbackResponseConfig Facultatif. Configuration pour la gestion des réponses de remplacement.
end_session_config	ErrorHandlingSettings.EndSessionConfig Facultatif. Configuration pour mettre fin à la session en cas d'erreurs système (par exemple, erreurs LLM).

EndSessionConfig

Configuration pour mettre fin à la session en cas d'erreurs système (par exemple, erreurs LLM).

Champs
escalate_session	bool Facultatif. Indique si la session doit être escaladée dans EndSession. Si la session est escaladée, metadata in EndSession contiendra session_escalated = true. Pour en savoir plus, consultez https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/deploy/google-telephony-platform#transfer_a_call_to_a_human_agent.

ErrorHandlingStrategy

Définit la stratégie de gestion des erreurs.

Enums
ERROR_HANDLING_STRATEGY_UNSPECIFIED	Stratégie de gestion des exceptions non spécifiée.
NONE	Aucune gestion spécifique n'est activée.
FALLBACK_RESPONSE	Un message de secours sera renvoyé à l'utilisateur en cas d'erreur système (par exemple, erreur de LLM).
END_SESSION	Un signal EndSession sera émis en cas d'erreurs système (par exemple, erreurs LLM).

FallbackResponseConfig

Configuration pour la gestion des réponses de remplacement.

Champs
custom_fallback_messages	map<string, string> Facultatif. Messages de remplacement en cas d'erreurs système (par exemple, erreurs LLM), mappés par code de langue compatible.
max_fallback_attempts	int32 Facultatif. Nombre maximal de tentatives de secours à effectuer avant que l'agent n'émette le signal EndSession.

EvaluationMetricsThresholds

Paramètres de seuil pour les métriques d'une évaluation.

Champs
golden_evaluation_metrics_thresholds	EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds Facultatif. Seuils des métriques d'évaluation de référence.
hallucination_metric_behavior (deprecated)	EvaluationMetricsThresholds.HallucinationMetricBehavior Cet élément est obsolète. Facultatif. Obsolète : utilisez plutôt golden_hallucination_metric_behavior. Le comportement de la métrique d'hallucination est actuellement utilisé pour les évaluations de référence.
golden_hallucination_metric_behavior	EvaluationMetricsThresholds.HallucinationMetricBehavior Facultatif. Comportement de la métrique d'hallucination pour les évaluations clés.
scenario_hallucination_metric_behavior	EvaluationMetricsThresholds.HallucinationMetricBehavior Facultatif. Comportement de la métrique d'hallucination pour les évaluations de scénarios.

GoldenEvaluationMetricsThresholds

Paramètres pour les évaluations de référence.

Champs
turn_level_metrics_thresholds	EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds Facultatif. Seuils des métriques au niveau du tour.
expectation_level_metrics_thresholds	EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.ExpectationLevelMetricsThresholds Facultatif. Seuils des métriques de niveau d'attente.
tool_matching_settings	EvaluationMetricsThresholds.ToolMatchingSettings Facultatif. Paramètres de correspondance de l'outil. Un appel d'outil supplémentaire est un appel d'outil présent dans l'exécution, mais qui ne correspond à aucun appel d'outil dans l'attente de référence.

ExpectationLevelMetricsThresholds

Seuils des métriques de niveau d'attente.

Champs
tool_invocation_parameter_correctness_threshold	float Facultatif. Seuil de réussite pour la justesse des paramètres d'appel d'outils individuels. Doit être un nombre à virgule flottante compris entre 0 et 1. La valeur par défaut est 1.0.

TurnLevelMetricsThresholds

Seuils des métriques au niveau du tour.

Champs
semantic_similarity_channel	EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds.SemanticSimilarityChannel Facultatif. Canal de similarité sémantique à utiliser pour l'évaluation.
semantic_similarity_success_threshold	int32 Facultatif. Seuil de réussite pour la similarité sémantique. Veuillez saisir un nombre entier compris entre 0 et 4. La valeur par défaut est >= 3.
overall_tool_invocation_correctness_threshold	float Facultatif. Seuil de réussite pour la correction globale de l'invocation d'outil. Doit être un nombre à virgule flottante compris entre 0 et 1. La valeur par défaut est 1.0.

SemanticSimilarityChannel

Canal de similarité sémantique à utiliser.

Enums
SEMANTIC_SIMILARITY_CHANNEL_UNSPECIFIED	Métrique non spécifiée. La valeur par défaut est TEXT.
TEXT	Utilisez la similarité sémantique du texte.
AUDIO	Utilisez la similarité sémantique audio.

HallucinationMetricBehavior

Comportement de la métrique d'hallucination. Quel que soit le comportement, la métrique sera toujours calculée. La différence est que, lorsqu'elle est désactivée, la métrique n'est pas utilisée pour calculer le score d'évaluation global.

Enums
HALLUCINATION_METRIC_BEHAVIOR_UNSPECIFIED	Comportement non spécifié de la métrique d'hallucination.
DISABLED	Désactivez la métrique d'hallucination.
ENABLED	Activez la métrique d'hallucination.

ToolMatchingSettings

Paramètres pour les appels d'outils correspondants.

Champs
extra_tool_call_behavior	EvaluationMetricsThresholds.ToolMatchingSettings.ExtraToolCallBehavior Facultatif. Comportement pour les appels d'outils supplémentaires. La valeur par défaut est "FAIL".

ExtraToolCallBehavior

Définit le comportement lorsqu'un appel d'outil supplémentaire est rencontré. Un appel d'outil supplémentaire est un appel d'outil présent dans l'exécution, mais qui ne correspond à aucun appel d'outil dans l'attente de référence.

Enums
EXTRA_TOOL_CALL_BEHAVIOR_UNSPECIFIED	Comportement non spécifié. La valeur par défaut est "FAIL".
FAIL	Échec de l'évaluation si un appel d'outil supplémentaire est détecté.
ALLOW	Autorisez l'appel d'outil supplémentaire.

Événement

Entrée d'événement.

Champs
event	string Obligatoire. Nom de l'événement.
variables	Struct Facultatif. Variables supplémentaires associées à l'événement.

Exemple

Un exemple représente un échantillon de conversation entre l'utilisateur et l'agent(ou les agents).

Champs
name	string Identifiant. Identifiant unique de l'exemple. Format : projects/{project}/locations/{location}/apps/{app}/examples/{example}
display_name	string Obligatoire. Nom à afficher de l'exemple.
description	string Facultatif. Description de l'exemple lisible par l'humain.
entry_agent	string Facultatif. Agent qui gère initialement la conversation. Si aucune valeur n'est spécifiée, l'exemple représente une conversation gérée par l'agent racine. Format : projects/{project}/locations/{location}/apps/{app}/agents/{agent}
messages[]	Message Facultatif. Collection de messages qui composent la conversation.
create_time	Timestamp Uniquement en sortie. Code temporel de création de l'exemple.
update_time	Timestamp Uniquement en sortie. Code temporel de la dernière mise à jour de l'exemple.
invalid	bool Uniquement en sortie. L'exemple peut devenir non valide si les ressources référencées sont supprimées. Les exemples incorrects ne seront pas utilisés comme exemples few-shot.
etag	string Etag utilisé pour s'assurer que l'objet n'a pas été modifié lors d'une opération de lecture-modification-écriture. Si l'etag est vide, la mise à jour écrasera toutes les modifications simultanées.

ExecuteToolRequest

Message de requête pour ToolService.ExecuteTool.

Champs
parent	string Obligatoire. Nom de ressource de l'application à laquelle appartient l'outil ou l'ensemble d'outils. Format : projects/{project}/locations/{location}/apps/{app}
args	Struct Facultatif. Paramètres et valeurs d'entrée de l'outil au format d'objet JSON.
mock_config	MockConfig Facultatif. Configuration fictive pour l'exécution de l'outil. Si ce champ est défini, les outils qui appellent d'autres outils seront simulés en fonction des modèles et des réponses fournis.
Champ d'union tool_identifier. Identifiant de l'outil à exécuter. Il peut s'agir d'un outil persistant ou d'un outil d'un ensemble d'outils. tool_identifier ne peut être qu'un des éléments suivants :
tool	string Facultatif. Nom de l'outil à exécuter. Format : projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolset_tool	ToolsetTool Facultatif. Outil du toolset à exécuter. Un seul outil doit correspondre au prédicat de l'ensemble d'outils. Sinon, une erreur sera renvoyée.
Champ d'union tool_execution_context. Le contexte supplémentaire à fournir pour l'exécution de l'outil tool_execution_context ne peut être que l'un des suivants :
variables	Struct Facultatif. Variables disponibles pour l'exécution de l'outil.
context	Struct Facultatif. Le [ToolCallContext](https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/python#environment pour en savoir plus) à transmettre à l'outil Python.

ExecuteToolResponse

Message de réponse pour ToolService.ExecuteTool.

Champs
response	Struct Résultat de l'exécution de l'outil au format d'objet JSON. Utilisez la clé "output" pour spécifier la réponse de l'outil et la clé "error" pour spécifier les détails de l'erreur (le cas échéant). Si les clés "output" et "error" ne sont pas spécifiées, l'ensemble de la "response" est traité comme le résultat de l'exécution de l'outil.
variables	Struct Valeurs des variables à la fin de l'exécution de l'outil.
citations	Citations Citations qui fournissent des informations sur la source de l'exécution de l'outil.
google_search_suggestions	GoogleSearchSuggestions Suggestions renvoyées par la recherche Google suite à l'appel de l'outil de recherche Google lors de l'exécution de l'outil.
Champ d'union tool_identifier. Identifiant de l'outil exécuté. tool_identifier ne peut être qu'un des éléments suivants :
tool	string Nom de l'outil exécuté. Format : projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolset_tool	ToolsetTool Outil de l'ensemble d'outils qui a été exécuté.

ExecutionType

Type d'exécution de l'outil ou de l'ensemble d'outils.

Enums
EXECUTION_TYPE_UNSPECIFIED	Le type d'exécution n'est pas spécifié. Prend la valeur SYNCHRONOUS par défaut s'il n'est pas spécifié.
SYNCHRONOUS	L'outil est exécuté de manière synchrone. La session est bloquée jusqu'à ce que l'outil soit renvoyé.
ASYNCHRONOUS	L'outil est exécuté de manière asynchrone. La session se poursuivra pendant l'exécution de l'outil.

ExperimentConfig

Expérimentez pour le déploiement.

Champs
version_release	ExperimentConfig.VersionRelease Facultatif. Version du test.

État

État du test.

Enums
STATE_UNSPECIFIED	État non spécifié.
PENDING	Obsolète : cet état n'est plus utilisé.
RUNNING	État d'exécution. Le test est en cours et valide.
DONE	Obsolète : cet état n'est plus utilisé.
EXPIRED	Obsolète : cet état n'est plus utilisé.

VersionRelease

Version du test.

Champs
state	ExperimentConfig.State Facultatif. État de la version.
traffic_allocations[]	ExperimentConfig.VersionRelease.TrafficAllocation Facultatif. Répartition du trafic pour la version.

TrafficAllocation

Répartition du trafic pour la version.

Champs
id	string Facultatif. ID de la répartition du trafic. Chaîne au format libre, jusqu'à 128 caractères.
traffic_percentage	int32 Facultatif. Pourcentage de la répartition du trafic. La valeur doit être comprise entre 0 et 100.
app_version	string Facultatif. Version de l'application de la répartition du trafic. Format : projects/{project}/locations/{location}/apps/{app}/versions/{version}

ExportAppRequest

Message de requête pour AgentService.ExportApp.

Champs
name	string Obligatoire. Nom de ressource de l'application à exporter.
export_format	ExportAppRequest.ExportFormat Obligatoire. Format dans lequel exporter l'application.
gcs_uri	string Facultatif. URI Google Cloud Storage vers lequel exporter l'application. Le format de cet URI doit être gs://<bucket-name>/<object-name>. L'archive d'application exportée sera écrite directement dans l'objet GCS spécifié.
app_version	string Facultatif. Nom de ressource de la version de l'application à exporter. Format : projects/{project}/locations/{location}/apps/{app}/versions/{version}.

ExportFormat

Format d'exportation de l'application.

Enums
EXPORT_FORMAT_UNSPECIFIED	Le format d'exportation n'est pas spécifié.
JSON	Le format d'exportation est JSON.
YAML	Le format d'exportation est YAML.

ExportAppResponse

Message de réponse pour AgentService.ExportApp.

Champs
Champ d'union app. L'application exportée. app ne peut être qu'un des éléments suivants :
app_content	bytes Dossier de l'application compressé sous forme de fichier ZIP.
app_uri	string URI Google Cloud Storage vers lequel l'application a été exportée.

ExpressionCondition

Condition d'expression basée sur l'état de la session.

Champs
expression	string Obligatoire. Représentation sous forme de chaîne de la condition cloud.api.Expression.

FileSearchTool

L'outil de recherche de fichiers permet à l'agent de rechercher des fichiers importés par le développeur de l'application ou de l'agent. Il dispose de préréglages pour fournir une recherche de qualité relativement bonne sur les fichiers importés et un résumé des résultats obtenus.

Champs
corpus_type	FileSearchTool.CorpusType Facultatif. Type de corpus. La valeur par défaut est FULLY_MANAGED.
name	string Obligatoire. Nom de l'outil.
description	string Facultatif. Description de l'outil.
file_corpus	string Facultatif. Corpus dans lequel les fichiers sont stockés. Format : projects/{project}/locations/{location}/ragCorpora/{rag_corpus}

CorpusType

Type de corpus RAG Vertex.

Enums
CORPUS_TYPE_UNSPECIFIED	Type de corpus non spécifié.
USER_OWNED	Le corpus est créé par l'utilisateur et lui appartient.
FULLY_MANAGED	Le corpus est créé par l'agent.

GenerateChatTokenRequest

Message de requête pour WidgetService.GenerateChatToken.

Champs
name	string Obligatoire. Nom de la session pour laquelle générer le jeton de chat. Format : projects/{project}/locations/{location}/apps/{app}/sessions/{session}
deployment	string Obligatoire. Déploiement de l'application à utiliser pour la session. Format : projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
recaptcha_token	string Facultatif. Jeton reCAPTCHA généré par le widget de chat côté client.
live_handoff_enabled	bool Facultatif. Indique si la redirection en direct est activée pour la session.

GenerateChatTokenResponse

Message de réponse pour WidgetService.GenerateChatToken.

Champs
chat_token	string Jeton à portée de session pour le widget de chat afin de s'authentifier auprès des API de session.
expire_time	Timestamp Heure d'expiration du jeton de chat.

GetAgentRequest

Message de requête pour AgentService.GetAgent.

Champs
name	string Obligatoire. Nom de ressource de l'agent à récupérer.

GetAppRequest

Message de requête pour AgentService.GetApp.

Champs
name	string Obligatoire. Nom de ressource de l'application à récupérer.

GetAppVersionRequest

Message de requête pour AgentService.GetAppVersion.

Champs
name	string Obligatoire. Nom de ressource de la version de l'application à récupérer.

GetChangelogRequest

Message de requête pour AgentService.GetChangelog.

Champs
name	string Obligatoire. Nom de ressource du journal des modifications à récupérer.

GetConversationRequest

Message de requête pour AgentService.GetConversation.

Champs
name	string Obligatoire. Nom de ressource de la conversation à récupérer.
source (deprecated)	Conversation.Source Cet élément est obsolète. Facultatif. Indiquez la source de la conversation. Si aucune source n'est définie, toutes les sources seront recherchées.

GetDeploymentRequest

Message de requête pour AgentService.GetDeployment.

Champs
name	string Obligatoire. Le nom du déploiement. Format : projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}

GetExampleRequest

Message de requête pour AgentService.GetExample.

Champs
name	string Obligatoire. Nom de ressource de l'exemple à récupérer.

GetGuardrailRequest

Message de requête pour AgentService.GetGuardrail.

Champs
name	string Obligatoire. Nom de ressource du garde-fou à récupérer.

GetToolRequest

Message de requête pour AgentService.GetTool.

Champs
name	string Obligatoire. Nom de ressource de l'outil à récupérer.

GetToolsetRequest

Message de requête pour AgentService.GetToolset.

Champs
name	string Obligatoire. Nom de ressource de l'ensemble d'outils à récupérer.

GoAway

Ce type ne comporte aucun champ.

Indique que le serveur va bientôt se déconnecter et que le client doit fermer à moitié et redémarrer la connexion.

GoogleSearchSuggestions

Suggestions de recherche de Google Search Tool.

Champs
htmls[]	string Style HTML et CSS conforme pour les suggestions de recherche. Les codes HTML et CSS fournis s'adaptent automatiquement aux paramètres de votre appareil et s'affichent en mode clair ou sombre, comme indiqué par @media(prefers-color-scheme).
web_search_queries[]	WebSearchQuery Liste des requêtes utilisées pour effectuer la recherche Google, ainsi que les URI des résultats de recherche qui forment les suggestions de recherche.

GoogleSearchTool

Représente un outil permettant d'effectuer des recherches sur le Web Google pour l'ancrage. Consultez https://cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool#google-search.

Champs
name	string Obligatoire. Nom de l'outil.
description	string Facultatif. Description de l'objectif de l'outil.
context_urls[]	string Facultatif. Le contenu sera extrait directement de ces URL pour le contexte et l'ancrage. Exemple : "https://example.com/path.html". Vous pouvez ajouter jusqu'à 20 URL.
preferred_domains[]	string Facultatif. Spécifie les domaines auxquels limiter les résultats de recherche. Exemple : "example.com", "another.site". Vous pouvez spécifier jusqu'à 20 domaines.
exclude_domains[]	string Facultatif. Liste des domaines à exclure des résultats de recherche. Exemple : "example.com". Vous pouvez exclure jusqu'à 2 000 domaines.
prompt_config	GoogleSearchTool.PromptConfig Facultatif. Instructions transmises au planificateur sur la façon dont les résultats de recherche doivent être traités pour le texte et la voix.

PromptConfig

Paramètres de requête utilisés par le modèle lors du traitement ou de la synthèse des résultats de recherche Google.

Champs
text_prompt	string Facultatif. Définit la requête utilisée pour les instructions système lors des interactions avec l'agent dans les conversations par chat. Si aucune valeur n'est spécifiée, une requête par défaut sera utilisée.
voice_prompt	string Facultatif. Définit la requête utilisée pour les instructions système lors des interactions avec l'agent dans les conversations vocales. Si aucune valeur n'est spécifiée, une requête par défaut sera utilisée.

Garde-fou

Les garde-fous contiennent une liste de contrôles et d'équilibres pour assurer la sécurité des agents.

Champs
name	string Identifiant. Identifiant unique du garde-fou. Format : projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}
display_name	string Obligatoire. Nom à afficher de la barrière de sécurité.
description	string Facultatif. Description de la barrière de sécurité.
enabled	bool Facultatif. Indique si le garde-fou est activé.
action	TriggerAction Facultatif. Action à effectuer lorsque le garde-fou est déclenché.
create_time	Timestamp Uniquement en sortie. Code temporel de la création du garde-fou.
update_time	Timestamp Uniquement en sortie. Code temporel de la dernière mise à jour du garde-fou.
etag	string Etag utilisé pour s'assurer que l'objet n'a pas été modifié lors d'une opération de lecture-modification-écriture. Si l'etag est vide, la mise à jour écrasera toutes les modifications simultanées.
Champ d'union guardrail_type. Type de garde-fou. guardrail_type ne peut être qu'un des éléments suivants :
content_filter	Guardrail.ContentFilter Facultatif. Garde-fou qui interdit l'utilisation de certains contenus dans la conversation.
llm_prompt_security	Guardrail.LlmPromptSecurity Facultatif. Garde-fou qui bloque la conversation si la requête est considérée comme dangereuse en fonction de la classification du LLM.
llm_policy	Guardrail.LlmPolicy Facultatif. Garde-fou qui bloque la conversation si la réponse du LLM est considérée comme enfreignant le règlement en fonction de la classification du LLM.
model_safety	Guardrail.ModelSafety Facultatif. Garde-fou qui bloque la conversation si la réponse du LLM est considérée comme non sécurisée en fonction des paramètres de sécurité du modèle.
code_callback	Guardrail.CodeCallback Facultatif. Garde-fou qui bloque potentiellement la conversation en fonction du résultat de l'exécution du rappel.
supervisor	Guardrail.Supervisor Facultatif. Garde-fou qui déclenche une intervention du superviseur.

CodeCallback

Garde-fou qui bloque la conversation en fonction des rappels de code fournis.

Champs
before_agent_callback	Callback Facultatif. Rappel à exécuter avant l'appel de l'agent. Chaque fonction de rappel doit renvoyer une structure (par exemple, un dict ou un objet) contenant au moins : - "decision" : "OK" ou "TRIGGER". - "reason" : chaîne expliquant la décision. Une décision "DÉCLENCHEMENT" peut interrompre le traitement.
after_agent_callback	Callback Facultatif. Rappel à exécuter après l'appel de l'agent. Chaque fonction de rappel doit renvoyer une structure (par exemple, un dict ou un objet) contenant au moins : - "decision" : "OK" ou "TRIGGER". - "reason" : chaîne expliquant la décision. Une décision "DÉCLENCHEMENT" peut interrompre le traitement.
before_model_callback	Callback Facultatif. Rappel à exécuter avant l'appel du modèle. S'il existe plusieurs appels au modèle, le rappel sera exécuté plusieurs fois. Chaque fonction de rappel doit renvoyer une structure (par exemple, un dict ou un objet) contenant au moins : - "decision" : "OK" ou "TRIGGER". - "reason" : chaîne expliquant la décision. Une décision "DÉCLENCHEMENT" peut interrompre le traitement.
after_model_callback	Callback Facultatif. Rappel à exécuter après l'appel du modèle. S'il existe plusieurs appels au modèle, le rappel sera exécuté plusieurs fois. Chaque fonction de rappel doit renvoyer une structure (par exemple, un dict ou un objet) contenant au moins : - "decision" : "OK" ou "TRIGGER". - "reason" : chaîne expliquant la décision. Une décision "DÉCLENCHEMENT" peut interrompre le traitement.

ContentFilter

Garde-fou qui interdit l'utilisation de certains contenus dans la conversation.

Champs
banned_contents[]	string Facultatif. Liste des expressions interdites. S'applique aux entrées utilisateur et aux réponses de l'agent.
banned_contents_in_user_input[]	string Facultatif. Liste des expressions interdites. S'applique uniquement aux entrées utilisateur.
banned_contents_in_agent_response[]	string Facultatif. Liste des expressions interdites. Ne s'applique qu'aux réponses des agents.
match_type	Guardrail.ContentFilter.MatchType Obligatoire. Type de correspondance pour le filtre de contenu.
disregard_diacritics	bool Facultatif. Si la valeur est "true", les signes diacritiques sont ignorés lors de la recherche des correspondances.

MatchType

Type de correspondance pour le filtre de contenu.

Enums
MATCH_TYPE_UNSPECIFIED	Le type de correspondance n'est pas spécifié.
SIMPLE_STRING_MATCH	Le contenu est mis en correspondance pour les sous-chaînes caractère par caractère.
WORD_BOUNDARY_STRING_MATCH	Le contenu ne correspond que si le motif trouvé dans le texte est entouré de délimiteurs de mots. Les expressions interdites peuvent également contenir des délimiteurs de mots.
REGEXP_MATCH	Le contenu est mis en correspondance à l'aide de la syntaxe des expressions régulières.

LlmPolicy

Garde-fou qui bloque la conversation si la réponse du LLM est considérée comme enfreignant le règlement en fonction de la classification du LLM.

Champs
max_conversation_messages	int32 Facultatif. Lorsque vous vérifiez le respect de ce règlement, tenez compte des "n" derniers messages de la conversation. Si aucune valeur n'est définie, la valeur par défaut de 10 est utilisée.
model_settings	ModelSettings Facultatif. Paramètres du modèle.
prompt	string Obligatoire. Prompt de règle.
policy_scope	Guardrail.LlmPolicy.PolicyScope Obligatoire. Définit le moment où la vérification des règles doit être appliquée pendant la conversation. Si elle est définie sur POLICY_SCOPE_UNSPECIFIED, la règle s'applique à l'entrée utilisateur. Lorsque vous appliquez la règle à la réponse de l'agent, une latence supplémentaire est introduite avant que l'agent puisse répondre.
fail_open	bool Facultatif. Si une erreur se produit lors de la vérification des règles, ouvrez le système et ne déclenchez pas le garde-fou.
allow_short_utterance	bool Facultatif. Par défaut, la vérification des règles LLM est ignorée pour les énoncés courts. Si vous activez ce paramètre, la vérification des règles s'applique à toutes les expressions, y compris celles qui seraient normalement ignorées.

PolicyScope

Définit le moment où la vérification des règles doit être appliquée pendant la conversation.

Enums
POLICY_SCOPE_UNSPECIFIED	Le champ d'application de la règle n'est pas spécifié.
USER_QUERY	La vérification des règles est déclenchée par l'entrée utilisateur.
AGENT_RESPONSE	La vérification des règles est déclenchée par la réponse de l'agent. L'application de ce champ d'application de la règle entraînera une latence supplémentaire avant que l'agent puisse répondre.
USER_QUERY_AND_AGENT_RESPONSE	La vérification des règles est déclenchée à la fois sur les entrées utilisateur et sur les réponses de l'agent. L'application de ce champ d'application de la règle entraînera une latence supplémentaire avant que l'agent puisse répondre.

LlmPromptSecurity

Garde-fou qui bloque la conversation si l'entrée est considérée comme non sécurisée en fonction de la classification du LLM.

Champs
fail_open	bool Facultatif. Détermine le comportement lorsque le garde-fou rencontre une erreur LLM. - Si la valeur est "true", le garde-fou est contourné. - Si la valeur est "false" (par défaut), la barrière de sécurité se déclenche/bloque. Remarque : Si une règle personnalisée est fournie, ce champ est ignoré au profit de la configuration "fail_open" de la règle.
Champ d'union security_config. Définit le mode de configuration de la sécurité. L'utilisateur doit choisir l'une des configurations suivantes. security_config ne peut être qu'un des éléments suivants :
default_settings	Guardrail.LlmPromptSecurity.DefaultSecuritySettings Facultatif. Utilisez les paramètres de sécurité par défaut prédéfinis du système. Pour sélectionner ce mode, incluez un message "default_settings" vide dans la requête. Le champ "default_prompt_template" sera renseigné par le serveur dans la réponse.
custom_policy	Guardrail.LlmPolicy Facultatif. Utilisez une LlmPolicy définie par l'utilisateur pour configurer le garde-fou de sécurité.

DefaultSecuritySettings

Configuration des paramètres de sécurité système par défaut.

Champs
default_prompt_template	string Uniquement en sortie. Modèle de prompt par défaut utilisé par le système. Ce champ est destiné à afficher l'invite que le système utilise par défaut. Il s'agit d'un champ OUTPUT_ONLY.

ModelSafety

Remplacements des paramètres de sécurité du modèle. Lorsque ce paramètre est défini, il remplace les paramètres par défaut et déclenche la barrière de sécurité si la réponse est considérée comme non sécurisée.

Champs
safety_settings[]	Guardrail.ModelSafety.SafetySetting Obligatoire. Liste des paramètres de sécurité.

HarmBlockThreshold

Niveaux de seuil de probabilité pour le blocage.

Enums
HARM_BLOCK_THRESHOLD_UNSPECIFIED	Seuil de blocage de préjudice non spécifié.
BLOCK_LOW_AND_ABOVE	Bloquer les seuils faibles et supérieurs (augmenter le nombre de blocages).
BLOCK_MEDIUM_AND_ABOVE	Bloquer les seuils moyens et supérieurs.
BLOCK_ONLY_HIGH	Bloquer uniquement les seuils élevés (réduire le nombre de blocage).
BLOCK_NONE	Ne rien bloquer.
OFF	Désactivez le filtre de sécurité.

HarmCategory

Catégorie de préjudice.

Enums
HARM_CATEGORY_UNSPECIFIED	La catégorie de préjudice n'est pas spécifiée.
HARM_CATEGORY_HATE_SPEECH	La catégorie de préjudice est "incitation à la haine".
HARM_CATEGORY_DANGEROUS_CONTENT	La catégorie de préjudice est "contenu dangereux".
HARM_CATEGORY_HARASSMENT	La catégorie de préjudice est "harcèlement".
HARM_CATEGORY_SEXUALLY_EXPLICIT	La catégorie de préjudice est "contenu à caractère sexuel explicite".
HARM_CATEGORY_PROFANITY	La catégorie de préjudice est "propos obscènes".
HARM_CATEGORY_TOXIC	La catégorie de préjudice est "contenu toxique".

SafetySetting

Paramètre de sécurité

Champs
category	Guardrail.ModelSafety.HarmCategory Obligatoire. Catégorie de préjudice.
threshold	Guardrail.ModelSafety.HarmBlockThreshold Obligatoire. Seuil de blocage de préjudice.

Superviseur

Garde-fou qui déclenche une intervention du superviseur.

Champs
type	Guardrail.Supervisor.Type Facultatif. Type de superviseur.
detection_mode	Guardrail.Supervisor.DetectionMode Facultatif. Mode de détection du superviseur.

DetectionMode

Mode de détection du superviseur.

Enums
DETECTION_MODE_UNSPECIFIED	Le mode de détection n'est pas spécifié. La valeur par défaut est NON_BLOCKING.
NON_BLOCKING	Mode de détection non bloquant. La réponse n'est pas bloquée lorsque la détection de la supervision est en cours.
BLOCKING	Mode de détection du blocage. La réponse est bloquée lorsque la détection de la supervision est en cours.

Type

Type de responsable.

Enums
TYPE_UNSPECIFIED	Le type n'est pas spécifié.
INVALID_TEXT	Type de problème de texte non valide.
LANGUAGE_SHIFT	Type de problème lié au changement de langue.
SPEAKER_SHIFT	Type de problème de décalage de l'intervenant.
AUDIO_MISMATCH	Type de problème de non-concordance audio.
MISSING_TOOL_CALL	Type de problème d'appel d'outil manquant.
CUSTOM	Type de problème personnalisé.
CHOPPY_AUDIO	Type de problème de son haché.
PROFANITY	Type de problème lié à un langage grossier de l'agent.

Image

Représente une entrée ou une sortie d'image dans la conversation.

Champs
mime_type	string Obligatoire. Type MIME standard IANA des données sources. Les types d'images acceptés sont les suivants : * image/png * image/jpeg * image/webp
data	bytes Obligatoire. Octets bruts de l'image.
alt_text	string Facultatif. Texte alternatif de l'image.

ImportAppRequest

Message de requête pour AgentService.ImportApp.

Champs
parent	string Obligatoire. Nom de la ressource parente avec l'emplacement de l'application à importer.
display_name	string Facultatif. Nom à afficher de l'application à importer. * Si l'application est créée lors de l'importation et que le nom à afficher est spécifié, l'application importée utilisera ce nom à afficher. Si un conflit est détecté avec une application existante, un code temporel est ajouté au nom à afficher pour le rendre unique. * Si l'application est réimportée, ce champ ne doit pas être défini. Si vous fournissez un nom à afficher lors de la réimportation, une erreur INVALID_ARGUMENT s'affichera.
app_id	string Facultatif. ID à utiliser pour l'application importée. * Si aucun ID n'est spécifié, un ID unique sera automatiquement attribué à l'application. * Sinon, l'application importée utilisera cet ID comme composant final de son nom de ressource. Si une application portant le même ID existe déjà à l'emplacement spécifié dans le projet, le contenu de l'application existante sera remplacé.
import_options	ImportAppRequest.ImportOptions Facultatif. Options régissant le processus d'importation de l'application.
ignore_app_lock	bool Facultatif. Indicateur permettant de remplacer le verrouillage d'application lors de l'importation. Si la valeur est définie sur "true", le processus d'importation ignore le verrouillage d'application.
Champ d'union app. Application à importer. app ne peut être qu'un des éléments suivants :
gcs_uri	string URI Google Cloud Storage à partir duquel importer l'application. Le format de cet URI doit être gs://<bucket-name>/<object-name>.
app_content	bytes Octets bruts représentant le fichier ZIP compressé avec la structure de dossiers de l'application.
Champ d'union json_patch. Les correctifs JSON à appliquer à l'application importée. json_patch ne peut être que l'un des suivants :
json_patch_content	string Facultatif. Contenu du correctif sous forme de chaîne JSON.
json_patch_gcs_uri	string Facultatif. URI Cloud Storage pointant vers un fichier JSON contenant les correctifs.

ImportOptions

Options de configuration pour le processus d'importation d'applications. Ces options permettent de contrôler le comportement de l'importation, en particulier en cas de conflit avec les données d'application existantes.

Champs
conflict_resolution_strategy	ImportAppRequest.ImportOptions.ConflictResolutionStrategy Facultatif. Stratégie à utiliser pour résoudre les conflits lors de l'importation.
validate_only	bool Facultatif. Indicateur pour effectuer un dry run du processus d'importation. Si la valeur est définie sur "true", le processus d'importation n'effectue que des validations et n'apporte aucune modification à l'application existante ni n'en crée une.

ConflictResolutionStrategy

Définit la stratégie de gestion des conflits lorsqu'une application portant le même ID existe déjà ou lorsque des ressources importées (comme des agents, des outils, etc.) ont le même nom à afficher que des ressources existantes dans cette application.

Enums
CONFLICT_RESOLUTION_STRATEGY_UNSPECIFIED	La stratégie de résolution des conflits n'est pas spécifiée.
REPLACE	remplacer les données existantes par les données importées ; Si une application avec le même app_id existe déjà, son contenu sera mis à jour en fonction de l'application importée. Les ressources (application, agents, outils, exemples, garde-fous, ensembles d'outils) de l'application importée qui ont le même nom à afficher que les ressources existantes écraseront celles-ci. - Des ressources importées avec de nouveaux noms à afficher seront créées. - Les ressources existantes qui n'ont pas de nom à afficher correspondant dans l'application importée resteront inchangées.
OVERWRITE	Écraser les données existantes avec les données importées Si une application avec le même app_id existe déjà, son contenu sera écrasé par l'application importée. Les ressources existantes (agents, outils, exemples, garde-fous, ensembles d'outils) dans l'application seront supprimées. - Les ressources importées seront créées en tant que nouvelles ressources.

ImportAppResponse

Message de réponse pour AgentService.ImportApp.

Champs
name	string Nom de ressource de l'application importée.
warnings[]	string Messages d'avertissement générés lors du processus d'importation. Si des erreurs se produisent pour des ressources spécifiques, elles ne seront pas incluses dans l'application importée et l'erreur sera mentionnée ici.

InputAudioConfig

InputAudioConfig configure la façon dont l'agent CES doit interpréter les données audio entrantes.

Champs
audio_encoding	AudioEncoding Obligatoire. Encodage des données audio d'entrée.
sample_rate_hertz	int32 Obligatoire. Taux d'échantillonnage (en hertz) des données audio d'entrée.
noise_suppression_level	string Facultatif. Indique si la suppression du bruit doit être activée pour l'entrée audio. Les valeurs disponibles sont "low", "moderate", "high" et "very_high".

InstagramCredentials

Identifiants Meta éphémères pour l'intégration native d'Instagram.

Champs
auth_code	string Obligatoire. Code d'autorisation Meta fourni par le flux d'inscription intégré.
conversation_profile_id	string Facultatif. ID du profil de conversation à utiliser pour le déploiement.

InterruptionSignal

Indique que la réponse audio de l'agent a été interrompue. Le client doit immédiatement arrêter toute lecture audio en cours (par exemple, en raison d'une intervention de l'utilisateur ou de la génération d'une nouvelle réponse de l'agent).

Champs
barge_in	bool Indique si l'interruption est due à un événement d'intrusion de l'utilisateur.

LanguageSettings

Paramètres de langue de l'application.

Champs
default_language_code	string Facultatif. Code de langue par défaut de l'application.
supported_language_codes[]	string Facultatif. Liste des codes de langue acceptés par l'application, en plus de default_language_code.
enable_multilingual_support	bool Facultatif. Active la compatibilité multilingue. Si la valeur est "true", les agents de l'application utiliseront des instructions prédéfinies pour mieux gérer les entrées multilingues.
fallback_action (deprecated)	string Cet élément est obsolète. Facultatif. Obsolète : cette fonctionnalité n'est plus disponible. Utilisez plutôt enable_multilingual_support pour mieux gérer les entrées multilingues. Action à effectuer lorsqu'un agent reçoit une entrée dans une langue non acceptée. Il peut s'agir d'une action prédéfinie ou d'un appel d'outil personnalisé. Les valeurs valides sont les suivantes : - Nom complet de la ressource d'un outil, qui déclenche l'exécution d'un outil spécifique. - Une action système prédéfinie, telle que "escalade" ou "quitter", qui déclenche un signal EndSession avec le metadata correspondant pour mettre fin à la conversation.

ListAgentsRequest

Message de requête pour AgentService.ListAgents.

Champs
parent	string Obligatoire. Nom de ressource de l'application à partir de laquelle lister les agents.
page_size	int32 Facultatif. Taille de la page demandée. Le serveur peut renvoyer un nombre d'éléments inférieur à celui demandé. Si aucune valeur n'est spécifiée, le serveur sélectionne une valeur par défaut appropriée.
page_token	string Facultatif. La valeur next_page_token renvoyée par un appel de liste AgentService.ListAgents précédent.
filter	string Facultatif. Filtre à appliquer lors de la liste des agents. Pour en savoir plus, consultez https://google.aip.dev/160.
order_by	string Facultatif. Champ de tri. Seuls "name" et "create_time" sont acceptés. Pour en savoir plus, consultez https://google.aip.dev/132#ordering.

ListAgentsResponse

Message de réponse pour AgentService.ListAgents.

Champs
agents[]	Agent Liste des agents.
next_page_token	string Jeton pouvant être envoyé en tant que ListAgentsRequest.page_token pour récupérer la page suivante. L'absence de ce champ indique qu'il n'y a pas d'autres pages.

ListAppVersionsRequest

Message de requête pour AgentService.ListAppVersions.

Champs
parent	string Obligatoire. Nom de ressource de l'application à partir de laquelle lister les versions.
page_size	int32 Facultatif. Taille de la page demandée. Le serveur peut renvoyer un nombre d'éléments inférieur à celui demandé. Si aucune valeur n'est spécifiée, le serveur sélectionne une valeur par défaut appropriée.
page_token	string Facultatif. La valeur next_page_token renvoyée par un appel de liste AgentService.ListAppVersions précédent.
filter	string Facultatif. Filtre à appliquer lors de la liste des versions de l'application. Pour en savoir plus, consultez https://google.aip.dev/160.
order_by	string Facultatif. Champ de tri. Seuls "name" et "create_time" sont acceptés. Pour en savoir plus, consultez https://google.aip.dev/132#ordering.

ListAppVersionsResponse

Message de réponse pour AgentService.ListAppVersions.

Champs
app_versions[]	AppVersion Liste des versions de l'application.
next_page_token	string Jeton pouvant être envoyé en tant que ListAppVersionsRequest.page_token pour récupérer la page suivante. L'absence de ce champ indique qu'il n'y a pas d'autres pages.

ListAppsRequest

Message de requête pour AgentService.ListApps.

Champs
parent	string Obligatoire. Nom de ressource de l'établissement à partir duquel lister les applications.
page_size	int32 Facultatif. Taille de la page demandée. Le serveur peut renvoyer un nombre d'éléments inférieur à celui demandé. Si aucune valeur n'est spécifiée, le serveur sélectionne une valeur par défaut appropriée.
page_token	string Facultatif. La valeur next_page_token renvoyée par un appel de liste AgentService.ListApps précédent.
filter	string Facultatif. Filtre à appliquer lors de la liste des applications. Pour en savoir plus, consultez https://google.aip.dev/160.
order_by	string Facultatif. Champ de tri. Seuls "name" et "create_time" sont acceptés. Pour en savoir plus, consultez https://google.aip.dev/132#ordering.

ListAppsResponse

Message de réponse pour AgentService.ListApps.

Champs
apps[]	App Liste des applications.
next_page_token	string Jeton pouvant être envoyé en tant que ListAppsRequest.page_token pour récupérer la page suivante. L'absence de ce champ indique qu'il n'y a pas d'autres pages.
unreachable[]	string Liste non triée. Emplacements inaccessibles.

ListChangelogsRequest

Message de requête pour AgentService.ListChangelogs.

Champs
parent	string Obligatoire. Nom de ressource de l'application dont vous souhaitez lister les journaux des modifications.
page_size	int32 Facultatif. Taille de la page demandée. Le serveur peut renvoyer un nombre d'éléments inférieur à celui demandé. Si aucune valeur n'est spécifiée, le serveur sélectionne une valeur par défaut appropriée.
page_token	string Facultatif. La valeur next_page_token renvoyée par un appel de liste AgentService.ListChangelogs précédent.
filter	string Facultatif. Filtre à appliquer lors de la liste des journaux des modifications. Pour en savoir plus, consultez https://google.aip.dev/160. La chaîne de filtre peut être utilisée pour filtrer par action, resource_type, resource_name, author et create_time. Le comparateur : peut être utilisé pour une correspondance partielle non sensible à la casse sur les champs de chaîne, tandis que = effectue une correspondance exacte sensible à la casse. Exemples : * action:update (correspondance partielle non sensible à la casse) * action="Create" (correspondance exacte sensible à la casse) * resource_type:agent * resource_name:my-agent * author:[e-mail] * create_time > "2025-01-01T00:00:00Z" * create_time <= "2025-01-01T00:00:00Z" AND resource_type:tool
order_by	string Facultatif. Champ de tri. Seuls "name" et "create_time" sont acceptés. Pour en savoir plus, consultez https://google.aip.dev/132#ordering.

ListChangelogsResponse

Message de réponse pour AgentService.ListChangelogs.

Champs
changelogs[]	Changelog Liste des journaux des modifications.
next_page_token	string Jeton pouvant être envoyé en tant que ListChangelogsRequest.page_token pour récupérer la page suivante. L'absence de ce champ indique qu'il n'y a pas d'autres pages.

ListConversationsRequest

Message de requête pour AgentService.ListConversations.

Champs
parent	string Obligatoire. Nom de ressource de l'application à partir de laquelle lister les conversations.
page_size	int32 Facultatif. Taille de la page demandée. Le serveur peut renvoyer un nombre d'éléments inférieur à celui demandé. Si aucune valeur n'est spécifiée, le serveur sélectionne une valeur par défaut appropriée.
page_token	string Facultatif. La valeur next_page_token renvoyée par un appel de liste AgentService.ListConversations précédent.
filter	string Facultatif. Filtre à appliquer lors de la liste des conversations. Pour en savoir plus, consultez https://google.aip.dev/160.
source	Conversation.Source Facultatif. Indiquez la source de la conversation. Si aucune valeur n'est définie, Source.Live est appliqué par défaut. Sera abandonné au profit du champ sources.
sources[]	Conversation.Source Facultatif. Indiquez les sources des conversations. Si aucune n'est définie, toutes les sources disponibles seront appliquées par défaut.

ListConversationsResponse

Message de réponse pour AgentService.ListConversations.

Champs
conversations[]	Conversation Liste des conversations.
next_page_token	string Jeton pouvant être envoyé en tant que ListConversationsRequest.page_token pour récupérer la page suivante. L'absence de ce champ indique qu'il n'y a pas d'autres pages.

ListDeploymentsRequest

Message de requête pour AgentService.ListDeployments.

Champs
parent	string Obligatoire. Application parente. Format : projects/{project}/locations/{location}/apps/{app}
page_size	int32 Facultatif. Nombre maximal de déploiements à renvoyer. Le service peut renvoyer un nombre inférieur à cette valeur. Si aucune valeur n'est spécifiée, 50 déploiements au maximum sont renvoyés. La valeur maximale est 1 000. Les valeurs supérieures sont réduites à 1 000.
page_token	string Facultatif. Jeton de page reçu d'un appel ListDeployments précédent. Fournissez-le pour récupérer la page suivante. Lors de la pagination, tous les autres paramètres fournis à ListDeployments doivent correspondre à l'appel ayant fourni le jeton de page.
order_by	string Facultatif. Champ de tri. Seuls "name" et "create_time" sont acceptés. Pour en savoir plus, consultez https://google.aip.dev/132#ordering.

ListDeploymentsResponse

Message de réponse pour AgentService.ListDeployments.

Champs
deployments[]	Deployment Liste des déploiements.
next_page_token	string Jeton pouvant être envoyé en tant que page_token pour récupérer la page suivante. Si ce champ est omis, il n'y a pas d'autres pages.

ListExamplesRequest

Message de requête pour AgentService.ListExamples.

Champs
parent	string Obligatoire. Nom de ressource de l'application à partir de laquelle lister les exemples.
page_size	int32 Facultatif. Taille de la page demandée. Le serveur peut renvoyer un nombre d'éléments inférieur à celui demandé. Si aucune valeur n'est spécifiée, le serveur sélectionne une valeur par défaut appropriée.
page_token	string Facultatif. La valeur next_page_token renvoyée par un appel de liste AgentService.ListExamples précédent.
filter	string Facultatif. Filtre à appliquer lors du listage des exemples. Pour en savoir plus, consultez https://google.aip.dev/160.
order_by	string Facultatif. Champ de tri. Seuls "name" et "create_time" sont acceptés. Pour en savoir plus, consultez https://google.aip.dev/132#ordering.

ListExamplesResponse

Message de réponse pour AgentService.ListExamples.

Champs
examples[]	Example Liste des exemples.
next_page_token	string Jeton pouvant être envoyé en tant que ListExamplesRequest.page_token pour récupérer la page suivante. L'absence de ce champ indique qu'il n'y a pas d'autres pages.

ListGuardrailsRequest

Message de requête pour AgentService.ListGuardrails.

Champs
parent	string Obligatoire. Nom de ressource de l'application à partir de laquelle lister les consignes.
page_size	int32 Facultatif. Taille de la page demandée. Le serveur peut renvoyer un nombre d'éléments inférieur à celui demandé. Si aucune valeur n'est spécifiée, le serveur sélectionne une valeur par défaut appropriée.
page_token	string Facultatif. La valeur next_page_token renvoyée par un appel de liste AgentService.ListGuardrails précédent.
filter	string Facultatif. Filtre à appliquer lors de la liste des garde-fous. Pour en savoir plus, consultez https://google.aip.dev/160.
order_by	string Facultatif. Champ de tri. Seuls "name" et "create_time" sont acceptés. Pour en savoir plus, consultez https://google.aip.dev/132#ordering.

ListGuardrailsResponse

Message de réponse pour AgentService.ListGuardrails.

Champs
guardrails[]	Guardrail Liste des garde-fous.
next_page_token	string Jeton pouvant être envoyé en tant que ListGuardrailsRequest.page_token pour récupérer la page suivante. L'absence de ce champ indique qu'il n'y a pas d'autres pages.

ListToolsRequest

Message de requête pour AgentService.ListTools.

Champs
parent	string Obligatoire. Nom de ressource de l'application à partir de laquelle lister les outils.
page_size	int32 Facultatif. Taille de la page demandée. Le serveur peut renvoyer un nombre d'éléments inférieur à celui demandé. Si aucune valeur n'est spécifiée, le serveur sélectionne une valeur par défaut appropriée.
page_token	string Facultatif. La valeur next_page_token renvoyée par un appel de liste AgentService.ListTools précédent.
filter	string Facultatif. Filtre à appliquer lors de la liste des outils. Utilisez "include_system_tools=true" pour inclure les outils système dans la réponse. Pour en savoir plus, consultez https://google.aip.dev/160.
order_by	string Facultatif. Champ de tri. Seuls "name" et "create_time" sont acceptés. Pour en savoir plus, consultez https://google.aip.dev/132#ordering.

ListToolsResponse

Message de réponse pour AgentService.ListTools.

Champs
tools[]	Tool Liste des outils.
next_page_token	string Jeton pouvant être envoyé en tant que ListToolsRequest.page_token pour récupérer la page suivante. L'absence de ce champ indique qu'il n'y a pas d'autres pages.

ListToolsetsRequest

Message de requête pour AgentService.ListToolsets.

Champs
parent	string Obligatoire. Nom de ressource de l'application à partir de laquelle lister les ensembles d'outils.
page_size	int32 Facultatif. Taille de la page demandée. Le serveur peut renvoyer un nombre d'éléments inférieur à celui demandé. Si aucune valeur n'est spécifiée, le serveur sélectionne une valeur par défaut appropriée.
page_token	string Facultatif. La valeur next_page_token renvoyée par un appel de liste AgentService.ListToolsets précédent.
filter	string Facultatif. Filtre à appliquer lors de la liste des ensembles d'outils. Pour en savoir plus, consultez https://google.aip.dev/160.
order_by	string Facultatif. Champ de tri. Seuls "name" et "create_time" sont acceptés. Pour en savoir plus, consultez https://google.aip.dev/132#ordering.

ListToolsetsResponse

Message de réponse pour AgentService.ListToolsets.

Champs
toolsets[]	Toolset Liste des ensembles d'outils.
next_page_token	string Jeton pouvant être envoyé en tant que ListToolsetsRequest.page_token pour récupérer la page suivante. L'absence de ce champ indique qu'il n'y a pas d'autres pages.

LoggingSettings

Paramètres permettant de décrire les comportements de journalisation de l'application.

Champs
redaction_config	RedactionConfig Facultatif. Configuration du masquage des données sensibles.
audio_recording_config	AudioRecordingConfig Facultatif. Configuration de l'enregistrement des interactions audio. L'audio est masqué conformément à la configuration de RedactionConfig.
unredacted_audio_recording_config	AudioRecordingConfig Facultatif. Configure un enregistrement supplémentaire de l'audio non masqué. Cela peut être utile pour conserver une copie brute de l'audio lorsque la censure audio est enabled, généralement à des fins d'audit ou de surveillance.
bigquery_export_settings	BigQueryExportSettings Facultatif. Configure les comportements d'exportation BigQuery pour l'application. Les données de conversation sont soumises à la censure configurée dans RedactionConfig.
unredacted_bigquery_export_settings	BigQueryExportSettings Facultatif. Configure les comportements d'exportation BigQuery pour l'application. Les données de conversation non masquées seront exportées vers des tables BigQuery si cette option est activée.
cloud_logging_settings	CloudLoggingSettings Facultatif. Paramètres permettant de décrire les comportements de Cloud Logging pour l'application.
conversation_logging_settings	ConversationLoggingSettings Facultatif. Paramètres permettant de décrire les comportements de journalisation des conversations pour l'application.
evaluation_audio_recording_config	AudioRecordingConfig Facultatif. Configuration de l'enregistrement des interactions audio pour l'évaluation. Par défaut, l'enregistrement audio n'est pas activé pour les sessions d'évaluation.
metric_analysis_settings	MetricAnalysisSettings Facultatif. Paramètres permettant de décrire les comportements de collecte des données de conversation pour le pipeline d'analyse LLM de l'application.

McpTool

Un outil MCP. Pour en savoir plus, consultez https://modelcontextprotocol.io/specification/2025-06-18/server/tools.

Champs
name	string Obligatoire. Nom de l'outil MCP.
name_override	string Facultatif. Nom de remplacement de l'outil MCP. Ce champ est renseigné si le nom a été remplacé par un remplacement Toolset.
description	string Facultatif. Description de l'outil MCP.
input_schema	Schema Facultatif. Schéma des arguments d'entrée de l'outil MCP.
output_schema	Schema Facultatif. Schéma des arguments de sortie de l'outil MCP.
server_address	string Obligatoire. Adresse du serveur MCP, par exemple "https://example.com/mcp/". Si le serveur est créé avec le SDK MCP, l'URL doit être suffixée par "/mcp/". Seuls les serveurs basés sur le transport HTTP en flux continu sont acceptés. Elle est identique à server_address dans McpToolset. Pour en savoir plus, consultez https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http.
api_authentication	ApiAuthentication Facultatif. Informations d'authentification requises pour exécuter l'outil sur le serveur MCP. Pour l'authentification par jeton du porteur, le jeton ne s'applique qu'à l'exécution des outils, et non à la liste des outils. Cela nécessite que les outils puissent être listés sans authentification.
tls_config	TlsConfig Facultatif. Configuration TLS. Inclut les certificats de serveur personnalisés auxquels le client doit faire confiance.
service_directory_config	ServiceDirectoryConfig Facultatif. Configuration de l'annuaire des services pour VPC-SC, utilisée pour résoudre les noms de service dans un périmètre.
custom_headers	map<string, string> Facultatif. En-têtes personnalisés à envoyer dans la requête au serveur MCP. Les valeurs doivent être au format $context.variables.<name_of_variable> et peuvent être définies dans les variables de session. Pour en savoir plus, consultez https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection.
state	McpTool.State Uniquement en sortie. État de disponibilité dynamique de l'outil sur le serveur externe.

État

Représente l'état de disponibilité dynamique de l'outil.

Enums
STATE_UNSPECIFIED	État par défaut.
ACTIVE	L'outil est disponible et proposé activement par le serveur.
INACTIVE	L'outil est configuré ou épinglé, mais n'est actuellement pas proposé par le serveur.
STALE	L'outil existe sur le serveur, mais ne correspond pas à la version sur le serveur.

McpToolDefinition

Conteneur pour les éléments de définition de base d'un outil qui sont des instantanés. Les schémas de l'instantané sont utilisés tels quels et ne peuvent pas être remplacés.

Champs
description	string Uniquement en sortie. Description de l'outil MCP. Cette valeur peut être remplacée par description_override dans McpToolOverride.
input_schema	Schema Uniquement en sortie. Schéma des arguments d'entrée de l'outil MCP.
output_schema	Schema Uniquement en sortie. Schéma des arguments de sortie de l'outil MCP.

McpToolOverride

Remplacements associés à un outil donné dans un Toolset. Cela permet d'épingler ou de remplacer les définitions d'outils à partir du serveur dynamique externe.

Champs
tool	string Obligatoire. Nom d'origine de l'outil tel qu'il est émis par le serveur MCP.
name_override	string Facultatif. Si ce nom est présent, l'outil l'utilise dans l'agent au lieu du nom d'origine. Il est principalement utilisé comme alias si le serveur MCP propose des outils mal nommés.
description_override	string Facultatif. Si elle est présente, cet outil utilise cette description au lieu de la description d'origine du serveur.
snapshot	McpToolDefinition Uniquement en sortie. Si cet outil est présent, il est "épinglé" et utilise les valeurs du snapshot comme valeurs de remplacement si le serveur devient temporairement indisponible ou si aucune valeur de remplacement n'est présente.

McpToolset

Ensemble d'outils contenant la liste des outils proposés par le serveur MCP.

Champs
server_address	string Obligatoire. Adresse du serveur MCP (par exemple, "https://example.com/mcp/"). Si le serveur est créé avec le SDK MCP, l'URL doit être suffixée par "/mcp/". Seuls les serveurs basés sur le transport HTTP en flux continu sont acceptés. Pour en savoir plus, consultez https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http.
api_authentication	ApiAuthentication Facultatif. Informations d'authentification requises pour accéder aux outils et exécuter un outil sur le serveur MCP. Pour l'authentification par jeton du porteur, le jeton ne s'applique qu'à l'exécution des outils, et non à la liste des outils. Cela nécessite que les outils puissent être listés sans authentification.
service_directory_config	ServiceDirectoryConfig Facultatif. Configuration de l'annuaire des services pour VPC-SC, utilisée pour résoudre les noms de service dans un périmètre.
tls_config	TlsConfig Facultatif. Configuration TLS. Inclut les certificats de serveur personnalisés auxquels le client doit faire confiance.
custom_headers	map<string, string> Facultatif. En-têtes personnalisés à envoyer dans la requête au serveur MCP. Les valeurs doivent être au format $context.variables.<name_of_variable> et peuvent être définies dans les variables de session. Pour en savoir plus, consultez https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection.
tool_overrides[]	McpToolOverride Facultatif. Remplacements pour les outils individuels de cet ensemble d'outils. Cela permet de remplacer des détails spécifiques tels que les descriptions ou les noms, ou d'épingler les états des outils afin qu'ils ne soient pas entièrement dynamiques.

Message

Message dans une conversation.

Champs
role	string Facultatif. Rôle dans la conversation (par exemple, utilisateur ou agent).
chunks[]	Chunk Facultatif. Contenu du message sous forme de série de blocs.
event_time	Timestamp Facultatif. Horodatage de l'envoi ou de la réception du message. Ne doit pas être utilisé si le message fait partie d'un example.

MetricAnalysisSettings

Paramètres permettant de décrire les comportements de collecte de données de conversation pour le pipeline de métriques d'analyse LLM.

Champs
llm_metrics_opted_out	bool Facultatif. Indique si les données de conversation doivent être collectées pour les métriques d'analyse des LLM. Si la valeur est "true", les données de conversation ne seront pas collectées pour les métriques d'analyse LLM. Dans le cas contraire, elles le seront.

MockConfig

Configuration des appels d'outils fictifs pour la session.

Champs
mocked_tool_calls[]	MockedToolCall Facultatif. Tous les appels d'outil à simuler pendant la durée de la session.
unmatched_tool_call_behavior	MockConfig.UnmatchedToolCallBehavior Obligatoire. Comportement pour les appels d'outils qui ne correspondent à aucun modèle d'arguments dans mocked_tool_calls.

UnmatchedToolCallBehavior

Que faire lorsqu'un appel d'outil ne correspond à aucun appel d'outil simulé ?

Enums
UNMATCHED_TOOL_CALL_BEHAVIOR_UNSPECIFIED	Valeur par défaut. Cette valeur n'est pas utilisée.
FAIL	Génère une erreur pour tous les appels d'outils qui ne correspondent pas à un modèle d'entrée attendu fictif.
PASS_THROUGH	Pour les appels d'outils non correspondants, transmettez l'appel d'outil à l'outil réel.

MockedToolCall

Appel d'outil simulé.

Exprime l'outil cible et un modèle à comparer aux arguments / entrées de cet outil. Si le modèle correspond, la réponse fictive est renvoyée.

Champs
tool (deprecated)	string Cet élément est obsolète. Facultatif. Obsolète. Utilisez plutôt tool_identifier.
expected_args_pattern	Struct Obligatoire. Modèle à comparer aux arguments / entrées de tous les appels d'outils distribués. Si les entrées d'appel d'outil correspondent à ce modèle, une sortie fictive sera renvoyée.
mock_response	Struct Facultatif. Réponse / sortie fictive à renvoyer si les arguments / entrées de l'appel d'outil correspondent au modèle.
Champ d'union tool_identifier. Identifiant de l'outil à simuler. tool_identifier ne peut être qu'un des éléments suivants :
tool_id	string Facultatif. Nom de l'outil à simuler. Format : projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolset	ToolsetTool Facultatif. Ensemble d'outils pour simuler.

ModelSettings

Les paramètres du modèle contiennent différentes configurations pour le modèle LLM.

Champs
model	string Facultatif. Modèle LLM que l'agent doit utiliser. Si elle n'est pas définie, l'agent hérite du modèle de son agent parent.
thinking_level	ModelSettings.ThinkingLevel Facultatif. Niveau de réflexion du modèle.
temperature	double Facultatif. Si elle est définie, cette température sera utilisée pour le modèle LLM. La température contrôle le caractère aléatoire des réponses du modèle. Les températures plus basses produisent des réponses plus prévisibles. Les températures plus élevées génèrent des réponses plus créatives.

ThinkingLevel

Niveau de réflexion configuré pour le modèle.

Enums
THINKING_LEVEL_UNSPECIFIED	Le niveau de réflexion n'est pas spécifié.
DEFAULT	Niveau de réflexion par défaut.
LOW	Niveau de réflexion faible.
MEDIUM	Niveau de réflexion moyen.
HIGH	Niveau de réflexion élevé.

OAuthConfig

Configurations pour l'authentification avec OAuth.

Champs
oauth_grant_type	OAuthConfig.OauthGrantType Obligatoire. Types d'attribution OAuth.
client_id	string Obligatoire. ID client du fournisseur OAuth.
client_secret_version	string Obligatoire. Nom de la ressource de version du secret Secret Manager stockant le code secret du client. Format : projects/{project}/secrets/{secret}/versions/{version} Remarque : Vous devez attribuer le rôle roles/secretmanager.secretAccessor à l'agent de service CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
token_endpoint	string Obligatoire. Point de terminaison de jeton chez le fournisseur OAuth à échanger contre un jeton d'accès.
scopes[]	string Facultatif. Niveaux d'accès OAuth à accorder.

OauthGrantType

Types d'attribution OAuth. Seule l'autorisation d'identifiants client est acceptée.

Enums
OAUTH_GRANT_TYPE_UNSPECIFIED	Non spécifié. La valeur par défaut est CLIENT_CREDENTIAL.
CLIENT_CREDENTIAL	Représente le flux d'identifiants client.

OpenApiTool

Outil d'API à distance défini par un schéma OpenAPI.

Champs
open_api_schema	string Obligatoire. Schéma OpenAPI au format JSON ou YAML.
name	string Facultatif. Nom de l'outil. S'il n'est pas fourni, le nom de l'outil sera dérivé du schéma OpenAPI, à partir de operation.operationId.
description	string Facultatif. Description de l'outil. Si aucune description n'est fournie, elle sera dérivée du schéma OpenAPI, de operation.description ou de operation.summary.
api_authentication	ApiAuthentication Facultatif. Informations d'authentification requises par l'API.
tls_config	TlsConfig Facultatif. Configuration TLS. Inclut les certificats de serveur personnalisés auxquels le client fera confiance.
service_directory_config	ServiceDirectoryConfig Facultatif. Configuration de l'annuaire des services.
ignore_unknown_fields	bool Facultatif. Si la valeur est "true", l'agent ignore les champs inconnus dans la réponse de l'API.
url	string Facultatif. URL du serveur du schéma Open API. Ce champ n'est défini dans les outils des dépendances d'environnement lors du processus d'exportation que si le schéma contient une URL de serveur. Lors du processus d'importation, si cette URL est présente dans les dépendances de l'environnement et que le schéma comporte l'espace réservé $env_var, elle remplacera l'espace réservé dans le schéma.

OpenApiToolset

Ensemble d'outils contenant une liste d'outils définis par un schéma OpenAPI.

Champs
open_api_schema	string Obligatoire. Schéma OpenAPI de l'ensemble d'outils.
api_authentication	ApiAuthentication Facultatif. Informations d'authentification requises par l'API.
tls_config	TlsConfig Facultatif. Configuration TLS. Inclut les certificats de serveur personnalisés
service_directory_config	ServiceDirectoryConfig Facultatif. Configuration de l'annuaire des services.
ignore_unknown_fields	bool Facultatif. Si la valeur est "true", l'agent ignore les champs inconnus dans la réponse de l'API pour toutes les opérations définies dans le schéma OpenAPI.
url	string Facultatif. URL du serveur du schéma Open API. Ce champ n'est défini dans les ensembles d'outils que dans les dépendances de l'environnement pendant le processus d'exportation si le schéma contient une URL de serveur. Lors du processus d'importation, si cette URL est présente dans les dépendances de l'environnement et que le schéma comporte l'espace réservé $env_var, elle remplacera l'espace réservé dans le schéma.

OperationMetadata

Représente les métadonnées de l'opération de longue durée.

Champs
create_time	Timestamp Uniquement en sortie. Heure à laquelle l'opération a été créée.
end_time	Timestamp Uniquement en sortie. Heure à laquelle l'opération a terminé son exécution.
status_message	string Uniquement en sortie. Statut lisible de l'opération, le cas échéant.
requested_cancellation	bool Uniquement en sortie. Détermine si l'utilisateur a demandé l'annulation de l'opération. Les opérations qui ont bien été annulées possèdent la valeur google.longrunning.Operation.error avec un code d'état google.rpc.Status.code de 1, correspondant au code Code.CANCELLED.

OutputAudioConfig

OutputAudioConfig configure la façon dont l'agent CES doit synthétiser les réponses audio sortantes.

Champs
audio_encoding	AudioEncoding Obligatoire. Encodage des données audio de sortie.
sample_rate_hertz	int32 Obligatoire. Taux d'échantillonnage (en hertz) des données audio de sortie.

PythonCodeCondition

Bloc de code Python permettant d'évaluer la condition.

Champs
python_code	string Obligatoire. Code Python à exécuter.

PythonFunction

Un outil de fonction Python.

Champs
name	string Facultatif. Nom de la fonction Python à exécuter. Doit correspondre à un nom de fonction Python défini dans le code Python. Sensible à la casse. Si le nom n'est pas fourni, la première fonction définie dans le code Python sera utilisée.
python_code	string Facultatif. Code Python à exécuter pour l'outil.
description	string Uniquement en sortie. Description de la fonction Python, analysée à partir de la docstring du code Python.
service_directory_config	ServiceDirectoryConfig Facultatif. Configuration de l'Annuaire des services pour l'outil.

RecognitionResult

Résultat de la reconnaissance vocale pour l'entrée audio.

Champs
transcript	string Facultatif. Segments de parole de l'utilisateur concaténés capturés pendant le tour actuel.

RedactionConfig

Configuration indiquant comment les données sensibles doivent être traitées.

Champs
enable_redaction	bool Facultatif. Si la valeur est "true", la rédaction sera appliquée dans différents scénarios de journalisation, y compris l'historique des conversations, Cloud Logging et l'enregistrement audio.
inspect_template	string Facultatif. Nom du modèle d'inspection DLP permettant de configurer la détection des types de données sensibles. Format : projects/{project}/locations/{location}/inspectTemplates/{inspect_template}
deidentify_template	string Facultatif. Nom du modèle d'anonymisation DLP pour indiquer comment anonymiser le contenu. Format : projects/{project}/locations/{location}/deidentifyTemplates/{deidentify_template}

RemoteA2aConfig

Configuration partagée pour la connexion à un agent A2A distant.

Champs
api_authentication	ApiAuthentication Facultatif. Configuration de l'authentification pour appeler l'agent distant. Facultatif si la référence de registre gère déjà l'authentification.
input_variable_mapping	map<string, string> Facultatif. Mappage des noms de variables d'entrée de l'agent distant aux noms de variables GECX.
output_variable_mapping	map<string, string> Facultatif. Mappage des noms de variables de sortie de l'agent distant avec les noms de variables GECX.
streaming_enabled	bool Facultatif. Indique si le streaming est activé pour l'agent à distance.
context_id	string Facultatif. Si ce champ n'est pas vide, les interactions avec l'agent A2A distant utiliseront cet ID de contexte. Ce champ context_id peut faire référence à une variable de session telle que $context.variables.order_agent_session_id.
Champ d'union agent_spec. Spécification de l'agent distant. agent_spec ne peut être qu'un des éléments suivants :
agent_card	AgentCard Facultatif. Carte complète de l'agent définie de manière intégrée.
agent_registry	string Facultatif. Référence à l'agent dans Agent Registry. Format : projects/{project}/locations/{location}/agents/{agent}

RemoteAgentTool

Représente un outil qui permet à l'agent d'appeler un autre agent distant.

Champs
name	string Obligatoire. Nom de l'outil.
description	string Obligatoire. Description de l'outil.
agent_card	AgentCard Obligatoire. Fiche de l'agent distant que cet outil appelle.
api_authentication	ApiAuthentication Facultatif. Configuration de l'authentification pour appeler l'agent distant.
stateful_agent	bool Facultatif. Lorsque cette option est activée, l'interaction entre l'application CXAS et l'agent à distance partage le même contexte. Si l'agent distant renvoie un context_id, il sera conservé pendant toute la durée de la session pour cet outil d'agent distant.
input_variable_mapping	map<string, string> Facultatif. Mappage des noms de variables d'entrée de l'agent distant aux noms de variables GECX.
output_variable_mapping	map<string, string> Facultatif. Mappage des noms de variables de sortie de l'agent distant avec les noms de variables GECX.

RestoreAppVersionRequest

Message de requête pour AgentService.RestoreAppVersion

Champs
name	string Obligatoire. Nom de ressource de la version de l'application à restaurer.

RestoreAppVersionResponse

Ce type ne comporte aucun champ.

Message de réponse pour AgentService.RestoreAppVersion

RetrieveToolSchemaRequest

Message de requête pour ToolService.RetrieveToolSchema.

Champs
parent	string Obligatoire. Nom de ressource de l'application à laquelle appartient l'outil ou l'ensemble d'outils. Format : projects/{project}/locations/{location}/apps/{app}
Champ d'union tool_identifier. Identifiant de l'outil pour lequel récupérer le schéma. Il peut s'agir d'un outil persistant ou d'un outil d'un ensemble d'outils. tool_identifier ne peut être qu'un des éléments suivants :
tool	string Facultatif. Nom de l'outil pour lequel récupérer le schéma. Format : projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolset_tool	ToolsetTool Facultatif. Outil du toolset pour lequel récupérer le schéma. Un seul outil doit correspondre au prédicat de l'ensemble d'outils. Sinon, une erreur sera renvoyée.

RetrieveToolSchemaResponse

Message de réponse pour ToolService.RetrieveToolSchema.

Champs
input_schema	Schema Schéma des paramètres d'entrée de l'outil.
output_schema	Schema Schéma des paramètres de sortie de l'outil.
Champ d'union tool_identifier. Identifiant de l'outil auquel le schéma est destiné. tool_identifier ne peut être qu'un des éléments suivants :
tool	string Nom de l'outil auquel le schéma est destiné. Format : projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolset_tool	ToolsetTool Ensemble d'outils auquel le schéma est destiné.

RetrieveToolsRequest

Message de requête pour ToolService.RetrieveTools.

Champs
toolset	string Obligatoire. Nom de l'ensemble d'outils pour lequel les outils doivent être récupérés. Format : projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
tool_ids[]	string Facultatif. Identifiants des outils à récupérer à partir de l'ensemble d'outils. Si ce champ est vide, tous les outils de l'ensemble d'outils seront renvoyés.
bypass_persistence_config	bool Facultatif. Si la valeur est "true", les outils renvoyés contiendront des descriptions et des schémas bruts directement depuis le serveur, en ignorant toutes les configurations de persistance stockées (remplacements/instantanés).

RetrieveToolsResponse

Message de réponse pour ToolService.RetrieveTools.

Champs
tools[]	Tool Liste des outils inclus dans l'ensemble d'outils spécifié.

RunSessionRequest

Message de requête pour SessionService.RunSession.

Champs
config	SessionConfig Obligatoire. Configuration de la session.
inputs[]	SessionInput Obligatoire. Entrées de la session.

RunSessionResponse

Message de réponse pour SessionService.RunSession.

Champs
outputs[]	SessionOutput Sorties de la session.

Schéma

Représente un sous-ensemble spécifique d'un objet Schéma OpenAPI 3.0.

Champs
type	Schema.Type Obligatoire. Type des données.
properties	map<string, Schema> Facultatif. Propriétés de Type.OBJECT.
required[]	string Facultatif. Propriétés requises de Type.OBJECT.
description	string Facultatif. Description des données.
items	Schema Facultatif. Schéma des éléments de Type.ARRAY.
nullable	bool Facultatif. Indique si la valeur peut être nulle.
unique_items	bool Facultatif. Indique que les éléments du tableau doivent être uniques. Ne s'applique qu'à TYPE.ARRAY.
prefix_items[]	Schema Facultatif. Schémas des éléments initiaux de Type.ARRAY.
additional_properties	Schema Facultatif. Peut être une valeur booléenne ou un objet. Contrôle la présence de propriétés supplémentaires.
any_of[]	Schema Facultatif. La valeur doit être validée par rapport à l'un (ou plusieurs) des sous-schémas de la liste.
enum[]	string Facultatif. Valeurs possibles de l'élément de type primitif avec le format enum. Exemples : 1. Nous pouvons définir la direction comme suit : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. Nous pouvons définir le numéro d'appartement comme suit : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
default	Value Facultatif. Valeur par défaut des données.
ref	string Facultatif. Permet les références indirectes entre les nœuds de schéma. La valeur doit être une référence valide à un enfant de la racine defs. Par exemple, le schéma suivant définit une référence à un nœud de schéma nommé "Pet" : type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string La valeur de la propriété "pet" est une référence au nœud de schéma nommé "Pet". Pour en savoir plus, consultez https://json-schema.org/understanding-json-schema/structuring.
defs	map<string, Schema> Facultatif. Carte des définitions à utiliser par ref. Uniquement autorisé à la racine du schéma.
title	string Facultatif. Titre du schéma.
min_items	int64 Facultatif. Nombre minimal d'éléments pour Type.ARRAY.
max_items	int64 Facultatif. Nombre maximal d'éléments pour Type.ARRAY.
minimum	double Facultatif. Valeur minimale pour Type.INTEGER et Type.NUMBER.
maximum	double Facultatif. Valeur maximale pour Type.INTEGER et Type.NUMBER.

Type

Types de données OpenAPI.

Enums
TYPE_UNSPECIFIED	Type non spécifié
STRING	Type de chaîne.
INTEGER	Type entier.
NUMBER	Type de nombre.
BOOLEAN	Type booléen.
OBJECT	Type d'objet.
ARRAY	Type Array.

SecuritySettings

Paramètres de sécurité au niveau du projet/de l'emplacement pour CES.

Champs
name	string Identifiant. Identifiant unique des paramètres de sécurité. Format : projects/{project}/locations/{location}/securitySettings
endpoint_control_policy	EndpointControlPolicy Facultatif. Paramètres liés au contrôle des points de terminaison.
create_time	Timestamp Uniquement en sortie. Date de création des paramètres de sécurité.
update_time	Timestamp Uniquement en sortie. Heure de la dernière mise à jour des paramètres de sécurité.
etag	string Uniquement en sortie. Etag des paramètres de sécurité.

ServiceAccountAuthConfig

Configurations pour l'authentification à l'aide d'un compte de service personnalisé.

Champs
service_account	string Obligatoire. Adresse e-mail du compte de service utilisé pour l'authentification. CES utilise ce compte de service pour échanger un jeton d'accès, qui est ensuite envoyé dans l'en-tête Authorization de la requête. Le compte de service doit disposer du rôle roles/iam.serviceAccountTokenCreator attribué à l'agent de service CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
scopes[]	string Facultatif. Niveaux d'accès OAuth à accorder. Si aucune valeur n'est spécifiée, le champ d'application par défaut https://www.googleapis.com/auth/cloud-platform est utilisé.

ServiceAgentIdTokenAuthConfig

Ce type ne comporte aucun champ.

Configurations pour l'authentification avec un jeton d'identité généré à partir de l'agent de service.

ServiceDirectoryConfig

Configuration des outils utilisant l'Annuaire des services.

Champs
service	string Obligatoire. Nom du service Service Directory. Format : projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}. L'emplacement de l'annuaire des services doit être identique à celui de l'application.

SessionConfig

Configuration de la session.

Champs
session	string Obligatoire. Identifiant unique de la session. Format : projects/{project}/locations/{location}/apps/{app}/sessions/{session}
input_audio_config	InputAudioConfig Facultatif. Configuration pour le traitement de l'audio d'entrée.
output_audio_config	OutputAudioConfig Facultatif. Configuration pour générer l'audio de sortie.
historical_contexts[]	Message Facultatif. Contexte historique de la session, y compris les entrées utilisateur, les réponses de l'agent et les autres messages. En règle générale, l'agent CES gère la session automatiquement. Le client n'a donc pas besoin de renseigner explicitement ce champ. Toutefois, le client peut éventuellement remplacer les contextes historiques pour forcer le démarrage de la session à partir d'un certain état.
entry_agent	string Facultatif. Agent d'entrée chargé de gérer la session. Si aucune valeur n'est spécifiée, la session sera gérée par le root agent de l'application. Format : projects/{project}/locations/{location}/apps/{app}/agents/{agent}
deployment	string Facultatif. Déploiement de l'application à utiliser pour la session. Format : projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
time_zone	string Facultatif. Fuseau horaire de l'utilisateur. Si un fuseau horaire est fourni, l'agent l'utilisera pour les variables liées à la date et à l'heure. Sinon, l'agent utilisera le fuseau horaire spécifié dans App.time_zone_settings. Le format est celui du fuseau horaire de la base de données des fuseaux horaires de l'IANA (par exemple, "America/Los_Angeles").
use_tool_fakes	bool Facultatif. Indique s'il faut utiliser des faux outils pour la session. Si ce champ est défini, l'agent tentera d'utiliser des faux outils au lieu d'appeler les vrais outils.
remote_dialogflow_query_parameters	SessionConfig.RemoteDialogflowQueryParameters Facultatif. QueryParameters à envoyer à l'agent Dialogflow distant lorsque le contrôle de la session est transféré à l'agent distant.
enable_text_streaming	bool Facultatif. Indique si les sorties de texte en streaming du modèle doivent être activées. Par défaut, les sorties de texte du modèle sont collectées avant d'être envoyées au client. REMARQUE : Cette fonctionnalité n'est disponible que pour les sessions textuelles (non vocales) via StreamRunSession ou BidiRunSession.
exclude_diagnostic_info	bool Facultatif. Indique si les informations de diagnostic doivent être exclues de la sortie de la session.

RemoteDialogflowQueryParameters

QueryParameters à envoyer à l'agent Dialogflow distant lorsque le contrôle de la session est transféré à l'agent distant.

Champs
webhook_headers	map<string, string> Facultatif. En-têtes HTTP à envoyer en tant que webhook_headers dans QueryParameters.
payload	Struct Facultatif. Charge utile à envoyer dans QueryParameters.
end_user_metadata	Struct Facultatif. Métadonnées de l'utilisateur final à envoyer dans QueryParameters.

SessionInput

Entrée pour la session.

Champs
will_continue	bool Facultatif. Indicateur permettant de déterminer si le message actuel est un fragment d'une entrée plus grande dans la session de streaming bidirectionnel. Lorsque la valeur est définie sur true, l'agent diffère le traitement jusqu'à ce qu'il reçoive un message ultérieur où will_continue est défini sur false, ou jusqu'à ce que le système détecte un point de terminaison dans l'entrée audio. REMARQUE : Ce champ ne s'applique pas aux entrées audio et DTMF, car elles sont toujours traitées automatiquement en fonction du signal de fin.
Champ d'union input_type. Type de l'entrée. input_type ne peut être qu'un des éléments suivants :
text	string Facultatif. Données textuelles de l'utilisateur final.
dtmf	string Facultatif. Chiffres DTMF de l'utilisateur final.
audio	bytes Facultatif. Données audio de l'utilisateur final.
tool_responses	ToolResponses Facultatif. Résultats d'exécution des appels d'outils du client.
image	Image Facultatif. Données d'image de l'utilisateur final.
blob	Blob Facultatif. Données Blob de l'utilisateur final.
variables	Struct Facultatif. Variables contextuelles pour la session, indexées par nom. L'agent CES n'utilisera que les variables déclarées dans l'application. Les variables non reconnues seront toujours envoyées à l'agent Dialogflow en tant que paramètres de session supplémentaires.
event	Event Facultatif. Entrée d'événement.

SessionOutput

Sortie de la session.

Champs
turn_index	int32 Indique l'ordre séquentiel du tour de conversation auquel appartient cette sortie, en commençant par 1.
turn_completed	bool Si la valeur est "true", l'agent CES a détecté la fin du tour de conversation en cours et ne fournira aucune autre sortie pour ce tour.
diagnostic_info	SessionOutput.DiagnosticInfo Facultatif. Les informations de diagnostic contiennent des détails sur l'exécution lors du traitement de l'entrée. N'est renseigné que dans le dernier SessionOutput (avec turn_completed=true) pour chaque tour.
Champ d'union output_type. Type de sortie. output_type ne peut être qu'un des éléments suivants :
text	string Texte de sortie de l'agent CES.
audio	bytes Sortie audio de l'agent CES.
tool_calls	ToolCalls Demande au client d'exécuter les outils.
citations	Citations Citations qui fournissent des informations sur la source du texte généré par l'agent.
google_search_suggestions	GoogleSearchSuggestions Suggestions renvoyées par la recherche Google à la suite de l'appel de GoogleSearchTool.
end_session	EndSession Indique que la session est terminée.
payload	Struct Charge utile personnalisée avec sortie structurée de l'agent CES.
image	Image Image de sortie de l'agent CES.
progress	string Point intermédiaire sur l'avancement de l'agent CES.

DiagnosticInfo

Contient des détails sur l'exécution pendant le traitement.

Champs
messages[]	Message Liste des messages qui se sont affichés lors du traitement.
root_span	Span Trace du traitement complet de la requête, représentée sous forme de portée racine. Cette étendue peut contenir des étendues enfants imbriquées pour des opérations spécifiques.

Segment

Une portée est une unité de travail ou une opération unique lors du traitement des requêtes.

Champs
name	string Uniquement en sortie. Nom du segment.
start_time	Timestamp Uniquement en sortie. Heure de début du segment.
end_time	Timestamp Uniquement en sortie. Heure de fin de la période.
duration	Duration Uniquement en sortie. Durée du segment.
attributes	Struct Uniquement en sortie. Attributs clé-valeur associés à la portée.
child_spans[]	Span Uniquement en sortie. Les portées enfants imbriquées sous cette portée.

SynthesizeSpeechConfig

Configuration de la façon dont la réponse de l'agent doit être synthétisée.

Champs
voice	string Facultatif. Nom de la voix. Si ce champ n'est pas défini, le service choisira une voix en fonction des autres paramètres, tels que language_code. Pour obtenir la liste des voix disponibles, veuillez consulter Voix et langues disponibles dans Cloud Text-to-Speech.
speaking_rate	double Facultatif. Vitesse d'élocution dans la plage [0,25, 2,0]. La valeur 1,0 correspond à la vitesse native normale compatible avec la voix spécifique. La valeur 2,0 est deux fois plus rapide et la valeur 0,5 est deux fois moins rapide. Les valeurs en dehors de la plage [0,25, 2,0] renvoient une erreur.
model	string Facultatif. Modèle utilisé pour synthétiser l'audio. Valeurs actuellement acceptées : "gemini-3.1-flash-tts-preview". Si ce champ est vide, Chirp3-HD est utilisé.
instruction	string Facultatif. Instruction utilisée pour synthétiser la parole lors de l'utilisation d'un modèle génératif.

SystemTool

Outil système prédéfini.

Champs
name	string Obligatoire. Nom de l'outil système.
description	string Uniquement en sortie. Description de l'outil système.

TimeZoneSettings

Paramètres de fuseau horaire de l'application.

Champs
time_zone	string Facultatif. Fuseau horaire de l'application issu de la base de données des fuseaux horaires (par exemple, America/Los_Angeles ou Europe/Paris).

TlsConfig

Configuration TLS.

Champs
ca_certs[]	TlsConfig.CaCert Obligatoire. Spécifie une liste de certificats d'autorité de certification personnalisés autorisés pour la validation HTTPS.

CaCert

Certificat CA.

Champs
display_name	string Obligatoire. Nom des certificats d'autorité de certification personnalisés autorisés. Cela peut être utilisé pour lever toute ambiguïté concernant les certificats d'autorité de certification personnalisés.
cert	bytes Obligatoire. Certificats CA personnalisés autorisés (au format DER) pour la validation HTTPS. Cela remplace le magasin de confiance SSL par défaut. Si ce champ est vide ou n'est pas spécifié, CES utilisera le magasin de confiance par défaut de Google pour valider les certificats. Remarque : Assurez-vous que les certificats de serveur HTTPS sont signés avec "subject alt name". Par exemple, un certificat peut être auto-signé à l'aide de la commande suivante : openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'")

Outil

Un outil représente une action que l'agent CES peut effectuer pour atteindre certains objectifs.

Champs
name	string Identifiant. Nom de ressource de l'outil. Format : projects/{project}/locations/{location}/apps/{app}/tools/{tool} pour les outils autonomes. projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool} pour les outils récupérés à partir d'un ensemble d'outils. Ces outils sont dynamiques et ne peuvent être utilisés que pour la sortie. Ils ne peuvent pas être référencés directement lorsqu'un outil est attendu.
display_name	string Uniquement en sortie. Nom à afficher de l'outil, basé sur son type. Par exemple, le nom à afficher d'une [ClientFunction][Tool.ClientFunction] est dérivé de sa propriété name.
execution_type	ExecutionType Facultatif. Type d'exécution de l'outil.
timeout	Duration Facultatif. Délai d'expiration pour l'exécution de l'outil. Si ce paramètre n'est pas défini, le délai d'inactivité par défaut est de 30 secondes pour les outils SYNCHRONOUS et de 60 secondes pour les outils ASYNCHRONOUS.
create_time	Timestamp Uniquement en sortie. Code temporel de la création de l'outil.
update_time	Timestamp Uniquement en sortie. Code temporel de la dernière mise à jour de l'outil.
etag	string Etag utilisé pour s'assurer que l'objet n'a pas été modifié lors d'une opération de lecture-modification-écriture. Si l'etag est vide, la mise à jour écrasera toutes les modifications simultanées.
generated_summary	string Uniquement en sortie. Si l'outil est généré par l'assistant LLM, ce champ contient un résumé descriptif de la génération.
tool_fake_config	ToolFakeConfig Facultatif. Configuration du comportement de l'outil en mode factice.
read_only	bool Uniquement en sortie. Indique si l'outil est en lecture seule. Si la valeur est "true", l'utilisateur ne peut pas modifier l'outil.
Champ d'union tool_type. Type de l'outil. tool_type ne peut être qu'un des éléments suivants :
client_function	ClientFunction Facultatif. Fonction client.
open_api_tool	OpenApiTool Facultatif. Outil OpenAPI.
google_search_tool	GoogleSearchTool Facultatif. Outil de recherche Google.
connector_tool	ConnectorTool Facultatif. Outil Integration Connectors.
data_store_tool	DataStoreTool Facultatif. Outil de data store.
python_function	PythonFunction Facultatif. L'outil de fonction Python.
mcp_tool	McpTool Facultatif. L'outil MCP. Un outil MCP ne peut pas être créé ni mis à jour directement. Il est géré par l'ensemble d'outils MCP.
file_search_tool	FileSearchTool Facultatif. Outil de recherche de fichiers.
system_tool	SystemTool Facultatif. Outil système.
agent_tool	AgentTool Facultatif. Outil d'agent.
widget_tool	WidgetTool Facultatif. L'outil Widget.
remote_agent_tool	RemoteAgentTool Facultatif. L'outil d'agent distant.

ToolCall

Demande au client ou à l'agent d'exécuter l'outil spécifié.

Champs
id	string Facultatif. Identifiant unique de l'appel d'outil. Si ce champ est renseigné, le client doit renvoyer le résultat de l'exécution avec l'ID correspondant dans ToolResponse.
display_name	string Uniquement en sortie. Nom à afficher de l'outil.
args	Struct Facultatif. Paramètres et valeurs d'entrée de l'outil au format d'objet JSON.
parent_tool_call_id	string Uniquement en sortie. ID de l'appel d'outil qui a déclenché celui-ci, lorsqu'il a été émis par un sous-agent travaillant pour le compte d'un appel parent. Vide pour les appels de premier niveau. Permet à un client de regrouper le travail d'un sous-agent sous l'appel qui l'a déclenché au lieu de rendre chaque étape en tant que frère.
agent_name	string Uniquement en sortie. Nom de l'agent lisible par l'humain qui a émis cet appel, par exemple "Architecte de contrat". Vide lorsque l'agent racine l'a émis.
Champ d'union tool_identifier. Identifiant de l'outil à exécuter. Il peut s'agir d'un outil persistant ou d'un outil d'un ensemble d'outils. tool_identifier ne peut être qu'un des éléments suivants :
tool	string Facultatif. Nom de l'outil à exécuter. Format : projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolset_tool	ToolsetTool Facultatif. Outil du toolset à exécuter.

ToolCalls

Demande au client d'exécuter les outils et de renvoyer les résultats de l'exécution avant de poursuivre la session.

Champs
tool_calls[]	ToolCall Facultatif. Liste des appels d'outils à exécuter.

ToolFakeConfig

Configuration du comportement de l'outil en mode factice.

Champs
enable_fake_mode	bool Facultatif. Indique si l'outil utilise le mode factice.
Champ d'union tool_response. La réponse est statique ou fournie par une fonction Python. tool_response ne peut être qu'un des éléments suivants :
code_block	CodeBlock Facultatif. Bloc de code qui sera exécuté à la place d'un véritable appel d'outil.

ToolResponse

Résultat de l'exécution d'un outil spécifique par le client ou l'agent.

Champs
id	string Facultatif. ID correspondant du tool call auquel la réponse se rapporte.
display_name	string Uniquement en sortie. Nom à afficher de l'outil.
response	Struct Obligatoire. Résultat de l'exécution de l'outil au format d'objet JSON. Utilisez la clé "output" pour spécifier la réponse de l'outil et la clé "error" pour spécifier les détails de l'erreur (le cas échéant). Si les clés "output" et "error" ne sont pas spécifiées, l'ensemble de la "response" est traité comme le résultat de l'exécution de l'outil.
parent_tool_call_id	string Uniquement en sortie. ID de l'appel d'outil qui a déclenché celui-ci, lorsqu'il a été émis par un sous-agent travaillant pour le compte d'un appel parent. Vide pour les appels de premier niveau. Permet à un client de regrouper le travail d'un sous-agent sous l'appel qui l'a déclenché au lieu de rendre chaque étape en tant que frère.
agent_name	string Uniquement en sortie. Nom de l'agent lisible par l'humain qui a émis cet appel, par exemple "Architecte de contrat". Vide lorsque l'agent racine l'a émis.
Champ d'union tool_identifier. Identifiant de l'outil exécuté. Il peut s'agir d'un outil persistant ou d'un outil d'un ensemble d'outils. tool_identifier ne peut être qu'un des éléments suivants :
tool	string Facultatif. Nom de l'outil à exécuter. Format : projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolset_tool	ToolsetTool Facultatif. Outil de l'ensemble d'outils qui a été exécuté.

ToolResponses

Résultats d'exécution des appels d'outils demandés par le client.

Champs
tool_responses[]	ToolResponse Facultatif. Liste des résultats d'exécution de l'outil.

Ensemble d'outils

Un ensemble d'outils représente un groupe d'outils gérés de manière dynamique et pouvant être utilisés par l'agent.

Champs
name	string Identifiant. Identifiant unique de l'ensemble d'outils. Format : projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
display_name	string Facultatif. Nom à afficher de l'ensemble d'outils. Cet ID doit être unique dans la même application.
description	string Facultatif. Description de l'ensemble d'outils.
timeout	Duration Facultatif. Délai d'expiration pour l'exécution de l'ensemble d'outils. Si ce champ n'est pas défini, le délai avant expiration par défaut est de 30 secondes pour les ensembles d'outils SYNCHRONOUS et de 60 secondes pour les ensembles d'outils ASYNCHRONOUS.
create_time	Timestamp Uniquement en sortie. Code temporel de la création de l'ensemble d'outils.
update_time	Timestamp Uniquement en sortie. Code temporel de la dernière mise à jour de l'ensemble d'outils.
etag	string ETag utilisé pour s'assurer que l'objet n'a pas été modifié lors d'une opération de lecture-modification-écriture. Si l'etag est vide, la mise à jour écrasera toutes les modifications simultanées.
execution_type	ExecutionType Facultatif. Type d'exécution des outils dans l'ensemble d'outils.
tool_fake_config	ToolFakeConfig Facultatif. Configuration du comportement des outils en mode factice.
Champ d'union toolset_type. Type de l'ensemble d'outils. toolset_type ne peut être qu'un des éléments suivants :
mcp_toolset	McpToolset Facultatif. Ensemble d'outils contenant la liste des outils proposés par le serveur MCP.
open_api_toolset	OpenApiToolset Facultatif. Ensemble d'outils contenant une liste d'outils définis par un schéma OpenAPI.
connector_toolset	ConnectorToolset Facultatif. Ensemble d'outils qui génère des outils à partir d'une connexion Integration Connectors.

ToolsetTool

Outil créé à partir d'un ensemble d'outils.

Champs
toolset	string Obligatoire. Nom de ressource du Toolset à partir duquel cet outil est dérivé. Format : projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
tool_id	string Facultatif. ID de l'outil permettant de filtrer les outils pour récupérer le schéma.

TransferRule

Règle pour transférer la conversation à un agent spécifique.

Champs
child_agent	string Obligatoire. Nom de ressource de l'agent enfant auquel s'applique la règle. Format : projects/{project}/locations/{location}/apps/{app}/agents/{agent}
direction	TransferRule.Direction Obligatoire. Sens du transfert.
Champ d'union rule_type. Type de règle. rule_type ne peut être qu'un des éléments suivants :
deterministic_transfer	TransferRule.DeterministicTransfer Facultatif. Règle qui transfère immédiatement la demande à l'agent cible lorsque la condition est remplie.
disable_planner_transfer	TransferRule.DisablePlannerTransfer Facultatif. Règle qui empêche le planificateur d'être transféré à l'agent cible.

DeterministicTransfer

Règle de transfert déterministe. Lorsque la condition renvoie la valeur "true", le transfert a lieu.

Champs
Champ d'union condition_type. Condition à évaluer. condition_type ne peut être qu'un des éléments suivants :
expression_condition	ExpressionCondition Facultatif. Règle qui évalue une condition d'état de session. Si la condition renvoie la valeur "true", le transfert a lieu.
python_code_condition	PythonCodeCondition Facultatif. Règle qui utilise un bloc de code Python pour évaluer les conditions. Si la condition renvoie la valeur "true", le transfert a lieu.

Direction

Sens du transfert.

Enums
DIRECTION_UNSPECIFIED	Direction non spécifiée.
PARENT_TO_CHILD	Transférez l'agent parent vers l'agent enfant.
CHILD_TO_PARENT	Transférez de l'agent enfant vers l'agent parent.

DisablePlannerTransfer

Règle qui empêche le planificateur d'être transféré à l'agent cible.

Champs
expression_condition	ExpressionCondition Obligatoire. Si la condition renvoie la valeur "true", le planificateur ne sera pas autorisé à transférer la demande à l'agent cible.

TriggerAction

Action effectuée lorsqu'une condition préalable est remplie.

Champs
Champ d'union action. Action à effectuer. action ne peut être qu'un des éléments suivants :
respond_immediately	TriggerAction.RespondImmediately Facultatif. répondre immédiatement avec une réponse préconfigurée ;
transfer_agent	TriggerAction.TransferAgent Facultatif. Transférez la conversation à un autre agent.
generative_answer	TriggerAction.GenerativeAnswer Facultatif. Répondez avec une réponse générative.

GenerativeAnswer

L'agent répondra immédiatement avec une réponse générative.

Champs
prompt	string Obligatoire. Requête à utiliser pour la réponse générative.

RespondImmediately

L'agent répondra immédiatement avec une réponse préconfigurée.

Champs
responses[]	TriggerAction.Response Obligatoire. Réponses prédéfinies parmi lesquelles l'agent peut choisir. La réponse est choisie de manière aléatoire.

Réponse

Représente une réponse de l'agent.

Champs
text	string Obligatoire. Texte auquel l'agent doit répondre.
disabled	bool Facultatif. Indique si la réponse est désactivée. Les réponses désactivées ne sont pas utilisées par l'agent.

TransferAgent

L'agent transférera la conversation à un autre agent.

Champs
agent	string Obligatoire. Nom de l'agent auquel transférer la conversation. L'agent doit se trouver dans la même application que l'agent actuel. Format : projects/{project}/locations/{location}/apps/{app}/agents/{agent}

UpdateAgentRequest

Message de requête pour AgentService.UpdateAgent.

Champs
agent	Agent Obligatoire. Agent à mettre à jour.
update_mask	FieldMask Facultatif. Le masque de champ permet de contrôler les champs à mettre à jour. Si le masque n'est pas présent, tous les champs seront mis à jour.

UpdateAppRequest

Message de requête pour AgentService.UpdateApp.

Champs
app	App Obligatoire. Application à mettre à jour.
update_mask	FieldMask Facultatif. Le masque de champ permet de contrôler les champs à mettre à jour. Si le masque n'est pas présent, tous les champs seront mis à jour.

UpdateAppVersionRequest

Message de requête pour AgentService.UpdateAppVersion.

Champs
app_version	AppVersion Obligatoire. Version de l'application à mettre à jour.
update_mask	FieldMask Facultatif. Liste des champs à mettre à jour. S'il est vide, les champs display_name et description seront mis à jour.

UpdateDeploymentRequest

Message de requête pour AgentService.UpdateDeployment.

Champs
deployment	Deployment Obligatoire. Déploiement à mettre à jour.
update_mask	FieldMask Facultatif. Liste des champs à mettre à jour.

UpdateExampleRequest

Message de requête pour AgentService.UpdateExample.

Champs
example	Example Obligatoire. Exemple à mettre à jour.
update_mask	FieldMask Facultatif. Le masque de champ permet de contrôler les champs à mettre à jour. Si le masque n'est pas présent, tous les champs seront mis à jour.

UpdateGuardrailRequest

Message de requête pour AgentService.UpdateGuardrail.

Champs
guardrail	Guardrail Obligatoire. Garde-fou à mettre à jour.
update_mask	FieldMask Facultatif. Le masque de champ permet de contrôler les champs à mettre à jour. Si le masque n'est pas présent, tous les champs seront mis à jour.

UpdateToolRequest

Message de requête pour AgentService.UpdateTool.

Champs
tool	Tool Obligatoire. Outil à mettre à jour.
update_mask	FieldMask Facultatif. Le masque de champ permet de contrôler les champs à mettre à jour. Si le masque n'est pas présent, tous les champs seront mis à jour.

UpdateToolsetRequest

Message de requête pour AgentService.UpdateToolset.

Champs
toolset	Toolset Obligatoire. Ensemble d'outils à mettre à jour.
update_mask	FieldMask Facultatif. Le masque de champ permet de contrôler les champs à mettre à jour. Si le masque n'est pas présent, tous les champs seront mis à jour.

VpcScSettings

Paramètres VPC-SC pour l'application.

Champs

allowed_origins[]

string Facultatif. Origines HTTP(S) autorisées que les outils OpenAPI de l'application peuvent appeler directement lorsque VPC Service Controls est activé. Ces chaînes doivent correspondre exactement à l'origine, y compris au port si spécifié. Par exemple, "https://example.com" ou "https://example.com:443". Cette liste ne s'applique pas encore aux outils Python qui peuvent effectuer des appels HTTP directs.

WebSearchQuery

Représente une seule requête de recherche sur le Web et son URI de recherche associé.

Champs
query	string Texte de la requête de recherche.
uri	string URI de la page de résultats de recherche Google pour la requête.

WhatsAppCredentials

Identifiants Meta éphémères pour l'intégration native de WhatsApp.

Champs
auth_code	string Obligatoire. Code d'autorisation Meta fourni par le flux d'inscription intégré.
pin	string Obligatoire. Code à six chiffres créé par l'utilisateur pour la validation en deux étapes.
phone_number	string Obligatoire. Numéro de téléphone à enregistrer sur WhatsApp.
business_account_id	string Obligatoire. ID du compte professionnel à utiliser pour le numéro de téléphone.
waba_id	string Obligatoire. ID du compte WhatsApp Business.
conversation_profile_id	string Facultatif. ID du profil de conversation à utiliser pour le déploiement.

WidgetTool

Représente un outil de widget que l'agent peut appeler. Lorsque l'outil est choisi par l'agent, celui-ci renvoie le widget au client. Le client est responsable du traitement du widget et de la génération de la prochaine requête utilisateur pour poursuivre l'interaction avec l'agent.

Champs
name	string Obligatoire. Nom à afficher de l'outil de widget.
description	string Facultatif. Description de l'outil de widget.
widget_type	WidgetTool.WidgetType Facultatif. Type de l'outil de widget. Si aucune valeur n'est spécifiée, le type par défaut est "CUSTOMIZED" (PERSONNALISÉ).
ui_config	Struct Facultatif. Configuration pour afficher le widget.
data_mapping	WidgetTool.DataMapping Facultatif. Mappage qui définit la façon dont les données d'un outil source sont mappées aux paramètres d'entrée du widget.
text_response_config	WidgetTool.TextResponseConfig Facultatif. Configuration pour les réponses textuelles toujours incluses.
Champ d'union input. Entrée de l'outil de widget. input ne peut être qu'un des éléments suivants :
parameters	Schema Facultatif. Paramètres d'entrée de l'outil de widget.

DataMapping

Configuration du mappage des données d'un outil source aux paramètres d'entrée du widget.

Champs
source_tool_name	string Facultatif. Nom de ressource de l'outil qui fournit les données du widget (par exemple, un outil de recherche ou une fonction personnalisée). Format : projects/{project}/locations/{location}/agents/{agent}/tools/{tool}
field_mappings	map<string, string> Facultatif. Mappage des champs de paramètres d'entrée du widget avec les champs de sortie correspondants de l'outil source.
python_function	PythonFunction Facultatif. Configuration d'une fonction Python utilisée pour transformer la sortie de l'outil source au format d'entrée du widget.
mode	WidgetTool.DataMapping.Mode Facultatif. Mode de mappage des données.
python_script (deprecated)	string Cet élément est obsolète. Obsolète : utilisez plutôt python_function.

Mode

Stratégie utilisée pour mapper les données de l'outil source au widget.

Enums
MODE_UNSPECIFIED	Mode non spécifié.
FIELD_MAPPING	Utilisez la carte field_mappings pour transformer les données.
PYTHON_SCRIPT	Utilisez python_script pour transformer les données.

TextResponseConfig

Configuration de la réponse textuelle renvoyée avec le widget.

Champs
type	WidgetTool.TextResponseConfig.Type Facultatif. Stratégie pour fournir la réponse textuelle.
static_text	string Facultatif. Réponse textuelle statique à renvoyer lorsque le type est "STATIC".
text_response_instruction	string Facultatif. Instruction pour le LLM sur la façon de générer la réponse textuelle. Utilisé comme description du paramètre de réponse textuelle si le type est LLM_GENERATED.

Type

Définit la manière dont la réponse textuelle est produite.

Enums
TYPE_UNSPECIFIED	Type non spécifié.
NONE	Le LLM décide de manière dynamique s'il doit générer une réponse textuelle en plus du widget en fonction du contexte de la conversation.
LLM_GENERATED	Le LLM est explicitement tenu de générer une réponse textuelle.
STATIC	Une réponse textuelle statique prédéfinie est toujours utilisée.

WidgetType

Tous les types de widgets disponibles. De nouvelles valeurs pourront être ajoutées à cette énumération à l'avenir.

Enums
WIDGET_TYPE_UNSPECIFIED	Type de widget non spécifié.
CUSTOM	Type de widget personnalisé.
PRODUCT_CAROUSEL	Widget de carrousel de produits.
PRODUCT_DETAILS	Widget d'informations détaillées sur le produit.
QUICK_ACTIONS	Widget Actions rapides.
PRODUCT_COMPARISON	Widget de comparaison de produits.
ADVANCED_PRODUCT_DETAILS	Widget d'informations détaillées avancées sur le produit.
SHORT_FORM	Widget de formulaire court.
OVERALL_SATISFACTION	Widget de satisfaction globale.
ORDER_SUMMARY	Widget "Récapitulatif de la commande".
APPOINTMENT_DETAILS	Widget des détails du rendez-vous.
APPOINTMENT_SCHEDULER	Widget de planification des rendez-vous.
CONTACT_FORM	Widget de formulaire de contact.