CategoryScore¶

class oci.generative_ai_inference.models.CategoryScore(**kwargs)¶

Bases: object

A category with its score.

Attributes

`FLAGGED_MODALITIES_IMAGE`	A constant which can be used with the flagged_modalities property of a CategoryScore.
`FLAGGED_MODALITIES_TEXT`	A constant which can be used with the flagged_modalities property of a CategoryScore.
`flagged_modalities`	Gets the flagged_modalities of this CategoryScore.
`name`	[Required] Gets the name of this CategoryScore.
`score`	[Required] Gets the score of this CategoryScore.

Methods

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

FLAGGED_MODALITIES_IMAGE = 'IMAGE'¶: A constant which can be used with the flagged_modalities property of a CategoryScore. This constant has a value of “IMAGE”

FLAGGED_MODALITIES_TEXT = 'TEXT'¶: A constant which can be used with the flagged_modalities property of a CategoryScore. This constant has a value of “TEXT”

__init__(**kwargs)¶

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

Parameters:

name (str) – The value to assign to the name property of this CategoryScore.
score (float) – The value to assign to the score property of this CategoryScore.
flagged_modalities (list[str]) – The value to assign to the flagged_modalities property of this CategoryScore. Allowed values for items in this list are: “TEXT”, “IMAGE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

flagged_modalities¶

Gets the flagged_modalities of this CategoryScore. The input modalities flagged by this category score. Present only when the request is processed using a non-empty multimodalInput.

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

Returns:	The flagged_modalities of this CategoryScore.
Return type:	list[str]

name¶

[Required] Gets the name of this CategoryScore. The name of the category.

Returns:	The name of this CategoryScore.
Return type:	str

score¶

[Required] Gets the score of this CategoryScore. The score of the category.

Returns:	The score of this CategoryScore.
Return type:	float