索引
AgentService(介面)AssistantService(介面)EvaluationService(介面)SessionService(介面)ToolService(介面)WidgetService(介面)Action(訊息)Action.EntityOperation(訊息)Action.EntityOperation.OperationType(enum)ActiveTurnInfo(訊息)ActiveTurnInfo.Status(enum)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(enum)ApiAuthentication(訊息)ApiKeyConfig(訊息)ApiKeyConfig.RequestLocation(enum)App(訊息)App.ToolExecutionMode(enum)App.VariableDeclaration(訊息)AppSnapshot(訊息)AppVersion(訊息)ArtifactChunk(訊息)ArtifactChunk.State(enum)AssistantChunk(訊息)AssistantConfirmationRequest(訊息)AssistantConfirmationRequest.Target(訊息)AssistantConfirmationResponse(訊息)AssistantMessage(訊息)AssistantOutput(訊息)AssistantSession(訊息)AssistantSessionArtifact(訊息)AssistantSessionState(enum)AssistantSuggestion(訊息)AssistantSuggestion.Icon(enum)AssistantSuggestion.LoadSession(訊息)AssistantSuggestion.Source(enum)AudioEncoding(enum)AudioProcessingConfig(訊息)AudioRecordingConfig(訊息)BargeInConfig(訊息)BatchDeleteConversationsRequest(訊息)BatchDeleteConversationsResponse(訊息)BearerTokenConfig(訊息)BidiSessionClientMessage(訊息)BidiSessionServerMessage(訊息)BigQueryExportSettings(訊息)Blob(訊息)Callback(訊息)CancelAssistantTurnRequest(訊息)CancelAssistantTurnResponse(訊息)Changelog(訊息)ChannelProfile(訊息)ChannelProfile.ChannelType(enum)ChannelProfile.InstagramConfig(訊息)ChannelProfile.PersonaProperty(訊息)ChannelProfile.PersonaProperty.Persona(enum)ChannelProfile.WebWidgetConfig(訊息)ChannelProfile.WebWidgetConfig.Modality(enum)ChannelProfile.WebWidgetConfig.SecuritySettings(訊息)ChannelProfile.WebWidgetConfig.Theme(enum)ChannelProfile.WhatsAppConfig(訊息)ChatAiAssistantRequest(訊息)ChatAiAssistantResponse(訊息)Chunk(訊息)Citations(訊息)Citations.CitedChunk(訊息)Citations.InlineCitation(訊息)ClientCertificateSettings(訊息)ClientFunction(訊息)CloudLoggingSettings(訊息)CodeBlock(訊息)ConnectorTool(訊息)ConnectorToolset(訊息)Conversation(訊息)Conversation.ChannelType(enum)Conversation.InputType(enum)Conversation.Source(enum)Conversation.Turn(訊息)ConversationLoggingSettings(訊息)CreateAgentRequest(訊息)CreateAppRequest(訊息)CreateAppVersionRequest(訊息)CreateAssistantSessionRequest(訊息)CreateDeploymentRequest(訊息)CreateEvaluationDatasetRequest(訊息)CreateEvaluationExpectationRequest(訊息)CreateEvaluationRequest(訊息)CreateExampleRequest(訊息)CreateGuardrailRequest(訊息)CreateScheduledEvaluationRunRequest(訊息)CreateToolRequest(訊息)CreateToolsetRequest(訊息)CustomVoiceSample(訊息)CustomVoiceSample.VoiceInstructionMode(enum)CustomVoiceSample.Warning(訊息)CustomVoiceSample.Warning.WarningType(enum)DashboardSettings(訊息)DataStore(訊息)DataStore.ConnectorConfig(訊息)DataStore.DataStoreType(enum)DataStore.DocumentProcessingMode(enum)DataStoreSettings(訊息)DataStoreSettings.Engine(訊息)DataStoreSettings.Engine.Type(enum)DataStoreTool(訊息)DataStoreTool.BoostSpec(訊息)DataStoreTool.BoostSpec.ConditionBoostSpec(訊息)DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec(訊息)DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType(enum)DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint(訊息)DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.InterpolationType(enum)DataStoreTool.BoostSpecs(訊息)DataStoreTool.DataStoreSource(訊息)DataStoreTool.EngineSource(訊息)DataStoreTool.FilterParameterBehavior(enum)DataStoreTool.GroundingConfig(訊息)DataStoreTool.ModalityConfig(訊息)DataStoreTool.ModalityConfig.ModalityType(enum)DataStoreTool.RewriterConfig(訊息)DataStoreTool.SnippetsConfig(訊息)DataStoreTool.SummarizationConfig(訊息)DeleteAgentRequest(訊息)DeleteAppRequest(訊息)DeleteAppVersionRequest(訊息)DeleteAssistantSessionRequest(訊息)DeleteConversationRequest(訊息)DeleteDeploymentRequest(訊息)DeleteEvaluationDatasetRequest(訊息)DeleteEvaluationExpectationRequest(訊息)DeleteEvaluationRequest(訊息)DeleteEvaluationResultRequest(訊息)DeleteEvaluationRunOperationMetadata(訊息)DeleteEvaluationRunRequest(訊息)DeleteExampleRequest(訊息)DeleteGuardrailRequest(訊息)DeleteScheduledEvaluationRunRequest(訊息)DeleteToolRequest(訊息)DeleteToolsetRequest(訊息)DeployChannelResponse(訊息)Deployment(訊息)Deployment.Modality(enum)EndSession(訊息)EndUserAuthConfig(訊息)EndUserAuthConfig.Oauth2AuthCodeConfig(訊息)EndUserAuthConfig.Oauth2JwtBearerConfig(訊息)EndpointControlPolicy(訊息)EndpointControlPolicy.EnforcementScope(enum)ErrorHandlingSettings(訊息)ErrorHandlingSettings.EndSessionConfig(訊息)ErrorHandlingSettings.ErrorHandlingStrategy(enum)ErrorHandlingSettings.FallbackResponseConfig(訊息)Evaluation(訊息)Evaluation.Golden(訊息)Evaluation.GoldenExpectation(訊息)Evaluation.GoldenTurn(訊息)Evaluation.Scenario(訊息)Evaluation.Scenario.Milestone(訊息)Evaluation.Scenario.TaskCompletionBehavior(enum)Evaluation.Scenario.UserFact(訊息)Evaluation.Scenario.UserGoalBehavior(enum)Evaluation.ScenarioExpectation(訊息)Evaluation.ScenarioExpectation.ToolExpectation(訊息)Evaluation.Step(訊息)EvaluationConfig(訊息)EvaluationConfig.EvaluationChannel(enum)EvaluationDataset(訊息)EvaluationErrorInfo(訊息)EvaluationErrorInfo.ErrorType(enum)EvaluationExpectation(訊息)EvaluationExpectation.LlmCriteria(訊息)EvaluationMetricsConfig(訊息)EvaluationMetricsConfig.ComparisonType(enum)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(enum)EvaluationMetricsThresholds.HallucinationMetricBehavior(enum)EvaluationMetricsThresholds.ToolMatchingSettings(訊息)EvaluationMetricsThresholds.ToolMatchingSettings.ExtraToolCallBehavior(enum)EvaluationPersona(訊息)EvaluationPersona.SpeechConfig(訊息)EvaluationPersona.SpeechConfig.BackgroundEnvironment(enum)EvaluationResult(訊息)EvaluationResult.EvaluationExpectationResult(訊息)EvaluationResult.ExecutionState(enum)EvaluationResult.GoldenExpectationOutcome(訊息)EvaluationResult.GoldenExpectationOutcome.ToolInvocationResult(訊息)EvaluationResult.GoldenResult(訊息)EvaluationResult.GoldenResult.TurnReplayResult(訊息)EvaluationResult.HallucinationResult(訊息)EvaluationResult.Outcome(enum)EvaluationResult.OutcomeMetadata(enum)EvaluationResult.OverallToolInvocationResult(訊息)EvaluationResult.ScenarioExpectationOutcome(訊息)EvaluationResult.ScenarioExpectationOutcome.ObservedToolCall(訊息)EvaluationResult.ScenarioResult(訊息)EvaluationResult.ScenarioResult.MilestoneResult(訊息)EvaluationResult.ScenarioResult.MilestoneResult.MilestoneStatus(enum)EvaluationResult.ScenarioRubricOutcome(訊息)EvaluationResult.SemanticSimilarityResult(訊息)EvaluationResult.SpanLatency(訊息)EvaluationResult.SpanLatency.Type(enum)EvaluationResult.TaskCompletionResult(訊息)EvaluationResult.ToolCallLatency(訊息)EvaluationResult.UserGoalSatisfactionResult(訊息)EvaluationRun(訊息)EvaluationRun.EvaluationRunState(enum)EvaluationRun.EvaluationRunSummary(訊息)EvaluationRun.EvaluationType(enum)EvaluationRun.Progress(訊息)EvaluationRunCachingSettings(訊息)EvaluationRunCachingSettings.EvaluationRunCachingMode(enum)EvaluationSettings(訊息)EvaluationSettings.ScenarioConversationInitiator(enum)EvaluationSettings.ScenarioExecutionMode(enum)EvaluationToolCallBehaviour(enum)Event(訊息)Example(訊息)ExecuteToolRequest(訊息)ExecuteToolResponse(訊息)ExecutionType(enum)ExperimentConfig(訊息)ExperimentConfig.State(enum)ExperimentConfig.VersionRelease(訊息)ExperimentConfig.VersionRelease.TrafficAllocation(訊息)ExportAppRequest(訊息)ExportAppRequest.ExportFormat(enum)ExportAppResponse(訊息)ExportEvaluationResultsOperationMetadata(訊息)ExportEvaluationResultsRequest(訊息)ExportEvaluationResultsResponse(訊息)ExportEvaluationRunsOperationMetadata(訊息)ExportEvaluationRunsRequest(訊息)ExportEvaluationRunsResponse(訊息)ExportEvaluationsRequest(訊息)ExportEvaluationsResponse(訊息)ExportOptions(訊息)ExportOptions.ExportFormat(enum)ExpressionCondition(訊息)FileContext(訊息)FileContext.FileBytes(訊息)FileSearchTool(訊息)FileSearchTool.CorpusType(enum)GenerateAppResourceOperationMetadata(訊息)GenerateAppResourceOperationMetadata.GenerationType(enum)GenerateAppResourceRequest(訊息)GenerateAppResourceRequest.AppGenerationConfig(訊息)GenerateAppResourceRequest.AppVersionContext(訊息)GenerateAppResourceRequest.EvaluationGenerationConfig(訊息)GenerateAppResourceRequest.EvaluationPersonasGenerationConfig(訊息)GenerateAppResourceRequest.HillClimbingFixConfig(訊息)GenerateAppResourceRequest.QualityReportGenerationConfig(訊息)GenerateAppResourceRequest.QualityReportGenerationConfig.LossAttributionAlgorithm(enum)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(enum)GenerateOnboardingSuggestionsRequest(訊息)GenerateOnboardingSuggestionsResponse(訊息)GenerateOnboardingSuggestionsResponse.UserProfile(enum)GetAgentRequest(訊息)GetAppRequest(訊息)GetAppVersionRequest(訊息)GetAssistantSessionRequest(訊息)GetChangelogRequest(訊息)GetConversationRequest(訊息)GetDeploymentRequest(訊息)GetEvaluationDatasetRequest(訊息)GetEvaluationExpectationRequest(訊息)GetEvaluationRequest(訊息)GetEvaluationResultRequest(訊息)GetEvaluationRunRequest(訊息)GetExampleRequest(訊息)GetGuardrailRequest(訊息)GetScheduledEvaluationRunRequest(訊息)GetSecuritySettingsRequest(訊息)GetToolRequest(訊息)GetToolsetRequest(訊息)GoAway(訊息)GoogleSearchSuggestions(訊息)GoogleSearchTool(訊息)GoogleSearchTool.PromptConfig(訊息)Guardrail(訊息)Guardrail.CodeCallback(訊息)Guardrail.ContentFilter(訊息)Guardrail.ContentFilter.MatchType(enum)Guardrail.LlmPolicy(訊息)Guardrail.LlmPolicy.PolicyScope(enum)Guardrail.LlmPromptSecurity(訊息)Guardrail.LlmPromptSecurity.DefaultSecuritySettings(訊息)Guardrail.ModelSafety(訊息)Guardrail.ModelSafety.HarmBlockThreshold(enum)Guardrail.ModelSafety.HarmCategory(enum)Guardrail.ModelSafety.SafetySetting(訊息)Guardrail.Supervisor(訊息)Guardrail.Supervisor.DetectionMode(enum)Guardrail.Supervisor.Type(enum)Image(訊息)ImportAppRequest(訊息)ImportAppRequest.ImportOptions(訊息)ImportAppRequest.ImportOptions.ConflictResolutionStrategy(enum)ImportAppResponse(訊息)ImportEvaluationsOperationMetadata(訊息)ImportEvaluationsRequest(訊息)ImportEvaluationsRequest.ConversationList(訊息)ImportEvaluationsRequest.ImportOptions(訊息)ImportEvaluationsRequest.ImportOptions.ConflictResolutionStrategy(enum)ImportEvaluationsResponse(訊息)InputAudioConfig(訊息)InstagramCredentials(訊息)InterruptionSignal(訊息)LanguageSettings(訊息)LatencyReport(訊息)LatencyReport.CallbackLatency(訊息)LatencyReport.GuardrailLatency(訊息)LatencyReport.LatencyMetrics(訊息)LatencyReport.LlmCallLatency(訊息)LatencyReport.ToolLatency(訊息)ListAgentsRequest(訊息)ListAgentsResponse(訊息)ListAppVersionsRequest(訊息)ListAppVersionsResponse(訊息)ListAppsRequest(訊息)ListAppsResponse(訊息)ListAssistantSessionsRequest(訊息)ListAssistantSessionsResponse(訊息)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(enum)McpToolDefinition(訊息)McpToolOverride(訊息)McpToolset(訊息)Message(訊息)MetricAnalysisSettings(訊息)MockConfig(訊息)MockConfig.UnmatchedToolCallBehavior(enum)MockedToolCall(訊息)ModelSettings(訊息)ModelSettings.ThinkingLevel(enum)OAuthConfig(訊息)OAuthConfig.OauthGrantType(enum)OpenApiTool(訊息)OpenApiToolset(訊息)OperationCompletedEvent(訊息)OperationMetadata(訊息)OptimizationConfig(訊息)OptimizationConfig.OptimizationStatus(enum)OptionQuestionsChunk(訊息)OptionQuestionsChunk.Option(訊息)OptionQuestionsChunk.Question(訊息)OutputAudioConfig(訊息)PersonaRunConfig(訊息)PythonCodeCondition(訊息)PythonFunction(訊息)QualityReport(訊息)QualityReport.AgentIssues(訊息)QualityReport.Issue(訊息)RecognitionResult(訊息)RedactionConfig(訊息)RemoteA2aConfig(訊息)RemoteAgentTool(訊息)RestoreAppVersionRequest(訊息)RestoreAppVersionResponse(訊息)RetrieveToolSchemaRequest(訊息)RetrieveToolSchemaResponse(訊息)RetrieveToolsRequest(訊息)RetrieveToolsResponse(訊息)RunAssistantRequest(訊息)RunAssistantRequest.InteractionType(enum)RunAssistantResponse(訊息)RunEvaluationOperationMetadata(訊息)RunEvaluationRequest(訊息)RunEvaluationResponse(訊息)RunEvaluationResultMetricsOperationMetadata(訊息)RunEvaluationResultMetricsRequest(訊息)RunEvaluationResultMetricsResponse(訊息)RunSessionRequest(訊息)RunSessionResponse(訊息)ScheduledEvaluationRun(訊息)ScheduledEvaluationRun.SchedulingConfig(訊息)ScheduledEvaluationRun.SchedulingConfig.Frequency(enum)Schema(訊息)Schema.Type(enum)SecuritySettings(訊息)ServiceAccountAuthConfig(訊息)ServiceAgentIdTokenAuthConfig(訊息)ServiceDirectoryConfig(訊息)SessionCheckpoint(訊息)SessionConfig(訊息)SessionConfig.RemoteDialogflowQueryParameters(訊息)SessionInput(訊息)SessionInput.RecordingControl(enum)SessionOutput(訊息)SessionOutput.DiagnosticInfo(訊息)Span(訊息)StreamChatAiAssistantRequest(訊息)StreamChatAiAssistantRequest.ClientCapability(enum)StreamChatAiAssistantResponse(訊息)SynthesizeSpeechConfig(訊息)SystemTool(訊息)TestPersonaVoiceRequest(訊息)TestPersonaVoiceResponse(訊息)TimeZoneSettings(訊息)TlsConfig(訊息)TlsConfig.CaCert(訊息)Tool(訊息)ToolCall(訊息)ToolCalls(訊息)ToolFakeConfig(訊息)ToolResponse(訊息)ToolResponses(訊息)Toolset(訊息)ToolsetTool(訊息)TransferRule(訊息)TransferRule.DeterministicTransfer(訊息)TransferRule.Direction(enum)TransferRule.DisablePlannerTransfer(訊息)TriggerAction(訊息)TriggerAction.GenerativeAnswer(訊息)TriggerAction.RespondImmediately(訊息)TriggerAction.Response(訊息)TriggerAction.TransferAgent(訊息)TurnCompletedEvent(訊息)TurnCompletedEvent.Reason(enum)TurnHandoffEvent(訊息)TurnHandoffEvent.Reason(enum)TurnMetadata(訊息)TurnMetadata.ContractStreamingPhase(enum)TurnResumeSnapshot(訊息)TypedPayload(訊息)UiEvent(訊息)UpdateAgentRequest(訊息)UpdateAppRequest(訊息)UpdateAppVersionRequest(訊息)UpdateDeploymentRequest(訊息)UpdateEvaluationDatasetRequest(訊息)UpdateEvaluationExpectationRequest(訊息)UpdateEvaluationRequest(訊息)UpdateExampleRequest(訊息)UpdateGuardrailRequest(訊息)UpdateScheduledEvaluationRunRequest(訊息)UpdateSecuritySettingsRequest(訊息)UpdateToolRequest(訊息)UpdateToolsetRequest(訊息)UploadEvaluationAudioRequest(訊息)UploadEvaluationAudioResponse(訊息)UserResponseSuggestions(訊息)VpcScSettings(訊息)WebSearchQuery(訊息)WhatsAppCredentials(訊息)WidgetTool(訊息)WidgetTool.DataMapping(訊息)WidgetTool.DataMapping.Mode(enum)WidgetTool.TextResponseConfig(訊息)WidgetTool.TextResponseConfig.Type(enum)WidgetTool.WidgetType(enum)
AgentService
這項服務用於管理 Gemini Enterprise for Customer Engagement (CES) 中與代理相關的資源。
| BatchDeleteConversations |
|---|
|
批次刪除指定的對話。
|
| CreateAgent |
|---|
|
在指定應用程式中建立新的代理。
|
| CreateApp |
|---|
|
在指定專案和位置建立新的應用程式。
|
| CreateAppVersion |
|---|
|
在指定應用程式中建立新的應用程式版本。
|
| CreateDeployment |
|---|
|
在指定應用程式中建立新的部署作業。
|
| CreateExample |
|---|
|
在指定應用程式中建立新範例。
|
| CreateGuardrail |
|---|
|
在指定應用程式中建立新的護欄。
|
| CreateTool |
|---|
|
在指定應用程式中建立新工具。
|
| CreateToolset |
|---|
|
在指定應用程式中建立新的工具集。
|
| DeleteAgent |
|---|
|
刪除指定的代理。
|
| DeleteApp |
|---|
|
刪除指定的應用程式。
|
| DeleteAppVersion |
|---|
|
刪除指定的應用程式版本。
|
| DeleteConversation |
|---|
|
刪除指定的對話。
|
| DeleteDeployment |
|---|
|
刪除指定的部署作業。
|
| DeleteExample |
|---|
|
刪除指定的範例。
|
| DeleteGuardrail |
|---|
|
刪除指定的護欄。
|
| DeleteTool |
|---|
|
刪除指定工具。
|
| DeleteToolset |
|---|
|
刪除指定的工具集。
|
| ExportApp |
|---|
|
匯出指定的應用程式。
|
| GenerateAppResource |
|---|
|
使用 LLM 助理在應用程式中生成特定資源 (例如代理)。
|
| GetAgent |
|---|
|
取得指定代理的詳細資料。
|
| GetApp |
|---|
|
取得指定應用程式的詳細資料。
|
| GetAppVersion |
|---|
|
取得指定應用程式版本的詳細資料。
|
| GetChangelog |
|---|
|
取得指定的變更記錄。
|
| GetConversation |
|---|
|
取得指定對話的詳細資料。
|
| GetDeployment |
|---|
|
取得指定部署作業的詳細資料。
|
| GetExample |
|---|
|
取得指定範例的詳細資料。
|
| GetGuardrail |
|---|
|
取得指定護欄的詳細資料。
|
| GetSecuritySettings |
|---|
|
擷取專案和位置的安全設定。
|
| GetTool |
|---|
|
取得指定工具的詳細資料。
|
| GetToolset |
|---|
|
取得指定工具集的詳細資料。
|
| ImportApp |
|---|
|
匯入指定的應用程式。
|
| ListAgents |
|---|
|
列出指定應用程式中的代理。
|
| ListAppVersions |
|---|
|
列出指定應用程式的所有版本。
|
| ListApps |
|---|
|
列出指定專案和位置中的應用程式。
|
| ListChangelogs |
|---|
|
列出指定應用程式的變更記錄。
|
| ListConversations |
|---|
|
列出指定應用程式中的對話。
|
| ListDeployments |
|---|
|
列出指定應用程式中的部署作業。
|
| ListExamples |
|---|
|
列出指定應用程式中的範例。
|
| ListGuardrails |
|---|
|
列出指定應用程式中的護欄。
|
| ListTools |
|---|
|
列出指定應用程式中的工具。
|
| ListToolsets |
|---|
|
列出指定應用程式中的工具集。
|
| RestoreAppVersion |
|---|
|
還原指定的應用程式版本。系統會根據目前的草稿應用程式建立新的應用程式版本,並以指定的應用程式版本覆寫目前的草稿。
|
| UpdateAgent |
|---|
|
更新指定的代理。
|
| UpdateApp |
|---|
|
更新指定的應用程式。
|
| UpdateAppVersion |
|---|
|
更新指定的應用程式版本。
|
| UpdateDeployment |
|---|
|
更新指定的部署作業。
|
| UpdateExample |
|---|
|
更新指定範例。
|
| UpdateGuardrail |
|---|
|
更新指定的護欄。
|
| UpdateSecuritySettings |
|---|
|
更新專案和位置的安全設定。
|
| UpdateTool |
|---|
|
更新指定工具。
|
| UpdateToolset |
|---|
|
更新指定的工具集。
|
AssistantService
這項服務用於管理 Customer Engagement Suite (CES) 中與助理相關的資源。Arc 助理是對話式代理,內嵌於 CES 應用程式,可協助使用者建構代理。
| ChatAiAssistant |
|---|
|
為指定的助理工作階段執行 AI 助理 Arc。
|
| CreateAssistantSession |
|---|
|
在指定應用程式中建立新的助理工作階段。
|
| DeleteAssistantSession |
|---|
|
刪除指定的助理工作階段。
|
| GetAssistantSession |
|---|
|
取得指定助理工作階段的詳細資料。
|
| ListAssistantSessions |
|---|
|
列出指定應用程式中的所有助理工作階段。
|
| RunAssistant |
|---|
|
為指定助理工作階段執行助理代理。
|
EvaluationService
EvaluationService 會公開方法,為 CES 應用程式執行評估。
| CreateEvaluation |
|---|
|
建立評估作業。
|
| CreateEvaluationDataset |
|---|
|
建立評估資料集。
|
| CreateEvaluationExpectation |
|---|
|
建立評估預期。
|
| CreateScheduledEvaluationRun |
|---|
|
建立排定的評估執行作業。
|
| DeleteEvaluation |
|---|
|
刪除評估作業。
|
| DeleteEvaluationDataset |
|---|
|
刪除評估資料集。
|
| DeleteEvaluationExpectation |
|---|
|
刪除評估預期。
|
| DeleteEvaluationResult |
|---|
|
刪除評估結果。
|
| DeleteEvaluationRun |
|---|
|
刪除評估執行作業。
|
| DeleteScheduledEvaluationRun |
|---|
|
刪除排定的評估作業。
|
| ExportEvaluationResults |
|---|
|
匯出評估結果。
|
| ExportEvaluationRuns |
|---|
|
匯出評估執行作業。
|
| ExportEvaluations |
|---|
|
匯出評估作業。
|
| GenerateEvaluation |
|---|
|
根據對話建立黃金評估。
|
| GetEvaluation |
|---|
|
取得指定評估作業的詳細資料。
|
| GetEvaluationDataset |
|---|
|
取得指定評估資料集的詳細資料。
|
| GetEvaluationExpectation |
|---|
|
取得指定評估預期的詳細資料。
|
| GetEvaluationResult |
|---|
|
取得指定評估結果的詳細資料。
|
| GetEvaluationRun |
|---|
|
取得指定評估執行的詳細資料。
|
| GetScheduledEvaluationRun |
|---|
|
取得指定排定評估執行的詳細資料。
|
| ImportEvaluations |
|---|
|
將評估結果匯入應用程式。
|
| ListEvaluationDatasets |
|---|
|
列出指定應用程式中的所有評估資料集。
|
| ListEvaluationExpectations |
|---|
|
列出指定應用程式中的所有評估預期。
|
| ListEvaluationResults |
|---|
|
列出指定評估作業的所有評估結果。
|
| ListEvaluationRuns |
|---|
|
列出指定應用程式中的所有評估執行作業。
|
| ListEvaluations |
|---|
|
列出指定應用程式中的所有評估。
|
| ListScheduledEvaluationRuns |
|---|
|
列出指定應用程式中所有排定的評估執行作業。
|
| RunEvaluation |
|---|
|
執行應用程式評估。
|
| RunEvaluationResultMetrics |
|---|
|
對現有評估結果執行指標。
|
| TestPersonaVoice |
|---|
|
測試角色語音。也接受預設角色。
|
| UpdateEvaluation |
|---|
|
更新評估作業。
|
| UpdateEvaluationDataset |
|---|
|
更新評估資料集。
|
| UpdateEvaluationExpectation |
|---|
|
更新評估預期。
|
| UpdateScheduledEvaluationRun |
|---|
|
更新排定的評估執行作業。
|
| UploadEvaluationAudio |
|---|
|
上傳音訊,用於黃金標準評估。將音訊儲存在「App.logging_settings.evaluation_audio_recording_config.gcs_bucket」定義的 Cloud Storage bucket,並傳回轉錄稿。
|
SessionService
工作階段服務提供 API,可與 CES 代理互動。
| BidiRunSession |
|---|
|
與 CES 代理建立雙向串流連線。代理會處理連續的多模態輸入內容 (例如文字、音訊),並生成即時多模態輸出串流。 --- 用戶端要求串流 --- 用戶端會依下列順序串流要求:
--- 伺服器回應串流 --- 每次互動時,代理會依下列順序串流訊息:
--- 音訊最佳做法 --- 1. 串流:
|
| CancelAssistantTurn |
|---|
|
取消 Google 助理工作階段的進行中回合 (如有):使用者明確停止與任何串流分離的回合。如果取消作業落在未託管回合的工作上,則會改為透過工作階段回合週期先占該工作,並在一個租約續約內結束。
|
| GenerateOnboardingSuggestions |
|---|
|
為 Arc 零狀態生成個人化新手上路建議:根據應用程式中的助理工作階段記錄,將要求使用者分類 (新使用者/探索中/回訪者),並傳回建議方塊 (繼續工作階段、繼續工作或開始新工作),在傳送任何訊息前顯示。
|
| RunSession |
|---|
|
在工作階段中與 CES 代理啟動單一回合互動。
|
| StreamChatAiAssistant |
|---|
|
以串流方式,為指定助理工作階段執行 AI 助理 Arc。
|
| StreamRunSession |
|---|
|
與 CES 代理啟動單一回合互動。使用伺服器端串流,在生成結果時提供增量結果和部分回覆。 根據預設,系統會在完整回覆 (例如回呼訊息或完整 LLM 回覆) 產生後,立即傳送給用戶端。如要直接從模型串流個別文字區塊,請將
|
ToolService
工具服務提供 API,可與 CES 工具互動。
| ExecuteTool |
|---|
|
使用指定引數執行指定工具。
|
| RetrieveToolSchema |
|---|
|
擷取指定工具的結構定義。系統會針對指定的工具執行個體,即時計算結構定義。
|
| RetrieveTools |
|---|
|
擷取指定工具集中的工具清單。
|
WidgetService
提供 API,讓小工具與 CES API 互動。
| GenerateChatToken |
|---|
|
產生聊天小工具的工作階段範圍權杖,以便向 Session API 進行驗證。
|
動作
工具要使用的動作設定。注意:這可以是動作或作業。詳情請參閱 https://cloud.google.com/integration-connectors/docs/entities-operation-action。
| 欄位 | |
|---|---|
input_fields[] |
選用。要用做作業輸入內容的實體欄位。如未指定任何欄位,系統會使用實體的所有欄位。 |
output_fields[] |
選用。作業要傳回的實體欄位。如未指定任何欄位,系統會傳回實體的所有欄位。 |
聯集欄位 action_spec。指定要為工具設定的動作。action_spec 只能是下列其中一個設定: |
|
connection_action_id |
工具要使用的連線動作 ID。 |
entity_operation |
工具要使用的實體作業設定。 |
EntityOperation
實體 CRUD 作業規格。
| 欄位 | |
|---|---|
entity_id |
這是必要旗標,實體的 ID。 |
operation |
這是必要旗標,要對實體執行的作業。 |
OperationType
要對實體執行的作業。
| 列舉 | |
|---|---|
OPERATION_TYPE_UNSPECIFIED |
未指定作業類型。無效,ConnectorTool 建立/更新作業將失敗。 |
LIST |
列出作業。 |
GET |
Get 作業。 |
CREATE |
建立作業。 |
UPDATE |
更新作業。 |
DELETE |
刪除作業。 |
ActiveTurnInfo
目前執行中、與用戶端中斷連線,或暫停等待其他伺服器工作接手的會話群組輪流即時附加資訊。
| 欄位 | |
|---|---|
turn_id |
識別回合;由 Streaming API 的 Resume 快照回應。 |
status |
目前的附件狀態。 |
start_time |
僅供輸出。回合開始時間。 |
last_progress_time |
僅供輸出。上次保留回合進度的時間。 |
orphan_deadline_time |
僅供輸出。如果沒有用戶端附加,則輪流結束的時間。 |
狀態
目前執行中的回合與用戶端和伺服器工作的關係。
| 列舉 | |
|---|---|
STATUS_UNSPECIFIED |
未指定。 |
RUNNING |
執行回合時,至少附加一個用戶端。 |
DISCONNECTED |
回合正在執行,但未連結任何用戶端。 |
RESUMING |
回合已暫停,等待接續:下次附加時會繼續。 |
ABANDONED |
該回合的伺服器租約已到期,且沒有任何工作在執行;下次讀取時,系統會將其封存為已提交的部分。無法附加。 |
代理
代理是基本建構模塊,可向大型語言模型 (LLM) 提供指令,以便執行特定工作。
| 欄位 | |
|---|---|
name |
ID。代理的專屬 ID。格式: |
display_name |
這是必要旗標,代理的顯示名稱。 |
description |
選用。人類可讀的代理說明。 |
model_settings |
選用。LLM 模型的設定。 |
instruction |
選用。給 LLM 模型的指令,用於引導代理的行為。 |
tools[] |
選用。代理可用的工具清單。格式: |
child_agents[] |
選用。代理樹狀結構中的子代理清單。格式: |
before_agent_callbacks[] |
選用。呼叫代理前要執行的回呼。系統會按照清單中的順序,依序執行提供的回呼。如果回呼傳回覆寫的回應,執行作業就會停止,並略過其餘回呼。 |
after_agent_callbacks[] |
選用。呼叫代理後要執行的回呼。系統會按照清單中的順序,依序執行提供的回呼。如果回呼傳回覆寫的回應,執行作業就會停止,並略過其餘回呼。 |
before_model_callbacks[] |
選用。呼叫模型前要執行的回呼。如果多次呼叫模型,回呼就會執行多次。系統會按照清單中的順序,依序執行提供的回呼。如果回呼傳回覆寫的回應,執行作業就會停止,並略過其餘回呼。 |
after_model_callbacks[] |
選用。呼叫模型後要執行的回呼。如果多次呼叫模型,回呼就會執行多次。系統會按照清單中的順序,依序執行提供的回呼。如果回呼傳回覆寫的回應,執行作業就會停止,並略過其餘回呼。 |
before_tool_callbacks[] |
選用。叫用工具前要執行的回呼。如果有多個工具叫用,回呼會執行多次。系統會按照清單中的順序,依序執行提供的回呼。如果回呼傳回覆寫的回應,執行作業就會停止,並略過其餘回呼。 |
after_tool_callbacks[] |
選用。叫用工具後要執行的回呼。如果有多個工具叫用,回呼會執行多次。系統會按照清單中的順序,依序執行提供的回呼。如果回呼傳回覆寫的回應,執行作業就會停止,並略過其餘回呼。 |
create_time |
僅供輸出。建立代理的時間戳記。 |
update_time |
僅供輸出。上次更新代理程式的時間戳記。 |
guardrails[] |
選用。代理的護欄清單。格式: |
etag |
Etag 可確保物件在讀取-修改-寫入作業期間未變更。如果 etag 為空白,更新作業會覆寫所有並行變更。 |
toolsets[] |
選用。代理的工具組清單。 |
generated_summary |
僅供輸出。如果代理是由 LLM 助理生成,這個欄位會包含生成作業的摘要說明。 |
transfer_rules[] |
選用。代理轉移規則。如果有多項規則符合條件,系統會使用清單中的第一項規則。 |
validation_errors[] |
僅供輸出。代理設定錯誤或有誤,可能影響代理品質。 |
聯集欄位 agent_type。代理類型。agent_type 只能是下列其中一個設定: |
|
llm_agent |
選用。預設代理類型。 |
remote_dialogflow_agent |
選用。用於執行代理的遠端 Dialogflow 代理。如果設定這個欄位,系統會忽略所有其他代理層級屬性。 注意:如果 Dialogflow 代理與應用程式位於不同專案,請將 |
remote_a2a_agent |
選用。用於執行代理的遠端 A2A 代理。 |
AgentToolset
工具組,其中包含精選工具。
| 欄位 | |
|---|---|
toolset |
這是必要旗標,工具集的資源名稱。格式: |
tool_ids[] |
選用。用於篩選工具集的工具 ID。 |
LlmAgent
這個類型沒有任何欄位。
預設代理類型。代理會使用代理中指定的指令和回呼,透過大型語言模型執行工作。
RemoteA2aAgent
代理會將執行作業轉移至遠端 A2A 代理。
| 欄位 | |
|---|---|
a2a_config |
這是必要旗標,A2A 連線設定。 |
RemoteDialogflowAgent
代理會將執行作業轉移至遠端 Dialogflow CX 代理。Dialogflow 代理會處理後續的使用者查詢,直到工作階段或流程結束,並將控制權轉回父項 CES 代理。
| 欄位 | |
|---|---|
agent |
這是必要旗標,Dialogflow 代理資源名稱。格式: |
flow_id |
選用。Dialogflow 代理中流程的流程 ID。 |
environment_id |
選用。要用於執行代理的 Dialogflow 代理環境 ID。如未指定,系統會使用草稿環境。 |
input_variable_mapping |
選用。應用程式變數名稱與 Dialogflow 工作階段參數名稱的對應關係,會傳送至 Dialogflow 代理做為輸入內容。 |
output_variable_mapping |
選用。Dialogflow 代理執行結束後,Dialogflow 工作階段參數名稱與應用程式變數名稱的對應關係,會傳回 CES 代理。 |
respect_response_interruption_settings |
選用。指出是否要遵循 Dialogflow 代理中設定的訊息層級中斷設定。
|
language_code_variable |
選用。變數名稱,包含要用於 Dialogflow 工作階段的語言代碼。如未指定,系統會使用 Dialogflow 代理的預設語言代碼。 |
AgentCard
AgentCard 會傳達遠端代理的重要資訊。這是 A2A 通訊協定中定義的 AgentCard 簡化版本:https://a2a-protocol.org/dev/specification/#441-agentcard
| 欄位 | |
|---|---|
name |
這是必要旗標,人類可讀的代理名稱。 |
description |
這是必要旗標,說明代理的動作/解決方案空間。 |
supported_interfaces[] |
這是必要旗標,支援介面的排序清單。系統會優先使用第一個項目。 |
version |
這是必要旗標,代理的版本。 |
skills[] |
這是必要旗標,技能代表代理可執行的能力單位。這可能有點抽象,但代表代理高度可能成功的一組更聚焦的動作。 |
AgentInterface
宣告目標網址、傳輸和通訊協定版本的組合,以便與代理互動。這樣一來,代理就能透過多種通訊協定繫結機制,提供相同的功能。
| 欄位 | |
|---|---|
url |
這是必要旗標,這個介面的網址。必須是正式環境中有效的絕對 HTTPS 網址。例如:「https://api.example.com/a2a/v1」、「https://grpc.example.com/a2a」 |
protocol_binding |
這是必要旗標,這個網址支援的通訊協定繫結。這是開放式表單字串,可輕鬆擴充至其他通訊協定繫結。官方支援的核心程式庫為 |
tenant |
呼叫代理時,要求中要使用的租戶 ID。 |
protocol_version |
這是必要旗標,這個介面公開的 A2A 通訊協定版本。請使用各主要版本支援的最新子版本。例如:「0.3」、「1.0」 |
AgentRegistryDeployment
Agent Registry 部署作業的設定和狀態。
| 欄位 | |
|---|---|
agent_registry_service_name |
選用。僅供輸出。已部署 Agent Registry 服務的資源名稱。格式: |
AgentSkill
代表代理可執行的特定功能。
| 欄位 | |
|---|---|
id |
這是必要旗標,代理技能的專屬 ID。 |
name |
這是必要旗標,人類可讀的技能名稱。 |
description |
這是必要旗標,技能的詳細說明。 |
tags[] |
這是必要旗標,一組描述技能功能的關鍵字。 |
examples[] |
這項技能可處理的提示或情境範例。 |
input_modes[] |
這項技能支援的輸入媒體類型組合,會覆寫代理的預設值。 |
output_modes[] |
這項技能支援的輸出媒體類型組合,會覆寫代理的預設值。 |
AgentTool
代表可讓代理呼叫其他代理的工具。
| 欄位 | |
|---|---|
name |
這是必要旗標,代理工具的名稱。 |
description |
選用。工具用途說明。 |
agent |
選用。工具進入點的代理資源名稱。格式: |
AgentTransfer
代表將對話轉移至其他代理的事件。
| 欄位 | |
|---|---|
target_agent |
這是必要旗標,對話轉移到的代理。代理會從這個時間點開始處理對話。格式: |
display_name |
僅供輸出。代理的顯示名稱。 |
AggregatedMetrics
評估或評估資料集的匯總指標。
| 欄位 | |
|---|---|
metrics_by_app_version[] |
僅供輸出。匯總指標,依應用程式版本 ID 分組。 |
HallucinationMetrics
幻覺結果的指標。
| 欄位 | |
|---|---|
score |
僅供輸出。平均幻覺分數 (0 到 1)。 |
MetricsByAppVersion
按應用程式版本匯總的指標。
| 欄位 | |
|---|---|
app_version_id |
僅供輸出。應用程式版本 ID。 |
tool_metrics[] |
僅供輸出。這個應用程式版本中各項工具的指標。 |
semantic_similarity_metrics[] |
僅供輸出。這個應用程式版本中語意相似度的指標。 |
hallucination_metrics[] |
僅供輸出。這個應用程式版本的幻覺指標。 |
tool_call_latency_metrics[] |
僅供輸出。這個應用程式版本的工具呼叫延遲時間指標。 |
turn_latency_metrics[] |
僅供輸出。這個應用程式版本的回合延遲時間指標。 |
pass_count |
僅供輸出。評估通過的次數。 |
fail_count |
僅供輸出。評估失敗的次數。 |
metrics_by_turn[] |
僅供輸出。這個應用程式版本中,按回合匯總的指標。 |
MetricsByTurn
每輪匯總的指標。
| 欄位 | |
|---|---|
turn_index |
僅供輸出。回合索引 (從 0 開始)。 |
tool_metrics[] |
僅供輸出。本輪中各項工具的指標。 |
semantic_similarity_metrics[] |
僅供輸出。這個回合內語意相似度的指標。 |
hallucination_metrics[] |
僅供輸出。這個回合的幻覺指標。 |
tool_call_latency_metrics[] |
僅供輸出。這個回合中工具呼叫延遲時間的指標。 |
turn_latency_metrics[] |
僅供輸出。這輪對話的延遲時間指標。 |
SemanticSimilarityMetrics
語意相似度結果的指標。
| 欄位 | |
|---|---|
score |
僅供輸出。平均語意相似度分數 (0 到 4)。 |
ToolCallLatencyMetrics
工具呼叫延遲時間的指標。
| 欄位 | |
|---|---|
tool |
僅供輸出。工具名稱。 |
average_latency |
僅供輸出。工具呼叫的平均延遲時間。 |
ToolMetrics
單一工具的指標。
| 欄位 | |
|---|---|
tool |
僅供輸出。工具名稱。 |
pass_count |
僅供輸出。工具通過的次數。 |
fail_count |
僅供輸出。工具失敗次數。 |
TurnLatencyMetrics
回合延遲時間的指標。
| 欄位 | |
|---|---|
average_latency |
僅供輸出。對話的平均延遲時間。 |
AmbientSoundConfig
設定與合成代理回覆一起播放的環境音,提高對話的自然度。
| 欄位 | |
|---|---|
volume_gain_db |
選用。環境噪音支援的一般原生音量增益 (以分貝為單位),範圍為 [-96.0, 16.0]。如果設為 0.0 (dB) 或不予設定,系統會以正常原生訊號振幅播放。如果設為 -6.0 (dB),系統會以約為正常原生訊號振幅的一半振幅播放。如果設為 +6.0 (dB),系統會以約為正常原生訊號振幅的兩倍振幅播放。強烈建議您不要設定超過 +10 (dB) 的值,因為在超過這個值之後,通常就無法有效提高音量。 |
聯集欄位 source。與合成的代理回覆一起播放的環境噪音,可提高對話的自然度。source 只能是下列其中一個設定: |
|
prebuilt_ambient_noise |
選用。已淘汰: |
gcs_uri |
選用。環境噪音:儲存在 Cloud Storage 的單聲道 16 kHz WAV 檔案。 注意:請確認 CES 服務代理 |
prebuilt_ambient_sound |
選用。預建環境音效的名稱。有效值如下:- "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 |
選用。API 金鑰驗證設定。 |
oauth_config |
選用。OAuth 設定。 |
service_agent_id_token_auth_config |
選用。CES 服務代理產生的 ID 權杖驗證設定。 |
service_account_auth_config |
選用。服務帳戶驗證設定。 |
bearer_token_config |
選用。不記名權杖驗證的設定。 |
ApiKeyConfig
使用 API 金鑰進行驗證的設定。
| 欄位 | |
|---|---|
key_name |
這是必要旗標,API 金鑰的參數名稱或標頭名稱。例如:如果 API 要求是「https://example.com/act?X-Api-Key= |
api_key_secret_version |
這是必要旗標,儲存 API 金鑰的 SecretManager 密鑰版本資源名稱。格式: 注意:請將 |
request_location |
這是必要旗標,要求中的金鑰位置。 |
RequestLocation
要求中 API 金鑰的位置。
| 列舉 | |
|---|---|
REQUEST_LOCATION_UNSPECIFIED |
不明。請勿使用這個值。 |
HEADER |
代表 HTTP 標頭中的鍵。 |
QUERY_STRING |
代表查詢字串中的鍵。 |
應用程式
應用程式是頂層容器,可容納一組代理 (包括根層級代理和子代理) 及其相關設定。這些代理會共同合作,在應用程式情境中達成特定目標。
| 欄位 | |
|---|---|
name |
ID。應用程式的專屬 ID。格式: |
display_name |
這是必要旗標,應用程式的顯示名稱。 |
description |
選用。人類可讀的應用程式說明。 |
pinned |
選用。應用程式是否固定在應用程式清單中。 |
root_agent |
選用。根代理是應用程式的進入點。格式: |
language_settings |
選用。應用程式的語言設定。 |
time_zone_settings |
選用。應用程式的時區設定。 |
audio_processing_config |
選用。應用程式的音訊處理設定。 |
logging_settings |
選用。應用程式的記錄設定。 |
error_handling_settings |
選用。應用程式的錯誤處理設定。 |
model_settings |
選用。應用程式的預設 LLM 模型設定。個別資源 (例如代理、護欄) 可視需要覆寫這些設定。 |
tool_execution_mode |
選用。應用程式的工具執行模式。如未提供,則預設為 PARALLEL。 |
evaluation_metrics_thresholds |
選用。應用程式的評估門檻。 |
variable_declarations[] |
選用。變數宣告。 |
predefined_variable_declarations[] |
僅供輸出。應用程式預先定義變數的宣告。 |
global_instruction |
選用。應用程式中所有代理的操作說明。您可以使用這項操作說明,為所有代理設定穩定的身分或個性。 |
guardrails[] |
選用。應用程式的護欄清單。格式: |
data_store_settings |
選用。應用程式的資料儲存庫設定。 |
default_channel_profile |
選用。應用程式使用的預設管道設定檔。 |
metadata |
選用。應用程式的中繼資料。這個欄位可用於儲存與應用程式詳細資料或預期用途相關的其他資訊。 |
create_time |
僅供輸出。應用程式的建立時間戳記。 |
update_time |
僅供輸出。上次更新應用程式的時間戳記。 |
etag |
僅供輸出。Etag 可確保物件在讀取-修改-寫入作業期間未變更。如果 etag 為空白,更新作業會覆寫所有並行變更。 |
deployment_count |
僅供輸出。應用程式中的部署作業數量。 |
client_certificate_settings |
選用。應用程式的預設用戶端憑證設定。 |
vpc_sc_settings |
選用。應用程式的 VPC-SC 設定。 |
locked |
選用。指出應用程式是否已鎖定,無法變更。如果應用程式已鎖定,系統會拒絕修改應用程式資源。 |
evaluation_personas[] |
選用。應用程式的評估角色。這個欄位用於定義可用於評估的角色。最多可定義 30 個角色。 |
evaluation_settings |
選用。應用程式的評估設定。 |
validation_errors[] |
僅供輸出。應用程式設定錯誤或警告。 |
dashboard_settings |
選用。應用程式專屬資訊主頁設定,用於連結及設定 Contact Center Insights 資訊主頁。 |
ToolExecutionMode
定義代理同時選取多個工具時,工具的執行行為。
| 列舉 | |
|---|---|
TOOL_EXECUTION_MODE_UNSPECIFIED |
未指定工具執行模式。預設為 PARALLEL。 |
PARALLEL |
如果選取多項工具,系統會使用相同的 ToolContext 平行執行這些工具。 |
SEQUENTIAL |
如果選取多項工具,系統會依序執行。前一個工具執行完畢後,下一個工具才會執行,並可查看前一個工具更新後的 ToolContext。 |
VariableDeclaration
定義變數的結構和中繼資料。
| 欄位 | |
|---|---|
name |
這是必要旗標,變數名稱。名稱只能使用英文字母、數字或底線,開頭須為英文字母或底線。 |
description |
這是必要旗標,變數的說明。 |
schema |
這是必要旗標,變數的結構定義。 |
AppSnapshot
應用程式的快照。
| 欄位 | |
|---|---|
app |
選用。應用程式的基本設定。 |
agents[] |
選用。應用程式中的代理清單。 |
tools[] |
選用。應用程式中的工具清單。 |
examples[] |
選用。應用程式中的範例清單。 |
guardrails[] |
選用。應用程式中的護欄清單。 |
toolsets[] |
選用。應用程式中的工具組清單。 |
AppVersion
在 Customer Engagement Suite (CES) 中,應用程式版本是應用程式在特定時間點的快照。這項設定建立後即無法變更。
| 欄位 | |
|---|---|
name |
ID。應用程式版本的專屬 ID。格式: |
display_name |
選用。應用程式版本的顯示名稱。 |
description |
選用。應用程式版本的說明。 |
creator |
僅供輸出。建立應用程式版本的使用者電子郵件地址。 |
create_time |
僅供輸出。應用程式版本的建立時間戳記。 |
update_time |
僅供輸出。上次更新應用程式版本的時間戳記。 |
snapshot |
僅供輸出。建立版本時的應用程式快照。 |
etag |
僅供輸出。Etag 可確保物件在讀取-修改-寫入作業期間未變更。如果 etag 為空白,更新作業會覆寫所有並行變更。 |
ArtifactChunk
助理正在生成的串流文件構件片段 (例如 Markdown TDD)。系統會在寫入文件時串流內容差異,讓用戶端顯示即時預覽畫面;檔案保存後,FINALIZED 區塊會攜帶 Cloud Storage URI。
| 欄位 | |
|---|---|
artifact_id |
構件的 ID,在串流中一個構件的所有區塊中皆相同。 |
display_name |
向使用者顯示的檔案名稱,例如「hotel_booking_tdd.md」。在 STARTED 狀態設定 (並在 FINALIZED 狀態重複)。 |
mime_type |
構件內容的 IANA 媒體類型,例如「text/markdown」。 |
content_delta |
增量構件內容。在 DELTA 區塊上設定。 |
gcs_uri |
構件保存至的 Cloud Storage 物件。在 FINALIZED 區塊上設定。 |
state |
這個區塊的生命週期位置。 |
target_app |
僅供輸出。如果這個構件是為某個應用程式產生,則會顯示該應用程式。格式: |
狀態
這個區塊在構件串流中的生命週期位置。
| 列舉 | |
|---|---|
STATE_UNSPECIFIED |
未使用的預設值。 |
STARTED |
助理已開始生成構件。 |
DELTA |
內容增量;已設定 content_delta。 |
FINALIZED |
構件已保存,gcs_uri 已設定。 |
FAILED |
生成或保存失敗,未儲存構件。 |
CLOSED |
文件已完成串流:內容已透過 content_delta 區塊完整傳送。系統仍可能執行永久保存作業;如果構件已儲存,系統會傳送含有 gcs_uri 的 FINALIZED 區塊。 |
AssistantChunk
助理訊息中的資料區塊。
| 欄位 | |
|---|---|
create_time |
選用。建立或發出區塊的時間戳記。 |
聯集欄位 data。區塊中的資料。data 只能是下列其中一個設定: |
|
text |
選用。文字資料。 |
thought |
選用。模型生成的想法。 |
payload |
選用。酬載,內含品質報表、代理版本名稱、建議回覆等結構化回覆。 |
typed_payload |
選用。包含結構化回應的類型化酬載。 |
AssistantConfirmationRequest
助理需要先回答封鎖問題或確認,才能繼續執行代理動作。提出要求的代理會暫停,直到後續的 StreamChatAiAssistantRequest.confirmation_response 傳回答案後才會恢復。
| 欄位 | |
|---|---|
confirmation_id |
將這項要求與其回應建立關聯的 ID。對用戶端不透明;必須在回答要求時逐字回應。 |
context |
說明確認內容的背景資訊 (例如:代理要執行的動作,或需要回答的問題)。以純文字形式顯示,而非 Markdown。 |
positive_label |
二進位確認核准動作的標籤 (例如「發布」)。如果已填入 |
negative_label |
二進位確認拒絕動作的標籤 (例如「還沒」)。如果已填入 |
questions[] |
確認的多選表單。填入資料後,資訊卡會顯示可選取的選項清單,並將所選選項的 submit_text (或任意形式的使用者文字) 傳回為 |
tool |
代理暫停的工具呼叫名稱 (例如「update_app」),用於資訊卡標題。如果是純問題,則不設定。 |
agent_name |
資訊卡標頭:提出確認要求的代理顯示標籤 (例如「 |
expire_time |
超過這個時間後,就無法再回覆這項確認要求。過期的卡片會顯示為無效,伺服器會在下一輪拒絕確認,因此暫停的代理不會無限期等待。 |
targets[] |
確認動作會變更的所有內容,因此控制台可以顯示「更新 2 個應用程式」和每個應用程式一個徽章。舊版單一目標資訊卡則為空白。 |
目標
確認動作會變更的一項資源。
| 欄位 | |
|---|---|
resource |
要變更的資源,以完整資源名稱表示。 |
display_name |
資訊卡中資源或應用程式的顯示名稱。 |
action |
動作,例如 |
target_app |
資源所屬的應用程式,如果是建立應用程式等位置範圍動作,則留空。格式: |
AssistantConfirmationResponse
使用者對 AssistantConfirmationRequest 的回答,會在下一次 SessionService.StreamChatAiAssistant 呼叫時傳送,以恢復暫停的代理。
| 欄位 | |
|---|---|
confirmation_id |
|
聯集欄位 response。使用者的答案。response 只能是下列其中一個設定: |
|
confirmed |
二進位答案:true 表示核准暫停動作,false 表示拒絕。 |
answer_text |
所選選項的 submit_text,或使用者自由輸入的文字。暫停的動作會取消,文字會交給代理處理。 |
AssistantMessage
助理工作階段中的訊息。
| 欄位 | |
|---|---|
role |
這是必要旗標,對話中的角色:「user」或「model」。 |
chunks[] |
選用。訊息內容 (以區塊形式呈現)。 |
event_time |
這是必要旗標,傳送或接收訊息的時間戳記。 |
attached_gcs_uris[] |
選用。使用者在這輪對話上傳檔案的 Cloud Storage URI。這樣一來,附件就能保留並顯示在工作階段記錄 UI 中。範例:「gs://cxas-transient-uploads/uuid/prd.pdf」 |
AssistantOutput
助理代理的輸出內容。
| 欄位 | |
|---|---|
message |
這是必要旗標,助理代理的回覆。 |
user_response_suggestions |
僅供輸出。助理代理建議的使用者回覆。 |
AssistantSession
助理工作階段代表使用者與助理代理之間的對話。
| 欄位 | |
|---|---|
name |
這是必要旗標,ID。工作階段的專屬 ID。格式: |
requestor |
僅供輸出。發起工作階段的使用者。 |
messages[] |
選用。工作階段中的訊息記錄。 |
state |
僅供輸出。助理工作階段的狀態。 |
create_time |
僅供輸出。建立助理工作階段的時間。 |
update_time |
僅供輸出。上次更新 Google 助理工作階段的時間。 |
user_response_suggestions |
僅供輸出。助理代理建議的使用者回覆。 |
display_name |
選用。助理工作階段的顯示名稱。 |
artifacts[] |
僅供輸出。助理在這個工作階段中產生的文件構件 (例如以 Markdown 格式產生的 TDD)。僅限指標;檔案內容會儲存在客戶的 Cloud Storage bucket。 |
session_checkpoint |
僅供輸出。工作階段檢查點,包含使用者意圖和滾動記錄摘要。 |
active_turn |
僅供輸出。這個工作階段目前執行中的回合附件資訊。如果沒有執行中的回合,則不設定。 |
touched_apps[] |
僅供輸出。這個工作階段指定或變更的應用程式 (僅限專案範圍工作階段),用於記錄標記。格式: |
AssistantSessionArtifact
助理在工作階段中生成的文件構件,會以檔案形式儲存在客戶的 Cloud Storage bucket。
| 欄位 | |
|---|---|
id |
僅供輸出。工作階段中構件的專屬 ID。 |
display_name |
僅供輸出。向使用者顯示的檔案名稱,例如「hotel_booking_tdd.md」。 |
gcs_uri |
僅供輸出。存放構件內容的 Cloud Storage 物件。例如:「gs://{project}-agent-assist-artifacts/agent-assist-generated/1_tdd.md」 |
mime_type |
僅供輸出。構件內容的 IANA 媒體類型,例如「text/markdown」。 |
create_time |
僅供輸出。構件保存時間。 |
turn_index |
僅供輸出。[AssistantSession.messages] 中訊息的索引,其回合產生了構件,用於在還原歷史記錄時放置構件方塊。 |
AssistantSessionState
助理工作階段的狀態。
| 列舉 | |
|---|---|
ASSISTANT_SESSION_STATE_UNSPECIFIED |
預設值。如未指定狀態,系統會使用這個值。 |
PROCESSING |
助理代理正在處理要求,這項工作需要較長時間。 |
IDLE |
助理代理處於閒置狀態,沒有任何待處理的要求或回覆。 |
PENDING_REVIEW |
助理代理已完成長時間執行的工作,並準備好回覆使用者。 |
AssistantSuggestion
Arc 零狀態的單一個人化新手上路建議方塊。
| 欄位 | |
|---|---|
suggestion_id |
這項建議的固定 ID,由用戶端在互動記錄中來回傳送。 |
label |
向使用者顯示的方塊標籤 (最多 60 個半形字元)。 |
rationale |
簡短說明顯示這項建議的原因 (工具提示/原因彈出式視窗),此為選填項目。 |
icon |
方塊的圖示提示。 |
source |
這項建議的產生方式。 |
candidate_type |
規則表候選類型,以 kebab case 表示 (例如「resume-pending-review」),用於指標。 |
聯集欄位 action。啟用晶片的作用。action 只能是下列其中一個設定: |
|
seed_prompt |
在撰寫工具中預填這段文字,使用者可查看並傳送。 |
load_session |
開啟現有的助理工作階段。 |
send_message |
在撰寫工具中預填這段文字,並立即提交。僅用於新進人員訓練對話中的快速回覆方塊。 |
圖示
方塊的圖示提示。
| 列舉 | |
|---|---|
ICON_UNSPECIFIED |
未指定圖示。 |
RESUME |
繼續先前的課程。 |
BUILD |
建立新內容。 |
EVALUATE |
評估相關建議。 |
DEPLOY |
部署作業相關建議。 |
EXPLORE |
探索/發現建議。 |
FIX |
修正錯誤或失敗狀態。 |
LoadSession
load_session 動作的參數。
| 欄位 | |
|---|---|
assistant_session_id |
要開啟的 Google 助理工作階段 ID (AssistantSession 資源名稱的最後一個區隔)。 |
來源
這項建議的產生方式。
| 列舉 | |
|---|---|
SOURCE_UNSPECIFIED |
未指定來源。 |
RULE |
採用範本語句的確定性規則表候選項目。 |
LLM_RANKED |
規則表候選項目,由 LLM 措辭步驟重新排序及措辭。 |
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 |
選用。代理回覆的合成方式設定,從語言代碼對應至 如果找不到指定語言代碼的設定,系統會使用根語言代碼的設定。舉例來說,如果對應表包含「en-us」和「en」,而指定的語言代碼是「en-gb」,則會使用「en」設定。 注意:語言代碼不區分大小寫。 |
barge_in_config |
選用。設定使用者插話活動的代理行為。 |
inactivity_timeout |
選用。使用者閒置 (未說話或互動) 多久後,代理會提示使用者重新互動。如未設定,代理就不會提示使用者重新互動。 |
ambient_sound_config |
選用。設定與合成代理回覆一起播放的環境音,提高對話的自然度。 |
custom_voice_samples[] |
選用。設定用於語音複製的自訂語音樣本。 |
AudioRecordingConfig
音訊互動的錄製方式設定。
| 欄位 | |
|---|---|
gcs_bucket |
選用。用於儲存工作階段音訊錄音檔的 Cloud Storage bucket。URI 開頭必須是「gs://」。 請選擇符合資料落地規定的 bucket 位置。 注意:如果 Cloud Storage bucket 與應用程式位於不同專案,請將 |
gcs_path_prefix |
選用。錄音檔的 Cloud Storage 路徑前置字串。 這個前置字元可包含下列預留位置,這些預留位置會在提供時動態替換:- $project:專案 ID - $location:應用程式位置 - $app:應用程式 ID - $date:工作階段日期,格式為 YYYY-MM-DD - $session:工作階段 ID 如未指定路徑前置字串,系統會使用預設前置字串 |
BargeInConfig
使用者插話活動的處理方式設定。
| 欄位 | |
|---|---|
disable_barge_in |
選用。已淘汰: 停用使用者在代理說話時插話的功能。如果設為 true,系統會忽略代理回覆播放期間的使用者輸入內容。 |
barge_in_awareness |
選用。啟用後,代理會假設使用者未聽完先前的完整訊息,並據此調整下一個回覆。如果代理的回覆會以視覺化方式呈現,請勿使用這個屬性。 |
BatchDeleteConversationsRequest
| 欄位 | |
|---|---|
parent |
這是必要旗標,要刪除對話的應用程式資源名稱,格式: |
conversations[] |
這是必要旗標,要刪除的對話資源名稱。 |
BatchDeleteConversationsResponse
| 欄位 | |
|---|---|
deleted_conversations[] |
已成功刪除的對話清單。 |
failed_conversations[] |
無法刪除的對話清單。 |
error_messages[] |
選用。與刪除失敗的對話相關聯的錯誤訊息清單。 |
BearerTokenConfig
使用不記名權杖進行驗證的設定。
| 欄位 | |
|---|---|
token |
這是必要旗標,不記名權杖。格式必須為 |
BidiSessionClientMessage
用戶端針對 SessionService.BidiRunSession 方法傳送的頂層訊息。
| 欄位 | |
|---|---|
聯集欄位 message_type。訊息類型。message_type 只能是下列其中一個設定: |
|
config |
選用。工作階段的初始設定訊息。 |
realtime_input |
選用。工作階段的即時輸入內容。 |
BidiSessionServerMessage
從 SessionService.BidiRunSession 方法傳回的頂層訊息。
| 欄位 | |
|---|---|
聯集欄位 message_type。訊息類型。message_type 只能是下列其中一個設定: |
|
session_output |
選用。CES 代理的處理結果。 |
recognition_result |
選用。音訊輸入的即時語音辨識結果。 |
interruption_signal |
選用。表示代理的音訊回覆已中斷。 |
end_session |
選用。表示工作階段已結束。 |
go_away |
選用。表示伺服器即將中斷連線,用戶端應半關閉並重新啟動連線。 |
BigQueryExportSettings
用於描述應用程式 BigQuery 匯出行為的設定。
| 欄位 | |
|---|---|
enabled |
選用。指出是否啟用 BigQuery Export。 |
project |
選用。要匯出資料的 BigQuery 資料集專案 ID。 注意:如果 BigQuery 資料集與應用程式位於不同專案,請將 |
dataset |
選用。要匯出資料的 BigQuery 資料集 ID。 |
Blob
代表對話中的 blob 輸入或輸出內容。
| 欄位 | |
|---|---|
mime_type |
這是必要旗標,來源資料的 IANA 標準 MIME 類型。 |
data |
這是必要旗標,Blob 的原始位元組。 |
回撥電話
回呼會定義在代理互動的不同階段執行的自訂邏輯。
| 欄位 | |
|---|---|
description |
選用。人類可讀的回呼說明。 |
disabled |
選用。回呼是否已停用。代理會忽略停用的回呼。 |
proactive_execution_enabled |
選用。如果啟用,回呼也會在中間模型輸出內容上執行。這項設定只會影響 After Model 回呼。請謹慎啟用。一般來說,After Model 回呼只需在收到所有模型回覆後執行。啟用主動執行功能可能會對執行成本和延遲時間產生負面影響,因此請只在少數情況下啟用。 |
聯集欄位 callback。要執行的回呼。callback 只能是下列其中一個設定: |
|
python_code |
這是必要旗標,要為回呼執行的 Python 程式碼。 |
CancelAssistantTurnRequest
要求取消助理工作階段中正在執行的回合。
| 欄位 | |
|---|---|
name |
這是必要旗標,要取消進行中對話的 Google 助理工作階段。 |
turn_id |
選用。要取消的回合;如果留空,則會取消正在執行的回合。如果取消作業指定的輪次已非執行中的輪次,則不會執行任何操作。 |
CancelAssistantTurnResponse
CancelAssistantTurn 的回應。
| 欄位 | |
|---|---|
cancelled |
是否找到執行中的回合,並要求停止 (直接在這個任務上,或透過在其他位置託管的回合進行 epoch 搶占)。 |
變更記錄
變更記錄代表對應用程式或應用程式內資源所做的變更。
| 欄位 | |
|---|---|
name |
ID。變更記錄的專屬 ID。格式: |
author |
僅供輸出。變更作者的電子郵件地址。 |
display_name |
僅供輸出。變更的顯示名稱。通常應為已變更資源的顯示名稱。 |
description |
僅供輸出。變更說明,通常會擷取資源中變更的欄位。 |
resource |
僅供輸出。變更的資源。 |
resource_type |
僅供輸出。變更的資源類型。 |
action |
僅供輸出。對資源執行的動作。 |
original_resource |
僅供輸出。變更前的原始資源。 |
new_resource |
僅供輸出。變更後的新資源。 |
dependent_resources[] |
僅供輸出。已變更的依附資源。 |
create_time |
僅供輸出。變更時間。 |
sequence_number |
僅供輸出。變更記錄的序號,會單調遞增。 |
ChannelProfile
ChannelProfile 會設定代理在特定通訊管道 (例如網頁 UI 或電話) 的行為。
| 欄位 | |
|---|---|
profile_id |
選用。管道設定檔的專屬 ID。 |
channel_type |
選用。管道設定檔的類型。 |
persona_property |
選用。頻道個人資料的人物角色屬性。 |
web_widget_config |
選用。網頁小工具的設定。 |
whatsapp_config |
選用。WhatsApp 部署作業專屬設定。 |
instagram_config |
選用。Instagram 部署作業專屬設定。 |
disable_dtmf |
選用。是否停用 DTMF (雙音多頻)。 |
disable_barge_in_control |
選用。是否停用對話中的使用者插話控制項。- true:代理說話時,使用者無法中斷。- false:代理會自動控制使用者何時可以中斷。 |
noise_suppression_level |
選用。頻道設定檔的雜訊抑制等級。可用值為「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 |
這是必要旗標,Instagram 帳戶 ID。 |
display_name |
僅供輸出。擷取的 Meta 商家頁面名稱。 |
thumbnail_url |
僅供輸出。擷取的 Meta 商家檔案縮圖網址。 |
description |
僅供輸出。Meta 商家專頁或商家檔案的說明。 |
PersonaProperty
代表頻道的角色屬性。
| 欄位 | |
|---|---|
persona |
選用。頻道的人物設定。 |
角色
頻道的人物設定。
| 列舉 | |
|---|---|
UNKNOWN |
UNKNOWN 角色。 |
CONCISE |
代理的回覆簡明扼要 |
CHATTY |
代理會提供額外背景資訊、說明和詳細資料 |
WebWidgetConfig
網頁小工具設定訊息。
| 欄位 | |
|---|---|
modality |
選用。網頁小工具的模態。 |
theme |
選用。網頁小工具的主題。 |
web_widget_title |
選用。網頁小工具的標題。 |
security_settings |
選用。網頁小工具的安全性設定。 |
模態
網頁小工具的互動模式。
| 列舉 | |
|---|---|
MODALITY_UNSPECIFIED |
不明模態。 |
CHAT_AND_VOICE |
小工具支援即時通訊和語音輸入。 |
VOICE_ONLY |
小工具僅支援語音輸入。 |
CHAT_ONLY |
小工具僅支援對話輸入。 |
CHAT_VOICE_AND_VIDEO |
小工具支援即時通訊、語音和影片輸入。 |
SecuritySettings
網頁小工具的安全性設定。
| 欄位 | |
|---|---|
enable_public_access |
選用。指出是否已啟用網頁小工具的公開存取權。如果設為 |
enable_origin_check |
選用。指出是否啟用網頁小工具的來源檢查。如果 |
allowed_origins[] |
選用。允許託管網頁小工具的來源。來源由 RFC 6454 定義。如果留空,則允許所有來源。最多可設定 100 個來源。例如:「https://example.com」 |
enable_recaptcha |
選用。指出是否已啟用網頁小工具的 reCAPTCHA 驗證。 |
主題
網頁小工具的主題。
| 列舉 | |
|---|---|
THEME_UNSPECIFIED |
不明主題。 |
LIGHT |
淺色主題。 |
DARK |
深色主題。 |
WhatsAppConfig
WhatsApp 部署作業專屬設定。
| 欄位 | |
|---|---|
waba_id |
這是必要旗標,WhatsApp Business 帳戶 ID。 |
phone_number_id |
這是必要旗標,Meta 電話號碼 ID。 |
phone_number |
選用。電話號碼,格式為 E.164。 |
display_name |
僅供輸出。擷取的 Meta 商家頁面名稱。 |
thumbnail_url |
僅供輸出。擷取的 Meta 商家檔案縮圖網址。 |
description |
僅供輸出。Meta 商家專頁或商家檔案的說明。 |
ChatAiAssistantRequest
| 欄位 | |
|---|---|
app |
這是必要旗標,要執行助理的應用程式。格式: |
assistant_session |
這是必要旗標,用於執行助理的助理工作階段。格式: |
message |
這是必要旗標,要傳送給助理代理的訊息。 |
attached_gcs_uris[] |
選用。使用者在這輪對話上傳檔案的 Cloud Storage URI。範例:「gs://cxas-transient-uploads/uuid/prd.pdf」 |
context_token |
選用。 |
ChatAiAssistantResponse
| 欄位 | |
|---|---|
event_id |
事件的專屬 ID。 |
event_time |
事件發生時的時間戳記。 |
ui_event |
選用。UI 事件酬載。 |
聯集欄位 event。事件酬載。event 只能是下列其中一個設定: |
|
text_chunk |
文字詞元 (用於逐字串流 Gemini 回覆) |
status_message |
簡單的狀態更新 |
session_checkpoint |
工作階段檢查點/壓縮摘要事件,包含使用者意圖和滾動摘要。 |
Chunk
訊息中的內容區塊。
| 欄位 | |
|---|---|
聯集欄位 data。將資料分塊。data 只能是下列其中一個設定: |
|
text |
選用。文字資料。 |
transcript |
選用。與音訊相關聯的轉錄稿。 |
blob |
選用。Blob 資料。 |
payload |
選用。自訂酬載資料。 |
image |
選用。圖片資料。 |
tool_call |
選用。工具執行要求。 |
tool_response |
選用。工具執行回應。 |
agent_transfer |
選用。代理轉移事件。 |
updated_variables |
struct 代表對話中更新的變數,以變數名稱為鍵。 |
default_variables |
struct 代表對話開始時的預設變數,以變數名稱為索引鍵。 |
參考資料
與代理回覆相關聯的引用內容。
| 欄位 | |
|---|---|
cited_chunks[] |
引用的資訊清單。 |
inline_citations[] |
選用。代理回覆中的內嵌引用內容清單。 |
CitedChunk
引用的資訊。
| 欄位 | |
|---|---|
uri |
用於引用的 URI。 |
title |
引用文件的標題。 |
text |
用於引用的文字。 |
requires_attribution |
是否需要向使用者顯示這項引用的出處。 |
InlineCitation
回覆文字中的內嵌引用。
| 欄位 | |
|---|---|
start_index |
代理回覆中文字區隔的起始索引 (以位元組為單位)。 |
end_index |
代理回覆中文字區段的結尾索引 (以位元組為單位)。 |
cited_chunk_indices[] |
支援這個文字片段的引用區塊索引。索引是指 |
ClientCertificateSettings
自訂用戶端憑證的設定。
| 欄位 | |
|---|---|
tls_certificate |
這是必要旗標,以 PEM 格式編碼的 TLS 憑證。這個字串必須包含開頭標頭和結尾頁尾行。 |
private_key |
這是必要旗標,SecretManager 密鑰版本資源的名稱,用於儲存以 PEM 格式編碼的私密金鑰。格式: |
passphrase |
選用。SecretManager Secret 版本資源的名稱,用於儲存解密私密金鑰的通關密語。如果私密金鑰未加密,請勿設定這個欄位。格式: |
ClientFunction
代表代理可叫用的用戶端函式。代理選取工具後,控制權會移交給用戶端。用戶端負責執行函式,並以 ToolResponse 形式傳回結果,以便繼續與代理互動。
| 欄位 | |
|---|---|
name |
這是必要旗標,函式名稱。 |
description |
選用。函式說明。 |
parameters |
選用。函式參數的結構定義。 |
response |
選用。函式回應的結構定義。 |
CloudLoggingSettings
說明應用程式 Cloud Logging 行為的設定。
| 欄位 | |
|---|---|
enable_cloud_logging |
選用。是否要為工作階段啟用 Cloud Logging。 |
CodeBlock
要執行的程式碼區塊,而非實際的工具呼叫。
| 欄位 | |
|---|---|
python_code |
這是必要旗標,在工具模擬模式中叫用的 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 |
這是必要旗標,參照的 Integration Connectors 連線完整資源名稱。格式: |
action |
這是必要旗標,工具要執行的動作。 |
auth_config |
選用。設定 Integration Connectors 處理驗證的方式。根據預設,Integration Connectors API 要求會傳遞管理員驗證。您可以使用其他使用者驗證設定覆寫這項設定。注意:連線必須啟用驗證覆寫功能,才能在這裡指定 EUC 設定,否則 ConnectorTool 建立作業會失敗。詳情請參閱 https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override。 |
name |
選用。代理可使用的工具名稱,用於決定是否呼叫這個 ConnectorTool。 |
description |
選用。工具說明,代理可依據這項資訊決定是否呼叫這個 ConnectorTool。 |
ConnectorToolset
這組工具可從 Integration Connectors 連線生成工具。
| 欄位 | |
|---|---|
connection |
這是必要旗標,參照的 Integration Connectors 連線完整資源名稱。格式: |
auth_config |
選用。設定 Integration Connectors 處理驗證的方式。根據預設,Integration Connectors API 要求會傳遞管理員驗證。您可以使用其他使用者驗證設定覆寫這項設定。注意:連線必須啟用驗證覆寫功能,才能在這裡指定 EUC 設定,否則無法建立工具組。詳情請參閱:https://cloud.google.com/application-integration/docs/configure-connectors-task#configure-authentication-override |
connector_actions[] |
這是必要旗標,要產生工具的連接器動作/實體作業清單。 |
對話
對話代表使用者與 CES 應用程式之間的互動。
| 欄位 | |
|---|---|
name |
ID。對話的專屬 ID。格式: |
start_time |
僅供輸出。對話建立時間的時間戳記。 |
end_time |
僅供輸出。對話完成時的時間戳記。 |
turns[] |
這是必要旗標,對話中的回合。 |
turn_count |
僅供輸出。對話中的互動次數。 |
channel_type |
已淘汰。請改用 |
source |
僅供輸出。指出對話來源。 |
input_types[] |
僅供輸出。對話的輸入內容類型。 |
entry_agent |
僅供輸出。一開始處理對話的代理。如未指定,對話會由根代理處理。格式: |
deployment |
僅供輸出。用於處理對話的應用程式部署作業。格式: |
app_version |
僅供輸出。用於處理對話的應用程式版本。格式: |
language_code |
僅供輸出。對話的語言代碼。 |
messages[] |
已淘汰,請改用轉彎。 |
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
對話中單一回合的所有資訊。
| 欄位 | |
|---|---|
messages[] |
選用。對話回合中的訊息清單,包括使用者輸入內容、代理回覆,以及處理期間的中繼事件。 |
root_span |
選用。動作處理的根時距。 |
user_intended_text |
選用。模擬來電者 (Polysynth) 的預期基準真相文字。只有在啟用字詞錯誤率指標時,才會填入資料。 |
ConversationLoggingSettings
用於描述應用程式對話記錄行為的設定。
| 欄位 | |
|---|---|
disable_conversation_logging |
選用。是否要停用工作階段的對話記錄功能。 |
retention_window |
選用。控制對話的保留期。如未設定,對話會保留 365 天。 |
CreateAgentRequest
AgentService.CreateAgent 的要求訊息。
| 欄位 | |
|---|---|
parent |
這是必要旗標,要建立代理的應用程式資源名稱。 |
agent_id |
選用。代理程式的 ID,會成為代理程式資源名稱的最後一個部分。如未提供,系統會自動為代理指派專屬 ID。 |
agent |
這是必要旗標,要建立的代理。 |
CreateAppRequest
AgentService.CreateApp 的要求訊息。
| 欄位 | |
|---|---|
parent |
這是必要旗標,要建立應用程式的位置資源名稱。 |
app_id |
選用。應用程式要使用的 ID,會成為應用程式資源名稱的最後一個部分。如未提供,系統會自動為應用程式指派專屬 ID。 |
app |
這是必要旗標,要建立的應用程式。 |
CreateAppVersionRequest
| 欄位 | |
|---|---|
parent |
這是必要旗標,要建立應用程式版本的應用程式資源名稱。 |
app_version_id |
選用。應用程式版本要使用的 ID,會成為應用程式版本資源名稱的最後一個元件。如未提供,系統會自動為應用程式版本指派專屬 ID。 |
app_version |
這是必要旗標,要建立的應用程式版本。 |
CreateAssistantSessionRequest
| 欄位 | |
|---|---|
parent |
這是必要旗標,要建立助理工作階段的應用程式,格式: |
assistant_session_id |
選用。要用於助理工作階段的 ID,會成為助理工作階段資源名稱的最終元件。如未提供,系統會自動為助理工作階段指派專屬 ID。 |
assistant_session_messages[] |
選用。用於啟動助理工作階段的訊息。 |
CreateDeploymentRequest
| 欄位 | |
|---|---|
parent |
這是必要旗標,上層應用程式。格式: |
deployment_id |
選用。部署作業使用的 ID,會成為部署作業資源名稱的最後一個部分。如未提供,系統會自動為部署作業指派專屬 ID。 |
deployment |
這是必要旗標,要建立的部署作業。 |
CreateEvaluationDatasetRequest
| 欄位 | |
|---|---|
parent |
這是必要旗標,要建立評估作業的應用程式。格式: |
evaluation_dataset_id |
選用。評估資料集的 ID,會成為評估資料集資源名稱的最後一個部分。如未提供,系統會自動為評估作業指派專屬 ID。 |
evaluation_dataset |
這是必要旗標,要建立的評估資料集。 |
CreateEvaluationExpectationRequest
| 欄位 | |
|---|---|
parent |
這是必要旗標,要建立評估預期結果的應用程式。格式: |
evaluation_expectation_id |
選用。評估預期使用的 ID,會成為評估預期資源名稱的最後一個部分。如未提供,系統會自動為評估預期指派專屬 ID。 |
evaluation_expectation |
這是必要旗標,要建立的評估預期。 |
CreateEvaluationRequest
| 欄位 | |
|---|---|
parent |
這是必要旗標,要建立評估作業的應用程式。格式: |
evaluation_id |
選用。評估作業的 ID,會成為評估作業資源名稱的最後一個部分。如未提供,系統會自動為評估作業指派專屬 ID。 |
evaluation |
這是必要旗標,要建立的評估作業。 |
CreateExampleRequest
AgentService.CreateExample 的要求訊息。
| 欄位 | |
|---|---|
parent |
這是必要旗標,要建立範例的應用程式資源名稱。 |
example_id |
選用。範例使用的 ID,會成為範例資源名稱的最後一個部分。如未提供,系統會自動為範例指派專屬 ID。 |
example |
這是必要旗標,要建立的範例。 |
CreateGuardrailRequest
AgentService.CreateGuardrail 的要求訊息。
| 欄位 | |
|---|---|
parent |
這是必要旗標,要建立護欄的應用程式資源名稱。 |
guardrail_id |
選用。護欄 ID,會成為護欄資源名稱的最後一個部分。如未提供,系統會自動為護欄指派專屬 ID。 |
guardrail |
這是必要旗標,要建立的護欄。 |
CreateScheduledEvaluationRunRequest
| 欄位 | |
|---|---|
parent |
這是必要旗標,要建立排定評估執行的應用程式。格式: |
scheduled_evaluation_run_id |
選用。排定評估執行作業的 ID,會成為排定評估執行作業資源名稱的最後一個部分。如未提供,系統會自動指派專屬 ID。 |
scheduled_evaluation_run |
這是必要旗標,要建立的排定評估執行作業。 |
CreateToolRequest
AgentService.CreateTool 的要求訊息。
| 欄位 | |
|---|---|
parent |
這是必要旗標,要建立工具的應用程式資源名稱。 |
tool_id |
選用。工具的 ID,會成為工具資源名稱的最後一個部分。如未提供,系統會自動為工具指派專屬 ID。 |
tool |
這是必要旗標,要建立的工具。 |
CreateToolsetRequest
AgentService.CreateToolset 的要求訊息。
| 欄位 | |
|---|---|
parent |
這是必要旗標,要建立工具集的應用程式資源名稱。 |
toolset_id |
選用。工具集要使用的 ID,會成為工具集資源名稱的最後一個部分。如未提供,系統會自動為工具集指派專屬 ID。 |
toolset |
這是必要旗標,建立工具組。 |
CustomVoiceSample
用於語音複製的自訂語音樣本設定。
| 欄位 | |
|---|---|
name |
選用。使用者定義的自訂語音樣本名稱。 |
voice_sample_gcs_uri |
選用。用於語音複製的音訊樣本 Cloud Storage URI。音訊樣本應為單聲道、24kHz 的 WAV 檔案。 |
consent_audio_gcs_uri |
選用。同意複製語音的音訊。 |
voice_instruction |
選用。語音風格、語調、語速或發音的自然語言指令。 |
preview_audio_content |
僅供輸出。自訂語音的合成試聽音訊,格式為標準 WAV (LINEAR16、24kHz、16 位元、單聲道)。 |
preview_text |
選用。用於合成 Custom Voice 預覽音訊的文字。 |
warnings[] |
僅供輸出。語音複製處理期間出現的警告訊息 (例如音訊音量過低)。 |
voice_instruction_mode |
選用。語音範例的指示模式。如未指定,預設值為 NO_INSTRUCTION。 |
VoiceInstructionMode
語音樣本的指示模式。
| 列舉 | |
|---|---|
VOICE_INSTRUCTION_MODE_UNSPECIFIED |
未指定指令模式。預設值為 NO_INSTRUCTION。 |
NO_INSTRUCTION |
不會使用語音指示。 |
GENERATE_INSTRUCTION |
AI 會根據音訊樣本自動生成語音指示。 |
CUSTOM_INSTRUCTION |
使用者提供的自訂語音指令。 |
警告
處理語音樣本時出現警告訊息。
| 欄位 | |
|---|---|
message |
僅供輸出。人類可讀的警告說明。 |
type |
僅供輸出。警告類型。 |
WarningType
處理語音樣本時遇到的警告類型。
| 列舉 | |
|---|---|
WARNING_TYPE_UNSPECIFIED |
未指定的警告類型。 |
LOW_AUDIO_LEVEL |
語音樣本的音量過低 (例如均方根振幅過低)。 |
DashboardSettings
與應用程式相關聯的資訊主頁設定,會顯示在「監控」檢視畫面中。
| 欄位 | |
|---|---|
default_dashboard |
選用。與應用程式相關聯的預設 Contact Center Insights 資訊主頁資源名稱。使用者前往應用程式的「監控」檢視畫面時,就會看到這個資訊主頁。 格式: |
DataStore
Vertex AI Search 中的 DataStore 資源。
| 欄位 | |
|---|---|
name |
這是必要旗標,DataStore 的完整資源名稱。格式: |
type |
僅供輸出。資料儲存庫的類型。這個欄位為唯讀,由伺服器填入。 |
document_processing_mode |
僅供輸出。資料儲存庫連線的文件處理模式。僅適用於 PUBLIC_WEB 和 UNSTRUCTURED 資料儲存庫。 |
display_name |
僅供輸出。資料儲存庫的顯示名稱。 |
create_time |
僅供輸出。資料儲存庫的建立時間戳記。 |
connector_config |
僅供輸出。資料儲存庫連線的連接器設定。 |
ConnectorConfig
資料儲存庫連線的連接器設定。
| 欄位 | |
|---|---|
collection |
資料儲存庫所屬集合的資源名稱。 |
collection_display_name |
資料儲存庫所屬集合的顯示名稱。 |
data_source |
資料來源名稱。例如: |
DataStoreType
資料儲存庫的類型。
| 列舉 | |
|---|---|
DATA_STORE_TYPE_UNSPECIFIED |
不指定。這個值表示未指定資料儲存庫類型,因此搜尋時不會使用。 |
PUBLIC_WEB |
含有公開網路內容的資料儲存庫。 |
UNSTRUCTURED |
包含非結構化私人資料的資料儲存庫。 |
FAQ |
包含結構化資料的資料儲存庫,用於常見問題。 |
CONNECTOR |
資料儲存庫,可做為第一方或第三方服務的連接器。 |
DocumentProcessingMode
資料儲存庫的文件處理模式。
| 列舉 | |
|---|---|
DOCUMENT_PROCESSING_MODE_UNSPECIFIED |
不指定。 |
DOCUMENTS |
文件會以文件形式處理。 |
CHUNKS |
文件會轉換為區塊。 |
DataStoreSettings
應用程式的資料儲存庫相關設定。
| 欄位 | |
|---|---|
engines[] |
僅供輸出。應用程式的引擎。 |
引擎
連結資料儲存庫的引擎。請參閱 Vertex AI Search:https://cloud.google.com/generative-ai-app-builder/docs/enterprise-search-introduction。
| 欄位 | |
|---|---|
name |
僅供輸出。引擎的資源名稱。格式: |
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 |
這是必要旗標,資料儲存庫工具名稱。 |
description |
選用。工具說明。 |
boost_specs[] |
選用。提升規格,提高特定文件的排名。 |
modality_configs[] |
選用。資料儲存庫的模態設定。 |
filter_parameter_behavior |
選用。篩選器參數行為。 |
聯集欄位 search_source。定義搜尋來源,可以是單一 DataStore 或引擎。search_source 只能是下列其中一個設定: |
|
data_store_source |
選用。在單一特定 DataStore 中搜尋。 |
engine_source |
選用。在引擎內搜尋 (可能跨多個資料儲存庫)。 |
BoostSpec
提升規格,提高特定文件的排名。
| 欄位 | |
|---|---|
condition_boost_specs[] |
這是必要旗標,增強規格清單。 |
ConditionBoostSpec
條件的增強規格。
| 欄位 | |
|---|---|
condition |
這是必要旗標,指定提升條件的運算式。語法與篩選運算式語法相同。目前唯一支援的條件是 BCP-47 語言代碼清單。範例:如要提高英文或法文建議的排名,請輸入 (lang_code: ANY("en", "fr")) |
boost |
選用。增強程度,應介於 [-1, 1] 之間。如果設為負值,即代表降低排名。預設值為 0.0。 設為 1.0 可大幅提高建議排名。不過,這並不代表經過增強的建議一定會顯示在搜尋結果頂端。 設為 -1.0 則會大幅降低建議排名。但系統仍可能顯示其他相關建議。 設為 0.0 表示不套用增強。系統會忽略提升條件。 |
boost_control_spec |
選用。根據客戶定義的屬性值,自訂排名的複雜規格。 |
BoostControlSpec
根據客戶指定屬性值自訂排名的規格。與上述簡單的 (條件、提升) 組合相比,這項功能提供更多自訂排名的控制選項。
| 欄位 | |
|---|---|
field_name |
選用。欄位名稱,系統會根據該欄位的值決定提升幅度。 |
attribute_type |
選用。用來決定提升幅度的屬性類型。屬性值可從指定 field_name 的欄位值衍生。如果是數值,則很簡單,即 attribute_value = numerical_field_value。不過,如果是新鮮度,attribute_value = (time.now() - datetime_field_value)。 |
interpolation_type |
選用。要套用的內插類型,用於連接下方列出的控制點。 |
control_points[] |
選用。用來定義曲線的控制點。單調函式 (透過上述 interpolation_type 定義) 會通過此處列出的控制點。 |
AttributeType
要套用自訂排名的屬性 (或函式)。
| 列舉 | |
|---|---|
ATTRIBUTE_TYPE_UNSPECIFIED |
未指定 AttributeType。 |
NUMERICAL |
系統會根據數值欄位的值,動態更新提升幅度。在這種情況下,控制點的 attribute_value (x 值) 會是指定 boost_amount 的數值欄位實際值。 |
FRESHNESS |
如果是時效性用途,屬性值會是目前時間與指定日期時間欄位中日期之間的時長。這個值必須採用 XSD dayTimeDuration 值的格式 (ISO 8601 時間長度值的受限子集)。模式如下:[nD][T[nH][nM][nS]]。例如:5D、3DT12H30M、T24H。 |
ControlPoint
用來定義曲線的控制點。透過這些控制點定義的曲線只能單調遞增或遞減 (可接受常數值)。
| 欄位 | |
|---|---|
attribute_value |
選用。可以是下列其中一項:1. 數值欄位值。2. 新鮮度時間長度規格:值必須採用 XSD |
boost_amount |
選用。如果 attribute_value 評估為上述指定值,則分數會提高 -1 到 1 之間的值。 |
InterpolationType
要套用的內插類型。預設為線性 (分段線性)。
| 列舉 | |
|---|---|
INTERPOLATION_TYPE_UNSPECIFIED |
未指定內插類型。在本例中,預設值為「Linear」。 |
LINEAR |
系統會套用分段線性插值。 |
BoostSpecs
增強規格,提高特定文件的排名。詳情請參閱 https://cloud.google.com/generative-ai-app-builder/docs/boosting。
| 欄位 | |
|---|---|
data_stores[] |
這是必要旗標,套用提升設定的資料儲存庫。DataStore 的完整資源名稱,例如 projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}。 |
spec[] |
這是必要旗標,增強規格清單。 |
DataStoreSource
在特定 DataStore 中搜尋的設定。
| 欄位 | |
|---|---|
filter |
選用。DataStore 的篩選器規格。請參閱:https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata |
data_store |
選用。資料儲存庫。 |
EngineSource
在引擎中搜尋的設定,可能指定特定 DataStore。
| 欄位 | |
|---|---|
engine |
這是必要旗標,引擎的完整資源名稱。格式: |
data_store_sources[] |
選用。用於指定引擎內的特定 DataStore。如果留空,搜尋範圍會套用至與引擎相關聯的所有資料儲存庫。 |
filter |
選用。套用至引擎搜尋的篩選器。如果提供「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 |
選用。根據檢索來源,答案的依據性門檻。可設定的範圍為 [1, 5]。這個級別會做為答案依據程度的門檻,也就是說,如果回覆的依據程度分數低於門檻,系統就會改為只傳回相關摘要。 舉例來說,如果等級設為 3,則基準分數必須達到 3 以上,系統才會傳回回覆。 |
disabled |
選用。是否停用基準建立功能。 |
ModalityConfig
如果指定,系統會將指定設定套用至指定模態。
| 欄位 | |
|---|---|
modality_type |
這是必要旗標,模態類型。 |
rewriter_config |
選用。重寫器設定。 |
summarization_config |
選用。摘要設定。 |
grounding_config |
選用。基準設定。 |
snippets_config |
選用。摘要設定。 |
ModalityType
模態類型。
| 列舉 | |
|---|---|
MODALITY_TYPE_UNSPECIFIED |
未指定模態類型。 |
TEXT |
文字模態。 |
AUDIO |
音訊模態。 |
RewriterConfig
重寫器設定。
| 欄位 | |
|---|---|
model_settings |
這是必要旗標,LLM 模型的設定。 |
prompt |
選用。提示詞定義。如未設定,系統會使用預設提示。 |
disabled |
選用。是否停用重寫器。 |
SnippetsConfig
摘要設定。
| 欄位 | |
|---|---|
enable_snippets |
選用。是否啟用摘要。 |
max_snippets |
選用。每項查詢傳回的摘要數量。如未設定,系統預設會傳回服務的所有程式碼片段。 |
SummarizationConfig
摘要設定。
| 欄位 | |
|---|---|
model_settings |
選用。LLM 模型的設定。 |
prompt |
選用。提示詞定義。如未設定,系統會使用預設提示。 |
disabled |
選用。是否停用摘要功能。 |
DeleteAgentRequest
AgentService.DeleteAgent 的要求訊息。
| 欄位 | |
|---|---|
name |
這是必要旗標,要刪除的代理資源名稱。 |
force |
選用。指出是否要強制刪除代理,即使其他應用程式/代理/範例仍參照該代理。
|
etag |
選用。代理目前的 etag。如未提供 etag,刪除作業會覆寫任何並行變更。如果提供的 etag 與代理程式目前的 etag 不符,系統會禁止刪除,並傳回 ABORTED 錯誤。 |
DeleteAppRequest
AgentService.DeleteApp 的要求訊息。
| 欄位 | |
|---|---|
name |
這是必要旗標,要刪除的應用程式資源名稱。 |
etag |
選用。應用程式目前的 etag。如未提供 etag,刪除作業會覆寫所有並行變更。如果提供的 etag 與應用程式目前的 etag 不符,系統會禁止刪除,並傳回 ABORTED 錯誤。 |
DeleteAppVersionRequest
| 欄位 | |
|---|---|
name |
這是必要旗標,要刪除的應用程式版本資源名稱。 |
etag |
選用。應用程式版本的目前 etag。如未提供 etag,刪除作業會覆寫任何並行變更。如果提供的 etag 與應用程式版本目前的 etag 不符,系統會禁止刪除,並傳回 ABORTED 錯誤。 |
DeleteAssistantSessionRequest
| 欄位 | |
|---|---|
name |
這是必要旗標,要刪除的助理工作階段名稱,格式: |
DeleteConversationRequest
| 欄位 | |
|---|---|
name |
這是必要旗標,要刪除的對話資源名稱。 |
source |
選用。指明對話來源。如未設定,系統預設會套用 Source.Live。 |
DeleteDeploymentRequest
| 欄位 | |
|---|---|
name |
這是必要旗標,要刪除的部署作業名稱。格式: |
etag |
選用。部署作業的 ETag。如果提供的 etag 與部署作業目前的 etag 不符,系統會禁止刪除,並傳回 ABORTED 錯誤。 |
DeleteEvaluationDatasetRequest
| 欄位 | |
|---|---|
name |
這是必要旗標,要刪除的評估資料集資源名稱。 |
etag |
選用。評估資料集的目前 ETag。如未提供 etag,刪除作業會覆寫任何並行變更。如果提供的 etag 與評估資料集目前的 etag 不符,系統會禁止刪除,並傳回 ABORTED 錯誤。 |
DeleteEvaluationExpectationRequest
| 欄位 | |
|---|---|
name |
這是必要旗標,要刪除的評估預期資源名稱。 |
etag |
選用。評估預期的目前 ETag。如未提供 etag,刪除作業會覆寫任何並行變更。如果提供的 etag 與評估預期目前的 etag 不符,系統會封鎖刪除作業,並傳回 ABORTED 錯誤。 |
DeleteEvaluationRequest
| 欄位 | |
|---|---|
name |
這是必要旗標,要刪除的評估作業資源名稱。 |
force |
選用。指出是否要強制刪除評估,即使評估資料集仍參照該評估。
|
etag |
選用。評估作業目前的 etag。如未提供 etag,刪除作業會覆寫任何並行變更。如果提供的 etag 與評估作業目前的 etag 不符,系統會禁止刪除,並傳回 ABORTED 錯誤。 |
DeleteEvaluationResultRequest
| 欄位 | |
|---|---|
name |
這是必要旗標,要刪除的評估結果資源名稱。 |
DeleteEvaluationRunOperationMetadata
這個類型沒有任何欄位。
DeleteEvaluationRunRequest
| 欄位 | |
|---|---|
name |
這是必要旗標,要刪除的評估執行作業資源名稱。 |
DeleteExampleRequest
AgentService.DeleteExample 的要求訊息。
| 欄位 | |
|---|---|
name |
這是必要旗標,要刪除的範例資源名稱。 |
etag |
選用。範例目前的 etag。如未提供 etag,刪除作業會覆寫任何並行變更。如果提供的 etag 與範例目前的 etag 不符,系統會禁止刪除,並傳回 ABORTED 錯誤。 |
DeleteGuardrailRequest
AgentService.DeleteGuardrail 的要求訊息。
| 欄位 | |
|---|---|
name |
這是必要旗標,要刪除的護欄資源名稱。 |
force |
選用。指出是否要強制刪除護欄,即使應用程式/代理仍參照該護欄。
|
etag |
選用。護欄目前的 etag。如未提供 etag,刪除作業會覆寫任何並行變更。如果提供的 etag 與護欄目前的 etag 不符,系統會禁止刪除,並傳回 ABORTED 錯誤。 |
DeleteScheduledEvaluationRunRequest
| 欄位 | |
|---|---|
name |
這是必要旗標,要刪除的排定評估執行作業資源名稱。 |
etag |
選用。ScheduledEvaluationRun 的 etag。如有提供,則必須與伺服器的 etag 相符。 |
DeleteToolRequest
AgentService.DeleteTool 的要求訊息。
| 欄位 | |
|---|---|
name |
這是必要旗標,要刪除的工具資源名稱。 |
force |
選用。指出是否要強制刪除工具,即使代理/範例仍參照該工具。
|
etag |
選用。工具目前的 ETag。如未提供 etag,刪除作業會覆寫任何並行變更。如果提供的 etag 與工具目前的 etag 不符,系統會禁止刪除,並傳回 ABORTED 錯誤。 |
DeleteToolsetRequest
AgentService.DeleteToolset 的要求訊息。
| 欄位 | |
|---|---|
name |
這是必要旗標,要刪除的工具集資源名稱。 |
force |
選用。指出是否要強制刪除工具集,即使應用程式/代理仍參照該工具集。
|
etag |
選用。工具組目前的 ETag。如未提供 etag,刪除作業會覆寫任何並行變更。如果提供的 etag 與工具集目前的 etag 不符,系統會禁止刪除,並傳回 ABORTED 錯誤。 |
DeployChannelResponse
AgentService.DeployChannel 的回應訊息。
| 欄位 | |
|---|---|
deployment |
建立的部署作業。 |
部署作業
部署作業代表應用程式的不可變、可查詢版本,用於部署具有特定管道設定檔的應用程式版本。
| 欄位 | |
|---|---|
name |
ID。部署作業的資源名稱。格式: |
display_name |
這是必要旗標,部署作業的顯示名稱。 |
app_version |
選用。要部署的應用程式版本資源名稱。格式: |
channel_profile |
這是必要旗標,部署作業使用的頻道設定檔。 |
create_time |
僅供輸出。這項部署作業的建立時間戳記。 |
update_time |
僅供輸出。上次更新這項部署作業的時間戳記。 |
etag |
僅供輸出。Etag 可確保物件在讀取-修改-寫入作業期間未變更。如果 etag 為空白,更新作業會覆寫所有並行變更。 |
experiment_config |
選用。部署作業的實驗設定。 |
whatsapp_credentials |
選用。僅供輸入。設定 WhatsApp 管道設定檔時,需要提供臨時 WhatsApp 憑證。 |
instagram_credentials |
選用。僅供輸入。設定 Instagram 管道設定檔時,需要暫時 Instagram 憑證。 |
model_settings |
選用。部署作業的模型設定。覆寫在應用程式/代理層級設定的模型設定。注意:部署層級的模型設定覆寫功能僅限許可清單中的使用者使用。如要啟用這個欄位,請與 CXAS 團隊聯絡。 |
modality |
選用。部署作業的模態。注意:部署層級模態覆寫功能僅限許可清單中的使用者使用。如要啟用這個欄位,請與 CXAS 團隊聯絡。 |
agent_registry_deployment |
選用。將這個部署項目部署至 Agent Registry 的設定。如有,這項部署作業會發布至 Agent Registry。 |
模態
部署作業的模態。
| 列舉 | |
|---|---|
MODALITY_UNSPECIFIED |
不明模態。 |
MODALITY_TEXT |
文字模態。 |
MODALITY_VOICE |
語音模態。 |
MODALITY_VIDEO |
影片模態。 |
EndSession
表示工作階段已終止,原因可能是成功完成 (例如使用者說「再見!」) 或提報給服務專員。
工作階段終止後,代理不會再處理任何輸入內容,用戶端應在收到代理的所有剩餘回應後,半關閉並中斷連線。
| 欄位 | |
|---|---|
metadata |
選用。提供工作階段結束信號的額外資訊,例如工作階段結束的原因。 |
EndUserAuthConfig
用於連線呼叫的使用者驗證設定。欄位值必須是情境變數名稱,格式為 $context.variables.<name_of_variable>。
| 欄位 | |
|---|---|
聯集欄位 auth_config。驗證設定。auth_config 只能是下列其中一個設定: |
|
oauth2_auth_code_config |
OAuth 2.0 授權碼驗證。 |
oauth2_jwt_bearer_config |
JWT 設定檔 OAuth 2.0 授權許可驗證。 |
Oauth2AuthCodeConfig
OAuth 2.0 授權碼驗證設定。
| 欄位 | |
|---|---|
oauth_token |
這是必要旗標,要傳遞的 OAuth 權杖參數名稱。格式必須為 |
Oauth2JwtBearerConfig
JWT 設定檔 OAuth 2.0 授權授予驗證設定。
| 欄位 | |
|---|---|
issuer |
這是必要旗標,要傳遞的核發者參數名稱。格式必須為 |
subject |
這是必要旗標,要傳遞的主體參數名稱。格式必須為 |
client_key |
這是必要旗標,要傳遞的用戶端參數名稱。格式必須為 |
EndpointControlPolicy
定義專案/位置層級的端點控管政策。
| 欄位 | |
|---|---|
enforcement_scope |
選用。這項政策的 allowed_origins 清單強制執行的範圍。 |
allowed_origins[] |
選用。應用程式中的工具可直接呼叫的允許 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 |
選用。錯誤處理策略。 |
fallback_response_config |
選用。處理備用回應的設定。 |
end_session_config |
選用。發生系統錯誤 (例如 LLM 錯誤) 時,結束工作階段的設定。 |
EndSessionConfig
發生系統錯誤 (例如 LLM 錯誤) 時,結束工作階段的設定。
| 欄位 | |
|---|---|
escalate_session |
選用。是否要在 |
ErrorHandlingStrategy
定義錯誤處理策略。
| 列舉 | |
|---|---|
ERROR_HANDLING_STRATEGY_UNSPECIFIED |
未指定不明錯誤處理策略。 |
NONE |
未啟用任何特定處理方式。 |
FALLBACK_RESPONSE |
如果發生系統錯誤 (例如 LLM 錯誤),系統會向使用者傳回備用訊息。 |
END_SESSION |
如果發生系統錯誤 (例如 LLM 錯誤),系統會發出 EndSession 信號。 |
FallbackResponseConfig
處理備用回應的設定。
| 欄位 | |
|---|---|
custom_fallback_messages |
選用。發生系統錯誤 (例如 LLM 錯誤) 時的備用訊息,依支援的語言代碼對應。 |
max_fallback_attempts |
選用。代理在發出 |
評估
評估作業包含模擬及評估代理所需的所有資訊。
| 欄位 | |
|---|---|
name |
ID。這項評估的專屬 ID。格式: |
display_name |
這是必要旗標,使用者定義的評估顯示名稱。在應用程式中不得重複。 |
description |
選用。使用者定義的評估說明。 |
tags[] |
選用。使用者定義的標記,用於分類評估。 |
evaluation_datasets[] |
僅供輸出。評估作業所屬的評估資料集清單。格式: |
create_time |
僅供輸出。評估作業的建立時間戳記。 |
created_by |
僅供輸出。建立評估作業的使用者。 |
update_time |
僅供輸出。上次更新評估作業的時間戳記。 |
last_updated_by |
僅供輸出。上次更新評估作業的使用者。 |
evaluation_runs[] |
僅供輸出。與這項評估作業相關聯的 EvaluationRun。 |
etag |
僅供輸出。Etag 可確保物件在讀取-修改-寫入作業期間未變更。如果 etag 為空白,更新作業會覆寫所有並行變更。 |
aggregated_metrics |
僅供輸出。這項評估在所有執行作業中的匯總指標。 |
last_completed_result |
僅供輸出。這項評估的最新評估結果。 |
invalid |
僅供輸出。評估是否無效。如果評估作業參照的工具、工具集或代理已刪除,就可能發生這種情況。 |
last_ten_results[] |
僅供輸出。這項評估作業最近 10 次的評估結果。只有在 ListEvaluationsRequest 或 GetEvaluationRequest 中將 include_last_ten_results 設為 true 時,系統才會填入這個欄位。 |
evaluation_metrics_threshold_override |
選用。覆寫這項特定評估的指標門檻。 |
evaluation_metrics_config_override |
選用。覆寫這項特定評估作業的指標設定。 |
聯集欄位 inputs。評估 inputs 的輸入內容只能是下列其中一項: |
|
golden |
選用。要評估的黃金步驟。 |
scenario |
選用。情境設定。 |
金黃
重播黃金對話所需的步驟。
| 欄位 | |
|---|---|
turns[] |
這是必要旗標,重播黃金對話所需的黃金回合。對話回合數上限為 100。 |
evaluation_expectations[] |
選用。評估重播對話時的預期結果。格式: |
GoldenExpectation
代表單一可檢查的需求條件。
| 欄位 | |
|---|---|
note |
選用。這項規定的附註,在特定檢查失敗時,可用於回報。例如:"Check_Payment_Tool_Called". |
skip_evaluation |
選用。如果設為 true,系統就不會評估這項特定預期。 |
expectation_level_metrics_thresholds_override |
選用。覆寫步驟層級的指標。 |
agent_response_semantic_similarity_metrics_config_override |
選用。覆寫 agent_response 語意相似度指標。 |
agent_response_hallucination_metrics_config_override |
選用。覆寫 agent_response 幻覺指標。 |
comparison_type |
選用。預期檢查使用的比較類型。 |
聯集欄位 condition。實際執行的檢查。condition 只能是下列其中一個設定: |
|
tool_call |
選用。確認是否使用參數呼叫特定工具。 |
tool_response |
選用。確認特定工具是否產生預期回覆。 |
agent_response |
選用。確認代理的回覆是否正確。系統會自動假設角色為「agent」。 |
agent_transfer |
選用。確認代理已將對話轉給其他代理。 |
updated_variables |
選用。確認代理已將工作階段變數更新為預期值。也用於擷取黃金評估的代理變數更新。 |
mock_tool_response |
選用。要模擬的工具回應,並指定相關參數。未指定的參數會由 LLM 幻覺生成。 |
no_tool_calls |
選用。確認這個回合未呼叫任何工具。 |
GoldenTurn
黃金回合定義了黃金對話中的單一回合。
| 欄位 | |
|---|---|
steps[] |
這是必要旗標,重播黃金對話所需的步驟。 |
root_span |
選用。處理及維護音訊資訊的黃金回合根時距。音訊的 URI 必須包含以 16Khz 取樣率儲存的音訊。 |
turn_level_metrics_thresholds_override |
選用。覆寫回合層級指標門檻。 |
hallucination_metric_behavior_override |
選用。覆寫回合層級幻覺指標行為。 |
情境
情境設定
| 欄位 | |
|---|---|
task |
這是必要旗標,情境要指定的任務。 |
user_facts[] |
選用。情境要使用的使用者事實。 |
max_turns |
選用。要模擬的回合數上限。最大值為 100。預設值為 100。 |
rubrics[] |
這是必要旗標,情境的評分標準。 |
scenario_expectations[] |
這是必要旗標,ScenarioExpectations:評估使用者模擬功能生成的對話。 |
variable_overrides |
選用。變數/工作階段參數,做為工作階段的背景資訊,以變數名稱為索引鍵。這個結構體的成員會覆寫系統設定的所有預設值。 請注意,這與使用者事實不同,後者是指使用者已知的事實。變數是代理已知的參數,例如電話系統傳遞的 MDN (電話號碼)。 |
task_completion_behavior |
選用。已淘汰,請改用 user_goal_behavior。 |
user_goal_behavior |
選用。使用者目標的預期行為。 |
evaluation_expectations[] |
選用。評估模擬對話時,所依據的評估預期。格式: |
milestones[] |
選用。這個情境的里程碑。 |
scenario_execution_mode |
選用。情境評估的執行模式。 |
Milestone
代表情境中的單一里程碑。用於引導使用者模擬器的行為,使其遵循通訊協定。使用者模擬器會依序執行里程碑,只有在達成該里程碑的 success_criteria 時,才會繼續執行下一個里程碑。
| 欄位 | |
|---|---|
goal |
這是必要旗標,里程碑的目標。 |
max_turn_count |
選用。這個里程碑的回合數上限。 |
success_criteria |
選用。里程碑的成功標準。 |
protocol |
選用。代理在對話期間應遵循的指南。 |
static_utterance |
選用。模擬器會傳送靜態語句,而非動態生成使用者輸入內容。 |
event |
選用。要傳送的事件輸入,而非動態生成。 |
TaskCompletionBehavior
使用者工作的預期行為。這項資訊可用來判斷情境是否成功。
| 列舉 | |
|---|---|
TASK_COMPLETION_BEHAVIOR_UNSPECIFIED |
未指定行為。預設為 TASK_SATISFIED。 |
TASK_SATISFIED |
使用者工作應會順利完成。 |
TASK_REJECTED |
使用者工作應遭拒。 |
UserFact
以鍵/值組合呈現的使用者相關事實。
| 欄位 | |
|---|---|
name |
這是必要旗標,使用者事實的名稱。 |
value |
這是必要旗標,使用者事實的值。 |
UserGoalBehavior
使用者目標的預期行為。這項資訊可用來判斷情境是否成功。
| 列舉 | |
|---|---|
USER_GOAL_BEHAVIOR_UNSPECIFIED |
未指定行為。預設為 USER_GOAL_SATISFIED。 |
USER_GOAL_SATISFIED |
使用者目標應能順利完成。 |
USER_GOAL_REJECTED |
應拒絕使用者目標。 |
USER_GOAL_IGNORED |
忽略使用者目標狀態。 |
ScenarioExpectation
評估模擬生成對話的預期。
| 欄位 | |
|---|---|
聯集欄位 expectation。評估模擬生成對話的預期結果。expectation 只能是下列其中一個設定: |
|
tool_expectation |
選用。要評估的工具呼叫和回覆組合。 |
agent_response |
選用。要評估的代理回覆。 |
ToolExpectation
要評估的工具呼叫和回覆組合。
| 欄位 | |
|---|---|
expected_tool_call |
這是必要旗標,預期的工具呼叫,並指定相關參數。未指定的參數會由 LLM 幻覺生成。 |
mock_tool_response |
這是必要旗標,要模擬的工具回應,並指定相關參數。未指定的參數會由 LLM 幻覺生成。 |
步驟
步驟定義了評估期間要執行的單一動作。
| 欄位 | |
|---|---|
聯集欄位 step。要執行的步驟。step 只能是下列其中一個設定: |
|
user_input |
選用。對話的使用者輸入內容。 |
agent_transfer |
選用。將對話轉接給其他服務專員。 |
expectation |
選用。在目前的回合執行預期。 |
EvaluationConfig
EvaluationConfig 會設定執行評估的設定。
| 欄位 | |
|---|---|
input_audio_config |
選用。處理輸入音訊的設定。 |
output_audio_config |
選用。生成輸出音訊的設定。 |
evaluation_channel |
選用。要評估的管道。 |
tool_call_behaviour |
選用。指定評估作業應使用實際工具呼叫,還是假工具。 |
EvaluationChannel
要評估的管道。
| 列舉 | |
|---|---|
EVALUATION_CHANNEL_UNSPECIFIED |
未指定評估管道。 |
TEXT |
純文字評估管道。 |
AUDIO |
音訊評估管道。 |
EvaluationDataset
評估資料集代表一組評估,這些評估會根據共用標記分組。
| 欄位 | |
|---|---|
name |
ID。這個評估資料集的專屬 ID。格式: |
display_name |
這是必要旗標,使用者定義的評估資料集顯示名稱。在應用程式中不得重複。 |
evaluations[] |
選用。這個資料集包含的評估。 |
create_time |
僅供輸出。評估資料集的建立時間戳記。 |
update_time |
僅供輸出。上次更新評估資料集的時間戳記。 |
etag |
僅供輸出。Etag 可確保物件在讀取-修改-寫入作業期間未變更。如果 etag 為空白,更新作業會覆寫所有並行變更。 |
created_by |
僅供輸出。建立評估資料集的使用者。 |
last_updated_by |
僅供輸出。上次更新評估資料集的使用者。 |
aggregated_metrics |
僅供輸出。這個評估資料集在所有執行作業中的匯總指標。 |
EvaluationErrorInfo
評估執行期間發生錯誤的相關資訊。
| 欄位 | |
|---|---|
error_type |
僅供輸出。錯誤類型。 |
error_message |
僅供輸出。錯誤訊息。 |
session_id |
僅供輸出。發生錯誤的對話工作階段 ID。 |
user_facing_error_message |
僅供輸出。使用者看到的錯誤訊息。 |
ErrorType
錯誤類型
| 列舉 | |
|---|---|
ERROR_TYPE_UNSPECIFIED |
不明錯誤類型。 |
RUNTIME_FAILURE |
執行階段執行失敗。 |
CONVERSATION_RETRIEVAL_FAILURE |
無法從 CES 執行階段擷取對話。 |
METRIC_CALCULATION_FAILURE |
無法計算指標/結果。 |
EVALUATION_UPDATE_FAILURE |
無法更新評估作業。 |
QUOTA_EXHAUSTED |
配額已用完。 |
USER_SIMULATION_FAILURE |
使用者模擬失敗。 |
EvaluationExpectation
評估預期代表評估依據的特定條件。
| 欄位 | |
|---|---|
name |
ID。這項評估預期的專屬 ID。格式: |
display_name |
這是必要旗標,使用者定義的顯示名稱。在應用程式中不得重複。 |
tags[] |
選用。使用者定義的預期標記。可用於篩選預期。 |
create_time |
僅供輸出。建立評估預期結果的時間戳記。 |
update_time |
僅供輸出。上次更新評估預期值的時間戳記。 |
etag |
僅供輸出。Etag 可確保物件在讀取-修改-寫入作業期間未變更。如果 etag 為空白,更新作業會覆寫所有並行變更。 |
聯集欄位 criteria。評估標準的定義。criteria 只能是下列其中一個設定: |
|
llm_criteria |
選用。依據 LLM 提示詞的評估條件。 |
LlmCriteria
LLM 評估條件的設定。
| 欄位 | |
|---|---|
prompt |
這是必要旗標,提供給 LLM 評判者的提示/指示。 |
EvaluationMetricsConfig
設定評估指標。
| 欄位 | |
|---|---|
golden_metrics_config |
選用。評估黃金指標的設定。 |
scenario_metrics_config |
選用。評估情境指標的設定。 |
ComparisonType
檢查代理回覆時支援的比較類型。
| 列舉 | |
|---|---|
COMPARISON_TYPE_UNSPECIFIED |
未指定比較類型。代理回覆和工具呼叫的預設行為是 SEMANTIC_SIMILARITY。 |
EQUALS |
完全比對字串。 |
CONTAINS |
子字串比對 (檢查實際回應是否包含預期字串)。 |
SEMANTIC_SIMILARITY |
語意相似度比對 (使用 LLM 評估語意相似度)。 |
ExpectationsMetMetricsConfig
評估作業期望層級指標的設定。如要停用指標,請設定訊息,但不要將 enable_expectations_met_metrics 欄位設為 true (或明確設為 false)。如要取消設定並改回預設行為,請完全省略訊息。
| 欄位 | |
|---|---|
enable_expectations_met_metrics |
選用。是否要計算評估的期望層級指標。 |
GoldenMetricsConfig
評估黃金指標的設定。
| 欄位 | |
|---|---|
semantic_similarity_metrics_config |
選用。語意相似度指標的全域設定。 |
tool_correctness_metrics_config |
選用。回合層級工具正確性指標的設定。 |
step_tool_correctness_metrics_config |
選用。步驟層級工具正確性指標的設定。 |
HallucinationMetricsConfig
評估幻覺指標的設定。如要停用指標,請設定訊息,但不要將 enable_hallucination_metrics 欄位設為 true (或明確設為 false)。如要取消設定並改回預設行為,請完全省略訊息。
| 欄位 | |
|---|---|
enable_hallucination_metrics |
選用。是否要計算評估作業的幻覺指標。 |
ScenarioMetricsConfig
評估情境指標的設定。
| 欄位 | |
|---|---|
user_goal_met_metrics_config |
選用。使用者目標達成指標的設定。 |
expectations_met_metrics_config |
選用。預期層級指標的設定。 |
SemanticSimilarityMetricsConfig
評估作業的相似度指標設定。如要停用指標,請設定訊息,但不要將 enable_semantic_similarity_metrics 欄位設為 true (或明確設為 false)。如要取消設定並改回預設行為,請完全省略訊息。
| 欄位 | |
|---|---|
enable_semantic_similarity_metrics |
選用。是否要計算評估作業的語意相似度指標。 |
ToolCorrectnessMetricsConfig
評估正確性指標的設定。如要停用指標,請設定訊息,但不要將 enable_tool_correctness_metrics 欄位設為 true (或明確設為 false)。如要取消設定並改回預設行為,請完全省略訊息。
| 欄位 | |
|---|---|
enable_tool_correctness_metrics |
選用。是否要計算評估作業的工具正確性指標。 |
UserGoalMetMetricsConfig
評估使用者目標達成指標的設定。如要停用指標,請設定訊息,但不要將 enable_user_goal_met_metrics 欄位設為 true (或明確設為 false)。如要取消設定並改回預設行為,請完全省略訊息。
| 欄位 | |
|---|---|
enable_user_goal_met_metrics |
選用。是否要計算評估的使用者目標達成指標。 |
EvaluationMetricsThresholds
評估指標的門檻設定。
| 欄位 | |
|---|---|
golden_evaluation_metrics_thresholds |
選用。黃金評估指標門檻。 |
hallucination_metric_behavior |
選用。已淘汰:請改用 |
golden_hallucination_metric_behavior |
選用。黃金評估的幻覺指標行為。 |
scenario_hallucination_metric_behavior |
選用。情境評估的幻覺指標行為。 |
GoldenEvaluationMetricsThresholds
黃金評估作業的設定。
| 欄位 | |
|---|---|
turn_level_metrics_thresholds |
選用。回合層級指標門檻。 |
expectation_level_metrics_thresholds |
選用。預期層級指標門檻。 |
tool_matching_settings |
選用。工具比對設定。額外工具呼叫是指執行過程中出現,但與黃金期望中的任何工具呼叫都不相符的工具呼叫。 |
ExpectationLevelMetricsThresholds
期望層級指標門檻。
| 欄位 | |
|---|---|
tool_invocation_parameter_correctness_threshold |
選用。個別工具叫用參數正確性的成功門檻。必須是介於 0 到 1 之間的浮點數。預設值為 1.0。 |
TurnLevelMetricsThresholds
轉彎層級指標門檻。
| 欄位 | |
|---|---|
semantic_similarity_channel |
選用。用於評估的語意相似度管道。 |
semantic_similarity_success_threshold |
選用。語意相似度的成功門檻。必須是介於 0 到 4 之間的整數。預設值為 >= 3。 |
overall_tool_invocation_correctness_threshold |
選用。整體工具叫用正確性的成功門檻。必須是介於 0 到 1 之間的浮點數。預設值為 1.0。 |
SemanticSimilarityChannel
要使用的語意相似度管道。
| 列舉 | |
|---|---|
SEMANTIC_SIMILARITY_CHANNEL_UNSPECIFIED |
未指定指標。預設為 TEXT。 |
TEXT |
使用文字語意相似度。 |
AUDIO |
使用音訊語意相似度。 |
HallucinationMetricBehavior
幻覺指標行為。無論行為如何,系統一律會計算指標。差別在於,停用指標後,系統就不會使用該指標計算整體評估分數。
| 列舉 | |
|---|---|
HALLUCINATION_METRIC_BEHAVIOR_UNSPECIFIED |
未指定的幻覺指標行為。 |
DISABLED |
停用幻覺指標。 |
ENABLED |
啟用幻覺指標。 |
ToolMatchingSettings
比對工具呼叫的設定。
| 欄位 | |
|---|---|
extra_tool_call_behavior |
選用。額外工具呼叫的行為。預設值為 FAIL。 |
ExtraToolCallBehavior
定義遇到額外工具呼叫時的行為。額外工具呼叫是指執行過程中出現,但與黃金期望中的任何工具呼叫都不相符的工具呼叫。
| 列舉 | |
|---|---|
EXTRA_TOOL_CALL_BEHAVIOR_UNSPECIFIED |
未指定行為。預設值為 FAIL。 |
FAIL |
如果遇到額外的工具呼叫,評估就會失敗。 |
ALLOW |
允許額外的工具呼叫。 |
EvaluationPersona
人物代表評估中的使用者。
| 欄位 | |
|---|---|
name |
這是必要旗標,角色的專屬 ID。格式: |
description |
選用。人物角色的說明。 |
display_name |
這是必要旗標,Persona 的顯示名稱。在應用程式中不得重複。 |
personality |
這是必要旗標,指示代理在評估期間應如何行動。 |
speech_config |
選用。Persona 的聲音設定 (文字轉語音設定)。 |
SpeechConfig
文字轉語音生成作業的設定。
| 欄位 | |
|---|---|
speaking_rate |
選用。說話速率。1.0 為正常值。值越低,速度越慢 (例如 0.8);值越高,速度越快 (例如 1.5)。適合用來測試代理如何處理說話速度快的使用者。 |
environment |
選用。模擬音訊環境。 |
voice_id |
選用。要使用的特定語音 ID/口音。例如:「en-US-Wavenet-D」或「en-GB-Standard-A」 |
BackgroundEnvironment
模擬音訊環境。
| 列舉 | |
|---|---|
BACKGROUND_ENVIRONMENT_UNSPECIFIED |
未指定背景環境。 |
CALL_CENTER |
客服中心環境。 |
TRAFFIC |
交通噪音環境。 |
KIDS_NOISE |
兒童噪音環境。 |
CAFE |
咖啡廳環境。 |
EvaluationResult
評估結果代表執行評估的輸出內容。
| 欄位 | |
|---|---|
name |
ID。評估結果的專屬 ID。格式: |
display_name |
這是必要旗標,評估結果的顯示名稱。評估作業中的專屬 ID。預設格式為「 |
create_time |
僅供輸出。評估結果的建立時間戳記。 |
evaluation_status |
僅供輸出。評估結果。只有在 execution_state 為 COMPLETE 時,系統才會填入這個欄位。 |
evaluation_run |
僅供輸出。產生這項結果的評估執行作業。格式: |
persona |
僅供輸出。用於生成評估結果對話的角色。 |
error_info |
僅供輸出。評估結果的錯誤資訊。 |
error |
僅供輸出。已淘汰:請改用 |
initiated_by |
僅供輸出。發起評估執行作業並產生這項結果的使用者。 |
app_version |
僅供輸出。用於生成對話並產生這項結果的應用程式版本。格式: |
app_version_display_name |
僅供輸出。評估作業所依據的 |
changelog |
僅供輸出。評估對象應用程式版本的變更記錄。如果使用者對最新版本/草稿執行評估,系統就會填入這個值。 |
changelog_create_time |
僅供輸出。評估作業所用應用程式版本的變更記錄建立時間。如果使用者對最新版本/草稿執行評估,系統就會填入這個值。 |
execution_state |
僅供輸出。評估結果執行的狀態。 |
evaluation_metrics_thresholds |
僅供輸出。結果的評估門檻。 |
config |
僅供輸出。評估執行作業中使用的設定,產生這項結果。 |
golden_run_method |
僅供輸出。執行黃金評估的方法。 |
root_span |
僅供輸出。評估執行作業的根時距,包含評估各步驟的資訊。 |
outcome_metadata |
僅供輸出。評估結果中繼資料。只有在 execution_state 為 COMPLETE 時,系統才會填入這個欄位。 |
聯集欄位 result。評估結果。只有在 execution_state 為 COMPLETED 時,系統才會填入這個欄位。result 只能是下列其中一個設定: |
|
golden_result |
僅供輸出。黃金標準評估的結果。 |
scenario_result |
僅供輸出。情境評估結果。 |
EvaluationExpectationResult
單一評估預期結果。
| 欄位 | |
|---|---|
evaluation_expectation |
僅供輸出。評估預期。格式: |
prompt |
僅供輸出。用於評估的提示。 |
outcome |
僅供輸出。評估預期結果。 |
explanation |
僅供輸出。結果說明。 |
ExecutionState
評估結果執行的狀態。
| 列舉 | |
|---|---|
EXECUTION_STATE_UNSPECIFIED |
未指定評估結果執行狀態。 |
QUEUED |
評估結果執行作業已排入佇列。 |
RUNNING |
正在執行評估結果。 |
COMPLETED |
評估結果執行作業已完成。 |
ERROR |
發生內部錯誤,因此無法執行評估結果。 |
CANCELLED |
已取消執行評估結果。 |
GoldenExpectationOutcome
指定預期結果和實際結果。
| 欄位 | |
|---|---|
expectation |
僅供輸出。受評估的預期。 |
outcome |
僅供輸出。預期結果。 |
semantic_similarity_result |
僅供輸出。語意相似度檢查結果。 |
tool_invocation_result |
僅供輸出。工具叫用檢查結果。 |
聯集欄位 result。預期結果。result 只能是下列其中一個設定: |
|
observed_tool_call |
僅供輸出。工具呼叫預期結果。 |
observed_tool_response |
僅供輸出。工具回覆預期結果。 |
observed_agent_response |
僅供輸出。代理回覆預期結果。 |
observed_agent_transfer |
僅供輸出。代理轉移預期結果。 |
observed_payload |
僅供輸出。觀察到的自訂酬載。自訂酬載沒有任何預期。這項資訊僅用於計算指標。結果一律為「已略過」。 |
ToolInvocationResult
工具叫用檢查結果。
| 欄位 | |
|---|---|
outcome |
僅供輸出。工具叫用檢查結果。系統會比較 parameter_correctness_score 和門檻,如果分數等於或高於門檻,結果就會是「通過」。否則結果會是「失敗」。 |
explanation |
僅供輸出。工具叫用結果的文字說明。 |
parameter_correctness_score |
僅供輸出。工具叫用參數正確性分數。這項指標代表預期工具呼叫的參數中,實際工具呼叫也包含的參數百分比。 |
GoldenResult
黃金標準評估結果。
| 欄位 | |
|---|---|
turn_replay_results[] |
僅供輸出。執行黃金對話各回合的結果。 |
evaluation_expectation_results[] |
僅供輸出。評估預期結果。 |
TurnReplayResult
執行單輪黃金對話的結果。
| 欄位 | |
|---|---|
conversation |
僅供輸出。為這個回合生成的對話。 |
expectation_outcome[] |
僅供輸出。每項預期的結果。 |
hallucination_result |
僅供輸出。幻覺檢查結果。 |
tool_invocation_score |
僅供輸出。已淘汰,請改用 OverallToolInvocationResult。 |
turn_latency |
僅供輸出。轉彎所需時間。 |
tool_call_latencies[] |
僅供輸出。該輪對話中各項工具呼叫的延遲時間。 |
semantic_similarity_result |
僅供輸出。語意相似度檢查結果。 |
overall_tool_invocation_result |
僅供輸出。整體工具叫用檢查的結果。 |
error_info |
僅供輸出。這輪對話期間發生的錯誤資訊。 |
span_latencies[] |
僅供輸出。該輪對話中 span 的延遲時間。 |
tool_ordered_invocation_score |
僅供輸出。這個回合的整體工具排序叫用分數。這代表預期回合中,實際叫用工具的整體百分比,且叫用順序符合預期。 |
HallucinationResult
單一回合的幻覺檢查結果。
| 欄位 | |
|---|---|
label |
僅供輸出。與各分數相關聯的標籤。分數 1:合理;分數 0:不合理;分數 -1:沒有可評估的聲明 |
explanation |
僅供輸出。幻覺分數的說明。 |
score |
僅供輸出。幻覺分數。可以是 -1、0、1。 |
結果
評估或預期的結果。
| 列舉 | |
|---|---|
OUTCOME_UNSPECIFIED |
未指定評估結果。 |
PASS |
評估/預期通過。在評估時,這表示所有期望都已達成。 |
FAIL |
評估/預期失敗。在評估作業中,這表示至少有一項預期未達成。 |
SKIPPED |
已略過評估/預期。 |
OutcomeMetadata
評估結果的中繼資料。
| 列舉 | |
|---|---|
OUTCOME_METADATA_UNSPECIFIED |
未指定結果中繼資料。 |
GRACEFUL_HANDOFF |
評估結果是順利轉接給真人代表。 |
OverallToolInvocationResult
整體工具叫用檢查的結果。
| 欄位 | |
|---|---|
outcome |
僅供輸出。工具叫用檢查結果。系統會比較 tool_invocation_score 和 overall_tool_invocation_correctness_threshold,如果分數等於或高於門檻,結果就會是「通過」。否則結果會是「失敗」。 |
tool_invocation_score |
這個回合的整體工具叫用分數。這表示實際叫用的工具占預期回合工具總數的百分比。 |
ScenarioExpectationOutcome
情境預期的結果。
| 欄位 | |
|---|---|
expectation |
僅供輸出。受評估的預期。 |
outcome |
僅供輸出。ScenarioExpectation 的結果。 |
聯集欄位 result。預期結果。result 只能是下列其中一個設定: |
|
observed_tool_call |
僅供輸出。觀察到的工具呼叫。 |
observed_agent_response |
僅供輸出。觀察到的代理回覆。 |
ObservedToolCall
觀察到的工具呼叫和回應。
| 欄位 | |
|---|---|
tool_call |
僅供輸出。觀察到的工具呼叫。 |
tool_response |
僅供輸出。觀察到的工具回應。 |
ScenarioResult
情境評估結果。
| 欄位 | |
|---|---|
conversation |
僅供輸出。情境中生成的對話。 |
task |
僅供輸出。執行情境以取得這項結果時,所使用的任務。 |
user_facts[] |
僅供輸出。情境用於這項結果的使用者事實。 |
expectation_outcomes[] |
僅供輸出。每項預期的結果。 |
rubric_outcomes[] |
僅供輸出。評分量表的結果。 |
hallucination_result[] |
僅供輸出。幻覺檢查結果。對話中的每個回合都會有一個幻覺結果。 |
task_completion_result |
僅供輸出。工作完成檢查的結果。 |
tool_call_latencies[] |
僅供輸出。對話中每次執行工具呼叫的延遲時間。 |
user_goal_satisfaction_result |
僅供輸出。使用者目標滿意度檢查結果。 |
span_latencies[] |
僅供輸出。對話中 span 的延遲時間。 |
evaluation_expectation_results[] |
僅供輸出。評估預期結果。 |
milestone_results[] |
僅供輸出。情境中每個里程碑的結果。 |
all_expectations_satisfied |
僅供輸出。這輪對話是否符合所有預期。 |
task_completed |
僅供輸出。這回合是否完成工作。這項指標綜合了所有期望是否達成、是否出現幻覺,以及使用者目標是否達成。 |
MilestoneResult
代表里程碑執行作業的結果。
| 欄位 | |
|---|---|
milestone |
僅供輸出。要追蹤的里程碑。 |
status |
僅供輸出。里程碑的目前狀態。 |
justification |
僅供輸出。目前狀態的理由。 |
MilestoneStatus
里程碑的狀態。
| 列舉 | |
|---|---|
MILESTONE_STATUS_UNSPECIFIED |
未指定狀態。 |
NOT_STARTED |
里程碑尚未開始。 |
IN_PROGRESS |
里程碑目前正在進行中。 |
COMPLETED |
已順利完成里程碑。 |
ScenarioRubricOutcome
依據評分量表評估的結果。
| 欄位 | |
|---|---|
rubric |
僅供輸出。用於評估對話的評分標準。 |
score_explanation |
僅供輸出。評分者對評分量表的回覆。 |
score |
僅供輸出。對話依據評分量表獲得的分數。 |
SemanticSimilarityResult
語意相似度檢查結果。
| 欄位 | |
|---|---|
label |
僅供輸出。與各分數相關聯的標籤。4 分:完全一致 3 分:大致一致 2 分:部分一致 (有輕微遺漏) 1 分:大致不一致 (有重大遺漏) 0 分:完全不一致/矛盾 |
explanation |
僅供輸出。語意相似度分數的說明。 |
outcome |
僅供輸出。語意相似度檢查結果。系統會比較分數和 semantic_similarity_success_threshold,如果分數等於或高於門檻,結果就會是「通過」。否則結果會是「失敗」。 |
score |
僅供輸出。語意相似度分數。可以是 0、1、2、3 或 4。 |
SpanLatency
Span 執行作業的延遲時間。
| 欄位 | |
|---|---|
type |
僅供輸出。Span 類型。 |
display_name |
僅供輸出。Span 的顯示名稱。適用於工具和護欄 Span。 |
start_time |
僅供輸出。Span 的開始時間。 |
end_time |
僅供輸出。Span 的結束時間。 |
execution_latency |
僅供輸出。Span 的延遲時間。 |
聯集欄位 identifier。特定項目的 ID (依類型而定)。identifier 只能是下列其中一個設定: |
|
resource |
僅供輸出。護欄或工具 span 的資源名稱。 |
toolset |
僅供輸出。工具組工具 ID。 |
model |
僅供輸出。LLM 跨度的名稱。 |
callback |
僅供輸出。使用者回呼 Span 的名稱。 |
類型
Span 類型。日後可能會新增其他值。
| 列舉 | |
|---|---|
TYPE_UNSPECIFIED |
預設值。這個值不會用到。 |
TOOL |
工具呼叫 span。 |
USER_CALLBACK |
使用者回呼 span。 |
GUARDRAIL |
防護機制時間範圍。 |
LLM |
LLM 範圍。 |
TaskCompletionResult
對話的工作完成檢查結果。
| 欄位 | |
|---|---|
label |
僅供輸出。與各分數相關聯的標籤。1 分:完成工作;0 分:未完成工作;-1 分:未定義使用者目標 |
explanation |
僅供輸出。任務完成分數的說明。 |
score |
僅供輸出。工作完成分數。可以是 -1、0、1 |
ToolCallLatency
工具呼叫執行作業的延遲時間。
| 欄位 | |
|---|---|
tool |
僅供輸出。已執行的工具名稱。格式: |
display_name |
僅供輸出。工具的顯示名稱。 |
start_time |
僅供輸出。工具呼叫執行的開始時間。 |
end_time |
僅供輸出。工具呼叫執行的結束時間。 |
execution_latency |
僅供輸出。工具呼叫執行作業的延遲時間。 |
UserGoalSatisfactionResult
對話的使用者目標達成度檢查結果。
| 欄位 | |
|---|---|
label |
僅供輸出。與各分數相關聯的標籤。分數 2:順利交接;分數 1:使用者任務已完成;分數 0:使用者任務未完成;分數 -1:使用者任務未指定 |
explanation |
僅供輸出。使用者任務滿意度分數的說明。 |
score |
僅供輸出。使用者工作滿意度分數。可以是 -1、0、1、2。 |
EvaluationRun
評估執行作業代表評估執行作業的所有評估結果。
| 欄位 | |
|---|---|
name |
ID。評估執行的專屬 ID。格式: |
display_name |
選用。使用者定義的評估執行作業顯示名稱。預設值:「 |
evaluation_results[] |
僅供輸出。這項執行作業中的評估結果。格式: |
create_time |
僅供輸出。評估作業的建立時間戳記。 |
initiated_by |
僅供輸出。發起評估作業的使用者。 |
app_version |
僅供輸出。要評估的應用程式版本。格式: |
app_version_display_name |
僅供輸出。評估作業所依據的 |
changelog |
僅供輸出。評估對象應用程式版本的變更記錄。如果使用者對最新版本/草稿執行評估,系統就會填入這個值。 |
changelog_create_time |
僅供輸出。評估作業所用應用程式版本的變更記錄建立時間。如果使用者對最新版本/草稿執行評估,系統就會填入這個值。 |
evaluations[] |
僅供輸出。這項執行作業中的評估。清單可能包含任一類型的評估。這個欄位與 |
evaluation_dataset |
僅供輸出。與這項執行作業相關聯的評估資料集。這個欄位與 |
evaluation_type |
僅供輸出。這項執行作業的評估類型。 |
state |
僅供輸出。評估執行作業的狀態。 |
progress |
僅供輸出。評估執行作業的進度。 |
config |
僅供輸出。執行作業使用的設定。 |
error |
僅供輸出。已淘汰:請改用 error_info。執行期間發生錯誤。 |
error_info |
僅供輸出。評估執行的錯誤資訊。 |
evaluation_run_summaries |
僅供輸出。評估名稱與 EvaluationRunSummary 的對應關係。 |
latency_report |
僅供輸出。評估執行的延遲時間報表。 |
run_count |
僅供輸出。執行作業中評估作業的執行次數。 |
persona_run_configs[] |
僅供輸出。每個角色執行時要使用的設定。 |
optimization_config |
選用。設定在評估執行後執行最佳化步驟。如未設定,系統就不會執行最佳化步驟。 |
scheduled_evaluation_run |
僅供輸出。建立這項評估執行作業的排定評估執行作業資源名稱。只有在評估執行作業是由排定的評估執行作業建立時,系統才會設定這個欄位。格式: |
golden_run_method |
僅供輸出。執行評估的方法。 |
operation |
僅供輸出。建立這項評估執行的作業。格式: |
EvaluationRunState
評估執行作業的狀態。
| 列舉 | |
|---|---|
EVALUATION_RUN_STATE_UNSPECIFIED |
未指定評估執行作業狀態。 |
QUEUED |
表示評估執行作業已排入佇列。 |
RUNNING |
正在執行評估作業。 |
COMPLETED |
評估作業已執行完畢。 |
ERROR |
評估作業發生錯誤。 |
CANCELLED |
評估作業已取消。 |
EvaluationRunSummary
包含評估作業中特定評估的通過和失敗結果計數摘要。
| 欄位 | |
|---|---|
passed_count |
僅供輸出。這項執行作業中,相關評估通過的結果數量。 |
failed_count |
僅供輸出。這項執行作業中,相關評估的失敗結果數量。 |
error_count |
僅供輸出。這項執行作業中,相關聯評估作業的錯誤結果數量。 |
EvaluationType
這項執行作業的評估類型。日後可能會新增其他值。
| 列舉 | |
|---|---|
EVALUATION_TYPE_UNSPECIFIED |
未指定評估類型。 |
GOLDEN |
黃金標準評估。 |
SCENARIO |
情境評估。 |
MIXED |
表示執行作業包含黃金評估和情境評估。 |
進度
評估執行作業的進度。
| 欄位 | |
|---|---|
total_count |
僅供輸出。這項執行作業的評估結果總數。 |
failed_count |
僅供輸出。評估結果為「失敗」的已完成評估數量。(EvaluationResult.execution_state 為 COMPLETED,且 EvaluationResult.evaluation_status 為 FAIL)。 |
error_count |
僅供輸出。無法執行的評估結果數量。(EvaluationResult.execution_state 為 ERROR)。 |
completed_count |
僅供輸出。成功完成的評估結果數量。(EvaluationResult.execution_state 為 COMPLETED)。 |
passed_count |
僅供輸出。結果為「通過」的已完成評估數量。(EvaluationResult.execution_state 為 COMPLETED,且 EvaluationResult.evaluation_status 為 PASS)。 |
cancelled_count |
僅供輸出。已取消的評估結果數量。(EvaluationResult.execution_state 為 CANCELLED)。 |
EvaluationRunCachingSettings
評估執行快取的設定。
| 欄位 | |
|---|---|
run_caching_mode |
選用。評估執行作業要使用的快取模式。如未設定,預設為 FORCE_RUN。 |
EvaluationRunCachingMode
評估結果快取行為。控制是否要傳回上次完成的評估結果 (如有),或執行新的評估。
| 列舉 | |
|---|---|
EVALUATION_RUN_CACHING_MODE_UNSPECIFIED |
未指定執行快取模式。 |
FORCE_RUN |
無論是否有變更記錄,一律執行完整的即時模擬。 |
SKIP_IF_UNCHANGED |
如果沒有任何依附元件發生變化,且評估管道/執行方法相同,則略過執行並複製先前的驗證結果。 |
EvaluationSettings
評估設定。
| 欄位 | |
|---|---|
scenario_conversation_initiator |
選用。在情境評估中,誰會先發起對話。 |
golden_run_method |
選用。執行黃金評估的預設方法。如果 RunEvaluationRequest 中未指定 golden_run_method,就會使用這個方法。 |
golden_evaluation_tool_call_behaviour |
選用。設定黃金評估的預設工具呼叫行為。 |
scenario_evaluation_tool_call_behaviour |
選用。設定情境評估的預設工具呼叫行為。 |
metrics_config |
選用。設定評估作業的預設指標。 |
scenario_execution_mode |
選用。情境評估的執行模式。如未提供,則預設為 QUALITY_OPTIMIZED。 |
evaluation_run_caching_settings |
選用。評估執行作業要使用的快取設定。 |
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 |
這是必要旗標,事件名稱。 |
variables |
選用。與事件相關聯的其他變數。 |
範例
範例代表使用者與代理之間的對話樣本。
| 欄位 | |
|---|---|
name |
ID。範例的專屬 ID。格式: |
display_name |
這是必要旗標,範例的顯示名稱。 |
description |
選用。人類可讀的範例說明。 |
entry_agent |
選用。一開始處理對話的代理。如未指定,範例代表由根代理處理的對話。格式: |
messages[] |
選用。構成對話的訊息集合。 |
create_time |
僅供輸出。範例建立時間的時間戳記。 |
update_time |
僅供輸出。上次更新範例的時間戳記。 |
invalid |
僅供輸出。如果刪除參照資源,範例可能會失效。無效的範例不會做為少量樣本。 |
etag |
Etag 可確保物件在讀取-修改-寫入作業期間未變更。如果 etag 為空白,更新作業會覆寫所有並行變更。 |
ExecuteToolRequest
ToolService.ExecuteTool 的要求訊息。
| 欄位 | |
|---|---|
parent |
這是必要旗標,工具/工具集所屬應用程式的資源名稱。格式: |
args |
選用。工具的輸入參數和值,採用 JSON 物件格式。 |
mock_config |
選用。工具執行的模擬設定。如果設定這個欄位,系統會根據提供的模式和回覆,模擬呼叫其他工具的工具。 |
聯集欄位 tool_identifier。要執行的工具 ID。可以是永久工具或工具集中的工具。tool_identifier 只能是下列其中一個設定: |
|
tool |
選用。要執行的工具名稱。格式:projects/{project}/locations/{location}/apps/{app}/tools/{tool} |
toolset_tool |
選用。要執行的工具組工具。工具集中只有一項工具應符合述詞。否則會傳回錯誤。 |
聯集欄位 tool_execution_context。執行工具時提供的額外背景資訊 tool_execution_context 只能是下列其中一項: |
|
variables |
選用。可用於執行工具的變數。 |
context |
選用。要傳遞至 Python 工具的 [ToolCallContext](詳情請參閱 https://docs.cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool/python#environment)。 |
ExecuteToolResponse
ToolService.ExecuteTool 的回應訊息。
| 欄位 | |
|---|---|
response |
JSON 物件格式的工具執行結果。請使用「output」鍵指定工具回覆,並使用「error」鍵指定錯誤詳細資料 (如有)。如未指定「output」和「error」鍵,整個「response」都會視為工具執行結果。 |
variables |
工具執行結束時的變數值。 |
citations |
提供工具執行來源資訊的引用內容。 |
google_search_suggestions |
在工具執行期間叫用 Google 搜尋工具,Google 搜尋傳回的建議。 |
聯集欄位 tool_identifier。已執行工具的 ID。tool_identifier 只能是下列其中一個設定: |
|
tool |
已執行的工具名稱。格式: |
toolset_tool |
已執行的工具組工具。 |
ExecutionType
工具或工具集的執行類型。
| 列舉 | |
|---|---|
EXECUTION_TYPE_UNSPECIFIED |
未指定執行類型。如未指定,預設值為 SYNCHRONOUS。 |
SYNCHRONOUS |
工具會同步執行。工作階段會遭到封鎖,直到工具傳回結果為止。 |
ASYNCHRONOUS |
工具會以非同步方式執行。工具執行期間,工作階段會繼續進行。 |
ExperimentConfig
部署作業的實驗。
| 欄位 | |
|---|---|
version_release |
選用。實驗版本。 |
狀態
實驗狀態。
| 列舉 | |
|---|---|
STATE_UNSPECIFIED |
未指定狀態。 |
PENDING |
已淘汰:不再使用這個狀態。 |
RUNNING |
執行狀態。實驗正在執行且有效。 |
DONE |
已淘汰:不再使用這個狀態。 |
EXPIRED |
已淘汰:不再使用這個狀態。 |
VersionRelease
實驗版本。
| 欄位 | |
|---|---|
state |
選用。版本發布狀態。 |
traffic_allocations[] |
選用。版本發布的流量分配。 |
TrafficAllocation
版本發布的流量分配。
| 欄位 | |
|---|---|
id |
選用。流量分配的 ID。自由格式字串,最多 128 個字元。 |
traffic_percentage |
選用。流量分配的流量百分比。必須介於 0 至 100 之間。 |
app_version |
選用。流量分配的應用程式版本。格式: |
ExportAppRequest
AgentService.ExportApp 的要求訊息。
| 欄位 | |
|---|---|
name |
這是必要旗標,要匯出的應用程式資源名稱。 |
export_format |
這是必要旗標,匯出應用程式時使用的格式。 |
gcs_uri |
選用。要匯出應用程式的 Google Cloud Storage URI。這個 URI 的格式必須是 |
app_version |
選用。要匯出的應用程式版本資源名稱。格式: |
ExportFormat
應用程式的匯出格式。
| 列舉 | |
|---|---|
EXPORT_FORMAT_UNSPECIFIED |
未指定匯出格式。 |
JSON |
匯出格式為 JSON。 |
YAML |
匯出格式為 YAML。 |
ExportAppResponse
AgentService.ExportApp 的回應訊息。
| 欄位 | |
|---|---|
聯集欄位 app。匯出的應用程式。app 只能是下列其中一個設定: |
|
app_content |
壓縮成 ZIP 檔案的應用程式資料夾。 |
app_uri |
應用程式匯出至的 Google Cloud Storage URI。 |
ExportEvaluationResultsOperationMetadata
這個類型沒有任何欄位。
ExportEvaluationResultsRequest
| 欄位 | |
|---|---|
parent |
這是必要旗標,要匯出評估結果的評估資源名稱。格式: |
names[] |
這是必要旗標,要匯出的評估結果資源名稱。 |
export_options |
選用。評估結果的匯出選項。 |
ExportEvaluationResultsResponse
| 欄位 | |
|---|---|
聯集欄位 evaluation_results。匯出的評估結果。evaluation_results 只能是下列其中一個設定: |
|
evaluation_results_content |
匯出的評估結果內容。如果要求中未指定 gcs_uri,系統就會填入這個欄位。 |
evaluation_results_uri |
寫入匯出評估結果的 Google Cloud Storage URI 資料夾。如果要求中指定了 gcs_uri,系統就會填入這個欄位。 |
ExportEvaluationRunsOperationMetadata
這個類型沒有任何欄位。
ExportEvaluationRunsRequest
| 欄位 | |
|---|---|
parent |
這是必要旗標,要匯出評估執行的應用程式資源名稱。格式: |
names[] |
這是必要旗標,要匯出的評估執行作業資源名稱。 |
export_options |
選用。評估執行的匯出選項。 |
ExportEvaluationRunsResponse
| 欄位 | |
|---|---|
聯集欄位 evaluation_runs。匯出的評估執行作業。evaluation_runs 只能是下列其中一個設定: |
|
evaluation_runs_content |
匯出的評估執行作業內容。如果要求中未指定 gcs_uri,系統就會填入這個欄位。 |
evaluation_runs_uri |
寫入匯出評估執行的 Google Cloud Storage URI 資料夾。如果要求中指定了 gcs_uri,系統就會填入這個欄位。 |
ExportEvaluationsRequest
| 欄位 | |
|---|---|
parent |
這是必要旗標,要匯出評估結果的應用程式資源名稱。格式: |
names[] |
這是必要旗標,要匯出的評估作業資源名稱。 |
export_options |
選用。評估作業的匯出選項。 |
include_evaluation_results |
選用。在匯出作業中納入評估結果。必須至少設定 include_evaluation_results 或 include_evaluations 其中一項。 |
include_evaluations |
選用。匯出內容包含評估結果。必須至少設定 include_evaluation_results 或 include_evaluations 其中一項。 |
ExportEvaluationsResponse
| 欄位 | |
|---|---|
failed_evaluations |
僅供輸出。無法匯出的評估資源名稱對應表,以及失敗原因。 |
聯集欄位 evaluations。匯出的評估作業。evaluations 只能是下列其中一個設定: |
|
evaluations_content |
匯出的評估內容。如果要求中未指定 gcs_uri,系統就會填入這個欄位。 |
evaluations_uri |
寫入匯出評估作業的 Google Cloud Storage URI 資料夾。如果要求中指定了 gcs_uri,系統就會填入這個欄位。 |
ExportOptions
匯出 CES 評估資源的選項。
| 欄位 | |
|---|---|
export_format |
選用。評估結果的匯出格式。如未指定,則預設為 JSON。 |
gcs_uri |
選用。要寫入匯出評估結果的 Google Cloud Storage URI。 |
ExportFormat
匯出項目的格式。如未指定,則預設為 JSON。
| 列舉 | |
|---|---|
EXPORT_FORMAT_UNSPECIFIED |
未指定格式。 |
JSON |
YAML 或 JSON 格式 |
YAML |
YAML 格式。 |
ExpressionCondition
根據工作階段狀態設定的運算式條件。
| 欄位 | |
|---|---|
expression |
這是必要旗標,cloud.api.Expression 條件的字串表示法。 |
FileContext
要用做脈絡資訊的檔案。檔案可以原始位元組的形式提供。
| 欄位 | |
|---|---|
聯集欄位 file。檔案已做為背景資訊提供。file 只能是下列其中一個設定: |
|
file_bytes |
選用。以原始位元組形式提供的檔案。 |
FileBytes
以原始位元組形式提供的檔案。
| 欄位 | |
|---|---|
file_name |
這是必要旗標,以原始位元組提供的檔案名稱。 |
mime_type |
這是必要旗標,來源資料的 IANA 標準 MIME 類型。 |
data |
這是必要旗標,檔案的原始位元組。 |
FileSearchTool
檔案搜尋工具可讓代理搜尋應用程式/代理開發人員上傳的檔案。這項工具提供預設設定,可對上傳的檔案進行相對優質的搜尋,並摘要擷取的結果。
| 欄位 | |
|---|---|
corpus_type |
選用。語料庫的類型。預設值為 FULLY_MANAGED。 |
name |
這是必要旗標,工具名稱。 |
description |
選用。工具說明。 |
file_corpus |
選用。儲存檔案的語料庫。格式:projects/{project}/locations/{location}/ragCorpora/{rag_corpus} |
CorpusType
Vertex RAG 語料庫的類型。
| 列舉 | |
|---|---|
CORPUS_TYPE_UNSPECIFIED |
未指定語料庫類型。 |
USER_OWNED |
Corpus 由使用者建立及擁有。 |
FULLY_MANAGED |
語料庫是由代理建立。 |
GenerateAppResourceOperationMetadata
AgentService.GenerateAppResource 的作業中繼資料。
| 欄位 | |
|---|---|
generation_type |
僅供輸出。作業類型。 |
message |
僅供輸出。作業的人類可讀狀態 (如有)。 |
create_time |
僅供輸出。作業的建立時間。 |
end_time |
僅供輸出。作業執行完成的時間。 |
target |
僅供輸出。與作業相關聯的應用程式資源名稱。格式: |
partial_errors[] |
僅供輸出。資源生成程序中的錯誤訊息。 |
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
| 欄位 | |
|---|---|
parent |
這是必要旗標,要產生資源的應用程式資源名稱。 |
refine_instructions[] |
選用。用於修正資源的修正指令清單。 |
tool_generation_config |
選用。用於生成工具的設定。 |
app_generation_config |
選用。用於生成代理和工具的設定。 |
evaluation_generation_config |
選用。用於生成評估結果的設定。 |
evaluation_personas_generation_config |
選用。用於生成評估角色的設定。 |
quality_report_generation_config |
選用。用於生成品質報表的設定。 |
hill_climbing_fix_config |
選用。用於爬坡修正的設定。 |
聯集欄位 resource。要生成的資源。resource 只能是下列其中一個設定: |
|
agent |
LLM 助理要使用的代理資源,可留空來生成新代理。 |
tool |
LLM 助理要使用的工具資源,可留空來生成新工具。 |
toolset |
LLM 助理要使用的工具組資源,可留空來生成新的工具組。 |
app_version_context |
應用程式版本背景資訊,指定基本快照和目標代理。 |
AppGenerationConfig
用於生成應用程式的設定。
| 欄位 | |
|---|---|
context |
選用。說明要生成的代理和工具需求。 |
file_contexts[] |
選用。要用做脈絡資訊的檔案。 |
dataset_id |
選用。用於擷取對話資料,以生成代理和工具的洞察資料集。格式: |
generate_evaluations |
選用。是否要為應用程式生成評估。如果設為 true,系統會使用提供的背景資訊生成評估資料。 |
gcs_location |
選用。Cloud Storage 位置,用於儲存 Datastore 工具要使用的生成問答資料。只有在使用對話資料做為輸入來源時,系統才會產生這項資料。位置必須與應用程式位於相同專案。格式: |
AppVersionContext
應用程式版本背景資訊,指定基本快照和目標代理。
| 欄位 | |
|---|---|
app_version |
LLM 助理要使用的應用程式版本資源名稱。格式: |
agent_resource_name |
LLM 助理要使用的目標代理資源名稱。格式: |
EvaluationGenerationConfig
用於生成評估結果的設定。
| 欄位 | |
|---|---|
dataset_id |
選用。用於擷取對話資料,以生成評估結果的洞察資料集。格式: |
EvaluationPersonasGenerationConfig
這個類型沒有任何欄位。
用於生成評估角色的設定。
HillClimbingFixConfig
用於爬坡修正的設定。
| 欄位 | |
|---|---|
quality_report |
這是必要旗標,品質報表,用於說明指令遵循修正。 |
QualityReportGenerationConfig
用於生成品質報表的設定。
| 欄位 | |
|---|---|
evaluation_run |
這是必要旗標,用於提供品質報表分析資訊的評估執行作業。 |
algorithm |
選用。要使用的損失歸因演算法。 |
LossAttributionAlgorithm
用於損失歸因的演算法。
| 列舉 | |
|---|---|
LOSS_ATTRIBUTION_ALGORITHM_UNSPECIFIED |
未指定。 |
APP_CENTRIC |
以應用程式為主的損失歸因。將應用程式視為單一單元。 |
AGENT_CENTRIC |
以代理為中心的損失歸因。將損失歸因於個別代理。 |
RefineInstructions
用於修正部分資源的操作說明。您可以使用起始索引、結束索引和欄位遮罩指定資源部分。舉例來說,如要修正部分代理指令,可以指定指令第一個字元的索引、指令最後一個字元的索引,以及欄位遮罩「instructions」。
| 欄位 | |
|---|---|
start_index |
這是必要旗標,要修正的文字第一個字元 (含)。 |
end_index |
這是必要旗標,要修正的文字最後一個字元 (含)。 |
field_mask |
這是必要旗標,要精確調整的資源欄位。每個 RefineInstructions 只能有一個欄位。如要修正代理指令,欄位遮罩應為「instructions」。 |
instructions |
這是必要旗標,修正資源的指示。 |
ToolGenerationConfig
用於生成工具的設定。
| 欄位 | |
|---|---|
context |
選用。說明要生成的工具。如果已提供工具要求和回覆,則可留空。 |
file_contexts[] |
選用。要用做脈絡資訊的檔案。 |
open_api_toolset_generation_config |
選用。用於生成 Open API 架構的設定。 |
OpenApiToolsetGenerationConfig
用於產生 Open API 架構的設定。
| 欄位 | |
|---|---|
uri |
這是必要旗標,工具的基本 URI。 |
operation_generation_configs[] |
這是必要旗標,要新增至 Open API 架構的作業清單。 |
OperationGenerationConfig
用於在 Open API 架構中產生作業的設定。
| 欄位 | |
|---|---|
method |
這是必要旗標,工具的 URI。這應包含查詢和路徑參數 (如有)。 |
path |
這是必要旗標,要附加至基本 URI 的工具路徑。這應包含查詢和路徑參數 (如有)。 |
request_json |
這是必要旗標,JSON 格式的工具要求範例。如果工具不支援要求主體,請略過。 |
response_json |
這是必要旗標,工具的回覆範例 (JSON 格式)。 |
GenerateAppResourceResponse
| 欄位 | |
|---|---|
generate_result_info |
生成結果的其他資訊。 |
聯集欄位 generated_resource。生成的資源。generated_resource 只能是下列其中一個設定: |
|
agent |
由 LLM 助理生成的代理。 |
toolset |
LLM 助理生成的工具組。支援 Open API 工具組結構定義生成。 |
app_snapshot |
LLM 助理生成的應用程式數據匯報。這個快照包含 LLM 助理生成的應用程式、代理和工具。 |
tools |
LLM 助理生成的工具清單。 |
evaluations |
LLM 助理生成的評估結果。 |
app_resources |
LLM 助理生成的應用程式資源。 |
quality_report |
LLM 助理生成的品質報告。 |
AppResources
LLM 助理生成的應用程式資源清單。
| 欄位 | |
|---|---|
app_snapshot |
LLM 助理生成的應用程式快照。這個快照包含 LLM 助理生成的應用程式、代理和工具。 |
evaluations[] |
LLM 助理生成的評估清單。 |
評估結果
LLM 助理生成的評估清單。
| 欄位 | |
|---|---|
evaluations[] |
生成的評估清單。 |
GenerateResultInfo
這項功能可提供生成結果的額外資訊。
| 欄位 | |
|---|---|
explanation |
說明生成資源的變更。 |
工具
LLM 助理生成的工具清單。
| 欄位 | |
|---|---|
tools[] |
LLM 助理生成的工具清單。 |
GenerateChatTokenRequest
| 欄位 | |
|---|---|
name |
這是必要旗標,要生成即時通訊權杖的工作階段名稱。格式:projects/{project}/locations/{location}/apps/{app}/sessions/{session} |
deployment |
這是必要旗標,要用於工作階段的應用程式部署作業。格式:projects/{project}/locations/{location}/apps/{app}/deployments/{deployment} |
recaptcha_token |
選用。用戶端 Chat 小工具產生的 reCAPTCHA 權杖。 |
live_handoff_enabled |
選用。指出是否為工作階段啟用即時轉接功能。 |
GenerateChatTokenResponse
| 欄位 | |
|---|---|
chat_token |
聊天小工具的工作階段範圍權杖,用於向 Session API 驗證。 |
expire_time |
即時通訊權杖的到期時間。 |
GenerateEvaluationOperationMetadata
這個類型沒有任何欄位。
EvaluationService.GenerateEvaluation 的作業中繼資料。
GenerateEvaluationRequest
| 欄位 | |
|---|---|
conversation |
這是必要旗標,要建立黃金評估的對話。格式: |
source |
選用。指明對話來源。如未設定,系統會搜尋所有來源。 |
evaluation_type |
選用。要生成的評估類型。如未指定,預設為 GOLDEN。 |
EvaluationType
要生成的評估類型。
| 列舉 | |
|---|---|
EVALUATION_TYPE_UNSPECIFIED |
未指定類型,預設為 GOLDEN。 |
GOLDEN |
黃金標準評估。 |
SCENARIO |
情境評估。 |
GenerateOnboardingSuggestionsRequest
| 欄位 | |
|---|---|
name |
這是必要旗標,要顯示零狀態的應用程式。格式: |
max_suggestions |
選用。要傳回的建議數量上限。如未設定,預設值為 4。 |
GenerateOnboardingSuggestionsResponse
| 欄位 | |
|---|---|
user_profile |
提出要求的使用者記錄分類。 |
suggestions[] |
個人化建議,最相關的會排在最前面。 |
context_token |
不透明權杖,用於擷取產生這些建議時使用的新手上路快照。用戶端會在第一個 |
UserProfile
要求存取權的使用者與這個應用程式中助理的互動記錄分類。
| 列舉 | |
|---|---|
USER_PROFILE_UNSPECIFIED |
未指定設定檔。 |
NEW |
沒有包含訊息的 Google 助理工作階段。 |
EXPLORING |
一或兩個含有訊息的助理工作階段。 |
RETURNING |
超過兩個含有訊息的助理工作階段。 |
GetAgentRequest
AgentService.GetAgent 的要求訊息。
| 欄位 | |
|---|---|
name |
這是必要旗標,要擷取的代理資源名稱。 |
GetAppRequest
AgentService.GetApp 的要求訊息。
| 欄位 | |
|---|---|
name |
這是必要旗標,要擷取的應用程式資源名稱。 |
GetAppVersionRequest
AgentService.GetAppVersion 的要求訊息。
| 欄位 | |
|---|---|
name |
這是必要旗標,要擷取的應用程式版本資源名稱。 |
GetAssistantSessionRequest
| 欄位 | |
|---|---|
name |
這是必要旗標,要擷取的助理工作階段名稱,格式: |
GetChangelogRequest
AgentService.GetChangelog 的要求訊息。
| 欄位 | |
|---|---|
name |
這是必要旗標,要擷取的變更記錄資源名稱。 |
GetConversationRequest
AgentService.GetConversation 的要求訊息。
| 欄位 | |
|---|---|
name |
這是必要旗標,要擷取的對話資源名稱。 |
source |
選用。指明對話來源。如未設定,系統會搜尋所有來源。 |
GetDeploymentRequest
AgentService.GetDeployment 的要求訊息。
| 欄位 | |
|---|---|
name |
這是必要旗標,部署作業的名稱。格式: |
GetEvaluationDatasetRequest
| 欄位 | |
|---|---|
name |
這是必要旗標,要擷取的評估資料集資源名稱。 |
GetEvaluationExpectationRequest
| 欄位 | |
|---|---|
name |
這是必要旗標,要擷取的評估預期資源名稱。 |
GetEvaluationRequest
| 欄位 | |
|---|---|
name |
這是必要旗標,要擷取的評估作業資源名稱。 |
GetEvaluationResultRequest
| 欄位 | |
|---|---|
name |
這是必要旗標,要擷取的評估結果資源名稱。 |
GetEvaluationRunRequest
| 欄位 | |
|---|---|
name |
這是必要旗標,要擷取的評估執行作業資源名稱。 |
GetExampleRequest
AgentService.GetExample 的要求訊息。
| 欄位 | |
|---|---|
name |
這是必要旗標,要擷取的範例資源名稱。 |
GetGuardrailRequest
AgentService.GetGuardrail 的要求訊息。
| 欄位 | |
|---|---|
name |
這是必要旗標,要擷取的護欄資源名稱。 |
GetScheduledEvaluationRunRequest
| 欄位 | |
|---|---|
name |
這是必要旗標,要擷取的排定評估執行作業資源名稱。 |
GetSecuritySettingsRequest
| 欄位 | |
|---|---|
name |
這是必要旗標,要擷取的安全性設定資源名稱。格式: |
GetToolRequest
AgentService.GetTool 的要求訊息。
| 欄位 | |
|---|---|
name |
這是必要旗標,要擷取的工具資源名稱。 |
GetToolsetRequest
AgentService.GetToolset 的要求訊息。
| 欄位 | |
|---|---|
name |
這是必要旗標,要擷取的工具集資源名稱。 |
GoAway
這個類型沒有任何欄位。
表示伺服器即將中斷連線,用戶端應半關閉並重新啟動連線。
GoogleSearchSuggestions
Google Search Tool的搜尋建議。
| 欄位 | |
|---|---|
htmls[] |
符合規定的搜尋建議 HTML 和 CSS 樣式。提供的 HTML 和 CSS 會自動配合裝置設定,以 |
web_search_queries[] |
用於執行 Google 搜尋的查詢清單,以及構成搜尋建議的搜尋結果 URI。 |
GoogleSearchTool
代表用於執行 Google 網頁搜尋以建立基準的工具。詳情請參閱 https://cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool#google-search。
| 欄位 | |
|---|---|
name |
這是必要旗標,工具名稱。 |
description |
選用。工具用途說明。 |
context_urls[] |
選用。系統會直接從這些網址擷取內容,做為背景資訊和基準。例如:「https://example.com/path.html」。最多只能輸入 20 個網址。 |
preferred_domains[] |
選用。指定要限制搜尋結果的網域。例如:「example.com」、「another.site」。最多可以指定 20 個網域。 |
exclude_domains[] |
選用。要從搜尋結果中排除的網域清單。例如:「example.com」。最多可排除 2,000 個網域。 |
prompt_config |
選用。傳送給規劃器的提示指令,說明如何處理文字和語音的搜尋結果。 |
PromptConfig
模型處理或摘要 Google 搜尋結果時,使用的提示設定。
| 欄位 | |
|---|---|
text_prompt |
選用。定義在即時通訊對話中與代理互動時,系統指令使用的提示詞。如未設定,系統會使用預設提示。 |
voice_prompt |
選用。定義與代理進行語音對話時,系統指令使用的提示詞。如未設定,系統會使用預設提示。 |
護欄
護欄包含一系列檢查和平衡機制,可確保代理安全無虞。
| 欄位 | |
|---|---|
name |
ID。護欄的專屬 ID。格式: |
display_name |
這是必要旗標,護欄的顯示名稱。 |
description |
選用。護欄說明。 |
enabled |
選用。是否啟用護欄。 |
action |
選用。觸發護欄時要採取的動作。 |
create_time |
僅供輸出。護欄的建立時間戳記。 |
update_time |
僅供輸出。上次更新護欄的時間戳記。 |
etag |
Etag 可確保物件在讀取-修改-寫入作業期間未變更。如果 etag 為空白,更新作業會覆寫所有並行變更。 |
聯集欄位 guardrail_type。護欄類型。guardrail_type 只能是下列其中一個設定: |
|
content_filter |
選用。禁止在對話中使用特定內容的護欄。 |
llm_prompt_security |
選用。如果提示詞根據 LLM 分類被視為不安全,護欄會封鎖對話。 |
llm_policy |
選用。如果 LLM 回覆經 LLM 分類後判定違反政策,護欄就會封鎖對話。 |
model_safety |
選用。如果根據模型安全設定,LLM 回覆不安全,護欄就會封鎖對話。 |
code_callback |
選用。根據回呼執行結果,可能封鎖對話的護欄。 |
supervisor |
選用。執行監督者介入的防護機制。 |
CodeCallback
根據提供的程式碼回呼,封鎖對話的護欄。
| 欄位 | |
|---|---|
before_agent_callback |
選用。在呼叫代理前執行的回呼。每個回呼函式都應傳回至少包含下列項目的結構 (例如 dict 或物件):-「decision」:值為「OK」或「TRIGGER」。- 'reason':說明決策的字串。「TRIGGER」判定可能會停止進一步處理。 |
after_agent_callback |
選用。呼叫代理後要執行的回呼。每個回呼函式都應傳回至少包含下列項目的結構 (例如 dict 或物件):-「decision」:值為「OK」或「TRIGGER」。- 'reason':說明決策的字串。「TRIGGER」判定可能會停止進一步處理。 |
before_model_callback |
選用。在呼叫模型前執行的回呼。如果多次呼叫模型,回呼就會執行多次。每個回呼函式都應傳回至少包含下列項目的結構 (例如 dict 或物件):-「decision」:值為「OK」或「TRIGGER」。- 'reason':說明決策的字串。「TRIGGER」判定可能會停止進一步處理。 |
after_model_callback |
選用。呼叫模型後要執行的回呼。如果多次呼叫模型,回呼就會執行多次。每個回呼函式都應傳回至少包含下列項目的結構 (例如 dict 或物件):-「decision」:值為「OK」或「TRIGGER」。- 'reason':說明決策的字串。「TRIGGER」判定可能會停止進一步處理。 |
ContentFilter
禁止在對話中使用特定內容的護欄。
| 欄位 | |
|---|---|
banned_contents[] |
選用。禁用詞組清單。適用於使用者輸入內容和代理回覆。 |
banned_contents_in_user_input[] |
選用。禁用詞組清單。僅適用於使用者輸入內容。 |
banned_contents_in_agent_response[] |
選用。禁用詞組清單。僅適用於代理回覆。 |
match_type |
這是必要旗標,內容篩選器的比對類型。 |
disregard_diacritics |
選用。如果設為 true,比對時會忽略變音符號。 |
sensitive_words_exemptions[] |
選用。這項護欄允許的敏感字詞清單項目。只有在 match_type 為 SENSITIVE_WORDS 時才有效。每個值都必須與清單項目相同 (不區分大小寫,系統會忽略前後的空白字元),其他值則不會生效。僅適用於這個護欄。最多 1,000 個項目,每個項目最多 256 個字元。 |
MatchType
內容篩選器的比對類型。
| 列舉 | |
|---|---|
MATCH_TYPE_UNSPECIFIED |
未指定比對類型。 |
SIMPLE_STRING_MATCH |
系統會逐字元比對子字串。 |
WORD_BOUNDARY_STRING_MATCH |
只有在文字中找到的模式前後有字詞分隔符號時,內容才會相符。禁用詞組也可以包含字詞分隔符。 |
REGEXP_MATCH |
系統會使用規則運算式語法比對內容。 |
SENSITIVE_WORDS |
系統會比對內容與敏感字詞和詞組清單,如果將採用這種比對類型的護欄附加至應用程式或代理,受影響代理的預設敏感字詞篩選器會遭到取代。如要停用預設篩選器,請停用護欄。 |
LlmPolicy
如果 LLM 回覆經 LLM 分類判定為違反政策,護欄就會封鎖對話。
| 欄位 | |
|---|---|
max_conversation_messages |
選用。檢查這項政策時,請考量對話中最後「n」則訊息。如未設定,系統會使用預設值 10。 |
model_settings |
選用。模型設定。 |
prompt |
這是必要旗標,政策提示詞。支援工作階段變數預留位置 ( |
policy_scope |
這是必要旗標,定義在對話期間套用政策檢查的時機。如果設為 |
fail_open |
選用。如果政策檢查期間發生錯誤,則失敗時仍開放,且不觸發護欄。 |
allow_short_utterance |
選用。根據預設,系統會略過短語句的 LLM 政策檢查。啟用這項設定後,系統會對所有語句進行政策檢查,包括通常會略過的語句。 |
PolicyScope
定義在對話期間套用政策檢查的時機。
| 列舉 | |
|---|---|
POLICY_SCOPE_UNSPECIFIED |
未指定政策範圍。 |
USER_QUERY |
使用者輸入內容時,系統會觸發政策檢查。 |
AGENT_RESPONSE |
代理回覆時會觸發政策檢查。套用這項政策範圍後,代理回覆前會出現額外延遲。 |
USER_QUERY_AND_AGENT_RESPONSE |
使用者輸入內容和代理回覆都會觸發政策檢查。套用這項政策範圍後,代理回覆前會出現額外延遲。 |
LlmPromptSecurity
如果 LLM 分類結果判定輸入內容不安全,這項護欄會封鎖對話。
| 欄位 | |
|---|---|
fail_open |
選用。決定護欄遇到 LLM 錯誤時的行為。- 如果為 true:略過護欄。- 如果為 false (預設值):護欄會觸發/封鎖。 注意:如果提供自訂政策,系統會忽略這個欄位,改用政策的「fail_open」設定。 |
聯集欄位 security_config。定義安全性設定模式。使用者必須選擇下列其中一種設定。security_config 只能是下列其中一個設定: |
|
default_settings |
選用。使用系統預先定義的預設安全性設定。如要選取這個模式,請在要求中加入空白的「default_settings」訊息。伺服器會在回應中填入「default_prompt_template」欄位。 |
custom_policy |
選用。使用使用者定義的 LlmPolicy 設定安全防護機制。 |
DefaultSecuritySettings
預設系統安全性設定。
| 欄位 | |
|---|---|
default_prompt_template |
僅供輸出。系統使用的預設提示詞範本。這個欄位僅供顯示,讓使用者瞭解系統預設使用的提示詞。此為 OUTPUT_ONLY。 |
ModelSafety
模型安全性設定覆寫。設定後,系統會覆寫預設設定,並在回覆不安全時觸發護欄。
| 欄位 | |
|---|---|
safety_settings[] |
這是必要旗標,安全性設定清單。 |
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 |
這是必要旗標,危害類別。 |
threshold |
這是必要旗標,有害內容封鎖門檻。 |
主管
執行監督者介入的防護機制。
| 欄位 | |
|---|---|
type |
選用。監督者類型。 |
detection_mode |
選用。監督者的偵測模式。 |
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 |
這是必要旗標,來源資料的 IANA 標準 MIME 類型。支援的圖片類型包括:* image/png * image/jpeg * image/webp |
data |
這是必要旗標,圖片的原始位元組。 |
alt_text |
選用。圖片的替代文字。 |
ImportAppRequest
AgentService.ImportApp 的要求訊息。
| 欄位 | |
|---|---|
parent |
這是必要旗標,父項資源名稱,包含要匯入的應用程式位置。 |
display_name |
選用。要匯入的應用程式顯示名稱。* 如果應用程式是在匯入時建立,且已指定顯示名稱,則匯入的應用程式會使用這個顯示名稱。如果與現有應用程式發生衝突,系統會在顯示名稱後方加上時間戳記,確保名稱不重複。* 如果應用程式是重新匯入,則不應設定這個欄位。如果在重新匯入時提供顯示名稱,會導致 INVALID_ARGUMENT 錯誤。 |
app_id |
選用。匯入應用程式時要使用的 ID。* 如未指定,系統會自動為應用程式指派專屬 ID。* 否則,匯入的應用程式會使用這個 ID 做為資源名稱的最後一個元件。如果專案中指定位置已有相同 ID 的應用程式,系統會替換現有應用程式的內容。 |
import_options |
選用。控管應用程式匯入程序的選項。 |
ignore_app_lock |
選用。在匯入期間覆寫應用程式鎖定的標記。如果設為 True,匯入程序會忽略應用程式鎖定。 |
聯集欄位 app。要匯入的應用程式。app 只能是下列其中一個設定: |
|
gcs_uri |
要從中匯入應用程式的 Google Cloud Storage URI。這個 URI 的格式必須是 |
app_content |
原始位元組,代表含有應用程式資料夾結構的壓縮 ZIP 檔案。 |
聯集欄位 json_patch。要套用至匯入應用程式的 JSON 修補程式。json_patch 只能是下列其中一項: |
|
json_patch_content |
選用。修補內容 (JSON 字串)。 |
json_patch_gcs_uri |
選用。Cloud Storage URI,指向含有修補程式的 JSON 檔案。 |
ImportOptions
應用程式匯入程序的設定選項。這些選項可控制匯入行為,尤其是在與現有應用程式資料發生衝突時。
| 欄位 | |
|---|---|
conflict_resolution_strategy |
選用。匯入期間解決衝突時要採取的策略。 |
validate_only |
選用。用於模擬測試匯入程序的旗標。如果設為 true,匯入程序只會執行驗證,不會對現有應用程式進行任何變更,也不會建立新的應用程式。 |
ConflictResolutionStrategy
定義衝突處理策略,適用於已有相同 ID 的應用程式,或匯入的資源 (例如代理、工具等) 與該應用程式中的現有資源顯示名稱相同。
| 列舉 | |
|---|---|
CONFLICT_RESOLUTION_STRATEGY_UNSPECIFIED |
未指定衝突解決策略。 |
REPLACE |
以匯入的資料取代現有資料。如果已有相同 app_id 的應用程式,系統會根據匯入的應用程式更新內容。- 匯入的應用程式中,如果資源 (應用程式、代理、工具、範例、護欄、工具集) 的顯示名稱與現有資源相同,則會覆寫現有資源。- 系統會建立具有新顯示名稱的匯入資源。- 如果現有資源在匯入的應用程式中沒有相符的顯示名稱,則會保持不變。 |
OVERWRITE |
以匯入的資料覆寫現有資料。如果已有相同 app_id 的應用程式,系統會以匯入的應用程式覆寫其內容。- 應用程式中的現有資源 (代理、工具、範例、護欄、工具集) 將遭到刪除。- 匯入的資源會建立為新資源。 |
ImportAppResponse
AgentService.ImportApp 的回應訊息。
| 欄位 | |
|---|---|
name |
匯入應用程式的資源名稱。 |
warnings[] |
匯入程序中產生的警告訊息。如果特定資源發生錯誤,系統就不會將這些資源納入匯入的應用程式,並會在這裡說明錯誤。 |
ImportEvaluationsOperationMetadata
代表 EvaluationService.ImportEvaluations 長時間執行的作業中繼資料。
| 欄位 | |
|---|---|
create_time |
僅供輸出。作業的建立時間。 |
end_time |
僅供輸出。作業執行完成的時間。 |
status_message |
僅供輸出。作業的人類可讀狀態 (如有)。 |
ImportEvaluationsRequest
| 欄位 | |
|---|---|
parent |
這是必要旗標,要匯入評估資料的應用程式。格式: |
import_options |
選用。控管評估匯入程序的選項。 |
聯集欄位 source。要匯入的評估來源。source 只能是下列其中一個設定: |
|
conversation_list |
要從哪些對話匯入評估結果。 |
gcs_uri |
要從哪個 Google Cloud Storage URI 匯入評估資料。這個 URI 的格式必須是 |
csv_content |
原始位元組,代表具有評估結構的 CSV 檔案。 |
ConversationList
對話資源名稱清單。
| 欄位 | |
|---|---|
conversations[] |
選用。對話資源名稱。 |
ImportOptions
評估匯入程序的設定選項。這些選項可控管匯入行為,尤其是與現有評估資料發生衝突時。
| 欄位 | |
|---|---|
conflict_resolution_strategy |
選用。匯入期間解決衝突時要採取的策略。 |
ConflictResolutionStrategy
定義衝突處理策略,用於應用程式中已有相同評估 ID 的評估。
| 列舉 | |
|---|---|
CONFLICT_RESOLUTION_STRATEGY_UNSPECIFIED |
未指定衝突解決策略。 |
OVERWRITE |
以新評估覆寫現有評估。 |
SKIP |
保留現有評估作業,並略過新評估作業。 |
DUPLICATE |
保留現有評估,並將新評估複製為新評估。 |
ImportEvaluationsResponse
| 欄位 | |
|---|---|
evaluations[] |
匯入應用程式的評估清單。 |
evaluation_results[] |
匯入應用程式的評估結果清單。 |
evaluation_runs[] |
匯入應用程式的評估執行作業清單。 |
error_messages[] |
選用。與匯入失敗的評估相關聯的錯誤訊息清單。 |
import_failure_count |
完全無法匯入或匯入完成但發生一或多項錯誤的評估數量。 |
evaluation_result_import_failure_count |
完全無法匯入或匯入完成但發生一或多項錯誤的評估結果數量。 |
evaluation_run_import_failure_count |
完全無法匯入或完成匯入但發生一或多項錯誤的評估執行作業數量。 |
InputAudioConfig
InputAudioConfig 會設定 CES 代理應如何解讀傳入的音訊資料。
| 欄位 | |
|---|---|
audio_encoding |
這是必要旗標,輸入音訊資料的編碼。 |
sample_rate_hertz |
這是必要旗標,輸入音訊資料的取樣率 (赫茲)。 |
noise_suppression_level |
選用。是否要對輸入音訊啟用雜訊抑制功能。可用值為「low」、「moderate」、「high」、「very_high」。 |
InstagramCredentials
Instagram 原生整合的暫時性 Meta 憑證。
| 欄位 | |
|---|---|
auth_code |
這是必要旗標,嵌入式註冊流程提供的 Meta 授權碼。 |
conversation_profile_id |
選用。部署作業要使用的對話設定檔 ID。 |
InterruptionSignal
表示代理的音訊回覆已中斷。用戶端應立即停止播放目前的音訊 (例如使用者插話或生成新的代理回覆)。
| 欄位 | |
|---|---|
barge_in |
中斷是否由使用者插話事件造成。 |
LanguageSettings
應用程式的語言設定。
| 欄位 | |
|---|---|
default_language_code |
選用。應用程式的預設語言代碼。 |
supported_language_codes[] |
選用。除了 |
enable_multilingual_support |
選用。啟用多語言支援。如果 |
fallback_action |
選用。已淘汰:我們不再支援這項功能。請改用 可以是預先定義的動作或自訂工具呼叫。有效值包括:- 工具的完整資源名稱,會觸發特定工具執行。- 預先定義的系統動作,例如「提報」或「退出」,會觸發 |
LatencyReport
評估執行的延遲時間報表。
| 欄位 | |
|---|---|
tool_latencies[] |
僅供輸出。未排序的清單。各項工具的延遲指標。 |
callback_latencies[] |
僅供輸出。未排序的清單。每個回呼的延遲時間指標。 |
guardrail_latencies[] |
僅供輸出。未排序的清單。各護欄的延遲指標。 |
llm_call_latencies[] |
僅供輸出。未排序的清單。每次 LLM 呼叫的延遲時間指標。 |
session_count |
僅供輸出。延遲時間報表考量的工作階段總數。 |
CallbackLatency
單次回呼的延遲時間指標。
| 欄位 | |
|---|---|
stage |
僅供輸出。回呼的階段。 |
latency_metrics |
僅供輸出。回呼的延遲時間指標。 |
GuardrailLatency
單一護欄的延遲時間指標。
| 欄位 | |
|---|---|
guardrail |
僅供輸出。護欄名稱。格式: |
guardrail_display_name |
僅供輸出。護欄的顯示名稱。 |
latency_metrics |
僅供輸出。護欄的延遲時間指標。 |
LatencyMetrics
元件的延遲時間指標。
| 欄位 | |
|---|---|
p50_latency |
僅供輸出。第 50 個百分位數的延遲時間。 |
p90_latency |
僅供輸出。第 90 個百分位數的延遲時間。 |
p99_latency |
僅供輸出。第 99 個百分位數的延遲時間。 |
call_count |
僅供輸出。資源的呼叫次數。 |
LlmCallLatency
單一 LLM 呼叫的延遲時間指標。
| 欄位 | |
|---|---|
model |
僅供輸出。模型名稱。 |
latency_metrics |
僅供輸出。LLM 呼叫的延遲時間指標。 |
ToolLatency
單一工具的延遲時間指標。
| 欄位 | |
|---|---|
tool_display_name |
僅供輸出。工具的顯示名稱。 |
latency_metrics |
僅供輸出。工具的延遲時間指標。 |
聯集欄位 tool_identifier。工具的 ID。tool_identifier 只能是下列其中一個設定: |
|
tool |
僅供輸出。格式: |
toolset_tool |
僅供輸出。工具組工具 ID。 |
ListAgentsRequest
AgentService.ListAgents 的要求訊息。
| 欄位 | |
|---|---|
parent |
這是必要旗標,要列出代理的應用程式資源名稱。 |
page_size |
選用。要求的頁面大小。伺服器傳回的項目數量可能少於要求數量。如未指定,伺服器會選擇適當的預設值。 |
page_token |
選用。先前清單 |
filter |
選用。列出代理時要套用的篩選器。詳情請參閱 https://google.aip.dev/160。 |
order_by |
選用。排序依據欄位。僅支援「name」和「create_time」。詳情請參閱 https://google.aip.dev/132#ordering。 |
ListAgentsResponse
AgentService.ListAgents 的回應訊息。
| 欄位 | |
|---|---|
agents[] |
代理清單。 |
next_page_token |
可做為 |
ListAppVersionsRequest
AgentService.ListAppVersions 的要求訊息。
| 欄位 | |
|---|---|
parent |
這是必要旗標,要列出應用程式版本的應用程式資源名稱。 |
page_size |
選用。要求的頁面大小。伺服器傳回的項目數量可能少於要求數量。如未指定,伺服器會選擇適當的預設值。 |
page_token |
選用。先前清單 |
filter |
選用。列出應用程式版本時要套用的篩選器。詳情請參閱 https://google.aip.dev/160。 |
order_by |
選用。排序依據欄位。僅支援「name」和「create_time」。詳情請參閱 https://google.aip.dev/132#ordering。 |
ListAppVersionsResponse
AgentService.ListAppVersions 的回應訊息。
| 欄位 | |
|---|---|
app_versions[] |
應用程式版本清單。 |
next_page_token |
可做為 |
ListAppsRequest
AgentService.ListApps 的要求訊息。
| 欄位 | |
|---|---|
parent |
這是必要旗標,要列出應用程式的位置資源名稱。 |
page_size |
選用。要求的頁面大小。伺服器傳回的項目數量可能少於要求數量。如未指定,伺服器會選擇適當的預設值。 |
page_token |
選用。先前清單 |
filter |
選用。列出應用程式時要套用的篩選器。詳情請參閱 https://google.aip.dev/160。 |
order_by |
選用。排序依據欄位。僅支援「name」和「create_time」。詳情請參閱 https://google.aip.dev/132#ordering。 |
ListAppsResponse
AgentService.ListApps 的回應訊息。
| 欄位 | |
|---|---|
apps[] |
應用程式清單。 |
next_page_token |
可做為 |
unreachable[] |
未排序的清單。無法連線的位置。 |
ListAssistantSessionsRequest
| 欄位 | |
|---|---|
parent |
這是必要旗標,要列出助理工作階段的應用程式。格式: |
page_size |
選用。要求的頁面大小。伺服器傳回的項目數量可能少於要求數量。如未指定,伺服器會選擇適當的預設值。 |
page_token |
選用。先前清單 |
filter |
選用。列出助理工作階段時要套用的篩選器。詳情請參閱 https://google.aip.dev/160。 |
ListAssistantSessionsResponse
| 欄位 | |
|---|---|
assistant_sessions[] |
助理工作階段清單。 |
next_page_token |
選用。可做為 |
ListChangelogsRequest
AgentService.ListChangelogs 的要求訊息。
| 欄位 | |
|---|---|
parent |
這是必要旗標,要列出變更記錄的應用程式資源名稱。 |
page_size |
選用。要求的頁面大小。伺服器傳回的項目數量可能少於要求數量。如未指定,伺服器會選擇適當的預設值。 |
page_token |
選用。先前清單 |
filter |
選用。列出變更記錄時要套用的篩選器。詳情請參閱 https://google.aip.dev/160。 篩選器字串可用於依 範例:* |
order_by |
選用。排序依據欄位。僅支援「name」和「create_time」。詳情請參閱 https://google.aip.dev/132#ordering。 |
ListChangelogsResponse
AgentService.ListChangelogs 的回應訊息。
| 欄位 | |
|---|---|
changelogs[] |
變更記錄清單。 |
next_page_token |
可做為 |
ListConversationsRequest
| 欄位 | |
|---|---|
parent |
這是必要旗標,要列出對話的應用程式資源名稱。 |
page_size |
選用。要求的頁面大小。伺服器傳回的項目數量可能少於要求數量。如未指定,伺服器會選擇適當的預設值。 |
page_token |
選用。先前清單 |
filter |
選用。列出對話時要套用的篩選器。詳情請參閱 https://google.aip.dev/160。 |
source |
選用。指明對話來源。如未設定,系統預設會套用 Source.Live。即將淘汰,改用 |
sources[] |
選用。指明對話來源。如未設定,系統預設會套用所有可用來源。 |
ListConversationsResponse
| 欄位 | |
|---|---|
conversations[] |
對話清單。 |
next_page_token |
可做為 |
ListDeploymentsRequest
AgentService.ListDeployments 的要求訊息。
| 欄位 | |
|---|---|
parent |
這是必要旗標,上層應用程式。格式: |
page_size |
選用。要傳回的部署項目數量上限。服務傳回的產品數量可能會少於這個值。如未指定,最多會傳回 50 個部署作業。許可的最大值為 1000;超出的數值將一律指定為 1000。 |
page_token |
選用。從前一個 進行分頁時,提供至 |
order_by |
選用。排序依據欄位。僅支援「name」和「create_time」。詳情請參閱 https://google.aip.dev/132#ordering。 |
ListDeploymentsResponse
AgentService.ListDeployments 的回應訊息。
| 欄位 | |
|---|---|
deployments[] |
部署作業清單。 |
next_page_token |
可做為 |
ListEvaluationDatasetsRequest
| 欄位 | |
|---|---|
parent |
這是必要旗標,應用程式的資源名稱,用於列出評估資料集。 |
page_size |
選用。要求的頁面大小。伺服器傳回的項目數量可能少於要求數量。如未指定,伺服器會選擇適當的預設值。 |
page_token |
選用。先前清單 |
filter |
選用。列出評估資料集時要套用的篩選器。詳情請參閱 https://google.aip.dev/160。 |
order_by |
選用。排序依據欄位。僅支援「name」、「create_time」和「update_time」。時間欄位會依遞減順序排列,名稱欄位則依遞增順序排列。如未加入,則預設為「update_time」。詳情請參閱 https://google.aip.dev/132#ordering。 |
ListEvaluationDatasetsResponse
| 欄位 | |
|---|---|
evaluation_datasets[] |
評估資料集清單。 |
next_page_token |
可做為 |
ListEvaluationExpectationsRequest
| 欄位 | |
|---|---|
parent |
這是必要旗標,應用程式的資源名稱,用於列出評估預期。 |
page_size |
選用。要求的頁面大小。伺服器傳回的項目數量可能少於要求數量。如未指定,伺服器會選擇適當的預設值。 |
page_token |
選用。先前清單 |
filter |
選用。列出評估預期時要套用的篩選器。詳情請參閱 https://google.aip.dev/160。 |
order_by |
選用。排序依據欄位。僅支援「name」、「create_time」和「update_time」。時間欄位會依遞減順序排列,名稱欄位則依遞增順序排列。如未加入,則預設為「update_time」。詳情請參閱 https://google.aip.dev/132#ordering。 |
ListEvaluationExpectationsResponse
| 欄位 | |
|---|---|
evaluation_expectations[] |
評估預期結果清單。 |
next_page_token |
可做為 |
ListEvaluationResultsRequest
| 欄位 | |
|---|---|
parent |
這是必要旗標,評估作業的資源名稱,用於列出評估結果。如要依評估執行作業篩選,請使用 |
page_size |
選用。要求的頁面大小。伺服器傳回的項目數量可能少於要求數量。如未指定,伺服器會選擇適當的預設值。 |
page_token |
選用。先前清單 |
filter |
選用。列出評估結果時要套用的篩選器。詳情請參閱 https://google.aip.dev/160。 |
order_by |
選用。排序依據欄位。僅支援「name」、「create_time」和「update_time」。時間欄位會依遞減順序排列,名稱欄位則依遞增順序排列。如未加入,則預設為「update_time」。詳情請參閱 https://google.aip.dev/132#ordering。 |
ListEvaluationResultsResponse
| 欄位 | |
|---|---|
evaluation_results[] |
評估結果清單。 |
next_page_token |
可做為 |
ListEvaluationRunsRequest
| 欄位 | |
|---|---|
parent |
這是必要旗標,應用程式的資源名稱,用於列出評估執行作業。 |
page_size |
選用。要求的頁面大小。伺服器傳回的項目數量可能少於要求數量。如未指定,伺服器會選擇適當的預設值。 |
page_token |
選用。先前清單 |
filter |
選用。列出評估執行作業時要套用的篩選器。詳情請參閱 https://google.aip.dev/160。 |
order_by |
選用。排序依據欄位。僅支援「name」、「create_time」和「update_time」。時間欄位會依遞減順序排列,名稱欄位則依遞增順序排列。如未加入,則預設為「update_time」。詳情請參閱 https://google.aip.dev/132#ordering。 |
ListEvaluationRunsResponse
| 欄位 | |
|---|---|
evaluation_runs[] |
評估執行作業清單。 |
next_page_token |
可做為 |
ListEvaluationsRequest
| 欄位 | |
|---|---|
parent |
這是必要旗標,要列出評估結果的應用程式資源名稱。 |
page_size |
選用。要求的頁面大小。伺服器傳回的項目數量可能少於要求數量。如未指定,伺服器會選擇適當的預設值。 |
page_token |
選用。先前清單 |
filter |
選用。已淘汰:請改用 evaluation_filter 和 evaluation_run_filter。 |
evaluation_filter |
選用。列出評估時,要套用至評估的篩選器。詳情請參閱 https://google.aip.dev/160。支援的欄位:evaluation_datasets |
evaluation_run_filter |
選用。相關聯 EvaluationRun 資源欄位的篩選器字串。詳情請參閱 https://google.aip.dev/160。支援的欄位:create_time、initiated_by、app_version_display_name |
order_by |
選用。排序依據欄位。僅支援「name」、「create_time」和「update_time」。時間欄位會依遞減順序排列,名稱欄位則依遞增順序排列。如未加入,則預設為「update_time」。詳情請參閱 https://google.aip.dev/132#ordering。 |
last_ten_results |
選用。是否要在回覆中,納入每項評估作業的最近 10 次評估結果。 |
ListEvaluationsResponse
| 欄位 | |
|---|---|
evaluations[] |
評估清單。 |
next_page_token |
可做為 |
ListExamplesRequest
AgentService.ListExamples 的要求訊息。
| 欄位 | |
|---|---|
parent |
這是必要旗標,應用程式的資源名稱,用於列出範例。 |
page_size |
選用。要求的頁面大小。伺服器傳回的項目數量可能少於要求數量。如未指定,伺服器會選擇適當的預設值。 |
page_token |
選用。先前清單 |
filter |
選用。列出範例時要套用的篩選器。詳情請參閱 https://google.aip.dev/160。 |
order_by |
選用。排序依據欄位。僅支援「name」和「create_time」。詳情請參閱 https://google.aip.dev/132#ordering。 |
ListExamplesResponse
AgentService.ListExamples 的回應訊息。
| 欄位 | |
|---|---|
examples[] |
範例清單。 |
next_page_token |
可做為 |
ListGuardrailsRequest
AgentService.ListGuardrails 的要求訊息。
| 欄位 | |
|---|---|
parent |
這是必要旗標,要列出護欄的應用程式資源名稱。 |
page_size |
選用。要求的頁面大小。伺服器傳回的項目數量可能少於要求數量。如未指定,伺服器會選擇適當的預設值。 |
page_token |
選用。先前清單 |
filter |
選用。列出護欄時要套用的篩選器。詳情請參閱 https://google.aip.dev/160。 |
order_by |
選用。排序依據欄位。僅支援「name」和「create_time」。詳情請參閱 https://google.aip.dev/132#ordering。 |
ListGuardrailsResponse
AgentService.ListGuardrails 的回應訊息。
| 欄位 | |
|---|---|
guardrails[] |
護欄清單。 |
next_page_token |
可做為 |
ListScheduledEvaluationRunsRequest
| 欄位 | |
|---|---|
parent |
這是必要旗標,應用程式的資源名稱,用於列出排定的評估執行作業。 |
page_size |
選用。要求的頁面大小。伺服器傳回的項目數量可能少於要求數量。如未指定,伺服器會選擇適當的預設值。 |
page_token |
選用。先前清單 |
filter |
選用。列出排定的評估執行作業時要套用的篩選器。詳情請參閱 https://google.aip.dev/160。目前支援依下列項目篩選:* request.evaluations:evaluation_id * request.evaluation_dataset:evaluation_dataset_id |
order_by |
選用。排序依據欄位。支援的欄位包括:「name」(遞增)、「create_time」(遞減)、「update_time」(遞減)、「next_scheduled_execution」(遞增) 和「last_completed_run.create_time」(遞減)。如未加入,則預設為「update_time」。詳情請參閱 https://google.aip.dev/132#ordering。 |
ListScheduledEvaluationRunsResponse
| 欄位 | |
|---|---|
scheduled_evaluation_runs[] |
排定的評估執行作業清單。 |
next_page_token |
可做為 |
ListToolsRequest
AgentService.ListTools 的要求訊息。
| 欄位 | |
|---|---|
parent |
這是必要旗標,要列出工具的應用程式資源名稱。 |
page_size |
選用。要求的頁面大小。伺服器傳回的項目數量可能少於要求數量。如未指定,伺服器會選擇適當的預設值。 |
page_token |
選用。先前清單 |
filter |
選用。列出工具時要套用的篩選器。使用「include_system_tools=true」,在回覆中加入系統工具。詳情請參閱 https://google.aip.dev/160。 |
order_by |
選用。排序依據欄位。僅支援「name」和「create_time」。詳情請參閱 https://google.aip.dev/132#ordering。 |
ListToolsResponse
AgentService.ListTools 的回應訊息。
| 欄位 | |
|---|---|
tools[] |
工具清單。 |
next_page_token |
可做為 |
ListToolsetsRequest
AgentService.ListToolsets 的要求訊息。
| 欄位 | |
|---|---|
parent |
這是必要旗標,要列出工具集的應用程式資源名稱。 |
page_size |
選用。要求的頁面大小。伺服器傳回的項目數量可能少於要求數量。如未指定,伺服器會選擇適當的預設值。 |
page_token |
選用。先前清單 |
filter |
選用。列出工具集時要套用的篩選器。詳情請參閱 https://google.aip.dev/160。 |
order_by |
選用。排序依據欄位。僅支援「name」和「create_time」。詳情請參閱 https://google.aip.dev/132#ordering。 |
ListToolsetsResponse
AgentService.ListToolsets 的回應訊息。
| 欄位 | |
|---|---|
toolsets[] |
工具集清單。 |
next_page_token |
可做為 |
LoggingSettings
用於描述應用程式記錄行為的設定。
| 欄位 | |
|---|---|
redaction_config |
選用。機密資料遮蓋方式的設定。 |
audio_recording_config |
選用。音訊互動記錄方式的設定。音訊會根據 |
unredacted_audio_recording_config |
選用。設定額外錄製未遮蓋的音訊。如果音訊遮蓋功能為 |
bigquery_export_settings |
選用。設定應用程式的 BigQuery Export 行為。對話資料會依據 |
unredacted_bigquery_export_settings |
選用。設定應用程式的 BigQuery 匯出行為。啟用後,未遮蓋的對話資料會匯出至 BigQuery 資料表。 |
cloud_logging_settings |
選用。說明應用程式 Cloud Logging 行為的設定。 |
conversation_logging_settings |
選用。用於描述應用程式對話記錄行為的設定。 |
evaluation_audio_recording_config |
選用。設定如何錄製音訊互動,以進行評估。根據預設,評估工作階段不會啟用音訊錄音功能。 |
metric_analysis_settings |
選用。設定應用程式 LLM 分析管道的對話資料收集行為。 |
required_recording_consent |
選用。應用程式是否必須先說明可能記錄的內容,才能保留任何內容。 如果設為 true,工作階段開始時會關閉錄音功能,直到用戶端傳送 如果設為 |
McpTool
MCP 工具。詳情請參閱 https://modelcontextprotocol.io/specification/2025-06-18/server/tools。
| 欄位 | |
|---|---|
name |
這是必要旗標,MCP 工具的名稱。 |
name_override |
選用。MCP 工具的覆寫名稱。如果名稱已由工具集覆寫,系統會填入這個欄位。 |
description |
選用。MCP 工具的說明。 |
input_schema |
選用。MCP 工具輸入引數的結構定義。 |
output_schema |
選用。MCP 工具輸出引數的結構定義。 |
server_address |
這是必要旗標,MCP 伺服器的伺服器位址,例如「https://example.com/mcp/」。如果伺服器是使用 MCP SDK 建構,網址結尾應為「/mcp/」。僅支援以可串流 HTTP 傳輸為基礎的伺服器。這與 McpToolset 中的 server_address 相同。詳情請參閱 https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http。 |
api_authentication |
選用。對 MCP 伺服器執行工具時,必須提供驗證資訊。使用不記名權杖驗證時,權杖僅適用於執行工具,不適用於列出工具。這表示工具必須在未經驗證的情況下列出。 |
tls_config |
選用。TLS 設定。包含用戶端應信任的自訂伺服器憑證。 |
service_directory_config |
選用。VPC-SC 的 Service Directory 設定,用於解析 perimeter 內的服務名稱。 |
custom_headers |
選用。要在傳送至 MCP 伺服器的要求中,加入的自訂標頭。值必須採用 |
state |
僅供輸出。外部伺服器上工具的動態可用性狀態。 |
狀態
代表工具的動態可用性狀態。
| 列舉 | |
|---|---|
STATE_UNSPECIFIED |
預設狀態。 |
ACTIVE |
工具可用,且由伺服器主動提供。 |
INACTIVE |
工具已設定或固定,但伺服器目前未提供。 |
STALE |
伺服器上有這項工具,但版本不符。 |
McpToolDefinition
工具核心定義元素的容器,這些元素是快照。快照中的結構定義會依原樣使用,無法覆寫。
| 欄位 | |
|---|---|
description |
僅供輸出。MCP 工具的說明。 |
input_schema |
僅供輸出。MCP 工具輸入引數的結構定義。 |
output_schema |
僅供輸出。MCP 工具輸出引數的結構定義。 |
McpToolOverride
與工具集中特定工具相關聯的覆寫設定。這樣就能「固定」或「覆寫」外部動態伺服器的工具定義。
| 欄位 | |
|---|---|
tool |
這是必要旗標,MCP 伺服器發出的工具原始名稱。 |
name_override |
選用。如有提供,這項工具會在代理中使用這個名稱,而非原始名稱。如果 MCP 伺服器提供的工具名稱不佳,這個欄位主要會做為別名使用。 |
description_override |
選用。如果存在,這項工具會使用這項說明,而非伺服器的原始說明。 |
snapshot |
僅供輸出。如果這個工具存在,則會處於「固定」狀態,並在伺服器暫時無法使用或沒有覆寫值時,使用快照值做為備用值。 |
McpToolset
包含 MCP 伺服器提供工具清單的工具集。
| 欄位 | |
|---|---|
server_address |
這是必要旗標,MCP 伺服器的位址,例如「https://example.com/mcp/」。如果伺服器是使用 MCP SDK 建構,網址結尾應為「/mcp/」。僅支援以可串流 HTTP 傳輸為基礎的伺服器。詳情請參閱 https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http。 |
api_authentication |
選用。存取工具及對 MCP 伺服器執行工具所需的驗證資訊。使用不記名權杖驗證時,權杖僅適用於執行工具,不適用於列出工具。這表示工具必須在未經驗證的情況下列出。 |
service_directory_config |
選用。VPC-SC 的 Service Directory 設定,用於解析 perimeter 內的服務名稱。 |
tls_config |
選用。TLS 設定。包含用戶端應信任的自訂伺服器憑證。 |
custom_headers |
選用。要在傳送至 MCP 伺服器的要求中,加入的自訂標頭。值必須採用 |
tool_overrides[] |
選用。覆寫這個工具組中的個別工具。這樣一來,您就能覆寫特定詳細資料 (例如說明、名稱),或固定工具狀態,避免完全動態。 |
訊息
對話中的訊息。
| 欄位 | |
|---|---|
role |
選用。對話中的角色,例如使用者、代理。 |
chunks[] |
選用。訊息內容,以一系列區塊呈現。 |
event_time |
選用。傳送或接收訊息的時間戳記。如果訊息是 |
MetricAnalysisSettings
設定 LLM 分析指標管道的對話資料收集行為。
| 欄位 | |
|---|---|
llm_metrics_opted_out |
選用。是否要收集對話資料,用於 LLM 分析指標。如果設為 true,系統就不會收集對話資料,用於 LLM 分析指標;否則會收集對話資料。 |
MockConfig
工作階段的模擬工具呼叫設定。
| 欄位 | |
|---|---|
mocked_tool_calls[] |
選用。在工作階段期間,模擬所有工具呼叫。 |
unmatched_tool_call_behavior |
這是必要旗標,工具呼叫不符合 mocked_tool_calls 中任何引數模式時的行為。 |
UnmatchedToolCallBehavior
工具呼叫與任何模擬工具呼叫不符時的處理方式。
| 列舉 | |
|---|---|
UNMATCHED_TOOL_CALL_BEHAVIOR_UNSPECIFIED |
預設值。這個值不會用到。 |
FAIL |
如果工具呼叫與模擬的預期輸入模式不符,則擲回錯誤。 |
PASS_THROUGH |
如果工具呼叫不相符,請將工具呼叫傳遞至實際工具。 |
MockedToolCall
模擬工具呼叫。
表示目標工具 + 與該工具引數/輸入內容相符的模式。如果模式相符,系統就會傳回模擬回應。
| 欄位 | |
|---|---|
tool |
選用。已淘汰,請改用 tool_identifier。 |
expected_args_pattern |
這是必要旗標,用於比對所有已調度工具呼叫的引數/輸入內容的模式。如果工具呼叫輸入內容符合這個模式,系統就會傳回模擬輸出內容。 |
mock_response |
選用。如果工具呼叫引數/輸入內容與模式相符,則傳回模擬回覆/輸出內容。 |
聯集欄位 tool_identifier。要模擬的工具 ID。tool_identifier 只能是下列其中一個設定: |
|
tool_id |
選用。要模擬的工具名稱。格式: |
toolset |
選用。要模擬的工具組。 |
ModelSettings
模型設定包含 LLM 模型的各種設定。
| 欄位 | |
|---|---|
model |
選用。代理應使用的 LLM 模型。如未設定,代理會沿用上層代理的模型。 |
thinking_level |
選用。模型的思考程度。 |
temperature |
選用。如果設定,LLM 模型會使用這個溫度。Temperature 參數可控制模型回覆的隨機程度。溫度越低,回覆越容易預測。溫度越高,回覆越有創意。 |
ThinkingLevel
模型的思考程度設定。
| 列舉 | |
|---|---|
THINKING_LEVEL_UNSPECIFIED |
未指定思考程度。 |
DEFAULT |
預設思考程度。 |
LOW |
低思考程度。 |
MEDIUM |
中度思考。 |
HIGH |
高思考程度。 |
OAuthConfig
OAuth 驗證設定。
| 欄位 | |
|---|---|
oauth_grant_type |
這是必要旗標,OAuth 授權類型。 |
client_id |
這是必要旗標,OAuth 供應商提供的用戶端 ID。 |
client_secret_version |
這是必要旗標,儲存用戶端密鑰的 SecretManager 密鑰版本資源名稱。格式: 注意:請將 |
token_endpoint |
這是必要旗標,OAuth 供應商中的權杖端點,用於換取存取權杖。 |
scopes[] |
選用。要授予的 OAuth 範圍。 |
OauthGrantType
OAuth 授權類型。僅支援用戶端憑證授權。
| 列舉 | |
|---|---|
OAUTH_GRANT_TYPE_UNSPECIFIED |
不明。預設值為 CLIENT_CREDENTIAL。 |
CLIENT_CREDENTIAL |
代表用戶端憑證流程。 |
OpenApiTool
由 OpenAPI 結構定義定義的遠端 API 工具。
| 欄位 | |
|---|---|
open_api_schema |
這是必要旗標,JSON 或 YAML 格式的 OpenAPI 結構定義。 |
name |
選用。工具名稱。如未提供,工具名稱會衍生自 OpenAPI 結構定義,來自 |
description |
選用。工具說明。如未提供,系統會從 OpenAPI 結構定義、 |
api_authentication |
選用。API 所需的驗證資訊。 |
tls_config |
選用。TLS 設定。包含用戶端信任的自訂伺服器憑證。 |
service_directory_config |
選用。Service Directory 設定。 |
ignore_unknown_fields |
選用。如果設為 true,代理會忽略 API 回應中的不明欄位。 |
url |
選用。Open API 架構的伺服器網址。如果結構定義包含伺服器網址,則只有在匯出程序期間,環境依附元件中的工具才會設定這個欄位。匯入期間,如果環境依附元件中有這個網址,且結構定義含有 $env_var 預留位置,系統就會替換結構定義中的預留位置。 |
OpenApiToolset
工具集,包含由 OpenAPI 結構定義定義的工具清單。
| 欄位 | |
|---|---|
open_api_schema |
這是必要旗標,工具集的 OpenAPI 結構定義。 |
api_authentication |
選用。API 所需的驗證資訊。 |
tls_config |
選用。TLS 設定。包含自訂伺服器憑證 |
service_directory_config |
選用。Service Directory 設定。 |
ignore_unknown_fields |
選用。如果設為 true,對於 OpenAPI 結構定義中定義的所有作業,代理會忽略 API 回應中的不明欄位。 |
url |
選用。Open API 架構的伺服器網址。如果結構定義包含伺服器網址,則只有在匯出程序期間,環境依附元件中的工具集才會設定這個欄位。匯入期間,如果環境依附元件中有這個網址,且結構定義含有 $env_var 預留位置,系統就會替換結構定義中的預留位置。 |
OperationCompletedEvent
用戶端或背景工作站傳送的事件,用於在非同步長時間執行的作業 (LRO) 完成後,繼續助理工作階段。
| 欄位 | |
|---|---|
operation_name |
作業資源名稱 (例如 |
target_resource_name |
作業的主要目標或產生的資源 (例如評估執行作業 ID、應用程式 ID、資料集 ID)。 |
operation_type |
作業類型或工具名稱 (例如「run_evaluation」、「copy_app」、「export_app」)。 |
status |
作業執行的狀態 (例如「SUCCEEDED」、「FAILED」、「CANCELLED」)。 |
deduplication_token |
選用簡化權杖 (例如 UUID),防止並行瀏覽器分頁重複執行回合。 |
error |
作業失敗時的標準錯誤狀態 (選用)。 |
metadata |
選填的結構化結果中繼資料 (例如 pass_rate、total_examples、export_uri)。 |
OperationMetadata
代表長時間執行的作業的中繼資料。
| 欄位 | |
|---|---|
create_time |
僅供輸出。作業的建立時間。 |
end_time |
僅供輸出。作業執行完成的時間。 |
status_message |
僅供輸出。作業的人類可讀狀態 (如有)。 |
requested_cancellation |
僅供輸出。指出使用者是否已要求取消作業。成功取消的作業會擁有 |
OptimizationConfig
在評估執行作業後,執行最佳化步驟的設定。
| 欄位 | |
|---|---|
generate_loss_report |
選用。是否要產生競價失敗報表。 |
assistant_session |
僅供輸出。根據這項評估執行作業,用於最佳化的助理工作階段。格式: |
report_summary |
僅供輸出。損失報表摘要。 |
should_suggest_fix |
僅供輸出。是否要建議修正損失。 |
status |
僅供輸出。最佳化執行作業的狀態。 |
error_message |
僅供輸出。最佳化執行作業失敗時的錯誤訊息。 |
loss_report |
僅供輸出。生成的損失報表。 |
OptimizationStatus
最佳化執行作業的狀態。
| 列舉 | |
|---|---|
OPTIMIZATION_STATUS_UNSPECIFIED |
未指定最佳化狀態。 |
RUNNING |
最佳化作業正在執行中。 |
COMPLETED |
最佳化作業已完成。 |
ERROR |
發生內部錯誤,因此無法最佳化。 |
OptionQuestionsChunk
Google 助理要求使用者選擇的結構化釐清選項,由伺服器端從模型的回覆中轉換而來 (選項區塊會從串流和保留的文字中移除)。控制台會顯示可透過鍵盤操作的選項清單,並固定在撰寫工具上方。
| 欄位 | |
|---|---|
questions[] |
本回合提出的問題。如果有多個項目,控制台會顯示「1 of N」翻頁元素。 |
選項
單一可選取的選項。
| 欄位 | |
|---|---|
title |
簡短的純文字選項標題 (不含 Markdown 和編號)。 |
details |
次要文字顯示選用的權衡詳細資料。 |
submit_text |
選擇選項時要傳送的訊息文字 (選用);如果留空,預設為 |
問題
一個問題和選項。
| 欄位 | |
|---|---|
question |
問題標題文字。 |
options[] |
可選取的選項,依顯示順序排列。 |
OutputAudioConfig
OutputAudioConfig 會設定 CES 代理應如何合成傳出的音訊回覆。
| 欄位 | |
|---|---|
audio_encoding |
這是必要旗標,輸出音訊資料的編碼。 |
sample_rate_hertz |
這是必要旗標,輸出音訊資料的取樣率 (赫茲)。 |
PersonaRunConfig
執行特定角色評估的設定。
| 欄位 | |
|---|---|
persona |
選用。用於評估的角色。格式: |
task_count |
選用。要為角色執行的任務數量。 |
PythonCodeCondition
用於評估條件的 Python 程式碼區塊。
| 欄位 | |
|---|---|
python_code |
這是必要旗標,要執行的 Python 程式碼。 |
PythonFunction
Python 函式工具。
| 欄位 | |
|---|---|
name |
選用。要執行的 Python 函式名稱。必須與 Python 程式碼中定義的 Python 函式名稱相符。區分大小寫,如未提供名稱,系統會使用 Python 程式碼中定義的第一個函式。 |
python_code |
選用。工具要執行的 Python 程式碼。 |
description |
僅供輸出。Python 函式的說明,從 Python 程式碼的 docstring 剖析而來。 |
service_directory_config |
選用。工具的 Service Directory 設定。 |
QualityReport
這份報告會說明在應用程式中發現的所有品質問題。
| 欄位 | |
|---|---|
issues[] |
選用。依代理分組的問題。 |
evaluation_runs[] |
選用。用於生成品質報表的評估執行作業清單。格式: |
general_issues[] |
選用。不限於任何代理的一般問題。 |
AgentIssues
單一代理的問題。
| 欄位 | |
|---|---|
agent |
選用。與問題相關的代理名稱。格式: |
issues[] |
選用。這個代理的問題清單。 |
問題
發現的問題。
| 欄位 | |
|---|---|
description |
選用。發現的問題說明。 |
occurrence_count |
選用。這個問題發生的次數。 |
proposed_solution |
選用。建議透過修改指令或工具來解決問題。 |
RecognitionResult
音訊輸入的語音辨識結果。
| 欄位 | |
|---|---|
transcript |
選用。在目前對話輪次中擷取的串連使用者語音片段。 |
RedactionConfig
指示如何處理機密資料的設定。
| 欄位 | |
|---|---|
enable_redaction |
選用。如果設為 |
inspect_template |
選用。DLP 檢查範本名稱,用於設定機密資料類型的偵測。 格式: |
deidentify_template |
選用。DLP 去識別化範本名稱,用於指示如何將內容去識別化。 格式: |
RemoteA2aConfig
連線至遠端 A2A 代理的共用設定。
| 欄位 | |
|---|---|
api_authentication |
選用。呼叫遠端代理的驗證設定。如果登錄檔參照已處理驗證,則為選用。 |
input_variable_mapping |
選用。將遠端代理的輸入變數名稱對應至 GECX 變數名稱。 |
output_variable_mapping |
選用。將遠端代理的輸出變數名稱對應至 GECX 變數名稱。 |
streaming_enabled |
選用。是否為遠端代理程式啟用串流功能。 |
context_id |
選用。如果不是空白,與遠端 A2A 代理的互動就會使用這個情境 ID。這個 context_id 欄位可以參照 |
聯集欄位 agent_spec。遠端代理規格。agent_spec 只能是下列其中一個設定: |
|
agent_card |
選用。內嵌定義的完整代理資訊卡。 |
agent_registry |
選用。Agent Registry 中的代理參照。格式: |
RemoteAgentTool
代表可讓代理呼叫其他遠端代理的工具。
| 欄位 | |
|---|---|
name |
這是必要旗標,工具名稱。 |
description |
這是必要旗標,工具說明。 |
agent_card |
這是必要旗標,這項工具叫用的遠端代理資訊卡。 |
api_authentication |
選用。呼叫遠端代理的驗證設定。 |
stateful_agent |
選用。啟用後,CXAS 應用程式與遠端代理之間的互動會共用相同情境。如果遠端代理傳回 context_id,這個遠端代理工具的整個工作階段都會保留該 ID。 |
input_variable_mapping |
選用。將遠端代理的輸入變數名稱對應至 GECX 變數名稱。 |
output_variable_mapping |
選用。將遠端代理的輸出變數名稱對應至 GECX 變數名稱。 |
RestoreAppVersionRequest
| 欄位 | |
|---|---|
name |
這是必要旗標,要還原的應用程式版本資源名稱。 |
RestoreAppVersionResponse
這個類型沒有任何欄位。
RetrieveToolSchemaRequest
| 欄位 | |
|---|---|
parent |
這是必要旗標,工具/工具集所屬應用程式的資源名稱。格式: |
聯集欄位 tool_identifier。要擷取結構定義的工具 ID。可以是永久工具或工具集中的工具。tool_identifier 只能是下列其中一個設定: |
|
tool |
選用。要擷取結構定義的工具名稱。格式:projects/{project}/locations/{location}/apps/{app}/tools/{tool} |
toolset_tool |
選用。要擷取結構定義的工具組工具。工具集中只有一項工具應符合述詞。否則會傳回錯誤。 |
RetrieveToolSchemaResponse
| 欄位 | |
|---|---|
input_schema |
工具輸入參數的結構定義。 |
output_schema |
工具輸出參數的結構定義。 |
聯集欄位 tool_identifier。結構定義適用的工具 ID。tool_identifier 只能是下列其中一個設定: |
|
tool |
結構定義適用的工具名稱。格式: |
toolset_tool |
結構定義適用的工具組工具。 |
RetrieveToolsRequest
ToolService.RetrieveTools 的要求訊息。
| 欄位 | |
|---|---|
toolset |
這是必要旗標,要擷取工具的工具集名稱。格式: |
tool_ids[] |
選用。要從工具集擷取的工具 ID。如果留空,系統會傳回工具集中的所有工具。 |
bypass_persistence_config |
選用。如果設為 true,傳回的工具會包含直接來自伺服器的原始說明和結構定義,並略過任何儲存的永久設定 (覆寫/快照)。 |
RetrieveToolsResponse
ToolService.RetrieveTools 的回應訊息。
| 欄位 | |
|---|---|
tools[] |
指定工具集內含的工具清單。 |
RunAssistantRequest
| 欄位 | |
|---|---|
app |
這是必要旗標,要執行助理的應用程式。格式: |
assistant_session |
這是必要旗標,用於執行助理的助理工作階段。格式: |
message |
這是必要旗標,要傳送給助理代理的訊息。 |
interaction_type |
選用。助理訊息的不同互動類型。 |
InteractionType
傳送給 Google 助理的訊息互動類型。
| 列舉 | |
|---|---|
INTERACTION_TYPE_UNSPECIFIED |
預設值。如未指定類型,系統會使用這個值。 |
NEW_MESSAGE |
訊息是使用者輸入內容。使用者輸入內容會顯示在片段清單中。 |
POLL |
這則訊息用於輪詢 Google 助理工作階段的狀態。 |
DISMISS |
這則訊息用於關閉待審查的助理工作階段。這會將 Google 助理工作階段的狀態變更為閒置。 |
RunAssistantResponse
| 欄位 | |
|---|---|
output |
這是必要旗標,助理代理的輸出內容。 |
state |
僅供輸出。助理工作階段的狀態。 |
RunEvaluationOperationMetadata
EvaluationService.RunEvaluation 的作業中繼資料。
| 欄位 | |
|---|---|
evaluations[] |
僅供輸出。已執行的評估清單。格式: |
evaluation_run |
僅供輸出。已建立的評估執行作業。格式: |
create_time |
僅供輸出。作業的建立時間。 |
end_time |
僅供輸出。作業完成時間。 |
verb |
僅供輸出。作業的動詞。 |
cancel_requested |
僅供輸出。指出使用者是否已要求取消作業。成功取消的作業會擁有 |
RunEvaluationRequest
| 欄位 | |
|---|---|
app |
這是必要旗標,要評估的應用程式。格式: |
evaluations[] |
選用。要執行的評估清單。格式: |
evaluation_dataset |
選用。要執行的評估資料集。格式: |
display_name |
選用。評估執行的顯示名稱。 |
app_version |
選用。要評估的應用程式版本。 |
config |
選用。執行作業要使用的設定。 |
persona_run_configs[] |
選用。每個角色執行時要使用的設定。 |
optimization_config |
選用。設定在評估執行後執行最佳化步驟。如未設定,系統就不會執行最佳化步驟。 |
scheduled_evaluation_run |
選用。觸發這項評估執行的 如果設定這個欄位,系統會根據這個值,填入所建立 |
golden_run_method |
選用。執行黃金評估的方法。如未設定,預設為 STABLE。 |
generate_latency_report |
選用。是否要為評估執行作業產生延遲時間報表。 |
evaluation_run_caching_settings |
選用。評估執行作業要使用的快取設定。 |
run_count |
選用。評估作業的執行次數。如未設定,則預設值為每項黃金標準 1 個,每個情境 5 個。 |
RunEvaluationResponse
| 欄位 | |
|---|---|
evaluation_run |
已建立的評估執行作業名稱。格式: |
RunEvaluationResultMetricsOperationMetadata
這個類型沒有任何欄位。
RunEvaluationResultMetricsRequest
| 欄位 | |
|---|---|
evaluation_result_id |
這是必要旗標,要執行指標的評估結果。格式: |
RunEvaluationResultMetricsResponse
| 欄位 | |
|---|---|
status |
僅供輸出。評估結果指標計算作業的狀態。 |
RunSessionRequest
SessionService.RunSession 的要求訊息。
| 欄位 | |
|---|---|
config |
這是必要旗標,工作階段的設定。 |
inputs[] |
這是必要旗標,工作階段的輸入內容。 |
RunSessionResponse
SessionService.RunSession 的回應訊息。
| 欄位 | |
|---|---|
outputs[] |
工作階段的輸出內容。 |
ScheduledEvaluationRun
代表排定的評估執行作業設定。
| 欄位 | |
|---|---|
name |
ID。排定評估執行作業設定的專屬 ID。Format: projects/{projectId}/locations/{locationId}/apps/{appId}/scheduledEvaluationRuns/{scheduledEvaluationRunId} |
display_name |
這是必要旗標,使用者定義的排定評估執行作業設定顯示名稱。 |
request |
這是必要旗標,要排定的 RunEvaluationRequest |
description |
選用。使用者定義的排定評估執行作業說明。 |
scheduling_config |
這是必要旗標,設定評估執行的時間和頻率。 |
active |
選用。這項設定是否有效 |
last_completed_run |
僅供輸出。這項排定執行作業上次成功的 EvaluationRun。格式: |
total_executions |
僅供輸出。這項執行作業的總執行次數 |
next_scheduled_execution_time |
僅供輸出。下次排定執行時間 |
create_time |
僅供輸出。建立排定評估作業的時間戳記。 |
created_by |
僅供輸出。建立排定評估執行作業的使用者。 |
update_time |
僅供輸出。上次更新評估作業的時間戳記。 |
last_updated_by |
僅供輸出。上次更新評估作業的使用者。 |
etag |
僅供輸出。Etag 可確保物件在讀取-修改-寫入作業期間未變更。如果 etag 為空白,更新作業會覆寫所有並行變更。 |
SchedulingConfig
評估排程設定詳細資料
| 欄位 | |
|---|---|
frequency |
這是必要旗標,執行評估的頻率 |
start_time |
這是必要旗標,評估作業的開始時間戳記。 |
days_of_week[] |
選用。執行評估的星期幾。僅適用於每週和每兩週頻率。1 代表星期一,2 代表星期二,以此類推,7 代表星期日。 |
頻率
評估作業的執行頻率
| 列舉 | |
|---|---|
FREQUENCY_UNSPECIFIED |
未指定頻率。 |
NONE |
表示一次性排定執行作業,不應重複 |
DAILY |
每天執行評估作業。 |
WEEKLY |
每週執行評估作業。 |
BIWEEKLY |
每兩週執行一次評估。 |
結構定義
代表 OpenAPI 3.0 結構定義物件的特定子集。
| 欄位 | |
|---|---|
type |
這是必要旗標,資料類型。 |
properties |
選用。Type.OBJECT 的屬性。 |
required[] |
選用。Type.OBJECT 的必要屬性。 |
description |
選用。資料說明。 |
items |
選用。Type.ARRAY 元素的結構定義。 |
nullable |
選用。指出值是否可能為空值。 |
unique_items |
選用。指出陣列中的項目不得重複。僅適用於 TYPE.ARRAY。 |
prefix_items[] |
選用。Type.ARRAY 初始元素的結構定義。 |
additional_properties |
選用。可以是布林值或物件,用於控制是否顯示其他屬性。 |
any_of[] |
選用。值應根據清單中的任何 (一或多個) 子結構定義進行驗證。 |
enum[] |
選用。列舉格式的基本類型元素可能值。範例:1. 我們可以將方向定義為:{type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} 2. 我們可以將公寓號碼定義為:{type:INTEGER, format:enum, enum:["101", "201", "301"]} |
default |
選用。資料的預設值。 |
ref |
選用。允許結構定義節點之間間接參照。值應為根 舉例來說,下列結構定義定義了名為「Pet」的結構定義節點參照: 「pet」屬性的值是名為「Pet」的結構定義節點參照。詳情請參閱 https://json-schema.org/understanding-json-schema/structuring。 |
defs |
選用。 |
title |
選用。結構定義的標題。 |
min_items |
選用。Type.ARRAY 的元素數量下限。 |
max_items |
選用。Type.ARRAY 的元素數量上限。 |
minimum |
選用。Type.INTEGER 和 Type.NUMBER 的最小值。 |
maximum |
選用。Type.INTEGER 和 Type.NUMBER 的最大值。 |
類型
OpenAPI 資料類型。
| 列舉 | |
|---|---|
TYPE_UNSPECIFIED |
未指定類型。 |
STRING |
字串類型。 |
INTEGER |
整數類型。 |
NUMBER |
數字類型。 |
BOOLEAN |
布林值類型。 |
OBJECT |
物件類型。 |
ARRAY |
陣列類型。 |
SecuritySettings
CES 的專案/位置層級安全性設定。
| 欄位 | |
|---|---|
name |
ID。安全性設定的專屬 ID。格式: |
endpoint_control_policy |
選用。端點控制相關設定。 |
create_time |
僅供輸出。安全性設定的建立時間。 |
update_time |
僅供輸出。安全性設定的上次更新時間。 |
etag |
僅供輸出。安全性設定的 Etag。 |
ServiceAccountAuthConfig
使用自訂服務帳戶進行驗證的設定。
| 欄位 | |
|---|---|
service_account |
這是必要旗標,用於驗證的服務帳戶電子郵件地址。CES 會使用這個服務帳戶交換存取權杖,然後在要求的 服務帳戶必須將 |
scopes[] |
選用。要授予的 OAuth 範圍。如未指定,系統會使用預設範圍 |
ServiceAgentIdTokenAuthConfig
這個類型沒有任何欄位。
使用服務代理產生的 ID 權杖進行驗證的設定。
ServiceDirectoryConfig
使用 Service Directory 的工具設定。
| 欄位 | |
|---|---|
service |
這是必要旗標,Service Directory 服務的名稱。格式: |
SessionCheckpoint
工作階段檢查點,包含工作階段標題和 UI 的推論使用者意圖。
| 欄位 | |
|---|---|
user_intent |
推論出的工作階段使用者目標或主題 (例如「建構電子商務支援代理」)。 |
SessionConfig
工作階段的設定。
| 欄位 | |
|---|---|
session |
這是必要旗標,工作階段的專屬 ID。格式: |
input_audio_config |
選用。處理輸入音訊的設定。 |
output_audio_config |
選用。生成輸出音訊的設定。 |
historical_contexts[] |
選用。工作階段的歷史脈絡,包括使用者輸入內容、代理回覆和其他訊息。一般來說,CES 代理會自動管理工作階段,因此用戶端不需要明確填入這個欄位。不過,用戶端可以選擇覆寫歷來情境,強制工作階段從特定狀態開始。 |
entry_agent |
選用。處理工作階段的進入代理。如未指定,工作階段會由應用程式的 |
deployment |
選用。要用於工作階段的應用程式部署作業。格式: |
time_zone |
選用。使用者的時區。如果提供,代理會將時區用於日期和時間相關變數。否則,代理程式會使用 App.time_zone_settings 中指定的時區。 格式為 IANA 時區資料庫時區,例如「America/Los_Angeles」。 |
use_tool_fakes |
選用。是否要在工作階段使用工具假資料。如果設定這個欄位,代理會嘗試使用工具假資料,而非呼叫實際工具。 |
remote_dialogflow_query_parameters |
選用。當工作階段控制權轉移至遠端代理時,要傳送至遠端 Dialogflow 代理的 QueryParameters。 |
enable_text_streaming |
選用。是否在模型生成文字輸出內容時,逐步串流至用戶端。預設值為
注意:這項功能僅適用於使用 |
include_llm_thought_summary |
選用。是否在工作階段輸出內容中,加入 LLM 推論摘要。 |
exclude_diagnostic_info |
選用。是否要從工作階段輸出內容中排除診斷資訊。 |
include_progress_update |
選用。是否要向用戶端提供中繼處理更新。如果啟用,系統會在 |
RemoteDialogflowQueryParameters
當工作階段控制權轉移至遠端代理時,要傳送至遠端 Dialogflow 代理的 QueryParameters。
| 欄位 | |
|---|---|
webhook_headers |
選用。在 QueryParameters 中,以 webhook_headers 形式傳送的 HTTP 標頭。 |
payload |
選用。要在 QueryParameters 中傳送的酬載。 |
end_user_metadata |
選用。要在 QueryParameters 中傳送的使用者中繼資料。 |
SessionInput
工作階段的輸入內容。
| 欄位 | |
|---|---|
will_continue |
選用。這個標記用於指出目前訊息是否為雙向串流工作階段中較大輸入內容的一部分。 如果設為 注意:這個欄位不適用於音訊和 DTMF 輸入,因為系統一律會根據端點信號自動處理這些輸入。 |
recording_control |
選用。是否要從現在起錄製及記錄對話。 如果是由應用程式 (而非代理) 決定可保留的內容,請使用這個選項。舉例來說,使用者必須先同意錄音,系統才能儲存通話相關內容。 這個值會持續有效,直到用戶端傳送不同的值為止,因此只有在答案變更時才需要傳送。一輪對話結束時,系統會根據當時生效的設定,決定該輪對話的音訊是否會傳送至錄音 bucket,以及轉錄稿是否會傳送至對話記錄、BigQuery 和 Cloud Logging。涵蓋代理和使用者雙方的對話內容。 在用戶端首次傳送此欄位之前完成的回合,會根據應用程式的記錄設定記錄,就像該欄位不存在一樣。 如果同一要求中有多個輸入內容設定了這個值,則以最後一個為準。 |
聯集欄位 input_type。輸入內容的類型。input_type 只能是下列其中一個設定: |
|
text |
選用。使用者的文字資料。 |
dtmf |
選用。使用者輸入的 DTMF 數字。 |
audio |
選用。使用者提供的音訊資料。 |
tool_responses |
選用。用戶端工具呼叫的執行結果。 |
image |
選用。使用者提供的圖片資料。 |
blob |
選用。使用者提供的 Blob 資料。 |
variables |
選用。工作階段的情境變數,依名稱排序。CES 代理只會使用在應用程式中宣告的變數。 無法辨識的變數仍會以額外工作階段參數的形式,傳送至 [Dialogflow 代理][Agent.RemoteDialogflowAgent]。 |
event |
選用。事件輸入。 |
RecordingControl
應用程式做出的決定可能會記錄下來。
這個列舉可擴充,日後可能會新增值。
| 列舉 | |
|---|---|
RECORDING_CONTROL_UNSPECIFIED |
應用程式並未控制錄製功能。應用程式的記錄設定會決定,就像每個從未設定這個欄位的工作階段一樣。 |
RECORDING_ENABLED |
從現在起,系統可能會錄音並記錄對話內容。 |
RECORDING_DISABLED |
系統可能不會再錄製或記錄對話。 |
SessionOutput
工作階段的輸出內容。
| 欄位 | |
|---|---|
turn_index |
指出這項輸出內容所屬的對話輪次順序,從 1 開始。 |
turn_completed |
如果為 true,表示 CES 代理偵測到目前對話回合結束,不會再提供這個回合的輸出內容。 |
diagnostic_info |
選用。診斷資訊包含輸入內容處理期間的執行詳細資料。只有在每個回合的最後一個 SessionOutput (含有 |
聯集欄位 output_type。輸出內容的類型。output_type 只能是下列其中一個設定: |
|
text |
CES 代理的輸出文字。 |
audio |
CES 代理的輸出音訊。 |
tool_calls |
要求用戶端執行工具。 |
citations |
提供代理生成的文字來源資訊的引用內容。 |
google_search_suggestions |
叫用 |
end_session |
表示工作階段已結束。 |
payload |
CES 代理輸出的結構化自訂酬載。 |
image |
CES 代理的輸出圖片。 |
progress |
CES 代理的中繼進度更新。 |
DiagnosticInfo
包含處理期間的執行作業詳細資料。
| 欄位 | |
|---|---|
messages[] |
處理期間發生的訊息清單。 |
root_span |
整個要求處理作業的追蹤記錄,以根時距表示。這個 Span 可包含特定作業的巢狀子 Span。 |
時距
「Span」是要求處理期間的工作單位或單一作業。
| 欄位 | |
|---|---|
name |
僅供輸出。Span 的名稱。 |
start_time |
僅供輸出。Span 的開始時間。 |
end_time |
僅供輸出。Span 的結束時間。 |
duration |
僅供輸出。Span 的時間長度。 |
attributes |
僅供輸出。與 Span 相關聯的鍵/值屬性。 |
child_spans[] |
僅供輸出。這個 Span 下的巢狀子 Span。 |
StreamChatAiAssistantRequest
| 欄位 | |
|---|---|
name |
這是必要旗標,用於執行助理的助理工作階段。格式: |
message |
選用。要傳送給助理代理的訊息。如果已設定 |
attached_gcs_uris[] |
選用。使用者在這輪對話上傳檔案的 Cloud Storage URI。範例:「gs://cxas-transient-uploads/uuid/prd.pdf」 |
context_token |
選用。 |
confirmation_response |
選用。使用者對待處理 |
client_capabilities[] |
選用。這個用戶端可顯示的回應功能。伺服器只會在宣告功能時,發出需要該功能的事件 (例如 |
operation_completed_event |
選用。繼續執行助理工作階段,該工作階段先前因等待用戶端管理的長時間執行的作業完成而暫停。 |
resume_from_sequence_number |
選用。選用游標,可從進行中或已完成的回合繼續及重播事件。 |
attach_only |
選用。選用標記,可附加至現有的進行中回合,不需提交新訊息。 |
ClientCapability
用戶端可宣告的回應功能。
| 列舉 | |
|---|---|
CLIENT_CAPABILITY_UNSPECIFIED |
未指定功能,已忽略。 |
CONFIRMATION_CARDS |
用戶端會顯示 AssistantConfirmationRequest 卡片,並透過 confirmation_response 回答。 |
CLIENT_MANAGED_LRO |
用戶端會輪詢作業並傳送 operation_completed_event 來繼續對話,在頻外管理長時間執行的作業。如未宣告,伺服器會管理 LRO 輪詢,並在內嵌完成回合。 |
PROJECT_SCOPE |
用戶端會顯示專案範圍事件:typed_payload 卡片、工具呼叫和回覆的 target_app、確認要求的 targets,以及回合完成的 touched_apps。 |
StreamChatAiAssistantResponse
| 欄位 | |
|---|---|
event_id |
事件的專屬 ID。 |
event_time |
事件發生時的時間戳記。 |
ui_event |
選用。UI 事件酬載。 |
turn_metadata |
選用。回合層級中繼資料和意圖分類。 |
sequence_number |
選用。這個工作階段回合的序號,會單調遞增。 |
turn_in_progress |
選用。指出轉彎是否仍在背景執行。 |
聯集欄位 event。事件酬載。event 只能是下列其中一個設定: |
|
text_chunk |
文字詞元 (用於逐字串流 Gemini 回覆)。 |
status |
簡單的狀態更新。 |
thought_chunk |
思考文字區塊 (代理生成回覆前的推論過程)。 |
tool_call |
工具呼叫執行事件。 |
tool_response |
工具呼叫回應事件。 |
artifact_chunk |
生成文件構件事件 (即時預覽差異 + 最終 Cloud Storage 指標)。 |
option_questions_chunk |
從模型對話剖析出的結構化澄清選項。控制台會將這些內容轉譯為可選取的選項清單,而非原始文字。 |
confirmation_request |
代理暫停時的封鎖確認。當後續要求的 |
session_checkpoint |
工作階段檢查點/壓縮摘要事件,包含使用者意圖和滾動摘要。 |
resume_snapshot |
在任何即時事件之前,系統會傳送壓縮的重播事件,做為每個附加或繼續事件的第一個事件。用戶端會將這個回合在本機轉譯的所有狀態,替換為快照內容。 |
handoff |
指示用戶端使用 resume_from_sequence_number 重新連線,不顯示任何訊息:提供這個串流的工作即將結束,且會改在其他位置繼續。這不是錯誤,串流會在這個事件後正常完成。 |
turn_completed |
回合已結束。在原始串流和每個附加或恢復的串流上,做為每個回合的最後一個事件傳送,讓用戶端能根據明確信號結束回合,而非從串流關閉推斷。 |
SynthesizeSpeechConfig
代理回覆的合成方式設定。
| 欄位 | |
|---|---|
voice |
選用。語音的名稱。如未設定,服務會根據 language_code 等其他參數選擇語音。 如需可用語音清單,請參閱 Cloud Text-to-Speech 的支援的語音和語言。 |
speaking_rate |
選用。語速範圍為 [0.25, 2.0]。1.0 為特定語音支援的正常原生速度。2.0 為兩倍速,0.5 為一半的速度。如果值超出 [0.25, 2.0] 範圍,系統會傳回錯誤。 |
model |
選用。用於合成音訊的模型。目前支援的值:-「gemini-3.1-flash-tts-preview」如果留空,則會使用 Chirp3-HD。 |
instruction |
選用。使用生成模型時,用於合成語音的指令。 |
SystemTool
預先定義的系統工具。
| 欄位 | |
|---|---|
name |
這是必要旗標,系統工具的名稱。 |
description |
僅供輸出。系統工具的說明。 |
TestPersonaVoiceRequest
| 欄位 | |
|---|---|
app |
必要。要測試角色語音的應用程式資源名稱。格式: |
persona_id |
這是必要旗標,要測試語音的角色 ID。也接受「default」。 |
text |
這是必要旗標,要測試語音的文字。 |
TestPersonaVoiceResponse
| 欄位 | |
|---|---|
audio |
合成語音的音訊資料位元組。 |
TimeZoneSettings
應用程式的時區設定。
| 欄位 | |
|---|---|
time_zone |
選用。時區資料庫中的應用程式時區,例如 America/Los_Angeles、Europe/Paris。 |
TlsConfig
TLS 設定。
| 欄位 | |
|---|---|
ca_certs[] |
這是必要旗標,指定允許用於 HTTPS 驗證的自訂 CA 憑證清單。 |
CaCert
CA 憑證。
| 欄位 | |
|---|---|
display_name |
這是必要旗標,允許的自訂 CA 憑證名稱。這可用於區分自訂 CA 憑證。 |
cert |
這是必要旗標,用於 HTTPS 驗證的允許自訂 CA 憑證 (DER 格式)。這會覆寫預設 SSL 信任存放區。如果這個欄位留空或未指定,CES 會使用 Google 的預設信任存放區驗證憑證。注意:請確認 HTTPS 伺服器憑證是以「主體別名」簽署。舉例來說,您可以使用下列指令自行簽署憑證: |
工具
工具代表 CES 代理可採取的行動,以達成特定目標。
| 欄位 | |
|---|---|
name |
ID。工具的資源名稱。格式:
這些工具是動態的,且僅限輸出,無法在預期使用工具的地方直接參照。 |
display_name |
僅供輸出。工具的顯示名稱,依據工具類型衍生。舉例來說,[ClientFunction][Tool.ClientFunction] 的顯示名稱衍生自其 |
execution_type |
選用。工具的執行類型。 |
timeout |
選用。工具執行作業的逾時時間。如未設定, |
create_time |
僅供輸出。工具的建立時間戳記。 |
update_time |
僅供輸出。上次更新工具的時間戳記。 |
etag |
Etag 可確保物件在讀取-修改-寫入作業期間未變更。如果 etag 為空白,更新作業會覆寫所有並行變更。 |
generated_summary |
僅供輸出。如果工具是由 LLM 助理生成,這個欄位會包含生成內容的摘要說明。 |
tool_fake_config |
選用。模擬模式中的工具行為設定。 |
read_only |
僅供輸出。指出工具是否為唯讀。如果設為 true,使用者就無法修改工具。 |
聯集欄位 tool_type。工具類型。tool_type 只能是下列其中一個設定: |
|
client_function |
選用。用戶端函式。 |
open_api_tool |
選用。開放式 API 工具。 |
google_search_tool |
選用。Google 搜尋工具。 |
connector_tool |
選用。Integration Connector 工具。 |
data_store_tool |
選用。資料儲存庫工具。 |
python_function |
選用。Python 函式工具。 |
mcp_tool |
選用。MCP 工具。MCP 工具無法直接建立或更新,而是由 MCP 工具集管理。 |
file_search_tool |
選用。檔案搜尋工具。 |
system_tool |
選用。系統工具。 |
agent_tool |
選用。代理工具。 |
widget_tool |
選用。小工具。 |
remote_agent_tool |
選用。遠端代理工具。 |
ToolCall
要求用戶端或代理程式執行指定工具。
| 欄位 | |
|---|---|
id |
選用。工具呼叫的專屬 ID。如果已填入,用戶端應在 |
display_name |
僅供輸出。工具的顯示名稱。 |
args |
選用。工具的輸入參數和值,採用 JSON 物件格式。 |
parent_tool_call_id |
僅供輸出。如果工具呼叫是由代表父項呼叫的子代理發出,則此為導致該呼叫的工具呼叫 ID。頂層呼叫為空白。讓用戶端將子代理的工作分組到啟動該工作的呼叫下,而不是將每個步驟算做同層級。 |
agent_name |
僅供輸出。發出這項呼叫的代理人類可讀名稱,例如「Contract Architect」。如果是由根層級代理發出,則為空白。 |
target_app |
僅供輸出。這項呼叫指定的應用程式,由助理從呼叫的資源引數衍生:應用程式資源名稱、位置範圍工具的 |
聯集欄位 tool_identifier。要執行的工具 ID。可以是永久工具或工具集中的工具。tool_identifier 只能是下列其中一個設定: |
|
tool |
選用。要執行的工具名稱。格式: |
toolset_tool |
選用。要執行的工具組工具。 |
ToolCalls
要求用戶端執行工具並傳回執行結果,再繼續對話。
| 欄位 | |
|---|---|
tool_calls[] |
選用。要執行的工具呼叫清單。 |
ToolFakeConfig
模擬模式中的工具行為設定。
| 欄位 | |
|---|---|
enable_fake_mode |
選用。工具是否使用假模式。 |
聯集欄位 tool_response。回覆可以是靜態內容,也可以由 Python 函式提供。tool_response 只能是下列其中一個設定: |
|
code_block |
選用。要執行的程式碼區塊,而非實際工具呼叫。 |
ToolResponse
用戶端或代理執行特定工具的結果。
| 欄位 | |
|---|---|
id |
選用。回覆所屬 |
display_name |
僅供輸出。工具的顯示名稱。 |
response |
這是必要旗標,JSON 物件格式的工具執行結果。請使用「output」鍵指定工具回覆,並使用「error」鍵指定錯誤詳細資料 (如有)。如未指定「output」和「error」鍵,整個「response」都會視為工具執行結果。 |
parent_tool_call_id |
僅供輸出。如果工具呼叫是由代表父項呼叫的子代理發出,則此為導致該呼叫的工具呼叫 ID。頂層呼叫為空白。讓用戶端將子代理的工作分組到啟動該工作的呼叫下,而不是將每個步驟算做同層級。 |
agent_name |
僅供輸出。發出這項呼叫的代理人類可讀名稱,例如「Contract Architect」。如果是由根層級代理發出,則為空白。 |
target_app |
僅供輸出。執行工具指定的應用程式;與 |
聯集欄位 tool_identifier。已執行工具的 ID。可以是永久工具或工具集中的工具。tool_identifier 只能是下列其中一個設定: |
|
tool |
選用。要執行的工具名稱。格式: |
toolset_tool |
選用。已執行的工具組工具。 |
ToolResponses
用戶端要求的工具呼叫執行結果。
| 欄位 | |
|---|---|
tool_responses[] |
選用。工具執行結果清單。 |
工具集
工具集代表一組動態管理的工具,可供代理使用。
| 欄位 | |
|---|---|
name |
ID。工具組的專屬 ID。格式: |
display_name |
選用。工具集的顯示名稱。在同一個應用程式中不得重複。 |
description |
選用。工具集的說明。 |
timeout |
選用。工具組執行的逾時時間。如未設定, |
create_time |
僅供輸出。工具集建立時間的時間戳記。 |
update_time |
僅供輸出。上次更新工具組的時間戳記。 |
etag |
ETag 可確保物件在讀取-修改-寫入作業期間未變更。如果 etag 為空白,更新作業會覆寫所有並行變更。 |
execution_type |
選用。工具集中工具的執行類型。 |
tool_fake_config |
選用。模擬模式中的工具行為設定。 |
聯集欄位 toolset_type。工具組類型。toolset_type 只能是下列其中一個設定: |
|
mcp_toolset |
選用。包含 MCP 伺服器提供工具清單的工具集。 |
open_api_toolset |
選用。工具集,包含由 OpenAPI 結構定義定義的工具清單。 |
connector_toolset |
選用。這組工具集可從 Integration Connectors 連線生成工具。 |
ToolsetTool
從工具集建立的工具。
| 欄位 | |
|---|---|
toolset |
這是必要旗標,這個工具衍生自的工具集資源名稱。格式: |
tool_id |
選用。工具 ID,用於篩選要擷取結構定義的工具。 |
TransferRule
轉接至特定服務專員的規則。
| 欄位 | |
|---|---|
child_agent |
這是必要旗標,規則適用的子代理資源名稱。格式: |
direction |
這是必要旗標,移轉方向。 |
聯集欄位 rule_type。規則類型。rule_type 只能是下列其中一個設定: |
|
deterministic_transfer |
選用。符合條件時,立即轉移至目標代理的規則。 |
disable_planner_transfer |
選用。禁止規劃工具轉移至目標代理的規則。 |
DeterministicTransfer
確定性轉移規則。如果條件評估結果為 true,就會進行轉移。
| 欄位 | |
|---|---|
聯集欄位 condition_type。要評估的條件。condition_type 只能是下列其中一個設定: |
|
expression_condition |
選用。評估工作階段狀態條件的規則。如果條件評估結果為 true,就會執行移轉作業。 |
python_code_condition |
選用。使用 Python 程式碼區塊評估條件的規則。如果條件評估結果為 true,就會執行移轉作業。 |
方向
移轉方向。
| 列舉 | |
|---|---|
DIRECTION_UNSPECIFIED |
未指定方向。 |
PARENT_TO_CHILD |
從上層代理轉移至子代理。 |
CHILD_TO_PARENT |
從子代理轉移至上層代理。 |
DisablePlannerTransfer
防止規劃工具轉移至目標代理的規則。
| 欄位 | |
|---|---|
expression_condition |
這是必要旗標,如果條件評估結果為 true,規劃工具就無法轉移至目標代理。 |
TriggerAction
符合特定前提條件時採取的動作。
| 欄位 | |
|---|---|
聯集欄位 action。要採取的行動。action 只能是下列其中一個設定: |
|
respond_immediately |
選用。立即使用預先設定的回覆。 |
transfer_agent |
選用。將對話轉接給其他服務專員。 |
generative_answer |
選用。使用生成式答案回覆。 |
GenerativeAnswer
代理會立即回覆生成式答案。
| 欄位 | |
|---|---|
prompt |
這是必要旗標,用於生成回覆的提示。 |
RespondImmediately
代理會立即回覆預先設定的回應。
| 欄位 | |
|---|---|
responses[] |
這是必要旗標,可供服務專員選擇的罐頭回應。系統會隨機選擇回覆。 |
回應
代表代理的回覆。
| 欄位 | |
|---|---|
text |
這是必要旗標,代理回覆的文字。 |
disabled |
選用。是否停用回覆。代理不會使用已停用的回覆。 |
TransferAgent
代理會將對話轉移給其他代理。
| 欄位 | |
|---|---|
agent |
這是必要旗標,要轉移對話的代理名稱。代理必須與目前代理位於同一個應用程式。格式: |
TurnCompletedEvent
對話回合的終端事件 (請參閱 StreamChatAiAssistantResponse.turn_completed)。
| 欄位 | |
|---|---|
turn_id |
已結束轉彎的 ID,與 TurnResumeSnapshot.turn_id 和 ActiveTurnInfo.turn_id 相符。 |
reason |
回合結束的原因。 |
final_sequence_number |
回合產生的最後一個事件序號。如果用戶端的游標位置較低,表示錯過了內容,應重新載入工作階段才能看到。 |
touched_apps[] |
本次指定或變更的應用程式,讓控制台能準確重新整理這些應用程式的商店。僅限專案範圍工作階段。格式: |
原因
回合結束的原因,讓較晚加入的用戶端可以根據結果判斷,而不是從空白串流中猜測。
| 列舉 | |
|---|---|
REASON_UNSPECIFIED |
未指定。 |
COMPLETED |
回合已執行完畢,工作階段會保留已提交的輸出內容。 |
ABANDONED |
沒有任何工作在驅動該回合,該回合已密封為已提交的部分,無法繼續。 |
RESUME_UNAVAILABLE |
這個伺服器不提供附加或繼續工作階段的功能,因此未追蹤任何內容;用戶端應重新載入工作階段。 |
TurnHandoffEvent
這項工作在對話中途停止提供串流 (例如伺服器重新啟動) 前,會發出這個事件。系統會保留對話輪次的狀態,如果重新連線時帶有 resume_from_sequence_number,則會在另一個任務中繼續對話。
| 欄位 | |
|---|---|
turn_id |
識別要繼續的回合。 |
reason |
串流接力播放的原因。 |
原因
串流接力播放的原因。
| 列舉 | |
|---|---|
REASON_UNSPECIFIED |
未指定。 |
SERVER_RESTART |
服務工作正在關閉 (發布推送或重新排程)。 |
TurnMetadata
回合層級中繼資料和意圖分類。
| 欄位 | |
|---|---|
contract_related |
指出這個助理回合是否與合約相關 (例如合約草擬、調整、擷取或修訂)。 |
contract_finalized |
在合約草稿發布 (修訂版本已啟用) 的回合最終構件事件中設定。這份草稿的釐清流程終端:contract_progress 具有權威性且完整。 |
contract_streaming_phase |
僅在合約構件柵欄串流期間發出的執行中進度預估,以及修訂版本開始事件中設定。未設定授權酬載。 |
contract_draft_complete |
在合約草稿的終端事件上設定,其中每個預留位置都已解析 (contract_progress 為 100%),無論草稿是否已發布。用戶端完成並關閉合約進度顯示畫面;發布作業會由 contract_finalized 另外回報。 |
ContractStreamingPhase
合約進度酬載的串流階段。
| 列舉 | |
|---|---|
CONTRACT_STREAMING_PHASE_UNSPECIFIED |
酬載具有權威性 (根據完整合約文件、永久快照或預先草稿狀態計算)。用戶端必須將先前收到的進度替換為此進度。 |
DRAFTING |
正在串流初始合約草稿。contract_progress 是進行中的預估值:在一個構件範圍內不會減少,上限低於權威範圍,且 pillar_breakdowns 包含 total_item_count == 0,用於標示預估的支柱狀態。 |
REVISING |
現有合約的修訂版本正在串流 (例如提交註解後)。預估語意與 DRAFTING 相同。 |
TurnResumeSnapshot
轉彎期間的精簡重播:轉彎時顯示輸出內容所需的一切,以及即時事件繼續的位置。
| 欄位 | |
|---|---|
turn_id |
用於識別要附加的轉彎。 |
resolved_sequence_number |
這個快照代表的位置。sequence_number 必須大於這個值,才能追蹤直播活動。如果低於用戶端要求的 resume_from_sequence_number,清除進度會落後於用戶端已算繪的內容:用戶端必須捨棄這一輪中超過這個位置的算繪內容,才能套用快照。 |
events[] |
精簡事件會按照轉譯順序,使用與直播相同的事件形狀,重建該回合的可見輸出內容。 |
orphan_deadline_time |
如果沒有任何用戶端連結,系統會關閉 TURN。 |
TypedPayload
具有類型的酬載。Used by the assistant history (AssistantChunk) and by the streaming typed_payload event; lives here because both assistant_service.proto and session_service.proto need it.
| 欄位 | |
|---|---|
display_name |
這是必要旗標,酬載的顯示名稱。 |
type |
這是必要旗標,酬載類型。 |
value |
這是必要旗標,酬載的值。 |
metadata |
選用。酬載的中繼資料。 |
UiEvent
代表 UI 事件酬載。
| 欄位 | |
|---|---|
mime_type |
媒體類型 (MIME 類型),表示 UI 事件酬載的格式 (例如「application/json+a2ui」)。 |
json_payload |
代表 A2UI 介面的 JSON 酬載。 |
UpdateAgentRequest
AgentService.UpdateAgent 的要求訊息。
| 欄位 | |
|---|---|
agent |
這是必要旗標,要更新的代理。 |
update_mask |
選用。欄位遮罩可用來控制要更新的欄位。如未提供遮罩,系統會更新所有欄位。 |
UpdateAppRequest
AgentService.UpdateApp 的要求訊息。
| 欄位 | |
|---|---|
app |
這是必要旗標,要更新的應用程式。 |
update_mask |
選用。欄位遮罩可用來控制要更新的欄位。如未提供遮罩,系統會更新所有欄位。 |
UpdateAppVersionRequest
| 欄位 | |
|---|---|
app_version |
這是必要旗標,要更新的應用程式版本。 |
update_mask |
選用。要更新的欄位清單。如果留空,系統會更新 |
UpdateDeploymentRequest
| 欄位 | |
|---|---|
deployment |
這是必要旗標,要更新的部署作業。 |
update_mask |
選用。要更新的欄位清單。 |
UpdateEvaluationDatasetRequest
| 欄位 | |
|---|---|
evaluation_dataset |
這是必要旗標,要更新的評估資料集。 |
update_mask |
選用。欄位遮罩可用來控制要更新的欄位。如未提供遮罩,系統會更新所有欄位。 |
UpdateEvaluationExpectationRequest
| 欄位 | |
|---|---|
evaluation_expectation |
這是必要旗標,要更新的評估預期。 |
update_mask |
選用。欄位遮罩可用來控制要更新的欄位。如未提供遮罩,系統會更新所有欄位。 |
UpdateEvaluationRequest
| 欄位 | |
|---|---|
evaluation |
這是必要旗標,要更新的評估作業。 |
update_mask |
選用。欄位遮罩可用來控制要更新的欄位。如未提供遮罩,系統會更新所有欄位。 |
UpdateExampleRequest
AgentService.UpdateExample 的要求訊息。
| 欄位 | |
|---|---|
example |
這是必要旗標,要更新的範例。 |
update_mask |
選用。欄位遮罩可用來控制要更新的欄位。如未提供遮罩,系統會更新所有欄位。 |
UpdateGuardrailRequest
AgentService.UpdateGuardrail 的要求訊息。
| 欄位 | |
|---|---|
guardrail |
這是必要旗標,要更新的護欄。 |
update_mask |
選用。欄位遮罩可用來控制要更新的欄位。如未提供遮罩,系統會更新所有欄位。 |
UpdateScheduledEvaluationRunRequest
| 欄位 | |
|---|---|
scheduled_evaluation_run |
這是必要旗標,要更新的排定評估執行作業。 |
update_mask |
選用。欄位遮罩可用來控制要更新的欄位。如未提供遮罩,系統會更新所有欄位。 |
UpdateSecuritySettingsRequest
| 欄位 | |
|---|---|
security_settings |
這是必要旗標,要更新的安全性設定。 |
update_mask |
選用。欄位遮罩可用來控制要更新的欄位。如未提供遮罩,系統會更新所有欄位。 |
UpdateToolRequest
AgentService.UpdateTool 的要求訊息。
| 欄位 | |
|---|---|
tool |
這是必要旗標,要更新的工具。 |
update_mask |
選用。欄位遮罩可用來控制要更新的欄位。如未提供遮罩,系統會更新所有欄位。 |
UpdateToolsetRequest
AgentService.UpdateToolset 的要求訊息。
| 欄位 | |
|---|---|
toolset |
這是必要旗標,要更新的工具組。 |
update_mask |
選用。欄位遮罩可用來控制要更新的欄位。如未提供遮罩,系統會更新所有欄位。 |
UploadEvaluationAudioRequest
| 欄位 | |
|---|---|
name |
這是必要旗標,要上傳評估音訊的評估資源名稱。格式: |
audio_content |
這是必要旗標,原始音訊位元組。音訊格式必須是單聲道 LINEAR16,取樣率為 16kHz (預設 InputAudioConfig)。 |
previous_audio_gcs_uri |
選用。先前上傳的音訊檔案 Google Cloud Storage URI,用於刪除檔案。格式: |
UploadEvaluationAudioResponse
| 欄位 | |
|---|---|
audio_gcs_uri |
上傳的音訊檔案儲存位置的 Google Cloud Storage URI。格式: |
transcript |
由 Cloud Speech-to-Text 生成的音訊轉錄稿。 |
duration |
音訊長度。 |
UserResponseSuggestions
助理代理建議的使用者回覆。
| 欄位 | |
|---|---|
suggestions[] |
這是必要旗標,助理建議的使用者回覆。這些是建議使用者如何與助理互動的提示。 |
VpcScSettings
應用程式的 VPC-SC 設定。
| 欄位 | |
|---|---|
allowed_origins[] |
選用。啟用 VPC Service Controls 時,應用程式中的 OpenAPI 工具可直接呼叫的允許 HTTP(S) 來源。這些字串必須與來源完全相符,包括指定的通訊埠。例如「https://example.com」或「https://example.com:443」。這份清單尚未套用至可能直接發出 HTTP 呼叫的 Python 工具。 |
WebSearchQuery
代表單一網頁搜尋查詢和相關聯的搜尋 URI。
| 欄位 | |
|---|---|
query |
搜尋查詢文字。 |
uri |
查詢的 Google 搜尋結果網頁 URI。 |
WhatsAppCredentials
WhatsApp 原生整合的臨時 Meta 憑證。
| 欄位 | |
|---|---|
auth_code |
這是必要旗標,嵌入式註冊流程提供的 Meta 授權碼。 |
pin |
這是必要旗標,使用者為兩步驟驗證建立的 6 位數 PIN 碼。 |
phone_number |
這是必要旗標,要註冊 WhatsApp 的電話號碼。 |
business_account_id |
這是必要旗標,要用於電話號碼的商家帳戶 ID。 |
waba_id |
這是必要旗標,WhatsApp Business 帳戶 ID。 |
conversation_profile_id |
選用。部署作業要使用的對話設定檔 ID。 |
WidgetTool
代表代理可叫用的小工具。代理選取工具後,會將小工具傳回用戶端。用戶端負責處理小工具,並產生下一個使用者查詢,繼續與代理互動。
| 欄位 | |
|---|---|
name |
這是必要旗標,小工具工具的顯示名稱。 |
description |
選用。小工具工具的說明。 |
widget_type |
選用。小工具工具的類型。如未指定,預設類型為 CUSTOMIZED。 |
ui_config |
選用。用於顯示小工具的設定。 |
data_mapping |
選用。定義來源工具資料如何對應至小工具輸入參數的對應關係。 |
text_response_config |
選用。一律包含的文字回覆設定。 |
聯集欄位 input。小工具工具的輸入內容。input 只能是下列其中一個設定: |
|
parameters |
選用。小工具工具的輸入參數。 |
DataMapping
設定如何將來源工具的資料對應至小工具的輸入參數。
| 欄位 | |
|---|---|
source_tool_name |
選用。為小工具提供資料的工具資源名稱 (例如搜尋工具或自訂函式)。格式: |
field_mappings |
選用。小工具輸入參數欄位與來源工具對應輸出欄位的對應關係。 |
python_function |
選用。Python 函式的設定,用於將來源工具的輸出內容轉換為小工具的輸入格式。 |
mode |
選用。資料對應模式。 |
python_script |
已淘汰:請改用 |
模式
將資料從來源工具對應至小工具的策略。
| 列舉 | |
|---|---|
MODE_UNSPECIFIED |
未指定模式。 |
FIELD_MAPPING |
使用 field_mappings 對應進行資料轉換。 |
PYTHON_SCRIPT |
使用 python_script 轉換資料。 |
TextResponseConfig
與小工具一併傳回的文字回覆設定。
| 欄位 | |
|---|---|
type |
選用。提供文字回覆的策略。 |
static_text |
選用。類型為 STATIC 時要傳回的靜態文字回應。 |
text_response_instruction |
選用。指示 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 |
Shorts 小工具。 |
OVERALL_SATISFACTION |
整體滿意度小工具。 |
ORDER_SUMMARY |
訂單摘要小工具。 |
APPOINTMENT_DETAILS |
預約詳細資料小工具。 |
APPOINTMENT_SCHEDULER |
預約時間表小工具。 |
CONTACT_FORM |
聯絡表單小工具。 |