색인
AgentService(인터페이스)EvaluationService(인터페이스)SessionService(인터페이스)ToolService(인터페이스)WidgetService(인터페이스)Action(메시지)Action.EntityOperation(메시지)Action.EntityOperation.OperationType(열거형)Agent(메시지)Agent.AgentToolset(메시지)Agent.LlmAgent(메시지)Agent.RemoteA2aAgent(메시지)Agent.RemoteDialogflowAgent(메시지)AgentCard(메시지)AgentInterface(메시지)AgentRegistryDeployment(메시지)AgentSkill(메시지)AgentTool(메시지)AgentTransfer(메시지)AggregatedMetrics(메시지)AggregatedMetrics.HallucinationMetrics(메시지)AggregatedMetrics.MetricsByAppVersion(메시지)AggregatedMetrics.MetricsByTurn(메시지)AggregatedMetrics.SemanticSimilarityMetrics(메시지)AggregatedMetrics.ToolCallLatencyMetrics(메시지)AggregatedMetrics.ToolMetrics(메시지)AggregatedMetrics.TurnLatencyMetrics(메시지)AmbientSoundConfig(메시지)AmbientSoundConfig.PrebuiltAmbientNoise(열거형)ApiAuthentication(메시지)ApiKeyConfig(메시지)ApiKeyConfig.RequestLocation(열거형)App(메시지)App.ToolExecutionMode(열거형)App.VariableDeclaration(메시지)AppSnapshot(메시지)AppVersion(메시지)AudioEncoding(열거형)AudioProcessingConfig(메시지)AudioRecordingConfig(메시지)BargeInConfig(메시지)BatchDeleteConversationsRequest(메시지)BatchDeleteConversationsResponse(메시지)BearerTokenConfig(메시지)BidiSessionClientMessage(메시지)BidiSessionServerMessage(메시지)BigQueryExportSettings(메시지)Blob(메시지)Callback(메시지)Changelog(메시지)ChannelProfile(메시지)ChannelProfile.ChannelType(열거형)ChannelProfile.InstagramConfig(메시지)ChannelProfile.PersonaProperty(메시지)ChannelProfile.PersonaProperty.Persona(열거형)ChannelProfile.WebWidgetConfig(메시지)ChannelProfile.WebWidgetConfig.Modality(열거형)ChannelProfile.WebWidgetConfig.SecuritySettings(메시지)ChannelProfile.WebWidgetConfig.Theme(열거형)ChannelProfile.WhatsAppConfig(메시지)Chunk(메시지)Citations(메시지)Citations.CitedChunk(메시지)Citations.InlineCitation(메시지)ClientCertificateSettings(메시지)ClientFunction(메시지)CloudLoggingSettings(메시지)CodeBlock(메시지)ConnectorTool(메시지)ConnectorToolset(메시지)Conversation(메시지)Conversation.ChannelType(열거형)Conversation.InputType(열거형)Conversation.Source(열거형)Conversation.Turn(메시지)ConversationLoggingSettings(메시지)CreateAgentRequest(메시지)CreateAppRequest(메시지)CreateAppVersionRequest(메시지)CreateDeploymentRequest(메시지)CreateEvaluationDatasetRequest(메시지)CreateEvaluationExpectationRequest(메시지)CreateEvaluationRequest(메시지)CreateExampleRequest(메시지)CreateGuardrailRequest(메시지)CreateScheduledEvaluationRunRequest(메시지)CreateToolRequest(메시지)CreateToolsetRequest(메시지)CustomVoiceSample(메시지)CustomVoiceSample.VoiceInstructionMode(열거형)CustomVoiceSample.Warning(메시지)CustomVoiceSample.Warning.WarningType(열거형)DashboardSettings(메시지)DataStore(메시지)DataStore.ConnectorConfig(메시지)DataStore.DataStoreType(열거형)DataStore.DocumentProcessingMode(열거형)DataStoreSettings(메시지)DataStoreSettings.Engine(메시지)DataStoreSettings.Engine.Type(열거형)DataStoreTool(메시지)DataStoreTool.BoostSpec(메시지)DataStoreTool.BoostSpec.ConditionBoostSpec(메시지)DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec(메시지)DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.AttributeType(열거형)DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.ControlPoint(메시지)DataStoreTool.BoostSpec.ConditionBoostSpec.BoostControlSpec.InterpolationType(열거형)DataStoreTool.BoostSpecs(메시지)DataStoreTool.DataStoreSource(메시지)DataStoreTool.EngineSource(메시지)DataStoreTool.FilterParameterBehavior(열거형)DataStoreTool.GroundingConfig(메시지)DataStoreTool.ModalityConfig(메시지)DataStoreTool.ModalityConfig.ModalityType(열거형)DataStoreTool.RewriterConfig(메시지)DataStoreTool.SnippetsConfig(메시지)DataStoreTool.SummarizationConfig(메시지)DeleteAgentRequest(메시지)DeleteAppRequest(메시지)DeleteAppVersionRequest(메시지)DeleteConversationRequest(메시지)DeleteDeploymentRequest(메시지)DeleteEvaluationDatasetRequest(메시지)DeleteEvaluationExpectationRequest(메시지)DeleteEvaluationRequest(메시지)DeleteEvaluationResultRequest(메시지)DeleteEvaluationRunOperationMetadata(메시지)DeleteEvaluationRunRequest(메시지)DeleteExampleRequest(메시지)DeleteGuardrailRequest(메시지)DeleteScheduledEvaluationRunRequest(메시지)DeleteToolRequest(메시지)DeleteToolsetRequest(메시지)DeployChannelResponse(메시지)Deployment(메시지)Deployment.Modality(열거형)EndSession(메시지)EndUserAuthConfig(메시지)EndUserAuthConfig.Oauth2AuthCodeConfig(메시지)EndUserAuthConfig.Oauth2JwtBearerConfig(메시지)EndpointControlPolicy(메시지)EndpointControlPolicy.EnforcementScope(열거형)ErrorHandlingSettings(메시지)ErrorHandlingSettings.EndSessionConfig(메시지)ErrorHandlingSettings.ErrorHandlingStrategy(열거형)ErrorHandlingSettings.FallbackResponseConfig(메시지)Evaluation(메시지)Evaluation.Golden(메시지)Evaluation.GoldenExpectation(메시지)Evaluation.GoldenTurn(메시지)Evaluation.Scenario(메시지)Evaluation.Scenario.TaskCompletionBehavior(열거형)Evaluation.Scenario.UserFact(메시지)Evaluation.Scenario.UserGoalBehavior(열거형)Evaluation.ScenarioExpectation(메시지)Evaluation.ScenarioExpectation.ToolExpectation(메시지)Evaluation.Step(메시지)EvaluationConfig(메시지)EvaluationConfig.EvaluationChannel(열거형)EvaluationDataset(메시지)EvaluationErrorInfo(메시지)EvaluationErrorInfo.ErrorType(열거형)EvaluationExpectation(메시지)EvaluationExpectation.LlmCriteria(메시지)EvaluationMetricsConfig(메시지)EvaluationMetricsConfig.ComparisonType(열거형)EvaluationMetricsConfig.ExpectationsMetMetricsConfig(메시지)EvaluationMetricsConfig.GoldenMetricsConfig(메시지)EvaluationMetricsConfig.HallucinationMetricsConfig(메시지)EvaluationMetricsConfig.ScenarioMetricsConfig(메시지)EvaluationMetricsConfig.SemanticSimilarityMetricsConfig(메시지)EvaluationMetricsConfig.ToolCorrectnessMetricsConfig(메시지)EvaluationMetricsConfig.UserGoalMetMetricsConfig(메시지)EvaluationMetricsThresholds(메시지)EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds(메시지)EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.ExpectationLevelMetricsThresholds(메시지)EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds(메시지)EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds.SemanticSimilarityChannel(열거형)EvaluationMetricsThresholds.HallucinationMetricBehavior(열거형)EvaluationMetricsThresholds.ToolMatchingSettings(메시지)EvaluationMetricsThresholds.ToolMatchingSettings.ExtraToolCallBehavior(열거형)EvaluationPersona(메시지)EvaluationPersona.SpeechConfig(메시지)EvaluationPersona.SpeechConfig.BackgroundEnvironment(열거형)EvaluationResult(메시지)EvaluationResult.EvaluationExpectationResult(메시지)EvaluationResult.ExecutionState(열거형)EvaluationResult.GoldenExpectationOutcome(메시지)EvaluationResult.GoldenExpectationOutcome.ToolInvocationResult(메시지)EvaluationResult.GoldenResult(메시지)EvaluationResult.GoldenResult.TurnReplayResult(메시지)EvaluationResult.HallucinationResult(메시지)EvaluationResult.Outcome(열거형)EvaluationResult.OutcomeMetadata(열거형)EvaluationResult.OverallToolInvocationResult(메시지)EvaluationResult.ScenarioExpectationOutcome(메시지)EvaluationResult.ScenarioExpectationOutcome.ObservedToolCall(메시지)EvaluationResult.ScenarioResult(메시지)EvaluationResult.ScenarioRubricOutcome(메시지)EvaluationResult.SemanticSimilarityResult(메시지)EvaluationResult.SpanLatency(메시지)EvaluationResult.SpanLatency.Type(열거형)EvaluationResult.TaskCompletionResult(메시지)EvaluationResult.ToolCallLatency(메시지)EvaluationResult.UserGoalSatisfactionResult(메시지)EvaluationRun(메시지)EvaluationRun.EvaluationRunState(열거형)EvaluationRun.EvaluationRunSummary(메시지)EvaluationRun.EvaluationType(열거형)EvaluationRun.Progress(메시지)EvaluationRunCachingSettings(메시지)EvaluationRunCachingSettings.EvaluationRunCachingMode(열거형)EvaluationSettings(메시지)EvaluationSettings.ScenarioConversationInitiator(열거형)EvaluationSettings.ScenarioExecutionMode(열거형)EvaluationToolCallBehaviour(열거형)Event(메시지)Example(메시지)ExecuteToolRequest(메시지)ExecuteToolResponse(메시지)ExecutionType(열거형)ExperimentConfig(메시지)ExperimentConfig.State(열거형)ExperimentConfig.VersionRelease(메시지)ExperimentConfig.VersionRelease.TrafficAllocation(메시지)ExportAppRequest(메시지)ExportAppRequest.ExportFormat(열거형)ExportAppResponse(메시지)ExportEvaluationResultsOperationMetadata(메시지)ExportEvaluationResultsRequest(메시지)ExportEvaluationResultsResponse(메시지)ExportEvaluationRunsOperationMetadata(메시지)ExportEvaluationRunsRequest(메시지)ExportEvaluationRunsResponse(메시지)ExportEvaluationsRequest(메시지)ExportEvaluationsResponse(메시지)ExportOptions(메시지)ExportOptions.ExportFormat(열거형)ExpressionCondition(메시지)FileContext(메시지)FileContext.FileBytes(메시지)FileSearchTool(메시지)FileSearchTool.CorpusType(열거형)GenerateAppResourceOperationMetadata(메시지)GenerateAppResourceOperationMetadata.GenerationType(열거형)GenerateAppResourceRequest(메시지)GenerateAppResourceRequest.AppGenerationConfig(메시지)GenerateAppResourceRequest.AppVersionContext(메시지)GenerateAppResourceRequest.EvaluationGenerationConfig(메시지)GenerateAppResourceRequest.EvaluationPersonasGenerationConfig(메시지)GenerateAppResourceRequest.HillClimbingFixConfig(메시지)GenerateAppResourceRequest.QualityReportGenerationConfig(메시지)GenerateAppResourceRequest.QualityReportGenerationConfig.LossAttributionAlgorithm(열거형)GenerateAppResourceRequest.RefineInstructions(메시지)GenerateAppResourceRequest.ToolGenerationConfig(메시지)GenerateAppResourceRequest.ToolGenerationConfig.OpenApiToolsetGenerationConfig(메시지)GenerateAppResourceRequest.ToolGenerationConfig.OpenApiToolsetGenerationConfig.OperationGenerationConfig(메시지)GenerateAppResourceResponse(메시지)GenerateAppResourceResponse.AppResources(메시지)GenerateAppResourceResponse.Evaluations(메시지)GenerateAppResourceResponse.GenerateResultInfo(메시지)GenerateAppResourceResponse.Tools(메시지)GenerateChatTokenRequest(메시지)GenerateChatTokenResponse(메시지)GenerateEvaluationOperationMetadata(메시지)GenerateEvaluationRequest(메시지)GenerateEvaluationRequest.EvaluationType(열거형)GetAgentRequest(메시지)GetAppRequest(메시지)GetAppVersionRequest(메시지)GetChangelogRequest(메시지)GetConversationRequest(메시지)GetDeploymentRequest(메시지)GetEvaluationDatasetRequest(메시지)GetEvaluationExpectationRequest(메시지)GetEvaluationRequest(메시지)GetEvaluationResultRequest(메시지)GetEvaluationRunRequest(메시지)GetExampleRequest(메시지)GetGuardrailRequest(메시지)GetScheduledEvaluationRunRequest(메시지)GetSecuritySettingsRequest(메시지)GetToolRequest(메시지)GetToolsetRequest(메시지)GoAway(메시지)GoldenRunMethod(열거형)GoogleSearchSuggestions(메시지)GoogleSearchTool(메시지)GoogleSearchTool.PromptConfig(메시지)Guardrail(메시지)Guardrail.CodeCallback(메시지)Guardrail.ContentFilter(메시지)Guardrail.ContentFilter.MatchType(열거형)Guardrail.LlmPolicy(메시지)Guardrail.LlmPolicy.PolicyScope(열거형)Guardrail.LlmPromptSecurity(메시지)Guardrail.LlmPromptSecurity.DefaultSecuritySettings(메시지)Guardrail.ModelSafety(메시지)Guardrail.ModelSafety.HarmBlockThreshold(열거형)Guardrail.ModelSafety.HarmCategory(열거형)Guardrail.ModelSafety.SafetySetting(메시지)Guardrail.Supervisor(메시지)Guardrail.Supervisor.DetectionMode(열거형)Guardrail.Supervisor.Type(열거형)Image(메시지)ImportAppRequest(메시지)ImportAppRequest.ImportOptions(메시지)ImportAppRequest.ImportOptions.ConflictResolutionStrategy(열거형)ImportAppResponse(메시지)ImportEvaluationsOperationMetadata(메시지)ImportEvaluationsRequest(메시지)ImportEvaluationsRequest.ConversationList(메시지)ImportEvaluationsRequest.ImportOptions(메시지)ImportEvaluationsRequest.ImportOptions.ConflictResolutionStrategy(열거형)ImportEvaluationsResponse(메시지)InputAudioConfig(메시지)InstagramCredentials(메시지)InterruptionSignal(메시지)LanguageSettings(메시지)LatencyReport(메시지)LatencyReport.CallbackLatency(메시지)LatencyReport.GuardrailLatency(메시지)LatencyReport.LatencyMetrics(메시지)LatencyReport.LlmCallLatency(메시지)LatencyReport.ToolLatency(메시지)ListAgentsRequest(메시지)ListAgentsResponse(메시지)ListAppVersionsRequest(메시지)ListAppVersionsResponse(메시지)ListAppsRequest(메시지)ListAppsResponse(메시지)ListChangelogsRequest(메시지)ListChangelogsResponse(메시지)ListConversationsRequest(메시지)ListConversationsResponse(메시지)ListDeploymentsRequest(메시지)ListDeploymentsResponse(메시지)ListEvaluationDatasetsRequest(메시지)ListEvaluationDatasetsResponse(메시지)ListEvaluationExpectationsRequest(메시지)ListEvaluationExpectationsResponse(메시지)ListEvaluationResultsRequest(메시지)ListEvaluationResultsResponse(메시지)ListEvaluationRunsRequest(메시지)ListEvaluationRunsResponse(메시지)ListEvaluationsRequest(메시지)ListEvaluationsResponse(메시지)ListExamplesRequest(메시지)ListExamplesResponse(메시지)ListGuardrailsRequest(메시지)ListGuardrailsResponse(메시지)ListScheduledEvaluationRunsRequest(메시지)ListScheduledEvaluationRunsResponse(메시지)ListToolsRequest(메시지)ListToolsResponse(메시지)ListToolsetsRequest(메시지)ListToolsetsResponse(메시지)LoggingSettings(메시지)McpTool(메시지)McpTool.State(열거형)McpToolDefinition(메시지)McpToolOverride(메시지)McpToolset(메시지)Message(메시지)MetricAnalysisSettings(메시지)MockConfig(메시지)MockConfig.UnmatchedToolCallBehavior(열거형)MockedToolCall(메시지)ModelSettings(메시지)ModelSettings.ThinkingLevel(열거형)OAuthConfig(메시지)OAuthConfig.OauthGrantType(열거형)OpenApiTool(메시지)OpenApiToolset(메시지)OperationMetadata(메시지)OptimizationConfig(메시지)OptimizationConfig.OptimizationStatus(열거형)OutputAudioConfig(메시지)PersonaRunConfig(메시지)PythonCodeCondition(메시지)PythonFunction(메시지)QualityReport(메시지)QualityReport.AgentIssues(메시지)QualityReport.Issue(메시지)RecognitionResult(메시지)RedactionConfig(메시지)RemoteA2aConfig(메시지)RemoteAgentTool(메시지)RestoreAppVersionRequest(메시지)RestoreAppVersionResponse(메시지)RetrieveToolSchemaRequest(메시지)RetrieveToolSchemaResponse(메시지)RetrieveToolsRequest(메시지)RetrieveToolsResponse(메시지)RunEvaluationOperationMetadata(메시지)RunEvaluationRequest(메시지)RunEvaluationResponse(메시지)RunEvaluationResultMetricsOperationMetadata(메시지)RunEvaluationResultMetricsRequest(메시지)RunEvaluationResultMetricsResponse(메시지)RunSessionRequest(메시지)RunSessionResponse(메시지)ScheduledEvaluationRun(메시지)ScheduledEvaluationRun.SchedulingConfig(메시지)ScheduledEvaluationRun.SchedulingConfig.Frequency(열거형)Schema(메시지)Schema.Type(열거형)SecuritySettings(메시지)ServiceAccountAuthConfig(메시지)ServiceAgentIdTokenAuthConfig(메시지)ServiceDirectoryConfig(메시지)SessionConfig(메시지)SessionConfig.RemoteDialogflowQueryParameters(메시지)SessionInput(메시지)SessionOutput(메시지)SessionOutput.DiagnosticInfo(메시지)Span(메시지)SynthesizeSpeechConfig(메시지)SystemTool(메시지)TestPersonaVoiceRequest(메시지)TestPersonaVoiceResponse(메시지)TimeZoneSettings(메시지)TlsConfig(메시지)TlsConfig.CaCert(메시지)Tool(메시지)ToolCall(메시지)ToolCalls(메시지)ToolFakeConfig(메시지)ToolResponse(메시지)ToolResponses(메시지)Toolset(메시지)ToolsetTool(메시지)TransferRule(메시지)TransferRule.DeterministicTransfer(메시지)TransferRule.Direction(열거형)TransferRule.DisablePlannerTransfer(메시지)TriggerAction(메시지)TriggerAction.GenerativeAnswer(메시지)TriggerAction.RespondImmediately(메시지)TriggerAction.Response(메시지)TriggerAction.TransferAgent(메시지)UpdateAgentRequest(메시지)UpdateAppRequest(메시지)UpdateAppVersionRequest(메시지)UpdateDeploymentRequest(메시지)UpdateEvaluationDatasetRequest(메시지)UpdateEvaluationExpectationRequest(메시지)UpdateEvaluationRequest(메시지)UpdateExampleRequest(메시지)UpdateGuardrailRequest(메시지)UpdateScheduledEvaluationRunRequest(메시지)UpdateSecuritySettingsRequest(메시지)UpdateToolRequest(메시지)UpdateToolsetRequest(메시지)UploadEvaluationAudioRequest(메시지)UploadEvaluationAudioResponse(메시지)VpcScSettings(메시지)WebSearchQuery(메시지)WhatsAppCredentials(메시지)WidgetTool(메시지)WidgetTool.DataMapping(메시지)WidgetTool.DataMapping.Mode(열거형)WidgetTool.TextResponseConfig(메시지)WidgetTool.TextResponseConfig.Type(열거형)WidgetTool.WidgetType(열거형)
AgentService
Gemini Enterprise for Customer Engagement (CES)에서 에이전트 관련 리소스를 관리하는 서비스입니다.
| BatchDeleteConversations |
|---|
|
지정된 대화를 일괄 삭제합니다.
|
| 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 |
|---|
|
지정된 도구 모음을 업데이트합니다.
|
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 버킷에 오디오를 저장하고 스크립트를 반환합니다.
|
SessionService
세션 서비스는 CES 에이전트와 상호작용하기 위한 API를 제공합니다.
| BidiRunSession |
|---|
|
CES 에이전트와의 양방향 스트리밍 연결을 설정합니다. 에이전트는 지속적인 멀티모달 입력 (예: 텍스트, 오디오)을 처리하고 실시간 멀티모달 출력 스트림을 생성합니다. --- 클라이언트 요청 스트림 --- 클라이언트는 다음 순서로 요청을 스트리밍합니다.
--- 서버 응답 스트림 --- 각 상호작용 차례에서 에이전트는 다음 순서로 메시지를 스트리밍합니다.
--- 오디오 권장사항 --- 1. 스트리밍: 무음 구간에서도
|
| RunSession |
|---|
|
세션 내에서 CES 에이전트와의 단일 턴 상호작용을 시작합니다.
|
| StreamRunSession |
|---|
|
CES 에이전트와의 단일 턴 상호작용을 시작합니다. 서버 측 스트리밍을 사용하여 점진적인 결과와 부분 응답을 생성되는 대로 제공합니다. 기본적으로 완전한 응답 (예: 콜백의 메시지 또는 완전한 LLM 응답)은 제공되는 즉시 클라이언트로 전송됩니다. 모델에서 개별 텍스트 청크를 직접 스트리밍하려면
|
ToolService
도구 서비스는 CES 도구와 상호작용하기 위한 API를 제공합니다.
| ExecuteTool |
|---|
|
지정된 인수를 사용하여 지정된 도구를 실행합니다.
|
| RetrieveToolSchema |
|---|
|
지정된 도구의 스키마를 가져옵니다. 스키마는 지정된 도구 인스턴스에 대해 즉석에서 계산됩니다.
|
| RetrieveTools |
|---|
|
지정된 도구 모음에 포함된 도구 목록을 가져옵니다.
|
WidgetService
위젯이 CES API와 상호작용할 수 있는 API를 제공합니다.
| GenerateChatToken |
|---|
|
세션 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 |
작업 가져오기 |
CREATE |
작업 생성 |
UPDATE |
업데이트 작업입니다. |
DELETE |
삭제 작업입니다. |
에이전트
에이전트는 특정 작업을 실행하기 위해 대규모 언어 모델 (LLM)에 명령어를 제공하는 기본 구성요소 역할을 합니다.
| 필드 | |
|---|---|
name |
식별자. 에이전트의 고유 식별자입니다. 형식: |
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 에이전트가 앱과 다른 프로젝트에 있는 경우 CES 서비스 에이전트 |
remote_a2a_agent |
(선택사항) 에이전트 실행에 사용할 원격 A2A 에이전트입니다. |
AgentToolset
선택된 도구가 포함된 도구 세트입니다.
| 필드 | |
|---|---|
toolset |
필수 항목입니다. 툴셋의 리소스 이름입니다. 형식: |
tool_ids[] |
(선택사항) 툴셋을 필터링할 도구 ID입니다. |
LlmAgent
이 유형에는 필드가 없습니다.
기본 에이전트 유형입니다. 에이전트는 에이전트에 지정된 요청 사항과 콜백을 사용하여 대규모 언어 모델을 통해 작업을 실행합니다.
RemoteA2aAgent
실행을 원격 A2A 에이전트로 트랜스퍼하는 에이전트입니다.
| 필드 | |
|---|---|
a2a_config |
필수 항목입니다. A2A 연결 구성입니다. |
RemoteDialogflowAgent
실행을 원격 Dialogflow CX 에이전트로 트랜스퍼할 에이전트입니다. 세션이 종료되거나 흐름이 종료되고 제어 권한이 상위 CES 에이전트에게 다시 이전될 때까지 Dialogflow 에이전트가 후속 사용자 쿼리를 처리합니다.
| 필드 | |
|---|---|
agent |
필수 항목입니다. Dialogflow 에이전트 리소스 이름입니다. 형식: |
flow_id |
(선택사항) Dialogflow 에이전트의 흐름 ID입니다. |
environment_id |
(선택사항) 에이전트 실행에 사용할 Dialogflow 에이전트의 환경 ID입니다. 지정하지 않으면 초안 환경이 사용됩니다. |
input_variable_mapping |
(선택사항) Dialogflow 에이전트에 입력으로 전송될 앱 변수 이름과 Dialogflow 세션 매개변수 이름의 매핑입니다. |
output_variable_mapping |
(선택사항) Dialogflow 에이전트 실행이 종료된 후 CES 에이전트로 다시 전송될 Dialogflow 세션 매개변수 이름과 앱 변수 이름의 매핑입니다. |
respect_response_interruption_settings |
(선택사항) Dialogflow 에이전트에서 구성된 메시지 수준 인터럽션 설정을 준수할지 여부를 나타냅니다.
|
language_code_variable |
(선택사항) Dialogflow 세션에 사용할 언어 코드가 포함된 변수의 이름입니다. 지정하지 않으면 Dialogflow 에이전트의 기본 언어 코드가 사용됩니다. |
AgentCard
AgentCard는 원격 에이전트에 관한 주요 정보를 전달합니다. A2A 프로토콜 https://a2a-protocol.org/dev/specification/#441-agentcard에 정의된 AgentCard의 트리밍된 버전입니다.
| 필드 | |
|---|---|
name |
필수 항목입니다. 인간이 읽을 수 있는 에이전트의 이름입니다. |
description |
필수 항목입니다. 에이전트의 작업 도메인/솔루션 공간에 대한 설명입니다. |
supported_interfaces[] |
필수 항목입니다. 지원되는 인터페이스의 순서가 지정된 목록입니다. 첫 번째 항목이 선호됩니다. |
version |
필수 항목입니다. 에이전트 버전입니다. |
skills[] |
필수 항목입니다. 스킬은 상담사가 수행할 수 있는 능력의 단위를 나타냅니다. 다소 추상적일 수 있지만 에이전트가 성공할 가능성이 높은 더 집중적인 작업 집합을 나타냅니다. |
AgentInterface
에이전트와 상호작용하기 위한 대상 URL, 전송, 프로토콜 버전의 조합을 선언합니다. 이를 통해 에이전트는 여러 프로토콜 바인딩 메커니즘을 통해 동일한 기능을 노출할 수 있습니다.
| 필드 | |
|---|---|
url |
필수 항목입니다. 이 인터페이스를 사용할 수 있는 URL입니다. 프로덕션에서는 유효한 절대 HTTPS URL이어야 합니다. 예: 'https://api.example.com/a2a/v1', 'https://grpc.example.com/a2a' |
protocol_binding |
필수 항목입니다. 이 URL에서 지원되는 프로토콜 바인딩입니다. 이는 다른 프로토콜 바인딩을 위해 쉽게 확장할 수 있는 개방형 양식 문자열입니다. 공식적으로 지원되는 핵심은 |
tenant |
상담사를 호출할 때 요청에 사용할 테넌트 ID입니다. |
protocol_version |
필수 항목입니다. 이 인터페이스가 노출하는 A2A 프로토콜의 버전입니다. 메이저 버전별로 지원되는 최신 마이너 버전을 사용합니다. 예: '0.3', '1.0' |
AgentRegistryDeployment
에이전트 레지스트리 배포의 구성 및 상태입니다.
| 필드 | |
|---|---|
agent_registry_service_name |
(선택사항) 출력 전용입니다. 배포된 Agent Registry 서비스의 리소스 이름입니다. 형식: |
AgentSkill
에이전트가 실행할 수 있는 고유한 기능 또는 함수를 나타냅니다.
| 필드 | |
|---|---|
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 |
(선택사항) 주변 소음으로 지원되는 일반 네이티브 볼륨의 볼륨 게인 (dB)입니다. 범위는 [-96.0, 16.0]입니다. 값을 설정하지 않거나 0.0(dB)으로 설정하면 일반적인 기본 신호 진폭에서 재생됩니다. 값이 -6.0(dB)이면 일반적인 기본 신호 진폭의 약 절반에서 재생됩니다. 값이 +6.0(dB)이면 일반적인 기본 신호 진폭의 약 두 배에서 재생됩니다. +10(dB)을 초과하는 값을 사용하지 않는 것이 좋습니다. 값이 +10을 초과하면 일반적으로 소리가 커지는 효과가 없기 때문입니다. |
통합 필드 source. 합성된 에이전트 응답과 함께 재생되어 대화의 자연스러움을 향상시키는 주변 소음입니다. source은 다음 중 하나여야 합니다. |
|
prebuilt_ambient_noise |
(선택사항) 지원 중단됨: |
gcs_uri |
(선택사항) Cloud Storage에 저장된 모노 채널, 16kHz 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 |
(선택사항) Bearer 토큰 인증 구성입니다. |
ApiKeyConfig
API 키를 사용한 인증 구성입니다.
| 필드 | |
|---|---|
key_name |
필수 항목입니다. API 키의 매개변수 이름 또는 헤더 이름입니다. 예: API 요청이 'https://example.com/act?X-Api-Key= |
api_key_secret_version |
필수 항목입니다. API 키를 저장하는 SecretManager 보안 비밀 버전 리소스의 이름입니다. 형식: 참고: CES 서비스 에이전트 |
request_location |
필수 항목입니다. 요청의 키 위치입니다. |
RequestLocation
요청에서 API 키의 위치입니다.
| 열거형 | |
|---|---|
REQUEST_LOCATION_UNSPECIFIED |
지정되지 않음. 이 값을 사용하면 안 됩니다. |
HEADER |
HTTP 헤더의 키를 나타냅니다. |
QUERY_STRING |
쿼리 문자열의 키를 나타냅니다. |
앱
앱은 루트 에이전트와 하위 에이전트, 관련 구성을 포함한 에이전트 그룹의 최상위 컨테이너 역할을 합니다. 이러한 에이전트는 앱 컨텍스트 내에서 특정 목표를 달성하기 위해 함께 작동합니다.
| 필드 | |
|---|---|
name |
식별자. 앱의 고유 식별자입니다. 형식: |
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 |
(선택사항) 앱의 모든 에이전트에 대한 안내입니다. 이 안내를 사용하여 모든 에이전트에서 안정적인 ID 또는 페르소나를 설정할 수 있습니다. |
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 |
(선택사항) 고객센터 통계 대시보드를 연결하고 구성하기 위한 앱별 대시보드 설정입니다. |
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 |
식별자. 앱 버전의 고유 식별자입니다. 형식: |
display_name |
(선택사항) 앱 버전의 표시 이름입니다. |
description |
(선택사항) 앱 버전의 설명입니다. |
creator |
출력 전용입니다. 앱 버전을 만든 사용자의 이메일입니다. |
create_time |
출력 전용입니다. 앱 버전이 생성된 타임스탬프입니다. |
update_time |
출력 전용입니다. 앱 버전이 마지막으로 업데이트된 타임스탬프입니다. |
snapshot |
출력 전용입니다. 버전이 생성될 때의 앱 스냅샷입니다. |
etag |
출력 전용입니다. 읽기-수정-쓰기 작업 중에 객체가 변경되지 않았는지 확인하는 데 사용되는 Etag입니다. etag가 비어 있으면 업데이트가 동시에 이루어진 변경사항을 덮어씁니다. |
AudioEncoding
AudioEncoding은 오디오 데이터의 인코딩 형식을 지정합니다.
| 열거형 | |
|---|---|
AUDIO_ENCODING_UNSPECIFIED |
지정되지 않은 오디오 인코딩입니다. |
LINEAR16 |
16비트 선형 PCM 오디오 인코딩입니다. |
MULAW |
G.711 PCMU/mu-law를 사용하여 14비트 오디오 샘플을 압축하는 8비트 샘플입니다. |
ALAW |
G.711 PCMU/A-law를 사용하여 14비트 오디오 샘플을 압축하는 8비트 샘플 |
AudioProcessingConfig
입력 및 출력 오디오가 처리되고 전송되는 방식에 관한 구성입니다.
| 필드 | |
|---|---|
synthesize_speech_configs |
(선택사항) 에이전트 응답이 합성되는 방식을 구성합니다. 언어 코드에서 지정된 언어 코드의 구성이 없으면 루트 언어 코드의 구성이 사용됩니다. 예를 들어 지도에 'en-us'와 'en'이 포함되어 있고 지정된 언어 코드가 'en-gb'이면 'en' 구성이 사용됩니다. 참고: 언어 코드는 대소문자를 구분하지 않습니다. |
barge_in_config |
(선택사항) 사용자 끼어들기 활동에 대한 에이전트 동작을 구성합니다. |
inactivity_timeout |
(선택사항) 상담사가 사용자에게 재참여를 요청하기 전까지 사용자가 비활성 상태 (음성 또는 상호작용 없음)로 있는 시간입니다. 설정하지 않으면 상담사가 사용자에게 재참여를 요청하지 않습니다. |
ambient_sound_config |
(선택사항) 합성된 에이전트 응답과 함께 재생되는 주변 소리의 구성으로, 대화의 자연스러움을 향상합니다. |
custom_voice_samples[] |
(선택사항) 음성 복제를 위한 맞춤 음성 샘플을 구성합니다. |
AudioRecordingConfig
오디오 상호작용을 녹음하는 방법에 관한 구성입니다.
| 필드 | |
|---|---|
gcs_bucket |
(선택사항) 세션 오디오 녹음 파일을 저장할 Cloud Storage 버킷입니다. URI는 'gs://'로 시작해야 합니다. 데이터 레지던시 요구사항을 충족하는 버킷 위치를 선택하세요. 참고: Cloud Storage 버킷이 앱과 다른 프로젝트에 있는 경우 CES 서비스 에이전트 |
gcs_path_prefix |
(선택사항) 오디오 녹음 파일의 Cloud Storage 경로 접두사입니다. 이 접두사에는 게재 시 동적으로 대체되는 다음 자리표시자가 포함될 수 있습니다. - $project: 프로젝트 ID - $location: 앱 위치 - $app: 앱 ID - $date: YYYY-MM-DD 형식의 세션 날짜 - $session: 세션 ID 경로 접두사를 지정하지 않으면 기본 접두사 |
BargeInConfig
사용자 끼어들기 활동을 처리하는 방법에 관한 구성입니다.
| 필드 | |
|---|---|
disable_barge_in |
(선택사항) 지원 중단됨: ChannelProfile에서 상담사가 말하는 동안 사용자의 끼어들기를 사용 중지합니다. true인 경우 에이전트 응답 재생 중 사용자 입력이 무시됩니다. |
barge_in_awareness |
(선택사항) 이 기능을 사용 설정하면 상담사는 사용자가 이전 상담사의 메시지를 완전히 듣지 못했다는 가정에 따라 다음 응답을 조정합니다. 상담사 응답이 시각적으로 표시되는 시나리오에서는 사용하면 안 됩니다. |
BatchDeleteConversationsRequest
AgentService.BatchDeleteConversations에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
parent |
필수 항목입니다. 대화를 삭제할 앱의 리소스 이름입니다. 형식: |
conversations[] |
필수 항목입니다. 삭제할 대화의 리소스 이름입니다. |
BatchDeleteConversationsResponse
AgentService.BatchDeleteConversations의 응답 메시지입니다.
| 필드 | |
|---|---|
deleted_conversations[] |
삭제된 대화 목록입니다. |
failed_conversations[] |
삭제에 실패한 대화 목록입니다. |
error_messages[] |
(선택사항) 삭제되지 않은 대화와 관련된 오류 메시지 목록입니다. |
BearerTokenConfig
Bearer 토큰을 사용한 인증 구성입니다.
| 필드 | |
|---|---|
token |
필수 항목입니다. Bearer 토큰입니다. |
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 내보내기가 사용 설정되어 있는지 여부를 나타냅니다. |
project |
(선택사항) 데이터를 내보낼 BigQuery 데이터 세트의 프로젝트 ID입니다. 참고: BigQuery 데이터 세트가 앱과 다른 프로젝트에 있는 경우 CES 서비스 에이전트 |
dataset |
(선택사항) 데이터를 내보낼 BigQuery 데이터 세트 ID입니다. |
blob
대화의 blob 입력 또는 출력을 나타냅니다.
| 필드 | |
|---|---|
mime_type |
필수 항목입니다. 소스 데이터의 IANA 표준 MIME 유형입니다. |
data |
필수 항목입니다. blob의 원시 바이트입니다. |
콜백
콜백은 에이전트 상호작용의 다양한 단계에서 실행할 맞춤 로직을 정의합니다.
| 필드 | |
|---|---|
description |
(선택사항) 콜백에 대한 인간이 읽을 수 있는 설명입니다. |
disabled |
(선택사항) 콜백이 사용 중지되었는지 여부입니다. 사용 중지된 콜백은 에이전트에서 무시됩니다. |
proactive_execution_enabled |
(선택사항) 사용 설정된 경우 콜백은 중간 모델 출력에서도 실행됩니다. 이 설정은 모델 콜백 후에만 영향을 미칩니다. 주의해서 사용 설정하세요. 일반적으로 모델 콜백은 모든 모델 응답을 받은 후에만 실행하면 됩니다. 사전 실행을 사용 설정하면 실행 비용과 지연 시간에 부정적인 영향을 미칠 수 있으므로 드문 경우에만 사용 설정해야 합니다. |
통합 필드 callback. 실행할 콜백입니다. callback은 다음 중 하나여야 합니다. |
|
python_code |
필수 항목입니다. 콜백에 대해 실행할 Python 코드입니다. |
변경 로그
변경사항은 앱 또는 앱 내 리소스에 적용된 변경사항을 나타냅니다.
| 필드 | |
|---|---|
name |
식별자. 변경사항 로그의 고유 식별자입니다. 형식: |
author |
출력 전용입니다. 변경 작성자의 이메일 주소입니다. |
display_name |
출력 전용입니다. 변경사항의 표시 이름입니다. 일반적으로 변경된 리소스의 표시 이름이어야 합니다. |
description |
출력 전용입니다. 변경사항에 대한 설명입니다. 일반적으로 리소스에서 변경된 필드를 캡처합니다. |
resource |
출력 전용입니다. 변경된 리소스입니다. |
resource_type |
출력 전용입니다. 변경된 리소스 유형입니다. |
action |
출력 전용입니다. 리소스에서 실행된 작업입니다. |
original_resource |
출력 전용입니다. 변경 전의 원래 리소스입니다. |
new_resource |
출력 전용입니다. 변경 후의 새 리소스입니다. |
dependent_resources[] |
출력 전용입니다. 변경된 종속 리소스입니다. |
create_time |
출력 전용입니다. 변경이 이루어진 시간입니다. |
sequence_number |
출력 전용입니다. 변경 로그의 단조 증가 시퀀스 번호입니다. |
ChannelProfile
ChannelProfile은 웹 UI 또는 전화 통신과 같은 특정 커뮤니케이션 채널의 에이전트 동작을 구성합니다.
| 필드 | |
|---|---|
profile_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 비즈니스 프로필 썸네일 URL입니다. |
description |
출력 전용입니다. Meta 비즈니스 페이지 또는 프로필의 설명입니다. |
PersonaProperty
채널의 페르소나 속성을 나타냅니다.
| 필드 | |
|---|---|
persona |
(선택사항) 채널의 페르소나입니다. |
페르소나
채널의 페르소나입니다.
| 열거형 | |
|---|---|
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 비즈니스 프로필 썸네일 URL입니다. |
description |
출력 전용입니다. Meta 비즈니스 페이지 또는 프로필의 설명입니다. |
Chunk
메시지 내 콘텐츠 청크입니다.
| 필드 | |
|---|---|
통합 필드 data. 청크 데이터입니다. data은 다음 중 하나여야 합니다. |
|
text |
(선택사항) 텍스트 데이터. |
transcript |
(선택사항) 오디오와 연결된 스크립트입니다. |
blob |
(선택사항) BLOB 데이터입니다. |
payload |
(선택사항) 맞춤 페이로드 데이터입니다. |
image |
(선택사항) 이미지 데이터입니다. |
tool_call |
(선택사항) 도구 실행 요청입니다. |
tool_response |
(선택사항) 도구 실행 응답입니다. |
agent_transfer |
(선택사항) 상담사 트랜스퍼 이벤트입니다. |
updated_variables |
구조체는 대화에서 업데이트된 변수를 나타내며 변수 이름으로 키가 지정됩니다. |
default_variables |
구조체는 대화 시작 시 기본 변수를 나타내며 변수 이름으로 키가 지정됩니다. |
인용
에이전트 응답과 연결된 인용입니다.
| 필드 | |
|---|---|
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 |
필수 항목입니다. PEM 형식으로 인코딩된 비공개 키를 저장하는 SecretManager 보안 비밀 버전 리소스의 이름입니다. 형식: |
passphrase |
(선택사항) 비공개 키를 복호화하는 암호를 저장하는 SecretManager 보안 비밀 버전 리소스의 이름입니다. 비공개 키가 암호화되지 않은 경우 설정되지 않은 상태로 두어야 합니다. 형식: |
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 Connection의 전체 리소스 이름입니다. 형식: |
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 Connection의 전체 리소스 이름입니다. 형식: |
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 |
식별자. 대화의 고유 식별자입니다. 형식: |
start_time |
출력 전용입니다. 대화가 생성된 타임스탬프입니다. |
end_time |
출력 전용입니다. 대화가 완료된 시점의 타임스탬프입니다. |
turns[] |
필수 항목입니다. 대화의 턴입니다. |
turn_count |
출력 전용입니다. 대화의 차례 수입니다. |
channel_type |
DEPRECATED. 대신 |
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
| 필드 | |
|---|---|
parent |
필수 항목입니다. 에이전트를 만들 앱의 리소스 이름입니다. |
agent_id |
(선택사항) 상담사에 사용할 ID이며, 상담사 리소스 이름의 마지막 구성요소가 됩니다. 제공되지 않으면 에이전트에 고유 ID가 자동으로 할당됩니다. |
agent |
필수 항목입니다. 만들 에이전트입니다. |
CreateAppRequest
AgentService.CreateApp에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
parent |
필수 항목입니다. 앱을 만들 위치의 리소스 이름입니다. |
app_id |
(선택사항) 앱에 사용할 ID이며, 앱의 리소스 이름에서 마지막 구성요소가 됩니다. 제공되지 않으면 앱에 고유 ID가 자동으로 할당됩니다. |
app |
필수 항목입니다. 만들 앱입니다. |
CreateAppVersionRequest
AgentService.CreateAppVersion의 요청 메시지
| 필드 | |
|---|---|
parent |
필수 항목입니다. 앱 버전을 만들 앱의 리소스 이름입니다. |
app_version_id |
(선택사항) 앱 버전에 사용할 ID이며, 앱 버전의 리소스 이름에서 마지막 구성요소가 됩니다. 제공되지 않으면 앱 버전에 고유 ID가 자동으로 할당됩니다. |
app_version |
필수 항목입니다. 만들 앱 버전입니다. |
CreateDeploymentRequest
AgentService.CreateDeployment에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
parent |
필수 항목입니다. 상위 앱입니다. 형식: |
deployment_id |
(선택사항) 배포에 사용할 ID이며, 배포의 리소스 이름에서 마지막 구성요소가 됩니다. 제공되지 않으면 배포에 고유 ID가 자동으로 할당됩니다. |
deployment |
필수 항목입니다. 생성할 배포입니다. |
CreateEvaluationDatasetRequest
EvaluationService.CreateEvaluationDataset에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
parent |
필수 항목입니다. 평가를 생성할 앱입니다. 형식: |
evaluation_dataset_id |
(선택사항) 평가 데이터 세트에 사용할 ID이며, 평가 데이터 세트의 리소스 이름에서 마지막 구성요소가 됩니다. 제공되지 않으면 평가를 위해 고유 ID가 자동으로 할당됩니다. |
evaluation_dataset |
필수 항목입니다. 생성할 평가 데이터 세트입니다. |
CreateEvaluationExpectationRequest
EvaluationService.CreateEvaluationExpectation에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
parent |
필수 항목입니다. 평가 기대치를 생성할 앱입니다. 형식: |
evaluation_expectation_id |
(선택사항) 평가 기대치에 사용할 ID이며, 평가 기대치의 리소스 이름에서 마지막 구성요소가 됩니다. 제공되지 않으면 평가 기대치에 고유 ID가 자동으로 할당됩니다. |
evaluation_expectation |
필수 항목입니다. 생성할 평가 기대치입니다. |
CreateEvaluationRequest
EvaluationService.CreateEvaluation에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
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
EvaluationService.CreateScheduledEvaluationRun에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
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 |
(선택사항) 맞춤 음성의 미리보기 오디오를 합성하기 위한 텍스트입니다. |
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 |
음성 샘플의 오디오 레벨이 너무 낮습니다 (예: RMS 진폭이 낮음). |
DashboardSettings
모니터링 보기에 표시되는 앱과 연결된 대시보드의 설정입니다.
| 필드 | |
|---|---|
default_dashboard |
(선택사항) 앱과 연결된 기본 고객센터 통계 대시보드의 리소스 이름입니다. 사용자가 앱의 모니터링 보기로 이동할 때 표시되는 대시보드입니다. 형식: |
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 |
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 |
최신성 사용 사례의 경우 속성 값은 현재 시간과 지정된 datetime 필드의 날짜 사이의 기간입니다. 값은 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 |
구간별 선형 보간이 적용됩니다. |
BoostSpecs
특정 문서를 부스팅하는 부스트 사양입니다. 자세한 내용은 https://cloud.google.com/generative-ai-app-builder/docs/boosting을 참고하세요.
| 필드 | |
|---|---|
data_stores[] |
필수 항목입니다. 부스팅 구성이 적용되는 데이터 스토어입니다. DataStore의 전체 리소스 이름입니다(예: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}). |
spec[] |
필수 항목입니다. 부스팅 사양 목록입니다. |
DataStoreSource
특정 데이터 스토어 내에서 검색하기 위한 구성입니다.
| 필드 | |
|---|---|
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
AgentService.DeleteAppVersion에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
name |
필수 항목입니다. 삭제할 앱 버전의 리소스 이름입니다. |
etag |
(선택사항) 앱 버전의 현재 ETag입니다. etag가 제공되지 않으면 삭제로 인해 동시에 발생한 변경사항이 덮어쓰여집니다. ETag가 제공되었으나 앱 버전의 현재 ETag와 일치하지 않으면 삭제가 차단되고 ABORTED 오류가 반환됩니다. |
DeleteConversationRequest
AgentService.DeleteConversation에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
name |
필수 항목입니다. 삭제할 대화의 리소스 이름입니다. |
source |
(선택사항) 대화의 소스를 표시합니다. 설정하지 않으면 Source.Live가 기본적으로 적용됩니다. |
DeleteDeploymentRequest
AgentService.DeleteDeployment에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
name |
필수 항목입니다. 삭제할 배포의 이름입니다. 형식: |
etag |
(선택사항) 배포의 etag입니다. ETag가 제공되었으나 배포의 현재 ETag와 일치하지 않으면 삭제가 차단되고 ABORTED 오류가 반환됩니다. |
DeleteEvaluationDatasetRequest
EvaluationService.DeleteEvaluationDataset에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
name |
필수 항목입니다. 삭제할 평가 데이터 세트의 리소스 이름입니다. |
etag |
(선택사항) 평가 데이터 세트의 현재 ETag입니다. etag가 제공되지 않으면 삭제로 인해 동시에 발생한 변경사항이 덮어쓰여집니다. ETag가 제공되었으나 평가 데이터 세트의 현재 ETag와 일치하지 않으면 삭제가 차단되고 ABORTED 오류가 반환됩니다. |
DeleteEvaluationExpectationRequest
EvaluationService.DeleteEvaluationExpectation에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
name |
필수 항목입니다. 삭제할 평가 기대치의 리소스 이름입니다. |
etag |
(선택사항) 평가 기대치의 현재 ETag입니다. etag가 제공되지 않으면 삭제로 인해 동시에 발생한 변경사항이 덮어쓰여집니다. ETag가 제공되었으나 평가 기대치의 현재 ETag와 일치하지 않으면 삭제가 차단되고 ABORTED 오류가 반환됩니다. |
DeleteEvaluationRequest
EvaluationService.DeleteEvaluation에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
name |
필수 항목입니다. 삭제할 평가의 리소스 이름입니다. |
force |
(선택사항) 평가 데이터 세트에서 여전히 참조되더라도 평가를 강제로 삭제할지 여부를 나타냅니다.
|
etag |
(선택사항) 평가의 현재 ETag입니다. etag가 제공되지 않으면 삭제로 인해 동시에 발생한 변경사항이 덮어쓰여집니다. ETag가 제공되었으나 평가의 현재 ETag와 일치하지 않으면 삭제가 차단되고 ABORTED 오류가 반환됩니다. |
DeleteEvaluationResultRequest
EvaluationService.DeleteEvaluationResult에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
name |
필수 항목입니다. 삭제할 평가 결과의 리소스 이름입니다. |
DeleteEvaluationRunOperationMetadata
이 유형에는 필드가 없습니다.
EvaluationService.DeleteEvaluationRun의 작업 메타데이터입니다.
DeleteEvaluationRunRequest
EvaluationService.DeleteEvaluationRun에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
name |
필수 항목입니다. 삭제할 평가 실행의 리소스 이름입니다. |
DeleteExampleRequest
AgentService.DeleteExample에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
name |
필수 항목입니다. 삭제할 예의 리소스 이름입니다. |
etag |
(선택사항) 예의 현재 ETag입니다. etag가 제공되지 않으면 삭제로 인해 동시에 발생한 변경사항이 덮어쓰여집니다. ETag가 제공되었으나 예의 현재 ETag와 일치하지 않으면 삭제가 차단되고 ABORTED 오류가 반환됩니다. |
DeleteGuardrailRequest
AgentService.DeleteGuardrail에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
name |
필수 항목입니다. 삭제할 가드레일의 리소스 이름입니다. |
force |
(선택사항) 앱/에이전트에서 여전히 참조되더라도 가드레일을 강제로 삭제할지 여부를 나타냅니다.
|
etag |
(선택사항) 가드레일의 현재 ETag입니다. etag가 제공되지 않으면 삭제로 인해 동시에 발생한 변경사항이 덮어쓰여집니다. etag가 제공되었으나 가드레일의 현재 etag와 일치하지 않으면 삭제가 차단되고 ABORTED 오류가 반환됩니다. |
DeleteScheduledEvaluationRunRequest
EvaluationService.DeleteScheduledEvaluationRun에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
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 |
식별자. 배포의 리소스 이름입니다. 형식: |
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 |
식별자. 이 평가의 고유 식별자입니다. 형식: |
display_name |
필수 항목입니다. 평가의 사용자 정의 표시 이름입니다. 앱 내에서 고유합니다. |
description |
(선택사항) 평가에 대한 사용자 정의 설명입니다. |
tags[] |
(선택사항) 평가를 분류하는 사용자 정의 태그입니다. |
evaluation_datasets[] |
출력 전용입니다. 평가가 속한 평가 데이터 세트 목록입니다. 형식: |
create_time |
출력 전용입니다. 평가가 생성된 타임스탬프입니다. |
created_by |
출력 전용입니다. 평가를 만든 사용자입니다. |
update_time |
출력 전용입니다. 평가가 마지막으로 업데이트된 타임스탬프입니다. |
last_updated_by |
출력 전용입니다. 평가를 마지막으로 업데이트한 사용자입니다. |
evaluation_runs[] |
출력 전용입니다. 이 평가와 연결된 EvaluationRuns입니다. |
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[] |
(선택사항) 시뮬레이션에서 생성된 대화를 평가할 평가 기대치입니다. 형식: |
scenario_execution_mode |
(선택사항) 시나리오 평가의 실행 모드입니다. |
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 |
식별자. 이 평가 데이터 세트의 고유 식별자입니다. 형식: |
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 |
식별자. 이 평가 기대치의 고유 식별자입니다. 형식: |
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 |
필수 항목입니다. 페르소나의 고유 식별자입니다. 형식: |
description |
(선택사항) 페르소나에 대한 설명입니다. |
display_name |
필수 항목입니다. 페르소나의 표시 이름입니다. 앱 내에서 고유합니다. |
personality |
필수 항목입니다. 평가에서 에이전트가 어떻게 행동해야 하는지에 관한 안내입니다. |
speech_config |
(선택사항) 페르소나의 소리 (TTS 설정)에 관한 구성입니다. |
SpeechConfig
Text-to-Speech 생성을 위한 구성입니다.
| 필드 | |
|---|---|
speaking_rate |
(선택사항) 말하기 속도입니다. 1.0이 정상입니다. 낮을수록 느리고 (예: 0.8) 높을수록 빠릅니다 (예: 1.5). 에이전트가 빠른 대화자를 어떻게 처리하는지 테스트하는 데 유용합니다. |
environment |
(선택사항) 시뮬레이션된 오디오 환경입니다. |
voice_id |
(선택사항) 사용할 특정 음성 식별자/억양입니다. 예: 'en-US-Wavenet-D' 또는 'en-GB-Standard-A' |
BackgroundEnvironment
시뮬레이션된 오디오 환경입니다.
| 열거형 | |
|---|---|
BACKGROUND_ENVIRONMENT_UNSPECIFIED |
백그라운드 환경이 지정되지 않았습니다. |
CALL_CENTER |
콜센터 환경입니다. |
TRAFFIC |
교통 소음 환경입니다. |
KIDS_NOISE |
어린이 소음 환경 |
CAFE |
카페 환경 |
EvaluationResult
평가 결과는 평가 실행의 출력을 나타냅니다.
| 필드 | |
|---|---|
name |
식별자. 평가 결과의 고유 식별자입니다. 형식: |
display_name |
필수 항목입니다. 평가 결과의 표시 이름입니다. 평가 내에서 고유합니다. 기본적으로 형식은 ' |
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 |
출력 전용입니다. 관찰된 맞춤 페이로드입니다. 맞춤 페이로드에 대한 기대치는 없습니다. 이 값은 측정항목 계산에만 사용됩니다. 결과는 항상 SKIPPED입니다. |
ToolInvocationResult
도구 호출 확인 결과입니다.
| 필드 | |
|---|---|
outcome |
출력 전용입니다. 도구 호출 확인 결과입니다. 이는 parameter_correctness_score를 기준과 비교하여 결정됩니다. 점수가 기준점 이상이면 결과는 PASS입니다. 그렇지 않으면 결과는 FAIL입니다. |
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[] |
출력 전용입니다. 턴의 스팬 지연 시간입니다. |
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와 비교하여 결정됩니다. 점수가 기준점 이상이면 결과는 PASS입니다. 그렇지 않으면 결과는 FAIL입니다. |
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[] |
출력 전용입니다. 대화의 스팬 지연 시간입니다. |
evaluation_expectation_results[] |
출력 전용입니다. 평가 기대치의 결과입니다. |
all_expectations_satisfied |
출력 전용입니다. 이 턴의 모든 기대치가 충족되었는지 여부입니다. |
task_completed |
출력 전용입니다. 이 턴에서 작업이 완료되었는지 여부입니다. 이는 충족된 모든 기대치, 환각 없음, 사용자 목표 만족도의 복합입니다. |
ScenarioRubricOutcome
기준표에 대한 평가 결과입니다.
| 필드 | |
|---|---|
rubric |
출력 전용입니다. 대화를 평가하는 데 사용된 기준표입니다. |
score_explanation |
출력 전용입니다. 평가자의 루브릭에 대한 응답입니다. |
score |
출력 전용입니다. 기준표에 따른 대화 점수입니다. |
SemanticSimilarityResult
시맨틱 유사성 검사의 결과입니다.
| 필드 | |
|---|---|
label |
출력 전용입니다. 각 점수와 연결된 라벨입니다. 점수 4: 완전히 일관됨 점수 3: 대부분 일관됨 점수 2: 부분적으로 일관됨 (사소한 누락) 점수 1: 대체로 일관되지 않음 (심각한 누락) 점수 0: 완전히 일관되지 않음 / 모순됨 |
explanation |
출력 전용입니다. 의미 유사도 점수에 대한 설명입니다. |
outcome |
출력 전용입니다. 시맨틱 유사성 검사의 결과입니다. 점수를 semantic_similarity_success_threshold와 비교하여 결정됩니다. 점수가 기준점 이상이면 결과는 PASS입니다. 그렇지 않으면 결과는 FAIL입니다. |
score |
출력 전용입니다. 의미론적 유사성 점수입니다. 0, 1, 2, 3, 4일 수 있습니다. |
SpanLatency
스팬 실행의 지연 시간입니다.
| 필드 | |
|---|---|
type |
출력 전용입니다. 스팬 유형입니다. |
display_name |
출력 전용입니다. 스팬의 표시 이름입니다. 도구 및 가드레일 범위에 적용됩니다. |
start_time |
출력 전용입니다. 스팬의 시작 시간입니다. |
end_time |
출력 전용입니다. 스팬의 종료 시간입니다. |
execution_latency |
출력 전용입니다. 스팬의 지연 시간입니다. |
통합 필드 identifier. 유형에 따른 특정 항목의 식별자입니다. identifier은 다음 중 하나여야 합니다. |
|
resource |
출력 전용입니다. 가드레일 또는 도구 스팬의 리소스 이름입니다. |
toolset |
출력 전용입니다. 툴셋 도구 식별자입니다. |
model |
출력 전용입니다. LLM 스팬의 이름입니다. |
callback |
출력 전용입니다. 사용자 콜백 스팬의 이름입니다. |
유형
스팬 유형입니다. 향후 값이 추가될 수 있습니다.
| 열거형 | |
|---|---|
TYPE_UNSPECIFIED |
기본값 이 값은 사용되지 않습니다. |
TOOL |
도구 호출 스팬입니다. |
USER_CALLBACK |
사용자 콜백 스팬입니다. |
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 |
식별자. 평가 실행의 고유 식별자입니다. 형식: |
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 |
출력 전용입니다. 결과가 FAIL인 완료된 평가 결과의 수입니다. (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 |
식별자. 예의 고유 식별자입니다. 형식: |
display_name |
필수 항목입니다. 예의 표시 이름입니다. |
description |
(선택사항) 예에 대한 인간이 읽을 수 있는 설명입니다. |
entry_agent |
(선택사항) 처음 대화를 처리하는 상담사입니다. 지정하지 않으면 예시가 루트 상담사가 처리하는 대화를 나타냅니다. 형식: |
messages[] |
(선택사항) 대화를 구성하는 메시지 모음입니다. |
create_time |
출력 전용입니다. 예가 생성된 타임스탬프입니다. |
update_time |
출력 전용입니다. 예가 마지막으로 업데이트된 타임스탬프입니다. |
invalid |
출력 전용입니다. 참조 리소스가 삭제되면 예시가 무효화될 수 있습니다. 잘못된 예시는 퓨샷 예시로 사용되지 않습니다. |
etag |
읽기-수정-쓰기 작업 중에 객체가 변경되지 않았는지 확인하는 데 사용되는 Etag입니다. etag가 비어 있으면 업데이트가 동시에 이루어진 변경사항을 덮어씁니다. |
ExecuteToolRequest
ToolService.ExecuteTool에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
parent |
필수 항목입니다. 도구/툴셋이 속한 앱의 리소스 이름입니다. 형식: |
args |
(선택사항) JSON 객체 형식의 도구 입력 매개변수와 값입니다. |
mock_config |
(선택사항) 도구 실행의 모의 구성입니다. 이 필드가 설정되면 다른 도구를 호출하는 도구가 제공된 패턴과 응답을 기반으로 모의됩니다. |
통합 필드 tool_identifier. 실행할 도구의 식별자입니다. 지속형 도구 또는 도구 세트의 도구일 수 있습니다. 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. 실행된 도구의 식별자입니다. 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
이 유형에는 필드가 없습니다.
EvaluationService.ExportEvaluationResults의 작업 메타데이터입니다.
ExportEvaluationResultsRequest
EvaluationService.ExportEvaluationResults에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
parent |
필수 항목입니다. 평가 결과를 내보낼 평가의 리소스 이름입니다. 형식: |
names[] |
필수 항목입니다. 내보낼 평가 결과의 리소스 이름입니다. |
export_options |
(선택사항) 평가 결과의 내보내기 옵션입니다. |
ExportEvaluationResultsResponse
EvaluationService.ExportEvaluationResults의 응답 메시지입니다.
| 필드 | |
|---|---|
통합 필드 evaluation_results. 내보낸 평가 결과입니다. evaluation_results은 다음 중 하나여야 합니다. |
|
evaluation_results_content |
내보낸 평가 결과의 콘텐츠입니다. 요청에 gcs_uri가 지정되지 않은 경우 이 값이 채워집니다. |
evaluation_results_uri |
내보낸 평가 결과가 기록된 Google Cloud Storage URI 폴더입니다. 요청에 gcs_uri가 지정된 경우 채워집니다. |
ExportEvaluationRunsOperationMetadata
이 유형에는 필드가 없습니다.
EvaluationService.ExportEvaluationRuns의 작업 메타데이터입니다.
ExportEvaluationRunsRequest
EvaluationService.ExportEvaluationRuns에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
parent |
필수 항목입니다. 평가 실행을 내보낼 앱의 리소스 이름입니다. 형식: |
names[] |
필수 항목입니다. 내보낼 평가 실행의 리소스 이름입니다. |
export_options |
(선택사항) 평가 실행의 내보내기 옵션입니다. |
ExportEvaluationRunsResponse
EvaluationService.ExportEvaluationRuns의 응답 메시지입니다.
| 필드 | |
|---|---|
통합 필드 evaluation_runs. 내보낸 평가가 실행됩니다. evaluation_runs은 다음 중 하나여야 합니다. |
|
evaluation_runs_content |
내보낸 평가 실행의 콘텐츠입니다. 요청에 gcs_uri가 지정되지 않은 경우 이 값이 채워집니다. |
evaluation_runs_uri |
내보낸 평가 실행이 작성된 Google Cloud Storage URI 폴더입니다. 요청에 gcs_uri가 지정된 경우 채워집니다. |
ExportEvaluationsRequest
EvaluationService.ExportEvaluations에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
parent |
필수 항목입니다. 평가를 내보낼 앱의 리소스 이름입니다. 형식: |
names[] |
필수 항목입니다. 내보낼 평가의 리소스 이름입니다. |
export_options |
(선택사항) 평가의 내보내기 옵션입니다. |
include_evaluation_results |
(선택사항) 내보내기에 평가 결과를 포함합니다. include_evaluation_results 또는 include_evaluations 중 하나 이상을 설정해야 합니다. |
include_evaluations |
(선택사항) 내보내기에 평가를 포함합니다. include_evaluation_results 또는 include_evaluations 중 하나 이상을 설정해야 합니다. |
ExportEvaluationsResponse
EvaluationService.ExportEvaluations의 응답 메시지입니다.
| 필드 | |
|---|---|
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 |
표시할 수 있는 옵션도 있습니다 |
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 |
코퍼스는 사용자가 만들고 소유합니다. |
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
AgentService.GenerateAppResource에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
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 위치입니다. 이 데이터는 대화 데이터를 입력 소스로 사용하는 경우에만 생성됩니다. 위치는 앱과 동일한 프로젝트에 있어야 합니다. 형식: |
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
리소스의 일부를 세부적으로 조정하는 데 사용되는 안내입니다. 리소스의 일부는 시작 색인, 종료 색인, 필드 마스크로 지정할 수 있습니다. 예를 들어 에이전트 요청 사항의 일부를 수정하려면 요청 사항의 첫 번째 문자 색인, 요청 사항의 마지막 문자 색인, 필드 마스크를 '요청 사항'으로 지정하면 됩니다.
| 필드 | |
|---|---|
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
AgentService.GenerateAppResource의 응답 메시지입니다.
| 필드 | |
|---|---|
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
WidgetService.GenerateChatToken에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
name |
필수 항목입니다. 채팅 토큰을 생성할 세션 이름입니다. 형식: projects/{project}/locations/{location}/apps/{app}/sessions/{session} |
deployment |
필수 항목입니다. 세션에 사용할 앱의 배포입니다. 형식: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment} |
recaptcha_token |
(선택사항) 클라이언트 측 채팅 위젯에서 생성된 reCAPTCHA 토큰입니다. |
live_handoff_enabled |
(선택사항) 세션에 라이브 핸드오프가 사용 설정되어 있는지 여부를 나타냅니다. |
GenerateChatTokenResponse
WidgetService.GenerateChatToken의 응답 메시지입니다.
| 필드 | |
|---|---|
chat_token |
세션 API로 인증하기 위한 채팅 위젯의 세션 범위 토큰입니다. |
expire_time |
채팅 토큰이 만료되는 시간입니다. |
GenerateEvaluationOperationMetadata
이 유형에는 필드가 없습니다.
EvaluationService.GenerateEvaluation의 작업 메타데이터입니다.
GenerateEvaluationRequest
EvaluationService.GenerateEvaluation에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
conversation |
필수 항목입니다. 골든 평가를 생성할 대화입니다. 형식: |
source |
(선택사항) 대화의 소스를 표시합니다. 설정하지 않으면 모든 소스를 검색합니다. |
evaluation_type |
(선택사항) 생성할 평가 유형입니다. 지정하지 않으면 기본값은 GOLDEN입니다. |
EvaluationType
생성할 평가 유형입니다.
| 열거형 | |
|---|---|
EVALUATION_TYPE_UNSPECIFIED |
알 수 없는 유형. 기본값은 GOLDEN입니다. |
GOLDEN |
골든 평가 |
SCENARIO |
시나리오 평가 |
GetAgentRequest
AgentService.GetAgent에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
name |
필수 항목입니다. 가져올 에이전트의 리소스 이름입니다. |
GetAppRequest
AgentService.GetApp에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
name |
필수 항목입니다. 가져올 앱의 리소스 이름입니다. |
GetAppVersionRequest
AgentService.GetAppVersion에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
name |
필수 항목입니다. 가져올 앱 버전의 리소스 이름입니다. |
GetChangelogRequest
AgentService.GetChangelog에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
name |
필수 항목입니다. 가져올 변경사항 로그의 리소스 이름입니다. |
GetConversationRequest
AgentService.GetConversation에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
name |
필수 항목입니다. 가져올 대화의 리소스 이름입니다. |
source |
(선택사항) 대화의 소스를 표시합니다. 설정하지 않으면 모든 소스를 검색합니다. |
GetDeploymentRequest
AgentService.GetDeployment에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
name |
필수 항목입니다. 배포 이름입니다. 형식: |
GetEvaluationDatasetRequest
EvaluationService.GetEvaluationDataset에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
name |
필수 항목입니다. 가져올 평가 데이터 세트의 리소스 이름입니다. |
GetEvaluationExpectationRequest
EvaluationService.GetEvaluationExpectation에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
name |
필수 항목입니다. 가져올 평가 기대치의 리소스 이름입니다. |
GetEvaluationRequest
EvaluationService.GetEvaluation에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
name |
필수 항목입니다. 가져올 평가의 리소스 이름입니다. |
GetEvaluationResultRequest
EvaluationService.GetEvaluationResult에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
name |
필수 항목입니다. 가져올 평가 결과의 리소스 이름입니다. |
GetEvaluationRunRequest
EvaluationService.GetEvaluationRun에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
name |
필수 항목입니다. 가져올 평가 실행의 리소스 이름입니다. |
GetExampleRequest
AgentService.GetExample에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
name |
필수 항목입니다. 가져올 예시의 리소스 이름입니다. |
GetGuardrailRequest
AgentService.GetGuardrail에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
name |
필수 항목입니다. 가져올 가드레일의 리소스 이름입니다. |
GetScheduledEvaluationRunRequest
EvaluationService.GetScheduledEvaluationRun에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
name |
필수 항목입니다. 가져올 예약된 평가 실행의 리소스 이름입니다. |
GetSecuritySettingsRequest
AgentService.GetSecuritySettings에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
name |
필수 항목입니다. 가져올 보안 설정의 리소스 이름입니다. 형식: |
GetToolRequest
AgentService.GetTool에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
name |
필수 항목입니다. 가져올 도구의 리소스 이름입니다. |
GetToolsetRequest
AgentService.GetToolset에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
name |
필수 항목입니다. 가져올 도구 모음의 리소스 이름입니다. |
GoAway
이 유형에는 필드가 없습니다.
서버가 곧 연결을 해제할 것이며 클라이언트가 연결을 절반 닫고 다시 시작해야 함을 나타냅니다.
GoldenRunMethod
평가를 실행하는 데 사용된 방법입니다.
| 열거형 | |
|---|---|
GOLDEN_RUN_METHOD_UNSPECIFIED |
실행 메서드가 지정되지 않았습니다. |
STABLE |
각 턴이 이전 예상 턴이 컨텍스트로 삽입된 고유 세션인 안정적인 리플레이로 평가를 실행합니다. |
NAIVE |
실행이 컨텍스트가 삽입되지 않은 단일 세션인 단순 리플레이로 평가를 실행합니다. |
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[] |
(선택사항) 컨텍스트와 그라운딩을 위해 이러한 URL에서 콘텐츠가 직접 가져옵니다. 예: 'https://example.com/path.html' URL은 최대 20개까지 허용됩니다. |
preferred_domains[] |
(선택사항) 검색 결과를 제한할 도메인을 지정합니다. 예: 'example.com', 'another.site' 최대 20개의 도메인을 지정할 수 있습니다. |
exclude_domains[] |
(선택사항) 검색 결과에서 제외할 도메인 목록입니다. 예: 'example.com' 최대 2,000개의 도메인을 제외할 수 있습니다. |
prompt_config |
(선택사항) 텍스트 및 음성에 대해 검색 결과를 처리하는 방법에 관해 플래너에 전달되는 프롬프트 안내입니다. |
PromptConfig
Google 검색 결과를 처리하거나 요약할 때 모델에서 사용하는 프롬프트 설정입니다.
| 필드 | |
|---|---|
text_prompt |
(선택사항) 채팅 대화에서 에이전트와 상호작용할 때 시스템 요청 사항에 사용되는 프롬프트를 정의합니다. 설정하지 않으면 기본 프롬프트가 사용됩니다. |
voice_prompt |
(선택사항) 음성 대화에서 에이전트와 상호작용할 때 시스템 안내에 사용되는 프롬프트를 정의합니다. 설정하지 않으면 기본 프롬프트가 사용됩니다. |
가드레일
가드레일에는 에이전트를 안전하게 보호하기 위한 견제와 균형 목록이 포함되어 있습니다.
| 필드 | |
|---|---|
name |
식별자. 가드레일의 고유 식별자입니다. 형식: |
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인 경우 일치하는 동안 발음 구별 기호가 무시됩니다. |
MatchType
콘텐츠 필터의 검색 유형입니다.
| 열거형 | |
|---|---|
MATCH_TYPE_UNSPECIFIED |
검색 유형이 지정되지 않았습니다. |
SIMPLE_STRING_MATCH |
콘텐츠는 하위 문자열에 대해 문자별로 일치합니다. |
WORD_BOUNDARY_STRING_MATCH |
텍스트에서 발견된 패턴이 단어 구분 기호로 둘러싸여 있는 경우에만 콘텐츠가 일치합니다. 금지된 문구에는 단어 구분 기호도 포함될 수 있습니다. |
REGEXP_MATCH |
정규 표현식 문법을 사용하여 콘텐츠가 일치합니다. |
LlmPolicy
LLM 분류를 기반으로 LLM 대답이 정책을 위반하는 것으로 간주되는 경우 대화를 차단하는 가드레일입니다.
| 필드 | |
|---|---|
max_conversation_messages |
(선택사항) 이 정책을 확인할 때는 대화의 마지막 'n'개 메시지를 고려하세요. 설정하지 않으면 기본값 10이 사용됩니다. |
model_settings |
(선택사항) 모델 설정입니다. |
prompt |
필수 항목입니다. 정책 프롬프트 |
policy_scope |
필수 항목입니다. 대화 중에 정책 확인을 적용할 시기를 정의합니다. |
fail_open |
(선택사항) 정책 확인 중에 오류가 발생하면 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 |
(선택사항) 패치가 포함된 JSON 파일을 가리키는 Cloud Storage URI입니다. |
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
EvaluationService.ImportEvaluations에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
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
EvaluationService.ImportEvaluations의 응답 메시지입니다.
| 필드 | |
|---|---|
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 |
필수 항목입니다. 입력 오디오 데이터의 샘플링 레이트 (Hz)입니다. |
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 |
(선택사항) 다국어 지원을 사용 설정합니다. true인 경우 앱의 에이전트가 사전 빌드된 명령어를 사용하여 다국어 입력 처리를 개선합니다. |
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. 도구의 식별자입니다. tool_identifier은 다음 중 하나여야 합니다. |
|
tool |
출력 전용입니다. 형식은 |
toolset_tool |
출력 전용입니다. 툴셋 도구 식별자입니다. |
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[] |
순서가 지정되지 않은 목록 도달할 수 없는 위치입니다. |
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
AgentService.ListConversations에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
parent |
필수 항목입니다. 대화를 나열할 앱의 리소스 이름입니다. |
page_size |
(선택사항) 요청한 페이지 크기입니다. 서버에서 요청한 것보다 적은 항목을 반환할 수 있습니다. 지정하지 않으면 서버에서 적절한 기본값을 선택합니다. |
page_token |
(선택사항) 이전 목록 |
filter |
(선택사항) 대화를 나열할 때 적용할 필터입니다. 자세한 내용은 https://google.aip.dev/160을 참조하세요. |
source |
(선택사항) 대화의 소스를 표시합니다. 설정하지 않으면 Source.Live가 기본적으로 적용됩니다. |
sources[] |
(선택사항) 대화의 소스를 표시합니다. 설정하지 않으면 사용 가능한 모든 소스가 기본적으로 적용됩니다. |
ListConversationsResponse
AgentService.ListConversations의 응답 메시지입니다.
| 필드 | |
|---|---|
conversations[] |
대화 목록입니다. |
next_page_token |
다음 페이지를 검색하기 위해 |
ListDeploymentsRequest
AgentService.ListDeployments에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
parent |
필수 항목입니다. 상위 앱입니다. 형식: |
page_size |
(선택사항) 반환할 최대 배포 수입니다. 서비스가 이 값보다 더 적게 반환할 수 있습니다. 지정하지 않으면 최대 50개의 배포가 반환됩니다. 최댓값은 1,000이며, 1,000을 초과하는 값은 1,000으로 변환됩니다. |
page_token |
(선택사항) 이전 페이지를 매길 때 |
order_by |
(선택사항) 정렬할 필드입니다. 'name' 및 'create_time'만 지원됩니다. 자세한 내용은 https://google.aip.dev/132#ordering을 참조하세요. |
ListDeploymentsResponse
AgentService.ListDeployments의 응답 메시지입니다.
| 필드 | |
|---|---|
deployments[] |
배포 목록입니다. |
next_page_token |
다음 페이지를 검색하기 위해 |
ListEvaluationDatasetsRequest
EvaluationService.ListEvaluationDatasets에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
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
EvaluationService.ListEvaluationDatasets의 응답 메시지입니다.
| 필드 | |
|---|---|
evaluation_datasets[] |
평가 데이터 세트 목록입니다. |
next_page_token |
다음 페이지를 검색하기 위해 |
ListEvaluationExpectationsRequest
EvaluationService.ListEvaluationExpectations에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
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
EvaluationService.ListEvaluationExpectations의 응답 메시지입니다.
| 필드 | |
|---|---|
evaluation_expectations[] |
평가 기대치 목록입니다. |
next_page_token |
다음 페이지를 검색하기 위해 |
ListEvaluationResultsRequest
EvaluationService.ListEvaluationResults에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
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
EvaluationService.ListEvaluationResults의 응답 메시지입니다.
| 필드 | |
|---|---|
evaluation_results[] |
평가 결과 목록입니다. |
next_page_token |
다음 페이지를 검색하기 위해 |
ListEvaluationRunsRequest
EvaluationService.ListEvaluationRuns에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
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
EvaluationService.ListEvaluationRuns의 응답 메시지입니다.
| 필드 | |
|---|---|
evaluation_runs[] |
평가 실행 목록입니다. |
next_page_token |
다음 페이지를 검색하기 위해 |
ListEvaluationsRequest
EvaluationService.ListEvaluations에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
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
EvaluationService.ListEvaluations의 응답 메시지입니다.
| 필드 | |
|---|---|
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
EvaluationService.ListScheduledEvaluationRuns에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
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
EvaluationService.ListScheduledEvaluationRuns의 응답 메시지입니다.
| 필드 | |
|---|---|
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 내보내기 동작을 구성합니다. 대화 데이터는 |
unredacted_bigquery_export_settings |
(선택사항) 앱의 BigQuery 내보내기 동작을 구성합니다. 사용 설정된 경우 수정되지 않은 대화 데이터가 BigQuery 테이블로 내보내집니다. |
cloud_logging_settings |
(선택사항) 앱의 Cloud Logging 동작을 설명하는 설정입니다. |
conversation_logging_settings |
(선택사항) 앱의 대화 로깅 동작을 설명하는 설정입니다. |
evaluation_audio_recording_config |
(선택사항) 평가를 위해 오디오 상호작용을 녹음하는 방법에 관한 구성입니다. 기본적으로 평가 세션에는 오디오 녹음이 사용 설정되어 있지 않습니다. |
metric_analysis_settings |
(선택사항) 앱의 LLM 분석 파이프라인의 대화 데이터 수집 동작을 설명하는 설정입니다. |
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로 빌드된 경우 URL에 '/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용 서비스 디렉터리 구성입니다. |
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로 빌드된 경우 URL에 '/mcp/'가 접미사로 붙어야 합니다. 스트리밍 가능한 HTTP 전송 기반 서버만 지원됩니다. 자세한 내용은 https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http를 참고하세요. |
api_authentication |
(선택사항) 도구에 액세스하고 MCP 서버에 대해 도구를 실행하는 데 필요한 인증 정보입니다. 베어러 토큰 인증의 경우 토큰은 도구 실행에만 적용되며 도구 나열에는 적용되지 않습니다. 이를 위해서는 인증 없이 도구를 나열할 수 있어야 합니다. |
service_directory_config |
(선택사항) 경계 내에서 서비스 이름을 확인하는 데 사용되는 VPC-SC용 서비스 디렉터리 구성입니다. |
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의 args 패턴과 일치하지 않는 도구 호출의 동작입니다. |
UnmatchedToolCallBehavior
도구 호출이 모의 도구 호출과 일치하지 않는 경우 수행할 작업
| 열거형 | |
|---|---|
UNMATCHED_TOOL_CALL_BEHAVIOR_UNSPECIFIED |
기본값 이 값은 사용되지 않습니다. |
FAIL |
모의 예상 입력 패턴과 일치하지 않는 도구 호출에 대해 오류를 발생시킵니다. |
PASS_THROUGH |
일치하지 않는 도구 호출의 경우 도구 호출을 실제 도구에 전달합니다. |
MockedToolCall
모의 도구 호출입니다.
타겟 도구와 해당 도구의 args / 입력과 일치하는 패턴을 표현합니다. 패턴이 일치하면 모의 응답이 반환됩니다.
| 필드 | |
|---|---|
tool |
(선택사항) 지원 중단되었습니다. 대신 tool_identifier를 사용하세요. |
expected_args_pattern |
필수 항목입니다. 디스패치된 모든 도구 호출의 args / 입력과 일치하는 패턴입니다. 도구 호출 입력이 이 패턴과 일치하면 모의 출력이 반환됩니다. |
mock_response |
(선택사항) 도구 호출 인수 / 입력이 패턴과 일치하는 경우 반환할 모의 응답 / 출력입니다. |
통합 필드 tool_identifier. 모의할 도구의 식별자입니다. tool_identifier은 다음 중 하나여야 합니다. |
|
tool_id |
(선택사항) 모의할 도구의 이름입니다. 형식: |
toolset |
(선택사항) 모의할 도구 집합입니다. |
ModelSettings
모델 설정에는 LLM 모델의 다양한 구성이 포함되어 있습니다.
| 필드 | |
|---|---|
model |
(선택사항) 에이전트가 사용해야 하는 LLM 모델입니다. 설정하지 않으면 에이전트가 상위 에이전트의 모델을 상속합니다. |
thinking_level |
(선택사항) 모델의 사고 수준입니다. |
temperature |
(선택사항) 설정된 경우 이 온도가 LLM 모델에 사용됩니다. 온도는 모델 응답의 무작위성을 제어합니다. 온도가 낮을수록 더 예측 가능한 대답이 생성됩니다. 온도가 높을수록 더 창의적인 대답이 생성됩니다. |
ThinkingLevel
모델의 사고 수준 구성입니다.
| 열거형 | |
|---|---|
THINKING_LEVEL_UNSPECIFIED |
사고 수준이 지정되지 않았습니다. |
DEFAULT |
기본 사고 수준입니다. |
LOW |
사고 수준이 낮습니다. |
MEDIUM |
중간 사고 수준입니다. |
HIGH |
사고 수준이 높습니다. |
OAuthConfig
OAuth를 사용한 인증 구성입니다.
| 필드 | |
|---|---|
oauth_grant_type |
필수 항목입니다. OAuth 권한 부여 유형입니다. |
client_id |
필수 항목입니다. OAuth 제공업체의 클라이언트 ID입니다. |
client_secret_version |
필수 항목입니다. 클라이언트 보안 비밀번호를 저장하는 SecretManager 보안 비밀 버전 리소스의 이름입니다. 형식: 참고: CES 서비스 에이전트 |
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 |
(선택사항) 서비스 디렉터리 구성입니다. |
ignore_unknown_fields |
(선택사항) true인 경우 에이전트는 API 응답에서 알 수 없는 필드를 무시합니다. |
url |
(선택사항) Open API 스키마의 서버 URL입니다. 이 필드는 스키마에 서버 URL이 포함된 경우 내보내기 프로세스 중에 환경 종속 항목의 도구에만 설정됩니다. 가져오기 프로세스 중에 이 URL이 환경 종속 항목에 있고 스키마에 $env_var 자리표시자가 있으면 스키마의 자리표시자를 대체합니다. |
OpenApiToolset
OpenAPI 스키마로 정의된 도구 목록이 포함된 도구 세트입니다.
| 필드 | |
|---|---|
open_api_schema |
필수 항목입니다. 툴셋의 OpenAPI 스키마입니다. |
api_authentication |
(선택사항) API에 필요한 인증 정보입니다. |
tls_config |
(선택사항) TLS 구성입니다. 맞춤 서버 인증서를 포함합니다. |
service_directory_config |
(선택사항) 서비스 디렉터리 구성입니다. |
ignore_unknown_fields |
(선택사항) true인 경우 에이전트는 OpenAPI 스키마에 정의된 모든 작업의 API 응답에서 알 수 없는 필드를 무시합니다. |
url |
(선택사항) Open API 스키마의 서버 URL입니다. 이 필드는 스키마에 서버 URL이 포함된 경우 내보내기 프로세스 중에 환경 종속 항목의 툴셋에만 설정됩니다. 가져오기 프로세스 중에 이 URL이 환경 종속 항목에 있고 스키마에 $env_var 자리표시자가 있으면 스키마의 자리표시자를 대체합니다. |
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 |
내부 오류로 인해 최적화에 실패했습니다. |
OutputAudioConfig
OutputAudioConfig는 CES 에이전트가 나가는 오디오 응답을 합성하는 방법을 구성합니다.
| 필드 | |
|---|---|
audio_encoding |
필수 항목입니다. 출력 오디오 데이터의 인코딩입니다. |
sample_rate_hertz |
필수 항목입니다. 출력 오디오 데이터의 샘플링 레이트 (Hz)입니다. |
PersonaRunConfig
특정 페르소나의 평가를 실행하기 위한 구성입니다.
| 필드 | |
|---|---|
persona |
(선택사항) 평가에 사용할 페르소나입니다. 형식: |
task_count |
(선택사항) 페르소나에 대해 실행할 작업 수입니다. |
PythonCodeCondition
조건을 평가하는 Python 코드 블록입니다.
| 필드 | |
|---|---|
python_code |
필수 항목입니다. 실행할 Python 코드입니다. |
PythonFunction
Python 함수 도구입니다.
| 필드 | |
|---|---|
name |
(선택사항) 실행할 Python 함수의 이름입니다. Python 코드에 정의된 Python 함수 이름과 일치해야 합니다. 대소문자를 구분합니다. 이름이 제공되지 않으면 Python 코드에 정의된 첫 번째 함수가 사용됩니다. |
python_code |
(선택사항) 도구에서 실행할 Python 코드입니다. |
description |
출력 전용입니다. Python 코드의 문서 문자열에서 파싱된 Python 함수에 대한 설명입니다. |
service_directory_config |
(선택사항) 도구의 서비스 디렉터리 구성입니다. |
QualityReport
앱에서 식별된 품질 문제를 설명하는 보고서입니다.
| 필드 | |
|---|---|
issues[] |
(선택사항) 상담사별로 그룹화된 문제입니다. |
evaluation_runs[] |
(선택사항) 품질 보고서를 생성하는 데 사용된 평가 실행 목록입니다. 형식은 |
general_issues[] |
(선택사항) 특정 상담사와 관련이 없는 일반적인 문제입니다. |
AgentIssues
단일 상담사에 대해 식별된 문제입니다.
| 필드 | |
|---|---|
agent |
(선택사항) 문제가 관련되어 있는 상담사의 이름입니다. 형식: |
issues[] |
(선택사항) 이 에이전트에서 발견된 문제 목록입니다. |
문제
확인된 문제
| 필드 | |
|---|---|
description |
(선택사항) 발견된 문제에 대한 설명입니다. |
occurrence_count |
(선택사항) 이 문제가 발생한 횟수입니다. |
proposed_solution |
(선택사항) 안내 또는 도구를 수정하여 문제를 해결하기 위한 제안된 해결 방법입니다. |
RecognitionResult
오디오 입력의 음성 인식 결과입니다.
| 필드 | |
|---|---|
transcript |
(선택사항) 현재 턴 중에 캡처된 연결된 사용자 음성 세그먼트입니다. |
RedactionConfig
민감한 정보를 처리하는 방법을 안내하는 구성입니다.
| 필드 | |
|---|---|
enable_redaction |
(선택사항) true인 경우 대화 기록, Cloud Logging, 오디오 녹음 등 다양한 로깅 시나리오에 수정이 적용됩니다. |
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를 반환하면 이 원격 상담사 도구의 전체 세션에 대해 유지됩니다. |
input_variable_mapping |
(선택사항) 원격 에이전트의 입력 변수 이름을 GECX 변수 이름에 매핑합니다. |
output_variable_mapping |
(선택사항) 원격 에이전트의 출력 변수 이름을 GECX 변수 이름에 매핑합니다. |
RestoreAppVersionRequest
AgentService.RestoreAppVersion의 요청 메시지
| 필드 | |
|---|---|
name |
필수 항목입니다. 복원할 앱 버전의 리소스 이름입니다. |
RestoreAppVersionResponse
이 유형에는 필드가 없습니다.
AgentService.RestoreAppVersion의 응답 메시지입니다.
RetrieveToolSchemaRequest
ToolService.RetrieveToolSchema에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
parent |
필수 항목입니다. 도구/툴셋이 속한 앱의 리소스 이름입니다. 형식: |
통합 필드 tool_identifier. 스키마를 가져올 도구의 식별자입니다. 지속형 도구 또는 도구 세트의 도구일 수 있습니다. tool_identifier은 다음 중 하나여야 합니다. |
|
tool |
(선택사항) 스키마를 가져올 도구의 이름입니다. 형식: projects/{project}/locations/{location}/apps/{app}/tools/{tool} |
toolset_tool |
(선택사항) 스키마를 가져올 도구 세트 도구입니다. 도구 세트의 프레디케이트와 일치하는 도구는 하나만 있어야 합니다. 그렇지 않으면 오류가 반환됩니다. |
RetrieveToolSchemaResponse
ToolService.RetrieveToolSchema의 응답 메시지입니다.
| 필드 | |
|---|---|
input_schema |
도구 입력 매개변수의 스키마입니다. |
output_schema |
도구 출력 매개변수의 스키마입니다. |
통합 필드 tool_identifier. 스키마가 적용되는 도구의 식별자입니다. tool_identifier은 다음 중 하나여야 합니다. |
|
tool |
스키마가 적용되는 도구의 이름입니다. 형식: |
toolset_tool |
스키마가 적용되는 도구 세트 도구입니다. |
RetrieveToolsRequest
ToolService.RetrieveTools에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
toolset |
필수 항목입니다. 도구를 검색할 도구 세트의 이름입니다. 형식: |
tool_ids[] |
(선택사항) 툴셋에서 가져올 도구의 식별자입니다. 비어 있으면 도구 세트의 모든 도구가 반환됩니다. |
bypass_persistence_config |
(선택사항) true인 경우 반환된 도구에는 저장된 지속성 구성 (재정의/스냅샷)을 우회하여 서버에서 직접 가져온 원시 설명과 스키마가 포함됩니다. |
RetrieveToolsResponse
ToolService.RetrieveTools의 응답 메시지입니다.
| 필드 | |
|---|---|
tools[] |
지정된 도구 세트에 포함된 도구 목록입니다. |
RunEvaluationOperationMetadata
EvaluationService.RunEvaluation의 작업 메타데이터입니다.
| 필드 | |
|---|---|
evaluations[] |
출력 전용입니다. 실행된 평가 목록입니다. 형식: |
evaluation_run |
출력 전용입니다. 생성된 평가 실행입니다. 형식: |
create_time |
출력 전용입니다. 작업이 생성된 시간입니다. |
end_time |
출력 전용입니다. 작업이 완료된 시간입니다. |
verb |
출력 전용입니다. 작업의 동사입니다. |
cancel_requested |
출력 전용입니다. 사용자가 작업 취소를 요청했는지를 나타냅니다. 성공적으로 취소된 작업에는 |
RunEvaluationRequest
EvaluationService.RunEvaluation에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
app |
필수 항목입니다. 평가할 앱입니다. 형식: |
evaluations[] |
(선택사항) 실행할 평가 목록입니다. 형식: |
evaluation_dataset |
(선택사항) 실행할 평가 데이터 세트입니다. 형식: |
display_name |
(선택사항) 평가 실행의 표시 이름입니다. |
app_version |
(선택사항) 평가할 앱 버전입니다. |
config |
(선택사항) 실행에 사용할 구성입니다. |
persona_run_configs[] |
(선택사항) 페르소나별 실행에 사용할 구성입니다. |
optimization_config |
(선택사항) 평가 실행 후 최적화 단계를 실행하기 위한 구성입니다. 설정하지 않으면 최적화 단계가 실행되지 않습니다. |
scheduled_evaluation_run |
(선택사항) 이 평가 실행을 트리거하는 이 필드가 설정되면 생성된 |
golden_run_method |
(선택사항) 골든 평가인 경우 평가를 실행하는 방법입니다. 설정하지 않으면 안정 버전으로 기본 설정됩니다. |
generate_latency_report |
(선택사항) 평가 실행에 대한 지연 시간 보고서를 생성할지 여부입니다. |
evaluation_run_caching_settings |
(선택사항) 평가 실행에 사용할 캐싱 설정입니다. |
run_count |
(선택사항) 평가를 실행할 횟수입니다. 설정하지 않으면 기본값은 골든당 1개, 시나리오당 5개입니다. |
RunEvaluationResponse
EvaluationService.RunEvaluation의 응답 메시지입니다.
| 필드 | |
|---|---|
evaluation_run |
생성된 평가 실행의 이름입니다. 형식: |
RunEvaluationResultMetricsOperationMetadata
이 유형에는 필드가 없습니다.
EvaluationService.RunEvaluationResultMetrics의 작업 메타데이터입니다.
RunEvaluationResultMetricsRequest
EvaluationService.RunEvaluationResultMetrics에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
evaluation_result_id |
필수 항목입니다. 측정항목을 실행할 평가 결과입니다. 형식: |
RunEvaluationResultMetricsResponse
EvaluationService.RunEvaluationResultMetrics의 응답 메시지입니다.
| 필드 | |
|---|---|
status |
출력 전용입니다. 평가 결과 측정항목 계산의 상태입니다. |
RunSessionRequest
SessionService.RunSession에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
config |
필수 항목입니다. 세션의 구성입니다. |
inputs[] |
필수 항목입니다. 세션의 입력입니다. |
RunSessionResponse
SessionService.RunSession의 응답 메시지입니다.
| 필드 | |
|---|---|
outputs[] |
세션의 출력입니다. |
ScheduledEvaluationRun
예약된 평가 실행 구성을 나타냅니다.
| 필드 | |
|---|---|
name |
식별자. 예약된 평가 실행 구성의 고유 식별자입니다. 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 |
2주에 한 번 평가를 실행합니다. |
스키마
OpenAPI 3.0 스키마 객체의 선택된 하위 집합을 나타냅니다.
| 필드 | |
|---|---|
type |
필수 항목입니다. 데이터 유형입니다. |
properties |
(선택사항) Type.OBJECT의 속성입니다. |
required[] |
(선택사항) Type.OBJECT의 필수 속성입니다. |
description |
(선택사항) 데이터의 설명입니다. |
items |
(선택사항) Type.ARRAY 요소의 스키마입니다. |
nullable |
(선택사항) null 값을 나타냅니다. |
unique_items |
(선택사항) 배열의 항목이 고유해야 함을 나타냅니다. TYPE.ARRAY에만 적용됩니다. |
prefix_items[] |
(선택사항) Type.ARRAY의 초기 요소의 스키마입니다. |
additional_properties |
(선택사항) 불리언 또는 객체일 수 있으며 추가 속성의 존재를 제어합니다. |
any_of[] |
(선택사항) 값은 목록에 있는 하위 스키마 중 하나 이상에 대해 검증되어야 합니다. |
enum[] |
(선택사항) 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 |
식별자. 보안 설정의 고유 식별자입니다. 형식: |
endpoint_control_policy |
(선택사항) 엔드포인트 제어 관련 설정입니다. |
create_time |
출력 전용입니다. 보안 설정의 생성 시간입니다. |
update_time |
출력 전용입니다. 보안 설정의 마지막 업데이트 시간입니다. |
etag |
출력 전용입니다. 보안 설정의 ETag입니다. |
ServiceAccountAuthConfig
커스텀 서비스 계정을 사용한 인증 구성입니다.
| 필드 | |
|---|---|
service_account |
필수 항목입니다. 인증에 사용되는 서비스 계정의 이메일 주소입니다. CES는 이 서비스 계정을 사용하여 액세스 토큰을 교환하고 액세스 토큰은 요청의 서비스 계정에는 CES 서비스 에이전트 |
scopes[] |
(선택사항) 부여할 OAuth 범위입니다. 지정하지 않으면 기본 범위 |
ServiceAgentIdTokenAuthConfig
이 유형에는 필드가 없습니다.
서비스 에이전트에서 생성된 ID 토큰을 사용한 인증 구성
ServiceDirectoryConfig
서비스 디렉터리를 사용하는 도구의 구성입니다.
| 필드 | |
|---|---|
service |
필수 항목입니다. 서비스 디렉터리 서비스의 이름입니다. 형식은 |
SessionConfig
세션의 구성입니다.
| 필드 | |
|---|---|
session |
필수 항목입니다. 세션의 고유 식별자입니다. 형식: |
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 |
(선택사항) 모델에서 텍스트 출력을 스트리밍할지 여부입니다. 기본적으로 모델의 텍스트 출력은 클라이언트에 전송되기 전에 수집됩니다. 참고: |
exclude_diagnostic_info |
(선택사항) 세션 출력에서 진단 정보를 제외할지 여부입니다. |
RemoteDialogflowQueryParameters
세션 제어가 원격 에이전트로 트랜스퍼될 때 원격 Dialogflow 에이전트로 전송할 QueryParameters입니다.
| 필드 | |
|---|---|
webhook_headers |
(선택사항) QueryParameters에서 webhook_headers로 전송될 HTTP 헤더입니다. |
payload |
(선택사항) QueryParameters에 전송할 페이로드입니다. |
end_user_metadata |
(선택사항) QueryParameters에 전송할 최종 사용자 메타데이터입니다. |
SessionInput
세션의 입력입니다.
| 필드 | |
|---|---|
will_continue |
(선택사항) 현재 메시지가 bidi 스트리밍 세션에서 더 큰 입력의 프래그먼트인지 여부를 나타내는 플래그입니다.
참고: 이 필드는 오디오 및 DTMF 입력에는 적용되지 않습니다. 엔드포인팅 신호에 따라 항상 자동으로 처리되기 때문입니다. |
통합 필드 input_type. 입력 유형입니다. input_type은 다음 중 하나여야 합니다. |
|
text |
(선택사항) 최종 사용자의 텍스트 데이터입니다. |
dtmf |
(선택사항) 최종 사용자의 DTMF 숫자입니다. |
audio |
(선택사항) 최종 사용자의 오디오 데이터입니다. |
tool_responses |
(선택사항) 클라이언트의 도구 호출 실행 결과입니다. |
image |
(선택사항) 최종 사용자의 이미지 데이터입니다. |
blob |
(선택사항) 최종 사용자의 BLOB 데이터입니다. |
variables |
(선택사항) 세션의 컨텍스트 변수입니다. 이름으로 키가 지정됩니다. 앱에서 선언된 변수만 CES 에이전트에서 사용됩니다. 인식되지 않는 변수는 [Dialogflow 에이전트][Agent.RemoteDialogflowAgent] 에 추가 세션 매개변수로 계속 전송됩니다. |
event |
(선택사항) 이벤트 입력입니다. |
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 |
전체 요청 처리의 트레이스입니다. 루트 스팬으로 표현됩니다. 이 스팬에는 특정 작업의 중첩된 하위 스팬이 포함될 수 있습니다. |
스팬
스팬은 요청 처리 중의 작업 단위 또는 단일 작업입니다.
| 필드 | |
|---|---|
name |
출력 전용입니다. 스팬의 이름입니다. |
start_time |
출력 전용입니다. 스팬의 시작 시간입니다. |
end_time |
출력 전용입니다. 스팬의 종료 시간입니다. |
duration |
출력 전용입니다. 스팬의 지속 시간입니다. |
attributes |
출력 전용입니다. 스팬과 연결된 키-값 속성입니다. |
child_spans[] |
출력 전용입니다. 이 스팬 아래에 중첩된 하위 스팬입니다. |
SynthesizeSpeechConfig
에이전트 응답이 합성되는 방식에 관한 구성입니다.
| 필드 | |
|---|---|
voice |
선택사항. 음성 이름입니다. 설정되지 않은 경우 서비스에서 language_code와 같은 다른 매개변수를 기반으로 음성을 선택합니다. 사용 가능한 음성 목록은 Cloud Text-to-Speech의 지원되는 음성 및 언어를 참고하세요. |
speaking_rate |
(선택사항) 말하기 속도/속도(범위: [0.25, 2.0])입니다. 1.0은 특정 음성에서 지원하는 일반적인 기본 속도입니다. 2.0은 기본 속도의 2배이며 0.5는 절반입니다. [0.25, 2.0] 범위를 벗어나는 값은 오류를 반환합니다. |
model |
(선택사항) 오디오를 합성하는 데 사용되는 모델입니다. 현재 지원되는 값: - 'gemini-3.1-flash-tts-preview' 비어 있으면 Chirp3-HD가 사용됩니다. |
instruction |
(선택사항) 생성 모델을 사용할 때 음성을 합성하는 데 사용되는 안내입니다. |
SystemTool
사전 정의된 시스템 도구입니다.
| 필드 | |
|---|---|
name |
필수 항목입니다. 시스템 도구의 이름입니다. |
description |
출력 전용입니다. 시스템 도구의 설명입니다. |
TestPersonaVoiceRequest
EvaluationService.TestPersonaVoice에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
app |
필수 항목입니다. 페르소나 음성을 테스트할 앱의 리소스 이름입니다. 형식: |
persona_id |
필수 항목입니다. 음성을 테스트할 페르소나 ID입니다. 'default'도 허용됩니다. |
text |
필수 항목입니다. 음성을 테스트할 텍스트입니다. |
TestPersonaVoiceResponse
EvaluationService.TestPersonaVoice의 응답 메시지입니다.
| 필드 | |
|---|---|
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 |
식별자. 도구의 리소스 이름입니다. 형식:
이러한 도구는 동적이며 출력 전용입니다. 도구가 필요한 곳에서 직접 참조할 수 없습니다. |
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 |
(선택사항) 도구 호출의 고유 식별자입니다. 값이 채워진 경우 클라이언트는 |
display_name |
출력 전용입니다. 도구의 표시 이름입니다. |
args |
(선택사항) JSON 객체 형식의 도구 입력 매개변수와 값입니다. |
parent_tool_call_id |
출력 전용입니다. 상위 통화를 대신하여 작업하는 하위 에이전트가 발급한 경우 이 통화를 유발한 도구 호출의 ID입니다. 최상위 호출의 경우 비워 둡니다. 클라이언트가 모든 단계를 형제로 렌더링하는 대신 하위 에이전트의 작업을 시작한 호출 아래에 그룹화할 수 있습니다. |
agent_name |
출력 전용입니다. 이 통화를 발급한 상담사의 사람이 읽을 수 있는 이름입니다(예: '계약 설계사'). 루트 에이전트가 발급한 경우 비어 있습니다. |
통합 필드 tool_identifier. 실행할 도구의 식별자입니다. 지속형 도구 또는 도구 세트의 도구일 수 있습니다. 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 |
출력 전용입니다. 이 통화를 발급한 상담사의 사람이 읽을 수 있는 이름입니다(예: '계약 설계사'). 루트 에이전트가 발급한 경우 비어 있습니다. |
통합 필드 tool_identifier. 실행된 도구의 식별자입니다. 지속형 도구 또는 도구 세트의 도구일 수 있습니다. tool_identifier은 다음 중 하나여야 합니다. |
|
tool |
(선택사항) 실행할 도구의 이름입니다. 형식: |
toolset_tool |
(선택사항) 실행된 도구 세트 도구입니다. |
ToolResponses
클라이언트에서 요청한 도구 호출의 실행 결과입니다.
| 필드 | |
|---|---|
tool_responses[] |
(선택사항) 도구 실행 결과 목록입니다. |
툴셋
툴셋은 에이전트가 사용할 수 있는 동적으로 관리되는 도구 그룹을 나타냅니다.
| 필드 | |
|---|---|
name |
식별자. 툴셋의 고유 식별자입니다. 형식: |
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 |
필수 항목입니다. 대화를 트랜스퍼할 에이전트의 이름입니다. 에이전트는 현재 에이전트와 동일한 앱에 있어야 합니다. 형식: |
UpdateAgentRequest
AgentService.UpdateAgent에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
agent |
필수 항목입니다. 업데이트할 에이전트입니다. |
update_mask |
(선택사항) 필드 마스크는 업데이트할 필드를 제어하는 데 사용됩니다. 마스크가 없으면 모든 필드가 업데이트됩니다. |
UpdateAppRequest
AgentService.UpdateApp에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
app |
필수 항목입니다. 업데이트할 앱입니다. |
update_mask |
(선택사항) 필드 마스크는 업데이트할 필드를 제어하는 데 사용됩니다. 마스크가 없으면 모든 필드가 업데이트됩니다. |
UpdateAppVersionRequest
AgentService.UpdateAppVersion에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
app_version |
필수 항목입니다. 업데이트할 앱 버전입니다. |
update_mask |
(선택사항) 업데이트할 필드 목록입니다. 비어 있으면 |
UpdateDeploymentRequest
AgentService.UpdateDeployment에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
deployment |
필수 항목입니다. 업데이트할 배포입니다. |
update_mask |
(선택사항) 업데이트할 필드 목록입니다. |
UpdateEvaluationDatasetRequest
EvaluationService.UpdateEvaluationDataset에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
evaluation_dataset |
필수 항목입니다. 업데이트할 평가 데이터 세트입니다. |
update_mask |
(선택사항) 필드 마스크는 업데이트할 필드를 제어하는 데 사용됩니다. 마스크가 없으면 모든 필드가 업데이트됩니다. |
UpdateEvaluationExpectationRequest
EvaluationService.UpdateEvaluationExpectation에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
evaluation_expectation |
필수 항목입니다. 업데이트할 평가 기대치입니다. |
update_mask |
(선택사항) 필드 마스크는 업데이트할 필드를 제어하는 데 사용됩니다. 마스크가 없으면 모든 필드가 업데이트됩니다. |
UpdateEvaluationRequest
EvaluationService.UpdateEvaluation에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
evaluation |
필수 항목입니다. 업데이트할 평가입니다. |
update_mask |
(선택사항) 필드 마스크는 업데이트할 필드를 제어하는 데 사용됩니다. 마스크가 없으면 모든 필드가 업데이트됩니다. |
UpdateExampleRequest
AgentService.UpdateExample에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
example |
필수 항목입니다. 업데이트할 예시입니다. |
update_mask |
(선택사항) 필드 마스크는 업데이트할 필드를 제어하는 데 사용됩니다. 마스크가 없으면 모든 필드가 업데이트됩니다. |
UpdateGuardrailRequest
AgentService.UpdateGuardrail에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
guardrail |
필수 항목입니다. 업데이트할 가드레일입니다. |
update_mask |
(선택사항) 필드 마스크는 업데이트할 필드를 제어하는 데 사용됩니다. 마스크가 없으면 모든 필드가 업데이트됩니다. |
UpdateScheduledEvaluationRunRequest
EvaluationService.UpdateScheduledEvaluationRun에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
scheduled_evaluation_run |
필수 항목입니다. 업데이트할 예약된 평가 실행입니다. |
update_mask |
(선택사항) 필드 마스크는 업데이트할 필드를 제어하는 데 사용됩니다. 마스크가 없으면 모든 필드가 업데이트됩니다. |
UpdateSecuritySettingsRequest
AgentService.UpdateSecuritySettings에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
security_settings |
필수 항목입니다. 업데이트할 보안 설정입니다. |
update_mask |
(선택사항) 필드 마스크는 업데이트할 필드를 제어하는 데 사용됩니다. 마스크가 없으면 모든 필드가 업데이트됩니다. |
UpdateToolRequest
AgentService.UpdateTool에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
tool |
필수 항목입니다. 업데이트할 도구입니다. |
update_mask |
(선택사항) 필드 마스크는 업데이트할 필드를 제어하는 데 사용됩니다. 마스크가 없으면 모든 필드가 업데이트됩니다. |
UpdateToolsetRequest
AgentService.UpdateToolset에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
toolset |
필수 항목입니다. 업데이트할 도구 모음입니다. |
update_mask |
(선택사항) 필드 마스크는 업데이트할 필드를 제어하는 데 사용됩니다. 마스크가 없으면 모든 필드가 업데이트됩니다. |
UploadEvaluationAudioRequest
EvaluationService.UploadEvaluationAudio에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
name |
필수 항목입니다. 평가 오디오를 업로드할 평가의 리소스 이름입니다. 형식: |
audio_content |
필수 항목입니다. 원시 오디오 바이트입니다. 오디오 형식은 샘플링 레이트가 16kHz인 단일 채널 LINEAR16이어야 합니다 (기본 InputAudioConfig). |
previous_audio_gcs_uri |
(선택사항) 삭제할 이전에 업로드된 오디오 파일의 Google Cloud Storage URI입니다. 형식: |
UploadEvaluationAudioResponse
EvaluationService.UploadEvaluationAudio의 응답 메시지입니다.
| 필드 | |
|---|---|
audio_gcs_uri |
업로드된 오디오 파일이 저장된 Google Cloud Storage URI입니다. 형식: |
transcript |
Cloud Speech-to-Text로 생성된 오디오 스크립트입니다. |
duration |
오디오의 길이입니다. |
VpcScSettings
앱의 VPC-SC 설정입니다.
| 필드 | |
|---|---|
allowed_origins[] |
(선택사항) VPC 서비스 제어가 사용 설정된 경우 앱의 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 |
필수 항목입니다. 사용자가 2단계 인증을 위해 만든 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
사용 가능한 모든 위젯 유형입니다. 향후 이 enum에 새 값이 추가될 수 있습니다.
| 열거형 | |
|---|---|
WIDGET_TYPE_UNSPECIFIED |
지정되지 않은 위젯 유형입니다. |
CUSTOM |
맞춤 위젯 유형입니다. |
PRODUCT_CAROUSEL |
제품 캐러셀 위젯 |
PRODUCT_DETAILS |
제품 세부정보 위젯 |
QUICK_ACTIONS |
빠른 작업 위젯 |
PRODUCT_COMPARISON |
제품 비교 위젯입니다. |
ADVANCED_PRODUCT_DETAILS |
고급 제품 세부정보 위젯 |
SHORT_FORM |
짧은 형식 위젯입니다. |
OVERALL_SATISFACTION |
전반적인 만족도 위젯 |
ORDER_SUMMARY |
주문 요약 위젯 |
APPOINTMENT_DETAILS |
약속 세부정보 위젯입니다. |
APPOINTMENT_SCHEDULER |
약속 스케줄러 위젯 |
CONTACT_FORM |
문의 양식 위젯 |