Package google.cloud.ces.v1beta

インデックス

• AgentService（インターフェース）
• EvaluationService（インターフェース）
• SessionService（インターフェース）
• ToolService（インターフェース）
• WidgetService（インターフェース）
• Action（メッセージ）
• Action.EntityOperation（メッセージ）
• Action.EntityOperation.OperationType（列挙型）
• Agent（メッセージ）
• Agent.AgentToolset（メッセージ）
• Agent.LlmAgent（メッセージ）
• Agent.RemoteA2aAgent（メッセージ）
• Agent.RemoteDialogflowAgent（メッセージ）
• AgentCard（メッセージ）
• AgentInterface（メッセージ）
• AgentRegistryDeployment（メッセージ）
• AgentSkill（メッセージ）
• AgentTool（メッセージ）
• AgentTransfer（メッセージ）
• AggregatedMetrics（メッセージ）
• AggregatedMetrics.HallucinationMetrics（メッセージ）
• AggregatedMetrics.MetricsByAppVersion（メッセージ）
• AggregatedMetrics.MetricsByTurn（メッセージ）
• AggregatedMetrics.SemanticSimilarityMetrics（メッセージ）
• AggregatedMetrics.ToolCallLatencyMetrics（メッセージ）
• AggregatedMetrics.ToolMetrics（メッセージ）
• AggregatedMetrics.TurnLatencyMetrics（メッセージ）
• AmbientSoundConfig（メッセージ）
• AmbientSoundConfig.PrebuiltAmbientNoise（列挙型）
• ApiAuthentication（メッセージ）
• ApiKeyConfig（メッセージ）
• ApiKeyConfig.RequestLocation（列挙型）
• App（メッセージ）
• App.ToolExecutionMode（列挙型）
• App.VariableDeclaration（メッセージ）
• AppSnapshot（メッセージ）
• AppVersion（メッセージ）
• AudioEncoding（列挙型）
• AudioProcessingConfig（メッセージ）
• AudioRecordingConfig（メッセージ）
• BargeInConfig（メッセージ）
• BatchDeleteConversationsRequest（メッセージ）
• BatchDeleteConversationsResponse（メッセージ）
• BearerTokenConfig（メッセージ）
• BidiSessionClientMessage（メッセージ）
• BidiSessionServerMessage（メッセージ）
• BigQueryExportSettings（メッセージ）
• Blob（メッセージ）
• Callback（メッセージ）
• Changelog（メッセージ）
• ChannelProfile（メッセージ）
• ChannelProfile.ChannelType（列挙型）
• ChannelProfile.InstagramConfig（メッセージ）
• ChannelProfile.PersonaProperty（メッセージ）
• ChannelProfile.PersonaProperty.Persona（列挙型）
• ChannelProfile.WebWidgetConfig（メッセージ）
• ChannelProfile.WebWidgetConfig.Modality（列挙型）
• ChannelProfile.WebWidgetConfig.SecuritySettings（メッセージ）
• ChannelProfile.WebWidgetConfig.Theme（列挙型）
• ChannelProfile.WhatsAppConfig（メッセージ）
• Chunk（メッセージ）
• Citations（メッセージ）
• Citations.CitedChunk（メッセージ）
• Citations.InlineCitation（メッセージ）
• ClientCertificateSettings（メッセージ）
• ClientFunction（メッセージ）
• CloudLoggingSettings（メッセージ）
• CodeBlock（メッセージ）
• ConnectorTool（メッセージ）
• ConnectorToolset（メッセージ）
• Conversation（メッセージ）
• Conversation.ChannelType（列挙型）
• Conversation.InputType（列挙型）
• Conversation.Source（列挙型）
• Conversation.Turn（メッセージ）
• ConversationLoggingSettings（メッセージ）
• CreateAgentRequest（メッセージ）
• CreateAppRequest（メッセージ）
• CreateAppVersionRequest（メッセージ）
• CreateDeploymentRequest（メッセージ）
• CreateEvaluationDatasetRequest（メッセージ）
• CreateEvaluationExpectationRequest（メッセージ）
• CreateEvaluationRequest（メッセージ）
• CreateExampleRequest（メッセージ）
• CreateGuardrailRequest（メッセージ）
• CreateScheduledEvaluationRunRequest（メッセージ）
• CreateToolRequest（メッセージ）
• CreateToolsetRequest（メッセージ）
• CustomVoiceSample（メッセージ）
• CustomVoiceSample.VoiceInstructionMode（列挙型）
• CustomVoiceSample.Warning（メッセージ）
• CustomVoiceSample.Warning.WarningType（列挙型）
• DashboardSettings（メッセージ）
• DataStore（メッセージ）
• DataStore.ConnectorConfig（メッセージ）
• DataStore.DataStoreType（列挙型）
• DataStore.DocumentProcessingMode（列挙型）
• DataStoreSettings（メッセージ）
• DataStoreSettings.Engine（メッセージ）
• DataStoreSettings.Engine.Type（列挙型）
• DataStoreTool（メッセージ）
• DataStoreTool.BoostSpec（メッセージ）
• DataStoreTool.BoostSpec.ConditionBoostSpec（メッセージ）
• DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec（メッセージ）
• DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType（列挙型）
• DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint（メッセージ）
• DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.InterpolationType（列挙型）
• DataStoreTool.BoostSpecs（メッセージ）
• DataStoreTool.DataStoreSource（メッセージ）
• DataStoreTool.EngineSource（メッセージ）
• DataStoreTool.FilterParameterBehavior（列挙型）
• DataStoreTool.GroundingConfig（メッセージ）
• DataStoreTool.ModalityConfig（メッセージ）
• DataStoreTool.ModalityConfig.ModalityType（列挙型）
• DataStoreTool.RewriterConfig（メッセージ）
• DataStoreTool.SnippetsConfig（メッセージ）
• DataStoreTool.SummarizationConfig（メッセージ）
• DeleteAgentRequest（メッセージ）
• DeleteAppRequest（メッセージ）
• DeleteAppVersionRequest（メッセージ）
• DeleteConversationRequest（メッセージ）
• DeleteDeploymentRequest（メッセージ）
• DeleteEvaluationDatasetRequest（メッセージ）
• DeleteEvaluationExpectationRequest（メッセージ）
• DeleteEvaluationRequest（メッセージ）
• DeleteEvaluationResultRequest（メッセージ）
• DeleteEvaluationRunOperationMetadata（メッセージ）
• DeleteEvaluationRunRequest（メッセージ）
• DeleteExampleRequest（メッセージ）
• DeleteGuardrailRequest（メッセージ）
• DeleteScheduledEvaluationRunRequest（メッセージ）
• DeleteToolRequest（メッセージ）
• DeleteToolsetRequest（メッセージ）
• DeployChannelResponse（メッセージ）
• Deployment（メッセージ）
• Deployment.Modality（列挙型）
• EndSession（メッセージ）
• EndUserAuthConfig（メッセージ）
• EndUserAuthConfig.Oauth2AuthCodeConfig（メッセージ）
• EndUserAuthConfig.Oauth2JwtBearerConfig（メッセージ）
• EndpointControlPolicy（メッセージ）
• EndpointControlPolicy.EnforcementScope（列挙型）
• ErrorHandlingSettings（メッセージ）
• ErrorHandlingSettings.EndSessionConfig（メッセージ）
• ErrorHandlingSettings.ErrorHandlingStrategy（列挙型）
• ErrorHandlingSettings.FallbackResponseConfig（メッセージ）
• Evaluation（メッセージ）
• Evaluation.Golden（メッセージ）
• Evaluation.GoldenExpectation（メッセージ）
• Evaluation.GoldenTurn（メッセージ）
• Evaluation.Scenario（メッセージ）
• Evaluation.Scenario.TaskCompletionBehavior（列挙型）
• Evaluation.Scenario.UserFact（メッセージ）
• Evaluation.Scenario.UserGoalBehavior（列挙型）
• Evaluation.ScenarioExpectation（メッセージ）
• Evaluation.ScenarioExpectation.ToolExpectation（メッセージ）
• Evaluation.Step（メッセージ）
• EvaluationConfig（メッセージ）
• EvaluationConfig.EvaluationChannel（列挙型）
• EvaluationDataset（メッセージ）
• EvaluationErrorInfo（メッセージ）
• EvaluationErrorInfo.ErrorType（列挙型）
• EvaluationExpectation（メッセージ）
• EvaluationExpectation.LlmCriteria（メッセージ）
• EvaluationMetricsConfig（メッセージ）
• EvaluationMetricsConfig.ComparisonType（列挙型）
• EvaluationMetricsConfig.ExpectationsMetMetricsConfig（メッセージ）
• EvaluationMetricsConfig.GoldenMetricsConfig（メッセージ）
• EvaluationMetricsConfig.HallucinationMetricsConfig（メッセージ）
• EvaluationMetricsConfig.ScenarioMetricsConfig（メッセージ）
• EvaluationMetricsConfig.SemanticSimilarityMetricsConfig（メッセージ）
• EvaluationMetricsConfig.ToolCorrectnessMetricsConfig（メッセージ）
• EvaluationMetricsConfig.UserGoalMetMetricsConfig（メッセージ）
• EvaluationMetricsThresholds（メッセージ）
• EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds（メッセージ）
• EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.ExpectationLevelMetricsThresholds（メッセージ）
• EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds（メッセージ）
• EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds.SemanticSimilarityChannel（列挙型）
• EvaluationMetricsThresholds.HallucinationMetricBehavior（列挙型）
• EvaluationMetricsThresholds.ToolMatchingSettings（メッセージ）
• EvaluationMetricsThresholds.ToolMatchingSettings.ExtraToolCallBehavior（列挙型）
• EvaluationPersona（メッセージ）
• EvaluationPersona.SpeechConfig（メッセージ）
• EvaluationPersona.SpeechConfig.BackgroundEnvironment（列挙型）
• EvaluationResult（メッセージ）
• EvaluationResult.EvaluationExpectationResult（メッセージ）
• EvaluationResult.ExecutionState（列挙型）
• EvaluationResult.GoldenExpectationOutcome（メッセージ）
• EvaluationResult.GoldenExpectationOutcome.ToolInvocationResult（メッセージ）
• EvaluationResult.GoldenResult（メッセージ）
• EvaluationResult.GoldenResult.TurnReplayResult（メッセージ）
• EvaluationResult.HallucinationResult（メッセージ）
• EvaluationResult.Outcome（列挙型）
• EvaluationResult.OutcomeMetadata（列挙型）
• EvaluationResult.OverallToolInvocationResult（メッセージ）
• EvaluationResult.ScenarioExpectationOutcome（メッセージ）
• EvaluationResult.ScenarioExpectationOutcome.ObservedToolCall（メッセージ）
• EvaluationResult.ScenarioResult（メッセージ）
• EvaluationResult.ScenarioRubricOutcome（メッセージ）
• EvaluationResult.SemanticSimilarityResult（メッセージ）
• EvaluationResult.SpanLatency（メッセージ）
• EvaluationResult.SpanLatency.Type（列挙型）
• EvaluationResult.TaskCompletionResult（メッセージ）
• EvaluationResult.ToolCallLatency（メッセージ）
• EvaluationResult.UserGoalSatisfactionResult（メッセージ）
• EvaluationRun（メッセージ）
• EvaluationRun.EvaluationRunState（列挙型）
• EvaluationRun.EvaluationRunSummary（メッセージ）
• EvaluationRun.EvaluationType（列挙型）
• EvaluationRun.Progress（メッセージ）
• EvaluationRunCachingSettings（メッセージ）
• EvaluationRunCachingSettings.EvaluationRunCachingMode（列挙型）
• EvaluationSettings（メッセージ）
• EvaluationSettings.ScenarioConversationInitiator（列挙型）
• EvaluationSettings.ScenarioExecutionMode（列挙型）
• EvaluationToolCallBehaviour（列挙型）
• Event（メッセージ）
• Example（メッセージ）
• ExecuteToolRequest（メッセージ）
• ExecuteToolResponse（メッセージ）
• ExecutionType（列挙型）
• ExperimentConfig（メッセージ）
• ExperimentConfig.State（列挙型）
• ExperimentConfig.VersionRelease（メッセージ）
• ExperimentConfig.VersionRelease.TrafficAllocation（メッセージ）
• ExportAppRequest（メッセージ）
• ExportAppRequest.ExportFormat（列挙型）
• ExportAppResponse（メッセージ）
• ExportEvaluationResultsOperationMetadata（メッセージ）
• ExportEvaluationResultsRequest（メッセージ）
• ExportEvaluationResultsResponse（メッセージ）
• ExportEvaluationRunsOperationMetadata（メッセージ）
• ExportEvaluationRunsRequest（メッセージ）
• ExportEvaluationRunsResponse（メッセージ）
• ExportEvaluationsRequest（メッセージ）
• ExportEvaluationsResponse（メッセージ）
• ExportOptions（メッセージ）
• ExportOptions.ExportFormat（列挙型）
• ExpressionCondition（メッセージ）
• FileContext（メッセージ）
• FileContext.FileBytes（メッセージ）
• FileSearchTool（メッセージ）
• FileSearchTool.CorpusType（列挙型）
• GenerateAppResourceOperationMetadata（メッセージ）
• GenerateAppResourceOperationMetadata.GenerationType（列挙型）
• GenerateAppResourceRequest（メッセージ）
• GenerateAppResourceRequest.AppGenerationConfig（メッセージ）
• GenerateAppResourceRequest.AppVersionContext（メッセージ）
• GenerateAppResourceRequest.EvaluationGenerationConfig（メッセージ）
• GenerateAppResourceRequest.EvaluationPersonasGenerationConfig（メッセージ）
• GenerateAppResourceRequest.HillClimbingFixConfig（メッセージ）
• GenerateAppResourceRequest.QualityReportGenerationConfig（メッセージ）
• GenerateAppResourceRequest.QualityReportGenerationConfig.LossAttributionAlgorithm（列挙型）
• GenerateAppResourceRequest.RefineInstructions（メッセージ）
• GenerateAppResourceRequest.ToolGenerationConfig（メッセージ）
• GenerateAppResourceRequest.ToolGenerationConfig.OpenApiToolsetGenerationConfig（メッセージ）
• GenerateAppResourceRequest.ToolGenerationConfig.OpenApiToolsetGenerationConfig.OperationGenerationConfig（メッセージ）
• GenerateAppResourceResponse（メッセージ）
• GenerateAppResourceResponse.AppResources（メッセージ）
• GenerateAppResourceResponse.Evaluations（メッセージ）
• GenerateAppResourceResponse.GenerateResultInfo（メッセージ）
• GenerateAppResourceResponse.Tools（メッセージ）
• GenerateChatTokenRequest（メッセージ）
• GenerateChatTokenResponse（メッセージ）
• GenerateEvaluationOperationMetadata（メッセージ）
• GenerateEvaluationRequest（メッセージ）
• GenerateEvaluationRequest.EvaluationType（列挙型）
• GetAgentRequest（メッセージ）
• GetAppRequest（メッセージ）
• GetAppVersionRequest（メッセージ）
• GetChangelogRequest（メッセージ）
• GetConversationRequest（メッセージ）
• GetDeploymentRequest（メッセージ）
• GetEvaluationDatasetRequest（メッセージ）
• GetEvaluationExpectationRequest（メッセージ）
• GetEvaluationRequest（メッセージ）
• GetEvaluationResultRequest（メッセージ）
• GetEvaluationRunRequest（メッセージ）
• GetExampleRequest（メッセージ）
• GetGuardrailRequest（メッセージ）
• GetScheduledEvaluationRunRequest（メッセージ）
• GetSecuritySettingsRequest（メッセージ）
• GetToolRequest（メッセージ）
• GetToolsetRequest（メッセージ）
• GoAway（メッセージ）
• GoldenRunMethod（列挙型）
• GoogleSearchSuggestions（メッセージ）
• GoogleSearchTool（メッセージ）
• GoogleSearchTool.PromptConfig（メッセージ）
• Guardrail（メッセージ）
• Guardrail.CodeCallback（メッセージ）
• Guardrail.ContentFilter（メッセージ）
• Guardrail.ContentFilter.MatchType（列挙型）
• Guardrail.LlmPolicy（メッセージ）
• Guardrail.LlmPolicy.PolicyScope（列挙型）
• Guardrail.LlmPromptSecurity（メッセージ）
• Guardrail.LlmPromptSecurity.DefaultSecuritySettings（メッセージ）
• Guardrail.ModelSafety（メッセージ）
• Guardrail.ModelSafety.HarmBlockThreshold（列挙型）
• Guardrail.ModelSafety.HarmCategory（列挙型）
• Guardrail.ModelSafety.SafetySetting（メッセージ）
• Guardrail.Supervisor（メッセージ）
• Guardrail.Supervisor.DetectionMode（列挙型）
• Guardrail.Supervisor.Type（列挙型）
• Image（メッセージ）
• ImportAppRequest（メッセージ）
• ImportAppRequest.ImportOptions（メッセージ）
• ImportAppRequest.ImportOptions.ConflictResolutionStrategy（列挙型）
• ImportAppResponse（メッセージ）
• ImportEvaluationsOperationMetadata（メッセージ）
• ImportEvaluationsRequest（メッセージ）
• ImportEvaluationsRequest.ConversationList（メッセージ）
• ImportEvaluationsRequest.ImportOptions（メッセージ）
• ImportEvaluationsRequest.ImportOptions.ConflictResolutionStrategy（列挙型）
• ImportEvaluationsResponse（メッセージ）
• InputAudioConfig（メッセージ）
• InstagramCredentials（メッセージ）
• InterruptionSignal（メッセージ）
• LanguageSettings（メッセージ）
• LatencyReport（メッセージ）
• LatencyReport.CallbackLatency（メッセージ）
• LatencyReport.GuardrailLatency（メッセージ）
• LatencyReport.LatencyMetrics（メッセージ）
• LatencyReport.LlmCallLatency（メッセージ）
• LatencyReport.ToolLatency（メッセージ）
• ListAgentsRequest（メッセージ）
• ListAgentsResponse（メッセージ）
• ListAppVersionsRequest（メッセージ）
• ListAppVersionsResponse（メッセージ）
• ListAppsRequest（メッセージ）
• ListAppsResponse（メッセージ）
• ListChangelogsRequest（メッセージ）
• ListChangelogsResponse（メッセージ）
• ListConversationsRequest（メッセージ）
• ListConversationsResponse（メッセージ）
• ListDeploymentsRequest（メッセージ）
• ListDeploymentsResponse（メッセージ）
• ListEvaluationDatasetsRequest（メッセージ）
• ListEvaluationDatasetsResponse（メッセージ）
• ListEvaluationExpectationsRequest（メッセージ）
• ListEvaluationExpectationsResponse（メッセージ）
• ListEvaluationResultsRequest（メッセージ）
• ListEvaluationResultsResponse（メッセージ）
• ListEvaluationRunsRequest（メッセージ）
• ListEvaluationRunsResponse（メッセージ）
• ListEvaluationsRequest（メッセージ）
• ListEvaluationsResponse（メッセージ）
• ListExamplesRequest（メッセージ）
• ListExamplesResponse（メッセージ）
• ListGuardrailsRequest（メッセージ）
• ListGuardrailsResponse（メッセージ）
• ListScheduledEvaluationRunsRequest（メッセージ）
• ListScheduledEvaluationRunsResponse（メッセージ）
• ListToolsRequest（メッセージ）
• ListToolsResponse（メッセージ）
• ListToolsetsRequest（メッセージ）
• ListToolsetsResponse（メッセージ）
• LoggingSettings（メッセージ）
• McpTool（メッセージ）
• McpTool.State（列挙型）
• McpToolDefinition（メッセージ）
• McpToolOverride（メッセージ）
• McpToolset（メッセージ）
• Message（メッセージ）
• MetricAnalysisSettings（メッセージ）
• MockConfig（メッセージ）
• MockConfig.UnmatchedToolCallBehavior（列挙型）
• MockedToolCall（メッセージ）
• ModelSettings（メッセージ）
• ModelSettings.ThinkingLevel（列挙型）
• OAuthConfig（メッセージ）
• OAuthConfig.OauthGrantType（列挙型）
• OpenApiTool（メッセージ）
• OpenApiToolset（メッセージ）
• OperationMetadata（メッセージ）
• OptimizationConfig（メッセージ）
• OptimizationConfig.OptimizationStatus（列挙型）
• OutputAudioConfig（メッセージ）
• PersonaRunConfig（メッセージ）
• PythonCodeCondition（メッセージ）
• PythonFunction（メッセージ）
• QualityReport（メッセージ）
• QualityReport.AgentIssues（メッセージ）
• QualityReport.Issue（メッセージ）
• RecognitionResult（メッセージ）
• RedactionConfig（メッセージ）
• RemoteA2aConfig（メッセージ）
• RemoteAgentTool（メッセージ）
• RestoreAppVersionRequest（メッセージ）
• RestoreAppVersionResponse（メッセージ）
• RetrieveToolSchemaRequest（メッセージ）
• RetrieveToolSchemaResponse（メッセージ）
• RetrieveToolsRequest（メッセージ）
• RetrieveToolsResponse（メッセージ）
• RunEvaluationOperationMetadata（メッセージ）
• RunEvaluationRequest（メッセージ）
• RunEvaluationResponse（メッセージ）
• RunEvaluationResultMetricsOperationMetadata（メッセージ）
• RunEvaluationResultMetricsRequest（メッセージ）
• RunEvaluationResultMetricsResponse（メッセージ）
• RunSessionRequest（メッセージ）
• RunSessionResponse（メッセージ）
• ScheduledEvaluationRun（メッセージ）
• ScheduledEvaluationRun.SchedulingConfig（メッセージ）
• ScheduledEvaluationRun.SchedulingConfig.Frequency（列挙型）
• Schema（メッセージ）
• Schema.Type（列挙型）
• SecuritySettings（メッセージ）
• ServiceAccountAuthConfig（メッセージ）
• ServiceAgentIdTokenAuthConfig（メッセージ）
• ServiceDirectoryConfig（メッセージ）
• SessionConfig（メッセージ）
• SessionConfig.RemoteDialogflowQueryParameters（メッセージ）
• SessionInput（メッセージ）
• SessionOutput（メッセージ）
• SessionOutput.DiagnosticInfo（メッセージ）
• Span（メッセージ）
• SynthesizeSpeechConfig（メッセージ）
• SystemTool（メッセージ）
• TestPersonaVoiceRequest（メッセージ）
• TestPersonaVoiceResponse（メッセージ）
• TimeZoneSettings（メッセージ）
• TlsConfig（メッセージ）
• TlsConfig.CaCert（メッセージ）
• Tool（メッセージ）
• ToolCall（メッセージ）
• ToolCalls（メッセージ）
• ToolFakeConfig（メッセージ）
• ToolResponse（メッセージ）
• ToolResponses（メッセージ）
• Toolset（メッセージ）
• ToolsetTool（メッセージ）
• TransferRule（メッセージ）
• TransferRule.DeterministicTransfer（メッセージ）
• TransferRule.Direction（列挙型）
• TransferRule.DisablePlannerTransfer（メッセージ）
• TriggerAction（メッセージ）
• TriggerAction.GenerativeAnswer（メッセージ）
• TriggerAction.RespondImmediately（メッセージ）
• TriggerAction.Response（メッセージ）
• TriggerAction.TransferAgent（メッセージ）
• UpdateAgentRequest（メッセージ）
• UpdateAppRequest（メッセージ）
• UpdateAppVersionRequest（メッセージ）
• UpdateDeploymentRequest（メッセージ）
• UpdateEvaluationDatasetRequest（メッセージ）
• UpdateEvaluationExpectationRequest（メッセージ）
• UpdateEvaluationRequest（メッセージ）
• UpdateExampleRequest（メッセージ）
• UpdateGuardrailRequest（メッセージ）
• UpdateScheduledEvaluationRunRequest（メッセージ）
• UpdateSecuritySettingsRequest（メッセージ）
• UpdateToolRequest（メッセージ）
• UpdateToolsetRequest（メッセージ）
• UploadEvaluationAudioRequest（メッセージ）
• UploadEvaluationAudioResponse（メッセージ）
• VpcScSettings（メッセージ）
• WebSearchQuery（メッセージ）
• WhatsAppCredentials（メッセージ）
• WidgetTool（メッセージ）
• WidgetTool.DataMapping（メッセージ）
• WidgetTool.DataMapping.Mode（列挙型）
• WidgetTool.TextResponseConfig（メッセージ）
• WidgetTool.TextResponseConfig.Type（列挙型）
• WidgetTool.WidgetType（列挙型）

AgentService

Gemini Enterprise for Customer Engagement（CES）でエージェント関連のリソースを管理するサービス。

BatchDeleteConversations
rpc BatchDeleteConversations(BatchDeleteConversationsRequest) returns (Operation) 指定された会話を一括削除します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 parent リソースに対する次の IAM 権限が必要です。 ces.conversations.delete 詳細については、IAM のドキュメントをご覧ください。

CreateAgent
rpc CreateAgent(CreateAgentRequest) returns (Agent) 指定されたアプリに新しいエージェントを作成します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 parent リソースに対する次の IAM 権限が必要です。 ces.agents.create 詳細については、IAM のドキュメントをご覧ください。

CreateApp
rpc CreateApp(CreateAppRequest) returns (Operation) 指定されたプロジェクトとロケーションに新しいアプリを作成します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 parent リソースに対する次の IAM 権限が必要です。 ces.apps.create 詳細については、IAM のドキュメントをご覧ください。

CreateAppVersion
rpc CreateAppVersion(CreateAppVersionRequest) returns (AppVersion) 指定されたアプリに新しいアプリ バージョンを作成します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 parent リソースに対する次の IAM 権限が必要です。 ces.appVersions.create 詳細については、IAM のドキュメントをご覧ください。

CreateDeployment
rpc CreateDeployment(CreateDeploymentRequest) returns (Deployment) 指定されたアプリに新しいデプロイを作成します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 parent リソースに対する次の IAM 権限が必要です。 ces.deployments.create 詳細については、IAM のドキュメントをご覧ください。

CreateExample
rpc CreateExample(CreateExampleRequest) returns (Example) 指定されたアプリに新しい例を作成します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 parent リソースに対する次の IAM 権限が必要です。 ces.examples.create 詳細については、IAM のドキュメントをご覧ください。

CreateGuardrail
rpc CreateGuardrail(CreateGuardrailRequest) returns (Guardrail) 指定されたアプリに新しいガードレールを作成します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 parent リソースに対する次の IAM 権限が必要です。 ces.guardrails.create 詳細については、IAM のドキュメントをご覧ください。

CreateTool
rpc CreateTool(CreateToolRequest) returns (Tool) 指定されたアプリに新しいツールを作成します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 parent リソースに対する次の IAM 権限が必要です。 ces.tools.create 詳細については、IAM のドキュメントをご覧ください。

CreateToolset
rpc CreateToolset(CreateToolsetRequest) returns (Toolset) 指定されたアプリに新しいツールセットを作成します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 parent リソースに対する次の IAM 権限が必要です。 ces.toolsets.create 詳細については、IAM のドキュメントをご覧ください。

DeleteAgent
rpc DeleteAgent(DeleteAgentRequest) returns (Empty) 指定されたエージェントを削除します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 ces.agents.delete 詳細については、IAM のドキュメントをご覧ください。

DeleteApp
rpc DeleteApp(DeleteAppRequest) returns (Operation) 指定されたアプリを削除します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 ces.apps.delete 詳細については、IAM のドキュメントをご覧ください。

DeleteAppVersion
rpc DeleteAppVersion(DeleteAppVersionRequest) returns (Empty) 指定されたアプリのバージョンを削除します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 ces.appVersions.delete 詳細については、IAM のドキュメントをご覧ください。

DeleteConversation
rpc DeleteConversation(DeleteConversationRequest) returns (Empty) 指定された会話を削除します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 ces.conversations.delete 詳細については、IAM のドキュメントをご覧ください。

DeleteDeployment
rpc DeleteDeployment(DeleteDeploymentRequest) returns (Empty) 指定されたデプロイを削除します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 ces.deployments.delete 詳細については、IAM のドキュメントをご覧ください。

DeleteExample
rpc DeleteExample(DeleteExampleRequest) returns (Empty) 指定された例を削除します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 ces.examples.delete 詳細については、IAM のドキュメントをご覧ください。

DeleteGuardrail
rpc DeleteGuardrail(DeleteGuardrailRequest) returns (Empty) 指定されたガードレールを削除します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 ces.guardrails.delete 詳細については、IAM のドキュメントをご覧ください。

DeleteTool
rpc DeleteTool(DeleteToolRequest) returns (Empty) 指定されたツールを削除します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 ces.tools.delete 詳細については、IAM のドキュメントをご覧ください。

DeleteToolset
rpc DeleteToolset(DeleteToolsetRequest) returns (Empty) 指定されたツールセットを削除します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 ces.toolsets.delete 詳細については、IAM のドキュメントをご覧ください。

ExportApp
rpc ExportApp(ExportAppRequest) returns (Operation) 指定されたアプリをエクスポートします。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 ces.apps.export 詳細については、IAM のドキュメントをご覧ください。

GenerateAppResource
rpc GenerateAppResource(GenerateAppResourceRequest) returns (Operation) LLM アシスタントを使用して、アプリ内の特定のリソース（エージェントなど）を生成します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 parent リソースに対する次の IAM 権限が必要です。 ces.apps.update 詳細については、IAM のドキュメントをご覧ください。

GetAgent
rpc GetAgent(GetAgentRequest) returns (Agent) 指定されたエージェントの詳細を取得します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 ces.agents.get 詳細については、IAM のドキュメントをご覧ください。

GetApp
rpc GetApp(GetAppRequest) returns (App) 指定されたアプリの詳細を取得します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 ces.apps.get 詳細については、IAM のドキュメントをご覧ください。

GetAppVersion
rpc GetAppVersion(GetAppVersionRequest) returns (AppVersion) 指定されたアプリ バージョンの詳細を取得します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 ces.appVersions.get 詳細については、IAM のドキュメントをご覧ください。

GetChangelog
rpc GetChangelog(GetChangelogRequest) returns (Changelog) 指定された変更ログを取得します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 ces.changelogs.get 詳細については、IAM のドキュメントをご覧ください。

GetConversation
rpc GetConversation(GetConversationRequest) returns (Conversation) 指定された会話の詳細を取得します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 ces.conversations.get 詳細については、IAM のドキュメントをご覧ください。

GetDeployment
rpc GetDeployment(GetDeploymentRequest) returns (Deployment) 指定されたデプロイの詳細を取得します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 ces.deployments.get 詳細については、IAM のドキュメントをご覧ください。

GetExample
rpc GetExample(GetExampleRequest) returns (Example) 指定された例の詳細を取得します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 ces.examples.get 詳細については、IAM のドキュメントをご覧ください。

GetGuardrail
rpc GetGuardrail(GetGuardrailRequest) returns (Guardrail) 指定されたガードレールの詳細を取得します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 ces.guardrails.get 詳細については、IAM のドキュメントをご覧ください。

GetSecuritySettings
rpc GetSecuritySettings(GetSecuritySettingsRequest) returns (SecuritySettings) プロジェクトとロケーションのセキュリティ設定を取得します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 ces.securitySettings.get 詳細については、IAM のドキュメントをご覧ください。

GetTool
rpc GetTool(GetToolRequest) returns (Tool) 指定されたツールの詳細を取得します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 ces.tools.get 詳細については、IAM のドキュメントをご覧ください。

GetToolset
rpc GetToolset(GetToolsetRequest) returns (Toolset) 指定されたツールセットの詳細を取得します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 ces.toolsets.get 詳細については、IAM のドキュメントをご覧ください。

ImportApp
rpc ImportApp(ImportAppRequest) returns (Operation) 指定されたアプリをインポートします。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 parent リソースに対する次の IAM 権限が必要です。 ces.apps.import 詳細については、IAM のドキュメントをご覧ください。

ListAgents
rpc ListAgents(ListAgentsRequest) returns (ListAgentsResponse) 指定されたアプリ内のエージェントを一覧表示します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 parent リソースに対する次の IAM 権限が必要です。 ces.agents.list 詳細については、IAM のドキュメントをご覧ください。

ListAppVersions
rpc ListAppVersions(ListAppVersionsRequest) returns (ListAppVersionsResponse) 指定されたアプリのすべてのアプリ バージョンを一覧表示します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 parent リソースに対する次の IAM 権限が必要です。 ces.appVersions.list 詳細については、IAM のドキュメントをご覧ください。

ListApps
rpc ListApps(ListAppsRequest) returns (ListAppsResponse) 指定されたプロジェクトとロケーションのアプリを一覧表示します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 parent リソースに対する次の IAM 権限が必要です。 ces.apps.list 詳細については、IAM のドキュメントをご覧ください。

ListChangelogs
rpc ListChangelogs(ListChangelogsRequest) returns (ListChangelogsResponse) 指定したアプリの変更ログを一覧表示します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 parent リソースに対する次の IAM 権限が必要です。 ces.changelogs.list 詳細については、IAM のドキュメントをご覧ください。

ListConversations
rpc ListConversations(ListConversationsRequest) returns (ListConversationsResponse) 指定されたアプリの会話を一覧表示します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 parent リソースに対する次の IAM 権限が必要です。 ces.conversations.list 詳細については、IAM のドキュメントをご覧ください。

ListDeployments
rpc ListDeployments(ListDeploymentsRequest) returns (ListDeploymentsResponse) 指定されたアプリのデプロイを一覧表示します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 parent リソースに対する次の IAM 権限が必要です。 ces.deployments.list 詳細については、IAM のドキュメントをご覧ください。

ListExamples
rpc ListExamples(ListExamplesRequest) returns (ListExamplesResponse) 指定されたアプリの例を一覧表示します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 parent リソースに対する次の IAM 権限が必要です。 ces.examples.list 詳細については、IAM のドキュメントをご覧ください。

ListGuardrails
rpc ListGuardrails(ListGuardrailsRequest) returns (ListGuardrailsResponse) 指定されたアプリのガードレールを一覧表示します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 parent リソースに対する次の IAM 権限が必要です。 ces.guardrails.list 詳細については、IAM のドキュメントをご覧ください。

ListTools
rpc ListTools(ListToolsRequest) returns (ListToolsResponse) 指定されたアプリ内のツールを一覧表示します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 parent リソースに対する次の IAM 権限が必要です。 ces.tools.list 詳細については、IAM のドキュメントをご覧ください。

ListToolsets
rpc ListToolsets(ListToolsetsRequest) returns (ListToolsetsResponse) 指定されたアプリのツールセットを一覧表示します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 parent リソースに対する次の IAM 権限が必要です。 ces.toolsets.list 詳細については、IAM のドキュメントをご覧ください。

RestoreAppVersion
rpc RestoreAppVersion(RestoreAppVersionRequest) returns (Operation) 指定されたアプリのバージョンを復元します。これにより、現在の下書きアプリから新しいアプリ バージョンが作成され、現在の下書きが指定されたアプリ バージョンで上書きされます。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 ces.appVersions.restore 詳細については、IAM のドキュメントをご覧ください。

UpdateAgent
rpc UpdateAgent(UpdateAgentRequest) returns (Agent) 指定されたエージェントを更新します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 ces.agents.update 詳細については、IAM のドキュメントをご覧ください。

UpdateApp
rpc UpdateApp(UpdateAppRequest) returns (App) 指定されたアプリを更新します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 ces.apps.update 詳細については、IAM のドキュメントをご覧ください。

UpdateAppVersion
rpc UpdateAppVersion(UpdateAppVersionRequest) returns (AppVersion) 指定されたアプリのバージョンを更新します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。

UpdateDeployment
rpc UpdateDeployment(UpdateDeploymentRequest) returns (Deployment) 指定されたデプロイを更新します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 ces.deployments.update 詳細については、IAM のドキュメントをご覧ください。

UpdateExample
rpc UpdateExample(UpdateExampleRequest) returns (Example) 指定された例を更新します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 ces.examples.update 詳細については、IAM のドキュメントをご覧ください。

UpdateGuardrail
rpc UpdateGuardrail(UpdateGuardrailRequest) returns (Guardrail) 指定されたガードレールを更新します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 ces.guardrails.update 詳細については、IAM のドキュメントをご覧ください。

UpdateSecuritySettings
rpc UpdateSecuritySettings(UpdateSecuritySettingsRequest) returns (SecuritySettings) プロジェクトとロケーションのセキュリティ設定を更新します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 ces.securitySettings.update 詳細については、IAM のドキュメントをご覧ください。

UpdateTool
rpc UpdateTool(UpdateToolRequest) returns (Tool) 指定されたツールを更新します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 ces.tools.update 詳細については、IAM のドキュメントをご覧ください。

UpdateToolset
rpc UpdateToolset(UpdateToolsetRequest) returns (Toolset) 指定されたツールセットを更新します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 ces.toolsets.update 詳細については、IAM のドキュメントをご覧ください。

EvaluationService

EvaluationService は、CES アプリの評価を実行するメソッドを公開します。

CreateEvaluation
rpc CreateEvaluation(CreateEvaluationRequest) returns (Evaluation) 評価を作成します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 parent リソースに対する次の IAM 権限が必要です。 ces.evaluations.create 詳細については、IAM のドキュメントをご覧ください。

CreateEvaluationDataset
rpc CreateEvaluationDataset(CreateEvaluationDatasetRequest) returns (EvaluationDataset) 評価データセットを作成します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 parent リソースに対する次の IAM 権限が必要です。 ces.evaluationDatasets.create 詳細については、IAM のドキュメントをご覧ください。

CreateEvaluationExpectation
rpc CreateEvaluationExpectation(CreateEvaluationExpectationRequest) returns (EvaluationExpectation) 評価の期待値を作成します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 parent リソースに対する次の IAM 権限が必要です。 ces.evaluationExpectations.create 詳細については、IAM のドキュメントをご覧ください。

CreateScheduledEvaluationRun
rpc CreateScheduledEvaluationRun(CreateScheduledEvaluationRunRequest) returns (ScheduledEvaluationRun) スケジュールされた評価実行を作成します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。

DeleteEvaluation
rpc DeleteEvaluation(DeleteEvaluationRequest) returns (Empty) 評価を削除します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 ces.evaluations.delete 詳細については、IAM のドキュメントをご覧ください。

