TextClassificationModelDetails

class oci.ai_language.models.TextClassificationModelDetails(**kwargs)

Bases: ModelDetails

Possible TextClassificationModelDetails

Attributes:

MODEL_TYPE_HEALTH_NLU

A constant which can be used with the model_type property of a ModelDetails.

MODEL_TYPE_NAMED_ENTITY_RECOGNITION

A constant which can be used with the model_type property of a ModelDetails.

MODEL_TYPE_PII

A constant which can be used with the model_type property of a ModelDetails.

MODEL_TYPE_PRE_TRAINED_HEALTH_NLU

A constant which can be used with the model_type property of a ModelDetails.

MODEL_TYPE_PRE_TRAINED_KEYPHRASE_EXTRACTION

A constant which can be used with the model_type property of a ModelDetails.

MODEL_TYPE_PRE_TRAINED_LANGUAGE_DETECTION

A constant which can be used with the model_type property of a ModelDetails.

MODEL_TYPE_PRE_TRAINED_NAMED_ENTITY_RECOGNITION

A constant which can be used with the model_type property of a ModelDetails.

MODEL_TYPE_PRE_TRAINED_PII

A constant which can be used with the model_type property of a ModelDetails.

MODEL_TYPE_PRE_TRAINED_SENTIMENT_ANALYSIS

A constant which can be used with the model_type property of a ModelDetails.

MODEL_TYPE_PRE_TRAINED_SUMMARIZATION

A constant which can be used with the model_type property of a ModelDetails.

MODEL_TYPE_PRE_TRAINED_TEXT_CLASSIFICATION

A constant which can be used with the model_type property of a ModelDetails.

MODEL_TYPE_PRE_TRAINED_TRANSLATION

A constant which can be used with the model_type property of a ModelDetails.

MODEL_TYPE_PRE_TRAINED_UNIVERSAL

A constant which can be used with the model_type property of a ModelDetails.

MODEL_TYPE_TEXT_CLASSIFICATION

A constant which can be used with the model_type property of a ModelDetails.

classification_mode

Gets the classification_mode of this TextClassificationModelDetails.

language_code

Gets the language_code of this ModelDetails.

model_type

[Required] Gets the model_type of this ModelDetails.

Methods:

__init__(**kwargs)

Initializes a new TextClassificationModelDetails object with values from keyword arguments.

get_subtype(object_dictionary)

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

MODEL_TYPE_HEALTH_NLU = 'HEALTH_NLU'

A constant which can be used with the model_type property of a ModelDetails. This constant has a value of “HEALTH_NLU”

MODEL_TYPE_NAMED_ENTITY_RECOGNITION = 'NAMED_ENTITY_RECOGNITION'

A constant which can be used with the model_type property of a ModelDetails. This constant has a value of “NAMED_ENTITY_RECOGNITION”

MODEL_TYPE_PII = 'PII'

A constant which can be used with the model_type property of a ModelDetails. This constant has a value of “PII”

MODEL_TYPE_PRE_TRAINED_HEALTH_NLU = 'PRE_TRAINED_HEALTH_NLU'

A constant which can be used with the model_type property of a ModelDetails. This constant has a value of “PRE_TRAINED_HEALTH_NLU”

MODEL_TYPE_PRE_TRAINED_KEYPHRASE_EXTRACTION = 'PRE_TRAINED_KEYPHRASE_EXTRACTION'

A constant which can be used with the model_type property of a ModelDetails. This constant has a value of “PRE_TRAINED_KEYPHRASE_EXTRACTION”

MODEL_TYPE_PRE_TRAINED_LANGUAGE_DETECTION = 'PRE_TRAINED_LANGUAGE_DETECTION'

A constant which can be used with the model_type property of a ModelDetails. This constant has a value of “PRE_TRAINED_LANGUAGE_DETECTION”

MODEL_TYPE_PRE_TRAINED_NAMED_ENTITY_RECOGNITION = 'PRE_TRAINED_NAMED_ENTITY_RECOGNITION'

A constant which can be used with the model_type property of a ModelDetails. This constant has a value of “PRE_TRAINED_NAMED_ENTITY_RECOGNITION”

MODEL_TYPE_PRE_TRAINED_PII = 'PRE_TRAINED_PII'

