ModelSummary¶

class oci.generative_ai.models.ModelSummary(**kwargs)¶

Bases: object

Summary of the model.

Attributes

`CAPABILITIES_CHAT`	A constant which can be used with the capabilities property of a ModelSummary.
`CAPABILITIES_FINE_TUNE`	A constant which can be used with the capabilities property of a ModelSummary.
`CAPABILITIES_TEXT_EMBEDDINGS`	A constant which can be used with the capabilities property of a ModelSummary.
`CAPABILITIES_TEXT_GENERATION`	A constant which can be used with the capabilities property of a ModelSummary.
`CAPABILITIES_TEXT_RERANK`	A constant which can be used with the capabilities property of a ModelSummary.
`CAPABILITIES_TEXT_SUMMARIZATION`	A constant which can be used with the capabilities property of a ModelSummary.
`base_model_id`	Gets the base_model_id of this ModelSummary.
`capabilities`	[Required] Gets the capabilities of this ModelSummary.
`compartment_id`	[Required] Gets the compartment_id of this ModelSummary.
`defined_tags`	Gets the defined_tags of this ModelSummary.
`display_name`	Gets the display_name of this ModelSummary.
`fine_tune_details`	Gets the fine_tune_details of this ModelSummary.
`freeform_tags`	Gets the freeform_tags of this ModelSummary.
`id`	[Required] Gets the id of this ModelSummary.
`is_long_term_supported`	Gets the is_long_term_supported of this ModelSummary.
`lifecycle_details`	Gets the lifecycle_details of this ModelSummary.
`lifecycle_state`	[Required] Gets the lifecycle_state of this ModelSummary.
`model_metrics`	Gets the model_metrics of this ModelSummary.
`system_tags`	Gets the system_tags of this ModelSummary.
`time_created`	[Required] Gets the time_created of this ModelSummary.
`time_dedicated_retired`	Gets the time_dedicated_retired of this ModelSummary.
`time_deprecated`	Gets the time_deprecated of this ModelSummary.
`time_on_demand_retired`	Gets the time_on_demand_retired of this ModelSummary.
`type`	[Required] Gets the type of this ModelSummary.
`vendor`	Gets the vendor of this ModelSummary.
`version`	Gets the version of this ModelSummary.

Methods

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

CAPABILITIES_CHAT = 'CHAT'¶: A constant which can be used with the capabilities property of a ModelSummary. This constant has a value of “CHAT”

CAPABILITIES_FINE_TUNE = 'FINE_TUNE'¶: A constant which can be used with the capabilities property of a ModelSummary. This constant has a value of “FINE_TUNE”

CAPABILITIES_TEXT_EMBEDDINGS = 'TEXT_EMBEDDINGS'¶: A constant which can be used with the capabilities property of a ModelSummary. This constant has a value of “TEXT_EMBEDDINGS”

CAPABILITIES_TEXT_GENERATION = 'TEXT_GENERATION'¶: A constant which can be used with the capabilities property of a ModelSummary. This constant has a value of “TEXT_GENERATION”

CAPABILITIES_TEXT_RERANK = 'TEXT_RERANK'¶: A constant which can be used with the capabilities property of a ModelSummary. This constant has a value of “TEXT_RERANK”

CAPABILITIES_TEXT_SUMMARIZATION = 'TEXT_SUMMARIZATION'¶: A constant which can be used with the capabilities property of a ModelSummary. This constant has a value of “TEXT_SUMMARIZATION”

__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.
compartment_id (str) – The value to assign to the compartment_id property of this ModelSummary.
capabilities (list[str]) – The value to assign to the capabilities property of this ModelSummary. Allowed values for items in this list are: “TEXT_GENERATION”, “TEXT_SUMMARIZATION”, “TEXT_EMBEDDINGS”, “FINE_TUNE”, “CHAT”, “TEXT_RERANK”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
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.
display_name (str) – The value to assign to the display_name property of this ModelSummary.
vendor (str) – The value to assign to the vendor property of this ModelSummary.
version (str) – The value to assign to the version property of this ModelSummary.
time_created (datetime) – The value to assign to the time_created property of this ModelSummary.
base_model_id (str) – The value to assign to the base_model_id property of this ModelSummary.
type (str) – The value to assign to the type property of this ModelSummary.
fine_tune_details (oci.generative_ai.models.FineTuneDetails) – The value to assign to the fine_tune_details property of this ModelSummary.
model_metrics (oci.generative_ai.models.ModelMetrics) – The value to assign to the model_metrics property of this ModelSummary.
is_long_term_supported (bool) – The value to assign to the is_long_term_supported property of this ModelSummary.
time_deprecated (datetime) – The value to assign to the time_deprecated property of this ModelSummary.
time_on_demand_retired (datetime) – The value to assign to the time_on_demand_retired property of this ModelSummary.
time_dedicated_retired (datetime) – The value to assign to the time_dedicated_retired 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.

