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

x/openai/lib/ChatCompletionStream.ts>ChatCompletionStream

Deno build of the official Typescript library for the OpenAI API.
openai/openai-deno-build
Extremely Popular
Latest
class ChatCompletionStream
implements AsyncIterable<ChatCompletionChunk>
import { ChatCompletionStream } from "https://deno.land/x/openai@v4.69.0/lib/ChatCompletionStream.ts";

Constructors

new
ChatCompletionStream(params: ChatCompletionCreateParams | null)

Type Parameters

optional
ParsedT = null

Properties

readonly
currentChatCompletionSnapshot: ChatCompletionSnapshot | undefined

Methods

protected
_createChatCompletion(
client: OpenAI,
options?: Core.RequestOptions,
): Promise<ParsedChatCompletion<ParsedT>>
protected
_fromReadableStream(readableStream: ReadableStream, options?: Core.RequestOptions): Promise<ChatCompletion>
[Symbol.asyncIterator](this: ChatCompletionStream<ParsedT>): AsyncIterator<ChatCompletionChunk>

Static Methods

createChatCompletion<ParsedT>(
client: OpenAI,
options?: Core.RequestOptions,
): ChatCompletionStream<ParsedT>
fromReadableStream(stream: ReadableStream): ChatCompletionStream<null>

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.