Package google.cloud.ces.v1

Indeks

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

AgentService

Layanan yang mengelola resource terkait agen di Gemini Enterprise for Customer Engagement (CES).

BatchDeleteConversations

rpc BatchDeleteConversations(BatchDeleteConversationsRequest) returns (Operation) Menghapus percakapan tertentu secara batch. Cakupan otorisasi Memerlukan salah satu cakupan OAuth berikut: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Untuk mengetahui informasi selengkapnya, lihat Authentication Overview. Izin IAM Memerlukan izin IAM berikut pada resource parent: ces.conversations.delete Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.

CreateAgent

rpc CreateAgent(CreateAgentRequest) returns (Agent) Membuat agen baru di aplikasi yang diberikan. Cakupan otorisasi Memerlukan salah satu cakupan OAuth berikut: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Untuk mengetahui informasi selengkapnya, lihat Authentication Overview. Izin IAM Memerlukan izin IAM berikut pada resource parent: ces.agents.create Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.

CreateApp

rpc CreateApp(CreateAppRequest) returns (Operation) Membuat aplikasi baru di project dan lokasi tertentu. Cakupan otorisasi Memerlukan salah satu cakupan OAuth berikut: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Untuk mengetahui informasi selengkapnya, lihat Authentication Overview. Izin IAM Memerlukan izin IAM berikut pada resource parent: ces.apps.create Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.

CreateAppVersion

rpc CreateAppVersion(CreateAppVersionRequest) returns (AppVersion) Membuat versi aplikasi baru di aplikasi yang diberikan. Cakupan otorisasi Memerlukan salah satu cakupan OAuth berikut: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Untuk mengetahui informasi selengkapnya, lihat Authentication Overview. Izin IAM Memerlukan izin IAM berikut pada resource parent: ces.appVersions.create Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.

CreateDeployment

rpc CreateDeployment(CreateDeploymentRequest) returns (Deployment) Membuat deployment baru di aplikasi yang diberikan. Cakupan otorisasi Memerlukan salah satu cakupan OAuth berikut: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Untuk mengetahui informasi selengkapnya, lihat Authentication Overview. Izin IAM Memerlukan izin IAM berikut pada resource parent: ces.deployments.create Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.

CreateExample

rpc CreateExample(CreateExampleRequest) returns (Example) Membuat contoh baru di aplikasi yang ditentukan. Cakupan otorisasi Memerlukan salah satu cakupan OAuth berikut: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Untuk mengetahui informasi selengkapnya, lihat Authentication Overview. Izin IAM Memerlukan izin IAM berikut pada resource parent: ces.examples.create Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.

CreateGuardrail

rpc CreateGuardrail(CreateGuardrailRequest) returns (Guardrail) Membuat pembatas baru di aplikasi yang diberikan. Cakupan otorisasi Memerlukan salah satu cakupan OAuth berikut: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Untuk mengetahui informasi selengkapnya, lihat Authentication Overview. Izin IAM Memerlukan izin IAM berikut pada resource parent: ces.guardrails.create Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.

CreateTool

rpc CreateTool(CreateToolRequest) returns (Tool) Membuat alat baru di aplikasi yang ditentukan. Cakupan otorisasi Memerlukan salah satu cakupan OAuth berikut: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Untuk mengetahui informasi selengkapnya, lihat Authentication Overview. Izin IAM Memerlukan izin IAM berikut pada resource parent: ces.tools.create Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.

CreateToolset

rpc CreateToolset(CreateToolsetRequest) returns (Toolset) Membuat toolset baru di aplikasi yang ditentukan. Cakupan otorisasi Memerlukan salah satu cakupan OAuth berikut: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Untuk mengetahui informasi selengkapnya, lihat Authentication Overview. Izin IAM Memerlukan izin IAM berikut pada resource parent: ces.toolsets.create Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.

DeleteAgent

rpc DeleteAgent(DeleteAgentRequest) returns (Empty) Menghapus agen yang ditentukan. Cakupan otorisasi Memerlukan salah satu cakupan OAuth berikut: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Untuk mengetahui informasi selengkapnya, lihat Authentication Overview. Izin IAM Memerlukan izin IAM berikut pada resource name: ces.agents.delete Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.

DeleteApp

rpc DeleteApp(DeleteAppRequest) returns (Operation) Menghapus aplikasi yang ditentukan. Cakupan otorisasi Memerlukan salah satu cakupan OAuth berikut: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Untuk mengetahui informasi selengkapnya, lihat Authentication Overview. Izin IAM Memerlukan izin IAM berikut pada resource name: ces.apps.delete Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.

DeleteAppVersion

rpc DeleteAppVersion(DeleteAppVersionRequest) returns (Empty) Menghapus versi aplikasi yang ditentukan. Cakupan otorisasi Memerlukan salah satu cakupan OAuth berikut: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Untuk mengetahui informasi selengkapnya, lihat Authentication Overview. Izin IAM Memerlukan izin IAM berikut pada resource name: ces.appVersions.delete Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.

DeleteConversation

rpc DeleteConversation(DeleteConversationRequest) returns (Empty) Menghapus percakapan yang ditentukan. Cakupan otorisasi Memerlukan salah satu cakupan OAuth berikut: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Untuk mengetahui informasi selengkapnya, lihat Authentication Overview. Izin IAM Memerlukan izin IAM berikut pada resource name: ces.conversations.delete Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.

DeleteDeployment

rpc DeleteDeployment(DeleteDeploymentRequest) returns (Empty) Menghapus deployment yang ditentukan. Cakupan otorisasi Memerlukan salah satu cakupan OAuth berikut: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Untuk mengetahui informasi selengkapnya, lihat Authentication Overview. Izin IAM Memerlukan izin IAM berikut pada resource name: ces.deployments.delete Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.

DeleteExample

rpc DeleteExample(DeleteExampleRequest) returns (Empty) Menghapus contoh yang ditentukan. Cakupan otorisasi Memerlukan salah satu cakupan OAuth berikut: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Untuk mengetahui informasi selengkapnya, lihat Authentication Overview. Izin IAM Memerlukan izin IAM berikut pada resource name: ces.examples.delete Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.

DeleteGuardrail

rpc DeleteGuardrail(DeleteGuardrailRequest) returns (Empty) Menghapus pembatasan yang ditentukan. Cakupan otorisasi Memerlukan salah satu cakupan OAuth berikut: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Untuk mengetahui informasi selengkapnya, lihat Authentication Overview. Izin IAM Memerlukan izin IAM berikut pada resource name: ces.guardrails.delete Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.

DeleteTool

rpc DeleteTool(DeleteToolRequest) returns (Empty) Menghapus alat yang ditentukan. Cakupan otorisasi Memerlukan salah satu cakupan OAuth berikut: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Untuk mengetahui informasi selengkapnya, lihat Authentication Overview. Izin IAM Memerlukan izin IAM berikut pada resource name: ces.tools.delete Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.

DeleteToolset

rpc DeleteToolset(DeleteToolsetRequest) returns (Empty) Menghapus toolset yang ditentukan. Cakupan otorisasi Memerlukan salah satu cakupan OAuth berikut: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Untuk mengetahui informasi selengkapnya, lihat Authentication Overview. Izin IAM Memerlukan izin IAM berikut pada resource name: ces.toolsets.delete Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.

ExportApp

rpc ExportApp(ExportAppRequest) returns (Operation) Mengekspor aplikasi yang ditentukan. Cakupan otorisasi Memerlukan salah satu cakupan OAuth berikut: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Untuk mengetahui informasi selengkapnya, lihat Authentication Overview. Izin IAM Memerlukan izin IAM berikut pada resource name: ces.apps.export Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.

GetAgent

rpc GetAgent(GetAgentRequest) returns (Agent) Mendapatkan detail agen yang ditentukan. Cakupan otorisasi Memerlukan salah satu cakupan OAuth berikut: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Untuk mengetahui informasi selengkapnya, lihat Authentication Overview. Izin IAM Memerlukan izin IAM berikut pada resource name: ces.agents.get Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.

GetApp

rpc GetApp(GetAppRequest) returns (App) Mendapatkan detail aplikasi yang ditentukan. Cakupan otorisasi Memerlukan salah satu cakupan OAuth berikut: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Untuk mengetahui informasi selengkapnya, lihat Authentication Overview. Izin IAM Memerlukan izin IAM berikut pada resource name: ces.apps.get Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.

GetAppVersion

rpc GetAppVersion(GetAppVersionRequest) returns (AppVersion) Mendapatkan detail versi aplikasi yang ditentukan. Cakupan otorisasi Memerlukan salah satu cakupan OAuth berikut: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Untuk mengetahui informasi selengkapnya, lihat Authentication Overview. Izin IAM Memerlukan izin IAM berikut pada resource name: ces.appVersions.get Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.

GetChangelog

rpc GetChangelog(GetChangelogRequest) returns (Changelog) Mendapatkan log perubahan yang ditentukan. Cakupan otorisasi Memerlukan salah satu cakupan OAuth berikut: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Untuk mengetahui informasi selengkapnya, lihat Authentication Overview. Izin IAM Memerlukan izin IAM berikut pada resource name: ces.changelogs.get Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.

GetConversation

rpc GetConversation(GetConversationRequest) returns (Conversation) Mendapatkan detail percakapan yang ditentukan. Cakupan otorisasi Memerlukan salah satu cakupan OAuth berikut: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Untuk mengetahui informasi selengkapnya, lihat Authentication Overview. Izin IAM Memerlukan izin IAM berikut pada resource name: ces.conversations.get Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.

GetDeployment

rpc GetDeployment(GetDeploymentRequest) returns (Deployment) Mendapatkan detail deployment yang ditentukan. Cakupan otorisasi Memerlukan salah satu cakupan OAuth berikut: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Untuk mengetahui informasi selengkapnya, lihat Authentication Overview. Izin IAM Memerlukan izin IAM berikut pada resource name: ces.deployments.get Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.

GetExample

rpc GetExample(GetExampleRequest) returns (Example) Mendapatkan detail contoh yang ditentukan. Cakupan otorisasi Memerlukan salah satu cakupan OAuth berikut: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Untuk mengetahui informasi selengkapnya, lihat Authentication Overview. Izin IAM Memerlukan izin IAM berikut pada resource name: ces.examples.get Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.

GetGuardrail

rpc GetGuardrail(GetGuardrailRequest) returns (Guardrail) Mendapatkan detail pembatasan yang ditentukan. Cakupan otorisasi Memerlukan salah satu cakupan OAuth berikut: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Untuk mengetahui informasi selengkapnya, lihat Authentication Overview. Izin IAM Memerlukan izin IAM berikut pada resource name: ces.guardrails.get Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.

GetTool

rpc GetTool(GetToolRequest) returns (Tool) Mendapatkan detail alat yang ditentukan. Cakupan otorisasi Memerlukan salah satu cakupan OAuth berikut: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Untuk mengetahui informasi selengkapnya, lihat Authentication Overview. Izin IAM Memerlukan izin IAM berikut pada resource name: ces.tools.get Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.

GetToolset

rpc GetToolset(GetToolsetRequest) returns (Toolset) Mendapatkan detail toolset yang ditentukan. Cakupan otorisasi Memerlukan salah satu cakupan OAuth berikut: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Untuk mengetahui informasi selengkapnya, lihat Authentication Overview. Izin IAM Memerlukan izin IAM berikut pada resource name: ces.toolsets.get Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.

ImportApp

rpc ImportApp(ImportAppRequest) returns (Operation) Mengimpor aplikasi yang ditentukan. Cakupan otorisasi Memerlukan salah satu cakupan OAuth berikut: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Untuk mengetahui informasi selengkapnya, lihat Authentication Overview. Izin IAM Memerlukan izin IAM berikut pada resource parent: ces.apps.import Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.

ListAgents

rpc ListAgents(ListAgentsRequest) returns (ListAgentsResponse) Mencantumkan agen di aplikasi tertentu. Cakupan otorisasi Memerlukan salah satu cakupan OAuth berikut: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Untuk mengetahui informasi selengkapnya, lihat Authentication Overview. Izin IAM Memerlukan izin IAM berikut pada resource parent: ces.agents.list Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.

ListAppVersions

rpc ListAppVersions(ListAppVersionsRequest) returns (ListAppVersionsResponse) Mencantumkan semua versi aplikasi di aplikasi tertentu. Cakupan otorisasi Memerlukan salah satu cakupan OAuth berikut: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Untuk mengetahui informasi selengkapnya, lihat Authentication Overview. Izin IAM Memerlukan izin IAM berikut pada resource parent: ces.appVersions.list Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.

ListApps

rpc ListApps(ListAppsRequest) returns (ListAppsResponse) Mencantumkan aplikasi dalam project dan lokasi tertentu. Cakupan otorisasi Memerlukan salah satu cakupan OAuth berikut: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Untuk mengetahui informasi selengkapnya, lihat Authentication Overview. Izin IAM Memerlukan izin IAM berikut pada resource parent: ces.apps.list Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.

ListChangelogs

rpc ListChangelogs(ListChangelogsRequest) returns (ListChangelogsResponse) Mencantumkan log perubahan aplikasi yang ditentukan. Cakupan otorisasi Memerlukan salah satu cakupan OAuth berikut: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Untuk mengetahui informasi selengkapnya, lihat Authentication Overview. Izin IAM Memerlukan izin IAM berikut pada resource parent: ces.changelogs.list Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.

ListConversations

rpc ListConversations(ListConversationsRequest) returns (ListConversationsResponse) Mencantumkan percakapan di aplikasi tertentu. Cakupan otorisasi Memerlukan salah satu cakupan OAuth berikut: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Untuk mengetahui informasi selengkapnya, lihat Authentication Overview. Izin IAM Memerlukan izin IAM berikut pada resource parent: ces.conversations.list Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.

ListDeployments

rpc ListDeployments(ListDeploymentsRequest) returns (ListDeploymentsResponse) Mencantumkan deployment di aplikasi tertentu. Cakupan otorisasi Memerlukan salah satu cakupan OAuth berikut: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Untuk mengetahui informasi selengkapnya, lihat Authentication Overview. Izin IAM Memerlukan izin IAM berikut pada resource parent: ces.deployments.list Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.

ListExamples

rpc ListExamples(ListExamplesRequest) returns (ListExamplesResponse) Mencantumkan contoh di aplikasi tertentu. Cakupan otorisasi Memerlukan salah satu cakupan OAuth berikut: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Untuk mengetahui informasi selengkapnya, lihat Authentication Overview. Izin IAM Memerlukan izin IAM berikut pada resource parent: ces.examples.list Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.

ListGuardrails

rpc ListGuardrails(ListGuardrailsRequest) returns (ListGuardrailsResponse) Mencantumkan batas aman dalam aplikasi tertentu. Cakupan otorisasi Memerlukan salah satu cakupan OAuth berikut: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Untuk mengetahui informasi selengkapnya, lihat Authentication Overview. Izin IAM Memerlukan izin IAM berikut pada resource parent: ces.guardrails.list Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.

ListTools

rpc ListTools(ListToolsRequest) returns (ListToolsResponse) Mencantumkan alat di aplikasi tertentu. Cakupan otorisasi Memerlukan salah satu cakupan OAuth berikut: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Untuk mengetahui informasi selengkapnya, lihat Authentication Overview. Izin IAM Memerlukan izin IAM berikut pada resource parent: ces.tools.list Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.

ListToolsets

rpc ListToolsets(ListToolsetsRequest) returns (ListToolsetsResponse) Mencantumkan set alat di aplikasi tertentu. Cakupan otorisasi Memerlukan salah satu cakupan OAuth berikut: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Untuk mengetahui informasi selengkapnya, lihat Authentication Overview. Izin IAM Memerlukan izin IAM berikut pada resource parent: ces.toolsets.list Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.

RestoreAppVersion

rpc RestoreAppVersion(RestoreAppVersionRequest) returns (Operation) Memulihkan versi aplikasi yang ditentukan. Tindakan ini akan membuat versi aplikasi baru dari aplikasi draf saat ini dan menimpa draf saat ini dengan versi aplikasi yang ditentukan. Cakupan otorisasi Memerlukan salah satu cakupan OAuth berikut: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Untuk mengetahui informasi selengkapnya, lihat Authentication Overview. Izin IAM Memerlukan izin IAM berikut pada resource name: ces.appVersions.restore Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.

UpdateAgent

rpc UpdateAgent(UpdateAgentRequest) returns (Agent) Memperbarui agen yang ditentukan. Cakupan otorisasi Memerlukan salah satu cakupan OAuth berikut: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Untuk mengetahui informasi selengkapnya, lihat Authentication Overview. Izin IAM Memerlukan izin IAM berikut pada resource name: ces.agents.update Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.

UpdateApp

rpc UpdateApp(UpdateAppRequest) returns (App) Memperbarui aplikasi yang ditentukan. Cakupan otorisasi Memerlukan salah satu cakupan OAuth berikut: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Untuk mengetahui informasi selengkapnya, lihat Authentication Overview. Izin IAM Memerlukan izin IAM berikut pada resource name: ces.apps.update Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.

UpdateAppVersion
rpc UpdateAppVersion(UpdateAppVersionRequest) returns (AppVersion) Memperbarui versi aplikasi yang ditentukan. Cakupan otorisasi Memerlukan salah satu cakupan OAuth berikut: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.

UpdateDeployment

rpc UpdateDeployment(UpdateDeploymentRequest) returns (Deployment) Memperbarui deployment yang ditentukan. Cakupan otorisasi Memerlukan salah satu cakupan OAuth berikut: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Untuk mengetahui informasi selengkapnya, lihat Authentication Overview. Izin IAM Memerlukan izin IAM berikut pada resource name: ces.deployments.update Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.

UpdateExample

rpc UpdateExample(UpdateExampleRequest) returns (Example) Memperbarui contoh yang ditentukan. Cakupan otorisasi Memerlukan salah satu cakupan OAuth berikut: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Untuk mengetahui informasi selengkapnya, lihat Authentication Overview. Izin IAM Memerlukan izin IAM berikut pada resource name: ces.examples.update Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.

UpdateGuardrail

rpc UpdateGuardrail(UpdateGuardrailRequest) returns (Guardrail) Memperbarui pembatasan yang ditentukan. Cakupan otorisasi Memerlukan salah satu cakupan OAuth berikut: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Untuk mengetahui informasi selengkapnya, lihat Authentication Overview. Izin IAM Memerlukan izin IAM berikut pada resource name: ces.guardrails.update Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.

UpdateTool

rpc UpdateTool(UpdateToolRequest) returns (Tool) Memperbarui alat yang ditentukan. Cakupan otorisasi Memerlukan salah satu cakupan OAuth berikut: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Untuk mengetahui informasi selengkapnya, lihat Authentication Overview. Izin IAM Memerlukan izin IAM berikut pada resource name: ces.tools.update Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.

UpdateToolset

rpc UpdateToolset(UpdateToolsetRequest) returns (Toolset) Memperbarui toolset yang ditentukan. Cakupan otorisasi Memerlukan salah satu cakupan OAuth berikut: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Untuk mengetahui informasi selengkapnya, lihat Authentication Overview. Izin IAM Memerlukan izin IAM berikut pada resource name: ces.toolsets.update Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.

SessionService

Layanan sesi menyediakan API untuk berinteraksi dengan agen CES.

BidiRunSession

rpc BidiRunSession(BidiSessionClientMessage) returns (BidiSessionServerMessage) Membuat koneksi streaming dua arah dengan agen CES. Agen memproses input multimodal berkelanjutan (misalnya, teks, audio) dan menghasilkan streaming output multimodal real-time. --- Aliran Permintaan Klien --- Klien mengalirkan permintaan dalam urutan berikut: Inisialisasi: Pesan pertama harus berisi SessionConfig. Untuk sesi audio, payload ini juga harus menyertakan InputAudioConfig dan OutputAudioConfig untuk menentukan parameter pemrosesan dan sintesis audio. Interaksi: Pesan berikutnya mengalirkan SessionInput yang berisi data input pengguna real-time. Penghentian: Klien harus menutup setengah streaming jika tidak ada lagi input pengguna. Panel juga harus menutup setengah saat menerima EndSession atau GoAway dari agen. --- Aliran Respons Server --- Untuk setiap giliran interaksi, agen mengalirkan pesan dalam urutan berikut: Pengenalan Ucapan (N Pesan Pertama): Berisi RecognitionResult yang merepresentasikan segmen ucapan pengguna yang digabungkan yang telah direkam sejauh ini. Kolom ini hanya diisi untuk sesi audio. Respons (M pesan berikutnya): Berisi SessionOutput yang menyampaikan respons agen dalam berbagai modalitas (misalnya, teks, audio). Penyelesaian Giliran (Pesan akhir giliran): Berisi SessionOutput dengan turn_completed disetel ke benar (true). Hal ini menandakan akhir giliran saat ini dan mencakup DiagnosticInfo dengan detail eksekusi. --- Praktik Terbaik Audio --- 1. Streaming: Streaming audio data TERUS-MENERUS, bahkan saat hening. Ukuran potongan yang direkomendasikan: 40-120 md (menyeimbangkan latensi vs. efisiensi). Pemutaran & Interupsi: Putar audio responses setelah diterima. Hentikan pemutaran segera jika InterruptionSignal diterima (misalnya, pengguna menyela atau respons agen baru). Cakupan otorisasi Memerlukan salah satu cakupan OAuth berikut: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Untuk mengetahui informasi selengkapnya, lihat Authentication Overview. Izin IAM Memerlukan izin IAM berikut pada resource session: ces.sessions.bidiRunSession Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.

RunSession

rpc RunSession(RunSessionRequest) returns (RunSessionResponse) Memulai interaksi satu giliran dengan agen CES dalam sesi. Cakupan otorisasi Memerlukan salah satu cakupan OAuth berikut: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Untuk mengetahui informasi selengkapnya, lihat Authentication Overview. Izin IAM Memerlukan izin IAM berikut pada resource session: ces.sessions.runSession Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.

StreamRunSession

rpc StreamRunSession(RunSessionRequest) returns (RunSessionResponse) Memulai interaksi satu giliran dengan agen CES. Menggunakan streaming sisi server untuk memberikan hasil inkremental dan respons parsial saat dihasilkan. Secara default, respons lengkap (misalnya, pesan dari panggilan balik atau respons LLM lengkap) dikirim ke klien segera setelah tersedia. Untuk mengaktifkan streaming setiap potongan teks langsung dari model, setel enable_text_streaming ke benar (true). Cakupan otorisasi Memerlukan salah satu cakupan OAuth berikut: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Untuk mengetahui informasi selengkapnya, lihat Authentication Overview. Izin IAM Memerlukan izin IAM berikut pada resource session: ces.sessions.runSession Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.

ToolService

Layanan alat menyediakan API untuk berinteraksi dengan alat CES.

ExecuteTool

rpc ExecuteTool(ExecuteToolRequest) returns (ExecuteToolResponse) Menjalankan alat yang diberikan dengan argumen yang diberikan. Cakupan otorisasi Memerlukan salah satu cakupan OAuth berikut: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Untuk mengetahui informasi selengkapnya, lihat Authentication Overview. Izin IAM Memerlukan izin IAM berikut pada resource parent: ces.tools.execute Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.

RetrieveToolSchema

rpc RetrieveToolSchema(RetrieveToolSchemaRequest) returns (RetrieveToolSchemaResponse) Mengambil skema alat yang ditentukan. Skema dihitung secara langsung untuk instance alat tertentu. Cakupan otorisasi Memerlukan salah satu cakupan OAuth berikut: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Untuk mengetahui informasi selengkapnya, lihat Authentication Overview. Izin IAM Memerlukan izin IAM berikut pada resource parent: ces.tools.get Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.

RetrieveTools

rpc RetrieveTools(RetrieveToolsRequest) returns (RetrieveToolsResponse) Mengambil daftar alat yang disertakan dalam toolset yang ditentukan. Cakupan otorisasi Memerlukan salah satu cakupan OAuth berikut: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Untuk mengetahui informasi selengkapnya, lihat Authentication Overview. Izin IAM Memerlukan izin IAM berikut pada resource toolset: ces.toolsets.get Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.

WidgetService

Menyediakan API bagi widget untuk berinteraksi dengan CES API.

GenerateChatToken
rpc GenerateChatToken(GenerateChatTokenRequest) returns (GenerateChatTokenResponse) Membuat token cakupan sesi untuk widget chat agar dapat melakukan autentikasi dengan Session API. Cakupan otorisasi Memerlukan salah satu cakupan OAuth berikut: https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.

Tindakan

Konfigurasi Tindakan yang akan digunakan alat. Catatan: Ini bisa berupa Tindakan atau Operasi. Lihat https://cloud.google.com/integration-connectors/docs/entities-operation-action untuk mengetahui detailnya.

Kolom
input_fields[]	string Opsional. Kolom entitas yang akan digunakan sebagai input untuk operasi. Jika tidak ada kolom yang ditentukan, semua kolom Entity akan digunakan.
output_fields[]	string Opsional. Kolom entitas yang akan ditampilkan dari operasi. Jika tidak ada kolom yang ditentukan, semua kolom Entity akan ditampilkan.
Kolom union action_spec. Spesifikasi untuk tindakan yang akan dikonfigurasi agar dapat digunakan oleh alat. action_spec hanya ada berupa salah satu diantara berikut:
connection_action_id	string ID tindakan Koneksi yang akan digunakan alat.
entity_operation	Action.EntityOperation Konfigurasi operasi entitas yang akan digunakan alat.

EntityOperation

Spesifikasi operasi CRUD entity.

Kolom
entity_id	string Wajib. ID entitas.
operation	Action.EntityOperation.OperationType Wajib. Operasi yang akan dilakukan pada entity.

OperationType

Operasi yang akan dilakukan pada entity.

