BaseSearchRequestOptions interface

Пакет:

@azure/search-documents

Параметры фильтрации, сортировки, фасетирования, разбиения по страницам и других поведении поисковых запросов.

Свойства

facets	Список выражений аспектов, применяемых к поисковому запросу. Каждое выражение аспектов содержит имя поля, за которым следует список пар name:value, разделенный запятыми.
filter	Выражение OData $filter, применяемое к поисковому запросу.
highlightFields	Список имен полей, разделенных запятыми, используемых для выделения попаданий. Для выделения попаданий можно использовать только поля, доступные для поиска.
highlightPostTag	Тег строки, добавляемый для выделения попаданий. Необходимо задать с выделенным значениемPreTag. Значение по умолчанию — </em>.
highlightPreTag	Тег строки, который предопределен для выделения попаданий. Необходимо задать с помощью highlightPostTag. По умолчанию используется <em>.
includeTotalCount	Значение, указывающее, следует ли получить общее количество результатов. Значение по умолчанию — false. Если задать значение true, это значение может повлиять на производительность. Обратите внимание, что возвращаемое число является приблизительный.
minimumCoverage	Число от 0 до 100, указывающее процент индекса, который должен охватываться поисковым запросом, чтобы запрос сообщалось успешно. Этот параметр может быть полезен для обеспечения доступности поиска даже для служб с одной репликой. Значение по умолчанию — 100.
orderBy	Список выражений OData $orderby, по которым выполняется сортировка результатов. Каждое выражение может быть именем поля или вызовом функций geo.distance() или search.score(). За каждым выражением можно следовать какc, чтобы указать возрастание, или desc, чтобы указать убывание. Значение по умолчанию — по возрастанию. Связи будут нарушены с помощью показателей соответствия документов. Если $orderby не указано, порядок сортировки по умолчанию убывает по оценке соответствия документа. Существует не более 32 предложений $orderby.
queryType	Значение, указывающее синтаксис поискового запроса. Значение по умолчанию — simple. Используйте значение full, если запрос использует синтаксис запроса Lucene. Возможные значения: "simple", "full", "semantic"
scoringParameters	Список значений параметров, используемых в функциях оценки (например, referencePointParameter) с использованием значений имени формата. Например, если профиль оценки определяет функцию с параметром с именем mylocation, строка параметра будет "mylocation--122.2,44.8" (без кавычки).
scoringProfile	Имя профиля оценки для оценки показателей для сопоставления документов для сортировки результатов.
scoringStatistics	Значение, указывающее, требуется ли вычислить статистику оценки (например, частоту документов) глобально для более согласованной оценки или локальной задержки. Возможные значения: Local, Global
searchFields	Список имен полей, разделенных запятыми, в которых выполняется полнотекстовый поиск. При использовании поля поиска (fieldName:searchExpression) в полном запросе Lucene имена полей каждого поля выражения поиска имеют приоритет над именами полей, перечисленными в этом параметре.
searchMode	Значение, указывающее, должны ли совпадать все или все условия поиска, чтобы подсчитать документ как совпадение. Возможные значения: "any", "all"
select	Список полей для извлечения. Если не указано, все поля, помеченные как извлекаемые в схеме, включаются.
sessionId	Значение, используемое для создания липкого сеанса, которое может помочь получить более согласованные результаты. До тех пор, пока используется тот же идентификатор сеанса, будет предпринята попытка попытаться выбрать тот же набор реплик. Будьте осторожны, что повторное использование одних и того же значения sessionID многократно может повлиять на балансировку нагрузки запросов между репликами и негативно повлиять на производительность службы поиска. Значение, используемое в качестве sessionId, не может начинаться с символа "_".
skip	Количество пропущенных результатов поиска. Это значение не может быть больше 100 000. Если вам нужно сканировать документы в последовательности, но не удается пропустить из-за этого ограничения, рекомендуется использовать orderby на полностью упорядоченном ключе и фильтровать с помощью запроса диапазона.
top	Количество полученных результатов поиска. Это можно использовать в сочетании с $skip для реализации разбиения по страницам на стороне клиента результатов поиска. Если результаты усечены из-за разбиения на страницы на стороне сервера, ответ будет содержать маркер продолжения, который можно использовать для выдачи другого запроса поиска на следующую страницу результатов.
vectorSearchOptions	Определяет параметры запросов поиска векторов

Сведения о свойстве

facets

Список выражений аспектов, применяемых к поисковому запросу. Каждое выражение аспектов содержит имя поля, за которым следует список пар name:value, разделенный запятыми.

facets?: string[]

Значение свойства

string[]

filter

Выражение OData $filter, применяемое к поисковому запросу.

filter?: string

Значение свойства

string

highlightFields

Список имен полей, разделенных запятыми, используемых для выделения попаданий. Для выделения попаданий можно использовать только поля, доступные для поиска.

