RecognizePiiEntitiesAction Classe

  • Referência

RecognizePiiEntitiesAction encapsula os parâmetros para iniciar uma operação de reconhecimento de entidades PII de execução longa. Veja mais informações nos documentos do serviço: https://aka.ms/azsdk/language/pii

Se você quiser apenas reconhecer entidades pii em uma lista de documentos e não executar várias ações de execução longa na entrada de documentos, chame o método recognize_pii_entities em vez de fazer a interfacagem com esse modelo.

Herança
azure.ai.textanalytics._dict_mixin.DictMixin
RecognizePiiEntitiesAction

Construtor

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)

Parâmetros somente de palavra-chave

Nome Description
model_version
Optional[str]

A versão do modelo a ser usada para a análise, por exemplo, "mais recente". Se uma versão de modelo não for especificada, a API usará como padrão a versão mais recente, não prévia. Consulte aqui para obter mais informações: https://aka.ms/text-analytics-model-versioning
domain_filter
Optional[str]

Uma cadeia de caracteres opcional para definir o domínio PII para incluir apenas um subconjunto das categorias de entidade PII. Os valores possíveis incluem 'phi' ou None.
categories_filter
Optional[list[str ou PiiEntityCategory]]

Em vez de filtrar todas as categorias de entidade PII, você pode passar uma lista das categorias de entidade PII específicas que deseja filtrar. Por exemplo, se você quiser filtrar apenas os números do seguro social dos EUA em um documento, poderá passar [PiiEntityCategory.US_SOCIAL_SECURITY_NUMBER] para este kwarg.
string_index_type
Optional[str]

Especifica o método usado para interpretar deslocamentos de cadeia de caracteres. UnicodeCodePoint, a codificação do Python, é o padrão. Para substituir o padrão do Python, você também pode passar Utf16CodeUnit ou TextElement_v8. Para obter informações adicionais, consulte https://aka.ms/text-analytics-offsets
disable_service_logs
Optional[bool]

O padrão é true, o que significa que o serviço de Linguagem não registrará seu texto de entrada no lado do serviço para solução de problemas. Se definido como False, o serviço de Linguagem registrará seu texto de entrada por 48 horas, apenas para permitir a solução de problemas ao fornecer as funções de processamento de linguagem natural do serviço. Consulte As notas de Conformidade e Privacidade dos Serviços Cognitivos em https://aka.ms/cs-compliance para obter detalhes adicionais e princípios de IA responsável da Microsoft em https://www.microsoft.com/ai/responsible-ai.

Métodos

get
has_key
items
keys
update
values

get 

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

Parâmetros

Nome Description
key
Obrigatório
default
valor padrão: None

has_key 

has_key(k: str) -> bool

Parâmetros

Nome Description
k
Obrigatório

items 

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

keys 

keys() -> Iterable[str]

update 

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

values 

values() -> Iterable[Any]

Atributos

categories_filter

Em vez de filtrar todas as categorias de entidade PII, você pode passar uma lista das categorias de entidade PII específicas que deseja filtrar. Por exemplo, se você quiser filtrar apenas os números do seguro social dos EUA em um documento, poderá passar [PiiEntityCategory.US_SOCIAL_SECURITY_NUMBER] para este kwarg.

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

disable_service_logs

O padrão é true, o que significa que o serviço de Linguagem não registrará seu texto de entrada no lado do serviço para solução de problemas. Se definido como False, o serviço de Linguagem registrará seu texto de entrada por 48 horas, apenas para permitir a solução de problemas ao fornecer as funções de processamento de linguagem natural do serviço. Consulte As notas de Conformidade e Privacidade dos Serviços Cognitivos em https://aka.ms/cs-compliance para obter detalhes adicionais e princípios de IA responsável da Microsoft em https://www.microsoft.com/ai/responsible-ai.

disable_service_logs: bool | None = None

domain_filter

Uma cadeia de caracteres opcional para definir o domínio PII para incluir apenas um subconjunto das categorias de entidade PII. Os valores possíveis incluem 'phi' ou None.

domain_filter: str | None = None

model_version

A versão do modelo a ser usada para a análise, por exemplo, "mais recente". Se uma versão de modelo não for especificada, a API usará como padrão a versão mais recente, não prévia. Consulte aqui para obter mais informações: https://aka.ms/text-analytics-model-versioning

model_version: str | None = None

string_index_type

Especifica o método usado para interpretar deslocamentos de cadeia de caracteres. UnicodeCodePoint, a codificação do Python, é o padrão. Para substituir o padrão do Python, você também pode passar Utf16CodeUnit ou TextElement_v8. Para obter informações adicionais, consulte https://aka.ms/text-analytics-offsets

string_index_type: str | None = None