Enum
OPERATION_TYPE_UNSPECIFIED	Jenis operasi tidak ditentukan. Tidak valid, pembuatan/pembaruan ConnectorTool akan gagal.
LIST	Operasi daftar.
GET	Mendapatkan operasi.
CREATE	Operasi pembuatan.
UPDATE	Operasi update.
DELETE	Hapus operasi.

Agen

Agen bertindak sebagai elemen penyusun dasar yang memberikan petunjuk ke Model Bahasa Besar (LLM) untuk menjalankan tugas tertentu.

Kolom
name	string ID. ID unik agen. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
display_name	string Wajib. Nama tampilan agen.
description	string Opsional. Deskripsi agen yang dapat dibaca manusia.
model_settings	ModelSettings Opsional. Konfigurasi untuk model LLM.
instruction	string Opsional. Petunjuk untuk model LLM guna memandu perilaku agen.
tools[]	string Opsional. Daftar alat yang tersedia untuk agen. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
child_agents[]	string Opsional. Daftar agen turunan di struktur agen. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
before_agent_callbacks[]	Callback Opsional. Callback yang akan dieksekusi sebelum agen dipanggil. Callback yang diberikan dieksekusi secara berurutan dalam urutan persis seperti yang diberikan dalam daftar. Jika callback menampilkan respons yang diganti, eksekusi akan berhenti dan callback yang tersisa akan dilewati.
after_agent_callbacks[]	Callback Opsional. Callback yang akan dieksekusi setelah agen dipanggil. Callback yang diberikan dieksekusi secara berurutan dalam urutan persis seperti yang diberikan dalam daftar. Jika callback menampilkan respons yang diganti, eksekusi akan berhenti dan callback yang tersisa akan dilewati.
before_model_callbacks[]	Callback Opsional. Callback yang akan dieksekusi sebelum model dipanggil. Jika ada beberapa panggilan ke model, callback akan dieksekusi beberapa kali. Callback yang diberikan dieksekusi secara berurutan dalam urutan persis seperti yang diberikan dalam daftar. Jika callback menampilkan respons yang diganti, eksekusi akan berhenti dan callback yang tersisa akan dilewati.
after_model_callbacks[]	Callback Opsional. Callback yang akan dijalankan setelah model dipanggil. Jika ada beberapa panggilan ke model, callback akan dieksekusi beberapa kali. Callback yang diberikan dieksekusi secara berurutan dalam urutan persis seperti yang diberikan dalam daftar. Jika callback menampilkan respons yang diganti, eksekusi akan berhenti dan callback yang tersisa akan dilewati.
before_tool_callbacks[]	Callback Opsional. Callback yang akan dieksekusi sebelum alat dipanggil. Jika ada beberapa pemanggilan alat, callback akan dieksekusi beberapa kali. Callback yang diberikan dieksekusi secara berurutan dalam urutan persis seperti yang diberikan dalam daftar. Jika callback menampilkan respons yang diganti, eksekusi akan berhenti dan callback yang tersisa akan dilewati.
after_tool_callbacks[]	Callback Opsional. Callback yang akan dieksekusi setelah alat dipanggil. Jika ada beberapa pemanggilan alat, callback akan dieksekusi beberapa kali. Callback yang diberikan dieksekusi secara berurutan dalam urutan persis seperti yang diberikan dalam daftar. Jika callback menampilkan respons yang diganti, eksekusi akan berhenti dan callback yang tersisa akan dilewati.
create_time	Timestamp Hanya output. Stempel waktu saat agen dibuat.
update_time	Timestamp Hanya output. Stempel waktu saat agen terakhir diperbarui.
guardrails[]	string Opsional. Daftar batasan untuk agen. Format: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}
etag	string ETag yang digunakan untuk memastikan objek tidak berubah selama operasi baca-ubah-tulis. Jika etag kosong, pembaruan akan menimpa perubahan serentak.
toolsets[]	Agent.AgentToolset Opsional. Daftar toolset untuk agen.
generated_summary	string Hanya output. Jika agen dibuat oleh asisten LLM, kolom ini berisi ringkasan deskriptif dari pembuatan tersebut.
transfer_rules[]	TransferRule Opsional. Aturan transfer agen. Jika ada beberapa aturan yang cocok, aturan pertama dalam daftar akan digunakan.
validation_errors[]	string Hanya output. Kesalahan konfigurasi atau error pada agen yang dapat memengaruhi kualitas agen.
Kolom union agent_type. Jenis agen. agent_type hanya ada berupa salah satu diantara berikut:
llm_agent	Agent.LlmAgent Opsional. Jenis agen default.
remote_dialogflow_agent	Agent.RemoteDialogflowAgent Opsional. Agen Dialogflow jarak jauh yang akan digunakan untuk eksekusi agen. Jika kolom ini ditetapkan, semua properti tingkat agen lainnya akan diabaikan. Catatan: Jika agen Dialogflow berada dalam project yang berbeda dari aplikasi, Anda harus memberikan roles/dialogflow.client ke agen layanan CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
remote_a2a_agent	Agent.RemoteA2aAgent Opsional. Agen A2A jarak jauh yang akan digunakan untuk eksekusi agen.

AgentToolset

Kumpulan alat dengan pilihan alatnya.

Kolom
toolset	string Wajib. Nama resource toolset. Format: projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
tool_ids[]	string Opsional. ID alat untuk memfilter set alat.

LlmAgent

Jenis ini tidak memiliki kolom.

Jenis agen default. Agen menggunakan petunjuk dan callback yang ditentukan di agen untuk melakukan tugas menggunakan model bahasa besar.

RemoteA2aAgent

Agen yang akan mentransfer eksekusi ke agen A2A jarak jauh.

Kolom
a2a_config	RemoteA2aConfig Wajib. Konfigurasi koneksi A2A.

RemoteDialogflowAgent

Agen yang akan mentransfer eksekusi ke agen Dialogflow CX jarak jauh. Agen Dialogflow akan memproses kueri pengguna berikutnya hingga sesi berakhir atau alur berakhir, dan kontrol ditransfer kembali ke agen CES induk.

Kolom
agent	string Wajib. Nama resource agen Dialogflow. Format: projects/{project}/locations/{location}/agents/{agent}
flow_id	string Opsional. ID alur untuk alur di agen Dialogflow.
environment_id	string Opsional. ID lingkungan agen Dialogflow yang akan digunakan untuk eksekusi agen. Jika tidak ditentukan, lingkungan draf akan digunakan.
input_variable_mapping	map<string, string> Opsional. Pemetaan nama variabel aplikasi ke nama parameter sesi Dialogflow yang akan dikirim ke agen Dialogflow sebagai input.
output_variable_mapping	map<string, string> Opsional. Pemetaan nama parameter sesi Dialogflow ke nama variabel aplikasi yang akan dikirim kembali ke agen CES setelah eksekusi agen Dialogflow berakhir.
respect_response_interruption_settings	bool Opsional. Menunjukkan apakah akan mematuhi setelan gangguan tingkat pesan yang dikonfigurasi di agen Dialogflow. Jika salah (false): semua pesan respons dari agen Dialogflow mengikuti setelan interupsi tingkat aplikasi. Jika benar: hanya pesan respons dengan allow_playback_interruption yang disetel ke benar yang dapat disela, semua pesan lainnya mengikuti setelan sela di tingkat aplikasi.
language_code_variable	string Opsional. Nama variabel yang berisi kode bahasa yang akan digunakan untuk sesi Dialogflow. Jika tidak ditentukan, kode bahasa default agen Dialogflow akan digunakan.

AgentCard

AgentCard menyampaikan informasi penting tentang agen jarak jauh. Ini adalah versi yang disederhanakan dari AgentCard yang ditentukan dalam protokol A2A https://a2a-protocol.org/dev/specification/#441-agentcard

Kolom
name	string Wajib. Nama agen yang dapat dibaca manusia.
description	string Wajib. Deskripsi domain tindakan/ruang solusi agen.
supported_interfaces[]	AgentInterface Wajib. Daftar antarmuka yang didukung dan diurutkan. Entri pertama lebih disukai.
version	string Wajib. Versi agen.
skills[]	AgentSkill Wajib. Keahlian mewakili unit kemampuan yang dapat dilakukan agen. Hal ini mungkin agak abstrak, tetapi mewakili serangkaian tindakan yang lebih terfokus yang kemungkinan besar akan berhasil dilakukan agen.

AgentInterface

Mendeklarasikan kombinasi URL target, transpor, dan versi protokol untuk berinteraksi dengan agen. Hal ini memungkinkan agen mengekspos fungsi yang sama melalui beberapa mekanisme pengikatan protokol.

Kolom
url	string Wajib. URL tempat antarmuka ini tersedia. Harus berupa URL HTTPS absolut yang valid dalam produksi. Contoh: "https://api.example.com/a2a/v1", "https://grpc.example.com/a2a"
protocol_binding	string Wajib. Pengikatan protokol yang didukung di URL ini. Ini adalah string formulir terbuka, yang dapat dengan mudah diperluas untuk binding protokol lainnya. Yang didukung secara resmi adalah JSONRPC, GRPC, dan HTTP+JSON.
tenant	string ID tenant yang akan digunakan dalam permintaan saat memanggil agen.
protocol_version	string Wajib. Versi protokol A2A yang diekspos oleh antarmuka ini. Gunakan versi minor terbaru yang didukung per versi utama. Contoh: "0.3", "1.0"

AgentRegistryDeployment

Konfigurasi dan status untuk deployment Agent Registry.

Kolom
agent_registry_service_name	string Opsional. Hanya output. Nama resource layanan Agent Registry yang di-deploy. Format: projects/{project}/locations/{location}/services/{service}

AgentSkill

Mewakili kemampuan atau fungsi berbeda yang dapat dilakukan agen.

Kolom
id	string Wajib. ID unik untuk kemampuan agen.
name	string Wajib. Nama keahlian yang dapat dibaca manusia.
description	string Wajib. Deskripsi mendetail tentang keahlian.
tags[]	string Wajib. Sekumpulan kata kunci yang menjelaskan kemampuan skill.
examples[]	string Contoh perintah atau skenario yang dapat ditangani oleh kemampuan ini.
input_modes[]	string Kumpulan jenis media input yang didukung untuk skill ini, yang menggantikan default agen.
output_modes[]	string Kumpulan jenis media output yang didukung untuk skill ini, yang menggantikan default agen.

AgentTool

Mewakili alat yang memungkinkan agen memanggil agen lain.

Kolom
name	string Wajib. Nama alat agen.
description	string Opsional. Deskripsi tujuan alat.
agent	string Opsional. Nama resource agen yang menjadi titik entri alat. Format: projects/{project}/locations/{location}/agents/{agent}

AgentTransfer

Mewakili peristiwa yang menunjukkan pengalihan percakapan ke agen lain.

Kolom
target_agent	string Wajib. Agen yang akan menerima pengalihan percakapan. Agen akan menangani percakapan mulai saat ini. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
display_name	string Hanya output. Nama tampilan agen.

AmbientSoundConfig

Konfigurasi untuk suara sekitar yang akan diputar dengan respons agen yang disintesis, untuk meningkatkan kealamian percakapan.

Kolom
volume_gain_db	double Opsional. Peningkatan volume (dalam dB) volume native normal yang didukung oleh suara bising di sekitar, dalam rentang [-96,0, 16,0]. Jika tidak disetel, atau disetel ke nilai 0,0 (dB), akan diputar pada amplitudo sinyal native normal. Nilai -6,0 (dB) akan diputar dengan sekitar setengah amplitudo sinyal native normal. Nilai +6,0 (dB) akan diputar dengan amplitudo sinyal native normal yang kira-kira dua kali lipat. Sebaiknya jangan melebihi +10 (dB) karena biasanya tidak ada peningkatan efektif dalam kerasnya suara untuk nilai yang lebih besar dari itu.
Kolom union source. Suara bising di sekitar yang akan diputar dengan respons agen yang disintesis, untuk meningkatkan kealamian percakapan. source hanya ada berupa salah satu diantara berikut:
prebuilt_ambient_noise (deprecated)	AmbientSoundConfig.PrebuiltAmbientNoise Item ini tidak digunakan lagi. Opsional. Tidak digunakan lagi: prebuilt_ambient_noise tidak digunakan lagi dan digantikan dengan prebuilt_ambient_sound.
gcs_uri	string Opsional. Suara bising di sekitar sebagai file WAV 16 kHz satu saluran yang disimpan di Cloud Storage. Catatan: Pastikan agen layanan CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com memiliki izin storage.objects.get ke objek Cloud Storage.
prebuilt_ambient_sound	string Opsional. Nama suara sekitar bawaan. Nilai yang valid adalah: - "coffee_shop" - "keyboard" - "keypad" - "hum" - "office_1" - "office_2" - "office_3" - "room_1" - "room_2" - "room_3" - "room_4" - "room_5" - "air_conditioner"

PrebuiltAmbientNoise

Suara bising di sekitar bawaan.

Enum
PREBUILT_AMBIENT_NOISE_UNSPECIFIED	Tidak ditentukan.
RETAIL_STORE	Suara latar toko retail.
CONVENTION_HALL	Suara bising di sekitar aula konvensi.
OUTDOOR	Suara bising di sekitar jalan.

ApiAuthentication

Informasi autentikasi diperlukan untuk panggilan API.

Kolom
Kolom union auth_config. Konfigurasi autentikasi. auth_config hanya ada berupa salah satu diantara berikut:
api_key_config	ApiKeyConfig Opsional. Konfigurasi untuk autentikasi kunci API.
oauth_config	OAuthConfig Opsional. Konfigurasi untuk OAuth.
service_agent_id_token_auth_config	ServiceAgentIdTokenAuthConfig Opsional. Konfigurasi untuk autentikasi token ID yang dibuat dari agen layanan CES.
service_account_auth_config	ServiceAccountAuthConfig Opsional. Konfigurasi untuk autentikasi akun layanan.
bearer_token_config	BearerTokenConfig Opsional. Konfigurasi untuk autentikasi token pembawa.

ApiKeyConfig

Konfigurasi untuk autentikasi dengan kunci API.

Kolom
key_name	string Wajib. Nama parameter atau nama header kunci API. Misalnya, Jika permintaan API adalah "https://example.com/act?X-Api-Key=", "X-Api-Key" akan menjadi nama parameter.
api_key_secret_version	string Wajib. Nama resource versi secret SecretManager yang menyimpan kunci API. Format: projects/{project}/secrets/{secret}/versions/{version} Catatan: Anda harus memberikan peran roles/secretmanager.secretAccessor kepada agen layanan CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
request_location	ApiKeyConfig.RequestLocation Wajib. Lokasi kunci dalam permintaan.

RequestLocation

Lokasi kunci API dalam permintaan.

Enum
REQUEST_LOCATION_UNSPECIFIED	Tidak ditentukan. Nilai ini tidak boleh digunakan.
HEADER	Mewakili kunci di header http.
QUERY_STRING	Mewakili kunci dalam string kueri.

Aplikasi

Aplikasi berfungsi sebagai penampung tingkat teratas untuk sekelompok agen, termasuk agen root dan sub-agennya, beserta konfigurasi terkaitnya. Agen ini bekerja sama untuk mencapai sasaran tertentu dalam konteks aplikasi.

Kolom
name	string ID. ID unik aplikasi. Format: projects/{project}/locations/{location}/apps/{app}
display_name	string Wajib. Nama tampilan aplikasi.
description	string Opsional. Deskripsi aplikasi yang dapat dibaca manusia.
pinned	bool Opsional. Apakah aplikasi disematkan dalam daftar aplikasi.
root_agent	string Opsional. Agen root adalah titik entri aplikasi. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
language_settings	LanguageSettings Opsional. Setelan bahasa aplikasi.
time_zone_settings	TimeZoneSettings Opsional. Setelan TimeZone aplikasi.
audio_processing_config	AudioProcessingConfig Opsional. Konfigurasi pemrosesan audio aplikasi.
logging_settings	LoggingSettings Opsional. Setelan pencatatan log aplikasi.
error_handling_settings	ErrorHandlingSettings Opsional. Menangani error setelan aplikasi.
model_settings	ModelSettings Opsional. Setelan model LLM default untuk aplikasi. Setiap resource (misalnya, agen, pembatas) dapat mengganti konfigurasi ini sesuai kebutuhan.
tool_execution_mode	App.ToolExecutionMode Opsional. Mode eksekusi alat untuk aplikasi. Jika tidak diberikan, defaultnya adalah PARALLEL.
evaluation_metrics_thresholds	EvaluationMetricsThresholds Opsional. Batas evaluasi untuk aplikasi.
variable_declarations[]	App.VariableDeclaration Opsional. Deklarasi variabel.
predefined_variable_declarations[]	App.VariableDeclaration Hanya output. Deklarasi variabel yang telah ditentukan sebelumnya untuk aplikasi.
global_instruction	string Opsional. Petunjuk untuk semua agen di aplikasi. Anda dapat menggunakan petunjuk ini untuk menyiapkan identitas atau kepribadian yang stabil di semua agen.
guardrails[]	string Opsional. Daftar pembatasan untuk aplikasi. Format: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}
data_store_settings	DataStoreSettings Opsional. Setelan penyimpanan data untuk aplikasi.
default_channel_profile	ChannelProfile Opsional. Profil saluran default yang digunakan oleh aplikasi.
metadata	map<string, string> Opsional. Metadata tentang aplikasi. Kolom ini dapat digunakan untuk menyimpan informasi tambahan yang relevan dengan detail atau penggunaan yang dimaksudkan dari aplikasi.
create_time	Timestamp Hanya output. Stempel waktu saat aplikasi dibuat.
update_time	Timestamp Hanya output. Stempel waktu saat aplikasi terakhir diperbarui.
etag	string Hanya output. ETag yang digunakan untuk memastikan objek tidak berubah selama operasi baca-ubah-tulis. Jika etag kosong, pembaruan akan menimpa perubahan serentak.
deployment_count	int32 Hanya output. Jumlah deployment di aplikasi.
client_certificate_settings	ClientCertificateSettings Opsional. Setelan sertifikat klien default untuk aplikasi.
vpc_sc_settings	VpcScSettings Opsional. Setelan VPC-SC untuk aplikasi.
locked	bool Opsional. Menunjukkan apakah aplikasi dikunci untuk perubahan. Jika aplikasi dikunci, modifikasi pada resource aplikasi akan ditolak.
validation_errors[]	string Hanya output. Kesalahan konfigurasi atau peringatan di aplikasi.
dashboard_settings	DashboardSettings Opsional. Setelan dasbor khusus aplikasi untuk menautkan dan mengonfigurasi dasbor Contact Center Insights.

ToolExecutionMode

Menentukan perilaku eksekusi alat jika ada beberapa alat yang dipilih oleh agen secara bersamaan.

Enum
TOOL_EXECUTION_MODE_UNSPECIFIED	Mode eksekusi alat tidak ditentukan. Nilai defaultnya adalah PARALEL.
PARALLEL	Jika ada beberapa alat yang dipilih, alat tersebut akan dieksekusi secara paralel, dengan ToolContext yang sama.
SEQUENTIAL	Jika ada beberapa alat yang dipilih, alat tersebut akan dieksekusi secara berurutan. Alat berikutnya hanya akan dieksekusi setelah alat sebelumnya selesai dan dapat melihat ToolContext yang diperbarui dari alat sebelumnya.

VariableDeclaration

Menentukan struktur dan metadata untuk variabel.

Kolom
name	string Wajib. Nama variabel. Nama harus diawali dengan huruf atau garis bawah dan hanya berisi huruf, angka, atau garis bawah.
description	string Wajib. Deskripsi variabel.
schema	Schema Wajib. Skema variabel.

AppSnapshot

Snapshot aplikasi.

Kolom
app	App Opsional. Setelan dasar untuk aplikasi.
agents[]	Agent Opsional. Daftar agen di aplikasi.
tools[]	Tool Opsional. Daftar alat di aplikasi.
examples[]	Example Opsional. Daftar contoh dalam aplikasi.
guardrails[]	Guardrail Opsional. Daftar pembatasan dalam aplikasi.
toolsets[]	Toolset Opsional. Daftar toolset di aplikasi.

AppVersion

Di Customer Engagement Suite (CES), versi aplikasi adalah snapshot aplikasi pada titik waktu tertentu. Objek ini tidak dapat diubah dan tidak dapat dimodifikasi setelah dibuat.

Kolom
name	string ID. ID unik versi aplikasi. Format: projects/{project}/locations/{location}/apps/{app}/versions/{version}
display_name	string Opsional. Nama tampilan versi aplikasi.
description	string Opsional. Deskripsi versi aplikasi.
creator	string Hanya output. Email pengguna yang membuat versi aplikasi.
create_time	Timestamp Hanya output. Stempel waktu saat versi aplikasi dibuat.
update_time	Timestamp Hanya output. Stempel waktu saat versi aplikasi terakhir diperbarui.
snapshot	AppSnapshot Hanya output. Snapshot aplikasi saat versi dibuat.
etag	string Hanya output. ETag yang digunakan untuk memastikan objek tidak berubah selama operasi baca-ubah-tulis. Jika etag kosong, pembaruan akan menimpa perubahan serentak.

AudioEncoding

AudioEncoding menentukan format encoding untuk data audio.

Enum
AUDIO_ENCODING_UNSPECIFIED	Encoding audio tidak ditentukan.
LINEAR16	Encoding audio PCM linear 16-bit.
MULAW	Sampel 8-bit yang memadatkan sampel audio 14-bit menggunakan G.711 PCMU/mu-law.
ALAW	Sampel 8-bit yang memadatkan sampel audio 14-bit menggunakan G.711 PCMU/A-law.

AudioProcessingConfig

Konfigurasi untuk cara pemrosesan dan pengiriman audio input dan output.

Kolom
synthesize_speech_configs	map<string, SynthesizeSpeechConfig> Opsional. Konfigurasi cara respons agen harus disintesis, pemetaan dari kode bahasa ke SynthesizeSpeechConfig. Jika konfigurasi untuk kode bahasa yang ditentukan tidak ditemukan, konfigurasi untuk kode bahasa root akan digunakan. Misalnya, jika peta berisi "en-us" dan "en", dan kode bahasa yang ditentukan adalah "en-gb", maka konfigurasi "en" akan digunakan. Catatan: Kode bahasa tidak peka huruf besar/kecil.
barge_in_config	BargeInConfig Opsional. Mengonfigurasi perilaku agen untuk aktivitas interupsi pengguna.
inactivity_timeout	Duration Opsional. Durasi tidak aktif pengguna (tidak ada ucapan atau interaksi) sebelum agen meminta pengguna untuk berinteraksi kembali. Jika tidak disetel, agen tidak akan meminta pengguna untuk berinteraksi kembali.
ambient_sound_config	AmbientSoundConfig Opsional. Konfigurasi untuk suara sekitar yang akan diputar dengan respons agen yang disintesis, untuk meningkatkan kealamian percakapan.
custom_voice_samples[]	CustomVoiceSample Opsional. Mengonfigurasi contoh suara kustom untuk kloning suara.

AudioRecordingConfig

Konfigurasi cara interaksi audio harus direkam.

Kolom
gcs_bucket	string Opsional. Bucket Cloud Storage untuk menyimpan rekaman audio sesi. URI harus diawali dengan "gs://". Pilih lokasi bucket yang memenuhi persyaratan residensi data Anda. Catatan: Jika bucket Cloud Storage berada di project yang berbeda dari aplikasi, Anda harus memberikan izin storage.objects.create ke agen layanan CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
gcs_path_prefix	string Opsional. Awalan jalur Cloud Storage untuk rekaman audio. Awalan ini dapat mencakup placeholder berikut, yang akan diganti secara dinamis pada waktu penayangan: - $project: project ID - $location: lokasi aplikasi - $app: ID aplikasi - $date: tanggal sesi dalam format YYYY-MM-DD - $session: ID sesi Jika awalan jalur tidak ditentukan, awalan default $project/$location/$app/$date/$session/ akan digunakan.

BargeInConfig

Konfigurasi cara penanganan aktivitas interupsi pengguna.

Kolom
disable_barge_in (deprecated)	bool Item ini tidak digunakan lagi. Opsional. Tidak digunakan lagi: disable_barge_in tidak digunakan lagi dan digantikan dengan disable_barge_in_control di ChannelProfile. Menonaktifkan interupsi pengguna saat agen sedang berbicara. Jika benar (true), input pengguna selama pemutaran respons agen akan diabaikan.
barge_in_awareness	bool Opsional. Jika diaktifkan, agen akan menyesuaikan respons berikutnya berdasarkan asumsi bahwa pengguna belum mendengar pesan agen sebelumnya secara keseluruhan. Hal ini tidak boleh digunakan dalam skenario saat respons agen ditampilkan secara visual.

BatchDeleteConversationsRequest

Pesan permintaan untuk AgentService.BatchDeleteConversations.

Kolom
parent	string Wajib. Nama resource aplikasi yang percakapannya akan dihapus. Format: projects/{project}/locations/{location}/apps/{app}
conversations[]	string Wajib. Nama resource percakapan yang akan dihapus.

BatchDeleteConversationsResponse

Pesan respons untuk AgentService.BatchDeleteConversations.

Kolom
deleted_conversations[]	string Daftar percakapan yang berhasil dihapus.
failed_conversations[]	string Daftar percakapan yang gagal dihapus.
error_messages[]	string Opsional. Daftar pesan error yang terkait dengan percakapan yang gagal dihapus.

BearerTokenConfig

Konfigurasi untuk autentikasi dengan token pembawa.

Kolom
token	string Wajib. Token pemilik. Harus dalam format $context.variables.<name_of_variable>.

BidiSessionClientMessage

Pesan tingkat teratas yang dikirim oleh klien untuk metode SessionService.BidiRunSession.

Kolom
Kolom union message_type. Jenis pesan. message_type hanya ada berupa salah satu diantara berikut:
config	SessionConfig Opsional. Pesan konfigurasi awal untuk sesi.
realtime_input	SessionInput Opsional. Input real-time untuk sesi.

