Interface ChatApiEvents

interface ChatApiEvents {
    completed: ChatCompletionResult;
    error: {
        error: string;
        errorCode?: string;
        jobID: string;
        message: string;
        workerName?: string;
    };
    jobState: ChatJobStateEvent;
    modelsUpdated: Record<string, LLMModelInfo>;
    token: ChatCompletionChunk;
}

Properties

completed error jobState modelsUpdated token

Properties

completed

completed: ChatCompletionResult

Emitted when a chat completion finishes

error

error: {
    error: string;
    errorCode?: string;
    jobID: string;
    message: string;
    workerName?: string;
}

Emitted when a chat completion fails

Type declaration

  • error: string
  • OptionalerrorCode?: string

    Server error code as a string (e.g. '4080') when the failure carries one — see SUBSCRIPTION_ERROR_CODES for subscription denials.

  • jobID: string
  • message: string
  • OptionalworkerName?: string

jobState

jobState: ChatJobStateEvent

Emitted when the job state changes (queued, assigned to worker, started, etc.)

modelsUpdated

modelsUpdated: Record<string, LLMModelInfo>

Emitted when the available LLM models list is updated from the network

token

token: ChatCompletionChunk

Emitted for each token chunk received during streaming

Settings

Member Visibility

On This Page

Properties