ImportedModelSummary¶

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

Bases: object

Summary of the importedModel.

Attributes

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

Methods

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

CAPABILITIES_EMBEDDING = 'EMBEDDING'¶: A constant which can be used with the capabilities property of a ImportedModelSummary. 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 ImportedModelSummary. 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 ImportedModelSummary. 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 ImportedModelSummary. This constant has a value of “TEXT_TO_TEXT”

__init__(**kwargs)¶

Initializes a new ImportedModelSummary 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 ImportedModelSummary.
display_name (str) – The value to assign to the display_name property of this ImportedModelSummary.
description (str) – The value to assign to the description property of this ImportedModelSummary.
compartment_id (str) – The value to assign to the compartment_id property of this ImportedModelSummary.
capabilities (list[str]) – The value to assign to the capabilities property of this ImportedModelSummary. 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 ImportedModelSummary.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this ImportedModelSummary.
vendor (str) – The value to assign to the vendor property of this ImportedModelSummary.
version (str) – The value to assign to the version property of this ImportedModelSummary.
data_source (oci.generative_ai.models.ModelDataSource) – The value to assign to the data_source property of this ImportedModelSummary.
time_created (datetime) – The value to assign to the time_created property of this ImportedModelSummary.
time_updated (datetime) – The value to assign to the time_updated property of this ImportedModelSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this ImportedModelSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ImportedModelSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this ImportedModelSummary.

capabilities¶

Gets the capabilities of this ImportedModelSummary. 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 ImportedModelSummary.
Return type:	list[str]

compartment_id¶

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

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

data_source¶

[Required] Gets the data_source of this ImportedModelSummary.

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

defined_tags¶

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

description¶

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

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

display_name¶

Gets the display_name of this ImportedModelSummary. A user-friendly name of the imported model.

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

freeform_tags¶

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

id¶

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

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

lifecycle_details¶

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

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

lifecycle_state¶

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

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

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

system_tags¶

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

time_created¶

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

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

time_updated¶

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

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

vendor¶

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

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

version¶

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

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