@smythos/sre 1.6.0 → 1.6.8

package/dist/types/index.d.ts

@@ -168,6 +168,7 @@ export * from './subsystems/LLMManager/LLM.service/connectors/Bedrock.class';
 export * from './subsystems/LLMManager/LLM.service/connectors/Echo.class';
 export * from './subsystems/LLMManager/LLM.service/connectors/GoogleAI.class';
 export * from './subsystems/LLMManager/LLM.service/connectors/Groq.class';
+export * from './subsystems/LLMManager/LLM.service/connectors/Ollama.class';
 export * from './subsystems/LLMManager/LLM.service/connectors/Perplexity.class';
 export * from './subsystems/LLMManager/LLM.service/connectors/VertexAI.class';
 export * from './subsystems/LLMManager/LLM.service/connectors/xAI.class';

package/dist/types/subsystems/LLMManager/LLM.service/connectors/Ollama.class.d.ts

@@ -0,0 +1,45 @@
+import EventEmitter from 'events';
+import { TLLMMessageBlock, ToolData, APIKeySource, ILLMRequestFuncParams, TLLMChatResponse, TLLMPreparedParams, TLLMToolResultMessageBlock, TLLMRequestBody } from '@sre/types/LLM.types';
+import { LLMConnector } from '../LLMConnector';
+export declare class OllamaConnector extends LLMConnector {
+    name: string;
+    private getClient;
+    protected request({ acRequest, body, context }: ILLMRequestFuncParams): Promise<TLLMChatResponse>;
+    protected streamRequest({ acRequest, body, context }: ILLMRequestFuncParams): Promise<EventEmitter>;
+    protected reqBodyAdapter(params: TLLMPreparedParams): Promise<TLLMRequestBody>;
+    protected reportUsage(usage: {
+        prompt_tokens: number;
+        completion_tokens: number;
+        total_tokens: number;
+    }, metadata: {
+        modelEntryName: string;
+        keySource: APIKeySource;
+        agentId: string;
+        teamId: string;
+    }): {
+        sourceId: string;
+        input_tokens: number;
+        output_tokens: number;
+        input_tokens_cache_write: number;
+        input_tokens_cache_read: number;
+        keySource: APIKeySource;
+        agentId: string;
+        teamId: string;
+    };
+    transformToolMessageBlocks({ messageBlock, toolsData, }: {
+        messageBlock: TLLMMessageBlock;
+        toolsData: ToolData[];
+    }): TLLMToolResultMessageBlock[];
+    formatToolsConfig({ type, toolDefinitions, toolChoice }: {
+        type?: string;
+        toolDefinitions: any;
+        toolChoice?: string;
+    }): {
+        tools: any[];
+        tool_choice: string;
+    } | {
+        tools?: undefined;
+        tool_choice?: undefined;
+    };
+    getConsistentMessages(messages: TLLMMessageBlock[]): TLLMMessageBlock[];
+}

package/dist/types/subsystems/LLMManager/ModelsProvider.service/connectors/SmythModelsProvider.class.d.ts

@@ -0,0 +1,39 @@
+import { AccessRequest } from '@sre/Security/AccessControl/AccessRequest.class';
+import { ModelsProviderConnector } from '../ModelsProviderConnector';
+import { IAccessCandidate } from '@sre/types/ACL.types';
+import { ACL } from '@sre/Security/AccessControl/ACL.class';
+import { TLLMModelsList } from '@sre/types/LLM.types';
+type SmythModelsProviderConfig = {
+    /**
+     * The models to be used.
+     *
+     * If a string is provided, it will be used as the directory name to load the models from.
+     * If a TLLMModelsList is provided, it will be used as the models to be used.
+     *
+     */
+    models?: string | TLLMModelsList;
+    /**
+     * The mode to be used.
+     *
+     * If 'append' is used, the models will be appended to the existing models.
+     * If 'replace' is used, the existing models will be replaced with the new models.
+     */
+    mode?: 'merge' | 'replace';
+};
+export declare class SmythModelsProvider extends ModelsProviderConnector {
+    protected _settings?: SmythModelsProviderConfig;
+    name: string;
+    private models;
+    constructor(_settings?: SmythModelsProviderConfig);
+    start(): Promise<void>;
+    addModels(acRequest: AccessRequest, models: TLLMModelsList): Promise<void>;
+    getModels(acRequest: AccessRequest): Promise<any>;
+    getResourceACL(resourceId: string, candidate: IAccessCandidate): Promise<ACL>;
+    private reindexModels;
+    private scanDirectoryForModels;
+    private getValidModels;
+    private isValidSingleModel;
+    private isValidModel;
+    private initDirWatcher;
+}
+export {};

