Method: projects.locations.collections.engines.completionConfig.completeQuery

고급 키워드 추천으로 사용자 입력을 완성합니다.

HTTP 요청

POST https://discoveryengine.googleapis.com/v1beta/{completionConfig=projects/*/locations/*/collections/*/engines/*/completionConfig}:completeQuery

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

경로 매개변수

매개변수
completionConfig

string

필수 항목입니다. 완성이 실행되는 상위 데이터 스토어 또는 엔진 리소스 이름의 completionConfig입니다(예: projects/*/locations/global/collections/default_collection/dataStores/*/completionConfig projects/*/locations/global/collections/default_collection/engines/*/completionConfig).

요청 본문

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

JSON 표현 
{
  "query": string,
  "queryModel": string,
  "userPseudoId": string,
  "userInfo": {
    object (UserInfo)
  },
  "includeTailSuggestions": boolean,
  "boostSpec": {
    object (BoostSpec)
  },
  "suggestionTypes": [
    enum (SuggestionType)
  ],
  "suggestionTypeSpecs": [
    {
      object (SuggestionTypeSpec)
    }
  ],
  "experimentIds": [
    string
  ]
}
필드
query

string

필수 항목입니다. 추천을 가져오는 데 사용되는 typeahead 입력입니다. 최대 길이는 128자(영문 기준)입니다.

대부분의 추천 유형에서 쿼리는 비워 둘 수 없습니다. 비어 있으면 INVALID_ARGUMENT 오류가 반환됩니다. 예외적으로 suggestionTypes에 RECENT_SEARCH 유형만 포함된 경우 쿼리는 빈 문자열일 수 있습니다. 이를 '0 접두사' 기능이라고 하며, 빈 쿼리가 주어지면 사용자가 최근에 검색한 쿼리를 반환합니다.
queryModel

string

자동 완성 쿼리 모델을 지정합니다. 이는 QUERY SuggestionType에만 적용됩니다. 이렇게 하면 Cloud 콘솔의 구성 > 자동 완성 섹션에 지정된 모델이 재정의됩니다. 현재 지원되는 값:

  • document - 사용자가 가져온 문서에서 생성된 추천 사용
  • search-history - SearchService.Search API 호출의 이전 기록에서 생성된 추천 사용 Search API에 트래픽이 없는 경우에는 사용하지 마세요.
  • user-event - 사용자가 가져온 검색 이벤트에서 생성된 추천 사용
  • document-completable - 완성 가능으로 표시된 사용자 가져오기 문서 필드에서 직접 가져온 추천을 사용합니다.

기본값:

  • document은 일반 dataStore의 기본 모델입니다.
  • search-history은 사이트 검색 데이터 스토어의 기본 모델입니다.
userPseudoId

string

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

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

UserEvent.user_pseudo_id 및 SearchRequest.user_pseudo_id과 동일한 식별자여야 합니다.

필드는 길이 제한이 128인 UTF-8로 인코딩된 문자열이어야 합니다.
userInfo

object (UserInfo)

(선택사항) 최종 사용자에 관한 정보입니다.

UserEvent.user_info 및 SearchRequest.user_info과 동일한 식별자 정보여야 합니다.
includeTailSuggestions

boolean

전체 검색어와 일치하는 추천이 없는 경우 꼬리 추천을 반환해야 하는지 여부를 나타냅니다. true로 설정된 경우에도 전체 검색어와 일치하는 추천이 있으면 해당 추천이 반환되고 꼬리 추천은 반환되지 않습니다.
boostSpec

object (BoostSpec)

(선택사항) 조건과 일치하는 추천을 부스트하는 사양입니다.
suggestionTypes[]

enum (SuggestionType)

(선택사항) 반환할 추천 유형입니다. 비어 있거나 지정되지 않은 경우 쿼리 추천이 반환됩니다. 현재는 하나의 추천 유형만 지원됩니다.
suggestionTypeSpecs[]

object (SuggestionTypeSpec)

(선택사항) 각 제안 유형의 사양입니다.
experimentIds[]

string

선택사항입니다. 이 요청의 실험 ID입니다.

응답 본문

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

승인 범위

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

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/cloud_search.query
  • https://www.googleapis.com/auth/discoveryengine.complete_query
  • https://www.googleapis.com/auth/discoveryengine.assist.readwrite

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

IAM 권한

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

  • discoveryengine.completionConfigs.completeQuery

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