REST Resource: projects.locations.apps

리소스: App

앱은 루트 에이전트와 하위 에이전트, 관련 구성을 비롯한 에이전트 그룹의 최상위 컨테이너 역할을 합니다. 이러한 에이전트는 앱 컨텍스트 내에서 특정 목표를 달성하기 위해 함께 작동합니다.

JSON 표현 
{
  "name": string,
  "displayName": string,
  "description": string,
  "pinned": boolean,
  "rootAgent": string,
  "languageSettings": {
    object (LanguageSettings)
  },
  "timeZoneSettings": {
    object (TimeZoneSettings)
  },
  "audioProcessingConfig": {
    object (AudioProcessingConfig)
  },
  "loggingSettings": {
    object (LoggingSettings)
  },
  "errorHandlingSettings": {
    object (ErrorHandlingSettings)
  },
  "modelSettings": {
    object (ModelSettings)
  },
  "toolExecutionMode": enum (App.ToolExecutionMode),
  "evaluationMetricsThresholds": {
    object (EvaluationMetricsThresholds)
  },
  "variableDeclarations": [
    {
      object (App.VariableDeclaration)
    }
  ],
  "predefinedVariableDeclarations": [
    {
      object (App.VariableDeclaration)
    }
  ],
  "globalInstruction": string,
  "guardrails": [
    string
  ],
  "dataStoreSettings": {
    object (DataStoreSettings)
  },
  "defaultChannelProfile": {
    object (ChannelProfile)
  },
  "metadata": {
    string: string,
    ...
  },
  "createTime": string,
  "updateTime": string,
  "etag": string,
  "deploymentCount": integer,
  "clientCertificateSettings": {
    object (ClientCertificateSettings)
  },
  "locked": boolean
}
필드
name

string

식별자. 앱의 고유 식별자입니다. 형식: projects/{project}/locations/{location}/apps/{app}
displayName

string

필수 항목입니다. 앱의 표시 이름입니다.
description

string

선택사항입니다. 인간이 읽을 수 있는 앱 설명입니다.
pinned

boolean

선택사항입니다. 앱이 앱 목록에 고정되어 있는지 여부입니다.
rootAgent

string

선택사항입니다. 루트 에이전트는 앱의 진입점입니다. 형식: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
languageSettings

object (LanguageSettings)

선택사항입니다. 앱의 언어 설정입니다.
timeZoneSettings

object (TimeZoneSettings)

선택사항입니다. 앱의 시간대 설정입니다.
audioProcessingConfig

object (AudioProcessingConfig)

선택사항입니다. 앱의 오디오 처리 구성입니다.
loggingSettings

object (LoggingSettings)

선택사항입니다. 앱의 로깅 설정입니다.
errorHandlingSettings

object (ErrorHandlingSettings)

선택사항입니다. 앱의 오류 처리 설정입니다.
modelSettings

object (ModelSettings)

선택사항입니다. 앱의 기본 LLM 모델 설정입니다. 개별 리소스 (예: 에이전트, 가드레일)는 필요에 따라 이러한 구성을 재정의할 수 있습니다.
toolExecutionMode

enum (App.ToolExecutionMode)

선택사항입니다. 앱의 도구 실행 모드입니다. 제공되지 않으면 기본값은 PARALLEL입니다.
evaluationMetricsThresholds

object (EvaluationMetricsThresholds)

선택사항입니다. 앱의 평가 기준입니다.
variableDeclarations[]

object (App.VariableDeclaration)

선택사항입니다. 변수의 선언입니다.
predefinedVariableDeclarations[]

object (App.VariableDeclaration)

출력 전용입니다. 앱의 사전 정의된 변수 선언입니다.
globalInstruction

string

선택사항입니다. 앱의 모든 에이전트에 관한 안내입니다. 이 안내를 사용하여 모든 에이전트에서 안정적인 ID 또는 페르소나를 설정할 수 있습니다.
guardrails[]

string

선택사항입니다. 앱의 가이드라인 목록입니다. 형식: projects/{project}/locations/{location}/apps/{app}/guardrails/{guardrail}
dataStoreSettings

object (DataStoreSettings)

선택사항입니다. 앱의 데이터 스토어 설정입니다.
defaultChannelProfile

object (ChannelProfile)

선택사항입니다. 앱에서 사용하는 기본 채널 프로필입니다.
metadata

map (key: string, value: string)

선택사항입니다. 앱에 관한 메타데이터입니다. 이 필드는 앱의 세부정보 또는 의도된 사용과 관련된 추가 정보를 저장하는 데 사용할 수 있습니다.

"key": value 쌍 목록을 포함하는 객체입니다. 예: { "name": "wrench", "mass": "1.3kg", "count": "3" }
createTime

string (Timestamp format)

출력 전용입니다. 앱이 생성된 타임스탬프입니다.

생성된 출력은 항상 Z-정규화되고 소수점 이하 0, 3, 6 또는 9자리인 RFC 3339를 사용합니다. 'Z' 이외의 오프셋도 허용됩니다. 예를 들면 "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" 또는 "2014-10-02T15:01:23+05:30"입니다.
updateTime

string (Timestamp format)

출력 전용입니다. 앱이 마지막으로 업데이트된 타임스탬프입니다.

생성된 출력은 항상 Z-정규화되고 소수점 이하 0, 3, 6 또는 9자리인 RFC 3339를 사용합니다. 'Z' 이외의 오프셋도 허용됩니다. 예를 들면 "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" 또는 "2014-10-02T15:01:23+05:30"입니다.
etag

string

출력 전용입니다. 읽기-수정-쓰기 작업 중에 객체가 변경되지 않았는지 확인하는 데 사용되는 Etag입니다. etag가 비어 있으면 업데이트가 동시에 발생한 변경사항을 덮어씁니다.
deploymentCount

integer

출력 전용입니다. 앱의 배포 수입니다.
clientCertificateSettings

object (ClientCertificateSettings)

선택사항입니다. 앱의 기본 클라이언트 인증서 설정입니다.
locked

boolean

선택사항입니다. 앱이 변경사항에 대해 잠겨 있는지 여부를 나타냅니다. 앱이 잠겨 있으면 앱 리소스 수정이 거부됩니다.

LanguageSettings

앱의 언어 설정입니다.

JSON 표현 
{
  "defaultLanguageCode": string,
  "supportedLanguageCodes": [
    string
  ],
  "enableMultilingualSupport": boolean,
  "fallbackAction": string
}
필드
defaultLanguageCode

string

선택사항입니다. 앱의 기본 언어 코드입니다.
supportedLanguageCodes[]

string

선택사항입니다. defaultLanguageCode 외에 앱에서 지원하는 언어 코드 목록입니다.
enableMultilingualSupport

boolean

선택사항입니다. 다국어 지원을 사용 설정합니다. true인 경우 앱의 에이전트가 사전 빌드된 안내를 사용하여 다국어 입력 처리를 개선합니다.
fallbackAction

string

선택사항입니다. 상담사가 지원되지 않는 언어로 입력을 받는 경우 수행할 작업입니다.

사전 정의된 작업 또는 맞춤 도구 호출일 수 있습니다. 유효한 값은 다음과 같습니다. - 특정 도구 실행을 트리거하는 도구의 전체 리소스 이름 - '에스컬레이션' 또는 '종료'와 같은 사전 정의된 시스템 작업으로, 대화를 종료하기 위해 해당 metadata와 함께 EndSession 신호를 트리거합니다.

TimeZoneSettings

앱의 시간대 설정입니다.

JSON 표현 
{
  "timeZone": string
}
필드
timeZone

string

