@depup/openai 6.31.0-depup.0

package/lib/ChatCompletionRunner.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ChatCompletionRunner.js","sourceRoot":"","sources":["../src/lib/ChatCompletionRunner.ts"],"names":[],"mappings":";;;AAKA,oFAIwC;AACxC,kEAA2D;AAe3D,MAAa,oBAAqC,SAAQ,2DAGzD;IACC,MAAM,CAAC,QAAQ,CACb,MAAc,EACd,MAA6C,EAC7C,OAAuB;QAEvB,MAAM,MAAM,GAAG,IAAI,oBAAoB,EAAW,CAAC;QACnD,MAAM,IAAI,GAAG;YACX,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE,2BAA2B,EAAE,UAAU,EAAE;SAC1E,CAAC;QACF,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC;QAC1D,OAAO,MAAM,CAAC;IAChB,CAAC;IAEQ,WAAW,CAElB,OAAmC,EACnC,OAAgB,IAAI;QAEpB,KAAK,CAAC,WAAW,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QACjC,IAAI,IAAA,wCAAkB,EAAC,OAAO,CAAC,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;YACnD,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,OAAO,CAAC,OAAiB,CAAC,CAAC;QACnD,CAAC;IACH,CAAC;CACF;AA5BD,oDA4BC"}

package/lib/ChatCompletionRunner.mjs

@@ -0,0 +1,20 @@
+import { AbstractChatCompletionRunner, } from "./AbstractChatCompletionRunner.mjs";
+import { isAssistantMessage } from "./chatCompletionUtils.mjs";
+export class ChatCompletionRunner extends AbstractChatCompletionRunner {
+    static runTools(client, params, options) {
+        const runner = new ChatCompletionRunner();
+        const opts = {
+            ...options,
+            headers: { ...options?.headers, 'X-Stainless-Helper-Method': 'runTools' },
+        };
+        runner._run(() => runner._runTools(client, params, opts));
+        return runner;
+    }
+    _addMessage(message, emit = true) {
+        super._addMessage(message, emit);
+        if (isAssistantMessage(message) && message.content) {
+            this._emit('content', message.content);
+        }
+    }
+}
+//# sourceMappingURL=ChatCompletionRunner.mjs.map

package/lib/ChatCompletionRunner.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"ChatCompletionRunner.mjs","sourceRoot":"","sources":["../src/lib/ChatCompletionRunner.ts"],"names":[],"mappings":"OAKO,EACL,4BAA4B,GAG7B;OACM,EAAE,kBAAkB,EAAE;AAe7B,MAAM,OAAO,oBAAqC,SAAQ,4BAGzD;IACC,MAAM,CAAC,QAAQ,CACb,MAAc,EACd,MAA6C,EAC7C,OAAuB;QAEvB,MAAM,MAAM,GAAG,IAAI,oBAAoB,EAAW,CAAC;QACnD,MAAM,IAAI,GAAG;YACX,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE,2BAA2B,EAAE,UAAU,EAAE;SAC1E,CAAC;QACF,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC;QAC1D,OAAO,MAAM,CAAC;IAChB,CAAC;IAEQ,WAAW,CAElB,OAAmC,EACnC,OAAgB,IAAI;QAEpB,KAAK,CAAC,WAAW,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QACjC,IAAI,kBAAkB,CAAC,OAAO,CAAC,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;YACnD,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,OAAO,CAAC,OAAiB,CAAC,CAAC;QACnD,CAAC;IACH,CAAC;CACF"}

package/lib/ChatCompletionStream.d.mts

