Поделиться через


SuggestRequest interface

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

Свойства

filter

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

highlightPostTag

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

highlightPreTag

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

minimumCoverage

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

orderBy

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

searchFields

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

select

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

top

/**

  • Число предложений, которое необходимо получить. Это должно быть значение от 1 до 100. Значение по умолчанию — .
useFuzzyMatching

Значение типа , указывающее, следует ли использовать нечеткое сопоставление для запроса предложения. Значение по умолчанию — 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, по которым сортируются результаты. Каждое выражение может быть именем поля или вызовом функций geo.distance() или search.score(). За каждым выражением может следовать asc для указания по возрастанию, или desc для указания по убыванию. По умолчанию результаты сортируются по возрастанию. При равенстве позиций порядок определяется по показателю совпадения документа. Если $orderby не указан, порядок сортировки по умолчанию убывания по оценке соответствия документа. Может быть не более 32 предложений $orderby.

orderBy?: string[]

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

string[]

searchFields

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

searchFields?: SearchFieldArray<TModel>

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

select

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

select?: SelectArray<TFields>

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

SelectArray<TFields>

top

/**

  • Число предложений, которое необходимо получить. Это должно быть значение от 1 до 100. Значение по умолчанию — .
top?: number

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

number

useFuzzyMatching

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

useFuzzyMatching?: boolean

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

boolean