Module
x/openai/resources/chat/completions.ts
Deno build of the official Typescript library for the OpenAI API.
Extremely Popular
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898// File generated from our OpenAPI spec by Stainless.
import * as Core from "../../core.ts";import { APIPromise } from "../../core.ts";import { APIResource } from "../../resource.ts";import * as ChatCompletionsAPI from "./completions.ts";import * as CompletionsAPI from "../completions.ts";import * as Shared from "../shared.ts";import { Stream } from "../../streaming.ts";
export class Completions extends APIResource { /** * Creates a model response for the given chat conversation. */ create( body: ChatCompletionCreateParamsNonStreaming, options?: Core.RequestOptions, ): APIPromise<ChatCompletion>; create( body: ChatCompletionCreateParamsStreaming, options?: Core.RequestOptions, ): APIPromise<Stream<ChatCompletionChunk>>; create( body: ChatCompletionCreateParamsBase, options?: Core.RequestOptions, ): APIPromise<Stream<ChatCompletionChunk> | ChatCompletion>; create( body: ChatCompletionCreateParams, options?: Core.RequestOptions, ): APIPromise<ChatCompletion> | APIPromise<Stream<ChatCompletionChunk>> { return this._client.post("/chat/completions", { body, ...options, stream: body.stream ?? false, }) as | APIPromise<ChatCompletion> | APIPromise<Stream<ChatCompletionChunk>>; }}
/** * Represents a chat completion response returned by model, based on the provided * input. */export interface ChatCompletion { /** * A unique identifier for the chat completion. */ id: string;
/** * A list of chat completion choices. Can be more than one if `n` is greater * than 1. */ choices: Array<ChatCompletion.Choice>;
/** * The Unix timestamp (in seconds) of when the chat completion was created. */ created: number;
/** * The model used for the chat completion. */ model: string;
/** * The object type, which is always `chat.completion`. */ object: "chat.completion";
/** * This fingerprint represents the backend configuration that the model runs with. * * Can be used in conjunction with the `seed` request parameter to understand when * backend changes have been made that might impact determinism. */ system_fingerprint?: string;
/** * Usage statistics for the completion request. */ usage?: CompletionsAPI.CompletionUsage;}
export namespace ChatCompletion { export interface Choice { /** * The reason the model stopped generating tokens. This will be `stop` if the model * hit a natural stop point or a provided stop sequence, `length` if the maximum * number of tokens specified in the request was reached, `content_filter` if * content was omitted due to a flag from our content filters, `tool_calls` if the * model called a tool, or `function_call` (deprecated) if the model called a * function. */ finish_reason: | "stop" | "length" | "tool_calls" | "content_filter" | "function_call";
/** * The index of the choice in the list of choices. */ index: number;
/** * A chat completion message generated by the model. */ message: ChatCompletionsAPI.ChatCompletionMessage; }}
export interface ChatCompletionAssistantMessageParam { /** * The contents of the assistant message. */ content: string | null;
/** * The role of the messages author, in this case `assistant`. */ role: "assistant";
/** * Deprecated and replaced by `tool_calls`. The name and arguments of a function * that should be called, as generated by the model. */ function_call?: ChatCompletionAssistantMessageParam.FunctionCall;
/** * The tool calls generated by the model, such as function calls. */ tool_calls?: Array<ChatCompletionMessageToolCall>;}
export namespace ChatCompletionAssistantMessageParam { /** * Deprecated and replaced by `tool_calls`. The name and arguments of a function * that should be called, as generated by the model. */ export interface FunctionCall { /** * The arguments to call the function with, as generated by the model in JSON * format. Note that the model does not always generate valid JSON, and may * hallucinate parameters not defined by your function schema. Validate the * arguments in your code before calling your function. */ arguments: string;
/** * The name of the function to call. */ name: string; }}
/** * Represents a streamed chunk of a chat completion response returned by model, * based on the provided input. */export interface ChatCompletionChunk { /** * A unique identifier for the chat completion. Each chunk has the same ID. */ id: string;
/** * A list of chat completion choices. Can be more than one if `n` is greater * than 1. */ choices: Array<ChatCompletionChunk.Choice>;
/** * The Unix timestamp (in seconds) of when the chat completion was created. Each * chunk has the same timestamp. */ created: number;
/** * The model to generate the completion. */ model: string;
/** * The object type, which is always `chat.completion.chunk`. */ object: "chat.completion.chunk";
/** * This fingerprint represents the backend configuration that the model runs with. * Can be used in conjunction with the `seed` request parameter to understand when * backend changes have been made that might impact determinism. */ system_fingerprint?: string;}
export namespace ChatCompletionChunk { export interface Choice { /** * A chat completion delta generated by streamed model responses. */ delta: Choice.Delta;
/** * The reason the model stopped generating tokens. This will be `stop` if the model * hit a natural stop point or a provided stop sequence, `length` if the maximum * number of tokens specified in the request was reached, `content_filter` if * content was omitted due to a flag from our content filters, `tool_calls` if the * model called a tool, or `function_call` (deprecated) if the model called a * function. */ finish_reason: | "stop" | "length" | "tool_calls" | "content_filter" | "function_call" | null;
/** * The index of the choice in the list of choices. */ index: number; }
export namespace Choice { /** * A chat completion delta generated by streamed model responses. */ export interface Delta { /** * The contents of the chunk message. */ content?: string | null;
/** * Deprecated and replaced by `tool_calls`. The name and arguments of a function * that should be called, as generated by the model. */ function_call?: Delta.FunctionCall;
/** * The role of the author of this message. */ role?: "system" | "user" | "assistant" | "tool";
tool_calls?: Array<Delta.ToolCall>; }
export namespace Delta { /** * Deprecated and replaced by `tool_calls`. The name and arguments of a function * that should be called, as generated by the model. */ export interface FunctionCall { /** * The arguments to call the function with, as generated by the model in JSON * format. Note that the model does not always generate valid JSON, and may * hallucinate parameters not defined by your function schema. Validate the * arguments in your code before calling your function. */ arguments?: string;
/** * The name of the function to call. */ name?: string; }
export interface ToolCall { index: number;
/** * The ID of the tool call. */ id?: string;
function?: ToolCall.Function;
/** * The type of the tool. Currently, only `function` is supported. */ type?: "function"; }
export namespace ToolCall { export interface Function { /** * The arguments to call the function with, as generated by the model in JSON * format. Note that the model does not always generate valid JSON, and may * hallucinate parameters not defined by your function schema. Validate the * arguments in your code before calling your function. */ arguments?: string;
/** * The name of the function to call. */ name?: string; } } } }}
export type ChatCompletionContentPart = | ChatCompletionContentPartText | ChatCompletionContentPartImage;
export interface ChatCompletionContentPartImage { image_url: ChatCompletionContentPartImage.ImageURL;
/** * The type of the content part. */ type: "image_url";}
export namespace ChatCompletionContentPartImage { export interface ImageURL { /** * Either a URL of the image or the base64 encoded image data. */ url: string;
/** * Specifies the detail level of the image. */ detail?: "auto" | "low" | "high"; }}
export interface ChatCompletionContentPartText { /** * The text content. */ text: string;
/** * The type of the content part. */ type: "text";}
/** * Specifying a particular function via `{"name": "my_function"}` forces the model * to call that function. */export interface ChatCompletionFunctionCallOption { /** * The name of the function to call. */ name: string;}
export interface ChatCompletionFunctionMessageParam { /** * The return value from the function call, to return to the model. */ content: string | null;
/** * The name of the function to call. */ name: string;
/** * The role of the messages author, in this case `function`. */ role: "function";}
/** * A chat completion message generated by the model. */export interface ChatCompletionMessage { /** * The contents of the message. */ content: string | null;
/** * The role of the author of this message. */ role: "assistant";
/** * Deprecated and replaced by `tool_calls`. The name and arguments of a function * that should be called, as generated by the model. */ function_call?: ChatCompletionMessage.FunctionCall;
/** * The tool calls generated by the model, such as function calls. */ tool_calls?: Array<ChatCompletionMessageToolCall>;}
export namespace ChatCompletionMessage { /** * Deprecated and replaced by `tool_calls`. The name and arguments of a function * that should be called, as generated by the model. */ export interface FunctionCall { /** * The arguments to call the function with, as generated by the model in JSON * format. Note that the model does not always generate valid JSON, and may * hallucinate parameters not defined by your function schema. Validate the * arguments in your code before calling your function. */ arguments: string;
/** * The name of the function to call. */ name: string; }}
export type ChatCompletionMessageParam = | ChatCompletionSystemMessageParam | ChatCompletionUserMessageParam | ChatCompletionAssistantMessageParam | ChatCompletionToolMessageParam | ChatCompletionFunctionMessageParam;
export interface ChatCompletionMessageToolCall { /** * The ID of the tool call. */ id: string;
/** * The function that the model called. */ function: ChatCompletionMessageToolCall.Function;
/** * The type of the tool. Currently, only `function` is supported. */ type: "function";}
export namespace ChatCompletionMessageToolCall { /** * The function that the model called. */ export interface Function { /** * The arguments to call the function with, as generated by the model in JSON * format. Note that the model does not always generate valid JSON, and may * hallucinate parameters not defined by your function schema. Validate the * arguments in your code before calling your function. */ arguments: string;
/** * The name of the function to call. */ name: string; }}
/** * Specifies a tool the model should use. Use to force the model to call a specific * function. */export interface ChatCompletionNamedToolChoice { function?: ChatCompletionNamedToolChoice.Function;
/** * The type of the tool. Currently, only `function` is supported. */ type?: "function";}
export namespace ChatCompletionNamedToolChoice { export interface Function { /** * The name of the function to call. */ name: string; }}
/** * The role of the author of a message */export type ChatCompletionRole = | "system" | "user" | "assistant" | "tool" | "function";
export interface ChatCompletionSystemMessageParam { /** * The contents of the system message. */ content: string | null;
/** * The role of the messages author, in this case `system`. */ role: "system";}
export interface ChatCompletionTool { function: Shared.FunctionDefinition;
/** * The type of the tool. Currently, only `function` is supported. */ type: "function";}
/** * 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. */export type ChatCompletionToolChoiceOption = | "none" | "auto" | ChatCompletionNamedToolChoice;
export interface ChatCompletionToolMessageParam { /** * The contents of the tool message. */ content: string | null;
/** * The role of the messages author, in this case `tool`. */ role: "tool";
/** * Tool call that this message is responding to. */ tool_call_id: string;}
export interface ChatCompletionUserMessageParam { /** * The contents of the user message. */ content: string | Array<ChatCompletionContentPart> | null;
/** * The role of the messages author, in this case `user`. */ role: "user";}
/** * @deprecated ChatCompletionMessageParam should be used instead */export type CreateChatCompletionRequestMessage = ChatCompletionMessageParam;
export type ChatCompletionCreateParams = | ChatCompletionCreateParamsNonStreaming | ChatCompletionCreateParamsStreaming;
export interface ChatCompletionCreateParamsBase { /** * A list of messages comprising the conversation so far. * [Example Python code](https://cookbook.openai.com/examples/how_to_format_inputs_to_chatgpt_models). */ messages: Array<ChatCompletionMessageParam>;
/** * ID of the model to use. See the * [model endpoint compatibility](https://platform.openai.com/docs/models/model-endpoint-compatibility) * table for details on which models work with the Chat API. */ 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";
/** * 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.](https://platform.openai.com/docs/guides/gpt/parameter-details) */ frequency_penalty?: number | null;
/** * 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. */ function_call?: "none" | "auto" | ChatCompletionFunctionCallOption;
/** * Deprecated in favor of `tools`. * * A list of functions the model may generate JSON inputs for. */ functions?: Array<ChatCompletionCreateParams.Function>;
/** * 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. */ logit_bias?: Record<string, number> | null;
/** * The maximum number of [tokens](/tokenizer) 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](https://cookbook.openai.com/examples/how_to_count_tokens_with_tiktoken) * for counting tokens. */ max_tokens?: number | null;
/** * How many chat completion choices to generate for each input message. */ n?: number | null;
/** * 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.](https://platform.openai.com/docs/guides/gpt/parameter-details) */ presence_penalty?: number | null;
/** * 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. */ response_format?: ChatCompletionCreateParams.ResponseFormat;
/** * 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. */ seed?: number | null;
/** * Up to 4 sequences where the API will stop generating further tokens. */ stop?: string | null | Array<string>;
/** * If set, partial message deltas will be sent, like in ChatGPT. Tokens will be * sent as data-only * [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format) * as they become available, with the stream terminated by a `data: [DONE]` * message. * [Example Python code](https://cookbook.openai.com/examples/how_to_stream_completions). */ stream?: boolean | null;
/** * 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?: number | null;
/** * 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. */ tool_choice?: ChatCompletionToolChoiceOption;
/** * 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. */ tools?: Array<ChatCompletionTool>;
/** * 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. */ top_p?: number | null;
/** * A unique identifier representing your end-user, which can help OpenAI to monitor * and detect abuse. * [Learn more](https://platform.openai.com/docs/guides/safety-best-practices/end-user-ids). */ user?: string;}
export namespace ChatCompletionCreateParams { export interface Function { /** * The name of the function to be called. Must be a-z, A-Z, 0-9, or contain * underscores and dashes, with a maximum length of 64. */ name: string;
/** * The parameters the functions accepts, described as a JSON Schema object. See the * [guide](https://platform.openai.com/docs/guides/gpt/function-calling) for * examples, and the * [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for * documentation about the format. * * To describe a function that accepts no parameters, provide the value * `{"type": "object", "properties": {}}`. */ parameters: Shared.FunctionParameters;
/** * A description of what the function does, used by the model to choose when and * how to call the function. */ description?: string; }
/** * 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. */ export interface ResponseFormat { /** * Must be one of `text` or `json_object`. */ type?: "text" | "json_object"; }
export type ChatCompletionCreateParamsNonStreaming = ChatCompletionsAPI.ChatCompletionCreateParamsNonStreaming; export type ChatCompletionCreateParamsStreaming = ChatCompletionsAPI.ChatCompletionCreateParamsStreaming;}
/** * @deprecated Use ChatCompletionCreateParams instead */export type CompletionCreateParams = ChatCompletionCreateParams;
export interface ChatCompletionCreateParamsNonStreaming extends ChatCompletionCreateParamsBase { /** * If set, partial message deltas will be sent, like in ChatGPT. Tokens will be * sent as data-only * [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format) * as they become available, with the stream terminated by a `data: [DONE]` * message. * [Example Python code](https://cookbook.openai.com/examples/how_to_stream_completions). */ stream?: false | null;}
/** * @deprecated Use ChatCompletionCreateParamsNonStreaming instead */export type CompletionCreateParamsNonStreaming = ChatCompletionCreateParamsNonStreaming;
export interface ChatCompletionCreateParamsStreaming extends ChatCompletionCreateParamsBase { /** * If set, partial message deltas will be sent, like in ChatGPT. Tokens will be * sent as data-only * [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format) * as they become available, with the stream terminated by a `data: [DONE]` * message. * [Example Python code](https://cookbook.openai.com/examples/how_to_stream_completions). */ stream: true;}
/** * @deprecated Use ChatCompletionCreateParamsStreaming instead */export type CompletionCreateParamsStreaming = ChatCompletionCreateParamsStreaming;
export namespace Completions { export type ChatCompletion = ChatCompletionsAPI.ChatCompletion; export type ChatCompletionAssistantMessageParam = ChatCompletionsAPI.ChatCompletionAssistantMessageParam; export type ChatCompletionChunk = ChatCompletionsAPI.ChatCompletionChunk; export type ChatCompletionContentPart = ChatCompletionsAPI.ChatCompletionContentPart; export type ChatCompletionContentPartImage = ChatCompletionsAPI.ChatCompletionContentPartImage; export type ChatCompletionContentPartText = ChatCompletionsAPI.ChatCompletionContentPartText; export type ChatCompletionFunctionCallOption = ChatCompletionsAPI.ChatCompletionFunctionCallOption; export type ChatCompletionFunctionMessageParam = ChatCompletionsAPI.ChatCompletionFunctionMessageParam; export type ChatCompletionMessage = ChatCompletionsAPI.ChatCompletionMessage; export type ChatCompletionMessageParam = ChatCompletionsAPI.ChatCompletionMessageParam; export type ChatCompletionMessageToolCall = ChatCompletionsAPI.ChatCompletionMessageToolCall; export type ChatCompletionNamedToolChoice = ChatCompletionsAPI.ChatCompletionNamedToolChoice; export type ChatCompletionRole = ChatCompletionsAPI.ChatCompletionRole; export type ChatCompletionSystemMessageParam = ChatCompletionsAPI.ChatCompletionSystemMessageParam; export type ChatCompletionTool = ChatCompletionsAPI.ChatCompletionTool; export type ChatCompletionToolChoiceOption = ChatCompletionsAPI.ChatCompletionToolChoiceOption; export type ChatCompletionToolMessageParam = ChatCompletionsAPI.ChatCompletionToolMessageParam; export type ChatCompletionUserMessageParam = ChatCompletionsAPI.ChatCompletionUserMessageParam; export type CreateChatCompletionRequestMessage = ChatCompletionsAPI.CreateChatCompletionRequestMessage; export type ChatCompletionCreateParams = ChatCompletionsAPI.ChatCompletionCreateParams; export type CompletionCreateParams = ChatCompletionsAPI.CompletionCreateParams; export type ChatCompletionCreateParamsNonStreaming = ChatCompletionsAPI.ChatCompletionCreateParamsNonStreaming; export type CompletionCreateParamsNonStreaming = ChatCompletionsAPI.CompletionCreateParamsNonStreaming; export type ChatCompletionCreateParamsStreaming = ChatCompletionsAPI.ChatCompletionCreateParamsStreaming; export type CompletionCreateParamsStreaming = ChatCompletionsAPI.CompletionCreateParamsStreaming;}