ImportedModel¶

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

Bases: object

Represents a model imported into the system based on an external data source, such as Hugging Face or Object Storage.

To use any of the API operations, you must be authorized in an IAM policy. If you’re not authorized, talk to an administrator who gives OCI resource access to users. See Getting Started with Policies and Getting Access to Generative AI Resources.

Attributes

`CAPABILITIES_EMBEDDING`	A constant which can be used with the capabilities property of a ImportedModel.
`CAPABILITIES_IMAGE_TEXT_TO_TEXT`	A constant which can be used with the capabilities property of a ImportedModel.
`CAPABILITIES_RERANK`	A constant which can be used with the capabilities property of a ImportedModel.
`CAPABILITIES_TEXT_TO_TEXT`	A constant which can be used with the capabilities property of a ImportedModel.
`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a ImportedModel.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a ImportedModel.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a ImportedModel.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a ImportedModel.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a ImportedModel.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a ImportedModel.
`capabilities`	Gets the capabilities of this ImportedModel.
`compartment_id`	[Required] Gets the compartment_id of this ImportedModel.
`data_source`	[Required] Gets the data_source of this ImportedModel.
`defined_tags`	Gets the defined_tags of this ImportedModel.
`description`	Gets the description of this ImportedModel.
`display_name`	Gets the display_name of this ImportedModel.
`freeform_tags`	Gets the freeform_tags of this ImportedModel.
`id`	[Required] Gets the id of this ImportedModel.
`lifecycle_details`	Gets the lifecycle_details of this ImportedModel.
`lifecycle_state`	[Required] Gets the lifecycle_state of this ImportedModel.
`previous_state`	Gets the previous_state of this ImportedModel.
`system_tags`	Gets the system_tags of this ImportedModel.
`time_created`	[Required] Gets the time_created of this ImportedModel.
`time_updated`	Gets the time_updated of this ImportedModel.
`vendor`	Gets the vendor of this ImportedModel.
`version`	Gets the version of this ImportedModel.

Methods

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

CAPABILITIES_EMBEDDING = 'EMBEDDING'¶: A constant which can be used with the capabilities property of a ImportedModel. This constant has a value of “EMBEDDING”

CAPABILITIES_IMAGE_TEXT_TO_TEXT = 'IMAGE_TEXT_TO_TEXT'¶: A constant which can be used with the capabilities property of a ImportedModel. This constant has a value of “IMAGE_TEXT_TO_TEXT”

CAPABILITIES_RERANK = 'RERANK'¶: A constant which can be used with the capabilities property of a ImportedModel. This constant has a value of “RERANK”

CAPABILITIES_TEXT_TO_TEXT = 'TEXT_TO_TEXT'¶: A constant which can be used with the capabilities property of a ImportedModel. This constant has a value of “TEXT_TO_TEXT”

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

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

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

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

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

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

__init__(**kwargs)¶

Initializes a new ImportedModel 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 ImportedModel.
display_name (str) – The value to assign to the display_name property of this ImportedModel.
description (str) – The value to assign to the description property of this ImportedModel.
compartment_id (str) – The value to assign to the compartment_id property of this ImportedModel.
capabilities (list[str]) – The value to assign to the capabilities property of this ImportedModel. Allowed values for items in this list are: “TEXT_TO_TEXT”, “IMAGE_TEXT_TO_TEXT”, “EMBEDDING”, “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 ImportedModel. Allowed values for this property are: “ACTIVE”, “CREATING”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, ‘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 ImportedModel.
vendor (str) – The value to assign to the vendor property of this ImportedModel.
version (str) – The value to assign to the version property of this ImportedModel.
data_source (oci.generative_ai.models.ModelDataSource) – The value to assign to the data_source property of this ImportedModel.
time_created (datetime) – The value to assign to the time_created property of this ImportedModel.
time_updated (datetime) – The value to assign to the time_updated property of this ImportedModel.
previous_state (oci.generative_ai.models.ImportedModel) – The value to assign to the previous_state property of this ImportedModel.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this ImportedModel.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ImportedModel.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this ImportedModel.

capabilities¶

Gets the capabilities of this ImportedModel. Specifies the intended use or supported capabilities of the imported model.

Allowed values for items in this list are: “TEXT_TO_TEXT”, “IMAGE_TEXT_TO_TEXT”, “EMBEDDING”, “RERANK”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

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

compartment_id¶

[Required] Gets the compartment_id of this ImportedModel. The compartment OCID from which the model is imported.

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

data_source¶

[Required] Gets the data_source of this ImportedModel.

Returns:	The data_source of this ImportedModel.
Return type:	oci.generative_ai.models.ModelDataSource

defined_tags¶

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

description¶

Gets the description of this ImportedModel. An optional description of the imported model.

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

display_name¶

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

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

freeform_tags¶

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

id¶

[Required] Gets the id of this ImportedModel. An OCID that uniquely identifies an imported model.

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

lifecycle_details¶

Gets the lifecycle_details of this ImportedModel. Additional information about the current state of the imported model, providing more detailed and actionable context.

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

lifecycle_state¶

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

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

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

previous_state¶

Gets the previous_state of this ImportedModel.

Returns:	The previous_state of this ImportedModel.
Return type:	oci.generative_ai.models.ImportedModel

system_tags¶

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

time_created¶

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

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

time_updated¶

Gets the time_updated of this ImportedModel. The date and time that the imported model was updated in the format of an RFC3339 datetime string.

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

vendor¶

Gets the vendor of this ImportedModel. The provider of the imported model.

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

version¶

Gets the version of this ImportedModel. The version of the imported model.

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