CustomEntity Classe
Objet qui contient des informations sur les correspondances trouvées et les métadonnées associées.
Tous les paramètres requis doivent être renseignés pour pouvoir être envoyés à Azure.
- Héritage
-
azure.search.documents.indexes._generated._serialization.ModelCustomEntity
Constructeur
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)Paramètres de mots-clés uniquement
| Nom | Description |
|---|---|
|
name
|
descripteur d'entité de niveau supérieur. Dans la sortie de la compétence, les correspondances seront regroupées en fonction de ce nom. Il s'agit de la forme « normalisée » du texte trouvé. Obligatoire. |
|
description
|
Ce champ peut être utilisé comme passthrough pour les métadonnées personnalisées concernant le ou les textes correspondants. La valeur de ce champ apparaîtra avec chaque correspondance de son entité dans la sortie de la compétence. |
|
type
|
Ce champ peut être utilisé comme passthrough pour les métadonnées personnalisées concernant le ou les textes correspondants. La valeur de ce champ apparaîtra avec chaque correspondance de son entité dans la sortie de la compétence. |
|
subtype
|
Ce champ peut être utilisé comme passthrough pour les métadonnées personnalisées concernant le ou les textes correspondants. La valeur de ce champ apparaîtra avec chaque correspondance de son entité dans la sortie de la compétence. |
|
id
|
Ce champ peut être utilisé comme passthrough pour les métadonnées personnalisées concernant le ou les textes correspondants. La valeur de ce champ apparaîtra avec chaque correspondance de son entité dans la sortie de la compétence. |
|
case_sensitive
|
La valeur par défaut est false. Valeur booléenne indiquant si les comparaisons avec le nom de l'entité doivent respecter la casse des caractères. Les exemples de correspondances non sensibles à la casse de « Microsoft » peuvent être : microsoft, microSoft, MICROSOFT. |
|
accent_sensitive
|
La valeur par défaut est false. Valeur booléenne indiquant si les comparaisons avec le nom d’entité doivent être sensibles à l’accentuation. |
|
fuzzy_edit_distance
|
La valeur par défaut est 0. La valeur maximale est 5. Indique le nombre acceptable de caractères divergents qui constitueraient encore une correspondance avec le nom de l'entité. La plus petite approximation possible d'une correspondance donnée est renvoyée. Par instance, si la distance de modification est définie sur 3, « Windows10 » correspond toujours à « Windows », « Windows10 » et « Windows 7 ». Lorsque le respect de la casse est défini sur « False », les différences de casse ne comptent PAS dans le cadre de la tolérance aux approximations, mais sinon elles comptent. |
|
default_case_sensitive
|
Modifie la valeur de respect de la casse par défaut pour cette entité. Elle peut être utilisée pour modifier les valeurs caseSensitive par défaut de tous les alias. |
|
default_accent_sensitive
|
Modifie la valeur de sensibilité aux accents par défaut pour cette entité. Il permet de modifier la valeur par défaut de toutes les valeurs accentSensitive de tous les alias. |
|
default_fuzzy_edit_distance
|
Modifie la valeur de la distance de modification approximative par défaut pour cette entité. Elle peut être utilisée pour modifier les valeurs fuzzyEditDistance par défaut de tous les alias. |
|
aliases
|
list[<xref:search_service_client.models.CustomEntityAlias>]
Tableau d’objets complexes qui peuvent être utilisés pour spécifier d’autres orthographes ou synonymes au nom de l’entité racine. |
Variables
| Nom | Description |
|---|---|
|
name
|
descripteur d'entité de niveau supérieur. Dans la sortie de la compétence, les correspondances seront regroupées en fonction de ce nom. Il s'agit de la forme « normalisée » du texte trouvé. Obligatoire. |
|
description
|
Ce champ peut être utilisé comme passthrough pour les métadonnées personnalisées concernant le ou les textes correspondants. La valeur de ce champ apparaîtra avec chaque correspondance de son entité dans la sortie de la compétence. |
|
type
|
Ce champ peut être utilisé comme passthrough pour les métadonnées personnalisées concernant le ou les textes correspondants. La valeur de ce champ apparaîtra avec chaque correspondance de son entité dans la sortie de la compétence. |
|
subtype
|
Ce champ peut être utilisé comme passthrough pour les métadonnées personnalisées concernant le ou les textes correspondants. La valeur de ce champ apparaîtra avec chaque correspondance de son entité dans la sortie de la compétence. |
|
id
|
Ce champ peut être utilisé comme passthrough pour les métadonnées personnalisées concernant le ou les textes correspondants. La valeur de ce champ apparaîtra avec chaque correspondance de son entité dans la sortie de la compétence. |
|
case_sensitive
|
La valeur par défaut est false. Valeur booléenne indiquant si les comparaisons avec le nom de l'entité doivent respecter la casse des caractères. Les exemples de correspondances non sensibles à la casse de « Microsoft » peuvent être : microsoft, microSoft, MICROSOFT. |
|
accent_sensitive
|
La valeur par défaut est false. Valeur booléenne indiquant si les comparaisons avec le nom d’entité doivent être sensibles à l’accentuation. |
|
fuzzy_edit_distance
|
La valeur par défaut est 0. La valeur maximale est 5. Indique le nombre acceptable de caractères divergents qui constitueraient encore une correspondance avec le nom de l'entité. La plus petite approximation possible d'une correspondance donnée est renvoyée. Par instance, si la distance de modification est définie sur 3, « Windows10 » correspond toujours à « Windows », « Windows10 » et « Windows 7 ». Lorsque le respect de la casse est défini sur « False », les différences de casse ne comptent PAS dans le cadre de la tolérance aux approximations, mais sinon elles comptent. |
|
default_case_sensitive
|
Modifie la valeur de respect de la casse par défaut pour cette entité. Elle peut être utilisée pour modifier les valeurs caseSensitive par défaut de tous les alias. |
|
default_accent_sensitive
|
Modifie la valeur de sensibilité aux accents par défaut pour cette entité. Il permet de modifier la valeur par défaut de toutes les valeurs accentSensitive de tous les alias. |
|
default_fuzzy_edit_distance
|
Modifie la valeur de la distance de modification approximative par défaut pour cette entité. Elle peut être utilisée pour modifier les valeurs fuzzyEditDistance par défaut de tous les alias. |
|
aliases
|
list[<xref:search_service_client.models.CustomEntityAlias>]
Tableau d’objets complexes qui peuvent être utilisés pour spécifier d’autres orthographes ou synonymes au nom de l’entité racine. |
Méthodes
| as_dict |
Retourne un dictée qui peut être sérialisé à l’aide de json.dump. L’utilisation avancée peut éventuellement utiliser un rappel comme paramètre : La clé est le nom d’attribut utilisé dans Python. Attr_desc est un dictée de métadonnées. Contient actuellement « type » avec le type msrest et « key » avec la clé encodée RestAPI. Value est la valeur actuelle dans cet objet. La chaîne retournée sera utilisée pour sérialiser la clé. Si le type de retour est une liste, cela est considéré comme un dicté de résultat hiérarchique. Consultez les trois exemples de ce fichier :
Si vous souhaitez une sérialisation XML, vous pouvez passer les kwargs is_xml=True. |
| deserialize |
Analysez un str à l’aide de la syntaxe RestAPI et retournez un modèle. |
| enable_additional_properties_sending | |
| from_dict |
L’analyse d’un dicté à l’aide de l’extracteur de clé donné retourne un modèle. Par défaut, considérez les extracteurs de clés (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor et last_rest_key_case_insensitive_extractor) |
| is_xml_model | |
| serialize |
Retourne le json qui serait envoyé au serveur à partir de ce modèle. Il s’agit d’un alias pour as_dict(full_restapi_key_transformer, keep_readonly=False). Si vous souhaitez une sérialisation XML, vous pouvez passer les kwargs is_xml=True. |
as_dict
Retourne un dictée qui peut être sérialisé à l’aide de json.dump.
L’utilisation avancée peut éventuellement utiliser un rappel comme paramètre :
La clé est le nom d’attribut utilisé dans Python. Attr_desc est un dictée de métadonnées. Contient actuellement « type » avec le type msrest et « key » avec la clé encodée RestAPI. Value est la valeur actuelle dans cet objet.
La chaîne retournée sera utilisée pour sérialiser la clé. Si le type de retour est une liste, cela est considéré comme un dicté de résultat hiérarchique.
Consultez les trois exemples de ce fichier :
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
Si vous souhaitez une sérialisation XML, vous pouvez passer les 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]Paramètres
| Nom | Description |
|---|---|
|
key_transformer
|
<xref:function>
Fonction de transformateur de clé. |
|
keep_readonly
|
valeur par défaut: True
|
Retours
| Type | Description |
|---|---|
|
Objet compatible JSON de dict |
deserialize
Analysez un str à l’aide de la syntaxe RestAPI et retournez un modèle.
deserialize(data: Any, content_type: str | None = None) -> ModelTypeParamètres
| Nom | Description |
|---|---|
|
data
Obligatoire
|
Str utilisant la structure RestAPI. JSON par défaut. |
|
content_type
|
JSON par défaut, définissez application/xml si XML. valeur par défaut: None
|
Retours
| Type | Description |
|---|---|
|
Une instance de ce modèle |
Exceptions
| Type | Description |
|---|---|
|
DeserializationError if something went wrong
|
enable_additional_properties_sending
enable_additional_properties_sending() -> Nonefrom_dict
L’analyse d’un dicté à l’aide de l’extracteur de clé donné retourne un modèle.
Par défaut, considérez les extracteurs de clés (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor et 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) -> ModelTypeParamètres
| Nom | Description |
|---|---|
|
data
Obligatoire
|
Dict utilisant la structure RestAPI |
|
content_type
|
JSON par défaut, définissez application/xml si XML. valeur par défaut: None
|
|
key_extractors
|
valeur par défaut: None
|
Retours
| Type | Description |
|---|---|
|
Une instance de ce modèle |
Exceptions
| Type | Description |
|---|---|
|
DeserializationError if something went wrong
|
is_xml_model
is_xml_model() -> boolserialize
Retourne le json qui serait envoyé au serveur à partir de ce modèle.
Il s’agit d’un alias pour as_dict(full_restapi_key_transformer, keep_readonly=False).
Si vous souhaitez une sérialisation XML, vous pouvez passer les kwargs is_xml=True.
serialize(keep_readonly: bool = False, **kwargs: Any) -> MutableMapping[str, Any]Paramètres
| Nom | Description |
|---|---|
|
keep_readonly
|
Si vous souhaitez sérialiser les attributs readonly valeur par défaut: False
|
Retours
| Type | Description |
|---|---|
|
Objet compatible JSON de dict |
Azure SDK for Python