BidiSessionServerMessage

Pesan tingkat teratas yang ditampilkan dari metode SessionService.BidiRunSession.

Kolom
Kolom union message_type. Jenis pesan. message_type hanya ada berupa salah satu diantara berikut:
session_output	SessionOutput Opsional. Hasil pemrosesan dari agen CES.
recognition_result	RecognitionResult Opsional. Hasil pengenalan ucapan real-time untuk input audio.
interruption_signal	InterruptionSignal Opsional. Menunjukkan bahwa respons audio agen telah terganggu.
end_session	EndSession Opsional. Menunjukkan bahwa sesi telah berakhir.
go_away	GoAway Opsional. Menunjukkan bahwa server akan segera terputus dan klien harus menutup sebagian dan memulai ulang koneksi.

BigQueryExportSettings

Setelan untuk menjelaskan perilaku BigQuery Export untuk aplikasi.

Kolom
enabled	bool Opsional. Menunjukkan apakah BigQuery Export diaktifkan.
project	string Opsional. Project ID set data BigQuery yang akan diekspor datanya. Catatan: Jika set data BigQuery berada dalam project yang berbeda dengan aplikasi, Anda harus memberikan peran roles/bigquery.admin kepada agen layanan CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
dataset	string Opsional. ID set data BigQuery untuk mengekspor data.

Blob

Menampilkan input atau output blob dalam percakapan.

Kolom
mime_type	string Wajib. Jenis MIME standar IANA dari data sumber.
data	bytes Wajib. Byte mentah blob.

Callback

Callback menentukan logika kustom yang akan dieksekusi di berbagai tahap interaksi agen.

Kolom
description	string Opsional. Deskripsi callback yang dapat dibaca manusia.
disabled	bool Opsional. Apakah panggilan balik dinonaktifkan. Callback yang dinonaktifkan akan diabaikan oleh agen.
proactive_execution_enabled	bool Opsional. Jika diaktifkan, callback juga akan dieksekusi pada output model perantara. Setelan ini hanya memengaruhi callback setelah model. AKTIFKAN DENGAN HATI-HATI. Biasanya, callback setelah model hanya perlu dieksekusi setelah menerima semua respons model. Mengaktifkan eksekusi proaktif dapat berimplikasi negatif pada biaya dan latensi eksekusi, dan hanya boleh diaktifkan dalam situasi yang jarang terjadi.
Kolom union callback. Callback yang akan dieksekusi. callback hanya ada berupa salah satu diantara berikut:
python_code	string Wajib. Kode python yang akan dieksekusi untuk callback.

Log perubahan

Log perubahan mewakili perubahan yang dilakukan pada aplikasi atau pada resource dalam aplikasi.

Kolom
name	string ID. ID unik log perubahan. Format: projects/{project}/locations/{location}/apps/{app}/changelogs/{changelog}
author	string Hanya output. Alamat email penulis perubahan.
display_name	string Hanya output. Nama tampilan perubahan. Biasanya, nilai ini adalah nama tampilan resource yang diubah.
description	string Hanya output. Deskripsi perubahan, yang biasanya mencakup kolom yang diubah dalam resource.
resource	string Hanya output. Resource yang diubah.
resource_type	string Hanya output. Jenis resource yang diubah.
action	string Hanya output. Tindakan yang dilakukan pada resource.
original_resource	Struct Hanya output. Resource asli sebelum perubahan.
new_resource	Struct Hanya output. Aset baru setelah perubahan.
dependent_resources[]	Struct Hanya output. Resource dependen yang diubah.
create_time	Timestamp Hanya output. Waktu saat perubahan dilakukan.
sequence_number	int64 Hanya output. Nomor urut changelog yang meningkat secara monoton.

ChannelProfile

ChannelProfile mengonfigurasi perilaku agen untuk saluran komunikasi tertentu, seperti UI web atau telepon.

Kolom
profile_id	string Opsional. ID unik profil channel.
channel_type	ChannelProfile.ChannelType Opsional. Jenis profil saluran.
persona_property	ChannelProfile.PersonaProperty Opsional. Properti persona profil channel.
web_widget_config	ChannelProfile.WebWidgetConfig Opsional. Konfigurasi untuk widget web.
whatsapp_config	ChannelProfile.WhatsAppConfig Opsional. Konfigurasi khusus untuk deployment WhatsApp.
instagram_config	ChannelProfile.InstagramConfig Opsional. Konfigurasi khusus untuk deployment Instagram.
disable_dtmf	bool Opsional. Apakah akan menonaktifkan DTMF (nada ganda multi-frekuensi).
disable_barge_in_control	bool Opsional. Apakah akan menonaktifkan kontrol interupsi pengguna dalam percakapan. - true: Interupsi pengguna dinonaktifkan saat agen berbicara. - false: Agen mempertahankan kontrol otomatis atas kapan pengguna dapat menginterupsi.
noise_suppression_level	string Opsional. Tingkat peredam bising profil channel. Nilai yang tersedia adalah "low", "moderate", "high", "very_high".

ChannelType

Jenis profil saluran.

Enum
UNKNOWN	Jenis saluran tidak diketahui.
WEB_UI	Saluran UI Web.
API	Saluran API.
TWILIO	Saluran Twilio.
GOOGLE_TELEPHONY_PLATFORM	Saluran Google Telephony Platform.
CONTACT_CENTER_AS_A_SERVICE	Saluran Contact Center as a Service (CCaaS).
CONTACT_CENTER_AS_A_SERVICE_CHAT	Saluran Contact Center as a Service (CCaaS Chat).
FIVE9	Saluran Five9.
CONTACT_CENTER_INTEGRATION	Saluran integrasi pusat kontak pihak ketiga.
WHATSAPP	Saluran WhatsApp.
INSTAGRAM	Channel Instagram.

InstagramConfig

Konfigurasi khusus untuk deployment Instagram.

Kolom
instagram_account_id	string Wajib. ID Akun Instagram.
display_name	string Hanya output. Nama halaman bisnis Meta yang diambil.
thumbnail_url	string Hanya output. URL thumbnail profil bisnis Meta yang diambil.
description	string Hanya output. Deskripsi halaman atau profil bisnis Meta.

PersonaProperty

Mewakili properti persona channel.

Kolom
persona	ChannelProfile.PersonaProperty.Persona Opsional. Persona channel.

Persona

Persona channel.

Enum
UNKNOWN	Persona TIDAK DIKENAL.
CONCISE	Agen menjaga agar respons tetap ringkas dan langsung ke intinya
CHATTY	Agen memberikan konteks, penjelasan, dan detail tambahan

WebWidgetConfig

Pesan untuk konfigurasi widget web.

Kolom
modality	ChannelProfile.WebWidgetConfig.Modality Opsional. Modalitas widget web.
theme	ChannelProfile.WebWidgetConfig.Theme Opsional. Tema widget web.
web_widget_title	string Opsional. Judul widget web.
security_settings	ChannelProfile.WebWidgetConfig.SecuritySettings Opsional. Setelan keamanan widget web.

Modalitas

Modalitas widget web.

Enum
MODALITY_UNSPECIFIED	Modalitas tidak diketahui.
CHAT_AND_VOICE	Widget mendukung input chat dan suara.
VOICE_ONLY	Widget hanya mendukung input suara.
CHAT_ONLY	Widget hanya mendukung input chat.
CHAT_VOICE_AND_VIDEO	Widget mendukung input chat, suara, dan video.

SecuritySettings

Setelan keamanan untuk widget web.

Kolom
enable_public_access	bool Opsional. Menunjukkan apakah akses publik ke widget web diaktifkan. Jika true, widget web akan dapat diakses secara publik. Jika false, widget web harus diintegrasikan dengan sistem autentikasi dan otorisasi Anda sendiri untuk menampilkan kredensial yang valid untuk mengakses agen CES.
enable_origin_check	bool Opsional. Menunjukkan apakah pemeriksaan origin untuk widget web diaktifkan. Jika true, widget web akan memeriksa asal situs yang memuat widget web dan hanya mengizinkannya dimuat di asal yang sama atau salah satu asal yang diizinkan.
allowed_origins[]	string Opsional. Origin yang diizinkan untuk menghosting widget web. Origin ditentukan oleh RFC 6454. Jika kosong, semua origin diizinkan. Maksimum 100 origin diizinkan. Contoh: "https://example.com"
enable_recaptcha	bool Opsional. Menunjukkan apakah verifikasi reCAPTCHA untuk widget web diaktifkan.

Tema

Tema widget web.

Enum
THEME_UNSPECIFIED	Tema tidak diketahui.
LIGHT	Tema terang.
DARK	Tema gelap.

WhatsAppConfig

Konfigurasi khusus untuk deployment WhatsApp.

Kolom
waba_id	string Wajib. ID Akun WhatsApp Business.
phone_number_id	string Wajib. ID nomor telepon Meta.
phone_number	string Opsional. Nomor telepon dalam format E.164.
display_name	string Hanya output. Nama halaman bisnis Meta yang diambil.
thumbnail_url	string Hanya output. URL thumbnail profil bisnis Meta yang diambil.
description	string Hanya output. Deskripsi halaman atau profil bisnis Meta.

Chunk

Potongan konten dalam pesan.

Kolom
Kolom union data. Data potongan. data hanya ada berupa salah satu diantara berikut:
text	string Opsional. Data teks.
transcript	string Opsional. Transkrip yang terkait dengan audio.
blob	Blob Opsional. Data blob.
payload	Struct Opsional. Data payload kustom.
image	Image Opsional. Data gambar.
tool_call	ToolCall Opsional. Permintaan eksekusi alat.
tool_response	ToolResponse Opsional. Respons eksekusi alat.
agent_transfer	AgentTransfer Opsional. Peristiwa transfer agen.
updated_variables	Struct Struct merepresentasikan variabel yang diperbarui dalam percakapan, yang dikelompokkan berdasarkan nama variabel.
default_variables	Struct Struct merepresentasikan variabel default di awal percakapan, yang dikelompokkan berdasarkan nama variabel.

Kutipan

Kutipan yang terkait dengan respons agen.

Kolom
cited_chunks[]	Citations.CitedChunk Daftar informasi yang dikutip.
inline_citations[]	Citations.InlineCitation Opsional. Daftar kutipan inline dalam respons agen.

CitedChunk

Bagian informasi yang dikutip.

Kolom
uri	string URI yang digunakan untuk kutipan.
title	string Judul dokumen yang dikutip.
text	string Teks yang digunakan untuk kutipan.
requires_attribution	bool Apakah kutipan ini memerlukan atribusi yang ditampilkan kepada pengguna akhir.

InlineCitation

Kutipan inline dalam teks respons.

Kolom
start_index	int32 Indeks awal (dalam byte) segmen teks dalam respons agen.
end_index	int32 Indeks akhir (dalam byte) segmen teks dalam respons agen.
cited_chunk_indices[]	int32 Indeks potongan yang dikutip yang mendukung segmen teks ini. Indeks mengacu pada elemen dalam cited_chunks.

ClientCertificateSettings

Setelan untuk sertifikat klien kustom.

Kolom
tls_certificate	string Wajib. Sertifikat TLS yang dienkode dalam format PEM. String ini harus menyertakan baris header awal dan footer akhir.
private_key	string Wajib. Nama resource versi secret SecretManager yang menyimpan kunci pribadi yang dienkode dalam format PEM. Format: projects/{project}/secrets/{secret}/versions/{version}
passphrase	string Opsional. Nama resource versi secret SecretManager yang menyimpan frasa sandi untuk mendekripsi kunci pribadi. Harus dibiarkan tidak disetel jika kunci pribadi tidak dienkripsi. Format: projects/{project}/secrets/{secret}/versions/{version}

ClientFunction

Mewakili fungsi sisi klien yang dapat dipanggil oleh agen. Saat alat dipilih oleh agen, kontrol akan diserahkan kepada klien. Klien bertanggung jawab untuk menjalankan fungsi dan menampilkan hasilnya sebagai ToolResponse untuk melanjutkan interaksi dengan agen.

Kolom
name	string Wajib. Nama fungsi.
description	string Opsional. Deskripsi fungsi.
parameters	Schema Opsional. Skema parameter fungsi.
response	Schema Opsional. Skema respons fungsi.

CloudLoggingSettings

Setelan untuk menjelaskan perilaku Cloud Logging untuk aplikasi.

Kolom
enable_cloud_logging	bool Opsional. Apakah akan mengaktifkan Cloud Logging untuk sesi.

CodeBlock

Blok kode yang akan dieksekusi, bukan panggilan alat yang sebenarnya.

Kolom

python_code

string Wajib. Kode Python yang akan dipanggil dalam mode palsu alat. Tanda tangan fungsi Python yang diharapkan - Untuk menangkap semua panggilan alat: def fake_tool_call(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: Untuk menangkap panggilan alat tertentu: def fake_{tool_id}(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: Jika fungsi menampilkan None, alat yang sebenarnya akan dipanggil.

ConnectorTool

ConnectorTool memungkinkan koneksi ke berbagai integrasi. Lihat: https://cloud.google.com/integration-connectors/docs/overview.

Kolom
connection	string Wajib. Nama resource lengkap Koneksi Integration Connectors yang dirujuk. Format: projects/{project}/locations/{location}/connections/{connection}
action	Action Wajib. Tindakan untuk alat yang akan digunakan.
auth_config	EndUserAuthConfig Opsional. Mengonfigurasi cara penanganan autentikasi di Integration Connectors. Secara default, autentikasi admin diteruskan dalam permintaan API Integration Connectors. Anda dapat menggantinya dengan konfigurasi autentikasi pengguna akhir yang berbeda. Catatan: Koneksi harus mengaktifkan penggantian autentikasi agar dapat menentukan konfigurasi EUC di sini. Jika tidak, pembuatan ConnectorTool akan gagal. Lihat https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override untuk mengetahui detailnya.
name	string Opsional. Nama alat yang dapat digunakan oleh Agen untuk memutuskan apakah akan memanggil ConnectorTool ini.
description	string Opsional. Deskripsi alat yang dapat digunakan oleh Agen untuk memutuskan apakah akan memanggil ConnectorTool ini atau tidak.

ConnectorToolset

Kumpulan alat yang membuat alat dari Koneksi Integration Connectors.

Kolom
connection	string Wajib. Nama resource lengkap Koneksi Integration Connectors yang dirujuk. Format: projects/{project}/locations/{location}/connections/{connection}
auth_config	EndUserAuthConfig Opsional. Mengonfigurasi cara penanganan autentikasi di Integration Connectors. Secara default, autentikasi admin diteruskan dalam permintaan API Integration Connectors. Anda dapat menggantinya dengan konfigurasi autentikasi pengguna akhir yang berbeda. Catatan: Koneksi harus mengaktifkan penggantian autentikasi agar dapat menentukan konfigurasi EUC di sini. Jika tidak, pembuatan Toolset akan gagal. Lihat: https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override
connector_actions[]	Action Wajib. Daftar tindakan konektor/operasi entitas untuk membuat alat.

Percakapan

Percakapan mewakili interaksi antara pengguna akhir dan aplikasi CES.

Kolom
name	string ID. ID unik percakapan. Format: projects/{project}/locations/{location}/apps/{app}/conversations/{conversation}
start_time	Timestamp Hanya output. Stempel waktu saat percakapan dibuat.
end_time	Timestamp Hanya output. Stempel waktu saat percakapan selesai.
turns[]	Conversation.Turn Wajib. Giliran dalam percakapan.
turn_count	int32 Hanya output. Jumlah giliran dalam percakapan.
channel_type (deprecated)	Conversation.ChannelType Item ini tidak digunakan lagi. TIDAK DIGUNAKAN LAGI. Sebagai gantinya, gunakan input_types.
source	Conversation.Source Hanya output. Menunjukkan sumber percakapan.
input_types[]	Conversation.InputType Hanya output. Jenis input percakapan.
entry_agent	string Hanya output. Agen yang awalnya menangani percakapan. Jika tidak ditentukan, percakapan akan ditangani oleh agen root. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
deployment	string Hanya output. Deployment aplikasi yang digunakan untuk memproses percakapan. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
app_version	string Hanya output. Versi aplikasi yang digunakan untuk memproses percakapan. Format: projects/{project}/locations/{location}/apps/{app}/versions/{version}
language_code	string Hanya output. Kode bahasa percakapan.
messages[] (deprecated)	Message Item ini tidak digunakan lagi. Tidak digunakan lagi. Gunakan giliran sebagai gantinya.

ChannelType

Jenis channel percakapan.

Enum
CHANNEL_TYPE_UNSPECIFIED	Jenis saluran tidak ditentukan.
TEXT	Percakapan hanya berisi pesan teks antara pengguna akhir dan agen.
AUDIO	Percakapan berisi pesan audio antara pengguna akhir dan agen.
MULTIMODAL	Pesan multi-modal percakapan (misalnya, gambar) antara pengguna akhir dan agen.

InputType

Jenis pesan input.

Enum
INPUT_TYPE_UNSPECIFIED	Jenis input tidak ditentukan.
INPUT_TYPE_TEXT	Input teks.
INPUT_TYPE_EVENT	Input acara.
INPUT_TYPE_AUDIO	Input audio.
INPUT_TYPE_IMAGE	Input gambar.
INPUT_TYPE_BLOB	Input blob.
INPUT_TYPE_TOOL_RESPONSE	Input respons alat fungsi klien.
INPUT_TYPE_VARIABLES	Input variabel.

Sumber

Sumber percakapan.

Enum
SOURCE_UNSPECIFIED	Sumber tidak ditentukan.
LIVE	Percakapan berasal dari pengguna akhir yang aktif.
SIMULATOR	Percakapan berasal dari simulator.
EVAL	Percakapan berasal dari evaluasi.
AGENT_TOOL	Percakapan berasal dari alat agen. Alat agen menjalankan agen dalam sesi terpisah, yang dipertahankan untuk tujuan pengujian dan proses debug.

Belok

Semua informasi tentang satu giliran dalam percakapan.

Kolom
messages[]	Message Opsional. Daftar pesan dalam giliran percakapan, termasuk input pengguna, respons agen, dan peristiwa perantara selama pemrosesan.
root_span	Span Opsional. Rentang root pemrosesan tindakan.
user_intended_text	string Opsional. Teks kebenaran nyata yang dimaksud dari Penelepon Simulasi (Polysynth). Hanya diisi jika metrik rasio kesalahan kata diaktifkan.

ConversationLoggingSettings

Setelan untuk menjelaskan perilaku logging percakapan untuk aplikasi.

Kolom
disable_conversation_logging	bool Opsional. Apakah akan menonaktifkan logging percakapan untuk sesi.
retention_window	Duration Opsional. Mengontrol periode retensi untuk percakapan. Jika tidak disetel, percakapan akan dipertahankan selama 365 hari.

CreateAgentRequest

Kolom
parent	string Wajib. Nama resource aplikasi untuk membuat agen.
agent_id	string Opsional. ID yang akan digunakan untuk agen, yang akan menjadi komponen akhir dari nama resource agen. Jika tidak diberikan, ID unik akan otomatis ditetapkan untuk agen.
agent	Agent Wajib. Agen yang akan dibuat.

CreateAppRequest

Pesan permintaan untuk AgentService.CreateApp.

Kolom
parent	string Wajib. Nama resource lokasi untuk membuat aplikasi.
app_id	string Opsional. ID yang akan digunakan untuk aplikasi, yang akan menjadi komponen akhir dari nama resource aplikasi. Jika tidak diberikan, ID unik akan otomatis ditetapkan untuk aplikasi.
app	App Wajib. Aplikasi yang akan dibuat.

CreateAppVersionRequest

Pesan permintaan untuk AgentService.CreateAppVersion

Kolom
parent	string Wajib. Nama resource aplikasi untuk membuat versi aplikasi.
app_version_id	string Opsional. ID yang akan digunakan untuk versi aplikasi, yang akan menjadi komponen akhir nama resource versi aplikasi. Jika tidak diberikan, ID unik akan otomatis ditetapkan untuk versi aplikasi.
app_version	AppVersion Wajib. Versi aplikasi yang akan dibuat.

CreateDeploymentRequest

Pesan permintaan untuk AgentService.CreateDeployment.

Kolom
parent	string Wajib. Aplikasi induk. Format: projects/{project}/locations/{location}/apps/{app}
deployment_id	string Opsional. ID yang akan digunakan untuk deployment, yang akan menjadi komponen akhir dari nama resource deployment. Jika tidak diberikan, ID unik akan otomatis ditetapkan untuk deployment.
deployment	Deployment Wajib. Deployment yang akan dibuat.

CreateExampleRequest

Pesan permintaan untuk AgentService.CreateExample.

Kolom
parent	string Wajib. Nama resource aplikasi untuk membuat contoh.
example_id	string Opsional. ID yang akan digunakan untuk contoh, yang akan menjadi komponen akhir dari nama resource contoh. Jika tidak diberikan, ID unik akan otomatis ditetapkan untuk contoh.
example	Example Wajib. Contoh yang akan dibuat.

CreateGuardrailRequest

Pesan permintaan untuk AgentService.CreateGuardrail.

Kolom
parent	string Wajib. Nama resource aplikasi tempat membuat pembatasan.
guardrail_id	string Opsional. ID yang akan digunakan untuk pembatas, yang akan menjadi komponen akhir dari nama resource pembatas. Jika tidak diberikan, ID unik akan otomatis ditetapkan untuk pembatas.
guardrail	Guardrail Wajib. Batasan yang akan dibuat.

CreateToolRequest

Pesan permintaan untuk AgentService.CreateTool.

Kolom
parent	string Wajib. Nama resource aplikasi tempat alat akan dibuat.
tool_id	string Opsional. ID yang akan digunakan untuk alat, yang akan menjadi komponen akhir dari nama resource alat. Jika tidak diberikan, ID unik akan otomatis ditetapkan untuk alat.
tool	Tool Wajib. Alat yang akan dibuat.

CreateToolsetRequest

Pesan permintaan untuk AgentService.CreateToolset.

Kolom
parent	string Wajib. Nama resource aplikasi tempat membuat toolset.
toolset_id	string Opsional. ID yang akan digunakan untuk toolset, yang akan menjadi komponen akhir dari nama resource toolset. Jika tidak diberikan, ID unik akan otomatis ditetapkan untuk toolset.
toolset	Toolset Wajib. Kumpulan alat yang akan dibuat.

CustomVoiceSample

Konfigurasi untuk sampel suara kustom yang digunakan untuk kloning suara.

Kolom
name	string Opsional. Nama yang ditentukan pengguna untuk sampel suara kustom.
voice_sample_gcs_uri	string Opsional. Cloud Storage URI ke sampel audio untuk kloning suara. Contoh audio harus berupa file WAV 24 kHz satu saluran.
consent_audio_gcs_uri	string Opsional. Menyetujui audio untuk kloning suara.
voice_instruction	string Opsional. Petunjuk bahasa alami untuk gaya suara, nada, kecepatan, atau pengucapan.
preview_audio_content	bytes Hanya output. Audio pratinjau yang disintesis untuk suara kustom, diformat sebagai WAV kanonis (LINEAR16, 24 kHz, 16 bit, mono).
preview_text	string Opsional. Teks untuk menyintesis audio pratinjau untuk suara kustom.
warnings[]	CustomVoiceSample.Warning Hanya output. Pesan peringatan yang muncul selama pemrosesan klon suara (misalnya, level audio rendah).
voice_instruction_mode	CustomVoiceSample.VoiceInstructionMode Opsional. Mode petunjuk untuk sampel suara. Jika tidak ditentukan, defaultnya adalah NO_INSTRUCTION.

VoiceInstructionMode

Mode petunjuk untuk sampel suara.

Enum
VOICE_INSTRUCTION_MODE_UNSPECIFIED	Mode petunjuk tidak ditentukan. Nilai defaultnya adalah NO_INSTRUCTION.
NO_INSTRUCTION	Tidak ada perintah suara yang akan digunakan.
GENERATE_INSTRUCTION	Petunjuk suara akan otomatis dibuat oleh AI dari sampel audio.
CUSTOM_INSTRUCTION	Petunjuk suara kustom yang diberikan oleh pengguna.

Peringatan

Pesan peringatan yang muncul selama pemrosesan sampel suara.

Kolom
message	string Hanya output. Deskripsi peringatan yang dapat dibaca manusia.
type	CustomVoiceSample.Warning.WarningType Hanya output. Jenis peringatan.

WarningType

Jenis peringatan yang muncul selama pemrosesan sampel suara.

Enum
WARNING_TYPE_UNSPECIFIED	Jenis peringatan tidak ditentukan.
LOW_AUDIO_LEVEL	Level audio sampel suara terlalu rendah (misalnya, amplitudo RMS rendah).

DashboardSettings

Setelan untuk dasbor yang terkait dengan aplikasi, yang muncul di tampilan Monitoring.

Kolom
default_dashboard	string Opsional. Nama resource dasbor Contact Center Insights default yang terkait dengan aplikasi. Dasbor ini adalah dasbor yang akan ditampilkan saat pengguna membuka tampilan Pemantauan untuk aplikasi. Format: projects/{project}/locations/{location}/dashboards/{dashboard}

DataStore

Resource DataStore di Vertex AI Search.

Kolom
name	string Wajib. Nama lengkap resource DataStore. Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}
type	DataStore.DataStoreType Hanya output. Jenis penyimpanan data. Kolom ini bersifat hanya baca dan diisi oleh server.
document_processing_mode	DataStore.DocumentProcessingMode Hanya output. Mode pemrosesan dokumen untuk koneksi penyimpanan data. Hanya ditetapkan untuk penyimpanan data PUBLIC_WEB dan UNSTRUCTURED.
display_name	string Hanya output. Nama tampilan penyimpanan data.
create_time	Timestamp Hanya output. Stempel waktu saat penyimpanan data dibuat.
connector_config	DataStore.ConnectorConfig Hanya output. Konfigurasi konektor untuk koneksi penyimpanan data.

ConnectorConfig

Konfigurasi konektor untuk koneksi penyimpanan data.

Kolom
collection	string Nama resource koleksi tempat penyimpanan data berada.
collection_display_name	string Nama tampilan koleksi tempat penyimpanan data berada.
data_source	string Nama sumber data. Contoh: salesforce, jira, confluence, bigquery.

DataStoreType

Jenis penyimpanan data.

Enum
DATA_STORE_TYPE_UNSPECIFIED	Tidak ditentukan. Nilai ini menunjukkan bahwa jenis penyimpanan data tidak ditentukan, sehingga tidak akan digunakan selama penelusuran.
PUBLIC_WEB	Penyimpanan data yang berisi konten web publik.
UNSTRUCTURED	Penyimpanan data yang berisi data pribadi tidak terstruktur.
FAQ	Penyimpanan data yang berisi data terstruktur yang digunakan sebagai FAQ.
CONNECTOR	Penyimpanan data yang merupakan konektor ke layanan pihak pertama atau pihak ketiga.

DocumentProcessingMode

Mode pemrosesan dokumen penyimpanan data.

Enum
DOCUMENT_PROCESSING_MODE_UNSPECIFIED	Tidak ditentukan.
DOCUMENTS	Dokumen diproses sebagai dokumen.
CHUNKS	Dokumen dikonversi menjadi potongan.

DataStoreSettings

Setelan terkait penyimpanan data untuk aplikasi.

Kolom
engines[]	DataStoreSettings.Engine Hanya output. Mesin untuk aplikasi.

Mesin

Mesin yang terhubung ke penyimpanan data. Lihat Vertex AI Search: https://cloud.google.com/generative-ai-app-builder/docs/enterprise-search-introduction.

Kolom
name	string Hanya output. Nama resource mesin telusur. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}
type	DataStoreSettings.Engine.Type Hanya output. Jenis mesin.

