CreateImportedModelDetails¶

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

Bases: object

The data to import a model.

Attributes

`CAPABILITIES_EMBEDDING`	A constant which can be used with the capabilities property of a CreateImportedModelDetails.
`CAPABILITIES_IMAGE_TEXT_TO_TEXT`	A constant which can be used with the capabilities property of a CreateImportedModelDetails.
`CAPABILITIES_RERANK`	A constant which can be used with the capabilities property of a CreateImportedModelDetails.
`CAPABILITIES_TEXT_TO_TEXT`	A constant which can be used with the capabilities property of a CreateImportedModelDetails.
`capabilities`	Gets the capabilities of this CreateImportedModelDetails.
`compartment_id`	[Required] Gets the compartment_id of this CreateImportedModelDetails.
`data_source`	[Required] Gets the data_source of this CreateImportedModelDetails.
`defined_tags`	Gets the defined_tags of this CreateImportedModelDetails.
`description`	Gets the description of this CreateImportedModelDetails.
`display_name`	Gets the display_name of this CreateImportedModelDetails.
`freeform_tags`	Gets the freeform_tags of this CreateImportedModelDetails.
`vendor`	Gets the vendor of this CreateImportedModelDetails.
`version`	Gets the version of this CreateImportedModelDetails.

Methods

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

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

__init__(**kwargs)¶

Initializes a new CreateImportedModelDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

display_name (str) – The value to assign to the display_name property of this CreateImportedModelDetails.
description (str) – The value to assign to the description property of this CreateImportedModelDetails.
compartment_id (str) – The value to assign to the compartment_id property of this CreateImportedModelDetails.
vendor (str) – The value to assign to the vendor property of this CreateImportedModelDetails.
version (str) – The value to assign to the version property of this CreateImportedModelDetails.
data_source (oci.generative_ai.models.ModelDataSource) – The value to assign to the data_source property of this CreateImportedModelDetails.
capabilities (list[str]) – The value to assign to the capabilities property of this CreateImportedModelDetails. Allowed values for items in this list are: “TEXT_TO_TEXT”, “IMAGE_TEXT_TO_TEXT”, “EMBEDDING”, “RERANK”
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateImportedModelDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateImportedModelDetails.

capabilities¶

Gets the capabilities of this CreateImportedModelDetails. 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”

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

compartment_id¶

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

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

data_source¶

[Required] Gets the data_source of this CreateImportedModelDetails.

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

defined_tags¶

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

description¶

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

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

display_name¶

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

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

freeform_tags¶

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

vendor¶

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

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

version¶

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

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