Package google.cloud.ces.v1

Index

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

AgentService

Der Dienst, der Agent-bezogene Ressourcen in Gemini Enterprise for Customer Engagement (CES) verwaltet.

BatchDeleteConversations

rpc BatchDeleteConversations(BatchDeleteConversationsRequest) returns (Operation) Löscht die angegebenen Unterhaltungen im Batch. Autorisierungsbereiche Erfordert einen der folgenden OAuth-Bereiche: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Weitere Informationen finden Sie unter Authentication Overview. IAM-Berechtigungen Erfordert die folgende IAM-Berechtigung für die Ressource parent: ces.conversations.delete Weitere Informationen finden Sie in der IAM-Dokumentation.

CreateAgent

rpc CreateAgent(CreateAgentRequest) returns (Agent) Erstellt einen neuen Agenten in der angegebenen App. Autorisierungsbereiche Erfordert einen der folgenden OAuth-Bereiche: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Weitere Informationen finden Sie unter Authentication Overview. IAM-Berechtigungen Erfordert die folgende IAM-Berechtigung für die Ressource parent: ces.agents.create Weitere Informationen finden Sie in der IAM-Dokumentation.

CreateApp

rpc CreateApp(CreateAppRequest) returns (Operation) Erstellt eine neue App im angegebenen Projekt und am angegebenen Standort. Autorisierungsbereiche Erfordert einen der folgenden OAuth-Bereiche: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Weitere Informationen finden Sie unter Authentication Overview. IAM-Berechtigungen Erfordert die folgende IAM-Berechtigung für die Ressource parent: ces.apps.create Weitere Informationen finden Sie in der IAM-Dokumentation.

CreateAppVersion

rpc CreateAppVersion(CreateAppVersionRequest) returns (AppVersion) Erstellt eine neue App-Version in der angegebenen App. Autorisierungsbereiche Erfordert einen der folgenden OAuth-Bereiche: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Weitere Informationen finden Sie unter Authentication Overview. IAM-Berechtigungen Erfordert die folgende IAM-Berechtigung für die Ressource parent: ces.appVersions.create Weitere Informationen finden Sie in der IAM-Dokumentation.

CreateDeployment

rpc CreateDeployment(CreateDeploymentRequest) returns (Deployment) Erstellt ein neues Deployment in der angegebenen App. Autorisierungsbereiche Erfordert einen der folgenden OAuth-Bereiche: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Weitere Informationen finden Sie unter Authentication Overview. IAM-Berechtigungen Erfordert die folgende IAM-Berechtigung für die Ressource parent: ces.deployments.create Weitere Informationen finden Sie in der IAM-Dokumentation.

CreateExample

rpc CreateExample(CreateExampleRequest) returns (Example) Erstellt ein neues Beispiel in der angegebenen App. Autorisierungsbereiche Erfordert einen der folgenden OAuth-Bereiche: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Weitere Informationen finden Sie unter Authentication Overview. IAM-Berechtigungen Erfordert die folgende IAM-Berechtigung für die Ressource parent: ces.examples.create Weitere Informationen finden Sie in der IAM-Dokumentation.

CreateGuardrail

rpc CreateGuardrail(CreateGuardrailRequest) returns (Guardrail) Erstellt einen neuen Guardrail in der angegebenen App. Autorisierungsbereiche Erfordert einen der folgenden OAuth-Bereiche: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Weitere Informationen finden Sie unter Authentication Overview. IAM-Berechtigungen Erfordert die folgende IAM-Berechtigung für die Ressource parent: ces.guardrails.create Weitere Informationen finden Sie in der IAM-Dokumentation.

CreateTool

rpc CreateTool(CreateToolRequest) returns (Tool) Erstellt ein neues Tool in der angegebenen App. Autorisierungsbereiche Erfordert einen der folgenden OAuth-Bereiche: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Weitere Informationen finden Sie unter Authentication Overview. IAM-Berechtigungen Erfordert die folgende IAM-Berechtigung für die Ressource parent: ces.tools.create Weitere Informationen finden Sie in der IAM-Dokumentation.

CreateToolset

rpc CreateToolset(CreateToolsetRequest) returns (Toolset) Erstellt ein neues Toolset in der angegebenen App. Autorisierungsbereiche Erfordert einen der folgenden OAuth-Bereiche: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Weitere Informationen finden Sie unter Authentication Overview. IAM-Berechtigungen Erfordert die folgende IAM-Berechtigung für die Ressource parent: ces.toolsets.create Weitere Informationen finden Sie in der IAM-Dokumentation.

DeleteAgent

rpc DeleteAgent(DeleteAgentRequest) returns (Empty) Löscht den angegebenen Agent. Autorisierungsbereiche Erfordert einen der folgenden OAuth-Bereiche: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Weitere Informationen finden Sie unter Authentication Overview. IAM-Berechtigungen Erfordert die folgende IAM-Berechtigung für die Ressource name: ces.agents.delete Weitere Informationen finden Sie in der IAM-Dokumentation.

DeleteApp

rpc DeleteApp(DeleteAppRequest) returns (Operation) Löscht die angegebene App. Autorisierungsbereiche Erfordert einen der folgenden OAuth-Bereiche: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Weitere Informationen finden Sie unter Authentication Overview. IAM-Berechtigungen Erfordert die folgende IAM-Berechtigung für die Ressource name: ces.apps.delete Weitere Informationen finden Sie in der IAM-Dokumentation.

DeleteAppVersion

rpc DeleteAppVersion(DeleteAppVersionRequest) returns (Empty) Löscht die angegebene App-Version. Autorisierungsbereiche Erfordert einen der folgenden OAuth-Bereiche: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Weitere Informationen finden Sie unter Authentication Overview. IAM-Berechtigungen Erfordert die folgende IAM-Berechtigung für die Ressource name: ces.appVersions.delete Weitere Informationen finden Sie in der IAM-Dokumentation.

DeleteConversation

rpc DeleteConversation(DeleteConversationRequest) returns (Empty) Löscht die angegebene Unterhaltung. Autorisierungsbereiche Erfordert einen der folgenden OAuth-Bereiche: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Weitere Informationen finden Sie unter Authentication Overview. IAM-Berechtigungen Erfordert die folgende IAM-Berechtigung für die Ressource name: ces.conversations.delete Weitere Informationen finden Sie in der IAM-Dokumentation.

DeleteDeployment

rpc DeleteDeployment(DeleteDeploymentRequest) returns (Empty) Löscht das angegebene Deployment. Autorisierungsbereiche Erfordert einen der folgenden OAuth-Bereiche: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Weitere Informationen finden Sie unter Authentication Overview. IAM-Berechtigungen Erfordert die folgende IAM-Berechtigung für die Ressource name: ces.deployments.delete Weitere Informationen finden Sie in der IAM-Dokumentation.

DeleteExample

rpc DeleteExample(DeleteExampleRequest) returns (Empty) Löscht das angegebene Beispiel. Autorisierungsbereiche Erfordert einen der folgenden OAuth-Bereiche: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Weitere Informationen finden Sie unter Authentication Overview. IAM-Berechtigungen Erfordert die folgende IAM-Berechtigung für die Ressource name: ces.examples.delete Weitere Informationen finden Sie in der IAM-Dokumentation.

DeleteGuardrail

rpc DeleteGuardrail(DeleteGuardrailRequest) returns (Empty) Löscht die angegebene Schutzvorrichtung. Autorisierungsbereiche Erfordert einen der folgenden OAuth-Bereiche: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Weitere Informationen finden Sie unter Authentication Overview. IAM-Berechtigungen Erfordert die folgende IAM-Berechtigung für die Ressource name: ces.guardrails.delete Weitere Informationen finden Sie in der IAM-Dokumentation.

DeleteTool

rpc DeleteTool(DeleteToolRequest) returns (Empty) Löscht das angegebene Tool. Autorisierungsbereiche Erfordert einen der folgenden OAuth-Bereiche: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Weitere Informationen finden Sie unter Authentication Overview. IAM-Berechtigungen Erfordert die folgende IAM-Berechtigung für die Ressource name: ces.tools.delete Weitere Informationen finden Sie in der IAM-Dokumentation.

DeleteToolset

rpc DeleteToolset(DeleteToolsetRequest) returns (Empty) Löscht das angegebene Toolset. Autorisierungsbereiche Erfordert einen der folgenden OAuth-Bereiche: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Weitere Informationen finden Sie unter Authentication Overview. IAM-Berechtigungen Erfordert die folgende IAM-Berechtigung für die Ressource name: ces.toolsets.delete Weitere Informationen finden Sie in der IAM-Dokumentation.

ExportApp

rpc ExportApp(ExportAppRequest) returns (Operation) Exportiert die angegebene App. Autorisierungsbereiche Erfordert einen der folgenden OAuth-Bereiche: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Weitere Informationen finden Sie unter Authentication Overview. IAM-Berechtigungen Erfordert die folgende IAM-Berechtigung für die Ressource name: ces.apps.export Weitere Informationen finden Sie in der IAM-Dokumentation.

GetAgent

rpc GetAgent(GetAgentRequest) returns (Agent) Ruft Details zum angegebenen Agent ab. Autorisierungsbereiche Erfordert einen der folgenden OAuth-Bereiche: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Weitere Informationen finden Sie unter Authentication Overview. IAM-Berechtigungen Erfordert die folgende IAM-Berechtigung für die Ressource name: ces.agents.get Weitere Informationen finden Sie in der IAM-Dokumentation.

GetApp

rpc GetApp(GetAppRequest) returns (App) Ruft Details zur angegebenen App ab. Autorisierungsbereiche Erfordert einen der folgenden OAuth-Bereiche: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Weitere Informationen finden Sie unter Authentication Overview. IAM-Berechtigungen Erfordert die folgende IAM-Berechtigung für die Ressource name: ces.apps.get Weitere Informationen finden Sie in der IAM-Dokumentation.

GetAppVersion

rpc GetAppVersion(GetAppVersionRequest) returns (AppVersion) Ruft Details zur angegebenen App-Version ab. Autorisierungsbereiche Erfordert einen der folgenden OAuth-Bereiche: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Weitere Informationen finden Sie unter Authentication Overview. IAM-Berechtigungen Erfordert die folgende IAM-Berechtigung für die Ressource name: ces.appVersions.get Weitere Informationen finden Sie in der IAM-Dokumentation.

GetChangelog

rpc GetChangelog(GetChangelogRequest) returns (Changelog) Ruft das angegebene Changelog ab. Autorisierungsbereiche Erfordert einen der folgenden OAuth-Bereiche: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Weitere Informationen finden Sie unter Authentication Overview. IAM-Berechtigungen Erfordert die folgende IAM-Berechtigung für die Ressource name: ces.changelogs.get Weitere Informationen finden Sie in der IAM-Dokumentation.

GetConversation

rpc GetConversation(GetConversationRequest) returns (Conversation) Ruft Details zur angegebenen Unterhaltung ab. Autorisierungsbereiche Erfordert einen der folgenden OAuth-Bereiche: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Weitere Informationen finden Sie unter Authentication Overview. IAM-Berechtigungen Erfordert die folgende IAM-Berechtigung für die Ressource name: ces.conversations.get Weitere Informationen finden Sie in der IAM-Dokumentation.

GetDeployment

rpc GetDeployment(GetDeploymentRequest) returns (Deployment) Ruft die Details der angegebenen Bereitstellung ab. Autorisierungsbereiche Erfordert einen der folgenden OAuth-Bereiche: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Weitere Informationen finden Sie unter Authentication Overview. IAM-Berechtigungen Erfordert die folgende IAM-Berechtigung für die Ressource name: ces.deployments.get Weitere Informationen finden Sie in der IAM-Dokumentation.

GetExample

rpc GetExample(GetExampleRequest) returns (Example) Ruft Details zum angegebenen Beispiel ab. Autorisierungsbereiche Erfordert einen der folgenden OAuth-Bereiche: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Weitere Informationen finden Sie unter Authentication Overview. IAM-Berechtigungen Erfordert die folgende IAM-Berechtigung für die Ressource name: ces.examples.get Weitere Informationen finden Sie in der IAM-Dokumentation.

GetGuardrail

rpc GetGuardrail(GetGuardrailRequest) returns (Guardrail) Ruft Details zur angegebenen Schutzvorrichtung ab. Autorisierungsbereiche Erfordert einen der folgenden OAuth-Bereiche: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Weitere Informationen finden Sie unter Authentication Overview. IAM-Berechtigungen Erfordert die folgende IAM-Berechtigung für die Ressource name: ces.guardrails.get Weitere Informationen finden Sie in der IAM-Dokumentation.

GetTool

rpc GetTool(GetToolRequest) returns (Tool) Ruft die Details des angegebenen Tools ab. Autorisierungsbereiche Erfordert einen der folgenden OAuth-Bereiche: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Weitere Informationen finden Sie unter Authentication Overview. IAM-Berechtigungen Erfordert die folgende IAM-Berechtigung für die Ressource name: ces.tools.get Weitere Informationen finden Sie in der IAM-Dokumentation.

GetToolset

rpc GetToolset(GetToolsetRequest) returns (Toolset) Ruft die Details des angegebenen Toolsets ab. Autorisierungsbereiche Erfordert einen der folgenden OAuth-Bereiche: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Weitere Informationen finden Sie unter Authentication Overview. IAM-Berechtigungen Erfordert die folgende IAM-Berechtigung für die Ressource name: ces.toolsets.get Weitere Informationen finden Sie in der IAM-Dokumentation.

ImportApp

rpc ImportApp(ImportAppRequest) returns (Operation) Importiert die angegebene App. Autorisierungsbereiche Erfordert einen der folgenden OAuth-Bereiche: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Weitere Informationen finden Sie unter Authentication Overview. IAM-Berechtigungen Erfordert die folgende IAM-Berechtigung für die Ressource parent: ces.apps.import Weitere Informationen finden Sie in der IAM-Dokumentation.

ListAgents

rpc ListAgents(ListAgentsRequest) returns (ListAgentsResponse) Listet Agents in der angegebenen App auf. Autorisierungsbereiche Erfordert einen der folgenden OAuth-Bereiche: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Weitere Informationen finden Sie unter Authentication Overview. IAM-Berechtigungen Erfordert die folgende IAM-Berechtigung für die Ressource parent: ces.agents.list Weitere Informationen finden Sie in der IAM-Dokumentation.

ListAppVersions

rpc ListAppVersions(ListAppVersionsRequest) returns (ListAppVersionsResponse) Listet alle App-Versionen in der angegebenen App auf. Autorisierungsbereiche Erfordert einen der folgenden OAuth-Bereiche: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Weitere Informationen finden Sie unter Authentication Overview. IAM-Berechtigungen Erfordert die folgende IAM-Berechtigung für die Ressource parent: ces.appVersions.list Weitere Informationen finden Sie in der IAM-Dokumentation.

ListApps

rpc ListApps(ListAppsRequest) returns (ListAppsResponse) Listet Apps im angegebenen Projekt und am angegebenen Standort auf. Autorisierungsbereiche Erfordert einen der folgenden OAuth-Bereiche: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Weitere Informationen finden Sie unter Authentication Overview. IAM-Berechtigungen Erfordert die folgende IAM-Berechtigung für die Ressource parent: ces.apps.list Weitere Informationen finden Sie in der IAM-Dokumentation.

ListChangelogs

rpc ListChangelogs(ListChangelogsRequest) returns (ListChangelogsResponse) Listet die Änderungsprotokolle der angegebenen App auf. Autorisierungsbereiche Erfordert einen der folgenden OAuth-Bereiche: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Weitere Informationen finden Sie unter Authentication Overview. IAM-Berechtigungen Erfordert die folgende IAM-Berechtigung für die Ressource parent: ces.changelogs.list Weitere Informationen finden Sie in der IAM-Dokumentation.

ListConversations

rpc ListConversations(ListConversationsRequest) returns (ListConversationsResponse) Listet Unterhaltungen in der angegebenen App auf. Autorisierungsbereiche Erfordert einen der folgenden OAuth-Bereiche: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Weitere Informationen finden Sie unter Authentication Overview. IAM-Berechtigungen Erfordert die folgende IAM-Berechtigung für die Ressource parent: ces.conversations.list Weitere Informationen finden Sie in der IAM-Dokumentation.

ListDeployments

rpc ListDeployments(ListDeploymentsRequest) returns (ListDeploymentsResponse) Listet Bereitstellungen in der angegebenen App auf. Autorisierungsbereiche Erfordert einen der folgenden OAuth-Bereiche: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Weitere Informationen finden Sie unter Authentication Overview. IAM-Berechtigungen Erfordert die folgende IAM-Berechtigung für die Ressource parent: ces.deployments.list Weitere Informationen finden Sie in der IAM-Dokumentation.

ListExamples

rpc ListExamples(ListExamplesRequest) returns (ListExamplesResponse) Listet Beispiele in der angegebenen App auf. Autorisierungsbereiche Erfordert einen der folgenden OAuth-Bereiche: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Weitere Informationen finden Sie unter Authentication Overview. IAM-Berechtigungen Erfordert die folgende IAM-Berechtigung für die Ressource parent: ces.examples.list Weitere Informationen finden Sie in der IAM-Dokumentation.

ListGuardrails

rpc ListGuardrails(ListGuardrailsRequest) returns (ListGuardrailsResponse) Listet die Schutzmaßnahmen in der angegebenen App auf. Autorisierungsbereiche Erfordert einen der folgenden OAuth-Bereiche: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Weitere Informationen finden Sie unter Authentication Overview. IAM-Berechtigungen Erfordert die folgende IAM-Berechtigung für die Ressource parent: ces.guardrails.list Weitere Informationen finden Sie in der IAM-Dokumentation.

ListTools

rpc ListTools(ListToolsRequest) returns (ListToolsResponse) Listet Tools in der angegebenen App auf. Autorisierungsbereiche Erfordert einen der folgenden OAuth-Bereiche: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Weitere Informationen finden Sie unter Authentication Overview. IAM-Berechtigungen Erfordert die folgende IAM-Berechtigung für die Ressource parent: ces.tools.list Weitere Informationen finden Sie in der IAM-Dokumentation.

ListToolsets

rpc ListToolsets(ListToolsetsRequest) returns (ListToolsetsResponse) Listet Toolsets in der angegebenen App auf. Autorisierungsbereiche Erfordert einen der folgenden OAuth-Bereiche: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Weitere Informationen finden Sie unter Authentication Overview. IAM-Berechtigungen Erfordert die folgende IAM-Berechtigung für die Ressource parent: ces.toolsets.list Weitere Informationen finden Sie in der IAM-Dokumentation.

RestoreAppVersion

rpc RestoreAppVersion(RestoreAppVersionRequest) returns (Operation) Stellt die angegebene App-Version wieder her. Dadurch wird eine neue App-Version aus der aktuellen Draft-App erstellt und der aktuelle Draft mit der angegebenen App-Version überschrieben. Autorisierungsbereiche Erfordert einen der folgenden OAuth-Bereiche: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Weitere Informationen finden Sie unter Authentication Overview. IAM-Berechtigungen Erfordert die folgende IAM-Berechtigung für die Ressource name: ces.appVersions.restore Weitere Informationen finden Sie in der IAM-Dokumentation.

UpdateAgent

rpc UpdateAgent(UpdateAgentRequest) returns (Agent) Aktualisiert den angegebenen Agent. Autorisierungsbereiche Erfordert einen der folgenden OAuth-Bereiche: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Weitere Informationen finden Sie unter Authentication Overview. IAM-Berechtigungen Erfordert die folgende IAM-Berechtigung für die Ressource name: ces.agents.update Weitere Informationen finden Sie in der IAM-Dokumentation.

UpdateApp

rpc UpdateApp(UpdateAppRequest) returns (App) Aktualisiert die angegebene App. Autorisierungsbereiche Erfordert einen der folgenden OAuth-Bereiche: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Weitere Informationen finden Sie unter Authentication Overview. IAM-Berechtigungen Erfordert die folgende IAM-Berechtigung für die Ressource name: ces.apps.update Weitere Informationen finden Sie in der IAM-Dokumentation.

UpdateAppVersion
rpc UpdateAppVersion(UpdateAppVersionRequest) returns (AppVersion) Aktualisiert die angegebene App-Version. Autorisierungsbereiche Erfordert einen der folgenden OAuth-Bereiche: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Weitere Informationen finden Sie unter Authentication Overview.

UpdateDeployment

rpc UpdateDeployment(UpdateDeploymentRequest) returns (Deployment) Aktualisiert die angegebene Bereitstellung. Autorisierungsbereiche Erfordert einen der folgenden OAuth-Bereiche: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Weitere Informationen finden Sie unter Authentication Overview. IAM-Berechtigungen Erfordert die folgende IAM-Berechtigung für die Ressource name: ces.deployments.update Weitere Informationen finden Sie in der IAM-Dokumentation.

UpdateExample

rpc UpdateExample(UpdateExampleRequest) returns (Example) Aktualisiert das angegebene Beispiel. Autorisierungsbereiche Erfordert einen der folgenden OAuth-Bereiche: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Weitere Informationen finden Sie unter Authentication Overview. IAM-Berechtigungen Erfordert die folgende IAM-Berechtigung für die Ressource name: ces.examples.update Weitere Informationen finden Sie in der IAM-Dokumentation.

UpdateGuardrail

rpc UpdateGuardrail(UpdateGuardrailRequest) returns (Guardrail) Aktualisiert die angegebene Schutzvorrichtung. Autorisierungsbereiche Erfordert einen der folgenden OAuth-Bereiche: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Weitere Informationen finden Sie unter Authentication Overview. IAM-Berechtigungen Erfordert die folgende IAM-Berechtigung für die Ressource name: ces.guardrails.update Weitere Informationen finden Sie in der IAM-Dokumentation.

UpdateTool

rpc UpdateTool(UpdateToolRequest) returns (Tool) Aktualisiert das angegebene Tool. Autorisierungsbereiche Erfordert einen der folgenden OAuth-Bereiche: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Weitere Informationen finden Sie unter Authentication Overview. IAM-Berechtigungen Erfordert die folgende IAM-Berechtigung für die Ressource name: ces.tools.update Weitere Informationen finden Sie in der IAM-Dokumentation.

UpdateToolset

rpc UpdateToolset(UpdateToolsetRequest) returns (Toolset) Aktualisiert das angegebene Toolset. Autorisierungsbereiche Erfordert einen der folgenden OAuth-Bereiche: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Weitere Informationen finden Sie unter Authentication Overview. IAM-Berechtigungen Erfordert die folgende IAM-Berechtigung für die Ressource name: ces.toolsets.update Weitere Informationen finden Sie in der IAM-Dokumentation.

SessionService

Der Sitzungsdienst bietet APIs für die Interaktion mit CES-Agents.

BidiRunSession

rpc BidiRunSession(BidiSessionClientMessage) returns (BidiSessionServerMessage) Stellt eine bidirektionale Streamingverbindung zum CES-Agenten her. Der Agent verarbeitet kontinuierliche multimodale Eingaben (z.B. Text, Audio) und generiert multimodale Ausgabestreams in Echtzeit. --- Client Request Stream --- Der Client streamt Anfragen in der folgenden Reihenfolge: Initialisierung: Die erste Nachricht muss SessionConfig enthalten. Bei Audiositzungen sollten auch InputAudioConfig und OutputAudioConfig enthalten sein, um Parameter für die Audioverarbeitung und ‑synthese zu definieren. Interaktion: Nachfolgende Nachrichten im Stream SessionInput mit Echtzeit-Nutzereingaben. Beenden: Der Client sollte den Stream halb schließen, wenn keine Nutzereingabe mehr erfolgt. Außerdem sollte es sich halb schließen, wenn es EndSession oder GoAway vom Agenten empfängt. --- Server Response Stream --- Für jede Interaktionsrunde streamt der Agent Nachrichten in der folgenden Reihenfolge: Spracherkennung (erste N Nachrichten): Enthält RecognitionResult, die die bisher erfassten zusammengefügten Sprachsegmente des Nutzers darstellt. Wird nur für Audiositzungen ausgefüllt. Antwort (nächste M Nachrichten): Enthält SessionOutput, die die Antwort des KI-Agents in verschiedenen Modalitäten (z.B. Text, Audio) liefert. Abschluss des Turns (letzte Nachricht des Turns): Enthält SessionOutput mit turn_completed auf „true“ gesetzt. Dies signalisiert das Ende des aktuellen Zuges und enthält DiagnosticInfo mit Ausführungsdetails. --- Best Practices für Audioanzeigen --- 1. Streaming: Streame audio data KONTINUIERLICH, auch wenn es still ist. Empfohlene Chunk-Größe: 40–120 ms (ausgewogenes Verhältnis von Latenz und Effizienz). Wiedergabe und Unterbrechung: Spiele audio responses nach Erhalt ab. Die Wiedergabe muss sofort beendet werden, wenn ein InterruptionSignal empfangen wird (z.B. wenn der Nutzer sich einmischt oder ein neuer Agent antwortet). Autorisierungsbereiche Erfordert einen der folgenden OAuth-Bereiche: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Weitere Informationen finden Sie unter Authentication Overview. IAM-Berechtigungen Erfordert die folgende IAM-Berechtigung für die Ressource session: ces.sessions.bidiRunSession Weitere Informationen finden Sie in der IAM-Dokumentation.

RunSession

rpc RunSession(RunSessionRequest) returns (RunSessionResponse) Startet eine einmalige Interaktion mit dem CES-Agenten in einer Sitzung. Autorisierungsbereiche Erfordert einen der folgenden OAuth-Bereiche: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Weitere Informationen finden Sie unter Authentication Overview. IAM-Berechtigungen Erfordert die folgende IAM-Berechtigung für die Ressource session: ces.sessions.runSession Weitere Informationen finden Sie in der IAM-Dokumentation.

StreamRunSession

rpc StreamRunSession(RunSessionRequest) returns (RunSessionResponse) Leitet eine Interaktion mit dem CES-Agenten ein. Verwendet serverseitiges Streaming, um inkrementelle Ergebnisse und Teilantworten zu liefern, sobald sie generiert werden. Standardmäßig werden vollständige Antworten (z.B. Nachrichten von Callbacks oder vollständige LLM-Antworten) an den Client gesendet, sobald sie verfügbar sind. Wenn Sie das Streaming einzelner Textblöcke direkt aus dem Modell aktivieren möchten, setzen Sie enable_text_streaming auf „true“. Autorisierungsbereiche Erfordert einen der folgenden OAuth-Bereiche: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Weitere Informationen finden Sie unter Authentication Overview. IAM-Berechtigungen Erfordert die folgende IAM-Berechtigung für die Ressource session: ces.sessions.runSession Weitere Informationen finden Sie in der IAM-Dokumentation.

ToolService

Der Tool-Dienst bietet APIs für die Interaktion mit CES-Tools.

ExecuteTool

rpc ExecuteTool(ExecuteToolRequest) returns (ExecuteToolResponse) Führt das angegebene Tool mit den angegebenen Argumenten aus. Autorisierungsbereiche Erfordert einen der folgenden OAuth-Bereiche: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Weitere Informationen finden Sie unter Authentication Overview. IAM-Berechtigungen Erfordert die folgende IAM-Berechtigung für die Ressource parent: ces.tools.execute Weitere Informationen finden Sie in der IAM-Dokumentation.

RetrieveToolSchema

rpc RetrieveToolSchema(RetrieveToolSchemaRequest) returns (RetrieveToolSchemaResponse) Ruft das Schema des angegebenen Tools ab. Das Schema wird für die jeweilige Instanz des Tools dynamisch berechnet. Autorisierungsbereiche Erfordert einen der folgenden OAuth-Bereiche: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Weitere Informationen finden Sie unter Authentication Overview. IAM-Berechtigungen Erfordert die folgende IAM-Berechtigung für die Ressource parent: ces.tools.get Weitere Informationen finden Sie in der IAM-Dokumentation.

RetrieveTools

rpc RetrieveTools(RetrieveToolsRequest) returns (RetrieveToolsResponse) Rufen Sie die Liste der Tools ab, die im angegebenen Toolset enthalten sind. Autorisierungsbereiche Erfordert einen der folgenden OAuth-Bereiche: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Weitere Informationen finden Sie unter Authentication Overview. IAM-Berechtigungen Erfordert die folgende IAM-Berechtigung für die Ressource toolset: ces.toolsets.get Weitere Informationen finden Sie in der IAM-Dokumentation.

WidgetService

Stellt APIs für Widgets zur Interaktion mit CES-APIs bereit.

GenerateChatToken
rpc GenerateChatToken(GenerateChatTokenRequest) returns (GenerateChatTokenResponse) Generiert ein sitzungsbezogenes Token für das Chat-Widget zur Authentifizierung bei Session APIs. Autorisierungsbereiche Erfordert einen der folgenden OAuth-Bereiche: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Weitere Informationen finden Sie unter Authentication Overview.

Aktion

Konfiguration einer Aktion, die vom Tool verwendet werden soll. Hinweis: Dies kann entweder eine Aktion oder ein Vorgang sein. Weitere Informationen finden Sie unter https://cloud.google.com/integration-connectors/docs/entities-operation-action.

