SuggestRequest interface

Пакет:

@azure/search-documents

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

Свойства

filter	Выражение OData, которое фильтрует документы, которые рассматриваются для предложений.
highlightPostTag	Тег строки, добавляемый для выделения попаданий. Необходимо задать с выделенным значениемPreTag. Если опущено, выделение предложений отключено.
highlightPreTag	Тег строки, который предопределен для выделения попаданий. Необходимо задать с помощью highlightPostTag. Если опущено, выделение предложений отключено.
minimumCoverage	Число от 0 до 100, указывающее процент индекса, который должен охватываться запросом предложения, чтобы запрос сообщалось как успешный. Этот параметр может быть полезен для обеспечения доступности поиска даже для служб с одной репликой. Значение по умолчанию — 80.
orderBy	Список выражений OData $orderby, по которым выполняется сортировка результатов. Каждое выражение может быть именем поля или вызовом функций geo.distance() или search.score(). За каждым выражением можно следовать какc, чтобы указать возрастание, или desc, чтобы указать убывание. Значение по умолчанию — по возрастанию. Связи будут нарушены с помощью показателей соответствия документов. Если $orderby не указано, порядок сортировки по умолчанию убывает по оценке соответствия документа. Существует не более 32 предложений $orderby.
searchFields	Разделенный запятыми список имен полей для поиска указанного текста поиска. Целевые поля должны быть включены в указанный средство предложения.
select	Список полей для извлечения. Если не указано, в результаты будут включены только ключевое поле.
top	/** Количество предложений для получения. Это должно быть значение от 1 до 100. Значение по умолчанию —
useFuzzyMatching	Значение, указывающее, следует ли использовать нечеткое сопоставление для запроса предложения. Значение по умолчанию — false. Если задано значение true, запрос найдет предложения, даже если в тексте поиска есть замещающий или отсутствующий символ. Хотя это обеспечивает более широкий опыт в некоторых сценариях, он приходится на производительность, так как поиск нечетких предложений медленнее и потребляет больше ресурсов.

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

filter

Выражение OData, которое фильтрует документы, которые рассматриваются для предложений.

filter?: string

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

string

highlightPostTag

Тег строки, добавляемый для выделения попаданий. Необходимо задать с выделенным значениемPreTag. Если опущено, выделение предложений отключено.

highlightPostTag?: string

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

string

highlightPreTag

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

highlightPreTag?: string

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

string

minimumCoverage

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

minimumCoverage?: number

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

number

orderBy

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

orderBy?: string[]

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

string[]

searchFields

Разделенный запятыми список имен полей для поиска указанного текста поиска. Целевые поля должны быть включены в указанный средство предложения.

searchFields?: SearchFieldArray<TModel>

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

SearchFieldArray<TModel>

select

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

select?: SelectArray<TFields>

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

SelectArray<TFields>

top

/**

• Количество предложений для получения. Это должно быть значение от 1 до 100. Значение по умолчанию —

top?: number

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

number

useFuzzyMatching

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

useFuzzyMatching?: boolean

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

boolean