Documents - Autocomplete Post

참조

서비스:: Search Service

API 버전:: 2024-07-01

입력 텍스트 및 인덱스의 일치하는 용어에 따라 불완전한 쿼리 용어를 자동으로 완성합니다.

POST {endpoint}/indexes('{indexName}')/docs/search.post.autocomplete?api-version=2024-07-01

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
endpoint	path	True	string	검색 서비스의 엔드포인트 URL입니다.
indexName	path	True	string	인덱스의 이름입니다.
api-version	query	True	string	클라이언트 API 버전입니다.

요청 헤더

Name	필수	형식	Description
x-ms-client-request-id		string uuid	디버깅에 도움이 되도록 요청과 함께 전송된 추적 ID입니다.

요청 본문

Name	필수	형식	Description
search	True	string	자동 완성 결과를 기반으로 할 검색 텍스트입니다.
suggesterName	True	string	인덱스 정의의 일부인 제안기 컬렉션에 지정된 제안기의 이름입니다.
autocompleteMode		AutocompleteMode	자동 완성 모드를 지정합니다. 기본값은 'oneTerm'입니다. 자동 완성 용어를 생성하는 동안 'twoTerms'를 사용하여 대상 포진 및 'oneTermWithContext'를 사용하여 현재 컨텍스트를 사용합니다.
filter		string	자동 완성 결과에 대해 완료된 용어를 생성하는 데 사용되는 문서를 필터링하는 OData 식입니다.
fuzzy		boolean	자동 완성 쿼리에 유사 항목 일치를 사용할지 여부를 나타내는 값입니다. 기본값은 false입니다. true로 설정하면 검색 텍스트에 대체 문자나 누락된 문자가 있더라도 쿼리가 용어를 자동으로 완성합니다. 이는 일부 시나리오에서 더 나은 환경을 제공하지만 유사 항목 자동 완성 쿼리가 느리고 더 많은 리소스를 사용하므로 성능 비용이 발생합니다.
highlightPostTag		string	적중 강조 표시에 추가되는 문자열 태그입니다. highlightPreTag를 사용하여 설정해야 합니다. 생략하면 적중 항목 강조 표시가 비활성화됩니다.
highlightPreTag		string	강조 표시를 적중하기 위해 앞에 추가되는 문자열 태그입니다. highlightPostTag를 사용하여 설정해야 합니다. 생략하면 적중 항목 강조 표시가 비활성화됩니다.
minimumCoverage		number	쿼리가 성공으로 보고되려면 자동 완성 쿼리에서 처리해야 하는 인덱스의 백분율을 나타내는 0에서 100 사이의 숫자입니다. 이 매개 변수는 복제본이 하나뿐인 서비스에 대해서도 검색 가용성을 보장하는 데 유용할 수 있습니다. 기본값은 80입니다.
searchFields		string	자동 완성 용어를 쿼리할 때 고려할 필드 이름의 쉼표로 구분된 목록입니다. 대상 필드는 지정된 제안자에 포함되어야 합니다.
top		integer	검색할 자동 완성 용어 수입니다. 1에서 100 사이의 값이어야 합니다. 기본값은 5입니다.

응답

Name	형식	Description
200 OK	AutocompleteResult	부분 입력을 완료하는 제안된 쿼리 용어를 포함하는 응답입니다.
Other Status Codes	ErrorResponse	오류 응답입니다.

예제

SearchIndexAutocompleteDocumentsPost

샘플 요청

HTTP

POST https://myservice.search.windows.net/indexes('myindex')/docs/search.post.autocomplete?api-version=2024-07-01

{
  "autocompleteMode": "oneTerm",
  "search": "washington medic",
  "suggesterName": "sg",
  "filter": "search.in(docId,'101,102,105')",
  "highlightPostTag": "</em>",
  "highlightPreTag": "<em>",
  "minimumCoverage": 80,
  "searchFields": "title,description",
  "top": 10
}

샘플 응답

상태 코드:: 200

[
  {
    "text": "medicaid",
    "queryPlusText": "washington medicaid"
  },
  {
    "text": "medicare",
    "queryPlusText": "washington medicare"
  },
  {
    "text": "medicine",
    "queryPlusText": "washington medicine"
  }
]

정의

Name	Description
AutocompleteItem	자동 완성 요청의 결과입니다.
AutocompleteMode	자동 완성 모드를 지정합니다. 기본값은 'oneTerm'입니다. 'twoTerms'를 사용하여 대상 포진 및 'oneTermWithContext'를 사용하여 자동 완성 용어를 생성하는 데 현재 컨텍스트를 사용합니다.
AutocompleteRequest	유사 항목 일치 및 기타 자동 완성 쿼리 동작에 대한 매개 변수입니다.
AutocompleteResult	자동 완성 쿼리의 결과입니다.
ErrorAdditionalInfo	리소스 관리 오류 추가 정보입니다.
ErrorDetail	오류 세부 정보입니다.
ErrorResponse	오류 응답

AutocompleteItem

