BaseChatResponse¶

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

Bases: object

The base class that creates the chat response.

Attributes:

`API_FORMAT_COHERE`	A constant which can be used with the api_format property of a BaseChatResponse.
`API_FORMAT_COHEREV2`	A constant which can be used with the api_format property of a BaseChatResponse.
`API_FORMAT_GENERIC`	A constant which can be used with the api_format property of a BaseChatResponse.
`api_format`	[Required] Gets the api_format of this BaseChatResponse.

Methods:

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

API_FORMAT_COHERE = 'COHERE'¶: A constant which can be used with the api_format property of a BaseChatResponse. This constant has a value of “COHERE”

API_FORMAT_COHEREV2 = 'COHEREV2'¶: A constant which can be used with the api_format property of a BaseChatResponse. This constant has a value of “COHEREV2”

API_FORMAT_GENERIC = 'GENERIC'¶: A constant which can be used with the api_format property of a BaseChatResponse. This constant has a value of “GENERIC”

__init__(**kwargs)¶

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

The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters: api_format (str) – The value to assign to the api_format property of this BaseChatResponse. Allowed values for this property are: “COHERE”, “GENERIC”, “COHEREV2”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

property api_format¶

[Required] Gets the api_format of this BaseChatResponse. The API format for the model’s response.

Allowed values for this property are: “COHERE”, “GENERIC”, “COHEREV2”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns: The api_format of this BaseChatResponse.
Return type: str

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.