@theia/ai-huggingface 1.46.0-next.241

package/lib/node/huggingface-language-models-manager-impl.js

@@ -0,0 +1,63 @@
+"use strict";
+// *****************************************************************************
+// Copyright (C) 2024 EclipseSource GmbH.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HuggingFaceLanguageModelsManagerImpl = void 0;
+const tslib_1 = require("tslib");
+const ai_core_1 = require("@theia/ai-core");
+const inversify_1 = require("@theia/core/shared/inversify");
+const huggingface_language_model_1 = require("./huggingface-language-model");
+let HuggingFaceLanguageModelsManagerImpl = class HuggingFaceLanguageModelsManagerImpl {
+    get apiKey() {
+        var _a;
+        return (_a = this._apiKey) !== null && _a !== void 0 ? _a : process.env.HUGGINGFACE_API_KEY;
+    }
+    async createOrUpdateLanguageModels(...modelDescriptions) {
+        for (const modelDescription of modelDescriptions) {
+            const model = await this.languageModelRegistry.getLanguageModel(modelDescription.id);
+            const apiKeyProvider = () => this.apiKey;
+            if (model) {
+                if (!(model instanceof huggingface_language_model_1.HuggingFaceModel)) {
+                    console.warn(`Hugging Face: model ${modelDescription.id} is not a Hugging Face model`);
+                    continue;
+                }
+                model.model = modelDescription.model;
+                model.apiKey = apiKeyProvider;
+                model.defaultRequestSettings = modelDescription.defaultRequestSettings;
+            }
+            else {
+                this.languageModelRegistry.addLanguageModels([
+                    new huggingface_language_model_1.HuggingFaceModel(modelDescription.id, modelDescription.model, apiKeyProvider, undefined, undefined, undefined, undefined, undefined, undefined, modelDescription.defaultRequestSettings)
+                ]);
+            }
+        }
+    }
+    removeLanguageModels(...modelIds) {
+        this.languageModelRegistry.removeLanguageModels(modelIds);
+    }
+    setApiKey(apiKey) {
+        this._apiKey = apiKey || undefined;
+    }
+};
+exports.HuggingFaceLanguageModelsManagerImpl = HuggingFaceLanguageModelsManagerImpl;
+tslib_1.__decorate([
+    (0, inversify_1.inject)(ai_core_1.LanguageModelRegistry),
+    tslib_1.__metadata("design:type", Object)
+], HuggingFaceLanguageModelsManagerImpl.prototype, "languageModelRegistry", void 0);
+exports.HuggingFaceLanguageModelsManagerImpl = HuggingFaceLanguageModelsManagerImpl = tslib_1.__decorate([
+    (0, inversify_1.injectable)()
+], HuggingFaceLanguageModelsManagerImpl);
+//# sourceMappingURL=huggingface-language-models-manager-impl.js.map

