ai 2.1.26 → 2.1.27

package/dist/index.d.ts

@@ -83,7 +83,12 @@ declare function trimStartOfStreamHelper(): (text: string) => string;
  * @return {ReadableStream} The AIStream.
  * @throws Will throw an error if the response is not OK.
  */
-declare function AIStream(response: Response, customParser: AIStreamParser, callbacks?: AIStreamCallbacks): ReadableStream;
+declare function AIStream(response: Response, customParser: AIStreamParser, callbacks?: AIStreamCallbacks): ReadableStream<Uint8Array>;
+/**
+ * Implements ReadableStream.from(asyncIterable), which isn't documented in MDN and isn't implemented in node.
+ * https://github.com/whatwg/streams/commit/8d7a0bf26eb2cc23e884ddbaac7c1da4b91cf2bc
+ */
+declare function readableFromAsyncIterable<T>(iterable: AsyncIterable<T>): ReadableStream<T>;
 
 /**
  * Shared types between the API and UI packages.
@@ -282,7 +287,47 @@ type OpenAIStreamCallbacks = AIStreamCallbacks & {
      */
     experimental_onFunctionCall?: (functionCallPayload: FunctionCallPayload, createFunctionCallMessages: (functionCallResult: JSONValue) => CreateMessage[]) => Promise<Response | undefined | void | string>;
 };
-declare function OpenAIStream(res: Response, callbacks?: OpenAIStreamCallbacks): ReadableStream;
+interface ChatCompletionChunk {
+    id: string;
+    choices: Array<ChatCompletionChunkChoice>;
+    created: number;
+    model: string;
+    object: string;
+}
+interface ChatCompletionChunkChoice {
+    delta: ChoiceDelta;
+    finish_reason: 'stop' | 'length' | 'function_call' | null;
+    index: number;
+}
+interface ChoiceDelta {
+    /**
+     * The contents of the chunk message.
+     */
+    content?: string | null;
+    /**
+     * The name and arguments of a function that should be called, as generated by the
+     * model.
+     */
+    function_call?: FunctionCall;
+    /**
+     * The role of the author of this message.
+     */
+    role?: 'system' | 'user' | 'assistant' | 'function';
+}
+interface FunctionCall {
+    /**
+     * The arguments to call the function with, as generated by the model in JSON
+     * format. Note that the model does not always generate valid JSON, and may
+     * hallucinate parameters not defined by your function schema. Validate the
+     * arguments in your code before calling your function.
+     */
+    arguments?: string;
+    /**
+     * The name of the function to call.
+     */
+    name?: string;
+}
+declare function OpenAIStream(res: Response | AsyncIterable<ChatCompletionChunk>, callbacks?: OpenAIStreamCallbacks): ReadableStream;
 
 /**
  * A utility class for streaming text responses.
@@ -323,4 +368,4 @@ declare function LangChainStream(callbacks?: AIStreamCallbacks): {
 declare const nanoid: (size?: number | undefined) => string;
 declare function createChunkDecoder(): (chunk: Uint8Array | undefined) => string;
 
-export { AIStream, AIStreamCallbacks, AIStreamParser, AnthropicStream, ChatRequest, ChatRequestOptions, CohereStream, CreateMessage, FunctionCallHandler, FunctionCallPayload, HuggingFaceStream, LangChainStream, Message, OpenAIStream, OpenAIStreamCallbacks, RequestOptions, StreamingTextResponse, UseChatOptions, UseCompletionOptions, createCallbacksTransformer, createChunkDecoder, createEventStreamTransformer, nanoid, streamToResponse, trimStartOfStreamHelper };
+export { AIStream, AIStreamCallbacks, AIStreamParser, AnthropicStream, ChatRequest, ChatRequestOptions, CohereStream, CreateMessage, FunctionCallHandler, FunctionCallPayload, HuggingFaceStream, LangChainStream, Message, OpenAIStream, OpenAIStreamCallbacks, RequestOptions, StreamingTextResponse, UseChatOptions, UseCompletionOptions, createCallbacksTransformer, createChunkDecoder, createEventStreamTransformer, nanoid, readableFromAsyncIterable, streamToResponse, trimStartOfStreamHelper };