ollama-api-facade-js/dist/models/ChatModels.d.ts

OllamaApiFacadeJS is an open-source library for running an ExpressJS backend as an Ollama API using LangChainJS. It supports local language models services like LmStudio and allows seamless message conversion and streaming between LangChainJS and Ollama c

import { BaseMessage, HumanMessage } from '@langchain/core/messages';
import { BaseChatModel } from '@langchain/core/language_models/chat_models';
import { ChatResponse } from '../core/ChatResponse';
import { ToolCallService } from '../core/ToolCallService';
/**
 * Class representing a chat request.
 * This is submitted by the Ollama client and automatically mapped to LangChain message objects.
 */
export declare class ChatRequest {
    /**
     * The chat ID.
     */
    chat_id: string;
    /**
     * The request ID.
     */
    id: string;
    /**
     * An array of chat messages based on LangChain message types sent by the client.
     */
    messages: BaseMessage[];
    /**
     * The model to be used for the chat.
     */
    model: string;
    /**
     * Additional options for the chat request.
     */
    options: {
        [key: string]: any;
    };
    /**
     * The session ID.
     */
    session_id: string;
    /**
     * Indicates whether the response should be streamed.
     */
    stream: boolean;
    constructor({ chat_id, id, messages, model, options, session_id, stream, }: {
        chat_id: string;
        id: string;
        messages: BaseMessage[];
        model: string;
        options: {
            [key: string]: any;
        };
        session_id: string;
        stream: boolean;
    });
    /**
     * Adds a system message.
     * @param systemPrompt - The system message to be added.
     */
    addSystemMessage(systemPrompt: string): void;
    /**
     * Retrieves the last human message from the chat messages.
     * @returns {HumanMessage} - The last human message.
     */
    lastHumanMessage(): HumanMessage | undefined;
    /**
     * Replaces the last human message in the chat messages.
     * @param {HumanMessage | string} humanMessage - The new human message to replace the last one. Can be a HumanMessage object or a string.
     * @returns {BaseMessage[]} - The updated array of chat messages.
     */
    replaceLastHumanMessage(humanMessage: HumanMessage | string): BaseMessage[];
}
/**
 * Interface representing a native chat message.
 */
export interface NativeChatMessage {
    /**
     * The role of the message sender (e.g., system, user, assistant).
     */
    role: string;
    /**
     * The content of the message.
     */
    content: string;
}
/**
 * Type representing a chat handler function.
 * @param {ChatRequest} chatRequest - The chat request object submitted by the Ollama client.
 * @param {BaseChatModel} chatModel - The LangChain chat model service used to communicate with the language model.
 * @param {ChatResponse} chatResponse - The proxy that streams LangChain incoming messages back to the client.
 * @param {ToolCallService} toolCallService - The service that handles tool calls.
 * @returns {Promise<void>} - A promise that resolves when the chat handling is complete.
 */
export type ChatHandler = (chatRequest: ChatRequest, chatModel: BaseChatModel, chatResponse: ChatResponse, toolCallService: ToolCallService) => Promise<void>;
//# sourceMappingURL=ChatModels.d.ts.map