@@ -0,0 +1,208 @@
+import OpenAI from "../index.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+import { type ReadableStream } from "../internal/shim-types.mjs";
+import { ParsedChatCompletion } from "../resources/chat/completions.mjs";
+import { ChatCompletionTokenLogprob, type ChatCompletion, type ChatCompletionChunk, type ChatCompletionCreateParams, type ChatCompletionCreateParamsBase, type ChatCompletionRole } from "../resources/chat/completions/completions.mjs";
+import { AbstractChatCompletionRunner, type AbstractChatCompletionRunnerEvents } from "./AbstractChatCompletionRunner.mjs";
+export interface ContentDeltaEvent {
+    delta: string;
+    snapshot: string;
+    parsed: unknown | null;
+}
+export interface ContentDoneEvent<ParsedT = null> {
+    content: string;
+    parsed: ParsedT | null;
+}
+export interface RefusalDeltaEvent {
+    delta: string;
+    snapshot: string;
+}
+export interface RefusalDoneEvent {
+    refusal: string;
+}
+export interface FunctionToolCallArgumentsDeltaEvent {
+    name: string;
+    index: number;
+    arguments: string;
+    parsed_arguments: unknown;
+    arguments_delta: string;
+}
+export interface FunctionToolCallArgumentsDoneEvent {
+    name: string;
+    index: number;
+    arguments: string;
+    parsed_arguments: unknown;
+}
+export interface LogProbsContentDeltaEvent {
+    content: Array<ChatCompletionTokenLogprob>;
+    snapshot: Array<ChatCompletionTokenLogprob>;
+}
+export interface LogProbsContentDoneEvent {
+    content: Array<ChatCompletionTokenLogprob>;
+}
+export interface LogProbsRefusalDeltaEvent {
+    refusal: Array<ChatCompletionTokenLogprob>;
+    snapshot: Array<ChatCompletionTokenLogprob>;
+}
+export interface LogProbsRefusalDoneEvent {
+    refusal: Array<ChatCompletionTokenLogprob>;
+}
+export interface ChatCompletionStreamEvents<ParsedT = null> extends AbstractChatCompletionRunnerEvents {
+    content: (contentDelta: string, contentSnapshot: string) => void;
+    chunk: (chunk: ChatCompletionChunk, snapshot: ChatCompletionSnapshot) => void;
+    'content.delta': (props: ContentDeltaEvent) => void;
+    'content.done': (props: ContentDoneEvent<ParsedT>) => void;
+    'refusal.delta': (props: RefusalDeltaEvent) => void;
+    'refusal.done': (props: RefusalDoneEvent) => void;
+    'tool_calls.function.arguments.delta': (props: FunctionToolCallArgumentsDeltaEvent) => void;
+    'tool_calls.function.arguments.done': (props: FunctionToolCallArgumentsDoneEvent) => void;
+    'logprobs.content.delta': (props: LogProbsContentDeltaEvent) => void;
+    'logprobs.content.done': (props: LogProbsContentDoneEvent) => void;
+    'logprobs.refusal.delta': (props: LogProbsRefusalDeltaEvent) => void;
+    'logprobs.refusal.done': (props: LogProbsRefusalDoneEvent) => void;
+}
+export type ChatCompletionStreamParams = Omit<ChatCompletionCreateParamsBase, 'stream'> & {
+    stream?: true;
+};
+export declare class ChatCompletionStream<ParsedT = null> extends AbstractChatCompletionRunner<ChatCompletionStreamEvents<ParsedT>, ParsedT> implements AsyncIterable<ChatCompletionChunk> {
+    #private;
+    constructor(params: ChatCompletionCreateParams | null);
+    get currentChatCompletionSnapshot(): ChatCompletionSnapshot | undefined;
+    /**
+     * Intended for use on the frontend, consuming a stream produced with
+     * `.toReadableStream()` on the backend.
+     *
+     * Note that messages sent to the model do not appear in `.on('message')`
+     * in this context.
+     */
+    static fromReadableStream(stream: ReadableStream): ChatCompletionStream<null>;
+    static createChatCompletion<ParsedT>(client: OpenAI, params: ChatCompletionStreamParams, options?: RequestOptions): ChatCompletionStream<ParsedT>;
+    protected _createChatCompletion(client: OpenAI, params: ChatCompletionCreateParams, options?: RequestOptions): Promise<ParsedChatCompletion<ParsedT>>;
+    protected _fromReadableStream(readableStream: ReadableStream, options?: RequestOptions): Promise<ChatCompletion>;
+    [Symbol.asyncIterator](this: ChatCompletionStream<ParsedT>): AsyncIterator<ChatCompletionChunk>;
+    toReadableStream(): ReadableStream;
+}
+/**
+ * Represents a streamed chunk of a chat completion response returned by model,
+ * based on the provided input.
+ */
+export interface ChatCompletionSnapshot {
+    /**
+     * 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<ChatCompletionSnapshot.Choice>;
+    /**
+     * The Unix timestamp (in seconds) of when the chat completion was created.
+     */
+    created: number;
+    /**
+     * The model to generate the completion.
+     */
+    model: string;
+    /**
+     * 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 declare namespace ChatCompletionSnapshot {
+    interface Choice {
+        /**
+         * A chat completion delta generated by streamed model responses.
+         */
+        message: Choice.Message;
+        /**
+         * 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, or `function_call`
+         * if the model called a function.
+         */
+        finish_reason: ChatCompletion.Choice['finish_reason'] | null;
+        /**
+         * Log probability information for the choice.
+         */
+        logprobs: ChatCompletion.Choice.Logprobs | null;
+        /**
+         * The index of the choice in the list of choices.
+         */
+        index: number;
+    }
+    namespace Choice {
+        /**
+         * A chat completion delta generated by streamed model responses.
+         */
+        interface Message {
+            /**
+             * The contents of the chunk message.
+             */
+            content?: string | null;
+            refusal?: string | null;
+            parsed?: unknown | null;
+            /**
+             * The name and arguments of a function that should be called, as generated by the
+             * model.
+             */
+            function_call?: Message.FunctionCall;
+            tool_calls?: Array<Message.ToolCall>;
+            /**
+             * The role of the author of this message.
+             */
+            role?: ChatCompletionRole;
+        }
+        namespace Message {
+            interface ToolCall {
+                /**
+                 * The ID of the tool call.
+                 */
+                id: string;
+                function: ToolCall.Function;
+                /**
+                 * The type of the tool.
+                 */
+                type: 'function';
+            }
+            namespace ToolCall {
+                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;
+                    parsed_arguments?: unknown;
+                    /**
+                     * The name of the function to call.
+                     */
+                    name: string;
+                }
+            }
+            /**
+             * The name and arguments of a function that should be called, as generated by the
+             * model.
+             */
+            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;
+            }
+        }
+    }
+}
+//# sourceMappingURL=ChatCompletionStream.d.mts.map

package/lib/ChatCompletionStream.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ChatCompletionStream.d.mts","sourceRoot":"","sources":["../src/lib/ChatCompletionStream.ts"],"names":[],"mappings":"OAOO,MAAM;OACN,EAAE,cAAc,EAAE;OAClB,EAAE,KAAK,cAAc,EAAE;OAUvB,EAA8B,oBAAoB,EAAE;OACpD,EACL,0BAA0B,EAC1B,KAAK,cAAc,EACnB,KAAK,mBAAmB,EACxB,KAAK,0BAA0B,EAC/B,KAAK,8BAA8B,EAEnC,KAAK,kBAAkB,EACxB;OAEM,EACL,4BAA4B,EAC5B,KAAK,kCAAkC,EACxC;AAED,MAAM,WAAW,iBAAiB;IAChC,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,OAAO,GAAG,IAAI,CAAC;CACxB;AAED,MAAM,WAAW,gBAAgB,CAAC,OAAO,GAAG,IAAI;IAC9C,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,OAAO,GAAG,IAAI,CAAC;CACxB;AAED,MAAM,WAAW,iBAAiB;IAChC,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,gBAAgB;IAC/B,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,mCAAmC;IAClD,IAAI,EAAE,MAAM,CAAC;IAEb,KAAK,EAAE,MAAM,CAAC;IAEd,SAAS,EAAE,MAAM,CAAC;IAElB,gBAAgB,EAAE,OAAO,CAAC;IAE1B,eAAe,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,kCAAkC;IACjD,IAAI,EAAE,MAAM,CAAC;IAEb,KAAK,EAAE,MAAM,CAAC;IAEd,SAAS,EAAE,MAAM,CAAC;IAElB,gBAAgB,EAAE,OAAO,CAAC;CAC3B;AAED,MAAM,WAAW,yBAAyB;IACxC,OAAO,EAAE,KAAK,CAAC,0BAA0B,CAAC,CAAC;IAC3C,QAAQ,EAAE,KAAK,CAAC,0BAA0B,CAAC,CAAC;CAC7C;AAED,MAAM,WAAW,wBAAwB;IACvC,OAAO,EAAE,KAAK,CAAC,0BAA0B,CAAC,CAAC;CAC5C;AAED,MAAM,WAAW,yBAAyB;IACxC,OAAO,EAAE,KAAK,CAAC,0BAA0B,CAAC,CAAC;IAC3C,QAAQ,EAAE,KAAK,CAAC,0BAA0B,CAAC,CAAC;CAC7C;AAED,MAAM,WAAW,wBAAwB;IACvC,OAAO,EAAE,KAAK,CAAC,0BAA0B,CAAC,CAAC;CAC5C;AAED,MAAM,WAAW,0BAA0B,CAAC,OAAO,GAAG,IAAI,CAAE,SAAQ,kCAAkC;IACpG,OAAO,EAAE,CAAC,YAAY,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,KAAK,IAAI,CAAC;IACjE,KAAK,EAAE,CAAC,KAAK,EAAE,mBAAmB,EAAE,QAAQ,EAAE,sBAAsB,KAAK,IAAI,CAAC;IAE9E,eAAe,EAAE,CAAC,KAAK,EAAE,iBAAiB,KAAK,IAAI,CAAC;IACpD,cAAc,EAAE,CAAC,KAAK,EAAE,gBAAgB,CAAC,OAAO,CAAC,KAAK,IAAI,CAAC;IAE3D,eAAe,EAAE,CAAC,KAAK,EAAE,iBAAiB,KAAK,IAAI,CAAC;IACpD,cAAc,EAAE,CAAC,KAAK,EAAE,gBAAgB,KAAK,IAAI,CAAC;IAElD,qCAAqC,EAAE,CAAC,KAAK,EAAE,mCAAmC,KAAK,IAAI,CAAC;IAC5F,oCAAoC,EAAE,CAAC,KAAK,EAAE,kCAAkC,KAAK,IAAI,CAAC;IAE1F,wBAAwB,EAAE,CAAC,KAAK,EAAE,yBAAyB,KAAK,IAAI,CAAC;IACrE,uBAAuB,EAAE,CAAC,KAAK,EAAE,wBAAwB,KAAK,IAAI,CAAC;IAEnE,wBAAwB,EAAE,CAAC,KAAK,EAAE,yBAAyB,KAAK,IAAI,CAAC;IACrE,uBAAuB,EAAE,CAAC,KAAK,EAAE,wBAAwB,KAAK,IAAI,CAAC;CACpE;AAED,MAAM,MAAM,0BAA0B,GAAG,IAAI,CAAC,8BAA8B,EAAE,QAAQ,CAAC,GAAG;IACxF,MAAM,CAAC,EAAE,IAAI,CAAC;CACf,CAAC;AAWF,qBAAa,oBAAoB,CAAC,OAAO,GAAG,IAAI,CAC9C,SAAQ,4BAA4B,CAAC,0BAA0B,CAAC,OAAO,CAAC,EAAE,OAAO,CACjF,YAAW,aAAa,CAAC,mBAAmB,CAAC;;gBAMjC,MAAM,EAAE,0BAA0B,GAAG,IAAI;IAMrD,IAAI,6BAA6B,IAAI,sBAAsB,GAAG,SAAS,CAEtE;IAED;;;;;;OAMG;IACH,MAAM,CAAC,kBAAkB,CAAC,MAAM,EAAE,cAAc,GAAG,oBAAoB,CAAC,IAAI,CAAC;IAM7E,MAAM,CAAC,oBAAoB,CAAC,OAAO,EACjC,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,0BAA0B,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,oBAAoB,CAAC,OAAO,CAAC;cA8MP,qBAAqB,CAC5C,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,0BAA0B,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;cAuBzB,mBAAmB,CACjC,cAAc,EAAE,cAAc,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,cAAc,CAAC;IA8I1B,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,IAAI,EAAE,oBAAoB,CAAC,OAAO,CAAC,GAAG,aAAa,CAAC,mBAAmB,CAAC;IA6D/F,gBAAgB,IAAI,cAAc;CAInC;AAwGD;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,OAAO,EAAE,KAAK,CAAC,sBAAsB,CAAC,MAAM,CAAC,CAAC;IAE9C;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAMd;;;;;OAKG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,yBAAiB,sBAAsB,CAAC;IACtC,UAAiB,MAAM;QACrB;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC;QAExB;;;;;;WAMG;QACH,aAAa,EAAE,cAAc,CAAC,MAAM,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC;QAE7D;;WAEG;QACH,QAAQ,EAAE,cAAc,CAAC,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC;QAEhD;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;IAED,UAAiB,MAAM,CAAC;QACtB;;WAEG;QACH,UAAiB,OAAO;YACtB;;eAEG;YACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAExB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAExB,MAAM,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;YAExB;;;eAGG;YACH,aAAa,CAAC,EAAE,OAAO,CAAC,YAAY,CAAC;YAErC,UAAU,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;YAErC;;eAEG;YACH,IAAI,CAAC,EAAE,kBAAkB,CAAC;SAC3B;QAED,UAAiB,OAAO,CAAC;YACvB,UAAiB,QAAQ;gBACvB;;mBAEG;gBACH,EAAE,EAAE,MAAM,CAAC;gBAEX,QAAQ,EAAE,QAAQ,CAAC,QAAQ,CAAC;gBAE5B;;mBAEG;gBACH,IAAI,EAAE,UAAU,CAAC;aAClB;YAED,UAAiB,QAAQ,CAAC;gBACxB,UAAiB,QAAQ;oBACvB;;;;;uBAKG;oBACH,SAAS,EAAE,MAAM,CAAC;oBAElB,gBAAgB,CAAC,EAAE,OAAO,CAAC;oBAE3B;;uBAEG;oBACH,IAAI,EAAE,MAAM,CAAC;iBACd;aACF;YAED;;;eAGG;YACH,UAAiB,YAAY;gBAC3B;;;;;mBAKG;gBACH,SAAS,CAAC,EAAE,MAAM,CAAC;gBAEnB;;mBAEG;gBACH,IAAI,CAAC,EAAE,MAAM,CAAC;aACf;SACF;KACF;CACF"}

