PIIDetectionSkill interface

Paket:

@azure/search-documents

Mithilfe der Text Analytics-API werden persönliche Informationen aus einem Eingabetext extrahiert und sie maskieren können.

Extends

BaseSearchIndexerSkill

Eigenschaften

categories	Eine Liste der PiI-Entitätskategorien, die extrahiert und maskiert werden sollen.
defaultLanguageCode	Ein Wert, der angibt, welcher Sprachcode verwendet werden soll. Der Standardwert ist "en".
domain	Wenn angegeben, wird die PII-Domäne so festgelegt, dass nur eine Teilmenge der Entitätskategorien eingeschlossen wird. Mögliche Werte sind: 'phi', 'none'. Der Standardwert ist 'none'.
maskingCharacter	Das Zeichen, das zum Maskieren des Texts verwendet wird, wenn der Parameter maskingMode zum Ersetzen festgelegt ist. Der Standardwert ist '*'.
maskingMode	Ein Parameter, der verschiedene Möglichkeiten bietet, die im Eingabetext erkannten persönlichen Informationen zu maskieren. Der Standardwert ist 'none'.
minimumPrecision	Ein Wert zwischen 0 und 1, der nur Entitäten enthält, deren Konfidenzbewertung größer als der angegebene Wert ist. Wenn sie nicht festgelegt (Standardeinstellung) oder explizit auf NULL festgelegt ist, werden alle Entitäten eingeschlossen.
modelVersion	Die Version des Modells, die beim Aufrufen des Text Analytics-Diensts verwendet werden soll. Er wird standardmäßig auf den neuesten verfügbaren Wert festgelegt, wenn er nicht angegeben ist. Es wird empfohlen, diesen Wert nicht anzugeben, es sei denn, es ist unbedingt erforderlich.
odatatype	Polymorphe Diskriminator, der die verschiedenen Typen angibt, die dieses Objekt sein kann

Geerbte Eigenschaften

context	Stellt die Ebene dar, auf der Vorgänge ausgeführt werden, z. B. der Dokumentstamm- oder Dokumentinhalt (z. B. /document oder /document/content). Der Standardwert ist /document.
description	Die Beschreibung der Fähigkeiten, die die Eingaben, Ausgaben und die Nutzung der Fähigkeiten beschreibt.
inputs	Eingaben der Fähigkeiten können eine Spalte im Quelldatensatz oder die Ausgabe einer upstream-Fähigkeit sein.
name	Der Name der Fähigkeit, die sie innerhalb des Skillsets eindeutig identifiziert. Eine Fähigkeit ohne definierten Namen erhält einen Standardnamen des 1-basierten Indexes im Kompetenzarray, dem das Zeichen "#" vorangestellt ist.
outputs	Die Ausgabe einer Fähigkeit ist entweder ein Feld in einem Suchindex oder ein Wert, der als Eingabe durch eine andere Fähigkeit genutzt werden kann.

Details zur Eigenschaft

categories

Eine Liste der PiI-Entitätskategorien, die extrahiert und maskiert werden sollen.

categories?: string[]

Eigenschaftswert

string[]

defaultLanguageCode

Ein Wert, der angibt, welcher Sprachcode verwendet werden soll. Der Standardwert ist "en".

defaultLanguageCode?: string

Eigenschaftswert

string

domain

Wenn angegeben, wird die PII-Domäne so festgelegt, dass nur eine Teilmenge der Entitätskategorien eingeschlossen wird. Mögliche Werte sind: 'phi', 'none'. Der Standardwert ist 'none'.

domain?: string

Eigenschaftswert

string

maskingCharacter

Das Zeichen, das zum Maskieren des Texts verwendet wird, wenn der Parameter maskingMode zum Ersetzen festgelegt ist. Der Standardwert ist '*'.

maskingCharacter?: string

Eigenschaftswert

string

maskingMode

Ein Parameter, der verschiedene Möglichkeiten bietet, die im Eingabetext erkannten persönlichen Informationen zu maskieren. Der Standardwert ist 'none'.

maskingMode?: "none" | "replace"

Eigenschaftswert

"none" | "replace"

minimumPrecision

Ein Wert zwischen 0 und 1, der nur Entitäten enthält, deren Konfidenzbewertung größer als der angegebene Wert ist. Wenn sie nicht festgelegt (Standardeinstellung) oder explizit auf NULL festgelegt ist, werden alle Entitäten eingeschlossen.

minimumPrecision?: number

Eigenschaftswert

number

modelVersion

Die Version des Modells, die beim Aufrufen des Text Analytics-Diensts verwendet werden soll. Er wird standardmäßig auf den neuesten verfügbaren Wert festgelegt, wenn er nicht angegeben ist. Es wird empfohlen, diesen Wert nicht anzugeben, es sei denn, es ist unbedingt erforderlich.

modelVersion?: string

Eigenschaftswert

string

odatatype

Polymorphe Diskriminator, der die verschiedenen Typen angibt, die dieses Objekt sein kann

odatatype: "#Microsoft.Skills.Text.PIIDetectionSkill"

Eigenschaftswert

"#Microsoft.Skills.Text.PIIDetectionSkill"

Geerbte Eigenschaftsdetails

context

Stellt die Ebene dar, auf der Vorgänge ausgeführt werden, z. B. der Dokumentstamm- oder Dokumentinhalt (z. B. /document oder /document/content). Der Standardwert ist /document.

context?: string

Eigenschaftswert

string

geerbt vonBaseSearchIndexerSkill.context

description

Die Beschreibung der Fähigkeiten, die die Eingaben, Ausgaben und die Nutzung der Fähigkeiten beschreibt.

description?: string

Eigenschaftswert

string

geerbt vonBaseSearchIndexerSkill.description

inputs

Eingaben der Fähigkeiten können eine Spalte im Quelldatensatz oder die Ausgabe einer upstream-Fähigkeit sein.

inputs: InputFieldMappingEntry[]

Eigenschaftswert

InputFieldMappingEntry[]

vonBaseSearchIndexerSkill.inputs geerbt

name

Der Name der Fähigkeit, die sie innerhalb des Skillsets eindeutig identifiziert. Eine Fähigkeit ohne definierten Namen erhält einen Standardnamen des 1-basierten Indexes im Kompetenzarray, dem das Zeichen "#" vorangestellt ist.

name?: string

Eigenschaftswert

string

geerbt vonBaseSearchIndexerSkill.name

outputs

Die Ausgabe einer Fähigkeit ist entweder ein Feld in einem Suchindex oder ein Wert, der als Eingabe durch eine andere Fähigkeit genutzt werden kann.

outputs: OutputFieldMappingEntry[]

Eigenschaftswert

OutputFieldMappingEntry[]

vonBaseSearchIndexerSkill.outputs