DeleteEvaluationDataset
rpc DeleteEvaluationDataset(DeleteEvaluationDatasetRequest) returns (Empty) 評価データセットを削除します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 ces.evaluationDatasets.delete 詳細については、IAM のドキュメントをご覧ください。

DeleteEvaluationExpectation
rpc DeleteEvaluationExpectation(DeleteEvaluationExpectationRequest) returns (Empty) 評価の期待値を削除します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 ces.evaluationExpectations.delete 詳細については、IAM のドキュメントをご覧ください。

DeleteEvaluationResult
rpc DeleteEvaluationResult(DeleteEvaluationResultRequest) returns (Empty) 評価結果を削除します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 ces.evaluationResults.delete 詳細については、IAM のドキュメントをご覧ください。

DeleteEvaluationRun
rpc DeleteEvaluationRun(DeleteEvaluationRunRequest) returns (Operation) 評価実行を削除します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 ces.evaluationRuns.delete 詳細については、IAM のドキュメントをご覧ください。

DeleteScheduledEvaluationRun
rpc DeleteScheduledEvaluationRun(DeleteScheduledEvaluationRunRequest) returns (Empty) スケジュール設定された評価実行を削除します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。

ExportEvaluationResults
rpc ExportEvaluationResults(ExportEvaluationResultsRequest) returns (Operation) 評価結果をエクスポートします。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 parent リソースに対する次の IAM 権限が必要です。 ces.evaluations.export 詳細については、IAM のドキュメントをご覧ください。

ExportEvaluationRuns
rpc ExportEvaluationRuns(ExportEvaluationRunsRequest) returns (Operation) 評価実行をエクスポートします。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 names リソースに対する次の IAM 権限が必要です。 ces.evaluationRuns.get parent リソースに対する次の IAM 権限が必要です。 ces.evaluations.export 詳細については、IAM のドキュメントをご覧ください。

ExportEvaluations
rpc ExportEvaluations(ExportEvaluationsRequest) returns (Operation) 評価をエクスポートします。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 parent リソースに対する次の IAM 権限が必要です。 ces.evaluations.export 詳細については、IAM のドキュメントをご覧ください。

GenerateEvaluation
rpc GenerateEvaluation(GenerateEvaluationRequest) returns (Operation) 会話からゴールデン評価を作成します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 conversation リソースに対する次の IAM 権限が必要です。 ces.conversations.get 詳細については、IAM のドキュメントをご覧ください。

GetEvaluation
rpc GetEvaluation(GetEvaluationRequest) returns (Evaluation) 指定された評価の詳細を取得します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 ces.evaluations.get 詳細については、IAM のドキュメントをご覧ください。

GetEvaluationDataset
rpc GetEvaluationDataset(GetEvaluationDatasetRequest) returns (EvaluationDataset) 指定された評価データセットの詳細を取得します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 ces.evaluationDatasets.get 詳細については、IAM のドキュメントをご覧ください。

GetEvaluationExpectation
rpc GetEvaluationExpectation(GetEvaluationExpectationRequest) returns (EvaluationExpectation) 指定された評価の期待値の詳細を取得します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 ces.evaluationExpectations.get 詳細については、IAM のドキュメントをご覧ください。

GetEvaluationResult
rpc GetEvaluationResult(GetEvaluationResultRequest) returns (EvaluationResult) 指定された評価結果の詳細を取得します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 ces.evaluationResults.get 詳細については、IAM のドキュメントをご覧ください。

GetEvaluationRun
rpc GetEvaluationRun(GetEvaluationRunRequest) returns (EvaluationRun) 指定された評価実行の詳細を取得します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 ces.evaluationRuns.get 詳細については、IAM のドキュメントをご覧ください。

GetScheduledEvaluationRun
rpc GetScheduledEvaluationRun(GetScheduledEvaluationRunRequest) returns (ScheduledEvaluationRun) 指定されたスケジュールされた評価実行の詳細を取得します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。

ImportEvaluations
rpc ImportEvaluations(ImportEvaluationsRequest) returns (Operation) 評価をアプリにインポートします。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 parent リソースに対する次の IAM 権限が必要です。 ces.evaluations.create ces.evaluations.update 詳細については、IAM のドキュメントをご覧ください。

ListEvaluationDatasets
rpc ListEvaluationDatasets(ListEvaluationDatasetsRequest) returns (ListEvaluationDatasetsResponse) 指定されたアプリのすべての評価用データセットを一覧表示します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 parent リソースに対する次の IAM 権限が必要です。 ces.evaluationDatasets.list 詳細については、IAM のドキュメントをご覧ください。

ListEvaluationExpectations
rpc ListEvaluationExpectations(ListEvaluationExpectationsRequest) returns (ListEvaluationExpectationsResponse) 指定されたアプリのすべての評価の期待値を一覧表示します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 parent リソースに対する次の IAM 権限が必要です。 ces.evaluationExpectations.list 詳細については、IAM のドキュメントをご覧ください。

ListEvaluationResults
rpc ListEvaluationResults(ListEvaluationResultsRequest) returns (ListEvaluationResultsResponse) 特定の評価のすべての評価結果を一覧表示します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 parent リソースに対する次の IAM 権限が必要です。 ces.evaluationResults.list 詳細については、IAM のドキュメントをご覧ください。

ListEvaluationRuns
rpc ListEvaluationRuns(ListEvaluationRunsRequest) returns (ListEvaluationRunsResponse) 指定されたアプリのすべての評価実行を一覧表示します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 parent リソースに対する次の IAM 権限が必要です。 ces.evaluationRuns.list 詳細については、IAM のドキュメントをご覧ください。

ListEvaluations
rpc ListEvaluations(ListEvaluationsRequest) returns (ListEvaluationsResponse) 指定されたアプリのすべての評価を一覧表示します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 parent リソースに対する次の IAM 権限が必要です。 ces.evaluations.list 詳細については、IAM のドキュメントをご覧ください。

ListScheduledEvaluationRuns
rpc ListScheduledEvaluationRuns(ListScheduledEvaluationRunsRequest) returns (ListScheduledEvaluationRunsResponse) 指定されたアプリでスケジュールされたすべての評価実行を一覧表示します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。

RunEvaluation
rpc RunEvaluation(RunEvaluationRequest) returns (Operation) アプリの評価を実行します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 app リソースに対する次の IAM 権限が必要です。 ces.apps.runEvaluation 詳細については、IAM のドキュメントをご覧ください。

RunEvaluationResultMetrics
rpc RunEvaluationResultMetrics(RunEvaluationResultMetricsRequest) returns (Operation) 既存の評価結果に対して指標を実行します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。

TestPersonaVoice
rpc TestPersonaVoice(TestPersonaVoiceRequest) returns (TestPersonaVoiceResponse) ペルソナのトーンをテストします。デフォルトのペルソナも受け入れます。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 app リソースに対する次の IAM 権限が必要です。 ces.apps.get 詳細については、IAM のドキュメントをご覧ください。

UpdateEvaluation
rpc UpdateEvaluation(UpdateEvaluationRequest) returns (Evaluation) 評価を更新します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 ces.evaluations.update 詳細については、IAM のドキュメントをご覧ください。

UpdateEvaluationDataset
rpc UpdateEvaluationDataset(UpdateEvaluationDatasetRequest) returns (EvaluationDataset) 評価データセットを更新します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 ces.evaluationDatasets.update 詳細については、IAM のドキュメントをご覧ください。

UpdateEvaluationExpectation
rpc UpdateEvaluationExpectation(UpdateEvaluationExpectationRequest) returns (EvaluationExpectation) 評価の期待値を更新します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 ces.evaluationExpectations.update 詳細については、IAM のドキュメントをご覧ください。

UpdateScheduledEvaluationRun
rpc UpdateScheduledEvaluationRun(UpdateScheduledEvaluationRunRequest) returns (ScheduledEvaluationRun) スケジュールされた評価実行を更新します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。

UploadEvaluationAudio

rpc UploadEvaluationAudio(UploadEvaluationAudioRequest) returns (UploadEvaluationAudioResponse) ゴールデン評価で使用する音声をアップロードします。'App.logging_settings.evaluation_audio_recording_config.gcs_bucket' で定義された Cloud Storage バケットに音声を保存し、文字起こしを返します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 name リソースに対する次の IAM 権限が必要です。 ces.evaluations.update 詳細については、IAM のドキュメントをご覧ください。

SessionService

セッション サービスは、CES エージェントとやり取りするための API を提供します。

BidiRunSession

rpc BidiRunSession(BidiSessionClientMessage) returns (BidiSessionServerMessage) CES エージェントとの双方向ストリーミング接続を確立します。エージェントは、継続的なマルチモーダル入力（テキスト、音声など）を処理し、リアルタイムのマルチモーダル出力ストリームを生成します。 --- クライアント リクエスト ストリーム --- クライアントは次の順序でリクエストをストリーミングします。 初期化: 最初のメッセージには SessionConfig が含まれている必要があります。音声セッションの場合、音声処理と合成のパラメータを定義するために InputAudioConfig と OutputAudioConfig も含める必要があります。 インタラクション: 後続のメッセージ ストリーム SessionInput には、リアルタイムのユーザー入力データが含まれます。 終了: ユーザー入力がなくなると、クライアントはストリームをハーフクローズする必要があります。また、エージェントから EndSession または GoAway を受け取ると、半閉じ状態になります。 --- サーバー レスポンス ストリーム --- 各インタラクション ターンで、エージェントは次の順序でメッセージをストリーミングします。 音声認識（最初の N 個のメッセージ）: これまでにキャプチャされたユーザーの音声セグメントを連結したものを表す RecognitionResult が含まれます。これはオーディオ セッションに対してのみ入力されます。 レスポンス（次の M 個のメッセージ）: さまざまなモダリティ（テキスト、音声など）でエージェントのレスポンスを配信する SessionOutput が含まれます。 ターン完了（ターンの最後のメッセージ）: turn_completed が true に設定された SessionOutput を含みます。これは現在のターンの終了を示し、実行の詳細を含む DiagnosticInfo が含まれます。 --- オーディオに関するベスト プラクティス --- 1. ストリーミング: 無音時でも audio data を継続的にストリーミングします。推奨されるチャンクサイズ: 40 ～ 120 ミリ秒（レイテンシと効率性のバランス）。 再生と割り込み: 受信時に audio responses を再生します。InterruptionSignal（ユーザーの割り込みや新しいエージェントの応答など）を受信した場合は、すぐに再生を停止します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 session リソースに対する次の IAM 権限が必要です。 ces.sessions.bidiRunSession 詳細については、IAM のドキュメントをご覧ください。

RunSession
rpc RunSession(RunSessionRequest) returns (RunSessionResponse) セッション内で CES エージェントとの 1 ターンのやり取りを開始します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 session リソースに対する次の IAM 権限が必要です。 ces.sessions.runSession 詳細については、IAM のドキュメントをご覧ください。

StreamRunSession

rpc StreamRunSession(RunSessionRequest) returns (RunSessionResponse) CES エージェントとの 1 回のやり取りを開始します。サーバーサイド ストリーミングを使用して、増分結果と部分レスポンスを生成時に配信します。 デフォルトでは、完全なレスポンス（コールバックからのメッセージや完全な LLM レスポンスなど）は、利用可能になるとすぐにクライアントに送信されます。モデルから個々のテキスト チャンクを直接ストリーミングするには、enable_text_streaming を true に設定します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 session リソースに対する次の IAM 権限が必要です。 ces.sessions.runSession 詳細については、IAM のドキュメントをご覧ください。

ToolService

ツールサービスは、CES ツールを操作するための API を提供します。

ExecuteTool
rpc ExecuteTool(ExecuteToolRequest) returns (ExecuteToolResponse) 指定された引数を使用して、指定されたツールを実行します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 parent リソースに対する次の IAM 権限が必要です。 ces.tools.execute 詳細については、IAM のドキュメントをご覧ください。

RetrieveToolSchema
rpc RetrieveToolSchema(RetrieveToolSchemaRequest) returns (RetrieveToolSchemaResponse) 指定されたツールのスキーマを取得します。スキーマは、ツールの特定のインスタンスに対してオンザフライで計算されます。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 parent リソースに対する次の IAM 権限が必要です。 ces.tools.get 詳細については、IAM のドキュメントをご覧ください。

RetrieveTools
rpc RetrieveTools(RetrieveToolsRequest) returns (RetrieveToolsResponse) 指定されたツールセットに含まれるツールのリストを取得します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。 IAM 権限 toolset リソースに対する次の IAM 権限が必要です。 ces.toolsets.get 詳細については、IAM のドキュメントをご覧ください。

WidgetService

ウィジェットが CES API とやり取りするための API を提供します。

GenerateChatToken
rpc GenerateChatToken(GenerateChatTokenRequest) returns (GenerateChatTokenResponse) チャット ウィジェットが Session API で認証するためのセッション スコープ トークンを生成します。 認可スコープ 次の OAuth スコープのいずれかが必要です。 https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ces 詳細については、Authentication Overview をご覧ください。

アクション

ツールで使用するアクションの構成。注: これは Action または Operation のいずれかになります。詳細については、https://cloud.google.com/integration-connectors/docs/entities-operation-action をご覧ください。

フィールド
input_fields[]	string 省略可。オペレーションの入力として使用するエンティティ フィールド。フィールドが指定されていない場合は、エンティティのすべてのフィールドが使用されます。
output_fields[]	string 省略可。オペレーションから返すエンティティ フィールド。フィールドが指定されていない場合は、Entity のすべてのフィールドが返されます。
共用体フィールド action_spec。ツールで使用するアクションを構成するための仕様。action_spec は次のいずれかになります。
connection_action_id	string ツールが使用する接続アクションの ID。
entity_operation	Action.EntityOperation ツールで使用するエンティティ オペレーション構成。

EntityOperation

エンティティの CRUD オペレーションの仕様。

フィールド
entity_id	string 必須。エンティティの ID。
operation	Action.EntityOperation.OperationType 必須。エンティティに対して実行するオペレーション。

OperationType

エンティティに対して実行するオペレーション。

列挙型
OPERATION_TYPE_UNSPECIFIED	オペレーション タイプが指定されていません。無効です。ConnectorTool の作成または更新は失敗します。
LIST	リスト オペレーション。
GET	オペレーションを取得します。
CREATE	作成オペレーション。
UPDATE	更新オペレーション。
DELETE	削除オペレーション。

エージェント

エージェントは、特定のタスクを実行するための指示を大規模言語モデル（LLM）に提供する基本的な構成要素として機能します。

フィールド
name	string ID。エージェントの固有識別子。形式: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
display_name	string 必須。エージェントの表示名。
description	string 省略可。人が読める形式のエージェントの説明。
model_settings	ModelSettings 省略可。LLM モデルの構成。
instruction	string 省略可。エージェントの動作をガイドする LLM モデルの指示。
tools[]	string 省略可。エージェントが使用できるツールのリスト。形式: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
child_agents[]	string 省略可。エージェント ツリー内の子エージェントのリスト。形式: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
before_agent_callbacks[]	Callback 省略可。エージェントが呼び出される前に実行するコールバック。指定されたコールバックは、リストに指定された順序で順番に実行されます。コールバックがオーバーライドされたレスポンスを返すと、実行が停止し、残りのコールバックはスキップされます。
after_agent_callbacks[]	Callback 省略可。エージェントの呼び出し後に実行するコールバック。指定されたコールバックは、リストに指定された順序で順番に実行されます。コールバックがオーバーライドされたレスポンスを返すと、実行が停止し、残りのコールバックはスキップされます。
before_model_callbacks[]	Callback 省略可。モデルが呼び出される前に実行するコールバック。モデルへの呼び出しが複数ある場合、コールバックは複数回実行されます。指定されたコールバックは、リストに指定された順序で順番に実行されます。コールバックがオーバーライドされたレスポンスを返すと、実行が停止し、残りのコールバックはスキップされます。
after_model_callbacks[]	Callback 省略可。モデルの呼び出し後に実行するコールバック。モデルへの呼び出しが複数ある場合、コールバックは複数回実行されます。指定されたコールバックは、リストに指定された順序で順番に実行されます。コールバックがオーバーライドされたレスポンスを返すと、実行が停止し、残りのコールバックはスキップされます。
before_tool_callbacks[]	Callback 省略可。ツールが呼び出される前に実行するコールバック。ツールの呼び出しが複数ある場合、コールバックは複数回実行されます。指定されたコールバックは、リストに指定された順序で順番に実行されます。コールバックがオーバーライドされたレスポンスを返すと、実行が停止し、残りのコールバックはスキップされます。
after_tool_callbacks[]	Callback 省略可。ツールが呼び出された後に実行するコールバック。ツールの呼び出しが複数ある場合、コールバックは複数回実行されます。指定されたコールバックは、リストに指定された順序で順番に実行されます。コールバックがオーバーライドされたレスポンスを返すと、実行が停止し、残りのコールバックはスキップされます。
create_time	Timestamp 出力専用。エージェントが作成されたときのタイムスタンプ。
update_time	Timestamp 出力専用。エージェントが最後に更新されたときのタイムスタンプ。
guardrails[]	string 省略可。エージェントのガードレールのリスト。形式: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}
etag	string 読み取り / 変更 / 書き込みオペレーション中にオブジェクトが変更されていないことを確認するために使用される ETag。etag が空の場合、更新によって同時変更が上書きされます。
toolsets[]	Agent.AgentToolset 省略可。エージェントのツールセットのリスト。
generated_summary	string 出力専用。エージェントが LLM アシスタントによって生成された場合、このフィールドには生成の説明的な概要が含まれます。
transfer_rules[]	TransferRule 省略可。エージェントの転送ルール。複数のルールが一致する場合は、リストの最初のルールが使用されます。
validation_errors[]	string 出力専用。エージェントの品質に影響する可能性のあるエージェントの構成ミスやエラー。
共用体フィールド agent_type。エージェントのタイプ。agent_type は次のいずれかになります。
llm_agent	Agent.LlmAgent 省略可。デフォルトのエージェント タイプ。
remote_dialogflow_agent	Agent.RemoteDialogflowAgent 省略可。エージェントの実行に使用されるリモート Dialogflow エージェント。このフィールドが設定されている場合、他のすべてのエージェント レベルのプロパティは無視されます。 注: Dialogflow エージェントがアプリとは異なるプロジェクトにある場合は、CES サービス エージェント service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com に roles/dialogflow.client を付与する必要があります。
remote_a2a_agent	Agent.RemoteA2aAgent 省略可。エージェントの実行に使用されるリモート A2A エージェント。

AgentToolset

ツールセットとそのツールの一部。

フィールド
toolset	string 必須。ツールセットのリソース名。形式: projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
tool_ids[]	string 省略可。ツールセットをフィルタするツール ID。

LlmAgent

この型にはフィールドがありません。

デフォルトのエージェント タイプ。エージェントは、エージェントで指定された指示とコールバックを使用して、大規模言語モデルでタスクを実行します。

RemoteA2aAgent

実行をリモート A2A エージェントに転送するエージェント。

フィールド
a2a_config	RemoteA2aConfig 必須。A2A 接続の構成。

RemoteDialogflowAgent

実行をリモートの Dialogflow CX エージェントに転送するエージェント。Dialogflow エージェントは、セッションまたはフローが終了し、制御が親 CES エージェントに戻るまで、後続のユーザー クエリを処理します。

フィールド
agent	string 必須。Dialogflow エージェントのリソース名。形式: projects/{project}/locations/{location}/agents/{agent}
flow_id	string 省略可。Dialogflow エージェントのフローのフロー ID。
environment_id	string 省略可。エージェントの実行に使用される Dialogflow エージェントの環境 ID。指定しない場合は、ドラフト環境が使用されます。
input_variable_mapping	map<string, string> 省略可。Dialogflow エージェントに入力として送信されるアプリ変数名と Dialogflow セッション パラメータ名のマッピング。
output_variable_mapping	map<string, string> 省略可。Dialogflow エージェントの実行終了後に CES エージェントに返送される Dialogflow セッション パラメータ名とアプリ変数名のマッピング。
respect_response_interruption_settings	bool 省略可。Dialogflow エージェントで構成されたメッセージ レベルの中断設定を尊重するかどうかを示します。 false の場合: Dialogflow エージェントからのすべてのレスポンス メッセージは、アプリレベルの割り込み設定に従います。 true の場合: allow_playback_interruption が true に設定されているレスポンス メッセージのみが割り込み可能になり、他のすべてのメッセージはアプリレベルの割り込み設定に従います。
language_code_variable	string 省略可。Dialogflow セッションで使用する言語コードを含む変数の名前。指定しない場合、Dialogflow エージェントのデフォルトの言語コードが使用されます。

AgentCard

AgentCard は、リモート エージェントに関する重要な情報を伝えます。これは、A2A プロトコル https://a2a-protocol.org/dev/specification/#441-agentcard で定義されている AgentCard のトリミング バージョンです。

フィールド
name	string 必須。人が読める形式のエージェントの名前。
description	string 必須。エージェントの行動範囲/ソリューション空間の説明。
supported_interfaces[]	AgentInterface 必須。サポートされているインターフェースの順序付きリスト。最初の入力が優先されます。
version	string 必須。エージェントのバージョン。
skills[]	AgentSkill 必須。スキルは、エージェントが実行できる能力の単位を表します。これはやや抽象的ですが、エージェントが成功する可能性が高い、より絞り込まれた一連のアクションを表しています。

AgentInterface

エージェントとやり取りするためのターゲット URL、トランスポート、プロトコル バージョンの組み合わせを宣言します。これにより、エージェントは複数のプロトコル バインディング メカニズムで同じ機能を公開できます。

フィールド
url	string 必須。このインターフェースが利用可能な URL。本番環境では、有効な絶対 HTTPS URL である必要があります。例: "https://api.example.com/a2a/v1", "https://grpc.example.com/a2a"
protocol_binding	string 必須。この URL でサポートされているプロトコル バインディング。これはオープン フォーム文字列であり、他のプロトコル バインディングに簡単に拡張できます。正式にサポートされているコアは JSONRPC、GRPC、HTTP+JSON です。
tenant	string エージェントを呼び出すときにリクエストで使用するテナント ID。
protocol_version	string 必須。このインターフェースが公開する A2A プロトコルのバージョン。メジャー バージョンごとに、サポートされている最新のマイナー バージョンを使用します。例: 「0.3」、「1.0」

AgentRegistryDeployment

Agent Registry のデプロイの構成とステータス。

フィールド
agent_registry_service_name	string 省略可。出力専用。デプロイされた Agent Registry サービスのリソース名。形式: projects/{project}/locations/{location}/services/{service}

AgentSkill

エージェントが実行できる個別の機能を表します。

フィールド
id	string 必須。エージェントのスキルの一意の識別子。
name	string 必須。人が読める形式のスキルの名前。
description	string 必須。スキルの詳細な説明。
tags[]	string 必須。スキルの機能を説明するキーワードのセット。
examples[]	string このスキルで処理できるプロンプトやシナリオの例。
input_modes[]	string このスキルでサポートされている入力メディア タイプのセット。エージェントのデフォルトをオーバーライドします。
output_modes[]	string このスキルでサポートされている出力メディア タイプのセット。エージェントのデフォルトをオーバーライドします。

AgentTool

エージェントが別のエージェントを呼び出すことができるツールを表します。

フィールド
name	string 必須。エージェント ツールの名前。
description	string 省略可。ツールの目的の説明。
agent	string 省略可。ツールのエントリ ポイントであるエージェントのリソース名。形式: projects/{project}/locations/{location}/agents/{agent}

AgentTransfer

会話が別のエージェントに転送されたことを示すイベントを表します。

フィールド
target_agent	string 必須。会話の転送先のエージェント。ここから先は、エージェントが会話に対応します。形式: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
display_name	string 出力専用。エージェントの表示名。

AggregatedMetrics

評価または評価データセットの集計指標。

フィールド
metrics_by_app_version[]	AggregatedMetrics.MetricsByAppVersion 出力専用。アプリ バージョン ID でグループ化された集計指標。

HallucinationMetrics

ハルシネーション結果の指標。

フィールド
score	float 出力専用。平均ハルシネーション スコア（0 ～ 1）。

MetricsByAppVersion

アプリのバージョンごとに集計された指標。

フィールド
app_version_id	string 出力専用。アプリのバージョン ID。
tool_metrics[]	AggregatedMetrics.ToolMetrics 出力専用。このアプリ バージョン内の各ツールの指標。
semantic_similarity_metrics[]	AggregatedMetrics.SemanticSimilarityMetrics 出力専用。このアプリ バージョン内のセマンティック類似性の指標。
hallucination_metrics[]	AggregatedMetrics.HallucinationMetrics 出力専用。このアプリ バージョン内のハルシネーションの指標。
tool_call_latency_metrics[]	AggregatedMetrics.ToolCallLatencyMetrics 出力専用。このアプリ バージョン内のツール呼び出しレイテンシの指標。
turn_latency_metrics[]	AggregatedMetrics.TurnLatencyMetrics 出力専用。このアプリ バージョン内のターン レイテンシの指標。
pass_count	int32 出力専用。評価に合格した回数。
fail_count	int32 出力専用。評価が失敗した回数。
metrics_by_turn[]	AggregatedMetrics.MetricsByTurn 出力専用。このアプリ バージョン内のターンごとに集計された指標。

MetricsByTurn

ターンごとに集計された指標。

フィールド
turn_index	int32 出力専用。ターン インデックス（0 ベース）。
tool_metrics[]	AggregatedMetrics.ToolMetrics 出力専用。このターンの各ツールの指標。
semantic_similarity_metrics[]	AggregatedMetrics.SemanticSimilarityMetrics 出力専用。このターンのセマンティック類似性の指標。
hallucination_metrics[]	AggregatedMetrics.HallucinationMetrics 出力専用。このターンのハルシネーションの指標。
tool_call_latency_metrics[]	AggregatedMetrics.ToolCallLatencyMetrics 出力専用。このターンのツール呼び出しレイテンシの指標。
turn_latency_metrics[]	AggregatedMetrics.TurnLatencyMetrics 出力専用。このターンのターン レイテンシの指標。

SemanticSimilarityMetrics

意味的類似度結果の指標。

フィールド
score	float 出力専用。意味的類似性の平均スコア（0 ～ 4）。

ToolCallLatencyMetrics

ツール呼び出しのレイテンシの指標。

フィールド
tool	string 出力専用。ツールの名前。
average_latency	Duration 出力専用。ツール呼び出しの平均レイテンシ。

ToolMetrics

単一のツールの指標。

フィールド
tool	string 出力専用。ツールの名前。
pass_count	int32 出力専用。ツールが合格した回数。
fail_count	int32 出力専用。ツールが失敗した回数。

TurnLatencyMetrics

ターン レイテンシの指標。

フィールド
average_latency	Duration 出力専用。ターンの平均レイテンシ。

AmbientSoundConfig

会話の自然さを高めるために、合成されたエージェントの応答とともに再生されるアンビエント サウンドの構成。

フィールド
volume_gain_db	double 省略可。周囲のノイズによってサポートされる通常のネイティブ音量の音量ゲイン（dB 単位）。範囲は [-96.0, 16.0] です。未設定にするか、0.0（dB）に設定すると、ネイティブの通常の信号振幅で再生されます。-6.0（dB）に設定すると、ネイティブの通常の信号振幅の約半分の振幅で再生されます。+6.0（dB）に設定すると、ネイティブの通常の信号振幅の約 2 倍の振幅で再生されます。+10（dB）より大きい値を指定しないことを強くおすすめします。通常は、そのような大きい値を指定しても音量は効果的に増加しません。
共用体フィールド source。会話の自然さを高めるために、合成されたエージェントの応答とともに再生される周囲のノイズ。source は次のいずれかになります。
prebuilt_ambient_noise (deprecated)	AmbientSoundConfig.PrebuiltAmbientNoise この項目は非推奨です。 省略可。非推奨: prebuilt_ambient_noise は非推奨となり、prebuilt_ambient_sound に置き換えられました。
gcs_uri	string 省略可。Cloud Storage に保存されているモノラル チャンネルの 16 kHz WAV ファイルとしての周囲のノイズ。 注: CES サービス エージェント service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com に Cloud Storage オブジェクトに対する storage.objects.get 権限があることを確認してください。
prebuilt_ambient_sound	string 省略可。プリビルドのアンビエント サウンドの名前。有効な値は、- 「coffee_shop」- 「keyboard」- 「keypad」- 「hum」- 「office_1」- 「office_2」- 「office_3」- 「room_1」- 「room_2」- 「room_3」- 「room_4」- 「room_5」- 「air_conditioner」です。

PrebuiltAmbientNoise

プリビルドの周囲のノイズ。

列挙型
PREBUILT_AMBIENT_NOISE_UNSPECIFIED	指定されていません。
RETAIL_STORE	小売店の周囲のノイズ。
CONVENTION_HALL	コンベンション ホールの周囲のノイズ。
OUTDOOR	街の周囲のノイズ。

ApiAuthentication

API 呼び出しに必要な認証情報。

フィールド
共用体フィールド auth_config。認証構成。auth_config は次のいずれかになります。
api_key_config	ApiKeyConfig 省略可。API キー認証の構成。
oauth_config	OAuthConfig 省略可。OAuth の構成。
service_agent_id_token_auth_config	ServiceAgentIdTokenAuthConfig 省略可。CES サービス エージェントから生成された ID トークン認証の構成。
service_account_auth_config	ServiceAccountAuthConfig 省略可。サービス アカウント認証の構成。
bearer_token_config	BearerTokenConfig 省略可。ベアラートークン認証の構成。

ApiKeyConfig

API キーを使用した認証の構成。

フィールド
key_name	string 必須。API キーのパラメータ名またはヘッダー名。例: API リクエストが「https://example.com/act?X-Api-Key="」の場合、「X-Api-Key」がパラメータ名になります。
api_key_secret_version	string 必須。API キーを保存する SecretManager シークレット バージョン リソースの名前。形式: projects/{project}/secrets/{secret}/versions/{version} 注: CES サービス エージェント service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com に roles/secretmanager.secretAccessor ロールを付与する必要があります。
request_location	ApiKeyConfig.RequestLocation 必須。リクエスト内の鍵のロケーション。

RequestLocation

リクエスト内の API キーの場所。

列挙型
REQUEST_LOCATION_UNSPECIFIED	指定なし。この値は使用されるべきではありません。
HEADER	HTTP ヘッダーのキーを表します。
QUERY_STRING	クエリ文字列のキーを表します。

アプリ

アプリは、ルート エージェントとそのサブエージェント、関連する構成など、エージェントのグループの最上位コンテナとして機能します。これらのエージェントは、アプリのコンテキスト内で特定の目標を達成するために連携して動作します。

フィールド
name	string ID。アプリの固有識別子。形式: projects/{project}/locations/{location}/apps/{app}
display_name	string 必須。アプリの表示名。
description	string 省略可。人が読める形式のアプリの説明。
pinned	bool 省略可。アプリがアプリリストに固定されているかどうか。
root_agent	string 省略可。ルート エージェントはアプリのエントリ ポイントです。形式: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
language_settings	LanguageSettings 省略可。アプリの言語設定。
time_zone_settings	TimeZoneSettings 省略可。アプリのタイムゾーン設定。
audio_processing_config	AudioProcessingConfig 省略可。アプリの音声処理構成。
logging_settings	LoggingSettings 省略可。アプリのロギング設定。
error_handling_settings	ErrorHandlingSettings 省略可。アプリの設定のエラー処理。
model_settings	ModelSettings 省略可。アプリのデフォルトの LLM モデル設定。個々のリソース（エージェント、ガードレールなど）は、必要に応じてこれらの構成をオーバーライドできます。
tool_execution_mode	App.ToolExecutionMode 省略可。アプリのツール実行モード。指定しない場合、デフォルトは PARALLEL になります。
evaluation_metrics_thresholds	EvaluationMetricsThresholds 省略可。アプリの評価しきい値。
variable_declarations[]	App.VariableDeclaration 省略可。変数の宣言。
predefined_variable_declarations[]	App.VariableDeclaration 出力専用。アプリの事前定義変数の宣言。
global_instruction	string 省略可。アプリ内のすべてのエージェントの手順。この手順を使用して、すべてのエージェントにわたって安定した ID またはパーソナリティを設定できます。
guardrails[]	string 省略可。アプリのガードレールのリスト。形式: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}
data_store_settings	DataStoreSettings 省略可。アプリのデータストア設定。
default_channel_profile	ChannelProfile 省略可。アプリで使用されるデフォルトのチャネル プロファイル。
metadata	map<string, string> 省略可。アプリに関するメタデータ。このフィールドは、アプリの詳細や想定される用途に関連する追加情報を保存するために使用できます。
create_time	Timestamp 出力専用。アプリが作成されたときのタイムスタンプ。
update_time	Timestamp 出力専用。アプリが最後に更新されたときのタイムスタンプ。
etag	string 出力専用。読み取り / 変更 / 書き込みオペレーション中にオブジェクトが変更されていないことを確認するために使用される ETag。etag が空の場合、更新によって同時変更が上書きされます。
deployment_count	int32 出力専用。アプリ内のデプロイ数。
client_certificate_settings	ClientCertificateSettings 省略可。アプリのデフォルトのクライアント証明書の設定。
vpc_sc_settings	VpcScSettings 省略可。アプリの VPC-SC 設定。
locked	bool 省略可。アプリが変更に対してロックされているかどうかを示します。アプリがロックされている場合、アプリリソースの変更は拒否されます。
evaluation_personas[]	EvaluationPersona 省略可。アプリの評価ペルソナ。このフィールドは、評価に使用できるペルソナを定義するために使用されます。最大 30 個のペルソナを定義できます。
evaluation_settings	EvaluationSettings 省略可。アプリの評価設定。
validation_errors[]	string 出力専用。アプリの構成の誤りや警告。
dashboard_settings	DashboardSettings 省略可。Contact Center Insights ダッシュボードのリンクと構成を行うためのアプリ固有のダッシュボード設定。

ToolExecutionMode

エージェントが同時に複数のツールを選択した場合のツール実行の動作を定義します。

列挙型
TOOL_EXECUTION_MODE_UNSPECIFIED	ツールの実行モードが指定されていません。デフォルトは PARALLEL です。
PARALLEL	複数のツールが選択されている場合は、同じ ToolContext で並行して実行されます。
SEQUENTIAL	複数のツールが選択されている場合は、順番に実行されます。次のツールは、前のツールが完了した後にのみ実行され、前のツールから更新された ToolContext を確認できます。

VariableDeclaration

変数の構造とメタデータを定義します。

フィールド
name	string 必須。変数の名前。名前の先頭は英字またはアンダースコアにする必要があります。使用できるのは、英字、数字、アンダースコアのみです。
description	string 必須。変数の説明。
schema	Schema 必須。変数のスキーマ。

AppSnapshot

アプリのスナップショット。

フィールド
app	App 省略可。アプリの基本設定。
agents[]	Agent 省略可。アプリ内のエージェントのリスト。
tools[]	Tool 省略可。アプリ内のツールのリスト。
examples[]	Example 省略可。アプリ内の例のリスト。
guardrails[]	Guardrail 省略可。アプリのガードレールのリスト。
toolsets[]	Toolset 省略可。アプリ内のツールセットのリスト。

AppVersion

Customer Engagement Suite（CES）では、アプリのバージョンは特定の時点でのアプリのスナップショットです。これは不変であり、作成後に変更することはできません。

フィールド
name	string ID。アプリ バージョンの固有識別子。形式: projects/{project}/locations/{location}/apps/{app}/versions/{version}
display_name	string 省略可。アプリ バージョンの表示名。
description	string 省略可。アプリのバージョンの説明。
creator	string 出力専用。アプリ バージョンを作成したユーザーのメールアドレス。
create_time	Timestamp 出力専用。アプリのバージョンが作成されたときのタイムスタンプ。
update_time	Timestamp 出力専用。アプリのバージョンが最後に更新されたときのタイムスタンプ。
snapshot	AppSnapshot 出力専用。バージョンの作成時のアプリのスナップショット。
etag	string 出力専用。読み取り / 変更 / 書き込みオペレーション中にオブジェクトが変更されていないことを確認するために使用される ETag。etag が空の場合、更新によって同時変更が上書きされます。

AudioEncoding

AudioEncoding は、音声データのエンコード形式を指定します。

列挙型
AUDIO_ENCODING_UNSPECIFIED	音声エンコードが指定されていません。
LINEAR16	16 ビット リニア PCM 音声エンコード。
MULAW	G.711 PCMU/mu-law を使用して 14 ビットの音声サンプルの圧縮と伸張を行う 8 ビットのサンプル。
ALAW	G.711 PCMU/A-law を使用して 14 ビットの音声サンプルをコンパンディングする 8 ビットのサンプル。

AudioProcessingConfig

入力音声と出力音声を処理して配信する方法の構成。

フィールド
synthesize_speech_configs	map<string, SynthesizeSpeechConfig> 省略可。エージェントのレスポンスを合成する方法の構成。言語コードから SynthesizeSpeechConfig へのマッピング。 指定された言語コードの構成が見つからない場合は、ルート言語コードの構成が使用されます。たとえば、マップに「en-us」と「en」が含まれており、指定された言語コードが「en-gb」の場合、「en」構成が使用されます。 注: 言語コードでは大文字と小文字が区別されません。
barge_in_config	BargeInConfig 省略可。ユーザーの割り込みアクティビティに対するエージェントの動作を構成します。
inactivity_timeout	Duration 省略可。エージェントがユーザーに再エンゲージメントを促すまでの、ユーザーの操作がない（音声や操作がない）時間。設定されていない場合、エージェントはユーザーに再エンゲージメントを促しません。
ambient_sound_config	AmbientSoundConfig 省略可。会話の自然さを高めるために、合成されたエージェントの応答とともに再生されるアンビエント サウンドの構成。
custom_voice_samples[]	CustomVoiceSample 省略可。音声クローニング用のカスタム音声サンプルを構成します。

AudioRecordingConfig

音声インタラクションの記録方法に関する構成。

