@axflow/models/dist/shared/index.d.mts

Zero-dependency, modular SDK for building robust natural language applications

declare class HttpError extends Error {
    readonly code: number;
    readonly response: Response;
    constructor(message: string, response: Response);
}
declare function isHttpError(e: unknown): e is HttpError;
type HttpOptionsType = RequestInit & {
    fetch?: typeof fetch;
};
declare function POST(url: string, options?: HttpOptionsType): Promise<Response>;

type RecursivePartial<T> = {
    [P in keyof T]?: T[P] extends (infer U)[] ? RecursivePartial<U>[] : T[P] extends object | undefined ? RecursivePartial<T[P]> : T[P];
};

type JSONValueType = null | string | number | boolean | {
    [x: string]: JSONValueType;
} | Array<JSONValueType>;
type FunctionType = {
    name: string;
    description?: string;
    parameters: JSONValueType;
};
type ToolType = {
    type: 'function';
    function: FunctionType;
};
type ToolCallType = {
    index: number;
    id: string;
    type: 'function';
    function: {
        name: string;
        arguments: string;
    };
};
declare const toolCallWithDefaults: (toolCall: RecursivePartial<ToolCallType>) => ToolCallType;
type MessageType = {
    /**
     * Can be any unique string.
     *
     * For example, the `useChat` hook uses UUIDs because of their native availability in both Node and browsers.
     *
     * @see https://developer.mozilla.org/en-US/docs/Web/API/Crypto/randomUUID
     */
    id: string;
    /**
     * Specifies who this message is from.
     */
    role: 'user' | 'assistant' | 'system';
    /**
     * The content of the message. If the message was a function call from the assistant,
     * then this field will be an empty string and the `functionCall` field will be populated.
     */
    content: string;
    /**
     * The time this message was created, expressed as milliseconds since Epoch.
     *
     * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/now
     */
    created: number;
    /**
     * Any additional data to associate with the message.
     */
    data?: JSONValueType[];
    /**
     * If using OpenAI functions, the functions available to the assistant can be defined here.
     *
     * @see https://platform.openai.com/docs/api-reference/chat/create
     */
    functions?: FunctionType[];
    /**
     * If using OpenAI functions and the assistant responds with a function call,
     * this field will be populated with the function invocation information.
     *
     * @see https://platform.openai.com/docs/api-reference/chat/object
     */
    functionCall?: {
        name: string;
        arguments: string;
    };
    /**
     * If using openAI tools, the tools available to the assistant can be defined here.
     *
     * @see  https://platform.openai.com/docs/guides/function-calling
     */
    tools?: ToolType[];
    /**
     * If using OpenAI tools and the assistant responds with one or more tool calls,
     * this field will be populated with the tool invocation information.
     *
     *
     * @see https://platform.openai.com/docs/guides/function-calling
     */
    toolCalls?: ToolCallType[];
};

/**
 * Converts an AsyncIterable<T> to a ReadableStream<T>.
 *
 * ReadableStreams implement this natively as `ReadableStream.from` but this is
 * hardly available in any environments as of the time this was written.
 *
 * @see https://developer.mozilla.org/en-US/docs/Web/API/ReadableStream/from_static
 *
 * @param iterable Any async iterable object.
 * @returns A ReadableStream over the iterable contents.
 */
declare function IterableToStream<T>(iterable: AsyncIterable<T>): ReadableStream<T>;
/**
 * Convert a ReadableStream<T> to an AsyncIterable<T>.
 *
 * ReadableStreams implement this natively in recent node versions. Unfortunately, older
 * node versions, most browsers, and the TypeScript type system do not support it yet.
 *
 * Example:
 *
 *     for await (const chunk of StreamToIterable(stream)) {
 *       // Do stuff with chunk
 *     }
 *
 * @param stream A ReadableStream.
 * @returns An AsyncIterable over the stream contents.
 */
declare function StreamToIterable<T>(stream: ReadableStream<T>): AsyncIterable<T>;
type NdJsonValueType = {
    type: 'chunk' | 'data';
    value: JSONValueType;
};
/**
 * An object that can encode and decode newline-delimited JSON in the following format:
 *
 *     { type: 'data' | 'chunk', value: <any valid JSON value> }
 *
 * When `type` is `chunk`, `value` represents a chunk of the source stream. When `type`
 * is `data`, `value` represents any additional data sent along with the source stream.
 *
 * @see http://ndjson.org
 */
