CustomAnalyzer Classe
Vous permet de prendre le contrôle du processus de conversion du texte en jetons indexables/pouvant faire l’objet d’une recherche. Il s’agit d’une configuration définie par l’utilisateur composée d’un générateur de jetons unique prédéfini et d’un ou plusieurs filtres. Le générateur de jetons est responsable de la fractionnement du texte en jetons et des filtres pour la modification des jetons émis par le générateur de jetons.
Tous les paramètres requis doivent être renseignés pour pouvoir être envoyés à Azure.
- Héritage
-
azure.search.documents.indexes._generated.models._models_py3.LexicalAnalyzerCustomAnalyzer
Constructeur
CustomAnalyzer(**kwargs)Variables
| Nom | Description |
|---|---|
|
odata_type
|
Obligatoire. Identifie le type concret de l’analyseur. Constante remplie par le serveur. |
|
name
|
Obligatoire. Nom de l’analyseur. Il doit contenir uniquement des lettres, des chiffres, des espaces, des tirets ou des traits de soulignement. Il doit commencer et se terminer uniquement par des caractères alphanumériques, et ne doit pas dépasser 128 caractères. |
|
tokenizer_name
|
Obligatoire. Nom du générateur de jetons à utiliser pour diviser le texte continu en une séquence de jetons, telle que la division d’une phrase en mots. Les valeurs possibles sont les suivantes : « classic », « edgeNGram », « keyword_v2 », « letter », « lowercase », « microsoft_language_tokenizer », « microsoft_language_stemming_tokenizer », « nGram », « path_hierarchy_v2 », « pattern », « standard_v2 », « uax_url_email », « whitespace ». |
|
token_filters
|
Liste des filtres de jetons utilisés pour filtrer ou modifier les jetons générés par un générateur de jetons. Par exemple, vous pouvez spécifier un filtre lowercase qui convertit tous les caractères en minuscules. Les filtres sont exécutés dans l’ordre dans lequel ils sont répertoriés. |
|
char_filters
|
Liste des filtres de caractères utilisés pour préparer le texte d’entrée avant qu’il ne soit traité par le générateur de jetons. Par exemple, il peut remplacer certains caractères ou certains symboles. Les filtres sont exécutés dans l’ordre dans lequel ils sont répertoriés. |
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