Documents - Search Post

Service:

Search Service

API Version:

2023-10-01-Preview

인덱스에서 문서를 검색합니다.

POST {endpoint}/indexes('{indexName}')/docs/search.post.search?api-version=2023-10-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
answers	QueryAnswerType	답변이 검색 응답의 일부로 반환되어야 하는지 여부를 지정하는 값입니다.
captions	QueryCaptionType	캡션을 검색 응답의 일부로 반환할지 여부를 지정하는 값입니다.
count	boolean	결과의 총 수를 가져올지 여부를 지정하는 값입니다. 기본값은 false입니다. 이 값을 true로 설정하면 성능에 영향을 미칠 수 있습니다. 반환되는 개수는 근사값입니다.
debug	QueryDebugMode	다시 순위가 지정된 결과를 추가로 탐색하는 데 사용할 수 있는 디버깅 도구를 사용하도록 설정합니다.
facets	string[]	검색 쿼리에 적용할 패싯 식 목록입니다. 각 패싯 식에는 필드 이름이 포함되며, 필요에 따라 이름:값 쌍의 쉼표로 구분된 목록이 옵니다.
filter	string	검색 쿼리에 적용할 OData $filter 식입니다.
highlight	string	적중 하이라이트에 사용할 필드 이름의 쉼표로 구분된 목록입니다. 검색 가능한 필드만 적중 항목 강조 표시에 사용할 수 있습니다.
highlightPostTag	string	강조 표시에 추가되는 문자열 태그입니다. highlightPreTag를 사용하여 설정해야 합니다. 기본값은 /em>입니다<.
highlightPreTag	string	강조 표시 앞에 추가되는 문자열 태그입니다. highlightPostTag를 사용하여 설정해야 합니다. 기본값은 em>입니다<.
minimumCoverage	number	쿼리가 성공으로 보고되려면 검색 쿼리에서 다루어야 하는 인덱스의 백분율을 나타내는 0에서 100 사이의 숫자입니다. 이 매개 변수는 복제본(replica) 하나만 있는 서비스에서도 검색 가용성을 보장하는 데 유용할 수 있습니다. 기본값은 100입니다.
orderby	string	결과를 정렬할 OData $orderby 식의 쉼표로 구분된 목록입니다. 각 식은 field name 또는 geo.distance() 또는 search.score() 함수에 대한 호출일 수 있습니다. 각 식 뒤에 asc를 추가하여 오름차순을 나타내거나 내림차순을 나타내는 desc를 사용할 수 있습니다. 기본값은 오름차순입니다. 동률은 문서의 일치 점수로 구분됩니다. $orderby 지정하지 않으면 기본 정렬 순서가 문서 일치 점수별로 내림차순입니다. 최대 32개의 $orderby 절이 있을 수 있습니다.
queryLanguage	QueryLanguage	검색 쿼리의 언어를 지정하는 값입니다.
queryType	QueryType	검색 쿼리의 구문을 지정하는 값입니다. 기본값은 'simple'입니다. 쿼리에서 Lucene 쿼리 구문을 사용하는 경우 'full'을 사용합니다.
scoringParameters	string[]	name-values 형식을 사용하여 점수 매기기 함수(예: referencePointParameter)에 사용할 매개 변수 값 목록입니다. 예를 들어 점수 매기기 프로필이 'mylocation'이라는 매개 변수를 사용하여 함수를 정의하는 경우 매개 변수 문자열은 따옴표 없이 "mylocation--122.2,44.8"입니다.
scoringProfile	string	결과를 정렬하기 위해 일치하는 문서의 일치 점수를 계산하는 점수 매기기 프로필의 이름입니다.
scoringStatistics	ScoringStatistics	더 일관된 채점을 위해 점수 매기기 통계(예: 문서 빈도)를 전역적으로 계산할지, 아니면 대기 시간을 낮추기 위해 로컬로 계산할지를 지정하는 값입니다. 기본값은 'local'입니다. 채점하기 전에 'global'을 사용하여 점수 매기기 통계를 전역적으로 집계합니다. 전역 점수 매기기 통계를 사용하면 검색 쿼리의 대기 시간을 늘릴 수 있습니다.
search	string	전체 텍스트 검색 쿼리 식입니다. 모든 문서와 일치하려면 "*"를 사용하거나 이 매개 변수를 생략합니다.
searchFields	string	전체 텍스트 검색을 scope 필드 이름의 쉼표로 구분된 목록입니다. 전체 Lucene 쿼리에서 필드 검색(fieldName:searchExpression)을 사용하는 경우 필드가 있는 각 검색 식의 필드 이름이 이 매개 변수에 나열된 필드 이름보다 우선합니다.
searchMode	SearchMode	문서를 일치 항목으로 계산하기 위해 검색어 중 하나 또는 모두를 일치시켜야 하는지 여부를 지정하는 값입니다.
select	string	검색할 필드의 쉼표로 구분된 목록입니다. 지정하지 않으면 스키마에서 검색 가능으로 표시된 모든 필드가 포함됩니다.
semanticConfiguration	string	의미 체계 형식의 쿼리에 대한 문서를 처리할 때 사용할 의미 체계 구성의 이름입니다.
semanticErrorHandling	SemanticErrorMode	사용자가 의미 체계 호출이 완전히 실패할지 또는 부분 결과(기본값)를 반환할지 선택할 수 있습니다.
semanticFields	string	의미 체계 순위에 사용되는 필드 이름의 쉼표로 구분된 목록입니다.
semanticMaxWaitInMilliseconds	integer	사용자가 요청이 실패하기 전에 의미 체계 보강이 처리를 완료하는 데 걸리는 시간에 상한을 설정할 수 있습니다.
semanticQuery	string	의미 체계 재전송, 의미 체계 캡션 및 의미 체계 답변에만 사용되는 별도의 검색 쿼리를 설정할 수 있습니다. 기본 검색 및 순위 단계와 L2 의미 체계 단계 간에 서로 다른 쿼리를 사용해야 하는 시나리오에 유용합니다.
sessionId	string	더 일관된 결과를 얻는 데 도움이 될 수 있는 고정 세션을 만드는 데 사용할 값입니다. 동일한 sessionId를 사용하는 한 동일한 복제본(replica) 집합을 대상으로 하여 최선의 노력을 기울입니다. 동일한 sessionID 값을 반복적으로 다시 사용하면 복제본 간에 요청의 부하 분산을 방해하고 검색 서비스의 성능에 부정적인 영향을 줄 수 있습니다. sessionId로 사용된 값은 '_' 문자로 시작할 수 없습니다.
skip	integer	건너뛸 검색 결과의 수입니다. 이 값은 100,000보다 클 수 없습니다. 문서를 순서대로 검사해야 하지만 이 제한으로 인해 skip을 사용할 수 없는 경우 완전히 정렬된 키에 orderby를 사용하고 범위 쿼리를 사용하여 필터링하는 것이 좋습니다.
speller	QuerySpellerType	개별 검색 쿼리 용어를 맞춤법 검사하는 데 사용할 맞춤법 검사기 유형을 지정한 값입니다.
top	integer	검색할 검색 결과의 수입니다. $skip 함께 사용하여 검색 결과의 클라이언트 쪽 페이징을 구현할 수 있습니다. 서버 쪽 페이징으로 인해 결과가 잘리는 경우 응답에는 결과의 다음 페이지에 대한 다른 검색 요청을 발급하는 데 사용할 수 있는 연속 토큰이 포함됩니다.
vectorFilterMode	VectorFilterMode	벡터 검색이 수행되기 전이나 후에 필터가 적용되는지 여부를 결정합니다. 기본값은 'preFilter'입니다.
vectorQueries	VectorQuery[]: RawVectorQuery[] VectorizableTextQuery[]	벡터 및 하이브리드 검색 쿼리에 대한 쿼리 매개 변수입니다.

