llmjs2 1.0.1 → 1.0.5

package/src/types.ts

@@ -1,243 +0,0 @@
-/**
- * Unified type definitions for llmjs2
- * Enterprise-grade LLM abstraction layer supporting OpenAI and Ollama
- */
-
-/**
- * Supported LLM providers
- */
-export type ProviderType = 'openai' | 'ollama';
-
-/**
- * Role of a message in a conversation
- */
-export type MessageRole = 'system' | 'user' | 'assistant';
-
-/**
- * A single message in a conversation
- */
-export interface Message {
-  role: MessageRole;
-  content: string;
-}
-
-/**
- * Tool/function definition for function calling
- */
-export interface ToolBase {
-  type?: 'function';
-  description?: string;
-  parameters?: Record<string, unknown>;
-  handler?: (args: Record<string, unknown>) => string | Promise<string>;
-}
-
-export interface ToolV1 extends ToolBase {
-  function: {
-    name: string;
-    description?: string;
-    parameters?: Record<string, unknown>;
-  };
-}
-
-export interface ToolV2 extends ToolBase {
-  name: string;
-}
-
-export type Tool = ToolV1 | ToolV2;
-
-/**
- * Configuration for a completion request
- */
-export interface CompletionRequest {
-  /** Model identifier (e.g., 'openai/gpt-4', 'ollama/mistral') */
-  model: string;
-
-  /** API key or authentication token */
-  apiKey?: string;
-
-  /** Base URL for the API (mainly for Ollama) */
-  baseUrl?: string;
-
-  /** Messages for the completion */
-  messages: Message[];
-
-  /** Maximum tokens to generate */
-  maxTokens?: number;
-
-  /** Sampling temperature (0-2 for OpenAI, typically 0-1) */
-  temperature?: number;
-
-  /** Top-p (nucleus sampling) */
-  topP?: number;
-
-  /** Top-k sampling parameter */
-  topK?: number;
-
-  /** Frequency penalty (-2 to 2 for OpenAI) */
-  frequencyPenalty?: number;
-
-  /** Presence penalty (-2 to 2 for OpenAI) */
-  presencePenalty?: number;
-
-  /** Stop sequences */
-  stop?: string[];
-
-  /** Available tools for function calling */
-  tools?: Tool[];
-
-  /** Force tool usage */
-  toolChoice?: 'auto' | 'required' | string;
-
-  /** Custom headers to send with requests */
-  headers?: Record<string, string>;
-
-  /** Request timeout in milliseconds */
-  timeout?: number;
-
-  /** Retry configuration */
-  retry?: {
-    maxRetries?: number;
-    backoffMultiplier?: number;
-    initialDelayMs?: number;
-  };
-}
-
-/**
- * Completion response
- */
-export interface CompletionResponse {
-  /** Generated text content */
-  content: string;
-
-  /** The model used */
-  model: string;
-
-  /** Stop reason */
-  stopReason?: 'stop_sequence' | 'length' | 'tool_calls' | 'end_turn' | string;
-
-  /** Total tokens used (if available) */
-  usage?: {
-    promptTokens?: number;
-    completionTokens?: number;
-    totalTokens?: number;
-  };
-
-  /** Raw provider response for advanced use cases */
-  raw?: unknown;
-
-  /** Finish reason from provider */
-  finishReason?: string;
-
-  /** Tool calls if function calling was used */
-  toolCalls?: Array<{
-    id?: string;
-    name: string;
-    arguments: Record<string, unknown>;
-  }>;
-}
-
-/**
- * Streaming completion chunk
- */
-export interface CompletionChunk {
-  /** Delta content */
-  delta: string;
-
-  /** Stop reason if stream ended */
-  stopReason?: string;
-
-  /** Usage at end of stream */
-  usage?: {
-    promptTokens?: number;
-    completionTokens?: number;
-    totalTokens?: number;
-  };
-}
-
-/**
- * Provider configuration options
- */
-export interface ProviderConfig {
-  /** Provider type */
-  type: ProviderType;
-
-  /** API key */
-  apiKey?: string;
-
-  /** Base URL for API */
-  baseUrl?: string;
-
-  /** Default model */
-  model?: string;
-
-  /** Request timeout */
-  timeout?: number;
-
-  /** Retry configuration */
-  retry?: {
-    maxRetries?: number;
-    backoffMultiplier?: number;
-    initialDelayMs?: number;
-  };
-
-  /** Custom headers */
-  headers?: Record<string, string>;
-}
-
-/**
- * Error response from provider
- */
-export interface ProviderError extends Error {
-  name: string;
-  message: string;
-  code?: string;
-  statusCode?: number;
-  details?: unknown;
-  retryable?: boolean;
-}
-
-/**
- * Provider interface that all providers must implement
- */
-export interface IProvider {
-  /** Create a completion request */
-  complete(request: CompletionRequest): Promise<CompletionResponse>;
-
-  /** Stream a completion request */
-  completeStream(
-    request: CompletionRequest
-  ): AsyncIterable<CompletionChunk>;
-
-  /** Validate that the configuration is correct */
-  validate(): Promise<void>;
-
-  /** Parse model string (e.g., 'openai/gpt-4' -> 'gpt-4') */
-  parseModel(model: string): string;
-
-  /** Enable or disable debug mode */
-  setDebug(debug: boolean): void;
-
-  /** Set custom logger function */
-  setLogger(logger: (level: string, message: string, data?: unknown) => void): void;
-}
-
-/**
- * Global completion options
- */
-export interface CompletionOptions {
-  /** Enable request logging for debugging */
-  debug?: boolean;
-
-  /** Custom logger function */
-  logger?: (level: string, message: string, data?: unknown) => void;
-
-  /** Global timeout override */
-  globalTimeout?: number;
-
-  /** Retry configuration override */
-  globalRetry?: {
-    maxRetries?: number;
-    backoffMultiplier?: number;
-    initialDelayMs?: number;
-  };
-}