Documents - Suggest Post

서비스:: Search Service

API 버전:: 2024-05-01-preview

인덱스에 지정된 부분 쿼리 텍스트와 일치하는 문서를 제안합니다.

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

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	문서를 제안하는 데 사용할 검색 텍스트입니다. 1자 이상이어야 하며 100자를 넘지 않아야 합니다.
suggesterName	True	string	인덱스 정의의 일부인 제안기 컬렉션에 지정된 제안기의 이름입니다.
filter		string	제안으로 간주되는 문서를 필터링하는 OData 식입니다.
fuzzy		boolean	제안 쿼리에 유사 항목 일치를 사용할지 여부를 나타내는 값입니다. 기본값은 false입니다. true로 설정하면 검색 텍스트에 대체 문자나 누락된 문자가 있더라도 쿼리에서 제안을 찾을 수 있습니다. 이는 일부 시나리오에서 더 나은 환경을 제공하지만 유사 항목 제안 검색이 느리고 더 많은 리소스를 사용하므로 성능 비용이 발생합니다.
highlightPostTag		string	적중 강조 표시에 추가되는 문자열 태그입니다. highlightPreTag를 사용하여 설정해야 합니다. 생략하면 추천 항목의 적중 강조 표시가 비활성화됩니다.
highlightPreTag		string	강조 표시를 적중하기 위해 앞에 추가되는 문자열 태그입니다. highlightPostTag를 사용하여 설정해야 합니다. 생략하면 추천 항목의 적중 강조 표시가 비활성화됩니다.
minimumCoverage		number (double)	쿼리가 성공으로 보고되려면 제안 쿼리에서 처리해야 하는 인덱스의 백분율을 나타내는 0에서 100 사이의 숫자입니다. 이 매개 변수는 복제본이 하나뿐인 서비스에 대해서도 검색 가용성을 보장하는 데 유용할 수 있습니다. 기본값은 80입니다.
orderby		string	결과를 정렬할 쉼표로 구분된 OData $orderby 식 목록입니다. 각 식은 field 이름 또는 geo.distance() 또는 search.score() 함수에 대한 호출일 수 있습니다. 각 식 뒤에 asc를 추가하여 오름차순을 나타내거나 내림차순을 나타내는 desc를 지정할 수 있습니다. 기본값은 오름차순입니다. 동점은 문서의 일치 점수에 의해 깨질 것입니다. $orderby 지정하지 않으면 기본 정렬 순서가 문서 일치 점수로 내림차순입니다. 최대 32개의 $orderby 절이 있을 수 있습니다.
searchFields		string	지정된 검색 텍스트를 검색할 필드 이름의 쉼표로 구분된 목록입니다. 대상 필드는 지정된 제안자에 포함되어야 합니다.
select		string	검색할 필드의 쉼표로 구분된 목록입니다. 지정되지 않은 경우 키 필드만 결과에 포함됩니다.
top		integer (int32)	검색할 제안 수입니다. 1에서 100 사이의 값이어야 합니다. 기본값은 5입니다.

응답

Name	형식	Description
200 OK	SuggestDocumentsResult	부분 입력과 일치하는 제안된 문서가 포함된 응답입니다.
Other Status Codes	ErrorResponse	오류 응답입니다.

예제

SearchIndexSuggestDocumentsPost

샘플 요청

HTTP

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

{
  "filter": "rating gt 4.0",
  "highlightPostTag": "</em>",
  "highlightPreTag": "<em>",
  "minimumCoverage": 80,
  "orderby": "rating desc",
  "search": "hote",
  "searchFields": "title",
  "select": "docId,title,description",
  "suggesterName": "sg",
  "top": 10
}

샘플 응답

상태 코드:: 200

{
  "value": [
    {
      "@search.text": "Nice <em>Hotel</em>",
      "description": "Cheapest hotel in town",
      "docId": "1",
      "title": "Nice Hotel"
    },
    {
      "@search.text": "Fancy <em>Hotel</em>",
      "description": "Best hotel in town",
      "docId": "2",
      "title": "Fancy Hotel"
    }
  ]
}

정의

