ai 2.2.33 → 2.2.35

package/dist/index.d.ts

@@ -280,78 +280,6 @@ type DataMessage = {
     data: JSONValue;
 };
 
-interface StreamPart<CODE extends string, NAME extends string, TYPE> {
-    code: CODE;
-    name: NAME;
-    parse: (value: JSONValue) => {
-        type: NAME;
-        value: TYPE;
-    };
-}
-declare const textStreamPart: StreamPart<'0', 'text', string>;
-declare const functionCallStreamPart: StreamPart<'1', 'function_call', {
-    function_call: FunctionCall;
-}>;
-declare const dataStreamPart: StreamPart<'2', 'data', Array<JSONValue>>;
-declare const errorStreamPart: StreamPart<'3', 'error', string>;
-declare const assistantMessageStreamPart: StreamPart<'4', 'assistant_message', AssistantMessage>;
-declare const assistantControlDataStreamPart: StreamPart<'5', 'assistant_control_data', {
-    threadId: string;
-    messageId: string;
-}>;
-declare const dataMessageStreamPart: StreamPart<'6', 'data_message', DataMessage>;
-declare const toolCallStreamPart: StreamPart<'7', 'tool_calls', {
-    tool_calls: ToolCall[];
-}>;
-declare const messageAnnotationsStreamPart: StreamPart<'8', 'message_annotations', Array<JSONValue>>;
-type StreamPartType = ReturnType<typeof textStreamPart.parse> | ReturnType<typeof functionCallStreamPart.parse> | ReturnType<typeof dataStreamPart.parse> | ReturnType<typeof errorStreamPart.parse> | ReturnType<typeof assistantMessageStreamPart.parse> | ReturnType<typeof assistantControlDataStreamPart.parse> | ReturnType<typeof dataMessageStreamPart.parse> | ReturnType<typeof toolCallStreamPart.parse> | ReturnType<typeof messageAnnotationsStreamPart.parse>;
-/**
- * The map of prefixes for data in the stream
- *
- * - 0: Text from the LLM response
- * - 1: (OpenAI) function_call responses
- * - 2: custom JSON added by the user using `Data`
- * - 6: (OpenAI) tool_call responses
- *
- * Example:
- * ```
- * 0:Vercel
- * 0:'s
- * 0: AI
- * 0: AI
- * 0: SDK
- * 0: is great
- * 0:!
- * 2: { "someJson": "value" }
- * 1: {"function_call": {"name": "get_current_weather", "arguments": "{\\n\\"location\\": \\"Charlottesville, Virginia\\",\\n\\"format\\": \\"celsius\\"\\n}"}}
- * 6: {"tool_call": {"id": "tool_0", "type": "function", "function": {"name": "get_current_weather", "arguments": "{\\n\\"location\\": \\"Charlottesville, Virginia\\",\\n\\"format\\": \\"celsius\\"\\n}"}}}
- *```
- */
-declare const StreamStringPrefixes: {
-    readonly text: "0";
-    readonly function_call: "1";
-    readonly data: "2";
-    readonly error: "3";
-    readonly assistant_message: "4";
-    readonly assistant_control_data: "5";
-    readonly data_message: "6";
-    readonly tool_calls: "7";
-    readonly message_annotations: "8";
-};
-
-declare const nanoid: (size?: number | undefined) => string;
-declare function createChunkDecoder(): (chunk: Uint8Array | undefined) => string;
-declare function createChunkDecoder(complex: false): (chunk: Uint8Array | undefined) => string;
-declare function createChunkDecoder(complex: true): (chunk: Uint8Array | undefined) => StreamPartType[];
-declare function createChunkDecoder(complex?: boolean): (chunk: Uint8Array | undefined) => StreamPartType[] | string;
-
-declare const isStreamStringEqualToType: (type: keyof typeof StreamStringPrefixes, value: string) => value is `0:${string}\n` | `1:${string}\n` | `2:${string}\n` | `3:${string}\n` | `4:${string}\n` | `5:${string}\n` | `6:${string}\n` | `7:${string}\n` | `8:${string}\n`;
-type StreamString = `${(typeof StreamStringPrefixes)[keyof typeof StreamStringPrefixes]}:${string}\n`;
-/**
- * A header sent to the client so it knows how to handle parsing the stream (as a deprecated text response or using the new prefixed protocol)
- */
-declare const COMPLEX_HEADER = "X-Experimental-Stream-Data";
-
 declare interface AzureChatCompletions {
     id: string;
     created: Date;
@@ -697,6 +625,63 @@ declare function AIStream(response: Response, customParser?: AIStreamParser, cal
  */
 declare function readableFromAsyncIterable<T>(iterable: AsyncIterable<T>): ReadableStream<T>;
 
+interface AWSBedrockResponse {
+    body?: AsyncIterable<{
+        chunk?: {
+            bytes?: Uint8Array;
+        };
+    }>;
+}
+declare function AWSBedrockAnthropicStream(response: AWSBedrockResponse, callbacks?: AIStreamCallbacksAndOptions): ReadableStream;
+declare function AWSBedrockCohereStream(response: AWSBedrockResponse, callbacks?: AIStreamCallbacksAndOptions): ReadableStream;
+declare function AWSBedrockLlama2Stream(response: AWSBedrockResponse, callbacks?: AIStreamCallbacksAndOptions): ReadableStream;
+declare function AWSBedrockStream(response: AWSBedrockResponse, callbacks: AIStreamCallbacksAndOptions | undefined, extractTextDeltaFromChunk: (chunk: any) => string): ReadableStream<any>;
+
+/**
+ * A stream wrapper to send custom JSON-encoded data back to the client.
+ */
+declare class experimental_StreamData {
+    private encoder;
+    private controller;
+    stream: TransformStream<Uint8Array, Uint8Array>;
+    private isClosedPromise;
+    private isClosedPromiseResolver;
+    private isClosed;
+    private data;
+    private messageAnnotations;
+    constructor();
+    close(): Promise<void>;
+    append(value: JSONValue): void;
+    appendMessageAnnotation(value: JSONValue): void;
+}
+/**
+ * A TransformStream for LLMs that do not have their own transform stream handlers managing encoding (e.g. OpenAIStream has one for function call handling).
+ * This assumes every chunk is a 'text' chunk.
+ */
+declare function createStreamDataTransformer(experimental_streamData: boolean | undefined): TransformStream<any, any>;
+
+/**
+ * A utility class for streaming text responses.
+ */
+declare class StreamingTextResponse extends Response {
+    constructor(res: ReadableStream, init?: ResponseInit, data?: experimental_StreamData);
+}
+/**
+ * A utility function to stream a ReadableStream to a Node.js response-like object.
+ */
+declare function streamToResponse(res: ReadableStream, response: ServerResponse, init?: {
+    headers?: Record<string, string>;
+    status?: number;
+}): void;
+
+declare function HuggingFaceStream(res: AsyncGenerator<any>, callbacks?: AIStreamCallbacksAndOptions): ReadableStream;
+
+interface StreamChunk {
+    text?: string;
+    eventType: 'stream-start' | 'search-queries-generation' | 'search-results' | 'text-generation' | 'citation-generation' | 'stream-end';
+}
+declare function CohereStream(reader: Response | AsyncIterable<StreamChunk>, callbacks?: AIStreamCallbacksAndOptions): ReadableStream;
+
 interface CompletionChunk {
     /**
      * The resulting completion up to and excluding the stop sequences.
@@ -771,56 +756,16 @@ interface MessageStopEvent {
  */
 declare function AnthropicStream(res: Response | AsyncIterable<CompletionChunk> | AsyncIterable<MessageStreamEvent>, cb?: AIStreamCallbacksAndOptions): ReadableStream;
 
-type AssistantResponseSettings = {
-    threadId: string;
-    messageId: string;
+type InkeepOnFinalMetadata = {
+    chat_session_id: string;
+    records_cited: any;
 };
-type AssistantResponseCallback = (stream: {
-    threadId: string;
-    messageId: string;
-    sendMessage: (message: AssistantMessage) => void;
-    sendDataMessage: (message: DataMessage) => void;
-}) => Promise<void>;
-declare function experimental_AssistantResponse({ threadId, messageId }: AssistantResponseSettings, process: AssistantResponseCallback): Response;
-
-interface AWSBedrockResponse {
-    body?: AsyncIterable<{
-        chunk?: {
-            bytes?: Uint8Array;
-        };
-    }>;
-}
-declare function AWSBedrockAnthropicStream(response: AWSBedrockResponse, callbacks?: AIStreamCallbacksAndOptions): ReadableStream;
-declare function AWSBedrockCohereStream(response: AWSBedrockResponse, callbacks?: AIStreamCallbacksAndOptions): ReadableStream;
-declare function AWSBedrockLlama2Stream(response: AWSBedrockResponse, callbacks?: AIStreamCallbacksAndOptions): ReadableStream;
-declare function AWSBedrockStream(response: AWSBedrockResponse, callbacks: AIStreamCallbacksAndOptions | undefined, extractTextDeltaFromChunk: (chunk: any) => string): ReadableStream<any>;
-
-declare function CohereStream(reader: Response, callbacks?: AIStreamCallbacksAndOptions): ReadableStream;
-
-interface GenerateContentResponse {
-    candidates?: GenerateContentCandidate[];
-}
-interface GenerateContentCandidate {
-    index: number;
-    content: Content;
-}
-interface Content {
-    role: string;
-    parts: Part[];
-}
-type Part = TextPart | InlineDataPart;
-interface InlineDataPart {
-    text?: never;
-}
-interface TextPart {
-    text: string;
-    inlineData?: never;
-}
-declare function GoogleGenerativeAIStream(response: {
-    stream: AsyncIterable<GenerateContentResponse>;
-}, cb?: AIStreamCallbacksAndOptions): ReadableStream;
-
-declare function HuggingFaceStream(res: AsyncGenerator<any>, callbacks?: AIStreamCallbacksAndOptions): ReadableStream;
+type InkeepChatResultCallbacks = {
+    onFinal?: (completion: string, metadata?: InkeepOnFinalMetadata) => Promise<void> | void;
+    onRecordsCited?: (records_cited: InkeepOnFinalMetadata['records_cited']) => void;
+};
+type InkeepAIStreamCallbacksAndOptions = AIStreamCallbacksAndOptions & InkeepChatResultCallbacks;
+declare function InkeepStream(res: Response, callbacks?: InkeepAIStreamCallbacksAndOptions): ReadableStream;
 
 declare function LangChainStream(callbacks?: AIStreamCallbacksAndOptions): {
     stream: ReadableStream<any>;
@@ -885,28 +830,112 @@ declare function ReplicateStream(res: Prediction, cb?: AIStreamCallbacksAndOptio
     headers?: Record<string, string>;
 }): Promise<ReadableStream>;
 
+interface StreamPart<CODE extends string, NAME extends string, TYPE> {
+    code: CODE;
+    name: NAME;
+    parse: (value: JSONValue) => {
+        type: NAME;
+        value: TYPE;
+    };
+}
+declare const textStreamPart: StreamPart<'0', 'text', string>;
+declare const functionCallStreamPart: StreamPart<'1', 'function_call', {
+    function_call: FunctionCall;
+}>;
+declare const dataStreamPart: StreamPart<'2', 'data', Array<JSONValue>>;
+declare const errorStreamPart: StreamPart<'3', 'error', string>;
+declare const assistantMessageStreamPart: StreamPart<'4', 'assistant_message', AssistantMessage>;
+declare const assistantControlDataStreamPart: StreamPart<'5', 'assistant_control_data', {
+    threadId: string;
+    messageId: string;
+}>;
+declare const dataMessageStreamPart: StreamPart<'6', 'data_message', DataMessage>;
+declare const toolCallStreamPart: StreamPart<'7', 'tool_calls', {
+    tool_calls: ToolCall[];
+}>;
+declare const messageAnnotationsStreamPart: StreamPart<'8', 'message_annotations', Array<JSONValue>>;
+type StreamPartType = ReturnType<typeof textStreamPart.parse> | ReturnType<typeof functionCallStreamPart.parse> | ReturnType<typeof dataStreamPart.parse> | ReturnType<typeof errorStreamPart.parse> | ReturnType<typeof assistantMessageStreamPart.parse> | ReturnType<typeof assistantControlDataStreamPart.parse> | ReturnType<typeof dataMessageStreamPart.parse> | ReturnType<typeof toolCallStreamPart.parse> | ReturnType<typeof messageAnnotationsStreamPart.parse>;
 /**
- * A stream wrapper to send custom JSON-encoded data back to the client.
+ * The map of prefixes for data in the stream
+ *
+ * - 0: Text from the LLM response
+ * - 1: (OpenAI) function_call responses
+ * - 2: custom JSON added by the user using `Data`
+ * - 6: (OpenAI) tool_call responses
+ *
+ * Example:
+ * ```
+ * 0:Vercel
+ * 0:'s
+ * 0: AI
+ * 0: AI
+ * 0: SDK
+ * 0: is great
+ * 0:!
+ * 2: { "someJson": "value" }
+ * 1: {"function_call": {"name": "get_current_weather", "arguments": "{\\n\\"location\\": \\"Charlottesville, Virginia\\",\\n\\"format\\": \\"celsius\\"\\n}"}}
+ * 6: {"tool_call": {"id": "tool_0", "type": "function", "function": {"name": "get_current_weather", "arguments": "{\\n\\"location\\": \\"Charlottesville, Virginia\\",\\n\\"format\\": \\"celsius\\"\\n}"}}}
+ *```
  */
-declare class experimental_StreamData {
-    private encoder;
-    private controller;
-    stream: TransformStream<Uint8Array, Uint8Array>;
-    private isClosedPromise;
-    private isClosedPromiseResolver;
-    private isClosed;
-    private data;
-    private messageAnnotations;
-    constructor();
-    close(): Promise<void>;
-    append(value: JSONValue): void;
-    appendMessageAnnotation(value: JSONValue): void;
-}
+declare const StreamStringPrefixes: {
+    readonly text: "0";
+    readonly function_call: "1";
+    readonly data: "2";
+    readonly error: "3";
+    readonly assistant_message: "4";
+    readonly assistant_control_data: "5";
+    readonly data_message: "6";
+    readonly tool_calls: "7";
+    readonly message_annotations: "8";
+};
+
+declare const nanoid: (size?: number | undefined) => string;
+declare function createChunkDecoder(): (chunk: Uint8Array | undefined) => string;
+declare function createChunkDecoder(complex: false): (chunk: Uint8Array | undefined) => string;
+declare function createChunkDecoder(complex: true): (chunk: Uint8Array | undefined) => StreamPartType[];
+declare function createChunkDecoder(complex?: boolean): (chunk: Uint8Array | undefined) => StreamPartType[] | string;
+
+declare const isStreamStringEqualToType: (type: keyof typeof StreamStringPrefixes, value: string) => value is `0:${string}\n` | `1:${string}\n` | `2:${string}\n` | `3:${string}\n` | `4:${string}\n` | `5:${string}\n` | `6:${string}\n` | `7:${string}\n` | `8:${string}\n`;
+type StreamString = `${(typeof StreamStringPrefixes)[keyof typeof StreamStringPrefixes]}:${string}\n`;
 /**
- * A TransformStream for LLMs that do not have their own transform stream handlers managing encoding (e.g. OpenAIStream has one for function call handling).
- * This assumes every chunk is a 'text' chunk.
+ * A header sent to the client so it knows how to handle parsing the stream (as a deprecated text response or using the new prefixed protocol)
  */
-declare function createStreamDataTransformer(experimental_streamData: boolean | undefined): TransformStream<any, any>;
+declare const COMPLEX_HEADER = "X-Experimental-Stream-Data";
+
+type AssistantResponseSettings = {
+    threadId: string;
+    messageId: string;
+};
+type AssistantResponseCallback = (stream: {
+    threadId: string;
+    messageId: string;
+    sendMessage: (message: AssistantMessage) => void;
+    sendDataMessage: (message: DataMessage) => void;
+}) => Promise<void>;
+declare function experimental_AssistantResponse({ threadId, messageId }: AssistantResponseSettings, process: AssistantResponseCallback): Response;
+
+interface GenerateContentResponse {
+    candidates?: GenerateContentCandidate[];
+}
+interface GenerateContentCandidate {
+    index: number;
+    content: Content;
+}
+interface Content {
+    role: string;
+    parts: Part[];
+}
+type Part = TextPart | InlineDataPart;
+interface InlineDataPart {
+    text?: never;
+}
+interface TextPart {
+    text: string;
+    inlineData?: never;
+}
+declare function GoogleGenerativeAIStream(response: {
+    stream: AsyncIterable<GenerateContentResponse>;
+}, cb?: AIStreamCallbacksAndOptions): ReadableStream;
 
 /**
  * This is a naive implementation of the streaming React response API.
@@ -940,18 +969,4 @@ declare class experimental_StreamingReactResponse {
     });
 }
 
-/**
- * A utility class for streaming text responses.
- */
-declare class StreamingTextResponse extends Response {
-    constructor(res: ReadableStream, init?: ResponseInit, data?: experimental_StreamData);
-}
-/**
- * A utility function to stream a ReadableStream to a Node.js response-like object.
- */
-declare function streamToResponse(res: ReadableStream, response: ServerResponse, init?: {
-    headers?: Record<string, string>;
-    status?: number;
-}): void;
-
-export { AIStream, AIStreamCallbacksAndOptions, AIStreamParser, AIStreamParserOptions, AWSBedrockAnthropicStream, AWSBedrockCohereStream, AWSBedrockLlama2Stream, AWSBedrockStream, AnthropicStream, AssistantMessage, COMPLEX_HEADER, ChatRequest, ChatRequestOptions, CohereStream, CompletionUsage, CreateMessage, DataMessage, Function, FunctionCall, FunctionCallHandler, FunctionCallPayload, GoogleGenerativeAIStream, HuggingFaceStream, IdGenerator, JSONValue, LangChainStream, Message$1 as Message, OpenAIStream, OpenAIStreamCallbacks, ReactResponseRow, ReplicateStream, RequestOptions, StreamString, StreamingTextResponse, Tool, ToolCall, ToolCallHandler, ToolCallPayload, ToolChoice, UseChatOptions, UseCompletionOptions, createCallbacksTransformer, createChunkDecoder, createEventStreamTransformer, createStreamDataTransformer, experimental_AssistantResponse, experimental_StreamData, experimental_StreamingReactResponse, isStreamStringEqualToType, nanoid, readableFromAsyncIterable, streamToResponse, trimStartOfStreamHelper };
+export { AIStream, AIStreamCallbacksAndOptions, AIStreamParser, AIStreamParserOptions, AWSBedrockAnthropicStream, AWSBedrockCohereStream, AWSBedrockLlama2Stream, AWSBedrockStream, AnthropicStream, AssistantMessage, COMPLEX_HEADER, ChatRequest, ChatRequestOptions, CohereStream, CompletionUsage, CreateMessage, DataMessage, Function, FunctionCall, FunctionCallHandler, FunctionCallPayload, GoogleGenerativeAIStream, HuggingFaceStream, IdGenerator, InkeepAIStreamCallbacksAndOptions, InkeepChatResultCallbacks, InkeepOnFinalMetadata, InkeepStream, JSONValue, LangChainStream, Message$1 as Message, OpenAIStream, OpenAIStreamCallbacks, ReactResponseRow, ReplicateStream, RequestOptions, StreamString, StreamingTextResponse, Tool, ToolCall, ToolCallHandler, ToolCallPayload, ToolChoice, UseChatOptions, UseCompletionOptions, createCallbacksTransformer, createChunkDecoder, createEventStreamTransformer, createStreamDataTransformer, experimental_AssistantResponse, experimental_StreamData, experimental_StreamingReactResponse, isStreamStringEqualToType, nanoid, readableFromAsyncIterable, streamToResponse, trimStartOfStreamHelper };