Felder
input_fields[]	string Optional. Entitätsfelder, die als Eingaben für den Vorgang verwendet werden sollen. Wenn keine Felder angegeben sind, werden alle Felder der Entität verwendet.
output_fields[]	string Optional. Die Entitätsfelder, die vom Vorgang zurückgegeben werden sollen. Wenn keine Felder angegeben sind, werden alle Felder der Entität zurückgegeben.
Union-Feld action_spec. Spezifikation einer Aktion, die für das zu verwendende Tool konfiguriert werden soll. Für action_spec ist nur einer der folgenden Werte zulässig:
connection_action_id	string ID einer Verbindungsaktion für das zu verwendende Tool.
entity_operation	Action.EntityOperation Konfiguration für den Entitätsvorgang, die vom Tool verwendet werden soll.

EntityOperation

Spezifikation für CRUD-Vorgänge für Entitäten.

Felder
entity_id	string Erforderlich. ID der Entität.
operation	Action.EntityOperation.OperationType Erforderlich. Vorgang, der für die Entität ausgeführt werden soll.

OperationType

Der Vorgang, der für die Entität ausgeführt werden soll.

Enums
OPERATION_TYPE_UNSPECIFIED	Vorgangstyp nicht angegeben. Ungültig. Das Erstellen/Aktualisieren von ConnectorTool schlägt fehl.
LIST	Listenvorgang.
GET	Vorgang abrufen
CREATE	Erstellungsvorgang
UPDATE	Aktualisierungsvorgang.
DELETE	Löschvorgang.

Agent

Ein Agent ist der grundlegende Baustein, der dem Large Language Model (LLM) Anweisungen zur Ausführung bestimmter Aufgaben gibt.

Felder
name	string ID. Die eindeutige Kennung des Agents. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
display_name	string Erforderlich. Anzeigename des KI-Agenten.
description	string Optional. Eine menschenlesbare Beschreibung des KI-Agenten.
model_settings	ModelSettings Optional. Konfigurationen für das LLM-Modell.
instruction	string Optional. Anweisungen für das LLM-Modell, um das Verhalten des KI-Agenten zu steuern.
tools[]	string Optional. Liste der verfügbaren Tools für den Agenten. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
child_agents[]	string Optional. Liste der untergeordneten Agents in der Agent-Baumstruktur. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
before_agent_callbacks[]	Callback Optional. Die Callbacks, die vor dem Aufrufen des Agents ausgeführt werden sollen. Die bereitgestellten Callbacks werden sequenziell in der genauen Reihenfolge ausgeführt, in der sie in der Liste angegeben sind. Wenn ein Callback eine überschriebene Antwort zurückgibt, wird die Ausführung beendet und alle verbleibenden Callbacks werden übersprungen.
after_agent_callbacks[]	Callback Optional. Die Callbacks, die nach dem Aufrufen des Agenten ausgeführt werden sollen. Die bereitgestellten Callbacks werden sequenziell in der genauen Reihenfolge ausgeführt, in der sie in der Liste angegeben sind. Wenn ein Callback eine überschriebene Antwort zurückgibt, wird die Ausführung beendet und alle verbleibenden Callbacks werden übersprungen.
before_model_callbacks[]	Callback Optional. Die Callbacks, die vor dem Aufrufen des Modells ausgeführt werden. Wenn das Modell mehrmals aufgerufen wird, wird der Callback mehrmals ausgeführt. Die bereitgestellten Callbacks werden sequenziell in der genauen Reihenfolge ausgeführt, in der sie in der Liste angegeben sind. Wenn ein Callback eine überschriebene Antwort zurückgibt, wird die Ausführung beendet und alle verbleibenden Callbacks werden übersprungen.
after_model_callbacks[]	Callback Optional. Die Callbacks, die nach dem Aufrufen des Modells ausgeführt werden sollen. Wenn das Modell mehrmals aufgerufen wird, wird der Callback mehrmals ausgeführt. Die bereitgestellten Callbacks werden sequenziell in der genauen Reihenfolge ausgeführt, in der sie in der Liste angegeben sind. Wenn ein Callback eine überschriebene Antwort zurückgibt, wird die Ausführung beendet und alle verbleibenden Callbacks werden übersprungen.
before_tool_callbacks[]	Callback Optional. Die Callbacks, die vor dem Aufrufen des Tools ausgeführt werden sollen. Wenn mehrere Toolaufrufe vorhanden sind, wird der Callback mehrmals ausgeführt. Die bereitgestellten Callbacks werden sequenziell in der genauen Reihenfolge ausgeführt, in der sie in der Liste angegeben sind. Wenn ein Callback eine überschriebene Antwort zurückgibt, wird die Ausführung beendet und alle verbleibenden Callbacks werden übersprungen.
after_tool_callbacks[]	Callback Optional. Die Callbacks, die nach dem Aufrufen des Tools ausgeführt werden sollen. Wenn mehrere Toolaufrufe vorhanden sind, wird der Callback mehrmals ausgeführt. Die bereitgestellten Callbacks werden sequenziell in der genauen Reihenfolge ausgeführt, in der sie in der Liste angegeben sind. Wenn ein Callback eine überschriebene Antwort zurückgibt, wird die Ausführung beendet und alle verbleibenden Callbacks werden übersprungen.
create_time	Timestamp Nur Ausgabe. Zeitstempel für die Erstellung des Agents.
update_time	Timestamp Nur Ausgabe. Zeitstempel der letzten Aktualisierung des Agents.
guardrails[]	string Optional. Liste der Richtlinien für den Agenten. Format: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}
etag	string ETag, mit dem sichergestellt wird, dass sich das Objekt während eines Read-Modify-Write-Vorgangs nicht geändert hat. Wenn das ETag leer ist, werden durch das Update alle gleichzeitigen Änderungen überschrieben.
toolsets[]	Agent.AgentToolset Optional. Liste der Toolsets für den Agenten.
generated_summary	string Nur Ausgabe. Wenn der Agent vom LLM-Assistenten generiert wird, enthält dieses Feld eine beschreibende Zusammenfassung der Generierung.
transfer_rules[]	TransferRule Optional. Regeln für die Agentenübertragung. Wenn mehrere Regeln zutreffen, wird die erste Regel in der Liste verwendet.
validation_errors[]	string Nur Ausgabe. Fehlkonfigurationen oder Fehler im Agent, die sich auf die Qualität des Agenten auswirken können.
Union-Feld agent_type. Der Typ des KI-Agenten. Für agent_type ist nur einer der folgenden Werte zulässig:
llm_agent	Agent.LlmAgent Optional. Der Standard-KI-Agent-Typ.
remote_dialogflow_agent	Agent.RemoteDialogflowAgent Optional. Der Remote-Dialogflow-Agent, der für die Ausführung des Agenten verwendet werden soll. Wenn dieses Feld festgelegt ist, werden alle anderen Eigenschaften auf Agentenebene ignoriert. Hinweis: Wenn sich der Dialogflow-Agent in einem anderen Projekt als die App befindet, sollten Sie dem CES-Dienst-Agent service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com die Rolle roles/dialogflow.client zuweisen.
remote_a2a_agent	Agent.RemoteA2aAgent Optional. Der A2A-Remote-Agent, der für die Ausführung des Agenten verwendet werden soll.

AgentToolset

Ein Toolset mit einer Auswahl seiner Tools.

Felder
toolset	string Erforderlich. Der Ressourcenname des Toolsets. Format: projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
tool_ids[]	string Optional. Die Tool-IDs zum Filtern des Toolsets.

LlmAgent

Dieser Typ hat keine Felder.

Standard-Agent-Typ. Der Agent verwendet Anweisungen und Callbacks, die im Agent angegeben sind, um die Aufgabe mit einem Large Language Model auszuführen.

RemoteA2aAgent

Der Agent, der die Ausführung an einen Remote-A2A-Agenten überträgt.

Felder
a2a_config	RemoteA2aConfig Erforderlich. Die A2A-Verbindungskonfiguration.

RemoteDialogflowAgent

Der Agent, der die Ausführung an einen Remote-Agenten in Dialogflow CX überträgt. Der Dialogflow-Agent verarbeitet nachfolgende Nutzeranfragen, bis die Sitzung oder der Ablauf endet und die Steuerung an den übergeordneten CES-Agent zurückgegeben wird.

Felder
agent	string Erforderlich. Der Ressourcenname des Dialogflow-Agents. Format: projects/{project}/locations/{location}/agents/{agent}
flow_id	string Optional. Die Flow-ID des Flows im Dialogflow-Agenten.
environment_id	string Optional. Die Umgebungs-ID des Dialogflow-KI-Agenten, der für die Ausführung des KI-Agenten verwendet werden soll. Wenn keine Angabe erfolgt, wird die Umgebung „draft“ verwendet.
input_variable_mapping	map<string, string> Optional. Die Zuordnung der Namen der App-Variablen zu den Namen der Dialogflow-Sitzungsparameter, die als Eingabe an den Dialogflow-Agent gesendet werden sollen.
output_variable_mapping	map<string, string> Optional. Die Zuordnung der Namen der Dialogflow-Sitzungsparameter zu den Namen der App-Variablen, die nach Beendigung der Ausführung des Dialogflow-Agenten an den CES-Agenten zurückgesendet werden sollen.
respect_response_interruption_settings	bool Optional. Gibt an, ob die auf Nachrichtenebene konfigurierten Unterbrechungseinstellungen im Dialogflow-Agent berücksichtigt werden sollen. Falsch: Alle Antwortnachrichten des Dialogflow-Agents folgen den Einstellungen für das Unterbrechen auf App-Ebene. Wenn „true“: Nur Antwortnachrichten, bei denen allow_playback_interruption auf „true“ gesetzt ist, können unterbrochen werden. Für alle anderen Nachrichten gelten die Einstellungen für das Unterbrechen auf App-Ebene.
language_code_variable	string Optional. Der Name der Variablen, die den Sprachcode für die Dialogflow-Sitzung enthält. Wenn nicht angegeben, wird der Standardsprachcode des Dialogflow-Agents verwendet.

AgentCard

Die AgentCard enthält wichtige Informationen zu einem Remote-KI-Agenten. Es handelt sich um eine gekürzte Version der AgentCard, die im A2A-Protokoll definiert ist: https://a2a-protocol.org/dev/specification/#441-agentcard.

Felder
name	string Erforderlich. Ein menschenlesbarer Name für den KI-Agenten.
description	string Erforderlich. Eine Beschreibung des Handlungsbereichs/Lösungsraums des KI-Agenten.
supported_interfaces[]	AgentInterface Erforderlich. Geordnete Liste der unterstützten Schnittstellen. Der erste Eintrag wird bevorzugt.
version	string Erforderlich. Die Version des KI-Agenten.
skills[]	AgentSkill Erforderlich. Skills stellen eine Einheit von Fähigkeiten dar, die ein Agent ausführen kann. Das ist vielleicht etwas abstrakt, aber es handelt sich um eine gezieltere Reihe von Aktionen, bei denen der Agent mit hoher Wahrscheinlichkeit erfolgreich sein wird.

AgentInterface

Deklariert eine Kombination aus Ziel-URL, Transport und Protokollversion für die Interaktion mit dem Agent. So können Agenten dieselbe Funktionalität über mehrere Protokollbindungsmechanismen hinweg verfügbar machen.

Felder
url	string Erforderlich. Die URL, unter der diese Schnittstelle verfügbar ist. Muss eine gültige absolute HTTPS-URL in der Produktion sein. Beispiel: „https://api.beispiel.de/a2a/v1“, „https://grpc.beispiel.de/a2a“
protocol_binding	string Erforderlich. Die an dieser URL unterstützte Protokollbindung. Dies ist ein offener Formularstring, der sich leicht für andere Protokollbindungen erweitern lässt. Die offiziell unterstützten Kern-APIs sind JSONRPC, GRPC und HTTP+JSON.
tenant	string Die Mandanten-ID, die in der Anfrage verwendet werden soll, wenn der Agent aufgerufen wird.
protocol_version	string Erforderlich. Die Version des A2A-Protokolls, das von dieser Schnittstelle bereitgestellt wird. Verwenden Sie die neueste unterstützte Nebenversion pro Hauptversion. Beispiele: „0.3“, „1.0“

AgentRegistryDeployment

Konfiguration und Status für die Bereitstellung der Agent Registry.

Felder
agent_registry_service_name	string Optional. Nur Ausgabe. Der Ressourcenname des bereitgestellten Agent Registry-Dienstes. Format: projects/{project}/locations/{location}/services/{service}

AgentSkill

Stellt eine bestimmte Funktion dar, die ein Agent ausführen kann.

Felder
id	string Erforderlich. Eine eindeutige Kennung für die Funktion des KI-Agenten.
name	string Erforderlich. Ein menschenlesbarer Name für den Skill.
description	string Erforderlich. Eine detaillierte Beschreibung des Skills.
tags[]	string Erforderlich. Eine Reihe von Keywords, die die Fähigkeiten des Skills beschreiben.
examples[]	string Beispiel-Prompts oder ‑Szenarien, die diese Skill verarbeiten kann.
input_modes[]	string Die Menge der unterstützten Eingabemedientypen für diesen Skill, die die Standardeinstellungen des Agenten überschreiben.
output_modes[]	string Die Menge der unterstützten Ausgabemedientypen für diesen Skill, die die Standardeinstellungen des Agenten überschreiben.

AgentTool

Stellt ein Tool dar, mit dem der KI-Agent einen anderen KI-Agenten aufrufen kann.

Felder
name	string Erforderlich. Der Name des Agent-Tools.
description	string Optional. Beschreibung des Zwecks des Tools.
agent	string Optional. Der Ressourcenname des KI-Agenten, der der Einstiegspunkt des Tools ist. Format: projects/{project}/locations/{location}/agents/{agent}

AgentTransfer

Stellt ein Ereignis dar, das die Übertragung einer Unterhaltung an einen anderen Kundenservicemitarbeiter angibt.

Felder
target_agent	string Erforderlich. Der KI-Agent, an den die Unterhaltung übertragen wird. Der Agent übernimmt die Unterhaltung ab diesem Punkt. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
display_name	string Nur Ausgabe. Anzeigename des KI-Agenten.

AmbientSoundConfig

Konfiguration für den Umgebungsgeräusch, der mit der synthetisierten Agentenantwort wiedergegeben werden soll, um die Natürlichkeit des Gesprächs zu verbessern.

Felder
volume_gain_db	double Optional. Lautstärkeerhöhung (in dB) der normalen nativen Lautstärke, die durch Umgebungsgeräusche unterstützt wird, im Bereich [-96,0, 16,0]. Wenn dieser Wert nicht festgelegt oder ein Wert von 0,0 (dB) eingestellt ist, erfolgt die Wiedergabe mit der natürlichen Signalamplitude. Bei einem Wert von –6,0 (dB) erfolgt die Wiedergabe mit einer Signalamplitude, die etwa halb so hoch wie die natürliche ist. Bei einem Wert von +6.0 (dB) erfolgt die Wiedergabe mit einer Signalamplitude, die etwa doppelt so hoch wie die natürliche ist. Es wird dringend empfohlen, +10 (dB) nicht zu überschreiten, da es bei einem höheren Wert in der Regel zu keiner effektiven Erhöhung der Lautstärke kommt.
Union-Feld source. Umgebungsgeräusche, die mit der synthetisierten Agent-Antwort wiedergegeben werden sollen, um die Natürlichkeit der Unterhaltung zu verbessern. Für source ist nur einer der folgenden Werte zulässig:
prebuilt_ambient_noise (deprecated)	AmbientSoundConfig.PrebuiltAmbientNoise Dieses Element wird nicht mehr unterstützt. Optional. Eingestellt: prebuilt_ambient_noise wurde zugunsten von prebuilt_ambient_sound eingestellt.
gcs_uri	string Optional. Umgebungsgeräusche als Mono-Kanal-WAV-Datei mit 16 kHz, die in Cloud Storage gespeichert ist. Hinweis: Der CES-Dienst-Agent service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com muss die Berechtigung storage.objects.get für das Cloud Storage-Objekt haben.
prebuilt_ambient_sound	string Optional. Name des integrierten Ambient-Sounds. Gültige Werte sind: - "coffee_shop" - "keyboard" - "keypad" - "hum" - "office_1" - "office_2" - "office_3" - "room_1" - "room_2" - "room_3" - "room_4" - "room_5" - "air_conditioner"

PrebuiltAmbientNoise

Vorgefertigte Umgebungsgeräusche.

Enums
PREBUILT_AMBIENT_NOISE_UNSPECIFIED	Nicht angegeben.
RETAIL_STORE	Umgebungsgeräusche in einem Einzelhandelsgeschäft.
CONVENTION_HALL	Umgebungsgeräusche einer Kongresshalle.
OUTDOOR	Umgebungsgeräusche einer Straße.

ApiAuthentication

Für API-Aufrufe erforderliche Authentifizierungsinformationen.

Felder
Union-Feld auth_config. Die Authentifizierungskonfiguration. Für auth_config ist nur einer der folgenden Werte zulässig:
api_key_config	ApiKeyConfig Optional. Konfiguration für die API-Schlüsselauthentifizierung.
oauth_config	OAuthConfig Optional. Konfiguration für OAuth.
service_agent_id_token_auth_config	ServiceAgentIdTokenAuthConfig Optional. Konfiguration für die ID-Token-Authentifizierung, die vom CES-Service-Agent generiert wird.
service_account_auth_config	ServiceAccountAuthConfig Optional. Konfiguration für die Dienstkontoauthentifizierung.
bearer_token_config	BearerTokenConfig Optional. Konfiguration für die Inhabertoken-Authentifizierung.

ApiKeyConfig

Konfigurationen für die Authentifizierung mit API-Schlüssel.

Felder
key_name	string Erforderlich. Der Parametername oder der Headername des API-Schlüssels. Beispiel: Wenn die API-Anfrage „https://beispiel.de/act?X-Api-Key=“ lautet, ist „X-Api-Key“ der Parametername.
api_key_secret_version	string Erforderlich. Der Name der Secret-Versionsressource des Secret Manager, in der der API-Schlüssel gespeichert ist. Format: projects/{project}/secrets/{secret}/versions/{version} Hinweis: Sie sollten dem CES-Dienst-Agenten service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com die Rolle roles/secretmanager.secretAccessor zuweisen.
request_location	ApiKeyConfig.RequestLocation Erforderlich. Schlüsselposition in der Anfrage.

RequestLocation

Der Speicherort des API-Schlüssels in der Anfrage.

Enums
REQUEST_LOCATION_UNSPECIFIED	Nicht angegeben. Dieser Wert sollte nicht verwendet werden.
HEADER	Stellt den Schlüssel im HTTP-Header dar.
QUERY_STRING	Stellt den Schlüssel im Abfragestring dar.

App

Eine App dient als Container der obersten Ebene für eine Gruppe von Agenten, einschließlich des Root-Agenten und seiner Sub-Agenten sowie der zugehörigen Konfigurationen. Diese Agents arbeiten zusammen, um bestimmte Ziele im Kontext der App zu erreichen.

Felder
name	string ID. Die eindeutige Kennung der App. Format: projects/{project}/locations/{location}/apps/{app}
display_name	string Erforderlich. Anzeigename der App.
description	string Optional. Eine für Menschen lesbare Beschreibung der App.
pinned	bool Optional. Gibt an, ob die App in der App-Liste angepinnt ist.
root_agent	string Optional. Der Root-Agent ist der Einstiegspunkt der App. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
language_settings	LanguageSettings Optional. Spracheinstellungen der App.
time_zone_settings	TimeZoneSettings Optional. Zeitzoneneinstellungen der App.
audio_processing_config	AudioProcessingConfig Optional. Konfiguration der Audioverarbeitung der App.
logging_settings	LoggingSettings Optional. Protokollierungseinstellungen der App.
error_handling_settings	ErrorHandlingSettings Optional. Einstellungen für die Fehlerbehandlung der App.
model_settings	ModelSettings Optional. Die Standardeinstellungen für das LLM-Modell für die App. Einzelne Ressourcen (z.B. Agents, Guardrails) können diese Konfigurationen bei Bedarf überschreiben.
tool_execution_mode	App.ToolExecutionMode Optional. Der Ausführungsmodus des Tools für die App. Wenn nicht angegeben, wird standardmäßig PARALLEL verwendet.
evaluation_metrics_thresholds	EvaluationMetricsThresholds Optional. Die Bewertungs-Schwellenwerte für die App.
variable_declarations[]	App.VariableDeclaration Optional. Die Deklarationen der Variablen.
predefined_variable_declarations[]	App.VariableDeclaration Nur Ausgabe. Die Deklarationen vordefinierter Variablen für die App.
global_instruction	string Optional. Anleitung für alle KI-Agenten in der App. Mit dieser Anleitung können Sie eine stabile Identität oder Persönlichkeit für alle KI-Agenten festlegen.
guardrails[]	string Optional. Liste der Schutzmaßnahmen für die App. Format: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}
data_store_settings	DataStoreSettings Optional. Die Datenspeichereinstellungen für die App.
default_channel_profile	ChannelProfile Optional. Das von der App verwendete Standard-Channelprofil.
metadata	map<string, string> Optional. Metadaten zur App. In diesem Feld können zusätzliche Informationen gespeichert werden, die für die Details oder die beabsichtigte Nutzung der App relevant sind.
create_time	Timestamp Nur Ausgabe. Zeitstempel für die Erstellung der App.
update_time	Timestamp Nur Ausgabe. Zeitstempel der letzten Aktualisierung der App.
etag	string Nur Ausgabe. ETag, mit dem sichergestellt wird, dass sich das Objekt während eines Read-Modify-Write-Vorgangs nicht geändert hat. Wenn das ETag leer ist, werden durch das Update alle gleichzeitigen Änderungen überschrieben.
deployment_count	int32 Nur Ausgabe. Anzahl der Bereitstellungen in der App.
client_certificate_settings	ClientCertificateSettings Optional. Die Standardeinstellungen für Clientzertifikate für die App.
vpc_sc_settings	VpcScSettings Optional. VPC-SC-Einstellungen für die App.
locked	bool Optional. Gibt an, ob die App für Änderungen gesperrt ist. Wenn die App gesperrt ist, werden Änderungen an den App-Ressourcen abgelehnt.
validation_errors[]	string Nur Ausgabe. Fehlkonfigurationen oder Warnungen in der App.
dashboard_settings	DashboardSettings Optional. App-spezifische Dashboard-Einstellungen zum Verknüpfen und Konfigurieren von Contact Center Insights-Dashboards.

ToolExecutionMode

Definiert das Verhalten bei der Tool-Ausführung, wenn der Agent mehrere Tools gleichzeitig auswählt.

Enums
TOOL_EXECUTION_MODE_UNSPECIFIED	Nicht angegebener Modus für die Tool-Ausführung. Die Standardeinstellung ist PARALLEL.
PARALLEL	Wenn mehrere Tools ausgewählt sind, werden sie parallel mit demselben ToolContext ausgeführt.
SEQUENTIAL	Wenn mehrere Tools ausgewählt sind, werden sie nacheinander ausgeführt. Das nächste Tool wird erst ausgeführt, wenn das vorherige Tool abgeschlossen ist. Es kann dann den aktualisierten ToolContext des vorherigen Tools sehen.

VariableDeclaration

Definiert die Struktur und die Metadaten für eine Variable.

Felder
name	string Erforderlich. Der Name der Variablen. Der Name muss mit einem Buchstaben oder Unterstrich beginnen und darf nur Buchstaben, Ziffern oder Unterstriche enthalten.
description	string Erforderlich. Die Beschreibung der Variablen.
schema	Schema Erforderlich. Das Schema der Variablen.

AppSnapshot

Ein Snapshot der App.

Felder
app	App Optional. Die Grundeinstellungen für die App.
agents[]	Agent Optional. Liste der Agents in der App.
tools[]	Tool Optional. Liste der Tools in der App.
examples[]	Example Optional. Liste mit Beispielen in der App.
guardrails[]	Guardrail Optional. Liste der Sicherheitsmaßnahmen in der App.
toolsets[]	Toolset Optional. Liste der Toolsets in der App.

AppVersion

In der Customer Engagement Suite (CES) ist eine App-Version eine Momentaufnahme der App zu einem bestimmten Zeitpunkt. Sie ist unveränderlich und kann nach der Erstellung nicht mehr geändert werden.

Felder
name	string ID. Die eindeutige Kennung der App-Version. Format: projects/{project}/locations/{location}/apps/{app}/versions/{version}
display_name	string Optional. Der Anzeigename der App-Version.
description	string Optional. Die Beschreibung der App-Version.
creator	string Nur Ausgabe. E-Mail-Adresse des Nutzers, der die App-Version erstellt hat.
create_time	Timestamp Nur Ausgabe. Zeitstempel für die Erstellung der App-Version.
update_time	Timestamp Nur Ausgabe. Zeitstempel der letzten Aktualisierung der App-Version.
snapshot	AppSnapshot Nur Ausgabe. Der Snapshot der App, der beim Erstellen der Version aufgenommen wurde.
etag	string Nur Ausgabe. ETag, mit dem sichergestellt wird, dass sich das Objekt während eines Read-Modify-Write-Vorgangs nicht geändert hat. Wenn das ETag leer ist, werden durch das Update alle gleichzeitigen Änderungen überschrieben.

AudioEncoding

AudioEncoding gibt das Codierungsformat für Audiodaten an.

Enums
AUDIO_ENCODING_UNSPECIFIED	Nicht angegebene Audiocodierung.
LINEAR16	16-Bit-Codierung mit linearer Pulscodemodulation (PCM)
MULAW	8-Bit-Samples zur Kompandierung von 14-Bit-Audiosamples mit G.711 PCMU/mu-law.
ALAW	8-Bit-Samples, die 14-Bit-Audio-Samples mit G.711 PCMU/A-Law kompandieren.

AudioProcessingConfig

Konfiguration für die Verarbeitung und Bereitstellung des Ein- und Ausgabesignals.

Felder
synthesize_speech_configs	map<string, SynthesizeSpeechConfig> Optional. Konfiguration der Synthese der Agent-Antwort, Zuordnung vom Sprachcode zu SynthesizeSpeechConfig. Wenn die Konfiguration für den angegebenen Sprachcode nicht gefunden wird, wird die Konfiguration für den Stamm-Sprachcode verwendet. Wenn die Karte beispielsweise „en-us“ und „en“ enthält und der angegebene Sprachcode „en-gb“ ist, wird die Konfiguration „en“ verwendet. Hinweis: Beim Sprachcode wird die Groß-/Kleinschreibung nicht beachtet.
barge_in_config	BargeInConfig Optional. Konfiguriert das Verhalten des Agents für die Unterbrechungsaktivitäten des Nutzers.
inactivity_timeout	Duration Optional. Die Dauer der Nutzerinaktivität (keine Sprache oder Interaktion), bevor der Agent den Nutzer auffordert, die Interaktion fortzusetzen. Wenn nicht festgelegt, wird der Nutzer vom Kundenservicemitarbeiter nicht aufgefordert, die Interaktion fortzusetzen.
ambient_sound_config	AmbientSoundConfig Optional. Konfiguration für den Umgebungsgeräusch, der mit der synthetisierten Agentenantwort wiedergegeben werden soll, um die Natürlichkeit des Gesprächs zu verbessern.
custom_voice_samples[]	CustomVoiceSample Optional. Konfiguriert benutzerdefinierte Sprachbeispiele für das Klonen von Stimmen.

AudioRecordingConfig

Konfiguration für die Aufzeichnung von Audiointeraktionen.

Felder
gcs_bucket	string Optional. Der Cloud Storage-Bucket, in dem die Audioaufzeichnungen der Sitzung gespeichert werden. Der URI muss mit „gs://“ beginnen. Wählen Sie einen Bucket-Standort aus, der Ihren Anforderungen an den Datenstandort entspricht. Hinweis: Wenn sich der Cloud Storage-Bucket in einem anderen Projekt als der App befindet, sollten Sie dem CES-Dienst-Agent service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com die Berechtigung storage.objects.create gewähren.
gcs_path_prefix	string Optional. Das Cloud Storage-Pfadpräfix für Audioaufnahmen. Dieses Präfix kann die folgenden Platzhalter enthalten, die zur Laufzeit dynamisch ersetzt werden: – $project: Projekt-ID – $location: App-Standort – $app: App-ID – $date: Sitzungsdatum im Format JJJJ-MM-TT – $session: Sitzungs-ID Wenn das Pfadpräfix nicht angegeben ist, wird das Standardpräfix $project/$location/$app/$date/$session/ verwendet.

BargeInConfig

Konfiguration für die Verarbeitung von Nutzerunterbrechungen.

Felder
disable_barge_in (deprecated)	bool Dieses Element wird nicht mehr unterstützt. Optional. Eingestellt: disable_barge_in wird zugunsten von disable_barge_in_control in ChannelProfile eingestellt. Deaktiviert das Unterbrechen des Agents durch den Nutzer, während der Agent spricht. Wenn „true“ festgelegt ist, werden Nutzereingaben während der Wiedergabe der Agent-Antwort ignoriert.
barge_in_awareness	bool Optional. Wenn diese Option aktiviert ist, passt der Agent seine nächste Antwort an die Annahme an, dass der Nutzer die vorherige Nachricht des Agents nicht vollständig gehört hat. Diese Funktion sollte nicht in Szenarien verwendet werden, in denen die Antworten des Kundenservicemitarbeiters visuell dargestellt werden.

BatchDeleteConversationsRequest

Anfragenachricht für AgentService.BatchDeleteConversations.

