ChatCompleteText class

Constructors

ChatCompleteText({required ChatModel model, required List<Messages> messages, double? temperature = .3, double? topP = 1.0, int? n = 1, bool? stream = false, List<String>? stop, int? maxToken = 100, double? presencePenalty = .0, double? frequencyPenalty = .0, String? user = "", List<FunctionData>? functions, FunctionCall? functionCall})

Properties

frequencyPenalty double?
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. frequencyPenalty
final
functionCall FunctionCall?
Controls how the model responds to function calls. "none" means the model does not call a function, and responds to the end-user. "auto" means the model can pick between an end-user or calling a function. Specifying a particular function via forces the model to call that function. "none" is the default when no functions are present. "auto" is the default if functions are present.{"name":\ "my_function"} functionCall
final
functions List<FunctionData>?
A list of functions the model may generate JSON inputs for. functions
final
hashCode int
The hash code for this object.
no setterinherited
maxToken int?
The maximum number of tokens allowed for the generated answer. By default, the number of tokens the model can return will be (4096 - prompt tokens). maxToken
final
messages List<Messages>
The messages to generate chat completions for, in the chat format. messages
final
model ChatModel
ID of the model to use. Currently, only gpt-3.5-turbo and gpt-3.5-turbo-0301 are supported. model kChatGptTurboModel kChatGptTurbo0301Model
final
n int?
How many chat completion choices to generate for each input message. n
final
presencePenalty double?
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. presencePenalty
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
stop List<String>?
Up to 4 sequences where the API will stop generating further tokens. stop
final
stream bool?
If set, partial message deltas will be sent, like in ChatGPT. Tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a data: DONE message. stream
final
temperature double?
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. We generally recommend altering this or top_p but not both. temperature
final
topP double?
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. We generally recommend altering this or temperature but not both. topP
final
user String?
Modify the likelihood of specified tokens appearing in the completion. Accepts a json object that maps tokens (specified by their token ID in the tokenizer) to an associated bias value from -100 to 100. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token. logitBias A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse.user
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() Map<String, dynamic>
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited