Chat

Chat

POST

Request

This endpoint expects an object.
messages
list of objectsRequired
List of messages specifying the conversation so far.
model
stringRequired

See Available Models for possible values.

frequency_penalty
doubleOptional
Parameter which penalises tokens based on their frequency in the model's output so far. The larger the value, the higher the penalisation. 0.0 means no frequency penalty. Defaults to 0.0.
max_tokens
integerOptional
The maximum number of new tokens to be generated by the model. Note that this is limited by the model's context length. Defaults to 1024.
presence_penalty
doubleOptional
Parameter which penalises tokens based on whether they have appeared in the model's output so far. The larger the value, the higher the penalisation. 0.0 means no presence penalty. Defaults to 0.0.
seed
integerOptional
Random seed used for generations. The same value forces the model to sample the same output.
stop
list of stringsOptional
A list of stop strings used to control generation. If the model generates one of these, it will stop.
stream
booleanOptional

Set to true to enable streaming. See Chat Streaming

temperature
doubleOptional

Positive number representing the temperature to use for generation. Higher values will make the output more unformly random or creative. 0.0 means greedy decoding. Defaults to 0.4.

top_k
integerOptional

Parameter which forces the model to only consider the tokens with the top_k highest probabilities at the next step. Defaults to 1024.

top_p
doubleOptional

Parameter used to do nucleus sampling, i.e. only consider tokens comprising the top_p probability of the next token’s distribution. Defaults to 0.95.

use_search_engine
booleanOptional

Whether to consider using search engine to complete the request. Note that even if this is set to True, the model might decide to not use search.

Response

This endpoint returns a union
Chat Responseobject
OR
Chunk Chat Responseobject