Method: projects.locations.collections.engines.servingConfigs.streamAnswer

질문 답변 메서드 (스트리밍)

하나의 AnswerQueryRequest를 가져와 스트림에서 여러 AnswerQueryResponse 메시지를 반환합니다.

HTTP 요청

POST https://discoveryengine.googleapis.com/v1beta/{servingConfig=projects/*/locations/*/collections/*/engines/*/servingConfigs/*}:streamAnswer

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

경로 매개변수

매개변수
servingConfig

string

필수 항목입니다. 서빙Configs.search 서빙 구성의 리소스 이름입니다(예: projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config 또는 projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config). 이 필드는 검색하는 데 사용되는 모델 집합인 서빙 구성 이름을 식별하는 데 사용됩니다.

요청 본문

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

JSON 표현 
{
  "query": {
    object (Query)
  },
  "session": string,
  "safetySpec": {
    object (SafetySpec)
  },
  "relatedQuestionsSpec": {
    object (RelatedQuestionsSpec)
  },
  "groundingSpec": {
    object (GroundingSpec)
  },
  "answerGenerationSpec": {
    object (AnswerGenerationSpec)
  },
  "searchSpec": {
    object (SearchSpec)
  },
  "queryUnderstandingSpec": {
    object (QueryUnderstandingSpec)
  },
  "asynchronousMode": boolean,
  "userPseudoId": string,
  "userLabels": {
    string: string,
    ...
  },
  "endUserSpec": {
    object (EndUserSpec)
  }
}
필드
query

object (Query)

필수 항목입니다. 현재 사용자 쿼리입니다.
session

string

세션 리소스 이름입니다. 필수 항목이 아닙니다.

세션 필드가 설정되지 않은 경우 API는 세션 없는 모드에 있습니다.

자동 세션 모드가 지원됩니다. 사용자는 와일드 카드 기호 -를 세션 ID로 사용할 수 있습니다. 새 ID가 자동으로 생성되어 할당됩니다.
safetySpec

object (SafetySpec)

모델 사양입니다.
relatedQuestionsSpec

object (RelatedQuestionsSpec)

관련 질문 사양입니다.
groundingSpec

object (GroundingSpec)

(선택사항) 그라운딩 사양입니다.
answerGenerationSpec

object (AnswerGenerationSpec)

대답 생성 사양입니다.
searchSpec

object (SearchSpec)

servingConfigs.search 사양입니다.
queryUnderstandingSpec

object (QueryUnderstandingSpec)

질문 이해 사양입니다.
asynchronousMode
(deprecated)

boolean

지원 중단됨: 이 필드는 지원 중단되었습니다. Streaming Answer API가 지원됩니다.

비동기 모드 제어

사용 설정된 경우 최종 답변 없이 답변/세션 리소스 이름과 함께 응답이 반환됩니다. API 사용자는 ConversationalSearchService.GetAnswer 또는 ConversationalSearchService.GetSession 메서드를 호출하여 답변/세션의 최신 상태를 가져오기 위해 폴링을 실행해야 합니다.
userPseudoId

string

방문자 추적을 위한 고유 식별자입니다. 예를 들어 단일 기기에서 방문자를 고유하게 식별할 수 있는 HTTP 쿠키를 사용하여 이를 구현할 수 있습니다. 이 고유 식별자는 방문자가 웹사이트에 로그인 또는 로그아웃해도 변경되지 않아야 합니다.

이 필드에는 unknown_visitor과 같은 고정 값이 있어서는 안 됩니다(NOT).

필드는 길이 제한이 128자(영문 기준)인 UTF-8로 인코딩된 문자열이어야 합니다. 그렇지 않으면 INVALID_ARGUMENT 오류가 반환됩니다.
userLabels

map (key: string, value: string)

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

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

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

object (EndUserSpec)

(선택사항) 최종 사용자 사양입니다.

응답 본문

성공하면 응답 본문에 AnswerQueryResponse 인스턴스 스트림이 포함됩니다.

승인 범위

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

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

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

IAM 권한

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

  • discoveryengine.servingConfigs.answer

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