응답

Name	형식	Description
200 OK	SearchDocumentsResult	검색 조건과 일치하는 문서가 포함된 응답입니다.
Other Status Codes	SearchError	오류 응답입니다.

예제

SearchIndexSearchDocumentsPost

Sample Request

HTTP

POST https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2023-10-01-Preview

{
  "count": true,
  "facets": [
    "category,count:10,sort:count"
  ],
  "filter": "rating gt 4.0",
  "highlight": "description",
  "highlightPostTag": "</em>",
  "highlightPreTag": "<em>",
  "minimumCoverage": null,
  "orderby": "rating desc",
  "queryType": "simple",
  "scoringParameters": [
    "currentLocation--122.123,44.77233"
  ],
  "scoringProfile": "sp",
  "search": "nice hotels",
  "searchFields": "category,description",
  "searchMode": "any",
  "sessionId": "mysessionid",
  "scoringStatistics": "global",
  "select": "hotelId,description",
  "skip": 0,
  "top": 10,
  "vectorQueries": [
    {
      "kind": "vector",
      "vector": [
        0.103,
        0.0712,
        0.0852,
        0.1547,
        0.1183
      ],
      "fields": "descriptionEmbedding",
      "k": 5,
      "exhaustive": true
    }
  ],
  "vectorFilterMode": "preFilter"
}

Sample Response

Status code:

200

{
  "@odata.count": 25,
  "@search.facets": {
    "category": [
      {
        "count": 1,
        "value": "Economy"
      },
      {
        "count": 1,
        "value": "Luxury"
      }
    ]
  },
  "@search.nextPageParameters": {
    "count": true,
    "facets": [
      "category,count:10,sort:count"
    ],
    "filter": "rating gt 4.0",
    "highlight": "title",
    "highlightPostTag": "</em>",
    "highlightPreTag": "<em>",
    "minimumCoverage": null,
    "orderby": "search.score() desc,rating desc",
    "queryType": "simple",
    "sessionId": "mysessionid",
    "scoringStatistics": "global",
    "scoringParameters": [
      "currentLocation--122.123,44.77233"
    ],
    "scoringProfile": "sp",
    "search": "nice hotels",
    "searchFields": "title,description",
    "searchMode": "any",
    "select": "docId,title,description",
    "skip": 2,
    "top": 8
  },
  "value": [
    {
      "@search.score": 1.5,
      "@search.highlights": {
        "title": [
          "<em>Nice</em> <em>Hotel</em>"
        ]
      },
      "description": "Cheapest hotel in town",
      "docId": "1",
      "title": "Nice Hotel"
    },
    {
      "@search.score": 0.7,
      "@search.highlights": {
        "title": [
          "Fancy <em>Hotel</em>"
        ]
      },
      "description": "Best hotel in town",
      "docId": "2",
      "title": "Fancy Hotel"
    }
  ],
  "@odata.nextLink": "https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2023-10-01-Preview"
}

정의