Felder
parent	string Erforderlich. Der Ressourcenname der App, aus der Unterhaltungen gelöscht werden sollen. Format: projects/{project}/locations/{location}/apps/{app}
conversations[]	string Erforderlich. Die Ressourcennamen der zu löschenden Unterhaltungen.

BatchDeleteConversationsResponse

Antwortnachricht für AgentService.BatchDeleteConversations.

Felder
deleted_conversations[]	string Die Liste der Unterhaltungen, die erfolgreich gelöscht wurden.
failed_conversations[]	string Die Liste der Unterhaltungen, die nicht gelöscht werden konnten.
error_messages[]	string Optional. Eine Liste der Fehlermeldungen, die mit Chats verknüpft sind, die nicht gelöscht werden konnten.

BearerTokenConfig

Konfigurationen für die Authentifizierung mit einem Inhabertoken.

Felder
token	string Erforderlich. Das Inhabertoken. Muss das Format $context.variables.<name_of_variable> aufweisen.

BidiSessionClientMessage

Die Nachricht auf oberster Ebene, die vom Client an die Methode SessionService.BidiRunSession gesendet wird.

Felder
Union-Feld message_type. Der Typ der Nachricht. Für message_type ist nur einer der folgenden Werte zulässig:
config	SessionConfig Optional. Die erste Konfigurationsnachricht für die Sitzung.
realtime_input	SessionInput Optional. Echtzeiteingabe für die Sitzung.

BidiSessionServerMessage

Die Nachricht der obersten Ebene, die von der Methode SessionService.BidiRunSession zurückgegeben wird.

Felder
Union-Feld message_type. Der Typ der Nachricht. Für message_type ist nur einer der folgenden Werte zulässig:
session_output	SessionOutput Optional. Verarbeitungsergebnis des CES-Kundenservicemitarbeiters.
recognition_result	RecognitionResult Optional. Echtzeit-Spracherkennungsergebnis für die Audioeingabe.
interruption_signal	InterruptionSignal Optional. Gibt an, dass die Audioantwort des Agenten unterbrochen wurde.
end_session	EndSession Optional. Gibt an, dass die Sitzung beendet wurde.
go_away	GoAway Optional. Gibt an, dass die Verbindung zum Server bald getrennt wird und der Client die Verbindung halb schließen und neu starten sollte.

BigQueryExportSettings

Einstellungen, die das Verhalten des BigQuery-Exports für die App beschreiben.

Felder
enabled	bool Optional. Gibt an, ob der BigQuery-Export aktiviert ist.
project	string Optional. Die Projekt-ID des BigQuery-Datasets, in das die Daten exportiert werden sollen. Hinweis: Wenn sich das BigQuery-Dataset in einem anderen Projekt als die App befindet, sollten Sie dem CES-Dienst-Agent service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com die Rolle roles/bigquery.admin zuweisen.
dataset	string Optional. Die Dataset-ID von BigQuery, in die die Daten exportiert werden sollen.

Blob

Stellt eine Blob-Eingabe oder -Ausgabe in der Konversation dar.

Felder
mime_type	string Erforderlich. Der IANA-Standard-MIME-Typ der Quelldaten.
data	bytes Erforderlich. Rohbyte des Blobs.

Rückruf

Ein Callback definiert die benutzerdefinierte Logik, die in verschiedenen Phasen der Agenteninteraktion ausgeführt werden soll.

Felder
description	string Optional. Eine menschenlesbare Beschreibung des Rückrufs.
disabled	bool Optional. Gibt an, ob der Rückruf deaktiviert ist. Deaktivierte Rückrufe werden vom Kundenservicemitarbeiter ignoriert.
proactive_execution_enabled	bool Optional. Wenn aktiviert, wird der Callback auch für Zwischenausgaben des Modells ausgeführt. Diese Einstellung wirkt sich nur auf den „After Model“-Callback aus. VORSICHTIG AKTIVIEREN. Normalerweise muss „after_model_callback“ erst nach dem Empfang aller Modellantworten ausgeführt werden. Die Aktivierung der proaktiven Ausführung kann sich negativ auf die Ausführungskosten und die Latenz auswirken und sollte nur in seltenen Fällen aktiviert werden.
Union-Feld callback. Der auszuführende Callback. Für callback ist nur einer der folgenden Werte zulässig:
python_code	string Erforderlich. Der Python-Code, der für den Callback ausgeführt werden soll.

Änderungsprotokoll

Änderungsprotokolle stellen eine Änderung an der App oder an einer Ressource in der App dar.

Felder
name	string ID. Die eindeutige Kennung des Änderungsprotokolls. Format: projects/{project}/locations/{location}/apps/{app}/changelogs/{changelog}
author	string Nur Ausgabe. E‑Mail-Adresse des Autors der Änderung.
display_name	string Nur Ausgabe. Anzeigename der Änderung. In der Regel sollte es sich um den Anzeigenamen der geänderten Ressource handeln.
description	string Nur Ausgabe. Beschreibung der Änderung, in der in der Regel die geänderten Felder in der Ressource angegeben werden.
resource	string Nur Ausgabe. Die Ressource, die geändert wurde.
resource_type	string Nur Ausgabe. Der Typ der Ressource, die geändert wurde.
action	string Nur Ausgabe. Die Aktion, die für die Ressource ausgeführt wurde.
original_resource	Struct Nur Ausgabe. Die ursprüngliche Ressource vor der Änderung.
new_resource	Struct Nur Ausgabe. Die neue Ressource nach der Änderung.
dependent_resources[]	Struct Nur Ausgabe. Die abhängigen Ressourcen, die geändert wurden.
create_time	Timestamp Nur Ausgabe. Der Zeitpunkt, zu dem die Änderung vorgenommen wurde.
sequence_number	int64 Nur Ausgabe. Die monoton steigende Sequenznummer des Änderungsprotokolls.

ChannelProfile

Mit einem ChannelProfile wird das Verhalten des Agenten für einen bestimmten Kommunikationskanal wie die Web-UI oder Telefonie konfiguriert.

Felder
profile_id	string Optional. Die eindeutige Kennung des Channelprofils.
channel_type	ChannelProfile.ChannelType Optional. Der Typ des Channelprofils.
persona_property	ChannelProfile.PersonaProperty Optional. Das Persona-Attribut des Kanalprofils.
web_widget_config	ChannelProfile.WebWidgetConfig Optional. Die Konfiguration für das Web-Widget.
whatsapp_config	ChannelProfile.WhatsAppConfig Optional. Konfiguration speziell für WhatsApp-Bereitstellungen.
instagram_config	ChannelProfile.InstagramConfig Optional. Konfiguration speziell für Instagram-Bereitstellungen.
disable_dtmf	bool Optional. Gibt an, ob DTMF (Dual-Tone Multi-Frequency) deaktiviert werden soll.
disable_barge_in_control	bool Optional. Gibt an, ob die Funktion zum Unterbrechen von Nutzeranfragen in der Unterhaltung deaktiviert werden soll. – true: Nutzerunterbrechungen sind deaktiviert, während der Agent spricht. – false: Der Agent behält die automatische Kontrolle darüber, wann der Nutzer unterbrechen kann.
noise_suppression_level	string Optional. Der Grad der Geräuschunterdrückung des Kanalprofils. Mögliche Werte sind „low“, „moderate“, „high“ und „very_high“.

ChannelType

Der Typ des Channelprofils.

Enums
UNKNOWN	Unbekannter Kanaltyp.
WEB_UI	Webbenutzeroberflächen-Channel
API	API-Channel.
TWILIO	Twilio-Channel
GOOGLE_TELEPHONY_PLATFORM	Google Telephony Platform-Kanal.
CONTACT_CENTER_AS_A_SERVICE	Contact Center as a Service (CCaaS)
CONTACT_CENTER_AS_A_SERVICE_CHAT	Contact Center as a Service (CCaaS Chat)
FIVE9	Five9-Channel.
CONTACT_CENTER_INTEGRATION	Kanal für die Contact-Center-Integration von Drittanbietern.
WHATSAPP	WhatsApp-Kanal.
INSTAGRAM	Instagram-Kanal

InstagramConfig

Konfiguration speziell für Instagram-Bereitstellungen.

Felder
instagram_account_id	string Erforderlich. Die Instagram-Konto-ID.
display_name	string Nur Ausgabe. Der abgerufene Name der Meta-Unternehmensseite.
thumbnail_url	string Nur Ausgabe. Die abgerufene Miniaturansicht-URL des Meta-Unternehmensprofils.
description	string Nur Ausgabe. Die Beschreibung der Meta-Unternehmensseite oder des Meta-Unternehmensprofils.

PersonaProperty

Stellt die Persona-Eigenschaft eines Channels dar.

Felder
persona	ChannelProfile.PersonaProperty.Persona Optional. Die Persona des Kanals.

Persona

Die Persona des Kanals.

Enums
UNKNOWN	UNKNOWN-Persona.
CONCISE	Der Agent hält die Antworten kurz und prägnant.
CHATTY	Der KI-Agent liefert zusätzlichen Kontext, Erklärungen und Details.

WebWidgetConfig

Nachricht für die Konfiguration des Web-Widgets.

Felder
modality	ChannelProfile.WebWidgetConfig.Modality Optional. Die Modalität des Web-Widgets.
theme	ChannelProfile.WebWidgetConfig.Theme Optional. Das Design des Web-Widgets.
web_widget_title	string Optional. Der Titel des Web-Widgets.
security_settings	ChannelProfile.WebWidgetConfig.SecuritySettings Optional. Die Sicherheitseinstellungen des Web-Widgets.

Modalität

Modalität des Web-Widgets.

Enums
MODALITY_UNSPECIFIED	Unbekannte Modalität.
CHAT_AND_VOICE	Das Widget unterstützt sowohl Chat- als auch Spracheingabe.
VOICE_ONLY	Das Widget unterstützt nur Spracheingabe.
CHAT_ONLY	Das Widget unterstützt nur Chateingaben.
CHAT_VOICE_AND_VIDEO	Das Widget unterstützt Chat-, Sprach- und Videoeingaben.

SecuritySettings

Sicherheitseinstellungen für das Web-Widget.

Felder
enable_public_access	bool Optional. Gibt an, ob der öffentliche Zugriff auf das Web-Widget aktiviert ist. Wenn true, ist das Web-Widget öffentlich zugänglich. Wenn false, muss das Web-Widget in Ihr eigenes Authentifizierungs- und Autorisierungssystem integriert werden, um gültige Anmeldedaten für den Zugriff auf den CES-Agent zurückzugeben.
enable_origin_check	bool Optional. Gibt an, ob die Ursprungsprüfung für das Web-Widget aktiviert ist. Wenn true, prüft das Web-Widget den Ursprung der Website, auf der das Web-Widget geladen wird. Das Laden ist nur für denselben Ursprung oder einen der zulässigen Ursprünge zulässig.
allowed_origins[]	string Optional. Die Ursprünge, die das Web-Widget hosten dürfen. Ein Ursprung wird durch RFC 6454 definiert. Wenn das Feld leer ist, sind alle Ursprünge zulässig. Es sind maximal 100 Ursprünge zulässig. Beispiel: „https://beispiel.de“
enable_recaptcha	bool Optional. Gibt an, ob die reCAPTCHA-Überprüfung für das Web-Widget aktiviert ist.

Design

Design des Web-Widgets.

Enums
THEME_UNSPECIFIED	Unbekanntes Thema.
LIGHT	Helles Design
DARK	Dunkles Design

WhatsAppConfig

Konfiguration speziell für WhatsApp-Bereitstellungen.

Felder
waba_id	string Erforderlich. Die WhatsApp Business-Konto-ID.
phone_number_id	string Erforderlich. Die Meta-Telefonnummer-ID.
phone_number	string Optional. Die Telefonnummer im E.164-Format.
display_name	string Nur Ausgabe. Der abgerufene Name der Meta-Unternehmensseite.
thumbnail_url	string Nur Ausgabe. Die abgerufene Miniaturansicht-URL des Meta-Unternehmensprofils.
description	string Nur Ausgabe. Die Beschreibung der Meta-Unternehmensseite oder des Meta-Unternehmensprofils.

Chunk

Ein Inhaltsblock in einer Nachricht.

Felder
Union-Feld data. Daten in Blöcke aufteilen. Für data ist nur einer der folgenden Werte zulässig:
text	string Optional. Textdaten.
transcript	string Optional. Das mit dem Audio verknüpfte Transkript.
blob	Blob Optional. Blob-Daten.
payload	Struct Optional. Benutzerdefinierte Nutzlastdaten.
image	Image Optional. Bilddaten.
tool_call	ToolCall Optional. Anfrage zur Toolausführung.
tool_response	ToolResponse Optional. Antwort auf die Toolausführung.
agent_transfer	AgentTransfer Optional. Ereignis für die Übertragung von Agenten.
updated_variables	Struct Ein Struct stellt Variablen dar, die in der Unterhaltung aktualisiert wurden, wobei die Variablennamen als Schlüssel verwendet werden.
default_variables	Struct Ein Struct stellt Standardvariablen zu Beginn der Unterhaltung dar, die nach Variablennamen sortiert sind.

Zitate

Zitationen, die mit der Antwort des KI-Agenten verknüpft sind.

Felder
cited_chunks[]	Citations.CitedChunk Liste der zitierten Informationen.
inline_citations[]	Citations.InlineCitation Optional. Liste der Inline-Quellenangaben in der Antwort des Agenten.

CitedChunk

Zitierte Information.

Felder
uri	string URI, der für die Quellenangabe verwendet wird.
title	string Titel des zitierten Dokuments.
text	string Für die Quellenangabe verwendeter Text.
requires_attribution	bool Gibt an, ob für diese Quellenangabe eine Quellenangabe für Endnutzer erforderlich ist.

InlineCitation

Eine Inline-Zitation im Antworttext.

Felder
start_index	int32 Der Startindex (in Byte) des Textsegments in der Antwort des KI-Agents.
end_index	int32 Der Endindex (in Byte) des Textsegments in der Antwort des KI-Agenten.
cited_chunk_indices[]	int32 Die Indexe der zitierten Chunks, die dieses Textsegment untermauern. Die Indexe beziehen sich auf die Elemente in cited_chunks.

ClientCertificateSettings

Einstellungen für benutzerdefinierte Clientzertifikate.

Felder
tls_certificate	string Erforderlich. Das im PEM-Format codierte TLS-Zertifikat. Dieser String muss die Zeilen für den Beginn der Kopfzeile und das Ende der Fußzeile enthalten.
private_key	string Erforderlich. Der Name der Secret-Versionsressource des Secret Manager, in der der private Schlüssel im PEM-Format gespeichert ist. Format: projects/{project}/secrets/{secret}/versions/{version}
passphrase	string Optional. Der Name der SecretManager-Secret-Versionsressource, in der die Passphrase zum Entschlüsseln des privaten Schlüssels gespeichert ist. Sollte nicht festgelegt werden, wenn der private Schlüssel nicht verschlüsselt ist. Format: projects/{project}/secrets/{secret}/versions/{version}

ClientFunction

Stellt eine clientseitige Funktion dar, die der KI-Agent aufrufen kann. Wenn das Tool vom Agenten ausgewählt wird, wird die Steuerung an den Client übergeben. Der Client ist für die Ausführung der Funktion und die Rückgabe des Ergebnisses als ToolResponse verantwortlich, um die Interaktion mit dem Agent fortzusetzen.

Felder
name	string Erforderlich. Der Funktionsname.
description	string Optional. Die Funktionsbeschreibung.
parameters	Schema Optional. Das Schema der Funktionsparameter.
response	Schema Optional. Das Schema der Funktionsantwort.

CloudLoggingSettings

Einstellungen zur Beschreibung des Cloud Logging-Verhaltens für die App.

Felder
enable_cloud_logging	bool Optional. Gibt an, ob Cloud Logging für die Sitzungen aktiviert werden soll.

CodeBlock

Ein Codeblock, der anstelle eines echten Tool-Aufrufs ausgeführt werden soll.

Felder

python_code

string Erforderlich. Python-Code, der im Tool-Fakemodus aufgerufen wird. Erwartete Python-Funktionssignatur: Um alle Tool-Aufrufe abzufangen: def fake_tool_call(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: Um einen bestimmten Tool-Aufruf abzufangen: def fake_{tool_id}(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: Wenn die Funktion „None“ zurückgibt, wird stattdessen das echte Tool aufgerufen.

ConnectorTool

Mit einem ConnectorTool können Verbindungen zu verschiedenen Integrationen hergestellt werden. Weitere Informationen finden Sie unter https://cloud.google.com/integration-connectors/docs/overview.

Felder
connection	string Erforderlich. Der vollständige Ressourcenname der referenzierten Integration Connectors-Verbindung. Format: projects/{project}/locations/{location}/connections/{connection}
action	Action Erforderlich. Aktion für das zu verwendende Tool.
auth_config	EndUserAuthConfig Optional. Konfiguriert, wie die Authentifizierung in Integration Connectors gehandhabt wird. Standardmäßig wird eine Administratorauthentifizierung in den Integration Connectors API-Anfragen übergeben. Sie können sie mit einer anderen Endnutzerauthentifizierungskonfiguration überschreiben. Hinweis: Für die Verbindung muss die Authentifizierungsüberschreibung aktiviert sein, damit Sie hier eine EUC-Konfiguration angeben können. Andernfalls schlägt die Erstellung des Connector-Tools fehl. Weitere Informationen finden Sie unter https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override.
name	string Optional. Der Name des Tools, das vom Agent verwendet werden kann, um zu entscheiden, ob dieses ConnectorTool aufgerufen werden soll.
description	string Optional. Die Beschreibung des Tools, anhand derer der Agent entscheiden kann, ob dieses ConnectorTool aufgerufen werden soll.

ConnectorToolset

Ein Toolset, mit dem Tools aus einer Integration Connectors-Verbindung generiert werden.

Felder
connection	string Erforderlich. Der vollständige Ressourcenname der referenzierten Integration Connectors-Verbindung. Format: projects/{project}/locations/{location}/connections/{connection}
auth_config	EndUserAuthConfig Optional. Konfiguriert, wie die Authentifizierung in Integration Connectors gehandhabt wird. Standardmäßig wird eine Administratorauthentifizierung in den Integration Connectors API-Anfragen übergeben. Sie können sie mit einer anderen Endnutzerauthentifizierungskonfiguration überschreiben. Hinweis: Für die Verbindung muss die Authentifizierungsüberschreibung aktiviert sein, damit hier eine EUC-Konfiguration angegeben werden kann. Andernfalls schlägt die Toolset-Erstellung fehl. Weitere Informationen finden Sie unter https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override.
connector_actions[]	Action Erforderlich. Die Liste der Connector-Aktionen/Entitätsvorgänge, für die Tools generiert werden sollen.

Unterhaltung

Eine Unterhaltung stellt eine Interaktion zwischen einem Endnutzer und der CES-App dar.

Felder
name	string ID. Die eindeutige Kennung des Chats. Format: projects/{project}/locations/{location}/apps/{app}/conversations/{conversation}
start_time	Timestamp Nur Ausgabe. Zeitstempel für die Erstellung der Unterhaltung.
end_time	Timestamp Nur Ausgabe. Zeitstempel für den Abschluss der Unterhaltung.
turns[]	Conversation.Turn Erforderlich. Die Schritte in der Unterhaltung.
turn_count	int32 Nur Ausgabe. Die Anzahl der Züge in der Unterhaltung.
channel_type (deprecated)	Conversation.ChannelType Dieses Element wird nicht mehr unterstützt. VERWORFEN. Verwende stattdessen input_types.
source	Conversation.Source Nur Ausgabe. Geben Sie die Quelle der Unterhaltung an.
input_types[]	Conversation.InputType Nur Ausgabe. Die Eingabetypen der Unterhaltung.
entry_agent	string Nur Ausgabe. Der Agent, der die Unterhaltung ursprünglich bearbeitet. Wenn nichts angegeben ist, wird die Unterhaltung vom Stamm-Agent bearbeitet. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
deployment	string Nur Ausgabe. Die Bereitstellung der App, die zum Verarbeiten der Unterhaltung verwendet wird. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
app_version	string Nur Ausgabe. Die Version der App, die zum Verarbeiten der Unterhaltung verwendet wurde. Format: projects/{project}/locations/{location}/apps/{app}/versions/{version}
language_code	string Nur Ausgabe. Der Sprachcode der Unterhaltung.
messages[] (deprecated)	Message Dieses Element wird nicht mehr unterstützt. Verworfen Verwenden Sie stattdessen Züge.

ChannelType

Der Kanaltyp der Unterhaltung.

Enums
CHANNEL_TYPE_UNSPECIFIED	Nicht angegebener Kanaltyp.
TEXT	Die Unterhaltung enthält nur Textnachrichten zwischen dem Endnutzer und dem KI-Agenten.
AUDIO	Die Unterhaltung enthält Audio-Nachrichten zwischen dem Endnutzer und dem Agent.
MULTIMODAL	Die multimodalen Nachrichten (z.B. Bilder) in der Unterhaltung zwischen dem Endnutzer und dem Agent.

InputType

Typ der Eingabenachricht.

Enums
INPUT_TYPE_UNSPECIFIED	Nicht angegebener Eingabetyp.
INPUT_TYPE_TEXT	Texteingabe.
INPUT_TYPE_EVENT	Ereigniseingabe
INPUT_TYPE_AUDIO	Audioeingabe
INPUT_TYPE_IMAGE	Bildeingabe
INPUT_TYPE_BLOB	Blob-Eingabe.
INPUT_TYPE_TOOL_RESPONSE	Eingabe für die Antwort des Client-Funktionstools.
INPUT_TYPE_VARIABLES	Eingabe von Variablen.

Quelle

Die Quelle der Unterhaltung.

Enums
SOURCE_UNSPECIFIED	Nicht angegebene Quelle.
LIVE	Die Unterhaltung stammt vom Endnutzer.
SIMULATOR	Die Unterhaltung stammt aus dem Simulator.
EVAL	Die Unterhaltung stammt aus der Bewertung.
AGENT_TOOL	Die Unterhaltung stammt von einem Agent-Tool. Mit dem Agent-Tool wird der Agent in einer separaten Sitzung ausgeführt, die zu Test- und Debuggingzwecken beibehalten wird.

Runde

Alle Informationen zu einem einzelnen Zug in der Unterhaltung.

Felder
messages[]	Message Optional. Liste der Nachrichten in der Unterhaltungsrunde, einschließlich Nutzereingabe, Agent-Antworten und Zwischenereignissen während der Verarbeitung.
root_span	Span Optional. Der Stamm-Span der Aktionsverarbeitung.
user_intended_text	string Optional. Der beabsichtigte Ground-Truth-Text des simulierten Anrufers (Polysynth). Wird nur ausgefüllt, wenn Messwerte für die Wortfehlerrate aktiviert sind.

ConversationLoggingSettings

Einstellungen zur Beschreibung des Verhaltens beim Aufzeichnen von Unterhaltungen für die App.

Felder
disable_conversation_logging	bool Optional. Gibt an, ob das Logging von Unterhaltungen für die Sitzungen deaktiviert werden soll.
retention_window	Duration Optional. Legt die Aufbewahrungsdauer für den Chat fest. Wenn nicht festgelegt, wird die Unterhaltung 365 Tage lang aufbewahrt.

CreateAgentRequest

Felder
parent	string Erforderlich. Der Ressourcenname der App, in der ein KI-Agent erstellt werden soll.
agent_id	string Optional. Die für den Agenten zu verwendende ID, die als letzte Komponente des Ressourcennamens des Agenten verwendet wird. Wenn nicht angegeben, wird dem Agent automatisch eine eindeutige ID zugewiesen.
agent	Agent Erforderlich. Der zu erstellende Agent.

CreateAppRequest

Anfragenachricht für AgentService.CreateApp.

Felder
parent	string Erforderlich. Der Ressourcenname des Standorts, an dem eine App erstellt werden soll.
app_id	string Optional. Die für die App zu verwendende ID, die als letzte Komponente des Ressourcennamens der App verwendet wird. Wenn nicht angegeben, wird der App automatisch eine eindeutige ID zugewiesen.
app	App Erforderlich. Die zu erstellende App.

CreateAppVersionRequest

Anfragenachricht für AgentService.CreateAppVersion

Felder
parent	string Erforderlich. Der Ressourcenname der App, in der eine App-Version erstellt werden soll.
app_version_id	string Optional. Die für die App-Version zu verwendende ID, die als letzte Komponente des Ressourcennamens der App-Version verwendet wird. Wenn nicht angegeben, wird der App-Version automatisch eine eindeutige ID zugewiesen.
app_version	AppVersion Erforderlich. Die zu erstellende App-Version.

CreateDeploymentRequest

Anfragenachricht für AgentService.CreateDeployment.

Felder
parent	string Erforderlich. Die übergeordnete App. Format: projects/{project}/locations/{location}/apps/{app}
deployment_id	string Optional. Die für das Deployment zu verwendende ID, die als letzte Komponente des Ressourcennamens des Deployments verwendet wird. Wenn nicht angegeben, wird für die Bereitstellung automatisch eine eindeutige ID zugewiesen.
deployment	Deployment Erforderlich. Die zu erstellende Bereitstellung.

CreateExampleRequest

Anfragenachricht für AgentService.CreateExample.

Felder
parent	string Erforderlich. Der Ressourcenname der App, in der ein Beispiel erstellt werden soll.
example_id	string Optional. Die für das Beispiel zu verwendende ID, die als letzte Komponente des Ressourcennamens des Beispiels verwendet wird. Wenn nicht angegeben, wird dem Beispiel automatisch eine eindeutige ID zugewiesen.
example	Example Erforderlich. Das zu erstellende Beispiel.

CreateGuardrailRequest

Anfragenachricht für AgentService.CreateGuardrail.

Felder
parent	string Erforderlich. Der Ressourcenname der App, in der eine Leitplanke erstellt werden soll.
guardrail_id	string Optional. Die für die Richtlinie zu verwendende ID, die als letzte Komponente des Ressourcennamens der Richtlinie verwendet wird. Wenn nicht angegeben, wird automatisch eine eindeutige ID für die Schutzvorrichtung zugewiesen.
guardrail	Guardrail Erforderlich. Die zu erstellende Guardrail.

CreateToolRequest

Anfragenachricht für AgentService.CreateTool.

Felder
parent	string Erforderlich. Der Ressourcenname der App, in der ein Tool erstellt werden soll.
tool_id	string Optional. Die für das Tool zu verwendende ID, die als letzte Komponente des Ressourcennamens des Tools verwendet wird. Wenn nicht angegeben, wird dem Tool automatisch eine eindeutige ID zugewiesen.
tool	Tool Erforderlich. Das zu erstellende Tool.

CreateToolsetRequest

Anfragenachricht für AgentService.CreateToolset.

Felder
parent	string Erforderlich. Der Ressourcenname der App, in der ein Toolset erstellt werden soll.
toolset_id	string Optional. Die für das Toolset zu verwendende ID, die als letzte Komponente des Ressourcennamens des Toolsets verwendet wird. Wenn nicht angegeben, wird dem Toolset automatisch eine eindeutige ID zugewiesen.
toolset	Toolset Erforderlich. Das zu erstellende Toolset.

CustomVoiceSample

Konfiguration für ein benutzerdefiniertes Sprachbeispiel, das zum Klonen von Stimmen verwendet wird.

Felder
name	string Optional. Der benutzerdefinierte Name für das Custom Voice-Beispiel.
voice_sample_gcs_uri	string Optional. Der Cloud Storage-URI des Audio-Samples für das Klonen der Stimme. Das Audiobeispiel sollte eine Mono-WAV-Datei mit 24 kHz sein.
consent_audio_gcs_uri	string Optional. Einwilligung zur Verwendung von Audioinhalten für das Klonen von Stimmen einholen.
voice_instruction	string Optional. Anweisungen in natürlicher Sprache für Stil, Ton, Tempo oder Aussprache.
preview_audio_content	bytes Nur Ausgabe. Synthetisiertes Vorschau-Audio für die benutzerdefinierte Stimme im kanonischen WAV-Format (LINEAR16, 24 kHz, 16 Bit, Mono).
preview_text	string Optional. Text zum Synthetisieren von Vorschau-Audio für benutzerdefinierte Stimmen.
warnings[]	CustomVoiceSample.Warning Nur Ausgabe. Warnmeldungen, die während der Verarbeitung des Sprachklons aufgetreten sind, z.B. ein niedriger Audiopegel.
voice_instruction_mode	CustomVoiceSample.VoiceInstructionMode Optional. Anweisungsmodus für die Sprachprobe. Wenn nicht angegeben, wird standardmäßig NO_INSTRUCTION verwendet.

VoiceInstructionMode

Anweisungsmodus für die Sprachprobe.

Enums
VOICE_INSTRUCTION_MODE_UNSPECIFIED	Nicht angegebener Anweisungsmodus. Die Standardeinstellung ist NO_INSTRUCTION.
NO_INSTRUCTION	Es werden keine Sprachbefehle verwendet.
GENERATE_INSTRUCTION	Die Sprachanweisung wird automatisch von KI aus der Audio-Stichprobe generiert.
CUSTOM_INSTRUCTION	Benutzerdefinierte Sprachanweisung des Nutzers.

Warnung

Eine Warnmeldung, die bei der Verarbeitung der Sprachprobe ausgegeben wird.

Felder
message	string Nur Ausgabe. Eine menschenlesbare Beschreibung der Warnung.
type	CustomVoiceSample.Warning.WarningType Nur Ausgabe. Der Typ der Warnung.

WarningType

Art der Warnung, die bei der Verarbeitung der Sprachprobe aufgetreten ist.

Enums
WARNING_TYPE_UNSPECIFIED	Nicht angegebener Warnungstyp.
LOW_AUDIO_LEVEL	Der Audiopegel der Sprachprobe ist zu niedrig (z.B. niedrige RMS-Amplitude).

DashboardSettings

Einstellungen für Dashboards, die mit der App verknüpft sind und in der Monitoring-Ansicht angezeigt werden.

Felder
default_dashboard	string Optional. Der Ressourcenname des Standard-Contact Center Insights-Dashboards, das mit der App verknüpft ist. Dieses Dashboard wird angezeigt, wenn Nutzer zur Monitoring-Ansicht für die App wechseln. Format: projects/{project}/locations/{location}/dashboards/{dashboard}

Datastore

Eine DataStore-Ressource in Vertex AI Search.

Felder
name	string Erforderlich. Vollständiger Ressourcenname des DataStore. Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}
type	DataStore.DataStoreType Nur Ausgabe. Der Typ des Datenspeichers. Dieses Feld ist schreibgeschützt und wird vom Server ausgefüllt.
document_processing_mode	DataStore.DocumentProcessingMode Nur Ausgabe. Der Dokumentverarbeitungsmodus für die Datenspeicherverbindung. Wird nur für PUBLIC_WEB- und UNSTRUCTURED-Datenspeicher festgelegt.
display_name	string Nur Ausgabe. Der Anzeigename des Datenspeichers.
create_time	Timestamp Nur Ausgabe. Zeitstempel für die Erstellung des Datenspeichers.
connector_config	DataStore.ConnectorConfig Nur Ausgabe. Die Connector-Konfiguration für die Datenspeicherverbindung.

ConnectorConfig

Die Connector-Konfiguration für die Datenspeicherverbindung.

Felder
collection	string Der Ressourcenname der Sammlung, zu der der Datenspeicher gehört.
collection_display_name	string Der Anzeigename der Sammlung, zu der der Datenspeicher gehört.
data_source	string Der Name der Datenquelle. Beispiel: salesforce, jira, confluence, bigquery.

DataStoreType

Der Typ des Datenspeichers.

Enums
DATA_STORE_TYPE_UNSPECIFIED	Nicht angegeben. Dieser Wert gibt an, dass der Datenspeichertyp nicht angegeben ist. Er wird daher bei der Suche nicht verwendet.
PUBLIC_WEB	Ein Datenspeicher, der öffentliche Webinhalte enthält.
UNSTRUCTURED	Ein Datenspeicher, der unstrukturierte private Daten enthält.
FAQ	Ein Datenspeicher mit strukturierten Daten, die als FAQs verwendet werden.
CONNECTOR	Ein Datenspeicher, der ein Connector zu einem selbst erhobenen oder einem Drittanbieterdienst ist.

DocumentProcessingMode

Der Dokumentverarbeitungsmodus des Datenspeichers.

Enums
DOCUMENT_PROCESSING_MODE_UNSPECIFIED	Nicht angegeben.
DOCUMENTS	Dokumente werden als Dokumente verarbeitet.
CHUNKS	Dokumente werden in Blöcke unterteilt.

DataStoreSettings

Datenspeicherbezogene Einstellungen für die App.

Felder
engines[]	DataStoreSettings.Engine Nur Ausgabe. Die Engines für die App.

Engine

Eine Engine, mit der die Datenspeicher verbunden sind. Weitere Informationen finden Sie unter Vertex AI Search: https://cloud.google.com/generative-ai-app-builder/docs/enterprise-search-introduction.

Felder
name	string Nur Ausgabe. Der Ressourcenname der Engine. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}
type	DataStoreSettings.Engine.Type Nur Ausgabe. Der Typ der Engine.

