Partager via

CustomEntityLookupSkill Classe

  • Référence

Une compétence recherche du texte à partir d’une liste personnalisée définie par l’utilisateur de mots et d’expressions.

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.SearchIndexerSkill
CustomEntityLookupSkill

Constructeur

CustomEntityLookupSkill(*, inputs: List[_models.InputFieldMappingEntry], outputs: List[_models.OutputFieldMappingEntry], name: str | None = None, description: str | None = None, context: str | None = None, default_language_code: str | _models.CustomEntityLookupSkillLanguage | None = None, entities_definition_uri: str | None = None, inline_entities_definition: List[_models.CustomEntity] | None = None, global_default_case_sensitive: bool | None = None, global_default_accent_sensitive: bool | None = None, global_default_fuzzy_edit_distance: int | None = None, **kwargs: Any)

Paramètres de mots-clés uniquement

Nom Description
name
str

Nom de la compétence qui l’identifie de manière unique dans l’ensemble de compétences. Une compétence sans nom défini reçoit un nom par défaut de son index de base 1 dans le tableau de compétences, précédé du caractère #.
description
str

Description de la compétence qui décrit les entrées, les sorties et l’utilisation de la compétence.
context
str

Représente le niveau auquel les opérations ont lieu, comme la racine du document ou le contenu du document (par exemple, /document ou /document/content). La valeur par défaut est /document.
inputs
list[<xref:search_service_client.models.InputFieldMappingEntry>]

Les entrées des compétences peuvent être une colonne dans le jeu de données source ou la sortie d’une compétence amont. Obligatoire.
outputs
list[<xref:search_service_client.models.OutputFieldMappingEntry>]

La sortie d’une compétence est soit un champ dans un index de recherche, soit une valeur qui peut être consommée comme entrée par une autre compétence. Obligatoire.
default_language_code
str ou <xref:search_service_client.models.CustomEntityLookupSkillLanguage>

Valeur indiquant le code de langue à utiliser. La valeur par défaut est en. Les valeurs connues sont : « da », « de », « en », « es », « fi », « fr », « it », « ko » et « pt ».
entities_definition_uri
str

Chemin d'accès à un fichier JSON ou CSV contenant tout le texte cible à comparer. Cette définition d’entité est lue au début d’une exécution de l’indexeur. Les mises à jour de ce fichier pendant l’exécution de l’indexeur ne prendront effet qu’après les exécutions. Cette configuration doit être accessible via HTTPS.
inline_entities_definition
list[<xref:search_service_client.models.CustomEntity>]

Définition de CustomEntity inline.
global_default_case_sensitive
bool

Indicateur global pour CaseSensitive. Si CaseSensitive n’est pas défini dans CustomEntity, cette valeur est la valeur par défaut.
global_default_accent_sensitive
bool

Indicateur global pour AccentSensitive. Si AccentSensitive n’est pas défini dans CustomEntity, cette valeur est la valeur par défaut.
global_default_fuzzy_edit_distance
int

Indicateur global pour FuzzyEditDistance. Si FuzzyEditDistance n’est pas défini dans CustomEntity, cette valeur est la valeur par défaut.

Variables

Nom Description
odata_type
str

Fragment d’URI spécifiant le type de compétence. Obligatoire.
name
str

Nom de la compétence qui l’identifie de manière unique dans l’ensemble de compétences. Une compétence sans nom défini reçoit un nom par défaut de son index de base 1 dans le tableau de compétences, précédé du caractère #.
description
str

Description de la compétence qui décrit les entrées, les sorties et l’utilisation de la compétence.
context
str

Représente le niveau auquel les opérations ont lieu, comme la racine du document ou le contenu du document (par exemple, /document ou /document/content). La valeur par défaut est /document.
inputs
list[<xref:search_service_client.models.InputFieldMappingEntry>]

Les entrées des compétences peuvent être une colonne dans le jeu de données source ou la sortie d’une compétence amont. Obligatoire.
outputs
list[<xref:search_service_client.models.OutputFieldMappingEntry>]

La sortie d’une compétence est soit un champ dans un index de recherche, soit une valeur qui peut être consommée comme entrée par une autre compétence. Obligatoire.
default_language_code
str ou <xref:search_service_client.models.CustomEntityLookupSkillLanguage>

Valeur indiquant le code de langue à utiliser. La valeur par défaut est en. Les valeurs connues sont : « da », « de », « en », « es », « fi », « fr », « it », « ko » et « pt ».
entities_definition_uri
str

Chemin d'accès à un fichier JSON ou CSV contenant tout le texte cible à comparer. Cette définition d’entité est lue au début d’une exécution de l’indexeur. Les mises à jour de ce fichier pendant l’exécution de l’indexeur ne prendront effet qu’après les exécutions. Cette configuration doit être accessible via HTTPS.
inline_entities_definition
list[<xref:search_service_client.models.CustomEntity>]

Définition de CustomEntity inline.
global_default_case_sensitive
bool

Indicateur global pour CaseSensitive. Si CaseSensitive n’est pas défini dans CustomEntity, cette valeur est la valeur par défaut.
global_default_accent_sensitive
bool

Indicateur global pour AccentSensitive. Si AccentSensitive n’est pas défini dans CustomEntity, cette valeur est la valeur par défaut.
global_default_fuzzy_edit_distance
int

Indicateur global pour FuzzyEditDistance. Si FuzzyEditDistance n’est pas défini dans CustomEntity, cette valeur est la valeur par défaut.

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 :

  • 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.
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
dict

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

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

Si vous souhaitez sérialiser les attributs readonly

valeur par défaut: False

Retours

Type Description
dict

Objet compatible JSON de dict