フィールド
gcs_bucket	string 省略可。セッションの音声録音を保存する Cloud Storage バケット。URI は「gs://」で始まる必要があります。 データ所在地に関する要件を満たすバケットのロケーションを選択してください。 注: Cloud Storage バケットがアプリとは異なるプロジェクトにある場合は、CES サービス エージェント service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com に storage.objects.create 権限を付与する必要があります。
gcs_path_prefix	string 省略可。音声録音の Cloud Storage パス接頭辞。 この接頭辞には、次のプレースホルダを含めることができます。これらは、配信時に動的に置き換えられます。- $project: プロジェクト ID - $location: アプリの地域 - $app: アプリ ID - $date: セッションの日付（YYYY-MM-DD 形式） - $session: セッション ID パス接頭辞が指定されていない場合は、デフォルトの接頭辞 $project/$location/$app/$date/$session/ が使用されます。

BargeInConfig

ユーザーの割り込みアクティビティの処理方法に関する構成。

フィールド
disable_barge_in (deprecated)	bool この項目は非推奨です。 省略可。非推奨: ChannelProfile で disable_barge_in が非推奨となり、disable_barge_in_control に置き換えられました。 エージェントが話している間、ユーザーの割り込みを無効にします。true の場合、エージェントの応答の再生中のユーザー入力は無視されます。
barge_in_awareness	bool 省略可。有効にすると、エージェントは、ユーザーが直前のエージェント メッセージをすべて聞いていないという前提に基づいて、次の応答を調整します。エージェントの回答が視覚的に表示されるシナリオでは使用しないでください。

BatchDeleteConversationsRequest

AgentService.BatchDeleteConversations のリクエスト メッセージです。

フィールド
parent	string 必須。会話を削除するアプリのリソース名。形式: projects/{project}/locations/{location}/apps/{app}
conversations[]	string 必須。削除する会話のリソース名。

BatchDeleteConversationsResponse

AgentService.BatchDeleteConversations に対するレスポンス メッセージです。

フィールド
deleted_conversations[]	string 削除に成功した会話のリスト。
failed_conversations[]	string 削除できなかった会話のリスト。
error_messages[]	string 省略可。削除に失敗した会話に関連付けられたエラー メッセージのリスト。

BearerTokenConfig

署名なしトークンを使用した認証の構成。

フィールド
token	string 必須。署名なしトークン。$context.variables.<name_of_variable> の形式で指定してください。

BidiSessionClientMessage

SessionService.BidiRunSession メソッドに対してクライアントが送信する最上位のメッセージ。

フィールド
共用体フィールド message_type。メッセージのタイプ。message_type は次のいずれかになります。
config	SessionConfig 省略可。セッションの初期構成メッセージ。
realtime_input	SessionInput 省略可。セッションのリアルタイム入力。

BidiSessionServerMessage

SessionService.BidiRunSession メソッドから返される最上位のメッセージ。

フィールド
共用体フィールド message_type。メッセージのタイプ。message_type は次のいずれかになります。
session_output	SessionOutput 省略可。CES エージェントからの結果を処理します。
recognition_result	RecognitionResult 省略可。音声入力のリアルタイム音声認識結果。
interruption_signal	InterruptionSignal 省略可。エージェントの音声応答が中断されたことを示します。
end_session	EndSession 省略可。セッションが終了したことを示します。
go_away	GoAway 省略可。サーバーがまもなく切断されるため、クライアントが接続をハーフクローズして再起動する必要があることを示します。

BigQueryExportSettings

アプリの BigQuery エクスポートの動作を記述する設定。

フィールド
enabled	bool 省略可。BigQuery エクスポートが有効かどうかを示します。
project	string 省略可。データのエクスポート先の BigQuery データセットのプロジェクト ID。 注: BigQuery データセットがアプリとは異なるプロジェクトにある場合は、CES サービス エージェント service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com に roles/bigquery.admin ロールを付与する必要があります。
dataset	string 省略可。データのエクスポート先の BigQuery データセット ID。

Blob

会話内の BLOB の入力または出力を表します。

フィールド
mime_type	string 必須。ソースデータの IANA 標準 MIME タイプ。
data	bytes 必須。blob の元のバイト。

コールバック

コールバックは、エージェントのインタラクションのさまざまな段階で実行されるカスタム ロジックを定義します。

フィールド
description	string 省略可。コールバックの説明（人が読める形式）。
disabled	bool 省略可。コールバックが無効かどうか。無効になっているコールバックはエージェントによって無視されます。
proactive_execution_enabled	bool 省略可。有効にすると、中間モデルの出力でもコールバックが実行されます。この設定は、モデル呼び出し後のコールバックにのみ影響します。慎重に有効にしてください。通常、モデル コールバック後は、すべてのモデル レスポンスを受信した後にのみ実行する必要があります。プロアクティブな実行を有効にすると、実行コストとレイテンシに悪影響が生じる可能性があるため、有効にするのはまれな状況のみにしてください。
共用体フィールド callback。実行するコールバック。callback は次のいずれかになります。
python_code	string 必須。コールバックで実行する Python コード。

変更履歴

変更ログは、アプリまたはアプリ内のリソースに加えられた変更を表します。

フィールド
name	string ID。変更ログの固有識別子。形式: projects/{project}/locations/{location}/apps/{app}/changelogs/{changelog}
author	string 出力専用。変更の作成者のメールアドレス。
display_name	string 出力専用。変更の表示名。通常は、変更されたリソースの表示名にする必要があります。
description	string 出力専用。変更の説明。通常は、リソース内の変更されたフィールドをキャプチャします。
resource	string 出力専用。変更されたリソース。
resource_type	string 出力専用。変更されたリソースのタイプ。
action	string 出力専用。リソースに対して実行されたアクション。
original_resource	Struct 出力専用。変更前の元のリソース。
new_resource	Struct 出力専用。変更後の新しいリソース。
dependent_resources[]	Struct 出力専用。変更された依存リソース。
create_time	Timestamp 出力専用。変更が行われた日時。
sequence_number	int64 出力専用。変更ログの単調増加シーケンス番号。

ChannelProfile

ChannelProfile は、ウェブ UI や電話など、特定のコミュニケーション チャネルに対するエージェントの動作を構成します。

フィールド
profile_id	string 省略可。チャネル プロファイルの固有識別子。
channel_type	ChannelProfile.ChannelType 省略可。チャンネル プロファイルのタイプ。
persona_property	ChannelProfile.PersonaProperty 省略可。チャンネル プロファイルのペルソナ プロパティ。
web_widget_config	ChannelProfile.WebWidgetConfig 省略可。ウェブ ウィジェットの構成。
whatsapp_config	ChannelProfile.WhatsAppConfig 省略可。WhatsApp のデプロイに固有の構成。
instagram_config	ChannelProfile.InstagramConfig 省略可。Instagram デプロイに固有の構成。
disable_dtmf	bool 省略可。DTMF（デュアルトーン マルチ周波数）を無効にするかどうか。
disable_barge_in_control	bool 省略可。会話でユーザーの割り込み制御を無効にするかどうか。- true: エージェントが話している間、ユーザーによる割り込みが無効になります。- false: エージェントは、ユーザーが割り込みできるタイミングを自動的に制御します。
noise_suppression_level	string 省略可。チャンネル プロファイルのノイズ サプレッション レベル。使用可能な値は「low」、「moderate」、「high」、「very_high」です。

ChannelType

チャンネル プロファイルのタイプ。

列挙型
UNKNOWN	不明なチャネルタイプ。
WEB_UI	ウェブ UI チャネル。
API	API チャネル。
TWILIO	Twilio チャネル。
GOOGLE_TELEPHONY_PLATFORM	Google Telephony Platform チャンネル。
CONTACT_CENTER_AS_A_SERVICE	Contact Center as a Service（CCaaS）チャネル。
CONTACT_CENTER_AS_A_SERVICE_CHAT	Contact Center as a Service（CCaaS Chat）チャネル。
FIVE9	Five9 チャネル。
CONTACT_CENTER_INTEGRATION	サードパーティのコンタクト センター統合チャネル。
WHATSAPP	WhatsApp チャネル。
INSTAGRAM	Instagram チャンネル。

InstagramConfig

Instagram デプロイに固有の構成。

フィールド
instagram_account_id	string 必須。Instagram アカウント ID。
display_name	string 出力専用。取得された Meta ビジネス ページの名称。
thumbnail_url	string 出力専用。取得した Meta ビジネス プロフィールのサムネイル URL。
description	string 出力専用。Meta のビジネス ページまたはプロフィールの説明。

PersonaProperty

チャンネルのペルソナ プロパティを表します。

フィールド
persona	ChannelProfile.PersonaProperty.Persona 省略可。チャンネルのペルソナ。

ペルソナ

チャンネルのペルソナ。

列挙型
UNKNOWN	UNKNOWN ペルソナ。
CONCISE	エージェントは回答を簡潔かつ要点に絞って行う
CHATTY	エージェントが追加のコンテキスト、説明、詳細情報を提供している

WebWidgetConfig

ウェブ ウィジェットの構成に関するメッセージ。

フィールド
modality	ChannelProfile.WebWidgetConfig.Modality 省略可。ウェブ ウィジェットのモダリティ。
theme	ChannelProfile.WebWidgetConfig.Theme 省略可。ウェブ ウィジェットのテーマ。
web_widget_title	string 省略可。ウェブ ウィジェットのタイトル。
security_settings	ChannelProfile.WebWidgetConfig.SecuritySettings 省略可。ウェブ ウィジェットのセキュリティ設定。

モダリティ

ウェブ ウィジェットのモダリティ。

列挙型
MODALITY_UNSPECIFIED	不明なモダリティ。
CHAT_AND_VOICE	ウィジェットはチャットと音声入力の両方をサポートしています。
VOICE_ONLY	ウィジェットは音声入力のみをサポートしています。
CHAT_ONLY	ウィジェットはチャット入力のみをサポートしています。
CHAT_VOICE_AND_VIDEO	ウィジェットは、チャット、音声、動画の入力をサポートしています。

SecuritySettings

ウェブ ウィジェットのセキュリティ設定。

フィールド
enable_public_access	bool 省略可。ウェブ ウィジェットへの一般公開アクセスが有効かどうかを示します。true の場合、ウェブ ウィジェットは一般公開されます。false の場合、ウェブ ウィジェットは、CES エージェントにアクセスするための有効な認証情報を返すために、独自の認証システムおよび認可システムと統合する必要があります。
enable_origin_check	bool 省略可。ウェブ ウィジェットのオリジン チェックが有効かどうかを示します。true の場合、ウェブ ウィジェットはウェブ ウィジェットを読み込むウェブサイトのオリジンを確認し、同じオリジンまたは許可されたオリジンのいずれかでのみ読み込みを許可します。
allowed_origins[]	string 省略可。ウェブ ウィジェットのホストを許可されているオリジン。オリジンは RFC 6454 で定義されています。空の場合、すべてのオリジンが許可されます。オリジンは最大 100 個まで指定できます。例: "https://example.com"
enable_recaptcha	bool 省略可。ウェブ ウィジェットの reCAPTCHA による確認が有効かどうかを示します。

テーマ

ウェブ ウィジェットのテーマ。

列挙型
THEME_UNSPECIFIED	不明なテーマ。
LIGHT	ライトモード。
DARK	ダークモード。

WhatsAppConfig

WhatsApp のデプロイに固有の構成。

フィールド
waba_id	string 必須。WhatsApp Business のアカウント ID。
phone_number_id	string 必須。Meta の電話番号 ID。
phone_number	string 省略可。E.164 形式の電話番号。
display_name	string 出力専用。取得された Meta ビジネス ページの名称。
thumbnail_url	string 出力専用。取得した Meta ビジネス プロフィールのサムネイル URL。
description	string 出力専用。Meta のビジネス ページまたはプロフィールの説明。

チャンク

メッセージ内のコンテンツのチャンク。

フィールド
共用体フィールド data。チャンクデータ。data は次のいずれかになります。
text	string 省略可。テキストデータ。
transcript	string 省略可。音声に関連付けられた文字起こし。
blob	Blob 省略可。Blob データ。
payload	Struct 省略可。カスタム ペイロード データ。
image	Image 省略可。画像データ。
tool_call	ToolCall 省略可。ツールの実行リクエスト。
tool_response	ToolResponse 省略可。ツール実行のレスポンス。
agent_transfer	AgentTransfer 省略可。エージェントの転送イベント。
updated_variables	Struct 構造体は、会話で更新された変数を変数名でキー設定して表します。
default_variables	Struct 構造体は、会話の開始時のデフォルト変数を表します。変数名でキー設定されます。

引用

エージェントの回答に関連付けられた引用。

フィールド
cited_chunks[]	Citations.CitedChunk 引用された情報のリスト。
inline_citations[]	Citations.InlineCitation 省略可。エージェントの回答に含まれるインライン引用のリスト。

CitedChunk

引用された情報の断片。

フィールド
uri	string 引用に使用される URI。
title	string 引用されたドキュメントのタイトル。
text	string 引用に使用されるテキスト。
requires_attribution	bool この引用でエンドユーザーに帰属表示を行う必要があるかどうか。

InlineCitation

レスポンス テキストのインライン引用。

フィールド
start_index	int32 エージェント レスポンス内のテキスト セグメントの開始インデックス（バイト単位）。
end_index	int32 エージェントのレスポンス内のテキスト セグメントの終了インデックス（バイト単位）。
cited_chunk_indices[]	int32 このテキスト セグメントを裏付ける引用チャンクのインデックス。インデックスは cited_chunks 内の要素を参照します。

ClientCertificateSettings

カスタム クライアント証明書の設定。

フィールド
tls_certificate	string 必須。PEM 形式でエンコードされた TLS 証明書。この文字列には、ヘッダーの開始行とフッターの終了行を含める必要があります。
private_key	string 必須。PEM 形式でエンコードされた秘密鍵を保存する SecretManager シークレット バージョン リソースの名前。形式: projects/{project}/secrets/{secret}/versions/{version}
passphrase	string 省略可。秘密鍵を復号するためのパスフレーズを保存する SecretManager シークレット バージョン リソースの名前。秘密鍵が暗号化されていない場合は、設定しないでください。形式: projects/{project}/secrets/{secret}/versions/{version}

ClientFunction

エージェントが呼び出すことができるクライアントサイド関数を表します。エージェントがツールを選択すると、制御がクライアントに引き渡されます。クライアントは、関数を実行し、結果を ToolResponse として返して、エージェントとのやり取りを続行する責任があります。

フィールド
name	string 必須。関数名。
description	string 省略可。関数の説明。
parameters	Schema 省略可。関数パラメータのスキーマ。
response	Schema 省略可。関数レスポンスのスキーマ。

CloudLoggingSettings

アプリの Cloud Logging の動作を記述する設定。

フィールド
enable_cloud_logging	bool 省略可。セッションで Cloud Logging を有効にするかどうか。

CodeBlock

実際のツール呼び出しの代わりに実行されるコードブロック。

フィールド
python_code	string 必須。ツール フェイクモードで呼び出される Python コード。想定される Python 関数のシグネチャ - すべてのツール呼び出しをキャッチする場合: def fake_tool_call(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: 特定のツール呼び出しをキャッチする場合: def fake_{tool_id}(tool: Tool, input: dict[str, Any], callback_context: CallbackContext) -> Optional[dict[str, Any]]: 関数が None を返すと、代わりに実際のツールが呼び出されます。

ConnectorTool

ConnectorTool を使用すると、さまざまな統合に接続できます。https://cloud.google.com/integration-connectors/docs/overview をご覧ください。

フィールド
connection	string 必須。参照される Integration Connectors Connection の完全なリソース名。形式: projects/{project}/locations/{location}/connections/{connection}
action	Action 必須。ツールが使用するアクション。
auth_config	EndUserAuthConfig 省略可。Integration Connectors で認証を処理する方法を構成します。デフォルトでは、管理者の認証は Integration Connectors API リクエストで渡されます。別のエンドユーザー認証構成でオーバーライドできます。注: ここで EUC 構成を指定するには、接続で認証オーバーライドが有効になっている必要があります。有効になっていない場合、ConnectorTool の作成は失敗します。詳細については、https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override をご覧ください。
name	string 省略可。エージェントがこの ConnectorTool を呼び出すかどうかを判断するために使用できるツールの名前。
description	string 省略可。この ConnectorTool を呼び出すかどうかをエージェントが判断するために使用できるツールの説明。

ConnectorToolset

Integration Connectors 接続からツールを生成するツールセット。

フィールド
connection	string 必須。参照される Integration Connectors Connection の完全なリソース名。形式: projects/{project}/locations/{location}/connections/{connection}
auth_config	EndUserAuthConfig 省略可。Integration Connectors で認証を処理する方法を構成します。デフォルトでは、管理者の認証は Integration Connectors API リクエストで渡されます。別のエンドユーザー認証構成でオーバーライドできます。注: ここで EUC 構成を指定するには、接続で認証オーバーライドが有効になっている必要があります。有効になっていない場合、ツールセットの作成は失敗します。参照: https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override
connector_actions[]	Action 必須。ツールの生成対象となるコネクタ アクション/エンティティ オペレーションのリスト。

会話

会話は、エンドユーザーと CES アプリ間のやり取りを表します。

フィールド
name	string ID。会話の固有識別子。形式: projects/{project}/locations/{location}/apps/{app}/conversations/{conversation}
start_time	Timestamp 出力専用。会話が作成されたときのタイムスタンプ。
end_time	Timestamp 出力専用。会話が完了したときのタイムスタンプ。
turns[]	Conversation.Turn 必須。会話のターン。
turn_count	int32 出力専用。会話のターン数。
channel_type (deprecated)	Conversation.ChannelType この項目は非推奨です。 非推奨。代わりに input_types を使用してください。
source	Conversation.Source 出力専用。会話のソースを示します。
input_types[]	Conversation.InputType 出力専用。会話の入力タイプ。
entry_agent	string 出力専用。会話に最初に対応するエージェント。指定しない場合、会話はルート エージェントによって処理されます。形式: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
deployment	string 出力専用。会話の処理に使用されるアプリのデプロイ。形式: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
app_version	string 出力専用。会話の処理に使用されたアプリのバージョン。形式: projects/{project}/locations/{location}/apps/{app}/versions/{version}
language_code	string 出力専用。会話の言語コード。
messages[] (deprecated)	Message この項目は非推奨です。 非推奨。代わりにターンを使用してください。

ChannelType

会話のチャンネル タイプ。

列挙型
CHANNEL_TYPE_UNSPECIFIED	チャンネル タイプが指定されていません。
TEXT	会話には、エンドユーザーとエージェント間のテキスト メッセージのみが含まれます。
AUDIO	会話には、エンドユーザーとエージェント間の音声メッセージが含まれています。
MULTIMODAL	エンドユーザーとエージェント間の会話のマルチモーダル メッセージ（画像など）。

InputType

入力メッセージのタイプ。

列挙型
INPUT_TYPE_UNSPECIFIED	入力タイプが指定されていません。
INPUT_TYPE_TEXT	テキスト入力。
INPUT_TYPE_EVENT	イベント入力。
INPUT_TYPE_AUDIO	音声入力。
INPUT_TYPE_IMAGE	画像入力。
INPUT_TYPE_BLOB	Blob 入力。
INPUT_TYPE_TOOL_RESPONSE	クライアント関数ツールのレスポンス入力。
INPUT_TYPE_VARIABLES	変数の入力。

ソース

会話のソース。

列挙型
SOURCE_UNSPECIFIED	ソースが指定されていません。
LIVE	会話はライブ エンドユーザーからのものです。
SIMULATOR	会話はシミュレータからのものです。
EVAL	会話は評価からのものです。
AGENT_TOOL	会話がエージェント ツールからのものである。エージェント ツールは、テストとデバッグの目的で永続化される別のセッションでエージェントを実行します。

Turn

会話の 1 ターンのすべての情報。

フィールド
messages[]	Message 省略可。会話ターンのメッセージのリスト。ユーザー入力、エージェントのレスポンス、処理中の中間イベントが含まれます。
root_span	Span 省略可。アクション処理のルートスパン。
user_intended_text	string 省略可。シミュレートされた発信者（Polysynth）からの意図された正解テキスト。単語誤り率の指標が有効になっている場合にのみ入力されます。

ConversationLoggingSettings

アプリの会話ロギングの動作を記述する設定。

フィールド
disable_conversation_logging	bool 省略可。セッションの会話のロギングを無効にするかどうか。
retention_window	Duration 省略可。会話の保持期間を制御します。設定しない場合、会話は 365 日間保持されます。

CreateAgentRequest

フィールド
parent	string 必須。エージェントを作成するアプリのリソース名。
agent_id	string 省略可。エージェントに使用する ID。エージェントのリソース名の最終的なコンポーネントになります。指定しない場合、エージェントに一意の ID が自動的に割り当てられます。
agent	Agent 必須。作成するエージェント。

CreateAppRequest

AgentService.CreateApp のリクエスト メッセージです。

フィールド
parent	string 必須。アプリを作成するビジネスのリソース名。
app_id	string 省略可。アプリに使用する ID。アプリのリソース名の最終的なコンポーネントになります。指定しない場合、アプリに一意の ID が自動的に割り当てられます。
app	App 必須。作成するアプリ。

CreateAppVersionRequest

AgentService.CreateAppVersion のリクエスト メッセージ

フィールド
parent	string 必須。アプリ バージョンを作成するアプリのリソース名。
app_version_id	string 省略可。アプリのバージョンに使用する ID。アプリのバージョンのリソース名の最終的なコンポーネントになります。指定しない場合、アプリのバージョンに一意の ID が自動的に割り当てられます。
app_version	AppVersion 必須。作成するアプリのバージョン。

CreateDeploymentRequest

AgentService.CreateDeployment のリクエスト メッセージです。

フィールド
parent	string 必須。親アプリ。形式: projects/{project}/locations/{location}/apps/{app}
deployment_id	string 省略可。デプロイに使用する ID。デプロイのリソース名の最終的なコンポーネントになります。指定しない場合、デプロイに一意の ID が自動的に割り当てられます。
deployment	Deployment 必須。作成するデプロイ。

CreateEvaluationDatasetRequest

EvaluationService.CreateEvaluationDataset のリクエスト メッセージです。

フィールド
parent	string 必須。評価を作成するアプリ。形式: projects/{project}/locations/{location}/apps/{app}
evaluation_dataset_id	string 省略可。評価データセットに使用する ID。評価データセットのリソース名の最終的なコンポーネントになります。指定しない場合、評価用に一意の ID が自動的に割り当てられます。
evaluation_dataset	EvaluationDataset 必須。作成する評価データセット。

CreateEvaluationExpectationRequest

EvaluationService.CreateEvaluationExpectation のリクエスト メッセージです。

フィールド
parent	string 必須。評価の期待値を作成するアプリ。形式: projects/{project}/locations/{location}/apps/{app}
evaluation_expectation_id	string 省略可。評価の期待値に使用する ID。評価の期待値のリソース名の最終的なコンポーネントになります。指定しない場合、評価の期待値に一意の ID が自動的に割り当てられます。
evaluation_expectation	EvaluationExpectation 必須。作成する評価の期待値。

CreateEvaluationRequest

EvaluationService.CreateEvaluation のリクエスト メッセージです。

フィールド
parent	string 必須。評価を作成するアプリ。形式: projects/{project}/locations/{location}/apps/{app}
evaluation_id	string 省略可。評価に使用する ID。評価のリソース名の最終的なコンポーネントになります。指定しない場合、評価用に一意の ID が自動的に割り当てられます。
evaluation	Evaluation 必須。作成する評価。

CreateExampleRequest

AgentService.CreateExample のリクエスト メッセージです。

フィールド
parent	string 必須。例を作成するアプリのリソース名。
example_id	string 省略可。例に使用する ID。例のリソース名の最終的なコンポーネントになります。指定しない場合、一意の ID が例に自動的に割り当てられます。
example	Example 必須。作成する例。

CreateGuardrailRequest

AgentService.CreateGuardrail のリクエスト メッセージです。

フィールド
parent	string 必須。ガードレールを作成するアプリのリソース名。
guardrail_id	string 省略可。ガードレールに使用する ID。ガードレールのリソース名の最終的なコンポーネントになります。指定しない場合、ガードレールに一意の ID が自動的に割り当てられます。
guardrail	Guardrail 必須。作成するガードレール。

CreateScheduledEvaluationRunRequest

EvaluationService.CreateScheduledEvaluationRun のリクエスト メッセージです。

フィールド
parent	string 必須。スケジュールされた評価実行を作成するアプリ。形式: projects/{project}/locations/{location}/apps/{app}
scheduled_evaluation_run_id	string 省略可。スケジュールされた評価実行に使用する ID。スケジュールされた評価実行のリソース名の最終的なコンポーネントになります。指定しない場合、一意の ID が自動的に割り当てられます。
scheduled_evaluation_run	ScheduledEvaluationRun 必須。作成するスケジュール設定された評価実行。

CreateToolRequest

AgentService.CreateTool のリクエスト メッセージです。

フィールド
parent	string 必須。ツールを作成するアプリのリソース名。
tool_id	string 省略可。ツールに使用する ID。ツールのリソース名の最終的なコンポーネントになります。指定しない場合、ツールに一意の ID が自動的に割り当てられます。
tool	Tool 必須。作成するツール。

CreateToolsetRequest

AgentService.CreateToolset のリクエスト メッセージです。

フィールド
parent	string 必須。ツールセットを作成するアプリのリソース名。
toolset_id	string 省略可。ツールセットに使用する ID。ツールセットのリソース名の最終的なコンポーネントになります。指定しない場合、ツールセットに一意の ID が自動的に割り当てられます。
toolset	Toolset 必須。作成するツールセット。

CustomVoiceSample

音声クローニングに使用されるカスタム音声サンプルの構成。

フィールド
name	string 省略可。カスタム音声サンプルのユーザー定義名。
voice_sample_gcs_uri	string 省略可。音声クローニング用の音声サンプルの Cloud Storage URI。音声サンプルは、モノラル チャンネルの 24 kHz WAV ファイルである必要があります。
consent_audio_gcs_uri	string 省略可。音声クローニングの同意音声。
voice_instruction	string 省略可。音声のスタイル、トーン、ペース、発音に関する自然言語による指示。
preview_audio_content	bytes 出力専用。カスタム音声の合成プレビュー音声。標準 WAV（LINEAR16、24 kHz、16 ビット、モノラル）としてフォーマットされます。
preview_text	string 省略可。カスタム音声のプレビュー音声を合成するためのテキスト。
warnings[]	CustomVoiceSample.Warning 出力専用。音声クローン処理中に発生した警告メッセージ（音声レベルが低いなど）。
voice_instruction_mode	CustomVoiceSample.VoiceInstructionMode 省略可。音声サンプルの指示モード。指定されていない場合、デフォルトは NO_INSTRUCTION です。

VoiceInstructionMode

音声サンプルの指示モード。

列挙型
VOICE_INSTRUCTION_MODE_UNSPECIFIED	指示モードが指定されていません。デフォルトは NO_INSTRUCTION です。
NO_INSTRUCTION	音声による指示は使用されません。
GENERATE_INSTRUCTION	音声指示は、音声サンプルから AI によって自動的に生成されます。
CUSTOM_INSTRUCTION	ユーザーが指定したカスタム音声指示。

警告

音声サンプルの処理中に発生した警告メッセージ。

フィールド
message	string 出力専用。警告の説明（人が読める形式）。
type	CustomVoiceSample.Warning.WarningType 出力専用。警告のタイプ。

WarningType

音声サンプルの処理中に発生した警告の種類。

列挙型
WARNING_TYPE_UNSPECIFIED	警告タイプが指定されていません。
LOW_AUDIO_LEVEL	音声サンプルの音声レベルが低すぎる（RMS 振幅が小さいなど）。

DashboardSettings

モニタリング ビューに表示される、アプリに関連付けられたダッシュボードの設定。

フィールド
default_dashboard	string 省略可。アプリに関連付けられているデフォルトの Contact Center Insights ダッシュボードのリソース名。ユーザーがアプリのモニタリング ビューに移動したときに表示されるダッシュボードです。 形式: projects/{project}/locations/{location}/dashboards/{dashboard}

DataStore

Vertex AI Search の DataStore リソース。

フィールド
name	string 必須。DataStore の完全なリソース名。形式: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}
type	DataStore.DataStoreType 出力専用。データストアのタイプ。このフィールドは読み取り専用で、サーバーによって入力されます。
document_processing_mode	DataStore.DocumentProcessingMode 出力専用。データストア接続のドキュメント処理モード。PUBLIC_WEB データストアと UNSTRUCTURED データストアでのみ設定されます。
display_name	string 出力専用。データストアの表示名。
create_time	Timestamp 出力専用。データストアが作成されたときのタイムスタンプ。
connector_config	DataStore.ConnectorConfig 出力専用。データストア接続のコネクタ構成。

ConnectorConfig

データストア接続のコネクタ構成。

フィールド
collection	string データストアが属するコレクションのリソース名。
collection_display_name	string データストアが属するコレクションの表示名。
data_source	string データソース名。例: salesforce、jira、confluence、bigquery。

DataStoreType

データストアのタイプ。

列挙型
DATA_STORE_TYPE_UNSPECIFIED	指定なし。この値は、データストアのタイプが指定されていないことを示します。そのため、検索時に使用されません。
PUBLIC_WEB	一般公開のウェブ コンテンツを含むデータストア。
UNSTRUCTURED	構造化されていない非公開データを含むデータストア。
FAQ	FAQ として使用される構造化データを含むデータストア。
CONNECTOR	ファーストパーティまたはサードパーティ サービスへのコネクタであるデータストア。

DocumentProcessingMode

データストアのドキュメント処理モード。

列挙型
DOCUMENT_PROCESSING_MODE_UNSPECIFIED	指定されていません。
DOCUMENTS	ドキュメントはドキュメントとして処理されます。
CHUNKS	ドキュメントがチャンクに変換されます。

DataStoreSettings

アプリのデータストア関連の設定。

フィールド
engines[]	DataStoreSettings.Engine 出力専用。アプリのエンジン。

エンジン

データストアが接続されているエンジン。Vertex AI Search をご覧ください: https://cloud.google.com/generative-ai-app-builder/docs/enterprise-search-introduction。

フィールド
name	string 出力専用。エンジンのリソース名。形式: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}
type	DataStoreSettings.Engine.Type 出力専用。エンジンのタイプ。

タイプ

エンジンの種類。https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1/SolutionType と https://cloud.google.com/generative-ai-app-builder/docs/create-datastore-ingest で利用可能なドキュメントをご覧ください。

列挙型
TYPE_UNSPECIFIED	エンジンタイプが指定されていません。
ENGINE_TYPE_SEARCH	アプリの SOLUTION_TYPE_SEARCH エンジン。アプリに追加されたすべてのコネクタ データストアがこのエンジンに追加されます。
ENGINE_TYPE_CHAT	チャット エンジンのタイプ。アプリの SOLUTION_TYPE_CHAT エンジン。アプリに追加されたすべてのコネクタ データストアがこのエンジンに追加されます。

DataStoreTool

グラウンディングのために Vertex AI Search データストアまたはエンジンから取得するツール。データストアまたはエンジンのいずれかを受け入れますが、両方は受け入れません。Vertex AI Search をご覧ください: https://cloud.google.com/generative-ai-app-builder/docs/enterprise-search-introduction。

フィールド
name	string 必須。データストア ツールの名前。
description	string 省略可。ツールの説明。
boost_specs[]	DataStoreTool.BoostSpecs 省略可。特定のドキュメントをブーストするブースト仕様。
modality_configs[]	DataStoreTool.ModalityConfig 省略可。データストアのモダリティ構成。
filter_parameter_behavior	DataStoreTool.FilterParameterBehavior 省略可。フィルタ パラメータの動作。
共用体フィールド search_source。検索ソース（単一のデータストアまたはエンジン）を定義します。search_source は次のいずれかになります。
data_store_source	DataStoreTool.DataStoreSource 省略可。特定の 1 つの DataStore 内を検索します。
engine_source	DataStoreTool.EngineSource 省略可。エンジン内を検索します（複数のデータストアにまたがる可能性があります）。

BoostSpec

特定のドキュメントをブーストするブースト仕様。

フィールド
condition_boost_specs[]	DataStoreTool.BoostSpec.ConditionBoostSpec 必須。ブースト仕様のリスト。

ConditionBoostSpec

条件のブースト仕様。

フィールド
condition	string 必須。ブースト条件を指定する式。構文はフィルタ式の構文と同じです。現在、サポートされている条件は BCP-47 言語コードのリストのみです。例: 言語 en または fr の候補をブーストするには: (lang_code: ANY("en", "fr"))
boost	float 省略可。ブーストの強さ。[-1, 1] の範囲で指定します。ブーストが負の値である場合は順位を下げることを意味します。デフォルトは 0.0 です。 1.0 に設定すると、候補に強力なプロモーションが与えられます。ただし、ブーストされた候補が上位の結果になるとは限りません。 -1.0 に設定すると、候補に大きなデモートが与えられます。ただし、関連性の高い他の候補は引き続き表示されることがあります。 0.0 に設定すると、ブーストは適用されません。ブースト条件は無視されます。
boost_control_spec	DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec 省略可。顧客定義の属性値に基づくカスタム ランキングの複雑な仕様。

BoostControlSpec

顧客が指定した属性値に基づくカスタム ランキングの仕様。上記の単純な（条件、ブースト）の組み合わせよりも、カスタマイズされたランキングをより細かく制御できます。

フィールド
field_name	string 省略可。ブースト量を決定するために値が使用されるフィールドの名前。
attribute_type	DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType 省略可。ブースト額の決定に使用する属性のタイプ。属性値は、指定された field_name のフィールド値から導出できます。数値の場合、attribute_value = numerical_field_value となります。ただし、鮮度の場合は、attribute_value = (time.now() - datetime_field_value) となります。
interpolation_type	DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.InterpolationType 省略可。以下に表示されているコントロール ポイントを接続するために適用される補完タイプ。
control_points[]	DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint 省略可。曲線の定義に使用されるコントロール ポイント。単調関数（上記の interpolation_type で定義）は、ここに記載されているコントロール ポイントを通過します。

AttributeType

カスタム ランキングを適用する属性（または関数）。

列挙型
ATTRIBUTE_TYPE_UNSPECIFIED	AttributeType が指定されていません。
NUMERICAL	数値フィールドの値は、ブースト額を動的に更新するために使用されます。この場合、コントロール ポイントの attribute_value（x 値）は、boost_amount が指定されている数値フィールドの実際の値になります。
FRESHNESS	鮮度のユースケースでは、属性値は現在時刻と指定された datetime フィールドの日付の間の期間になります。値は、XSD dayTimeDuration 値（ISO 8601 期間値の制限付きサブセット）としてフォーマットする必要があります。このパターンは [nD][T[nH][nM][nS]] です。例: 5D、3DT12H30M、T24H。

ControlPoint

曲線の定義に使用されるコントロール ポイント。これらの制御点を通過する曲線は、単調に増加または減少する（定数値は許容される）必要があります。

フィールド
attribute_value	string 省略可。以下のいずれか: 1. 数値フィールドの値。2. 鮮度の期間仕様: 値は XSD dayTimeDuration 値（ISO 8601 期間値の制限付きサブセット）としてフォーマットする必要があります。このパターンは [nD][T[nH][nM][nS]] です。
boost_amount	float 省略可。attribute_value が上記で指定した値と評価された場合にスコアをブーストする値（-1 ～ 1）。

InterpolationType

適用する補完タイプ。デフォルトは線形（区分線形）です。

列挙型
INTERPOLATION_TYPE_UNSPECIFIED	補完タイプが指定されていません。この場合、デフォルトは Linear になります。
LINEAR	区分線形補完タイプが適用されます。

BoostSpecs

特定のドキュメントをブーストするブースト仕様。詳細については、https://cloud.google.com/generative-ai-app-builder/docs/boosting をご覧ください。

フィールド
data_stores[]	string 必須。ブースト構成が適用されるデータストア。DataStore の完全なリソース名（例: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}）。
spec[]	DataStoreTool.BoostSpec 必須。ブースト仕様のリスト。

DataStoreSource

特定の DataStore 内を検索するための構成。

フィールド
filter	string 省略可。DataStore のフィルタ仕様。参照: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata
data_store	DataStore 省略可。データストア。

EngineSource

Engine 内で検索するための構成。特定の DataStore をターゲットにする可能性があります。

フィールド
engine	string 必須。Engine の完全なリソース名。形式: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}
data_store_sources[]	DataStoreTool.DataStoreSource 省略可。Engine 内の特定の DataStore をターゲットにするために使用します。空の場合、検索は Engine に関連付けられているすべての DataStore に適用されます。
filter	string 省略可。エンジン全体で検索に適用されるフィルタ。data_store_sources が指定されている場合は、関連性がなく、使用されません。参照: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata

FilterParameterBehavior

フィルタ パラメータの動作。

列挙型
FILTER_PARAMETER_BEHAVIOR_UNSPECIFIED	デフォルトのフィルタ動作。コネクタ データストアの一致フィルタを含めます。他のデータストア型では、フィルタ入力パラメータは省略されます。
ALWAYS_INCLUDE	すべてのデータストア タイプでフィルタ パラメータを常に含めます。
NEVER_INCLUDE	フィルタ パラメータは、データストアのタイプに関係なく、ツール パラメータのリストに含まれません。

GroundingConfig

グラウンディング構成。

フィールド
grounding_level	float 省略可。取得されたソースに基づく回答のグラウンディングのしきい値。値の構成可能な範囲は [1, 5] です。このレベルは、回答のグラウンディングのしきい値に使用されます。つまり、グラウンディング スコアがしきい値を下回るすべての回答は、関連するスニペットのみを返すようにフォールバックされます。 たとえば、レベル 3 の場合、レスポンスが返されるには、グラウンディング スコアが 3 以上である必要があります。
disabled	bool 省略可。グラウンディングが無効かどうか。

ModalityConfig

指定した場合、指定されたモダリティに指定された構成が適用されます。

フィールド
modality_type	DataStoreTool.ModalityConfig.ModalityType 必須。モダリティ タイプ。
rewriter_config	DataStoreTool.RewriterConfig 省略可。リライター構成。
summarization_config	DataStoreTool.SummarizationConfig 省略可。要約構成。
grounding_config	DataStoreTool.GroundingConfig 省略可。グラウンディング構成。
snippets_config	DataStoreTool.SnippetsConfig 省略可。スニペットの構成。

