BaseChatRequest¶
- class oci.generative_ai_inference.models.BaseChatRequest(**kwargs)¶
Bases:
objectThe base class to use for the chat inference request.
Attributes:
A constant which can be used with the api_format property of a BaseChatRequest.
A constant which can be used with the api_format property of a BaseChatRequest.
A constant which can be used with the api_format property of a BaseChatRequest.
[Required] Gets the api_format of this BaseChatRequest.
Methods:
__init__(**kwargs)Initializes a new BaseChatRequest 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 BaseChatRequest. This constant has a value of “COHERE”
- API_FORMAT_COHEREV2 = 'COHEREV2'¶
A constant which can be used with the api_format property of a BaseChatRequest. This constant has a value of “COHEREV2”
- API_FORMAT_GENERIC = 'GENERIC'¶
A constant which can be used with the api_format property of a BaseChatRequest. This constant has a value of “GENERIC”
- __init__(**kwargs)¶
Initializes a new BaseChatRequest 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 BaseChatRequest. Allowed values for this property are: “COHERE”, “COHEREV2”, “GENERIC”
- property api_format¶
[Required] Gets the api_format of this BaseChatRequest. The API format for the model’s family group. COHERE is for the Cohere family models such as the cohere.command-r-16k and cohere.command-r-plus models. GENERIC is for other model families such as the meta.llama-3-70b-instruct model.
Allowed values for this property are: “COHERE”, “COHEREV2”, “GENERIC”
- Returns
The api_format of this BaseChatRequest.
- 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.