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)

僅限關鍵字的參數

名稱	Description
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] 指定用來解譯字串位移的方法。 UnicodeCodePoint是 Python 編碼的預設值。若要覆寫 Python 預設值，您也可以傳入 Utf16CodeUnit 或 TextElement_v8。如需詳細資訊，請參閱 https://aka.ms/text-analytics-offsets
disable_service_logs	Optional[bool] 預設為 true，這表示語言服務不會在服務端記錄您的輸入文字以進行疑難排解。如果設定為 False，語言服務會記錄您的輸入文字 48 小時，只允許針對提供服務的自然語言處理函式的問題進行疑難排解。如需詳細資訊，請參閱中的認知服務合規性和隱私權注意事項 https://aka.ms/cs-compliance ，以及的 https://www.microsoft.com/ai/responsible-ai Microsoft 負責任 AI 原則。

方法

get
has_key
items
keys
update
values

get

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

參數

名稱	Description
key 必要
default	預設值: None

has_key

has_key(k: str) -> bool

參數

名稱	Description
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 小時，只允許針對提供服務的自然語言處理函式的問題進行疑難排解。如需詳細資訊，請參閱中的認知服務合規性和隱私權注意事項 https://aka.ms/cs-compliance ，以及的 https://www.microsoft.com/ai/responsible-ai Microsoft 負責任 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

指定用來解譯字串位移的方法。 UnicodeCodePoint是 Python 編碼的預設值。若要覆寫 Python 預設值，您也可以傳入 Utf16CodeUnit 或 TextElement_v8。如需詳細資訊，請參閱 https://aka.ms/text-analytics-offsets

string_index_type: str | None = None

共用方式為