ModalityType

モダリティ タイプ。

列挙型
MODALITY_TYPE_UNSPECIFIED	モダリティ タイプが指定されていません。
TEXT	テキスト モダリティ。
AUDIO	音声モダリティ。

RewriterConfig

リライターの構成。

フィールド
model_settings	ModelSettings 必須。LLM モデルの構成。
prompt	string 省略可。プロンプトの定義。設定されていない場合は、デフォルトのプロンプトが使用されます。
disabled	bool 省略可。リライターが無効かどうか。

SnippetsConfig

スニペットの設定。

フィールド
enable_snippets	bool 省略可。スニペットが有効かどうか。
max_snippets	int32 省略可。クエリごとに返すスニペットの数。設定されていない場合は、デフォルトでサービスからすべてのスニペットが返されます。

SummarizationConfig

要約の構成。

フィールド
model_settings	ModelSettings 省略可。LLM モデルの構成。
prompt	string 省略可。プロンプトの定義。設定されていない場合は、デフォルトのプロンプトが使用されます。
disabled	bool 省略可。要約が無効かどうか。

DeleteAgentRequest

AgentService.DeleteAgent のリクエスト メッセージです。

フィールド
name	string 必須。削除するエージェントのリソース名。
force	bool 省略可。他のアプリ、エージェント、例で参照されている場合でも、エージェントを強制的に削除するかどうかを示します。 force = false の場合、他のエージェントや例が参照していると削除に失敗します。 force = true の場合は、エージェントを削除し、参照しているすべてのアプリ、エージェント、例から削除します。
etag	string 省略可。エージェントの現在の ETag。ETag が指定されていない場合、削除によって同時変更が上書きされます。指定された ETag がエージェントの現在の ETag と一致しない場合、削除することはできず、ABORTED エラーが返されます。

DeleteAppRequest

AgentService.DeleteApp のリクエスト メッセージです。

フィールド
name	string 必須。削除するアプリのリソース名。
etag	string 省略可。アプリの現在の etag。etag が指定されていない場合、削除によって同時変更が上書きされます。指定された ETag がアプリの現在の ETag と一致しない場合、削除することはできず、ABORTED エラーが返されます。

DeleteAppVersionRequest

AgentService.DeleteAppVersion のリクエスト メッセージです。

フィールド
name	string 必須。削除するアプリ バージョンのリソース名。
etag	string 省略可。アプリ バージョンの現在の ETag。ETag が指定されていない場合、削除によって同時変更が上書きされます。指定された ETag がアプリ バージョンの現在の ETag と一致しない場合、削除することはできず、ABORTED エラーが返されます。

DeleteConversationRequest

AgentService.DeleteConversation のリクエスト メッセージです。

フィールド
name	string 必須。削除する会話のリソース名。
source (deprecated)	Conversation.Source この項目は非推奨です。 省略可。会話のソースを示します。設定されていない場合は、デフォルトで Source.Live が適用されます。

DeleteDeploymentRequest

AgentService.DeleteDeployment のリクエスト メッセージです。

フィールド
name	string 必須。削除するデプロイの名前。形式: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
etag	string 省略可。デプロイの etag。指定された ETag がデプロイの現在の ETag と一致しない場合、削除することはできず、ABORTED エラーが返されます。

DeleteEvaluationDatasetRequest

EvaluationService.DeleteEvaluationDataset のリクエスト メッセージです。

フィールド
name	string 必須。削除する評価データセットのリソース名。
etag	string 省略可。評価データセットの現在の ETag。ETag が指定されていない場合、削除によって同時変更が上書きされます。指定された ETag が評価データセットの現在の ETag と一致しない場合、削除することはできず、ABORTED エラーが返されます。

DeleteEvaluationExpectationRequest

EvaluationService.DeleteEvaluationExpectation のリクエスト メッセージです。

フィールド
name	string 必須。削除する評価の期待値のリソース名。
etag	string 省略可。評価の期待値の現在の ETag。ETag が指定されていない場合、削除によって同時変更が上書きされます。指定された ETag が評価の期待値の現在の ETag と一致しない場合、削除することはできず、ABORTED エラーが返されます。

DeleteEvaluationRequest

EvaluationService.DeleteEvaluation のリクエスト メッセージです。

フィールド
name	string 必須。削除する評価のリソース名。
force	bool 省略可。評価データセットで参照されている場合でも、評価を強制的に削除するかどうかを示します。 force = false の場合、評価を参照しているデータセットが残っていると、削除は失敗します。 force = true の場合、データセットからの既存の参照がすべて削除され、評価が削除されます。
etag	string 省略可。評価の現在の ETag。ETag が指定されていない場合、削除によって同時変更が上書きされます。指定された ETag が評価の現在の ETag と一致しない場合、削除することはできず、ABORTED エラーが返されます。

DeleteEvaluationResultRequest

EvaluationService.DeleteEvaluationResult のリクエスト メッセージです。

フィールド
name	string 必須。削除する評価結果のリソース名。

DeleteEvaluationRunOperationMetadata

この型にはフィールドがありません。

EvaluationService.DeleteEvaluationRun のオペレーション メタデータ。

DeleteEvaluationRunRequest

EvaluationService.DeleteEvaluationRun のリクエスト メッセージです。

フィールド
name	string 必須。削除する評価実行のリソース名。

DeleteExampleRequest

AgentService.DeleteExample のリクエスト メッセージです。

フィールド
name	string 必須。削除する例のリソース名。
etag	string 省略可。例の現在の ETag。ETag が指定されていない場合、削除によって同時変更が上書きされます。指定された ETag が例の現在の ETag と一致しない場合、削除することはできず、ABORTED エラーが返されます。

DeleteGuardrailRequest

AgentService.DeleteGuardrail のリクエスト メッセージです。

フィールド
name	string 必須。削除するガードレールのリソース名。
force	bool 省略可。アプリやエージェントで参照されている場合でも、ガードレールを強制的に削除するかどうかを示します。 force = false の場合、アプリやエージェントがガードレールを参照していると、削除は失敗します。 force = true の場合、アプリ/エージェントからの既存の参照はすべて削除され、ガードレールも削除されます。
etag	string 省略可。ガードレールの現在の ETag。ETag が指定されていない場合、削除によって同時変更が上書きされます。指定された ETag がガードレールの現在の ETag と一致しない場合、削除することはできず、ABORTED エラーが返されます。

DeleteScheduledEvaluationRunRequest

EvaluationService.DeleteScheduledEvaluationRun のリクエスト メッセージです。

フィールド
name	string 必須。削除するスケジュールされた評価実行のリソース名。
etag	string 省略可。ScheduledEvaluationRun の etag。提供される場合、サーバーの ETag に一致する必要があります。

DeleteToolRequest

AgentService.DeleteTool のリクエスト メッセージです。

フィールド
name	string 必須。削除するツールのリソース名。
force	bool 省略可。エージェントや例で参照されている場合でも、ツールを強制的に削除するかどうかを示します。 force = false の場合、ツールを参照しているエージェントがまだ存在すると、削除は失敗します。 force = true の場合、エージェントからの既存の参照はすべて削除され、ツールは削除されます。
etag	string 省略可。ツールの現在の ETag。ETag が指定されていない場合、削除によって同時変更が上書きされます。指定された ETag がツールの現在の ETag と一致しない場合、削除することはできず、ABORTED エラーが返されます。

DeleteToolsetRequest

AgentService.DeleteToolset のリクエスト メッセージです。

フィールド
name	string 必須。削除するツールセットのリソース名。
force	bool 省略可。アプリやエージェントで参照されている場合でも、ツールセットを強制的に削除するかどうかを示します。 force = false の場合、ツールセットを参照しているエージェントがまだ存在する場合は、削除に失敗します。 force = true の場合、エージェントからの既存の参照はすべて削除され、ツールセットは削除されます。
etag	string 省略可。ツールセットの現在の ETag。ETag が指定されていない場合、削除によって同時変更が上書きされます。指定された ETag がツールセットの現在の ETag と一致しない場合、削除することはできず、ABORTED エラーが返されます。

DeployChannelResponse

AgentService.DeployChannel に対するレスポンス メッセージです。

フィールド
deployment	Deployment 作成されたデプロイ。

デプロイ

デプロイは、アプリの不変でクエリ可能なバージョンを表します。特定のチャンネル プロファイルでアプリのバージョンをデプロイするために使用されます。

フィールド
name	string ID。デプロイのリソース名。形式: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
display_name	string 必須。デプロイの表示名。
app_version	string 省略可。デプロイするアプリ バージョンのリソース名。形式: projects/{project}/locations/{location}/apps/{app}/versions/{version} 下書きアプリを使用するには、projects/{project}/locations/{location}/apps/{app}/versions/- を使用します。
channel_profile	ChannelProfile 必須。デプロイで使用されるチャンネル プロファイル。
create_time	Timestamp 出力専用。このデプロイが作成されたときのタイムスタンプ。
update_time	Timestamp 出力専用。このデプロイが最後に更新されたときのタイムスタンプ。
etag	string 出力専用。読み取り / 変更 / 書き込みオペレーション中にオブジェクトが変更されていないことを確認するために使用される ETag。etag が空の場合、更新によって同時変更が上書きされます。
experiment_config	ExperimentConfig 省略可。デプロイのテスト構成。
whatsapp_credentials	WhatsAppCredentials 省略可。入力専用。WhatsApp チャンネル プロファイルを構成するときに必要なエフェメラル WhatsApp 認証情報。
instagram_credentials	InstagramCredentials 省略可。入力専用。Instagram チャンネル プロフィールを構成する際に必要な一時的な Instagram 認証情報。
model_settings	ModelSettings 省略可。デプロイのモデル設定。アプリ/エージェント レベルで構成されたモデル設定をオーバーライドします。注: デプロイレベルのモデル設定のオーバーライドは、許可リストで制御されます。このフィールドを有効にするには、CXAS チームにお問い合わせください。
modality	Deployment.Modality 省略可。デプロイのモダリティ。注: デプロイレベルのモダリティのオーバーライドは、許可リストでゲートされています。このフィールドを有効にするには、CXAS チームにお問い合わせください。
agent_registry_deployment	AgentRegistryDeployment 省略可。このデプロイを Agent Registry にデプロイするための構成。存在する場合、このデプロイは Agent Registry に公開されます。

モダリティ

デプロイのモダリティ。

列挙型
MODALITY_UNSPECIFIED	不明なモダリティ。
MODALITY_TEXT	テキスト モダリティ。
MODALITY_VOICE	音声モダリティ。
MODALITY_VIDEO	動画モダリティ。

EndSession

セッションが終了したことを示します。終了の理由は、正常に完了した（ユーザーが「さようなら」と言ったなど）か、）またはエージェントによるエスカレーション。

セッションが終了すると、エージェントはそれ以降の入力を処理しません。クライアントは、エージェントから残りのすべてのレスポンスを受信した後、ハーフクローズして切断する必要があります。

フィールド
metadata	Struct 省略可。セッション終了の理由など、セッション終了シグナルに関する追加情報を提供します。

EndUserAuthConfig

Connection 呼び出しに使用されるエンドユーザー認証構成。フィールド値は、$context.variables.<name_of_variable> 形式のコンテキスト変数の名前にする必要があります。

フィールド
共用体フィールド auth_config。認証構成。auth_config は次のいずれかになります。
oauth2_auth_code_config	EndUserAuthConfig.Oauth2AuthCodeConfig OAuth 2.0 認証コード認証。
oauth2_jwt_bearer_config	EndUserAuthConfig.Oauth2JwtBearerConfig JWT プロファイル OAuth 2.0 認可権限付与認証。

Oauth2AuthCodeConfig

OAuth 2.0 認証コードの認証構成。

フィールド
oauth_token	string 必須。渡す OAuth トークン パラメータ名。$context.variables.<name_of_variable> の形式で指定してください。

Oauth2JwtBearerConfig

JWT プロファイル Oauth 2.0 認可権限付与認証構成。

フィールド
issuer	string 必須。渡す発行者パラメータ名。$context.variables.<name_of_variable> の形式で指定してください。
subject	string 必須。渡すサブジェクト パラメータ名。$context.variables.<name_of_variable> の形式で指定してください。
client_key	string 必須。渡すクライアント パラメータ名。$context.variables.<name_of_variable> の形式で指定してください。

EndpointControlPolicy

プロジェクト/ロケーション レベルのエンドポイント制御ポリシーを定義します。

フィールド
enforcement_scope	EndpointControlPolicy.EnforcementScope 省略可。このポリシーの allowed_origins リストが適用されるスコープ。
allowed_origins[]	string 省略可。アプリ内のツールが直接呼び出すことができる許可された HTTP(s) オリジン。適用は、enforcement_scope の値とプロジェクトの VPC-SC ステータスによって異なります。ポート番号が指定されていない場合、すべてのポートが許可されます。それ以外の場合は、ポート番号が完全に一致している必要があります。たとえば、「https://example.com」は「https://example.com:443」やその他のポートと一致します。「https://example.com:443」は「https://example.com:443」にのみ一致します。

EnforcementScope

このポリシーの allowed_origins リストが適用されるスコープを定義します。

列挙型
ENFORCEMENT_SCOPE_UNSPECIFIED	指定なし。このポリシーは VPCSC_ONLY として扱われます。
VPCSC_ONLY	このポリシーは、VPC-SC が有効な場合にのみ適用されます。
ALWAYS	このポリシーは、VPC-SC のステータスに関係なく常に適用されます。

ErrorHandlingSettings

アプリでエラーを処理する方法を記述する設定。

フィールド
error_handling_strategy	ErrorHandlingSettings.ErrorHandlingStrategy 省略可。エラー処理に使用する戦略。
fallback_response_config	ErrorHandlingSettings.FallbackResponseConfig 省略可。フォールバック レスポンスを処理するための構成。
end_session_config	ErrorHandlingSettings.EndSessionConfig 省略可。システムエラー（LLM エラーなど）が発生した場合にセッションを終了するための構成。

EndSessionConfig

システムエラー（LLM エラーなど）が発生した場合にセッションを終了するための構成。

フィールド
escalate_session	bool 省略可。EndSession でセッションをエスカレーションするかどうか。セッションがエスカレーションされた場合、metadata in EndSession に session_escalated = true が含まれます。詳しくは、https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/deploy/google-telephony-platform#transfer_a_call_to_a_human_agent をご覧ください。

ErrorHandlingStrategy

エラー処理の戦略を定義します。

列挙型
ERROR_HANDLING_STRATEGY_UNSPECIFIED	エラー処理方式が指定されていません。
NONE	特別な処理は有効になっていません。
FALLBACK_RESPONSE	システムエラー（LLM エラーなど）が発生した場合、フォールバック メッセージがユーザーに返されます。
END_SESSION	システムエラー（LLM エラーなど）が発生した場合、EndSession シグナルが発行されます。

FallbackResponseConfig

フォールバック レスポンスを処理するための構成。

フィールド
custom_fallback_messages	map<string, string> 省略可。システムエラー（LLM エラーなど）が発生した場合のフォールバック メッセージ。サポートされている言語コードでマッピングされます。
max_fallback_attempts	int32 省略可。エージェントが EndSession シグナルを発行する前に試行するフォールバックの最大回数。

評価

評価は、エージェントのシミュレーションと評価に必要なすべての情報を表します。

フィールド
name	string ID。この評価の固有識別子。形式: projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}
display_name	string 必須。ユーザー定義の評価の表示名。アプリ内で一意。
description	string 省略可。評価のユーザー定義の説明。
tags[]	string 省略可。評価を分類するためのユーザー定義タグ。
evaluation_datasets[]	string 出力専用。評価が属する評価データセットのリスト。形式: projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}
create_time	Timestamp 出力専用。評価が作成されたときのタイムスタンプ。
created_by	string 出力専用。評価を作成したユーザー。
update_time	Timestamp 出力専用。評価が最後に更新されたときのタイムスタンプ。
last_updated_by	string 出力専用。評価を最後に更新したユーザー。
evaluation_runs[]	string 出力専用。この評価に関連付けられている EvaluationRun。
etag	string 出力専用。読み取り / 変更 / 書き込みオペレーション中にオブジェクトが変更されていないことを確認するために使用される ETag。etag が空の場合、更新によって同時変更が上書きされます。
aggregated_metrics	AggregatedMetrics 出力専用。すべての実行にわたるこの評価の集計指標。
last_completed_result	EvaluationResult 出力専用。この評価の最新の評価結果。
invalid	bool 出力専用。評価が無効かどうか。これは、評価が、その後削除されたツール、ツールセット、またはエージェントを参照している場合に発生する可能性があります。
last_ten_results[]	EvaluationResult 出力専用。この評価の過去 10 件の評価結果。これは、ListEvaluationsRequest または GetEvaluationRequest で include_last_ten_results が true に設定されている場合にのみ入力されます。
evaluation_metrics_threshold_override	EvaluationMetricsThresholds 省略可。この特定の評価の指標しきい値をオーバーライドします。
evaluation_metrics_config_override	EvaluationMetricsConfig 省略可。この特定の評価の指標構成をオーバーライドします。
共用体フィールド inputs。評価 inputs の入力は、次のいずれか 1 つのみにできます。
golden	Evaluation.Golden 省略可。評価するゴールデン ステップ。
scenario	Evaluation.Scenario 省略可。シナリオの構成。

Golden

ゴールデン会話を再生するために必要な手順。

フィールド
turns[]	Evaluation.GoldenTurn 必須。ゴールデン会話を再生するために必要なゴールデン ターン。許可される最大ターン数は 100 です。
evaluation_expectations[]	string 省略可。再生された会話を評価するための評価の期待値。形式: projects/{project}/locations/{location}/apps/{app}/evaluationExpectations/{evaluationExpectation}

GoldenExpectation

チェック可能な単一の要件を表します。

フィールド
note	string 省略可。この要件に関するメモ。特定のチェックが失敗した場合のレポートに役立ちます。例: "Check_Payment_Tool_Called".
skip_evaluation	bool 省略可。true に設定すると、この特定の期待値は評価されません。
expectation_level_metrics_thresholds_override	EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.ExpectationLevelMetricsThresholds 省略可。ステップレベルで指標をオーバーライドします。
agent_response_semantic_similarity_metrics_config_override	EvaluationMetricsConfig.SemanticSimilarityMetricsConfig 省略可。agent_response の意味的類似性指標のオーバーライド。
agent_response_hallucination_metrics_config_override	EvaluationMetricsConfig.HallucinationMetricsConfig 省略可。agent_response ハルシネーション指標のオーバーライド。
comparison_type	EvaluationMetricsConfig.ComparisonType 省略可。期待値チェックに使用する比較タイプ。
共用体フィールド condition。実行する実際のチェック。condition は次のいずれかになります。
tool_call	ToolCall 省略可。特定のツールがパラメータとともに呼び出されたことを確認します。
tool_response	ToolResponse 省略可。特定のツールが想定どおりのレスポンスを返したことを確認します。
agent_response	Message 省略可。エージェントが正しい回答で対応していることを確認します。ロール「agent」は暗黙的に指定されます。
agent_transfer	AgentTransfer 省略可。エージェントが会話を別のエージェントに転送したことを確認します。
updated_variables	Struct 省略可。エージェントがセッション変数を想定どおりの値に更新したことを確認します。ゴールデン評価用のエージェント変数の更新もキャプチャするために使用されます。
mock_tool_response	ToolResponse 省略可。モックするツールのレスポンス。対象のパラメータが指定されています。指定されていないパラメータは LLM によってハルシネーションされます。
no_tool_calls	bool 省略可。このターンでツールが呼び出されなかったことを確認します。

GoldenTurn

ゴールデン ターンは、ゴールデン会話の 1 つのターンを定義します。

フィールド
steps[]	Evaluation.Step 必須。ゴールデン会話を再生するために必要な手順。
root_span	Span 省略可。音声情報の処理と維持のためのゴールデン ターンのルート スパン。音声の URI には、16 Khz のサンプリング レートで保存された音声を含める必要があります。
turn_level_metrics_thresholds_override	EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds 省略可。ターンレベルの指標のしきい値のオーバーライド。
hallucination_metric_behavior_override	EvaluationMetricsThresholds.HallucinationMetricBehavior 省略可。ターンレベルのハルシネーション指標の動作をオーバーライドします。

シナリオ

シナリオの構成

フィールド
task	string 必須。シナリオのターゲットとなるタスク。
user_facts[]	Evaluation.Scenario.UserFact 省略可。シナリオで使用されるユーザーの事実。
max_turns	int32 省略可。シミュレートするターンの最大数。最大値は 100 です。デフォルト値は 100 です。
rubrics[]	string 必須。シナリオを評価するためのルーブリック。
scenario_expectations[]	Evaluation.ScenarioExpectation 必須。ユーザー シミュレーションによって生成された会話を評価する ScenarioExpectations。
variable_overrides	Struct 省略可。セッションのコンテキストとしての変数 / セッション パラメータ。変数名でキー設定されます。この構造体のメンバーは、システムによって設定されたデフォルト値をオーバーライドします。 なお、これらはユーザーが知っている事実であるユーザーの事実とは異なります。変数はエージェントが認識しているパラメータです。たとえば、テレフォニー システムから渡された MDN（電話番号）などです。
task_completion_behavior (deprecated)	Evaluation.Scenario.TaskCompletionBehavior この項目は非推奨です。 省略可。非推奨。代わりに user_goal_behavior を使用してください。
user_goal_behavior	Evaluation.Scenario.UserGoalBehavior 省略可。ユーザー目標の想定される動作。
evaluation_expectations[]	string 省略可。シミュレーションによって生成された会話を評価するための評価の期待値。形式: projects/{project}/locations/{location}/apps/{app}/evaluationExpectations/{evaluationExpectation}
scenario_execution_mode	EvaluationSettings.ScenarioExecutionMode 省略可。シナリオ評価の実行モード。

TaskCompletionBehavior

ユーザー タスクの想定される動作。これは、シナリオが成功したかどうかを判断するために使用されます。

列挙型
TASK_COMPLETION_BEHAVIOR_UNSPECIFIED	動作が指定されていません。デフォルトは TASK_SATISFIED になります。
TASK_SATISFIED	ユーザー タスクが正常に完了している必要があります。
TASK_REJECTED	ユーザー タスクは拒否されます。

UserFact

ユーザーに関する事実を Key-Value ペアで表します。

フィールド
name	string 必須。ユーザー ファクトの名前。
value	string 必須。ユーザー ファクトの値。

UserGoalBehavior

ユーザー目標の想定される動作。これは、シナリオが成功したかどうかを判断するために使用されます。

列挙型
USER_GOAL_BEHAVIOR_UNSPECIFIED	動作が指定されていません。デフォルトは USER_GOAL_SATISFIED になります。
USER_GOAL_SATISFIED	ユーザー目標が正常に完了している必要があります。
USER_GOAL_REJECTED	ユーザーの目標は拒否される必要があります。
USER_GOAL_IGNORED	ユーザーの目標ステータスは無視します。

ScenarioExpectation

シミュレーションによって生成された会話を評価するための期待値。

フィールド
共用体フィールド expectation。シミュレーションによって生成された会話を評価するための期待値。expectation は次のいずれかになります。
tool_expectation	Evaluation.ScenarioExpectation.ToolExpectation 省略可。評価するツール呼び出しとレスポンスのペア。
agent_response	Message 省略可。評価するエージェントのレスポンス。

ToolExpectation

評価するツール呼び出しとレスポンスのペア。

フィールド
expected_tool_call	ToolCall 必須。対象のパラメータが指定された、想定されるツール呼び出し。指定されていないパラメータは LLM によってハルシネーションされます。
mock_tool_response	ToolResponse 必須。モックするツールのレスポンス。対象のパラメータが指定されています。指定されていないパラメータは LLM によってハルシネーションされます。

ステップ

ステップは、評価中に発生する単一のアクションを定義します。

フィールド
共用体フィールド step。実行するステップ。step は次のいずれかになります。
user_input	SessionInput 省略可。会話のユーザー入力。
agent_transfer	AgentTransfer 省略可。会話を別のエージェントに転送します。
expectation	Evaluation.GoldenExpectation 省略可。現在のターンで期待値を実行します。

EvaluationConfig

EvaluationConfig は、評価の実行に関する設定を構成します。

フィールド
input_audio_config	InputAudioConfig 省略可。入力音声の処理の構成。
output_audio_config	OutputAudioConfig 省略可。出力音声の生成に関する構成。
evaluation_channel	EvaluationConfig.EvaluationChannel 省略可。評価するチャネル。
tool_call_behaviour	EvaluationToolCallBehaviour 省略可。評価で実際のツール呼び出しを使用するか、偽のツールを使用するかを指定します。

EvaluationChannel

評価するチャネル。

列挙型
EVALUATION_CHANNEL_UNSPECIFIED	評価チャンネルが指定されていません。
TEXT	テキストのみの評価チャネル。
AUDIO	音声評価チャンネル。

EvaluationDataset

評価データセットは、共有タグに基づいてグループ化された一連の評価を表します。

フィールド
name	string ID。この評価データセットの固有識別子。形式: projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}
display_name	string 必須。評価データセットのユーザー定義の表示名。アプリ内で一意。
evaluations[]	string 省略可。このデータセットに含まれる評価。
create_time	Timestamp 出力専用。評価データセットが作成されたときのタイムスタンプ。
update_time	Timestamp 出力専用。評価データセットが最後に更新されたときのタイムスタンプ。
etag	string 出力専用。読み取り / 変更 / 書き込みオペレーション中にオブジェクトが変更されていないことを確認するために使用される ETag。etag が空の場合、更新によって同時変更が上書きされます。
created_by	string 出力専用。評価データセットを作成したユーザー。
last_updated_by	string 出力専用。評価データセットを最後に更新したユーザー。
aggregated_metrics	AggregatedMetrics 出力専用。この評価データセットのすべての実行にわたる集計指標。

EvaluationErrorInfo

評価の実行中に発生したエラーに関する情報。

フィールド
error_type	EvaluationErrorInfo.ErrorType 出力専用。エラーの種類。
error_message	string 出力専用。エラー メッセージ。
session_id	string 出力専用。エラーの原因となった会話のセッション ID。
user_facing_error_message	string 出力専用。ユーザーに表示されるエラー メッセージ。

ErrorType

エラーの種類

列挙型
ERROR_TYPE_UNSPECIFIED	エラータイプが指定されていません。
RUNTIME_FAILURE	ランタイム実行中のエラー。
CONVERSATION_RETRIEVAL_FAILURE	CES ランタイムから会話を取得できませんでした。
METRIC_CALCULATION_FAILURE	指標 / 結果を計算できない。
EVALUATION_UPDATE_FAILURE	評価を更新できませんでした。
QUOTA_EXHAUSTED	割り当てを使い切りました。
USER_SIMULATION_FAILURE	ユーザー シミュレーション中にエラーが発生しました。

EvaluationExpectation

評価の期待値は、評価に使用する特定の基準を表します。

フィールド
name	string ID。この評価の期待値の固有識別子。形式: projects/{project}/locations/{location}/apps/{app}/evaluationExpectations/{evaluation_expectation}
display_name	string 必須。ユーザー定義の表示名。アプリ内で一意である必要があります。
tags[]	string 省略可。期待値のユーザー定義タグ。期待値をフィルタするために使用できます。
create_time	Timestamp 出力専用。評価の期待値が作成されたときのタイムスタンプ。
update_time	Timestamp 出力専用。評価の期待値が最後に更新されたときのタイムスタンプ。
etag	string 出力専用。読み取り / 変更 / 書き込みオペレーション中にオブジェクトが変更されていないことを確認するために使用される ETag。etag が空の場合、更新によって同時変更が上書きされます。
共用体フィールド criteria。評価に使用される基準の定義。criteria は次のいずれかになります。
llm_criteria	EvaluationExpectation.LlmCriteria 省略可。LLM プロンプトに基づく評価基準。

LlmCriteria

LLM ベースの評価基準の構成。

フィールド
prompt	string 必須。LLM ジャッジに提供されるプロンプト/指示。

EvaluationMetricsConfig

評価の指標を構成します。

フィールド
golden_metrics_config	EvaluationMetricsConfig.GoldenMetricsConfig 省略可。評価のゴールデン指標の構成。
scenario_metrics_config	EvaluationMetricsConfig.ScenarioMetricsConfig 省略可。評価のシナリオ指標の構成。

ComparisonType

エージェントのレスポンスを確認するためにサポートされている比較タイプ。

列挙型
COMPARISON_TYPE_UNSPECIFIED	比較タイプが指定されていません。エージェントの回答とツール呼び出しの動作は、デフォルトで SEMANTIC_SIMILARITY に設定されています。
EQUALS	文字列が完全に一致します。
CONTAINS	部分文字列の一致（実際のレスポンスに期待される文字列が含まれているかどうかを確認します）。
SEMANTIC_SIMILARITY	意味的類似性の一致（LLM を使用して意味的類似性を評価します）。

ExpectationsMetMetricsConfig

評価の期待値レベルの指標の構成。指標を無効にするには、メッセージを設定しますが、enable_expectations_met_metrics フィールドを true に設定しません（または、明示的に false に設定します）。構成を解除してデフォルトの動作に戻すには、メッセージを完全に省略します。

フィールド
enable_expectations_met_metrics	bool 省略可。評価の期待値レベルの指標を計算するかどうか。

GoldenMetricsConfig

評価のゴールデン指標の構成。

フィールド
semantic_similarity_metrics_config	EvaluationMetricsConfig.SemanticSimilarityMetricsConfig 省略可。セマンティック類似性指標のグローバル構成。
tool_correctness_metrics_config	EvaluationMetricsConfig.ToolCorrectnessMetricsConfig 省略可。ターンレベルのツールの正確性指標の構成。
step_tool_correctness_metrics_config	EvaluationMetricsConfig.ToolCorrectnessMetricsConfig 省略可。ステップレベルのツールの正しさの指標の構成。

HallucinationMetricsConfig

評価のハルシネーション指標の構成。指標を無効にするには、メッセージを設定しますが、enable_hallucination_metrics フィールドを true に設定しません（または、明示的に false に設定します）。構成を解除してデフォルトの動作に戻すには、メッセージを完全に省略します。

フィールド
enable_hallucination_metrics	bool 省略可。評価のハルシネーション指標を計算するかどうか。

ScenarioMetricsConfig

評価のシナリオ指標の構成。

フィールド
user_goal_met_metrics_config	EvaluationMetricsConfig.UserGoalMetMetricsConfig 省略可。ユーザー目標達成指標の構成。
expectations_met_metrics_config	EvaluationMetricsConfig.ExpectationsMetMetricsConfig 省略可。期待値レベルの指標の構成。

SemanticSimilarityMetricsConfig

評価の類似性指標の構成。指標を無効にするには、メッセージを設定しますが、enable_semantic_similarity_metrics フィールドを true に設定しません（または、明示的に false に設定します）。構成を解除してデフォルトの動作に戻すには、メッセージを完全に省略します。

フィールド
enable_semantic_similarity_metrics	bool 省略可。評価のセマンティック類似性指標を計算するかどうか。

ToolCorrectnessMetricsConfig

評価の正しさ指標の構成。指標を無効にするには、メッセージを設定しますが、enable_tool_correctness_metrics フィールドを true に設定しません（または、明示的に false に設定します）。構成を解除してデフォルトの動作に戻すには、メッセージを完全に省略します。

フィールド
enable_tool_correctness_metrics	bool 省略可。評価でツールの正しさの指標を計算するかどうか。

UserGoalMetMetricsConfig

評価のユーザー目標達成指標の構成。指標を無効にするには、メッセージを設定しますが、enable_user_goal_met_metrics フィールドを true に設定しません（または、明示的に false に設定します）。構成を解除してデフォルトの動作に戻すには、メッセージを完全に省略します。

フィールド
enable_user_goal_met_metrics	bool 省略可。評価でユーザー目標達成指標を計算するかどうか。

EvaluationMetricsThresholds

評価の指標のしきい値設定。

フィールド
golden_evaluation_metrics_thresholds	EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds 省略可。ゴールデン評価指標のしきい値。
hallucination_metric_behavior (deprecated)	EvaluationMetricsThresholds.HallucinationMetricBehavior この項目は非推奨です。 省略可。非推奨: 代わりに、golden_hallucination_metric_behavior を使用してください。現在、ハルシネーション指標の動作はゴールデン評価に使用されています。
golden_hallucination_metric_behavior	EvaluationMetricsThresholds.HallucinationMetricBehavior 省略可。ゴールデン評価のハルシネーション指標の動作。
scenario_hallucination_metric_behavior	EvaluationMetricsThresholds.HallucinationMetricBehavior 省略可。シナリオ評価のハルシネーション指標の動作。

GoldenEvaluationMetricsThresholds

ゴールデン評価の設定。

フィールド
turn_level_metrics_thresholds	EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds 省略可。ターンレベルの指標のしきい値。
expectation_level_metrics_thresholds	EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.ExpectationLevelMetricsThresholds 省略可。期待値レベルの指標のしきい値。
tool_matching_settings	EvaluationMetricsThresholds.ToolMatchingSettings 省略可。ツール マッチングの設定。余分なツール呼び出しとは、実行には存在するものの、ゴールデン エクスペクテーションのツール呼び出しと一致しないツール呼び出しのことです。

ExpectationLevelMetricsThresholds

期待レベルの指標のしきい値。

フィールド
tool_invocation_parameter_correctness_threshold	float 省略可。個々のツール呼び出しパラメータの正しさの成功しきい値。0 ～ 1 の浮動小数点数にする必要があります。デフォルトは 1.0 です。

TurnLevelMetricsThresholds

ターンレベルの指標のしきい値をオンにします。

フィールド
semantic_similarity_channel	EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds.SemanticSimilarityChannel 省略可。評価に使用するセマンティック類似性チャネル。
semantic_similarity_success_threshold	int32 省略可。意味的類似性の成功しきい値。0 ～ 4 の整数を指定してください。デフォルトは 3 以上です。
overall_tool_invocation_correctness_threshold	float 省略可。ツール呼び出しの全体的な正しさの成功しきい値。0 ～ 1 の浮動小数点数にする必要があります。デフォルトは 1.0 です。

SemanticSimilarityChannel

使用する意味的類似性チャンネル。

列挙型
SEMANTIC_SIMILARITY_CHANNEL_UNSPECIFIED	指標が指定されていません。デフォルトは TEXT です。
TEXT	テキストのセマンティック類似性を使用します。
AUDIO	音声の意味的類似性を使用します。

HallucinationMetricBehavior

ハルシネーション指標の動作。動作に関係なく、指標は常に計算されます。無効にすると、指標が総合評価スコアの計算に使用されなくなる点が異なります。

列挙型
HALLUCINATION_METRIC_BEHAVIOR_UNSPECIFIED	ハルシネーション指標の動作が指定されていません。
DISABLED	ハルシネーション指標を無効にします。
ENABLED	ハルシネーション指標を有効にします。

ToolMatchingSettings

ツール呼び出しのマッチングの設定。

フィールド
extra_tool_call_behavior	EvaluationMetricsThresholds.ToolMatchingSettings.ExtraToolCallBehavior 省略可。追加のツール呼び出しの動作。デフォルトは FAIL です。

ExtraToolCallBehavior

追加のツール呼び出しが発生した場合の動作を定義します。余分なツール呼び出しとは、実行には存在するものの、ゴールデン エクスペクテーションのツール呼び出しと一致しないツール呼び出しのことです。

列挙型
EXTRA_TOOL_CALL_BEHAVIOR_UNSPECIFIED	未指定の動作。デフォルトは FAIL です。
FAIL	余分なツール呼び出しが発生した場合は、評価を不合格にします。
ALLOW	追加のツール呼び出しを許可します。

EvaluationPersona

ペルソナは、評価におけるエンドユーザーを表します。

フィールド
name	string 必須。ペルソナの固有識別子。形式: projects/{project}/locations/{location}/apps/{app}/evaluationPersonas/{evaluationPersona}
description	string 省略可。ペルソナの説明。
display_name	string 必須。ペルソナの表示名。アプリ内で一意。
personality	string 必須。評価でどのように動作するかについてのエージェントへの指示。
speech_config	EvaluationPersona.SpeechConfig 省略可。ペルソナの音声（テキスト読み上げの設定）に関する構成。

SpeechConfig

Text-to-Speech 生成の構成。

フィールド
speaking_rate	double 省略可。発話速度。1.0 が正常です。値が小さいほど遅く（0.8 など）、値が大きいほど速くなります（1.5 など）。エージェントが早口の話し手をどのように処理するかをテストするのに役立ちます。
environment	EvaluationPersona.SpeechConfig.BackgroundEnvironment 省略可。シミュレートされたオーディオ環境。
voice_id	string 省略可。使用する特定の音声識別子/アクセント。例: 「en-US-Wavenet-D」、「en-GB-Standard-A」

BackgroundEnvironment

シミュレートされたオーディオ環境。

列挙型
BACKGROUND_ENVIRONMENT_UNSPECIFIED	バックグラウンド環境が指定されていません。
CALL_CENTER	コールセンター環境。
TRAFFIC	交通騒音環境。
KIDS_NOISE	子どもの騒音環境。
CAFE	カフェ環境。

EvaluationResult

評価結果は、評価の実行結果を表します。