package/lib/node/huggingface-language-models-manager-impl.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"huggingface-language-models-manager-impl.js","sourceRoot":"","sources":["../../src/node/huggingface-language-models-manager-impl.ts"],"names":[],"mappings":";AAAA,gFAAgF;AAChF,yCAAyC;AACzC,EAAE;AACF,2EAA2E;AAC3E,mEAAmE;AACnE,wCAAwC;AACxC,EAAE;AACF,4EAA4E;AAC5E,8EAA8E;AAC9E,6EAA6E;AAC7E,yDAAyD;AACzD,uDAAuD;AACvD,EAAE;AACF,gFAAgF;AAChF,gFAAgF;;;;AAEhF,4CAAuD;AACvD,4DAAkE;AAClE,6EAAgE;AAIzD,IAAM,oCAAoC,GAA1C,MAAM,oCAAoC;IAO7C,IAAI,MAAM;;QACN,OAAO,MAAA,IAAI,CAAC,OAAO,mCAAI,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC;IAC3D,CAAC;IAED,KAAK,CAAC,4BAA4B,CAAC,GAAG,iBAAgD;QAClF,KAAK,MAAM,gBAAgB,IAAI,iBAAiB,EAAE,CAAC;YAC/C,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,qBAAqB,CAAC,gBAAgB,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC;YACrF,MAAM,cAAc,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC;YAEzC,IAAI,KAAK,EAAE,CAAC;gBACR,IAAI,CAAC,CAAC,KAAK,YAAY,6CAAgB,CAAC,EAAE,CAAC;oBACvC,OAAO,CAAC,IAAI,CAAC,uBAAuB,gBAAgB,CAAC,EAAE,8BAA8B,CAAC,CAAC;oBACvF,SAAS;gBACb,CAAC;gBACD,KAAK,CAAC,KAAK,GAAG,gBAAgB,CAAC,KAAK,CAAC;gBACrC,KAAK,CAAC,MAAM,GAAG,cAAc,CAAC;gBAC9B,KAAK,CAAC,sBAAsB,GAAG,gBAAgB,CAAC,sBAAsB,CAAC;YAC3E,CAAC;iBAAM,CAAC;gBACJ,IAAI,CAAC,qBAAqB,CAAC,iBAAiB,CAAC;oBACzC,IAAI,6CAAgB,CAChB,gBAAgB,CAAC,EAAE,EACnB,gBAAgB,CAAC,KAAK,EACtB,cAAc,EACd,SAAS,EACT,SAAS,EACT,SAAS,EACT,SAAS,EACT,SAAS,EACT,SAAS,EACT,gBAAgB,CAAC,sBAAsB,CAC1C;iBACJ,CAAC,CAAC;YACP,CAAC;QACL,CAAC;IACL,CAAC;IAED,oBAAoB,CAAC,GAAG,QAAkB;QACtC,IAAI,CAAC,qBAAqB,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC;IAC9D,CAAC;IAED,SAAS,CAAC,MAA0B;QAChC,IAAI,CAAC,OAAO,GAAG,MAAM,IAAI,SAAS,CAAC;IACvC,CAAC;CACJ,CAAA;AAlDY,oFAAoC;AAK1B;IADlB,IAAA,kBAAM,EAAC,+BAAqB,CAAC;;mFACkC;+CALvD,oCAAoC;IADhD,IAAA,sBAAU,GAAE;GACA,oCAAoC,CAkDhD"}

package/lib/package.spec.d.ts

@@ -0,0 +1 @@
+//# sourceMappingURL=package.spec.d.ts.map

package/lib/package.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"package.spec.d.ts","sourceRoot":"","sources":["../src/package.spec.ts"],"names":[],"mappings":""}

package/lib/package.spec.js

@@ -0,0 +1,26 @@
+// *****************************************************************************
+// Copyright (C) 2024 EclipseSource GmbH and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+/* note: this bogus test file is required so that
+   we are able to run mocha unit tests on this
+   package, without having any actual unit tests in it.
+   This way a coverage report will be generated,
+   showing 0% coverage, instead of no report.
+   This file can be removed once we have real unit
+   tests in place. */
+describe('ai-huggingface package', () => {
+    it('support code coverage statistics', () => true);
+});
+//# sourceMappingURL=package.spec.js.map

package/lib/package.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"package.spec.js","sourceRoot":"","sources":["../src/package.spec.ts"],"names":[],"mappings":"AAAA,gFAAgF;AAChF,oDAAoD;AACpD,EAAE;AACF,2EAA2E;AAC3E,mEAAmE;AACnE,wCAAwC;AACxC,EAAE;AACF,4EAA4E;AAC5E,8EAA8E;AAC9E,6EAA6E;AAC7E,yDAAyD;AACzD,uDAAuD;AACvD,EAAE;AACF,gFAAgF;AAChF,gFAAgF;AAEhF;;;;;;qBAMqB;AAErB,QAAQ,CAAC,wBAAwB,EAAE,GAAG,EAAE;IAEpC,EAAE,CAAC,kCAAkC,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,CAAC;AACvD,CAAC,CAAC,CAAC"}

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@theia/ai-huggingface",
+  "version": "1.46.0-next.241+4295c1a8c",
+  "description": "Theia - Hugging Face Integration",
+  "dependencies": {
+    "@huggingface/inference": "^2.0.0",
+    "@theia/ai-core": "1.46.0-next.241+4295c1a8c",
+    "@theia/core": "1.46.0-next.241+4295c1a8c"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "theiaExtensions": [
+    {
+      "frontend": "lib/browser/huggingface-frontend-module",
+      "backend": "lib/node/huggingface-backend-module"
+    }
+  ],
+  "keywords": [
+    "theia-extension"
+  ],
+  "license": "EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/eclipse-theia/theia.git"
+  },
+  "bugs": {
+    "url": "https://github.com/eclipse-theia/theia/issues"
+  },
+  "homepage": "https://github.com/eclipse-theia/theia",
+  "files": [
+    "lib",
+    "src"
+  ],
+  "scripts": {
+    "build": "theiaext build",
+    "clean": "theiaext clean",
+    "compile": "theiaext compile",
+    "lint": "theiaext lint",
+    "test": "theiaext test",
+    "watch": "theiaext watch"
+  },
+  "devDependencies": {
+    "@theia/ext-scripts": "1.56.0"
+  },
+  "nyc": {
+    "extends": "../../configs/nyc.json"
+  },
+  "gitHead": "4295c1a8c8b5d23471f274265c798bac9e6baecc"
+}

