EntityListDataset

class oci.ai_speech.models.EntityListDataset(**kwargs)

Bases: CustomizationDatasetDetails

Entity List Dataset

Attributes:

DATASET_TYPE_ENTITY_LIST

A constant which can be used with the dataset_type property of a CustomizationDatasetDetails.

DATASET_TYPE_OBJECT_STORAGE

A constant which can be used with the dataset_type property of a CustomizationDatasetDetails.

dataset_type

[Required] Gets the dataset_type of this CustomizationDatasetDetails.

entity_list

Gets the entity_list of this EntityListDataset.

reference_examples

Gets the reference_examples of this EntityListDataset.

Methods:

__init__(**kwargs)

Initializes a new EntityListDataset 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.

DATASET_TYPE_ENTITY_LIST = 'ENTITY_LIST'

A constant which can be used with the dataset_type property of a CustomizationDatasetDetails. This constant has a value of “ENTITY_LIST”

DATASET_TYPE_OBJECT_STORAGE = 'OBJECT_STORAGE'

A constant which can be used with the dataset_type property of a CustomizationDatasetDetails. This constant has a value of “OBJECT_STORAGE”

__init__(**kwargs)

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

Parameters
  • dataset_type (str) – The value to assign to the dataset_type property of this EntityListDataset. Allowed values for this property are: “OBJECT_STORAGE”, “ENTITY_LIST”

  • reference_examples (list[str]) – The value to assign to the reference_examples property of this EntityListDataset.

  • entity_list (list[oci.ai_speech.models.EntityList]) – The value to assign to the entity_list property of this EntityListDataset.

property dataset_type

[Required] Gets the dataset_type of this CustomizationDatasetDetails. Possible data sets

Allowed values for this property are: “OBJECT_STORAGE”, “ENTITY_LIST”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The dataset_type of this CustomizationDatasetDetails.

Return type

str

property entity_list

Gets the entity_list of this EntityListDataset. Array of entityLists

Returns

The entity_list of this EntityListDataset.

Return type

list[oci.ai_speech.models.EntityList]

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 reference_examples

Gets the reference_examples of this EntityListDataset. List of sentences referencing 1 or more entityType matching those defined in the linked entityLists, used to improve accuracy by providing model training context of where/how an entity may appear in a sentence. EntityTypes referenced in sentences should be written in all caps surrounded by angled braces (i.e “<PATIENT>” if entityType=patient)

Returns

The reference_examples of this EntityListDataset.

Return type

list[str]