ModelDiscovery¶

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

Bases: object

Metadata describing a specific model

Attributes

`MODEL_ACCESS_HOSTED`	A constant which can be used with the model_access property of a ModelDiscovery.
`MODEL_ACCESS_PROXY`	A constant which can be used with the model_access property of a ModelDiscovery.
`api_capability`	Gets the api_capability of this ModelDiscovery.
`availability`	Gets the availability of this ModelDiscovery.
`capabilities`	[Required] Gets the capabilities of this ModelDiscovery.
`modality_support`	Gets the modality_support of this ModelDiscovery.
`model_access`	Gets the model_access of this ModelDiscovery.
`model_id`	[Required] Gets the model_id of this ModelDiscovery.
`parameters`	Gets the parameters of this ModelDiscovery.
`vendor`	[Required] Gets the vendor of this ModelDiscovery.

Methods

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

MODEL_ACCESS_HOSTED = 'HOSTED'¶: A constant which can be used with the model_access property of a ModelDiscovery. This constant has a value of “HOSTED”

MODEL_ACCESS_PROXY = 'PROXY'¶: A constant which can be used with the model_access property of a ModelDiscovery. This constant has a value of “PROXY”

__init__(**kwargs)¶

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

Parameters:

model_id (str) – The value to assign to the model_id property of this ModelDiscovery.
vendor (str) – The value to assign to the vendor property of this ModelDiscovery.
capabilities (list[oci.generative_ai.models.ModelCapability]) – The value to assign to the capabilities property of this ModelDiscovery.
api_capability (list[str]) – The value to assign to the api_capability property of this ModelDiscovery.
modality_support (list[oci.generative_ai.models.ModelModalitySupport]) – The value to assign to the modality_support property of this ModelDiscovery.
model_access (str) – The value to assign to the model_access property of this ModelDiscovery. Allowed values for this property are: “HOSTED”, “PROXY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
parameters (list[oci.generative_ai.models.Parameter]) – The value to assign to the parameters property of this ModelDiscovery.
availability (list[oci.generative_ai.models.Availability]) – The value to assign to the availability property of this ModelDiscovery.

api_capability¶

Gets the api_capability of this ModelDiscovery. The specific API endpoints that this model supports. For example, a chat model may support OPENAI_V1_CHAT_COMPLETIONS and/or OPENAI_V1_RESPONSES. If empty, the model has not yet been annotated with API capabilities.

Returns:	The api_capability of this ModelDiscovery.
Return type:	list[str]

availability¶

Gets the availability of this ModelDiscovery. The list of availability details for the model across different regions and deployment modes.

Returns:	The availability of this ModelDiscovery.
Return type:	list[oci.generative_ai.models.Availability]

capabilities¶

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

Returns:	The capabilities of this ModelDiscovery.
Return type:	list[oci.generative_ai.models.ModelCapability]

modality_support¶

Gets the modality_support of this ModelDiscovery. The supported input-to-output modality transformations for this model. For example, a model can support TEXT to VIDEO or AUDIO to VIDEO.

Returns:	The modality_support of this ModelDiscovery.
Return type:	list[oci.generative_ai.models.ModelModalitySupport]

model_access¶

Gets the model_access of this ModelDiscovery. The access level required to use the model, which can be either HOSTED (the model is hosted by the provider and can be accessed via API calls) or PROXY (the model is not directly accessible and requires going through a proxy).

Allowed values for this property are: “HOSTED”, “PROXY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The model_access of this ModelDiscovery.
Return type:	str

model_id¶

[Required] Gets the model_id of this ModelDiscovery. A unique identifier for the model

Returns:	The model_id of this ModelDiscovery.
Return type:	str

parameters¶

Gets the parameters of this ModelDiscovery. The list of configurable parameters supported by the model. For example, temperature and max_tokens for a text generation model.

Returns:	The parameters of this ModelDiscovery.
Return type:	list[oci.generative_ai.models.Parameter]

vendor¶

[Required] Gets the vendor of this ModelDiscovery. The vendor that offers the model.

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