package/src/browser/huggingface-frontend-application-contribution.ts

@@ -0,0 +1,95 @@
+// *****************************************************************************
+// Copyright (C) 2024 EclipseSource GmbH.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+import { FrontendApplicationContribution, PreferenceService } from '@theia/core/lib/browser';
+import { inject, injectable } from '@theia/core/shared/inversify';
+import { HuggingFaceLanguageModelsManager, HuggingFaceModelDescription } from '../common';
+import { API_KEY_PREF, MODELS_PREF } from './huggingface-preferences';
+import { PREFERENCE_NAME_REQUEST_SETTINGS, RequestSetting } from '@theia/ai-core/lib/browser/ai-core-preferences';
+
+const HUGGINGFACE_PROVIDER_ID = 'huggingface';
+@injectable()
+export class HuggingFaceFrontendApplicationContribution implements FrontendApplicationContribution {
+
+    @inject(PreferenceService)
+    protected preferenceService: PreferenceService;
+
+    @inject(HuggingFaceLanguageModelsManager)
+    protected manager: HuggingFaceLanguageModelsManager;
+
+    protected prevModels: string[] = [];
+
+    onStart(): void {
+        this.preferenceService.ready.then(() => {
+            const apiKey = this.preferenceService.get<string>(API_KEY_PREF, undefined);
+            this.manager.setApiKey(apiKey);
+
+            const models = this.preferenceService.get<string[]>(MODELS_PREF, []);
+            const requestSettings = this.preferenceService.get<RequestSetting[]>(PREFERENCE_NAME_REQUEST_SETTINGS, []);
+            this.manager.createOrUpdateLanguageModels(...models.map(modelId => this.createHuggingFaceModelDescription(modelId, requestSettings)));
+            this.prevModels = [...models];
+
+            this.preferenceService.onPreferenceChanged(event => {
+                if (event.preferenceName === API_KEY_PREF) {
+                    this.manager.setApiKey(event.newValue);
+                } else if (event.preferenceName === MODELS_PREF) {
+                    this.handleModelChanges(event.newValue as string[]);
+                } else if (event.preferenceName === PREFERENCE_NAME_REQUEST_SETTINGS) {
+                    this.handleRequestSettingsChanges(event.newValue as RequestSetting[]);
+                }
+            });
+        });
+    }
+
+    protected handleModelChanges(newModels: string[]): void {
+        const oldModels = new Set(this.prevModels);
+        const updatedModels = new Set(newModels);
+
+        const modelsToRemove = [...oldModels].filter(model => !updatedModels.has(model));
+        const modelsToAdd = [...updatedModels].filter(model => !oldModels.has(model));
+
+        this.manager.removeLanguageModels(...modelsToRemove.map(model => `${HUGGINGFACE_PROVIDER_ID}/${model}`));
+        const requestSettings = this.preferenceService.get<RequestSetting[]>(PREFERENCE_NAME_REQUEST_SETTINGS, []);
+        this.manager.createOrUpdateLanguageModels(...modelsToAdd.map(modelId => this.createHuggingFaceModelDescription(modelId, requestSettings)));
+        this.prevModels = newModels;
+    }
+
+    protected handleRequestSettingsChanges(newSettings: RequestSetting[]): void {
+        const models = this.preferenceService.get<string[]>(MODELS_PREF, []);
+        this.manager.createOrUpdateLanguageModels(...models.map(modelId => this.createHuggingFaceModelDescription(modelId, newSettings)));
+    }
+
+    protected createHuggingFaceModelDescription(
+        modelId: string,
+        requestSettings: RequestSetting[]
+    ): HuggingFaceModelDescription {
+        const id = `${HUGGINGFACE_PROVIDER_ID}/${modelId}`;
+        const matchingSettings = requestSettings.filter(
+            setting => (!setting.providerId || setting.providerId === HUGGINGFACE_PROVIDER_ID) && setting.modelId === modelId
+        );
+        if (matchingSettings.length > 1) {
+            console.warn(
+                `Multiple entries found for modelId "${modelId}". Using the first match and ignoring the rest.`
+            );
+        }
+        const modelRequestSetting = matchingSettings[0];
+        return {
+            id: id,
+            model: modelId,
+            defaultRequestSettings: modelRequestSetting?.requestSettings
+        };
+    }
+}

