Customization

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

Bases: object

Description of a Customization.

Attributes:

LIFECYCLE_STATE_ACTIVE

A constant which can be used with the lifecycle_state property of a Customization.

LIFECYCLE_STATE_CREATING

A constant which can be used with the lifecycle_state property of a Customization.

LIFECYCLE_STATE_DELETED

A constant which can be used with the lifecycle_state property of a Customization.

LIFECYCLE_STATE_DELETING

A constant which can be used with the lifecycle_state property of a Customization.

LIFECYCLE_STATE_FAILED

A constant which can be used with the lifecycle_state property of a Customization.

LIFECYCLE_STATE_UPDATING

A constant which can be used with the lifecycle_state property of a Customization.

alias

Gets the alias of this Customization.

compartment_id

[Required] Gets the compartment_id of this Customization.

defined_tags

Gets the defined_tags of this Customization.

description

Gets the description of this Customization.

display_name

Gets the display_name of this Customization.

entities

Gets the entities of this Customization.

freeform_tags

Gets the freeform_tags of this Customization.

id

[Required] Gets the id of this Customization.

lifecycle_details

Gets the lifecycle_details of this Customization.

lifecycle_state

Gets the lifecycle_state of this Customization.

model_details

[Required] Gets the model_details of this Customization.

system_tags

Gets the system_tags of this Customization.

time_created

Gets the time_created of this Customization.

time_updated

Gets the time_updated of this Customization.

training_dataset

Gets the training_dataset of this Customization.

Methods:

__init__(**kwargs)

Initializes a new Customization object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a Customization. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'

A constant which can be used with the lifecycle_state property of a Customization. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'

A constant which can be used with the lifecycle_state property of a Customization. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'

A constant which can be used with the lifecycle_state property of a Customization. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'

A constant which can be used with the lifecycle_state property of a Customization. This constant has a value of “FAILED”

LIFECYCLE_STATE_UPDATING = 'UPDATING'

A constant which can be used with the lifecycle_state property of a Customization. This constant has a value of “UPDATING”

__init__(**kwargs)

Initializes a new Customization object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters
  • id (str) – The value to assign to the id property of this Customization.

  • display_name (str) – The value to assign to the display_name property of this Customization.

  • compartment_id (str) – The value to assign to the compartment_id property of this Customization.

  • alias (str) – The value to assign to the alias property of this Customization.

  • description (str) – The value to assign to the description property of this Customization.

  • model_details (oci.ai_speech.models.CustomizationModelDetails) – The value to assign to the model_details property of this Customization.

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this Customization. Allowed values for this property are: “DELETING”, “DELETED”, “FAILED”, “UPDATING”, “ACTIVE”, “CREATING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • lifecycle_details (str) – The value to assign to the lifecycle_details property of this Customization.

  • time_created (datetime) – The value to assign to the time_created property of this Customization.

  • time_updated (datetime) – The value to assign to the time_updated property of this Customization.

  • training_dataset (oci.ai_speech.models.CustomizationDatasetDetails) – The value to assign to the training_dataset property of this Customization.

  • entities (list[oci.ai_speech.models.CustomizationReferencedEntities]) – The value to assign to the entities property of this Customization.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this Customization.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this Customization.

  • system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this Customization.

property alias

Gets the alias of this Customization. Customization Details Alias

Returns

The alias of this Customization.

Return type

str

property compartment_id

[Required] Gets the compartment_id of this Customization. The OCID of the compartment where you want to create the job.

Returns

The compartment_id of this Customization.

Return type

str

property defined_tags

Gets the defined_tags of this Customization. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace-1”: {“bar-key-1”: “value-1”, “bar-key-2”: “value-2”}, “foo-namespace-2”: {“bar-key-1”: “value-1”, “bar-key-2”: “value-2”}}.

Returns

The defined_tags of this Customization.

Return type

dict(str, dict(str, object))

property description

Gets the description of this Customization. A short description of the job.

Returns

The description of this Customization.

Return type

str

property display_name

Gets the display_name of this Customization. A user-friendly display name for the job.

Returns

The display_name of this Customization.

Return type

str

property entities

Gets the entities of this Customization. array of referenced entities

Returns

The entities of this Customization.

Return type

list[oci.ai_speech.models.CustomizationReferencedEntities]

property freeform_tags

Gets the freeform_tags of this Customization. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}.

Returns

The freeform_tags of this Customization.

Return type

dict(str, str)

property id

[Required] Gets the id of this Customization. The OCID of the job.

Returns

The id of this Customization.

Return type

str

property lifecycle_details

Gets the lifecycle_details of this Customization. A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

Returns

The lifecycle_details of this Customization.

Return type

str

property lifecycle_state

Gets the lifecycle_state of this Customization. The current state of the Job.

Allowed values for this property are: “DELETING”, “DELETED”, “FAILED”, “UPDATING”, “ACTIVE”, “CREATING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The lifecycle_state of this Customization.

Return type

str

property model_details

[Required] Gets the model_details of this Customization.

Returns

The model_details of this Customization.

Return type

oci.ai_speech.models.CustomizationModelDetails

property system_tags

Gets the system_tags of this Customization. Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}.

Returns

The system_tags of this Customization.

Return type

dict(str, dict(str, object))

property time_created

Gets the time_created of this Customization. Customization Created time. An RFC3339 formatted datetime string.

Returns

The time_created of this Customization.

Return type

datetime

property time_updated

Gets the time_updated of this Customization. Customization Updated time. An RFC3339 formatted datetime string.

Returns

The time_updated of this Customization.

Return type

datetime

property training_dataset

Gets the training_dataset of this Customization.

Returns

The training_dataset of this Customization.

Return type

oci.ai_speech.models.CustomizationDatasetDetails