ResponseJsonSchema¶

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

Bases: object

The JSON schema definition to be used in JSON_SCHEMA response format.

Methods

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

Attributes

`description`	Gets the description of this ResponseJsonSchema.
`is_strict`	Gets the is_strict of this ResponseJsonSchema.
`name`	[Required] Gets the name of this ResponseJsonSchema.
`schema`	Gets the schema of this ResponseJsonSchema.

__init__(**kwargs)¶

Initializes a new ResponseJsonSchema 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 ResponseJsonSchema. description (str) – The value to assign to the description property of this ResponseJsonSchema. schema (object) – The value to assign to the schema property of this ResponseJsonSchema. is_strict (bool) – The value to assign to the is_strict property of this ResponseJsonSchema.

description¶

Gets the description of this ResponseJsonSchema. A description of what the response format is for, used by the model to determine how to respond in the format.

Returns:	The description of this ResponseJsonSchema.
Return type:	str

is_strict¶

Gets the is_strict of this ResponseJsonSchema. Whether to enable strict schema adherence when generating the output. If set to true, the model will always follow the exact schema defined in the schema field. Only a subset of JSON Schema is supported when strict is true.

Returns:	The is_strict of this ResponseJsonSchema.
Return type:	bool

name¶

[Required] Gets the name of this ResponseJsonSchema. The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes.

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

schema¶

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

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