Interface ChatCompletionCreateRequestStream

ChatCompletionCreateRequest class. Can be used as an interface, but also instantiates the class handling stream default behavior with stream default being disabled if not explicitly set to on.

interface ChatCompletionCreateRequestStream {
    frequency_penalty?: number;
    max_tokens?: number;
    messages: ChatCompletionRequestMessage[];
    model: "llama-2-13b-chat" | "llama-2-70b-chat" | "codellama-7b-instruct" | "codellama-13b-instruct" | "codellama-34b-instruct" | "codellama-70b-instruct" | "mistral-7b-instruct" | "mixtral-8x7b-instruct" | "nous-hermes-2-mixtral-8x7b-dpo" | "nous-hermes-2-mistral-7b-dpo";
    presence_penalty?: number;
    response_format?: ChatCompletionRequestResponseFormat;
    stop?: string | string[];
    stream?: true;
    temperature?: number;
    top_p?: number;
}

Hierarchy

Properties

frequency_penalty? max_tokens? messages model presence_penalty? response_format? stop? stream? temperature? top_p?

Properties

Optional frequency_penalty

frequency_penalty?: number

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.

Optional max_tokens

max_tokens?: number

The maximum number of tokens to generate in the chat completion. The total length of input tokens and generated tokens is limited by the model's context length.

messages

messages: ChatCompletionRequestMessage[]

messages - An array of ChatCompletionRequestMessage comprising the conversation so far.

model

model: "llama-2-13b-chat" | "llama-2-70b-chat" | "codellama-7b-instruct" | "codellama-13b-instruct" | "codellama-34b-instruct" | "codellama-70b-instruct" | "mistral-7b-instruct" | "mixtral-8x7b-instruct" | "nous-hermes-2-mixtral-8x7b-dpo" | "nous-hermes-2-mistral-7b-dpo"

ID of the model to use.

Optional presence_penalty

presence_penalty?: number

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.

Optional response_format

response_format?: ChatCompletionRequestResponseFormat

Optional stop

stop?: string | string[]

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

Optional stream

stream?: true

If set, partial message deltas will be sent. Tokens will be sent as data-only. Defaults to false. server-sent events as they become available, with the stream terminated by a data: [DONE] message. This output is processed through Stream and returns CreateChatCompletionStreamResponse if set to true. If set to false or not specified, returns CreateChatCompletionResponse

Optional temperature

temperature?: number

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.

Optional top_p

top_p?: number

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.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc