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