BaseSearchRequestOptions interface

Пакет:

@azure/search-documents

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

Свойства

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

minimumCoverage?: number

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

number

orderBy

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

orderBy?: string[]

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

string[]

queryType

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

queryType?: QueryType

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

QueryType

scoringParameters

Список значений параметров, используемых в функциях оценки (например, referencePointParameter), используя формат name-values. Например, если профиль оценки определяет функцию с параметром 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, не может начинаться с символа "_".

sessionId?: string

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

string

skip

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

skip?: number

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

number

top

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

top?: number

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

number

vectorSearchOptions

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

vectorSearchOptions?: VectorSearchOptions<TModel>

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

VectorSearchOptions<TModel>