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

x/openai/lib/AbstractAssistantStreamRunner.ts>AbstractAssistantStreamRunner

Deno build of the official Typescript library for the OpenAI API.
openai/openai-deno-build
Extremely Popular
Go to Latest
class AbstractAssistantStreamRunner
Abstract
import { AbstractAssistantStreamRunner } from "https://deno.land/x/openai@v4.39.0/lib/AbstractAssistantStreamRunner.ts";

Constructors

new
AbstractAssistantStreamRunner()

Type Parameters

optional
Events extends CustomEvents<any> = AbstractAssistantRunnerEvents

Properties

readonly
aborted: boolean
controller: AbortController
readonly
ended: boolean
readonly
errored: boolean

Methods

protected
_addRun(run: Run): Run
protected
_connected()
protected
_createAssistantStream(
run: Runs,
threadId: string,
options?: Core.RequestOptions,
): Promise<Run>
protected
_createThreadAssistantStream(
thread: Threads,
options?: Core.RequestOptions,
): Promise<Run>
protected
_createToolAssistantStream(
run: Runs,
threadId: string,
runId: string,
options?: Core.RequestOptions,
): Promise<Run>
protected
_emit<Event extends keyof Events>(event: Event, ...args: EventParameters<Events, Event>)
protected
_run(executor: () => Promise<any>)
protected
_runAssistantStream(
threadId: string,
runs: Runs,
options?: Core.RequestOptions,
): Promise<Run>
protected
_runToolAssistantStream(
threadId: string,
runId: string,
runs: Runs,
options?: Core.RequestOptions,
): Promise<Run>
protected
_threadAssistantStream(
thread: Threads,
options?: Core.RequestOptions,
): Promise<Run>
done(): Promise<void>
emitted<Event extends keyof Events>(event: Event): Promise<EventParameters<Events, Event> extends [infer Param] ? Param : EventParameters<Events, Event> extends [] ? void : EventParameters<Events, Event>>

This is similar to .once(), but returns a Promise that resolves the next time the event is triggered, instead of calling a listener callback.

off<Event extends keyof Events>(event: Event, listener: ListenerForEvent<Events, Event>): this

Removes the specified listener from the listener array for the event. off() will remove, at most, one instance of a listener from the listener array. If any single listener has been added multiple times to the listener array for the specified event, then off() must be called multiple times to remove each instance.

on<Event extends keyof Events>(event: Event, listener: ListenerForEvent<Events, Event>): this

Adds the listener function to the end of the listeners array for the event. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of event and listener will result in the listener being added, and called, multiple times.

once<Event extends keyof Events>(event: Event, listener: ListenerForEvent<Events, Event>): this

Adds a one-time listener function for the event. The next time the event is triggered, this listener is removed and then invoked.