Packages

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

model

ID of the model to use.

messages

A list of messages describing the conversation so far.

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.

n

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

stop

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

maxTokens

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

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.

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.

user

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

Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ChatBody
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

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

    model

    ID of the model to use.

    messages

    A list of messages describing the conversation so far.

    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.

    n

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

    stop

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

    maxTokens

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

    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.

    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.

    user

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

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. val frequencyPenalty: Option[Double]
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  9. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  10. val logitBias: Option[Map[String, Float]]
  11. val maxTokens: Option[Int]
  12. val messages: Seq[Message]
  13. val model: ChatCompletionModel
  14. val n: Option[Int]
  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  18. val presencePenalty: Option[Double]
  19. def productElementNames: Iterator[String]
    Definition Classes
    Product
  20. val stop: Option[Stop]
  21. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  22. val temperature: Option[Double]
  23. val topP: Option[Double]
  24. val user: Option[String]
  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  27. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped