ModelSummary¶
- class oci.ai_language.models.ModelSummary(**kwargs)¶
Bases:
objectSummary of the language Model.
Methods:
__init__(**kwargs)Initializes a new ModelSummary object with values from keyword arguments.
Attributes:
[Required] Gets the compartment_id of this ModelSummary.
Gets the defined_tags of this ModelSummary.
Gets the description of this ModelSummary.
[Required] Gets the display_name of this ModelSummary.
Gets the freeform_tags of this ModelSummary.
[Required] Gets the id of this ModelSummary.
Gets the lifecycle_details of this ModelSummary.
[Required] Gets the lifecycle_state of this ModelSummary.
[Required] Gets the model_details of this ModelSummary.
[Required] Gets the project_id of this ModelSummary.
Gets the system_tags of this ModelSummary.
[Required] Gets the time_created of this ModelSummary.
Gets the version of this ModelSummary.
- __init__(**kwargs)¶
Initializes a new ModelSummary 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 ModelSummary.
display_name (str) – The value to assign to the display_name property of this ModelSummary.
compartment_id (str) – The value to assign to the compartment_id property of this ModelSummary.
description (str) – The value to assign to the description property of this ModelSummary.
model_details (oci.ai_language.models.ModelDetails) – The value to assign to the model_details property of this ModelSummary.
time_created (datetime) – The value to assign to the time_created property of this ModelSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this ModelSummary.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this ModelSummary.
project_id (str) – The value to assign to the project_id property of this ModelSummary.
version (str) – The value to assign to the version property of this ModelSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this ModelSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ModelSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this ModelSummary.
- property compartment_id¶
[Required] Gets the compartment_id of this ModelSummary. The OCID for the model’s compartment.
- Returns
The compartment_id of this ModelSummary.
- Return type
str
- property defined_tags¶
Gets the defined_tags of this ModelSummary. 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 ModelSummary.
- Return type
dict(str, dict(str, object))
- property description¶
Gets the description of this ModelSummary. A short description of the Model.
- Returns
The description of this ModelSummary.
- Return type
str
- property display_name¶
[Required] Gets the display_name of this ModelSummary. 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 ModelSummary.
- Return type
str
- property freeform_tags¶
Gets the freeform_tags of this ModelSummary. 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 ModelSummary.
- Return type
dict(str, str)
- property id¶
[Required] Gets the id of this ModelSummary. Unique identifier model OCID of a model that is immutable on creation
- Returns
The id of this ModelSummary.
- Return type
str
- property lifecycle_details¶
Gets the lifecycle_details of this ModelSummary. 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 ModelSummary.
- Return type
str
- property lifecycle_state¶
[Required] Gets the lifecycle_state of this ModelSummary. The state of the model.
- Returns
The lifecycle_state of this ModelSummary.
- Return type
str
- property model_details¶
[Required] Gets the model_details of this ModelSummary.
- Returns
The model_details of this ModelSummary.
- Return type
- property project_id¶
[Required] Gets the project_id of this ModelSummary. The OCID of the project to associate with the model.
- Returns
The project_id of this ModelSummary.
- Return type
str
- property system_tags¶
Gets the system_tags of this ModelSummary. 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 ModelSummary.
- Return type
dict(str, dict(str, object))
- property time_created¶
[Required] Gets the time_created of this ModelSummary. The time the the Model was created. An RFC3339 formatted datetime string.
- Returns
The time_created of this ModelSummary.
- Return type
datetime
- property version¶
Gets the version of this ModelSummary. 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 ModelSummary.
- Return type
str