package/lib/ChatCompletionStream.d.ts

@@ -0,0 +1,208 @@
+import OpenAI from "../index.js";
+import { RequestOptions } from "../internal/request-options.js";
+import { type ReadableStream } from "../internal/shim-types.js";
+import { ParsedChatCompletion } from "../resources/chat/completions.js";
+import { ChatCompletionTokenLogprob, type ChatCompletion, type ChatCompletionChunk, type ChatCompletionCreateParams, type ChatCompletionCreateParamsBase, type ChatCompletionRole } from "../resources/chat/completions/completions.js";
+import { AbstractChatCompletionRunner, type AbstractChatCompletionRunnerEvents } from "./AbstractChatCompletionRunner.js";
+export interface ContentDeltaEvent {
+    delta: string;
+    snapshot: string;
+    parsed: unknown | null;
+}
+export interface ContentDoneEvent<ParsedT = null> {
+    content: string;
+    parsed: ParsedT | null;
+}
+export interface RefusalDeltaEvent {
+    delta: string;
+    snapshot: string;
+}
+export interface RefusalDoneEvent {
+    refusal: string;
+}
+export interface FunctionToolCallArgumentsDeltaEvent {
+    name: string;
+    index: number;
+    arguments: string;
+    parsed_arguments: unknown;
+    arguments_delta: string;
+}
+export interface FunctionToolCallArgumentsDoneEvent {
+    name: string;
+    index: number;
+    arguments: string;
+    parsed_arguments: unknown;
+}
+export interface LogProbsContentDeltaEvent {
+    content: Array<ChatCompletionTokenLogprob>;
+    snapshot: Array<ChatCompletionTokenLogprob>;
+}
+export interface LogProbsContentDoneEvent {
+    content: Array<ChatCompletionTokenLogprob>;
+}
+export interface LogProbsRefusalDeltaEvent {
+    refusal: Array<ChatCompletionTokenLogprob>;
+    snapshot: Array<ChatCompletionTokenLogprob>;
+}
+export interface LogProbsRefusalDoneEvent {
+    refusal: Array<ChatCompletionTokenLogprob>;
+}
+export interface ChatCompletionStreamEvents<ParsedT = null> extends AbstractChatCompletionRunnerEvents {
+    content: (contentDelta: string, contentSnapshot: string) => void;
+    chunk: (chunk: ChatCompletionChunk, snapshot: ChatCompletionSnapshot) => void;
+    'content.delta': (props: ContentDeltaEvent) => void;
+    'content.done': (props: ContentDoneEvent<ParsedT>) => void;
+    'refusal.delta': (props: RefusalDeltaEvent) => void;
+    'refusal.done': (props: RefusalDoneEvent) => void;
+    'tool_calls.function.arguments.delta': (props: FunctionToolCallArgumentsDeltaEvent) => void;
+    'tool_calls.function.arguments.done': (props: FunctionToolCallArgumentsDoneEvent) => void;
+    'logprobs.content.delta': (props: LogProbsContentDeltaEvent) => void;
+    'logprobs.content.done': (props: LogProbsContentDoneEvent) => void;
+    'logprobs.refusal.delta': (props: LogProbsRefusalDeltaEvent) => void;
+    'logprobs.refusal.done': (props: LogProbsRefusalDoneEvent) => void;
+}
+export type ChatCompletionStreamParams = Omit<ChatCompletionCreateParamsBase, 'stream'> & {
+    stream?: true;
+};
+export declare class ChatCompletionStream<ParsedT = null> extends AbstractChatCompletionRunner<ChatCompletionStreamEvents<ParsedT>, ParsedT> implements AsyncIterable<ChatCompletionChunk> {
+    #private;
+    constructor(params: ChatCompletionCreateParams | null);
+    get currentChatCompletionSnapshot(): ChatCompletionSnapshot | undefined;
+    /**
+     * Intended for use on the frontend, consuming a stream produced with
+     * `.toReadableStream()` on the backend.
+     *
+     * Note that messages sent to the model do not appear in `.on('message')`
+     * in this context.
+     */
+    static fromReadableStream(stream: ReadableStream): ChatCompletionStream<null>;
+    static createChatCompletion<ParsedT>(client: OpenAI, params: ChatCompletionStreamParams, options?: RequestOptions): ChatCompletionStream<ParsedT>;
+    protected _createChatCompletion(client: OpenAI, params: ChatCompletionCreateParams, options?: RequestOptions): Promise<ParsedChatCompletion<ParsedT>>;
+    protected _fromReadableStream(readableStream: ReadableStream, options?: RequestOptions): Promise<ChatCompletion>;
+    [Symbol.asyncIterator](this: ChatCompletionStream<ParsedT>): AsyncIterator<ChatCompletionChunk>;
+    toReadableStream(): ReadableStream;
+}
+/**
+ * Represents a streamed chunk of a chat completion response returned by model,
+ * based on the provided input.
+ */
+export interface ChatCompletionSnapshot {
+    /**
+     * 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<ChatCompletionSnapshot.Choice>;
+    /**
+     * The Unix timestamp (in seconds) of when the chat completion was created.
+     */
+    created: number;
+    /**
+     * The model to generate the completion.
+     */
+    model: string;
+    /**
+     * 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 declare namespace ChatCompletionSnapshot {
+    interface Choice {
+        /**
+         * A chat completion delta generated by streamed model responses.
+         */
+        message: Choice.Message;
+        /**
+         * 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, or `function_call`
+         * if the model called a function.
+         */
+        finish_reason: ChatCompletion.Choice['finish_reason'] | null;
+        /**
+         * Log probability information for the choice.
+         */
+        logprobs: ChatCompletion.Choice.Logprobs | null;
+        /**
+         * The index of the choice in the list of choices.
+         */
+        index: number;
+    }
+    namespace Choice {
+        /**
+         * A chat completion delta generated by streamed model responses.
+         */
+        interface Message {
+            /**
+             * The contents of the chunk message.
+             */
+            content?: string | null;
+            refusal?: string | null;
+            parsed?: unknown | null;
+            /**
+             * The name and arguments of a function that should be called, as generated by the
+             * model.
+             */
+            function_call?: Message.FunctionCall;
+            tool_calls?: Array<Message.ToolCall>;
+            /**
+             * The role of the author of this message.
+             */
+            role?: ChatCompletionRole;
+        }
+        namespace Message {
+            interface ToolCall {
+                /**
+                 * The ID of the tool call.
+                 */
+                id: string;
+                function: ToolCall.Function;
+                /**
+                 * The type of the tool.
+                 */
+                type: 'function';
+            }
+            namespace ToolCall {
+                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;
+                    parsed_arguments?: unknown;
+                    /**
+                     * The name of the function to call.
+                     */
+                    name: string;
+                }
+            }
+            /**
+             * The name and arguments of a function that should be called, as generated by the
+             * model.
+             */
+            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;
+            }
+        }
+    }
+}
+//# sourceMappingURL=ChatCompletionStream.d.ts.map