package/dist/types/types/LLM.types.d.ts

@@ -228,6 +228,7 @@ export declare const BuiltinLLMProviders: {
     readonly VertexAI: "VertexAI";
     readonly xAI: "xAI";
     readonly Perplexity: "Perplexity";
+    readonly Ollama: "Ollama";
 };
 export type TBuiltinLLMProvider = (typeof BuiltinLLMProviders)[keyof typeof BuiltinLLMProviders];
 export interface ILLMProviders {
@@ -245,6 +246,7 @@ export declare const TLLMProvider: {
     readonly VertexAI: "VertexAI";
     readonly xAI: "xAI";
     readonly Perplexity: "Perplexity";
+    readonly Ollama: "Ollama";
 };
 export type TBedrockSettings = {
     keyIDName: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@smythos/sre",
-  "version": "1.6.0",
+  "version": "1.6.8",
   "description": "Smyth Runtime Environment",
   "author": "Alaa-eddine KADDOURI",
   "license": "MIT",
@@ -82,6 +82,7 @@
     "mime": "^4.0.3",
     "mysql2": "^3.11.3",
     "oauth-1.0a": "^2.2.6",
+    "ollama": "^0.6.0",
     "openai": "^5.12.2",
     "p-limit": "^6.1.0",
     "qs": "^6.13.0",

package/src/Components/APICall/APICall.class.ts

@@ -1,161 +1,161 @@
-import axios, { AxiosRequestConfig } from 'axios';
-import Joi from 'joi';
-
-import { Agent } from '@sre/AgentManager/Agent.class';
-import { Component } from '../Component.class';
-import { parseHeaders } from './parseHeaders';
-import { parseUrl, parseSmythFsUrl, destroyPublicUrls } from './parseUrl';
-import { parseData } from './parseData';
-import { parseProxy } from './parseProxy';
-import { parseArrayBufferResponse } from './ArrayBufferResponse.helper';
-import { extractAdditionalParamsForOAuth1, handleOAuthHeaders as generateOAuthHeaders } from './OAuth.helper';
-import { SocksProxyAgent } from 'socks-proxy-agent';
-import { formatDataForDebug } from '@sre/utils/data.utils';
-import { AccessCandidate } from '@sre/Security/AccessControl/AccessCandidate.class';
-
-export class APICall extends Component {
-    protected schema = {
-        name: 'APICall',
-        description: 'Use this component to make an API call',
-        inputs: {},
-        outputs: {
-            Headers: {
-                description: 'The headers of the API call response',
-                default: true,
-            },
-            Response: {
-                description: 'The response of the API call',
-                default: true,
-            },
-        },
-    };
-
-    protected configSchema = Joi.object({
-        method: Joi.string().valid('GET', 'POST', 'PUT', 'PATCH', 'DELETE', 'HEAD', 'OPTIONS').required().label('Method'),
-        url: Joi.string()
-            .max(8192) /*.custom(isUrlValid, 'URL validation')*/
-            .required()
-            .label('URL'),
-        headers: Joi.any().allow('').label('Headers'),
-        contentType: Joi.string()
-            .valid('none', 'application/json', 'multipart/form-data', 'binary', 'application/x-www-form-urlencoded', 'text/plain', 'application/xml')
-            .label('Content-Type'),
-        body: Joi.any().allow('').label('Body'),
-        _templateSettings: Joi.object().allow(null).label('Template Settings'),
-        _templateVars: Joi.object().allow(null).label('Template Variables'),
-        proxy: Joi.string().allow('').label('Proxy'),
-        oauthService: Joi.string().allow('').label('OAuth Service'),
-        scope: Joi.string().allow('').label('Scope'),
-        authorizationURL: Joi.string().allow('').label('Authorization URL'),
-        tokenURL: Joi.string().allow('').label('Token URL'),
-        clientID: Joi.string().allow('').label('Client ID'),
-        clientSecret: Joi.string().allow('').label('Client Secret'),
-        oauth2CallbackURL: Joi.string().allow('').label('OAuth2 Callback URL'),
-        callbackURL: Joi.string().allow('').label('Callback URL'), // !TEMP: prevent validation error
-        requestTokenURL: Joi.string().allow('').label('Request Token URL'),
-        accessTokenURL: Joi.string().allow('').label('Access Token URL'),
-        userAuthorizationURL: Joi.string().allow('').label('User Authorization URL'),
-        consumerKey: Joi.string().allow('').label('Consumer Key'),
-        consumerSecret: Joi.string().allow('').label('Consumer Secret'),
-        oauth1CallbackURL: Joi.string().allow('').label('OAuth1 Callback URL'),
-        authenticate: Joi.string().allow('').label('Authenticate'),
-        oauth_con_id: Joi.string().allow('').label('OAuth Connection ID'),
-    });
-    constructor() {
-        super();
-    }
-
-    init() {}
-
-    async process(input, config, agent: Agent) {
-        await super.process(input, config, agent);
-
-        const logger = this.createComponentLogger(agent, config);
-
-        let publicUrls: string[] = [];
-
-        try {
-            logger.debug(`=== API Call Log ===`);
-
-            const method = config?.data?.method || 'get';
-
-            const reqConfig: AxiosRequestConfig = {};
-            reqConfig.method = method;
-
-            reqConfig.url = await parseUrl(input, config, agent);
-
-            // We generate public URLs for any resources specified with the smythfs protocol in the request URL.
-            ({ url: reqConfig.url, publicUrls } = await parseSmythFsUrl(reqConfig.url, agent));
-
-            const { data, headers } = await parseData(input, config, agent);
-
-            // If the data is null, the request may fail. We encountered an issue where a request failed due to null data being provided.
-            let dataForDebug;
-            if (data) {
-                reqConfig.data = data;
-
-                dataForDebug = await formatDataForDebug(data, AccessCandidate.agent(agent.id));
-            }
-
-            reqConfig.headers = (await parseHeaders(input, config, agent)).concat({ ...headers });
-
-            const proxyConfig = await parseProxy(input, config, agent);
-
-            if (proxyConfig) {
-                if (proxyConfig instanceof SocksProxyAgent) {
-                    const isSecureEndpoint = reqConfig.url?.startsWith('https://');
-                    reqConfig[isSecureEndpoint ? 'httpsAgent' : 'httpAgent'] = proxyConfig;
-                } else {
-                    reqConfig.proxy = proxyConfig;
-                }
-            }
-
-            let Response: any = {};
-            let Headers: any = {};
-            let _error: any = undefined;
-            try {
-                // To support both old and new OAuth configuration, we check for both oauth_con_id and oauthService.
-                logger.debug('checking oauth config', config?.data?.oauth_con_id, config?.data?.oauthService);
-                if (
-                    (config?.data?.oauth_con_id && config.data.oauth_con_id !== 'None') ||
-                    (config?.data?.oauthService && config.data.oauthService !== 'None')
-                ) {
-                    const additionalParams = extractAdditionalParamsForOAuth1(reqConfig);
-                    const oauthHeaders = await generateOAuthHeaders(agent, config, reqConfig, logger, additionalParams);
-                    //reqConfig.headers = { ...reqConfig.headers, ...oauthHeaders };
-                    reqConfig.headers = reqConfig.headers.concat({ ...oauthHeaders });
-                }
-
-                // in order to handle binary data automatically, we need to set responseType to 'arraybuffer' for all requests, then parse the response data based on content-type
-                reqConfig.responseType = 'arraybuffer';
-
-                logger.debug('Making API call', { ...reqConfig, data: dataForDebug });
-
-                const response = await axios.request(reqConfig);
-
-                const parsedRes = await parseArrayBufferResponse(response, agent);
-
-                // log response headers
-                logger.debug('API call Response Headers', response.headers);
-                Response = parsedRes;
-
-                logger.debug('API call Response\n', Response);
-
-                Headers = Object.fromEntries(Object.entries(response.headers));
-            } catch (error) {
-                logger.debug(`Error making API call: ${error.message}`);
-                Headers = error?.response?.headers ? Object.fromEntries(Object.entries(error.response.headers)) : {};
-                Response = await parseArrayBufferResponse(error.response, agent);
-                _error = error.message;
-            }
-
-            return { Response, Headers, _error, _debug: logger.output };
-        } catch (error) {
-            return { _error: error.message, _debug: logger.output };
-        } finally {
-            if (publicUrls.length > 0) {
-                await destroyPublicUrls(publicUrls);
-            }
-        }
-    }
-}
+import axios, { AxiosRequestConfig } from 'axios';
+import Joi from 'joi';
+
+import { Agent } from '@sre/AgentManager/Agent.class';
+import { Component } from '../Component.class';
+import { parseHeaders } from './parseHeaders';
+import { parseUrl, parseSmythFsUrl, destroyPublicUrls } from './parseUrl';
+import { parseData } from './parseData';
+import { parseProxy } from './parseProxy';
+import { parseArrayBufferResponse } from './ArrayBufferResponse.helper';
+import { extractAdditionalParamsForOAuth1, handleOAuthHeaders as generateOAuthHeaders } from './OAuth.helper';
+import { SocksProxyAgent } from 'socks-proxy-agent';
+import { formatDataForDebug } from '@sre/utils/data.utils';
+import { AccessCandidate } from '@sre/Security/AccessControl/AccessCandidate.class';
+
+export class APICall extends Component {
+    protected schema = {
+        name: 'APICall',
+        description: 'Use this component to make an API call',
+        inputs: {},
+        outputs: {
+            Headers: {
+                description: 'The headers of the API call response',
+                default: true,
+            },
+            Response: {
+                description: 'The response of the API call',
+                default: true,
+            },
+        },
+    };
+
+    protected configSchema = Joi.object({
+        method: Joi.string().valid('GET', 'POST', 'PUT', 'PATCH', 'DELETE', 'HEAD', 'OPTIONS').required().label('Method'),
+        url: Joi.string()
+            .max(8192) /*.custom(isUrlValid, 'URL validation')*/
+            .required()
+            .label('URL'),
+        headers: Joi.any().allow('').label('Headers'),
+        contentType: Joi.string()
+            .valid('none', 'application/json', 'multipart/form-data', 'binary', 'application/x-www-form-urlencoded', 'text/plain', 'application/xml')
+            .label('Content-Type'),
+        body: Joi.any().allow('').label('Body'),
+        _templateSettings: Joi.object().allow(null).label('Template Settings'),
+        _templateVars: Joi.object().allow(null).label('Template Variables'),
+        proxy: Joi.string().allow('').label('Proxy'),
+        oauthService: Joi.string().allow('').label('OAuth Service'),
+        scope: Joi.string().allow('').label('Scope'),
+        authorizationURL: Joi.string().allow('').label('Authorization URL'),
+        tokenURL: Joi.string().allow('').label('Token URL'),
+        clientID: Joi.string().allow('').label('Client ID'),
+        clientSecret: Joi.string().allow('').label('Client Secret'),
+        oauth2CallbackURL: Joi.string().allow('').label('OAuth2 Callback URL'),
+        callbackURL: Joi.string().allow('').label('Callback URL'), // !TEMP: prevent validation error
+        requestTokenURL: Joi.string().allow('').label('Request Token URL'),
+        accessTokenURL: Joi.string().allow('').label('Access Token URL'),
+        userAuthorizationURL: Joi.string().allow('').label('User Authorization URL'),
+        consumerKey: Joi.string().allow('').label('Consumer Key'),
+        consumerSecret: Joi.string().allow('').label('Consumer Secret'),
+        oauth1CallbackURL: Joi.string().allow('').label('OAuth1 Callback URL'),
+        authenticate: Joi.string().allow('').label('Authenticate'),
+        oauth_con_id: Joi.string().allow('').label('OAuth Connection ID'),
+    });
+    constructor() {
+        super();
+    }
+
+    init() {}
+
+    async process(input, config, agent: Agent) {
+        await super.process(input, config, agent);
+
+        const logger = this.createComponentLogger(agent, config);
+
+        let publicUrls: string[] = [];
+
+        try {
+            logger.debug(`=== API Call Log ===`);
+
+            const method = config?.data?.method || 'get';
+
+            const reqConfig: AxiosRequestConfig = {};
+            reqConfig.method = method;
+
+            reqConfig.url = await parseUrl(input, config, agent);
+
+            // We generate public URLs for any resources specified with the smythfs protocol in the request URL.
+            ({ url: reqConfig.url, publicUrls } = await parseSmythFsUrl(reqConfig.url, agent));
+
+            const { data, headers } = await parseData(input, config, agent);
+
+            // If the data is null, the request may fail. We encountered an issue where a request failed due to null data being provided.
+            let dataForDebug;
+            if (data) {
+                reqConfig.data = data;
+
+                dataForDebug = await formatDataForDebug(data, AccessCandidate.agent(agent.id));
+            }
+
+            reqConfig.headers = (await parseHeaders(input, config, agent)).concat({ ...headers });
+
+            const proxyConfig = await parseProxy(input, config, agent);
+
+            if (proxyConfig) {
+                if (proxyConfig instanceof SocksProxyAgent) {
+                    const isSecureEndpoint = reqConfig.url?.startsWith('https://');
+                    reqConfig[isSecureEndpoint ? 'httpsAgent' : 'httpAgent'] = proxyConfig;
+                } else {
+                    reqConfig.proxy = proxyConfig;
+                }
+            }
+
+            let Response: any = {};
+            let Headers: any = {};
+            let _error: any = undefined;
+            try {
+                // To support both old and new OAuth configuration, we check for both oauth_con_id and oauthService.
+                logger.debug('checking oauth config', config?.data?.oauth_con_id, config?.data?.oauthService);
+                if (
+                    (config?.data?.oauth_con_id && config.data.oauth_con_id !== 'None') ||
+                    (config?.data?.oauthService && config.data.oauthService !== 'None')
+                ) {
+                    const additionalParams = extractAdditionalParamsForOAuth1(reqConfig);
+                    const oauthHeaders = await generateOAuthHeaders(agent, config, reqConfig, logger, additionalParams);
+                    //reqConfig.headers = { ...reqConfig.headers, ...oauthHeaders };
+                    reqConfig.headers = reqConfig.headers.concat({ ...oauthHeaders });
+                }
+
+                // in order to handle binary data automatically, we need to set responseType to 'arraybuffer' for all requests, then parse the response data based on content-type
+                reqConfig.responseType = 'arraybuffer';
+
+                logger.debug('Making API call', { ...reqConfig, data: dataForDebug });
+
+                const response = await axios.request(reqConfig);
+
+                const parsedRes = await parseArrayBufferResponse(response, agent);
+
+                // log response headers
+                logger.debug('API call Response Headers', response.headers);
+                Response = parsedRes;
+
+                logger.debug('API call Response\n', Response);
+
+                Headers = Object.fromEntries(Object.entries(response.headers));
+            } catch (error) {
+                logger.debug(`Error making API call: ${error.message}`);
+                Headers = error?.response?.headers ? Object.fromEntries(Object.entries(error.response.headers)) : {};
+                Response = await parseArrayBufferResponse(error.response, agent);
+                _error = error.message;
+            }
+
+            return { Response, Headers, _error, _debug: logger.output };
+        } catch (error) {
+            return { _error: error.message, _debug: logger.output };
+        } finally {
+            if (publicUrls.length > 0) {
+                await destroyPublicUrls(publicUrls);
+            }
+        }
+    }
+}