Name	Description
AnswerResult	대답은 쿼리와 일치하는 가장 관련성이 큰 문서의 내용에서 추출된 텍스트 구절입니다. 답변은 상위 검색 결과에서 추출됩니다. 답변 응시자가 채점되고 상위 답변이 선택됩니다.
CaptionResult	캡션은 검색 쿼리에 상대적으로 문서에서 가장 대표적인 구절입니다. 문서 요약으로 자주 사용됩니다. 캡션은 '의미 체계' 형식의 쿼리에 대해서만 반환됩니다.
DocumentDebugInfo	검색 결과를 추가로 탐색하는 데 사용할 수 있는 디버깅 정보를 포함합니다.
QueryAnswerType	응답을 검색 응답의 일부로 반환할지 여부를 지정하는 값입니다.
QueryCaptionType	캡션을 검색 응답의 일부로 반환할지 여부를 지정하는 값입니다.
QueryDebugMode	검색 결과를 추가로 탐색하는 데 사용할 수 있는 디버깅 도구를 사용하도록 설정합니다.
QueryLanguage	쿼리의 언어입니다.
QueryResultDocumentRerankerInput	의미 체계 보강 프로세스로 전송된 원시 연결 문자열입니다.
QueryResultDocumentSemanticField	의미 체계 보강 프로세스로 전송된 필드와 사용 방법에 대한 설명
QuerySpellerType	개별 검색 쿼리 용어를 맞춤법 검사하는 데 사용할 맞춤법 검사기의 형식을 지정한 값입니다.
QueryType	검색 쿼리의 구문을 지정합니다. 기본값은 'simple'입니다. 쿼리에서 Lucene 쿼리 구문을 사용하는 경우 'full'을 사용하고 쿼리 구문이 필요하지 않은 경우 '의미 체계'를 사용합니다.
RawVectorQuery	원시 벡터 값이 제공될 때 벡터 검색에 사용할 쿼리 매개 변수입니다.
ScoringStatistics	더 일관된 채점을 위해 점수 매기기 통계(예: 문서 빈도)를 전역적으로 계산할지, 아니면 대기 시간을 낮추기 위해 로컬로 계산할지를 지정하는 값입니다. 기본값은 'local'입니다. 채점하기 전에 'global'을 사용하여 점수 매기기 통계를 전역적으로 집계합니다. 전역 점수 매기기 통계를 사용하면 검색 쿼리의 대기 시간을 늘릴 수 있습니다.
SearchDocumentsResult	인덱스에서 검색 결과를 포함하는 응답입니다.
SearchError	API에 대한 오류 조건에 대해 설명합니다.
SearchMode	문서를 일치 항목으로 계산하기 위해 일치해야 하는 항목(모든 검색 용어 또는 검색 용어 중 하나)을 지정합니다.
SearchRequest	필터링, 정렬, 패싯, 페이징 및 기타 검색 쿼리 동작에 대한 매개 변수입니다.
SearchResult	검색 쿼리에서 찾은 문서와 연결된 메타데이터를 포함합니다.
SemanticDebugInfo
SemanticErrorMode	사용자가 의미 체계 호출이 완전히 실패할지 또는 부분 결과(기본값)를 반환할지 선택할 수 있습니다.
SemanticErrorReason	의미 체계 순위 요청에 대해 부분 응답이 반환된 이유입니다.
SemanticFieldState	필드가 의미 체계 보강 프로세스에 사용된 방식(완전히 사용, 부분적으로 사용 또는 사용되지 않음)
SemanticSearchResultsType	의미 체계 순위 요청에 대해 반환된 부분 응답의 유형입니다.
VectorFilterMode	벡터 검색이 수행되기 전이나 후에 필터가 적용되는지 여부를 결정합니다.
VectorizableTextQuery	벡터화해야 하는 텍스트 값이 제공될 때 벡터 검색에 사용할 쿼리 매개 변수입니다.
VectorQueryKind	수행 중인 벡터 쿼리의 종류입니다.

AnswerResult

대답은 쿼리와 일치하는 가장 관련성이 큰 문서의 내용에서 추출된 텍스트 구절입니다. 답변은 상위 검색 결과에서 추출됩니다. 답변 응시자가 채점되고 상위 답변이 선택됩니다.

Name	형식	Description
highlights	string	쿼리와 가장 관련이 있는 강조 표시된 텍스트 구가 있는 Text 속성과 동일한 텍스트 구절입니다.
key	string	답변이 추출된 문서의 키입니다.
score	number	점수 값은 쿼리에 대해 반환된 다른 답변과 비교하여 응답이 쿼리와 얼마나 관련이 있는지를 나타냅니다.
text	string	문서 내용에서 추출된 텍스트 구절을 답변으로 사용합니다.

CaptionResult

캡션은 검색 쿼리에 상대적으로 문서에서 가장 대표적인 구절입니다. 문서 요약으로 자주 사용됩니다. 캡션은 '의미 체계' 형식의 쿼리에 대해서만 반환됩니다.

Name	형식	Description
highlights	string	쿼리와 가장 관련이 있는 강조 표시된 구가 있는 Text 속성과 동일한 텍스트 구절입니다.
text	string	검색 쿼리와 가장 관련된 문서에서 추출된 대표 텍스트 구절입니다.

DocumentDebugInfo

검색 결과를 추가로 탐색하는 데 사용할 수 있는 디버깅 정보를 포함합니다.

Name	형식	Description
semantic	SemanticDebugInfo	의미 체계 순위 요청과 관련된 디버깅 정보를 포함합니다.

QueryAnswerType

응답을 검색 응답의 일부로 반환할지 여부를 지정하는 값입니다.

Name	형식	Description
extractive	string	자연어로 질문으로 표현된 쿼리에 대한 응답으로 반환된 문서의 내용에서 답변 후보를 추출합니다.
none	string	쿼리에 대한 답변을 반환하지 마세요.

