Documents - Search Get

참조

서비스:: Search Service

API 버전:: 2024-07-01

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

GET {endpoint}/indexes('{indexName}')/docs?api-version=2024-07-01

선택적 매개 변수:

GET {endpoint}/indexes('{indexName}')/docs?search={search}&$count={$count}&facet={facet}&$filter={$filter}&highlight={highlight}&highlightPostTag={highlightPostTag}&highlightPreTag={highlightPreTag}&minimumCoverage={minimumCoverage}&$orderby={$orderby}&queryType={queryType}&scoringParameter={scoringParameter}&scoringProfile={scoringProfile}&searchFields={searchFields}&searchMode={searchMode}&scoringStatistics={scoringStatistics}&sessionId={sessionId}&$select={$select}&$skip={$skip}&$top={$top}&api-version=2024-07-01&semanticConfiguration={semanticConfiguration}&semanticErrorHandling={semanticErrorHandling}&semanticMaxWaitInMilliseconds={semanticMaxWaitInMilliseconds}&answers={answers}&captions={captions}&semanticQuery={semanticQuery}

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
endpoint	path	True	string	검색 서비스의 엔드포인트 URL입니다.
indexName	path	True	string	인덱스의 이름입니다.
api-version	query	True	string	클라이언트 API 버전입니다.
$count	query		boolean	총 결과 수를 가져올지 여부를 지정하는 값입니다. 기본값은 false입니다. 이 값을 true로 설정하면 성능에 영향을 미칠 수 있습니다. 반환된 개수는 근사치입니다.
$filter	query		string	검색 쿼리에 적용할 OData $filter 식입니다.
$orderby	query		string[]	결과를 정렬할 OData $orderby 식의 목록입니다. 각 식은 field 이름 또는 geo.distance() 또는 search.score() 함수에 대한 호출일 수 있습니다. 각 식 뒤에 asc를 추가하여 오름차순을 나타내고 내림차순을 나타내도록 desc할 수 있습니다. 기본값은 오름차순입니다. 동점은 문서의 일치 점수에 의해 깨질 것입니다. OrderBy를 지정하지 않으면 기본 정렬 순서가 문서 일치 점수로 내림차순입니다. 최대 32개의 $orderby 절이 있을 수 있습니다.
$select	query		string[]	검색할 필드 목록입니다. 지정되지 않은 경우 스키마에서 검색 가능한 것으로 표시된 모든 필드가 포함됩니다.
$skip	query		integer int32	건너뛸 검색 결과 수입니다. 이 값은 100,000을 초과할 수 없습니다. 문서를 순서대로 검색해야 하지만 이 제한으로 인해 $skip 사용할 수 없는 경우 완전히 정렬된 키에 $orderby 사용하고 범위 쿼리를 사용하여 $filter 것이 좋습니다.
$top	query		integer int32	검색할 검색 결과 수입니다. $skip 함께 사용하여 검색 결과의 클라이언트 쪽 페이징을 구현할 수 있습니다. 서버 쪽 페이징으로 인해 결과가 잘리는 경우 응답에는 결과의 다음 페이지에 대한 다른 검색 요청을 발급하는 데 사용할 수 있는 연속 토큰이 포함됩니다.
answers	query		QueryAnswerType	이 매개 변수는 쿼리 형식이 `semantic`경우에만 유효합니다. 설정된 경우 쿼리는 가장 높은 순위의 문서의 주요 구절에서 추출된 답변을 반환합니다. 반환되는 답변 수는 파이프 문자 `\|` 추가한 다음 `extractive\|count-3`같은 답변 매개 변수 값 뒤에 `count-<number of answers>` 옵션을 추가하여 구성할 수 있습니다. 기본 개수는 1입니다. 신뢰도 임계값은 파이프 문자 `\|` 추가한 다음 응답 매개 변수 값 뒤에 `threshold-<confidence threshold>` 옵션(예: `extractive\|threshold-0.9`)을 추가하여 구성할 수 있습니다. 기본 임계값은 0.7입니다.
captions	query		QueryCaptionType	이 매개 변수는 쿼리 형식이 `semantic`경우에만 유효합니다. 설정된 경우 쿼리는 가장 높은 순위의 문서의 주요 구절에서 추출된 캡션을 반환합니다. 캡션이 `extractive`설정되면 강조 표시가 기본적으로 사용하도록 설정되며 파이프 문자 `\|` 추가한 다음 `extractive\|highlight-true`같은 `highlight-<true/false>` 옵션을 추가하여 구성할 수 있습니다. 기본값은 `None`.
facet	query		string[]	검색 쿼리에 적용할 패싯 식 목록입니다. 각 패싯 식에는 필드 이름이 포함되며, 필요에 따라 이름:값 쌍의 쉼표로 구분된 목록이 뒤따릅니다.
highlight	query		string[]	적중 항목 강조 표시에 사용할 필드 이름 목록입니다. 검색 가능한 필드만 적중 항목 강조 표시에 사용할 수 있습니다.
highlightPostTag	query		string	적중 강조 표시에 추가되는 문자열 태그입니다. highlightPreTag를 사용하여 설정해야 합니다. 기본값은 </em>.
highlightPreTag	query		string	강조 표시를 적중하기 위해 앞에 추가되는 문자열 태그입니다. highlightPostTag를 사용하여 설정해야 합니다. 기본값은 <>.
minimumCoverage	query		number double	쿼리가 성공으로 보고되려면 검색 쿼리에서 처리해야 하는 인덱스의 백분율을 나타내는 0에서 100 사이의 숫자입니다. 이 매개 변수는 복제본이 하나뿐인 서비스에 대해서도 검색 가용성을 보장하는 데 유용할 수 있습니다. 기본값은 100입니다.
queryType	query		QueryType	검색 쿼리의 구문을 지정하는 값입니다. 기본값은 'simple'입니다. 쿼리에서 Lucene 쿼리 구문을 사용하는 경우 'full'을 사용합니다.
scoringParameter	query		string[]	형식 이름 값을 사용하여 점수 매기기 함수(예: referencePointParameter)에 사용할 매개 변수 값 목록입니다. 예를 들어 점수 매기기 프로필이 'mylocation'이라는 매개 변수를 사용하여 함수를 정의하는 경우 매개 변수 문자열은 따옴표 없이 "mylocation--122.2,44.8"입니다.
scoringProfile	query		string	결과를 정렬하기 위해 일치하는 문서의 일치 점수를 평가할 점수 매기기 프로필의 이름입니다.
scoringStatistics	query		ScoringStatistics	더 일관된 채점을 위해 전역적으로 점수 매기기 통계(예: 문서 빈도)를 계산할지, 아니면 대기 시간을 낮추기 위해 로컬로 계산할지를 지정하는 값입니다.
search	query		string	전체 텍스트 검색 쿼리 식입니다. 모든 문서와 일치하려면 "*"를 사용하거나 이 매개 변수를 생략합니다.
searchFields	query		string[]	전체 텍스트 검색의 범위를 지정할 필드 이름 목록입니다. 전체 Lucene 쿼리에서 필드 검색(fieldName:searchExpression)을 사용하는 경우 각 필드 검색 식의 필드 이름이 이 매개 변수에 나열된 필드 이름보다 우선합니다.
searchMode	query		SearchMode	문서를 일치 항목으로 계산하기 위해 검색어 중 하나 또는 전부를 일치해야 하는지 여부를 지정하는 값입니다.
semanticConfiguration	query		string	의미 체계 순위, 캡션, 강조 표시 및 답변에 사용해야 하는 필드를 나열하는 의미 체계 구성의 이름입니다.
semanticErrorHandling	query		SemanticErrorMode	사용자가 의미 체계 호출이 완전히 실패할지 또는 부분 결과(기본값)를 반환할지를 선택할 수 있습니다.
semanticMaxWaitInMilliseconds	query		integer int32	요청이 실패하기 전에 의미 체계 보강이 처리를 완료하는 데 걸리는 시간에 상한을 설정할 수 있습니다.
semanticQuery	query		string	의미 체계 재전송, 의미 체계 캡션 및 의미 체계 답변에만 사용되는 별도의 검색 쿼리를 설정할 수 있습니다. 기본 검색 및 순위 단계와 L2 의미 체계 단계 간에 서로 다른 쿼리를 사용해야 하는 시나리오에 유용합니다.
sessionId	query		string	더 일관된 결과를 얻는 데 도움이 될 수 있는 고정 세션을 만드는 데 사용할 값입니다. 동일한 sessionId를 사용하는 한 동일한 복제본 집합을 대상으로 지정하기 위해 최선의 노력을 기울입니다. 동일한 sessionID 값을 반복적으로 다시 사용하면 복제본 간에 요청의 부하 분산을 방해하고 검색 서비스의 성능에 부정적인 영향을 줄 수 있습니다. sessionId로 사용되는 값은 '_' 문자로 시작할 수 없습니다.