Typ

Der Typ der Engine. Weitere Informationen finden Sie in der Dokumentation unter https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1/SolutionType und https://cloud.google.com/generative-ai-app-builder/docs/create-datastore-ingest.

Enums
TYPE_UNSPECIFIED	Nicht angegebener Motortyp.
ENGINE_TYPE_SEARCH	Die SOLUTION_TYPE_SEARCH-Engine für die App. Alle Connector-Datenspeicher, die der App hinzugefügt werden, werden dieser Engine hinzugefügt.
ENGINE_TYPE_CHAT	Typ der Chat-Engine. Die SOLUTION_TYPE_CHAT-Engine für die App. Alle Connector-Datenspeicher, die der App hinzugefügt werden, werden dieser Engine hinzugefügt.

DataStoreTool

Tool zum Abrufen von Daten aus dem Vertex AI Search-Datenspeicher oder der Engine zur Fundierung. Akzeptiert entweder einen Datenspeicher oder eine Engine, aber nicht beides. Weitere Informationen finden Sie unter Vertex AI Search: https://cloud.google.com/generative-ai-app-builder/docs/enterprise-search-introduction.

Felder
name	string Erforderlich. Der Name des Datenspeichertools.
description	string Optional. Die Toolbeschreibung.
boost_specs[]	DataStoreTool.BoostSpecs Optional. Mit der Boost-Spezifikation können Sie bestimmte Dokumente hervorheben.
modality_configs[]	DataStoreTool.ModalityConfig Optional. Die Modalitätskonfigurationen für den Datenspeicher.
filter_parameter_behavior	DataStoreTool.FilterParameterBehavior Optional. Das Verhalten des Filterparameters.
Union-Feld search_source. Definiert die Suchquelle, entweder einen einzelnen Datenspeicher oder eine Engine. Für search_source ist nur einer der folgenden Werte zulässig:
data_store_source	DataStoreTool.DataStoreSource Optional. In einem einzelnen bestimmten Datenspeicher suchen.
engine_source	DataStoreTool.EngineSource Optional. In einer Engine suchen (möglicherweise in mehreren DataStores).

BoostSpec

Mit der Boost-Spezifikation können Sie bestimmte Dokumente hervorheben.

Felder
condition_boost_specs[]	DataStoreTool.BoostSpec.ConditionBoostSpec Erforderlich. Eine Liste mit Boosting-Spezifikationen.

ConditionBoostSpec

Boost-Spezifikation für eine Bedingung.

Felder
condition	string Erforderlich. Der Ausdruck für eine Boost-Bedingung. Die Syntax ist dieselbe wie die Syntax für Filterausdrücke. Derzeit wird nur eine Liste von BCP-47-Sprachcodes als Bedingung unterstützt. Beispiel: So verbessern Sie Vorschläge in den Sprachen „en“ oder „fr“: (lang_code: ANY("en", "fr"))
boost	float Optional. Stärke des Boostings, das im Bereich [-1, 1] liegen sollte. Negatives Boosting bedeutet Abwertung. Der Standardwert ist 0,0. Wenn Sie den Wert auf 1,0 setzen, werden die Vorschläge deutlich hochgestuft. Das bedeutet jedoch nicht, dass das Top-Ergebnis immer ein geboosteter Vorschlag ist. Wenn Sie den Wert auf -1,0 setzen, werden die Vorschläge stark herabgestuft. Es werden jedoch möglicherweise weiterhin andere relevante Vorschläge angezeigt. Wenn Sie den Wert auf 0,0 festlegen, wird kein Boosting angewendet. Die Boost-Bedingung wird ignoriert.
boost_control_spec	DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec Optional. Komplexe Spezifikation für benutzerdefiniertes Ranking basierend auf einem vom Kunden definierten Attributwert.

BoostControlSpec

Spezifikation für benutzerdefiniertes Ranking basierend auf einem vom Kunden angegebenen Attributwert. Sie bietet mehr Steuerungsmöglichkeiten für das benutzerdefinierte Ranking als die oben genannte einfache Kombination aus „Bedingung“ und „Boost“ oben.

Felder
field_name	string Optional. Der Name des Feldes, dessen Wert zur Bestimmung des Boost-Betrags verwendet wird.
attribute_type	DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType Optional. Der Attributtyp, der zum Ermitteln des Boost-Betrags verwendet werden soll. Der Attributwert kann aus dem Feldwert des angegebenen „field_name“ abgeleitet werden. Bei numerischen Werten ist das ganz einfach: attribute_value = numerical_field_value. Bei der Aktualität gilt jedoch: attribute_value = (time.now() – datetime_field_value).
interpolation_type	DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.InterpolationType Optional. Der Interpolationstyp, der zum Verbinden der unten aufgeführten Kontrollpunkte verwendet wird.
control_points[]	DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint Optional. Die Kontrollpunkte, mit denen die Kurve definiert wird. Die monotone Funktion (die oben über „interpolation_type“ definiert wurde) geht durch die hier aufgeführten Kontrollpunkte.

AttributeType

Das Attribut (oder die Funktion), auf das bzw. die das benutzerdefinierte Ranking angewendet werden soll.

Enums
ATTRIBUTE_TYPE_UNSPECIFIED	Nicht angegebener AttributeType.
NUMERICAL	Der Wert des numerischen Felds wird verwendet, um den Boost-Betrag dynamisch zu aktualisieren. In diesem Fall ist der „attribute_value“ (der x-Wert) des Kontrollpunkts der tatsächliche Wert des numerischen Felds, für das „boost_amount“ definiert ist.
FRESHNESS	Im Anwendungsfall „Aktualität“ ist der Attributwert die Zeitspanne zwischen der aktuellen Uhrzeit und dem Datum im angegebenen Datums-/Uhrzeitfeld. Der Wert muss als XSD-dayTimeDuration-Wert formatiert sein (eine eingeschränkte Teilmenge eines ISO 8601-Dauerwerts). Das Muster dafür ist: [nD][T[nH][nM][nS]]. Beispiele: 5D, 3DT12H30M, T24H.

ControlPoint

Die Kontrollpunkte, mit denen die Kurve definiert wird. Die durch diese Kontrollpunkte definierte Kurve kann nur monoton steigend oder fallend sein (konstante Werte sind zulässig).

Felder
attribute_value	string Optional. Kann einer der folgenden Werte sein: 1. Der numerische Feldwert. 2. Die Dauerangabe für die Aktualität: Der Wert muss als XSD-dayTimeDuration-Wert formatiert sein (eine eingeschränkte Teilmenge eines ISO 8601-Dauerwerts). Das Muster dafür ist: [nD][T[nH][nM][nS]].
boost_amount	float Optional. Der Wert zwischen -1 und 1, der angibt, um wieviel die Punktzahl erhöht werden soll, wenn „attribute_value“ dem oben angegebenen Wert entspricht.

InterpolationType

Anzuwendender Interpolationstyp. Der Standardwert ist „linear“ (Piecewise Linear).

Enums
INTERPOLATION_TYPE_UNSPECIFIED	Der Interpolationstyp ist nicht angegeben. In diesem Fall wird standardmäßig der Typ „Linear“ verwendet.
LINEAR	Die „PiecewiseLinear“-Interpolation wird angewendet.

BoostSpecs

Mit Boost-Spezifikationen können Sie bestimmte Dokumente hervorheben. Weitere Informationen finden Sie unter https://cloud.google.com/generative-ai-app-builder/docs/boosting.

Felder
data_stores[]	string Erforderlich. Der Datenspeicher, auf den die Konfiguration für die Steigerung angewendet wird. Vollständiger Ressourcenname des DataStore, z. B. „projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}“.
spec[]	DataStoreTool.BoostSpec Erforderlich. Eine Liste mit Boosting-Spezifikationen.

DataStoreSource

Konfiguration für die Suche in einem bestimmten Datenspeicher.

Felder
filter	string Optional. Filterspezifikation für den Datenspeicher. Weitere Informationen: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata
data_store	DataStore Optional. Der Datenspeicher.

EngineSource

Konfiguration für die Suche in einer Engine, die möglicherweise auf bestimmte Datenspeicher ausgerichtet ist.

Felder
engine	string Erforderlich. Vollständiger Ressourcenname der Engine. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}
data_store_sources[]	DataStoreTool.DataStoreSource Optional. Wird verwendet, um bestimmte Datenspeicher innerhalb der Engine als Ziel auszuwählen. Wenn das Feld leer ist, wird die Suche auf alle Datenspeicher angewendet, die mit der Engine verknüpft sind.
filter	string Optional. Ein Filter, der auf die Suche in der Engine angewendet wird. Nicht relevant und nicht verwendet, wenn „data_store_sources“ angegeben ist. Weitere Informationen: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata

FilterParameterBehavior

Verhalten von Filterparametern

Enums
FILTER_PARAMETER_BEHAVIOR_UNSPECIFIED	Standardverhalten von Filtern Filterparameter für Connector-Datenspeicher einfügen Für die restlichen Datenspeichertypen wird der Filter-Eingabeparameter weggelassen.
ALWAYS_INCLUDE	Geben Sie immer einen Filterparameter für alle Datastore-Typen an.
NEVER_INCLUDE	Der Filterparameter ist unabhängig vom Datenspeichertyp nie in der Liste der Tool-Parameter enthalten.

GroundingConfig

Konfiguration der Fundierung.

Felder
grounding_level	float Optional. Der Fundierungsschwellenwert der Antwort basierend auf den abgerufenen Quellen. Der Wert hat einen konfigurierbaren Bereich von [1, 5]. Mit der Ebene wird die Fundierung der Antwort begrenzt. Das bedeutet, dass für alle Antworten mit einem Fundierungswert unter dem Schwellenwert nur relevante Snippets zurückgegeben werden. Wenn der Wert beispielsweise 3 ist, muss der Fundierungs-Score mindestens 3 sein, damit die Antwort zurückgegeben wird.
disabled	bool Optional. Gibt an, ob die Fundierung deaktiviert ist.

ModalityConfig

Falls angegeben, wird die angegebene Konfiguration für die angegebene Modalität angewendet.

Felder
modality_type	DataStoreTool.ModalityConfig.ModalityType Erforderlich. Der Modalitätstyp.
rewriter_config	DataStoreTool.RewriterConfig Optional. Die Rewriter-Konfiguration.
summarization_config	DataStoreTool.SummarizationConfig Optional. Die Zusammenfassungskonfiguration.
grounding_config	DataStoreTool.GroundingConfig Optional. Die Fundierungskonfiguration.
snippets_config	DataStoreTool.SnippetsConfig Optional. Die Snippets-Konfiguration.

ModalityType

Der Modalitätstyp.

Enums
MODALITY_TYPE_UNSPECIFIED	Nicht angegebener Modalitätstyp.
TEXT	Textmodalität.
AUDIO	Audio-Modalität

RewriterConfig

Rewriter-Konfiguration.

Felder
model_settings	ModelSettings Erforderlich. Konfigurationen für das LLM-Modell.
prompt	string Optional. Die Prompt-Definition. Wenn nichts angegeben ist, wird ein Standard-Prompt verwendet.
disabled	bool Optional. Gibt an, ob der Rewriter deaktiviert ist.

SnippetsConfig

Snippet-Konfiguration

Felder
enable_snippets	bool Optional. Gibt an, ob Snippets aktiviert sind.
max_snippets	int32 Optional. Anzahl der Snippets, die pro Anfrage zurückgegeben werden sollen. Wenn nicht festgelegt, werden standardmäßig alle Snippets des Dienstes zurückgegeben.

SummarizationConfig

Konfiguration der Zusammenfassung.

Felder
model_settings	ModelSettings Optional. Konfigurationen für das LLM-Modell.
prompt	string Optional. Die Prompt-Definition. Wenn nichts angegeben ist, wird ein Standard-Prompt verwendet.
disabled	bool Optional. Gibt an, ob die Zusammenfassung deaktiviert ist.

DeleteAgentRequest

Anfragenachricht für AgentService.DeleteAgent.

Felder
name	string Erforderlich. Der Ressourcenname des zu löschenden KI-Agenten.
force	bool Optional. Gibt an, ob der KI-Agent auch dann gelöscht werden soll, wenn noch andere Apps, KI-Agenten oder Beispiele darauf verweisen. Wenn force = false, schlägt das Löschen fehl, wenn andere Agents/Beispiele darauf verweisen. Wenn force = true, löschen Sie den Agent und entfernen Sie ihn aus allen referenzierenden Apps, Agents und Beispielen.
etag	string Optional. Das aktuelle ETag des KI-Agenten. Wenn kein ETag angegeben wird, werden durch das Löschen alle gleichzeitigen Änderungen überschrieben. Wenn ein ETag angegeben wird, das nicht mit dem aktuellen ETag des Agents übereinstimmt, wird das Löschen blockiert und ein ABORTED-Fehler zurückgegeben.

DeleteAppRequest

Anfragenachricht für AgentService.DeleteApp.

Felder
name	string Erforderlich. Der Ressourcenname der zu löschenden App.
etag	string Optional. Das aktuelle ETag der App. Wenn kein ETag angegeben wird, werden durch das Löschen alle gleichzeitigen Änderungen überschrieben. Wenn ein ETag angegeben wird, das nicht mit dem aktuellen ETag der App übereinstimmt, wird das Löschen blockiert und ein ABORTED-Fehler zurückgegeben.

DeleteAppVersionRequest

Anfragenachricht für AgentService.DeleteAppVersion.

Felder
name	string Erforderlich. Der Ressourcenname der zu löschenden App-Version.
etag	string Optional. Der aktuelle ETag der App-Version. Wenn kein ETag angegeben wird, werden durch das Löschen alle gleichzeitigen Änderungen überschrieben. Wenn ein ETag angegeben wird, das nicht mit dem aktuellen ETag der App-Version übereinstimmt, wird das Löschen blockiert und ein ABORTED-Fehler zurückgegeben.

DeleteConversationRequest

Anfragenachricht für AgentService.DeleteConversation.

Felder
name	string Erforderlich. Der Ressourcenname der zu löschenden Unterhaltung.
source (deprecated)	Conversation.Source Dieses Element wird nicht mehr unterstützt. Optional. Geben Sie die Quelle der Unterhaltung an. Wenn nicht festgelegt, wird standardmäßig „Source.Live“ angewendet.

DeleteDeploymentRequest

Anfragenachricht für AgentService.DeleteDeployment.

Felder
name	string Erforderlich. Der Name der zu löschenden Bereitstellung. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
etag	string Optional. Das ETag der Bereitstellung. Wenn ein ETag angegeben wird, das nicht mit dem aktuellen ETag der Bereitstellung übereinstimmt, wird das Löschen blockiert und ein ABORTED-Fehler zurückgegeben.

DeleteExampleRequest

Anfragenachricht für AgentService.DeleteExample.

Felder
name	string Erforderlich. Der Ressourcenname des zu löschenden Beispiels.
etag	string Optional. Der aktuelle ETag-Wert des Beispiels. Wenn kein ETag angegeben wird, werden durch das Löschen alle gleichzeitigen Änderungen überschrieben. Wenn ein ETag angegeben wird, das nicht mit dem aktuellen ETag des Beispiels übereinstimmt, wird das Löschen blockiert und ein ABORTED-Fehler zurückgegeben.

DeleteGuardrailRequest

Anfragenachricht für AgentService.DeleteGuardrail.

Felder
name	string Erforderlich. Der Ressourcenname der zu löschenden Guardrail.
force	bool Optional. Gibt an, ob die Richtlinie erzwungen gelöscht werden soll, auch wenn sie noch von Apps/Agents referenziert wird. Wenn force = false, schlägt das Löschen fehl, wenn Apps oder Agents noch auf die Richtlinie verweisen. Wenn force = true, werden alle vorhandenen Verweise aus Apps/Agents entfernt und die Schutzvorrichtung wird gelöscht.
etag	string Optional. Der aktuelle ETag der Guardrail. Wenn kein ETag angegeben wird, werden durch das Löschen alle gleichzeitigen Änderungen überschrieben. Wenn ein ETag angegeben wird, das nicht mit dem aktuellen ETag der Guardrail übereinstimmt, wird das Löschen blockiert und ein ABORTED-Fehler zurückgegeben.

DeleteToolRequest

Anfragenachricht für AgentService.DeleteTool.

Felder
name	string Erforderlich. Der Ressourcenname des zu löschenden Tools.
force	bool Optional. Gibt an, ob das Tool auch dann gelöscht werden soll, wenn noch von Agents/Beispielen darauf verwiesen wird. Wenn force = false, schlägt das Löschen fehl, wenn noch Agents auf das Tool verweisen. Wenn force = true, werden alle vorhandenen Verweise von Kundenservicemitarbeitern entfernt und das Tool wird gelöscht.
etag	string Optional. Der aktuelle ETag des Tools. Wenn kein ETag angegeben wird, werden durch das Löschen alle gleichzeitigen Änderungen überschrieben. Wenn ein ETag angegeben wird, das nicht mit dem aktuellen ETag des Tools übereinstimmt, wird das Löschen blockiert und ein ABORTED-Fehler zurückgegeben.

DeleteToolsetRequest

Anfragenachricht für AgentService.DeleteToolset.

Felder
name	string Erforderlich. Der Ressourcenname des zu löschenden Toolsets.
force	bool Optional. Gibt an, ob das Toolset zwangsweise gelöscht werden soll, auch wenn es noch von Apps oder KI-Agents referenziert wird. Wenn force = false, schlägt das Löschen fehl, wenn noch Agents auf das Toolset verweisen. Wenn force = true, werden alle vorhandenen Verweise von Kundenservicemitarbeitern entfernt und das Toolset wird gelöscht.
etag	string Optional. Der aktuelle ETag des Toolsets. Wenn kein ETag angegeben wird, werden durch das Löschen alle gleichzeitigen Änderungen überschrieben. Wenn ein ETag angegeben wird, das nicht mit dem aktuellen ETag des Toolsets übereinstimmt, wird das Löschen blockiert und ein ABORTED-Fehler zurückgegeben.

DeployChannelResponse

Antwortnachricht für AgentService.DeployChannel.

Felder
deployment	Deployment Das erstellte Deployment.

Bereitstellung

Eine Bereitstellung ist eine unveränderliche, abfragbare Version der App. Sie wird verwendet, um eine App-Version mit einem bestimmten Channel-Profil bereitzustellen.

Felder
name	string ID. Der Ressourcenname der Bereitstellung. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
display_name	string Erforderlich. Der Anzeigename der Bereitstellung.
app_version	string Optional. Der Ressourcenname der bereitzustellenden App-Version. Format: projects/{project}/locations/{location}/apps/{app}/versions/{version} Verwenden Sie projects/{project}/locations/{location}/apps/{app}/versions/-, um die App-Version zu verwenden.
channel_profile	ChannelProfile Erforderlich. Das in der Bereitstellung verwendete Channel-Profil.
create_time	Timestamp Nur Ausgabe. Zeitstempel für die Erstellung dieser Bereitstellung.
update_time	Timestamp Nur Ausgabe. Zeitstempel der letzten Aktualisierung dieser Bereitstellung.
etag	string Nur Ausgabe. ETag, mit dem sichergestellt wird, dass sich das Objekt während eines Read-Modify-Write-Vorgangs nicht geändert hat. Wenn das ETag leer ist, werden durch das Update alle gleichzeitigen Änderungen überschrieben.
experiment_config	ExperimentConfig Optional. Testkonfiguration für die Bereitstellung.
whatsapp_credentials	WhatsAppCredentials Optional. Nur Eingabe. Beim Konfigurieren eines WhatsApp-Channelprofils sind temporäre WhatsApp-Anmeldedaten erforderlich.
instagram_credentials	InstagramCredentials Optional. Nur Eingabe. Beim Konfigurieren eines Instagram-Kanalprofils sind flüchtige Instagram-Anmeldedaten erforderlich.
model_settings	ModelSettings Optional. Modelleinstellungen für die Bereitstellung. Überschreibt die auf App-/Agent-Ebene konfigurierten Modelleinstellungen. Hinweis: Das Überschreiben von Modelleinstellungen auf Bereitstellungsebene ist nur über eine Zulassungsliste möglich. Wenden Sie sich an das CXAS-Team, um dieses Feld zu aktivieren.
modality	Deployment.Modality Optional. Die Modalität der Bereitstellung. Hinweis: Das Überschreiben von Modalitäten auf Bereitstellungsebene ist nur mit einer Zulassungsliste möglich. Wenden Sie sich an das CXAS-Team, um dieses Feld zu aktivieren.
agent_registry_deployment	AgentRegistryDeployment Optional. Konfiguration für die Bereitstellung dieser Bereitstellung in Agent Registry. Falls vorhanden, wird diese Bereitstellung in Agent Registry veröffentlicht.

Modalität

Die Modalität der Bereitstellung.

Enums
MODALITY_UNSPECIFIED	Unbekannte Modalität.
MODALITY_TEXT	Textmodalität.
MODALITY_VOICE	Sprachmodalität
MODALITY_VIDEO	Videomodalität

EndSession

Gibt an, dass die Sitzung beendet wurde, entweder durch erfolgreichen Abschluss (z.B. wenn der Nutzer „Tschüss!“ sagt) ) oder eine Agent-Eskalierung.

Der Agent verarbeitet keine weiteren Eingaben mehr, nachdem die Sitzung beendet wurde. Der Client sollte die Verbindung halb schließen und trennen, nachdem er alle verbleibenden Antworten vom Agenten erhalten hat.

Felder
metadata	Struct Optional. Enthält zusätzliche Informationen zum Signal für das Ende der Sitzung, z. B. den Grund für das Ende der Sitzung.

EndUserAuthConfig

Konfiguration der Endnutzerauthentifizierung, die für Verbindungsaufrufe verwendet wird. Die Feldwerte müssen die Namen von Kontextvariablen im Format $context.variables.<name_of_variable> sein.

Felder
Union-Feld auth_config. Die Authentifizierungskonfiguration. Für auth_config ist nur einer der folgenden Werte zulässig:
oauth2_auth_code_config	EndUserAuthConfig.Oauth2AuthCodeConfig Authentifizierung mit OAuth 2.0-Autorisierungscode.
oauth2_jwt_bearer_config	EndUserAuthConfig.Oauth2JwtBearerConfig JWT-Profil für die OAuth 2.0-Autorisierung.

Oauth2AuthCodeConfig

Konfiguration der Authentifizierung mit OAuth 2.0-Autorisierungscode.

Felder
oauth_token	string Erforderlich. Name des OAuth-Tokenparameters, der übergeben werden soll. Muss das Format $context.variables.<name_of_variable> aufweisen.

Oauth2JwtBearerConfig

Authentifizierungskonfiguration für die OAuth 2.0-Autorisierungserteilung mit JWT-Profil.

Felder
issuer	string Erforderlich. Name des Ausstellerparameters, der übergeben werden soll. Muss das Format $context.variables.<name_of_variable> aufweisen.
subject	string Erforderlich. Name des zu übergebenden Subjektparameters. Muss das Format $context.variables.<name_of_variable> aufweisen.
client_key	string Erforderlich. Name des Clientparameters, der übergeben werden soll. Muss das Format $context.variables.<name_of_variable> aufweisen.

EndpointControlPolicy

Definiert die Richtlinie zur Endpunktsteuerung auf Projekt-/Standortebene.

Felder
enforcement_scope	EndpointControlPolicy.EnforcementScope Optional. Der Bereich, in dem die Liste „allowed_origins“ dieser Richtlinie erzwungen wird.
allowed_origins[]	string Optional. Die zulässigen HTTP(s)-Ursprünge, die von Tools in der App direkt aufgerufen werden können. Die Erzwingung hängt vom Wert von „enforcement_scope“ und vom VPC-SC-Status des Projekts ab. Wenn keine Portnummer angegeben ist, sind alle Ports zulässig. Andernfalls muss die Portnummer genau übereinstimmen. So wird beispielsweise „https://beispiel.de“ genau wie „https://beispiel.de:443“ und jeder andere Port behandelt. „https://beispiel.de:443“ entspricht nur „https://beispiel.de:443“.

EnforcementScope

Definiert den Bereich, in dem die Liste „allowed_origins“ dieser Richtlinie erzwungen wird.

Enums
ENFORCEMENT_SCOPE_UNSPECIFIED	Nicht angegeben. Diese Richtlinie wird als VPCSC_ONLY behandelt.
VPCSC_ONLY	Diese Richtlinie gilt nur, wenn VPC-SC aktiv ist.
ALWAYS	Diese Richtlinie gilt IMMER, unabhängig vom VPC-SC-Status.

ErrorHandlingSettings

Einstellungen, die beschreiben, wie Fehler in der App behandelt werden sollen.

Felder
error_handling_strategy	ErrorHandlingSettings.ErrorHandlingStrategy Optional. Die Strategie, die für die Fehlerbehandlung verwendet werden soll.
fallback_response_config	ErrorHandlingSettings.FallbackResponseConfig Optional. Konfiguration für die Verarbeitung von Fallback-Antworten.
end_session_config	ErrorHandlingSettings.EndSessionConfig Optional. Konfiguration zum Beenden der Sitzung bei Systemfehlern (z.B. LLM-Fehlern).

EndSessionConfig

Konfiguration zum Beenden der Sitzung bei Systemfehlern (z.B. LLM-Fehlern).

Felder
escalate_session	bool Optional. Gibt an, ob die Sitzung in EndSession eskaliert werden soll. Wenn die Sitzung eskaliert wird, enthält metadata in EndSession den Wert session_escalated = true. Weitere Informationen finden Sie unter https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/deploy/google-telephony-platform#transfer_a_call_to_a_human_agent.

