AssistantStream.d.ts 4.1 KB

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