QueryCaptionType

캡션을 검색 응답의 일부로 반환할지 여부를 지정하는 값입니다.

Name	형식	Description
extractive	string	검색 쿼리와 관련된 구절이 포함된 일치하는 문서에서 캡션을 추출합니다.
none	string	쿼리에 대한 캡션을 반환하지 마세요.

QueryDebugMode

검색 결과를 추가로 탐색하는 데 사용할 수 있는 디버깅 도구를 사용하도록 설정합니다.

Name	형식	Description
disabled	string	쿼리 디버깅 정보가 반환되지 않습니다.
semantic	string	사용자가 다시 순위가 지정된 결과를 추가로 탐색할 수 있습니다.

QueryLanguage

쿼리의 언어입니다.

Name	형식	Description
ar-eg	string	아랍어(이집트)에 대한 쿼리 언어 값입니다.
ar-jo	string	아랍어(요르단)에 대한 쿼리 언어 값입니다.
ar-kw	string	아랍어(쿠웨이트)에 대한 쿼리 언어 값입니다.
ar-ma	string	아랍어(모로코)에 대한 쿼리 언어 값입니다.
ar-sa	string	아랍어(사우디아라비아)에 대한 쿼리 언어 값입니다.
bg-bg	string	불가리아어(불가리아)에 대한 쿼리 언어 값입니다.
bn-in	string	벵골어(인도)에 대한 쿼리 언어 값입니다.
ca-es	string	카탈로니아어에 대한 쿼리 언어 값입니다.
cs-cz	string	체코어(체코)에 대한 쿼리 언어 값입니다.
da-dk	string	덴마크어(덴마크)에 대한 쿼리 언어 값입니다.
de-de	string	독일어(독일)에 대한 쿼리 언어 값입니다.
el-gr	string	그리스어(그리스)에 대한 쿼리 언어 값입니다.
en-au	string	영어(오스트레일리아)에 대한 쿼리 언어 값입니다.
en-ca	string	영어(캐나다)에 대한 쿼리 언어 값입니다.
en-gb	string	영어(영국)에 대한 쿼리 언어 값입니다.
en-in	string	영어(인도)에 대한 쿼리 언어 값입니다.
en-us	string	영어(미국)에 대한 쿼리 언어 값입니다.
es-es	string	스페인어(스페인)에 대한 쿼리 언어 값입니다.
es-mx	string	스페인어(멕시코)에 대한 쿼리 언어 값입니다.
et-ee	string	에스토니아어(에스토니아)에 대한 쿼리 언어 값입니다.
eu-es	string	Basque에 대한 쿼리 언어 값입니다.
fa-ae	string	페르시아어(U.A.E.)에 대한 쿼리 언어 값입니다.
fi-fi	string	핀란드어(핀란드)에 대한 쿼리 언어 값입니다.
fr-ca	string	프랑스어(캐나다)에 대한 쿼리 언어 값입니다.
fr-fr	string	프랑스어(프랑스)에 대한 쿼리 언어 값입니다.
ga-ie	string	아일랜드어(아일랜드)에 대한 쿼리 언어 값입니다.
gl-es	string	Galician에 대한 쿼리 언어 값입니다.
gu-in	string	구자라트어(인도)에 대한 쿼리 언어 값입니다.
he-il	string	히브리어(이스라엘)에 대한 쿼리 언어 값입니다.
hi-in	string	힌디어(인도)에 대한 쿼리 언어 값입니다.
hr-ba	string	크로아티아어(보스니아 헤르체고비나)에 대한 쿼리 언어 값입니다.
hr-hr	string	크로아티아어(크로아티아)에 대한 쿼리 언어 값입니다.
hu-hu	string	헝가리어(헝가리)에 대한 쿼리 언어 값입니다.
hy-am	string	아르메니아어(아르메니아)에 대한 쿼리 언어 값입니다.
id-id	string	인도네시아어(인도네시아)에 대한 쿼리 언어 값입니다.
is-is	string	아이슬란드어(아이슬란드)에 대한 쿼리 언어 값입니다.
it-it	string	이탈리아어(이탈리아)에 대한 쿼리 언어 값입니다.
ja-jp	string	일본어(일본)에 대한 쿼리 언어 값입니다.
kn-in	string	Kannada(인도)에 대한 쿼리 언어 값입니다.
ko-kr	string	한국어(한국)에 대한 쿼리 언어 값입니다.
lt-lt	string	리투아니아어(리투아니아)에 대한 쿼리 언어 값입니다.
lv-lv	string	라트비아어(라트비아)에 대한 쿼리 언어 값입니다.
ml-in	string	Malayalam(인도)에 대한 쿼리 언어 값입니다.
mr-in	string	Marathi(인도)에 대한 쿼리 언어 값입니다.
ms-bn	string	말레이어(브루나이 다루살람)에 대한 쿼리 언어 값입니다.
ms-my	string	말레이어(말레이시아)에 대한 쿼리 언어 값입니다.
nb-no	string	노르웨이어(노르웨이)에 대한 쿼리 언어 값입니다.
nl-be	string	네덜란드어(벨기에)에 대한 쿼리 언어 값입니다.
nl-nl	string	네덜란드어(네덜란드)에 대한 쿼리 언어 값입니다.
no-no	string	노르웨이어(노르웨이)에 대한 쿼리 언어 값입니다.
none	string	쿼리 언어가 지정되지 않았습니다.
pa-in	string	펀자브어(인도)에 대한 쿼리 언어 값입니다.
pl-pl	string	폴란드어(폴란드)에 대한 쿼리 언어 값입니다.
pt-br	string	포르투갈어(브라질)에 대한 쿼리 언어 값입니다.
pt-pt	string	포르투갈어(포르투갈)에 대한 쿼리 언어 값입니다.
ro-ro	string	루마니아어(루마니아)에 대한 쿼리 언어 값입니다.
ru-ru	string	러시아어(러시아)에 대한 쿼리 언어 값입니다.
sk-sk	string	슬로바키아어(슬로바키아)에 대한 쿼리 언어 값입니다.
sl-sl	string	슬로베니아어(슬로베니아)에 대한 쿼리 언어 값입니다.
sr-ba	string	세르비아어(보스니아 헤르체고비나)에 대한 쿼리 언어 값입니다.
sr-me	string	세르비아어(몬테네그로)에 대한 쿼리 언어 값입니다.
sr-rs	string	세르비아어(세르비아)에 대한 쿼리 언어 값입니다.
sv-se	string	스웨덴어(스웨덴)에 대한 쿼리 언어 값입니다.
ta-in	string	타밀어(인도)에 대한 쿼리 언어 값입니다.
te-in	string	Telugu(인도)에 대한 쿼리 언어 값입니다.
th-th	string	태국어(태국)에 대한 쿼리 언어 값입니다.
tr-tr	string	터키어(터키)에 대한 쿼리 언어 값입니다.
uk-ua	string	우크라이나어(우크라이나)에 대한 쿼리 언어 값입니다.
ur-pk	string	Urdu(파키스탄)에 대한 쿼리 언어 값입니다.
vi-vn	string	베트남어(Viet Nam)에 대한 쿼리 언어 값입니다.
zh-cn	string	중국어(중국)에 대한 쿼리 언어 값입니다.
zh-tw	string	중국어(대만)에 대한 쿼리 언어 값입니다.