선택사항입니다. 시간대 데이터베이스의 앱 시간대입니다(예: America/Los_Angeles, Europe/Paris

AudioProcessingConfig

입력 및 출력 오디오를 처리하고 전송하는 방식에 관한 구성입니다.

JSON 표현 
{
  "synthesizeSpeechConfigs": {
    string: {
      object (SynthesizeSpeechConfig)
    },
    ...
  },
  "bargeInConfig": {
    object (BargeInConfig)
  },
  "inactivityTimeout": string,
  "ambientSoundConfig": {
    object (AmbientSoundConfig)
  }
}
필드
synthesizeSpeechConfigs

map (key: string, value: object (SynthesizeSpeechConfig))

선택사항입니다. 에이전트 응답이 합성되는 방식을 구성합니다. 언어 코드에서 SynthesizeSpeechConfig로 매핑됩니다.

지정된 언어 코드의 구성이 없으면 루트 언어 코드의 구성이 사용됩니다. 예를 들어 지도에 'en-us'와 'en'이 포함되어 있고 지정된 언어 코드가 'en-gb'인 경우 'en' 구성이 사용됩니다.

참고: 언어 코드는 대소문자를 구분하지 않습니다.

"key": value 쌍 목록을 포함하는 객체입니다. 예: { "name": "wrench", "mass": "1.3kg", "count": "3" }
bargeInConfig

object (BargeInConfig)

선택사항입니다. 사용자 끼어들기 활동의 에이전트 동작을 구성합니다.
inactivityTimeout

string (Duration format)

선택사항입니다. 상담사가 사용자에게 다시 참여하도록 프롬프트하기 전까지 사용자가 비활성 상태 (음성 또는 상호작용 없음)로 있는 시간입니다. 설정하지 않으면 상담사가 사용자에게 재참여를 요청하지 않습니다.

소수점 아래가 최대 9자리까지이고 's'로 끝나는 초 단위 기간입니다. 예를 들면 "3.5s"입니다.
ambientSoundConfig

object (AmbientSoundConfig)

선택사항입니다. 합성된 에이전트 응답과 함께 재생되는 주변 소리의 구성으로, 대화의 자연스러움을 향상합니다.

SynthesizeSpeechConfig

에이전트 응답을 합성하는 방식에 관한 구성입니다.

JSON 표현 
{
  "voice": string,
  "speakingRate": number
}
필드
voice

string

선택사항. 음성 이름입니다. 설정하지 않으면 서비스는 languageCode와 같은 다른 매개변수를 기반으로 음성을 선택합니다.

사용 가능한 음성 목록은 Cloud Text-to-Speech의 지원되는 음성 및 언어를 참고하세요.
speakingRate

number

선택사항입니다. 말하기 속도로 범위는 [0.25, 2.0]입니다. 1.0은 특정 음성에서 지원하는 일반적인 기본 속도입니다. 2.0은 기본 속도의 2배이며 0.5는 절반입니다. [0.25, 2.0] 범위를 벗어난 값은 오류를 반환합니다.

BargeInConfig

사용자 끼어들기 활동을 처리하는 방법에 관한 구성입니다.

JSON 표현 
{
  "disableBargeIn": boolean,
  "bargeInAwareness": boolean
}
필드
disableBargeIn
(deprecated)

boolean

선택사항입니다. 상담사가 말하는 동안 사용자의 끼어들기를 사용 중지합니다. true인 경우 에이전트 응답 재생 중 사용자 입력이 무시됩니다.

지원 중단됨: ChannelProfile에서 disableBargeIn가 지원 중단되고 disableBargeInControl로 대체되었습니다.
bargeInAwareness

boolean

선택사항입니다. 사용 설정된 경우 상담사는 사용자가 이전 상담사 메시지를 완전히 듣지 않았다는 가정에 따라 다음 응답을 조정합니다. 에이전트 응답이 시각적으로 표시되는 시나리오에서는 사용하면 안 됩니다.

AmbientSoundConfig

합성된 에이전트 응답과 함께 재생되는 주변 소리의 구성으로, 대화의 자연스러움을 향상합니다.

JSON 표현 
{
  "volumeGainDb": number,

  // Union field source can be only one of the following:
  "prebuiltAmbientNoise": enum (AmbientSoundConfig.PrebuiltAmbientNoise),
  "gcsUri": string,
  "prebuiltAmbientSound": string
  // End of list of possible types for union field source.
}
필드
volumeGainDb

number

선택사항입니다. 주변 소음으로 지원되는 일반 기본 볼륨의 볼륨 게인 (dB)입니다. 범위는 [-96.0, 16.0]입니다. 값을 설정하지 않거나 0.0(dB)으로 설정하면 일반적인 기본 신호 진폭에서 재생됩니다. 값이 -6.0(dB)이면 일반적인 기본 신호 진폭의 약 절반에서 재생됩니다. 값이 +6.0(dB)이면 일반적인 기본 신호 진폭의 약 두 배에서 재생됩니다. +10(dB)을 초과하는 값을 사용하지 않는 것이 좋습니다. 값이 +10을 초과하면 일반적으로 소리가 커지는 효과가 없기 때문입니다.
통합 필드 source. 대화의 자연스러움을 높이기 위해 합성된 에이전트 응답과 함께 재생되는 주변 소음입니다. source은 다음 중 하나여야 합니다.
prebuiltAmbientNoise
(deprecated)

enum (AmbientSoundConfig.PrebuiltAmbientNoise)

선택사항입니다. 지원 중단됨: prebuiltAmbientNoise이(가) 지원 중단되고 prebuiltAmbientSound(으)로 대체되었습니다.
gcsUri

string

선택사항입니다. Cloud Storage에 저장된 모노 채널, 16kHz WAV 파일 형식의 주변 소음

참고: CES 서비스 에이전트 service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com에 Cloud Storage 객체에 대한 storage.objects.get 권한이 있는지 확인하세요.
prebuiltAmbientSound

string

선택사항입니다. 미리 빌드된 주변 소리의 이름입니다. 유효한 값은 다음과 같습니다. - 'coffee_shop' - 'keyboard' - 'keypad' - 'hum' - 'office_1' - 'office_2' - 'office_3' - 'room_1' - 'room_2' - 'room_3' - 'room_4' - 'room_5' - 'air_conditioner'

AmbientSoundConfig.PrebuiltAmbientNoise

사전 빌드된 주변 소음입니다.

열거형
PREBUILT_AMBIENT_NOISE_UNSPECIFIED 지정되지 않음
RETAIL_STORE 소매점의 주변 소음입니다.
CONVENTION_HALL 컨벤션 홀의 주변 소음입니다.
OUTDOOR 거리의 주변 소음입니다.

LoggingSettings

앱의 로깅 동작을 설명하는 설정입니다.

JSON 표현 
{
  "redactionConfig": {
    object (RedactionConfig)
  },
  "audioRecordingConfig": {
    object (AudioRecordingConfig)
  },
  "bigqueryExportSettings": {
    object (BigQueryExportSettings)
  },
  "cloudLoggingSettings": {
    object (CloudLoggingSettings)
  },
  "conversationLoggingSettings": {
    object (ConversationLoggingSettings)
  },
  "evaluationAudioRecordingConfig": {
    object (AudioRecordingConfig)
  },
  "metricAnalysisSettings": {
    object (MetricAnalysisSettings)
  }
}
필드
redactionConfig

object (RedactionConfig)

선택사항입니다. 민감한 정보를 수정하는 방법에 관한 구성입니다.
audioRecordingConfig

object (AudioRecordingConfig)

선택사항입니다. 오디오 상호작용을 녹음하는 방식에 관한 구성입니다.
bigqueryExportSettings

object (BigQueryExportSettings)

선택사항입니다. 앱의 BigQuery 내보내기 동작을 설명하는 설정입니다. 사용 설정된 경우 대화 데이터가 BigQuery 테이블로 내보내집니다.
cloudLoggingSettings

object (CloudLoggingSettings)

선택사항입니다. 앱의 Cloud Logging 동작을 설명하는 설정입니다.
conversationLoggingSettings

object (ConversationLoggingSettings)

선택사항입니다. 앱의 대화 로깅 동작을 설명하는 설정입니다.
evaluationAudioRecordingConfig

object (AudioRecordingConfig)

선택사항입니다. 평가를 위해 오디오 상호작용을 녹음하는 방식에 관한 구성입니다. 기본적으로 평가 세션에는 오디오 녹음이 사용 설정되어 있지 않습니다.
metricAnalysisSettings

object (MetricAnalysisSettings)

선택사항입니다. 앱의 LLM 분석 파이프라인의 대화 데이터 수집 동작을 설명하는 설정입니다.

RedactionConfig

민감한 정보를 처리하는 방법을 안내하는 구성입니다.

JSON 표현 
{
  "enableRedaction": boolean,
  "inspectTemplate": string,
  "deidentifyTemplate": string
}
필드
enableRedaction

boolean

선택사항입니다. true인 경우 대화 기록, Cloud Logging, 오디오 녹음 등 다양한 로깅 시나리오에 수정이 적용됩니다.
inspectTemplate

string

선택사항입니다. 민감한 정보 유형의 감지를 구성하는 DLP 검사 템플릿 이름입니다.

형식: projects/{project}/locations/{location}/inspectTemplates/{inspectTemplate}
deidentifyTemplate

string

선택사항입니다. 콘텐츠를 익명화하는 방법을 안내하는 DLP 익명화 템플릿 이름입니다.

형식: projects/{project}/locations/{location}/deidentifyTemplates/{deidentifyTemplate}

AudioRecordingConfig

오디오 상호작용을 녹음하는 방식에 관한 구성입니다.

JSON 표현 
{
  "gcsBucket": string,
  "gcsPathPrefix": string
}
필드
gcsBucket

string

선택사항입니다. 세션 오디오 녹음을 저장할 Cloud Storage 버킷입니다. URI는 'gs://'로 시작해야 합니다.

데이터 상주 요구사항을 충족하는 버킷 위치를 선택하세요.

참고: Cloud Storage 버킷이 앱과 다른 프로젝트에 있는 경우 CES 서비스 에이전트 service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com에 storage.objects.create 권한을 부여해야 합니다.
gcsPathPrefix

string

선택사항입니다. 오디오 녹음 파일의 Cloud Storage 경로 접두사입니다.

이 접두사에는 게재 시간에 동적으로 대체되는 다음 자리표시자가 포함될 수 있습니다. - $project: 프로젝트 ID - $location: 앱 위치 - $app: 앱 ID - $date: YYYY-MM-DD 형식의 세션 날짜 - $session: 세션 ID

경로 접두사를 지정하지 않으면 기본 접두사 $project/$location/$app/$date/$session/가 사용됩니다.

BigQueryExportSettings

앱의 BigQuery 내보내기 동작을 설명하는 설정입니다.

JSON 표현 
{
  "enabled": boolean,
  "project": string,
  "dataset": string
}
필드
enabled

boolean

선택사항입니다. BigQuery 내보내기가 사용 설정되어 있는지 여부를 나타냅니다.
project

string

선택사항입니다. 데이터를 내보낼 BigQuery 데이터 세트의 프로젝트 ID입니다.

참고: BigQuery 데이터 세트가 앱과 다른 프로젝트에 있는 경우 CES 서비스 에이전트 service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com에 roles/bigquery.admin 역할을 부여해야 합니다.
dataset

string

선택사항입니다. 데이터를 내보낼 BigQuery 데이터 세트입니다.

CloudLoggingSettings

앱의 Cloud Logging 동작을 설명하는 설정입니다.

JSON 표현 
{
  "enableCloudLogging": boolean
}
필드
enableCloudLogging

boolean

선택사항입니다. 세션에 Cloud Logging을 사용 설정할지 여부입니다.

ConversationLoggingSettings

앱의 대화 로깅 동작을 설명하는 설정입니다.

JSON 표현 
{
  "disableConversationLogging": boolean
}
필드
disableConversationLogging

boolean

선택사항입니다. 세션의 대화 로깅을 사용 중지할지 여부입니다.

MetricAnalysisSettings

LLM 분석 측정항목 파이프라인의 대화 데이터 수집 동작을 설명하는 설정입니다.

JSON 표현 
{
  "llmMetricsOptedOut": boolean
}
필드
llmMetricsOptedOut

boolean

선택사항입니다. llm 분석 측정항목을 위해 대화 데이터를 수집할지 여부입니다. true인 경우 llm 분석 측정항목에 대한 대화 데이터가 수집되지 않습니다. 그렇지 않으면 대화 데이터가 수집됩니다.

ErrorHandlingSettings

앱에서 오류를 처리하는 방법을 설명하는 설정입니다.

JSON 표현 
{
  "errorHandlingStrategy": enum (ErrorHandlingSettings.ErrorHandlingStrategy)
}
필드
errorHandlingStrategy

enum (ErrorHandlingSettings.ErrorHandlingStrategy)

선택사항입니다. 오류 처리에 사용할 전략입니다.

ErrorHandlingSettings.ErrorHandlingStrategy

오류 처리 전략을 정의합니다.

열거형
ERROR_HANDLING_STRATEGY_UNSPECIFIED 지정되지 않은 오류 처리 전략입니다. 기본값은 FALLBACK_RESPONSE입니다.
NONE 특정 처리가 사용 설정되지 않았습니다.
FALLBACK_RESPONSE LLM 오류가 발생하면 대체 메시지가 사용자에게 반환됩니다.

App.ToolExecutionMode

에이전트가 동시에 선택하는 도구가 여러 개인 경우 도구 실행 동작을 정의합니다.

열거형
TOOL_EXECUTION_MODE_UNSPECIFIED 지정되지 않은 도구 실행 모드입니다. 기본값은 PARALLEL입니다.
PARALLEL 선택된 도구가 여러 개인 경우 동일한 ToolContext로 병렬 실행됩니다.
SEQUENTIAL 선택된 도구가 여러 개인 경우 순차적으로 실행됩니다. 다음 도구는 이전 도구가 완료된 후에만 실행되며 이전 도구에서 업데이트된 ToolContext를 확인할 수 있습니다.

EvaluationMetricsThresholds

평가의 측정항목에 대한 기준점 설정입니다.

JSON 표현 
{
  "goldenEvaluationMetricsThresholds": {
    object (EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds)
  },
  "hallucinationMetricBehavior": enum (EvaluationMetricsThresholds.HallucinationMetricBehavior),
  "goldenHallucinationMetricBehavior": enum (EvaluationMetricsThresholds.HallucinationMetricBehavior),
  "scenarioHallucinationMetricBehavior": enum (EvaluationMetricsThresholds.HallucinationMetricBehavior)
}
필드
goldenEvaluationMetricsThresholds

object (EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds)

선택사항입니다. 핵심 평가 측정항목 기준입니다.
hallucinationMetricBehavior
(deprecated)

enum (EvaluationMetricsThresholds.HallucinationMetricBehavior)

선택사항입니다. 지원 중단됨: 대신 goldenHallucinationMetricBehavior을 사용하세요. 현재 골든 평가에는 허위 정보 측정항목 동작이 사용됩니다.
goldenHallucinationMetricBehavior

enum (EvaluationMetricsThresholds.HallucinationMetricBehavior)

선택사항입니다. 골든 평가의 허위 정보 측정항목 동작입니다.
scenarioHallucinationMetricBehavior

enum (EvaluationMetricsThresholds.HallucinationMetricBehavior)

선택사항입니다. 시나리오 평가의 허위 정보 측정항목 동작입니다.

EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds

골든 평가 설정입니다.

JSON 표현 
{
  "turnLevelMetricsThresholds": {
    object (EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds)
  },
  "expectationLevelMetricsThresholds": {
    object (EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.ExpectationLevelMetricsThresholds)
  },
  "toolMatchingSettings": {
    object (EvaluationMetricsThresholds.ToolMatchingSettings)
  }
}
필드
turnLevelMetricsThresholds

object (EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds)

선택사항입니다. 턴 수준 측정항목 기준점입니다.
expectationLevelMetricsThresholds

object (EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.ExpectationLevelMetricsThresholds)

선택사항입니다. 기대 수준 측정항목 기준점입니다.
toolMatchingSettings

object (EvaluationMetricsThresholds.ToolMatchingSettings)

선택사항입니다. 도구 매칭 설정입니다. 추가 도구 호출은 실행에 있지만 골든 기대치에 있는 도구 호출과 일치하지 않는 도구 호출입니다.

EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds

수준 측정항목 기준점을 사용 설정합니다.

JSON 표현 
{
  "semanticSimilarityChannel": enum (EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds.SemanticSimilarityChannel),
  "semanticSimilaritySuccessThreshold": integer,
  "overallToolInvocationCorrectnessThreshold": number
}
필드
semanticSimilarityChannel

enum (EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds.SemanticSimilarityChannel)

선택사항입니다. 평가에 사용할 시맨틱 유사성 채널입니다.
semanticSimilaritySuccessThreshold

integer

선택사항입니다. 의미론적 유사성의 성공 기준입니다. 0에서 4 사이의 정수여야 합니다. 기본값은 3 이상입니다.
overallToolInvocationCorrectnessThreshold

number

선택사항입니다. 전반적인 도구 호출 정확성의 성공 기준입니다. 0과 1 사이의 부동 소수점이어야 합니다. 기본값은 1.0입니다.

EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.TurnLevelMetricsThresholds.SemanticSimilarityChannel

사용할 시맨틱 유사성 채널입니다.

열거형
SEMANTIC_SIMILARITY_CHANNEL_UNSPECIFIED 측정항목이 지정되지 않았습니다. 기본값은 TEXT입니다.
TEXT 텍스트 시맨틱 유사성을 사용합니다.
AUDIO 오디오 시맨틱 유사성을 사용합니다.

EvaluationMetricsThresholds.GoldenEvaluationMetricsThresholds.ExpectationLevelMetricsThresholds

기대 수준 측정항목 기준점입니다.

JSON 표현 
{
  "toolInvocationParameterCorrectnessThreshold": number
}
필드
toolInvocationParameterCorrectnessThreshold

number

선택사항입니다. 개별 도구 호출 매개변수 정확성의 성공 기준입니다. 0과 1 사이의 부동 소수점이어야 합니다. 기본값은 1.0입니다.

EvaluationMetricsThresholds.ToolMatchingSettings

도구 호출 일치 설정입니다.

JSON 표현 
{
  "extraToolCallBehavior": enum (EvaluationMetricsThresholds.ToolMatchingSettings.ExtraToolCallBehavior)
}
필드
extraToolCallBehavior

enum (EvaluationMetricsThresholds.ToolMatchingSettings.ExtraToolCallBehavior)

선택사항입니다. 추가 도구 호출의 동작입니다. 기본값은 FAIL입니다.

EvaluationMetricsThresholds.ToolMatchingSettings.ExtraToolCallBehavior

추가 도구 호출이 발생할 때의 동작을 정의합니다. 추가 도구 호출은 실행에 있지만 골든 기대치에 있는 도구 호출과 일치하지 않는 도구 호출입니다.

열거형
EXTRA_TOOL_CALL_BEHAVIOR_UNSPECIFIED 지정되지 않은 동작입니다. 기본값은 FAIL입니다.
FAIL 추가 도구 호출이 발견되면 평가에 실패합니다.
ALLOW 추가 도구 호출을 허용합니다.

EvaluationMetricsThresholds.HallucinationMetricBehavior

과장된 대답 측정항목 동작입니다. 동작과 관계없이 측정항목은 항상 계산됩니다. 사용 중지된 경우 측정항목이 전체 평가 점수를 계산하는 데 사용되지 않는다는 점이 다릅니다.

열거형
HALLUCINATION_METRIC_BEHAVIOR_UNSPECIFIED 지정되지 않은 환각 측정항목 동작입니다.
DISABLED 환각 측정항목을 사용 중지합니다.
ENABLED 환각 측정항목을 사용 설정합니다.

App.VariableDeclaration

변수의 구조와 메타데이터를 정의합니다.

JSON 표현 
{
  "name": string,
  "description": string,
  "schema": {
    object (Schema)
  }
}
필드
name

string

필수 항목입니다. 변수의 이름입니다. 이름은 문자 또는 밑줄로 시작해야 하며 문자, 숫자, 밑줄만 포함할 수 있습니다.
description

string

필수 항목입니다. 변수에 대한 설명입니다.
schema

object (Schema)

필수 항목입니다. 변수의 스키마입니다.

DataStoreSettings

앱의 데이터 스토어 관련 설정입니다.

JSON 표현 
{
  "engines": [
    {
      object (DataStoreSettings.Engine)
    }
  ]
}
필드
engines[]

object (DataStoreSettings.Engine)

출력 전용입니다. 앱의 엔진입니다.

DataStoreSettings.Engine

데이터 스토어가 연결된 엔진입니다. Vertex AI Search를 참고하세요(https://cloud.google.com/generative-ai-app-builder/docs/enterprise-search-introduction).

JSON 표현 
{
  "name": string,
  "type": enum (DataStoreSettings.Engine.Type)
}
필드
name

string

출력 전용입니다. 엔진의 리소스 이름입니다. 형식: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}
type

enum (DataStoreSettings.Engine.Type)

출력 전용입니다. 엔진 유형입니다.

DataStoreSettings.Engine.Type

엔진 유형입니다. https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1/SolutionType 및 https://cloud.google.com/generative-ai-app-builder/docs/create-datastore-ingest에서 제공되는 문서를 참고하세요.

열거형
TYPE_UNSPECIFIED 지정되지 않은 엔진 유형입니다.
ENGINE_TYPE_CHAT 채팅 엔진 유형입니다. 앱의 SOLUTION_TYPE_CHAT 엔진입니다. 앱에 추가된 모든 커넥터 데이터 스토어가 이 엔진에 추가됩니다.

ClientCertificateSettings

맞춤 클라이언트 인증서 설정입니다.

JSON 표현 
{
  "tlsCertificate": string,
  "privateKey": string,
  "passphrase": string
}
필드
tlsCertificate

string

필수 항목입니다. PEM 형식으로 인코딩된 TLS 인증서입니다. 이 문자열에는 시작 헤더와 종료 바닥글 줄이 포함되어야 합니다.
privateKey

string

필수 항목입니다. PEM 형식으로 인코딩된 비공개 키를 저장하는 SecretManager 보안 비밀 버전 리소스의 이름입니다. 형식: projects/{project}/secrets/{secret}/versions/{version}
passphrase

string

선택사항입니다. 비공개 키를 복호화하는 암호를 저장하는 SecretManager 보안 비밀 버전 리소스의 이름입니다. 비공개 키가 암호화되지 않은 경우 설정되지 않은 상태로 두어야 합니다. 형식: projects/{project}/secrets/{secret}/versions/{version}

메서드

create

 지정된 프로젝트와 위치에 새 앱을 만듭니다.

delete

 지정된 앱을 삭제합니다.

executeTool

 지정된 인수를 사용하여 지정된 도구를 실행합니다.

exportApp

 지정된 앱을 내보냅니다.

get

 지정된 앱의 세부정보를 가져옵니다.

importApp

 지정된 앱을 가져옵니다.

list

 특정 프로젝트와 위치의 앱을 나열합니다.

patch

 지정된 앱을 업데이트합니다.

retrieveToolSchema

 지정된 도구의 스키마를 가져옵니다.