package/src/browser/huggingface-frontend-module.ts

@@ -0,0 +1,31 @@
+// *****************************************************************************
+// Copyright (C) 2024 EclipseSource GmbH.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+import { ContainerModule } from '@theia/core/shared/inversify';
+import { HuggingFacePreferencesSchema } from './huggingface-preferences';
+import { FrontendApplicationContribution, PreferenceContribution, RemoteConnectionProvider, ServiceConnectionProvider } from '@theia/core/lib/browser';
+import { HuggingFaceFrontendApplicationContribution } from './huggingface-frontend-application-contribution';
+import { HUGGINGFACE_LANGUAGE_MODELS_MANAGER_PATH, HuggingFaceLanguageModelsManager } from '../common';
+
+export default new ContainerModule(bind => {
+    bind(PreferenceContribution).toConstantValue({ schema: HuggingFacePreferencesSchema });
+    bind(HuggingFaceFrontendApplicationContribution).toSelf().inSingletonScope();
+    bind(FrontendApplicationContribution).toService(HuggingFaceFrontendApplicationContribution);
+    bind(HuggingFaceLanguageModelsManager).toDynamicValue(ctx => {
+        const provider = ctx.container.get<ServiceConnectionProvider>(RemoteConnectionProvider);
+        return provider.createProxy<HuggingFaceLanguageModelsManager>(HUGGINGFACE_LANGUAGE_MODELS_MANAGER_PATH);
+    }).inSingletonScope();
+});

package/src/browser/huggingface-preferences.ts

@@ -0,0 +1,42 @@
+// *****************************************************************************
+// Copyright (C) 2024 EclipseSource GmbH.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+import { PreferenceSchema } from '@theia/core/lib/browser/preferences/preference-contribution';
+import { AI_CORE_PREFERENCES_TITLE } from '@theia/ai-core/lib/browser/ai-core-preferences';
+
+export const API_KEY_PREF = 'ai-features.huggingFace.apiKey';
+export const MODELS_PREF = 'ai-features.huggingFace.models';
+
+export const HuggingFacePreferencesSchema: PreferenceSchema = {
+    type: 'object',
+    properties: {
+        [API_KEY_PREF]: {
+            type: 'string',
+            markdownDescription: 'Enter an API Key for your Hugging Face Account. **Please note:** By using this preference the Hugging Face API key will be stored in clear text\
+            on the machine running Theia. Use the environment variable `HUGGINGFACE_API_KEY` to set the key securely.',
+            title: AI_CORE_PREFERENCES_TITLE,
+        },
+        [MODELS_PREF]: {
+            type: 'array',
+            description: 'Hugging Face models to use',
+            title: AI_CORE_PREFERENCES_TITLE,
+            default: ['bigcode/starcoder'],
+            items: {
+                type: 'string'
+            }
+        }
+    }
+};

package/src/common/huggingface-language-models-manager.ts

@@ -0,0 +1,40 @@
+// *****************************************************************************
+// Copyright (C) 2024 EclipseSource GmbH.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+export const HUGGINGFACE_LANGUAGE_MODELS_MANAGER_PATH = '/services/huggingface/language-model-manager';
+export const HuggingFaceLanguageModelsManager = Symbol('HuggingFaceLanguageModelsManager');
+
+export interface HuggingFaceModelDescription {
+    /**
+     * The identifier of the model which will be shown in the UI.
+     */
+    id: string;
+    /**
+     * The model ID as used by the Hugging Face API.
+     */
+    model: string;
+    /**
+     * Default request settings for the Hugging Face model.
+     */
+    defaultRequestSettings?: { [key: string]: unknown };
+}
+
+export interface HuggingFaceLanguageModelsManager {
+    apiKey: string | undefined;
+    setApiKey(key: string | undefined): void;
+    createOrUpdateLanguageModels(...models: HuggingFaceModelDescription[]): Promise<void>;
+    removeLanguageModels(...modelIds: string[]): void;
+}