QueryResultDocumentRerankerInput

의미 체계 보강 프로세스로 전송된 원시 연결 문자열입니다.

Name	형식	Description
content	string	의미 체계 보강에 사용된 콘텐츠 필드의 원시 연결 문자열입니다.
keywords	string	의미 체계 보강에 사용된 키워드(keyword) 필드에 대한 원시 연결 문자열입니다.
title	string	의미 체계 보강에 사용된 제목 필드의 원시 문자열입니다.

QueryResultDocumentSemanticField

의미 체계 보강 프로세스로 전송된 필드와 사용 방법에 대한 설명

Name	형식	Description
name	string	의미 체계 보강 프로세스로 전송된 필드의 이름입니다.
state	SemanticFieldState	필드가 의미 체계 보강 프로세스에 사용된 방식(완전히 사용, 부분적으로 사용 또는 사용되지 않음)

QuerySpellerType

개별 검색 쿼리 용어를 맞춤법 검사하는 데 사용할 맞춤법 검사기의 형식을 지정한 값입니다.

Name	형식	Description
lexicon	string	맞춤법 검사기는 queryLanguage 매개 변수로 지정된 언어에 대해 정적 어휘집을 사용하여 개별 쿼리 용어를 수정합니다.
none	string	맞춤법 검사기를 사용할 수 없습니다.

QueryType

검색 쿼리의 구문을 지정합니다. 기본값은 'simple'입니다. 쿼리에서 Lucene 쿼리 구문을 사용하는 경우 'full'을 사용하고 쿼리 구문이 필요하지 않은 경우 '의미 체계'를 사용합니다.

Name	형식	Description
full	string	검색에 전체 Lucene 쿼리 구문을 사용합니다. 검색 텍스트는 필드별 및 가중치 검색과 기타 고급 기능을 허용하는 Lucene 쿼리 언어를 사용하여 해석됩니다.
semantic	string	키워드가 아닌 자연어로 표현된 쿼리에 가장 적합합니다. 웹 모음에서 학습된 순위 모델을 사용하여 상위 검색 결과의 순위를 다시 지정하여 검색 결과의 정밀도를 향상시킵니다.
simple	string	검색에 간단한 쿼리 구문을 사용합니다. 검색 텍스트는 +, * 및 ""와 같은 기호를 허용하는 간단한 쿼리 언어를 사용하여 해석됩니다. searchFields 매개 변수를 지정하지 않는 한 쿼리는 기본적으로 모든 검색 가능한 필드에서 평가됩니다.

RawVectorQuery

원시 벡터 값이 제공될 때 벡터 검색에 사용할 쿼리 매개 변수입니다.

Name	형식	Description
exhaustive	boolean	true이면 벡터 인덱스 내의 모든 벡터에서 K-가장 가까운 전체 인접 검색을 트리거합니다. 정확한 일치 항목이 중요한 시나리오(예: 접지 진리 값 결정)에 유용합니다.
fields	string	검색된 벡터에 포함할 Collection(Edm.Single) 형식의 벡터 필드입니다.
k	integer	상위 적중으로 반환할 가장 가까운 이웃의 수입니다.
kind	string: vector	수행 중인 벡터 쿼리의 종류입니다.
vector	number[]	검색 쿼리의 벡터 표현입니다.

ScoringStatistics

더 일관된 채점을 위해 점수 매기기 통계(예: 문서 빈도)를 전역적으로 계산할지, 아니면 대기 시간을 낮추기 위해 로컬로 계산할지를 지정하는 값입니다. 기본값은 'local'입니다. 채점하기 전에 'global'을 사용하여 점수 매기기 통계를 전역적으로 집계합니다. 전역 점수 매기기 통계를 사용하면 검색 쿼리의 대기 시간을 늘릴 수 있습니다.

