PIIDetectionSkill Klas

Met behulp van de Text Analytics-API extraheert u persoonlijke gegevens uit een invoertekst en kunt u deze maskeren.

Alle vereiste parameters moeten worden ingevuld om naar Azure te kunnen worden verzonden.

Overname

azure.search.documents.indexes._generated.models._models_py3.SearchIndexerSkill

PIIDetectionSkill

Constructor

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)

Keyword-Only Parameters

Name	Description
name	str De naam van de vaardigheid die deze uniek identificeert binnen de vaardighedenset. Een vaardigheid zonder gedefinieerde naam krijgt een standaardnaam van de op 1 gebaseerde index in de vaardighedenmatrix, voorafgegaan door het teken #.
description	str De beschrijving van de vaardigheid die de invoer, uitvoer en het gebruik van de vaardigheid beschrijft.
context	str Vertegenwoordigt het niveau waarop bewerkingen worden uitgevoerd, zoals de hoofdmap van het document of de inhoud van het document (bijvoorbeeld /document of /document/content). De standaardwaarde is /document.
inputs	list[<xref:search_service_client.models.InputFieldMappingEntry>] Invoer van de vaardigheden kan een kolom in de brongegevensset zijn of de uitvoer van een upstream-vaardigheid. Vereist.
outputs	list[<xref:search_service_client.models.OutputFieldMappingEntry>] De uitvoer van een vaardigheid is een veld in een zoekindex of een waarde die kan worden gebruikt als invoer door een andere vaardigheid. Vereist.
default_language_code	str Een waarde die aangeeft welke taalcode moet worden gebruikt. De standaardinstelling is en.
minimum_precision	float Een waarde tussen 0 en 1 die wordt gebruikt om alleen entiteiten op te nemen waarvan de betrouwbaarheidsscore hoger is dan de opgegeven waarde. Als dit niet is ingesteld (standaard) of expliciet is ingesteld op null, worden alle entiteiten opgenomen.
masking_mode	str of <xref:search_service_client.models.PIIDetectionSkillMaskingMode> Een parameter die verschillende manieren biedt om de persoonlijke gegevens te maskeren die in de invoertekst worden gedetecteerd. De standaardwaarde is 'none'. Bekende waarden zijn: 'none' en 'replace'.
mask	str Het teken dat wordt gebruikt om de tekst te maskeren als de parameter maskingMode is ingesteld om te vervangen. De standaardinstelling is *.
model_version	str De versie van het model die moet worden gebruikt bij het aanroepen van de Text Analytics-service. Deze wordt standaard ingesteld op de meest recente versie wanneer deze niet is opgegeven. We raden u aan deze waarde niet op te geven, tenzij dit absoluut noodzakelijk is.
pii_categories	list[str] Een lijst met PII-entiteitscategorieën die moeten worden geëxtraheerd en gemaskeerd.
domain	str Indien opgegeven, stelt het PII-domein in om alleen een subset van de entiteitscategorieën op te nemen. Mogelijke waarden zijn: 'phi', 'none'. De standaardwaarde is 'none'.

Variabelen

Name	Description
odata_type	str Een URI-fragment dat het type vaardigheid aangeeft. Vereist.
name	str De naam van de vaardigheid die deze uniek identificeert binnen de vaardighedenset. Een vaardigheid zonder gedefinieerde naam krijgt een standaardnaam van de op 1 gebaseerde index in de vaardighedenmatrix, voorafgegaan door het teken #.
description	str De beschrijving van de vaardigheid die de invoer, uitvoer en het gebruik van de vaardigheid beschrijft.
context	str Vertegenwoordigt het niveau waarop bewerkingen worden uitgevoerd, zoals de hoofdmap van het document of de inhoud van het document (bijvoorbeeld /document of /document/content). De standaardwaarde is /document.
inputs	list[<xref:search_service_client.models.InputFieldMappingEntry>] Invoer van de vaardigheden kan een kolom in de brongegevensset zijn of de uitvoer van een upstream-vaardigheid. Vereist.
outputs	list[<xref:search_service_client.models.OutputFieldMappingEntry>] De uitvoer van een vaardigheid is een veld in een zoekindex of een waarde die kan worden gebruikt als invoer door een andere vaardigheid. Vereist.
default_language_code	str Een waarde die aangeeft welke taalcode moet worden gebruikt. De standaardinstelling is en.
minimum_precision	float Een waarde tussen 0 en 1 die wordt gebruikt om alleen entiteiten op te nemen waarvan de betrouwbaarheidsscore hoger is dan de opgegeven waarde. Als dit niet is ingesteld (standaard) of expliciet is ingesteld op null, worden alle entiteiten opgenomen.
masking_mode	str of <xref:search_service_client.models.PIIDetectionSkillMaskingMode> Een parameter die verschillende manieren biedt om de persoonlijke gegevens te maskeren die in de invoertekst worden gedetecteerd. De standaardwaarde is 'none'. Bekende waarden zijn: 'none' en 'replace'.
mask	str Het teken dat wordt gebruikt om de tekst te maskeren als de parameter maskingMode is ingesteld om te vervangen. De standaardinstelling is *.
model_version	str De versie van het model die moet worden gebruikt bij het aanroepen van de Text Analytics-service. Deze wordt standaard ingesteld op de meest recente versie wanneer deze niet is opgegeven. We raden u aan deze waarde niet op te geven, tenzij dit absoluut noodzakelijk is.
pii_categories	list[str] Een lijst met PII-entiteitscategorieën die moeten worden geëxtraheerd en gemaskeerd.
domain	str Indien opgegeven, stelt het PII-domein in om alleen een subset van de entiteitscategorieën op te nemen. Mogelijke waarden zijn: 'phi', 'none'. De standaardwaarde is 'none'.