base_model_id¶

Gets the base_model_id of this ModelSummary. The OCID of the base model that’s used for fine-tuning. For pretrained models, the value is null.

Returns:	The base_model_id of this ModelSummary.
Return type:	str

capabilities¶

[Required] Gets the capabilities of this ModelSummary. Describes what this model can be used for.

Allowed values for items in this list are: “TEXT_GENERATION”, “TEXT_SUMMARIZATION”, “TEXT_EMBEDDINGS”, “FINE_TUNE”, “CHAT”, “TEXT_RERANK”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The capabilities of this ModelSummary.
Return type:	list[str]

compartment_id¶

[Required] Gets the compartment_id of this ModelSummary. The compartment OCID for fine-tuned models. For pretrained models, this value is null.

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

defined_tags¶

Gets the defined_tags of this ModelSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {“Operations”: {“CostCenter”: “42”}}

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

display_name¶

Gets the display_name of this ModelSummary. A user-friendly name.

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

fine_tune_details¶

Gets the fine_tune_details of this ModelSummary.

Returns:	The fine_tune_details of this ModelSummary.
Return type:	oci.generative_ai.models.FineTuneDetails

freeform_tags¶

Gets the freeform_tags of this ModelSummary. Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {“Department”: “Finance”}

Returns:	The freeform_tags of this ModelSummary.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this ModelSummary. An ID that uniquely identifies a pretrained or a fine-tuned model.

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

is_long_term_supported¶

Gets the is_long_term_supported of this ModelSummary. Whether a model is supported long-term. Applies only to base models.

Returns:	The is_long_term_supported of this ModelSummary.
Return type:	bool

lifecycle_details¶

Gets the lifecycle_details of this ModelSummary. A message describing the current state of the model with detail that can provide actionable information.

Returns:	The lifecycle_details of this ModelSummary.
Return type:	str

lifecycle_state¶

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

Allowed values are: - ACTIVE - CREATING - DELETING - DELETED - FAILED

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

model_metrics¶

Gets the model_metrics of this ModelSummary.

Returns:	The model_metrics of this ModelSummary.
Return type:	oci.generative_ai.models.ModelMetrics

system_tags¶

Gets the system_tags of this ModelSummary. System tags for this resource. Each key is predefined and scoped to a namespace.

Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns:	The system_tags of this ModelSummary.
Return type:	dict(str, dict(str, object))

time_created¶

[Required] Gets the time_created of this ModelSummary. The date and time that the model was created in the format of an RFC3339 datetime string.

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

time_dedicated_retired¶

Gets the time_dedicated_retired of this ModelSummary. The timestamp indicating when the custom model and its associated foundation model will be fully retired.

Returns:	The time_dedicated_retired of this ModelSummary.
Return type:	datetime

time_deprecated¶

Gets the time_deprecated of this ModelSummary. Corresponds to the time when the custom model and its associated foundation model will be deprecated.

Returns:	The time_deprecated of this ModelSummary.
Return type:	datetime

time_on_demand_retired¶

Gets the time_on_demand_retired of this ModelSummary. The timestamp indicating when the base model will no longer be available for on-demand usage.

Returns:	The time_on_demand_retired of this ModelSummary.
Return type:	datetime

type¶

[Required] Gets the type of this ModelSummary. The model type indicating whether this is a pretrained/base model or a custom/fine-tuned model.

Allowed values are: - BASE - CUSTOM

Returns:	The type of this ModelSummary.
Return type:	str

vendor¶

Gets the vendor of this ModelSummary. The provider of the model.

Returns:	The vendor of this ModelSummary.
Return type:	str

version¶

Gets the version of this ModelSummary. The version of the model.

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