색인
AgentService(인터페이스)SessionService(인터페이스)ToolService(인터페이스)WidgetService(인터페이스)Action(메시지)Action.EntityOperation(메시지)Action.EntityOperation.OperationType(열거형)Agent(메시지)Agent.AgentToolset(메시지)Agent.LlmAgent(메시지)Agent.RemoteDialogflowAgent(메시지)AgentTransfer(메시지)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.PersonaProperty(메시지)ChannelProfile.PersonaProperty.Persona(열거형)ChannelProfile.WebWidgetConfig(메시지)ChannelProfile.WebWidgetConfig.Modality(열거형)ChannelProfile.WebWidgetConfig.SecuritySettings(메시지)ChannelProfile.WebWidgetConfig.Theme(열거형)Chunk(메시지)Citations(메시지)Citations.CitedChunk(메시지)ClientCertificateSettings(메시지)ClientFunction(메시지)CloudLoggingSettings(메시지)CodeBlock(메시지)ConnectorTool(메시지)ConnectorToolset(메시지)Conversation(메시지)Conversation.ChannelType(열거형)Conversation.InputType(열거형)Conversation.Source(열거형)Conversation.Turn(메시지)ConversationLoggingSettings(메시지)CreateAgentRequest(메시지)CreateAppRequest(메시지)CreateAppVersionRequest(메시지)CreateDeploymentRequest(메시지)CreateExampleRequest(메시지)CreateGuardrailRequest(메시지)CreateToolRequest(메시지)CreateToolsetRequest(메시지)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.SummarizationConfig(메시지)DeleteAgentRequest(메시지)DeleteAppRequest(메시지)DeleteAppVersionRequest(메시지)DeleteConversationRequest(메시지)DeleteDeploymentRequest(메시지)DeleteExampleRequest(메시지)DeleteGuardrailRequest(메시지)DeleteToolRequest(메시지)DeleteToolsetRequest(메시지)Deployment(메시지)EndSession(메시지)EndUserAuthConfig(메시지)EndUserAuthConfig.Oauth2AuthCodeConfig(메시지)EndUserAuthConfig.Oauth2JwtBearerConfig(메시지)ErrorHandlingSettings(메시지)ErrorHandlingSettings.ErrorHandlingStrategy(열거형)EvaluationMetricsThresholds(메시지)EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds(메시지)EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.ExpectationLevelMetricsThresholds(메시지)EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds(메시지)EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds.SemanticSimilarityChannel(열거형)EvaluationMetricsThresholds.HallucinationMetricBehavior(열거형)EvaluationMetricsThresholds.ToolMatchingSettings(메시지)EvaluationMetricsThresholds.ToolMatchingSettings.ExtraToolCallBehavior(열거형)Event(메시지)Example(메시지)ExecuteToolRequest(메시지)ExecuteToolResponse(메시지)ExecutionType(열거형)ExportAppRequest(메시지)ExportAppRequest.ExportFormat(열거형)ExportAppResponse(메시지)ExpressionCondition(메시지)FileSearchTool(메시지)FileSearchTool.CorpusType(열거형)GenerateChatTokenRequest(메시지)GenerateChatTokenResponse(메시지)GetAgentRequest(메시지)GetAppRequest(메시지)GetAppVersionRequest(메시지)GetChangelogRequest(메시지)GetConversationRequest(메시지)GetDeploymentRequest(메시지)GetExampleRequest(메시지)GetGuardrailRequest(메시지)GetToolRequest(메시지)GetToolsetRequest(메시지)GoAway(메시지)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(메시지)Image(메시지)ImportAppRequest(메시지)ImportAppRequest.ImportOptions(메시지)ImportAppRequest.ImportOptions.ConflictResolutionStrategy(열거형)ImportAppResponse(메시지)InputAudioConfig(메시지)InterruptionSignal(메시지)LanguageSettings(메시지)ListAgentsRequest(메시지)ListAgentsResponse(메시지)ListAppVersionsRequest(메시지)ListAppVersionsResponse(메시지)ListAppsRequest(메시지)ListAppsResponse(메시지)ListChangelogsRequest(메시지)ListChangelogsResponse(메시지)ListConversationsRequest(메시지)ListConversationsResponse(메시지)ListDeploymentsRequest(메시지)ListDeploymentsResponse(메시지)ListExamplesRequest(메시지)ListExamplesResponse(메시지)ListGuardrailsRequest(메시지)ListGuardrailsResponse(메시지)ListToolsRequest(메시지)ListToolsResponse(메시지)ListToolsetsRequest(메시지)ListToolsetsResponse(메시지)LoggingSettings(메시지)McpTool(메시지)McpToolset(메시지)Message(메시지)MetricAnalysisSettings(메시지)ModelSettings(메시지)OAuthConfig(메시지)OAuthConfig.OauthGrantType(열거형)Omnichannel(메시지)OmnichannelIntegrationConfig(메시지)OmnichannelIntegrationConfig.CesAppConfig(메시지)OmnichannelIntegrationConfig.ChannelConfig(메시지)OmnichannelIntegrationConfig.RoutingConfig(메시지)OmnichannelIntegrationConfig.SubscriberConfig(메시지)OmnichannelIntegrationConfig.WhatsappConfig(메시지)OmnichannelOperationMetadata(메시지)OpenApiTool(메시지)OpenApiToolset(메시지)OperationMetadata(메시지)OutputAudioConfig(메시지)PythonCodeCondition(메시지)PythonFunction(메시지)RecognitionResult(메시지)RedactionConfig(메시지)RestoreAppVersionRequest(메시지)RestoreAppVersionResponse(메시지)RetrieveToolSchemaRequest(메시지)RetrieveToolSchemaResponse(메시지)RetrieveToolsRequest(메시지)RetrieveToolsResponse(메시지)RunSessionRequest(메시지)RunSessionResponse(메시지)Schema(메시지)Schema.Type(열거형)ServiceAccountAuthConfig(메시지)ServiceAgentIdTokenAuthConfig(메시지)ServiceDirectoryConfig(메시지)SessionConfig(메시지)SessionConfig.RemoteDialogflowQueryParameters(메시지)SessionInput(메시지)SessionOutput(메시지)SessionOutput.DiagnosticInfo(메시지)Span(메시지)SynthesizeSpeechConfig(메시지)SystemTool(메시지)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(메시지)UpdateDeploymentRequest(메시지)UpdateExampleRequest(메시지)UpdateGuardrailRequest(메시지)UpdateToolRequest(메시지)UpdateToolsetRequest(메시지)WebSearchQuery(메시지)WidgetTool(메시지)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 |
|---|
|
지정된 앱을 내보냅니다.
|
| GetAgent |
|---|
|
지정된 에이전트의 세부정보를 가져옵니다.
|
| GetApp |
|---|
|
지정된 앱의 세부정보를 가져옵니다.
|
| GetAppVersion |
|---|
|
지정된 앱 버전의 세부정보를 가져옵니다.
|
| GetChangelog |
|---|
|
지정된 변경 로그를 가져옵니다.
|
| GetConversation |
|---|
|
지정된 대화의 세부정보를 가져옵니다.
|
| GetDeployment |
|---|
|
지정된 배포의 세부정보를 가져옵니다.
|
| GetExample |
|---|
|
지정된 예의 세부정보를 가져옵니다.
|
| GetGuardrail |
|---|
|
지정된 가드레일의 세부정보를 가져옵니다.
|
| GetTool |
|---|
|
지정된 도구의 세부정보를 가져옵니다.
|
| GetToolset |
|---|
|
지정된 도구 모음의 세부정보를 가져옵니다.
|
| ImportApp |
|---|
|
지정된 앱을 가져옵니다.
|
| ListAgents |
|---|
|
지정된 앱의 에이전트를 나열합니다.
|
| ListAppVersions |
|---|
|
지정된 앱의 모든 앱 버전을 나열합니다.
|
| ListApps |
|---|
|
특정 프로젝트와 위치의 앱을 나열합니다.
|
| ListChangelogs |
|---|
|
지정된 앱의 변경사항을 나열합니다.
|
| ListConversations |
|---|
|
지정된 앱의 대화를 나열합니다.
|
| ListDeployments |
|---|
|
지정된 앱의 배포를 나열합니다.
|
| ListExamples |
|---|
|
지정된 앱의 예시를 나열합니다.
|
| ListGuardrails |
|---|
|
지정된 앱의 가이드라인을 나열합니다.
|
| ListTools |
|---|
|
지정된 앱의 도구를 나열합니다.
|
| ListToolsets |
|---|
|
지정된 앱의 툴셋을 나열합니다.
|
| RestoreAppVersion |
|---|
|
지정된 앱 버전을 복원합니다. 이렇게 하면 현재 초안 앱에서 새 앱 버전이 생성되고 현재 초안이 지정된 앱 버전으로 덮어쓰여집니다.
|
| UpdateAgent |
|---|
|
지정된 에이전트를 업데이트합니다.
|
| UpdateApp |
|---|
|
지정된 앱을 업데이트합니다.
|
| UpdateDeployment |
|---|
|
지정된 배포를 업데이트합니다.
|
| UpdateExample |
|---|
|
지정된 예시를 업데이트합니다.
|
| UpdateGuardrail |
|---|
|
지정된 가드레일을 업데이트합니다.
|
| UpdateTool |
|---|
|
지정된 도구를 업데이트합니다.
|
| UpdateToolset |
|---|
|
지정된 도구 모음을 업데이트합니다.
|
SessionService
세션 서비스는 CES 에이전트와 상호작용하기 위한 API를 제공합니다.
| BidiRunSession |
|---|
|
CES 에이전트와의 양방향 스트리밍 연결을 설정합니다. 에이전트는 연속적인 멀티모달 입력 (예: 텍스트, 오디오)을 처리하고 실시간 멀티모달 출력 스트림을 생성합니다. --- 클라이언트 요청 스트림 --- 클라이언트는 다음 순서로 요청을 스트리밍합니다.
--- 서버 응답 스트림 --- 각 상호작용 차례에서 상담사는 다음 순서로 메시지를 스트리밍합니다.
--- 오디오 권장사항 --- 1. 스트리밍: 무음 구간에서도
|
| RunSession |
|---|
|
세션 내에서 CES 에이전트와의 단일 턴 상호작용을 시작합니다.
|
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[] |
선택사항입니다. 상담사 트랜스퍼 규칙입니다. 일치하는 규칙이 여러 개 있으면 목록의 첫 번째 규칙이 사용됩니다. |
통합 필드 agent_type. 에이전트 유형입니다. agent_type은 다음 중 하나여야 합니다. |
|
llm_agent |
선택사항입니다. 기본 에이전트 유형입니다. |
remote_dialogflow_agent |
선택사항입니다. 에이전트 실행에 사용할 원격 Dialogflow 에이전트입니다. 이 필드가 설정되면 다른 모든 상담사 수준 속성은 무시됩니다. 참고: Dialogflow 에이전트가 앱과 다른 프로젝트에 있는 경우 CES 서비스 에이전트 |
AgentToolset
선택된 도구가 포함된 도구 세트입니다.
| 필드 | |
|---|---|
toolset |
필수 항목입니다. 툴셋의 리소스 이름입니다. 형식: |
tool_ids[] |
선택사항입니다. 도구 세트를 필터링할 도구 ID입니다. |
LlmAgent
이 유형에는 필드가 없습니다.
기본 에이전트 유형입니다. 에이전트는 에이전트에 지정된 요청 사항과 콜백을 사용하여 대규모 언어 모델을 통해 작업을 실행합니다.
RemoteDialogflowAgent
실행을 원격 Dialogflow CX 에이전트로 트랜스퍼할 에이전트입니다. Dialogflow 에이전트는 세션이 종료되거나 흐름이 종료되고 제어가 상위 CES 에이전트로 다시 전송될 때까지 후속 사용자 쿼리를 처리합니다.
| 필드 | |
|---|---|
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 에이전트에서 구성된 메시지 수준 인터럽션 설정을 준수할지 여부를 나타냅니다.
|
AgentTransfer
대화가 다른 상담사에게 트랜스퍼되었음을 나타내는 이벤트를 나타냅니다.
| 필드 | |
|---|---|
target_agent |
필수 항목입니다. 대화가 트랜스퍼되는 상담사입니다. 이 시점부터 상담사가 대화를 처리합니다. 형식: |
display_name |
출력 전용입니다. 에이전트의 표시 이름입니다. |
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 |
선택사항입니다. 앱의 기본 클라이언트 인증서 설정입니다. |
locked |
선택사항입니다. 앱이 변경사항에 대해 잠겨 있는지 여부를 나타냅니다. 앱이 잠겨 있으면 앱 리소스 수정이 거부됩니다. |
ToolExecutionMode
에이전트가 동시에 선택하는 도구가 여러 개인 경우 도구 실행 동작을 정의합니다.
| 열거형 | |
|---|---|
TOOL_EXECUTION_MODE_UNSPECIFIED |
지정되지 않은 도구 실행 모드입니다. 기본값은 PARALLEL입니다. |
PARALLEL |
선택된 도구가 여러 개인 경우 동일한 ToolContext로 병렬 실행됩니다. |
SEQUENTIAL |
선택된 도구가 여러 개인 경우 순차적으로 실행됩니다. 다음 도구는 이전 도구가 완료된 후에만 실행되며 이전 도구에서 업데이트된 ToolContext를 확인할 수 있습니다. |
VariableDeclaration
변수의 구조와 메타데이터를 정의합니다.
| 필드 | |
|---|---|
name |
필수 항목입니다. 변수의 이름입니다. 이름은 문자 또는 밑줄로 시작해야 하며 문자, 숫자, 밑줄만 포함할 수 있습니다. |
description |
필수 항목입니다. 변수에 대한 설명입니다. |
schema |
필수 항목입니다. 변수의 스키마입니다. |
AppSnapshot
앱의 스냅샷입니다.
| 필드 | |
|---|---|
app |
선택사항입니다. 앱의 기본 설정입니다. |
agents[] |
선택사항입니다. 앱의 에이전트 목록입니다. |
tools[] |
선택사항입니다. 앱의 도구 목록입니다. |
examples[] |
선택사항입니다. 앱의 예시 목록입니다. |
guardrails[] |
선택사항입니다. 앱의 가드레일 목록입니다. |
toolsets[] |
선택사항입니다. 앱의 도구 모음 목록입니다. |
AppVersion
고객 참여 스위트 (CES)에서 앱 버전은 특정 시점의 앱 스냅샷입니다. 변경할 수 없으며 생성 후 수정할 수 없습니다.
| 필드 | |
|---|---|
name |
식별자. 앱 버전의 고유 식별자입니다. 형식: |
display_name |
선택사항입니다. 앱 버전의 표시 이름입니다. |
description |
선택사항입니다. 앱 버전의 설명입니다. |
creator |
출력 전용입니다. 앱 버전을 만든 사용자의 이메일입니다. |
create_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 |
선택사항입니다. 합성된 에이전트 응답과 함께 재생되는 주변 소리의 구성으로, 대화의 자연스러움을 향상합니다. |
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 |
선택사항입니다. 상담사가 말하는 동안 사용자의 끼어들기를 사용 중지합니다. true인 경우 에이전트 응답 재생 중 사용자 입력이 무시됩니다. 지원 중단됨: ChannelProfile에서 |
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 데이터 세트입니다. |
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 |
선택사항입니다. 채널 프로필의 페르소나 속성입니다. |
disable_dtmf |
선택사항입니다. DTMF (듀얼 톤 다중 주파수)를 사용 중지할지 여부입니다. |
disable_barge_in_control |
선택사항입니다. 대화에서 사용자 끼어들기 제어를 사용 중지할지 여부입니다. - true: 에이전트가 말하는 동안 사용자 중단이 사용 중지됩니다. - false: 사용자가 언제 중단할 수 있는지에 대한 자동 제어가 에이전트에 유지됩니다. |
web_widget_config |
선택사항입니다. 웹 위젯의 구성입니다. |
noise_suppression_level |
선택사항입니다. 채널 프로필의 노이즈 제거 수준입니다. 사용 가능한 값은 'low', 'moderate', 'high', 'very_high'입니다. |
ChannelType
채널 프로필 유형입니다.
| 열거형 | |
|---|---|
UNKNOWN |
알 수 없는 채널 유형입니다. |
WEB_UI |
웹 UI 채널입니다. |
API |
API 채널입니다. |
TWILIO |
Twilio 채널입니다. |
GOOGLE_TELEPHONY_PLATFORM |
Google 전화 통신 플랫폼 채널 |
CONTACT_CENTER_AS_A_SERVICE |
서비스형 고객센터 (CCaaS) 채널입니다. |
FIVE9 |
Five9 채널 |
CONTACT_CENTER_INTEGRATION |
서드 파티 고객센터 통합 채널입니다. |
PersonaProperty
채널의 페르소나 속성을 나타냅니다.
| 필드 | |
|---|---|
persona |
선택사항입니다. 채널의 페르소나입니다. |
페르소나
채널의 페르소나입니다.
| 열거형 | |
|---|---|
UNKNOWN |
알 수 없는 페르소나입니다. |
CONCISE |
상담사는 간결하고 요점이 명확하게 대답합니다. |
CHATTY |
상담사가 추가 컨텍스트, 설명, 세부정보를 제공합니다. |
WebWidgetConfig
웹 위젯 구성 메시지입니다.
| 필드 | |
|---|---|
modality |
선택사항입니다. 웹 위젯의 모달리티입니다. |
theme |
선택사항입니다. 웹 위젯의 테마입니다. |
web_widget_title |
선택사항입니다. 웹 위젯의 제목입니다. |
security_settings |
선택사항입니다. 웹 위젯의 보안 설정입니다. |
형식
웹 위젯의 모달리티입니다.
| 열거형 | |
|---|---|
MODALITY_UNSPECIFIED |
알 수 없는 모달리티입니다. |
CHAT_AND_VOICE |
위젯은 채팅과 음성 입력을 모두 지원합니다. |
VOICE_ONLY |
위젯은 음성 입력만 지원합니다. |
CHAT_ONLY |
위젯은 채팅 입력만 지원합니다. |
SecuritySettings
웹 위젯의 보안 설정입니다.
| 필드 | |
|---|---|
enable_public_access |
선택사항입니다. 웹 위젯에 대한 공개 액세스가 사용 설정되어 있는지 여부를 나타냅니다. |
enable_origin_check |
선택사항입니다. 웹 위젯의 출처 확인이 사용 설정되었는지 나타냅니다. |
allowed_origins[] |
선택사항입니다. 웹 위젯을 호스팅할 수 있는 출처입니다. 출처는 RFC 6454에 의해 정의됩니다. 비어 있으면 모든 출처가 허용됩니다. 최대 100개의 출처가 허용됩니다. 예: 'https://example.com' |
enable_recaptcha |
선택사항입니다. 웹 위젯의 reCAPTCHA 인증이 사용 설정되어 있는지 여부를 나타냅니다. |
테마
웹 위젯의 테마입니다.
| 열거형 | |
|---|---|
THEME_UNSPECIFIED |
알 수 없는 테마입니다. |
LIGHT |
밝은 테마 |
DARK |
어두운 테마 |
Chunk
메시지 내 콘텐츠의 청크입니다.
| 필드 | |
|---|---|
통합 필드 data. 청크 데이터입니다. data은 다음 중 하나여야 합니다. |
|
text |
선택사항입니다. 텍스트 데이터. |
transcript |
선택사항입니다. 오디오와 연결된 스크립트입니다. |
blob |
선택사항입니다. BLOB 데이터입니다. |
payload |
선택사항입니다. 맞춤 페이로드 데이터입니다. |
image |
선택사항입니다. 이미지 데이터입니다. |
tool_call |
선택사항입니다. 도구 실행 요청입니다. |
tool_response |
선택사항입니다. 도구 실행 응답입니다. |
agent_transfer |
선택사항입니다. 상담사 트랜스퍼 이벤트입니다. |
updated_variables |
구조체는 변수 이름으로 키가 지정된 대화에서 업데이트된 변수를 나타냅니다. |
default_variables |
구조체는 대화 시작 시 기본 변수를 나타내며 변수 이름으로 키가 지정됩니다. |
인용
에이전트 응답과 연결된 인용입니다.
| 필드 | |
|---|---|
cited_chunks[] |
인용된 정보 목록입니다. |
CitedChunk
인용된 정보입니다.
| 필드 | |
|---|---|
uri |
인용에 사용된 URI입니다. |
title |
인용된 문서의 제목입니다. |
text |
인용에 사용된 텍스트입니다. |
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_AUDIO |
입력 메시지가 오디오입니다. |
INPUT_TYPE_IMAGE |
입력 메시지가 이미지입니다. |
INPUT_TYPE_BLOB |
입력 메시지가 blob 파일입니다. |
INPUT_TYPE_TOOL_RESPONSE |
입력 메시지는 클라이언트 함수 도구 응답입니다. |
INPUT_TYPE_VARIABLES |
입력 메시지는 변수입니다. |
소스
대화의 소스입니다.
| 열거형 | |
|---|---|
SOURCE_UNSPECIFIED |
지정되지 않은 소스입니다. |
LIVE |
실제 최종 사용자의 대화입니다. |
SIMULATOR |
대화가 시뮬레이터에서 시작됩니다. |
EVAL |
평가에서 가져온 대화입니다. |
Turn
대화의 단일 턴에 관한 모든 정보입니다.
| 필드 | |
|---|---|
messages[] |
선택사항입니다. 처리 중 사용자 입력, 에이전트 응답, 중간 이벤트를 포함한 대화 턴의 메시지 목록입니다. |
root_span |
선택사항입니다. 작업 처리의 루트 스팬입니다. |
ConversationLoggingSettings
앱의 대화 로깅 동작을 설명하는 설정입니다.
| 필드 | |
|---|---|
disable_conversation_logging |
선택사항입니다. 세션의 대화 로깅을 사용 중지할지 여부입니다. |
CreateAgentRequest
AgentService.CreateAgent에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
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 |
필수 항목입니다. 생성할 배포입니다. |
CreateExampleRequest
AgentService.CreateExample에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
parent |
필수 항목입니다. 예시를 만들 앱의 리소스 이름입니다. |
example_id |
선택사항입니다. 예에 사용할 ID이며, 예의 리소스 이름에서 마지막 구성요소가 됩니다. 제공되지 않으면 예시에 고유 ID가 자동으로 할당됩니다. |
example |
필수 항목입니다. 만들 예시입니다. |
CreateGuardrailRequest
AgentService.CreateGuardrail에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
parent |
필수 항목입니다. 가이드라인을 만들 앱의 리소스 이름입니다. |
guardrail_id |
선택사항입니다. 가드레일에 사용할 ID이며, 가드레일의 리소스 이름에서 마지막 구성요소가 됩니다. 제공되지 않으면 가드레일에 고유 ID가 자동으로 할당됩니다. |
guardrail |
필수 항목입니다. 만들 가드레일입니다. |
CreateToolRequest
AgentService.CreateTool에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
parent |
필수 항목입니다. 도구를 만들 앱의 리소스 이름입니다. |
tool_id |
선택사항입니다. 도구에 사용할 ID이며, 도구의 리소스 이름에서 마지막 구성요소가 됩니다. 제공되지 않으면 도구에 고유 ID가 자동으로 할당됩니다. |
tool |
필수 항목입니다. 만들 도구입니다. |
CreateToolsetRequest
AgentService.CreateToolset에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
parent |
필수 항목입니다. 툴셋을 만들 앱의 리소스 이름입니다. |
toolset_id |
선택사항입니다. 툴셋에 사용할 ID이며, 툴셋의 리소스 이름에서 마지막 구성요소가 됩니다. 제공되지 않으면 툴셋에 고유 ID가 자동으로 할당됩니다. |
toolset |
필수 항목입니다. 만들 도구 모음입니다. |
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
특정 DataStore 내에서 검색하기 위한 구성입니다.
| 필드 | |
|---|---|
filter |
선택사항입니다. DataStore의 필터 사양입니다. 참고: https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata |
data_store |
선택사항입니다. 데이터 스토어입니다. |
EngineSource
엔진 내 검색 구성으로, 특정 DataStore를 타겟팅할 수 있습니다.
| 필드 | |
|---|---|
engine |
필수 항목입니다. 엔진의 전체 리소스 이름입니다. 형식: |
data_store_sources[] |
선택사항입니다. 엔진 내에서 특정 데이터 스토어를 타겟팅하는 데 사용됩니다. 비어 있으면 검색이 엔진과 연결된 모든 데이터 스토어에 적용됩니다. |
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 |
선택사항입니다. 그라운딩 구성입니다. |
ModalityType
모달리티 유형입니다.
| 열거형 | |
|---|---|
MODALITY_TYPE_UNSPECIFIED |
지정되지 않은 모달리티 유형입니다. |
TEXT |
텍스트 형식입니다. |
AUDIO |
오디오 모달리티입니다. |
RewriterConfig
재작성기 구성입니다.
| 필드 | |
|---|---|
model_settings |
필수 항목입니다. LLM 모델의 구성입니다. |
prompt |
선택사항입니다. 프롬프트 정의입니다. 설정하지 않으면 기본 프롬프트가 사용됩니다. |
disabled |
선택사항입니다. 리라이터가 사용 중지되었는지 여부입니다. |
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 오류가 반환됩니다. |
DeleteExampleRequest
AgentService.DeleteExample에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
name |
필수 항목입니다. 삭제할 예의 리소스 이름입니다. |
etag |
선택사항입니다. 예의 현재 ETag입니다. etag가 제공되지 않으면 삭제로 인해 동시에 이루어진 변경사항이 덮어쓰여집니다. ETag가 제공되었으나 예의 현재 ETag와 일치하지 않으면 삭제가 차단되고 ABORTED 오류가 반환됩니다. |
DeleteGuardrailRequest
AgentService.DeleteGuardrail에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
name |
필수 항목입니다. 삭제할 가드레일의 리소스 이름입니다. |
force |
선택사항입니다. 앱/에이전트에서 여전히 참조하는 경우에도 가드레일을 강제로 삭제할지 여부를 나타냅니다.
|
etag |
선택사항입니다. 가드레일의 현재 ETag입니다. etag가 제공되지 않으면 삭제로 인해 동시에 이루어진 변경사항이 덮어쓰여집니다. etag가 제공되었으나 가드레일의 현재 etag와 일치하지 않으면 삭제가 차단되고 ABORTED 오류가 반환됩니다. |
DeleteToolRequest
AgentService.DeleteTool에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
name |
필수 항목입니다. 삭제할 도구의 리소스 이름입니다. |
force |
선택사항입니다. 에이전트/예시에서 여전히 참조되는 경우에도 도구를 강제로 삭제할지 여부를 나타냅니다.
|
etag |
선택사항입니다. 도구의 현재 ETag입니다. etag가 제공되지 않으면 삭제로 인해 동시에 이루어진 변경사항이 덮어쓰여집니다. ETag가 제공되었으나 도구의 현재 ETag와 일치하지 않으면 삭제가 차단되고 ABORTED 오류가 반환됩니다. |
DeleteToolsetRequest
AgentService.DeleteToolset에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
name |
필수 항목입니다. 삭제할 툴셋의 리소스 이름입니다. |
force |
선택사항입니다. 앱/에이전트에서 여전히 참조하는 경우에도 툴셋을 강제로 삭제할지 여부를 나타냅니다.
|
etag |
선택사항입니다. 툴셋의 현재 ETag입니다. etag가 제공되지 않으면 삭제로 인해 동시에 이루어진 변경사항이 덮어쓰여집니다. ETag가 제공되었으나 도구 세트의 현재 ETag와 일치하지 않으면 삭제가 차단되고 ABORTED 오류가 반환됩니다. |
배포
배포는 변경할 수 없고 쿼리할 수 있는 앱 버전을 나타냅니다. 특정 채널 프로필로 앱 버전을 배포하는 데 사용됩니다.
| 필드 | |
|---|---|
name |
식별자. 배포의 리소스 이름입니다. 형식: |
display_name |
필수 항목입니다. 배포의 표시 이름입니다. |
app_version |
선택사항입니다. 배포할 앱 버전의 리소스 이름입니다. 형식: |
channel_profile |
필수 항목입니다. 배포에 사용되는 채널 프로필입니다. |
create_time |
출력 전용입니다. 이 배포가 생성된 타임스탬프입니다. |
update_time |
출력 전용입니다. 이 배포가 마지막으로 업데이트된 타임스탬프입니다. |
etag |
출력 전용입니다. 읽기-수정-쓰기 작업 중에 객체가 변경되지 않았는지 확인하는 데 사용되는 Etag입니다. etag가 비어 있으면 업데이트가 동시에 발생한 변경사항을 덮어씁니다. |
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 |
필수 항목입니다. 통과할 클라이언트 매개변수 이름입니다. |
ErrorHandlingSettings
앱에서 오류를 처리하는 방법을 설명하는 설정입니다.
| 필드 | |
|---|---|
error_handling_strategy |
선택사항입니다. 오류 처리에 사용할 전략입니다. |
ErrorHandlingStrategy
오류 처리 전략을 정의합니다.
| 열거형 | |
|---|---|
ERROR_HANDLING_STRATEGY_UNSPECIFIED |
지정되지 않은 오류 처리 전략입니다. 기본값은 FALLBACK_RESPONSE입니다. |
NONE |
특정 처리가 사용 설정되지 않았습니다. |
FALLBACK_RESPONSE |
LLM 오류가 발생하면 대체 메시지가 사용자에게 반환됩니다. |
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 |
추가 도구 호출을 허용합니다. |
이벤트
이벤트 입력입니다.
| 필드 | |
|---|---|
event |
필수 항목입니다. 이벤트 이름입니다. |
예
예시는 사용자와 에이전트 간의 샘플 대화를 나타냅니다.
| 필드 | |
|---|---|
name |
식별자. 예의 고유 식별자입니다. 형식: |
display_name |
필수 항목입니다. 예의 표시 이름입니다. |
description |
선택사항입니다. 예에 대한 인간이 읽을 수 있는 설명입니다. |
entry_agent |
선택사항입니다. 대화를 처음 처리하는 상담사입니다. 지정하지 않으면 예시가 루트 에이전트가 처리하는 대화를 나타냅니다. 형식: |
messages[] |
선택사항입니다. 대화를 구성하는 메시지 모음입니다. |
create_time |
출력 전용입니다. 예가 생성된 타임스탬프입니다. |
update_time |
출력 전용입니다. 예가 마지막으로 업데이트된 타임스탬프입니다. |
invalid |
출력 전용입니다. 참조 리소스가 삭제되면 예가 무효화될 수 있습니다. 잘못된 예는 퓨샷 예로 사용되지 않습니다. |
etag |
읽기-수정-쓰기 작업 중에 객체가 변경되지 않았는지 확인하는 데 사용되는 Etag입니다. etag가 비어 있으면 업데이트가 동시에 발생한 변경사항을 덮어씁니다. |
ExecuteToolRequest
ToolService.ExecuteTool에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
parent |
필수 항목입니다. 도구/툴셋이 속한 앱의 리소스 이름입니다. 형식: |
args |
선택사항입니다. JSON 객체 형식의 도구 입력 매개변수와 값입니다. |
variables |
선택사항입니다. 도구 실행에 사용할 수 있는 변수입니다. |
통합 필드 tool_identifier. 실행할 도구의 식별자입니다. 지속형 도구 또는 도구 세트의 도구일 수 있습니다. tool_identifier은 다음 중 하나여야 합니다. |
|
tool |
선택사항입니다. 실행할 도구의 이름입니다. 형식: projects/{project}/locations/{location}/apps/{app}/tools/{tool} |
toolset_tool |
선택사항입니다. 실행할 도구 세트 도구입니다. 도구 세트의 조건자와 일치하는 도구는 하나만 있어야 합니다. 그렇지 않으면 오류가 반환됩니다. |
ExecuteToolResponse
ToolService.ExecuteTool의 응답 메시지입니다.
| 필드 | |
|---|---|
response |
JSON 객체 형식의 도구 실행 결과입니다. 'output' 키를 사용하여 도구 응답을 지정하고 'error' 키를 사용하여 오류 세부정보를 지정합니다 (있는 경우). 'output' 및 'error' 키가 지정되지 않은 경우 전체 'response'가 도구 실행 결과로 처리됩니다. |
variables |
도구 실행이 끝날 때의 변수 값입니다. |
통합 필드 tool_identifier. 실행된 도구의 식별자입니다. tool_identifier은 다음 중 하나여야 합니다. |
|
tool |
실행된 도구의 이름입니다. 형식: |
toolset_tool |
실행된 도구 세트 도구입니다. |
ExecutionType
도구 또는 도구 모음의 실행 유형입니다.
| 열거형 | |
|---|---|
EXECUTION_TYPE_UNSPECIFIED |
실행 유형이 지정되지 않았습니다. 지정되지 않은 경우 기본값은 SYNCHRONOUS입니다. |
SYNCHRONOUS |
도구는 동기식으로 실행됩니다. 세션은 도구가 반환될 때까지 차단됩니다. |
ASYNCHRONOUS |
이 도구는 비동기적으로 실행됩니다. 도구가 실행되는 동안 세션이 계속됩니다. |
ExportAppRequest
AgentService.ExportApp에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
name |
필수 항목입니다. 내보낼 앱의 리소스 이름입니다. |
export_format |
필수 항목입니다. 앱을 내보낼 형식입니다. |
gcs_uri |
선택사항입니다. 앱을 내보낼 Google Cloud Storage URI입니다. 이 URI의 형식은 |
ExportFormat
앱의 내보내기 형식입니다.
| 열거형 | |
|---|---|
EXPORT_FORMAT_UNSPECIFIED |
내보내기 형식이 지정되지 않았습니다. |
JSON |
내보내기 형식은 JSON입니다. |
YAML |
내보내기 형식은 YAML입니다. |
ExportAppResponse
AgentService.ExportApp의 응답 메시지입니다.
| 필드 | |
|---|---|
통합 필드 app. 내보낸 앱입니다. app은 다음 중 하나여야 합니다. |
|
app_content |
앱 폴더가 ZIP 파일로 압축되어 있습니다. |
app_uri |
앱이 내보내진 Google Cloud Storage URI입니다. |
ExpressionCondition
세션 상태를 기반으로 하는 표현식 조건입니다.
| 필드 | |
|---|---|
expression |
필수 항목입니다. cloud.api.Expression 조건의 문자열 표현입니다. |
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 |
코퍼스는 에이전트에 의해 생성됩니다. |
GenerateChatTokenRequest
WidgetService.GenerateChatToken에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
name |
필수 항목입니다. 채팅 토큰을 생성할 세션 이름입니다. 형식: projects/{project}/locations/{location}/apps/{app}/sessions/{session} |
deployment |
필수 항목입니다. 세션에 사용할 앱의 배포입니다. 형식: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment} |
recaptcha_token |
선택사항입니다. 클라이언트 측 채팅 위젯에서 생성된 reCAPTCHA 토큰입니다. |
GenerateChatTokenResponse
WidgetService.GenerateChatToken의 응답 메시지입니다.
| 필드 | |
|---|---|
chat_token |
세션 API로 인증하기 위한 채팅 위젯의 세션 범위 토큰입니다. |
expire_time |
채팅 토큰이 만료되는 시간입니다. |
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 |
필수 항목입니다. 배포 이름입니다. 형식: |
GetExampleRequest
AgentService.GetExample에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
name |
필수 항목입니다. 가져올 예의 리소스 이름입니다. |
GetGuardrailRequest
AgentService.GetGuardrail에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
name |
필수 항목입니다. 가져올 가드레일의 리소스 이름입니다. |
GetToolRequest
AgentService.GetTool에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
name |
필수 항목입니다. 가져올 도구의 리소스 이름입니다. |
GetToolsetRequest
AgentService.GetToolset에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
name |
필수 항목입니다. 가져올 도구 세트의 리소스 이름입니다. |
GoAway
이 유형에는 필드가 없습니다.
서버가 곧 연결을 끊을 것이므로 클라이언트가 연결을 절반 닫고 다시 시작해야 함을 나타냅니다.
GoogleSearchSuggestions
Google Search Tool의 추천 검색어
| 필드 | |
|---|---|
htmls[] |
추천 검색어에 대한 규정을 준수하는 HTML 및 CSS 스타일입니다. 제공된 HTML 및 CSS는 기기 설정에 따라 자동으로 조정되어 |
web_search_queries[] |
Google 검색을 수행하는 데 사용된 쿼리 목록과 검색 추천을 구성하는 검색 결과 URI입니다. |
GoogleSearchTool
그라운딩을 위해 Google 웹 검색을 실행하는 도구를 나타냅니다. https://cloud.google.com/customer-engagement-ai/conversational-agents/ps/tool#google-search를 참고하세요.
| 필드 | |
|---|---|
name |
필수 항목입니다. 도구의 이름입니다. |
description |
선택사항입니다. 도구의 목적에 관한 설명입니다. |
context_urls[] |
선택사항입니다. 콘텐츠는 컨텍스트와 그라운딩을 위해 이러한 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 |
선택사항입니다. 콜백 실행 결과에 따라 대화를 차단할 수 있는 가드레일입니다. |
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 |
피해 카테고리는 음란물입니다. |
SafetySetting
안전 설정
| 필드 | |
|---|---|
category |
필수 항목입니다. 피해 카테고리입니다. |
threshold |
필수 항목입니다. 피해 차단 기준점입니다. |
이미지
대화의 이미지 입력 또는 출력을 나타냅니다.
| 필드 | |
|---|---|
mime_type |
필수 항목입니다. 소스 데이터의 IANA 표준 MIME 유형입니다. 지원되는 이미지 유형은 다음과 같습니다. * image/png * image/jpeg * image/webp |
data |
필수 항목입니다. 이미지의 원시 바이트입니다. |
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 파일을 나타내는 원시 바이트입니다. |
ImportOptions
앱 가져오기 프로세스의 구성 옵션입니다. 이 옵션은 특히 기존 앱 데이터와 충돌이 발생할 때 가져오기가 작동하는 방식을 제어합니다.
| 필드 | |
|---|---|
conflict_resolution_strategy |
선택사항입니다. 가져오기 중에 충돌을 해결할 때 사용할 전략입니다. |
ConflictResolutionStrategy
ID가 동일한 앱이 이미 있거나 가져온 리소스 (예: 에이전트, 도구 등)의 표시 이름이 해당 앱 내의 기존 리소스와 동일한 경우 충돌을 처리하는 전략을 정의합니다.
| 열거형 | |
|---|---|
CONFLICT_RESOLUTION_STRATEGY_UNSPECIFIED |
충돌 해결 전략이 지정되지 않았습니다. |
REPLACE |
기존 데이터를 가져온 데이터로 대체합니다. app_id이 동일한 앱이 이미 있는 경우 가져온 앱을 기반으로 콘텐츠가 업데이트됩니다. - 가져온 앱의 리소스 (앱, 에이전트, 도구, 예시, 가드레일, 도구 모음) 중 기존 리소스와 표시 이름이 동일한 리소스는 기존 리소스를 덮어씁니다. - 새 표시 이름이 있는 가져온 리소스가 생성됩니다. - 가져온 앱에 일치하는 표시 이름이 없는 기존 리소스는 그대로 유지됩니다. |
OVERWRITE |
가져온 데이터로 기존 데이터를 덮어씁니다. app_id이 동일한 앱이 이미 있는 경우 가져온 앱으로 콘텐츠가 덮어쓰여집니다. - 앱의 기존 리소스 (에이전트, 도구, 예시, 가드레일, 도구 모음)가 삭제됩니다. - 가져온 리소스는 새 리소스로 생성됩니다. |
ImportAppResponse
AgentService.ImportApp의 응답 메시지입니다.
| 필드 | |
|---|---|
name |
가져온 앱의 리소스 이름입니다. |
warnings[] |
가져오기 프로세스 중에 생성된 경고 메시지입니다. 특정 리소스에 오류가 발생하면 가져온 앱에 포함되지 않으며 오류가 여기에 언급됩니다. |
InputAudioConfig
InputAudioConfig는 CES 에이전트가 수신되는 오디오 데이터를 해석하는 방법을 구성합니다.
| 필드 | |
|---|---|
audio_encoding |
필수 항목입니다. 입력 오디오 데이터의 인코딩입니다. |
sample_rate_hertz |
필수 항목입니다. 입력 오디오 데이터의 샘플링 레이트 (Hz)입니다. |
noise_suppression_level |
선택사항입니다. 입력 오디오에서 주변 소음 제거를 사용 설정할지 여부입니다. 사용 가능한 값은 'low', 'moderate', 'high', 'very_high'입니다. |
InterruptionSignal
에이전트의 오디오 응답이 중단되었음을 나타냅니다. 클라이언트는 현재 오디오 재생을 즉시 중지해야 합니다 (예: 사용자 끼어들기 또는 새로운 상담사 응답이 생성됨).
| 필드 | |
|---|---|
barge_in |
사용자 끼어들기 이벤트로 인해 중단이 발생했는지 여부입니다. |
LanguageSettings
앱의 언어 설정입니다.
| 필드 | |
|---|---|
default_language_code |
선택사항입니다. 앱의 기본 언어 코드입니다. |
supported_language_codes[] |
선택사항입니다. |
enable_multilingual_support |
선택사항입니다. 다국어 지원을 사용 설정합니다. true인 경우 앱의 에이전트가 사전 빌드된 안내를 사용하여 다국어 입력 처리를 개선합니다. |
fallback_action |
선택사항입니다. 상담사가 지원되지 않는 언어로 입력을 받는 경우 수행할 작업입니다. 사전 정의된 작업 또는 맞춤 도구 호출일 수 있습니다. 유효한 값은 다음과 같습니다. - 특정 도구 실행을 트리거하는 도구의 전체 리소스 이름 - '에스컬레이션' 또는 '종료'와 같은 사전 정의된 시스템 작업으로, 대화를 종료하기 위해 해당 |
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 |
다음 페이지를 검색하기 위해 |
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 |
다음 페이지를 검색하기 위해 |
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 |
선택사항입니다. 오디오 상호작용을 녹음하는 방식에 관한 구성입니다. |
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 도구의 이름입니다. |
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의 서비스 디렉터리 구성입니다. |
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 구성입니다. 클라이언트가 신뢰해야 하는 맞춤 서버 인증서를 포함합니다. |
메시지
대화 내의 메시지입니다.
| 필드 | |
|---|---|
role |
선택사항입니다. 대화 내 역할(예: 사용자, 에이전트)입니다. |
chunks[] |
선택사항입니다. 메시지의 콘텐츠(일련의 청크). |
event_time |
선택사항입니다. 메일이 전송 또는 수신된 시점의 타임스탬프입니다. 메시지가 |
MetricAnalysisSettings
LLM 분석 측정항목 파이프라인의 대화 데이터 수집 동작을 설명하는 설정입니다.
| 필드 | |
|---|---|
llm_metrics_opted_out |
선택사항입니다. llm 분석 측정항목을 위해 대화 데이터를 수집할지 여부입니다. true인 경우 llm 분석 측정항목에 대한 대화 데이터가 수집되지 않습니다. 그렇지 않으면 대화 데이터가 수집됩니다. |
ModelSettings
모델 설정에는 LLM 모델의 다양한 구성이 포함되어 있습니다.
| 필드 | |
|---|---|
model |
선택사항입니다. 에이전트가 사용해야 하는 LLM 모델입니다. 설정하지 않으면 에이전트가 상위 에이전트의 모델을 상속합니다. |
temperature |
선택사항입니다. 설정된 경우 이 온도가 LLM 모델에 사용됩니다. 온도는 모델 응답의 무작위성을 제어합니다. 온도가 낮을수록 더 예측 가능한 대답이 생성됩니다. 온도가 높을수록 더 창의적인 대답이 생성됩니다. |
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 |
클라이언트 사용자 인증 정보 흐름을 나타냅니다. |
옴니채널
옴니채널 리소스를 나타냅니다.
| 필드 | |
|---|---|
name |
식별자. 옴니채널 리소스의 고유 식별자입니다. 형식: |
display_name |
필수 항목입니다. 옴니채널 리소스의 표시 이름입니다. |
description |
선택사항입니다. 옴니채널 리소스에 대한 사람이 읽을 수 있는 설명입니다. |
create_time |
출력 전용입니다. 옴니채널 리소스가 생성된 타임스탬프입니다. |
update_time |
출력 전용입니다. 옴니채널 리소스가 마지막으로 업데이트된 타임스탬프입니다. |
etag |
출력 전용입니다. 읽기-수정-쓰기 작업 중에 객체가 변경되지 않았는지 확인하는 데 사용되는 Etag입니다. |
integration_config |
선택사항입니다. 옴니채널 리소스의 통합 구성입니다. |
OmnichannelIntegrationConfig
OmnichannelIntegrationConfig에는 모든 앱 통합 구성이 포함됩니다.
| 필드 | |
|---|---|
channel_configs |
선택사항입니다. 앱 이벤트를 처리하기 위한 다양한 구성입니다. |
subscriber_configs |
선택사항입니다. 다양한 구독자 구성 |
routing_configs |
선택사항입니다. routing_configs의 키는 |
CesAppConfig
CES 앱 구성
| 필드 | |
|---|---|
app |
CES 앱의 고유 식별자입니다. 형식: |
ChannelConfig
ChannelConfig에는 다양한 앱 통합의 구성이 포함되어 있습니다.
| 필드 | |
|---|---|
통합 필드 channel_config. 앱의 구성입니다. channel_config은 다음 중 하나여야 합니다. |
|
whatsapp_config |
WhatsApp 구성 |
RoutingConfig
라우팅 구성은 앱 이벤트를 구독자에게 라우팅하는 방법/대상을 지정합니다.
| 필드 | |
|---|---|
subscriber_key |
구독자의 키입니다. |
SubscriberConfig
구독자의 구성입니다.
| 필드 | |
|---|---|
통합 필드 subscriber_config. 구독자의 구성입니다. subscriber_config은 다음 중 하나여야 합니다. |
|
ces_app_config |
Ces app config. |
WhatsappConfig
옴니채널이 WhatsApp에서 이벤트를 수신/답장하는 방법입니다.
| 필드 | |
|---|---|
phone_number_id |
WhatsApp Business 계정과 연결된 전화번호 ID입니다. |
phone_number |
메시지를 보내거나 받는 데 사용되는 전화번호입니다. |
whatsapp_business_account_id |
고객의 WhatsApp Business 계정 (WABA) ID입니다. |
webhook_verify_token |
웹훅 확인을 위해 Meta 앱 대시보드에서 구성된 토큰을 확인합니다. |
whatsapp_business_token |
WhatsApp Cloud API에 대한 API 호출을 인증하기 위한 액세스 토큰입니다. https://developers.facebook.com/docs/whatsapp/business-management-api/get-started/#business-integration-system-user-access-tokens |
meta_business_portfolio_id |
Meta 비즈니스 포트폴리오 (MBP) ID입니다. https://www.facebook.com/business/help/1710077379203657 |
OmnichannelOperationMetadata
장기 실행 작업의 메타데이터를 나타냅니다.
| 필드 | |
|---|---|
create_time |
출력 전용입니다. 작업이 생성된 시간입니다. |
end_time |
출력 전용입니다. 작업 실행이 완료된 시간입니다. |
status_message |
출력 전용입니다. 상태에 대한 인간이 읽을 수 있는 상태입니다(존재하는 경우). |
requested_cancellation |
출력 전용입니다. 사용자가 작업 취소를 요청했는지를 나타냅니다. |
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 |
출력 전용입니다. 사용자가 작업 취소를 요청했는지를 나타냅니다. 성공적으로 취소된 작업에는 |
OutputAudioConfig
OutputAudioConfig는 CES 에이전트가 나가는 오디오 응답을 합성하는 방식을 구성합니다.
| 필드 | |
|---|---|
audio_encoding |
필수 항목입니다. 출력 오디오 데이터의 인코딩입니다. |
sample_rate_hertz |
필수 항목입니다. 출력 오디오 데이터의 샘플링 레이트 (Hz)입니다. |
PythonCodeCondition
조건을 평가하는 Python 코드 블록입니다.
| 필드 | |
|---|---|
python_code |
필수 항목입니다. 실행할 Python 코드입니다. |
PythonFunction
Python 함수 도구입니다.
| 필드 | |
|---|---|
name |
선택사항입니다. 실행할 Python 함수의 이름입니다. Python 코드에 정의된 Python 함수 이름과 일치해야 합니다. 대소문자를 구분합니다. 이름이 제공되지 않으면 Python 코드에 정의된 첫 번째 함수가 사용됩니다. |
python_code |
선택사항입니다. 도구에 대해 실행할 Python 코드입니다. |
description |
출력 전용입니다. Python 코드의 문서 문자열에서 파싱된 Python 함수의 설명입니다. |
RecognitionResult
오디오 입력의 음성 인식 결과입니다.
| 필드 | |
|---|---|
transcript |
선택사항입니다. 현재 턴 중에 캡처된 연결된 사용자 음성 세그먼트입니다. |
RedactionConfig
민감한 정보를 처리하는 방법을 안내하는 구성입니다.
| 필드 | |
|---|---|
enable_redaction |
선택사항입니다. true인 경우 대화 기록, Cloud Logging, 오디오 녹음 등 다양한 로깅 시나리오에 수정이 적용됩니다. |
inspect_template |
선택사항입니다. 민감한 정보 유형의 감지를 구성하는 DLP 검사 템플릿 이름입니다. 형식: |
deidentify_template |
선택사항입니다. 콘텐츠를 익명화하는 방법을 안내하는 DLP 익명화 템플릿 이름입니다. 형식: |
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[] |
선택사항입니다. 툴셋에서 가져올 도구의 식별자입니다. 비어 있으면 도구 세트의 모든 도구가 반환됩니다. |
RetrieveToolsResponse
ToolService.RetrieveTools의 응답 메시지입니다.
| 필드 | |
|---|---|
tools[] |
지정된 도구 세트에 포함된 도구 목록입니다. |
RunSessionRequest
SessionService.RunSession에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
config |
필수 항목입니다. 세션의 구성입니다. |
inputs[] |
필수 항목입니다. 세션의 입력입니다. |
RunSessionResponse
SessionService.RunSession의 응답 메시지입니다.
| 필드 | |
|---|---|
outputs[] |
세션의 출력입니다. |
스키마
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 |
배열 유형입니다. |
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'). |
remote_dialogflow_query_parameters |
선택사항입니다. 세션 제어가 원격 에이전트로 트랜스퍼될 때 원격 Dialogflow 에이전트로 전송할 QueryParameters입니다. |
RemoteDialogflowQueryParameters
세션 제어가 원격 에이전트로 트랜스퍼될 때 원격 Dialogflow 에이전트로 전송할 QueryParameters입니다.
| 필드 | |
|---|---|
webhook_headers |
선택사항입니다. QueryParameters에서 webhook_headers로 전송될 HTTP 헤더입니다. |
payload |
선택사항입니다. QueryParameters로 전송할 페이로드입니다. |
end_user_metadata |
선택사항입니다. QueryParameters에 전송할 최종 사용자 메타데이터입니다. |
SessionInput
세션의 입력입니다.
| 필드 | |
|---|---|
will_continue |
선택사항입니다. 현재 메시지가 양방향 스트리밍 세션에서 더 큰 입력의 프래그먼트인지 나타내는 플래그입니다.
참고: 이 필드는 오디오 및 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 에이전트의 구조화된 출력이 포함된 맞춤 페이로드 |
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] 범위를 벗어난 값은 오류를 반환합니다. |
SystemTool
사전 정의된 시스템 도구입니다.
| 필드 | |
|---|---|
name |
필수 항목입니다. 시스템 도구의 이름입니다. |
description |
출력 전용입니다. 시스템 도구의 설명입니다. |
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 서버 인증서가 '제목 대체 이름'으로 서명되었는지 확인하세요. 예를 들어 다음 명령어를 사용하여 인증서를 자체 서명할 수 있습니다. openssl x509 -req -days 200 -in example.com.csr \ -signkey example.com.key \ -out example.com.crt \ -extfile <(printf "\nsubjectAltName='DNS:www.example.com'") |
도구
도구는 CES 상담사가 특정 목표를 달성하기 위해 취할 수 있는 작업을 나타냅니다.
| 필드 | |
|---|---|
name |
식별자. 도구의 고유 식별자입니다. 형식: -
|
display_name |
출력 전용입니다. 도구의 유형에 따라 파생된 도구의 표시 이름입니다. 예를 들어 [ClientFunction][Tool.ClientFunction] 의 표시 이름은 |
execution_type |
선택사항입니다. 도구의 실행 유형입니다. |
create_time |
출력 전용입니다. 도구가 생성된 타임스탬프입니다. |
update_time |
출력 전용입니다. 도구가 마지막으로 업데이트된 타임스탬프입니다. |
etag |
읽기-수정-쓰기 작업 중에 객체가 변경되지 않았는지 확인하는 데 사용되는 Etag입니다. etag가 비어 있으면 업데이트가 동시에 발생한 변경사항을 덮어씁니다. |
generated_summary |
출력 전용입니다. 도구가 LLM 어시스턴트에 의해 생성된 경우 이 필드에는 생성에 관한 설명 요약이 포함됩니다. |
tool_fake_config |
선택사항입니다. 가짜 모드에서 도구 동작의 구성입니다. |
통합 필드 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 |
선택사항입니다. 시스템 도구 |
widget_tool |
선택사항입니다. 위젯 도구 |
ToolCall
클라이언트 또는 에이전트가 지정된 도구를 실행하도록 요청합니다.
| 필드 | |
|---|---|
id |
선택사항입니다. 도구 호출의 고유 식별자입니다. 채워진 경우 클라이언트는 |
display_name |
출력 전용입니다. 도구의 표시 이름입니다. |
args |
선택사항입니다. JSON 객체 형식의 도구 입력 매개변수와 값입니다. |
통합 필드 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'가 도구 실행 결과로 처리됩니다. |
통합 필드 tool_identifier. 실행된 도구의 식별자입니다. 지속형 도구 또는 도구 세트의 도구일 수 있습니다. tool_identifier은 다음 중 하나여야 합니다. |
|
tool |
선택사항입니다. 실행할 도구의 이름입니다. 형식: |
toolset_tool |
선택사항입니다. 실행된 도구 세트 도구입니다. |
ToolResponses
클라이언트에서 요청한 도구 호출의 실행 결과입니다.
| 필드 | |
|---|---|
tool_responses[] |
선택사항입니다. 도구 실행 결과 목록입니다. |
툴셋
툴셋은 에이전트가 사용할 수 있는 동적으로 관리되는 도구 그룹을 나타냅니다.
| 필드 | |
|---|---|
name |
식별자. 툴셋의 고유 식별자입니다. 형식: |
display_name |
선택사항입니다. 툴셋의 표시 이름입니다. 동일한 앱 내에서 고유해야 합니다. |
description |
선택사항입니다. 툴셋에 대한 설명입니다. |
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 |
선택사항입니다. 필드 마스크는 업데이트되는 필드를 제어하는 데 사용됩니다. 마스크가 없으면 모든 필드가 업데이트됩니다. |
UpdateDeploymentRequest
AgentService.UpdateDeployment에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
deployment |
필수 항목입니다. 업데이트할 배포입니다. |
update_mask |
선택사항입니다. 업데이트할 필드 목록입니다. |
UpdateExampleRequest
AgentService.UpdateExample에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
example |
필수 항목입니다. 업데이트할 예입니다. |
update_mask |
선택사항입니다. 필드 마스크는 업데이트되는 필드를 제어하는 데 사용됩니다. 마스크가 없으면 모든 필드가 업데이트됩니다. |
UpdateGuardrailRequest
AgentService.UpdateGuardrail에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
guardrail |
필수 항목입니다. 업데이트할 가드레일입니다. |
update_mask |
선택사항입니다. 필드 마스크는 업데이트되는 필드를 제어하는 데 사용됩니다. 마스크가 없으면 모든 필드가 업데이트됩니다. |
UpdateToolRequest
AgentService.UpdateTool에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
tool |
필수 항목입니다. 업데이트할 도구입니다. |
update_mask |
선택사항입니다. 필드 마스크는 업데이트되는 필드를 제어하는 데 사용됩니다. 마스크가 없으면 모든 필드가 업데이트됩니다. |
UpdateToolsetRequest
AgentService.UpdateToolset에 대한 요청 메시지입니다.
| 필드 | |
|---|---|
toolset |
필수 항목입니다. 업데이트할 툴셋입니다. |
update_mask |
선택사항입니다. 필드 마스크는 업데이트되는 필드를 제어하는 데 사용됩니다. 마스크가 없으면 모든 필드가 업데이트됩니다. |
WebSearchQuery
단일 웹 검색어와 연결된 검색 URI를 나타냅니다.
| 필드 | |
|---|---|
query |
검색어 텍스트입니다. |
uri |
질문에 대한 Google 검색 결과 페이지의 URI입니다. |
WidgetTool
에이전트가 호출할 수 있는 위젯 도구를 나타냅니다. 상담사가 도구를 선택하면 상담사가 위젯을 클라이언트에게 반환합니다. 클라이언트는 위젯을 처리하고 에이전트와의 상호작용을 계속하기 위한 다음 사용자 쿼리를 생성해야 합니다.
| 필드 | |
|---|---|
name |
필수 항목입니다. 위젯 도구의 표시 이름입니다. |
description |
선택사항입니다. 위젯 도구의 설명입니다. |
widget_type |
선택사항입니다. 위젯 도구의 유형입니다. 지정하지 않으면 기본 유형은 CUSTOMIZED입니다. |
통합 필드 input. 위젯 도구의 입력입니다. input은 다음 중 하나여야 합니다. |
|
parameters |
선택사항입니다. 위젯 도구의 입력 매개변수입니다. |
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 |
문의 양식 위젯 |