Share via

SingleLabelClassifyAction Class

  • Reference

SingleLabelClassifyAction encapsulates the parameters for starting a long-running custom single label classification operation. For information on regional support of custom features and how to train a model to classify your documents, see https://aka.ms/azsdk/textanalytics/customfunctionalities

New in version 2022-05-01: The SingleLabelClassifyAction model.

Inheritance
azure.ai.textanalytics._dict_mixin.DictMixin
SingleLabelClassifyAction

Constructor

SingleLabelClassifyAction(project_name: str, deployment_name: str, *, disable_service_logs: bool | None = None, **kwargs: Any)

Parameters

Name Description
project_name
Required
str

Required. This field indicates the project name for the model.
deployment_name
Required
str

Required. This field indicates the deployment name for the model.

Keyword-Only Parameters

Name Description
disable_service_logs
Optional[bool]

If set to true, you opt-out of having your text input logged on the service side for troubleshooting. By default, the Language service logs your input text for 48 hours, solely to allow for troubleshooting issues in providing you with the service's natural language processing functions. Setting this parameter to true, disables input logging and may limit our ability to remediate issues that occur. Please see Cognitive Services Compliance and Privacy notes at https://aka.ms/cs-compliance for additional details, and Microsoft Responsible AI principles at https://www.microsoft.com/ai/responsible-ai.

Methods

get
has_key
items
keys
update
values

get 

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

Parameters

Name Description
key
Required
default
Default value: None

has_key 

has_key(k: str) -> bool

Parameters

Name Description
k
Required

items 

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

keys 

keys() -> Iterable[str]

update 

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

values 

values() -> Iterable[Any]

Attributes

deployment_name

This field indicates the deployment name for the model.

deployment_name: str

disable_service_logs

If set to true, you opt-out of having your text input logged on the service side for troubleshooting. By default, the Language service logs your input text for 48 hours, solely to allow for troubleshooting issues in providing you with the service's natural language processing functions. Setting this parameter to true, disables input logging and may limit our ability to remediate issues that occur. Please see Cognitive Services Compliance and Privacy notes at https://aka.ms/cs-compliance for additional details, and Microsoft Responsible AI principles at https://www.microsoft.com/ai/responsible-ai.

disable_service_logs: bool | None = None

project_name

This field indicates the project name for the model.

project_name: str