Name	형식	Description
global	string	점수 매기기 통계는 보다 일관된 채점을 위해 전역적으로 계산됩니다.
local	string	채점 통계는 대기 시간을 낮추기 위해 로컬로 계산됩니다.

SearchDocumentsResult

인덱스에서 검색 결과를 포함하는 응답입니다.

Name	형식	Description
@odata.count	integer	검색 작업에서 찾은 결과의 총 개수이거나, 개수가 요청되지 않은 경우 null입니다. 있는 경우 개수가 이 응답의 결과 수보다 클 수 있습니다. 이 문제는 $top 또는 $skip 매개 변수를 사용하거나 쿼리가 요청된 모든 문서를 단일 응답으로 반환할 수 없는 경우에 발생할 수 있습니다.
@odata.nextLink	string	쿼리가 요청된 모든 결과를 단일 응답으로 반환할 수 없을 때 반환되는 연속 URL입니다. 이 URL을 사용하여 다른 GET 또는 POST 검색 요청을 작성하여 검색 응답의 다음 부분을 가져올 수 있습니다. 이 응답을 생성한 요청과 동일한 동사(GET 또는 POST)를 사용해야 합니다.
@search.answers	AnswerResult[]	검색 작업에 대한 쿼리 결과에 대한 답변입니다. 응답 쿼리 매개 변수가 지정되지 않았거나 'none'으로 설정되지 않은 경우 null입니다.
@search.coverage	number	쿼리에 포함된 인덱스의 백분율을 나타내는 값이거나, 요청에 minimumCoverage가 지정되지 않은 경우 null입니다.
@search.facets	object	각 패싯 필드에 대한 버킷 컬렉션으로 구성된 검색 작업에 대한 패싯 쿼리 결과입니다. 쿼리에 패싯 식이 포함되지 않은 경우 null입니다.
@search.nextPageParameters	SearchRequest	쿼리가 요청된 모든 결과를 단일 응답으로 반환할 수 없을 때 반환되는 연속 JSON 페이로드입니다. 이 JSON과 @odata.nextLink 함께 다른 POST Search 요청을 작성하여 검색 응답의 다음 부분을 가져올 수 있습니다.
@search.semanticPartialResponseReason	SemanticErrorReason	의미 체계 순위 요청에 대해 부분 응답이 반환된 이유입니다.
@search.semanticPartialResponseType	SemanticSearchResultsType	의미 체계 순위 요청에 대해 반환된 부분 응답의 유형입니다.
value	SearchResult[]	쿼리에서 반환된 결과 시퀀스입니다.

SearchError

API에 대한 오류 조건에 대해 설명합니다.

Name	형식	Description
code	string	서버 정의 오류 코드 집합 중 하나입니다.
details	SearchError[]	이 보고된 오류로 이어진 특정 오류에 대한 세부 정보 배열입니다.
message	string	사람이 읽을 수 있는 오류 표현입니다.

SearchMode

문서를 일치 항목으로 계산하기 위해 일치해야 하는 항목(모든 검색 용어 또는 검색 용어 중 하나)을 지정합니다.

Name	형식	Description
all	string	문서를 일치 항목으로 계산하려면 모든 검색어를 일치시켜야 합니다.
any	string	문서를 일치 항목으로 계산하려면 검색어 중 하나라도 일치해야 합니다.

SearchRequest

필터링, 정렬, 패싯, 페이징 및 기타 검색 쿼리 동작에 대한 매개 변수입니다.

Name	형식	Description
answers	QueryAnswerType	응답을 검색 응답의 일부로 반환할지 여부를 지정하는 값입니다.
captions	QueryCaptionType	캡션을 검색 응답의 일부로 반환할지 여부를 지정하는 값입니다.
count	boolean	결과의 총 수를 가져올지 여부를 지정하는 값입니다. 기본값은 false입니다. 이 값을 true로 설정하면 성능에 영향을 미칠 수 있습니다. 반환되는 개수는 근사값입니다.
debug	QueryDebugMode	다시 실행된 결과를 추가로 탐색하는 데 사용할 수 있는 디버깅 도구를 사용하도록 설정합니다.
facets	string[]	검색 쿼리에 적용할 패싯 식 목록입니다. 각 패싯 식에는 필드 이름이 포함되며, 필요에 따라 이름:값 쌍의 쉼표로 구분된 목록이 옵니다.
filter	string	검색 쿼리에 적용할 OData $filter 식입니다.
highlight	string	적중 하이라이트에 사용할 필드 이름의 쉼표로 구분된 목록입니다. 검색 가능한 필드만 적중 항목 강조 표시에 사용할 수 있습니다.
highlightPostTag	string	강조 표시에 추가되는 문자열 태그입니다. highlightPreTag를 사용하여 설정해야 합니다. 기본값은 /em>입니다<.
highlightPreTag	string	강조 표시 앞에 추가되는 문자열 태그입니다. highlightPostTag를 사용하여 설정해야 합니다. 기본값은 em>입니다<.
minimumCoverage	number	쿼리가 성공으로 보고되려면 검색 쿼리에서 다루어야 하는 인덱스의 백분율을 나타내는 0에서 100 사이의 숫자입니다. 이 매개 변수는 복제본(replica) 하나만 있는 서비스에서도 검색 가용성을 보장하는 데 유용할 수 있습니다. 기본값은 100입니다.
orderby	string	결과를 정렬할 OData $orderby 식의 쉼표로 구분된 목록입니다. 각 식은 field name 또는 geo.distance() 또는 search.score() 함수에 대한 호출일 수 있습니다. 각 식 뒤에 asc를 추가하여 오름차순을 나타내거나 내림차순을 나타내는 desc를 사용할 수 있습니다. 기본값은 오름차순입니다. 동률은 문서의 일치 점수로 구분됩니다. $orderby 지정하지 않으면 기본 정렬 순서가 문서 일치 점수별로 내림차순입니다. 최대 32개의 $orderby 절이 있을 수 있습니다.
queryLanguage	QueryLanguage	검색 쿼리의 언어를 지정하는 값입니다.
queryType	QueryType	검색 쿼리의 구문을 지정하는 값입니다. 기본값은 'simple'입니다. 쿼리에서 Lucene 쿼리 구문을 사용하는 경우 'full'을 사용합니다.
scoringParameters	string[]	name-values 형식을 사용하여 점수 매기기 함수(예: referencePointParameter)에 사용할 매개 변수 값 목록입니다. 예를 들어 점수 매기기 프로필이 'mylocation'이라는 매개 변수를 사용하여 함수를 정의하는 경우 매개 변수 문자열은 따옴표 없이 "mylocation--122.2,44.8"이 됩니다.
scoringProfile	string	결과를 정렬하기 위해 일치하는 문서의 일치 점수를 계산하는 점수 매기기 프로필의 이름입니다.
scoringStatistics	ScoringStatistics	더 일관된 채점을 위해 점수 매기기 통계(예: 문서 빈도)를 전역적으로 계산할지, 아니면 대기 시간을 낮추기 위해 로컬로 계산할지를 지정하는 값입니다. 기본값은 'local'입니다. 채점하기 전에 'global'을 사용하여 점수 매기기 통계를 전역적으로 집계합니다. 전역 점수 매기기 통계를 사용하면 검색 쿼리의 대기 시간을 늘릴 수 있습니다.
search	string	전체 텍스트 검색 쿼리 식입니다. 모든 문서와 일치하려면 "*"를 사용하거나 이 매개 변수를 생략합니다.
searchFields	string	전체 텍스트 검색을 scope 필드 이름의 쉼표로 구분된 목록입니다. 전체 Lucene 쿼리에서 필드 검색(fieldName:searchExpression)을 사용하는 경우 필드가 있는 각 검색 식의 필드 이름이 이 매개 변수에 나열된 필드 이름보다 우선합니다.
searchMode	SearchMode	문서를 일치 항목으로 계산하기 위해 검색어 중 하나 또는 전부를 일치시켜야 하는지 여부를 지정하는 값입니다.
select	string	검색할 쉼표로 구분된 필드 목록입니다. 지정하지 않으면 스키마에서 검색 가능으로 표시된 모든 필드가 포함됩니다.
semanticConfiguration	string	형식 의미 체계의 쿼리에 대한 문서를 처리할 때 사용할 의미 체계 구성의 이름입니다.
semanticErrorHandling	SemanticErrorMode	사용자가 의미 체계 호출이 완전히 실패할지 또는 부분 결과(기본값)를 반환할지 선택할 수 있습니다.
semanticFields	string	의미 체계 순위에 사용되는 필드 이름의 쉼표로 구분된 목록입니다.
semanticMaxWaitInMilliseconds	integer	사용자가 요청이 실패하기 전에 의미 체계 보강이 처리를 완료하는 데 걸리는 시간에 상한을 설정할 수 있습니다.
semanticQuery	string	의미 체계 재전송, 의미 체계 캡션 및 의미 체계 답변에만 사용되는 별도의 검색 쿼리를 설정할 수 있습니다. 기본 검색 및 순위 단계와 L2 의미 체계 단계 간에 서로 다른 쿼리를 사용해야 하는 시나리오에 유용합니다.
sessionId	string	더 일관된 결과를 얻는 데 도움이 될 수 있는 고정 세션을 만드는 데 사용할 값입니다. 동일한 sessionId를 사용하는 한 동일한 복제본(replica) 집합을 대상으로 하여 최선의 노력을 기울입니다. 동일한 sessionID 값을 반복적으로 다시 사용하면 복제본 간에 요청의 부하 분산을 방해하고 검색 서비스의 성능에 부정적인 영향을 줄 수 있습니다. sessionId로 사용된 값은 '_' 문자로 시작할 수 없습니다.
skip	integer	건너뛸 검색 결과의 수입니다. 이 값은 100,000보다 클 수 없습니다. 문서를 순서대로 검사해야 하지만 이 제한으로 인해 건너뛰기를 사용할 수 없는 경우 완전히 정렬된 키에 orderby를 사용하고 범위 쿼리를 사용하여 필터링하는 것이 좋습니다.
speller	QuerySpellerType	개별 검색 쿼리 용어를 맞춤법 검사하는 데 사용할 맞춤법 검사기의 형식을 지정한 값입니다.
top	integer	검색할 검색 결과의 수입니다. $skip 함께 사용하여 검색 결과의 클라이언트 쪽 페이징을 구현할 수 있습니다. 서버 쪽 페이징으로 인해 결과가 잘리는 경우 응답에는 결과의 다음 페이지에 대한 다른 검색 요청을 발급하는 데 사용할 수 있는 연속 토큰이 포함됩니다.
vectorFilterMode	VectorFilterMode	벡터 검색이 수행되기 전이나 후에 필터가 적용되는지 여부를 결정합니다. 기본값은 'preFilter'입니다.
vectorQueries	VectorQuery[]: RawVectorQuery[] VectorizableTextQuery[]	벡터 및 하이브리드 검색 쿼리에 대한 쿼리 매개 변수입니다.