자동 완성 요청의 결과입니다.

Name	형식	Description
queryPlusText	string	완료된 용어와 함께 쿼리입니다.
text	string	완료된 용어입니다.

AutocompleteMode

자동 완성 모드를 지정합니다. 기본값은 'oneTerm'입니다. 'twoTerms'를 사용하여 대상 포진 및 'oneTermWithContext'를 사용하여 자동 완성 용어를 생성하는 데 현재 컨텍스트를 사용합니다.

Name	형식	Description
oneTerm	string	단 하나의 용어만 제안됩니다. 쿼리에 두 개의 용어가 있는 경우 마지막 용어만 완료됩니다. 예를 들어 입력이 '워싱턴 메딕'인 경우 제안된 용어에는 '메디케이드', '메디케어' 및 '의학'이 포함될 수 있습니다.
oneTermWithContext	string	두 개 이상의 용어를 사용하여 쿼리의 마지막 용어를 완료합니다. 여기서 마지막 두 용어는 인덱스에 있는 구입니다. 예를 들어 입력이 '워싱턴 메딕'인 경우 제안된 용어에는 '워싱턴 메디케이드'와 '워싱턴 의료'가 포함될 수 있습니다.
twoTerms	string	인덱스의 일치하는 2기 구가 제안됩니다. 예를 들어 입력이 '메딕'인 경우 제안된 용어에는 '메디케어 보장'과 '의료 도우미'가 포함될 수 있습니다.

AutocompleteRequest

유사 항목 일치 및 기타 자동 완성 쿼리 동작에 대한 매개 변수입니다.

Name	형식	Description
autocompleteMode	AutocompleteMode	자동 완성 모드를 지정합니다. 기본값은 'oneTerm'입니다. 자동 완성 용어를 생성하는 동안 'twoTerms'를 사용하여 대상 포진 및 'oneTermWithContext'를 사용하여 현재 컨텍스트를 사용합니다.
filter	string	자동 완성 결과에 대해 완료된 용어를 생성하는 데 사용되는 문서를 필터링하는 OData 식입니다.
fuzzy	boolean	자동 완성 쿼리에 유사 항목 일치를 사용할지 여부를 나타내는 값입니다. 기본값은 false입니다. true로 설정하면 검색 텍스트에 대체 문자나 누락된 문자가 있더라도 쿼리가 용어를 자동으로 완성합니다. 이는 일부 시나리오에서 더 나은 환경을 제공하지만 유사 항목 자동 완성 쿼리가 느리고 더 많은 리소스를 사용하므로 성능 비용이 발생합니다.
highlightPostTag	string	적중 강조 표시에 추가되는 문자열 태그입니다. highlightPreTag를 사용하여 설정해야 합니다. 생략하면 적중 항목 강조 표시가 비활성화됩니다.
highlightPreTag	string	강조 표시를 적중하기 위해 앞에 추가되는 문자열 태그입니다. highlightPostTag를 사용하여 설정해야 합니다. 생략하면 적중 항목 강조 표시가 비활성화됩니다.
minimumCoverage	number	쿼리가 성공으로 보고되려면 자동 완성 쿼리에서 처리해야 하는 인덱스의 백분율을 나타내는 0에서 100 사이의 숫자입니다. 이 매개 변수는 복제본이 하나뿐인 서비스에 대해서도 검색 가용성을 보장하는 데 유용할 수 있습니다. 기본값은 80입니다.
search	string	자동 완성 결과를 기반으로 할 검색 텍스트입니다.
searchFields	string	자동 완성 용어를 쿼리할 때 고려할 필드 이름의 쉼표로 구분된 목록입니다. 대상 필드는 지정된 제안자에 포함되어야 합니다.
suggesterName	string	인덱스 정의의 일부인 제안기 컬렉션에 지정된 제안기의 이름입니다.
top	integer	검색할 자동 완성 용어 수입니다. 1에서 100 사이의 값이어야 합니다. 기본값은 5입니다.

AutocompleteResult

자동 완성 쿼리의 결과입니다.

Name	형식	Description
@search.coverage	number	자동 완성 요청에 의해 고려된 인덱스의 백분율을 나타내는 값이거나, 요청에 minimumCoverage가 지정되지 않은 경우 null입니다.
value	AutocompleteItem[]	반환된 자동 완성 항목의 목록입니다.

ErrorAdditionalInfo

리소스 관리 오류 추가 정보입니다.

Name	형식	Description
info	object	추가 정보입니다.
type	string	추가 정보 유형입니다.

ErrorDetail

오류 세부 정보입니다.

Name	형식	Description
additionalInfo	ErrorAdditionalInfo[]	오류 추가 정보입니다.
code	string	오류 코드입니다.
details	ErrorDetail[]	오류 세부 정보입니다.
message	string	오류 메시지입니다.
target	string	오류 대상입니다.

ErrorResponse

오류 응답

Name	형식	Description
error	ErrorDetail	오류 개체입니다.

다음을 통해 공유