Method: projects.locations.collections.engines.conversations.converse

대화를 변환합니다.

HTTP 요청

POST https://discoveryengine.googleapis.com/v1/{name=projects/*/locations/*/collections/*/engines/*/conversations/*}:converse

URL은 gRPC 트랜스코딩 문법을 사용합니다.

경로 매개변수

매개변수
name

string

필수 항목입니다. 가져올 대화의 리소스 이름입니다. 형식은 projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStoreId}/conversations/{conversationId}입니다. projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStoreId}/conversations/-을 사용하여 자동 세션 모드를 활성화합니다. 그러면 conversations.converse 세션 내에 새 대화가 자동으로 생성됩니다.

요청 본문

요청 본문에는 다음과 같은 구조의 데이터가 포함됩니다.

JSON 표현 
{
  "query": {
    object (TextInput)
  },
  "servingConfig": string,
  "conversation": {
    object (Conversation)
  },
  "safeSearch": boolean,
  "userLabels": {
    string: string,
    ...
  },
  "summarySpec": {
    object (SummarySpec)
  },
  "filter": string,
  "boostSpec": {
    object (BoostSpec)
  }
}
필드
query

object (TextInput)

필수 항목입니다. 현재 사용자 입력입니다.
servingConfig

string

사용할 서빙 구성의 리소스 이름입니다. 형식: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStoreId}/servingConfigs/{servingConfigId} 설정하지 않으면 기본 제공 구성이 사용됩니다.
conversation

object (Conversation)

자동 세션에서만 사용할 대화입니다. 자동 세션에서 대화에 새 이름을 자동으로 할당하므로 이름 필드는 무시됩니다.
userLabels

map (key: string, value: string)

리소스에 적용된 사용자 라벨은 다음 요구사항을 충족해야 합니다.

  • 각 리소스는 여러 개의 라벨(최대 64개)을 가질 수 있습니다.
  • 각 라벨은 키-값 쌍이어야 합니다.
  • 키는 비워 둘 수 없으며 최소 길이는 1자이고 최대 길이는 63자입니다. 값은 비워 둘 수 있으며 최대 길이는 63자(영문 기준)입니다.
  • 키와 값에는 소문자, 숫자, 밑줄, 대시만 사용할 수 있습니다. 모든 문자는 UTF-8 인코딩을 사용해야 하며 국제 문자가 허용됩니다.
  • 라벨의 키 부분은 고유해야 합니다. 그러나 여러 리소스에 동일한 키를 사용할 수 있습니다.
  • 키는 소문자나 국제 문자로 시작해야 합니다.

자세한 내용은 Google Cloud 문서를 참고하세요.
summarySpec

object (SummarySpec)

대답에 반환되는 요약을 구성하기 위한 사양입니다.
filter

string

필터 구문은 필터링되는 문서의 하나 이상의 필드에서 조건자를 구성하기 위한 표현식 언어로 구성됩니다. 필터 표현식은 대소문자를 구분합니다. 요약 대답에 영향을 줄 수 있는 검색 결과를 필터링하는 데 사용됩니다.

이 필드를 인식할 수 없으면 INVALID_ARGUMENT가 반환됩니다.

Vertex AI Search의 필터링은 LHS 필터 키를 Vertex AI Search 백엔드에 정의된 키 속성에 매핑하여 실행됩니다. 이 매핑은 고객이 스키마에 정의합니다. 예를 들어 미디어 고객의 스키마에 'name' 필드가 있을 수 있습니다. 이 경우 필터는 다음과 같습니다. filter --> name:'ANY("king kong")'

구문 및 필터 연산자를 비롯한 필터링에 대한 자세한 내용은 필터를 참고하세요.
boostSpec

object (BoostSpec)

검색 결과에서 특정 문서를 부스팅하는 부스트 사양으로, 대화 응답에 영향을 줄 수 있습니다. 부스팅에 대한 자세한 내용은 부스팅을 참고하세요.

응답 본문

성공한 경우 응답 본문에 ConverseConversationResponse의 인스턴스가 포함됩니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite

자세한 내용은 Authentication Overview를 참조하세요.

IAM 권한

name 리소스에 대해서는 다음 IAM 권한이 필요합니다.

  • discoveryengine.conversations.converse

자세한 내용은 IAM 문서를 참조하세요.