package/lib/ChatCompletionStream.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ChatCompletionStream.d.ts","sourceRoot":"","sources":["../src/lib/ChatCompletionStream.ts"],"names":[],"mappings":"OAOO,MAAM;OACN,EAAE,cAAc,EAAE;OAClB,EAAE,KAAK,cAAc,EAAE;OAUvB,EAA8B,oBAAoB,EAAE;OACpD,EACL,0BAA0B,EAC1B,KAAK,cAAc,EACnB,KAAK,mBAAmB,EACxB,KAAK,0BAA0B,EAC/B,KAAK,8BAA8B,EAEnC,KAAK,kBAAkB,EACxB;OAEM,EACL,4BAA4B,EAC5B,KAAK,kCAAkC,EACxC;AAED,MAAM,WAAW,iBAAiB;IAChC,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,OAAO,GAAG,IAAI,CAAC;CACxB;AAED,MAAM,WAAW,gBAAgB,CAAC,OAAO,GAAG,IAAI;IAC9C,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,OAAO,GAAG,IAAI,CAAC;CACxB;AAED,MAAM,WAAW,iBAAiB;IAChC,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,gBAAgB;IAC/B,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,mCAAmC;IAClD,IAAI,EAAE,MAAM,CAAC;IAEb,KAAK,EAAE,MAAM,CAAC;IAEd,SAAS,EAAE,MAAM,CAAC;IAElB,gBAAgB,EAAE,OAAO,CAAC;IAE1B,eAAe,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,kCAAkC;IACjD,IAAI,EAAE,MAAM,CAAC;IAEb,KAAK,EAAE,MAAM,CAAC;IAEd,SAAS,EAAE,MAAM,CAAC;IAElB,gBAAgB,EAAE,OAAO,CAAC;CAC3B;AAED,MAAM,WAAW,yBAAyB;IACxC,OAAO,EAAE,KAAK,CAAC,0BAA0B,CAAC,CAAC;IAC3C,QAAQ,EAAE,KAAK,CAAC,0BAA0B,CAAC,CAAC;CAC7C;AAED,MAAM,WAAW,wBAAwB;IACvC,OAAO,EAAE,KAAK,CAAC,0BAA0B,CAAC,CAAC;CAC5C;AAED,MAAM,WAAW,yBAAyB;IACxC,OAAO,EAAE,KAAK,CAAC,0BAA0B,CAAC,CAAC;IAC3C,QAAQ,EAAE,KAAK,CAAC,0BAA0B,CAAC,CAAC;CAC7C;AAED,MAAM,WAAW,wBAAwB;IACvC,OAAO,EAAE,KAAK,CAAC,0BAA0B,CAAC,CAAC;CAC5C;AAED,MAAM,WAAW,0BAA0B,CAAC,OAAO,GAAG,IAAI,CAAE,SAAQ,kCAAkC;IACpG,OAAO,EAAE,CAAC,YAAY,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,KAAK,IAAI,CAAC;IACjE,KAAK,EAAE,CAAC,KAAK,EAAE,mBAAmB,EAAE,QAAQ,EAAE,sBAAsB,KAAK,IAAI,CAAC;IAE9E,eAAe,EAAE,CAAC,KAAK,EAAE,iBAAiB,KAAK,IAAI,CAAC;IACpD,cAAc,EAAE,CAAC,KAAK,EAAE,gBAAgB,CAAC,OAAO,CAAC,KAAK,IAAI,CAAC;IAE3D,eAAe,EAAE,CAAC,KAAK,EAAE,iBAAiB,KAAK,IAAI,CAAC;IACpD,cAAc,EAAE,CAAC,KAAK,EAAE,gBAAgB,KAAK,IAAI,CAAC;IAElD,qCAAqC,EAAE,CAAC,KAAK,EAAE,mCAAmC,KAAK,IAAI,CAAC;IAC5F,oCAAoC,EAAE,CAAC,KAAK,EAAE,kCAAkC,KAAK,IAAI,CAAC;IAE1F,wBAAwB,EAAE,CAAC,KAAK,EAAE,yBAAyB,KAAK,IAAI,CAAC;IACrE,uBAAuB,EAAE,CAAC,KAAK,EAAE,wBAAwB,KAAK,IAAI,CAAC;IAEnE,wBAAwB,EAAE,CAAC,KAAK,EAAE,yBAAyB,KAAK,IAAI,CAAC;IACrE,uBAAuB,EAAE,CAAC,KAAK,EAAE,wBAAwB,KAAK,IAAI,CAAC;CACpE;AAED,MAAM,MAAM,0BAA0B,GAAG,IAAI,CAAC,8BAA8B,EAAE,QAAQ,CAAC,GAAG;IACxF,MAAM,CAAC,EAAE,IAAI,CAAC;CACf,CAAC;AAWF,qBAAa,oBAAoB,CAAC,OAAO,GAAG,IAAI,CAC9C,SAAQ,4BAA4B,CAAC,0BAA0B,CAAC,OAAO,CAAC,EAAE,OAAO,CACjF,YAAW,aAAa,CAAC,mBAAmB,CAAC;;gBAMjC,MAAM,EAAE,0BAA0B,GAAG,IAAI;IAMrD,IAAI,6BAA6B,IAAI,sBAAsB,GAAG,SAAS,CAEtE;IAED;;;;;;OAMG;IACH,MAAM,CAAC,kBAAkB,CAAC,MAAM,EAAE,cAAc,GAAG,oBAAoB,CAAC,IAAI,CAAC;IAM7E,MAAM,CAAC,oBAAoB,CAAC,OAAO,EACjC,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,0BAA0B,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,oBAAoB,CAAC,OAAO,CAAC;cA8MP,qBAAqB,CAC5C,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,0BAA0B,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;cAuBzB,mBAAmB,CACjC,cAAc,EAAE,cAAc,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,cAAc,CAAC;IA8I1B,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,IAAI,EAAE,oBAAoB,CAAC,OAAO,CAAC,GAAG,aAAa,CAAC,mBAAmB,CAAC;IA6D/F,gBAAgB,IAAI,cAAc;CAInC;AAwGD;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,OAAO,EAAE,KAAK,CAAC,sBAAsB,CAAC,MAAM,CAAC,CAAC;IAE9C;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAMd;;;;;OAKG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,yBAAiB,sBAAsB,CAAC;IACtC,UAAiB,MAAM;QACrB;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC;QAExB;;;;;;WAMG;QACH,aAAa,EAAE,cAAc,CAAC,MAAM,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC;QAE7D;;WAEG;QACH,QAAQ,EAAE,cAAc,CAAC,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC;QAEhD;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;IAED,UAAiB,MAAM,CAAC;QACtB;;WAEG;QACH,UAAiB,OAAO;YACtB;;eAEG;YACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAExB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAExB,MAAM,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;YAExB;;;eAGG;YACH,aAAa,CAAC,EAAE,OAAO,CAAC,YAAY,CAAC;YAErC,UAAU,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;YAErC;;eAEG;YACH,IAAI,CAAC,EAAE,kBAAkB,CAAC;SAC3B;QAED,UAAiB,OAAO,CAAC;YACvB,UAAiB,QAAQ;gBACvB;;mBAEG;gBACH,EAAE,EAAE,MAAM,CAAC;gBAEX,QAAQ,EAAE,QAAQ,CAAC,QAAQ,CAAC;gBAE5B;;mBAEG;gBACH,IAAI,EAAE,UAAU,CAAC;aAClB;YAED,UAAiB,QAAQ,CAAC;gBACxB,UAAiB,QAAQ;oBACvB;;;;;uBAKG;oBACH,SAAS,EAAE,MAAM,CAAC;oBAElB,gBAAgB,CAAC,EAAE,OAAO,CAAC;oBAE3B;;uBAEG;oBACH,IAAI,EAAE,MAAM,CAAC;iBACd;aACF;YAED;;;eAGG;YACH,UAAiB,YAAY;gBAC3B;;;;;mBAKG;gBACH,SAAS,CAAC,EAAE,MAAM,CAAC;gBAEnB;;mBAEG;gBACH,IAAI,CAAC,EAAE,MAAM,CAAC;aACf;SACF;KACF;CACF"}