JsonSchemaResponseFormat¶

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

Bases: oci.generative_ai_inference.models.response_format.ResponseFormat

Enables Structured Outputs which ensures the model will match your supplied JSON schema.

Attributes

`TYPE_JSON_OBJECT`	str(object=’’) -> str
`TYPE_JSON_SCHEMA`	str(object=’’) -> str
`TYPE_TEXT`	str(object=’’) -> str
`json_schema`	Gets the json_schema of this JsonSchemaResponseFormat.
`type`	Gets the type of this ResponseFormat.

Methods

`__init__`(**kwargs)	Initializes a new JsonSchemaResponseFormat 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'¶

TYPE_JSON_SCHEMA = 'JSON_SCHEMA'¶

TYPE_TEXT = 'TEXT'¶

__init__(**kwargs)¶

Initializes a new JsonSchemaResponseFormat object with values from keyword arguments. The default value of the type attribute of this class is JSON_SCHEMA 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 JsonSchemaResponseFormat. Allowed values for this property are: “TEXT”, “JSON_OBJECT”, “JSON_SCHEMA” json_schema (oci.generative_ai_inference.models.ResponseJsonSchema) – The value to assign to the json_schema property of this JsonSchemaResponseFormat.

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.

json_schema¶

Gets the json_schema of this JsonSchemaResponseFormat.

Returns:	The json_schema of this JsonSchemaResponseFormat.
Return type:	oci.generative_ai_inference.models.ResponseJsonSchema

type¶

Gets the type of this ResponseFormat. The format type

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

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