AssistantStream.d.ts 4.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960
  1. import { Message, Text, ImageFile, TextDelta, MessageDelta } from "../resources/beta/threads/messages.js";
  2. import { RequestOptions } from "../internal/request-options.js";
  3. import { Run, RunCreateParamsBase, Runs, RunSubmitToolOutputsParamsBase } from "../resources/beta/threads/runs/runs.js";
  4. import { type ReadableStream } from "../internal/shim-types.js";
  5. import { AssistantStreamEvent } from "../resources/beta/assistants.js";
  6. import { RunStep, RunStepDelta, ToolCall, ToolCallDelta } from "../resources/beta/threads/runs/steps.js";
  7. import { ThreadCreateAndRunParamsBase, Threads } from "../resources/beta/threads/threads.js";
  8. import { BaseEvents, EventStream } from "./EventStream.js";
  9. export interface AssistantStreamEvents extends BaseEvents {
  10. run: (run: Run) => void;
  11. messageCreated: (message: Message) => void;
  12. messageDelta: (message: MessageDelta, snapshot: Message) => void;
  13. messageDone: (message: Message) => void;
  14. runStepCreated: (runStep: RunStep) => void;
  15. runStepDelta: (delta: RunStepDelta, snapshot: Runs.RunStep) => void;
  16. runStepDone: (runStep: Runs.RunStep, snapshot: Runs.RunStep) => void;
  17. toolCallCreated: (toolCall: ToolCall) => void;
  18. toolCallDelta: (delta: ToolCallDelta, snapshot: ToolCall) => void;
  19. toolCallDone: (toolCall: ToolCall) => void;
  20. textCreated: (content: Text) => void;
  21. textDelta: (delta: TextDelta, snapshot: Text) => void;
  22. textDone: (content: Text, snapshot: Message) => void;
  23. imageFileDone: (content: ImageFile, snapshot: Message) => void;
  24. event: (event: AssistantStreamEvent) => void;
  25. }
  26. export type ThreadCreateAndRunParamsBaseStream = Omit<ThreadCreateAndRunParamsBase, 'stream'> & {
  27. stream?: true;
  28. };
  29. export type RunCreateParamsBaseStream = Omit<RunCreateParamsBase, 'stream'> & {
  30. stream?: true;
  31. };
  32. export type RunSubmitToolOutputsParamsStream = Omit<RunSubmitToolOutputsParamsBase, 'stream'> & {
  33. stream?: true;
  34. };
  35. export declare class AssistantStream extends EventStream<AssistantStreamEvents> implements AsyncIterable<AssistantStreamEvent> {
  36. #private;
  37. [Symbol.asyncIterator](): AsyncIterator<AssistantStreamEvent>;
  38. static fromReadableStream(stream: ReadableStream): AssistantStream;
  39. protected _fromReadableStream(readableStream: ReadableStream, options?: RequestOptions): Promise<Run>;
  40. toReadableStream(): ReadableStream;
  41. static createToolAssistantStream(runId: string, runs: Runs, params: RunSubmitToolOutputsParamsStream, options: RequestOptions | undefined): AssistantStream;
  42. protected _createToolAssistantStream(run: Runs, runId: string, params: RunSubmitToolOutputsParamsStream, options?: RequestOptions): Promise<Run>;
  43. static createThreadAssistantStream(params: ThreadCreateAndRunParamsBaseStream, thread: Threads, options?: RequestOptions): AssistantStream;
  44. static createAssistantStream(threadId: string, runs: Runs, params: RunCreateParamsBaseStream, options?: RequestOptions): AssistantStream;
  45. currentEvent(): AssistantStreamEvent | undefined;
  46. currentRun(): Run | undefined;
  47. currentMessageSnapshot(): Message | undefined;
  48. currentRunStepSnapshot(): Runs.RunStep | undefined;
  49. finalRunSteps(): Promise<Runs.RunStep[]>;
  50. finalMessages(): Promise<Message[]>;
  51. finalRun(): Promise<Run>;
  52. protected _createThreadAssistantStream(thread: Threads, params: ThreadCreateAndRunParamsBase, options?: RequestOptions): Promise<Run>;
  53. protected _createAssistantStream(run: Runs, threadId: string, params: RunCreateParamsBase, options?: RequestOptions): Promise<Run>;
  54. static accumulateDelta(acc: Record<string, any>, delta: Record<string, any>): Record<string, any>;
  55. protected _addRun(run: Run): Run;
  56. protected _threadAssistantStream(params: ThreadCreateAndRunParamsBase, thread: Threads, options?: RequestOptions): Promise<Run>;
  57. protected _runAssistantStream(threadId: string, runs: Runs, params: RunCreateParamsBase, options?: RequestOptions): Promise<Run>;
  58. protected _runToolAssistantStream(runId: string, runs: Runs, params: RunSubmitToolOutputsParamsStream, options?: RequestOptions): Promise<Run>;
  59. }
  60. //# sourceMappingURL=AssistantStream.d.ts.map