ModelMetrics

class oci.generative_ai.models.ModelMetrics(**kwargs)

Bases: object

Model metrics during the creation of a new model.

Attributes:

MODEL_METRICS_TYPE_CHAT_MODEL_METRICS	A constant which can be used with the model_metrics_type property of a ModelMetrics.
MODEL_METRICS_TYPE_TEXT_GENERATION_MODEL_METRICS	A constant which can be used with the model_metrics_type property of a ModelMetrics.
model_metrics_type	[Required] Gets the model_metrics_type of this ModelMetrics.

Methods:

__init__(**kwargs)	Initializes a new ModelMetrics object with values from keyword arguments.
get_subtype(object_dictionary)	Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

MODEL_METRICS_TYPE_CHAT_MODEL_METRICS = 'CHAT_MODEL_METRICS'

A constant which can be used with the model_metrics_type property of a ModelMetrics. This constant has a value of “CHAT_MODEL_METRICS”

MODEL_METRICS_TYPE_TEXT_GENERATION_MODEL_METRICS = 'TEXT_GENERATION_MODEL_METRICS'

A constant which can be used with the model_metrics_type property of a ModelMetrics. This constant has a value of “TEXT_GENERATION_MODEL_METRICS”

__init__(**kwargs)

Initializes a new ModelMetrics object with values from keyword arguments. This class has the following subclasses and if you are using this class as input to a service operations then you should favor using a subclass over the base class:

• TextGenerationModelMetrics

• ChatModelMetrics

The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters

model_metrics_type (str) – The value to assign to the model_metrics_type property of this ModelMetrics. Allowed values for this property are: “TEXT_GENERATION_MODEL_METRICS”, “CHAT_MODEL_METRICS”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

static get_subtype(object_dictionary)

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

property model_metrics_type

[Required] Gets the model_metrics_type of this ModelMetrics. The type of the model metrics. Each type of model can expect a different set of model metrics.

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

Returns

The model_metrics_type of this ModelMetrics.

Return type

str