Model¶

class oci.ai_language.models.Model(**kwargs)¶

Bases: object

Description of the a Model.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a Model.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a Model.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a Model.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a Model.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a Model.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a Model.
`compartment_id`	[Required] Gets the compartment_id of this Model.
`defined_tags`	Gets the defined_tags of this Model.
`description`	Gets the description of this Model.
`display_name`	[Required] Gets the display_name of this Model.
`evaluation_results`	Gets the evaluation_results of this Model.
`freeform_tags`	Gets the freeform_tags of this Model.
`id`	[Required] Gets the id of this Model.
`lifecycle_details`	Gets the lifecycle_details of this Model.
`lifecycle_state`	[Required] Gets the lifecycle_state of this Model.
`model_details`	[Required] Gets the model_details of this Model.
`project_id`	[Required] Gets the project_id of this Model.
`system_tags`	Gets the system_tags of this Model.
`test_strategy`	Gets the test_strategy of this Model.
`time_created`	[Required] Gets the time_created of this Model.
`time_updated`	Gets the time_updated of this Model.
`training_dataset`	Gets the training_dataset of this Model.
`version`	Gets the version of this Model.

Methods

__init__(**kwargs) Initializes a new Model object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a Model. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a Model. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a Model. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a Model. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a Model. This constant has a value of “FAILED”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a Model. This constant has a value of “UPDATING”

__init__(**kwargs)¶

Initializes a new Model 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 Model.
display_name (str) – The value to assign to the display_name property of this Model.
compartment_id (str) – The value to assign to the compartment_id property of this Model.
project_id (str) – The value to assign to the project_id property of this Model.
description (str) – The value to assign to the description property of this Model.
model_details (oci.ai_language.models.ModelDetails) – The value to assign to the model_details property of this Model.
time_created (datetime) – The value to assign to the time_created property of this Model.
time_updated (datetime) – The value to assign to the time_updated property of this Model.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this Model. Allowed values for this property are: “DELETING”, “DELETED”, “FAILED”, “CREATING”, “ACTIVE”, “UPDATING”, ‘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 Model.
training_dataset (oci.ai_language.models.DatasetDetails) – The value to assign to the training_dataset property of this Model.
evaluation_results (oci.ai_language.models.EvaluationResults) – The value to assign to the evaluation_results property of this Model.
test_strategy (oci.ai_language.models.TestStrategy) – The value to assign to the test_strategy property of this Model.
version (str) – The value to assign to the version property of this Model.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this Model.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this Model.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this Model.

compartment_id¶

[Required] Gets the compartment_id of this Model. The OCID for the model’s compartment.

Returns:	The compartment_id of this Model.
Return type:	str

defined_tags¶

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

Returns:	The defined_tags of this Model.
Return type:	dict(str, dict(str, object))

description¶

Gets the description of this Model. A short description of the Model.

Returns:	The description of this Model.
Return type:	str

display_name¶

[Required] Gets the display_name of this Model. A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.

Returns:	The display_name of this Model.
Return type:	str

evaluation_results¶

Gets the evaluation_results of this Model.

Returns:	The evaluation_results of this Model.
Return type:	oci.ai_language.models.EvaluationResults

freeform_tags¶

Gets the freeform_tags of this Model. 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 Model.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this Model. Unique identifier model OCID of a model that is immutable on creation

Returns:	The id of this Model.
Return type:	str

lifecycle_details¶

Gets the lifecycle_details of this Model. 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 Model.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this Model. The state of the model.

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

Returns:	The lifecycle_state of this Model.
Return type:	str

model_details¶

[Required] Gets the model_details of this Model.

Returns:	The model_details of this Model.
Return type:	oci.ai_language.models.ModelDetails

project_id¶

[Required] Gets the project_id of this Model. The OCID of the project to associate with the model.

Returns:	The project_id of this Model.
Return type:	str

system_tags¶

Gets the system_tags of this Model. 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 Model.
Return type:	dict(str, dict(str, object))

test_strategy¶

Gets the test_strategy of this Model.

Returns:	The test_strategy of this Model.
Return type:	oci.ai_language.models.TestStrategy

time_created¶

[Required] Gets the time_created of this Model. The time the the model was created. An RFC3339 formatted datetime string.

Returns:	The time_created of this Model.
Return type:	datetime

time_updated¶

Gets the time_updated of this Model. The time the model was updated. An RFC3339 formatted datetime string.

Returns:	The time_updated of this Model.
Return type:	datetime

training_dataset¶

Gets the training_dataset of this Model.

Returns:	The training_dataset of this Model.
Return type:	oci.ai_language.models.DatasetDetails

version¶

Gets the version of this Model. For pre trained models this will identify model type version used for model creation For custom this will identify model type version used for model creation and custom model on which training has to be done <<service>>::<<service-name>>_<<model-type-version>>::<<custom model on which this training has to be done>> ex: ai-lang::NER_V1::CUSTOM-V0

Returns:	The version of this Model.
Return type:	str