BaseSearchRequestOptions interface

패키지:

@azure/search-documents

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

속성

facets	검색 쿼리에 적용할 패싯 식 목록입니다. 각 패싯 식에는 필드 이름이 포함되며, 필요에 따라 이름:값 쌍의 쉼표로 구분된 목록이 옵니다.
filter	검색 쿼리에 적용할 OData $filter 식입니다.
highlightFields	적중 하이라이트에 사용할 필드 이름의 쉼표로 구분된 목록입니다. 검색 가능한 필드만 적중 항목 강조 표시에 사용할 수 있습니다.
highlightPostTag	강조 표시에 추가되는 문자열 태그입니다. highlightPreTag를 사용하여 설정해야 합니다. 기본값은 /em>입니다<.
highlightPreTag	강조 표시 앞에 추가되는 문자열 태그입니다. highlightPostTag를 사용하여 설정해야 합니다. 기본값은 em>입니다<.
includeTotalCount	결과의 총 수를 가져올지 여부를 지정하는 값입니다. 기본값은 false입니다. 이 값을 true로 설정하면 성능에 영향을 미칠 수 있습니다. 반환되는 개수는 근사값입니다.
minimumCoverage	쿼리가 성공으로 보고되려면 검색 쿼리에서 다루어야 하는 인덱스의 백분율을 나타내는 0에서 100 사이의 숫자입니다. 이 매개 변수는 복제본(replica) 하나만 있는 서비스에서도 검색 가용성을 보장하는 데 유용할 수 있습니다. 기본값은 100입니다.
orderBy	결과를 정렬할 OData $orderby 식 목록입니다. 각 식은 field name 또는 geo.distance() 또는 search.score() 함수에 대한 호출일 수 있습니다. 각 식 뒤에 asc를 추가하여 오름차순을 나타내거나 내림차순을 나타내는 desc를 사용할 수 있습니다. 기본값은 오름차순입니다. 동률은 문서의 일치 점수로 구분됩니다. $orderby 지정하지 않으면 기본 정렬 순서가 문서 일치 점수별로 내림차순입니다. 최대 32개의 $orderby 절이 있을 수 있습니다.
queryType	검색 쿼리의 구문을 지정하는 값입니다. 기본값은 'simple'입니다. 쿼리에서 Lucene 쿼리 구문을 사용하는 경우 'full'을 사용합니다. 가능한 값은 'simple', 'full', 'semantic'입니다.
scoringParameters	name-values 형식을 사용하여 점수 매기기 함수(예: referencePointParameter)에 사용할 매개 변수 값 목록입니다. 예를 들어 점수 매기기 프로필이 'mylocation'이라는 매개 변수를 사용하여 함수를 정의하는 경우 매개 변수 문자열은 따옴표 없이 "mylocation--122.2,44.8"이 됩니다.
scoringProfile	결과를 정렬하기 위해 일치하는 문서의 일치 점수를 계산하는 점수 매기기 프로필의 이름입니다.
scoringStatistics	더 일관된 채점을 위해 점수 매기기 통계(예: 문서 빈도)를 전역적으로 계산할지, 아니면 대기 시간을 낮추기 위해 로컬로 계산할지를 지정하는 값입니다. 가능한 값은 'Local', 'Global'입니다.
searchFields	전체 텍스트 검색을 scope 필드 이름의 쉼표로 구분된 목록입니다. 전체 Lucene 쿼리에서 필드 검색(fieldName:searchExpression)을 사용하는 경우 필드가 있는 각 검색 식의 필드 이름이 이 매개 변수에 나열된 필드 이름보다 우선합니다.
searchMode	문서를 일치 항목으로 계산하기 위해 검색어 중 하나 또는 전부를 일치시켜야 하는지 여부를 지정하는 값입니다. 가능한 값은 'any', 'all'입니다.
select	검색할 필드 목록입니다. 지정하지 않으면 스키마에서 검색 가능으로 표시된 모든 필드가 포함됩니다.
sessionId	더 일관된 결과를 얻는 데 도움이 될 수 있는 고정 세션을 만드는 데 사용할 값입니다. 동일한 sessionId를 사용하는 한 동일한 복제본(replica) 집합을 대상으로 하여 최선의 노력을 기울입니다. 동일한 sessionID 값을 반복적으로 다시 사용하면 복제본 간에 요청의 부하 분산을 방해하고 검색 서비스의 성능에 부정적인 영향을 줄 수 있습니다. sessionId로 사용된 값은 '_' 문자로 시작할 수 없습니다.
skip	건너뛸 검색 결과의 수입니다. 이 값은 100,000보다 클 수 없습니다. 문서를 순서대로 검사해야 하지만 이 제한으로 인해 건너뛰기를 사용할 수 없는 경우 완전히 정렬된 키에 orderby를 사용하고 범위 쿼리를 사용하여 필터링하는 것이 좋습니다.
top	검색할 검색 결과의 수입니다. $skip 함께 사용하여 검색 결과의 클라이언트 쪽 페이징을 구현할 수 있습니다. 서버 쪽 페이징으로 인해 결과가 잘리는 경우 응답에는 결과의 다음 페이지에 대한 다른 검색 요청을 발급하는 데 사용할 수 있는 연속 토큰이 포함됩니다.
vectorSearchOptions	벡터 검색 쿼리에 대한 옵션을 정의합니다.

속성 세부 정보

facets

검색 쿼리에 적용할 패싯 식 목록입니다. 각 패싯 식에는 필드 이름이 포함되며, 필요에 따라 이름:값 쌍의 쉼표로 구분된 목록이 옵니다.

facets?: string[]

속성 값

string[]

filter

검색 쿼리에 적용할 OData $filter 식입니다.

filter?: string

속성 값

string

highlightFields

적중 하이라이트에 사용할 필드 이름의 쉼표로 구분된 목록입니다. 검색 가능한 필드만 적중 항목 강조 표시에 사용할 수 있습니다.

highlightFields?: string

속성 값

string

highlightPostTag

강조 표시에 추가되는 문자열 태그입니다. highlightPreTag를 사용하여 설정해야 합니다. 기본값은 /em>입니다<.

highlightPostTag?: string

속성 값

string

highlightPreTag

강조 표시 앞에 추가되는 문자열 태그입니다. highlightPostTag를 사용하여 설정해야 합니다. 기본값은 em>입니다<.

highlightPreTag?: string

속성 값

string

includeTotalCount

결과의 총 수를 가져올지 여부를 지정하는 값입니다. 기본값은 false입니다. 이 값을 true로 설정하면 성능에 영향을 미칠 수 있습니다. 반환되는 개수는 근사값입니다.

includeTotalCount?: boolean

속성 값

boolean

minimumCoverage

쿼리가 성공으로 보고되려면 검색 쿼리에서 다루어야 하는 인덱스의 백분율을 나타내는 0에서 100 사이의 숫자입니다. 이 매개 변수는 복제본(replica) 하나만 있는 서비스에서도 검색 가용성을 보장하는 데 유용할 수 있습니다. 기본값은 100입니다.

minimumCoverage?: number

속성 값

number

orderBy

결과를 정렬할 OData $orderby 식 목록입니다. 각 식은 field name 또는 geo.distance() 또는 search.score() 함수에 대한 호출일 수 있습니다. 각 식 뒤에 asc를 추가하여 오름차순을 나타내거나 내림차순을 나타내는 desc를 사용할 수 있습니다. 기본값은 오름차순입니다. 동률은 문서의 일치 점수로 구분됩니다. $orderby 지정하지 않으면 기본 정렬 순서가 문서 일치 점수별로 내림차순입니다. 최대 32개의 $orderby 절이 있을 수 있습니다.

orderBy?: string[]

속성 값