ErrorHandlingStrategy

Definiert die Strategie für die Fehlerbehandlung.

Enums
ERROR_HANDLING_STRATEGY_UNSPECIFIED	Nicht angegebene Strategie zur Fehlerbehandlung.
NONE	Es ist keine spezielle Verarbeitung aktiviert.
FALLBACK_RESPONSE	Im Falle von Systemfehlern (z.B. LLM-Fehlern) wird dem Nutzer eine Fallback-Nachricht zurückgegeben.
END_SESSION	Bei Systemfehlern (z.B. LLM-Fehlern) wird ein EndSession-Signal ausgegeben.

FallbackResponseConfig

Konfiguration für die Verarbeitung von Fallback-Antworten.

Felder
custom_fallback_messages	map<string, string> Optional. Die Fallback-Nachrichten bei Systemfehlern (z.B. LLM-Fehler), die nach unterstütztem Sprachcode zugeordnet werden.
max_fallback_attempts	int32 Optional. Die maximale Anzahl von Fallback-Versuchen, die unternommen werden sollen, bevor der Agent das EndSession-Signal ausgibt.

EvaluationMetricsThresholds

Schwellenwerteinstellungen für Messwerte in einer Bewertung.

Felder
golden_evaluation_metrics_thresholds	EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds Optional. Die Grenzwerte für die Golden-Bewertungsmesswerte.
hallucination_metric_behavior (deprecated)	EvaluationMetricsThresholds.HallucinationMetricBehavior Dieses Element wird nicht mehr unterstützt. Optional. Nicht mehr unterstützt: Verwenden Sie stattdessen golden_hallucination_metric_behavior. Das Verhalten des Halluzinationsmesswerts wird derzeit für goldene Bewertungen verwendet.
golden_hallucination_metric_behavior	EvaluationMetricsThresholds.HallucinationMetricBehavior Optional. Das Verhalten des Messwerts für Halluzinationen bei Golden-Evaluierungen.
scenario_hallucination_metric_behavior	EvaluationMetricsThresholds.HallucinationMetricBehavior Optional. Das Verhalten des Messwerts für Halluzinationen bei Szenariobewertungen.

GoldenEvaluationMetricsThresholds

Einstellungen für Golden Evaluations.

Felder
turn_level_metrics_thresholds	EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds Optional. Die Schwellenwerte für Messwerte auf Turn-Ebene.
expectation_level_metrics_thresholds	EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.ExpectationLevelMetricsThresholds Optional. Die Grenzwerte für die Messwerte für das Erwartungsniveau.
tool_matching_settings	EvaluationMetricsThresholds.ToolMatchingSettings Optional. Die Einstellungen für den Tool-Abgleich. Ein zusätzlicher Tool-Aufruf ist ein Tool-Aufruf, der in der Ausführung vorhanden ist, aber nicht mit einem Tool-Aufruf in der Golden-Erwartung übereinstimmt.

ExpectationLevelMetricsThresholds

Grenzwerte für Messwerte auf Erwartungsebene.

Felder
tool_invocation_parameter_correctness_threshold	float Optional. Der Erfolgsschwellenwert für die Korrektheit einzelner Parameter für den Toolaufruf. Muss eine Gleitkommazahl zwischen 0 und 1 sein. Der Standardwert ist 1,0.

TurnLevelMetricsThresholds

Schwellenwerte für Messwerte auf Ebene der Kampagne.

Felder
semantic_similarity_channel	EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds.SemanticSimilarityChannel Optional. Der Channel für semantische Ähnlichkeit, der für die Bewertung verwendet werden soll.
semantic_similarity_success_threshold	int32 Optional. Der Erfolgsgrenzwert für die semantische Ähnlichkeit. Muss eine Ganzzahl zwischen 0 und 4 sein. Der Standardwert ist >= 3.
overall_tool_invocation_correctness_threshold	float Optional. Der Erfolgsschwellenwert für die allgemeine Korrektheit des Toolaufrufs. Muss eine Gleitkommazahl zwischen 0 und 1 sein. Der Standardwert ist 1,0.

SemanticSimilarityChannel

Der zu verwendende Channel für die semantische Ähnlichkeit.

Enums
SEMANTIC_SIMILARITY_CHANNEL_UNSPECIFIED	Messwert nicht angegeben. Die Standardeinstellung ist TEXT.
TEXT	Verwenden Sie die semantische Ähnlichkeit von Text.
AUDIO	Semantische Ähnlichkeit von Audioinhalten verwenden.

HallucinationMetricBehavior

Das Verhalten des Messwerts für Halluzinationen. Unabhängig vom Verhalten wird der Messwert immer berechnet. Der Unterschied besteht darin, dass der Messwert bei Deaktivierung nicht zur Berechnung der Gesamtbewertung verwendet wird.

Enums
HALLUCINATION_METRIC_BEHAVIOR_UNSPECIFIED	Nicht angegebenes Verhalten des Halluzinationsmesswerts.
DISABLED	Halluzinationsmesswert deaktivieren.
ENABLED	Halluzinationsmesswert aktivieren.

ToolMatchingSettings

Einstellungen für den Abgleich von Tool-Aufrufen.

Felder
extra_tool_call_behavior	EvaluationMetricsThresholds.ToolMatchingSettings.ExtraToolCallBehavior Optional. Verhalten bei zusätzlichen Tool-Aufrufen. Die Standardeinstellung ist FAIL.

ExtraToolCallBehavior

Definiert das Verhalten, wenn ein zusätzlicher Tool-Aufruf erfolgt. Ein zusätzlicher Tool-Aufruf ist ein Tool-Aufruf, der in der Ausführung vorhanden ist, aber nicht mit einem Tool-Aufruf in der Golden-Erwartung übereinstimmt.

Enums
EXTRA_TOOL_CALL_BEHAVIOR_UNSPECIFIED	Nicht angegebenes Verhalten. Die Standardeinstellung ist FAIL.
FAIL	Die Auswertung schlägt fehl, wenn ein zusätzlicher Toolaufruf erfolgt.
ALLOW	Zusätzlichen Toolaufruf zulassen

Ereignis

Ereigniseingabe

Felder
event	string Erforderlich. Der Name des Ereignisses.
variables	Struct Optional. Zusätzliche Variablen, die mit dem Ereignis verknüpft sind.

Beispiel

Ein Beispiel stellt eine Beispielunterhaltung zwischen dem Nutzer und dem/den Agenten dar.

Felder
name	string ID. Die eindeutige Kennung des Beispiels. Format: projects/{project}/locations/{location}/apps/{app}/examples/{example}
display_name	string Erforderlich. Anzeigename des Beispiels.
description	string Optional. Eine für Menschen lesbare Beschreibung des Beispiels.
entry_agent	string Optional. Der Agent, der die Unterhaltung ursprünglich bearbeitet. Wenn nicht angegeben, stellt das Beispiel eine Unterhaltung dar, die vom Stamm-Agent bearbeitet wird. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
messages[]	Message Optional. Die Sammlung von Nachrichten, aus denen sich die Unterhaltung zusammensetzt.
create_time	Timestamp Nur Ausgabe. Zeitstempel für die Erstellung des Beispiels.
update_time	Timestamp Nur Ausgabe. Zeitstempel der letzten Aktualisierung des Beispiels.
invalid	bool Nur Ausgabe. Das Beispiel kann ungültig werden, wenn referenzierte Ressourcen gelöscht werden. Ungültige Beispiele werden nicht als Few-Shot-Beispiele verwendet.
etag	string ETag, mit dem sichergestellt wird, dass sich das Objekt während eines Read-Modify-Write-Vorgangs nicht geändert hat. Wenn das ETag leer ist, werden durch das Update alle gleichzeitigen Änderungen überschrieben.

ExecuteToolRequest

Anfragenachricht für ToolService.ExecuteTool.

Felder
parent	string Erforderlich. Der Ressourcenname der App, zu der das Tool bzw. das Toolset gehört. Format: projects/{project}/locations/{location}/apps/{app}
args	Struct Optional. Die Eingabeparameter und -werte für das Tool im JSON-Objektformat.
mock_config	MockConfig Optional. Mock-Konfiguration für die Tool-Ausführung. Wenn dieses Feld festgelegt ist, werden Tools, die andere Tools aufrufen, basierend auf den bereitgestellten Mustern und Antworten simuliert.
Union-Feld tool_identifier. Die Kennung des auszuführenden Tools. Es kann sich entweder um ein dauerhaftes Tool oder ein Tool aus einem Toolset handeln. Für tool_identifier ist nur einer der folgenden Werte zulässig:
tool	string Optional. Der Name des auszuführenden Tools. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolset_tool	ToolsetTool Optional. Das Toolset-Tool, das ausgeführt werden soll. Nur ein Tool aus dem Toolset sollte dem Prädikat entsprechen. Andernfalls wird ein Fehler zurückgegeben.
Union-Feld tool_execution_context. Zusätzlicher Kontext, der für die Ausführung des Tools angegeben werden muss tool_execution_context, kann nur einer der folgenden Werte sein:
variables	Struct Optional. Die Variablen, die für die Ausführung des Tools verfügbar sind.
context	Struct Optional. Der [ToolCallContext](https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/python#environment für Details), der an das Python-Tool übergeben werden soll.

ExecuteToolResponse

Antwortnachricht für ToolService.ExecuteTool.

Felder
response	Struct Das Ergebnis der Tool-Ausführung im JSON-Objektformat. Verwenden Sie den Schlüssel „output“, um die Tool-Antwort anzugeben, und den Schlüssel „error“, um Fehlerdetails anzugeben (falls vorhanden). Wenn die Schlüssel „output“ und „error“ nicht angegeben sind, wird die gesamte „response“ als Ergebnis der Tool-Ausführung behandelt.
variables	Struct Die Variablenwerte am Ende der Tool-Ausführung.
citations	Citations Zitationen, die die Quellinformationen für die Ausführung des Tools enthalten.
google_search_suggestions	GoogleSearchSuggestions Die Vorschläge, die von der Google Suche zurückgegeben werden, wenn das Google Search Tool während der Tool-Ausführung aufgerufen wird.
Union-Feld tool_identifier. Die Kennung des Tools, das ausgeführt wurde. Für tool_identifier ist nur einer der folgenden Werte zulässig:
tool	string Der Name des ausgeführten Tools. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolset_tool	ToolsetTool Das Toolset-Tool, das ausgeführt wurde.

ExecutionType

Der Ausführungstyp des Tools oder Toolsets.

Enums
EXECUTION_TYPE_UNSPECIFIED	Der Ausführungstyp ist nicht angegeben. Wenn kein Wert angegeben wird, gilt der Standardwert SYNCHRONOUS.
SYNCHRONOUS	Das Tool wird synchron ausgeführt. Die Sitzung wird blockiert, bis das Tool zurückgegeben wird.
ASYNCHRONOUS	Das Tool wird asynchron ausgeführt. Die Sitzung wird fortgesetzt, während das Tool ausgeführt wird.

ExperimentConfig

Test für die Bereitstellung

Felder
version_release	ExperimentConfig.VersionRelease Optional. Version für den Test.

Bundesland

Status des Tests.

Enums
STATE_UNSPECIFIED	Nicht angegebener Zustand.
PENDING	Eingestellt: Dieser Status wird nicht mehr verwendet.
RUNNING	Ausführungsstatus. Der Test wird ausgeführt und ist gültig.
DONE	Eingestellt: Dieser Status wird nicht mehr verwendet.
EXPIRED	Eingestellt: Dieser Status wird nicht mehr verwendet.

VersionRelease

Version für den Test.

Felder
state	ExperimentConfig.State Optional. Status der Version.
traffic_allocations[]	ExperimentConfig.VersionRelease.TrafficAllocation Optional. Traffic-Zuweisungen für die Versionsveröffentlichung.

TrafficAllocation

Traffic-Zuordnung für die Versionsveröffentlichung.

Felder
id	string Optional. ID der Traffic-Zuordnung. String im freien Format mit bis zu 128 Zeichen.
traffic_percentage	int32 Optional. Prozentsatz des Traffics für die Traffic-Zuordnung. muss zwischen 0 und 100 liegen.
app_version	string Optional. App-Version der Traffic-Zuordnung. Format: projects/{project}/locations/{location}/apps/{app}/versions/{version}

ExportAppRequest

Anfragenachricht für AgentService.ExportApp.

Felder
name	string Erforderlich. Der Ressourcenname der zu exportierenden App.
export_format	ExportAppRequest.ExportFormat Erforderlich. Das Format, in dem die App exportiert werden soll.
gcs_uri	string Optional. Der Google Cloud Storage-URI, in den die App exportiert werden soll. Das Format dieses URI muss gs://<bucket-name>/<object-name> sein. Das exportierte App-Archiv wird direkt in das angegebene GCS-Objekt geschrieben.
app_version	string Optional. Der Ressourcenname der zu exportierenden App-Version. Format: projects/{project}/locations/{location}/apps/{app}/versions/{version}.

ExportFormat

Exportformat für die App.

Enums
EXPORT_FORMAT_UNSPECIFIED	Das Exportformat ist nicht angegeben.
JSON	Das Exportformat ist JSON.
YAML	Das Exportformat ist YAML.

ExportAppResponse

Antwortnachricht für AgentService.ExportApp.

Felder
Union-Feld app. Die exportierte App. Für app ist nur einer der folgenden Werte zulässig:
app_content	bytes Der App-Ordner wird als ZIP-Datei komprimiert.
app_uri	string Der Google Cloud Storage-URI, in den die App exportiert wurde.

ExpressionCondition

Ausdrucksbedingung basierend auf dem Sitzungsstatus.

Felder
expression	string Erforderlich. Die Stringdarstellung der Bedingung „cloud.api.Expression“.

FileSearchTool

Mit dem Tool zur Dateisuche kann der Agent in den vom App-/Agent-Entwickler hochgeladenen Dateien suchen. Es bietet Voreinstellungen für eine relativ gute Suchqualität in den hochgeladenen Dateien und eine Zusammenfassung der abgerufenen Ergebnisse.

Felder
corpus_type	FileSearchTool.CorpusType Optional. Der Typ des Korpus. Der Standardwert ist FULLY_MANAGED.
name	string Erforderlich. Der Name des Tools.
description	string Optional. Die Toolbeschreibung.
file_corpus	string Optional. Das Corpus, in dem Dateien gespeichert werden. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}

CorpusType

Der Typ des Vertex-RAG-Korpus.

Enums
CORPUS_TYPE_UNSPECIFIED	Nicht angegebener Korpus-Typ.
USER_OWNED	Der Korpus wird vom Nutzer erstellt und gehört ihm.
FULLY_MANAGED	Der Korpus wird vom KI-Agenten erstellt.

GenerateChatTokenRequest

Anfragenachricht für WidgetService.GenerateChatToken.

Felder
name	string Erforderlich. Der Name der Sitzung, für die das Chat-Token generiert werden soll. Format: projects/{project}/locations/{location}/apps/{app}/sessions/{session}
deployment	string Erforderlich. Die Bereitstellung der App, die für die Sitzung verwendet werden soll. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
recaptcha_token	string Optional. Das reCAPTCHA-Token, das vom clientseitigen Chat-Widget generiert wird.
live_handoff_enabled	bool Optional. Gibt an, ob die Live-Übergabe für die Sitzung aktiviert ist.

GenerateChatTokenResponse

Antwortnachricht für WidgetService.GenerateChatToken.

Felder
chat_token	string Das sitzungsbezogene Token für das Chat-Widget zur Authentifizierung bei Session APIs.
expire_time	Timestamp Der Zeitpunkt, zu dem das Chat-Token abläuft.

GetAgentRequest

Anfragenachricht für AgentService.GetAgent.

Felder
name	string Erforderlich. Der Ressourcenname des abzurufenden KI-Agenten.

GetAppRequest

Anfragenachricht für AgentService.GetApp.

Felder
name	string Erforderlich. Der Ressourcenname der abzurufenden App.

GetAppVersionRequest

Anfragenachricht für AgentService.GetAppVersion.

Felder
name	string Erforderlich. Der Ressourcenname der abzurufenden App-Version.

GetChangelogRequest

Anfragenachricht für AgentService.GetChangelog.

Felder
name	string Erforderlich. Der Ressourcenname des abzurufenden Changelogs.

GetConversationRequest

Anfragenachricht für AgentService.GetConversation.

Felder
name	string Erforderlich. Der Ressourcenname der abzurufenden Unterhaltung.
source (deprecated)	Conversation.Source Dieses Element wird nicht mehr unterstützt. Optional. Geben Sie die Quelle der Unterhaltung an. Wenn nicht festgelegt, wird in allen Quellen gesucht.

GetDeploymentRequest

Anfragenachricht für AgentService.GetDeployment.

Felder
name	string Erforderlich. Der Name der Bereitstellung. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}

GetExampleRequest

Anfragenachricht für AgentService.GetExample.

Felder
name	string Erforderlich. Der Ressourcenname des abzurufenden Beispiels.

GetGuardrailRequest

Anfragenachricht für AgentService.GetGuardrail.

Felder
name	string Erforderlich. Der Ressourcenname der abzurufenden Schutzvorrichtung.

GetToolRequest

Anfragenachricht für AgentService.GetTool.

Felder
name	string Erforderlich. Der Ressourcenname des abzurufenden Tools.

GetToolsetRequest

Anfragenachricht für AgentService.GetToolset.

Felder
name	string Erforderlich. Der Ressourcenname des abzurufenden Toolsets.

GoAway

Dieser Typ hat keine Felder.

Gibt an, dass die Verbindung zum Server bald getrennt wird und der Client die Verbindung halb schließen und neu starten sollte.

GoogleSearchSuggestions

Suchvorschläge von Google Search Tool.

Felder
htmls[]	string Konforme HTML- und CSS-Stile für Suchvorschläge. Der bereitgestellte HTML- und CSS-Code passt sich automatisch an die Geräteeinstellungen an und wird entweder im hellen oder im dunklen Modus angezeigt, je nach @media(prefers-color-scheme).
web_search_queries[]	WebSearchQuery Liste der Anfragen, die für die Google-Suche verwendet wurden, sowie der Suchergebnis-URIs, aus denen die Suchvorschläge bestehen.

GoogleSearchTool

Stellt ein Tool zum Ausführen von Google-Websuchen zur Fundierung dar. Weitere Informationen finden Sie unter https://cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool#google-search.

Felder
name	string Erforderlich. Der Name des Tools.
description	string Optional. Beschreibung des Zwecks des Tools.
context_urls[]	string Optional. Inhalte werden direkt von diesen URLs abgerufen, um Kontext und Fundierung zu erhalten. Beispiel: „https://beispiel.de/pfad.html“. Es sind maximal 20 URLs zulässig.
preferred_domains[]	string Optional. Gibt Domains an, auf die Suchergebnisse beschränkt werden sollen. Beispiel: „beispiel.de“, „andere.website“. Es können maximal 20 Domains angegeben werden.
exclude_domains[]	string Optional. Liste der Domains, die aus den Suchergebnissen ausgeschlossen werden sollen. Beispiel: „beispiel.de“. Es können maximal 2.000 Domains ausgeschlossen werden.
prompt_config	GoogleSearchTool.PromptConfig Optional. Anweisungen für den Planner, wie die Suchergebnisse für Text und Sprache verarbeitet werden sollen.

PromptConfig

Prompteinstellungen, die vom Modell beim Verarbeiten oder Zusammenfassen der Google-Suchergebnisse verwendet werden.

Felder
text_prompt	string Optional. Definiert den Prompt, der für die Systemanweisungen verwendet wird, wenn Sie in Chatunterhaltungen mit dem Agent interagieren. Wenn nichts angegeben ist, wird ein Standard-Prompt verwendet.
voice_prompt	string Optional. Definiert den Prompt, der für die Systemanweisungen verwendet wird, wenn Sie in Sprachunterhaltungen mit dem Agent interagieren. Wenn nichts angegeben ist, wird ein Standard-Prompt verwendet.

Schutzmaßnahme

Guardrail enthält eine Liste von Kontrollen und Sicherheitsvorkehrungen, um die Sicherheit der Agents zu gewährleisten.

Felder
name	string ID. Die eindeutige Kennung der Schutzvorrichtung. Format: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}
display_name	string Erforderlich. Der Anzeigename der Richtlinie.
description	string Optional. Beschreibung der Schutzmaßnahme.
enabled	bool Optional. Gibt an, ob die Schutzvorrichtung aktiviert ist.
action	TriggerAction Optional. Aktion, die ausgeführt werden soll, wenn die Schutzmaßnahme ausgelöst wird.
create_time	Timestamp Nur Ausgabe. Zeitstempel für die Erstellung der Richtlinie.
update_time	Timestamp Nur Ausgabe. Zeitstempel der letzten Aktualisierung der Richtlinie.
etag	string ETag, mit dem sichergestellt wird, dass sich das Objekt während eines Read-Modify-Write-Vorgangs nicht geändert hat. Wenn das ETag leer ist, werden durch das Update alle gleichzeitigen Änderungen überschrieben.
Union-Feld guardrail_type. Typ der Schutzmaßnahme. Für guardrail_type ist nur einer der folgenden Werte zulässig:
content_filter	Guardrail.ContentFilter Optional. Guardrail, die die Verwendung bestimmter Inhalte in der Unterhaltung verbietet.
llm_prompt_security	Guardrail.LlmPromptSecurity Optional. Schutzfunktion, die die Unterhaltung blockiert, wenn der Prompt basierend auf der LLM-Klassifizierung als unsicher eingestuft wird.
llm_policy	Guardrail.LlmPolicy Optional. Guardrail, die die Unterhaltung blockiert, wenn die LLM-Antwort basierend auf der LLM-Klassifizierung als Richtlinienverstoß eingestuft wird.
model_safety	Guardrail.ModelSafety Optional. Guardrail, die die Unterhaltung blockiert, wenn die LLM-Antwort basierend auf den Sicherheitseinstellungen des Modells als unsicher eingestuft wird.
code_callback	Guardrail.CodeCallback Optional. Guardrail, die die Unterhaltung basierend auf dem Ergebnis der Callback-Ausführung möglicherweise blockiert.
supervisor	Guardrail.Supervisor Optional. Schutzmaßnahme, die die Intervention des Supervisors auslöst.

CodeCallback

Schutzvorrichtung, die die Unterhaltung basierend auf den bereitgestellten Code-Callbacks blockiert.

Felder
before_agent_callback	Callback Optional. Der Callback, der vor dem Aufrufen des Agenten ausgeführt werden soll. Jede Callback-Funktion muss eine Struktur (z.B. ein Dictionary oder Objekt) mit mindestens folgenden Elementen zurückgeben: – „decision“: entweder „OK“ oder „TRIGGER“. – „reason“: Ein String, der die Entscheidung erläutert. Eine Entscheidung vom Typ „TRIGGER“ kann die weitere Verarbeitung stoppen.
after_agent_callback	Callback Optional. Der Callback, der nach dem Aufrufen des Agenten ausgeführt werden soll. Jede Callback-Funktion muss eine Struktur (z.B. ein Dictionary oder Objekt) mit mindestens folgenden Elementen zurückgeben: – „decision“: entweder „OK“ oder „TRIGGER“. – „reason“: Ein String, der die Entscheidung erläutert. Eine Entscheidung vom Typ „TRIGGER“ kann die weitere Verarbeitung stoppen.
before_model_callback	Callback Optional. Der Callback, der vor dem Aufrufen des Modells ausgeführt werden soll. Wenn das Modell mehrmals aufgerufen wird, wird der Callback mehrmals ausgeführt. Jede Callback-Funktion muss eine Struktur (z.B. ein Dictionary oder Objekt) mit mindestens folgenden Elementen zurückgeben: – „decision“: entweder „OK“ oder „TRIGGER“. – „reason“: Ein String, der die Entscheidung erläutert. Eine Entscheidung vom Typ „TRIGGER“ kann die weitere Verarbeitung stoppen.
after_model_callback	Callback Optional. Der Callback, der nach dem Aufrufen des Modells ausgeführt werden soll. Wenn das Modell mehrmals aufgerufen wird, wird der Callback mehrmals ausgeführt. Jede Callback-Funktion muss eine Struktur (z.B. ein Dictionary oder Objekt) mit mindestens folgenden Elementen zurückgeben: – „decision“: entweder „OK“ oder „TRIGGER“. – „reason“: Ein String, der die Entscheidung erläutert. Eine Entscheidung vom Typ „TRIGGER“ kann die weitere Verarbeitung stoppen.

ContentFilter

Guardrail, die die Verwendung bestimmter Inhalte in der Unterhaltung verbietet.

Felder
banned_contents[]	string Optional. Liste verbotener Ausdrücke. Gilt sowohl für Nutzereingaben als auch für Antworten von KI-Agenten.
banned_contents_in_user_input[]	string Optional. Liste verbotener Ausdrücke. Gilt nur für Nutzereingaben.
banned_contents_in_agent_response[]	string Optional. Liste verbotener Ausdrücke. Gilt nur für Antworten von KI-Agenten.
match_type	Guardrail.ContentFilter.MatchType Erforderlich. Keyword-Option für den Inhaltsfilter.
disregard_diacritics	bool Optional. Bei „true“ werden diakritische Zeichen beim Abgleich ignoriert.

MatchType

Keyword-Option für den Inhaltsfilter.

Enums
MATCH_TYPE_UNSPECIFIED	Die Keyword-Option ist nicht angegeben.
SIMPLE_STRING_MATCH	Inhalte werden zeichenweise auf Teilstrings abgeglichen.
WORD_BOUNDARY_STRING_MATCH	Inhalte werden nur dann abgeglichen, wenn das im Text gefundene Muster von Worttrennzeichen umgeben ist. Verbotene Ausdrücke können auch Worttrennzeichen enthalten.
REGEXP_MATCH	Inhalte werden mithilfe der Syntax für reguläre Ausdrücke abgeglichen.

LlmPolicy

Guardrail, die die Unterhaltung blockiert, wenn die LLM-Antwort basierend auf der LLM-Klassifizierung als Richtlinienverstoß eingestuft wird.

Felder
max_conversation_messages	int32 Optional. Berücksichtigen Sie beim Prüfen dieser Richtlinie die letzten „n“ Nachrichten in der Unterhaltung. Wenn kein Wert festgelegt ist, wird der Standardwert 10 verwendet.
model_settings	ModelSettings Optional. Modelleinstellungen
prompt	string Erforderlich. Richtlinien-Prompt
policy_scope	Guardrail.LlmPolicy.PolicyScope Erforderlich. Definiert, wann die Richtlinienprüfung während der Unterhaltung angewendet werden soll. Wenn sie auf POLICY_SCOPE_UNSPECIFIED festgelegt ist, wird die Richtlinie auf die Nutzereingabe angewendet. Wenn die Richtlinie auf die Antwort des KI‑Agents angewendet wird, kommt es zu zusätzlichen Latenzen, bevor der KI‑Agent antworten kann.
fail_open	bool Optional. Wenn während der Richtlinienprüfung ein Fehler auftritt, wird die Anfrage nicht blockiert und die Schutzmaßnahme wird nicht ausgelöst.
allow_short_utterance	bool Optional. Standardmäßig wird die LLM-Richtlinienprüfung bei kurzen Äußerungen umgangen. Wenn Sie diese Einstellung aktivieren, wird die Richtlinienprüfung auf alle Äußerungen angewendet, auch auf solche, die normalerweise übersprungen würden.

PolicyScope

Definiert, wann die Richtlinienprüfung während der Unterhaltung angewendet werden soll.

Enums
POLICY_SCOPE_UNSPECIFIED	Der Richtlinienbereich ist nicht angegeben.
USER_QUERY	Die Richtlinienprüfung wird durch Nutzereingaben ausgelöst.
AGENT_RESPONSE	Die Richtlinienprüfung wird bei der Antwort des KI-Agents ausgelöst. Wenn Sie diesen Richtlinienbereich anwenden, kommt es zu zusätzlichen Latenzen, bevor der Kundenservicemitarbeiter antworten kann.
USER_QUERY_AND_AGENT_RESPONSE	Die Richtlinienprüfung wird sowohl bei Nutzereingaben als auch bei Antworten des KI-Agenten ausgelöst. Wenn Sie diesen Richtlinienbereich anwenden, kommt es zu zusätzlichen Latenzen, bevor der Kundenservicemitarbeiter antworten kann.

LlmPromptSecurity

Leitlinie, die die Unterhaltung blockiert, wenn die Eingabe basierend auf der LLM-Klassifizierung als unsicher eingestuft wird.

Felder
fail_open	bool Optional. Bestimmt das Verhalten, wenn bei der Schutzmaßnahme ein LLM-Fehler auftritt. – Bei „true“ wird die Schutzvorrichtung umgangen. – Falsch (Standard): Die Richtlinie wird ausgelöst bzw. blockiert. Hinweis: Wenn eine benutzerdefinierte Richtlinie angegeben wird, wird dieses Feld zugunsten der „fail_open“-Konfiguration der Richtlinie ignoriert.
Union-Feld security_config. Definiert den Modus für die Sicherheitskonfiguration. Der Nutzer muss eine der folgenden Konfigurationen auswählen. Für security_config ist nur einer der folgenden Werte zulässig:
default_settings	Guardrail.LlmPromptSecurity.DefaultSecuritySettings Optional. Verwenden Sie die vordefinierten Standardsicherheitseinstellungen des Systems. Wenn Sie diesen Modus auswählen möchten, fügen Sie eine leere „default_settings“-Nachricht in die Anfrage ein. Das Feld „default_prompt_template“ wird vom Server in der Antwort ausgefüllt.
custom_policy	Guardrail.LlmPolicy Optional. Verwenden Sie eine benutzerdefinierte LlmPolicy, um den Sicherheitsmechanismus zu konfigurieren.

DefaultSecuritySettings

Konfiguration für die Standardeinstellungen für die Systemsicherheit.

Felder
default_prompt_template	string Nur Ausgabe. Die vom System verwendete Standardvorlage für Prompts. Dieses Feld dient dazu, dem Nutzer anzuzeigen, welchen Prompt das System standardmäßig verwendet. Es ist OUTPUT_ONLY.

ModelSafety

Überschreibungen der Sicherheitseinstellungen für Modelle. Wenn diese Option festgelegt ist, werden die Standardeinstellungen überschrieben und die Schutzvorrichtung wird ausgelöst, wenn die Antwort als unsicher eingestuft wird.

Felder
safety_settings[]	Guardrail.ModelSafety.SafetySetting Erforderlich. Liste der Sicherheitseinstellungen.

HarmBlockThreshold

Wahrscheinlichkeitsbasierte Schwellenwertebenen für die Blockierung

Enums
HARM_BLOCK_THRESHOLD_UNSPECIFIED	Unbekannter Schwellenwert für die Schadensblockierung
BLOCK_LOW_AND_ABOVE	Niedrigen Schwellenwert und höher blockieren (d. h. mehr blockieren)
BLOCK_MEDIUM_AND_ABOVE	Mittleren Schwellenwert und höher blockieren
BLOCK_ONLY_HIGH	Nur einen hohen Schwellenwert blockieren (d. h. weniger blockieren)
BLOCK_NONE	Nichts blockieren
OFF	Sicherheitsfilter deaktivieren

HarmCategory

Schadenskategorie

Enums
HARM_CATEGORY_UNSPECIFIED	Die Schadenskategorie ist nicht angegeben.
HARM_CATEGORY_HATE_SPEECH	Die Schadenskategorie ist Hassrede.
HARM_CATEGORY_DANGEROUS_CONTENT	Die Schadenskategorie ist gefährlicher Inhalt.
HARM_CATEGORY_HARASSMENT	Die Schadenskategorie ist Belästigung.
HARM_CATEGORY_SEXUALLY_EXPLICIT	Die Schadenskategorie umfasst sexuell anstößige Inhalte.
HARM_CATEGORY_PROFANITY	Die Schadenskategorie ist Obszönität.
HARM_CATEGORY_TOXIC	Die Schadenskategorie ist „schädlich“.

SafetySetting

Sicherheitseinstellung.

Felder
category	Guardrail.ModelSafety.HarmCategory Erforderlich. Die Schadenskategorie.
threshold	Guardrail.ModelSafety.HarmBlockThreshold Erforderlich. Der Schwellenwert für die Schadensblockierung

Filialleitung

Schutzmaßnahme, die die Intervention des Supervisors auslöst.

Felder
type	Guardrail.Supervisor.Type Optional. Der Typ des Supervisors.
detection_mode	Guardrail.Supervisor.DetectionMode Optional. Der Erkennungsmodus des Supervisors.

DetectionMode

Erkennungsmodus des Supervisors.

Enums
DETECTION_MODE_UNSPECIFIED	Der Erkennungsmodus ist nicht angegeben. Die Standardeinstellung ist NON_BLOCKING.
NON_BLOCKING	Nicht blockierender Erkennungsmodus. Die Antwort wird nicht blockiert, während die Aufsichtserkennung läuft.
BLOCKING	Blockiermodus für die Erkennung. Die Antwort wird blockiert, während die Aufsichtserkennung läuft.

Typ

Art des Supervisors.

Enums
TYPE_UNSPECIFIED	Typ ist nicht angegeben.
INVALID_TEXT	Ungültiger Problemtyp für Text.
LANGUAGE_SHIFT	Problemtyp für Sprachwechsel.
SPEAKER_SHIFT	Problemtyp „Lautsprecher verschoben“
AUDIO_MISMATCH	Typ des Problems mit der Audio-Inkongruenz.
MISSING_TOOL_CALL	Der Problemtyp für den Toolaufruf fehlt.
CUSTOM	Benutzerdefinierter Problematyp
CHOPPY_AUDIO	Problemtyp „Abgehackte Übertragung“
PROFANITY	Typ des Problems mit Obszönitäten im KI-Agenten.

Bild

Stellt eine Bild-Ein- oder ‑Ausgabe in der Unterhaltung dar.

Felder
mime_type	string Erforderlich. Der IANA-Standard-MIME-Typ der Quelldaten. Unterstützte Bildtypen: * image/png * image/jpeg * image/webp
data	bytes Erforderlich. Rohbyte des Bildes.
alt_text	string Optional. Der Alternativtext für das Bild.

ImportAppRequest

Anfragenachricht für AgentService.ImportApp.

Felder
parent	string Erforderlich. Der Name der übergeordneten Ressource mit dem Speicherort der zu importierenden App.
display_name	string Optional. Der Anzeigename der zu importierenden App. * Wenn die App beim Import erstellt wird und der Anzeigename angegeben ist, wird dieser für die importierte App verwendet. Wenn ein Konflikt mit einer vorhandenen App erkannt wird, wird dem Anzeigenamen ein Zeitstempel angehängt, um ihn eindeutig zu machen. * Wenn die App ein Reimport ist, sollte dieses Feld nicht festgelegt werden. Wenn Sie beim Reimport einen Anzeigenamen angeben, wird der Fehler INVALID_ARGUMENT zurückgegeben.
app_id	string Optional. Die ID für die importierte App. * Wenn sie nicht angegeben ist, wird der App automatisch eine eindeutige ID zugewiesen. * Andernfalls wird diese ID als letzte Komponente des Ressourcennamens der importierten App verwendet. Wenn am angegebenen Speicherort im Projekt bereits eine App mit derselben ID vorhanden ist, wird der Inhalt der vorhandenen App ersetzt.
import_options	ImportAppRequest.ImportOptions Optional. Optionen für den Importvorgang für die App.
ignore_app_lock	bool Optional. Flag zum Außerkraftsetzen der App-Sperre während des Imports. Wenn auf „true“ gesetzt, wird die App-Sperre beim Importvorgang ignoriert.
Union-Feld app. Die zu importierende App. Für app ist nur einer der folgenden Werte zulässig:
gcs_uri	string Der Google Cloud Storage-URI, aus dem die App importiert werden soll. Das Format dieses URI muss gs://<bucket-name>/<object-name> sein.
app_content	bytes Rohe Byte, die die komprimierte ZIP-Datei mit der Ordnerstruktur der App darstellen.
Union-Feld json_patch. Die JSON-Patches, die auf die importierte App angewendet werden sollen. json_patch kann nur einer der folgenden Werte sein:
json_patch_content	string Optional. Patch-Inhalt als JSON-String.
json_patch_gcs_uri	string Optional. Ein Cloud Storage-URI, der auf eine JSON-Datei mit den Patches verweist.

ImportOptions

Konfigurationsoptionen für den App-Import. Mit diesen Optionen wird das Importverhalten gesteuert, insbesondere wenn Konflikte mit vorhandenen App-Daten auftreten.

Felder
conflict_resolution_strategy	ImportAppRequest.ImportOptions.ConflictResolutionStrategy Optional. Die Strategie, die beim Beheben von Konflikten während des Imports verwendet werden soll.
validate_only	bool Optional. Flagge für den Testlauf des Importvorgangs. Wenn der Wert auf „true“ gesetzt ist, werden beim Importvorgang nur Validierungen durchgeführt. Es werden keine Änderungen an der vorhandenen App vorgenommen und keine neue App erstellt.

ConflictResolutionStrategy

Definiert die Strategie für den Umgang mit Konflikten, wenn eine App mit derselben ID bereits vorhanden ist oder wenn importierte Ressourcen (z. B. Agents, Tools usw.) dieselben Anzeigenamen wie vorhandene Ressourcen in dieser App haben.

Enums
CONFLICT_RESOLUTION_STRATEGY_UNSPECIFIED	Die Strategie zur Konfliktlösung ist nicht angegeben.
REPLACE	Vorhandene Daten durch importierte Daten ersetzen Wenn bereits eine App mit demselben app_id vorhanden ist, werden ihre Inhalte basierend auf der importierten App aktualisiert. Ressourcen (App, Agents, Tools, Beispiele, Guardrails, Toolsets) in der importierten App, die denselben Anzeigenamen wie vorhandene Ressourcen haben, überschreiben die vorhandenen Ressourcen. – Importierte Ressourcen mit neuen Anzeigenamen werden erstellt. – Vorhandene Ressourcen, die in der importierten App keinen passenden Anzeigenamen haben, bleiben unverändert.
OVERWRITE	Vorhandene Daten mit importierten Daten überschreiben Wenn bereits eine App mit derselben app_id vorhanden ist, werden ihre Inhalte mit der importierten App überschrieben. Vorhandene Ressourcen (Agents, Tools, Beispiele, Schutzmaßnahmen, Toolsets) in der App werden gelöscht. – Importierte Ressourcen werden als neue Ressourcen erstellt.

ImportAppResponse

Antwortnachricht für AgentService.ImportApp.

Felder
name	string Der Ressourcenname der importierten App.
warnings[]	string Warnmeldungen, die während des Importvorgangs generiert wurden. Wenn bei bestimmten Ressourcen Fehler auftreten, werden sie nicht in die importierte App aufgenommen und der Fehler wird hier erwähnt.

InputAudioConfig

Mit InputAudioConfig wird konfiguriert, wie der CES-Agent die eingehenden Audiodaten interpretieren soll.

Felder
audio_encoding	AudioEncoding Erforderlich. Die Codierung der Eingangsaudiodaten.
sample_rate_hertz	int32 Erforderlich. Die Abtastrate (in Hertz) der Eingabeaudiodaten.
noise_suppression_level	string Optional. Gibt an, ob die Rauschunterdrückung für das eingegebene Audio aktiviert werden soll. Mögliche Werte sind „low“, „moderate“, „high“ und „very_high“.

InstagramCredentials

Sitzungsspezifische Meta-Anmeldedaten für die native Instagram-Integration.

Felder
auth_code	string Erforderlich. Der Meta-Autorisierungscode, der vom eingebetteten Registrierungsvorgang bereitgestellt wird.
conversation_profile_id	string Optional. Die Konversationsprofil-ID, die für die Bereitstellung verwendet werden soll.

InterruptionSignal

Gibt an, dass die Audioantwort des Agenten unterbrochen wurde. Der Client sollte die aktuelle Audiowiedergabe sofort beenden, z.B. aufgrund einer Nutzerunterbrechung oder einer neuen Antwort des Agenten.

Felder
barge_in	bool Gibt an, ob die Unterbrechung durch ein Ereignis ausgelöst wurde, bei dem der Nutzer sich eingemischt hat.

LanguageSettings

Spracheinstellungen der App.

Felder
default_language_code	string Optional. Der Standardsprachcode der App.
supported_language_codes[]	string Optional. Liste der Sprachcodes, die von der App zusätzlich zu default_language_code unterstützt werden.
enable_multilingual_support	bool Optional. Ermöglicht die Unterstützung mehrerer Sprachen. Bei „true“ verwenden die Agents in der App vordefinierte Anweisungen, um die Verarbeitung mehrsprachiger Eingaben zu verbessern.
fallback_action (deprecated)	string Dieses Element wird nicht mehr unterstützt. Optional. Eingestellt: Diese Funktion wird nicht mehr unterstützt. Verwenden Sie stattdessen enable_multilingual_support, um die Verarbeitung mehrsprachiger Eingaben zu verbessern. Die Aktion, die ausgeführt werden soll, wenn ein Agent Eingaben in einer nicht unterstützten Sprache erhält. Das kann eine vordefinierte Aktion oder ein benutzerdefinierter Tool-Aufruf sein. Gültige Werte sind: - Der vollständige Ressourcenname eines Tools, der die Ausführung eines bestimmten Tools auslöst. – Eine vordefinierte Systemaktion wie „escalate“ (eskalieren) oder „exit“ (beenden), die ein EndSession-Signal mit dem entsprechenden metadata auslöst, um die Unterhaltung zu beenden.

ListAgentsRequest

Anfragenachricht für AgentService.ListAgents.

Felder
parent	string Erforderlich. Der Ressourcenname der App, aus der die Agenten aufgelistet werden sollen.
page_size	int32 Optional. Angeforderte Seitengröße. Der Server gibt möglicherweise weniger Elemente als angefordert zurück. Wenn kein Wert angegeben wurde, wählt der Server einen geeigneten Standardwert aus.
page_token	string Optional. Der Wert next_page_token wurde gegebenenfalls von einem vorherigen AgentService.ListAgents-Listenaufruf zurückgegeben.
filter	string Optional. Filter, der beim Auflisten der KI-Agents angewendet werden soll. Weitere Informationen finden Sie unter https://google.aip.dev/160.
order_by	string Optional. Feld, nach dem sortiert werden soll. Nur „name“ und „create_time“ werden unterstützt. Weitere Informationen finden Sie unter https://google.aip.dev/132#ordering.

ListAgentsResponse

Antwortnachricht für AgentService.ListAgents.

Felder
agents[]	Agent Die Liste der Agents.
next_page_token	string Ein Token, das als ListAgentsRequest.page_token gesendet werden kann, um die nächste Seite abzurufen. Wenn dieses Feld fehlt, gibt es keine nachfolgenden Seiten.

ListAppVersionsRequest

Anfragenachricht für AgentService.ListAppVersions.

Felder
parent	string Erforderlich. Der Ressourcenname der App, für die App-Versionen aufgeführt werden sollen.
page_size	int32 Optional. Angeforderte Seitengröße. Der Server gibt möglicherweise weniger Elemente als angefordert zurück. Wenn kein Wert angegeben wurde, wählt der Server einen geeigneten Standardwert aus.
page_token	string Optional. Der Wert next_page_token wurde gegebenenfalls von einem vorherigen AgentService.ListAppVersions-Listenaufruf zurückgegeben.
filter	string Optional. Filter, der beim Auflisten der App-Versionen angewendet werden soll. Weitere Informationen finden Sie unter https://google.aip.dev/160.
order_by	string Optional. Feld, nach dem sortiert werden soll. Nur „name“ und „create_time“ werden unterstützt. Weitere Informationen finden Sie unter https://google.aip.dev/132#ordering.

ListAppVersionsResponse

Antwortnachricht für AgentService.ListAppVersions.

Felder
app_versions[]	AppVersion Die Liste der App-Versionen.
next_page_token	string Ein Token, das als ListAppVersionsRequest.page_token gesendet werden kann, um die nächste Seite abzurufen. Wenn dieses Feld fehlt, gibt es keine nachfolgenden Seiten.

ListAppsRequest

Anfragenachricht für AgentService.ListApps.

Felder
parent	string Erforderlich. Der Ressourcenname des Standorts, für den Apps aufgeführt werden sollen.
page_size	int32 Optional. Angeforderte Seitengröße. Der Server gibt möglicherweise weniger Elemente als angefordert zurück. Wenn kein Wert angegeben wurde, wählt der Server einen geeigneten Standardwert aus.
page_token	string Optional. Der Wert next_page_token wurde gegebenenfalls von einem vorherigen AgentService.ListApps-Listenaufruf zurückgegeben.
filter	string Optional. Filter, der beim Auflisten der Apps angewendet werden soll. Weitere Informationen finden Sie unter https://google.aip.dev/160.
order_by	string Optional. Feld, nach dem sortiert werden soll. Nur „name“ und „create_time“ werden unterstützt. Weitere Informationen finden Sie unter https://google.aip.dev/132#ordering.

ListAppsResponse

Antwortnachricht für AgentService.ListApps.

Felder
apps[]	App Die Liste der Apps.
next_page_token	string Ein Token, das als ListAppsRequest.page_token gesendet werden kann, um die nächste Seite abzurufen. Wenn dieses Feld fehlt, gibt es keine nachfolgenden Seiten.
unreachable[]	string Unsortierte Liste. Standorte, die nicht erreicht werden konnten.

ListChangelogsRequest

Anfragenachricht für AgentService.ListChangelogs.

Felder
parent	string Erforderlich. Der Ressourcenname der App, für die Changelogs aufgeführt werden sollen.
page_size	int32 Optional. Angeforderte Seitengröße. Der Server gibt möglicherweise weniger Elemente als angefordert zurück. Wenn kein Wert angegeben wurde, wählt der Server einen geeigneten Standardwert aus.
page_token	string Optional. Der Wert next_page_token wurde gegebenenfalls von einem vorherigen AgentService.ListChangelogs-Listenaufruf zurückgegeben.
filter	string Optional. Filter, der beim Auflisten der Änderungsprotokolle angewendet werden soll. Weitere Informationen finden Sie unter https://google.aip.dev/160. Mit dem Filterstring kann nach action, resource_type, resource_name, author und create_time gefiltert werden. Der :-Vergleichsoperator kann für teilweise Übereinstimmungen ohne Berücksichtigung der Groß-/Kleinschreibung für Stringfelder verwendet werden, während = eine genaue Übereinstimmung mit Berücksichtigung der Groß-/Kleinschreibung ausführt. Beispiele: * action:update (Teilabgleich ohne Berücksichtigung der Groß-/Kleinschreibung) * action="Create" (genauer Abgleich mit Berücksichtigung der Groß-/Kleinschreibung) * 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 Optional. Feld, nach dem sortiert werden soll. Nur „name“ und „create_time“ werden unterstützt. Weitere Informationen finden Sie unter https://google.aip.dev/132#ordering.

ListChangelogsResponse

Antwortnachricht für AgentService.ListChangelogs.

Felder
changelogs[]	Changelog Die Liste der Änderungslogs.
next_page_token	string Ein Token, das als ListChangelogsRequest.page_token gesendet werden kann, um die nächste Seite abzurufen. Wenn dieses Feld fehlt, gibt es keine nachfolgenden Seiten.

ListConversationsRequest

Anfragenachricht für AgentService.ListConversations.

Felder
parent	string Erforderlich. Der Ressourcenname der App, aus der Unterhaltungen aufgelistet werden sollen.
page_size	int32 Optional. Angeforderte Seitengröße. Der Server gibt möglicherweise weniger Elemente als angefordert zurück. Wenn kein Wert angegeben wurde, wählt der Server einen geeigneten Standardwert aus.
page_token	string Optional. Der Wert next_page_token wurde gegebenenfalls von einem vorherigen AgentService.ListConversations-Listenaufruf zurückgegeben.
filter	string Optional. Filter, der beim Auflisten der Unterhaltungen angewendet werden soll. Weitere Informationen finden Sie unter https://google.aip.dev/160.
source	Conversation.Source Optional. Geben Sie die Quelle der Unterhaltung an. Wenn nicht festgelegt, wird standardmäßig „Source.Live“ angewendet. Wird zugunsten des Felds sources eingestellt.
sources[]	Conversation.Source Optional. Geben Sie die Quellen der Unterhaltungen an. Wenn nicht festgelegt, werden standardmäßig alle verfügbaren Quellen angewendet.

ListConversationsResponse

Antwortnachricht für AgentService.ListConversations.

Felder
conversations[]	Conversation Die Liste der Unterhaltungen.
next_page_token	string Ein Token, das als ListConversationsRequest.page_token gesendet werden kann, um die nächste Seite abzurufen. Wenn dieses Feld fehlt, gibt es keine nachfolgenden Seiten.

ListDeploymentsRequest

Anfragenachricht für AgentService.ListDeployments.

Felder
parent	string Erforderlich. Die übergeordnete App. Format: projects/{project}/locations/{location}/apps/{app}
page_size	int32 Optional. Die maximale Anzahl der zurückzugebenden Deployments. Der Dienst gibt möglicherweise weniger als diesen Wert zurück. Wenn nicht angegeben, werden maximal 50 Bereitstellungen zurückgegeben. Der Höchstwert liegt bei 1.000. Alle Werte darüber werden implizit in 1.000 umgewandelt.
page_token	string Optional. Ein Seitentoken, das von einem vorherigen ListDeployments-Aufruf empfangen wurde. Geben Sie dieses an, um die nachfolgende Seite abzurufen. Beim Paginieren müssen alle anderen für ListDeployments bereitgestellten Parameter mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat.
order_by	string Optional. Feld, nach dem sortiert werden soll. Nur „name“ und „create_time“ werden unterstützt. Weitere Informationen finden Sie unter https://google.aip.dev/132#ordering.

ListDeploymentsResponse

Antwortnachricht für AgentService.ListDeployments.

Felder
deployments[]	Deployment Die Liste der Bereitstellungen.
next_page_token	string Ein Token, das als page_token gesendet werden kann, um die nächste Seite abzurufen. Wenn dieses Feld weggelassen wird, gibt es keine nachfolgenden Seiten.

ListExamplesRequest

Anfragenachricht für AgentService.ListExamples.

Felder
parent	string Erforderlich. Der Ressourcenname der App, aus der Beispiele aufgeführt werden sollen.
page_size	int32 Optional. Angeforderte Seitengröße. Der Server gibt möglicherweise weniger Elemente als angefordert zurück. Wenn kein Wert angegeben wurde, wählt der Server einen geeigneten Standardwert aus.
page_token	string Optional. Der Wert next_page_token wurde gegebenenfalls von einem vorherigen AgentService.ListExamples-Listenaufruf zurückgegeben.
filter	string Optional. Filter, der beim Auflisten der Beispiele angewendet werden soll. Weitere Informationen finden Sie unter https://google.aip.dev/160.
order_by	string Optional. Feld, nach dem sortiert werden soll. Nur „name“ und „create_time“ werden unterstützt. Weitere Informationen finden Sie unter https://google.aip.dev/132#ordering.

ListExamplesResponse

Antwortnachricht für AgentService.ListExamples.

Felder
examples[]	Example Die Liste der Beispiele.
next_page_token	string Ein Token, das als ListExamplesRequest.page_token gesendet werden kann, um die nächste Seite abzurufen. Wenn dieses Feld fehlt, gibt es keine nachfolgenden Seiten.

ListGuardrailsRequest

Anfragenachricht für AgentService.ListGuardrails.

Felder
parent	string Erforderlich. Der Ressourcenname der App, für die Schutzmaßnahmen aufgeführt werden sollen.
page_size	int32 Optional. Angeforderte Seitengröße. Der Server gibt möglicherweise weniger Elemente als angefordert zurück. Wenn kein Wert angegeben wurde, wählt der Server einen geeigneten Standardwert aus.
page_token	string Optional. Der Wert next_page_token wurde gegebenenfalls von einem vorherigen AgentService.ListGuardrails-Listenaufruf zurückgegeben.
filter	string Optional. Filter, der beim Auflisten der Sicherheitsmaßnahmen angewendet werden soll. Weitere Informationen finden Sie unter https://google.aip.dev/160.
order_by	string Optional. Feld, nach dem sortiert werden soll. Nur „name“ und „create_time“ werden unterstützt. Weitere Informationen finden Sie unter https://google.aip.dev/132#ordering.

ListGuardrailsResponse

Antwortnachricht für AgentService.ListGuardrails.

Felder
guardrails[]	Guardrail Die Liste der Schutzmaßnahmen.
next_page_token	string Ein Token, das als ListGuardrailsRequest.page_token gesendet werden kann, um die nächste Seite abzurufen. Wenn dieses Feld fehlt, gibt es keine nachfolgenden Seiten.

ListToolsRequest

Anfragenachricht für AgentService.ListTools.

Felder
parent	string Erforderlich. Der Ressourcenname der App, aus der Tools aufgeführt werden sollen.
page_size	int32 Optional. Angeforderte Seitengröße. Der Server gibt möglicherweise weniger Elemente als angefordert zurück. Wenn kein Wert angegeben wurde, wählt der Server einen geeigneten Standardwert aus.
page_token	string Optional. Der Wert next_page_token wurde gegebenenfalls von einem vorherigen AgentService.ListTools-Listenaufruf zurückgegeben.
filter	string Optional. Filter, der beim Auflisten der Tools angewendet werden soll. Verwenden Sie „include_system_tools=true“, um Systemtools in die Antwort einzubeziehen. Weitere Informationen finden Sie unter https://google.aip.dev/160.
order_by	string Optional. Feld, nach dem sortiert werden soll. Nur „name“ und „create_time“ werden unterstützt. Weitere Informationen finden Sie unter https://google.aip.dev/132#ordering.

ListToolsResponse

Antwortnachricht für AgentService.ListTools.

Felder
tools[]	Tool Die Liste der Tools.
next_page_token	string Ein Token, das als ListToolsRequest.page_token gesendet werden kann, um die nächste Seite abzurufen. Wenn dieses Feld fehlt, gibt es keine nachfolgenden Seiten.

ListToolsetsRequest

Anfragenachricht für AgentService.ListToolsets.

Felder
parent	string Erforderlich. Der Ressourcenname der App, aus der Toolsets aufgeführt werden sollen.
page_size	int32 Optional. Angeforderte Seitengröße. Der Server gibt möglicherweise weniger Elemente als angefordert zurück. Wenn kein Wert angegeben wurde, wählt der Server einen geeigneten Standardwert aus.
page_token	string Optional. Der Wert next_page_token wurde gegebenenfalls von einem vorherigen AgentService.ListToolsets-Listenaufruf zurückgegeben.
filter	string Optional. Filter, der beim Auflisten der Toolsets angewendet werden soll. Weitere Informationen finden Sie unter https://google.aip.dev/160.
order_by	string Optional. Feld, nach dem sortiert werden soll. Nur „name“ und „create_time“ werden unterstützt. Weitere Informationen finden Sie unter https://google.aip.dev/132#ordering.

ListToolsetsResponse

Antwortnachricht für AgentService.ListToolsets.

Felder
toolsets[]	Toolset Die Liste der Toolsets.
next_page_token	string Ein Token, das als ListToolsetsRequest.page_token gesendet werden kann, um die nächste Seite abzurufen. Wenn dieses Feld fehlt, gibt es keine nachfolgenden Seiten.

LoggingSettings

Einstellungen zur Beschreibung des Logging-Verhaltens für die App.

Felder
redaction_config	RedactionConfig Optional. Konfiguration für das Unkenntlichmachen sensibler Daten.
audio_recording_config	AudioRecordingConfig Optional. Konfiguration für die Aufzeichnung von Audiointeraktionen. Das Audio unterliegt der Schwärzung, wie in RedactionConfig konfiguriert.
unredacted_audio_recording_config	AudioRecordingConfig Optional. Konfiguriert eine zusätzliche Aufzeichnung von Audio ohne Schwärzungen. So kann eine Rohkopie des Audios beibehalten werden, wenn die Audio-Schwärzung enabled ist, in der Regel für Audit- oder Überwachungszwecke.
bigquery_export_settings	BigQueryExportSettings Optional. Konfiguriert das BigQuery-Exportverhalten für die App. Die Unterhaltungsdaten werden gemäß der Konfiguration in RedactionConfig anonymisiert.
unredacted_bigquery_export_settings	BigQueryExportSettings Optional. Konfiguriert das BigQuery-Exportverhalten für die App. Die nicht geschwärzten Unterhaltungsdaten werden in BigQuery-Tabellen exportiert, wenn der Export aktiviert ist.
cloud_logging_settings	CloudLoggingSettings Optional. Einstellungen zur Beschreibung des Cloud Logging-Verhaltens für die App.
conversation_logging_settings	ConversationLoggingSettings Optional. Einstellungen zur Beschreibung des Verhaltens beim Aufzeichnen von Unterhaltungen für die App.
evaluation_audio_recording_config	AudioRecordingConfig Optional. Konfiguration für die Aufzeichnung von Audio-Interaktionen für die Bewertung. Standardmäßig ist die Audioaufnahme für Evaluationssitzungen nicht aktiviert.
metric_analysis_settings	MetricAnalysisSettings Optional. Einstellungen zur Beschreibung des Verhaltens bei der Erhebung von Konversationsdaten für die LLM-Analyse-Pipeline für die App.

McpTool

Ein MCP-Tool. Weitere Informationen finden Sie unter https://modelcontextprotocol.io/specification/2025-06-18/server/tools.

