core
API
Generated with
core/sttp.openai/sttp.openai.requests/sttp.openai.requests.completions/sttp.openai.requests.completions.chat/ChatRequestBody

ChatRequestBody

sttp.openai.requests.completions.chat.ChatRequestBody$
object ChatRequestBody

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type

Members list

Type members

Classlikes

case class ChatBody(model: ChatCompletionModel, messages: Seq[Message], temperature: Option[Double], topP: Option[Double], n: Option[Int], stop: Option[Stop], maxTokens: Option[Int], presencePenalty: Option[Double], frequencyPenalty: Option[Double], logitBias: Option[Map[String, Float]], user: Option[String])

Value parameters

frequencyPenalty

Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim.

logitBias

Modify the likelihood of specified tokens appearing in the completion.

maxTokens

The maximum number of tokens to generate in the chat completion.

messages

A list of messages describing the conversation so far.

model

ID of the model to use.

n

How many chat completion choices to generate for each input message.

presencePenalty

Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics.

stop

Up to 4 sequences where the API will stop generating further tokens.

temperature

What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.

topP

An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.

user

A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ChatBody

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
ChatBody.type
sealed abstract class ChatCompletionModel(val value: String)

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object GPT35Turbo.type
object GPT35Turbo0301.type
object GPT4.type
object GPT40314.type
object GPT432k.type
object GPT432k0314.type
Show all
object ChatCompletionModel

Attributes

Companion
class
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
Generated with