string[]

queryType

검색 쿼리의 구문을 지정하는 값입니다. 기본값은 'simple'입니다. 쿼리에서 Lucene 쿼리 구문을 사용하는 경우 'full'을 사용합니다. 가능한 값은 'simple', 'full', 'semantic'입니다.

queryType?: QueryType

속성 값

QueryType

scoringParameters

name-values 형식을 사용하여 점수 매기기 함수(예: referencePointParameter)에 사용할 매개 변수 값 목록입니다. 예를 들어 점수 매기기 프로필이 'mylocation'이라는 매개 변수를 사용하여 함수를 정의하는 경우 매개 변수 문자열은 따옴표 없이 "mylocation--122.2,44.8"이 됩니다.

scoringParameters?: string[]

속성 값

string[]

scoringProfile

결과를 정렬하기 위해 일치하는 문서의 일치 점수를 계산하는 점수 매기기 프로필의 이름입니다.

scoringProfile?: string

속성 값

string

scoringStatistics

더 일관된 채점을 위해 점수 매기기 통계(예: 문서 빈도)를 전역적으로 계산할지, 아니면 대기 시간을 낮추기 위해 로컬로 계산할지를 지정하는 값입니다. 가능한 값은 'Local', 'Global'입니다.

scoringStatistics?: ScoringStatistics

속성 값

ScoringStatistics

searchFields

전체 텍스트 검색을 scope 필드 이름의 쉼표로 구분된 목록입니다. 전체 Lucene 쿼리에서 필드 검색(fieldName:searchExpression)을 사용하는 경우 필드가 있는 각 검색 식의 필드 이름이 이 매개 변수에 나열된 필드 이름보다 우선합니다.

searchFields?: SearchFieldArray<TModel>

속성 값

SearchFieldArray<TModel>

searchMode

문서를 일치 항목으로 계산하기 위해 검색어 중 하나 또는 전부를 일치시켜야 하는지 여부를 지정하는 값입니다. 가능한 값은 'any', 'all'입니다.

searchMode?: SearchMode

속성 값

SearchMode

select

검색할 필드 목록입니다. 지정하지 않으면 스키마에서 검색 가능으로 표시된 모든 필드가 포함됩니다.

select?: SelectArray<TFields>

속성 값

SelectArray<TFields>

sessionId

더 일관된 결과를 얻는 데 도움이 될 수 있는 고정 세션을 만드는 데 사용할 값입니다. 동일한 sessionId를 사용하는 한 동일한 복제본(replica) 집합을 대상으로 하여 최선의 노력을 기울입니다. 동일한 sessionID 값을 반복적으로 다시 사용하면 복제본 간에 요청의 부하 분산을 방해하고 검색 서비스의 성능에 부정적인 영향을 줄 수 있습니다. sessionId로 사용된 값은 '_' 문자로 시작할 수 없습니다.

sessionId?: string

속성 값

string

skip

건너뛸 검색 결과의 수입니다. 이 값은 100,000보다 클 수 없습니다. 문서를 순서대로 검사해야 하지만 이 제한으로 인해 건너뛰기를 사용할 수 없는 경우 완전히 정렬된 키에 orderby를 사용하고 범위 쿼리를 사용하여 필터링하는 것이 좋습니다.

skip?: number

속성 값

number

top

검색할 검색 결과의 수입니다. $skip 함께 사용하여 검색 결과의 클라이언트 쪽 페이징을 구현할 수 있습니다. 서버 쪽 페이징으로 인해 결과가 잘리는 경우 응답에는 결과의 다음 페이지에 대한 다른 검색 요청을 발급하는 데 사용할 수 있는 연속 토큰이 포함됩니다.

top?: number

속성 값

number

vectorSearchOptions

벡터 검색 쿼리에 대한 옵션을 정의합니다.

vectorSearchOptions?: VectorSearchOptions<TModel>

속성 값

VectorSearchOptions<TModel>