declare class NdJsonStream {
    /**
     * These are the proper headers for newline-delimited JSON streams.
     *
     * @see http://ndjson.org
     */
    static headers: Readonly<{
        'content-type': "application/x-ndjson; charset=utf-8";
    }>;
    /**
     * Transforms a stream of JSON-serializable objects to stream of newline-delimited JSON.
     *
     * Each object is wrapped with an object that specifies the `type` and references
     * the `value`. The `type` is one of `chunk` or `data`. A type of `chunk` means that
     * the `value` corresponds to chunks from the input stream. A type of `data` means
     * that the `value` corresponds to the additional data provided as the second argument
     * to this function.
     *
     *
     * Example WITHOUT additional data:
     *
     *     const chunk = { key: 'value' };
     *     const stream = new ReadableStream({start(con) { con.enqueue(chunk); con.close() }});
     *     const ndJsonStream = NdJsonStream.encode(stream);
     *     const entries = [];
     *     for await (const chunk of stream) {
     *       entry.push(new TextDecoder().decode(chunk));
     *     }
     *     console.log(entries); // [ "{\"type\":\"chunk\",\"value\":{\"key\":\"value\"}}\n" ]
     *
     *
     * Example WITH additional data:
     *
     *     const chunk = { key: 'value' };
     *     const stream = new ReadableStream({start(con) { con.enqueue(chunk); con.close() }});
     *     const ndJsonStream = NdJsonStream.encode(stream, { data: [{ extra: 'data' }] });
     *     const entries = [];
     *     for await (const chunk of stream) {
     *       entry.push(new TextDecoder().decode(chunk));
     *     }
     *     console.log(entries); // [ "{\"type\":\"data\",\"value\":{\"extra\":\"data\"}}\n", "{\"type\":\"chunk\",\"value\":{\"key\":\"value\"}}\n" ]
     *
     * @see http://ndjson.org
     *
     * @param stream A readable stream of chunks to encode as newline-delimited JSON.
     * @param options
     * @param options.data Additional data to enqueue to the output stream. If data is a `Promise`, the stream will wait for it to resolve and enqueue its resolved values before closing.
     * @returns A readable stream of newline-delimited JSON.
     */
    static encode<T = any>(stream: ReadableStream<T>, options?: {
        data?: JSONValueType[] | Promise<JSONValueType[]>;
    }): ReadableStream<Uint8Array>;
    /**
     * Transforms a stream of newline-delimited JSON to a stream of objects.
     *
     * @see http://ndjson.org
     *
     * @param stream A readable stream of newline-delimited JSON objects.
     * @returns A readable stream of objects.
     */
    static decode(stream: ReadableStream<Uint8Array>): ReadableStream<NdJsonValueType>;
}
/**
 * A subclass of `Response` that streams newline-delimited JSON.
 */
declare class StreamingJsonResponse<T> extends Response {
    /**
     * Create a `Response` object that streams newline-delimited JSON objects.
     *
     * Example
     *
     *      export async function POST(request: Request) {
     *       const req = await request.json();
     *       const stream = await OpenAIChat.stream(req, { apiKey: OPENAI_API_KEY });
     *       return new StreamingJsonResponse(stream, {
     *         map: (chunk) => chunk.choices[0].delta.content ?? ''
     *         data: [{ stream: "additional" }, { data: "here" }]
     *       });
     *     }
     *
     * @see http://ndjson.org
     *
     * @param stream A readable stream of chunks to encode as newline-delimited JSON.
     * @param options
     * @param options.status HTTP response status.
     * @param options.statusText HTTP response status text.
     * @param options.headers HTTP response headers.
     * @param options.data Additional data to enqueue to the output stream. If data is a `Promise`, the stream will wait for it to resolve and enqueue its resolved values before closing.
     */
    constructor(stream: ReadableStream<T>, options?: ResponseInit & {
        data?: JSONValueType[] | Promise<JSONValueType[]>;
    });
}

declare const createMessage: (message: Partial<MessageType>) => MessageType;

export { FunctionType, HttpError, IterableToStream, JSONValueType, MessageType, NdJsonStream, NdJsonValueType, POST, RecursivePartial, StreamToIterable, StreamingJsonResponse, ToolCallType, ToolType, createMessage, isHttpError, toolCallWithDefaults };