PIIDetectionSkill interface

パッケージ:

@azure/search-documents

Text Analytics API を使用して、入力テキストから個人情報を抽出し、それをマスクするオプションを提供します。

Extends

BaseSearchIndexerSkill

プロパティ

categories	抽出およびマスクする必要がある PII エンティティ カテゴリの一覧。
defaultLanguageCode	使用する言語コードを示す値。 既定値は en です。
domain	指定した場合、エンティティ カテゴリのサブセットのみを含むように PII ドメインが設定されます。 指定できる値は、'phi'、'none' です。 既定値は 'none' です。
maskingCharacter	maskMode パラメーターが置換するように設定されている場合にテキストをマスクするために使用される文字。 既定値は '*' です。
maskingMode	入力テキストで検出された個人情報をマスクするさまざまな方法を提供するパラメーター。 既定値は 'none' です。
minimumPrecision	信頼度スコアが指定された値より大きいエンティティのみを含めるために使用される 0 ~ 1 の値。 設定されていない場合 (既定値)、または明示的に null に設定されている場合は、すべてのエンティティが含まれます。
modelVersion	Text Analytics サービスを呼び出すときに使用するモデルのバージョン。 指定されていない場合は、既定で使用可能な最新の値になります。 絶対に必要な場合を除き、この値は指定しないことをお勧めします。
odatatype	ポリモーフィック識別子。このオブジェクトは、さまざまな型を指定します。

継承されたプロパティ

context	ドキュメントのルートやドキュメントのコンテンツ (/document や /document/content など) など、操作が行われるレベルを表します。 既定値は /document です。
description	スキルの入力、出力、および使用方法を記述するスキルの説明。
inputs	スキルの入力には、ソース データ セット内の列、またはアップストリーム スキルの出力を指定できます。
name	スキルセット内で一意に識別されるスキルの名前。 名前が定義されていないスキルには、スキル配列内の 1 から始まるインデックスの既定の名前が付けられます。先頭には文字 '#' が付きます。
outputs	スキルの出力は、検索インデックス内のフィールドか、別のスキルによる入力として使用できる値のいずれかです。

プロパティの詳細

categories

抽出およびマスクする必要がある PII エンティティ カテゴリの一覧。

categories?: string[]

プロパティ値

string[]

defaultLanguageCode

使用する言語コードを示す値。 既定値は en です。

defaultLanguageCode?: string

プロパティ値

string

domain

指定した場合、エンティティ カテゴリのサブセットのみを含むように PII ドメインが設定されます。 指定できる値は、'phi'、'none' です。 既定値は 'none' です。

domain?: string

プロパティ値

string

maskingCharacter

maskMode パラメーターが置換するように設定されている場合にテキストをマスクするために使用される文字。 既定値は '*' です。

maskingCharacter?: string

プロパティ値

string

maskingMode

入力テキストで検出された個人情報をマスクするさまざまな方法を提供するパラメーター。 既定値は 'none' です。

maskingMode?: "none" | "replace"

プロパティ値

"none" | "replace"

minimumPrecision

信頼度スコアが指定された値より大きいエンティティのみを含めるために使用される 0 ~ 1 の値。 設定されていない場合 (既定値)、または明示的に null に設定されている場合は、すべてのエンティティが含まれます。

minimumPrecision?: number

プロパティ値

number

modelVersion

Text Analytics サービスを呼び出すときに使用するモデルのバージョン。 指定されていない場合は、既定で使用可能な最新の値になります。 絶対に必要な場合を除き、この値は指定しないことをお勧めします。

modelVersion?: string

プロパティ値

string

odatatype

ポリモーフィック識別子。このオブジェクトは、さまざまな型を指定します。

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

プロパティ値

"#Microsoft.Skills.Text.PIIDetectionSkill"

継承されたプロパティの詳細

context

ドキュメントのルートやドキュメントのコンテンツ (/document や /document/content など) など、操作が行われるレベルを表します。 既定値は /document です。

context?: string

プロパティ値

string

baseSearchIndexerSkill.context から継承

description

スキルの入力、出力、および使用方法を記述するスキルの説明。

description?: string

プロパティ値

string

baseSearchIndexerSkill.descriptionから継承された

inputs

スキルの入力には、ソース データ セット内の列、またはアップストリーム スキルの出力を指定できます。

inputs: InputFieldMappingEntry[]

プロパティ値

InputFieldMappingEntry[]

baseSearchIndexerSkill.inputs から継承

name

スキルセット内で一意に識別されるスキルの名前。 名前が定義されていないスキルには、スキル配列内の 1 から始まるインデックスの既定の名前が付けられます。先頭には文字 '#' が付きます。

name?: string

プロパティ値

string

BaseSearchIndexerSkill.name から継承された

outputs

スキルの出力は、検索インデックス内のフィールドか、別のスキルによる入力として使用できる値のいずれかです。

outputs: OutputFieldMappingEntry[]

プロパティ値

OutputFieldMappingEntry[]

baseSearchIndexerSkill.outputs から継承