フィールド
name	string ID。評価結果の固有識別子。形式: projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}/results/{result}
display_name	string 必須。評価結果の表示名。評価内で一意。デフォルトでは、「 結果 - 」という形式になります。
create_time	Timestamp 出力専用。評価結果が作成されたときのタイムスタンプ。
evaluation_status	EvaluationResult.Outcome 出力専用。評価の結果。execution_state が COMPLETE の場合にのみ入力されます。
evaluation_run	string 出力専用。この結果を生成した評価実行。形式: projects/{project}/locations/{location}/apps/{app}/evaluationRuns/{evaluationRun}
persona	EvaluationPersona 出力専用。評価結果の会話の生成に使用されたペルソナ。
error_info	EvaluationErrorInfo 出力専用。評価結果のエラー情報。
error (deprecated)	Status この項目は非推奨です。 出力専用。非推奨: 代わりに、error_info を使用してください。実行中に発生したエラー。
initiated_by	string 出力専用。この結果をもたらした評価実行を開始したユーザー。
app_version	string 出力専用。この結果につながった会話の生成に使用されたアプリのバージョン。形式: projects/{project}/locations/{location}/apps/{app}/versions/{version}
app_version_display_name	string 出力専用。評価が実行された app_version の表示名。
changelog	string 出力専用。評価が実行されたアプリ バージョンの変更ログ。これは、ユーザーが最新版/下書き版で評価を実行した場合に設定されます。
changelog_create_time	Timestamp 出力専用。評価が実行されたアプリ バージョンの変更ログの作成時間。これは、ユーザーが最新版/下書き版で評価を実行した場合に設定されます。
execution_state	EvaluationResult.ExecutionState 出力専用。評価結果の実行状態。
evaluation_metrics_thresholds	EvaluationMetricsThresholds 出力専用。結果の評価しきい値。
config	EvaluationConfig 出力専用。この結果をもたらした評価実行で使用された構成。
golden_run_method	GoldenRunMethod 出力専用。ゴールデン評価の実行に使用されるメソッド。
root_span	Span 出力専用。評価実行のルートスパン。評価の各ステップに関する情報が含まれます。
outcome_metadata	EvaluationResult.OutcomeMetadata 出力専用。評価の結果メタデータ。execution_state が COMPLETE の場合にのみ入力されます。
共用体フィールド result。評価の結果。execution_state が COMPLETED の場合にのみ入力されます。result は次のいずれかになります。
golden_result	EvaluationResult.GoldenResult 出力専用。ゴールデン評価の結果。
scenario_result	EvaluationResult.ScenarioResult 出力専用。シナリオ評価の結果。

EvaluationExpectationResult

単一の評価の期待値の結果。

フィールド
evaluation_expectation	string 出力専用。評価の期待値。形式: projects/{project}/locations/{location}/apps/{app}/evaluationExpectations/{evaluation_expectation}
prompt	string 出力専用。評価に使用されたプロンプト。
outcome	EvaluationResult.Outcome 出力専用。評価の期待値の結果。
explanation	string 出力専用。結果の説明。

ExecutionState

評価結果の実行状態。

列挙型
EXECUTION_STATE_UNSPECIFIED	評価結果の実行状態が指定されていません。
QUEUED	評価結果の実行がキューに登録されます。
RUNNING	評価結果の実行中です。
COMPLETED	評価結果の実行が完了しました。
ERROR	内部エラーのため、評価結果の実行に失敗しました。
CANCELLED	評価結果の実行がキャンセルされました。

GoldenExpectationOutcome

期待値とその結果を指定します。

フィールド
expectation	Evaluation.GoldenExpectation 出力専用。評価された期待値。
outcome	EvaluationResult.Outcome 出力専用。期待の結果。
semantic_similarity_result (deprecated)	EvaluationResult.SemanticSimilarityResult この項目は非推奨です。 出力専用。意味的類似性チェックの結果。
tool_invocation_result	EvaluationResult.GoldenExpectationOutcome.ToolInvocationResult 出力専用。ツール呼び出しチェックの結果。
共用体フィールド result。期待の結果。result は次のいずれかになります。
observed_tool_call	ToolCall 出力専用。ツール呼び出しの期待値の結果。
observed_tool_response	ToolResponse 出力専用。ツール レスポンスの期待値の結果。
observed_agent_response	Message 出力専用。エージェントの回答の期待値の結果。
observed_agent_transfer	AgentTransfer 出力専用。エージェント転送の期待値の結果。
observed_payload	Struct 出力専用。観測されたカスタム ペイロード。カスタム ペイロードに関する期待値はありません。これは指標の計算にのみ使用されます。結果は常に SKIPPED になります。

ToolInvocationResult

ツール呼び出しチェックの結果。

フィールド
outcome	EvaluationResult.Outcome 出力専用。ツール呼び出しチェックの結果。これは、parameter_correctness_score をしきい値と比較することで判断されます。スコアがしきい値以上の場合、結果は合格になります。それ以外の場合、結果は FAIL になります。
explanation	string 出力専用。ツール呼び出しの結果に関する自由形式の説明。
parameter_correctness_score	float 出力専用。ツール呼び出しパラメータの正確性スコア。これは、実際のツール呼び出しにも含まれていた、想定されるツール呼び出しのパラメータの割合を示します。

GoldenResult

ゴールデン評価の結果。

フィールド
turn_replay_results[]	EvaluationResult.GoldenResult.TurnReplayResult 出力専用。ゴールデン会話の各ターンの実行結果。
evaluation_expectation_results[]	EvaluationResult.EvaluationExpectationResult 出力専用。評価の期待値の結果。

TurnReplayResult

ゴールデン会話の 1 ターンを実行した結果。

フィールド
conversation	string 出力専用。このターンで生成された会話。
expectation_outcome[]	EvaluationResult.GoldenExpectationOutcome 出力専用。各期待値の結果。
hallucination_result	EvaluationResult.HallucinationResult 出力専用。ハルシネーション チェックの結果。
tool_invocation_score (deprecated)	float この項目は非推奨です。 出力専用。非推奨。代わりに OverallToolInvocationResult を使用してください。
turn_latency	Duration 出力専用。ターンの期間。
tool_call_latencies[]	EvaluationResult.ToolCallLatency 出力専用。ターンの各ツール呼び出しのレイテンシ。
semantic_similarity_result	EvaluationResult.SemanticSimilarityResult 出力専用。意味的類似性チェックの結果。
overall_tool_invocation_result	EvaluationResult.OverallToolInvocationResult 出力専用。ツール呼び出しの全体的なチェックの結果。
error_info	EvaluationErrorInfo 出力専用。このターン中に発生したエラーに関する情報。
span_latencies[]	EvaluationResult.SpanLatency 出力専用。ターンのスパンのレイテンシ。
tool_ordered_invocation_score	float 出力専用。このターンのツール注文呼び出しの総合スコア。これは、期待されるターンのツールが、期待される順序で実際に呼び出された割合を示します。

HallucinationResult

単一ターンのハルシネーション チェックの結果。

フィールド
label	string 出力専用。各スコアに関連付けられたラベル。スコア 1: 正当なスコア 0: 正当でないスコア -1: 評価する申し立てなし
explanation	string 出力専用。ハルシネーション スコアの説明。
score	int32 出力専用。ハルシネーション スコア。-1、0、1 のいずれかになります。

結果

評価または期待の結果。

列挙型
OUTCOME_UNSPECIFIED	評価結果が指定されていません。
PASS	評価/期待値に合格しました。評価の場合、これはすべての期待値が満たされたことを意味します。
FAIL	評価/期待値に失敗しました。評価の場合、これは少なくとも 1 つの期待値が満たされなかったことを意味します。
SKIPPED	評価/期待値がスキップされました。

OutcomeMetadata

評価の結果に関するメタデータ。

列挙型
OUTCOME_METADATA_UNSPECIFIED	未指定の結果メタデータ。
GRACEFUL_HANDOFF	評価の結果、人間の担当者にスムーズに引き継がれました。

OverallToolInvocationResult

ツール呼び出しの全体的なチェックの結果。

フィールド
outcome	EvaluationResult.Outcome 出力専用。ツール呼び出しチェックの結果。これは、tool_invocation_score と overall_tool_invocation_correctness_threshold を比較して判断されます。スコアがしきい値以上の場合、結果は合格になります。それ以外の場合、結果は FAIL になります。
tool_invocation_score	float このターンのツール呼び出しの総合スコア。これは、期待されるターンから実際に呼び出されたツールの全体的な割合を示します。

ScenarioExpectationOutcome

シナリオの期待の結果。

フィールド
expectation	Evaluation.ScenarioExpectation 出力専用。評価された期待値。
outcome	EvaluationResult.Outcome 出力専用。ScenarioExpectation の結果。
共用体フィールド result。期待の結果。result は次のいずれかになります。
observed_tool_call	EvaluationResult.ScenarioExpectationOutcome.ObservedToolCall 出力専用。観測されたツール呼び出し。
observed_agent_response	Message 出力専用。観測されたエージェントのレスポンス。

ObservedToolCall

観測されたツール呼び出しとレスポンス。

フィールド
tool_call	ToolCall 出力専用。観測されたツール呼び出し。
tool_response	ToolResponse 出力専用。観測されたツールのレスポンス。

ScenarioResult

シナリオ評価の結果。

フィールド
conversation	string 出力専用。シナリオで生成された会話。
task	string 出力専用。この結果のシナリオを実行したときに使用されたタスク。
user_facts[]	Evaluation.Scenario.UserFact 出力専用。この結果のシナリオで使用されたユーザー ファクト。
expectation_outcomes[]	EvaluationResult.ScenarioExpectationOutcome 出力専用。各期待値の結果。
rubric_outcomes[]	EvaluationResult.ScenarioRubricOutcome 出力専用。ルーブリックの結果。
hallucination_result[]	EvaluationResult.HallucinationResult 出力専用。ハルシネーション チェックの結果。会話のターンごとに 1 つのハルシネーション結果が返されます。
task_completion_result (deprecated)	EvaluationResult.TaskCompletionResult この項目は非推奨です。 出力専用。タスク完了チェックの結果。
tool_call_latencies[]	EvaluationResult.ToolCallLatency 出力専用。会話内の各ツール呼び出しの実行レイテンシ。
user_goal_satisfaction_result	EvaluationResult.UserGoalSatisfactionResult 出力専用。ユーザー目標の達成度チェックの結果。
span_latencies[]	EvaluationResult.SpanLatency 出力専用。会話内のスパンのレイテンシ。
evaluation_expectation_results[]	EvaluationResult.EvaluationExpectationResult 出力専用。評価の期待値の結果。
all_expectations_satisfied	bool 出力専用。このターンのすべての期待値が満たされたかどうか。
task_completed	bool 出力専用。このターンでタスクが完了したかどうか。これは、満たされたすべての期待、ハルシネーションの発生なし、ユーザーの目標達成度の複合指標です。

ScenarioRubricOutcome

ルーブリックに対する評価の結果。

フィールド
rubric	string 出力専用。会話の評価に使用されたルーブリック。
score_explanation	string 出力専用。ルーブリックに対する評価者の回答。
score	float 出力専用。ルーブリックに対する会話のスコア。

SemanticSimilarityResult

意味的類似性チェックの結果。

フィールド
label	string 出力専用。各スコアに関連付けられたラベル。スコア 4: 完全に一貫している スコア 3: ほぼ一貫している スコア 2: 部分的に一貫している（軽微な欠落がある） スコア 1: ほぼ一貫していない（重大な欠落がある） スコア 0: 完全に一貫していない / 矛盾している
explanation	string 出力専用。意味的類似性スコアの説明。
outcome	EvaluationResult.Outcome 出力専用。意味的類似性チェックの結果。これは、スコアと semantic_similarity_success_threshold を比較して判断されます。スコアがしきい値以上の場合、結果は合格になります。それ以外の場合、結果は FAIL になります。
score	int32 出力専用。意味的類似度スコア。0、1、2、3、4 のいずれかになります。

SpanLatency

スパン実行のレイテンシ。

フィールド
type	EvaluationResult.SpanLatency.Type 出力専用。スパンのタイプ。
display_name	string 出力専用。スパンの表示名。ツールとガードレールのスパンに適用されます。
start_time	Timestamp 出力専用。スパンの開始時間。
end_time	Timestamp 出力専用。スパンの終了時間。
execution_latency	Duration 出力専用。スパンのレイテンシ。
共用体フィールド identifier。タイプに基づく特定のアイテムの識別子。identifier は次のいずれかになります。
resource	string 出力専用。ガードレールまたはツールのスパンのリソース名。
toolset	ToolsetTool 出力専用。ツールセット ツールの ID。
model	string 出力専用。LLM スパンの名前。
callback	string 出力専用。ユーザー コールバック スパンの名前。

タイプ

スパンのタイプ。今後、値が追加される可能性があります。

列挙型
TYPE_UNSPECIFIED	デフォルト値。この値は使用されません。
TOOL	ツール呼び出しスパン。
USER_CALLBACK	ユーザー コールバック スパン。
GUARDRAIL	ガードレールのスパン。
LLM	LLM スパン。

TaskCompletionResult

会話のタスク完了チェックの結果。

フィールド
label	string 出力専用。各スコアに関連付けられたラベル。スコア 1: タスク完了 スコア 0: タスク未完了 スコア -1: ユーザーの目標が未定義
explanation	string 出力専用。タスク完了スコアの説明。
score	int32 出力専用。タスク完了のスコア。-1、0、1 のいずれかになります。

ToolCallLatency

ツール呼び出しの実行レイテンシ。

フィールド
tool	string 出力専用。実行されたツールの名前。形式: projects/{project}/locations/{location}/apps/{app}/tools/{tool}。
display_name	string 出力専用。ツールの表示名。
start_time	Timestamp 出力専用。ツール呼び出しの実行の開始時間。
end_time	Timestamp 出力専用。ツール呼び出しの実行の終了時間。
execution_latency	Duration 出力専用。ツール呼び出しの実行レイテンシ。

UserGoalSatisfactionResult

会話のユーザー目標の達成度チェックの結果。

フィールド
label	string 出力専用。各スコアに関連付けられたラベル。スコア 2: Graceful Handoff スコア 1: User Task Satisfied スコア 0: User Task Not Satisfied スコア -1: User Task Unspecified
explanation	string 出力専用。ユーザー タスクの満足度スコアの説明。
score	int32 出力専用。ユーザー タスクの満足度スコア。-1、0、1、2 のいずれかになります。

EvaluationRun

評価実行は、評価実行のすべての評価結果を表します。

フィールド
name	string ID。評価実行の固有識別子。形式: projects/{project}/locations/{location}/apps/{app}/evaluationRuns/{evaluationRun}
display_name	string 省略可。評価実行のユーザー定義の表示名。デフォルト: 「 run - 」。
evaluation_results[]	string 出力専用。この実行の一部である評価結果。形式: projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}/results/{result}
create_time	Timestamp 出力専用。評価の実行が作成されたときのタイムスタンプ。
initiated_by	string 出力専用。評価実行を開始したユーザー。
app_version	string 出力専用。評価するアプリのバージョン。形式: projects/{project}/locations/{location}/apps/{app}/versions/{version}
app_version_display_name	string 出力専用。評価が実行された app_version の表示名。
changelog	string 出力専用。評価が実行されたアプリ バージョンの変更ログ。これは、ユーザーが最新版/下書き版で評価を実行した場合に設定されます。
changelog_create_time	Timestamp 出力専用。評価が実行されたアプリ バージョンの変更ログの作成時間。これは、ユーザーが最新版/下書き版で評価を実行した場合に設定されます。
evaluations[]	string 出力専用。この実行に含まれる評価。リストには、どちらのタイプの評価も含まれる場合があります。このフィールドは evaluation_dataset と相互に排他的です。形式: projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}
evaluation_dataset	string 出力専用。この実行に関連付けられている評価データセット。このフィールドは evaluations と相互に排他的です。形式: projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}
evaluation_type	EvaluationRun.EvaluationType 出力専用。この実行の評価のタイプ。
state	EvaluationRun.EvaluationRunState 出力専用。評価実行の状態。
progress	EvaluationRun.Progress 出力専用。評価実行の進行状況。
config	EvaluationConfig 出力専用。実行で使用される構成。
error (deprecated)	Status この項目は非推奨です。 出力専用。非推奨: 代わりに error_info を使用してください。実行中に発生したエラー。
error_info	EvaluationErrorInfo 出力専用。評価実行のエラー情報。
evaluation_run_summaries	map<string, EvaluationRun.EvaluationRunSummary> 出力専用。評価名と EvaluationRunSummary のマッピング。
latency_report	LatencyReport 出力専用。評価実行のレイテンシ レポート。
run_count	int32 出力専用。実行内の評価が実行された回数。
persona_run_configs[]	PersonaRunConfig 出力専用。ペルソナごとに実行に使用する構成。
optimization_config	OptimizationConfig 省略可。評価実行後に最適化ステップを実行するための構成。設定されていない場合、最適化ステップは実行されません。
scheduled_evaluation_run	string 出力専用。この評価実行を作成したスケジュールされた評価実行のリソース名。このフィールドは、評価実行がスケジュールされた評価実行によって作成された場合にのみ設定されます。形式: projects/{project}/locations/{location}/apps/{app}/scheduledEvaluationRuns/{scheduled_evaluation_run}
golden_run_method	GoldenRunMethod 出力専用。評価の実行に使用されるメソッド。
operation	string 出力専用。この評価実行を作成したオペレーション。形式: projects/{project}/locations/{location}/operations/{operation}

EvaluationRunState

評価実行の状態。

列挙型
EVALUATION_RUN_STATE_UNSPECIFIED	評価実行の状態が指定されていません。
QUEUED	評価の実行がキューに登録されていることを示します。
RUNNING	評価実行が実行中です。
COMPLETED	評価の実行が完了しました。
ERROR	評価の実行にエラーがあります。
CANCELLED	評価の実行がキャンセルされました。

EvaluationRunSummary

評価の実行における特定の評価の合格と不合格の結果数の概要が含まれます。

フィールド
passed_count	int32 出力専用。この実行で関連付けられた評価の合格結果の数。
failed_count	int32 出力専用。この実行で関連付けられた評価の失敗した結果の数。
error_count	int32 出力専用。この実行に関連付けられた評価のエラー結果の数。

EvaluationType

この実行の評価のタイプ。今後、値が追加される可能性があります。

列挙型
EVALUATION_TYPE_UNSPECIFIED	評価タイプが指定されていません。
GOLDEN	ゴールデン評価。
SCENARIO	シナリオの評価。
MIXED	実行にゴールデン評価とシナリオ評価の両方が含まれていることを示します。

進行状況

評価実行の進行状況。

フィールド
total_count	int32 出力専用。この実行の評価結果の合計数。
failed_count	int32 出力専用。結果が FAIL の評価結果の完了数。（EvaluationResult.execution_state が COMPLETED で、EvaluationResult.evaluation_status が FAIL）。
error_count	int32 出力専用。実行に失敗した評価結果の数。（EvaluationResult.execution_state が ERROR）。
completed_count	int32 出力専用。正常に終了した評価結果の数。（EvaluationResult.execution_state が COMPLETED）。
passed_count	int32 出力専用。結果が PASS の完了した評価結果の数。（EvaluationResult.execution_state が COMPLETED で、EvaluationResult.evaluation_status が PASS）。
cancelled_count	int32 出力専用。キャンセルされた評価結果の数。（EvaluationResult.execution_state が CANCELLED）。

EvaluationRunCachingSettings

評価実行のキャッシュ保存の設定。

フィールド
run_caching_mode	EvaluationRunCachingSettings.EvaluationRunCachingMode 省略可。評価実行に使用するキャッシュ保存モード。設定しない場合、デフォルトは FORCE_RUN になります。

EvaluationRunCachingMode

評価結果のキャッシュ保存動作。最後に完了した評価結果（存在する場合）を返すか、新しい評価を実行するかを制御します。

列挙型
EVALUATION_RUN_CACHING_MODE_UNSPECIFIED	実行のキャッシュ保存モードが指定されていません。
FORCE_RUN	変更ログの有無にかかわらず、常に完全なライブ シミュレーションを実行します。
SKIP_IF_UNCHANGED	依存関係が変更されておらず、評価チャネル/実行メソッドが同じ場合は、実行をスキップして以前の検証済み結果をコピーします。

EvaluationSettings

評価の設定。

フィールド
scenario_conversation_initiator	EvaluationSettings.ScenarioConversationInitiator 省略可。シナリオ評価で会話を開始するユーザー。
golden_run_method	GoldenRunMethod 省略可。ゴールデン評価の実行に使用されるデフォルトのメソッド。これは、RunEvaluationRequest で golden_run_method が指定されていない場合に使用されます。
golden_evaluation_tool_call_behaviour	EvaluationToolCallBehaviour 省略可。ゴールデン評価のデフォルトのツール呼び出し動作を構成します。
scenario_evaluation_tool_call_behaviour	EvaluationToolCallBehaviour 省略可。シナリオ評価のデフォルトのツール呼び出し動作を構成します。
metrics_config	EvaluationMetricsConfig 省略可。評価のデフォルト指標を構成します。
scenario_execution_mode	EvaluationSettings.ScenarioExecutionMode 省略可。シナリオ評価の実行モード。指定しない場合、デフォルトは QUALITY_OPTIMIZED になります。
evaluation_run_caching_settings	EvaluationRunCachingSettings 省略可。評価実行に使用するキャッシュ設定。

ScenarioConversationInitiator

シナリオ評価セッションで会話を開始するユーザーを決定します。

列挙型
SCENARIO_CONVERSATION_INITIATOR_UNSPECIFIED	指定なし。デフォルトは USER です。
USER	ユーザーが会話を開始します。
AGENT	エージェントが会話を開始します。

ScenarioExecutionMode

シナリオ評価の実行モード。

列挙型
SCENARIO_EXECUTION_MODE_UNSPECIFIED	実行モードが指定されていません。デフォルトは QUALITY_OPTIMIZED です。
QUALITY_OPTIMIZED	品質最適化モード。
SPEED_OPTIMIZED	速度最適化モード。

EvaluationToolCallBehaviour

評価実行のツール呼び出しの動作を構成します。

列挙型
EVALUATION_TOOL_CALL_BEHAVIOUR_UNSPECIFIED	ツール呼び出しの動作が指定されていません。デフォルトでは実際のツール呼び出しになります。
REAL	実際のツール呼び出しを使用します。
FAKE	偽のツール呼び出しを使用します。

イベント

イベント入力。

フィールド
event	string 必須。イベントの名前。
variables	Struct 省略可。イベントに関連付けられた追加の変数。

例

例は、ユーザーとエージェント間の会話のサンプルを表します。

フィールド
name	string ID。例の固有識別子。形式: projects/{project}/locations/{location}/apps/{app}/examples/{example}
display_name	string 必須。例の表示名。
description	string 省略可。例の説明（人が読める形式）。
entry_agent	string 省略可。会話に最初に対応するエージェント。指定されていない場合、この例はルート エージェントによって処理される会話を表します。形式: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
messages[]	Message 省略可。会話を構成するメッセージのコレクション。
create_time	Timestamp 出力専用。例が作成されたときのタイムスタンプ。
update_time	Timestamp 出力専用。例が最後に更新されたときのタイムスタンプ。
invalid	bool 出力専用。参照リソースが削除されると、例が無効になることがあります。無効な例は少数ショットの例として使用されません。
etag	string 読み取り / 変更 / 書き込みオペレーション中にオブジェクトが変更されていないことを確認するために使用される ETag。etag が空の場合、更新によって同時変更が上書きされます。

ExecuteToolRequest

ToolService.ExecuteTool のリクエスト メッセージです。

フィールド
parent	string 必須。ツール/ツールセットが属するアプリのリソース名。形式: projects/{project}/locations/{location}/apps/{app}
args	Struct 省略可。JSON オブジェクト形式のツールの入力パラメータと値。
mock_config	MockConfig 省略可。ツール実行のモック構成。このフィールドが設定されている場合、他のツールを呼び出すツールは、指定されたパターンとレスポンスに基づいてモックされます。
共用体フィールド tool_identifier。実行するツールの識別子。永続化されたツールまたはツールセットのツールです。tool_identifier は次のいずれかになります。
tool	string 省略可。実行するツールの名前。形式: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolset_tool	ToolsetTool 省略可。実行するツールセット ツール。ツールセットの述語に一致するツールは 1 つだけです。それ以外の場合は、エラーが返されます。
共用体フィールド tool_execution_context。ツール実行 tool_execution_context に提供される追加のコンテキストは、次のいずれかになります。
variables	Struct 省略可。ツールの実行に使用できる変数。
context	Struct 省略可。Python ツールに渡される [ToolCallContext]（詳細については、https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/python#environment をご覧ください）。

ExecuteToolResponse

ToolService.ExecuteTool に対するレスポンス メッセージです。

フィールド
response	Struct JSON オブジェクト形式のツール実行結果。「output」キーを使用してツールのレスポンスを指定し、「error」キーを使用してエラーの詳細を指定します（ある場合）。「output」キーと「error」キーが指定されていない場合、レスポンス全体がツール実行結果として扱われます。
variables	Struct ツールの実行終了時の変数値。
citations	Citations ツールの実行に関するソース情報を提供する引用。
google_search_suggestions	GoogleSearchSuggestions ツールの実行中に Google 検索ツールを呼び出した結果として Google 検索から返された候補。
共用体フィールド tool_identifier。実行されたツールの ID。tool_identifier は次のいずれかになります。
tool	string 実行されたツールの名前。形式: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolset_tool	ToolsetTool 実行されたツールセット ツール。

ExecutionType

ツールまたはツールセットの実行タイプ。

列挙型
EXECUTION_TYPE_UNSPECIFIED	実行タイプが指定されていません。指定しない場合のデフォルトは SYNCHRONOUS です。
SYNCHRONOUS	ツールは同期的に実行されます。ツールが戻るまで、セッションはブロックされます。
ASYNCHRONOUS	このツールは非同期で実行されます。ツールが実行されている間、セッションは継続されます。

ExperimentConfig

デプロイのテスト。

フィールド
version_release	ExperimentConfig.VersionRelease 省略可。テストのバージョン リリース。

状態

テストの状態。

列挙型
STATE_UNSPECIFIED	未指定の状態
PENDING	非推奨: この状態は使用されなくなりました。
RUNNING	実行状態。テストが実行中で有効です。
DONE	非推奨: この状態は使用されなくなりました。
EXPIRED	非推奨: この状態は使用されなくなりました。

VersionRelease

テストのバージョン リリース。

フィールド
state	ExperimentConfig.State 省略可。バージョンのリリースの状態。
traffic_allocations[]	ExperimentConfig.VersionRelease.TrafficAllocation 省略可。バージョン リリースのトラフィック割り当て。

TrafficAllocation

バージョン リリースのトラフィックの割り当て。

フィールド
id	string 省略可。トラフィックの割り当ての ID。自由形式の文字列。最大 128 文字。
traffic_percentage	int32 省略可。トラフィックの割り当てのトラフィックの割合。0 ～ 100 の範囲で指定してください。
app_version	string 省略可。トラフィックの割り当てのアプリのバージョン。形式: projects/{project}/locations/{location}/apps/{app}/versions/{version}

ExportAppRequest

AgentService.ExportApp のリクエスト メッセージです。

フィールド
name	string 必須。エクスポートするアプリのリソース名。
export_format	ExportAppRequest.ExportFormat 必須。アプリをエクスポートする形式。
gcs_uri	string 省略可。アプリをエクスポートする Google Cloud Storage URI。この URI の形式は gs://<bucket-name>/<object-name> である必要があります。エクスポートされたアプリ アーカイブは、指定された GCS オブジェクトに直接書き込まれます。
app_version	string 省略可。エクスポートするアプリ バージョンのリソース名。形式: projects/{project}/locations/{location}/apps/{app}/versions/{version}。

ExportFormat

アプリのエクスポート形式。

列挙型
EXPORT_FORMAT_UNSPECIFIED	エクスポート形式が指定されていません。
JSON	エクスポート形式は JSON です。
YAML	エクスポート形式は YAML です。

ExportAppResponse

AgentService.ExportApp に対するレスポンス メッセージです。

フィールド
共用体フィールド app。エクスポートされたアプリ。app は次のいずれかになります。
app_content	bytes アプリのフォルダが ZIP ファイルとして圧縮されています。
app_uri	string アプリがエクスポートされた Google Cloud Storage URI。

ExportEvaluationResultsOperationMetadata

この型にはフィールドがありません。

EvaluationService.ExportEvaluationResults のオペレーション メタデータ。

ExportEvaluationResultsRequest

EvaluationService.ExportEvaluationResults のリクエスト メッセージです。

フィールド
parent	string 必須。評価結果をエクスポートする評価のリソース名。形式: projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}
names[]	string 必須。エクスポートする評価結果のリソース名。
export_options	ExportOptions 省略可。評価結果のエクスポート オプション。

ExportEvaluationResultsResponse

EvaluationService.ExportEvaluationResults に対するレスポンス メッセージです。

フィールド
共用体フィールド evaluation_results。エクスポートされた評価結果。evaluation_results は次のいずれかになります。
evaluation_results_content	bytes エクスポートされた評価結果の内容。これは、リクエストで gcs_uri が指定されていない場合に設定されます。
evaluation_results_uri	string エクスポートされた評価結果が書き込まれた Google Cloud Storage URI フォルダ。これは、リクエストで gcs_uri が指定されている場合に設定されます。

ExportEvaluationRunsOperationMetadata

この型にはフィールドがありません。

EvaluationService.ExportEvaluationRuns のオペレーション メタデータ。

ExportEvaluationRunsRequest

EvaluationService.ExportEvaluationRuns のリクエスト メッセージです。

フィールド
parent	string 必須。評価実行をエクスポートするアプリのリソース名。形式: projects/{project}/locations/{location}/apps/{app}
names[]	string 必須。エクスポートする評価実行のリソース名。
export_options	ExportOptions 省略可。評価実行のエクスポート オプション。

ExportEvaluationRunsResponse

EvaluationService.ExportEvaluationRuns に対するレスポンス メッセージです。

フィールド
共用体フィールド evaluation_runs。エクスポートされた評価実行。evaluation_runs は次のいずれかになります。
evaluation_runs_content	bytes エクスポートされた評価実行の内容。これは、リクエストで gcs_uri が指定されていない場合に設定されます。
evaluation_runs_uri	string エクスポートされた評価実行が書き込まれた Google Cloud Storage URI フォルダ。これは、リクエストで gcs_uri が指定されている場合に設定されます。

ExportEvaluationsRequest

EvaluationService.ExportEvaluations のリクエスト メッセージです。

フィールド
parent	string 必須。評価をエクスポートするアプリのリソース名。形式: projects/{project}/locations/{location}/apps/{app}
names[]	string 必須。エクスポートする評価のリソース名。
export_options	ExportOptions 省略可。評価のエクスポート オプション。
include_evaluation_results	bool 省略可。エクスポートに評価結果を含めます。include_evaluation_results または include_evaluations の少なくとも 1 つを設定する必要があります。
include_evaluations	bool 省略可。エクスポートに評価を含めます。include_evaluation_results または include_evaluations の少なくとも 1 つを設定する必要があります。

ExportEvaluationsResponse

EvaluationService.ExportEvaluations に対するレスポンス メッセージです。

フィールド
failed_evaluations	map<string, string> 出力専用。エクスポートできなかった評価リソース名と、その理由のマッピング。
共用体フィールド evaluations。エクスポートされた評価。evaluations は次のいずれかになります。
evaluations_content	bytes エクスポートされた評価の内容。これは、リクエストで gcs_uri が指定されていない場合に設定されます。
evaluations_uri	string エクスポートされた評価が書き込まれた Google Cloud Storage URI フォルダ。これは、リクエストで gcs_uri が指定されている場合に設定されます。

ExportOptions

CES 評価リソースをエクスポートするためのオプション。

フィールド
export_format	ExportOptions.ExportFormat 省略可。評価結果をエクスポートする形式。指定しない場合、デフォルトは JSON です。
gcs_uri	string 省略可。エクスポートされた評価結果を書き込む Google Cloud Storage URI。

ExportFormat

アイテムをエクスポートする形式。指定しない場合、デフォルトは JSON です。

列挙型
EXPORT_FORMAT_UNSPECIFIED	未指定の形式。
JSON	記述できます。
YAML	できます

ExpressionCondition

セッションの状態に基づく式条件。

フィールド
expression	string 必須。cloud.api.Expression 条件の文字列表現。

FileContext

コンテキストとして使用するファイル。ファイルは RAW バイトとして提供できます。

フィールド
共用体フィールド file。コンテキストとして提供されるファイル。file は次のいずれかになります。
file_bytes	FileContext.FileBytes 省略可。未加工バイトとして提供されるファイル。

FileBytes

未加工バイトとして提供されるファイル。

フィールド
file_name	string 必須。未加工のバイトとして提供されるファイルの名前。
mime_type	string 必須。ソースデータの IANA 標準 MIME タイプ。
data	bytes 必須。ファイルの未加工のバイト数。

FileSearchTool

ファイル検索ツールを使用すると、アプリ/エージェント デベロッパーがアップロードしたファイルを検索できます。アップロードされたファイルに対する比較的質の高い検索と、取得された結果の要約を行うプリセットが用意されています。

フィールド
corpus_type	FileSearchTool.CorpusType 省略可。コーパスのタイプ。デフォルトは FULLY_MANAGED です。
name	string 必須。ツールの名前。
description	string 省略可。ツールの説明。
file_corpus	string 省略可。ファイルが保存されているコーパス。形式: projects/{project}/locations/{location}/ragCorpora/{rag_corpus}

CorpusType

Vertex RAG コーパスのタイプ。

列挙型
CORPUS_TYPE_UNSPECIFIED	コーパスタイプが指定されていません。
USER_OWNED	コーパスはユーザーが作成して所有します。
FULLY_MANAGED	コーパスはエージェントによって作成されます。

GenerateAppResourceOperationMetadata

AgentService.GenerateAppResource のオペレーション メタデータ。

フィールド
generation_type	GenerateAppResourceOperationMetadata.GenerationType 出力専用。オペレーションのタイプ。
message	string 出力専用。人が読める形式のオペレーションのステータス（存在する場合）。
create_time	Timestamp 出力専用。オペレーションが作成された時刻。
end_time	Timestamp 出力専用。オペレーションの実行が終了した時刻。
target	string 出力専用。オペレーションが関連付けられているアプリのリソース名。形式: projects/{project}/locations/{location}/apps/{app}。
partial_errors[]	Status 出力専用。リソース生成プロセスからのエラー メッセージ。

GenerationType

生成オペレーションのタイプ。

列挙型
GENERATION_TYPE_UNSPECIFIED	指定されていないオペレーション タイプ。
AGENT_RESTRUCTURE	エージェント指示の再構築タイプ。
AGENT_REFINE	エージェント向けの指示の絞り込みタイプ。
AGENT_CREATE	タイプからのエージェントの作成。
TOOL_CREATE	ツールの作成タイプ。
SCENARIO_CREATE	シナリオの作成タイプ。
SCENARIO_CREATE_FROM_TRANSCRIPTS	文字起こしタイプからのシナリオ作成。
EVALUATION_PERSONA_CREATE	評価ペルソナの生成タイプ。
QUALITY_REPORT_CREATE	品質レポートの生成タイプ。
INSTRUCTION_FOLLOWING_FIX	命令追跡修正タイプ（ヒルクライミング修正に使用）。

GenerateAppResourceRequest

AgentService.GenerateAppResource のリクエスト メッセージです。

フィールド
parent	string 必須。リソースを生成するアプリのリソース名。
refine_instructions[]	GenerateAppResourceRequest.RefineInstructions 省略可。リソースの絞り込みに使用する絞り込み手順のリスト。
tool_generation_config	GenerateAppResourceRequest.ToolGenerationConfig 省略可。ツールの生成に使用される構成。
app_generation_config	GenerateAppResourceRequest.AppGenerationConfig 省略可。エージェントとツールの生成に使用される構成。
evaluation_generation_config	GenerateAppResourceRequest.EvaluationGenerationConfig 省略可。評価の生成に使用される構成。
evaluation_personas_generation_config	GenerateAppResourceRequest.EvaluationPersonasGenerationConfig 省略可。評価ペルソナの生成に使用される構成。
quality_report_generation_config	GenerateAppResourceRequest.QualityReportGenerationConfig 省略可。品質レポートの生成に使用される構成。
hill_climbing_fix_config	GenerateAppResourceRequest.HillClimbingFixConfig 省略可。ヒルクライミング修正に使用する構成。
共用体フィールド resource。生成するリソース。resource は次のいずれかになります。
agent	Agent LLM アシスタントで使用されるエージェント リソース。新しいエージェントを生成する場合は空にできます。
tool	Tool LLM アシスタントで使用されるツールリソース。新しいツールを生成する場合は空にできます。
toolset	Toolset LLM アシスタントで使用されるツールセット リソース。新しいツールセットを生成する場合は空にできます。
app_version_context	GenerateAppResourceRequest.AppVersionContext ベース スナップショットとターゲット エージェントを指定するアプリ バージョン コンテキスト。

AppGenerationConfig

アプリの生成に使用される構成。

フィールド
context	string 省略可。生成されるエージェントとツールの要件を記述するコンテキスト。
file_contexts[]	FileContext 省略可。コンテキストとして使用するファイル。
dataset_id	string 省略可。エージェントとツールの生成のために会話データを取得するために使用される分析情報データセット。形式: projects/{project}/locations/{location}/datasets/{dataset}。
generate_evaluations	bool 省略可。アプリの評価を生成するかどうか。true の場合、指定されたコンテキストを使用して評価データが生成されます。
gcs_location	string 省略可。Datastore ツールで使用される生成された質問回答データを保存する Cloud Storage のロケーション。このデータは、会話データを入力ソースとして使用する場合にのみ生成されます。ロケーションはアプリと同じプロジェクトに存在する必要があります。形式: gs://...。

AppVersionContext

ベース スナップショットとターゲット エージェントを指定するアプリ バージョン コンテキスト。

フィールド
app_version	string LLM アシスタントで使用されるアプリ バージョンのリソース名。形式: projects/{project}/locations/{location}/apps/{app}/versions/{version}
agent_resource_name	string LLM アシスタントが使用するターゲット エージェントのリソース名。形式: projects/{project}/locations/{location}/apps/{app}/agents/{agent}

EvaluationGenerationConfig

評価の生成に使用される構成。

フィールド
dataset_id	string 省略可。評価の生成のために会話データを取得するために使用される分析情報データセット。形式: projects/{project}/locations/{location}/datasets/{dataset}。

EvaluationPersonasGenerationConfig

この型にはフィールドがありません。

評価ペルソナの生成に使用される構成。

HillClimbingFixConfig

ヒルクライミング修正に使用する構成。

フィールド
quality_report	QualityReport 必須。修正後の手順を通知するために使用された品質レポート。

QualityReportGenerationConfig

品質レポートの生成に使用される構成。

フィールド
evaluation_run	string 必須。品質レポートの分析に使用される評価実行。
algorithm	GenerateAppResourceRequest.QualityReportGenerationConfig.LossAttributionAlgorithm 省略可。使用する損失アトリビューション アルゴリズム。

