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

CustomEntity Класс

  • Ссылка

Объект , содержащий сведения о найденных совпадениях и связанные метаданные.

Все необходимые параметры должны быть заполнены для отправки в Azure.

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

Конструктор

CustomEntity(*, name: str, description: str | None = None, type: str | None = None, subtype: str | None = None, id: str | None = None, case_sensitive: bool | None = None, accent_sensitive: bool | None = None, fuzzy_edit_distance: int | None = None, default_case_sensitive: bool | None = None, default_accent_sensitive: bool | None = None, default_fuzzy_edit_distance: int | None = None, aliases: List[_models.CustomEntityAlias] | None = None, **kwargs: Any)

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

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

Дескриптор сущности верхнего уровня. Совпадения в выходных данных навыка будут группироваться по этому названию. Оно должно представлять "нормализованную" форму найденного текста. Обязательный.
description
str

Это поле можно использовать в качестве сквозной передачи для пользовательских метаданных о сопоставленных текстах. Значение этого поля будет отображаться с каждым совпадением сущности в выходных данных навыка.
type
str

Это поле можно использовать в качестве сквозной передачи для пользовательских метаданных о сопоставленных текстах. Значение этого поля будет отображаться с каждым совпадением сущности в выходных данных навыка.
subtype
str

Это поле можно использовать в качестве сквозной передачи для пользовательских метаданных о сопоставленных текстах. Значение этого поля будет отображаться с каждым совпадением сущности в выходных данных навыка.
id
str

Это поле можно использовать в качестве сквозной передачи для пользовательских метаданных о сопоставленных текстах. Значение этого поля будет отображаться с каждым совпадением сущности в выходных данных навыка.
case_sensitive
bool

Значение по умолчанию — false. Логическое значение, указывающее, следует ли учитывать регистр символов при сравнении с названием сущности. Примеры совпадений "Microsoft" без учета регистра могут быть: microsoft, microSoft, MICROSOFT.
accent_sensitive
bool

Значение по умолчанию — false. Логическое значение, указывающее, должно ли сравнение с именем сущности быть чувствительным к диакритических знаков.
fuzzy_edit_distance
int

Значение по умолчанию — 0. Максимальное значение — 5. Допустимое количество символов, которые могут не соответствовать названию сущности, однако при этом совпадение будет найдено. Возвращается наименьшее возможное значение нечеткости для любого заданного соответствия. Например, если расстояние редактирования равно 3, "Windows10" по-прежнему будет соответствовать "Windows", "Windows10" и "Windows 7". Если параметр чувствительности к регистру имеет значение false, то разница в регистре НЕ считается нечеткостью.
default_case_sensitive
bool

Изменяет значение конфиденциальности регистра по умолчанию для этой сущности. Он используется для изменения значения по умолчанию для всех псевдонимов caseSensitive.
default_accent_sensitive
bool

Изменяет значение чувствительности диакритических знаков по умолчанию для этой сущности. Он используется для изменения значения по умолчанию для всех псевдонимов accentSensitive.
default_fuzzy_edit_distance
int

Изменяет значение нечеткого расстояния редактирования по умолчанию для этой сущности. Можно использовать для изменения значения по умолчанию для всех псевдонимов fuzzyEditDistance.
aliases
list[<xref:search_service_client.models.CustomEntityAlias>]

Массив сложных объектов, который можно использовать для указания альтернативных орфографических выражений или синонимов имени корневой сущности.

Переменные

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

Дескриптор сущности верхнего уровня. Совпадения в выходных данных навыка будут группироваться по этому названию. Оно должно представлять "нормализованную" форму найденного текста. Обязательный.
description
str

Это поле можно использовать в качестве сквозной передачи для пользовательских метаданных о сопоставленных текстах. Значение этого поля будет отображаться с каждым совпадением сущности в выходных данных навыка.
type
str

Это поле можно использовать в качестве сквозной передачи для пользовательских метаданных о сопоставленных текстах. Значение этого поля будет отображаться с каждым совпадением сущности в выходных данных навыка.
subtype
str

Это поле можно использовать в качестве сквозной передачи для пользовательских метаданных о сопоставленных текстах. Значение этого поля будет отображаться с каждым совпадением сущности в выходных данных навыка.
id
str

Это поле можно использовать в качестве сквозной передачи для пользовательских метаданных о сопоставленных текстах. Значение этого поля будет отображаться с каждым совпадением сущности в выходных данных навыка.
case_sensitive
bool

Значение по умолчанию — false. Логическое значение, указывающее, следует ли учитывать регистр символов при сравнении с названием сущности. Примеры совпадений "Microsoft" без учета регистра могут быть: microsoft, microSoft, MICROSOFT.
accent_sensitive
bool

Значение по умолчанию — false. Логическое значение, указывающее, должно ли сравнение с именем сущности быть чувствительным к диакритических знаков.
fuzzy_edit_distance
int

Значение по умолчанию — 0. Максимальное значение — 5. Допустимое количество символов, которые могут не соответствовать названию сущности, однако при этом совпадение будет найдено. Возвращается наименьшее возможное значение нечеткости для любого заданного соответствия. Например, если расстояние редактирования равно 3, "Windows10" по-прежнему будет соответствовать "Windows", "Windows10" и "Windows 7". Если параметр чувствительности к регистру имеет значение false, то разница в регистре НЕ считается нечеткостью.
default_case_sensitive
bool

Изменяет значение конфиденциальности регистра по умолчанию для этой сущности. Он используется для изменения значения по умолчанию для всех псевдонимов caseSensitive.
default_accent_sensitive
bool

Изменяет значение чувствительности диакритических знаков по умолчанию для этой сущности. Он используется для изменения значения по умолчанию для всех псевдонимов accentSensitive.
default_fuzzy_edit_distance
int

Изменяет значение нечеткого расстояния редактирования по умолчанию для этой сущности. Можно использовать для изменения значения по умолчанию для всех псевдонимов fuzzyEditDistance.
aliases
list[<xref:search_service_client.models.CustomEntityAlias>]

Массив сложных объектов, который можно использовать для указания альтернативных орфографических выражений или синонимов имени корневой сущности.

Методы

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

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

JSON по умолчанию задайте значение application/xml, если 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, если 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 для диктовки