SearchResult

검색 쿼리에서 찾은 문서와 연결된 메타데이터를 포함합니다.

Name	형식	Description
@search.captions	CaptionResult[]	캡션은 검색 쿼리에 상대적으로 문서에서 가장 대표적인 구절입니다. 문서 요약으로 자주 사용됩니다. 캡션은 '의미 체계' 형식의 쿼리에 대해서만 반환됩니다.
@search.documentDebugInfo	DocumentDebugInfo[]	검색 결과를 추가로 탐색하는 데 사용할 수 있는 디버깅 정보를 포함합니다.
@search.highlights	object	일치하는 검색어를 나타내는 문서의 텍스트 조각이며 해당 필드별로 구성됩니다. 적중 항목 강조 표시가 쿼리에 대해 사용하도록 설정되지 않은 경우 null입니다.
@search.rerankerScore	number	상위 검색 결과에 대한 의미 체계 순위가 계산한 관련성 점수입니다. 검색 결과는 먼저 RerankerScore를 기준으로 정렬된 다음 점수별로 정렬됩니다. RerankerScore는 '의미 체계' 형식의 쿼리에 대해서만 반환됩니다.
@search.score	number	쿼리에서 반환된 다른 문서와 비교하여 문서의 관련성 점수입니다.

SemanticDebugInfo

Name	형식	Description
contentFields	QueryResultDocumentSemanticField[]	의미 체계 보강 프로세스로 전송된 콘텐츠 필드와 사용된 방법
keywordFields	QueryResultDocumentSemanticField[]	의미 체계 보강 프로세스로 전송된 키워드(keyword) 필드 및 사용 방법
rerankerInput	QueryResultDocumentRerankerInput	의미 체계 보강 프로세스로 전송된 원시 연결 문자열입니다.
titleField	QueryResultDocumentSemanticField	의미 체계 보강 프로세스로 전송된 제목 필드와 사용된 방법

SemanticErrorMode

사용자가 의미 체계 호출이 완전히 실패할지 또는 부분 결과(기본값)를 반환할지 선택할 수 있습니다.

Name	형식	Description
fail	string	의미 체계 처리 단계에서 예외가 있는 경우 쿼리가 실패하고 오류에 따라 적절한 HTTP 코드를 반환합니다.
partial	string	의미 체계 처리에 실패하면 부분 결과가 여전히 반환됩니다. 부분 결과의 정의는 실패한 의미 체계 단계와 실패 원인에 따라 달라집니다.

SemanticErrorReason

의미 체계 순위 요청에 대해 부분 응답이 반환된 이유입니다.

Name	형식	Description
capacityOverloaded	string	요청이 제한되었습니다. 기본 결과만 반환되었습니다.
maxWaitExceeded	string	'semanticMaxWaitInMilliseconds'가 설정되고 의미 체계 처리 기간이 해당 값을 초과한 경우 기본 결과만 반환되었습니다.
transient	string	의미 체계 프로세스의 하나 이상의 단계가 실패했습니다.

SemanticFieldState

필드가 의미 체계 보강 프로세스에 사용된 방식(완전히 사용, 부분적으로 사용 또는 사용되지 않음)

Name	형식	Description
partial	string	필드는 의미 체계 보강에 부분적으로 사용되었습니다.
unused	string	필드는 의미 체계 보강에 사용되지 않았습니다.
used	string	필드는 의미 체계 보강에 완전히 사용되었습니다.

SemanticSearchResultsType

의미 체계 순위 요청에 대해 반환된 부분 응답의 유형입니다.

Name	형식	Description
baseResults	string	의미 체계 보강 또는 재전송이 없는 결과입니다.
rerankedResults	string	결과는 재전송 모델로 다시 표시되었으며 의미 체계 캡션이 포함됩니다. 여기에는 답변, 답변 하이라이트 또는 캡션 하이라이트가 포함되지 않습니다.

VectorFilterMode

벡터 검색이 수행되기 전이나 후에 필터가 적용되는지 여부를 결정합니다.

Name	형식	Description
postFilter	string	필터는 후보 벡터 결과 집합이 반환된 후에 적용됩니다. 필터 선택성에 따라 'k' 매개 변수에서 요청한 것보다 적은 결과가 발생할 수 있습니다.
preFilter	string	필터는 검색 쿼리 전에 적용됩니다.

VectorizableTextQuery

벡터화해야 하는 텍스트 값이 제공될 때 벡터 검색에 사용할 쿼리 매개 변수입니다.

Name	형식	Description
exhaustive	boolean	true이면 벡터 인덱스 내의 모든 벡터에서 K-가장 가까운 전체 인접 검색을 트리거합니다. 정확한 일치 항목이 중요한 시나리오(예: 접지 진리 값 결정)에 유용합니다.
fields	string	검색된 벡터에 포함할 Collection(Edm.Single) 형식의 벡터 필드입니다.
k	integer	상위 적중으로 반환할 가장 가까운 이웃의 수입니다.
kind	string: text	수행 중인 벡터 쿼리의 종류입니다.
text	string	벡터 검색 쿼리를 수행하기 위해 벡터화할 텍스트입니다.

VectorQueryKind

수행 중인 벡터 쿼리의 종류입니다.

Name	형식	Description
text	string	벡터화해야 하는 텍스트 값이 제공되는 벡터 쿼리입니다.
vector	string	원시 벡터 값이 제공되는 벡터 쿼리입니다.