LossAttributionAlgorithm

損失アトリビューションに使用するアルゴリズム。

列挙型
LOSS_ATTRIBUTION_ALGORITHM_UNSPECIFIED	指定なし。
APP_CENTRIC	アプリ中心の損失アトリビューション。アプリを単一のユニットとして扱います。
AGENT_CENTRIC	エージェント中心の損失アトリビューション。個々のエージェントに損失を割り当てます。

RefineInstructions

リソースの一部を絞り込むために使用する手順。リソースの一部は、開始インデックス、終了インデックス、フィールド マスクで指定できます。たとえば、エージェントの指示の一部を絞り込む場合は、指示の最初の文字のインデックス、指示の最後の文字のインデックス、フィールド マスクを「instructions」として指定できます。

フィールド
start_index	int64 必須。絞り込むテキストの最初の文字（この値を含む）。
end_index	int64 必須。絞り込むテキストの最後の文字（この値を含む）。
field_mask	FieldMask 必須。絞り込み対象のリソースのフィールド。RefineInstructions ごとに許可されるフィールドは 1 つのみです。エージェントの指示を調整する場合は、フィールド マスクを「instructions」にする必要があります。
instructions	string 必須。リソースを調整する手順。

ToolGenerationConfig

ツールの生成に使用される構成。

フィールド
context	string 省略可。生成するツールを説明するコンテキスト。ツール リクエストとレスポンスが提供されている場合は、空にできます。
file_contexts[]	FileContext 省略可。コンテキストとして使用するファイル。
open_api_toolset_generation_config	GenerateAppResourceRequest.ToolGenerationConfig.OpenApiToolsetGenerationConfig 省略可。Open API スキーマの生成に使用される構成。

OpenApiToolsetGenerationConfig

Open API スキーマの生成に使用される構成。

フィールド
uri	string 必須。ツールのベース URI。
operation_generation_configs[]	GenerateAppResourceRequest.ToolGenerationConfig.OpenApiToolsetGenerationConfig.OperationGenerationConfig 必須。Open API スキーマに追加するオペレーションのリスト。

OperationGenerationConfig

Open API スキーマでオペレーションを生成するために使用される構成。

フィールド
method	string 必須。ツールの URI。これには、クエリ パラメータとパス パラメータが含まれます。
path	string 必須。ベース URI に追加されるツールのパス。これには、クエリ パラメータとパス パラメータが含まれます。
request_json	string 必須。JSON 形式のツールへのリクエストの例。ツールがリクエスト本文をサポートしていない場合はスキップします。
response_json	string 必須。JSON 形式のツールからのレスポンスの例。

GenerateAppResourceResponse

AgentService.GenerateAppResource に対するレスポンス メッセージです。

フィールド
generate_result_info	GenerateAppResourceResponse.GenerateResultInfo 生成された結果に関する追加情報。
共用体フィールド generated_resource。生成されたリソース。generated_resource は次のいずれかになります。
agent	Agent LLM アシスタントによって生成されたエージェント。
toolset	Toolset LLM アシスタントによって生成されたツールセット。Open API ツールセットのスキーマ生成をサポートします。
app_snapshot	AppSnapshot LLM アシスタントによって生成されたアプリのスナップショット。このスナップショットには、LLM アシスタントによって生成されたアプリ、エージェント、ツールが含まれています。
tools	GenerateAppResourceResponse.Tools LLM アシスタントによって生成されたツールのリスト。
evaluations	GenerateAppResourceResponse.Evaluations LLM アシスタントによって生成された評価。
app_resources	GenerateAppResourceResponse.AppResources LLM アシスタントによって生成されたアプリリソース。
quality_report	QualityReport LLM アシスタントによって生成された品質レポート。

AppResources

LLM アシスタントによって生成されたアプリリソースのリスト。

フィールド
app_snapshot	AppSnapshot LLM アシスタントによって生成されたアプリのスナップショット。このスナップショットには、LLM アシスタントによって生成されたアプリ、エージェント、ツールが含まれています。
evaluations[]	Evaluation LLM アシスタントによって生成された評価のリスト。

評価

LLM アシスタントによって生成された評価のリスト。

フィールド
evaluations[]	Evaluation 生成された評価のリスト。

GenerateResultInfo

これにより、生成された結果に関する追加情報が提供されます。

フィールド
explanation	string 生成されたリソースの変更の説明。

ツール

LLM アシスタントによって生成されたツールのリスト。

フィールド
tools[]	Tool LLM アシスタントによって生成されたツールのリスト。

GenerateChatTokenRequest

WidgetService.GenerateChatToken のリクエスト メッセージです。

フィールド
name	string 必須。チャット トークンを生成するセッション名。形式: projects/{project}/locations/{location}/apps/{app}/sessions/{session}
deployment	string 必須。セッションで使用するアプリのデプロイ。形式: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
recaptcha_token	string 省略可。クライアントサイドのチャット ウィジェットによって生成された reCAPTCHA トークン。
live_handoff_enabled	bool 省略可。セッションでライブ ハンドオフが有効になっているかどうかを示します。

GenerateChatTokenResponse

WidgetService.GenerateChatToken に対するレスポンス メッセージです。

フィールド
chat_token	string Session API で認証するためのチャット ウィジェットのセッション スコープ トークン。
expire_time	Timestamp チャット トークンの有効期限。

GenerateEvaluationOperationMetadata

この型にはフィールドがありません。

EvaluationService.GenerateEvaluation のオペレーション メタデータ。

GenerateEvaluationRequest

EvaluationService.GenerateEvaluation のリクエスト メッセージです。

フィールド
conversation	string 必須。ゴールデン評価を作成する会話。形式: projects/{project}/locations/{location}/apps/{app}/conversations/{conversation}
source (deprecated)	Conversation.Source この項目は非推奨です。 省略可。会話のソースを示します。設定しない場合、すべてのソースが検索されます。
evaluation_type	GenerateEvaluationRequest.EvaluationType 省略可。生成する評価のタイプ。指定しない場合のデフォルトは GOLDEN です。

EvaluationType

生成する評価のタイプ。

列挙型
EVALUATION_TYPE_UNSPECIFIED	未指定のタイプ。デフォルトは GOLDEN です。
GOLDEN	ゴールデン評価。
SCENARIO	シナリオの評価。

GetAgentRequest

AgentService.GetAgent のリクエスト メッセージです。

フィールド
name	string 必須。取得するエージェントのリソース名。

GetAppRequest

AgentService.GetApp のリクエスト メッセージです。

フィールド
name	string 必須。取得するアプリのリソース名。

GetAppVersionRequest

AgentService.GetAppVersion のリクエスト メッセージです。

フィールド
name	string 必須。取得するアプリ バージョンのリソース名。

GetChangelogRequest

AgentService.GetChangelog のリクエスト メッセージです。

フィールド
name	string 必須。取得する変更ログのリソース名。

GetConversationRequest

AgentService.GetConversation のリクエスト メッセージです。

フィールド
name	string 必須。取得する会話のリソース名。
source (deprecated)	Conversation.Source この項目は非推奨です。 省略可。会話のソースを示します。設定しない場合、すべてのソースが検索されます。

GetDeploymentRequest

AgentService.GetDeployment のリクエスト メッセージです。

フィールド
name	string 必須。デプロイの名前。形式: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}

GetEvaluationDatasetRequest

EvaluationService.GetEvaluationDataset のリクエスト メッセージです。

フィールド
name	string 必須。取得する評価データセットのリソース名。

GetEvaluationExpectationRequest

EvaluationService.GetEvaluationExpectation のリクエスト メッセージです。

フィールド
name	string 必須。取得する評価の期待値のリソース名。

GetEvaluationRequest

EvaluationService.GetEvaluation のリクエスト メッセージです。

フィールド
name	string 必須。取得する評価のリソース名。

GetEvaluationResultRequest

EvaluationService.GetEvaluationResult のリクエスト メッセージです。

フィールド
name	string 必須。取得する評価結果のリソース名。

GetEvaluationRunRequest

EvaluationService.GetEvaluationRun のリクエスト メッセージです。

フィールド
name	string 必須。取得する評価実行のリソース名。

GetExampleRequest

AgentService.GetExample のリクエスト メッセージです。

フィールド
name	string 必須。取得する例のリソース名。

GetGuardrailRequest

AgentService.GetGuardrail のリクエスト メッセージです。

フィールド
name	string 必須。取得するガードレールのリソース名。

GetScheduledEvaluationRunRequest

EvaluationService.GetScheduledEvaluationRun のリクエスト メッセージです。

フィールド
name	string 必須。取得するスケジュール設定された評価実行のリソース名。

GetSecuritySettingsRequest

AgentService.GetSecuritySettings のリクエスト メッセージです。

フィールド
name	string 必須。取得するセキュリティ設定のリソース名。形式: projects/{project}/locations/{location}/securitySettings

GetToolRequest

AgentService.GetTool のリクエスト メッセージです。

フィールド
name	string 必須。取得するツールのリソース名。

GetToolsetRequest

AgentService.GetToolset のリクエスト メッセージです。

フィールド
name	string 必須。取得するツールセットのリソース名。

GoAway

この型にはフィールドがありません。

サーバーがまもなく切断されるため、クライアントが接続をハーフクローズして再起動する必要があることを示します。

GoldenRunMethod

評価の実行に使用されるメソッド。

列挙型
GOLDEN_RUN_METHOD_UNSPECIFIED	実行メソッドが指定されていません。
STABLE	評価を安定した再生として実行します。各ターンは一意のセッションであり、前の予想されるターンがコンテキストとして挿入されます。
NAIVE	評価をナイーブな再生として実行します。この実行は、コンテキストが挿入されていない単一のセッションです。

GoogleSearchSuggestions

Google Search Tool からの検索候補。

フィールド
htmls[]	string 検索候補の準拠する HTML と CSS のスタイル。提供される HTML と CSS は、デバイスの設定に自動的に適応し、@media(prefers-color-scheme) で示されるライトモードまたはダークモードで表示されます。
web_search_queries[]	WebSearchQuery Google 検索の実行に使用されたクエリのリストと、検索候補を構成する検索結果 URI。

GoogleSearchTool

グラウンディングのために Google ウェブ検索を実行するツールを表します。https://cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool#google-search をご覧ください。

フィールド
name	string 必須。ツールの名前。
description	string 省略可。ツールの目的の説明。
context_urls[]	string 省略可。コンテンツは、コンテキストとグラウンディングのためにこれらの URL から直接取得されます。例: "https://example.com/path.html"。指定できる URL は 20 個までです。
preferred_domains[]	string 省略可。検索結果を制限するドメインを指定します。例: "example.com"、"another.site"。指定できるドメインは最大 20 個です。
exclude_domains[]	string 省略可。検索結果から除外するドメインのリスト。例: "example.com"。除外できるドメインは最大 2,000 個です。
prompt_config	GoogleSearchTool.PromptConfig 省略可。テキストと音声の検索結果を処理する方法について、プランナーに渡されるプロンプトの指示。

PromptConfig

Google 検索結果の処理または要約時にモデルで使用されるプロンプト設定。

フィールド
text_prompt	string 省略可。チャット会話でエージェントとやり取りする際に、システム指示に使用されるプロンプトを定義します。設定されていない場合は、デフォルトのプロンプトが使用されます。
voice_prompt	string 省略可。音声会話でエージェントとやり取りする際に、システム指示に使用されるプロンプトを定義します。設定されていない場合は、デフォルトのプロンプトが使用されます。

ガードレール

ガードレールには、エージェントの安全性とセキュリティを維持するためのチェックとバランスのリストが含まれています。

フィールド
name	string ID。ガードレールの固有識別子。形式: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}
display_name	string 必須。ガードレールの表示名。
description	string 省略可。ガードレールの説明。
enabled	bool 省略可。ガードレールが有効かどうか。
action	TriggerAction 省略可。ガードレールがトリガーされたときに実行するアクション。
create_time	Timestamp 出力専用。ガードレールが作成されたときのタイムスタンプ。
update_time	Timestamp 出力専用。ガードレールが最後に更新されたときのタイムスタンプ。
etag	string 読み取り / 変更 / 書き込みオペレーション中にオブジェクトが変更されていないことを確認するために使用される ETag。etag が空の場合、更新によって同時変更が上書きされます。
共用体フィールド guardrail_type。ガードレールのタイプ。guardrail_type は次のいずれかになります。
content_filter	Guardrail.ContentFilter 省略可。特定のコンテンツが会話で使用されないようにするガードレール。
llm_prompt_security	Guardrail.LlmPromptSecurity 省略可。LLM の分類に基づいてプロンプトが安全でないと判断された場合に、会話をブロックするガードレール。
llm_policy	Guardrail.LlmPolicy 省略可。LLM の分類に基づいて LLM レスポンスがポリシーに違反していると判断された場合に、会話をブロックするガードレール。
model_safety	Guardrail.ModelSafety 省略可。モデルの安全に関する設定に基づいて LLM のレスポンスが安全でないと判断された場合に、会話をブロックするガードレール。
code_callback	Guardrail.CodeCallback 省略可。コールバック実行の結果に基づいて会話をブロックする可能性のあるガードレール。
supervisor	Guardrail.Supervisor 省略可。監督者の介入を実行するガードレール。

CodeCallback

提供されたコード コールバックに基づいて会話をブロックするガードレール。

フィールド
before_agent_callback	Callback 省略可。エージェントが呼び出される前に実行するコールバック。各コールバック関数は、少なくとも次のものを含む構造（辞書やオブジェクトなど）を返すことが想定されています。- 'decision': 'OK' または 'TRIGGER' のいずれか。- 'reason': 判定を説明する文字列。「TRIGGER」の判定により、それ以降の処理が停止されることがあります。
after_agent_callback	Callback 省略可。エージェントの呼び出し後に実行するコールバック。各コールバック関数は、少なくとも次のものを含む構造（辞書やオブジェクトなど）を返すことが想定されています。- 'decision': 'OK' または 'TRIGGER' のいずれか。- 'reason': 判定を説明する文字列。「TRIGGER」の判定により、それ以降の処理が停止されることがあります。
before_model_callback	Callback 省略可。モデルが呼び出される前に実行するコールバック。モデルへの呼び出しが複数ある場合、コールバックは複数回実行されます。各コールバック関数は、少なくとも次のものを含む構造（辞書やオブジェクトなど）を返すことが想定されています。- 'decision': 'OK' または 'TRIGGER' のいずれか。- 'reason': 判定を説明する文字列。「TRIGGER」の判定により、それ以降の処理が停止されることがあります。
after_model_callback	Callback 省略可。モデルの呼び出し後に実行するコールバック。モデルへの呼び出しが複数ある場合、コールバックは複数回実行されます。各コールバック関数は、少なくとも次のものを含む構造（辞書やオブジェクトなど）を返すことが想定されています。- 'decision': 'OK' または 'TRIGGER' のいずれか。- 'reason': 判定を説明する文字列。「TRIGGER」の判定により、それ以降の処理が停止されることがあります。

ContentFilter

特定のコンテンツが会話で使用されないようにするガードレール。

フィールド
banned_contents[]	string 省略可。禁止されたフレーズのリスト。ユーザー入力とエージェントの回答の両方に適用されます。
banned_contents_in_user_input[]	string 省略可。禁止されたフレーズのリスト。ユーザー入力にのみ適用されます。
banned_contents_in_agent_response[]	string 省略可。禁止されたフレーズのリスト。エージェントの回答にのみ適用されます。
match_type	Guardrail.ContentFilter.MatchType 必須。コンテンツ フィルタのマッチタイプ。
disregard_diacritics	bool 省略可。true の場合、マッチング時に発音区別符号が無視されます。

MatchType

コンテンツ フィルタのマッチタイプ。

列挙型
MATCH_TYPE_UNSPECIFIED	マッチタイプが指定されていません。
SIMPLE_STRING_MATCH	コンテンツは、部分文字列の文字ごとに照合されます。
WORD_BOUNDARY_STRING_MATCH	コンテンツは、テキスト内のパターンが単語区切り文字で囲まれている場合にのみ一致します。禁止フレーズに単語区切り文字を含めることもできます。
REGEXP_MATCH	コンテンツは正規表現構文を使用して照合されます。

LlmPolicy

LLM の分類に基づいて LLM レスポンスがポリシーに違反していると判断された場合に、会話をブロックするガードレール。

フィールド
max_conversation_messages	int32 省略可。このポリシーを確認する際は、会話の最後の「n」件のメッセージを考慮します。設定しない場合、デフォルト値の 10 が使用されます。
model_settings	ModelSettings 省略可。モデル設定。
prompt	string 必須。ポリシーのプロンプト。
policy_scope	Guardrail.LlmPolicy.PolicyScope 必須。会話中にポリシー チェックを適用するタイミングを定義します。POLICY_SCOPE_UNSPECIFIED に設定すると、ポリシーがユーザー入力に適用されます。ポリシーをエージェントのレスポンスに適用すると、エージェントが応答できるようになるまでに遅延が発生します。
fail_open	bool 省略可。ポリシーチェック中にエラーが発生した場合は、フェイルオープンしてガードレールをトリガーしません。
allow_short_utterance	bool 省略可。デフォルトでは、短い発話の場合、LLM ポリシー チェックはバイパスされます。この設定を有効にすると、通常はスキップされる発話も含め、すべての発話にポリシー チェックが適用されます。

PolicyScope

会話中にポリシー チェックを適用するタイミングを定義します。

列挙型
POLICY_SCOPE_UNSPECIFIED	ポリシーのスコープが指定されていません。
USER_QUERY	ポリシー チェックはユーザー入力時にトリガーされます。
AGENT_RESPONSE	ポリシー チェックはエージェントの回答でトリガーされます。このポリシー スコープを適用すると、エージェントが応答可能になるまでにレイテンシが追加されます。
USER_QUERY_AND_AGENT_RESPONSE	ポリシー チェックは、ユーザー入力とエージェントの回答の両方でトリガーされます。このポリシー スコープを適用すると、エージェントが応答可能になるまでにレイテンシが追加されます。

LlmPromptSecurity

LLM の分類に基づいて入力が安全でないと判断された場合に、会話をブロックするガードレール。

フィールド
fail_open	bool 省略可。ガードレールで LLM エラーが発生した場合の動作を決定します。- true の場合: ガードレールはバイパスされます。- false（デフォルト）の場合: ガードレールがトリガーまたはブロックされます。 注: カスタム ポリシーが指定されている場合、このフィールドは無視され、ポリシーの fail_open 構成が優先されます。
共用体フィールド security_config。セキュリティ構成モードを定義します。ユーザーは次のいずれかの構成を選択する必要があります。security_config は次のいずれかになります。
default_settings	Guardrail.LlmPromptSecurity.DefaultSecuritySettings 省略可。システムの事前定義されたデフォルトのセキュリティ設定を使用します。このモードを選択するには、リクエストに空の「default_settings」メッセージを含めます。レスポンス内の「default_prompt_template」フィールドには、サーバーによって値が設定されます。
custom_policy	Guardrail.LlmPolicy 省略可。ユーザー定義の LlmPolicy を使用して、セキュリティ ガードレールを構成します。

DefaultSecuritySettings

デフォルトのシステム セキュリティ設定の構成。

フィールド
default_prompt_template	string 出力専用。システムで使用されるデフォルトのプロンプト テンプレート。このフィールドは、システムがデフォルトで使用するプロンプトをユーザーに表示するためのものです。OUTPUT_ONLY です。

ModelSafety

モデルの安全設定のオーバーライド。この設定を行うと、デフォルト設定がオーバーライドされ、レスポンスが安全でないと判断された場合にガードレールがトリガーされます。

フィールド
safety_settings[]	Guardrail.ModelSafety.SafetySetting 必須。安全に関する設定のリスト。

HarmBlockThreshold

ブロックの確率ベースのしきい値レベル。

列挙型
HARM_BLOCK_THRESHOLD_UNSPECIFIED	有害ブロックのしきい値が指定されていません。
BLOCK_LOW_AND_ABOVE	低いしきい値以上をブロックします（つまり、より多くのものをブロックします）。
BLOCK_MEDIUM_AND_ABOVE	中程度のしきい値以上をブロックします。
BLOCK_ONLY_HIGH	高しきい値のみをブロックします（つまり、ブロックを少なくします）。
BLOCK_NONE	ブロックなし。
OFF	安全フィルタをオフにします。

HarmCategory

有害カテゴリ。

列挙型
HARM_CATEGORY_UNSPECIFIED	有害カテゴリが指定されていません。
HARM_CATEGORY_HATE_SPEECH	有害カテゴリはヘイトスピーチです。
HARM_CATEGORY_DANGEROUS_CONTENT	有害カテゴリは危険なコンテンツです。
HARM_CATEGORY_HARASSMENT	有害カテゴリはハラスメントです。
HARM_CATEGORY_SEXUALLY_EXPLICIT	有害カテゴリは、性的描写が露骨なコンテンツです。
HARM_CATEGORY_PROFANITY	有害カテゴリは不適切な表現です。
HARM_CATEGORY_TOXIC	有害カテゴリは有害です。

SafetySetting

安全に関する設定。

フィールド
category	Guardrail.ModelSafety.HarmCategory 必須。有害カテゴリ。
threshold	Guardrail.ModelSafety.HarmBlockThreshold 必須。有害ブロックのしきい値。

スーパーバイザー

監督者の介入を実行するガードレール。

フィールド
type	Guardrail.Supervisor.Type 省略可。スーパーバイザーのタイプ。
detection_mode	Guardrail.Supervisor.DetectionMode 省略可。スーパーバイザーの検出モード。

DetectionMode

スーパーバイザーの検出モード。

列挙型
DETECTION_MODE_UNSPECIFIED	検出モードが指定されていません。デフォルトは NON_BLOCKING です。
NON_BLOCKING	ブロックしない検出モード。監督者の検出が進行中の場合、レスポンスはブロックされません。
BLOCKING	ブロック検出モード。スーパーバイザーの検出が進行中の場合、レスポンスはブロックされます。

タイプ

スーパーバイザーのタイプ。

列挙型
TYPE_UNSPECIFIED	タイプは指定されていません。
INVALID_TEXT	テキストの問題タイプが無効です。
LANGUAGE_SHIFT	言語切り替えに関する問題の種類。
SPEAKER_SHIFT	スピーカーのシフトに関する問題のタイプ。
AUDIO_MISMATCH	音声の不一致に関する問題タイプ。
MISSING_TOOL_CALL	ツール呼び出しの問題タイプがありません。
CUSTOM	カスタムの問題タイプ。
CHOPPY_AUDIO	音声が途切れる問題のタイプ。
PROFANITY	エージェントの不適切な発言に関する問題のタイプ。

画像

会話内の画像入力または画像出力を表します。

フィールド
mime_type	string 必須。ソースデータの IANA 標準 MIME タイプ。サポートされている画像タイプは次のとおりです。* image/png * image/jpeg * image/webp
data	bytes 必須。画像の未加工のバイト数。
alt_text	string 省略可。画像の代替テキスト。

ImportAppRequest

AgentService.ImportApp のリクエスト メッセージです。

フィールド
parent	string 必須。インポートするアプリのロケーションを含む親リソース名。
display_name	string 省略可。インポートするアプリの表示名。* アプリがインポート時に作成され、表示名が指定されている場合、インポートされたアプリはこの表示名を使用します。既存のアプリとの競合が検出された場合は、表示名にタイムスタンプが付加されて一意になります。* アプリが再インポートされる場合、このフィールドは設定しないでください。再インポート時に表示名を指定すると、INVALID_ARGUMENT エラーが発生します。
app_id	string 省略可。インポートしたアプリに使用する ID。* 指定しない場合、アプリに一意の ID が自動的に割り当てられます。* 指定した場合、インポートしたアプリはこの ID をリソース名の最終的なコンポーネントとして使用します。同じ ID のアプリがプロジェクト内の指定された場所にすでに存在する場合、既存のアプリのコンテンツは置き換えられます。
import_options	ImportAppRequest.ImportOptions 省略可。アプリのインポート プロセスを制御するオプション。
ignore_app_lock	bool 省略可。インポート中にアプリのロックをオーバーライドするためのフラグ。true に設定すると、インポート プロセスでアプリのロックが無視されます。
共用体フィールド app。インポートするアプリ。app は次のいずれかになります。
gcs_uri	string アプリのインポート元となる Google Cloud Storage URI。この URI の形式は gs://<bucket-name>/<object-name> である必要があります。
app_content	bytes アプリのフォルダ構造を含む圧縮された ZIP ファイルを表す未加工のバイト。
共用体フィールド json_patch。インポートされたアプリに適用する JSON パッチ。json_patch は次のいずれかになります。
json_patch_content	string 省略可。JSON 文字列としてのパッチ コンテンツ。
json_patch_gcs_uri	string 省略可。パッチを含む JSON ファイルを指す Cloud Storage URI。

ImportOptions

アプリのインポート プロセスの構成オプション。これらのオプションは、特に既存のアプリデータとの競合が発生した場合のインポートの動作を制御します。

フィールド
conflict_resolution_strategy	ImportAppRequest.ImportOptions.ConflictResolutionStrategy 省略可。インポート中に競合を解決するときに使用する戦略。
validate_only	bool 省略可。インポート プロセスのドライランを行うためのフラグ。true に設定した場合、インポート プロセスでは検証のみが行われ、既存のアプリが変更されたり、新しいアプリが作成されたりすることはありません。

ConflictResolutionStrategy

同じ ID のアプリがすでに存在する場合、またはインポートされたリソース（エージェント、ツールなど）の表示名がそのアプリ内の既存のリソースと同じである場合に、競合を処理する戦略を定義します。

列挙型
CONFLICT_RESOLUTION_STRATEGY_UNSPECIFIED	競合解決戦略が指定されていません。
REPLACE	既存のデータをインポートしたデータに置き換えます。同じ app_id を持つアプリがすでに存在する場合、そのコンテンツはインポートされたアプリに基づいて更新されます。- インポートされたアプリ内のリソース（アプリ、エージェント、ツール、例、ガードレール、ツールセット）のうち、既存のリソースと同じ表示名を持つものは、既存のリソースを上書きします。- 新しい表示名でインポートされたリソースが作成されます。- インポートされたアプリに一致する表示名がない既存のリソースは変更されません。
OVERWRITE	インポートしたデータで既存のデータを上書きします。同じ app_id のアプリがすでに存在する場合、そのコンテンツはインポートされたアプリで上書きされます。- アプリ内の既存のリソース（エージェント、ツール、例、ガードレール、ツールセット）は削除されます。- インポートされたリソースは新しいリソースとして作成されます。

ImportAppResponse

AgentService.ImportApp に対するレスポンス メッセージです。

フィールド
name	string インポートされたアプリのリソース名。
warnings[]	string インポート プロセス中に生成された警告メッセージ。特定のリソースでエラーが発生した場合、そのリソースはインポートされたアプリに含まれず、エラーがここに表示されます。

ImportEvaluationsOperationMetadata

EvaluationService.ImportEvaluations の長時間実行オペレーションのメタデータを表します。

フィールド
create_time	Timestamp 出力専用。オペレーションが作成された時刻。
end_time	Timestamp 出力専用。オペレーションの実行が終了した時刻。
status_message	string 出力専用。人が読める形式のオペレーションのステータス（存在する場合）。

ImportEvaluationsRequest

EvaluationService.ImportEvaluations のリクエスト メッセージです。

フィールド
parent	string 必須。評価をインポートするアプリ。形式: projects/{project}/locations/{location}/apps/{app}
import_options	ImportEvaluationsRequest.ImportOptions 省略可。評価のインポート プロセスを制御するオプション。
共用体フィールド source。インポート元の評価のソース。source は次のいずれかになります。
conversation_list	ImportEvaluationsRequest.ConversationList 評価のインポート元となる会話。
gcs_uri	string 評価のインポート元となる Google Cloud Storage URI。この URI の形式は gs://<bucket-name>/<object-name> にする必要があります。
csv_content	bytes 評価構造を含む CSV ファイルを表す未加工のバイト。

ConversationList

会話リソース名のリスト。

フィールド
conversations[]	string 省略可。会話リソース名。

ImportOptions

評価のインポート プロセスの構成オプション。これらのオプションは、インポートの動作（特に既存の評価データとの競合が発生した場合の動作）を制御します。

フィールド
conflict_resolution_strategy	ImportEvaluationsRequest.ImportOptions.ConflictResolutionStrategy 省略可。インポート中に競合を解決するときに使用する戦略。

ConflictResolutionStrategy

同じ評価 ID の評価がアプリにすでに存在する場合の競合を処理する戦略を定義します。

列挙型
CONFLICT_RESOLUTION_STRATEGY_UNSPECIFIED	競合解決戦略が指定されていません。
OVERWRITE	既存の評価を新しい評価で上書きします。
SKIP	既存の評価を保持し、新しい評価をスキップします。
DUPLICATE	既存の評価を保持し、新しい評価を新しい評価として複製します。

ImportEvaluationsResponse

EvaluationService.ImportEvaluations に対するレスポンス メッセージです。

フィールド
evaluations[]	Evaluation アプリにインポートされた評価のリスト。
evaluation_results[]	EvaluationResult アプリにインポートされた評価結果のリスト。
evaluation_runs[]	EvaluationRun アプリにインポートされた評価実行のリスト。
error_messages[]	string 省略可。インポートできなかった評価に関連付けられたエラー メッセージのリスト。
import_failure_count	int32 インポートに完全に失敗したか、1 つ以上のエラーが発生してインポートが完了した評価の数。
evaluation_result_import_failure_count	int32 インポートに完全に失敗したか、1 つ以上のエラーが発生してインポートが完了した評価結果の数。
evaluation_run_import_failure_count	int32 インポートに完全に失敗したか、1 つ以上のエラーが発生してインポートが完了した評価実行の数。

InputAudioConfig

InputAudioConfig は、CES エージェントが受信した音声データを解釈する方法を構成します。

フィールド
audio_encoding	AudioEncoding 必須。入力音声データのエンコード。
sample_rate_hertz	int32 必須。入力音声データのサンプルレート（ヘルツ単位）。
noise_suppression_level	string 省略可。入力音声のノイズ サプレッションを有効にするかどうか。使用可能な値は「low」、「moderate」、「high」、「very_high」です。

InstagramCredentials

Instagram ネイティブ統合用の一時的な Meta 認証情報。

フィールド
auth_code	string 必須。埋め込み登録フローで提供される Meta 認証コード。
conversation_profile_id	string 省略可。デプロイに使用する会話プロファイル ID。

InterruptionSignal

エージェントの音声応答が中断されたことを示します。クライアントは、現在の音声再生を直ちに停止する必要があります（ユーザーの割り込みや新しいエージェントの応答の生成などによる）。

フィールド
barge_in	bool 割り込みがユーザーの割り込みイベントによって発生したかどうか。

LanguageSettings

アプリの言語設定。

フィールド
default_language_code	string 省略可。アプリのデフォルトの言語コード。
supported_language_codes[]	string 省略可。default_language_code に加えて、アプリでサポートされている言語コードのリスト。
enable_multilingual_support	bool 省略可。多言語サポートを有効にします。true の場合、アプリ内のエージェントは、多言語入力の処理を改善するために、事前構築済みの手順を使用します。
fallback_action (deprecated)	string この項目は非推奨です。 省略可。非推奨: この機能はサポートされなくなりました。代わりに enable_multilingual_support を使用して、多言語入力の処理を改善します。エージェントがサポートされていない言語で入力を受け取ったときに行うアクション。 これは、事前定義されたアクションまたはカスタムのツール呼び出しにすることができます。有効な値は次のとおりです。- 特定のツールの実行をトリガーするツールの完全なリソース名。- 「エスカレーション」や「終了」などの事前定義されたシステム アクション。対応する metadata を含む EndSession シグナルをトリガーして、会話を終了します。

LatencyReport

評価実行のレイテンシ レポート。

フィールド
tool_latencies[]	LatencyReport.ToolLatency 出力専用。順序なしリスト。各ツールのレイテンシ指標。
callback_latencies[]	LatencyReport.CallbackLatency 出力専用。順序なしリスト。各コールバックのレイテンシ指標。
guardrail_latencies[]	LatencyReport.GuardrailLatency 出力専用。順序なしリスト。各ガードレールのレイテンシ指標。
llm_call_latencies[]	LatencyReport.LlmCallLatency 出力専用。順序なしリスト。LLM 呼び出しごとのレイテンシ指標。
session_count	int32 出力専用。レイテンシ レポートで考慮されたセッションの合計数。

CallbackLatency

単一のコールバックのレイテンシ指標。

フィールド
stage	string 出力専用。コールバックのステージ。
latency_metrics	LatencyReport.LatencyMetrics 出力専用。コールバックのレイテンシ指標。

GuardrailLatency

単一のガードレールのレイテンシ指標。

フィールド
guardrail	string 出力専用。ガードレールの名前。形式: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}。
guardrail_display_name	string 出力専用。ガードレールの表示名。
latency_metrics	LatencyReport.LatencyMetrics 出力専用。ガードレールのレイテンシ指標。

LatencyMetrics

コンポーネントのレイテンシ指標。

フィールド
p50_latency	Duration 出力専用。50 パーセンタイル レイテンシ。
p90_latency	Duration 出力専用。90 パーセンタイル レイテンシ。
p99_latency	Duration 出力専用。99 パーセンタイル レイテンシ。
call_count	int32 出力専用。リソースが呼び出された回数。

LlmCallLatency

単一の LLM 呼び出しのレイテンシ指標。

フィールド
model	string 出力専用。モデルの名前。
latency_metrics	LatencyReport.LatencyMetrics 出力専用。LLM 呼び出しのレイテンシ指標。

ToolLatency

単一ツールのレイテンシ指標。

フィールド
tool_display_name	string 出力専用。ツールの表示名。
latency_metrics	LatencyReport.LatencyMetrics 出力専用。ツールのレイテンシ指標。
共用体フィールド tool_identifier。ツールの識別子。tool_identifier は次のいずれかになります。
tool	string 出力専用。形式: projects/{project}/locations/{location}/apps/{app}/tools/{tool}。
toolset_tool	ToolsetTool 出力専用。ツールセット ツールの ID。

ListAgentsRequest

AgentService.ListAgents のリクエスト メッセージです。

フィールド
parent	string 必須。エージェントを一覧表示するアプリのリソース名。
page_size	int32 省略可。リクエストされたページサイズ。サーバーはリクエストされた数よりも少ない項目を返す場合があります。指定しない場合は、サーバーで適切なデフォルトが選択されます。
page_token	string 省略可。前の list AgentService.ListAgents 呼び出しから返された next_page_token 値。
filter	string 省略可。エージェントのリスト表示時に適用するフィルタ。詳しくは、https://google.aip.dev/160 をご覧ください。
order_by	string 省略可。並べ替えの基準となるフィールド。「name」と「create_time」のみがサポートされています。詳しくは、https://google.aip.dev/132#ordering をご覧ください。

ListAgentsResponse

AgentService.ListAgents に対するレスポンス メッセージです。

フィールド
agents[]	Agent エージェントのリスト。
next_page_token	string 次のページを取得するために ListAgentsRequest.page_token として送信できるトークン。このフィールドがない場合、後続のページはありません。

ListAppVersionsRequest

AgentService.ListAppVersions のリクエスト メッセージです。

フィールド
parent	string 必須。アプリのバージョンを一覧表示するアプリのリソース名。
page_size	int32 省略可。リクエストされたページサイズ。サーバーはリクエストされた数よりも少ない項目を返す場合があります。指定しない場合は、サーバーで適切なデフォルトが選択されます。
page_token	string 省略可。前の list AgentService.ListAppVersions 呼び出しから返された next_page_token 値。
filter	string 省略可。アプリのバージョンを一覧表示するときに適用するフィルタ。詳しくは、https://google.aip.dev/160 をご覧ください。
order_by	string 省略可。並べ替えの基準となるフィールド。「name」と「create_time」のみがサポートされています。詳しくは、https://google.aip.dev/132#ordering をご覧ください。

ListAppVersionsResponse

AgentService.ListAppVersions に対するレスポンス メッセージです。

フィールド
app_versions[]	AppVersion アプリのバージョンのリスト。
next_page_token	string 次のページを取得するために ListAppVersionsRequest.page_token として送信できるトークン。このフィールドがない場合、後続のページはありません。

ListAppsRequest

AgentService.ListApps のリクエスト メッセージです。

フィールド
parent	string 必須。アプリを一覧表示するビジネスのリソース名。
page_size	int32 省略可。リクエストされたページサイズ。サーバーはリクエストされた数よりも少ない項目を返す場合があります。指定しない場合は、サーバーで適切なデフォルトが選択されます。
page_token	string 省略可。前の list AgentService.ListApps 呼び出しから返された next_page_token 値。
filter	string 省略可。アプリを一覧表示するときに適用するフィルタ。詳しくは、https://google.aip.dev/160 をご覧ください。
order_by	string 省略可。並べ替えの基準となるフィールド。「name」と「create_time」のみがサポートされています。詳しくは、https://google.aip.dev/132#ordering をご覧ください。

ListAppsResponse

AgentService.ListApps に対するレスポンス メッセージです。

フィールド
apps[]	App アプリのリスト。
next_page_token	string 次のページを取得するために ListAppsRequest.page_token として送信できるトークン。このフィールドがない場合、後続のページはありません。
unreachable[]	string 順序なしリスト。到達できなかったロケーション。

ListChangelogsRequest

AgentService.ListChangelogs のリクエスト メッセージです。

フィールド
parent	string 必須。変更ログを一覧表示するアプリのリソース名。
page_size	int32 省略可。リクエストされたページサイズ。サーバーはリクエストされた数よりも少ない項目を返す場合があります。指定しない場合は、サーバーで適切なデフォルトが選択されます。
page_token	string 省略可。前の list AgentService.ListChangelogs 呼び出しから返された next_page_token 値。
filter	string 省略可。変更ログを一覧表示するときに適用するフィルタ。詳しくは、https://google.aip.dev/160 をご覧ください。 フィルタ文字列を使用して、action、resource_type、resource_name、author、create_time でフィルタできます。: 比較演算子は、文字列フィールドで大文字と小文字を区別しない部分一致に使用できます。一方、= は大文字と小文字を区別する完全一致を実行します。 例: * action:update（大文字と小文字を区別しない部分一致）* action="Create"（大文字と小文字を区別する完全一致）* 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 省略可。並べ替えの基準となるフィールド。「name」と「create_time」のみがサポートされています。詳しくは、https://google.aip.dev/132#ordering をご覧ください。