Jenis

Jenis mesin. Lihat dokumentasi yang tersedia di https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1/SolutionType dan https://cloud.google.com/generative-ai-app-builder/docs/create-datastore-ingest.

Enum
TYPE_UNSPECIFIED	Jenis mesin tidak ditentukan.
ENGINE_TYPE_SEARCH	Mesin SOLUTION_TYPE_SEARCH untuk aplikasi. Semua penyimpanan data konektor yang ditambahkan ke aplikasi akan ditambahkan ke mesin ini.
ENGINE_TYPE_CHAT	Jenis mesin chat. Mesin SOLUTION_TYPE_CHAT untuk aplikasi. Semua penyimpanan data konektor yang ditambahkan ke aplikasi akan ditambahkan ke mesin ini.

DataStoreTool

Alat untuk mengambil dari datastore atau mesin Vertex AI Search untuk melakukan perujukan. Menerima datastore atau mesin, tetapi tidak keduanya. Lihat Vertex AI Search: https://cloud.google.com/generative-ai-app-builder/docs/enterprise-search-introduction.

Kolom
name	string Wajib. Nama alat penyimpanan data.
description	string Opsional. Deskripsi alat.
boost_specs[]	DataStoreTool.BoostSpecs Opsional. Spesifikasi penguatan untuk menguatkan dokumen tertentu.
modality_configs[]	DataStoreTool.ModalityConfig Opsional. Konfigurasi modalitas untuk penyimpanan data.
filter_parameter_behavior	DataStoreTool.FilterParameterBehavior Opsional. Perilaku parameter filter.
Kolom union search_source. Menentukan sumber penelusuran, baik DataStore tunggal maupun Mesin Telusur. search_source hanya ada berupa salah satu diantara berikut:
data_store_source	DataStoreTool.DataStoreSource Opsional. Menelusuri dalam satu DataStore tertentu.
engine_source	DataStoreTool.EngineSource Opsional. Menelusuri dalam Engine (berpotensi di beberapa DataStore).

BoostSpec

Spesifikasi penguatan untuk menguatkan dokumen tertentu.

Kolom
condition_boost_specs[]	DataStoreTool.BoostSpec.ConditionBoostSpec Wajib. Daftar spesifikasi peningkat.

ConditionBoostSpec

Spesifikasi penguatan untuk suatu kondisi.

Kolom
condition	string Wajib. Ekspresi yang menentukan kondisi peningkat. Sintaksisnya sama dengan sintaksis ekspresi filter. Saat ini, satu-satunya kondisi yang didukung adalah daftar kode bahasa BCP-47. Contoh: Untuk meningkatkan saran dalam bahasa Inggris atau Prancis: (lang_code: ANY("en", "fr"))
boost	float Opsional. Kekuatan peningkat, yang harus berada dalam [-1, 1]. Peningkatan negatif berarti penurunan. Defaultnya adalah 0,0. Menyetel ke 1.0 akan memberikan promosi besar pada saran. Namun, hasil teratas tidak selalu merupakan saran yang dipromosikan. Menetapkan ke -1,0 akan menurunkan saran secara signifikan. Namun, saran lain yang relevan mungkin masih ditampilkan. Menyetel ke 0,0 berarti tidak ada peningkatan yang diterapkan. Kondisi peningkatan diabaikan.
boost_control_spec	DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec Opsional. Spesifikasi kompleks untuk peringkat kustom berdasarkan nilai atribut yang ditentukan pelanggan.

BoostControlSpec

Spesifikasi untuk peringkat kustom berdasarkan nilai atribut yang ditentukan pelanggan. Hal ini memberikan lebih banyak kontrol untuk peringkat yang disesuaikan daripada kombinasi sederhana (kondisi, peningkatan) di atas.

Kolom
field_name	string Opsional. Nama kolom yang nilainya akan digunakan untuk menentukan jumlah peningkat.
attribute_type	DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType Opsional. Jenis atribut yang akan digunakan untuk menentukan jumlah peningkat. Nilai atribut dapat diperoleh dari nilai kolom field_name yang ditentukan. Untuk nilai numerik, caranya cukup mudah, yaitu attribute_value = numerical_field_value. Namun, dalam kasus keaktualan, attribute_value = (time.now() - datetime_field_value).
interpolation_type	DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.InterpolationType Opsional. Jenis interpolasi yang akan diterapkan untuk menghubungkan titik kontrol yang tercantum di bawah.
control_points[]	DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint Opsional. Titik kontrol yang digunakan untuk menentukan kurva. Fungsi monotonik (ditentukan melalui interpolation_type di atas) melewati titik kontrol yang tercantum di sini.

AttributeType

Atribut(atau fungsi) yang akan diterapkan peringkat kustomnya.

Enum
ATTRIBUTE_TYPE_UNSPECIFIED	AttributeType tidak ditentukan.
NUMERICAL	Nilai kolom numerik akan digunakan untuk memperbarui jumlah peningkat secara dinamis. Dalam hal ini, attribute_value (nilai x) titik kontrol akan menjadi nilai sebenarnya dari kolom numerik yang boost_amount-nya ditentukan.
FRESHNESS	Untuk kasus penggunaan keaktualan, nilai atribut akan berupa durasi antara waktu saat ini dan tanggal di kolom datetime yang ditentukan. Nilai harus diformat sebagai nilai dayTimeDuration XSD (subset terbatas dari nilai durasi ISO 8601). Pola untuk ini adalah: [nD][T[nH][nM][nS]]. Mis. 5D, 3DT12H30M, T24H.

ControlPoint

Titik kontrol yang digunakan untuk menentukan kurva. Kurva yang ditentukan melalui titik kontrol ini hanya dapat meningkat atau menurun secara monoton(nilai konstan dapat diterima).

Kolom
attribute_value	string Opsional. Dapat berupa salah satu dari: 1. Nilai kolom numerik. 2. Spesifikasi durasi untuk keaktualan: Nilai harus diformat sebagai nilai XSD dayTimeDuration (subset terbatas dari nilai durasi ISO 8601). Pola untuk ini adalah: [nD][T[nH][nM][nS]].
boost_amount	float Opsional. Nilai antara -1 hingga 1 yang digunakan untuk meningkatkan skor jika attribute_value dievaluasi ke nilai yang ditentukan di atas.

InterpolationType

Jenis interpolasi yang akan diterapkan. Defaultnya adalah linear (Piecewise Linear).

Enum
INTERPOLATION_TYPE_UNSPECIFIED	Jenis interpolasi tidak ditentukan. Dalam hal ini, nilai defaultnya adalah Linear.
LINEAR	Interpolasi linear sepotong-sepotong akan diterapkan.

BoostSpecs

Spesifikasi penguatan untuk menguatkan dokumen tertentu. Untuk mengetahui informasi selengkapnya, lihat https://cloud.google.com/generative-ai-app-builder/docs/boosting.

Kolom
data_stores[]	string Wajib. Penyimpanan Data tempat konfigurasi peningkatan diterapkan. Nama lengkap resource DataStore, seperti projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}.
spec[]	DataStoreTool.BoostSpec Wajib. Daftar spesifikasi peningkat.

DataStoreSource

Konfigurasi untuk menelusuri dalam DataStore tertentu.

Kolom
filter	string Opsional. Spesifikasi filter untuk DataStore. Lihat: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata
data_store	DataStore Opsional. Penyimpanan data.

EngineSource

Konfigurasi untuk menelusuri dalam Mesin, yang berpotensi menargetkan DataStore tertentu.

Kolom
engine	string Wajib. Nama lengkap resource Engine. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}
data_store_sources[]	DataStoreTool.DataStoreSource Opsional. Digunakan untuk menargetkan DataStore tertentu dalam Engine. Jika kosong, penelusuran berlaku untuk semua DataStore yang terkait dengan Engine.
filter	string Opsional. Filter yang diterapkan pada penelusuran di seluruh Mesin Telusur. Tidak relevan dan tidak digunakan jika 'data_store_sources' disediakan. Lihat: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata

FilterParameterBehavior

Perilaku parameter filter.

Enum
FILTER_PARAMETER_BEHAVIOR_UNSPECIFIED	Perilaku filter default. Sertakan parameter filter untuk penyimpanan data konektor. Untuk jenis datastore lainnya, parameter input filter dihilangkan.
ALWAYS_INCLUDE	Selalu sertakan parameter filter untuk semua jenis datastore.
NEVER_INCLUDE	Parameter filter tidak pernah disertakan dalam daftar parameter alat, terlepas dari jenis datastore.

GroundingConfig

Konfigurasi perujukan.

Kolom
grounding_level	float Opsional. Nilai minimum perujukan jawaban berdasarkan sumber yang diambil. Nilai memiliki rentang yang dapat dikonfigurasi [1, 5]. Tingkat ini digunakan untuk menentukan batas bawah perujukan jawaban, yang berarti bahwa semua respons dengan skor perujukan di bawah batas bawah akan kembali menampilkan hanya cuplikan yang relevan. Misalnya, tingkat 3 berarti skor perujukan harus 3 atau lebih tinggi agar respons ditampilkan.
disabled	bool Opsional. Apakah perujukan dinonaktifkan.

ModalityConfig

Jika ditentukan, akan menerapkan konfigurasi yang diberikan untuk modalitas yang ditentukan.

Kolom
modality_type	DataStoreTool.ModalityConfig.ModalityType Wajib. Jenis modalitas.
rewriter_config	DataStoreTool.RewriterConfig Opsional. Konfigurasi penulis ulang.
summarization_config	DataStoreTool.SummarizationConfig Opsional. Konfigurasi ringkasan.
grounding_config	DataStoreTool.GroundingConfig Opsional. Konfigurasi perujukan.
snippets_config	DataStoreTool.SnippetsConfig Opsional. Konfigurasi cuplikan.

ModalityType

Jenis modalitas.

Enum
MODALITY_TYPE_UNSPECIFIED	Jenis modalitas tidak ditentukan.
TEXT	Modalitas teks.
AUDIO	Modalitas audio.

RewriterConfig

Konfigurasi penulis ulang.

Kolom
model_settings	ModelSettings Wajib. Konfigurasi untuk model LLM.
prompt	string Opsional. Definisi perintah. Jika tidak disetel, perintah default akan digunakan.
disabled	bool Opsional. Apakah penulis ulang dinonaktifkan.

SnippetsConfig

Konfigurasi cuplikan.

Kolom
enable_snippets	bool Opsional. Apakah cuplikan diaktifkan atau tidak.
max_snippets	int32 Opsional. Jumlah cuplikan yang akan ditampilkan per kueri. Jika tidak disetel, secara default akan menampilkan semua cuplikan dari layanan.

SummarizationConfig

Konfigurasi ringkasan.

Kolom
model_settings	ModelSettings Opsional. Konfigurasi untuk model LLM.
prompt	string Opsional. Definisi perintah. Jika tidak disetel, perintah default akan digunakan.
disabled	bool Opsional. Apakah ringkasan dinonaktifkan.

DeleteAgentRequest

Pesan permintaan untuk AgentService.DeleteAgent.

Kolom
name	string Wajib. Nama resource agen yang akan dihapus.
force	bool Opsional. Menunjukkan apakah agen akan dihapus secara paksa, meskipun masih direferensikan oleh aplikasi/agen/contoh lain. Jika force = false, penghapusan akan gagal jika agen/contoh lain mereferensikannya. Jika force = true, hapus agen dan hapus dari semua aplikasi/agen/contoh yang mereferensikannya.
etag	string Opsional. ETag agen saat ini. Jika etag tidak diberikan, penghapusan akan menimpa perubahan serentak. Jika etag diberikan dan tidak cocok dengan etag agen saat ini, penghapusan akan diblokir dan error ABORTED akan ditampilkan.

DeleteAppRequest

Pesan permintaan untuk AgentService.DeleteApp.

Kolom
name	string Wajib. Nama resource aplikasi yang akan dihapus.
etag	string Opsional. ETag aplikasi saat ini. Jika etag tidak diberikan, penghapusan akan menimpa perubahan serentak. Jika etag diberikan dan tidak cocok dengan etag aplikasi saat ini, penghapusan akan diblokir dan error ABORTED akan ditampilkan.

DeleteAppVersionRequest

Pesan permintaan untuk AgentService.DeleteAppVersion.

Kolom
name	string Wajib. Nama resource versi aplikasi yang akan dihapus.
etag	string Opsional. ETag versi aplikasi saat ini. Jika etag tidak diberikan, penghapusan akan menimpa perubahan serentak. Jika etag diberikan dan tidak cocok dengan etag versi aplikasi saat ini, penghapusan akan diblokir dan error ABORTED akan ditampilkan.

DeleteConversationRequest

Pesan permintaan untuk AgentService.DeleteConversation.

Kolom
name	string Wajib. Nama resource percakapan yang akan dihapus.
source (deprecated)	Conversation.Source Item ini tidak digunakan lagi. Opsional. Menunjukkan sumber percakapan. Jika tidak disetel, Source.Live akan diterapkan secara default.

DeleteDeploymentRequest

Pesan permintaan untuk AgentService.DeleteDeployment.

Kolom
name	string Wajib. Nama deployment yang akan dihapus. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
etag	string Opsional. ETag deployment. Jika etag diberikan dan tidak cocok dengan etag deployment saat ini, penghapusan akan diblokir dan error ABORTED akan ditampilkan.

DeleteExampleRequest

Pesan permintaan untuk AgentService.DeleteExample.

Kolom
name	string Wajib. Nama resource contoh yang akan dihapus.
etag	string Opsional. ETag contoh saat ini. Jika etag tidak diberikan, penghapusan akan menimpa perubahan serentak. Jika etag diberikan dan tidak cocok dengan etag contoh saat ini, penghapusan akan diblokir dan error ABORTED akan ditampilkan.

DeleteGuardrailRequest

Pesan permintaan untuk AgentService.DeleteGuardrail.

Kolom
name	string Wajib. Nama resource pembatasan yang akan dihapus.
force	bool Opsional. Menunjukkan apakah akan menghapus batas aman secara paksa, meskipun masih dirujuk oleh aplikasi/agen. Jika force = false, penghapusan akan gagal jika ada aplikasi/agen yang masih mereferensikan pembatasan. Jika force = true, semua referensi yang ada dari aplikasi/agen akan dihapus dan pembatasan akan dihapus.
etag	string Opsional. ETag saat ini dari pembatasan. Jika etag tidak diberikan, penghapusan akan menimpa perubahan serentak. Jika etag diberikan dan tidak cocok dengan etag saat ini dari pembatasan, penghapusan akan diblokir dan error ABORTED akan ditampilkan.

DeleteToolRequest

Pesan permintaan untuk AgentService.DeleteTool.

Kolom
name	string Wajib. Nama resource alat yang akan dihapus.
force	bool Opsional. Menunjukkan apakah alat akan dihapus secara paksa, meskipun masih direferensikan oleh agen/contoh. Jika force = false, penghapusan akan gagal jika ada agen yang masih mereferensikan alat tersebut. Jika force = true, semua referensi yang ada dari agen akan dihapus dan alat akan dihapus.
etag	string Opsional. ETag alat saat ini. Jika etag tidak diberikan, penghapusan akan menimpa perubahan serentak. Jika etag diberikan dan tidak cocok dengan etag alat saat ini, penghapusan akan diblokir dan error ABORTED akan ditampilkan.

DeleteToolsetRequest

Pesan permintaan untuk AgentService.DeleteToolset.

Kolom
name	string Wajib. Nama resource toolset yang akan dihapus.
force	bool Opsional. Menunjukkan apakah akan menghapus toolset secara paksa, meskipun masih dirujuk oleh aplikasi/agen. Jika force = false, penghapusan akan gagal jika ada agen yang masih mereferensikan toolset. Jika force = true, semua referensi yang ada dari agen akan dihapus dan toolset akan dihapus.
etag	string Opsional. ETag set alat saat ini. Jika etag tidak diberikan, penghapusan akan menimpa perubahan serentak. Jika etag diberikan dan tidak cocok dengan etag toolset saat ini, penghapusan akan diblokir dan error ABORTED akan ditampilkan.

DeployChannelResponse

Pesan respons untuk AgentService.DeployChannel.

Kolom
deployment	Deployment Deployment yang dibuat.

Deployment

Deployment mewakili versi aplikasi yang tidak dapat diubah dan dapat dikueri. Deployment digunakan untuk men-deploy versi aplikasi dengan profil saluran tertentu.

Kolom
name	string ID. Nama resource deployment. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
display_name	string Wajib. Nama tampilan deployment.
app_version	string Opsional. Nama resource versi aplikasi yang akan di-deploy. Format: projects/{project}/locations/{location}/apps/{app}/versions/{version} Gunakan projects/{project}/locations/{location}/apps/{app}/versions/- untuk menggunakan aplikasi draf.
channel_profile	ChannelProfile Wajib. Profil channel yang digunakan dalam deployment.
create_time	Timestamp Hanya output. Stempel waktu saat deployment ini dibuat.
update_time	Timestamp Hanya output. Stempel waktu saat deployment ini terakhir diperbarui.
etag	string Hanya output. ETag yang digunakan untuk memastikan objek tidak berubah selama operasi baca-ubah-tulis. Jika etag kosong, pembaruan akan menimpa perubahan serentak.
experiment_config	ExperimentConfig Opsional. Konfigurasi eksperimen untuk deployment.
whatsapp_credentials	WhatsAppCredentials Opsional. Hanya input. Kredensial WhatsApp sementara diperlukan saat mengonfigurasi profil saluran WhatsApp.
instagram_credentials	InstagramCredentials Opsional. Hanya input. Kredensial Instagram sementara diperlukan saat mengonfigurasi profil channel Instagram.
model_settings	ModelSettings Opsional. Setelan model untuk deployment. Menggantikan setelan model yang dikonfigurasi di tingkat aplikasi/agen. Catatan: Penggantian setelan model tingkat deployment dibatasi di belakang daftar yang diizinkan. Hubungi tim CXAS untuk mengaktifkan kolom ini.
modality	Deployment.Modality Opsional. Modalitas deployment. Catatan: Penggantian modalitas tingkat deployment hanya dapat dilakukan oleh pihak yang masuk dalam daftar yang diizinkan. Hubungi tim CXAS untuk mengaktifkan kolom ini.
agent_registry_deployment	AgentRegistryDeployment Opsional. Konfigurasi untuk men-deploy deployment ini ke Agent Registry. Jika ada, deployment ini akan dipublikasikan ke Agent Registry.

Modalitas

Modalitas deployment.

Enum
MODALITY_UNSPECIFIED	Modalitas tidak diketahui.
MODALITY_TEXT	Modalitas teks.
MODALITY_VOICE	Modalitas suara.
MODALITY_VIDEO	Modalitas video.

EndSession

Menunjukkan bahwa sesi telah berakhir, karena berhasil diselesaikan (misalnya, pengguna mengatakan "Selamat tinggal!" ) atau eskalasi agen.

Agen tidak akan memproses input lebih lanjut setelah sesi dihentikan dan klien harus menutup sebagian dan memutuskan koneksi setelah menerima semua respons yang tersisa dari agen.

Kolom
metadata	Struct Opsional. Memberikan informasi tambahan tentang sinyal akhir sesi, seperti alasan mengakhiri sesi.

EndUserAuthConfig

Konfigurasi autentikasi pengguna akhir yang digunakan untuk panggilan Connection. Nilai kolom harus berupa nama variabel konteks dalam format $context.variables.<name_of_variable>.

Kolom
Kolom union auth_config. Konfigurasi autentikasi. auth_config hanya ada berupa salah satu diantara berikut:
oauth2_auth_code_config	EndUserAuthConfig.Oauth2AuthCodeConfig Autentikasi Kode Otorisasi OAuth 2.0.
oauth2_jwt_bearer_config	EndUserAuthConfig.Oauth2JwtBearerConfig Autentikasi Pemberian Otorisasi OAuth 2.0 Profil JWT.

Oauth2AuthCodeConfig

Konfigurasi autentikasi Kode Otorisasi OAuth 2.0.

Kolom
oauth_token	string Wajib. Nama parameter token OAuth yang akan diteruskan. Harus dalam format $context.variables.<name_of_variable>.

Oauth2JwtBearerConfig

Konfigurasi autentikasi Pemberian Otorisasi OAuth 2.0 Profil JWT.

Kolom
issuer	string Wajib. Nama parameter penerbit yang akan diteruskan. Harus dalam format $context.variables.<name_of_variable>.
subject	string Wajib. Nama parameter subjek yang akan diteruskan. Harus dalam format $context.variables.<name_of_variable>.
client_key	string Wajib. Nama parameter klien yang akan diteruskan. Harus dalam format $context.variables.<name_of_variable>.

EndpointControlPolicy

Menentukan kebijakan kontrol endpoint tingkat project/lokasi.

Kolom
enforcement_scope	EndpointControlPolicy.EnforcementScope Opsional. Cakupan tempat daftar allowed_origins kebijakan ini diterapkan.
allowed_origins[]	string Opsional. Origin HTTP(s) yang diizinkan yang dapat dipanggil langsung oleh alat di Aplikasi. Penerapan bergantung pada nilai enforcement_scope dan status VPC-SC project. Jika nomor port tidak diberikan, semua port akan diizinkan. Jika tidak, nomor port harus sama persis. Misalnya, "https://example.com" akan cocok dengan "https://example.com:443" dan port lainnya. "https://example.com:443" hanya akan cocok dengan "https://example.com:443".

EnforcementScope

Menentukan cakupan tempat daftar allowed_origins kebijakan ini diterapkan.

Enum
ENFORCEMENT_SCOPE_UNSPECIFIED	Tidak ditentukan. Kebijakan ini akan diperlakukan sebagai VPCSC_ONLY.
VPCSC_ONLY	Kebijakan ini hanya berlaku jika VPC-SC aktif.
ALWAYS	Kebijakan ini SELALU berlaku, terlepas dari status VPC-SC.

ErrorHandlingSettings

Setelan untuk menjelaskan cara error harus ditangani di aplikasi.

Kolom
error_handling_strategy	ErrorHandlingSettings.ErrorHandlingStrategy Opsional. Strategi yang digunakan untuk penanganan error.
fallback_response_config	ErrorHandlingSettings.FallbackResponseConfig Opsional. Konfigurasi untuk menangani respons penggantian.
end_session_config	ErrorHandlingSettings.EndSessionConfig Opsional. Konfigurasi untuk mengakhiri sesi jika terjadi error sistem (misalnya, error LLM).

EndSessionConfig

Konfigurasi untuk mengakhiri sesi jika terjadi error sistem (misalnya, error LLM).

Kolom
escalate_session	bool Opsional. Apakah akan meningkatkan sesi di EndSession. Jika sesi ditingkatkan, metadata in EndSession akan berisi session_escalated = true. Lihat https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/deploy/google-telephony-platform#transfer_a_call_to_a_human_agent untuk mengetahui detailnya.

ErrorHandlingStrategy

Menentukan strategi untuk menangani error.

Enum
ERROR_HANDLING_STRATEGY_UNSPECIFIED	Strategi penanganan error yang tidak ditentukan.
NONE	Tidak ada penanganan khusus yang diaktifkan.
FALLBACK_RESPONSE	Pesan pengganti akan ditampilkan kepada pengguna jika terjadi error sistem (misalnya, error LLM).
END_SESSION	Sinyal EndSession akan dipancarkan jika terjadi error sistem (misalnya, error LLM).

FallbackResponseConfig

Konfigurasi untuk menangani respons penggantian.

Kolom
custom_fallback_messages	map<string, string> Opsional. Pesan penggantian jika terjadi error sistem (misalnya, error LLM), dipetakan berdasarkan kode bahasa yang didukung.
max_fallback_attempts	int32 Opsional. Jumlah maksimum upaya penggantian yang akan dilakukan sebelum agen memancarkan Sinyal EndSession.

