RecognizePiiEntitiesAction クラス

  • リファレンス

RecognizePiiEntitiesAction は、実行時間の長い PII エンティティ認識操作を開始するためのパラメーターをカプセル化します。 詳細については、サービス ドキュメントを参照してください。 https://aka.ms/azsdk/language/pii

ドキュメントの一覧で pii エンティティを認識するだけで、ドキュメントの入力に対して複数の実行時間の長いアクションを実行しない場合は、このモデルとインターフェイスするのではなく、メソッド recognize_pii_entities を呼び出します。

継承
azure.ai.textanalytics._dict_mixin.DictMixin
RecognizePiiEntitiesAction

コンストラクター

RecognizePiiEntitiesAction(*, categories_filter: List[str | PiiEntityCategory] | None = None, domain_filter: str | None = None, model_version: str | None = None, string_index_type: str | None = None, disable_service_logs: bool | None = None, **kwargs: Any)

キーワードのみのパラメーター

名前 説明
model_version
Optional[str]

分析に使用するモデル バージョン ("最新" など)。 モデル バージョンが指定されていない場合、API は既定で最新のプレビュー以外のバージョンになります。 詳細については、こちらを参照してください。 https://aka.ms/text-analytics-model-versioning
domain_filter
Optional[str]

PII エンティティ カテゴリのサブセットのみを含むように PII ドメインを設定する省略可能な文字列。 使用できる値には、'phi' または None が含まれます。
categories_filter
Optional[list[str または PiiEntityCategory]]

すべての PII エンティティ カテゴリをフィルター処理する代わりに、フィルター処理する特定の PII エンティティ カテゴリの一覧を渡すことができます。たとえば、文書内の米国の社会保障番号のみを除外する場合は、この kwarg に [PiiEntityCategory.US_SOCIAL_SECURITY_NUMBER] を 渡すことができます。
string_index_type
Optional[str]

文字列オフセットの解釈に使用するメソッドを指定します。 Python エンコードである UnicodeCodePoint が既定です。 Python の既定値をオーバーライドするには、 Utf16CodeUnit または TextElement_v8 を渡すこともできます。 詳細については、以下を参照してください。 https://aka.ms/text-analytics-offsets
disable_service_logs
Optional[bool]

既定値は true です。つまり、言語サービスはトラブルシューティングのためにサービス側で入力テキストをログに記録しません。 False に設定すると、言語サービスは入力テキストを 48 時間ログに記録します。これは、サービスの自然言語処理機能を提供する際の問題のトラブルシューティングのみを可能にします。 詳細については、「Cognitive Services のコンプライアンスとプライバシーに関する注意事項 https://aka.ms/cs-compliance 」、および「Microsoft の責任ある AI の原則 https://www.microsoft.com/ai/responsible-ai」を参照してください。

メソッド

get
has_key
items
keys
update
values

get 

get(key: str, default: Any | None = None) -> Any

パラメーター

名前 説明
key
必須
default
既定値: None

has_key 

has_key(k: str) -> bool

パラメーター

名前 説明
k
必須

items 

items() -> Iterable[Tuple[str, Any]]

keys 

keys() -> Iterable[str]

update 

update(*args: Any, **kwargs: Any) -> None

values 

values() -> Iterable[Any]

属性

categories_filter

すべての PII エンティティ カテゴリをフィルター処理する代わりに、フィルター処理する特定の PII エンティティ カテゴリの一覧を渡すことができます。たとえば、文書内の米国の社会保障番号のみを除外する場合は、この kwarg に [PiiEntityCategory.US_SOCIAL_SECURITY_NUMBER] を 渡すことができます。

categories_filter: List[str | PiiEntityCategory] | None = None

disable_service_logs

既定値は true です。つまり、言語サービスはトラブルシューティングのためにサービス側で入力テキストをログに記録しません。 False に設定すると、言語サービスは入力テキストを 48 時間ログに記録します。これは、サービスの自然言語処理機能を提供する際の問題のトラブルシューティングのみを可能にします。 詳細については、「Cognitive Services のコンプライアンスとプライバシーに関する注意事項 https://aka.ms/cs-compliance 」、および「Microsoft の責任ある AI の原則 https://www.microsoft.com/ai/responsible-ai」を参照してください。

disable_service_logs: bool | None = None

domain_filter

PII エンティティ カテゴリのサブセットのみを含むように PII ドメインを設定する省略可能な文字列。 使用できる値には、'phi' または None が含まれます。

domain_filter: str | None = None

model_version

分析に使用するモデル バージョン ("最新" など)。 モデル バージョンが指定されていない場合、API は既定で最新のプレビュー以外のバージョンになります。 詳細については、こちらを参照してください。 https://aka.ms/text-analytics-model-versioning

model_version: str | None = None

string_index_type

文字列オフセットの解釈に使用するメソッドを指定します。 Python エンコードである UnicodeCodePoint が既定です。 Python の既定値をオーバーライドするには、 Utf16CodeUnit または TextElement_v8 を渡すこともできます。 詳細については、以下を参照してください。 https://aka.ms/text-analytics-offsets

string_index_type: str | None = None