ListChangelogsResponse

AgentService.ListChangelogs に対するレスポンス メッセージです。

フィールド
changelogs[]	Changelog 変更履歴のリスト。
next_page_token	string 次のページを取得するために ListChangelogsRequest.page_token として送信できるトークン。このフィールドがない場合、後続のページはありません。

ListConversationsRequest

AgentService.ListConversations のリクエスト メッセージです。

フィールド
parent	string 必須。会話を一覧表示するアプリのリソース名。
page_size	int32 省略可。リクエストされたページサイズ。サーバーはリクエストされた数よりも少ない項目を返す場合があります。指定しない場合は、サーバーで適切なデフォルトが選択されます。
page_token	string 省略可。前の list AgentService.ListConversations 呼び出しから返された next_page_token 値。
filter	string 省略可。会話を一覧表示するときに適用するフィルタ。詳しくは、https://google.aip.dev/160 をご覧ください。
source	Conversation.Source 省略可。会話のソースを示します。設定されていない場合は、デフォルトで Source.Live が適用されます。sources フィールドに置き換えられるため、非推奨となります。
sources[]	Conversation.Source 省略可。会話のソースを示します。設定しない場合、デフォルトですべての利用可能なソースが適用されます。

ListConversationsResponse

AgentService.ListConversations に対するレスポンス メッセージです。

フィールド
conversations[]	Conversation 会話のリスト。
next_page_token	string 次のページを取得するために ListConversationsRequest.page_token として送信できるトークン。このフィールドがない場合、後続のページはありません。

ListDeploymentsRequest

AgentService.ListDeployments のリクエスト メッセージです。

フィールド
parent	string 必須。親アプリ。形式: projects/{project}/locations/{location}/apps/{app}
page_size	int32 省略可。返すデプロイの最大数。サービスが返す値はこれよりも少ないことがあります。指定されていない場合、最大で 50 個のデプロイが返されます。最大値は 1,000 です。1,000 を超える値は 1,000 に強制変換されます。
page_token	string 省略可。前回の ListDeployments 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。 ページ分割を行う場合、ListDeployments に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。
order_by	string 省略可。並べ替えの基準となるフィールド。「name」と「create_time」のみがサポートされています。詳しくは、https://google.aip.dev/132#ordering をご覧ください。

ListDeploymentsResponse

AgentService.ListDeployments に対するレスポンス メッセージです。

フィールド
deployments[]	Deployment デプロイのリスト。
next_page_token	string 次のページを取得するために page_token として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

ListEvaluationDatasetsRequest

EvaluationService.ListEvaluationDatasets のリクエスト メッセージです。

フィールド
parent	string 必須。評価データセットを一覧表示するアプリのリソース名。
page_size	int32 省略可。リクエストされたページサイズ。サーバーはリクエストされた数よりも少ない項目を返す場合があります。指定しない場合は、サーバーで適切なデフォルトが選択されます。
page_token	string 省略可。前の list EvaluationService.ListEvaluationDatasets 呼び出しから返された next_page_token 値。
filter	string 省略可。評価データセットを一覧表示するときに適用するフィルタ。詳しくは、https://google.aip.dev/160 をご覧ください。
order_by	string 省略可。並べ替えの基準となるフィールド。「name」、「create_time」、「update_time」のみがサポートされています。時間フィールドは降順で並べ替えられ、名前フィールドは昇順で並べ替えられます。含まれていない場合は、「update_time」がデフォルトになります。詳しくは、https://google.aip.dev/132#ordering をご覧ください。

ListEvaluationDatasetsResponse

EvaluationService.ListEvaluationDatasets に対するレスポンス メッセージです。

フィールド
evaluation_datasets[]	EvaluationDataset 評価データセットのリスト。
next_page_token	string 次のページを取得するために ListEvaluationDatasetsRequest.page_token として送信できるトークン。このフィールドがない場合、後続のページはありません。

ListEvaluationExpectationsRequest

EvaluationService.ListEvaluationExpectations のリクエスト メッセージです。

フィールド
parent	string 必須。評価の期待値を一覧表示するアプリのリソース名。
page_size	int32 省略可。リクエストされたページサイズ。サーバーはリクエストされた数よりも少ない項目を返す場合があります。指定しない場合は、サーバーで適切なデフォルトが選択されます。
page_token	string 省略可。前の list EvaluationService.ListEvaluationExpectations 呼び出しから返された next_page_token 値。
filter	string 省略可。評価の期待値を一覧表示するときに適用するフィルタ。詳しくは、https://google.aip.dev/160 をご覧ください。
order_by	string 省略可。並べ替えの基準となるフィールド。「name」、「create_time」、「update_time」のみがサポートされています。時間フィールドは降順で並べ替えられ、名前フィールドは昇順で並べ替えられます。含まれていない場合は、「update_time」がデフォルトになります。詳しくは、https://google.aip.dev/132#ordering をご覧ください。

ListEvaluationExpectationsResponse

EvaluationService.ListEvaluationExpectations に対するレスポンス メッセージです。

フィールド
evaluation_expectations[]	EvaluationExpectation 評価の期待値のリスト。
next_page_token	string 次のページを取得するために ListEvaluationExpectationsRequest.page_token として送信できるトークン。このフィールドがない場合、後続のページはありません。

ListEvaluationResultsRequest

EvaluationService.ListEvaluationResults のリクエスト メッセージです。

フィールド
parent	string 必須。評価結果を一覧表示する評価のリソース名。評価実行でフィルタするには、評価 ID として - を使用し、フィルタで評価実行 ID を指定します。例: projects/{project}/locations/{location}/apps/{app}/evaluations/-
page_size	int32 省略可。リクエストされたページサイズ。サーバーはリクエストされた数よりも少ない項目を返す場合があります。指定しない場合は、サーバーで適切なデフォルトが選択されます。
page_token	string 省略可。前の list EvaluationService.ListEvaluationResults 呼び出しから返された next_page_token 値。
filter	string 省略可。評価結果を一覧表示するときに適用するフィルタ。詳しくは、https://google.aip.dev/160 をご覧ください。
order_by	string 省略可。並べ替えの基準となるフィールド。「name」、「create_time」、「update_time」のみがサポートされています。時間フィールドは降順で並べ替えられ、名前フィールドは昇順で並べ替えられます。含まれていない場合は、「update_time」がデフォルトになります。詳しくは、https://google.aip.dev/132#ordering をご覧ください。

ListEvaluationResultsResponse

EvaluationService.ListEvaluationResults に対するレスポンス メッセージです。

フィールド
evaluation_results[]	EvaluationResult 評価結果のリスト。
next_page_token	string 次のページを取得するために ListEvaluationResultsRequest.page_token として送信できるトークン。このフィールドがない場合、後続のページはありません。

ListEvaluationRunsRequest

EvaluationService.ListEvaluationRuns のリクエスト メッセージです。

フィールド
parent	string 必須。評価実行を一覧表示するアプリのリソース名。
page_size	int32 省略可。リクエストされたページサイズ。サーバーはリクエストされた数よりも少ない項目を返す場合があります。指定しない場合は、サーバーで適切なデフォルトが選択されます。
page_token	string 省略可。前の list EvaluationService.ListEvaluationRuns 呼び出しから返された next_page_token 値。
filter	string 省略可。評価実行を一覧表示するときに適用するフィルタ。詳しくは、https://google.aip.dev/160 をご覧ください。
order_by	string 省略可。並べ替えの基準となるフィールド。「name」、「create_time」、「update_time」のみがサポートされています。時間フィールドは降順で並べ替えられ、名前フィールドは昇順で並べ替えられます。含まれていない場合は、「update_time」がデフォルトになります。詳しくは、https://google.aip.dev/132#ordering をご覧ください。

ListEvaluationRunsResponse

EvaluationService.ListEvaluationRuns に対するレスポンス メッセージです。

フィールド
evaluation_runs[]	EvaluationRun 評価実行のリスト。
next_page_token	string 次のページを取得するために ListEvaluationRunsRequest.page_token として送信できるトークン。このフィールドがない場合、後続のページはありません。

ListEvaluationsRequest

EvaluationService.ListEvaluations のリクエスト メッセージです。

フィールド
parent	string 必須。評価を一覧表示するアプリのリソース名。
page_size	int32 省略可。リクエストされたページサイズ。サーバーはリクエストされた数よりも少ない項目を返す場合があります。指定しない場合は、サーバーで適切なデフォルトが選択されます。
page_token	string 省略可。前の list EvaluationService.ListEvaluations 呼び出しから返された next_page_token 値。
filter (deprecated)	string この項目は非推奨です。 省略可。非推奨: 代わりに evaluation_filter と evaluation_run_filter を使用してください。
evaluation_filter	string 省略可。評価を一覧表示するときに評価に適用するフィルタ。詳しくは、https://google.aip.dev/160 をご覧ください。サポートされているフィールド: evaluation_datasets
evaluation_run_filter	string 省略可。関連付けられた EvaluationRun リソースのフィールドのフィルタ文字列。詳しくは、https://google.aip.dev/160 をご覧ください。サポートされているフィールド: create_time、initiated_by、app_version_display_name
order_by	string 省略可。並べ替えの基準となるフィールド。「name」、「create_time」、「update_time」のみがサポートされています。時間フィールドは降順で並べ替えられ、名前フィールドは昇順で並べ替えられます。含まれていない場合は、「update_time」がデフォルトになります。詳しくは、https://google.aip.dev/132#ordering をご覧ください。
last_ten_results	bool 省略可。レスポンスに各評価の過去 10 件の評価結果を含めるかどうか。

ListEvaluationsResponse

EvaluationService.ListEvaluations に対するレスポンス メッセージです。

フィールド
evaluations[]	Evaluation 評価のリスト。
next_page_token	string 次のページを取得するために ListEvaluationsRequest.page_token として送信できるトークン。このフィールドがない場合、後続のページはありません。

ListExamplesRequest

AgentService.ListExamples のリクエスト メッセージです。

フィールド
parent	string 必須。例を一覧表示するアプリのリソース名。
page_size	int32 省略可。リクエストされたページサイズ。サーバーはリクエストされた数よりも少ない項目を返す場合があります。指定しない場合は、サーバーで適切なデフォルトが選択されます。
page_token	string 省略可。前の list AgentService.ListExamples 呼び出しから返された next_page_token 値。
filter	string 省略可。例を一覧表示するときに適用するフィルタ。詳しくは、https://google.aip.dev/160 をご覧ください。
order_by	string 省略可。並べ替えの基準となるフィールド。「name」と「create_time」のみがサポートされています。詳しくは、https://google.aip.dev/132#ordering をご覧ください。

ListExamplesResponse

AgentService.ListExamples に対するレスポンス メッセージです。

フィールド
examples[]	Example 例のリスト。
next_page_token	string 次のページを取得するために ListExamplesRequest.page_token として送信できるトークン。このフィールドがない場合、後続のページはありません。

ListGuardrailsRequest

AgentService.ListGuardrails のリクエスト メッセージです。

フィールド
parent	string 必須。ガードレールを一覧表示するアプリのリソース名。
page_size	int32 省略可。リクエストされたページサイズ。サーバーはリクエストされた数よりも少ない項目を返す場合があります。指定しない場合は、サーバーで適切なデフォルトが選択されます。
page_token	string 省略可。前の list AgentService.ListGuardrails 呼び出しから返された next_page_token 値。
filter	string 省略可。ガードレールを一覧表示するときに適用するフィルタ。詳しくは、https://google.aip.dev/160 をご覧ください。
order_by	string 省略可。並べ替えの基準となるフィールド。「name」と「create_time」のみがサポートされています。詳しくは、https://google.aip.dev/132#ordering をご覧ください。

ListGuardrailsResponse

AgentService.ListGuardrails に対するレスポンス メッセージです。

フィールド
guardrails[]	Guardrail ガードレールのリスト。
next_page_token	string 次のページを取得するために ListGuardrailsRequest.page_token として送信できるトークン。このフィールドがない場合、後続のページはありません。

ListScheduledEvaluationRunsRequest

EvaluationService.ListScheduledEvaluationRuns のリクエスト メッセージです。

フィールド
parent	string 必須。スケジュールされた評価実行を一覧表示するアプリのリソース名。
page_size	int32 省略可。リクエストされたページサイズ。サーバーはリクエストされた数よりも少ない項目を返す場合があります。指定しない場合は、サーバーで適切なデフォルトが選択されます。
page_token	string 省略可。前の list EvaluationService.ListScheduledEvaluationRuns 呼び出しから返された next_page_token 値。
filter	string 省略可。スケジュール設定された評価実行を一覧表示するときに適用するフィルタ。詳しくは、https://google.aip.dev/160 をご覧ください。現在、次のフィルタリングをサポートしています。* request.evaluations:evaluation_id * request.evaluation_dataset:evaluation_dataset_id
order_by	string 省略可。並べ替えの基準となるフィールド。サポートされているフィールドは、「name」（昇順）、「create_time」（降順）、「update_time」（降順）、「next_scheduled_execution」（昇順）、「last_completed_run.create_time」（降順）です。含まれていない場合は、「update_time」がデフォルトになります。詳しくは、https://google.aip.dev/132#ordering をご覧ください。

ListScheduledEvaluationRunsResponse

EvaluationService.ListScheduledEvaluationRuns に対するレスポンス メッセージです。

フィールド
scheduled_evaluation_runs[]	ScheduledEvaluationRun スケジュールされた評価実行のリスト。
next_page_token	string 次のページを取得するために ListScheduledEvaluationRunsRequest.page_token として送信できるトークン。このフィールドがない場合、後続のページはありません。

ListToolsRequest

AgentService.ListTools のリクエスト メッセージです。

フィールド
parent	string 必須。ツールを一覧表示するアプリのリソース名。
page_size	int32 省略可。リクエストされたページサイズ。サーバーはリクエストされた数よりも少ない項目を返す場合があります。指定しない場合は、サーバーで適切なデフォルトが選択されます。
page_token	string 省略可。前の list AgentService.ListTools 呼び出しから返された next_page_token 値。
filter	string 省略可。ツールを一覧表示するときに適用するフィルタ。「include_system_tools=true」を使用して、レスポンスにシステムツールを含めます。詳しくは、https://google.aip.dev/160 をご覧ください。
order_by	string 省略可。並べ替えの基準となるフィールド。「name」と「create_time」のみがサポートされています。詳しくは、https://google.aip.dev/132#ordering をご覧ください。

ListToolsResponse

AgentService.ListTools に対するレスポンス メッセージです。

フィールド
tools[]	Tool ツールのリスト。
next_page_token	string 次のページを取得するために ListToolsRequest.page_token として送信できるトークン。このフィールドがない場合、後続のページはありません。

ListToolsetsRequest

AgentService.ListToolsets のリクエスト メッセージです。

フィールド
parent	string 必須。ツールセットを一覧表示するアプリのリソース名。
page_size	int32 省略可。リクエストされたページサイズ。サーバーはリクエストされた数よりも少ない項目を返す場合があります。指定しない場合は、サーバーで適切なデフォルトが選択されます。
page_token	string 省略可。前の list AgentService.ListToolsets 呼び出しから返された next_page_token 値。
filter	string 省略可。ツールセットを一覧表示するときに適用するフィルタ。詳しくは、https://google.aip.dev/160 をご覧ください。
order_by	string 省略可。並べ替えの基準となるフィールド。「name」と「create_time」のみがサポートされています。詳しくは、https://google.aip.dev/132#ordering をご覧ください。

ListToolsetsResponse

AgentService.ListToolsets に対するレスポンス メッセージです。

フィールド
toolsets[]	Toolset ツールセットのリスト。
next_page_token	string 次のページを取得するために ListToolsetsRequest.page_token として送信できるトークン。このフィールドがない場合、後続のページはありません。

LoggingSettings

アプリのロギング動作を記述する設定。

フィールド
redaction_config	RedactionConfig 省略可。センシティブ データを編集する方法の構成。
audio_recording_config	AudioRecordingConfig 省略可。音声インタラクションの記録方法に関する構成。音声は、RedactionConfig で構成された秘匿化の対象となります。
unredacted_audio_recording_config	AudioRecordingConfig 省略可。編集されていない音声の追加録音を構成します。これは、音声の編集が enabled の場合に、通常は監査またはモニタリングの目的で、音声の未加工のコピーを保持するために使用できます。
bigquery_export_settings	BigQueryExportSettings 省略可。アプリの BigQuery エクスポートの動作を構成します。会話データは、RedactionConfig で構成されたとおりに編集されます。
unredacted_bigquery_export_settings	BigQueryExportSettings 省略可。アプリの BigQuery エクスポートの動作を構成します。有効になっている場合、編集されていない会話データが BigQuery テーブルにエクスポートされます。
cloud_logging_settings	CloudLoggingSettings 省略可。アプリの Cloud Logging の動作を記述する設定。
conversation_logging_settings	ConversationLoggingSettings 省略可。アプリの会話ロギングの動作を記述する設定。
evaluation_audio_recording_config	AudioRecordingConfig 省略可。評価のために音声操作を記録する方法の構成。デフォルトでは、評価セッションで音声録音は有効になっていません。
metric_analysis_settings	MetricAnalysisSettings 省略可。アプリの LLM 分析パイプラインの会話データの収集動作を記述する設定。

McpTool

MCP ツール。詳しくは、https://modelcontextprotocol.io/specification/2025-06-18/server/tools をご覧ください。

フィールド
name	string 必須。MCP ツールの名前。
name_override	string 省略可。MCP ツールの名前のオーバーライド。名前が Toolset のオーバーライドによってオーバーライドされた場合に設定されます。
description	string 省略可。MCP ツールの説明。
input_schema	Schema 省略可。MCP ツールの入力引数のスキーマ。
output_schema	Schema 省略可。MCP ツールの出力引数のスキーマ。
server_address	string 必須。MCP サーバーのサーバー アドレス（例: https://example.com/mcp/）。サーバーが MCP SDK で構築されている場合、URL の末尾に「/mcp/」を付加する必要があります。ストリーミング可能な HTTP 転送ベースのサーバーのみがサポートされています。これは、McpToolset の server_address と同じです。詳細については、https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http をご覧ください。
api_authentication	ApiAuthentication 省略可。MCP サーバーに対してツールを実行するために必要な認証情報。ベアラー トークン認証の場合、トークンはツールの実行にのみ適用され、ツールのリストには適用されません。そのため、ツールを認証なしで一覧表示できる必要があります。
tls_config	TlsConfig 省略可。TLS 構成。クライアントが信頼すべきカスタム サーバー証明書が含まれます。
service_directory_config	ServiceDirectoryConfig 省略可。VPC-SC の Service Directory 構成。境界内のサービス名の解決に使用されます。
custom_headers	map<string, string> 省略可。MCP サーバーへのリクエストで送信するカスタム ヘッダー。値は $context.variables.<name_of_variable> 形式にする必要があり、セッション変数で設定できます。詳しくは、https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection をご覧ください。
state	McpTool.State 出力専用。外部サーバー上のツールの動的な可用性状態。

状態

ツールの動的な可用性状態を表します。

列挙型
STATE_UNSPECIFIED	デフォルトの状態。
ACTIVE	ツールは利用可能で、サーバーによって積極的に提供されています。
INACTIVE	ツールが構成または固定されているが、現在サーバーで提供されていない。
STALE	ツールはサーバーに存在しますが、サーバーのバージョンと一致していません。

McpToolDefinition

スナップショットされるツールのコア定義要素のコンテナ。スナップショットのスキーマはそのまま使用され、オーバーライドできません。

フィールド
description	string 出力専用。MCP ツールの説明。これは、McpToolOverride の description_override でオーバーライドできます。
input_schema	Schema 出力専用。MCP ツールの入力引数のスキーマ。
output_schema	Schema 出力専用。MCP ツールの出力引数のスキーマ。

McpToolOverride

ツールセット内の特定のツールに関連付けられたオーバーライド。これにより、外部動的サーバーからのツール定義の「固定」または「オーバーライド」が可能になります。

フィールド
tool	string 必須。MCP サーバーによって出力されるツールの元の名前。
name_override	string 省略可。この名前が存在する場合、このツールは元の名前の代わりにこの名前をエージェントで使用します。これは、MCP サーバーが名前の付け方が悪いツールを提供している場合に、主にエイリアスとして使用されます。
description_override	string 省略可。この説明が存在する場合、このツールはサーバーの元の説明ではなく、この説明を使用します。
snapshot	McpToolDefinition 出力専用。このツールが存在する場合、ツールは「固定」され、サーバーが一時的に利用できなくなった場合やオーバーライドが存在しない場合は、スナップショット値がフォールバックとして使用されます。

McpToolset

MCP サーバーが提供するツールのリストを含むツールセット。

フィールド
server_address	string 必須。MCP サーバーのアドレス（例: https://example.com/mcp/）。サーバーが MCP SDK で構築されている場合、URL の末尾に「/mcp/」を付加する必要があります。ストリーミング可能な HTTP 転送ベースのサーバーのみがサポートされています。詳細については、https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http をご覧ください。
api_authentication	ApiAuthentication 省略可。ツールにアクセスして MCP サーバーに対してツールを実行するために必要な認証情報。ベアラー トークン認証の場合、トークンはツールの実行にのみ適用され、ツールのリストには適用されません。そのため、ツールを認証なしで一覧表示できる必要があります。
service_directory_config	ServiceDirectoryConfig 省略可。VPC-SC の Service Directory 構成。境界内のサービス名の解決に使用されます。
tls_config	TlsConfig 省略可。TLS 構成。クライアントが信頼すべきカスタム サーバー証明書が含まれます。
custom_headers	map<string, string> 省略可。MCP サーバーへのリクエストで送信するカスタム ヘッダー。値は $context.variables.<name_of_variable> 形式にする必要があり、セッション変数で設定できます。詳しくは、https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/open-api#openapi-injection をご覧ください。
tool_overrides[]	McpToolOverride 省略可。このツールセット内の個々のツールのオーバーライド。これにより、説明や名前などの特定の詳細をオーバーライドしたり、ツールを完全に動的にしないように状態を固定したりできます。

メッセージ

会話内のメッセージ。

フィールド
role	string 省略可。会話内のロール（ユーザー、エージェントなど）。
chunks[]	Chunk 省略可。メッセージのコンテンツをチャンクのシーケンスとして表します。
event_time	Timestamp 省略可。メッセージが送信または受信されたときのタイムスタンプ。メッセージが example の一部である場合は使用しないでください。

MetricAnalysisSettings

LLM 分析指標パイプラインの会話データの収集動作を記述する設定。

フィールド
llm_metrics_opted_out	bool 省略可。llm 分析指標の会話データを収集するかどうか。true の場合、llm 分析指標の会話データは収集されません。それ以外の場合、会話データは収集されます。

MockConfig

セッションのモックツール呼び出しの構成。

フィールド
mocked_tool_calls[]	MockedToolCall 省略可。セッション中にモックするすべてのツール呼び出し。
unmatched_tool_call_behavior	MockConfig.UnmatchedToolCallBehavior 必須。mocked_tool_calls の引数パターンに一致しないツール呼び出しの動作。

UnmatchedToolCallBehavior

ツール呼び出しがモックされたツール呼び出しと一致しない場合の対処方法。

列挙型
UNMATCHED_TOOL_CALL_BEHAVIOR_UNSPECIFIED	デフォルト値。この値は使用されません。
FAIL	モックの想定される入力パターンと一致しないツール呼び出しに対してエラーをスローします。
PASS_THROUGH	一致しないツール呼び出しの場合は、ツール呼び出しを実際のツールに渡します。

MockedToolCall

モックされたツールの呼び出し。

ターゲット ツールと、そのツールの引数 / 入力と照合するパターンを表します。パターンが一致すると、モック レスポンスが返されます。

フィールド
tool (deprecated)	string この項目は非推奨です。 省略可。非推奨。代わりに tool_identifier を使用してください。
expected_args_pattern	Struct 必須。ディスパッチされたすべてのツール呼び出しの引数 / 入力と照合するパターン。ツール呼び出しの入力がこのパターンと一致する場合、モック出力が返されます。
mock_response	Struct 省略可。ツール呼び出しの引数 / 入力がパターンに一致する場合に返すモック レスポンス / 出力。
共用体フィールド tool_identifier。モックするツールの識別子。tool_identifier は次のいずれかになります。
tool_id	string 省略可。モックするツールの名前。形式: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolset	ToolsetTool 省略可。モックするツールセット。

ModelSettings

モデル設定には、LLM モデルのさまざまな構成が含まれています。

フィールド
model	string 省略可。エージェントが使用する LLM モデル。設定されていない場合、エージェントは親エージェントからモデルを継承します。
thinking_level	ModelSettings.ThinkingLevel 省略可。モデルの思考レベル。
temperature	double 省略可。設定すると、この Temperature が LLM モデルに使用されます。Temperature は、モデルのレスポンスのランダム性を制御します。温度が低いほど、予測しやすい回答が生成されます。温度が高いほど、より創造的な回答が生成されます。

ThinkingLevel

モデルの思考レベルの構成。

列挙型
THINKING_LEVEL_UNSPECIFIED	思考レベルが指定されていません。
DEFAULT	デフォルトの思考レベル。
LOW	思考レベルが低い。
MEDIUM	中程度の思考レベル。
HIGH	高度な思考レベル。

OAuthConfig

OAuth を使用した認証の構成。

フィールド
oauth_grant_type	OAuthConfig.OauthGrantType 必須。OAuth 権限付与タイプ。
client_id	string 必須。OAuth プロバイダのクライアント ID。
client_secret_version	string 必須。クライアント シークレットを保存する SecretManager シークレット バージョン リソースの名前。形式: projects/{project}/secrets/{secret}/versions/{version} 注: CES サービス エージェント service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com に roles/secretmanager.secretAccessor ロールを付与する必要があります。
token_endpoint	string 必須。アクセス トークンと交換する OAuth プロバイダのトークン エンドポイント。
scopes[]	string 省略可。付与する OAuth スコープ。

OauthGrantType

OAuth 権限付与タイプ。クライアント認証情報付与のみがサポートされています。

列挙型
OAUTH_GRANT_TYPE_UNSPECIFIED	指定なし。デフォルトは CLIENT_CREDENTIAL です。
CLIENT_CREDENTIAL	クライアント認証情報フローを表します。

OpenApiTool

OpenAPI スキーマで定義されたリモート API ツール。

フィールド
open_api_schema	string 必須。JSON または YAML 形式の OpenAPI スキーマ。
name	string 省略可。ツールの名前。指定しない場合、ツールの名前は OpenAPI スキーマの operation.operationId から派生します。
description	string 省略可。ツールの説明。指定されていない場合、ツールの説明は OpenAPI スキーマの operation.description または operation.summary から取得されます。
api_authentication	ApiAuthentication 省略可。API で必要な認証情報。
tls_config	TlsConfig 省略可。TLS 構成。クライアントが信頼するカスタム サーバー証明書が含まれます。
service_directory_config	ServiceDirectoryConfig 省略可。Service Directory の構成。
ignore_unknown_fields	bool 省略可。true の場合、エージェントは API レスポンスの不明なフィールドを無視します。
url	string 省略可。Open API スキーマのサーバー URL。このフィールドは、スキーマにサーバー URL が含まれている場合に、エクスポート プロセス中に環境の依存関係のツールでのみ設定されます。インポート プロセス中に、この URL が環境の依存関係に存在し、スキーマに $env_var プレースホルダがある場合、スキーマ内のプレースホルダが置き換えられます。

OpenApiToolset

OpenAPI スキーマで定義されたツールのリストを含むツールセット。

フィールド
open_api_schema	string 必須。ツールセットの OpenAPI スキーマ。
api_authentication	ApiAuthentication 省略可。API で必要な認証情報。
tls_config	TlsConfig 省略可。TLS 構成。カスタム サーバー証明書が含まれます
service_directory_config	ServiceDirectoryConfig 省略可。Service Directory の構成。
ignore_unknown_fields	bool 省略可。true の場合、エージェントは OpenAPI スキーマで定義されたすべてのオペレーションについて、API レスポンス内の不明なフィールドを無視します。
url	string 省略可。Open API スキーマのサーバー URL。このフィールドは、エクスポート プロセス中に環境の依存関係のツールセットで、スキーマにサーバー URL が含まれている場合にのみ設定されます。インポート プロセス中に、この URL が環境の依存関係に存在し、スキーマに $env_var プレースホルダがある場合、スキーマ内のプレースホルダが置き換えられます。

OperationMetadata

長時間実行されているオペレーションのメタデータを表します。

フィールド
create_time	Timestamp 出力専用。オペレーションが作成された時刻。
end_time	Timestamp 出力専用。オペレーションの実行が終了した時刻。
status_message	string 出力専用。人が読める形式のオペレーションのステータス（存在する場合）。
requested_cancellation	bool 出力専用。ユーザーがオペレーションのキャンセルをリクエストしたかどうかを示します。正常にキャンセルされたオペレーションは、google.rpc.Status.code が 1 の google.longrunning.Operation.error 値を持ちます。これは Code.CANCELLED に相当します。

OptimizationConfig

評価実行後に最適化ステップを実行するための構成。

フィールド
generate_loss_report	bool 省略可。損失レポートを生成するかどうか。
assistant_session	string 出力専用。この評価実行に基づく最適化に使用するアシスタント セッション。形式: projects/{project}/locations/{location}/apps/{app}/assistantSessions/{assistantSession}
report_summary	string 出力専用。損失レポートの概要。
should_suggest_fix	bool 出力専用。損失の修正を提案するかどうか。
status	OptimizationConfig.OptimizationStatus 出力専用。最適化実行のステータス。
error_message	string 出力専用。最適化の実行が失敗した場合のエラー メッセージ。
loss_report	Struct 出力専用。生成された損失レポート。

OptimizationStatus

最適化実行のステータス。

列挙型
OPTIMIZATION_STATUS_UNSPECIFIED	最適化ステータスが指定されていません。
RUNNING	最適化が実行中です。
COMPLETED	最適化が完了しました。
ERROR	内部エラーのため、最適化に失敗しました。

OutputAudioConfig

OutputAudioConfig は、CES エージェントが発信音声レスポンスを合成する方法を構成します。

フィールド
audio_encoding	AudioEncoding 必須。出力音声データのエンコード。
sample_rate_hertz	int32 必須。出力音声データのサンプルレート（ヘルツ単位）。

PersonaRunConfig

特定のペルソナの評価を実行するための構成。

フィールド
persona	string 省略可。評価に使用するペルソナ。形式: projects/{project}/locations/{location}/apps/{app}/evaluationPersonas/{evaluationPersona}
task_count	int32 省略可。ペルソナで実行するタスクの数。

PythonCodeCondition

条件を評価する Python コードブロック。

フィールド
python_code	string 必須。実行する Python コード。

PythonFunction

Python 関数ツール。

フィールド
name	string 省略可。実行する Python 関数の名前。Python コードで定義された Python 関数名と一致する必要があります。大文字と小文字が区別されます。名前が指定されていない場合は、Python コードで定義されている最初の関数が使用されます。
python_code	string 省略可。ツールで実行する Python コード。
description	string 出力専用。Python コードの docstring から解析された Python 関数の説明。
service_directory_config	ServiceDirectoryConfig 省略可。ツールの Service Directory 構成。

QualityReport

アプリで特定された品質に関する問題を説明するレポート。

フィールド
issues[]	QualityReport.AgentIssues 省略可。エージェント別にグループ化された問題。
evaluation_runs[]	string 省略可。品質レポートの生成に使用された評価実行のリスト。形式: projects/{project}/locations/{location}/evaluationRuns/{evaluationRun}。
general_issues[]	QualityReport.Issue 省略可。特定のエージェントに固有ではない一般的な問題。

AgentIssues

単一のエージェントに対して特定された問題。

フィールド
agent	string 省略可。問題が関連付けられているエージェントの名前。形式: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
issues[]	QualityReport.Issue 省略可。このエージェントで見つかった問題のリスト。

問題

特定された問題。

フィールド
description	string 省略可。検出された問題の説明。
occurrence_count	int32 省略可。この問題が発生した回数。
proposed_solution	string 省略可。手順やツールを変更して問題を解決するための提案された解決策。

RecognitionResult

音声入力の音声認識結果。

フィールド
transcript	string 省略可。現在のターン中にキャプチャされたユーザーの発話セグメントを連結したものです。

RedactionConfig

センシティブ データの処理方法を指定する構成。

フィールド
enable_redaction	bool 省略可。true の場合、会話履歴、Cloud Logging、音声録音など、さまざまなロギング シナリオで編集が適用されます。
inspect_template	string 省略可。機密データ型の検出を構成する DLP 検査テンプレート名。 形式: projects/{project}/locations/{location}/inspectTemplates/{inspect_template}
deidentify_template	string 省略可。コンテンツの匿名化方法を指定する DLP 匿名化テンプレート名。 形式: projects/{project}/locations/{location}/deidentifyTemplates/{deidentify_template}

RemoteA2aConfig

リモート A2A エージェントに接続するための共有構成。

フィールド
api_authentication	ApiAuthentication 省略可。リモート エージェントを呼び出すための認証構成。レジストリ参照ですでに認証が処理されている場合は省略可能です。
input_variable_mapping	map<string, string> 省略可。リモート エージェントの入力変数名と GECX 変数名のマッピング。
output_variable_mapping	map<string, string> 省略可。リモート エージェントの出力変数名と GECX 変数名のマッピング。
streaming_enabled	bool 省略可。リモート エージェントでストリーミングが有効になっているかどうか。
context_id	string 省略可。空でない場合、リモート A2A エージェントとのやり取りではこのコンテキスト ID が使用されます。この context_id フィールドは、$context.variables.order_agent_session_id などのセッション変数を参照できます。
共用体フィールド agent_spec。リモート エージェントの仕様。agent_spec は次のいずれかになります。
agent_card	AgentCard 省略可。インラインで定義された完全なエージェント カード。
agent_registry	string 省略可。Agent Registry 内のエージェントへの参照。形式: projects/{project}/locations/{location}/agents/{agent}

RemoteAgentTool

エージェントが別のリモート エージェントを呼び出すことができるツールを表します。

フィールド
name	string 必須。ツールの名前。
description	string 必須。ツールの説明。
agent_card	AgentCard 必須。このツールが呼び出すリモート エージェントのエージェント カード。
api_authentication	ApiAuthentication 省略可。リモート エージェントを呼び出すための認証構成。
stateful_agent	bool 省略可。有効にすると、CXAS アプリとリモート エージェントの間のやり取りで同じコンテキストが共有されます。リモート エージェントが context_id を返した場合、このリモート エージェント ツールのセッション全体で保持されます。
input_variable_mapping	map<string, string> 省略可。リモート エージェントの入力変数名と GECX 変数名のマッピング。
output_variable_mapping	map<string, string> 省略可。リモート エージェントの出力変数名と GECX 変数名のマッピング。

RestoreAppVersionRequest

AgentService.RestoreAppVersion のリクエスト メッセージ

フィールド
name	string 必須。復元するアプリ バージョンのリソース名。

RestoreAppVersionResponse

この型にはフィールドがありません。

AgentService.RestoreAppVersion に対するレスポンス メッセージ。

RetrieveToolSchemaRequest

ToolService.RetrieveToolSchema のリクエスト メッセージです。

フィールド
parent	string 必須。ツール/ツールセットが属するアプリのリソース名。形式: projects/{project}/locations/{location}/apps/{app}
共用体フィールド tool_identifier。スキーマを取得するツールの識別子。永続化されたツールまたはツールセットのツールです。tool_identifier は次のいずれかになります。
tool	string 省略可。スキーマを取得するツールの名前。形式: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolset_tool	ToolsetTool 省略可。スキーマを取得するツールセット ツール。ツールセットの述語に一致するツールは 1 つだけです。それ以外の場合は、エラーが返されます。

RetrieveToolSchemaResponse

ToolService.RetrieveToolSchema に対するレスポンス メッセージです。

フィールド
input_schema	Schema ツールの入力パラメータのスキーマ。
output_schema	Schema ツールの出力パラメータのスキーマ。
共用体フィールド tool_identifier。スキーマの対象となるツールの識別子。tool_identifier は次のいずれかになります。
tool	string スキーマの対象となるツールの名前。形式: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolset_tool	ToolsetTool スキーマの対象となるツールセット ツール。

RetrieveToolsRequest

ToolService.RetrieveTools のリクエスト メッセージです。

フィールド
toolset	string 必須。ツールを取得するツールセットの名前。形式: projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
tool_ids[]	string 省略可。ツールセットから取得するツールの識別子。空の場合、ツールセット内のすべてのツールが返されます。
bypass_persistence_config	bool 省略可。true の場合、返されるツールには、保存されている永続構成（オーバーライド/スナップショット）をバイパスして、サーバーから直接取得した未加工の説明とスキーマが含まれます。

RetrieveToolsResponse

ToolService.RetrieveTools に対するレスポンス メッセージです。

フィールド
tools[]	Tool 指定されたツールセットに含まれるツールのリスト。

RunEvaluationOperationMetadata

EvaluationService.RunEvaluation のオペレーション メタデータ。

フィールド
evaluations[]	string 出力専用。実行された評価のリスト。形式: projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}
evaluation_run	string 出力専用。作成された評価実行。形式: projects/{project}/locations/{location}/apps/{app}/evaluationRuns/{evaluation_run}
create_time	Timestamp 出力専用。オペレーションが作成された時刻。
end_time	Timestamp 出力専用。オペレーションが完了した時刻。
verb	string 出力専用。オペレーションの動詞。
cancel_requested	bool 出力専用。ユーザーがオペレーションのキャンセルをリクエストしたかどうかを示します。正常にキャンセルされたオペレーションは、google.rpc.Status.code が 1 の google.longrunning.Operation.error 値を持ちます。これは Code.CANCELLED に相当します。

RunEvaluationRequest

EvaluationService.RunEvaluation のリクエスト メッセージです。