EvaluationMetricsThresholds

Setelan nilai minimum untuk metrik dalam Evaluasi.

Kolom
golden_evaluation_metrics_thresholds	EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds Opsional. Nilai minimum metrik evaluasi emas.
hallucination_metric_behavior (deprecated)	EvaluationMetricsThresholds.HallucinationMetricBehavior Item ini tidak digunakan lagi. Opsional. Tidak digunakan lagi: Gunakan golden_hallucination_metric_behavior sebagai gantinya. Perilaku metrik halusinasi saat ini digunakan untuk evaluasi utama.
golden_hallucination_metric_behavior	EvaluationMetricsThresholds.HallucinationMetricBehavior Opsional. Perilaku metrik halusinasi untuk evaluasi golden dataset.
scenario_hallucination_metric_behavior	EvaluationMetricsThresholds.HallucinationMetricBehavior Opsional. Perilaku metrik halusinasi untuk evaluasi skenario.

GoldenEvaluationMetricsThresholds

Setelan untuk evaluasi golden dataset.

Kolom
turn_level_metrics_thresholds	EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds Opsional. Nilai minimum metrik tingkat giliran.
expectation_level_metrics_thresholds	EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.ExpectationLevelMetricsThresholds Opsional. Nilai minimum metrik tingkat ekspektasi.
tool_matching_settings	EvaluationMetricsThresholds.ToolMatchingSettings Opsional. Setelan pencocokan alat. Panggilan alat tambahan adalah panggilan alat yang ada dalam eksekusi, tetapi tidak cocok dengan panggilan alat apa pun dalam ekspektasi standar.

ExpectationLevelMetricsThresholds

Nilai minimum metrik tingkat ekspektasi.

Kolom
tool_invocation_parameter_correctness_threshold	float Opsional. Nilai minimum keberhasilan untuk kebenaran parameter pemanggilan alat individual. Harus berupa float antara 0 dan 1. Defaultnya adalah 1.0.

TurnLevelMetricsThresholds

Mengaktifkan batas metrik tingkat.

Kolom
semantic_similarity_channel	EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds.SemanticSimilarityChannel Opsional. Saluran kemiripan semantik yang akan digunakan untuk evaluasi.
semantic_similarity_success_threshold	int32 Opsional. Nilai minimum keberhasilan untuk kemiripan semantik. Harus berupa bilangan bulat antara 0 dan 4. Defaultnya adalah >= 3.
overall_tool_invocation_correctness_threshold	float Opsional. Nilai minimum keberhasilan untuk kebenaran pemanggilan alat secara keseluruhan. Harus berupa float antara 0 dan 1. Defaultnya adalah 1.0.

SemanticSimilarityChannel

Saluran kemiripan semantik yang akan digunakan.

Enum
SEMANTIC_SIMILARITY_CHANNEL_UNSPECIFIED	Metrik tidak ditentukan. Nilai defaultnya adalah TEXT.
TEXT	Menggunakan kemiripan semantik teks.
AUDIO	Gunakan kesamaan semantik audio.

HallucinationMetricBehavior

Perilaku metrik halusinasi. Terlepas dari perilakunya, metrik akan selalu dihitung. Perbedaannya adalah bahwa jika dinonaktifkan, metrik tidak digunakan untuk menghitung skor evaluasi keseluruhan.

Enum
HALLUCINATION_METRIC_BEHAVIOR_UNSPECIFIED	Perilaku metrik halusinasi tidak ditentukan.
DISABLED	Menonaktifkan metrik halusinasi.
ENABLED	Aktifkan metrik halusinasi.

ToolMatchingSettings

Setelan untuk panggilan alat pencocokan.

Kolom
extra_tool_call_behavior	EvaluationMetricsThresholds.ToolMatchingSettings.ExtraToolCallBehavior Opsional. Perilaku untuk panggilan alat tambahan. Nilai defaultnya adalah GAGAL.

ExtraToolCallBehavior

Menentukan perilaku saat panggilan alat tambahan ditemukan. Panggilan alat tambahan adalah panggilan alat yang ada dalam eksekusi, tetapi tidak cocok dengan panggilan alat apa pun dalam ekspektasi standar.

Enum
EXTRA_TOOL_CALL_BEHAVIOR_UNSPECIFIED	Perilaku tidak ditentukan. Nilai defaultnya adalah GAGAL.
FAIL	Gagal dalam evaluasi jika panggilan alat tambahan ditemukan.
ALLOW	Izinkan panggilan alat tambahan.

Acara

Input acara.

Kolom
event	string Wajib. Nama acara.
variables	Struct Opsional. Variabel tambahan yang terkait dengan peristiwa.

Contoh

Contoh mewakili contoh percakapan antara pengguna dan agen.

Kolom
name	string ID. ID unik contoh. Format: projects/{project}/locations/{location}/apps/{app}/examples/{example}
display_name	string Wajib. Nama tampilan contoh.
description	string Opsional. Deskripsi contoh yang dapat dibaca manusia.
entry_agent	string Opsional. Agen yang awalnya menangani percakapan. Jika tidak ditentukan, contoh ini mewakili percakapan yang ditangani oleh agen root. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
messages[]	Message Opsional. Kumpulan pesan yang membentuk percakapan.
create_time	Timestamp Hanya output. Stempel waktu saat contoh dibuat.
update_time	Timestamp Hanya output. Stempel waktu saat contoh terakhir diperbarui.
invalid	bool Hanya output. Contoh dapat menjadi tidak valid jika resource yang dirujuk dihapus. Contoh yang tidak valid tidak akan digunakan sebagai contoh few-shot.
etag	string ETag yang digunakan untuk memastikan objek tidak berubah selama operasi baca-ubah-tulis. Jika etag kosong, pembaruan akan menimpa perubahan serentak.

ExecuteToolRequest

Pesan permintaan untuk ToolService.ExecuteTool.

Kolom
parent	string Wajib. Nama resource aplikasi yang memiliki alat/kumpulan alat. Format: projects/{project}/locations/{location}/apps/{app}
args	Struct Opsional. Parameter dan nilai input untuk alat dalam format objek JSON.
mock_config	MockConfig Opsional. Konfigurasi tiruan untuk eksekusi alat. Jika kolom ini disetel, alat yang memanggil alat lain akan di-mock berdasarkan pola dan respons yang diberikan.
Kolom union tool_identifier. ID alat yang akan dieksekusi. Alat ini bisa berupa alat yang tetap ada atau alat dari toolset. tool_identifier hanya ada berupa salah satu diantara berikut:
tool	string Opsional. Nama alat yang akan dieksekusi. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolset_tool	ToolsetTool Opsional. Alat toolset yang akan dijalankan. Hanya satu alat yang harus cocok dengan predikat dari toolset. Jika tidak, error akan ditampilkan.
Kolom union tool_execution_context. Konteks tambahan yang akan diberikan untuk eksekusi alat tool_execution_context hanya dapat berupa salah satu dari berikut:
variables	Struct Opsional. Variabel yang tersedia untuk eksekusi alat.
context	Struct Opsional. [ToolCallContext](https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/python#environment untuk mengetahui detailnya) yang akan diteruskan ke alat Python.

ExecuteToolResponse

Pesan respons untuk ToolService.ExecuteTool.

Kolom
response	Struct Hasil eksekusi alat dalam format objek JSON. Gunakan kunci "output" untuk menentukan respons alat dan kunci "error" untuk menentukan detail error (jika ada). Jika kunci "output" dan "error" tidak ditentukan, seluruh "respons" akan diperlakukan sebagai hasil eksekusi alat.
variables	Struct Nilai variabel di akhir eksekusi alat.
citations	Citations Kutipan yang memberikan informasi sumber untuk eksekusi alat.
google_search_suggestions	GoogleSearchSuggestions Saran yang ditampilkan dari Google Penelusuran sebagai hasil dari pemanggilan Alat Penelusuran Google selama eksekusi alat.
Kolom union tool_identifier. ID alat yang dieksekusi. tool_identifier hanya ada berupa salah satu diantara berikut:
tool	string Nama alat yang dijalankan. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolset_tool	ToolsetTool Alat toolset yang dieksekusi.

ExecutionType

Jenis eksekusi alat atau set alat.

Enum
EXECUTION_TYPE_UNSPECIFIED	Jenis eksekusi tidak ditentukan. Nilai defaultnya adalah SYNCHRONOUS jika tidak ditentukan.
SYNCHRONOUS	Alat ini dijalankan secara sinkron. Sesi diblokir hingga alat ditampilkan.
ASYNCHRONOUS	Alat ini dijalankan secara asinkron. Sesi akan berlanjut saat alat dijalankan.

ExperimentConfig

Eksperimen untuk deployment.

Kolom
version_release	ExperimentConfig.VersionRelease Opsional. Rilis versi untuk eksperimen.

Negara Bagian

Status eksperimen.

Enum
STATE_UNSPECIFIED	Status tidak ditentukan.
PENDING	Tidak digunakan lagi: Status ini tidak digunakan lagi.
RUNNING	Status berjalan. Eksperimen sedang berjalan dan valid.
DONE	Tidak digunakan lagi: Status ini tidak digunakan lagi.
EXPIRED	Tidak digunakan lagi: Status ini tidak digunakan lagi.

VersionRelease

Rilis versi untuk eksperimen.

Kolom
state	ExperimentConfig.State Opsional. Status rilis versi.
traffic_allocations[]	ExperimentConfig.VersionRelease.TrafficAllocation Opsional. Alokasi traffic untuk rilis versi.

TrafficAllocation

Alokasi traffic untuk rilis versi.

Kolom
id	string Opsional. ID alokasi traffic. String format bebas, hingga 128 karakter.
traffic_percentage	int32 Opsional. Persentase traffic dari alokasi traffic. Harus antara 0 dan 100.
app_version	string Opsional. Versi aplikasi alokasi traffic. Format: projects/{project}/locations/{location}/apps/{app}/versions/{version}

ExportAppRequest

Pesan permintaan untuk AgentService.ExportApp.

Kolom
name	string Wajib. Nama resource aplikasi yang akan diekspor.
export_format	ExportAppRequest.ExportFormat Wajib. Format untuk mengekspor aplikasi.
gcs_uri	string Opsional. URI Google Cloud Storage tempat aplikasi akan diekspor. Format URI ini harus gs://<bucket-name>/<object-name>. Arsip aplikasi yang diekspor akan ditulis langsung ke objek GCS yang ditentukan.
app_version	string Opsional. Nama resource versi aplikasi yang akan diekspor. Format: projects/{project}/locations/{location}/apps/{app}/versions/{version}.

ExportFormat

Format ekspor untuk aplikasi.

Enum
EXPORT_FORMAT_UNSPECIFIED	Format ekspor tidak ditentukan.
JSON	Format ekspornya adalah JSON.
YAML	Format ekspor adalah YAML.

ExportAppResponse

Pesan respons untuk AgentService.ExportApp.

Kolom
Kolom union app. Aplikasi yang diekspor. app hanya dapat berupa salah satu dari berikut:
app_content	bytes Folder aplikasi dikompresi sebagai file zip.
app_uri	string URI Google Cloud Storage tempat aplikasi diekspor.

ExpressionCondition

Kondisi ekspresi berdasarkan status sesi.

Kolom
expression	string Wajib. Representasi string dari kondisi cloud.api.Expression.

FileSearchTool

Alat penelusuran file memungkinkan agen menelusuri file yang diupload oleh developer aplikasi/agen. Gemini memiliki preset untuk memberikan penelusuran berkualitas cukup baik atas file yang diupload dan ringkasan hasil yang diambil.

Kolom
corpus_type	FileSearchTool.CorpusType Opsional. Jenis korpus. Default-nya adalah FULLY_MANAGED.
name	string Wajib. Nama alat.
description	string Opsional. Deskripsi alat.
file_corpus	string Opsional. Korpus tempat file disimpan. Format: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}

CorpusType

Jenis korpus RAG Vertex.

Enum
CORPUS_TYPE_UNSPECIFIED	Jenis korpus tidak ditentukan.
USER_OWNED	Korpus dibuat dan dimiliki oleh pengguna.
FULLY_MANAGED	Korpus dibuat oleh agen.

GenerateChatTokenRequest

Pesan permintaan untuk WidgetService.GenerateChatToken.

Kolom
name	string Wajib. Nama sesi untuk membuat token chat. Format: projects/{project}/locations/{location}/apps/{app}/sessions/{session}
deployment	string Wajib. Deployment aplikasi yang akan digunakan untuk sesi. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
recaptcha_token	string Opsional. Token reCAPTCHA yang dihasilkan oleh widget chat sisi klien.
live_handoff_enabled	bool Opsional. Menunjukkan apakah pengalihan langsung diaktifkan untuk sesi.

GenerateChatTokenResponse

Pesan respons untuk WidgetService.GenerateChatToken.

Kolom
chat_token	string Token cakupan sesi untuk widget chat guna mengautentikasi dengan Session API.
expire_time	Timestamp Waktu saat token chat berakhir masa berlakunya.

GetAgentRequest

Pesan permintaan untuk AgentService.GetAgent.

Kolom
name	string Wajib. Nama resource agen yang akan diambil.

GetAppRequest

Pesan permintaan untuk AgentService.GetApp.

Kolom
name	string Wajib. Nama resource aplikasi yang akan diambil.

GetAppVersionRequest

Pesan permintaan untuk AgentService.GetAppVersion.

Kolom
name	string Wajib. Nama resource versi aplikasi yang akan diambil.

GetChangelogRequest

Pesan permintaan untuk AgentService.GetChangelog.

Kolom
name	string Wajib. Nama resource log perubahan yang akan diambil.

GetConversationRequest

Pesan permintaan untuk AgentService.GetConversation.

Kolom
name	string Wajib. Nama resource percakapan yang akan diambil.
source (deprecated)	Conversation.Source Item ini tidak digunakan lagi. Opsional. Menunjukkan sumber percakapan. Jika tidak disetel, semua sumber akan ditelusuri.

GetDeploymentRequest

Pesan permintaan untuk AgentService.GetDeployment.

Kolom
name	string Wajib. Nama deployment. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}

GetExampleRequest

Pesan permintaan untuk AgentService.GetExample.

Kolom
name	string Wajib. Nama resource contoh yang akan diambil.

GetGuardrailRequest

Pesan permintaan untuk AgentService.GetGuardrail.

Kolom
name	string Wajib. Nama resource pembatasan yang akan diambil.

GetToolRequest

Pesan permintaan untuk AgentService.GetTool.

Kolom
name	string Wajib. Nama resource alat yang akan diambil.

GetToolsetRequest

Pesan permintaan untuk AgentService.GetToolset.

Kolom
name	string Wajib. Nama resource toolset yang akan diambil.

GoAway

Jenis ini tidak memiliki kolom.

Menunjukkan bahwa server akan segera terputus dan klien harus menutup sebagian dan memulai ulang koneksi.

GoogleSearchSuggestions

Saran penelusuran dari Google Search Tool.

Kolom
htmls[]	string Gaya HTML dan CSS yang sesuai untuk saran penelusuran. HTML dan CSS yang disediakan akan otomatis menyesuaikan setelan perangkat Anda, ditampilkan dalam mode terang atau gelap yang ditunjukkan oleh @media(prefers-color-scheme).
web_search_queries[]	WebSearchQuery Daftar kueri yang digunakan untuk melakukan penelusuran Google beserta URI hasil penelusuran yang membentuk saran penelusuran.

GoogleSearchTool

Menampilkan alat untuk melakukan penelusuran web Google untuk grounding. Lihat https://cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool#google-search.

Kolom
name	string Wajib. Nama alat.
description	string Opsional. Deskripsi tujuan alat.
context_urls[]	string Opsional. Konten akan diambil langsung dari URL ini untuk konteks dan perujukan. Contoh: "https://example.com/path.html". Maksimum 20 URL yang diizinkan.
preferred_domains[]	string Opsional. Menentukan domain untuk membatasi hasil penelusuran. Contoh: "example.com", "another.site". Maksimum 20 domain dapat ditentukan.
exclude_domains[]	string Opsional. Daftar domain yang akan dikecualikan dari hasil penelusuran. Contoh: "example.com". Maksimum 2.000 domain dapat dikecualikan.
prompt_config	GoogleSearchTool.PromptConfig Opsional. Petunjuk perintah yang diteruskan ke perencana tentang cara hasil penelusuran harus diproses untuk teks dan suara.

PromptConfig

Setelan perintah yang digunakan oleh model saat memproses atau meringkas hasil penelusuran Google.

Kolom
text_prompt	string Opsional. Menentukan perintah yang digunakan untuk petunjuk sistem saat berinteraksi dengan agen dalam percakapan chat. Jika tidak disetel, perintah default akan digunakan.
voice_prompt	string Opsional. Menentukan perintah yang digunakan untuk petunjuk sistem saat berinteraksi dengan agen dalam percakapan suara. Jika tidak disetel, perintah default akan digunakan.

Pagar pengaman

Pembatasan berisi daftar pemeriksaan dan keseimbangan untuk menjaga keamanan agen.

Kolom
name	string ID. ID unik pembatas. Format: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}
display_name	string Wajib. Nama tampilan pembatas.
description	string Opsional. Deskripsi pembatasan.
enabled	bool Opsional. Apakah pembatasan diaktifkan atau tidak.
action	TriggerAction Opsional. Tindakan yang harus diambil saat batasan pengaman dipicu.
create_time	Timestamp Hanya output. Stempel waktu saat pembatasan dibuat.
update_time	Timestamp Hanya output. Stempel waktu saat batas keamanan terakhir diperbarui.
etag	string ETag yang digunakan untuk memastikan objek tidak berubah selama operasi baca-ubah-tulis. Jika etag kosong, pembaruan akan menimpa perubahan serentak.
Kolom union guardrail_type. Jenis pembatasan. guardrail_type hanya ada berupa salah satu diantara berikut:
content_filter	Guardrail.ContentFilter Opsional. Pembatasan yang melarang penggunaan konten tertentu dalam percakapan.
llm_prompt_security	Guardrail.LlmPromptSecurity Opsional. Pembatas yang memblokir percakapan jika perintah dianggap tidak aman berdasarkan klasifikasi LLM.
llm_policy	Guardrail.LlmPolicy Opsional. Penjaga yang memblokir percakapan jika respons LLM dianggap melanggar kebijakan berdasarkan klasifikasi LLM.
model_safety	Guardrail.ModelSafety Opsional. Membatasi percakapan jika respons LLM dianggap tidak aman berdasarkan setelan keamanan model.
code_callback	Guardrail.CodeCallback Opsional. Pembatas yang berpotensi memblokir percakapan berdasarkan hasil eksekusi callback.
supervisor	Guardrail.Supervisor Opsional. Pedoman keamanan yang menjalankan intervensi supervisor.

CodeCallback

Pembatas yang memblokir percakapan berdasarkan callback kode yang diberikan.

Kolom
before_agent_callback	Callback Opsional. Callback yang akan dieksekusi sebelum agen dipanggil. Setiap fungsi callback diharapkan menampilkan struktur (misalnya, dict atau objek) yang berisi setidaknya: - 'decision': 'OK' atau 'TRIGGER'. - 'reason': String yang menjelaskan keputusan. Keputusan 'PICU' dapat menghentikan pemrosesan lebih lanjut.
after_agent_callback	Callback Opsional. Callback yang akan dieksekusi setelah agen dipanggil. Setiap fungsi callback diharapkan menampilkan struktur (misalnya, dict atau objek) yang berisi setidaknya: - 'decision': 'OK' atau 'TRIGGER'. - 'reason': String yang menjelaskan keputusan. Keputusan 'PICU' dapat menghentikan pemrosesan lebih lanjut.
before_model_callback	Callback Opsional. Callback yang akan dieksekusi sebelum model dipanggil. Jika ada beberapa panggilan ke model, callback akan dieksekusi beberapa kali. Setiap fungsi callback diharapkan menampilkan struktur (misalnya, dict atau objek) yang berisi setidaknya: - 'decision': 'OK' atau 'TRIGGER'. - 'reason': String yang menjelaskan keputusan. Keputusan 'PICU' dapat menghentikan pemrosesan lebih lanjut.
after_model_callback	Callback Opsional. Callback yang akan dieksekusi setelah model dipanggil. Jika ada beberapa panggilan ke model, callback akan dieksekusi beberapa kali. Setiap fungsi callback diharapkan menampilkan struktur (misalnya, dict atau objek) yang berisi setidaknya: - 'decision': 'OK' atau 'TRIGGER'. - 'reason': String yang menjelaskan keputusan. Keputusan 'PICU' dapat menghentikan pemrosesan lebih lanjut.

ContentFilter

Pembatasan yang melarang penggunaan konten tertentu dalam percakapan.

Kolom
banned_contents[]	string Opsional. Daftar frasa yang dilarang. Berlaku untuk input pengguna dan respons agen.
banned_contents_in_user_input[]	string Opsional. Daftar frasa yang dilarang. Hanya berlaku untuk input pengguna.
banned_contents_in_agent_response[]	string Opsional. Daftar frasa yang dilarang. Hanya berlaku untuk respons agen.
match_type	Guardrail.ContentFilter.MatchType Wajib. Jenis pencocokan untuk filter konten.
disregard_diacritics	bool Opsional. Jika benar (true), diakritik akan diabaikan selama pencocokan.

MatchType

Jenis pencocokan untuk filter konten.

Enum
MATCH_TYPE_UNSPECIFIED	Jenis pencocokan tidak ditentukan.
SIMPLE_STRING_MATCH	Konten dicocokkan untuk substring karakter demi karakter.
WORD_BOUNDARY_STRING_MATCH	Konten hanya cocok jika pola yang ditemukan dalam teks diapit oleh pembatas kata. Frasa yang dilarang juga dapat berisi pembatas kata.
REGEXP_MATCH	Konten dicocokkan menggunakan sintaksis ekspresi reguler.

LlmPolicy

Penjaga yang memblokir percakapan jika respons LLM dianggap melanggar kebijakan berdasarkan klasifikasi LLM.

Kolom
max_conversation_messages	int32 Opsional. Saat memeriksa kebijakan ini, pertimbangkan 'n' pesan terakhir dalam percakapan. Jika tidak ditetapkan, nilai default 10 akan digunakan.
model_settings	ModelSettings Opsional. Setelan model.
prompt	string Wajib. Perintah kebijakan.
policy_scope	Guardrail.LlmPolicy.PolicyScope Wajib. Menentukan kapan pemeriksaan kebijakan akan diterapkan selama percakapan. Jika disetel ke POLICY_SCOPE_UNSPECIFIED, kebijakan akan diterapkan ke input pengguna. Saat menerapkan kebijakan ke respons agen, latensi tambahan akan terjadi sebelum agen dapat merespons.
fail_open	bool Opsional. Jika terjadi error selama pemeriksaan kebijakan, buka dan jangan memicu batasan pengaman.
allow_short_utterance	bool Opsional. Secara default, pemeriksaan kebijakan LLM dilewati untuk ucapan singkat. Mengaktifkan setelan ini akan menerapkan pemeriksaan kebijakan ke semua ucapan, termasuk yang biasanya akan dilewati.

PolicyScope

Menentukan kapan pemeriksaan kebijakan akan diterapkan selama percakapan.

Enum
POLICY_SCOPE_UNSPECIFIED	Cakupan kebijakan tidak ditentukan.
USER_QUERY	Pemeriksaan kebijakan dipicu saat input pengguna.
AGENT_RESPONSE	Pemeriksaan kebijakan dipicu pada respons agen. Menerapkan cakupan kebijakan ini akan menimbulkan latensi tambahan sebelum agen dapat merespons.
USER_QUERY_AND_AGENT_RESPONSE	Pemeriksaan kebijakan dipicu pada input pengguna dan respons agen. Menerapkan cakupan kebijakan ini akan menimbulkan latensi tambahan sebelum agen dapat merespons.

LlmPromptSecurity

Batasan yang memblokir percakapan jika input dianggap tidak aman berdasarkan klasifikasi LLM.

Kolom
fail_open	bool Opsional. Menentukan perilaku saat batasan pengaman mengalami error LLM. - Jika benar (true): batas aman dilewati. - Jika salah (default): pembatasan akan dipicu/diblokir. Catatan: Jika kebijakan kustom diberikan, kolom ini akan diabaikan dan digantikan oleh konfigurasi 'fail_open' kebijakan.
Kolom union security_config. Menentukan mode konfigurasi keamanan. Pengguna harus memilih salah satu konfigurasi berikut. security_config hanya ada berupa salah satu diantara berikut:
default_settings	Guardrail.LlmPromptSecurity.DefaultSecuritySettings Opsional. Menggunakan setelan keamanan default bawaan sistem. Untuk memilih mode ini, sertakan pesan 'default_settings' kosong dalam permintaan. Kolom 'default_prompt_template' di dalamnya akan diisi oleh server dalam respons.
custom_policy	Guardrail.LlmPolicy Opsional. Gunakan LlmPolicy yang ditentukan pengguna untuk mengonfigurasi pembatasan keamanan.

DefaultSecuritySettings

Konfigurasi untuk setelan keamanan sistem default.

Kolom
default_prompt_template	string Hanya output. Template perintah default yang digunakan oleh sistem. Kolom ini digunakan untuk tujuan tampilan guna menunjukkan kepada pengguna perintah apa yang digunakan sistem secara default. Nilainya adalah OUTPUT_ONLY.

ModelSafety

Penggantian setelan keamanan model. Jika disetel, setelan ini akan menggantikan setelan default dan memicu pembatasan jika respons dianggap tidak aman.

Kolom
safety_settings[]	Guardrail.ModelSafety.SafetySetting Wajib. Daftar setelan keamanan.

HarmBlockThreshold

Tingkat nilai minimum berbasis probabilitas untuk pemblokiran.

Enum
HARM_BLOCK_THRESHOLD_UNSPECIFIED	Batas blokir bahaya tidak ditentukan.
BLOCK_LOW_AND_ABOVE	Blokir batas rendah dan lebih tinggi (yaitu, blokir lebih banyak).
BLOCK_MEDIUM_AND_ABOVE	Blokir batas sedang dan lebih tinggi.
BLOCK_ONLY_HIGH	Ambang batas Block only high (yaitu, blokir lebih sedikit).
BLOCK_NONE	Jangan blokir.
OFF	Nonaktifkan filter keamanan.

HarmCategory

Kategori bahaya.

Enum
HARM_CATEGORY_UNSPECIFIED	Kategori bahaya tidak ditentukan.
HARM_CATEGORY_HATE_SPEECH	Kategori bahayanya adalah ujaran kebencian.
HARM_CATEGORY_DANGEROUS_CONTENT	Kategori bahayanya adalah konten berbahaya.
HARM_CATEGORY_HARASSMENT	Kategori bahayanya adalah pelecehan.
HARM_CATEGORY_SEXUALLY_EXPLICIT	Kategori bahayanya adalah konten seksual vulgar.
HARM_CATEGORY_PROFANITY	Kategori bahayanya adalah kata-kata tidak sopan.
HARM_CATEGORY_TOXIC	Kategori bahayanya adalah beracun.

SafetySetting

Setelan keamanan.

Kolom
category	Guardrail.ModelSafety.HarmCategory Wajib. Kategori bahaya.
threshold	Guardrail.ModelSafety.HarmBlockThreshold Wajib. Batas blokir bahaya.

Supervisor

Pedoman keamanan yang menjalankan intervensi supervisor.

Kolom
type	Guardrail.Supervisor.Type Opsional. Jenis pengawas.
detection_mode	Guardrail.Supervisor.DetectionMode Opsional. Mode deteksi pengawas.

DetectionMode

Mode deteksi pengawas.

Enum
DETECTION_MODE_UNSPECIFIED	Mode deteksi tidak ditentukan. Defaultnya adalah NON_BLOCKING.
NON_BLOCKING	Mode deteksi tidak memblokir. Respons tidak diblokir saat deteksi supervisor sedang berlangsung.
BLOCKING	Mode deteksi pemblokiran. Respons diblokir saat deteksi supervisor sedang berlangsung.

Jenis

Jenis pengawas.

Enum
TYPE_UNSPECIFIED	Jenis tidak ditentukan.
INVALID_TEXT	Jenis masalah teks tidak valid.
LANGUAGE_SHIFT	Jenis masalah pergeseran bahasa.
SPEAKER_SHIFT	Jenis masalah perubahan pembicara.
AUDIO_MISMATCH	Jenis masalah ketidakcocokan audio.
MISSING_TOOL_CALL	Jenis masalah panggilan alat tidak ada.
CUSTOM	Jenis masalah kustom.
CHOPPY_AUDIO	Jenis masalah audio terputus-putus.
PROFANITY	Jenis masalah kata-kata tidak sopan agen.

Gambar

Menampilkan input atau output gambar dalam percakapan.

Kolom
mime_type	string Wajib. Jenis MIME standar IANA dari data sumber. Jenis gambar yang didukung meliputi: * image/png * image/jpeg * image/webp
data	bytes Wajib. Byte mentah gambar.
alt_text	string Opsional. Teks alternatif untuk gambar.

ImportAppRequest

Pesan permintaan untuk AgentService.ImportApp.

Kolom
parent	string Wajib. Nama resource induk dengan lokasi aplikasi yang akan diimpor.
display_name	string Opsional. Nama tampilan aplikasi yang akan diimpor. * Jika aplikasi dibuat saat diimpor, dan nama tampilannya ditentukan, aplikasi yang diimpor akan menggunakan nama tampilan ini. Jika konflik terdeteksi dengan aplikasi yang ada, stempel waktu akan ditambahkan ke nama tampilan agar unik. * Jika aplikasi adalah impor ulang, kolom ini tidak boleh disetel. Memberikan nama tampilan selama impor ulang akan menghasilkan error INVALID_ARGUMENT.
app_id	string Opsional. ID yang akan digunakan untuk aplikasi yang diimpor. * Jika tidak ditentukan, ID unik akan otomatis ditetapkan untuk aplikasi. * Jika tidak, aplikasi yang diimpor akan menggunakan ID ini sebagai komponen akhir dari nama resource-nya. Jika aplikasi dengan ID yang sama sudah ada di lokasi yang ditentukan dalam project, konten aplikasi yang ada akan diganti.
import_options	ImportAppRequest.ImportOptions Opsional. Opsi yang mengatur proses impor untuk aplikasi.
ignore_app_lock	bool Opsional. Flag untuk mengganti kunci aplikasi selama impor. Jika disetel ke benar (true), proses impor akan mengabaikan kunci aplikasi.
Kolom union app. Aplikasi yang akan diimpor. app hanya ada berupa salah satu diantara berikut:
gcs_uri	string URI Google Cloud Storage tempat aplikasi akan diimpor. Format URI ini harus gs://<bucket-name>/<object-name>.
app_content	bytes Byte mentah yang merepresentasikan file ZIP terkompresi dengan struktur folder aplikasi.
Kolom union json_patch. Patch JSON yang akan diterapkan ke aplikasi yang diimpor. json_patch hanya dapat berupa salah satu dari berikut ini:
json_patch_content	string Opsional. Membuat patch konten sebagai string JSON.
json_patch_gcs_uri	string Opsional. Cloud Storage URI yang mengarah ke file JSON yang berisi patch.

ImportOptions

Opsi konfigurasi untuk proses impor aplikasi. Opsi ini mengontrol cara kerja impor, terutama saat terjadi konflik dengan data aplikasi yang ada.

Kolom
conflict_resolution_strategy	ImportAppRequest.ImportOptions.ConflictResolutionStrategy Opsional. Strategi yang akan digunakan saat menyelesaikan konflik selama impor.
validate_only	bool Opsional. Tanda untuk menjalankan proses impor uji coba. Jika disetel ke benar (true), proses impor hanya akan melakukan validasi dan tidak akan membuat perubahan apa pun pada aplikasi yang ada atau membuat aplikasi baru.

ConflictResolutionStrategy

Menentukan strategi untuk menangani konflik saat aplikasi dengan ID yang sama sudah ada, atau saat resource yang diimpor (seperti Agen, Alat, dll.) memiliki nama tampilan yang sama dengan resource yang ada dalam aplikasi tersebut.

Enum
CONFLICT_RESOLUTION_STRATEGY_UNSPECIFIED	Strategi resolusi konflik tidak ditentukan.
REPLACE	Mengganti data yang ada dengan data yang diimpor. Jika aplikasi dengan app_id yang sama sudah ada, kontennya akan diperbarui berdasarkan aplikasi yang diimpor. - Resource (Aplikasi, Agen, Alat, Contoh, Batas Keamanan, Kumpulan Alat) di aplikasi yang diimpor yang memiliki nama tampilan yang sama dengan resource yang ada akan menggantikan resource yang ada. - Resource yang diimpor dengan nama tampilan baru akan dibuat. - Resource yang ada yang tidak memiliki nama tampilan yang cocok di aplikasi yang diimpor tidak akan diubah.
OVERWRITE	Menimpa data yang ada dengan data yang diimpor. Jika aplikasi dengan app_id yang sama sudah ada, kontennya akan ditimpa dengan aplikasi yang diimpor. - Resource yang ada (Agen, Alat, Contoh, Batas, Kumpulan Alat) di aplikasi akan dihapus. - Resource yang diimpor akan dibuat sebagai resource baru.

ImportAppResponse

Pesan respons untuk AgentService.ImportApp.

Kolom
name	string Nama resource aplikasi yang diimpor.
warnings[]	string Pesan peringatan yang dihasilkan selama proses impor. Jika terjadi error untuk resource tertentu, resource tersebut tidak akan disertakan dalam aplikasi yang diimpor dan error akan disebutkan di sini.

InputAudioConfig

InputAudioConfig mengonfigurasi cara agen CES harus menafsirkan data audio yang masuk.

Kolom
audio_encoding	AudioEncoding Wajib. Encoding data audio input.
sample_rate_hertz	int32 Wajib. Frekuensi sampel (dalam Hertz) data audio input.
noise_suppression_level	string Opsional. Apakah akan mengaktifkan peredam bising pada audio input. Nilai yang tersedia adalah "low", "moderate", "high", "very_high".

InstagramCredentials

Kredensial Meta efemeral untuk integrasi native Instagram.

Kolom
auth_code	string Wajib. Kode autentikasi Meta yang disediakan oleh alur pendaftaran tersemat.
conversation_profile_id	string Opsional. ID Profil Percakapan yang akan digunakan untuk deployment.

InterruptionSignal

Menunjukkan bahwa respons audio agen telah terganggu. Klien harus segera menghentikan pemutaran audio saat ini (misalnya, karena pengguna menyela atau respons agen baru sedang dibuat).

Kolom
barge_in	bool Apakah interupsi disebabkan oleh peristiwa penyelaan pengguna.

LanguageSettings

Setelan bahasa aplikasi.

Kolom
default_language_code	string Opsional. Kode bahasa default aplikasi.
supported_language_codes[]	string Opsional. Daftar kode bahasa yang didukung oleh aplikasi, selain default_language_code.
enable_multilingual_support	bool Opsional. Mengaktifkan dukungan multibahasa. Jika benar (true), agen di aplikasi akan menggunakan petunjuk bawaan untuk meningkatkan penanganan input multibahasa.
fallback_action (deprecated)	string Item ini tidak digunakan lagi. Opsional. Tidak digunakan lagi: Fitur ini tidak lagi didukung. Gunakan enable_multilingual_support sebagai gantinya untuk meningkatkan penanganan input multibahasa. Tindakan yang harus dilakukan saat agen menerima input dalam bahasa yang tidak didukung. Tindakan ini dapat berupa tindakan standar atau panggilan alat kustom. Nilai yang valid adalah: - Nama lengkap resource alat, yang memicu eksekusi alat tertentu. - Tindakan sistem yang telah ditentukan sebelumnya, seperti "eskalasikan" atau "keluar", yang memicu sinyal EndSession dengan metadata yang sesuai untuk mengakhiri percakapan.

ListAgentsRequest

Pesan permintaan untuk AgentService.ListAgents.

Kolom
parent	string Wajib. Nama resource aplikasi untuk mencantumkan agen.
page_size	int32 Opsional. Ukuran halaman yang diminta. Server dapat menampilkan lebih sedikit item daripada yang diminta. Jika tidak ditentukan, server akan memilih default yang sesuai.
page_token	string Opsional. Nilai next_page_token yang ditampilkan dari panggilan AgentService.ListAgents daftar sebelumnya.
filter	string Opsional. Filter yang akan diterapkan saat mencantumkan agen. Lihat https://google.aip.dev/160 untuk mengetahui detail selengkapnya.
order_by	string Opsional. Kolom yang akan diurutkan. Hanya "name" dan "create_time" yang didukung. Lihat https://google.aip.dev/132#ordering untuk mengetahui detail selengkapnya.

ListAgentsResponse

Pesan respons untuk AgentService.ListAgents.

Kolom
agents[]	Agent Daftar agen.
next_page_token	string Token yang dapat dikirim sebagai ListAgentsRequest.page_token untuk mengambil halaman berikutnya. Tidak adanya kolom ini menunjukkan bahwa tidak ada halaman berikutnya.

ListAppVersionsRequest

Pesan permintaan untuk AgentService.ListAppVersions.

Kolom
parent	string Wajib. Nama resource aplikasi yang akan mencantumkan versi aplikasi.
page_size	int32 Opsional. Ukuran halaman yang diminta. Server dapat menampilkan lebih sedikit item daripada yang diminta. Jika tidak ditentukan, server akan memilih default yang sesuai.
page_token	string Opsional. Nilai next_page_token yang ditampilkan dari panggilan AgentService.ListAppVersions daftar sebelumnya.
filter	string Opsional. Filter yang akan diterapkan saat mencantumkan versi aplikasi. Lihat https://google.aip.dev/160 untuk mengetahui detail selengkapnya.
order_by	string Opsional. Kolom yang akan diurutkan. Hanya "name" dan "create_time" yang didukung. Lihat https://google.aip.dev/132#ordering untuk mengetahui detail selengkapnya.

ListAppVersionsResponse

Pesan respons untuk AgentService.ListAppVersions.

Kolom
app_versions[]	AppVersion Daftar versi aplikasi.
next_page_token	string Token yang dapat dikirim sebagai ListAppVersionsRequest.page_token untuk mengambil halaman berikutnya. Tidak adanya kolom ini menunjukkan bahwa tidak ada halaman berikutnya.

ListAppsRequest

Pesan permintaan untuk AgentService.ListApps.

Kolom
parent	string Wajib. Nama resource lokasi tempat aplikasi akan dicantumkan.
page_size	int32 Opsional. Ukuran halaman yang diminta. Server dapat menampilkan lebih sedikit item daripada yang diminta. Jika tidak ditentukan, server akan memilih default yang sesuai.
page_token	string Opsional. Nilai next_page_token yang ditampilkan dari panggilan AgentService.ListApps daftar sebelumnya.
filter	string Opsional. Filter yang akan diterapkan saat mencantumkan aplikasi. Lihat https://google.aip.dev/160 untuk mengetahui detail selengkapnya.
order_by	string Opsional. Kolom yang akan diurutkan. Hanya "name" dan "create_time" yang didukung. Lihat https://google.aip.dev/132#ordering untuk mengetahui detail selengkapnya.

ListAppsResponse

Pesan respons untuk AgentService.ListApps.

Kolom
apps[]	App Daftar aplikasi.
next_page_token	string Token yang dapat dikirim sebagai ListAppsRequest.page_token untuk mengambil halaman berikutnya. Tidak adanya kolom ini menunjukkan bahwa tidak ada halaman berikutnya.
unreachable[]	string Daftar yang tidak diurutkan. Lokasi yang tidak dapat dijangkau.

ListChangelogsRequest

Pesan permintaan untuk AgentService.ListChangelogs.

Kolom
parent	string Wajib. Nama resource aplikasi untuk mencantumkan log perubahannya.
page_size	int32 Opsional. Ukuran halaman yang diminta. Server dapat menampilkan lebih sedikit item daripada yang diminta. Jika tidak ditentukan, server akan memilih default yang sesuai.
page_token	string Opsional. Nilai next_page_token yang ditampilkan dari panggilan AgentService.ListChangelogs daftar sebelumnya.
filter	string Opsional. Filter yang akan diterapkan saat mencantumkan log perubahan. Lihat https://google.aip.dev/160 untuk mengetahui detail selengkapnya. String filter dapat digunakan untuk memfilter menurut action, resource_type, resource_name, author, dan create_time. Pembanding : dapat digunakan untuk pencocokan sebagian yang tidak peka huruf besar/kecil pada kolom string, sedangkan = melakukan pencocokan persis yang peka huruf besar/kecil. Contoh: * action:update (kecocokan parsial tidak peka huruf besar/kecil) * action="Create" (kecocokan persis peka huruf besar/kecil) * 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 Opsional. Kolom yang akan diurutkan. Hanya "name" dan "create_time" yang didukung. Lihat https://google.aip.dev/132#ordering untuk mengetahui detail selengkapnya.

ListChangelogsResponse

Pesan respons untuk AgentService.ListChangelogs.

Kolom
changelogs[]	Changelog Daftar log perubahan.
next_page_token	string Token yang dapat dikirim sebagai ListChangelogsRequest.page_token untuk mengambil halaman berikutnya. Tidak adanya kolom ini menunjukkan bahwa tidak ada halaman berikutnya.

ListConversationsRequest

Pesan permintaan untuk AgentService.ListConversations.

Kolom
parent	string Wajib. Nama resource aplikasi untuk mencantumkan percakapan.
page_size	int32 Opsional. Ukuran halaman yang diminta. Server dapat menampilkan lebih sedikit item daripada yang diminta. Jika tidak ditentukan, server akan memilih default yang sesuai.
page_token	string Opsional. Nilai next_page_token yang ditampilkan dari panggilan AgentService.ListConversations daftar sebelumnya.
filter	string Opsional. Filter yang akan diterapkan saat mencantumkan percakapan. Lihat https://google.aip.dev/160 untuk mengetahui detail selengkapnya.
source	Conversation.Source Opsional. Menunjukkan sumber percakapan. Jika tidak disetel, Source.Live akan diterapkan secara default. Tidak akan digunakan lagi dan digantikan dengan kolom sources.
sources[]	Conversation.Source Opsional. Menunjukkan sumber percakapan. Jika tidak disetel, semua sumber yang tersedia akan diterapkan secara default.

ListConversationsResponse

Pesan respons untuk AgentService.ListConversations.

Kolom
conversations[]	Conversation Daftar percakapan.
next_page_token	string Token yang dapat dikirim sebagai ListConversationsRequest.page_token untuk mengambil halaman berikutnya. Tidak adanya kolom ini menunjukkan bahwa tidak ada halaman berikutnya.

ListDeploymentsRequest

Pesan permintaan untuk AgentService.ListDeployments.

Kolom
parent	string Wajib. Aplikasi induk. Format: projects/{project}/locations/{location}/apps/{app}
page_size	int32 Opsional. Jumlah maksimum deployment yang akan ditampilkan. Layanan mungkin menampilkan lebih sedikit dari nilai ini. Jika tidak ditentukan, paling banyak 50 deployment akan ditampilkan. Nilai maksimum adalah 1.000; nilai di atas 1.000 akan dikonversi menjadi 1.000.
page_token	string Opsional. Token halaman, yang diterima dari panggilan ListDeployments sebelumnya. Berikan ini untuk mengambil halaman selanjutnya. Saat melakukan penomoran halaman, semua parameter lain yang disediakan untuk ListDeployments harus sesuai dengan panggilan yang memberikan token halaman.
order_by	string Opsional. Kolom yang akan diurutkan. Hanya "name" dan "create_time" yang didukung. Lihat https://google.aip.dev/132#ordering untuk mengetahui detail selengkapnya.

ListDeploymentsResponse

Pesan respons untuk AgentService.ListDeployments.

Kolom
deployments[]	Deployment Daftar deployment.
next_page_token	string Token yang dapat dikirim sebagai page_token untuk mengambil halaman berikutnya. Jika kolom ini dihilangkan, tidak akan ada halaman berikutnya.

ListExamplesRequest

Pesan permintaan untuk AgentService.ListExamples.

Kolom
parent	string Wajib. Nama resource aplikasi untuk mencantumkan contoh.
page_size	int32 Opsional. Ukuran halaman yang diminta. Server dapat menampilkan lebih sedikit item daripada yang diminta. Jika tidak ditentukan, server akan memilih default yang sesuai.
page_token	string Opsional. Nilai next_page_token yang ditampilkan dari panggilan AgentService.ListExamples daftar sebelumnya.
filter	string Opsional. Filter yang akan diterapkan saat mencantumkan contoh. Lihat https://google.aip.dev/160 untuk mengetahui detail selengkapnya.
order_by	string Opsional. Kolom yang akan diurutkan. Hanya "name" dan "create_time" yang didukung. Lihat https://google.aip.dev/132#ordering untuk mengetahui detail selengkapnya.

ListExamplesResponse

Pesan respons untuk AgentService.ListExamples.

Kolom
examples[]	Example Daftar contoh.
next_page_token	string Token yang dapat dikirim sebagai ListExamplesRequest.page_token untuk mengambil halaman berikutnya. Tidak adanya kolom ini menunjukkan bahwa tidak ada halaman berikutnya.

ListGuardrailsRequest

Pesan permintaan untuk AgentService.ListGuardrails.

Kolom
parent	string Wajib. Nama resource aplikasi yang akan mencantumkan batas keamanannya.
page_size	int32 Opsional. Ukuran halaman yang diminta. Server dapat menampilkan lebih sedikit item daripada yang diminta. Jika tidak ditentukan, server akan memilih default yang sesuai.
page_token	string Opsional. Nilai next_page_token yang ditampilkan dari panggilan AgentService.ListGuardrails daftar sebelumnya.
filter	string Opsional. Filter yang akan diterapkan saat mencantumkan batas aman. Lihat https://google.aip.dev/160 untuk mengetahui detail selengkapnya.
order_by	string Opsional. Kolom yang akan diurutkan. Hanya "name" dan "create_time" yang didukung. Lihat https://google.aip.dev/132#ordering untuk mengetahui detail selengkapnya.

ListGuardrailsResponse

Pesan respons untuk AgentService.ListGuardrails.

Kolom
guardrails[]	Guardrail Daftar batasan.
next_page_token	string Token yang dapat dikirim sebagai ListGuardrailsRequest.page_token untuk mengambil halaman berikutnya. Tidak adanya kolom ini menunjukkan bahwa tidak ada halaman berikutnya.

ListToolsRequest

Pesan permintaan untuk AgentService.ListTools.

Kolom
parent	string Wajib. Nama resource aplikasi untuk mencantumkan alat.
page_size	int32 Opsional. Ukuran halaman yang diminta. Server dapat menampilkan lebih sedikit item daripada yang diminta. Jika tidak ditentukan, server akan memilih default yang sesuai.
page_token	string Opsional. Nilai next_page_token yang ditampilkan dari panggilan AgentService.ListTools daftar sebelumnya.
filter	string Opsional. Filter yang akan diterapkan saat mencantumkan alat. Gunakan "include_system_tools=true" untuk menyertakan alat sistem dalam respons. Lihat https://google.aip.dev/160 untuk mengetahui detail selengkapnya.
order_by	string Opsional. Kolom yang akan diurutkan. Hanya "name" dan "create_time" yang didukung. Lihat https://google.aip.dev/132#ordering untuk mengetahui detail selengkapnya.

ListToolsResponse

Pesan respons untuk AgentService.ListTools.

Kolom
tools[]	Tool Daftar alat.
next_page_token	string Token yang dapat dikirim sebagai ListToolsRequest.page_token untuk mengambil halaman berikutnya. Tidak adanya kolom ini menunjukkan bahwa tidak ada halaman berikutnya.

ListToolsetsRequest

Pesan permintaan untuk AgentService.ListToolsets.

Kolom
parent	string Wajib. Nama resource aplikasi untuk mencantumkan toolset.
page_size	int32 Opsional. Ukuran halaman yang diminta. Server dapat menampilkan lebih sedikit item daripada yang diminta. Jika tidak ditentukan, server akan memilih default yang sesuai.
page_token	string Opsional. Nilai next_page_token yang ditampilkan dari panggilan AgentService.ListToolsets daftar sebelumnya.
filter	string Opsional. Filter yang akan diterapkan saat mencantumkan toolset. Lihat https://google.aip.dev/160 untuk mengetahui detail selengkapnya.
order_by	string Opsional. Kolom yang akan diurutkan. Hanya "name" dan "create_time" yang didukung. Lihat https://google.aip.dev/132#ordering untuk mengetahui detail selengkapnya.

ListToolsetsResponse

Pesan respons untuk AgentService.ListToolsets.

Kolom
toolsets[]	Toolset Daftar toolset.
next_page_token	string Token yang dapat dikirim sebagai ListToolsetsRequest.page_token untuk mengambil halaman berikutnya. Tidak adanya kolom ini menunjukkan bahwa tidak ada halaman berikutnya.

LoggingSettings

Setelan untuk menjelaskan perilaku logging aplikasi.

Kolom
redaction_config	RedactionConfig Opsional. Konfigurasi cara data sensitif harus disamarkan.
audio_recording_config	AudioRecordingConfig Opsional. Konfigurasi cara interaksi audio harus direkam. Audio dapat disamarkan sesuai konfigurasi di RedactionConfig.
unredacted_audio_recording_config	AudioRecordingConfig Opsional. Mengonfigurasi rekaman tambahan audio yang tidak disamarkan. Salinan ini dapat digunakan untuk mempertahankan salinan audio mentah saat penyensoran audio enabled, biasanya untuk tujuan audit atau pemantauan.
bigquery_export_settings	BigQueryExportSettings Opsional. Mengonfigurasi perilaku ekspor BigQuery untuk aplikasi. Data percakapan tunduk pada penyamaran seperti yang dikonfigurasi di RedactionConfig.
unredacted_bigquery_export_settings	BigQueryExportSettings Opsional. Mengonfigurasi perilaku ekspor BigQuery untuk aplikasi. Data percakapan yang tidak disamarkan akan diekspor ke tabel BigQuery jika diaktifkan.
cloud_logging_settings	CloudLoggingSettings Opsional. Setelan untuk menjelaskan perilaku Cloud Logging untuk aplikasi.
conversation_logging_settings	ConversationLoggingSettings Opsional. Setelan untuk menjelaskan perilaku logging percakapan untuk aplikasi.
evaluation_audio_recording_config	AudioRecordingConfig Opsional. Konfigurasi cara interaksi audio harus direkam untuk evaluasi. Secara default, perekaman audio tidak diaktifkan untuk sesi evaluasi.
metric_analysis_settings	MetricAnalysisSettings Opsional. Setelan untuk menjelaskan perilaku pengumpulan data percakapan untuk pipeline analisis LLM untuk aplikasi.

McpTool

Alat MCP. Lihat https://modelcontextprotocol.io/specification/2025-06-18/server/tools untuk mengetahui detail selengkapnya.

Kolom
name	string Wajib. Nama alat MCP.
name_override	string Opsional. Penggantian nama alat MCP. Kolom ini diisi jika nama diganti oleh penggantian Toolset.
description	string Opsional. Deskripsi alat MCP.
input_schema	Schema Opsional. Skema argumen input alat MCP.
output_schema	Schema Opsional. Skema argumen output alat MCP.
server_address	string Wajib. Alamat server MCP, misalnya, "https://example.com/mcp/". Jika server dibangun dengan MCP SDK, URL harus memiliki akhiran "/mcp/". Hanya server berbasis transportasi HTTP yang dapat di-streaming yang didukung. Hal ini sama dengan server_address di McpToolset. Lihat https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http untuk mengetahui detail selengkapnya.
api_authentication	ApiAuthentication Opsional. Informasi autentikasi yang diperlukan untuk menjalankan alat terhadap server MCP. Untuk autentikasi token pembawa, token hanya berlaku untuk eksekusi alat, bukan untuk alat listingan. Hal ini mengharuskan alat dapat dicantumkan tanpa autentikasi.
tls_config	TlsConfig Opsional. Konfigurasi TLS. Mencakup sertifikat server kustom yang harus dipercaya oleh klien.
service_directory_config	ServiceDirectoryConfig Opsional. Konfigurasi Service Directory untuk VPC-SC, yang digunakan untuk menyelesaikan nama layanan dalam perimeter.
custom_headers	map<string, string> Opsional. Header kustom yang akan dikirim dalam permintaan ke server MCP. Nilai harus dalam format $context.variables.<name_of_variable> dan dapat ditetapkan dalam variabel sesi. Lihat https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection untuk mengetahui detail selengkapnya.
state	McpTool.State Hanya output. Status ketersediaan dinamis alat di server eksternal.

Negara Bagian

Mewakili status ketersediaan dinamis alat.

Enum
STATE_UNSPECIFIED	Status default.
ACTIVE	Alat ini tersedia dan ditawarkan secara aktif oleh server.
INACTIVE	Alat dikonfigurasi atau disematkan, tetapi saat ini tidak ditawarkan oleh server.
STALE	Alat ada di server, tetapi tidak cocok dengan versi di server.

McpToolDefinition

Penampung untuk elemen definisi inti alat yang diambil snapshotnya. Skema dalam snapshot digunakan sebagaimana adanya dan tidak dapat diganti.

Kolom
description	string Hanya output. Deskripsi alat MCP. Hal ini dapat diganti oleh description_override di McpToolOverride.
input_schema	Schema Hanya output. Skema argumen input alat MCP.
output_schema	Schema Hanya output. Skema argumen output alat MCP.

McpToolOverride

Penggantian yang terkait dengan alat tertentu dalam Toolset. Hal ini memungkinkan "penyematan" atau "penggantian" definisi alat dari server dinamis eksternal.

Kolom
tool	string Wajib. Nama asli alat sebagaimana dikeluarkan oleh server MCP.
name_override	string Opsional. Jika ada, alat ini akan menggunakan nama ini di Agen, bukan nama aslinya. Ini terutama digunakan sebagai alias jika server MCP menawarkan alat yang namanya kurang tepat.
description_override	string Opsional. Jika ada, alat ini akan menggunakan deskripsi ini, bukan deskripsi asli dari server.
snapshot	McpToolDefinition Hanya output. Jika ada, alat ini akan "Disematkan" dan menggunakan nilai snapshot sebagai penggantian jika server tidak tersedia untuk sementara atau jika tidak ada Penggantian.

McpToolset

Toolset yang berisi daftar alat yang ditawarkan oleh server MCP.

Kolom
server_address	string Wajib. Alamat server MCP, misalnya, "https://example.com/mcp/". Jika server dibangun dengan MCP SDK, URL harus memiliki akhiran "/mcp/". Hanya server berbasis transportasi HTTP yang dapat di-streaming yang didukung. Lihat https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http untuk mengetahui detail selengkapnya.
api_authentication	ApiAuthentication Opsional. Informasi autentikasi yang diperlukan untuk mengakses alat dan menjalankan alat terhadap server MCP. Untuk autentikasi token pembawa, token hanya berlaku untuk eksekusi alat, bukan untuk alat listingan. Hal ini mengharuskan alat dapat dicantumkan tanpa autentikasi.
service_directory_config	ServiceDirectoryConfig Opsional. Konfigurasi Service Directory untuk VPC-SC, yang digunakan untuk menyelesaikan nama layanan dalam perimeter.
tls_config	TlsConfig Opsional. Konfigurasi TLS. Mencakup sertifikat server kustom yang harus dipercaya oleh klien.
custom_headers	map<string, string> Opsional. Header kustom yang akan dikirim dalam permintaan ke server MCP. Nilai harus dalam format $context.variables.<name_of_variable> dan dapat ditetapkan dalam variabel sesi. Lihat https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection untuk mengetahui detail selengkapnya.
tool_overrides[]	McpToolOverride Opsional. Penggantian untuk setiap alat dalam set alat ini. Hal ini memungkinkan penggantian detail tertentu seperti deskripsi, nama, atau menyematkan status alat sehingga tidak sepenuhnya dinamis.

Pesan

Pesan dalam percakapan.

Kolom
role	string Opsional. Peran dalam percakapan, misalnya, pengguna, agen.
chunks[]	Chunk Opsional. Konten pesan sebagai serangkaian potongan.
event_time	Timestamp Opsional. Stempel waktu saat pesan dikirim atau diterima. Tidak boleh digunakan jika pesan adalah bagian dari example.

MetricAnalysisSettings

Setelan untuk menjelaskan perilaku pengumpulan data percakapan untuk pipeline metrik analisis LLM.

Kolom
llm_metrics_opted_out	bool Opsional. Apakah akan mengumpulkan data percakapan untuk metrik analisis LLM. Jika benar (true), data percakapan tidak akan dikumpulkan untuk metrik analisis llm; jika tidak, data percakapan akan dikumpulkan.

MockConfig

Konfigurasi panggilan alat tiruan untuk sesi.

Kolom
mocked_tool_calls[]	MockedToolCall Opsional. Semua panggilan alat yang akan di-mock selama durasi sesi.
unmatched_tool_call_behavior	MockConfig.UnmatchedToolCallBehavior Wajib. Perilaku untuk panggilan alat yang tidak cocok dengan pola argumen apa pun di mocked_tool_calls.

UnmatchedToolCallBehavior

Tindakan yang harus dilakukan saat panggilan alat tidak cocok dengan panggilan alat tiruan.

Enum
UNMATCHED_TOOL_CALL_BEHAVIOR_UNSPECIFIED	Nilai default. Nilai ini tidak digunakan.
FAIL	Menampilkan error untuk panggilan alat apa pun yang tidak cocok dengan pola input yang diharapkan tiruan.
PASS_THROUGH	Untuk panggilan alat yang tidak cocok, teruskan panggilan alat ke alat yang sebenarnya.

MockedToolCall

Panggilan alat tiruan.

Mengekspresikan alat target + pola untuk dicocokkan dengan argumen / input alat tersebut. Jika pola cocok, respons tiruan akan ditampilkan.

Kolom
tool (deprecated)	string Item ini tidak digunakan lagi. Opsional. Tidak digunakan lagi. Gunakan tool_identifier sebagai gantinya.
expected_args_pattern	Struct Wajib. Pola untuk mencocokkan argumen / input dari semua panggilan alat yang dikirim. Jika input panggilan alat cocok dengan pola ini, output tiruan akan ditampilkan.
mock_response	Struct Opsional. Respons / output tiruan yang akan ditampilkan jika argumen / input panggilan alat cocok dengan pola.
Kolom union tool_identifier. ID alat yang akan di-mock. tool_identifier hanya ada berupa salah satu diantara berikut:
tool_id	string Opsional. Nama alat yang akan di-mock. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolset	ToolsetTool Opsional. Kumpulan alat untuk membuat tiruan.

ModelSettings

Setelan model berisi berbagai konfigurasi untuk model LLM.

Kolom
model	string Opsional. Model LLM yang harus digunakan agen. Jika tidak disetel, agen akan mewarisi model dari agen induknya.
thinking_level	ModelSettings.ThinkingLevel Opsional. Tingkat penalaran model.
temperature	double Opsional. Jika disetel, suhu ini akan digunakan untuk model LLM. Temperatur mengontrol keacakan respons model. Temperatur yang lebih rendah menghasilkan respons yang lebih dapat diprediksi. Temperatur yang lebih tinggi menghasilkan respons yang lebih kreatif.

ThinkingLevel

Konfigurasi tingkat penalaran untuk model.

Enum
THINKING_LEVEL_UNSPECIFIED	Tingkat penalaran tidak ditentukan.
DEFAULT	Tingkat penalaran default.
LOW	Tingkat penalaran rendah.
MEDIUM	Tingkat penalaran sedang.
HIGH	Tingkat pemikiran tinggi.

OAuthConfig

Konfigurasi untuk autentikasi dengan OAuth.

Kolom
oauth_grant_type	OAuthConfig.OauthGrantType Wajib. Jenis pemberian izin OAuth.
client_id	string Wajib. Client ID dari penyedia OAuth.
client_secret_version	string Wajib. Nama resource versi secret SecretManager yang menyimpan rahasia klien. Format: projects/{project}/secrets/{secret}/versions/{version} Catatan: Anda harus memberikan peran roles/secretmanager.secretAccessor kepada agen layanan CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
token_endpoint	string Wajib. Endpoint token di penyedia OAuth untuk ditukar dengan token akses.
scopes[]	string Opsional. Cakupan OAuth yang akan diberikan.

OauthGrantType

Jenis pemberian izin OAuth. Hanya pemberian kredensial klien yang didukung.

Enum
OAUTH_GRANT_TYPE_UNSPECIFIED	Tidak ditentukan. Nilai defaultnya adalah CLIENT_CREDENTIAL.
CLIENT_CREDENTIAL	Mewakili alur kredensial klien.

OpenApiTool

Alat API jarak jauh yang ditentukan oleh skema OpenAPI.

Kolom
open_api_schema	string Wajib. Skema OpenAPI dalam format JSON atau YAML.
name	string Opsional. Nama alat. Jika tidak diberikan, nama alat akan diambil dari skema OpenAPI, dari operation.operationId.
description	string Opsional. Deskripsi alat. Jika tidak diberikan, deskripsi alat akan diambil dari skema OpenAPI, dari operation.description atau operation.summary.
api_authentication	ApiAuthentication Opsional. Informasi autentikasi yang diperlukan oleh API.
tls_config	TlsConfig Opsional. Konfigurasi TLS. Mencakup sertifikat server kustom yang akan dipercayai klien.
service_directory_config	ServiceDirectoryConfig Opsional. Konfigurasi Service Directory.
ignore_unknown_fields	bool Opsional. Jika benar (true), agen akan mengabaikan kolom yang tidak diketahui dalam respons API.
url	string Opsional. URL server skema Open API. Kolom ini hanya ditetapkan di alat dalam dependensi lingkungan selama proses ekspor jika skema berisi URL server. Selama proses impor, jika URL ini ada dalam dependensi lingkungan dan skema memiliki placeholder $env_var, URL ini akan menggantikan placeholder dalam skema.

OpenApiToolset

Toolset yang berisi daftar alat yang ditentukan oleh skema OpenAPI.

Kolom
open_api_schema	string Wajib. Skema OpenAPI toolset.
api_authentication	ApiAuthentication Opsional. Informasi autentikasi yang diperlukan oleh API.
tls_config	TlsConfig Opsional. Konfigurasi TLS. Mencakup sertifikat server kustom
service_directory_config	ServiceDirectoryConfig Opsional. Konfigurasi Service Directory.
ignore_unknown_fields	bool Opsional. Jika benar, agen akan mengabaikan kolom yang tidak diketahui dalam respons API untuk semua operasi yang ditentukan dalam skema OpenAPI.
url	string Opsional. URL server skema Open API. Kolom ini hanya ditetapkan di toolset dalam dependensi lingkungan selama proses ekspor jika skema berisi URL server. Selama proses impor, jika URL ini ada dalam dependensi lingkungan dan skema memiliki placeholder $env_var, URL ini akan menggantikan placeholder dalam skema.

OperationMetadata

Menampilkan metadata operasi yang berjalan lama.

Kolom
create_time	Timestamp Hanya output. Waktu pembuatan operasi.
end_time	Timestamp Hanya output. Waktu selesainya operasi.
status_message	string Hanya output. Status operasi yang dapat dibaca manusia, jika ada.
requested_cancellation	bool Hanya output. Mengidentifikasi apakah pengguna telah meminta pembatalan operasi. Operasi yang berhasil dibatalkan memiliki nilai google.longrunning.Operation.error dengan google.rpc.Status.code 1, yang sesuai dengan Code.CANCELLED.

OutputAudioConfig

OutputAudioConfig mengonfigurasi cara agen CES harus menyintesis respons audio keluar.

Kolom
audio_encoding	AudioEncoding Wajib. Encoding data audio output.
sample_rate_hertz	int32 Wajib. Frekuensi sampel (dalam Hertz) data audio output.

PythonCodeCondition

Blok kode Python untuk mengevaluasi kondisi.

Kolom
python_code	string Wajib. Kode python yang akan dieksekusi.

PythonFunction

Alat fungsi Python.

Kolom
name	string Opsional. Nama fungsi Python yang akan dieksekusi. Harus cocok dengan nama fungsi Python yang ditentukan dalam kode python. Peka huruf besar/kecil. Jika nama tidak diberikan, fungsi pertama yang ditentukan dalam kode python akan digunakan.
python_code	string Opsional. Kode Python yang akan dieksekusi untuk alat.
description	string Hanya output. Deskripsi fungsi Python, diuraikan dari docstring kode python.
service_directory_config	ServiceDirectoryConfig Opsional. Konfigurasi Service Directory untuk alat.

RecognitionResult

Hasil pengenalan ucapan untuk input audio.

Kolom
transcript	string Opsional. Segmen ucapan pengguna yang digabungkan dan direkam selama giliran saat ini.

RedactionConfig

Konfigurasi untuk menginstruksikan cara menangani data sensitif.

Kolom
enable_redaction	bool Opsional. Jika benar (true), penyamaran akan diterapkan dalam berbagai skenario logging, termasuk histori percakapan, Cloud Logging, dan rekaman audio.
inspect_template	string Opsional. Nama template inspeksi DLP untuk mengonfigurasi deteksi jenis data sensitif. Format: projects/{project}/locations/{location}/inspectTemplates/{inspect_template}
deidentify_template	string Opsional. Nama template de-identifikasi DLP untuk memberikan petunjuk tentang cara melakukan de-identifikasi konten. Format: projects/{project}/locations/{location}/deidentifyTemplates/{deidentify_template}

RemoteA2aConfig

Konfigurasi bersama untuk terhubung ke agen A2A jarak jauh.

Kolom
api_authentication	ApiAuthentication Opsional. Konfigurasi autentikasi untuk memanggil agen jarak jauh. Opsional jika referensi registry sudah menangani autentikasi.
input_variable_mapping	map<string, string> Opsional. Pemetaan nama variabel input agen jarak jauh ke nama variabel GECX.
output_variable_mapping	map<string, string> Opsional. Pemetaan nama variabel output agen jarak jauh ke nama variabel GECX.
streaming_enabled	bool Opsional. Apakah streaming diaktifkan untuk agen jarak jauh.
context_id	string Opsional. Jika tidak kosong, interaksi dengan agen A2A jarak jauh akan menggunakan ID konteks ini. Kolom context_id ini dapat merujuk ke variabel sesi seperti $context.variables.order_agent_session_id.
Kolom union agent_spec. Spesifikasi agen jarak jauh. agent_spec hanya ada berupa salah satu diantara berikut:
agent_card	AgentCard Opsional. Kartu agen lengkap yang ditentukan secara inline.
agent_registry	string Opsional. Referensi ke agen di Agent Registry. Format: projects/{project}/locations/{location}/agents/{agent}

RemoteAgentTool

Mewakili alat yang memungkinkan agen memanggil agen jarak jauh lain.

Kolom
name	string Wajib. Nama alat.
description	string Wajib. Deskripsi alat.
agent_card	AgentCard Wajib. Kartu agen dari agen jarak jauh yang dipanggil oleh alat ini.
api_authentication	ApiAuthentication Opsional. Konfigurasi autentikasi untuk memanggil agen jarak jauh.
stateful_agent	bool Opsional. Jika diaktifkan, interaksi antara aplikasi CXAS dan agen jarak jauh akan memiliki konteks yang sama. Jika agen jarak jauh menampilkan context_id, context_id tersebut akan dipertahankan selama sesi untuk alat agen jarak jauh ini.
input_variable_mapping	map<string, string> Opsional. Pemetaan nama variabel input agen jarak jauh ke nama variabel GECX.
output_variable_mapping	map<string, string> Opsional. Pemetaan nama variabel output agen jarak jauh ke nama variabel GECX.

RestoreAppVersionRequest

Pesan permintaan untuk AgentService.RestoreAppVersion

Kolom
name	string Wajib. Nama resource versi aplikasi yang akan dipulihkan.

RestoreAppVersionResponse

Jenis ini tidak memiliki kolom.

Pesan respons untuk AgentService.RestoreAppVersion

RetrieveToolSchemaRequest

Pesan permintaan untuk ToolService.RetrieveToolSchema.

Kolom
parent	string Wajib. Nama resource aplikasi yang memiliki alat/kumpulan alat. Format: projects/{project}/locations/{location}/apps/{app}
Kolom union tool_identifier. ID alat untuk mengambil skemanya. Alat ini bisa berupa alat yang tetap ada atau alat dari toolset. tool_identifier hanya ada berupa salah satu diantara berikut:
tool	string Opsional. Nama alat untuk mengambil skema. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolset_tool	ToolsetTool Opsional. Alat toolset untuk mengambil skema. Hanya satu alat yang harus cocok dengan predikat dari toolset. Jika tidak, error akan ditampilkan.

RetrieveToolSchemaResponse

Pesan respons untuk ToolService.RetrieveToolSchema.

Kolom
input_schema	Schema Skema parameter input alat.
output_schema	Schema Skema parameter output alat.
Kolom union tool_identifier. ID alat yang skemanya ditujukan untuknya. tool_identifier hanya ada berupa salah satu diantara berikut:
tool	string Nama alat yang ditujukan untuk skema. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolset_tool	ToolsetTool Alat toolset yang skemanya ditujukan untuk.

RetrieveToolsRequest

Pesan permintaan untuk ToolService.RetrieveTools.

Kolom
toolset	string Wajib. Nama toolset untuk mengambil alat. Format: projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
tool_ids[]	string Opsional. ID alat yang akan diambil dari toolset. Jika kosong, semua alat dalam toolset akan ditampilkan.
bypass_persistence_config	bool Opsional. Jika benar (true), alat yang ditampilkan akan berisi deskripsi dan skema mentah langsung dari server, dengan melewati konfigurasi persistensi yang disimpan (penggantian/snapshot).

RetrieveToolsResponse

Pesan respons untuk ToolService.RetrieveTools.

Kolom
tools[]	Tool Daftar alat yang disertakan dalam toolset yang ditentukan.

RunSessionRequest

Pesan permintaan untuk SessionService.RunSession.

Kolom
config	SessionConfig Wajib. Konfigurasi untuk sesi.
inputs[]	SessionInput Wajib. Input untuk sesi.

RunSessionResponse

Pesan respons untuk SessionService.RunSession.

Kolom
outputs[]	SessionOutput Output untuk sesi.

Skema

Mewakili subset objek skema OpenAPI 3.0 yang dipilih.

