@christianriedl/utils 1.0.122 → 1.0.124

package/dist/iOpenAI.d.ts

@@ -18,17 +18,67 @@ export interface ISchema {
     name: string;
     schema?: Dictionary<unknown>;
 }
+export interface ITool {
+    type: 'mcp' | 'file_search' | 'web_search_preview' | 'web_search_preview_2025_03_11' | 'function';
+    label: string;
+}
+export interface IMcpTool extends ITool {
+    type: 'mcp';
+    server_label: string;
+    server_url: string;
+    allowed_tools?: string[];
+    require_approval?: 'always' | 'never' | null;
+    server_description?: string;
+}
+export interface IFileSearchTool extends ITool {
+    type: 'file_search';
+    vector_store_ids: string[];
+    vector_store_names: string[];
+    filters?: any;
+    max_num_results?: number;
+}
+export interface IWebSearchLocation {
+    type: 'approximate';
+    city?: string | null;
+    country?: string | null;
+    region?: string | null;
+}
+export interface IWebSearchTool extends ITool {
+    type: 'web_search_preview' | 'web_search_preview_2025_03_11';
+    search_context_size?: 'low' | 'medium' | 'high';
+    user_location?: IWebSearchLocation | null;
+}
+export interface IFunctionTool {
+    type: 'function';
+    name: string;
+    parameters: Dictionary<unknown> | null;
+    strict: boolean | null;
+    description?: string | null;
+}
+export interface IOpenAIOptions {
+    model: string;
+    instructions?: string | null;
+    outputFormat: 'text' | 'markdown' | 'html';
+    reasoning_effort_level: 'minimum' | 'low' | 'medium' | 'high';
+    max_output_tokens?: number | null;
+    save?: boolean | null;
+    store?: boolean | null;
+    temperature?: number | null;
+    top_p?: number | null;
+}
 export interface IOpenAIService {
     log: ILogger;
+    options: IOpenAIOptions;
     response(prompt: string | string[], tools?: string[], imageUrl?: string, json?: ISchema): Promise<IResponseResult>;
     clearContext(): void;
 }
 export type ToolFunction = (input: Dictionary<unknown>) => Promise<Dictionary<any>>;
 export interface IOpenAIServiceWithTools extends IOpenAIService {
-    addMcpTool(label: string, url: string, desc: string, allowedTools?: string[]): void;
-    addFileSearchTool(label: string, vectorStore: string): boolean;
-    addWebSearchTool(label: string, country?: string, city?: string, region?: string): void;
-    addFunctionTool(functionName: string, description: string, parameters: Dictionary<unknown>, toolFunction: ToolFunction): void;
+    aiTools: Dictionary<ITool>;
+    addMcpTool(tool: IMcpTool): void;
+    addFileSearchTool(label: string, tool: IFileSearchTool): boolean;
+    addWebSearchTool(label: string, tool: IWebSearchTool): void;
+    addFunctionTool(tool: IFunctionTool, toolFunction: ToolFunction): void;
 }
 export interface IVectorStore {
     id: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@christianriedl/utils",
-  "version": "1.0.122",
+  "version": "1.0.124",
   "description": "Interfaces, local storage, service worker, configuration, application state",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",