フィールド
app	string 必須。評価するアプリ。形式: projects/{project}/locations/{location}/apps/{app}
evaluations[]	string 省略可。実行する評価のリスト。形式: projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}
evaluation_dataset	string 省略可。実行する評価データセット。形式: projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}
display_name	string 省略可。評価実行の表示名。
app_version	string 省略可。評価するアプリのバージョン。app_version または deployment のいずれか 1 つのみを設定できます。形式: projects/{project}/locations/{location}/apps/{app}/versions/{version}
config	EvaluationConfig 省略可。実行に使用する構成。
persona_run_configs[]	PersonaRunConfig 省略可。ペルソナごとに実行に使用する構成。
optimization_config	OptimizationConfig 省略可。評価実行後に最適化ステップを実行するための構成。設定されていない場合、最適化ステップは実行されません。
scheduled_evaluation_run	string 省略可。この評価実行をトリガーする ScheduledEvaluationRun のリソース名。 このフィールドが設定されている場合、作成された EvaluationRun リソースの scheduled_evaluation_run フィールドには、この値が入力されます。形式: projects/{project}/locations/{location}/apps/{app}/scheduledEvaluationRuns/{scheduled_evaluation_run}
golden_run_method	GoldenRunMethod 省略可。ゴールデン評価の場合に評価を実行する方法。設定しない場合、デフォルトは STABLE になります。
generate_latency_report	bool 省略可。評価実行のレイテンシ レポートを生成するかどうか。
evaluation_run_caching_settings	EvaluationRunCachingSettings 省略可。評価実行に使用するキャッシュ設定。
run_count	int32 省略可。評価を実行する回数。設定しない場合、デフォルト値はゴールデンごとに 1、シナリオごとに 5 です。

RunEvaluationResponse

EvaluationService.RunEvaluation に対するレスポンス メッセージです。

フィールド
evaluation_run	string 作成された評価実行の名前。形式: projects/{project}/locations/{location}/apps/{app}/evaluationRuns/{evaluation_run}

RunEvaluationResultMetricsOperationMetadata

この型にはフィールドがありません。

EvaluationService.RunEvaluationResultMetrics のオペレーション メタデータ。

RunEvaluationResultMetricsRequest

EvaluationService.RunEvaluationResultMetrics のリクエスト メッセージです。

フィールド
evaluation_result_id	string 必須。指標を実行する評価結果。形式: projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}/results/{evaluation_result_id}

RunEvaluationResultMetricsResponse

EvaluationService.RunEvaluationResultMetrics に対するレスポンス メッセージです。

フィールド
status	EvaluationResult.Outcome 出力専用。評価結果指標の計算ステータス。

RunSessionRequest

SessionService.RunSession のリクエスト メッセージです。

フィールド
config	SessionConfig 必須。セッションの構成。
inputs[]	SessionInput 必須。セッションの入力。

RunSessionResponse

SessionService.RunSession に対するレスポンス メッセージです。

フィールド
outputs[]	SessionOutput セッションの出力。

ScheduledEvaluationRun

スケジュールされた評価実行構成を表します。

フィールド
name	string ID。スケジュールされた評価実行構成の固有識別子。Format: projects/{projectId}/locations/{locationId}/apps/{appId}/scheduledEvaluationRuns/{scheduledEvaluationRunId}
display_name	string 必須。スケジュールされた評価実行構成のユーザー定義の表示名。
request	RunEvaluationRequest 必須。スケジュールする RunEvaluationRequest
description	string 省略可。スケジュールされた評価実行のユーザー定義の説明。
scheduling_config	ScheduledEvaluationRun.SchedulingConfig 必須。評価を実行するタイミングと頻度の構成。
active	bool 省略可。この構成がアクティブかどうか
last_completed_run	string 出力専用。このスケジュールされた実行の最後の成功した EvaluationRun。形式: projects/{project}/locations/{location}/apps/{app}/evaluationRuns/{evaluationRun}
total_executions	int32 出力専用。この実行が実行された合計回数
next_scheduled_execution_time	Timestamp 出力専用。次回実行予定時刻
create_time	Timestamp 出力専用。スケジュールされた評価実行が作成されたときのタイムスタンプ。
created_by	string 出力専用。スケジュールされた評価実行を作成したユーザー。
update_time	Timestamp 出力専用。評価が最後に更新されたときのタイムスタンプ。
last_updated_by	string 出力専用。評価を最後に更新したユーザー。
etag	string 出力専用。読み取り / 変更 / 書き込みオペレーション中にオブジェクトが変更されていないことを確認するために使用される ETag。etag が空の場合、更新によって同時変更が上書きされます。

SchedulingConfig

評価スケジュールの構成の詳細

フィールド
frequency	ScheduledEvaluationRun.SchedulingConfig.Frequency 必須。評価を実行する頻度
start_time	Timestamp 必須。評価を開始するタイムスタンプ。
days_of_week[]	int32 省略可。評価を実行する曜日。週単位と隔週単位の頻度にのみ適用されます。1 は月曜日、2 は火曜日、...、7 は日曜日です。

頻度

評価を実行できる頻度

列挙型
FREQUENCY_UNSPECIFIED	頻度が指定されていません。
NONE	繰り返さない 1 回限りのスケジュールされた実行を示します
DAILY	評価を毎日実行します。
WEEKLY	評価を毎週実行します。
BIWEEKLY	評価は隔週で実施します。

スキーマ

OpenAPI 3.0 スキーマ オブジェクトのサブセットを表します。

フィールド
type	Schema.Type 必須。データの型。
properties	map<string, Schema> 省略可。Type.OBJECT のプロパティ。
required[]	string 省略可。Type.OBJECT の必須プロパティ。
description	string 省略可。データの説明。
items	Schema 省略可。Type.ARRAY の要素のスキーマ。
nullable	bool 省略可。値が null の可能性があるかどうかを示します。
unique_items	bool 省略可。配列内の項目が一意である必要があることを示します。TYPE.ARRAY にのみ適用されます。
prefix_items[]	Schema 省略可。Type.ARRAY の初期要素のスキーマ。
additional_properties	Schema 省略可。ブール値またはオブジェクトのいずれかで、追加のプロパティの存在を制御します。
any_of[]	Schema 省略可。値は、リスト内のサブスキーマのいずれか（1 つ以上）に対して検証される必要があります。
enum[]	string 省略可。プリミティブ型の要素の可能な値（列挙型形式）。例: 1. 方向は {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. アパートの部屋番号は {type:INTEGER, format:enum, enum:["101", "201", "301"]} と定義できます。
default	Value 省略可。データのデフォルト値。
ref	string 省略可。スキーマノード間の間接参照を許可します。値は、ルート defs の子への有効な参照にする必要があります。 たとえば、次のスキーマは、「Pet」という名前のスキーマノードへの参照を定義します。 type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string 「pet」プロパティの値は、「Pet」という名前のスキーマノードへの参照です。詳しくは、https://json-schema.org/understanding-json-schema/structuring をご覧ください。
defs	map<string, Schema> 省略可。ref で使用する定義のマップ。スキーマのルートでのみ使用できます。
title	string 省略可。スキーマのタイトル。
min_items	int64 省略可。Type.ARRAY の要素の最小数。
max_items	int64 省略可。Type.ARRAY の要素の最大数。
minimum	double 省略可。Type.INTEGER と Type.NUMBER の最小値。
maximum	double 省略可。Type.INTEGER と Type.NUMBER の最大値。

タイプ

OpenAPI のデータ型。

列挙型
TYPE_UNSPECIFIED	未指定
STRING	文字列型。
INTEGER	整数型。
NUMBER	数値型。
BOOLEAN	ブール型。
OBJECT	オブジェクト タイプ。
ARRAY	配列型。

SecuritySettings

CES のプロジェクト/ロケーション レベルのセキュリティ設定。

フィールド
name	string ID。セキュリティ設定の固有識別子。形式: projects/{project}/locations/{location}/securitySettings
endpoint_control_policy	EndpointControlPolicy 省略可。エンドポイント制御に関連する設定。
create_time	Timestamp 出力専用。セキュリティ設定の作成時刻。
update_time	Timestamp 出力専用。セキュリティ設定の最終更新時刻。
etag	string 出力専用。セキュリティ設定の Etag。

ServiceAccountAuthConfig

カスタム サービス アカウントを使用した認証の構成。

フィールド
service_account	string 必須。認証に使用されるサービス アカウントのメールアドレス。CES はこのサービス アカウントを使用してアクセス トークンを交換し、アクセス トークンはリクエストの Authorization ヘッダーで送信されます。 サービス アカウントには、CES サービス エージェント service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com に付与された roles/iam.serviceAccountTokenCreator ロールが必要です。
scopes[]	string 省略可。付与する OAuth スコープ。指定しない場合は、デフォルトのスコープ https://www.googleapis.com/auth/cloud-platform が使用されます。

ServiceAgentIdTokenAuthConfig

この型にはフィールドがありません。

サービス エージェントから生成された ID トークンによる認証の構成。

ServiceDirectoryConfig

Service Directory を使用するツールの構成。

フィールド
service	string 必須。Service Directory サービスの名前。形式: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}。サービス ディレクトリのロケーションは、アプリのロケーションと同じである必要があります。

SessionConfig

セッションの構成。

フィールド
session	string 必須。セッションの固有識別子。形式: projects/{project}/locations/{location}/apps/{app}/sessions/{session}
input_audio_config	InputAudioConfig 省略可。入力音声の処理の構成。
output_audio_config	OutputAudioConfig 省略可。出力音声の生成に関する構成。
historical_contexts[]	Message 省略可。セッションの履歴コンテキスト（ユーザー入力、エージェントの応答、その他のメッセージなど）。通常、CES エージェントはセッションを自動的に管理するため、クライアントがこのフィールドを明示的に入力する必要はありません。ただし、クライアントは必要に応じて履歴コンテキストをオーバーライドして、特定の状態からセッションを強制的に開始できます。
entry_agent	string 省略可。セッションに対応する最初のエージェント。指定しない場合、セッションはアプリの root agent によって処理されます。形式: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
deployment	string 省略可。セッションで使用するアプリのデプロイ。形式: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
time_zone	string 省略可。ユーザーのタイムゾーン。指定された場合、エージェントは日付と時刻に関連する変数にタイムゾーンを使用します。それ以外の場合、エージェントは App.time_zone_settings で指定されたタイムゾーンを使用します。 形式は IANA タイムゾーン データベースのタイムゾーンです（例: America/Los_Angeles）。
use_tool_fakes	bool 省略可。セッションでツール フェイクを使用するかどうか。このフィールドが設定されている場合、エージェントは実際のツールを呼び出す代わりに、ツール フェイクを使用しようとします。
remote_dialogflow_query_parameters	SessionConfig.RemoteDialogflowQueryParameters 省略可。セッション制御がリモート エージェントに転送されたときに、リモート Dialogflow エージェントに送信する QueryParameters。
enable_text_streaming	bool 省略可。モデルからのテキスト出力のストリーミングを有効にするかどうか。デフォルトでは、モデルからのテキスト出力は、クライアントに送信される前に収集されます。注: これは、StreamRunSession または BidiRunSession を介したテキスト（音声以外）セッションでのみサポートされます。
exclude_diagnostic_info	bool 省略可。セッション出力から診断情報を除外するかどうか。

RemoteDialogflowQueryParameters

セッション制御がリモート エージェントに転送されたときに、リモート Dialogflow エージェントに送信する QueryParameters。

フィールド
webhook_headers	map<string, string> 省略可。QueryParameters で webhook_headers として送信される HTTP ヘッダー。
payload	Struct 省略可。QueryParameters で送信されるペイロード。
end_user_metadata	Struct 省略可。QueryParameters で送信されるエンドユーザーのメタデータ。

SessionInput

セッションの入力。

フィールド
will_continue	bool 省略可。現在のメッセージが双方向ストリーミング セッションの大きな入力のフラグメントであるかどうかを示すフラグ。 true に設定すると、エージェントは will_continue が false の後続のメッセージを受信するまで、またはシステムが音声入力でエンドポイントを検出するまで、処理を延期します。 注: このフィールドは、音声入力と DTMF 入力には適用されません。これらは常にエンドポイント信号に基づいて自動的に処理されるためです。
共用体フィールド input_type。入力のタイプ。input_type は次のいずれかになります。
text	string 省略可。エンドユーザーからのテキストデータ。
dtmf	string 省略可。エンドユーザーからの DTMF 数字。
audio	bytes 省略可。エンドユーザーからの音声データ。
tool_responses	ToolResponses 省略可。クライアントからのツール呼び出しの実行結果。
image	Image 省略可。エンドユーザーからの画像データ。
blob	Blob 省略可。エンドユーザーからの BLOB データ。
variables	Struct 省略可。セッションのコンテキスト変数。名前でキー設定されます。CES エージェントは、アプリで宣言された変数のみを使用します。 認識されない変数は、追加のセッション パラメータとして [Dialogflow エージェント][Agent.RemoteDialogflowAgent] に送信されます。
event	Event 省略可。イベント入力。

SessionOutput

セッションの出力。

フィールド
turn_index	int32 この出力が属する会話ターンの順序を 1 から始まる連番で示します。
turn_completed	bool true の場合、CES エージェントは現在の会話ターンの終了を検出し、このターンではこれ以上の出力を提供しません。
diagnostic_info	SessionOutput.DiagnosticInfo 省略可。診断情報には、入力の処理中の実行の詳細が含まれます。各ターンの最後の SessionOutput（turn_completed=true を含む）でのみ入力されます。
共用体フィールド output_type。出力のタイプ。output_type は次のいずれかになります。
text	string CES エージェントからの出力テキスト。
audio	bytes CES エージェントから音声を出力します。
tool_calls	ToolCalls クライアントにツールの実行をリクエストします。
citations	Citations エージェントが生成したテキストのソース情報を提供する引用。
google_search_suggestions	GoogleSearchSuggestions GoogleSearchTool の呼び出しの結果として Google 検索から返される候補。
end_session	EndSession セッションが終了したことを示します。
payload	Struct CES エージェントからの構造化された出力を含むカスタム ペイロード。
image	Image CES エージェントからの出力画像。
progress	string CES エージェントからの進捗状況の中間報告。

DiagnosticInfo

処理中の実行の詳細が含まれます。

フィールド
messages[]	Message 処理中に発生したメッセージのリスト。
root_span	Span リクエスト処理全体のトレース。ルートスパンとして表されます。このスパンには、特定のオペレーションのネストされた子スパンを含めることができます。

スパン

スパンは、リクエスト処理中の作業単位または単一のオペレーションです。

フィールド
name	string 出力専用。スパンの名前。
start_time	Timestamp 出力専用。スパンの開始時間。
end_time	Timestamp 出力専用。スパンの終了時間。
duration	Duration 出力専用。スパンの期間。
attributes	Struct 出力専用。スパンに関連付けられた Key-Value 属性。
child_spans[]	Span 出力専用。このスパンの下にネストされている子スパン。

SynthesizeSpeechConfig

エージェントの回答を合成する方法の構成。

フィールド
voice	string 省略可。声の名前。設定されていない場合、サービスは language_code などの他のパラメータに基づいて音声を選択します。 使用可能な音声の一覧については、Cloud Text-to-Speech のサポートされている音声と言語をご覧ください。
speaking_rate	double 省略可。話す速度（[0.25, 2.0] の範囲）。1.0 は、特定の声でサポートされているネイティブの通常の発声速度を表します。2.0 はその 2 倍の速さで、0.5 は半分の速さです。範囲 [0.25, 2.0] 外の値はエラーを返します。
model	string 省略可。音声の合成に使用されるモデル。現在サポートされている値: - 「gemini-3.1-flash-tts-preview」空の場合、Chirp3-HD が使用されます。
instruction	string 省略可。生成モデルを使用する際に音声の合成に使用される指示。

SystemTool

事前定義されたシステム ツール。

フィールド
name	string 必須。システムツールの名前。
description	string 出力専用。システム ツールの説明。

TestPersonaVoiceRequest

EvaluationService.TestPersonaVoice のリクエスト メッセージです。

フィールド
app	string 必須。ペルソナの音声をテストするアプリのリソース名。形式: projects/{project}/locations/{location}/apps/{app}
persona_id	string 必須。音声のテストに使用するペルソナ ID。「default」も使用できます。
text	string 必須。音声のテストに使用するテキスト。

TestPersonaVoiceResponse

EvaluationService.TestPersonaVoice に対するレスポンス メッセージです。

フィールド
audio	bytes 合成音声の音声データ バイト。

TimeZoneSettings

アプリのタイムゾーン設定。

フィールド
time_zone	string 省略可。タイムゾーン データベースから取得したアプリのタイムゾーン（例: America/Los_Angeles、Europe/Paris）。

TlsConfig

TLS 構成。

フィールド
ca_certs[]	TlsConfig.CaCert 必須。HTTPS 検証で許可されるカスタム CA 証明書のリストを指定します。

CaCert

CA 証明書。

フィールド
display_name	string 必須。許可されたカスタム CA 証明書の名前。これは、カスタム CA 証明書を明確にするために使用できます。
cert	bytes 必須。HTTPS 検証で許可されるカスタム CA 証明書（DER 形式）。これにより、デフォルトの SSL トラストストアがオーバーライドされます。空または未指定の場合、CES は Google のデフォルトのトラストストアを使用して証明書を検証します。注: HTTPS サーバー証明書が「サブジェクト代替名」で署名されていることを確認してください。たとえば、次のコマンドで証明書に自己署名できます。 openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'")

ツール

ツールは、CES エージェントが特定の目標を達成するために実行できるアクションを表します。

フィールド
name	string ID。ツールのリソース名。形式: スタンドアロン ツールの場合、projects/{project}/locations/{location}/apps/{app}/tools/{tool}。 ツールセットから取得されたツールの場合は projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}/tools/{tool}。 これらのツールは動的で出力専用です。ツールが想定される場所で直接参照することはできません。
display_name	string 出力専用。ツールのタイプに基づいて導出されたツールの表示名。たとえば、[ClientFunction][Tool.ClientFunction] の表示名は、その name プロパティから派生します。
execution_type	ExecutionType 省略可。ツールの実行タイプ。
timeout	Duration 省略可。ツールの実行のタイムアウト。設定しない場合、デフォルトのタイムアウトは SYNCHRONOUS ツールで 30 秒、ASYNCHRONOUS ツールで 60 秒です。
create_time	Timestamp 出力専用。ツールが作成されたときのタイムスタンプ。
update_time	Timestamp 出力専用。ツールが最後に更新されたときのタイムスタンプ。
etag	string 読み取り / 変更 / 書き込みオペレーション中にオブジェクトが変更されていないことを確認するために使用される ETag。etag が空の場合、更新によって同時変更が上書きされます。
generated_summary	string 出力専用。ツールが LLM アシスタントによって生成された場合、このフィールドには生成の概要が記述されます。
tool_fake_config	ToolFakeConfig 省略可。フェイクモードでのツールの動作の構成。
read_only	bool 出力専用。ツールが読み取り専用かどうかを示します。true の場合、ユーザーはツールを変更できません。
共用体フィールド tool_type。ツールのタイプ。tool_type は次のいずれかになります。
client_function	ClientFunction 省略可。クライアント関数。
open_api_tool	OpenApiTool 省略可。オープン API ツール。
google_search_tool	GoogleSearchTool 省略可。Google 検索ツール。
connector_tool	ConnectorTool 省略可。Integration Connector ツール。
data_store_tool	DataStoreTool 省略可。データストア ツール。
python_function	PythonFunction 省略可。Python 関数ツール。
mcp_tool	McpTool 省略可。MCP ツール。MCP ツールは直接作成または更新できず、MCP ツールセットによって管理されます。
file_search_tool	FileSearchTool 省略可。ファイル検索ツール。
system_tool	SystemTool 省略可。システムツール。
agent_tool	AgentTool 省略可。エージェント ツール。
widget_tool	WidgetTool 省略可。ウィジェット ツール。
remote_agent_tool	RemoteAgentTool 省略可。リモート エージェント ツール。

ToolCall

クライアントまたはエージェントに指定されたツールの実行をリクエストします。

フィールド
id	string 省略可。ツール呼び出しの固有識別子。入力されている場合、クライアントは ToolResponse の照合用のウェブ商品アイテム ID を含む実行結果を返す必要があります。
display_name	string 出力専用。ツールの表示名。
args	Struct 省略可。JSON オブジェクト形式のツールの入力パラメータと値。
parent_tool_call_id	string 出力専用。親通話の代わりに作業しているサブエージェントによって発行された場合、このツール呼び出しの原因となったツール呼び出しの ID。トップレベルの呼び出しの場合は空。クライアントが、サブエージェントの作業を、すべてのステップを兄弟としてレンダリングするのではなく、その作業を開始した呼び出しの下にグループ化できるようにします。
agent_name	string 出力専用。この呼び出しを発行したエージェントの人が読める形式の名前（「契約アーキテクト」など）。ルート エージェントが発行した場合は空。
共用体フィールド tool_identifier。実行するツールの識別子。永続化されたツールまたはツールセットのツールです。tool_identifier は次のいずれかになります。
tool	string 省略可。実行するツールの名前。形式: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolset_tool	ToolsetTool 省略可。実行するツールセット ツール。

ToolCalls

クライアントにツールを実行して、セッションを続行する前に実行結果を返すよう求めるリクエスト。

フィールド
tool_calls[]	ToolCall 省略可。実行するツール呼び出しのリスト。

ToolFakeConfig

フェイクモードでのツールの動作の構成。

フィールド
enable_fake_mode	bool 省略可。ツールがフェイクモードを使用しているかどうか。
共用体フィールド tool_response。レスポンスは静的であるか、Python 関数によって提供されます。tool_response は次のいずれかになります。
code_block	CodeBlock 省略可。実際のツール呼び出しの代わりに実行されるコードブロック。

ToolResponse

クライアントまたはエージェントからの特定のツールの実行結果。

フィールド
id	string 省略可。レスポンスの対象となる tool call の照合用のウェブ商品アイテム ID。
display_name	string 出力専用。ツールの表示名。
response	Struct 必須。JSON オブジェクト形式のツール実行結果。「output」キーを使用してツールのレスポンスを指定し、「error」キーを使用してエラーの詳細を指定します（ある場合）。「output」キーと「error」キーが指定されていない場合、レスポンス全体がツール実行結果として扱われます。
parent_tool_call_id	string 出力専用。親通話の代わりに作業しているサブエージェントによって発行された場合、このツール呼び出しの原因となったツール呼び出しの ID。トップレベルの呼び出しの場合は空。クライアントが、サブエージェントの作業を、すべてのステップを兄弟としてレンダリングするのではなく、その作業を開始した呼び出しの下にグループ化できるようにします。
agent_name	string 出力専用。この呼び出しを発行したエージェントの人が読める形式の名前（「契約アーキテクト」など）。ルート エージェントが発行した場合は空。
共用体フィールド tool_identifier。実行されたツールの ID。永続化されたツールまたはツールセットのツールです。tool_identifier は次のいずれかになります。
tool	string 省略可。実行するツールの名前。形式: projects/{project}/locations/{location}/apps/{app}/tools/{tool}
toolset_tool	ToolsetTool 省略可。実行されたツールセット ツール。

ToolResponses

クライアントからリクエストされたツール呼び出しの実行結果。

フィールド
tool_responses[]	ToolResponse 省略可。ツール実行結果のリスト。

ツールセット

ツールセットは、エージェントが使用できる動的に管理されるツールのグループを表します。

フィールド
name	string ID。ツールセットの固有識別子。形式: projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
display_name	string 省略可。ツールセットの表示名。同じアプリ内で一意である必要があります。
description	string 省略可。ツールセットの説明。
timeout	Duration 省略可。ツールセットの実行のタイムアウト。設定しない場合、デフォルトのタイムアウトは SYNCHRONOUS ツールセットで 30 秒、ASYNCHRONOUS ツールセットで 60 秒です。
create_time	Timestamp 出力専用。ツールセットが作成されたときのタイムスタンプ。
update_time	Timestamp 出力専用。ツールセットが最後に更新されたときのタイムスタンプ。
etag	string read-modify-write オペレーション中にオブジェクトが変更されていないことを確認するために使用される ETag。etag が空の場合、更新によって同時変更が上書きされます。
execution_type	ExecutionType 省略可。ツールセット内のツールの実行タイプ。
tool_fake_config	ToolFakeConfig 省略可。フェイクモードでのツールの動作の構成。
共用体フィールド toolset_type。ツールセットのタイプ。toolset_type は次のいずれかになります。
mcp_toolset	McpToolset 省略可。MCP サーバーが提供するツールのリストを含むツールセット。
open_api_toolset	OpenApiToolset 省略可。OpenAPI スキーマで定義されたツールのリストを含むツールセット。
connector_toolset	ConnectorToolset 省略可。Integration Connectors 接続からツールを生成するツールセット。

ToolsetTool

ツールセットから作成されたツール。

フィールド
toolset	string 必須。このツールが派生した Toolset のリソース名。形式: projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}
tool_id	string 省略可。スキーマを取得するツールをフィルタするツール ID。

TransferRule

特定のエージェントに転送するためのルール。

フィールド
child_agent	string 必須。ルールが適用される子エージェントのリソース名。形式: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
direction	TransferRule.Direction 必須。転送の方向。
共用体フィールド rule_type。ルールの種類。rule_type は次のいずれかになります。
deterministic_transfer	TransferRule.DeterministicTransfer 省略可。条件が満たされたときにターゲット エージェントに直ちに転送するルール。
disable_planner_transfer	TransferRule.DisablePlannerTransfer 省略可。プランナーがターゲット エージェントに転送できないようにするルール。

DeterministicTransfer

決定論的な転送ルール。条件が true と評価されると、転送が行われます。

フィールド
共用体フィールド condition_type。評価する条件。condition_type は次のいずれかになります。
expression_condition	ExpressionCondition 省略可。セッション状態の条件を評価するルール。条件が true と評価されると、転送が行われます。
python_code_condition	PythonCodeCondition 省略可。Python コードブロックを使用して条件を評価するルール。条件が true と評価されると、転送が行われます。

方向

転送の方向。

列挙型
DIRECTION_UNSPECIFIED	方向が指定されていません。
PARENT_TO_CHILD	親エージェントから子エージェントに転送します。
CHILD_TO_PARENT	子エージェントから親エージェントに転送します。

DisablePlannerTransfer

プランナーがターゲット エージェントに転送できないようにするルール。

フィールド
expression_condition	ExpressionCondition 必須。条件が true と評価されると、プランナーはターゲット エージェントに転送できなくなります。

TriggerAction

特定の前提条件が満たされたときに実行されるアクション。

フィールド
共用体フィールド action。必要な対応。action は次のいずれかになります。
respond_immediately	TriggerAction.RespondImmediately 省略可。事前設定された返信で即座に対応します。
transfer_agent	TriggerAction.TransferAgent 省略可。会話を別のエージェントに転送します。
generative_answer	TriggerAction.GenerativeAnswer 省略可。生成回答で応答します。

GenerativeAnswer

エージェントはすぐに生成された回答を返します。

フィールド
prompt	string 必須。生成回答に使用するプロンプト。

RespondImmediately

エージェントは、事前設定された回答ですぐに対応します。

フィールド
responses[]	TriggerAction.Response 必須。エージェントが選択できる返信定型文。回答はランダムに選択されます。

レスポンス

エージェントからのレスポンスを表します。

フィールド
text	string 必須。エージェントが返信するテキスト。
disabled	bool 省略可。レスポンスが無効かどうか。無効にしたレスポンスはエージェントによって使用されません。

TransferAgent

エージェントが会話を別のエージェントに転送します。

フィールド
agent	string 必須。会話の転送先のエージェントの名前。エージェントは、現在のエージェントと同じアプリに存在する必要があります。形式: projects/{project}/locations/{location}/apps/{app}/agents/{agent}

UpdateAgentRequest

AgentService.UpdateAgent のリクエスト メッセージです。

フィールド
agent	Agent 必須。更新するエージェント。
update_mask	FieldMask 省略可。フィールド マスクは、更新されるフィールドを制御するために使用されます。マスクが存在しない場合は、すべてのフィールドが更新されます。

UpdateAppRequest

AgentService.UpdateApp のリクエスト メッセージです。

フィールド
app	App 必須。更新するアプリ。
update_mask	FieldMask 省略可。フィールド マスクは、更新されるフィールドを制御するために使用されます。マスクが存在しない場合は、すべてのフィールドが更新されます。

UpdateAppVersionRequest

AgentService.UpdateAppVersion のリクエスト メッセージです。

フィールド
app_version	AppVersion 必須。更新するアプリのバージョン。
update_mask	FieldMask 省略可。更新するフィールドのリスト。空の場合、フィールド display_name と description が更新されます。

UpdateDeploymentRequest

AgentService.UpdateDeployment のリクエスト メッセージです。

フィールド
deployment	Deployment 必須。更新するデプロイ。
update_mask	FieldMask 省略可。更新するフィールドのリスト。

UpdateEvaluationDatasetRequest

EvaluationService.UpdateEvaluationDataset のリクエスト メッセージです。

フィールド
evaluation_dataset	EvaluationDataset 必須。更新する評価データセット。
update_mask	FieldMask 省略可。フィールド マスクは、更新されるフィールドを制御するために使用されます。マスクが存在しない場合は、すべてのフィールドが更新されます。

UpdateEvaluationExpectationRequest

EvaluationService.UpdateEvaluationExpectation のリクエスト メッセージです。

フィールド
evaluation_expectation	EvaluationExpectation 必須。更新する評価の期待値。
update_mask	FieldMask 省略可。フィールド マスクは、更新されるフィールドを制御するために使用されます。マスクが存在しない場合は、すべてのフィールドが更新されます。

UpdateEvaluationRequest

EvaluationService.UpdateEvaluation のリクエスト メッセージです。

フィールド
evaluation	Evaluation 必須。更新する評価。
update_mask	FieldMask 省略可。フィールド マスクは、更新されるフィールドを制御するために使用されます。マスクが存在しない場合は、すべてのフィールドが更新されます。

UpdateExampleRequest

AgentService.UpdateExample のリクエスト メッセージです。

フィールド
example	Example 必須。更新する例。
update_mask	FieldMask 省略可。フィールド マスクは、更新されるフィールドを制御するために使用されます。マスクが存在しない場合は、すべてのフィールドが更新されます。

UpdateGuardrailRequest

AgentService.UpdateGuardrail のリクエスト メッセージです。

フィールド
guardrail	Guardrail 必須。更新するガードレール。
update_mask	FieldMask 省略可。フィールド マスクは、更新されるフィールドを制御するために使用されます。マスクが存在しない場合は、すべてのフィールドが更新されます。

UpdateScheduledEvaluationRunRequest

EvaluationService.UpdateScheduledEvaluationRun のリクエスト メッセージです。

フィールド
scheduled_evaluation_run	ScheduledEvaluationRun 必須。更新するスケジュール設定された評価実行。
update_mask	FieldMask 省略可。フィールド マスクは、更新されるフィールドを制御するために使用されます。マスクが存在しない場合は、すべてのフィールドが更新されます。

UpdateSecuritySettingsRequest

AgentService.UpdateSecuritySettings のリクエスト メッセージです。

フィールド
security_settings	SecuritySettings 必須。更新するセキュリティ設定。
update_mask	FieldMask 省略可。フィールド マスクは、更新されるフィールドを制御するために使用されます。マスクが存在しない場合は、すべてのフィールドが更新されます。

UpdateToolRequest

AgentService.UpdateTool のリクエスト メッセージです。

フィールド
tool	Tool 必須。更新するツール。
update_mask	FieldMask 省略可。フィールド マスクは、更新されるフィールドを制御するために使用されます。マスクが存在しない場合は、すべてのフィールドが更新されます。

UpdateToolsetRequest

AgentService.UpdateToolset のリクエスト メッセージです。

フィールド
toolset	Toolset 必須。更新するツールセット。
update_mask	FieldMask 省略可。フィールド マスクは、更新されるフィールドを制御するために使用されます。マスクが存在しない場合は、すべてのフィールドが更新されます。

UploadEvaluationAudioRequest

EvaluationService.UploadEvaluationAudio のリクエスト メッセージです。

フィールド
name	string 必須。評価音声をアップロードする評価のリソース名。形式: projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}
audio_content	bytes 必須。未加工の音声バイト。音声の形式は、サンプルレートが 16 kHz のシングルチャンネル LINEAR16 である必要があります（デフォルトの InputAudioConfig）。
previous_audio_gcs_uri	string 省略可。削除する以前にアップロードした音声ファイルの Google Cloud Storage URI。形式: gs://<bucket-name>/<object-name>

UploadEvaluationAudioResponse

EvaluationService.UploadEvaluationAudio に対するレスポンス メッセージです。

フィールド
audio_gcs_uri	string アップロードされた音声ファイルが保存されている Google Cloud Storage URI。形式: gs://<bucket-name>/<object-name>
transcript	string Cloud Speech-to-Text によって生成された音声の文字起こし。
duration	Duration 音声の長さ。

VpcScSettings

アプリの VPC-SC 設定。

フィールド
allowed_origins[]	string 省略可。VPC Service Controls が有効になっている場合に、アプリ内の OpenAPI ツールが直接呼び出すことができる許可された HTTP(s) オリジン。これらの文字列は、指定されたポートを含め、オリジンと完全に一致している必要があります。例: 「https://example.com」または「https://example.com:443」。このリストは、直接 HTTP 呼び出しを行う可能性のある Python ツールにはまだ適用されていません。

WebSearchQuery

単一のウェブ検索クエリとそれに関連付けられた検索 URI を表します。

フィールド
query	string 検索クエリのテキスト。
uri	string クエリの Google 検索結果ページの URI。

WhatsAppCredentials

WhatsApp ネイティブ統合用の一時的な Meta 認証情報。

フィールド
auth_code	string 必須。埋め込み登録フローで提供される Meta 認証コード。
pin	string 必須。2 段階認証プロセス用にユーザーが作成した 6 桁の PIN。
phone_number	string 必須。WhatsApp に登録する電話番号。
business_account_id	string 必須。電話番号に使用するビジネス アカウント ID。
waba_id	string 必須。WhatsApp Business のアカウント ID。
conversation_profile_id	string 省略可。デプロイに使用する会話プロファイル ID。

WidgetTool

エージェントが呼び出すことができるウィジェット ツールを表します。エージェントがツールを選択すると、エージェントはウィジェットをクライアントに返します。クライアントは、ウィジェットの処理と、エージェントとのやり取りを継続するための次のユーザー クエリの生成を担当します。

フィールド
name	string 必須。ウィジェット ツールの表示名。
description	string 省略可。ウィジェット ツールの説明。
widget_type	WidgetTool.WidgetType 省略可。ウィジェット ツールのタイプ。指定しない場合、デフォルトのタイプは CUSTOMIZED になります。
ui_config	Struct 省略可。ウィジェットのレンダリングの構成。
data_mapping	WidgetTool.DataMapping 省略可。ソースツールのデータがウィジェットの入力パラメータにどのようにマッピングされるかを定義するマッピング。
text_response_config	WidgetTool.TextResponseConfig 省略可。常に含まれるテキスト レスポンスの構成。
共用体フィールド input。ウィジェット ツールの入力。input は次のいずれかになります。
parameters	Schema 省略可。ウィジェット ツールの入力パラメータ。

DataMapping

ソースツールのデータをウィジェットの入力パラメータにマッピングするための構成。

フィールド
source_tool_name	string 省略可。ウィジェットのデータを提供するツールのリソース名（検索ツールやカスタム関数など）。形式: projects/{project}/locations/{location}/agents/{agent}/tools/{tool}
field_mappings	map<string, string> 省略可。ウィジェットの入力パラメータ フィールドとソースツールの対応する出力フィールドのマッピング。
python_function	PythonFunction 省略可。ソースツールの出力をウィジェットの入力形式に変換するために使用される Python 関数の構成。
mode	WidgetTool.DataMapping.Mode 省略可。データ マッピングのモード。
python_script (deprecated)	string この項目は非推奨です。 非推奨: 代わりに、python_function を使用してください。

モード

ソースツールからウィジェットにデータをマッピングするために使用される戦略。

列挙型
MODE_UNSPECIFIED	モードが指定されていません。
FIELD_MAPPING	データ変換には field_mappings マップを使用します。
PYTHON_SCRIPT	データ変換には python_script を使用します。

TextResponseConfig

ウィジェットとともに返されるテキスト レスポンスの構成。

フィールド
type	WidgetTool.TextResponseConfig.Type 省略可。テキスト レスポンスを提供する戦略。
static_text	string 省略可。タイプが STATIC の場合に返す静的テキスト レスポンス。
text_response_instruction	string 省略可。テキスト レスポンスを生成する方法に関する LLM への指示。タイプが LLM_GENERATED の場合、テキスト レスポンス パラメータの説明として使用されます。

タイプ

テキスト レスポンスの生成方法を定義します。

列挙型
TYPE_UNSPECIFIED	未指定のタイプ。
NONE	LLM は、会話のコンテキストに基づいて、ウィジェットとともにテキスト レスポンスを生成するかどうかを動的に決定します。
LLM_GENERATED	LLM がテキスト レスポンスを生成することが明示的に求められています。
STATIC	事前定義された静的テキスト レスポンスが常に使用されます。

WidgetType

利用可能なすべてのウィジェット タイプ。今後、この列挙型に新しい値が追加される可能性があります。

列挙型
WIDGET_TYPE_UNSPECIFIED	ウィジェット タイプが指定されていません。
CUSTOM	カスタム ウィジェットのタイプ。
PRODUCT_CAROUSEL	商品カルーセル ウィジェット。
PRODUCT_DETAILS	商品詳細ウィジェット。
QUICK_ACTIONS	クイック操作ウィジェット。
PRODUCT_COMPARISON	プロダクト比較ウィジェット。
ADVANCED_PRODUCT_DETAILS	高度な商品詳細ウィジェット。
SHORT_FORM	ショート形式のウィジェット。
OVERALL_SATISFACTION	全体的な満足度ウィジェット。
ORDER_SUMMARY	注文の概要ウィジェット。
APPOINTMENT_DETAILS	予定の詳細ウィジェット。
APPOINTMENT_SCHEDULER	予約スケジューラ ウィジェット。
CONTACT_FORM	お問い合わせフォーム ウィジェット。