@ralphschuler.ai function caller.index.<internal>.OpenAI.Chat.Completions.ChatCompletionCreateParamsStreaming

Interface: ChatCompletionCreateParamsStreaming

Chat.Completions.ChatCompletionCreateParamsStreaming

Hierarchy

• ChatCompletionCreateParamsBase

  ↳ ChatCompletionCreateParamsStreaming

Table of contents

Properties

• frequency_penalty
• function_call
• functions
• logit_bias
• max_tokens
• messages
• model
• n
• presence_penalty
• response_format
• seed
• stop
• stream
• temperature
• tool_choice
• tools
• top_p
• user

Properties

frequency_penalty

• Optional frequency_penalty: null | 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.

See more information about frequency and presence penalties.

Inherited from

ChatCompletionCreateParamsBase.frequency_penalty

Defined in

node_modules/openai/resources/chat/completions.d.ts:463

---

function_call

• Optional function_call: "auto" | "none" | ChatCompletionFunctionCallOption

Deprecated in favor of tool_choice.

Controls which (if any) function is called by the model. none means the model will not call a function and instead generates a message. auto means the model can pick between generating a message or calling a function. Specifying a particular function via {"name": "my_function"} forces the model to call that function.

none is the default when no functions are present. `auto`` is the default if functions are present.

Inherited from

ChatCompletionCreateParamsBase.function_call

Defined in

node_modules/openai/resources/chat/completions.d.ts:476

---

functions

• Optional functions: Function[]

Deprecated in favor of tools.

A list of functions the model may generate JSON inputs for.

Inherited from

ChatCompletionCreateParamsBase.functions

Defined in

node_modules/openai/resources/chat/completions.d.ts:482

---

logit_bias

• Optional logit_bias: null | Record<string, number>

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.

Inherited from

ChatCompletionCreateParamsBase.logit_bias

Defined in

node_modules/openai/resources/chat/completions.d.ts:493

---

max_tokens

• Optional max_tokens: null | 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. Example Python code for counting tokens.

Inherited from

ChatCompletionCreateParamsBase.max_tokens

Defined in

node_modules/openai/resources/chat/completions.d.ts:502

---

messages

• messages: ChatCompletionMessageParam[]

A list of messages comprising the conversation so far. Example Python code.

Inherited from

ChatCompletionCreateParamsBase.messages

Defined in

node_modules/openai/resources/chat/completions.d.ts:449

---

model

• model: string & {} | "gpt-4-1106-preview" | "gpt-4-vision-preview" | "gpt-4" | "gpt-4-0314" | "gpt-4-0613" | "gpt-4-32k" | "gpt-4-32k-0314" | "gpt-4-32k-0613" | "gpt-3.5-turbo-1106" | "gpt-3.5-turbo" | "gpt-3.5-turbo-16k" | "gpt-3.5-turbo-0301" | "gpt-3.5-turbo-0613" | "gpt-3.5-turbo-16k-0613"

ID of the model to use. See the model endpoint compatibility table for details on which models work with the Chat API.

Inherited from

ChatCompletionCreateParamsBase.model

Defined in

node_modules/openai/resources/chat/completions.d.ts:455

---

n

• Optional n: null | number

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

Inherited from

ChatCompletionCreateParamsBase.n

Defined in

node_modules/openai/resources/chat/completions.d.ts:506

---

presence_penalty

• Optional presence_penalty: null | 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.

See more information about frequency and presence penalties.

Inherited from

ChatCompletionCreateParamsBase.presence_penalty

Defined in

node_modules/openai/resources/chat/completions.d.ts:514

---

response_format

• Optional response_format: ResponseFormat

An object specifying the format that the model must output.

Setting to { "type": "json_object" } enables JSON mode, which guarantees the message the model generates is valid JSON.

Important: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in increased latency and appearance of a "stuck" request. Also note that the message content may be partially cut off if finish_reason="length", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length.

Inherited from

ChatCompletionCreateParamsBase.response_format

Defined in

node_modules/openai/resources/chat/completions.d.ts:529

---

seed

• Optional seed: null | number

This feature is in Beta. If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result. Determinism is not guaranteed, and you should refer to the system_fingerprint response parameter to monitor changes in the backend.

Inherited from

ChatCompletionCreateParamsBase.seed

Defined in

node_modules/openai/resources/chat/completions.d.ts:537

---

stop

• Optional stop: null | string | string[]

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

Inherited from

ChatCompletionCreateParamsBase.stop

Defined in

node_modules/openai/resources/chat/completions.d.ts:541

---

stream

• stream: true

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. Example Python code.

Overrides

ChatCompletionCreateParamsBase.stream

Defined in

node_modules/openai/resources/chat/completions.d.ts:667

---

temperature

• Optional temperature: null | 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.

Inherited from

ChatCompletionCreateParamsBase.temperature

Defined in

node_modules/openai/resources/chat/completions.d.ts:558

---

tool_choice

• Optional tool_choice: ChatCompletionToolChoiceOption

Controls which (if any) function is called by the model. none means the model will not call a function and instead generates a message. auto means the model can pick between generating a message or calling a function. Specifying a particular function via {"type: "function", "function": {"name": "my_function"}} forces the model to call that function.

none is the default when no functions are present. auto is the default if functions are present.

Inherited from

ChatCompletionCreateParamsBase.tool_choice

Defined in

node_modules/openai/resources/chat/completions.d.ts:570

---

tools

• Optional tools: ChatCompletionTool[]

A list of tools the model may call. Currently, only functions are supported as a tool. Use this to provide a list of functions the model may generate JSON inputs for.

Inherited from

ChatCompletionCreateParamsBase.tools

Defined in

node_modules/openai/resources/chat/completions.d.ts:576

---

top_p

• Optional top_p: null | 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.

Inherited from

ChatCompletionCreateParamsBase.top_p

Defined in

node_modules/openai/resources/chat/completions.d.ts:584

---

user

• Optional user: string

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

Inherited from

ChatCompletionCreateParamsBase.user

Defined in

node_modules/openai/resources/chat/completions.d.ts:590