package/src/common/index.ts

@@ -0,0 +1,16 @@
+// *****************************************************************************
+// Copyright (C) 2024 EclipseSource GmbH.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+export * from './huggingface-language-models-manager';

package/src/node/huggingface-backend-module.ts

@@ -0,0 +1,30 @@
+// *****************************************************************************
+// Copyright (C) 2024 EclipseSource GmbH.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+import { ContainerModule } from '@theia/core/shared/inversify';
+import { HUGGINGFACE_LANGUAGE_MODELS_MANAGER_PATH, HuggingFaceLanguageModelsManager } from '../common/huggingface-language-models-manager';
+import { ConnectionHandler, RpcConnectionHandler } from '@theia/core';
+import { HuggingFaceLanguageModelsManagerImpl } from './huggingface-language-models-manager-impl';
+
+export const HuggingFaceModelFactory = Symbol('HuggingFaceModelFactory');
+
+export default new ContainerModule(bind => {
+    bind(HuggingFaceLanguageModelsManagerImpl).toSelf().inSingletonScope();
+    bind(HuggingFaceLanguageModelsManager).toService(HuggingFaceLanguageModelsManagerImpl);
+    bind(ConnectionHandler).toDynamicValue(ctx =>
+        new RpcConnectionHandler(HUGGINGFACE_LANGUAGE_MODELS_MANAGER_PATH, () => ctx.container.get(HuggingFaceLanguageModelsManager))
+    ).inSingletonScope();
+});

package/src/node/huggingface-language-model.ts

@@ -0,0 +1,166 @@
+// *****************************************************************************
+// Copyright (C) 2024 EclipseSource GmbH.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+import {
+    LanguageModel,
+    LanguageModelRequest,
+    LanguageModelRequestMessage,
+    LanguageModelResponse,
+    LanguageModelStreamResponsePart,
+    LanguageModelTextResponse,
+    MessageActor
+} from '@theia/ai-core';
+import { CancellationToken } from '@theia/core';
+import { HfInference } from '@huggingface/inference';
+
+export const HuggingFaceModelIdentifier = Symbol('HuggingFaceModelIdentifier');
+
+function toHuggingFacePrompt(messages: LanguageModelRequestMessage[]): string {
+    if (messages.length === 1) {
+        return messages[0].query;
+    }
+    return messages.map(message => `${toRoleLabel(message.actor)}: ${message.query}`).join('\n');
+}
+
+function toRoleLabel(actor: MessageActor): string {
+    switch (actor) {
+        case 'user':
+            return 'User';
+        case 'ai':
+            return 'Assistant';
+        case 'system':
+            return 'System';
+        default:
+            return '';
+    }
+}
+
+export class HuggingFaceModel implements LanguageModel {
+
+    /**
+     * @param id the unique id for this language model. It will be used to identify the model in the UI.
+     * @param model the model id as it is used by the Hugging Face API
+     * @param apiKey function to retrieve the API key for Hugging Face
+     */
+    constructor(
+        public readonly id: string,
+        public model: string,
+        public apiKey: () => string | undefined,
+        public readonly name?: string,
+        public readonly vendor?: string,
+        public readonly version?: string,
+        public readonly family?: string,
+        public readonly maxInputTokens?: number,
+        public readonly maxOutputTokens?: number,
+        public defaultRequestSettings?: Record<string, unknown>
+    ) { }
+
+    async request(request: LanguageModelRequest, cancellationToken?: CancellationToken): Promise<LanguageModelResponse> {
+        const hfInference = this.initializeHfInference();
+        if (this.isStreamingSupported(this.model)) {
+            return this.handleStreamingRequest(hfInference, request, cancellationToken);
+        } else {
+            return this.handleNonStreamingRequest(hfInference, request);
+        }
+    }
+
+    protected getSettings(request: LanguageModelRequest): Record<string, unknown> {
+        const settings = request.settings ? request.settings : this.defaultRequestSettings;
+        if (!settings) {
+            return {};
+        }
+        return settings;
+    }
+
+    protected async handleNonStreamingRequest(hfInference: HfInference, request: LanguageModelRequest): Promise<LanguageModelTextResponse> {
+        const settings = this.getSettings(request);
+
+        const response = await hfInference.textGeneration({
+            model: this.model,
+            inputs: toHuggingFacePrompt(request.messages),
+            parameters: {
+                ...settings
+            }
+        });
+
+        const stopWords = Array.isArray(settings.stop) ? settings.stop : [];
+        let cleanText = response.generated_text;
+
+        stopWords.forEach(stopWord => {
+            if (cleanText.endsWith(stopWord)) {
+                cleanText = cleanText.slice(0, -stopWord.length).trim();
+            }
+        });
+
+        return {
+            text: cleanText
+        };
+    }
+
+    protected async handleStreamingRequest(
+        hfInference: HfInference,
+        request: LanguageModelRequest,
+        cancellationToken?: CancellationToken
+    ): Promise<LanguageModelResponse> {
+
+        const settings = this.getSettings(request);
+
+        const stream = hfInference.textGenerationStream({
+            model: this.model,
+            inputs: toHuggingFacePrompt(request.messages),
+            parameters: {
+                ...settings
+            }
+        });
+
+        const stopWords = Array.isArray(settings.stop) ? settings.stop : [];
+
+        const asyncIterator = {
+            async *[Symbol.asyncIterator](): AsyncIterator<LanguageModelStreamResponsePart> {
+                for await (const chunk of stream) {
+                    let content = chunk.token.text;
+
+                    stopWords.forEach(stopWord => {
+                        if (content.endsWith(stopWord)) {
+                            content = content.slice(0, -stopWord.length).trim();
+                        }
+                    });
+
+                    yield { content };
+
+                    if (cancellationToken?.isCancellationRequested) {
+                        break;
+                    }
+                }
+            }
+        };
+
+        return { stream: asyncIterator };
+    }
+
+    protected isStreamingSupported(model: string): boolean {
+        // Assuming all models support streaming for now; can be refined if needed
+        return true;
+    }
+
+    private initializeHfInference(): HfInference {
+        const token = this.apiKey();
+        if (!token) {
+            throw new Error('Please provide a Hugging Face API token.');
+        }
+        return new HfInference(token);
+    }
+}

package/src/node/huggingface-language-models-manager-impl.ts

@@ -0,0 +1,73 @@
+// *****************************************************************************
+// Copyright (C) 2024 EclipseSource GmbH.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+import { LanguageModelRegistry } from '@theia/ai-core';
+import { inject, injectable } from '@theia/core/shared/inversify';
+import { HuggingFaceModel } from './huggingface-language-model';
+import { HuggingFaceLanguageModelsManager, HuggingFaceModelDescription } from '../common';
+
+@injectable()
+export class HuggingFaceLanguageModelsManagerImpl implements HuggingFaceLanguageModelsManager {
+
+    protected _apiKey: string | undefined;
+
+    @inject(LanguageModelRegistry)
+    protected readonly languageModelRegistry: LanguageModelRegistry;
+
+    get apiKey(): string | undefined {
+        return this._apiKey ?? process.env.HUGGINGFACE_API_KEY;
+    }
+
+    async createOrUpdateLanguageModels(...modelDescriptions: HuggingFaceModelDescription[]): Promise<void> {
+        for (const modelDescription of modelDescriptions) {
+            const model = await this.languageModelRegistry.getLanguageModel(modelDescription.id);
+            const apiKeyProvider = () => this.apiKey;
+
+            if (model) {
+                if (!(model instanceof HuggingFaceModel)) {
+                    console.warn(`Hugging Face: model ${modelDescription.id} is not a Hugging Face model`);
+                    continue;
+                }
+                model.model = modelDescription.model;
+                model.apiKey = apiKeyProvider;
+                model.defaultRequestSettings = modelDescription.defaultRequestSettings;
+            } else {
+                this.languageModelRegistry.addLanguageModels([
+                    new HuggingFaceModel(
+                        modelDescription.id,
+                        modelDescription.model,
+                        apiKeyProvider,
+                        undefined,
+                        undefined,
+                        undefined,
+                        undefined,
+                        undefined,
+                        undefined,
+                        modelDescription.defaultRequestSettings
+                    )
+                ]);
+            }
+        }
+    }
+
+    removeLanguageModels(...modelIds: string[]): void {
+        this.languageModelRegistry.removeLanguageModels(modelIds);
+    }
+
+    setApiKey(apiKey: string | undefined): void {
+        this._apiKey = apiKey || undefined;
+    }
+}