Methoden

as_dict	Een dict retourneren dat kan worden geserialiseerd met behulp van json.dump. Geavanceerd gebruik kan eventueel een callback gebruiken als parameter: Sleutel is de kenmerknaam die wordt gebruikt in Python. Attr_desc is een dictaat van metagegevens. Bevat momenteel 'type' met het msrest-type en 'key' met de RestAPI-gecodeerde sleutel. Waarde is de huidige waarde in dit object. De geretourneerde tekenreeks wordt gebruikt om de sleutel te serialiseren. Als het retourtype een lijst is, wordt dit beschouwd als hiërarchische resultaatdicteerfunctie. Bekijk de drie voorbeelden in dit bestand: attribute_transformer full_restapi_key_transformer last_restapi_key_transformer Als u XML-serialisatie wilt, kunt u de kwargs-is_xml=True doorgeven.
deserialize	Parseert een str met behulp van de RestAPI-syntaxis en retourneer een model.
enable_additional_properties_sending
from_dict	Een dicteren met behulp van de opgegeven sleutelextractor retourneert een model. Houd standaard rekening met sleutelextracties (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor en last_rest_key_case_insensitive_extractor)
is_xml_model
serialize	Retourneer de JSON die vanuit dit model naar de server wordt verzonden. Dit is een alias voor as_dict(full_restapi_key_transformer, keep_readonly=False). Als u XML-serialisatie wilt, kunt u de kwargs-is_xml=True doorgeven.

as_dict

Een dict retourneren dat kan worden geserialiseerd met behulp van json.dump.

Geavanceerd gebruik kan eventueel een callback gebruiken als parameter:

Sleutel is de kenmerknaam die wordt gebruikt in Python. Attr_desc is een dictaat van metagegevens. Bevat momenteel 'type' met het msrest-type en 'key' met de RestAPI-gecodeerde sleutel. Waarde is de huidige waarde in dit object.

De geretourneerde tekenreeks wordt gebruikt om de sleutel te serialiseren. Als het retourtype een lijst is, wordt dit beschouwd als hiërarchische resultaatdicteerfunctie.

Bekijk de drie voorbeelden in dit bestand:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

Als u XML-serialisatie wilt, kunt u de kwargs-is_xml=True doorgeven.

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]

Parameters

Name	Description
key_transformer	<xref:function> Een sleuteltransformatorfunctie.
keep_readonly	standaardwaarde: True

Retouren

Type	Description
dict	Een dict JSON-compatibel object

deserialize

Parseert een str met behulp van de RestAPI-syntaxis en retourneer een model.

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

Parameters

Name	Description
data Vereist	str Een str met behulp van restAPI-structuur. JSON standaard.
content_type	str JSON stelt standaard toepassing/xml in als XML. standaardwaarde: None

Retouren

Type	Description
	Een exemplaar van dit model

Uitzonderingen

Type	Description
DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending() -> None

from_dict

Een dicteren met behulp van de opgegeven sleutelextractor retourneert een model.

Houd standaard rekening met sleutelextracties (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor en 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

Parameters

Name	Description
data Vereist	dict Een dicteerfunctie met restAPI-structuur
content_type	str JSON stelt standaard toepassing/xml in als XML. standaardwaarde: None
key_extractors	standaardwaarde: None

Retouren

Type	Description
	Een exemplaar van dit model

Uitzonderingen

Type	Description
DeserializationError if something went wrong

is_xml_model

is_xml_model() -> bool

serialize

Retourneer de JSON die vanuit dit model naar de server wordt verzonden.

Dit is een alias voor as_dict(full_restapi_key_transformer, keep_readonly=False).

Als u XML-serialisatie wilt, kunt u de kwargs-is_xml=True doorgeven.

serialize(keep_readonly: bool = False, **kwargs: Any) -> MutableMapping[str, Any]

Parameters

Name	Description
keep_readonly	bool Als u de alleen-lezen kenmerken wilt serialiseren standaardwaarde: False

Retouren

Type	Description
dict	Een dict JSON-compatibel object