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

SuggestOptions Класс

  • Ссылка

Группа параметров.

Наследование
azure.search.documents._generated._serialization.Model
SuggestOptions

Конструктор

SuggestOptions(*, filter: str | None = None, use_fuzzy_matching: bool | None = None, highlight_post_tag: str | None = None, highlight_pre_tag: str | None = None, minimum_coverage: float | None = None, order_by: List[str] | None = None, search_fields: List[str] | None = None, select: List[str] | None = None, top: int | None = None, **kwargs: Any)

Параметры Keyword-Only

Имя Описание
filter
str

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

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

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

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

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

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

Список имен полей для поиска указанного текста поиска. Целевые поля должны быть включены в указанный средство подбора.
select
list[str]

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

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

Переменные

Имя Описание
filter
str

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

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

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

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

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

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

Список имен полей для поиска указанного текста поиска. Целевые поля должны быть включены в указанный средство подбора.
select
list[str]

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

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

Методы

as_dict

Возвращает дикт, который можно сериализовать с помощью json.dump.

Дополнительное использование может использовать обратный вызов в качестве параметра:

Ключ — это имя атрибута, используемого в Python. Attr_desc — это диктовка метаданных. В настоящее время содержит "тип" с типом msrest и "key" с ключом в кодировке RestAPI. Значение — это текущее значение в этом объекте.

Возвращаемая строка будет использоваться для сериализации ключа. Если тип возвращаемого значения является списком, это считается иерархическим результирующим диктом.

См. три примера в этом файле:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Если требуется xml-сериализация, можно передать kwargs is_xml=True.
deserialize

Синтаксический анализ str с помощью синтаксиса RestAPI и возврат модели.
enable_additional_properties_sending
from_dict

Синтаксический анализ дикта с помощью заданного средства извлечения ключа возвращает модель.

По умолчанию рекомендуется использовать средства извлечения ключей (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor и last_rest_key_case_insensitive_extractor).
is_xml_model
serialize

Возвращает json, который будет отправлен на сервер из этой модели.

Это псевдоним для as_dict(full_restapi_key_transformer, keep_readonly=False).

Если требуется xml-сериализация, можно передать kwargs is_xml=True.

as_dict

Возвращает дикт, который можно сериализовать с помощью json.dump.

Дополнительное использование может использовать обратный вызов в качестве параметра:

Ключ — это имя атрибута, используемого в Python. Attr_desc — это диктовка метаданных. В настоящее время содержит "тип" с типом msrest и "key" с ключом в кодировке RestAPI. Значение — это текущее значение в этом объекте.

Возвращаемая строка будет использоваться для сериализации ключа. Если тип возвращаемого значения является списком, это считается иерархическим результирующим диктом.

См. три примера в этом файле:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Если требуется xml-сериализация, можно передать kwargs is_xml=True.

as_dict(keep_readonly: bool = True, key_transformer: ~typing.Callable[[str, ~typing.Dict[str, ~typing.Any], ~typing.Any], ~typing.Any] = <function attribute_transformer>, **kwargs: ~typing.Any) -> MutableMapping[str, Any]

Параметры

Имя Описание
key_transformer
<xref:function>

Функция преобразователя ключей.
keep_readonly
значение по умолчанию: True

Возвращаемое значение

Тип Описание
dict

Объект, совместимый с JSON для дикта

deserialize

Синтаксический анализ str с помощью синтаксиса RestAPI и возврат модели.

deserialize(data: Any, content_type: str | None = None) -> ModelType

Параметры

Имя Описание
data
Обязательно
str

Строка, использующий структуру RestAPI. JSON по умолчанию.
content_type
str

JSON по умолчанию задайте значение application/xml if XML.

значение по умолчанию: None

Возвращаемое значение

Тип Описание

Экземпляр этой модели

Исключения

Тип Описание
DeserializationError if something went wrong

enable_additional_properties_sending 

enable_additional_properties_sending() -> None

from_dict

Синтаксический анализ дикта с помощью заданного средства извлечения ключа возвращает модель.

По умолчанию рекомендуется использовать средства извлечения ключей (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor и last_rest_key_case_insensitive_extractor).

from_dict(data: Any, key_extractors: Callable[[str, Dict[str, Any], Any], Any] | None = None, content_type: str | None = None) -> ModelType

Параметры

Имя Описание
data
Обязательно
dict

Словарь, использующий структуру RestAPI
content_type
str

JSON по умолчанию задайте значение application/xml if XML.

значение по умолчанию: None
key_extractors
значение по умолчанию: None

Возвращаемое значение

Тип Описание

Экземпляр этой модели

Исключения

Тип Описание
DeserializationError if something went wrong

is_xml_model 

is_xml_model() -> bool

serialize

Возвращает json, который будет отправлен на сервер из этой модели.

Это псевдоним для as_dict(full_restapi_key_transformer, keep_readonly=False).

Если требуется xml-сериализация, можно передать kwargs is_xml=True.

serialize(keep_readonly: bool = False, **kwargs: Any) -> MutableMapping[str, Any]

Параметры

Имя Описание
keep_readonly
bool

Если вы хотите сериализовать атрибуты только для чтения

значение по умолчанию: False

Возвращаемое значение

Тип Описание
dict

Объект, совместимый с JSON для дикта