Felder
name	string Erforderlich. Der Name des MCP-Tools.
name_override	string Optional. Die Namensüberschreibung des MCP-Tools. Dieses Feld wird ausgefüllt, wenn der Name durch eine Toolset-Überschreibung überschrieben wurde.
description	string Optional. Die Beschreibung des MCP-Tools.
input_schema	Schema Optional. Das Schema der Eingabeargumente des MCP-Tools.
output_schema	Schema Optional. Das Schema der Ausgabeargumente des MCP-Tools.
server_address	string Erforderlich. Die Serveradresse des MCP-Servers, z.B. „https://example.com/mcp/“. Wenn der Server mit dem MCP SDK erstellt wurde, sollte die URL mit „/mcp/“ enden. Es werden nur Server unterstützt, die auf dem Streamable HTTP-Transport basieren. Dies entspricht der server_address in McpToolset. Weitere Informationen finden Sie unter https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http.
api_authentication	ApiAuthentication Optional. Authentifizierungsinformationen, die zum Ausführen des Tools auf dem MCP-Server erforderlich sind. Bei der Authentifizierung mit einem Bearer-Token gilt das Token nur für die Ausführung von Tools, nicht für die Auflistung von Tools. Dazu müssen Tools ohne Authentifizierung aufgeführt werden können.
tls_config	TlsConfig Optional. Die TLS-Konfiguration. Enthält die benutzerdefinierten Serverzertifikate, denen der Client vertrauen soll.
service_directory_config	ServiceDirectoryConfig Optional. Service Directory-Konfiguration für VPC-SC, die zum Auflösen von Dienstnamen innerhalb eines Perimeters verwendet wird.
custom_headers	map<string, string> Optional. Die benutzerdefinierten Header, die in der Anfrage an den MCP-Server gesendet werden sollen. Die Werte müssen im Format $context.variables.<name_of_variable> angegeben werden und können in den Sitzungsvariablen festgelegt werden. Weitere Informationen finden Sie unter https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection.
state	McpTool.State Nur Ausgabe. Der dynamische Verfügbarkeitsstatus des Tools auf dem externen Server.

Bundesland

Stellt den dynamischen Verfügbarkeitsstatus des Tools dar.

Enums
STATE_UNSPECIFIED	Standardstatus.
ACTIVE	Das Tool ist verfügbar und wird aktiv vom Server angeboten.
INACTIVE	Das Tool ist konfiguriert oder angepinnt, wird aber derzeit nicht vom Server angeboten.
STALE	Das Tool ist auf dem Server vorhanden, stimmt aber nicht mit der Version auf dem Server überein.

McpToolDefinition

Container für die wichtigsten Definitionselemente eines Tools, die als Snapshot erfasst werden. Schemas im Snapshot werden unverändert verwendet und können nicht überschrieben werden.

Felder
description	string Nur Ausgabe. Die Beschreibung des MCP-Tools. Dies kann durch description_override in McpToolOverride überschrieben werden.
input_schema	Schema Nur Ausgabe. Das Schema der Eingabeargumente des MCP-Tools.
output_schema	Schema Nur Ausgabe. Das Schema der Ausgabeargumente des MCP-Tools.

McpToolOverride

Überschreibungen, die einem bestimmten Tool in einem Toolset zugeordnet sind. Dadurch können Tool-Definitionen vom externen dynamischen Server angepinnt oder überschrieben werden.

Felder
tool	string Erforderlich. Der ursprüngliche Name des Tools, wie er vom MCP-Server ausgegeben wird.
name_override	string Optional. Falls vorhanden, wird dieser Name im Agent anstelle des ursprünglichen Namens verwendet. Dies wird hauptsächlich als Alias verwendet, wenn der MCP-Server schlecht benannte Tools anbietet.
description_override	string Optional. Falls vorhanden, wird diese Beschreibung anstelle der ursprünglichen Beschreibung vom Server verwendet.
snapshot	McpToolDefinition Nur Ausgabe. Wenn dieses Tool vorhanden ist, wird es angepinnt und verwendet die Snapshot-Werte als Fallback, wenn der Server vorübergehend nicht verfügbar ist oder keine Überschreibung vorhanden ist.

McpToolset

Ein Toolset, das eine Liste der Tools enthält, die vom MCP-Server angeboten werden.

Felder
server_address	string Erforderlich. Die Adresse des MCP-Servers, z. B. „https://beispiel.de/mcp/“. Wenn der Server mit dem MCP SDK erstellt wurde, sollte die URL mit „/mcp/“ enden. Es werden nur Server unterstützt, die auf dem Streamable HTTP-Transport basieren. Weitere Informationen finden Sie unter https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http.
api_authentication	ApiAuthentication Optional. Authentifizierungsinformationen, die für den Zugriff auf Tools und die Ausführung eines Tools auf dem MCP-Server erforderlich sind. Bei der Authentifizierung mit einem Bearer-Token gilt das Token nur für die Ausführung von Tools, nicht für die Auflistung von Tools. Dazu müssen Tools ohne Authentifizierung aufgeführt werden können.
service_directory_config	ServiceDirectoryConfig Optional. Service Directory-Konfiguration für VPC-SC, die zum Auflösen von Dienstnamen innerhalb eines Perimeters verwendet wird.
tls_config	TlsConfig Optional. Die TLS-Konfiguration. Enthält die benutzerdefinierten Serverzertifikate, denen der Client vertrauen soll.
custom_headers	map<string, string> Optional. Die benutzerdefinierten Header, die in der Anfrage an den MCP-Server gesendet werden sollen. Die Werte müssen im Format $context.variables.<name_of_variable> angegeben werden und können in den Sitzungsvariablen festgelegt werden. Weitere Informationen finden Sie unter https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection.
tool_overrides[]	McpToolOverride Optional. Überschreibungen für einzelne Tools in diesem Toolset. So können Sie bestimmte Details wie Beschreibungen oder Namen überschreiben oder den Status der Tools fixieren, damit er nicht vollständig dynamisch ist.

Nachricht

Eine Nachricht in einer Unterhaltung.

Felder
role	string Optional. Die Rolle in der Unterhaltung, z.B. „user“ (Nutzer), „agent“ (KI-Agent).
chunks[]	Chunk Optional. Inhalt der Nachricht als Reihe von Chunks.
event_time	Timestamp Optional. Zeitstempel für den Versand oder Empfang der Nachricht. Sollte nicht verwendet werden, wenn die Nachricht Teil eines example ist.

MetricAnalysisSettings

Einstellungen zur Beschreibung des Verhaltens bei der Erfassung von Konversationsdaten für die Pipeline mit LLM-Analyse-Messwerten.

Felder
llm_metrics_opted_out	bool Optional. Gibt an, ob Konversationsdaten für LLM-Analyse-Messwerte erfasst werden sollen. Wenn „true“, werden keine Konversationsdaten für LLM-Analyse-Messwerte erhoben. Andernfalls werden Konversationsdaten erhoben.

MockConfig

Konfiguration von simulierten Toolaufrufen für die Sitzung.

Felder
mocked_tool_calls[]	MockedToolCall Optional. Alle Toolaufrufe, die für die Dauer der Sitzung simuliert werden sollen.
unmatched_tool_call_behavior	MockConfig.UnmatchedToolCallBehavior Erforderlich. Verhalten für Tool-Aufrufe, die mit keinem Argumentmuster in „mocked_tool_calls“ übereinstimmen.

UnmatchedToolCallBehavior

Was zu tun ist, wenn ein Toolaufruf nicht mit einem der simulierten Toolaufrufe übereinstimmt.

Enums
UNMATCHED_TOOL_CALL_BEHAVIOR_UNSPECIFIED	Standardwert. Dieser Wert wird nicht verwendet.
FAIL	Gibt einen Fehler für alle Tool-Aufrufe aus, die nicht mit einem erwarteten Mock-Eingabemuster übereinstimmen.
PASS_THROUGH	Leiten Sie nicht übereinstimmende Tool-Aufrufe an das tatsächliche Tool weiter.

MockedToolCall

Ein simulierter Toolaufruf.

Gibt das Zieltool und ein Muster an, das mit den Argumenten / Eingaben des Tools abgeglichen werden soll. Wenn das Muster übereinstimmt, wird die Mock-Antwort zurückgegeben.

Felder
tool (deprecated)	string Dieses Element wird nicht mehr unterstützt. Optional. Verworfen Verwenden Sie stattdessen „tool_identifier“.
expected_args_pattern	Struct Erforderlich. Ein Muster, das mit den Argumenten / Eingaben aller gesendeten Tool-Aufrufe abgeglichen wird. Wenn die Eingaben des Toolaufrufs mit diesem Muster übereinstimmen, wird die Mock-Ausgabe zurückgegeben.
mock_response	Struct Optional. Die Mock-Antwort bzw. -Ausgabe, die zurückgegeben werden soll, wenn die Argumente bzw. Eingaben des Toolaufrufs mit dem Muster übereinstimmen.
Union-Feld tool_identifier. Die Kennung des zu simulierenden Tools. Für tool_identifier ist nur einer der folgenden Werte zulässig:
tool_id	string Optional. Der Name des zu simulierenden Tools. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolset	ToolsetTool Optional. Das zu simulierende Toolset.

ModelSettings

Die Modelleinstellungen enthalten verschiedene Konfigurationen für das LLM-Modell.

Felder
model	string Optional. Das LLM-Modell, das der Agent verwenden soll. Wenn nicht festgelegt, übernimmt der Agent das Modell von seinem übergeordneten Agent.
thinking_level	ModelSettings.ThinkingLevel Optional. Der Denkaufwand des Modells.
temperature	double Optional. Wenn festgelegt, wird diese Temperatur für das LLM-Modell verwendet. Die Temperatur steuert die Zufälligkeit der Antworten des Modells. Niedrigere Temperaturen führen zu vorhersagbareren Antworten. Höhere Temperaturen führen zu kreativeren Antworten.

ThinkingLevel

Konfiguration des Denkaufwands für das Modell.

Enums
THINKING_LEVEL_UNSPECIFIED	Der Denkaufwand ist nicht angegeben.
DEFAULT	Standardmäßiger Denkaufwand.
LOW	Geringer Denkaufwand.
MEDIUM	Mittlerer Denkaufwand
HIGH	Hoher Denkaufwand

OAuthConfig

Konfigurationen für die Authentifizierung mit OAuth.

Felder
oauth_grant_type	OAuthConfig.OauthGrantType Erforderlich. OAuth-Berechtigungstypen.
client_id	string Erforderlich. Die Client-ID des OAuth-Anbieters.
client_secret_version	string Erforderlich. Der Name der SecretManager-Secret-Versionsressource, in der der Clientschlüssel gespeichert ist. Format: projects/{project}/secrets/{secret}/versions/{version} Hinweis: Sie sollten dem CES-Dienst-Agenten service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com die Rolle roles/secretmanager.secretAccessor zuweisen.
token_endpoint	string Erforderlich. Der Token-Endpunkt im OAuth-Anbieter, der gegen ein Zugriffstoken ausgetauscht werden soll.
scopes[]	string Optional. Die zu gewährenden OAuth-Bereiche.

OauthGrantType

OAuth-Berechtigungstypen. Es wird nur Clientanmeldedaten-Gewährung unterstützt.

Enums
OAUTH_GRANT_TYPE_UNSPECIFIED	Nicht angegeben. Die Standardeinstellung ist CLIENT_CREDENTIAL.
CLIENT_CREDENTIAL	Stellt den Ablauf für Clientanmeldedaten dar.

OpenApiTool

Ein Remote-API-Tool, das durch ein OpenAPI-Schema definiert wird.

Felder
open_api_schema	string Erforderlich. Das OpenAPI-Schema im JSON- oder YAML-Format.
name	string Optional. Der Name des Tools. Wenn kein Name angegeben ist, wird der Name des Tools aus dem OpenAPI-Schema abgeleitet, aus operation.operationId.
description	string Optional. Die Beschreibung des Tools. Wenn sie nicht angegeben ist, wird die Beschreibung des Tools aus dem OpenAPI-Schema, aus operation.description oder aus operation.summary abgeleitet.
api_authentication	ApiAuthentication Optional. Von der API benötigte Authentifizierungsinformationen.
tls_config	TlsConfig Optional. Die TLS-Konfiguration. Enthält die benutzerdefinierten Serverzertifikate, denen der Client vertrauen soll.
service_directory_config	ServiceDirectoryConfig Optional. Service Directory-Konfiguration.
ignore_unknown_fields	bool Optional. Bei „true“ ignoriert der Agent unbekannte Felder in der API-Antwort.
url	string Optional. Die Server-URL des Open API-Schemas. Dieses Feld wird in Tools in den Umgebungsabhängigkeiten während des Exportvorgangs nur festgelegt, wenn das Schema eine Server-URL enthält. Wenn diese URL während des Importvorgangs in den Umgebungsabhängigkeiten vorhanden ist und das Schema den Platzhalter $env_var enthält, wird der Platzhalter im Schema ersetzt.

OpenApiToolset

Ein Toolset, das eine Liste von Tools enthält, die durch ein OpenAPI-Schema definiert werden.

Felder
open_api_schema	string Erforderlich. Das OpenAPI-Schema des Toolsets.
api_authentication	ApiAuthentication Optional. Von der API benötigte Authentifizierungsinformationen.
tls_config	TlsConfig Optional. Die TLS-Konfiguration. Benutzerdefinierte Serverzertifikate sind enthalten
service_directory_config	ServiceDirectoryConfig Optional. Service Directory-Konfiguration.
ignore_unknown_fields	bool Optional. Bei „true“ ignoriert der Agent unbekannte Felder in der API-Antwort für alle im OpenAPI-Schema definierten Vorgänge.
url	string Optional. Die Server-URL des Open API-Schemas. Dieses Feld wird nur in Toolsets in den Umgebungsabhängigkeiten während des Exportvorgangs festgelegt, wenn das Schema eine Server-URL enthält. Wenn diese URL während des Importvorgangs in den Umgebungsabhängigkeiten vorhanden ist und das Schema den Platzhalter $env_var enthält, wird der Platzhalter im Schema ersetzt.

OperationMetadata

Stellt die Metadaten des Vorgangs mit langer Ausführungszeit dar.

Felder
create_time	Timestamp [Nur Ausgabe] Die Zeit, zu der die Vorgang erstellt wurde.
end_time	Timestamp [Nur Ausgabe] Der Zeitpunkt, zu dem der Vorgang abgeschlossen wurde.
status_message	string Nur Ausgabe. Lesbarer Status des Vorgangs, falls vorhanden.
requested_cancellation	bool Nur Ausgabe. Gibt an, ob der Nutzer einen Abbruch angefordert hat. Vorgänge, die erfolgreich abgebrochen wurden, haben den Wert google.longrunning.Operation.error mit einem google.rpc.Status.code von 1, was Code.CANCELLED entspricht.

OutputAudioConfig

Mit OutputAudioConfig wird konfiguriert, wie der CES-Agent ausgehende Audioantworten synthetisieren soll.

Felder
audio_encoding	AudioEncoding Erforderlich. Die Codierung der Audioausgabedaten.
sample_rate_hertz	int32 Erforderlich. Die Abtastrate (in Hertz) der Ausgabedaten.

PythonCodeCondition

Python-Codeblock zum Auswerten der Bedingung.

Felder
python_code	string Erforderlich. Der auszuführende Python-Code.

PythonFunction

Ein Python-Funktionstool.

Felder
name	string Optional. Der Name der auszuführenden Python-Funktion. Muss mit einem Python-Funktionsnamen übereinstimmen, der im Python-Code definiert ist. Groß- und Kleinschreibung wird berücksichtigt. Wenn der Name nicht angegeben ist, wird die erste im Python-Code definierte Funktion verwendet.
python_code	string Optional. Der Python-Code, der für das Tool ausgeführt werden soll.
description	string Nur Ausgabe. Die Beschreibung der Python-Funktion, die aus dem Docstring des Python-Codes geparst wurde.
service_directory_config	ServiceDirectoryConfig Optional. Service Directory-Konfiguration für das Tool.

RecognitionResult

Ergebnis der Spracherkennung für die Audioeingabe.

Felder
transcript	string Optional. Verkettete Sprachsegmente des Nutzers, die während des aktuellen Zuges erfasst wurden.

RedactionConfig

Konfiguration, die angibt, wie mit sensiblen Daten umgegangen werden soll.

Felder
enable_redaction	bool Optional. Wenn „true“, wird die Schwärzung in verschiedenen Protokollierungsszenarien angewendet, einschließlich Gesprächsablauf, Cloud Logging und Audioaufzeichnung.
inspect_template	string Optional. DLP-Prüfvorlagenname zum Konfigurieren der Erkennung sensibler Datentypen. Format: projects/{project}/locations/{location}/inspectTemplates/{inspect_template}
deidentify_template	string Optional. Name der DLP-De-Identifikationsvorlage, um anzugeben, wie Inhalte de-identifiziert werden sollen. Format: projects/{project}/locations/{location}/deidentifyTemplates/{deidentify_template}

RemoteA2aConfig

Gemeinsame Konfiguration für die Verbindung zu einem A2A-Remote-Agent.

Felder
api_authentication	ApiAuthentication Optional. Authentifizierungskonfiguration für den Aufruf des Remote-Agents. Optional, wenn die Authentifizierung bereits über den Registry-Verweis erfolgt.
input_variable_mapping	map<string, string> Optional. Zuordnung von Eingabevariablennamen des Remote-Agents zu GECX-Variablennamen.
output_variable_mapping	map<string, string> Optional. Zuordnung von Ausgabevariablennamen des Remote-Agents zu GECX-Variablennamen.
streaming_enabled	bool Optional. Gibt an, ob Streaming für den Remote-Agent aktiviert ist.
context_id	string Optional. Wenn nicht leer, wird diese Kontext-ID für Interaktionen mit dem Remote-A2A-Agent verwendet. Das Feld „context_id“ kann sich auf eine Sitzungsvariable wie $context.variables.order_agent_session_id beziehen.
Union-Feld agent_spec. Spezifikation des Remote-Agents. Für agent_spec ist nur einer der folgenden Werte zulässig:
agent_card	AgentCard Optional. Die vollständige Agentenkarte, die inline definiert ist.
agent_registry	string Optional. Referenz auf den KI-Agenten in der Agent Registry. Format: projects/{project}/locations/{location}/agents/{agent}

RemoteAgentTool

Stellt ein Tool dar, mit dem der Agent einen anderen Remote-Agenten aufrufen kann.

Felder
name	string Erforderlich. Der Name des Tools.
description	string Erforderlich. Die Beschreibung des Tools.
agent_card	AgentCard Erforderlich. Die Agentenkarte des Remote-Agenten, der von diesem Tool aufgerufen wird.
api_authentication	ApiAuthentication Optional. Authentifizierungskonfiguration für den Aufruf des Remote-Agents.
stateful_agent	bool Optional. Wenn diese Option aktiviert ist, haben die Interaktion zwischen der CXAS-App und dem Remote-Agenten denselben Kontext. Wenn der Remote-Agent eine context_id zurückgibt, wird sie für die gesamte Sitzung für dieses Remote-Agent-Tool beibehalten.
input_variable_mapping	map<string, string> Optional. Zuordnung von Eingabevariablennamen des Remote-Agents zu GECX-Variablennamen.
output_variable_mapping	map<string, string> Optional. Zuordnung von Ausgabevariablennamen des Remote-Agents zu GECX-Variablennamen.

RestoreAppVersionRequest

Anfragenachricht für AgentService.RestoreAppVersion

Felder
name	string Erforderlich. Der Ressourcenname der wiederherzustellenden App-Version.

RestoreAppVersionResponse

Dieser Typ hat keine Felder.

Antwortnachricht für AgentService.RestoreAppVersion

RetrieveToolSchemaRequest

Anfragenachricht für ToolService.RetrieveToolSchema.

Felder
parent	string Erforderlich. Der Ressourcenname der App, zu der das Tool bzw. das Toolset gehört. Format: projects/{project}/locations/{location}/apps/{app}
Union-Feld tool_identifier. Die Kennung des Tools, für das das Schema abgerufen werden soll. Es kann sich entweder um ein dauerhaftes Tool oder ein Tool aus einem Toolset handeln. Für tool_identifier ist nur einer der folgenden Werte zulässig:
tool	string Optional. Der Name des Tools, für das das Schema abgerufen werden soll. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolset_tool	ToolsetTool Optional. Das Toolset-Tool, für das das Schema abgerufen werden soll. Nur ein Tool aus dem Toolset sollte dem Prädikat entsprechen. Andernfalls wird ein Fehler zurückgegeben.

RetrieveToolSchemaResponse

Antwortnachricht für ToolService.RetrieveToolSchema.

Felder
input_schema	Schema Das Schema der Eingabeparameter des Tools.
output_schema	Schema Das Schema der Ausgabeparameter des Tools.
Union-Feld tool_identifier. Die Kennung des Tools, für das das Schema gilt. Für tool_identifier ist nur einer der folgenden Werte zulässig:
tool	string Der Name des Tools, für das das Schema gilt. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolset_tool	ToolsetTool Das Toolset-Tool, für das das Schema gilt.

RetrieveToolsRequest

Anfragenachricht für ToolService.RetrieveTools.

Felder
toolset	string Erforderlich. Der Name des Toolsets, für das die Tools abgerufen werden sollen. Format: projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
tool_ids[]	string Optional. Die Kennungen der Tools, die aus dem Toolset abgerufen werden sollen. Wenn leer, werden alle Tools im Toolset zurückgegeben.
bypass_persistence_config	bool Optional. Wenn „true“, enthalten die zurückgegebenen Tools Rohbeschreibungen und Schemas direkt vom Server, wobei alle gespeicherten Persistenzkonfigurationen (Überschreibungen/Snapshots) umgangen werden.

RetrieveToolsResponse

Antwortnachricht für ToolService.RetrieveTools.

Felder
tools[]	Tool Die Liste der Tools, die im angegebenen Toolset enthalten sind.

RunSessionRequest

Anfragenachricht für SessionService.RunSession.

Felder
config	SessionConfig Erforderlich. Die Konfiguration für die Sitzung.
inputs[]	SessionInput Erforderlich. Eingaben für die Sitzung.

RunSessionResponse

Antwortnachricht für SessionService.RunSession.

Felder
outputs[]	SessionOutput Ausgaben für die Sitzung.

Schema

Stellt eine ausgewählte Teilmenge eines OpenAPI 3.0-Schemaobjekts dar.

Felder
type	Schema.Type Erforderlich. Der Typ der Daten.
properties	map<string, Schema> Optional. Attribute von Type.OBJECT.
required[]	string Optional. Erforderliche Attribute von Type.OBJECT.
description	string Optional. Die Beschreibung der Daten.
items	Schema Optional. Schema der Elemente von Type.ARRAY.
nullable	bool Optional. Gibt an, ob der Wert null sein darf.
unique_items	bool Optional. Gibt an, dass die Elemente im Array eindeutig sein müssen. Gilt nur für TYPE.ARRAY.
prefix_items[]	Schema Optional. Schemas der ersten Elemente von Type.ARRAY.
additional_properties	Schema Optional. Kann entweder ein boolescher Wert oder ein Objekt sein. Steuert das Vorhandensein zusätzlicher Attribute.
any_of[]	Schema Optional. Der Wert sollte anhand eines oder mehrerer der Unterschemas in der Liste validiert werden.
enum[]	string Optional. Mögliche Werte des Elements des einfachen Typs im enum-Format. Beispiele: 1. Wir können die Richtung so definieren : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. Wir können die Wohnungsnummer so definieren : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
default	Value Optional. Standardwert der Daten.
ref	string Optional. Ermöglicht indirekte Verweise zwischen Schemaknoten. Der Wert sollte ein gültiger Verweis auf ein untergeordnetes Element des Stammelements defs sein. Das folgende Schema definiert beispielsweise einen Verweis auf einen Schemaknoten mit dem Namen „Pet“: type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string Der Wert des Attributs „pet“ ist ein Verweis auf den Schemaknoten mit dem Namen „Pet“. Weitere Informationen finden Sie unter https://json-schema.org/understanding-json-schema/structuring.
defs	map<string, Schema> Optional. Eine Zuordnung von Definitionen, die von ref verwendet werden. Nur im Stammverzeichnis des Schemas zulässig.
title	string Optional. Der Titel des Schemas.
min_items	int64 Optional. Mindestanzahl der Elemente für Type.ARRAY.
max_items	int64 Optional. Maximale Anzahl der Elemente für Type.ARRAY.
minimum	double Optional. Mindestwert für Type.INTEGER und Type.NUMBER.
maximum	double Optional. Maximaler Wert für Type.INTEGER und Type.NUMBER.

Typ

OpenAPI-Datentypen.

Enums
TYPE_UNSPECIFIED	Der Typ ist nicht angegeben.
STRING	String-Typ.
INTEGER	Ganzzahltyp.
NUMBER	Nummertyp.
BOOLEAN	Boolescher Typ.
OBJECT	Objekttyp.
ARRAY	Array-Typ.

SecuritySettings

Sicherheitseinstellungen auf Projekt-/Standortebene für CES.

Felder
name	string ID. Die eindeutige Kennung der Sicherheitseinstellungen. Format: projects/{project}/locations/{location}/securitySettings
endpoint_control_policy	EndpointControlPolicy Optional. Einstellungen für die Endpunktsteuerung.
create_time	Timestamp Nur Ausgabe. Erstellungszeitpunkt der Sicherheitseinstellungen.
update_time	Timestamp Nur Ausgabe. Zeitpunkt der letzten Aktualisierung der Sicherheitseinstellungen.
etag	string Nur Ausgabe. Etag der Sicherheitseinstellungen.

ServiceAccountAuthConfig

Konfigurationen für die Authentifizierung mit einem benutzerdefinierten Dienstkonto.

Felder
service_account	string Erforderlich. Die E-Mail-Adresse des Dienstkontos, das für die Authentifizierung verwendet wird. CES verwendet dieses Dienstkonto, um ein Zugriffstoken auszutauschen. Das Zugriffstoken wird dann im Authorization-Header der Anfrage gesendet. Dem Dienstkonto muss die Rolle roles/iam.serviceAccountTokenCreator für den CES-Dienst-Agent service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com zugewiesen sein.
scopes[]	string Optional. Die zu gewährenden OAuth-Bereiche. Wenn nichts angegeben ist, wird der Standardbereich https://www.googleapis.com/auth/cloud-platform verwendet.

ServiceAgentIdTokenAuthConfig

Dieser Typ hat keine Felder.

Konfigurationen für die Authentifizierung mit einem ID-Token, das vom Dienst-Agent generiert wurde.

ServiceDirectoryConfig

Konfiguration für Tools, die Service Directory verwenden.

Felder
service	string Erforderlich. Der Name des Service Directory-Dienstes. Format: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}. Der Standort des Dienstverzeichnisses muss mit dem Standort der App übereinstimmen.

SessionConfig

Die Konfiguration für die Sitzung.

Felder
session	string Erforderlich. Die eindeutige Kennung der Sitzung. Format: projects/{project}/locations/{location}/apps/{app}/sessions/{session}
input_audio_config	InputAudioConfig Optional. Konfiguration für die Verarbeitung des eingegebenen Audiosignals.
output_audio_config	OutputAudioConfig Optional. Konfiguration zum Generieren des Ausgabeaudios.
historical_contexts[]	Message Optional. Der bisherige Kontext der Sitzung, einschließlich Nutzereingaben, Agentenantworten und anderer Nachrichten. Normalerweise verwaltet der CES-Kundenservicemitarbeiter die Sitzung automatisch, sodass der Kunde dieses Feld nicht explizit ausfüllen muss. Der Client kann den bisherigen Kontext jedoch optional überschreiben, um den Sitzungsstart in einem bestimmten Zustand zu erzwingen.
entry_agent	string Optional. Der Einstiegs-Agent, der die Sitzung verarbeitet. Wenn nicht angegeben, wird die Sitzung vom root agent der App verarbeitet. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
deployment	string Optional. Die Bereitstellung der App, die für die Sitzung verwendet werden soll. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
time_zone	string Optional. Die Zeitzone des Nutzers. Falls angegeben, verwendet der Agent die Zeitzone für datums- und uhrzeitbezogene Variablen. Andernfalls verwendet der Agent die in App.time_zone_settings angegebene Zeitzone. Das Format ist die Zeitzone aus der IANA-Zeitzonendatenbank, z.B. „America/Los_Angeles“.
use_tool_fakes	bool Optional. Gibt an, ob Tool-Fakes für die Sitzung verwendet werden sollen. Wenn dieses Feld festgelegt ist, versucht der Agent, Tool-Fakes zu verwenden, anstatt die echten Tools aufzurufen.
remote_dialogflow_query_parameters	SessionConfig.RemoteDialogflowQueryParameters Optional. QueryParameters, die an den Dialogflow-Remote-Agenten gesendet werden, wenn die Sitzungssteuerung an den Remote-Agenten übertragen wird.
enable_text_streaming	bool Optional. Gibt an, ob das Streaming von Textausgaben aus dem Modell aktiviert werden soll. Standardmäßig werden Textausgaben des Modells gesammelt, bevor sie an den Client gesendet werden. HINWEIS: Dies wird nur für Text- (nicht Sprach-)Sitzungen über StreamRunSession oder BidiRunSession unterstützt.
exclude_diagnostic_info	bool Optional. Gibt an, ob Diagnoseinformationen aus der Sitzungsausgabe ausgeschlossen werden sollen.

RemoteDialogflowQueryParameters

QueryParameters, die an den Dialogflow-Remote-Agenten gesendet werden, wenn die Sitzungssteuerung an den Remote-Agenten übertragen wird.

Felder
webhook_headers	map<string, string> Optional. Die HTTP-Header, die als „webhook_headers“ in QueryParameters gesendet werden sollen.
payload	Struct Optional. Die Nutzlast, die in QueryParameters gesendet werden soll.
end_user_metadata	Struct Optional. Die Metadaten zu Endnutzern, die in QueryParameters gesendet werden sollen.

SessionInput

Eingabe für die Sitzung.

