@llumiverse/drivers/src/mistral/types.ts

LLM driver implementations. Currently supported are: openai, huggingface, bedrock, replicate.

// Copied from https://github.com/mistralai/client-js/blob/main/src/client.d.ts
// MistralAI Types

export interface ModelPermission {
    id: string;
    object: 'model_permission';
    created: number;
    allow_create_engine: boolean;
    allow_sampling: boolean;
    allow_logprobs: boolean;
    allow_search_indices: boolean;
    allow_view: boolean;
    allow_fine_tuning: boolean;
    organization: string;
    group: string | null;
    is_blocking: boolean;
}

export interface Model {
    id: string;
    object: 'model';
    created: number;
    owned_by: string;
    root: string | null;
    parent: string | null;
    permission: ModelPermission[];
}

export interface ListModelsResponse {
    object: 'list';
    data: Model[];
}

export interface Function {
    name: string;
    description: string;
    parameters: object;
}

export enum ToolType {
    function = 'function',
}

export interface FunctionCall {
    name: string;
    arguments: string;
}

export interface ToolCalls {
    id: 'null';
    type: ToolType;
    function: FunctionCall;
}

export enum ResponseFormats {
    text = 'text',
    json_object = 'json_object',
}

export enum ToolChoice {
    auto = 'auto',
    any = 'any',
    none = 'none',
}

export interface ResponseFormat {
    type: ResponseFormats;
}

export interface TokenUsage {
    prompt_tokens: number;
    completion_tokens: number;
    total_tokens: number;
}

export interface ChatCompletionResponseChoice {
    index: number;
    message: {
        role: string;
        content: string;
    };
    finish_reason: string; // "stop" "length" "model_length" "error" "tool_calls"
}

export interface ChatCompletionResponseChunkChoice {
    index: number;
    delta: {
        role?: string;
        content?: string;
        tool_calls?: ToolCalls[];
    };
    finish_reason: string; // "stop" "length" "model_length" "error" "tool_calls"
}

export interface ChatCompletionResponse {
    id: string;
    object: 'chat.completion';
    created: number;
    model: string;
    choices: ChatCompletionResponseChoice[];
    usage: TokenUsage;
}

export interface ChatCompletionResponseChunk {
    id: string;
    object: 'chat.completion.chunk';
    created: number;
    model: string;
    choices: ChatCompletionResponseChunkChoice[];
}

export interface Embedding {
    id: string;
    object: 'embedding';
    embedding: number[];
}

export interface EmbeddingResponse {
    id: string;
    object: 'list';
    data: Embedding[];
    model: string;
    usage: TokenUsage;
}

export interface CompletionRequestParams {
    model: string,
    messages: Array<{ role: string; name?: string, content: string | string[], tool_calls?: ToolCalls[]; }>,
    tools?: Array<{ type: string; function: Function; }>,
    temperature?: number,
    maxTokens?: number,
    topP?: number,
    randomSeed?: number,
    stream?: boolean,
    toolChoice?: ToolChoice,
    responseFormat?: ResponseFormat,
    stopSequences?: string[],
}

// class MistralClient {
//     constructor(apiKey?: string, endpoint?: string);

//     private _request(
//         method: string,
//         path: string,
//         request: unknown
//     ): Promise<unknown>;

//     private _makeChatCompletionRequest(
//         model: string,
//         messages: Array<{ role: string; name?: string, content: string | string[], tool_calls?: ToolCalls[]; }>,
//         tools?: Array<{ type: string; function: Function; }>,
//         temperature?: number,
//         maxTokens?: number,
//         topP?: number,
//         randomSeed?: number,
//         stream?: boolean,
//         /**
//          * @deprecated use safePrompt instead
//          */
//         safeMode?: boolean,
//         safePrompt?: boolean,
//         toolChoice?: ToolChoice,
//         responseFormat?: ResponseFormat
//     ): object;

//     listModels(): Promise<ListModelsResponse>;

//     chat(options: {
//         model: string;
//         messages: Array<{ role: string; name?: string, content: string | string[], tool_calls?: ToolCalls[]; }>;
//         tools?: Array<{ type: string; function: Function; }>;
//         temperature?: number;
//         maxTokens?: number;
//         topP?: number;
//         randomSeed?: number;
//         /**
//          * @deprecated use safePrompt instead
//          */
//         safeMode?: boolean;
//         safePrompt?: boolean;
//         toolChoice?: ToolChoice;
//         responseFormat?: ResponseFormat;
//     }): Promise<ChatCompletionResponse>;

//     chatStream(options: {
//         model: string;
//         messages: Array<{ role: string; name?: string, content: string | string[], tool_calls?: ToolCalls[]; }>;
//         tools?: Array<{ type: string; function: Function; }>;
//         temperature?: number;
//         maxTokens?: number;
//         topP?: number;
//         randomSeed?: number;
//         /**
//          * @deprecated use safePrompt instead
//          */
//         safeMode?: boolean;
//         safePrompt?: boolean;
//         toolChoice?: ToolChoice;
//         responseFormat?: ResponseFormat;
//     }): AsyncGenerator<ChatCompletionResponseChunk, void, unknown>;

//     embeddings(options: {
//         model: string;
//         input: string | string[];
//     }): Promise<EmbeddingResponse>;
// }