ChatCompletionStreamingRunner.d.ts 2.0 KB

123456789101112131415161718192021222324
  1. import { type ChatCompletionChunk, type ChatCompletionCreateParamsStreaming } from "../resources/chat/completions.js";
  2. import { RunnerOptions, type AbstractChatCompletionRunnerEvents } from "./AbstractChatCompletionRunner.js";
  3. import { type ReadableStream } from "../_shims/index.js";
  4. import { RunnableTools, type BaseFunctionsArgs, type RunnableFunctions } from "./RunnableFunction.js";
  5. import { ChatCompletionSnapshot, ChatCompletionStream } from "./ChatCompletionStream.js";
  6. import OpenAI from "../index.js";
  7. import { AutoParseableTool } from "../lib/parser.js";
  8. export interface ChatCompletionStreamEvents extends AbstractChatCompletionRunnerEvents {
  9. content: (contentDelta: string, contentSnapshot: string) => void;
  10. chunk: (chunk: ChatCompletionChunk, snapshot: ChatCompletionSnapshot) => void;
  11. }
  12. export type ChatCompletionStreamingFunctionRunnerParams<FunctionsArgs extends BaseFunctionsArgs> = Omit<ChatCompletionCreateParamsStreaming, 'functions'> & {
  13. functions: RunnableFunctions<FunctionsArgs>;
  14. };
  15. export type ChatCompletionStreamingToolRunnerParams<FunctionsArgs extends BaseFunctionsArgs> = Omit<ChatCompletionCreateParamsStreaming, 'tools'> & {
  16. tools: RunnableTools<FunctionsArgs> | AutoParseableTool<any, true>[];
  17. };
  18. export declare class ChatCompletionStreamingRunner<ParsedT = null> extends ChatCompletionStream<ParsedT> implements AsyncIterable<ChatCompletionChunk> {
  19. static fromReadableStream(stream: ReadableStream): ChatCompletionStreamingRunner<null>;
  20. /** @deprecated - please use `runTools` instead. */
  21. static runFunctions<T extends (string | object)[]>(client: OpenAI, params: ChatCompletionStreamingFunctionRunnerParams<T>, options?: RunnerOptions): ChatCompletionStreamingRunner<null>;
  22. static runTools<T extends (string | object)[], ParsedT = null>(client: OpenAI, params: ChatCompletionStreamingToolRunnerParams<T>, options?: RunnerOptions): ChatCompletionStreamingRunner<ParsedT>;
  23. }
  24. //# sourceMappingURL=ChatCompletionStreamingRunner.d.ts.map