ChatCompletionStream | /resources/beta/chat/completions.ts | openai@v4.69.0

class ChatCompletionStream

implements AsyncIterable<ChatCompletionChunk>

extends AbstractChatCompletionRunner<ChatCompletionStreamEvents<ParsedT>, ParsedT>

Re-export

import { ChatCompletionStream } from "https://deno.land/x/openai@v4.69.0/resources/beta/chat/completions.ts";

Constructors

new

ChatCompletionStream(params: ChatCompletionCreateParams | null)

optional

ParsedT = null

readonly

currentChatCompletionSnapshot: ChatCompletionSnapshot | undefined

protected

client: OpenAI,

params: ChatCompletionCreateParams,

options?: Core.RequestOptions,

): Promise<ParsedChatCompletion<ParsedT>>

protected

_fromReadableStream(readableStream: ReadableStream, options?: Core.RequestOptions): Promise<ChatCompletion>

[Symbol.asyncIterator](this: ChatCompletionStream<ParsedT>): AsyncIterator<ChatCompletionChunk>

client: OpenAI,

params: ChatCompletionStreamParams,

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.