CompletionConfig

엔진과 데이터 스토어 모두에 대해 Autocomplete API 응답을 맞춤설정하는 구성입니다. 일부 필드는 둘 중 하나에만 적용됩니다.

JSON 표현 
{
  "name": string,
  "matchingOrder": string,
  "maxSuggestions": integer,
  "minPrefixLength": integer,
  "queryModel": string,
  "queryFrequencyThreshold": integer,
  "numUniqueUsersThreshold": integer,
  "shouldServeContentSuggestions": boolean,
  "filterPiiSuggestionsUsingDlp": boolean,
  "enableMode": enum (EnableMode)
}
필드
name

string

필수 항목. 변경할 수 없습니다. 정규화된 이름 projects/*/locations/*/dataStores/*/completionConfig projects/*/locations/*/collections/*/dataStores/*/completionConfig projects/*/locations/*/collections/*/engines/*/completionConfig
matchingOrder

string

자동 완성 추천의 일치 순서입니다. 예를 들어 out-of-order가 지정된 sh로 구성된 쿼리는 women's shoes를 추천하는 반면 exact-prefix가 지정된 red s 쿼리는 red shoes를 추천합니다. 현재 지원되는 값은 다음과 같습니다.

  • out-of-order
  • exact-prefix

기본값은 exact-prefix입니다.
maxSuggestions

integer

용어당 반환되는 최대 자동 완성 추천 수입니다.

maxSuggestions는 [1, 20] 범위 내에 있어야 합니다. 설정되지 않았거나 0으로 설정된 경우 기본값인 20개의 추천으로 설정됩니다.
minPrefixLength

integer

추천을 받기 위해 입력해야 하는 최소 문자 수입니다.

minPrefixLength는 [1, 20] 범위 내에 있어야 합니다. 설정되지 않았거나 0으로 설정된 경우 기본값인 1자로 설정됩니다.
queryModel

string

서빙을 위한 쿼리 추천의 데이터 모델입니다.

현재 지원되는 값은 다음과 같습니다.

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

질의 모델이 비어 있으면 서빙에서 기본적으로 '자동' 모델을 적용합니다.
queryFrequencyThreshold

integer

이 필드는 사용자 이벤트 또는 검색 기록에서 생성된 추천에만 의미가 있습니다. 검색어가 이 기준 미만으로 표시되면 검색어가 거의 검색되지 않아 추천으로 생성되지 않을 수 있습니다. 이 필드는 PII 쿼리가 추천으로 표시되지 않도록 하는 데 유용합니다. 이러한 쿼리는 일반적으로 고유하게 검색되기 때문입니다. 설정하지 않으면 생성 파이프라인에서 사용되는 기본값 3이 사용됩니다.
numUniqueUsersThreshold

integer

이 필드는 사용자 ID가 연결되어 있을 수 있는 사용자 이벤트 또는 검색 기록에서 생성된 추천에만 의미가 있습니다. 검색어를 검색한 순 사용자 수가 이 기준점 미만이면 검색어가 추천으로 생성되지 않습니다. 이 필드는 PII 쿼리가 추천으로 표시되지 않도록 하는 데 유용합니다. 이러한 쿼리는 일반적으로 고유하게 검색되기 때문입니다. 설정하지 않으면 생성 파이프라인에서 사용되는 기본값 3이 사용됩니다.
shouldServeContentSuggestions

boolean

콘텐츠 추천을 생성하고 제공할지 여부입니다. 이를 통해 콘텐츠 추천이 검색어 추천과 함께 제공될 수 있습니다.
filterPiiSuggestionsUsingDlp

boolean

true인 경우 최선을 다해 특정 유형의 PII 정보가 포함된 추천을 감지하고 삭제하려고 시도합니다. 이 감지는 내부적으로 DLP에 의해 실행됩니다.
enableMode

enum (EnableMode)

자동 완성 생성 파이프라인의 사용 설정 모드입니다. 이 필드를 설정하지 않으면 서버 동작은 기본적으로 CompletionConfig.EnableMode.AUTOMATIC로 설정됩니다. DataStore에만 적용됩니다. 엔진에서 무시됩니다.

EnableMode

자동 완성 생성 파이프라인의 사용 설정 모드를 지정합니다.

열거형
ENABLE_MODE_UNSPECIFIED 자동 완성 사용 설정 모드를 지정하지 않으면 기본적으로 AUTOMATIC 모드로 설정됩니다.
AUTOMATIC 데이터 스토어가 기준을 충족하면 자동 완성이 사용 설정됩니다.
MANUAL UCS 데이터 요구사항과 관계없이 자동 완성이 사용 설정됩니다.