CohereResponseJsonFormat¶

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

Bases: CohereResponseFormat

The json object format for the model structured output

Attributes:

`TYPE_JSON_OBJECT`	A constant which can be used with the type property of a CohereResponseFormat.
`TYPE_TEXT`	A constant which can be used with the type property of a CohereResponseFormat.
`schema`	Gets the schema of this CohereResponseJsonFormat.
`type`	Gets the type of this CohereResponseFormat.

Methods:

`__init__`(**kwargs)	Initializes a new CohereResponseJsonFormat 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.

TYPE_JSON_OBJECT = 'JSON_OBJECT'¶: A constant which can be used with the type property of a CohereResponseFormat. This constant has a value of “JSON_OBJECT”

TYPE_TEXT = 'TEXT'¶: A constant which can be used with the type property of a CohereResponseFormat. This constant has a value of “TEXT”

__init__(**kwargs)¶

Initializes a new CohereResponseJsonFormat object with values from keyword arguments. The default value of the type attribute of this class is JSON_OBJECT and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters

type (str) – The value to assign to the type property of this CohereResponseJsonFormat. Allowed values for this property are: “JSON_OBJECT”, “TEXT”
schema (object) – The value to assign to the schema property of this CohereResponseJsonFormat.

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 schema¶

Gets the schema of this CohereResponseJsonFormat. The schema used by the structured output, described as a JSON Schema object.

Returns: The schema of this CohereResponseJsonFormat.
Return type: object

property type¶

Gets the type of this CohereResponseFormat. The format type

Allowed values for this property are: “JSON_OBJECT”, “TEXT”

Returns: The type of this CohereResponseFormat.
Return type: str