Kolom
type	Schema.Type Wajib. Jenis data.
properties	map<string, Schema> Opsional. Properti Type.OBJECT.
required[]	string Opsional. Properti wajib Type.OBJECT.
description	string Opsional. Deskripsi data.
items	Schema Opsional. Skema elemen Type.ARRAY.
nullable	bool Opsional. Menunjukkan apakah nilai mungkin null.
unique_items	bool Opsional. Menunjukkan bahwa item dalam array harus unik. Hanya berlaku untuk TYPE.ARRAY.
prefix_items[]	Schema Opsional. Skema elemen awal Type.ARRAY.
additional_properties	Schema Opsional. Dapat berupa boolean atau objek, mengontrol keberadaan properti tambahan.
any_of[]	Schema Opsional. Nilai harus divalidasi terhadap subskema apa pun (satu atau lebih) dalam daftar.
enum[]	string Opsional. Kemungkinan nilai elemen jenis primitif dengan format enum. Contoh: 1. Kita dapat menentukan arah sebagai : {type:STRING, format:enum, enum:["TIMUR", NORTH", "SELATAN", "BARAT"]} 2. Kita dapat menentukan nomor apartemen sebagai : {type:INTEGER, format:enum, enum:["101", "201", "301"]}
default	Value Opsional. Nilai default data.
ref	string Opsional. Memungkinkan referensi tidak langsung antar-node skema. Nilai harus berupa referensi yang valid ke turunan defs akar. Misalnya, skema berikut menentukan referensi ke node skema bernama "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string Nilai properti "pet" adalah referensi ke node skema bernama "Pet". Lihat detailnya di https://json-schema.org/understanding-json-schema/structuring.
defs	map<string, Schema> Opsional. Peta definisi untuk digunakan oleh ref. Hanya diizinkan di root skema.
title	string Opsional. Judul skema.
min_items	int64 Opsional. Jumlah minimum elemen untuk Type.ARRAY.
max_items	int64 Opsional. Jumlah maksimum elemen untuk Type.ARRAY.
minimum	double Opsional. Nilai minimum untuk Type.INTEGER dan Type.NUMBER.
maximum	double Opsional. Nilai maksimum untuk Type.INTEGER dan Type.NUMBER.

Jenis

Jenis data OpenAPI.

Enum
TYPE_UNSPECIFIED	Jenis tidak ditentukan.
STRING	Jenis string.
INTEGER	Jenis bilangan bulat.
NUMBER	Jenis angka.
BOOLEAN	Jenis boolean.
OBJECT	Jenis objek.
ARRAY	Jenis array.

SecuritySettings

Setelan keamanan tingkat Project/Lokasi untuk CES.

Kolom
name	string ID. ID unik setelan keamanan. Format: projects/{project}/locations/{location}/securitySettings
endpoint_control_policy	EndpointControlPolicy Opsional. Setelan terkait kontrol endpoint.
create_time	Timestamp Hanya output. Waktu pembuatan setelan keamanan.
update_time	Timestamp Hanya output. Waktu update terakhir setelan keamanan.
etag	string Hanya output. Etag setelan keamanan.

ServiceAccountAuthConfig

Konfigurasi untuk autentikasi menggunakan akun layanan kustom.

Kolom
service_account	string Wajib. Alamat email akun layanan yang digunakan untuk autentikasi. CES menggunakan akun layanan ini untuk menukar token akses dan token akses tersebut kemudian dikirim di header Authorization permintaan. Akun layanan harus memiliki peran roles/iam.serviceAccountTokenCreator yang diberikan kepada agen layanan CES service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com.
scopes[]	string Opsional. Cakupan OAuth yang akan diberikan. Jika tidak ditentukan, cakupan default https://www.googleapis.com/auth/cloud-platform akan digunakan.

ServiceAgentIdTokenAuthConfig

Jenis ini tidak memiliki kolom.

Konfigurasi untuk autentikasi dengan token ID yang dibuat dari agen layanan.

ServiceDirectoryConfig

Konfigurasi untuk alat yang menggunakan Direktori Layanan.

Kolom
service	string Wajib. Nama layanan Service Directory. Format: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}. Lokasi direktori layanan harus sama dengan lokasi aplikasi.

SessionConfig

Konfigurasi untuk sesi.

Kolom
session	string Wajib. ID unik sesi. Format: projects/{project}/locations/{location}/apps/{app}/sessions/{session}
input_audio_config	InputAudioConfig Opsional. Konfigurasi untuk memproses audio input.
output_audio_config	OutputAudioConfig Opsional. Konfigurasi untuk membuat audio output.
historical_contexts[]	Message Opsional. Konteks historis sesi, termasuk input pengguna, respons agen, dan pesan lainnya. Biasanya, agen CES akan mengelola sesi secara otomatis sehingga klien tidak perlu mengisi kolom ini secara eksplisit. Namun, klien dapat secara opsional mengganti konteks historis untuk memulai sesi dari status tertentu.
entry_agent	string Opsional. Agen entri untuk menangani sesi. Jika tidak ditentukan, sesi akan ditangani oleh root agent aplikasi. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
deployment	string Opsional. Deployment aplikasi yang akan digunakan untuk sesi. Format: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
time_zone	string Opsional. Zona waktu pengguna. Jika diberikan, agen akan menggunakan zona waktu untuk variabel terkait tanggal dan waktu. Jika tidak, agen akan menggunakan zona waktu yang ditentukan di App.time_zone_settings. Formatnya adalah zona waktu Database Zona Waktu IANA, misalnya "America/Los_Angeles".
use_tool_fakes	bool Opsional. Apakah akan menggunakan tiruan alat untuk sesi. Jika kolom ini disetel, agen akan mencoba menggunakan tiruan alat, bukan memanggil alat yang sebenarnya.
remote_dialogflow_query_parameters	SessionConfig.RemoteDialogflowQueryParameters Opsional. QueryParameters untuk dikirim ke agen Dialogflow jarak jauh saat kontrol sesi ditransfer ke agen jarak jauh.
enable_text_streaming	bool Opsional. Apakah akan mengaktifkan output teks streaming dari model. Secara default, output teks dari model dikumpulkan sebelum dikirim ke klien. CATATAN: Fitur ini hanya didukung untuk sesi teks (non-suara) melalui StreamRunSession atau BidiRunSession.
exclude_diagnostic_info	bool Opsional. Apakah akan mengecualikan info diagnostik dari output sesi.

RemoteDialogflowQueryParameters

QueryParameters untuk dikirim ke agen Dialogflow jarak jauh saat kontrol sesi ditransfer ke agen jarak jauh.

Kolom
webhook_headers	map<string, string> Opsional. Header HTTP yang akan dikirim sebagai webhook_headers di QueryParameters.
payload	Struct Opsional. Payload yang akan dikirim dalam QueryParameters.
end_user_metadata	Struct Opsional. Metadata pengguna akhir yang akan dikirim dalam QueryParameters.

SessionInput

Input untuk sesi.

Kolom
will_continue	bool Opsional. Flag untuk menunjukkan apakah pesan saat ini adalah fragmen input yang lebih besar dalam sesi streaming bidi. Jika disetel ke true, agen akan menunda pemrosesan hingga menerima pesan berikutnya dengan will_continue adalah false, atau hingga sistem mendeteksi titik akhir dalam input audio. CATATAN: Kolom ini tidak berlaku untuk input audio dan DTMF, karena input tersebut selalu diproses secara otomatis berdasarkan sinyal pengakhiran.
Kolom union input_type. Jenis input. input_type hanya ada berupa salah satu diantara berikut:
text	string Opsional. Data teks dari pengguna akhir.
dtmf	string Opsional. Digit DTMF dari pengguna akhir.
audio	bytes Opsional. Data audio dari pengguna akhir.
tool_responses	ToolResponses Opsional. Hasil eksekusi untuk panggilan alat dari klien.
image	Image Opsional. Data gambar dari pengguna akhir.
blob	Blob Opsional. Data blob dari pengguna akhir.
variables	Struct Opsional. Variabel kontekstual untuk sesi, yang dikelompokkan berdasarkan nama. Hanya variabel yang dideklarasikan di aplikasi yang akan digunakan oleh agen CES. Variabel yang tidak dikenali akan tetap dikirim ke [agen Dialogflow][Agent.RemoteDialogflowAgent] sebagai parameter sesi tambahan.
event	Event Opsional. Input acara.

SessionOutput

Output untuk sesi.

Kolom
turn_index	int32 Menunjukkan urutan percakapan yang berurutan yang menjadi bagian dari output ini, dimulai dari 1.
turn_completed	bool Jika benar (true), agen CES telah mendeteksi akhir giliran percakapan saat ini dan tidak akan memberikan output lebih lanjut untuk giliran ini.
diagnostic_info	SessionOutput.DiagnosticInfo Opsional. Informasi diagnostik berisi detail eksekusi selama pemrosesan input. Hanya diisi di SessionOutput terakhir (dengan turn_completed=true) untuk setiap giliran.
Kolom union output_type. Jenis output. output_type hanya ada berupa salah satu diantara berikut:
text	string Teks output dari agen CES.
audio	bytes Menghasilkan audio dari agen CES.
tool_calls	ToolCalls Permintaan agar klien menjalankan alat.
citations	Citations Kutipan yang memberikan informasi sumber untuk teks yang dihasilkan agen.
google_search_suggestions	GoogleSearchSuggestions Saran yang ditampilkan dari Google Penelusuran sebagai hasil dari pemanggilan GoogleSearchTool.
end_session	EndSession Menunjukkan bahwa sesi telah berakhir.
payload	Struct Payload kustom dengan output terstruktur dari agen CES.
image	Image Gambar output dari agen CES.
progress	string Pembaruan progres sementara dari agen CES.

DiagnosticInfo

Berisi detail eksekusi selama pemrosesan.

Kolom
messages[]	Message Daftar pesan yang terjadi selama pemrosesan.
root_span	Span Trace seluruh pemrosesan permintaan, yang ditampilkan sebagai rentang root. Rentang ini dapat berisi rentang turunan bertingkat untuk operasi tertentu.

Span

Rentang adalah unit tugas atau satu operasi selama pemrosesan permintaan.

Kolom
name	string Hanya output. Nama rentang.
start_time	Timestamp Hanya output. Waktu mulai rentang.
end_time	Timestamp Hanya output. Waktu berakhir rentang.
duration	Duration Hanya output. Durasi rentang.
attributes	Struct Hanya output. Atribut nilai kunci yang terkait dengan rentang.
child_spans[]	Span Hanya output. Rentang turunan yang bertingkat di bawah rentang ini.

SynthesizeSpeechConfig

Konfigurasi cara mensintesis respons agen.

Kolom
voice	string Opsional. Nama suara. Jika tidak disetel, layanan akan memilih suara berdasarkan parameter lain seperti language_code. Untuk mengetahui daftar suara yang tersedia, lihat Suara dan bahasa yang didukung dari Cloud Text-to-Speech.
speaking_rate	double Opsional. Kecepatan bicara dalam rentang [0,25, 2,0]. 1,0 adalah kecepatan native normal yang didukung oleh suara tertentu. 2,0 adalah dua kali lebih cepat, dan 0,5 adalah setengah kali lebih cepat. Nilai di luar rentang [0,25, 2,0] akan menampilkan error.
model	string Opsional. Model yang digunakan untuk menyintesis audio. Nilai yang saat ini didukung: - "gemini-3.1-flash-tts-preview" Jika kosong, Chirp3-HD akan digunakan.
instruction	string Opsional. Petunjuk yang digunakan untuk menyintesis ucapan saat menggunakan model generatif.

SystemTool

Alat sistem yang telah ditentukan sebelumnya.

Kolom
name	string Wajib. Nama alat sistem.
description	string Hanya output. Deskripsi alat sistem.

TimeZoneSettings

Setelan TimeZone aplikasi.

Kolom
time_zone	string Opsional. Zona waktu aplikasi dari database zona waktu, misalnya, America/Los_Angeles, Europe/Paris.

TlsConfig

Konfigurasi TLS.

Kolom
ca_certs[]	TlsConfig.CaCert Wajib. Menentukan daftar sertifikat CA kustom yang diizinkan untuk verifikasi HTTPS.

CaCert

Sertifikat CA.

Kolom
display_name	string Wajib. Nama sertifikat CA kustom yang diizinkan. Hal ini dapat digunakan untuk membedakan sertifikat CA kustom.
cert	bytes Wajib. Sertifikat CA kustom yang diizinkan (dalam format DER) untuk verifikasi HTTPS. Opsi ini menggantikan trust store SSL default. Jika kosong atau tidak ditentukan, CES akan menggunakan trust store default Google untuk memverifikasi sertifikat. Catatan: Pastikan sertifikat server HTTPS ditandatangani dengan "subject alt name". Misalnya, sertifikat dapat ditandatangani sendiri menggunakan perintah berikut: openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'")

Alat

Alat mewakili tindakan yang dapat dilakukan agen CES untuk mencapai tujuan tertentu.

Kolom
name	string ID. Nama resource alat. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool} untuk alat mandiri. projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool} untuk alat yang diambil dari toolset. Alat ini bersifat dinamis dan hanya menghasilkan output; alat ini tidak dapat dirujuk secara langsung jika alat diperlukan.
display_name	string Hanya output. Nama tampilan alat, yang berasal dari jenis alat. Misalnya, nama tampilan [ClientFunction][Tool.ClientFunction] berasal dari properti name-nya.
execution_type	ExecutionType Opsional. Jenis eksekusi alat.
timeout	Duration Opsional. Waktu tunggu untuk eksekusi alat. Jika tidak disetel, waktu tunggu default adalah 30 detik untuk alat SYNCHRONOUS dan 60 detik untuk alat ASYNCHRONOUS.
create_time	Timestamp Hanya output. Stempel waktu saat alat dibuat.
update_time	Timestamp Hanya output. Stempel waktu saat alat terakhir diperbarui.
etag	string ETag yang digunakan untuk memastikan objek tidak berubah selama operasi baca-ubah-tulis. Jika etag kosong, pembaruan akan menimpa perubahan serentak.
generated_summary	string Hanya output. Jika alat dibuat oleh asisten LLM, kolom ini berisi ringkasan deskriptif dari pembuatan tersebut.
tool_fake_config	ToolFakeConfig Opsional. Konfigurasi untuk perilaku alat dalam mode tiruan.
read_only	bool Hanya output. Menunjukkan apakah alat bersifat hanya baca. Jika benar (true), alat tidak dapat diubah oleh pengguna.
Kolom union tool_type. Jenis alat. tool_type hanya ada berupa salah satu diantara berikut:
client_function	ClientFunction Opsional. Fungsi klien.
open_api_tool	OpenApiTool Opsional. Alat API terbuka.
google_search_tool	GoogleSearchTool Opsional. Alat penelusuran google.
connector_tool	ConnectorTool Opsional. Alat Integration Connector.
data_store_tool	DataStoreTool Opsional. Alat penyimpanan data.
python_function	PythonFunction Opsional. Alat fungsi python.
mcp_tool	McpTool Opsional. Alat MCP. Alat MCP tidak dapat dibuat atau diperbarui secara langsung dan dikelola oleh toolset MCP.
file_search_tool	FileSearchTool Opsional. Alat penelusuran file.
system_tool	SystemTool Opsional. Alat sistem.
agent_tool	AgentTool Opsional. Alat agen.
widget_tool	WidgetTool Opsional. Alat widget.
remote_agent_tool	RemoteAgentTool Opsional. Alat agen jarak jauh.

ToolCall

Meminta klien atau agen untuk menjalankan alat yang ditentukan.

Kolom
id	string Opsional. ID unik panggilan alat. Jika diisi, klien harus menampilkan hasil eksekusi dengan ID yang cocok di ToolResponse.
display_name	string Hanya output. Nama tampilan alat.
args	Struct Opsional. Parameter dan nilai input untuk alat dalam format objek JSON.
parent_tool_call_id	string Hanya output. ID panggilan alat yang menyebabkan panggilan ini, saat dikeluarkan oleh sub-agen yang bekerja atas nama panggilan induk. Kosong untuk panggilan tingkat teratas. Memungkinkan klien mengelompokkan pekerjaan sub-agen dalam panggilan yang memulainya, bukan merender setiap langkah sebagai saudara.
agent_name	string Hanya output. Nama agen yang dapat dibaca manusia yang mengeluarkan panggilan ini, misalnya "Contract Architect". Kosong saat agen root menerbitkannya.
Kolom union tool_identifier. ID alat yang akan dieksekusi. Alat ini bisa berupa alat yang tetap ada atau alat dari toolset. tool_identifier hanya ada berupa salah satu diantara berikut:
tool	string Opsional. Nama alat yang akan dieksekusi. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolset_tool	ToolsetTool Opsional. Alat toolset yang akan dijalankan.

ToolCalls

Permintaan agar klien menjalankan alat dan menampilkan hasil eksekusi sebelum melanjutkan sesi.

Kolom
tool_calls[]	ToolCall Opsional. Daftar panggilan alat yang akan dieksekusi.

ToolFakeConfig

Konfigurasi untuk perilaku alat dalam mode tiruan.

Kolom
enable_fake_mode	bool Opsional. Apakah alat menggunakan mode palsu.
Kolom union tool_response. Respons bersifat statis atau disediakan oleh fungsi python. tool_response hanya ada berupa salah satu diantara berikut:
code_block	CodeBlock Opsional. Blok kode yang akan dieksekusi, bukan panggilan alat yang sebenarnya.

ToolResponse

Hasil eksekusi alat tertentu dari klien atau agen.

Kolom
id	string Opsional. ID yang cocok dari tool call yang menjadi tujuan respons.
display_name	string Hanya output. Nama tampilan alat.
response	Struct Wajib. Hasil eksekusi alat dalam format objek JSON. Gunakan kunci "output" untuk menentukan respons alat dan kunci "error" untuk menentukan detail error (jika ada). Jika kunci "output" dan "error" tidak ditentukan, seluruh "respons" akan diperlakukan sebagai hasil eksekusi alat.
parent_tool_call_id	string Hanya output. ID panggilan alat yang menyebabkan panggilan ini, saat dikeluarkan oleh sub-agen yang bekerja atas nama panggilan induk. Kosong untuk panggilan tingkat teratas. Memungkinkan klien mengelompokkan pekerjaan sub-agen dalam panggilan yang memulainya, bukan merender setiap langkah sebagai saudara.
agent_name	string Hanya output. Nama agen yang dapat dibaca manusia yang mengeluarkan panggilan ini, misalnya "Contract Architect". Kosong saat agen root menerbitkannya.
Kolom union tool_identifier. ID alat yang dieksekusi. Alat ini bisa berupa alat yang tetap ada atau alat dari toolset. tool_identifier hanya ada berupa salah satu diantara berikut:
tool	string Opsional. Nama alat yang akan dieksekusi. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolset_tool	ToolsetTool Opsional. Alat toolset yang dieksekusi.

ToolResponses

Hasil eksekusi untuk panggilan alat yang diminta dari klien.

Kolom
tool_responses[]	ToolResponse Opsional. Daftar hasil eksekusi alat.

Toolset

Toolset mewakili sekelompok alat yang dikelola secara dinamis yang dapat digunakan oleh agen.

Kolom
name	string ID. ID unik toolset. Format: projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
display_name	string Opsional. Nama tampilan toolset. Harus unik dalam aplikasi yang sama.
description	string Opsional. Deskripsi toolset.
timeout	Duration Opsional. Waktu tunggu untuk eksekusi toolset. Jika tidak disetel, waktu tunggu default adalah 30 detik untuk toolset SYNCHRONOUS dan 60 detik untuk toolset ASYNCHRONOUS.
create_time	Timestamp Hanya output. Stempel waktu saat toolset dibuat.
update_time	Timestamp Hanya output. Stempel waktu saat toolset terakhir diperbarui.
etag	string ETag digunakan untuk memastikan objek tidak berubah selama operasi baca-ubah-tulis. Jika etag kosong, pembaruan akan menimpa perubahan serentak.
execution_type	ExecutionType Opsional. Jenis eksekusi alat dalam toolset.
tool_fake_config	ToolFakeConfig Opsional. Konfigurasi untuk perilaku alat dalam mode palsu.
Kolom union toolset_type. Jenis toolset. toolset_type hanya ada berupa salah satu diantara berikut:
mcp_toolset	McpToolset Opsional. Toolset yang berisi daftar alat yang ditawarkan oleh server MCP.
open_api_toolset	OpenApiToolset Opsional. Toolset yang berisi daftar alat yang ditentukan oleh skema OpenAPI.
connector_toolset	ConnectorToolset Opsional. Kumpulan alat yang membuat alat dari Koneksi Integration Connectors.

ToolsetTool

Alat yang dibuat dari toolset.

Kolom
toolset	string Wajib. Nama resource Toolset dari mana alat ini berasal. Format: projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
tool_id	string Opsional. ID alat untuk memfilter alat yang akan diambil skemanya.

TransferRule

Aturan untuk mentransfer ke agen tertentu.

Kolom
child_agent	string Wajib. Nama resource agen turunan tempat aturan diterapkan. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
direction	TransferRule.Direction Wajib. Arah transfer.
Kolom union rule_type. Jenis aturan. rule_type hanya ada berupa salah satu diantara berikut:
deterministic_transfer	TransferRule.DeterministicTransfer Opsional. Aturan yang segera ditransfer ke agen target saat kondisi terpenuhi.
disable_planner_transfer	TransferRule.DisablePlannerTransfer Opsional. Aturan yang mencegah perencana berpindah ke agen target.

DeterministicTransfer

Aturan transfer deterministik. Saat kondisi bernilai benar, transfer akan terjadi.

Kolom
Kolom union condition_type. Kondisi yang akan dievaluasi. condition_type hanya ada berupa salah satu diantara berikut:
expression_condition	ExpressionCondition Opsional. Aturan yang mengevaluasi kondisi status sesi. Jika kondisi bernilai benar, transfer akan terjadi.
python_code_condition	PythonCodeCondition Opsional. Aturan yang menggunakan blok kode Python untuk mengevaluasi kondisi. Jika kondisi bernilai benar, transfer akan terjadi.

Arah

Arah transfer.

Enum
DIRECTION_UNSPECIFIED	Arah tidak ditentukan.
PARENT_TO_CHILD	Transfer dari agen induk ke agen turunan.
CHILD_TO_PARENT	Transfer dari agen anak ke agen induk.

DisablePlannerTransfer

Aturan yang mencegah perencana mentransfer ke agen target.

Kolom
expression_condition	ExpressionCondition Wajib. Jika kondisi bernilai benar, perencana tidak akan diizinkan untuk ditransfer ke agen target.

TriggerAction

Tindakan yang dilakukan saat prasyarat tertentu terpenuhi.

Kolom
Kolom union action. Tindakan yang harus dilakukan. action hanya ada berupa salah satu diantara berikut:
respond_immediately	TriggerAction.RespondImmediately Opsional. Segera merespons dengan respons yang telah dikonfigurasi sebelumnya.
transfer_agent	TriggerAction.TransferAgent Opsional. Mentransfer percakapan ke agen lain.
generative_answer	TriggerAction.GenerativeAnswer Opsional. Menanggapi dengan jawaban generatif.

GenerativeAnswer

Agen akan langsung merespons dengan jawaban generatif.

Kolom
prompt	string Wajib. Perintah yang akan digunakan untuk jawaban generatif.

RespondImmediately

Agen akan segera merespons dengan respons yang telah dikonfigurasi sebelumnya.

Kolom
responses[]	TriggerAction.Response Wajib. Respons standar yang dapat dipilih agen. Respons dipilih secara acak.

Respons

Mewakili respons dari agen.

Kolom
text	string Wajib. Teks yang akan digunakan agen untuk merespons.
disabled	bool Opsional. Apakah respons dinonaktifkan. Respons yang dinonaktifkan tidak digunakan oleh agen.

TransferAgent

Agen akan mengalihkan percakapan ke agen lain.

Kolom
agent	string Wajib. Nama agen yang akan menerima transfer percakapan. Agen harus berada di aplikasi yang sama dengan agen saat ini. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}

UpdateAgentRequest

Pesan permintaan untuk AgentService.UpdateAgent.

Kolom
agent	Agent Wajib. Agen yang akan diperbarui.
update_mask	FieldMask Opsional. Mask kolom digunakan untuk mengontrol kolom mana yang diperbarui. Jika mask tidak ada, semua kolom akan diperbarui.

UpdateAppRequest

Pesan permintaan untuk AgentService.UpdateApp.

Kolom
app	App Wajib. Aplikasi yang akan diupdate.
update_mask	FieldMask Opsional. Mask kolom digunakan untuk mengontrol kolom mana yang diperbarui. Jika mask tidak ada, semua kolom akan diperbarui.

UpdateAppVersionRequest

Pesan permintaan untuk AgentService.UpdateAppVersion.

Kolom
app_version	AppVersion Wajib. Versi aplikasi yang akan diupdate.
update_mask	FieldMask Opsional. Daftar kolom yang akan diperbarui. Jika kosong, kolom display_name dan description akan diperbarui.

UpdateDeploymentRequest

Pesan permintaan untuk AgentService.UpdateDeployment.

Kolom
deployment	Deployment Wajib. Deployment yang akan diperbarui.
update_mask	FieldMask Opsional. Daftar kolom yang akan diperbarui.

UpdateExampleRequest

Pesan permintaan untuk AgentService.UpdateExample.

Kolom
example	Example Wajib. Contoh yang akan diperbarui.
update_mask	FieldMask Opsional. Mask kolom digunakan untuk mengontrol kolom mana yang diperbarui. Jika mask tidak ada, semua kolom akan diperbarui.

UpdateGuardrailRequest

Pesan permintaan untuk AgentService.UpdateGuardrail.

Kolom
guardrail	Guardrail Wajib. Pembatasan yang akan diperbarui.
update_mask	FieldMask Opsional. Mask kolom digunakan untuk mengontrol kolom mana yang diperbarui. Jika mask tidak ada, semua kolom akan diperbarui.

UpdateToolRequest

Pesan permintaan untuk AgentService.UpdateTool.

Kolom
tool	Tool Wajib. Alat yang akan diupdate.
update_mask	FieldMask Opsional. Mask kolom digunakan untuk mengontrol kolom mana yang diperbarui. Jika mask tidak ada, semua kolom akan diperbarui.

UpdateToolsetRequest

Pesan permintaan untuk AgentService.UpdateToolset.

Kolom
toolset	Toolset Wajib. Kumpulan alat yang akan diupdate.
update_mask	FieldMask Opsional. Mask kolom digunakan untuk mengontrol kolom mana yang diperbarui. Jika mask tidak ada, semua kolom akan diperbarui.

VpcScSettings

Setelan VPC-SC untuk aplikasi.

Kolom
allowed_origins[]	string Opsional. Asal HTTP(s) yang diizinkan yang dapat dipanggil langsung oleh alat OpenAPI di Aplikasi saat Kontrol Layanan VPC diaktifkan. String ini harus sama persis dengan asal, termasuk port jika ditentukan. Misalnya, "https://example.com" atau "https://example.com:443". Daftar ini belum berlaku untuk alat Python yang dapat melakukan panggilan HTTP langsung.

WebSearchQuery

Menampilkan satu kueri penelusuran web dan URI penelusuran terkaitnya.

Kolom
query	string Teks kueri penelusuran.
uri	string URI ke halaman hasil penelusuran Google untuk kueri.

WhatsAppCredentials

Kredensial Meta sementara untuk integrasi native WhatsApp.

Kolom
auth_code	string Wajib. Kode autentikasi Meta yang disediakan oleh alur pendaftaran tersemat.
pin	string Wajib. PIN 6 digit yang dibuat oleh pengguna untuk verifikasi dua langkah.
phone_number	string Wajib. Nomor telepon yang akan didaftarkan dengan WhatsApp.
business_account_id	string Wajib. ID Akun Bisnis yang akan digunakan untuk nomor telepon.
waba_id	string Wajib. ID Akun WhatsApp Business.
conversation_profile_id	string Opsional. ID Profil Percakapan yang akan digunakan untuk deployment.

WidgetTool

Mewakili alat widget yang dapat dipanggil oleh agen. Saat alat dipilih oleh agen, agen akan mengembalikan widget ke klien. Klien bertanggung jawab untuk memproses widget dan membuat kueri pengguna berikutnya untuk melanjutkan interaksi dengan agen.

Kolom
name	string Wajib. Nama tampilan alat widget.
description	string Opsional. Deskripsi alat widget.
widget_type	WidgetTool.WidgetType Opsional. Jenis alat widget. Jika tidak ditentukan, jenis defaultnya adalah CUSTOMIZED.
ui_config	Struct Opsional. Konfigurasi untuk merender widget.
data_mapping	WidgetTool.DataMapping Opsional. Pemetaan yang menentukan cara data dari alat sumber dipetakan ke parameter input widget.
text_response_config	WidgetTool.TextResponseConfig Opsional. Konfigurasi untuk respons teks yang selalu disertakan.
Kolom union input. Input alat widget. input hanya ada berupa salah satu diantara berikut:
parameters	Schema Opsional. Parameter input alat widget.

DataMapping

Konfigurasi untuk memetakan data dari alat sumber ke parameter input widget.

Kolom
source_tool_name	string Opsional. Nama resource alat yang menyediakan data untuk widget (misalnya, alat penelusuran atau fungsi kustom). Format: projects/{project}/locations/{location}/agents/{agent}/tools/{tool}
field_mappings	map<string, string> Opsional. Peta kolom parameter input widget ke kolom output yang sesuai dari alat sumber.
python_function	PythonFunction Opsional. Konfigurasi untuk fungsi Python yang digunakan untuk mengubah output alat sumber ke dalam format input widget.
mode	WidgetTool.DataMapping.Mode Opsional. Mode pemetaan data.
python_script (deprecated)	string Item ini tidak digunakan lagi. Tidak digunakan lagi: Gunakan python_function sebagai gantinya.

Mode

Strategi yang digunakan untuk memetakan data dari alat sumber ke widget.

Enum
MODE_UNSPECIFIED	Mode tidak ditentukan.
FIELD_MAPPING	Gunakan peta field_mappings untuk transformasi data.
PYTHON_SCRIPT	Gunakan python_script untuk transformasi data.

TextResponseConfig

Konfigurasi untuk respons teks yang ditampilkan dengan widget.

Kolom
type	WidgetTool.TextResponseConfig.Type Opsional. Strategi untuk memberikan respons teks.
static_text	string Opsional. Respons teks statis yang akan ditampilkan saat jenisnya adalah STATIC.
text_response_instruction	string Opsional. Petunjuk untuk LLM tentang cara menghasilkan respons teks. Digunakan sebagai deskripsi untuk parameter respons teks jika jenisnya adalah LLM_GENERATED.

Jenis

Menentukan cara respons teks dibuat.

Enum
TYPE_UNSPECIFIED	Jenis tidak ditentukan.
NONE	LLM secara dinamis memutuskan apakah akan menghasilkan respons teks bersama widget berdasarkan konteks percakapan.
LLM_GENERATED	LLM secara eksplisit diwajibkan untuk menghasilkan respons teks.
STATIC	Respons teks statis yang telah ditentukan sebelumnya selalu digunakan.

WidgetType

Semua jenis widget yang tersedia. Nilai baru dapat ditambahkan ke enum ini pada masa mendatang.

Enum
WIDGET_TYPE_UNSPECIFIED	Jenis widget tidak ditentukan.
CUSTOM	Jenis widget kustom.
PRODUCT_CAROUSEL	Widget carousel produk.
PRODUCT_DETAILS	Widget detail produk.
QUICK_ACTIONS	Widget tindakan cepat.
PRODUCT_COMPARISON	Widget perbandingan produk.
ADVANCED_PRODUCT_DETAILS	Widget detail produk lanjutan.
SHORT_FORM	Widget formulir singkat.
OVERALL_SATISFACTION	Widget kepuasan secara keseluruhan.
ORDER_SUMMARY	Widget ringkasan pesanan.
APPOINTMENT_DETAILS	Widget detail janji temu.
APPOINTMENT_SCHEDULER	Widget penjadwal janji temu.
CONTACT_FORM	Widget formulir kontak.