ResponseFormat

class oci.generative_ai_inference.models.ResponseFormat(**kwargs)

Bases: object

An object specifying the format that the model must output.

Attributes:

TYPE_JSON_OBJECT	A constant which can be used with the type property of a ResponseFormat.
TYPE_JSON_SCHEMA	A constant which can be used with the type property of a ResponseFormat.
TYPE_TEXT	A constant which can be used with the type property of a ResponseFormat.
type	Gets the type of this ResponseFormat.

Methods:

__init__(**kwargs)	Initializes a new ResponseFormat 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 ResponseFormat. This constant has a value of “JSON_OBJECT”

TYPE_JSON_SCHEMA = 'JSON_SCHEMA'

A constant which can be used with the type property of a ResponseFormat. This constant has a value of “JSON_SCHEMA”

TYPE_TEXT = 'TEXT'

A constant which can be used with the type property of a ResponseFormat. This constant has a value of “TEXT”

__init__(**kwargs)

Initializes a new ResponseFormat 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:

• TextResponseFormat

• JsonObjectResponseFormat

• JsonSchemaResponseFormat

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 ResponseFormat. Allowed values for this property are: “TEXT”, “JSON_OBJECT”, “JSON_SCHEMA”

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