PIIDetectionSkill Classe
À l’aide de l’API Analyse de texte, extrait les informations personnelles d’un texte d’entrée et vous permet de les masquer.
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.SearchIndexerSkillPIIDetectionSkill
Constructeur
PIIDetectionSkill(*, inputs: List[_models.InputFieldMappingEntry], outputs: List[_models.OutputFieldMappingEntry], name: str | None = None, description: str | None = None, context: str | None = None, default_language_code: str | None = None, minimum_precision: float | None = None, masking_mode: str | _models.PIIDetectionSkillMaskingMode | None = None, mask: str | None = None, model_version: str | None = None, pii_categories: List[str] | None = None, domain: str | None = None, **kwargs: Any)Paramètres de mots-clés uniquement
| Nom | Description |
|---|---|
|
name
|
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
|
Description de la compétence qui décrit les entrées, les sorties et l’utilisation de la compétence. |
|
context
|
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 en tant qu’entrée par une autre compétence. Obligatoire. |
|
default_language_code
|
Valeur indiquant le code de langue à utiliser. La valeur par défaut est |
|
minimum_precision
|
Valeur comprise entre 0 et 1 utilisée pour inclure uniquement les entités dont le score de confiance est supérieur à la valeur spécifiée. Si elle n’est pas définie (valeur par défaut) ou si elle est explicitement définie sur null, toutes les entités sont incluses. |
|
masking_mode
|
str ou
<xref:search_service_client.models.PIIDetectionSkillMaskingMode>
Paramètre qui fournit différentes façons de masquer les informations personnelles détectées dans le texte d'entrée. La valeur par défaut est « none ». Les valeurs connues sont « none » et « replace ». |
|
mask
|
Caractère utilisé pour masquer le texte si le paramètre maskingMode est défini pour remplacer. La valeur par défaut est |
|
model_version
|
Version du modèle à utiliser lors de l’appel du service Analyse de texte. Si rien n’est spécifié, la dernière version disponible est utilisée par défaut. Nous vous recommandons de ne pas spécifier cette valeur, sauf nécessité absolue. |
|
pii_categories
|
Liste des catégories d’entités PII qui doivent être extraites et masquées. |
|
domain
|
S’il est spécifié, définit le domaine PII pour qu’il inclue uniquement un sous-ensemble des catégories d’entités. Les valeurs possibles sont les suivantes : 'phi', 'none'. La valeur par défaut est « none ». |
Variables
| Nom | Description |
|---|---|
|
odata_type
|
Fragment d’URI spécifiant le type de compétence. Obligatoire. |
|
name
|
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
|
Description de la compétence qui décrit les entrées, les sorties et l’utilisation de la compétence. |
|
context
|
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 en tant qu’entrée par une autre compétence. Obligatoire. |
|
default_language_code
|
Valeur indiquant le code de langue à utiliser. La valeur par défaut est |
|
minimum_precision
|
Valeur comprise entre 0 et 1 utilisée pour inclure uniquement les entités dont le score de confiance est supérieur à la valeur spécifiée. Si elle n’est pas définie (valeur par défaut) ou si elle est explicitement définie sur null, toutes les entités sont incluses. |
|
masking_mode
|
str ou
<xref:search_service_client.models.PIIDetectionSkillMaskingMode>
Paramètre qui fournit différentes façons de masquer les informations personnelles détectées dans le texte d'entrée. La valeur par défaut est « none ». Les valeurs connues sont « none » et « replace ». |
|
mask
|
Caractère utilisé pour masquer le texte si le paramètre maskingMode est défini pour remplacer.
La valeur par défaut est |
|
model_version
|
Version du modèle à utiliser lors de l’appel du service Analyse de texte. Si rien n’est spécifié, la dernière version disponible est utilisée par défaut. Nous vous recommandons de ne pas spécifier cette valeur, sauf nécessité absolue. |
|
pii_categories
|
Liste des catégories d’entités PII qui doivent être extraites et masquées. |
|
domain
|
S’il est spécifié, définit le domaine PII pour qu’il inclue uniquement un sous-ensemble des catégories d’entités. Les valeurs possibles sont les suivantes : 'phi', 'none'. La valeur par défaut est « none ». |
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 :
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 |
|---|---|
|
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) -> 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
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) -> 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 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
|
Si vous souhaitez sérialiser les attributs readonly valeur par défaut: False
|
Retours
| Type | Description |
|---|---|
|
Objet compatible JSON dict |
Azure SDK for Python