A constant which can be used with the model_type property of a ModelDetails. This constant has a value of “PRE_TRAINED_PII”

MODEL_TYPE_PRE_TRAINED_SENTIMENT_ANALYSIS = 'PRE_TRAINED_SENTIMENT_ANALYSIS'

A constant which can be used with the model_type property of a ModelDetails. This constant has a value of “PRE_TRAINED_SENTIMENT_ANALYSIS”

MODEL_TYPE_PRE_TRAINED_SUMMARIZATION = 'PRE_TRAINED_SUMMARIZATION'

A constant which can be used with the model_type property of a ModelDetails. This constant has a value of “PRE_TRAINED_SUMMARIZATION”

MODEL_TYPE_PRE_TRAINED_TEXT_CLASSIFICATION = 'PRE_TRAINED_TEXT_CLASSIFICATION'

A constant which can be used with the model_type property of a ModelDetails. This constant has a value of “PRE_TRAINED_TEXT_CLASSIFICATION”

MODEL_TYPE_PRE_TRAINED_TRANSLATION = 'PRE_TRAINED_TRANSLATION'

A constant which can be used with the model_type property of a ModelDetails. This constant has a value of “PRE_TRAINED_TRANSLATION”

MODEL_TYPE_PRE_TRAINED_UNIVERSAL = 'PRE_TRAINED_UNIVERSAL'

A constant which can be used with the model_type property of a ModelDetails. This constant has a value of “PRE_TRAINED_UNIVERSAL”

MODEL_TYPE_TEXT_CLASSIFICATION = 'TEXT_CLASSIFICATION'

A constant which can be used with the model_type property of a ModelDetails. This constant has a value of “TEXT_CLASSIFICATION”

__init__(**kwargs)

Initializes a new TextClassificationModelDetails object with values from keyword arguments. The default value of the model_type attribute of this class is TEXT_CLASSIFICATION and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters
  • language_code (str) – The value to assign to the language_code property of this TextClassificationModelDetails.

  • model_type (str) – The value to assign to the model_type property of this TextClassificationModelDetails. Allowed values for this property are: “NAMED_ENTITY_RECOGNITION”, “TEXT_CLASSIFICATION”, “PRE_TRAINED_NAMED_ENTITY_RECOGNITION”, “PRE_TRAINED_TEXT_CLASSIFICATION”, “PRE_TRAINED_SENTIMENT_ANALYSIS”, “PRE_TRAINED_KEYPHRASE_EXTRACTION”, “PRE_TRAINED_LANGUAGE_DETECTION”, “PRE_TRAINED_PII”, “PRE_TRAINED_HEALTH_NLU”, “PRE_TRAINED_SUMMARIZATION”, “PRE_TRAINED_UNIVERSAL”, “PII”, “PRE_TRAINED_TRANSLATION”, “HEALTH_NLU”

  • classification_mode (oci.ai_language.models.ClassificationType) – The value to assign to the classification_mode property of this TextClassificationModelDetails.

property classification_mode

Gets the classification_mode of this TextClassificationModelDetails.

Returns

The classification_mode of this TextClassificationModelDetails.

Return type

oci.ai_language.models.ClassificationType

static get_subtype(object_dictionary)

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

property language_code

Gets the language_code of this ModelDetails. supported language default value is en

Returns

The language_code of this ModelDetails.

Return type

str

property model_type

[Required] Gets the model_type of this ModelDetails. Model type

Allowed values for this property are: “NAMED_ENTITY_RECOGNITION”, “TEXT_CLASSIFICATION”, “PRE_TRAINED_NAMED_ENTITY_RECOGNITION”, “PRE_TRAINED_TEXT_CLASSIFICATION”, “PRE_TRAINED_SENTIMENT_ANALYSIS”, “PRE_TRAINED_KEYPHRASE_EXTRACTION”, “PRE_TRAINED_LANGUAGE_DETECTION”, “PRE_TRAINED_PII”, “PRE_TRAINED_HEALTH_NLU”, “PRE_TRAINED_SUMMARIZATION”, “PRE_TRAINED_UNIVERSAL”, “PII”, “PRE_TRAINED_TRANSLATION”, “HEALTH_NLU”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The model_type of this ModelDetails.

Return type

str