Skip to main content
Deno 2 is finally here 🎉️
Learn more
Module

x/openai/resources/beta/chat/completions.ts>ChatCompletionStream

Deno build of the official Typescript library for the OpenAI API.
Extremely Popular
Go to Latest
class ChatCompletionStream
implements AsyncIterable<ChatCompletionChunk>
extends AbstractChatCompletionRunner<ChatCompletionStreamEvents>
Re-export
import { ChatCompletionStream } from "https://deno.land/x/openai@v4.24.3/resources/beta/chat/completions.ts";

Properties

readonly
currentChatCompletionSnapshot: ChatCompletionSnapshot | undefined

Methods

protected
_createChatCompletion(
completions: Completions,
params: ChatCompletionCreateParams,
options?: Core.RequestOptions,
): Promise<ChatCompletion>
protected
_fromReadableStream(readableStream: ReadableStream, options?: Core.RequestOptions): Promise<ChatCompletion>
[Symbol.asyncIterator](): AsyncIterator<ChatCompletionChunk>

Static Methods

createChatCompletion(
completions: Completions,
options?: Core.RequestOptions,
): ChatCompletionStream

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.