Name	Description
ErrorAdditionalInfo	리소스 관리 오류 추가 정보입니다.
ErrorDetail	오류 세부 정보입니다.
ErrorResponse	오류 응답
SuggestDocumentsResult	인덱스에서의 제안 쿼리 결과를 포함하는 응답입니다.
SuggestRequest	필터링, 정렬, 유사 항목 일치 및 기타 제안 쿼리 동작에 대한 매개 변수입니다.
SuggestResult	제안 쿼리에서 찾은 문서와 관련 메타데이터가 포함된 결과입니다.

ErrorAdditionalInfo

Object

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

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

ErrorDetail

Object

오류 세부 정보입니다.

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

ErrorResponse

Object

오류 응답

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

SuggestDocumentsResult

Object

인덱스에서의 제안 쿼리 결과를 포함하는 응답입니다.

Name	형식	Description
@search.coverage	number (double)	쿼리에 포함된 인덱스의 백분율을 나타내는 값이거나, 요청에 minimumCoverage가 설정되지 않은 경우 null입니다.
value	SuggestResult[]	쿼리에서 반환된 결과의 시퀀스입니다.

SuggestRequest

Object

필터링, 정렬, 유사 항목 일치 및 기타 제안 쿼리 동작에 대한 매개 변수입니다.

Name	형식	Description
filter	string	제안으로 간주되는 문서를 필터링하는 OData 식입니다.
fuzzy	boolean	제안 쿼리에 유사 항목 일치를 사용할지 여부를 나타내는 값입니다. 기본값은 false입니다. true로 설정하면 검색 텍스트에 대체 문자나 누락된 문자가 있더라도 쿼리에서 제안을 찾을 수 있습니다. 이는 일부 시나리오에서 더 나은 환경을 제공하지만 유사 항목 제안 검색이 느리고 더 많은 리소스를 사용하므로 성능 비용이 발생합니다.
highlightPostTag	string	적중 강조 표시에 추가되는 문자열 태그입니다. highlightPreTag를 사용하여 설정해야 합니다. 생략하면 추천 항목의 적중 강조 표시가 비활성화됩니다.
highlightPreTag	string	강조 표시를 적중하기 위해 앞에 추가되는 문자열 태그입니다. highlightPostTag를 사용하여 설정해야 합니다. 생략하면 추천 항목의 적중 강조 표시가 비활성화됩니다.
minimumCoverage	number (double)	쿼리가 성공으로 보고되려면 제안 쿼리에서 처리해야 하는 인덱스의 백분율을 나타내는 0에서 100 사이의 숫자입니다. 이 매개 변수는 복제본이 하나뿐인 서비스에 대해서도 검색 가용성을 보장하는 데 유용할 수 있습니다. 기본값은 80입니다.
orderby	string	결과를 정렬할 쉼표로 구분된 OData $orderby 식 목록입니다. 각 식은 field 이름 또는 geo.distance() 또는 search.score() 함수에 대한 호출일 수 있습니다. 각 식 뒤에 asc를 추가하여 오름차순을 나타내거나 내림차순을 나타내는 desc를 지정할 수 있습니다. 기본값은 오름차순입니다. 동점은 문서의 일치 점수에 의해 깨질 것입니다. $orderby 지정하지 않으면 기본 정렬 순서가 문서 일치 점수로 내림차순입니다. 최대 32개의 $orderby 절이 있을 수 있습니다.
search	string	문서를 제안하는 데 사용할 검색 텍스트입니다. 1자 이상이어야 하며 100자를 넘지 않아야 합니다.
searchFields	string	지정된 검색 텍스트를 검색할 필드 이름의 쉼표로 구분된 목록입니다. 대상 필드는 지정된 제안자에 포함되어야 합니다.
select	string	검색할 필드의 쉼표로 구분된 목록입니다. 지정되지 않은 경우 키 필드만 결과에 포함됩니다.
suggesterName	string	인덱스 정의의 일부인 제안기 컬렉션에 지정된 제안기의 이름입니다.
top	integer (int32)	검색할 제안 수입니다. 1에서 100 사이의 값이어야 합니다. 기본값은 5입니다.

SuggestResult

Object

제안 쿼리에서 찾은 문서와 관련 메타데이터가 포함된 결과입니다.

Name	형식	Description
@search.text	string	제안 결과의 텍스트입니다.