Felder
will_continue	bool Optional. Ein Flag, das angibt, ob die aktuelle Nachricht ein Fragment einer größeren Eingabe in der bidirektionalen Streaming-Sitzung ist. Wenn true festgelegt ist, verschiebt der Agent die Verarbeitung, bis er eine nachfolgende Nachricht mit will_continue = false empfängt oder das System einen Endpunkt in der Audioeingabe erkennt. HINWEIS: Dieses Feld gilt nicht für Audio- und DTMF-Eingaben, da diese immer automatisch auf Grundlage des Endpunkt-Signals verarbeitet werden.
Union-Feld input_type. Der Typ der Eingabe. Für input_type ist nur einer der folgenden Werte zulässig:
text	string Optional. Textdaten vom Endnutzer.
dtmf	string Optional. DTMF-Ziffern vom Endnutzer.
audio	bytes Optional. Audiodaten des Endnutzers.
tool_responses	ToolResponses Optional. Ausführungsergebnisse für die Tool-Aufrufe vom Client.
image	Image Optional. Bilddaten des Endnutzers.
blob	Blob Optional. Blob-Daten vom Endnutzer.
variables	Struct Optional. Kontextbezogene Variablen für die Sitzung, nach Namen sortiert. Der CES-Kundenservicemitarbeiter verwendet nur Variablen, die in der App deklariert sind. Nicht erkannte Variablen werden weiterhin als zusätzliche Sitzungsparameter an den [Dialogflow-Agent][Agent.RemoteDialogflowAgent] gesendet.
event	Event Optional. Ereigniseingabe

SessionOutput

Ausgabe für die Sitzung.

Felder
turn_index	int32 Gibt die fortlaufende Nummer des Gesprächsbeitrags an, zu dem diese Ausgabe gehört, beginnend mit 1.
turn_completed	bool Wenn „true“, hat der CES-Agent das Ende des aktuellen Gesprächsabschnitts erkannt und gibt für diesen Abschnitt keine weitere Ausgabe aus.
diagnostic_info	SessionOutput.DiagnosticInfo Optional. Diagnoseinformationen enthalten Ausführungsdetails während der Verarbeitung der Eingabe. Wird nur im letzten SessionOutput (mit turn_completed=true) für jede Runde ausgegeben.
Union-Feld output_type. Der Typ der Ausgabe. Für output_type ist nur einer der folgenden Werte zulässig:
text	string Ausgabetext des CES-Agenten.
audio	bytes Audioausgabe des CES-Kundenservicemitarbeiters
tool_calls	ToolCalls Bitten Sie den Kunden, die Tools auszuführen.
citations	Citations Quellenangaben, die die Quellinformationen für den vom Agenten generierten Text enthalten.
google_search_suggestions	GoogleSearchSuggestions Die Vorschläge, die von der Google Suche als Ergebnis des Aufrufs von GoogleSearchTool zurückgegeben werden.
end_session	EndSession Gibt an, dass die Sitzung beendet wurde.
payload	Struct Benutzerdefinierte Nutzlast mit strukturierter Ausgabe des CES-Agents.
image	Image Ausgabebild des CES-Agents.
progress	string Zwischenbericht vom CES-Kundenservicemitarbeiter.

DiagnosticInfo

Enthält Ausführungsdetails während der Verarbeitung.

Felder
messages[]	Message Liste der Nachrichten, die während der Verarbeitung ausgegeben wurden.
root_span	Span Ein Trace der gesamten Anfrageverarbeitung, dargestellt als Stamm-Spanne. Dieser Bereich kann verschachtelte untergeordnete Bereiche für bestimmte Vorgänge enthalten.

Span

Ein Span ist eine Arbeitseinheit oder ein einzelner Vorgang während der Anfrageverarbeitung.

Felder
name	string Nur Ausgabe. Der Name des Spans.
start_time	Timestamp Nur Ausgabe. Die Startzeit des Zeitraums.
end_time	Timestamp Nur Ausgabe. Das Ende des Zeitraums.
duration	Duration Nur Ausgabe. Die Dauer des Zeitraums.
attributes	Struct Nur Ausgabe. Schlüssel/Wert-Attribute, die dem Bereich zugeordnet sind.
child_spans[]	Span Nur Ausgabe. Die untergeordneten Spans, die in dieser Span verschachtelt sind.

SynthesizeSpeechConfig

Konfiguration für die Synthese der Agentenantwort.

Felder
voice	string Optional. Die Bezeichnung der Stimme. Wenn kein Wert festgelegt ist, wählt der Dienst eine Stimme basierend auf den anderen Parametern wie „language_code“ aus. Eine Liste der verfügbaren Stimmen finden Sie unter Unterstützte Stimmen und Sprachen in der Cloud Text-to-Speech-Dokumentation.
speaking_rate	double Optional. Die Sprechgeschwindigkeit im Bereich [0,25, 2,0]. 1,0 ist die natürliche Geschwindigkeit, mit der der betreffende Sprecher normalerweise spricht. 2,0 bedeutet doppelt so schnell, 0,5 halb so schnell. Werte außerhalb des Bereichs [0,25, 2,0] führen zu einem Fehler.
model	string Optional. Das Modell, das zum Synthetisieren von Audio verwendet wird. Derzeit unterstützte Werte: - „gemini-3.1-flash-tts-preview“ Wenn leer, wird Chirp3-HD verwendet.
instruction	string Optional. Die Anweisung, die zum Synthetisieren von Sprache verwendet wird, wenn ein generatives Modell verwendet wird.

SystemTool

Vordefiniertes Systemtool.

Felder
name	string Erforderlich. Der Name des Systemtools.
description	string Nur Ausgabe. Die Beschreibung des Systemtools.

TimeZoneSettings

Zeitzoneneinstellungen der App.

Felder
time_zone	string Optional. Die Zeitzone der App aus der Zeitzonendatenbank, z.B. America/Los_Angeles, Europe/Paris.

TlsConfig

Die TLS-Konfiguration.

Felder
ca_certs[]	TlsConfig.CaCert Erforderlich. Gibt eine Liste der zulässigen benutzerdefinierten CA-Zertifikate für die HTTPS-Überprüfung an.

CaCert

Das CA-Zertifikat.

Felder
display_name	string Erforderlich. Der Name der zulässigen benutzerdefinierten CA-Zertifikate. Damit lassen sich die benutzerdefinierten CA-Zertifikate eindeutig zuordnen.
cert	bytes Erforderlich. Die zulässigen benutzerdefinierten CA-Zertifikate (im DER-Format) für die HTTPS-Überprüfung. Dadurch wird der Standard-SSL-Trust Store überschrieben. Wenn dieses Feld leer oder nicht angegeben ist, verwendet CES den Standard-Trust Store von Google, um Zertifikate zu prüfen. Hinweis: Die HTTPS-Serverzertifikate müssen mit „subject alt name“ signiert sein. Ein Zertifikat kann beispielsweise mit dem folgenden Befehl selbstsigniert werden: openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'")

Tool

Ein Tool stellt eine Aktion dar, die der CES-Agent ausführen kann, um bestimmte Ziele zu erreichen.

Felder
name	string ID. Der Ressourcenname des Tools. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool} für eigenständige Tools. projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool} für Tools, die aus einem Toolset abgerufen werden. Diese Tools sind dynamisch und geben nur Ausgaben zurück. Sie können nicht direkt referenziert werden, wenn ein Tool erwartet wird.
display_name	string Nur Ausgabe. Der Anzeigename des Tools, der auf dem Typ des Tools basiert. Der Anzeigename einer [ClientFunction][Tool.ClientFunction] wird beispielsweise aus der zugehörigen name-Eigenschaft abgeleitet.
execution_type	ExecutionType Optional. Der Ausführungstyp des Tools.
timeout	Duration Optional. Das Zeitlimit für die Toolausführung. Wenn nichts anderes festgelegt ist, beträgt das Standard-Zeitlimit 30 Sekunden für SYNCHRONOUS-Tools und 60 Sekunden für ASYNCHRONOUS-Tools.
create_time	Timestamp Nur Ausgabe. Zeitstempel für die Erstellung des Tools.
update_time	Timestamp Nur Ausgabe. Zeitstempel der letzten Aktualisierung des Tools.
etag	string ETag, mit dem sichergestellt wird, dass sich das Objekt während eines Read-Modify-Write-Vorgangs nicht geändert hat. Wenn das ETag leer ist, werden durch das Update alle gleichzeitigen Änderungen überschrieben.
generated_summary	string Nur Ausgabe. Wenn das Tool vom LLM-Assistenten generiert wird, enthält dieses Feld eine beschreibende Zusammenfassung der Generierung.
tool_fake_config	ToolFakeConfig Optional. Konfiguration für das Toolverhalten im Fälschungsmodus.
read_only	bool Nur Ausgabe. Gibt an, ob das Tool schreibgeschützt ist. Wenn „true“ festgelegt ist, kann das Tool nicht vom Nutzer geändert werden.
Union-Feld tool_type. Der Typ des Tools. Für tool_type ist nur einer der folgenden Werte zulässig:
client_function	ClientFunction Optional. Die Client-Funktion.
open_api_tool	OpenApiTool Optional. Das Open API-Tool.
google_search_tool	GoogleSearchTool Optional. Das Tool für die Google Suche.
connector_tool	ConnectorTool Optional. Das Integration Connector-Tool.
data_store_tool	DataStoreTool Optional. Das Datenspeichertool.
python_function	PythonFunction Optional. Das Python-Funktionstool.
mcp_tool	McpTool Optional. Das MCP-Tool. Ein MCP-Tool kann nicht direkt erstellt oder aktualisiert werden, sondern wird vom MCP-Toolset verwaltet.
file_search_tool	FileSearchTool Optional. Das Dateisuchtool.
system_tool	SystemTool Optional. Das Systemtool.
agent_tool	AgentTool Optional. Das Agent-Tool.
widget_tool	WidgetTool Optional. Das Widget-Tool
remote_agent_tool	RemoteAgentTool Optional. Das Remote-Agent-Tool.

ToolCall

Bitte den Kunden oder den Kundenservicemitarbeiter, das angegebene Tool auszuführen.

Felder
id	string Optional. Die eindeutige Kennung des Tool-Aufrufs. Falls angegeben, sollte der Client das Ausführungsergebnis mit der ID zum Abgleich in ToolResponse zurückgeben.
display_name	string Nur Ausgabe. Anzeigename des Tools.
args	Struct Optional. Die Eingabeparameter und -werte für das Tool im JSON-Objektformat.
parent_tool_call_id	string Nur Ausgabe. Die ID des Tool-Aufrufs, der diesen verursacht hat, wenn er von einem untergeordneten Agent im Auftrag eines übergeordneten Aufrufs ausgegeben wurde. Leer für Aufrufe auf oberster Ebene. Ermöglicht es einem Client, die Arbeit eines untergeordneten Agents unter dem Aufruf zu gruppieren, der sie gestartet hat, anstatt jeden Schritt als gleichgeordnetes Element darzustellen.
agent_name	string Nur Ausgabe. Menschenlesbarer Name des KI-Agenten, der diesen Aufruf ausgegeben hat, z.B. „Contract Architect“. Leer, wenn der Root-Agent die Anfrage gestellt hat.
Union-Feld tool_identifier. Die Kennung des auszuführenden Tools. Es kann sich entweder um ein dauerhaftes Tool oder ein Tool aus einem Toolset handeln. Für tool_identifier ist nur einer der folgenden Werte zulässig:
tool	string Optional. Der Name des auszuführenden Tools. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolset_tool	ToolsetTool Optional. Das Toolset-Tool, das ausgeführt werden soll.

ToolCalls

Aufforderung an den Client, die Tools auszuführen und die Ausführungsergebnisse zurückzugeben, bevor die Sitzung fortgesetzt wird.

Felder
tool_calls[]	ToolCall Optional. Die Liste der auszuführenden Tool-Aufrufe.

ToolFakeConfig

Konfiguration für das Toolverhalten im Fälschungsmodus.

Felder
enable_fake_mode	bool Optional. Gibt an, ob das Tool den Fälschungsmodus verwendet.
Union-Feld tool_response. Die Antwort ist entweder statisch oder wird von einer Python-Funktion bereitgestellt. Für tool_response ist nur einer der folgenden Werte zulässig:
code_block	CodeBlock Optional. Codeblock, der anstelle eines echten Tool-Aufrufs ausgeführt wird.

ToolResponse

Das Ausführungsergebnis eines bestimmten Tools vom Client oder vom Agenten.

Felder
id	string Optional. Die ID zum Abgleich des tool call, auf den sich die Antwort bezieht.
display_name	string Nur Ausgabe. Anzeigename des Tools.
response	Struct Erforderlich. Das Ergebnis der Tool-Ausführung im JSON-Objektformat. Verwenden Sie den Schlüssel „output“, um die Tool-Antwort anzugeben, und den Schlüssel „error“, um Fehlerdetails anzugeben (falls vorhanden). Wenn die Schlüssel „output“ und „error“ nicht angegeben sind, wird die gesamte „response“ als Ergebnis der Tool-Ausführung behandelt.
parent_tool_call_id	string Nur Ausgabe. Die ID des Tool-Aufrufs, der diesen verursacht hat, wenn er von einem untergeordneten Agent im Auftrag eines übergeordneten Aufrufs ausgegeben wurde. Leer für Aufrufe auf oberster Ebene. Ermöglicht es einem Client, die Arbeit eines untergeordneten Agents unter dem Aufruf zu gruppieren, der sie gestartet hat, anstatt jeden Schritt als gleichgeordnetes Element darzustellen.
agent_name	string Nur Ausgabe. Menschenlesbarer Name des KI-Agenten, der diesen Aufruf ausgegeben hat, z.B. „Contract Architect“. Leer, wenn der Root-Agent die Anfrage gestellt hat.
Union-Feld tool_identifier. Die Kennung des Tools, das ausgeführt wurde. Es kann sich entweder um ein dauerhaftes Tool oder ein Tool aus einem Toolset handeln. Für tool_identifier ist nur einer der folgenden Werte zulässig:
tool	string Optional. Der Name des auszuführenden Tools. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolset_tool	ToolsetTool Optional. Das Toolset-Tool, das ausgeführt wurde.

ToolResponses

Ausführungsergebnisse für die angeforderten Tool-Aufrufe vom Client.

Felder
tool_responses[]	ToolResponse Optional. Die Liste der Ergebnisse der Tool-Ausführung.

Toolset

Ein Toolset ist eine Gruppe von dynamisch verwalteten Tools, die vom Agent verwendet werden können.

Felder
name	string ID. Die eindeutige Kennung des Toolsets. Format: projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
display_name	string Optional. Der Anzeigename des Toolsets. Muss innerhalb derselben App eindeutig sein.
description	string Optional. Die Beschreibung des Toolsets.
timeout	Duration Optional. Das Zeitlimit für die Ausführung des Toolsets. Wenn nichts anderes festgelegt ist, beträgt das Standard-Zeitlimit 30 Sekunden für SYNCHRONOUS-Toolsets und 60 Sekunden für ASYNCHRONOUS-Toolsets.
create_time	Timestamp Nur Ausgabe. Zeitstempel für die Erstellung des Toolsets.
update_time	Timestamp Nur Ausgabe. Zeitstempel der letzten Aktualisierung des Toolsets.
etag	string ETag, das verwendet wird, um sicherzustellen, dass sich das Objekt während eines Read-Modify-Write-Vorgangs nicht geändert hat. Wenn das ETag leer ist, werden durch das Update alle gleichzeitigen Änderungen überschrieben.
execution_type	ExecutionType Optional. Der Ausführungstyp der Tools im Toolset.
tool_fake_config	ToolFakeConfig Optional. Konfiguration für das Verhalten von Tools im Fälschungsmodus.
Union-Feld toolset_type. Der Typ des Toolsets. Für toolset_type ist nur einer der folgenden Werte zulässig:
mcp_toolset	McpToolset Optional. Ein Toolset, das eine Liste der Tools enthält, die vom MCP-Server angeboten werden.
open_api_toolset	OpenApiToolset Optional. Ein Toolset, das eine Liste von Tools enthält, die durch ein OpenAPI-Schema definiert werden.
connector_toolset	ConnectorToolset Optional. Ein Toolset, mit dem Tools aus einer Integration Connectors-Verbindung generiert werden.

ToolsetTool

Ein Tool, das aus einem Toolset erstellt wird.

Felder
toolset	string Erforderlich. Der Ressourcenname des Toolsets, aus dem dieses Tool abgeleitet wird. Format: projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
tool_id	string Optional. Die Tool-ID, mit der die Tools gefiltert werden sollen, für die das Schema abgerufen werden soll.

TransferRule

Regel für die Weiterleitung an einen bestimmten Kundenservicemitarbeiter.

Felder
child_agent	string Erforderlich. Der Ressourcenname des untergeordneten KI-Agenten, auf den sich die Regel bezieht. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
direction	TransferRule.Direction Erforderlich. Die Richtung der Übertragung.
Union-Feld rule_type. Der Regeltyp. Für rule_type ist nur einer der folgenden Werte zulässig:
deterministic_transfer	TransferRule.DeterministicTransfer Optional. Eine Regel, die sofort an den Ziel-Agent übertragen wird, wenn die Bedingung erfüllt ist.
disable_planner_transfer	TransferRule.DisablePlannerTransfer Optional. Regel, die verhindert, dass der Planner an den Ziel-Agent übertragen wird.

DeterministicTransfer

Deterministische Übertragungsregel. Wenn die Bedingung als „wahr“ ausgewertet wird, erfolgt die Übertragung.

Felder
Union-Feld condition_type. Die Bedingung, die ausgewertet werden soll. Für condition_type ist nur einer der folgenden Werte zulässig:
expression_condition	ExpressionCondition Optional. Eine Regel, die eine Bedingung für den Sitzungsstatus auswertet. Wenn die Bedingung als „wahr“ ausgewertet wird, erfolgt die Übertragung.
python_code_condition	PythonCodeCondition Optional. Eine Regel, in der ein Python-Codeblock verwendet wird, um die Bedingungen auszuwerten. Wenn die Bedingung als „wahr“ ausgewertet wird, erfolgt die Übertragung.

Richtung

Die Richtung der Übertragung.

Enums
DIRECTION_UNSPECIFIED	Nicht angegebene Richtung.
PARENT_TO_CHILD	Übertragung vom übergeordneten Agenten an den untergeordneten Agenten.
CHILD_TO_PARENT	Übertragung vom untergeordneten zum übergeordneten Agenten.

DisablePlannerTransfer

Eine Regel, die verhindert, dass der Planner an den Ziel-Agent übertragen wird.

Felder
expression_condition	ExpressionCondition Erforderlich. Wenn die Bedingung „true“ ergibt, darf der Planer nicht zum Ziel-Kundenservicemitarbeiter weitergeleitet werden.

TriggerAction

Aktion, die ausgeführt wird, wenn eine bestimmte Vorbedingung erfüllt ist.

Felder
Union-Feld action. Die erforderliche Aktion. Für action ist nur einer der folgenden Werte zulässig:
respond_immediately	TriggerAction.RespondImmediately Optional. Sofort mit einer vorkonfigurierten Antwort reagieren
transfer_agent	TriggerAction.TransferAgent Optional. Leiten Sie das Gespräch an einen anderen Kundenservicemitarbeiter weiter.
generative_answer	TriggerAction.GenerativeAnswer Optional. Mit einer generativen Antwort antworten.

GenerativeAnswer

Der KI-Agent antwortet sofort mit einer generativen Antwort.

Felder
prompt	string Erforderlich. Der Prompt, der für die generative Antwort verwendet werden soll.

RespondImmediately

Der KI-Agent antwortet sofort mit einer vorkonfigurierten Antwort.

Felder
responses[]	TriggerAction.Response Erforderlich. Die Standardantworten, aus denen der KI-Agent auswählen kann. Die Antwort wird zufällig ausgewählt.

Antwort

Stellt eine Antwort des KI-Agenten dar.

Felder
text	string Erforderlich. Text, mit dem der Agent antworten soll.
disabled	bool Optional. Gibt an, ob die Antwort deaktiviert ist. Deaktivierte Antworten werden vom KI-Agenten nicht verwendet.

TransferAgent

Der Agent leitet die Unterhaltung an einen anderen Agenten weiter.

Felder
agent	string Erforderlich. Der Name des Agenten, an den die Unterhaltung übertragen werden soll. Der Agent muss sich in derselben App wie der aktuelle Agent befinden. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}

UpdateAgentRequest

Anfragenachricht für AgentService.UpdateAgent.

Felder
agent	Agent Erforderlich. Der zu aktualisierende Agent.
update_mask	FieldMask Optional. Mit der Feldmaske wird gesteuert, welche Felder aktualisiert werden. Wenn die Maske nicht vorhanden ist, werden alle Felder aktualisiert.

UpdateAppRequest

Anfragenachricht für AgentService.UpdateApp.

Felder
app	App Erforderlich. Die App, die aktualisiert werden soll.
update_mask	FieldMask Optional. Mit der Feldmaske wird gesteuert, welche Felder aktualisiert werden. Wenn die Maske nicht vorhanden ist, werden alle Felder aktualisiert.

UpdateAppVersionRequest

Anfragenachricht für AgentService.UpdateAppVersion.

Felder
app_version	AppVersion Erforderlich. Die App-Version, die aktualisiert werden soll.
update_mask	FieldMask Optional. Die Liste der zu aktualisierenden Felder. Wenn leer, werden die Felder display_name und description aktualisiert.

UpdateDeploymentRequest

Anfragenachricht für AgentService.UpdateDeployment.

Felder
deployment	Deployment Erforderlich. Die zu aktualisierende Bereitstellung.
update_mask	FieldMask Optional. Die Liste der zu aktualisierenden Felder.

UpdateExampleRequest

Anfragenachricht für AgentService.UpdateExample.

Felder
example	Example Erforderlich. Das zu aktualisierende Beispiel.
update_mask	FieldMask Optional. Mit der Feldmaske wird gesteuert, welche Felder aktualisiert werden. Wenn die Maske nicht vorhanden ist, werden alle Felder aktualisiert.

UpdateGuardrailRequest

Anfragenachricht für AgentService.UpdateGuardrail.

Felder
guardrail	Guardrail Erforderlich. Die zu aktualisierende Guardrail.
update_mask	FieldMask Optional. Mit der Feldmaske wird gesteuert, welche Felder aktualisiert werden. Wenn die Maske nicht vorhanden ist, werden alle Felder aktualisiert.

UpdateToolRequest

Anfragenachricht für AgentService.UpdateTool.

Felder
tool	Tool Erforderlich. Das zu aktualisierende Tool.
update_mask	FieldMask Optional. Mit der Feldmaske wird gesteuert, welche Felder aktualisiert werden. Wenn die Maske nicht vorhanden ist, werden alle Felder aktualisiert.

UpdateToolsetRequest

Anfragenachricht für AgentService.UpdateToolset.

Felder
toolset	Toolset Erforderlich. Das zu aktualisierende Toolset.
update_mask	FieldMask Optional. Mit der Feldmaske wird gesteuert, welche Felder aktualisiert werden. Wenn die Maske nicht vorhanden ist, werden alle Felder aktualisiert.

VpcScSettings

VPC-SC-Einstellungen für die App.

Felder

allowed_origins[]

string Optional. Die zulässigen HTTP(S)-Ursprünge, die von OpenAPI-Tools in der App direkt aufgerufen werden können, wenn VPC Service Controls aktiviert ist. Diese Strings müssen genau mit dem Ursprung übereinstimmen, einschließlich des Ports, falls angegeben. Beispiel: „https://beispiel.de“ oder „https://beispiel.de:443“. Diese Liste gilt noch nicht für Python-Tools, die möglicherweise direkte HTTP-Aufrufe ausführen.

WebSearchQuery

Stellt eine einzelne Websuchanfrage und den zugehörigen Such-URI dar.

Felder
query	string Der Suchanfragetext.
uri	string Die URI der Google-Suchergebnisseite für die Anfrage.

WhatsAppCredentials

Temporäre Meta-Anmeldedaten für die native WhatsApp-Integration.

Felder
auth_code	string Erforderlich. Der Meta-Autorisierungscode, der vom eingebetteten Registrierungsvorgang bereitgestellt wird.
pin	string Erforderlich. Die 6‑stellige PIN, die vom Nutzer für die Bestätigung in zwei Schritten erstellt wurde.
phone_number	string Erforderlich. Die Telefonnummer, mit der Sie sich bei WhatsApp registrieren.
business_account_id	string Erforderlich. Die Geschäfts-Konto-ID, die für die Telefonnummer verwendet werden soll.
waba_id	string Erforderlich. Die WhatsApp Business-Konto-ID.
conversation_profile_id	string Optional. Die Konversationsprofil-ID, die für die Bereitstellung verwendet werden soll.

WidgetTool

Stellt ein Widget-Tool dar, das der Agent aufrufen kann. Wenn das Tool vom Agenten ausgewählt wird, gibt der Agent das Widget an den Client zurück. Der Client ist für die Verarbeitung des Widgets und die Generierung der nächsten Nutzeranfrage verantwortlich, um die Interaktion mit dem KI-Agenten fortzusetzen.

Felder
name	string Erforderlich. Der Anzeigename des Widget-Tools.
description	string Optional. Die Beschreibung des Widget-Tools.
widget_type	WidgetTool.WidgetType Optional. Der Typ des Widget-Tools. Wenn nichts angegeben ist, ist der Standardtyp CUSTOMIZED.
ui_config	Struct Optional. Konfiguration für das Rendern des Widgets.
data_mapping	WidgetTool.DataMapping Optional. Die Zuordnung, mit der festgelegt wird, wie Daten aus einem Quelltool den Eingabeparametern des Widgets zugeordnet werden.
text_response_config	WidgetTool.TextResponseConfig Optional. Konfiguration für Textantworten, die immer enthalten sind.
Union-Feld input. Die Eingabe des Widget-Tools. Für input ist nur einer der folgenden Werte zulässig:
parameters	Schema Optional. Die Eingabeparameter des Widget-Tools.

DataMapping

Konfiguration für die Zuordnung von Daten aus einem Quelltool zu den Eingabeparametern des Widgets.

Felder
source_tool_name	string Optional. Der Ressourcenname des Tools, das die Daten für das Widget bereitstellt, z.B. ein Suchtool oder eine benutzerdefinierte Funktion. Format: projects/{project}/locations/{location}/agents/{agent}/tools/{tool}
field_mappings	map<string, string> Optional. Eine Zuordnung der Eingabeparameterfelder des Widgets zu den entsprechenden Ausgabefeldern des Quelltools.
python_function	PythonFunction Optional. Konfiguration für eine Python-Funktion, mit der die Ausgabe des Quelltools in das Eingabeformat des Widgets transformiert wird.
mode	WidgetTool.DataMapping.Mode Optional. Der Modus des Datenabgleichs.
python_script (deprecated)	string Dieses Element wird nicht mehr unterstützt. Nicht mehr unterstützt: Verwenden Sie stattdessen python_function.

Modus

Die Strategie, die zum Zuordnen von Daten aus dem Quelltool zum Widget verwendet wird.

Enums
MODE_UNSPECIFIED	Nicht angegebener Modus.
FIELD_MAPPING	Verwenden Sie die field_mappings-Map für die Datentransformation.
PYTHON_SCRIPT	Verwenden Sie python_script für die Datentransformation.

TextResponseConfig

Konfiguration für die Textantwort, die mit dem Widget zurückgegeben wird.

Felder
type	WidgetTool.TextResponseConfig.Type Optional. Die Strategie für die Bereitstellung der Textantwort.
static_text	string Optional. Die statische Textantwort, die zurückgegeben werden soll, wenn der Typ STATIC ist.
text_response_instruction	string Optional. Anweisung für das LLM, wie die Textantwort generiert werden soll. Wird als Beschreibung für den Parameter für die Textantwort verwendet, wenn der Typ LLM_GENERATED ist.

Typ

Definiert, wie die Textantwort erstellt wird.

Enums
TYPE_UNSPECIFIED	Nicht definierter Typ.
NONE	Das LLM entscheidet dynamisch, ob neben dem Widget eine Textantwort generiert werden soll, basierend auf dem Gesprächskontext.
LLM_GENERATED	Das LLM muss explizit eine Textantwort generieren.
STATIC	Es wird immer eine vordefinierte statische Textantwort verwendet.

WidgetType

Alle verfügbaren Widget-Typen. Dieser Enum können in Zukunft neue Werte hinzugefügt werden.

Enums
WIDGET_TYPE_UNSPECIFIED	Nicht angegebener Widget-Typ
CUSTOM	Benutzerdefinierter Widget-Typ.
PRODUCT_CAROUSEL	Widget für Produktkarussell
PRODUCT_DETAILS	Widget mit Produktdetails.
QUICK_ACTIONS	Schnellaktionen-Widget
PRODUCT_COMPARISON	Widget für Produktvergleich
ADVANCED_PRODUCT_DETAILS	Erweitertes Widget mit Produktdetails
SHORT_FORM	Kurzform-Widget
OVERALL_SATISFACTION	Widget zur Gesamtzufriedenheit
ORDER_SUMMARY	Widget „Zusammenfassung der Bestellung“
APPOINTMENT_DETAILS	Widget mit Termindetails.
APPOINTMENT_SCHEDULER	Widget für die Terminplanung
CONTACT_FORM	Kontaktformular-Widget