Partager via

ShingleTokenFilter Classe

  • Référence

Crée des combinaisons de jetons sous la forme d’un unique jeton. Ce filtre de jeton est implémenté à l’aide d’Apache Lucene.

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.TokenFilter
ShingleTokenFilter

Constructeur

ShingleTokenFilter(*, name: str, max_shingle_size: int = 2, min_shingle_size: int = 2, output_unigrams: bool = True, output_unigrams_if_no_shingles: bool = False, token_separator: str = ' ', filter_token: str = '_', **kwargs: Any)

Paramètres de mots-clés uniquement

Nom Description
name
str

Nom du filtre de jeton. 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. Obligatoire.
max_shingle_size
int

Taille maximale du bardeau. La valeur par défaut et minimale est 2.

valeur par défaut: 2
min_shingle_size
int

Taille minimale du bardeau. La valeur par défaut et minimale est 2. Doit être inférieur à la valeur de maxShingleSize.

valeur par défaut: 2
output_unigrams
bool

Valeur indiquant si le flux de sortie contiendra les jetons d’entrée (unigrammes) ainsi que les bardeaux. La valeur par défaut est true.

valeur par défaut: True
output_unigrams_if_no_shingles
bool

Valeur indiquant s’il faut générer des unigrammes pour les moments où aucun bardeau n’est disponible. Cette propriété est prioritaire lorsque outputUnigrams est défini sur false. La valeur par défaut est false.
token_separator
str

Chaîne à utiliser lors de la jointure de jetons adjacents pour former un bardeau. La valeur par défaut est un espace unique ( » « ).

valeur par défaut:
filter_token
str

Chaîne à insérer pour chaque position à laquelle il n’y a pas de jeton. La valeur par défaut est un trait de soulignement (« _ »).

valeur par défaut: _

Variables

Nom Description
odata_type
str

Fragment d’URI spécifiant le type de filtre de jeton. Obligatoire.
name
str

Nom du filtre de jeton. 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. Obligatoire.
max_shingle_size
int

Taille maximale du bardeau. La valeur par défaut et minimale est 2.
min_shingle_size
int

Taille minimale du bardeau. La valeur par défaut et minimale est 2. Doit être inférieur à la valeur de maxShingleSize.
output_unigrams
bool

Valeur indiquant si le flux de sortie contiendra les jetons d’entrée (unigrammes) ainsi que les bardeaux. La valeur par défaut est true.
output_unigrams_if_no_shingles
bool

Valeur indiquant s’il faut générer des unigrammes pour les moments où aucun bardeau n’est disponible. Cette propriété est prioritaire lorsque outputUnigrams est défini sur false. La valeur par défaut est false.
token_separator
str

Chaîne à utiliser lors de la jointure de jetons adjacents pour former un bardeau. La valeur par défaut est un espace unique ( » « ).
filter_token
str

Chaîne à insérer pour chaque position à laquelle il n’y a pas de jeton. La valeur par défaut est un trait de soulignement (« _ »).

Méthodes

as_dict

Retourne un dict 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 une 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 de cet objet.

La chaîne retournée sera utilisée pour sérialiser la clé. Si le type de retour est une liste, il 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 la sérialisation XML, vous pouvez passer les kwargs is_xml=True.
deserialize

Analysez une str à l’aide de la syntaxe RestAPI et retournez un modèle.
enable_additional_properties_sending
from_dict

Analyser une 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 la sérialisation XML, vous pouvez passer les kwargs is_xml=True.

as_dict

Retourne un dict 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 une 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 de cet objet.

La chaîne retournée sera utilisée pour sérialiser la clé. Si le type de retour est une liste, il 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 la 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
dict

Objet compatible JSON dict

deserialize

Analysez une str à l’aide de la syntaxe RestAPI et retournez un modèle.

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

Paramètres

Nom Description
data
Obligatoire
str

Str utilisant la structure RestAPI. JSON par défaut.
content_type
str

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() -> None

from_dict

Analyser une 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) -> ModelType

Paramètres

Nom Description
data
Obligatoire
dict

dict utilisant la structure RestAPI
content_type
str

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() -> bool

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 la 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
bool

Si vous souhaitez sérialiser les attributs readonly

valeur par défaut: False

Retours

Type Description
dict

Objet compatible JSON dict