요청 헤더

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

응답

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

예제

SearchIndexSearchDocumentsGet

SearchIndexSearchDocumentsSemanticGet

SearchIndexSearchDocumentsGet

샘플 요청

HTTP

GET https://myservice.search.windows.net/indexes('myindex')/docs?search=nice hotels&$count=True&facet=category,count:10,sort:count&$filter=rating gt 10&highlight=title&highlightPostTag=</em>&highlightPreTag=<em>&minimumCoverage=80&$orderby=search.score() desc,rating desc&queryType=simple&scoringProfile=sp&searchFields=title,description&searchMode=any&scoringStatistics=global&sessionId=mysessionid&$select=docId,title,description&$skip=100&$top=10&api-version=2024-07-01

샘플 응답

상태 코드:: 200

{
  "@odata.count": 25,
  "@search.coverage": 80,
  "@search.facets": {
    "category": [
      {
        "count": 1,
        "value": "Economy"
      },
      {
        "count": 1,
        "value": "Luxury"
      }
    ]
  },
  "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"
    }
  ]
}

SearchIndexSearchDocumentsSemanticGet

샘플 요청

HTTP

GET https://myservice.search.windows.net/indexes('myindex')/docs?search=how do clouds form&$count=True&highlightPostTag=</em>&highlightPreTag=<em>&queryType=semantic&api-version=2024-07-01&semanticConfiguration=my-semantic-config&semanticErrorHandling=partial&semanticMaxWaitInMilliseconds=780&answers=extractive|count-3&captions=extractive|highlight-true&semanticQuery={semanticQuery}