highlightFields?: string

Значение свойства

string

highlightPostTag

Тег строки, добавляемый для выделения попаданий. Необходимо задать с выделенным значениемPreTag. Значение по умолчанию — </em>.

highlightPostTag?: string

Значение свойства

string

highlightPreTag

Тег строки, который предопределен для выделения попаданий. Необходимо задать с помощью highlightPostTag. По умолчанию используется <em>.

highlightPreTag?: string

Значение свойства

string

includeTotalCount

Значение, указывающее, следует ли получить общее количество результатов. Значение по умолчанию — false. Если задать значение true, это значение может повлиять на производительность. Обратите внимание, что возвращаемое число является приблизительный.

includeTotalCount?: boolean

Значение свойства

boolean

minimumCoverage

Число от 0 до 100, указывающее процент индекса, который должен охватываться поисковым запросом, чтобы запрос сообщалось успешно. Этот параметр может быть полезен для обеспечения доступности поиска даже для служб с одной репликой. Значение по умолчанию — 100.

minimumCoverage?: number

Значение свойства

number

orderBy

Список выражений OData $orderby, по которым выполняется сортировка результатов. Каждое выражение может быть именем поля или вызовом функций geo.distance() или search.score(). За каждым выражением можно следовать какc, чтобы указать возрастание, или desc, чтобы указать убывание. Значение по умолчанию — по возрастанию. Связи будут нарушены с помощью показателей соответствия документов. Если $orderby не указано, порядок сортировки по умолчанию убывает по оценке соответствия документа. Существует не более 32 предложений $orderby.

orderBy?: string[]

Значение свойства

string[]

queryType

Значение, указывающее синтаксис поискового запроса. Значение по умолчанию — simple. Используйте значение full, если запрос использует синтаксис запроса Lucene. Возможные значения: "simple", "full", "semantic"

queryType?: QueryType

Значение свойства

QueryType

scoringParameters

Список значений параметров, используемых в функциях оценки (например, referencePointParameter) с использованием значений имени формата. Например, если профиль оценки определяет функцию с параметром с именем mylocation, строка параметра будет "mylocation--122.2,44.8" (без кавычки).

scoringParameters?: string[]

Значение свойства

string[]

scoringProfile

Имя профиля оценки для оценки показателей для сопоставления документов для сортировки результатов.

scoringProfile?: string

Значение свойства

string

scoringStatistics

Значение, указывающее, требуется ли вычислить статистику оценки (например, частоту документов) глобально для более согласованной оценки или локальной задержки. Возможные значения: Local, Global

scoringStatistics?: ScoringStatistics

Значение свойства

ScoringStatistics

searchFields

Список имен полей, разделенных запятыми, в которых выполняется полнотекстовый поиск. При использовании поля поиска (fieldName:searchExpression) в полном запросе Lucene имена полей каждого поля выражения поиска имеют приоритет над именами полей, перечисленными в этом параметре.

searchFields?: SearchFieldArray<TModel>

Значение свойства

SearchFieldArray<TModel>

searchMode

Значение, указывающее, должны ли совпадать все или все условия поиска, чтобы подсчитать документ как совпадение. Возможные значения: "any", "all"

searchMode?: SearchMode

Значение свойства

SearchMode

select

Список полей для извлечения. Если не указано, все поля, помеченные как извлекаемые в схеме, включаются.

select?: SelectArray<TFields>

Значение свойства

SelectArray<TFields>

sessionId

Значение, используемое для создания липкого сеанса, которое может помочь получить более согласованные результаты. До тех пор, пока используется тот же идентификатор сеанса, будет предпринята попытка попытаться выбрать тот же набор реплик. Будьте осторожны, что повторное использование одних и того же значения sessionID многократно может повлиять на балансировку нагрузки запросов между репликами и негативно повлиять на производительность службы поиска. Значение, используемое в качестве sessionId, не может начинаться с символа "_".

sessionId?: string

Значение свойства

string

skip

Количество пропущенных результатов поиска. Это значение не может быть больше 100 000. Если вам нужно сканировать документы в последовательности, но не удается пропустить из-за этого ограничения, рекомендуется использовать orderby на полностью упорядоченном ключе и фильтровать с помощью запроса диапазона.

skip?: number

Значение свойства

number

top

Количество полученных результатов поиска. Это можно использовать в сочетании с $skip для реализации разбиения по страницам на стороне клиента результатов поиска. Если результаты усечены из-за разбиения на страницы на стороне сервера, ответ будет содержать маркер продолжения, который можно использовать для выдачи другого запроса поиска на следующую страницу результатов.

top?: number

Значение свойства

number

vectorSearchOptions

Определяет параметры запросов поиска векторов

vectorSearchOptions?: VectorSearchOptions<TModel>

Значение свойства

VectorSearchOptions<TModel>