샘플 응답

상태 코드:: 200

{
  "@odata.count": 25,
  "@search.answers": [
    {
      "key": "4123",
      "text": "Sunlight heats the land all day, warming that moist air and causing it to rise high into the   atmosphere until it cools and condenses into water droplets. Clouds generally form where air is ascending (over land in this case),   but not where it is descending (over the river).",
      "highlights": "Sunlight heats the land all day, warming that moist air and causing it to rise high into the   atmosphere until it cools and condenses into water droplets. Clouds generally form<em> where air is ascending</em> (over land in this case),   but not where it is<em> descending</em> (over the river).",
      "score": 0.94639826
    }
  ],
  "value": [
    {
      "@search.score": 0.5479723,
      "@search.rerankerScore": 1.0321671911515296,
      "@search.captions": [
        {
          "text": "Like all clouds, it forms when the air reaches its dew point—the temperature at which an air mass is cool enough for its water vapor to condense into liquid droplets. This false-color image shows valley fog, which is common in the Pacific Northwest of North America.",
          "highlights": "Like all<em> clouds</em>, it<em> forms</em> when the air reaches its dew point—the temperature at    which an air mass is cool enough for its water vapor to condense into liquid droplets. This false-color image shows valley<em> fog</em>, which is common in the Pacific Northwest of North America."
        }
      ],
      "id": "4123",
      "title": "Earth Atmosphere",
      "content": "Fog is essentially a cloud lying on the ground. Like all clouds, it forms when the air reaches its dew point—the temperature at  \n\nwhich an air mass is cool enough for its water vapor to condense into liquid droplets.\n\nThis false-color image shows valley fog, which is common in the Pacific Northwest of North America. On clear winter nights, the \n\nground and overlying air cool off rapidly, especially at high elevations. Cold air is denser than warm air, and it sinks down into the \n\nvalleys. The moist air in the valleys gets chilled to its dew point, and fog forms. If undisturbed by winds, such fog may persist for \n\ndays. The Terra satellite captured this image of foggy valleys northeast of Vancouver in February 2010.\n\n\n",
      "locations": [
        "Pacific Northwest",
        "North America",
        "Vancouver"
      ]
    }
  ]
}

정의

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

AnswerResult

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

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

CaptionResult

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

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

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	오류 개체입니다.

QueryAnswerType

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

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

QueryCaptionType

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

Name	형식	Description
extractive	string	검색 쿼리와 관련된 구절이 포함된 일치하는 문서에서 캡션을 추출합니다.
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	검색된 벡터에 포함할 컬렉션(Edm.Single) 형식의 벡터 필드입니다.
k	integer	상위 적중 횟수로 반환할 가장 가까운 이웃의 수입니다.
kind	string: vector	수행 중인 벡터 쿼리의 종류입니다.
oversampling	number	오버샘플링 요소입니다. 최소값은 1입니다. 인덱스 정의에 구성된 'defaultOversampling' 매개 변수를 재정의합니다. 'rerankWithOriginalVectors'가 true인 경우에만 설정할 수 있습니다. 이 매개 변수는 압축 메서드가 기본 벡터 필드에 사용되는 경우에만 허용됩니다.
vector	number[]	검색 쿼리의 벡터 표현입니다.
weight	number	다른 벡터 쿼리 및/또는 동일한 검색 요청 내의 텍스트 쿼리와 비교할 때 벡터 쿼리의 상대적 가중치입니다. 이 값은 여러 벡터 쿼리 및/또는 텍스트 쿼리를 통해 검색된 결과에 의해 생성된 여러 순위 목록의 결과를 결합할 때 사용됩니다. 가중치가 높을수록 해당 쿼리와 일치하는 문서가 최종 순위에 있습니다. 기본값은 1.0이며 값은 0보다 큰 양수여야 합니다.

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[]	쿼리에서 반환된 결과의 시퀀스입니다.

SearchMode

문서를 일치 항목으로 계산하기 위해 검색어 중 하나 또는 전부를 일치시켜야 하는지 여부를 지정합니다.

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

SearchRequest

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

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

SearchResult

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

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

SemanticErrorMode

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

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

SemanticErrorReason

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

Name	형식	Description
capacityOverloaded	string	요청이 제한되었습니다. 기본 결과만 반환되었습니다.
maxWaitExceeded	string	`semanticMaxWaitInMilliseconds` 설정되었고 의미 체계 처리 기간이 해당 값을 초과한 경우 기본 결과만 반환되었습니다.
transient	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	검색된 벡터에 포함할 컬렉션(Edm.Single) 형식의 벡터 필드입니다.
k	integer	상위 적중 횟수로 반환할 가장 가까운 이웃의 수입니다.
kind	string: text	수행 중인 벡터 쿼리의 종류입니다.
oversampling	number	오버샘플링 요소입니다. 최소값은 1입니다. 인덱스 정의에 구성된 'defaultOversampling' 매개 변수를 재정의합니다. 'rerankWithOriginalVectors'가 true인 경우에만 설정할 수 있습니다. 이 매개 변수는 압축 메서드가 기본 벡터 필드에 사용되는 경우에만 허용됩니다.
text	string	벡터 검색 쿼리를 수행하기 위해 벡터화할 텍스트입니다.
weight	number	다른 벡터 쿼리 및/또는 동일한 검색 요청 내의 텍스트 쿼리와 비교할 때 벡터 쿼리의 상대적 가중치입니다. 이 값은 여러 벡터 쿼리 및/또는 텍스트 쿼리를 통해 검색된 결과에 의해 생성된 여러 순위 목록의 결과를 결합할 때 사용됩니다. 가중치가 높을수록 해당 쿼리와 일치하는 문서가 최종 순위에 있습니다. 기본값은 1.0이며 값은 0보다 큰 양수여야 합니다.

VectorQueryKind

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

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

다음을 통해 공유

Documents - Search Get

URI 매개 변수

요청 헤더

응답

예제

SearchIndexSearchDocumentsGet

샘플 요청

샘플 응답

SearchIndexSearchDocumentsSemanticGet

샘플 요청

샘플 응답

정의

AnswerResult

CaptionResult

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

QueryAnswerType

QueryCaptionType

QueryType

RawVectorQuery

ScoringStatistics

SearchDocumentsResult

SearchMode

SearchRequest

SearchResult

SemanticErrorMode

SemanticErrorReason

SemanticSearchResultsType

VectorFilterMode

VectorizableTextQuery

VectorQueryKind

추가 리소스