@sweetoburrito/backstage-plugin-ai-assistant-backend-module-embeddings-provider-ollama 0.0.0-snapshot-20251029150521

package/README.md

@@ -0,0 +1,77 @@
+# @sweetoburrito/backstage-plugin-ai-assistant-backend-module-embeddings-provider-ollama
+
+An embeddings provider module that lets the Backstage AI Assistant backend create vector
+embeddings using Ollama-hosted models (local Ollama server or Ollama Cloud).
+
+This README explains how the provider works, when to use it, configuration options, and how
+to wire it into your Backstage backend.
+
+## Features
+
+- Convert text or documents to numeric vector embeddings using an Ollama model.
+- Exposes a provider implementation compatible with the AI Assistant backend so different
+  embeddings services can be swapped without changing the rest of the app.
+- Minimal configuration for local or remote Ollama endpoints and optional API key support.
+
+## When to use
+
+Use this module when you run an Ollama embeddings-capable model and want the AI Assistant to
+build semantic search indices, vector stores, or provide retrieval-augmented generation (RAG)
+capabilities in Backstage. It's a good fit for local development with Ollama or when using an
+Ollama-hosted endpoint.
+
+## Configuration
+
+Add the provider configuration to your Backstage `app-config.yaml` or `app-config.local.yaml`
+under `aiAssistant.embeddings.ollama`.
+
+Minimum configuration keys (example):
+
+```yaml
+aiAssistant:
+  embeddings:
+    ollama:
+      baseUrl: 'http://localhost:11434'
+      model: 'text-embedding-3-small'
+      apiKey: ${OLLAMA_API_KEY}
+```
+
+Field descriptions:
+
+- `baseUrl` - The base URL of your Ollama service. For a local Ollama server this is typically
+  `http://localhost:11434`. For Ollama Cloud or a proxied endpoint, use the full base URL. For ollama with webui you must set the base url to the `/ollama` route. i.e `http://localhost:11434/ollama`
+- `model` - The name of the model to use for generating embeddings. The model must support
+  embeddings (check your Ollama model documentation for supported capabilities).
+- `apiKey` - (Optional) An API key for Ollama Cloud or any endpoint that requires authentication.
+  Mark this value as secret in Backstage configuration when applicable.
+
+The exact keys available and required depend on your Ollama setup. Check the provider's
+`config.d.ts` in the package for the canonical types used by the module.
+
+## Install
+
+Install the module into your Backstage backend workspace:
+
+```sh
+yarn workspace backend add @sweetoburrito/backstage-plugin-ai-assistant-backend-module-embeddings-provider-ollama
+```
+
+## Wire the provider into your backend
+
+Add the provider module import to your backend entrypoint (usually `packages/backend/src/index.ts`):
+
+```diff
+// packages/backend/src/index.ts
+
+// other backend modules...
+backend.add(import('@sweetoburrito/backstage-plugin-ai-assistant-backend'));
+
+// Add the Ollama embeddings provider
+++backend.add(
+++  import(
+++    '@sweetoburrito/backstage-plugin-ai-assistant-backend-module-embeddings-provider-ollama'
+++  ),
+++);
+```
+
+Restart your backend after adding the provider so it registers with the AI Assistant plugin.

package/config.d.ts

@@ -0,0 +1,14 @@
+export interface Config {
+  aiAssistant: {
+    embeddings: {
+      ollama: {
+        baseUrl: string;
+        model: string;
+        /**
+         * @visibility secret
+         */
+        apiKey: string;
+      };
+    };
+  };
+}

package/dist/index.cjs.js

@@ -0,0 +1,10 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var module$1 = require('./module.cjs.js');
+
+
+
+exports.default = module$1.aiAssistantModuleEmbeddingsProviderOllama;
+//# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;"}

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
+
+declare const aiAssistantModuleEmbeddingsProviderOllama: _backstage_backend_plugin_api.BackendFeature;
+
+export { aiAssistantModuleEmbeddingsProviderOllama as default };

package/dist/module.cjs.js

@@ -0,0 +1,39 @@
+'use strict';
+
+var backendPluginApi = require('@backstage/backend-plugin-api');
+var backstagePluginAiAssistantNode = require('@sweetoburrito/backstage-plugin-ai-assistant-node');
+var ollama = require('@langchain/ollama');
+
+const aiAssistantModuleEmbeddingsProviderOllama = backendPluginApi.createBackendModule({
+  pluginId: "ai-assistant",
+  moduleId: "embeddings-provider-ollama",
+  register(reg) {
+    reg.registerInit({
+      deps: {
+        logger: backendPluginApi.coreServices.logger,
+        config: backendPluginApi.coreServices.rootConfig,
+        embeddingsProvider: backstagePluginAiAssistantNode.embeddingsProviderExtensionPoint
+      },
+      async init({ embeddingsProvider, config }) {
+        const model = config.getString("aiAssistant.embeddings.ollama.model");
+        const apiKey = config.getString("aiAssistant.embeddings.ollama.apiKey");
+        const baseUrl = config.getString(
+          "aiAssistant.embeddings.ollama.baseUrl"
+        );
+        const embeddings = new ollama.OllamaEmbeddings({
+          baseUrl,
+          model,
+          headers: {
+            Authorization: `Bearer ${apiKey}`
+          }
+        });
+        return embeddingsProvider.register({
+          getEmbeddings: async () => embeddings
+        });
+      }
+    });
+  }
+});
+
+exports.aiAssistantModuleEmbeddingsProviderOllama = aiAssistantModuleEmbeddingsProviderOllama;
+//# sourceMappingURL=module.cjs.js.map

package/dist/module.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"module.cjs.js","sources":["../src/module.ts"],"sourcesContent":["import {\n  coreServices,\n  createBackendModule,\n} from '@backstage/backend-plugin-api';\nimport { embeddingsProviderExtensionPoint } from '@sweetoburrito/backstage-plugin-ai-assistant-node';\nimport { OllamaEmbeddings } from '@langchain/ollama';\n\nexport const aiAssistantModuleEmbeddingsProviderOllama = createBackendModule({\n  pluginId: 'ai-assistant',\n  moduleId: 'embeddings-provider-ollama',\n  register(reg) {\n    reg.registerInit({\n      deps: {\n        logger: coreServices.logger,\n        config: coreServices.rootConfig,\n        embeddingsProvider: embeddingsProviderExtensionPoint,\n      },\n      async init({ embeddingsProvider, config }) {\n        const model = config.getString('aiAssistant.embeddings.ollama.model');\n        const apiKey = config.getString('aiAssistant.embeddings.ollama.apiKey');\n        const baseUrl = config.getString(\n          'aiAssistant.embeddings.ollama.baseUrl',\n        );\n\n        const embeddings = new OllamaEmbeddings({\n          baseUrl,\n          model,\n          headers: {\n            Authorization: `Bearer ${apiKey}`,\n          },\n        });\n\n        return embeddingsProvider.register({\n          getEmbeddings: async () => embeddings,\n        });\n      },\n    });\n  },\n});\n"],"names":["createBackendModule","coreServices","embeddingsProviderExtensionPoint","OllamaEmbeddings"],"mappings":";;;;;;AAOO,MAAM,4CAA4CA,oCAAA,CAAoB;AAAA,EAC3E,QAAA,EAAU,cAAA;AAAA,EACV,QAAA,EAAU,4BAAA;AAAA,EACV,SAAS,GAAA,EAAK;AACZ,IAAA,GAAA,CAAI,YAAA,CAAa;AAAA,MACf,IAAA,EAAM;AAAA,QACJ,QAAQC,6BAAA,CAAa,MAAA;AAAA,QACrB,QAAQA,6BAAA,CAAa,UAAA;AAAA,QACrB,kBAAA,EAAoBC;AAAA,OACtB;AAAA,MACA,MAAM,IAAA,CAAK,EAAE,kBAAA,EAAoB,QAAO,EAAG;AACzC,QAAA,MAAM,KAAA,GAAQ,MAAA,CAAO,SAAA,CAAU,qCAAqC,CAAA;AACpE,QAAA,MAAM,MAAA,GAAS,MAAA,CAAO,SAAA,CAAU,sCAAsC,CAAA;AACtE,QAAA,MAAM,UAAU,MAAA,CAAO,SAAA;AAAA,UACrB;AAAA,SACF;AAEA,QAAA,MAAM,UAAA,GAAa,IAAIC,uBAAA,CAAiB;AAAA,UACtC,OAAA;AAAA,UACA,KAAA;AAAA,UACA,OAAA,EAAS;AAAA,YACP,aAAA,EAAe,UAAU,MAAM,CAAA;AAAA;AACjC,SACD,CAAA;AAED,QAAA,OAAO,mBAAmB,QAAA,CAAS;AAAA,UACjC,eAAe,YAAY;AAAA,SAC5B,CAAA;AAAA,MACH;AAAA,KACD,CAAA;AAAA,EACH;AACF,CAAC;;;;"}

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@sweetoburrito/backstage-plugin-ai-assistant-backend-module-embeddings-provider-ollama",
+  "version": "0.0.0-snapshot-20251029150521",
+  "license": "Apache-2.0",
+  "description": "The embeddings-provider-ollama backend module for the ai-assistant plugin.",
+  "main": "dist/index.cjs.js",
+  "types": "dist/index.d.ts",
+  "publishConfig": {
+    "access": "public",
+    "main": "dist/index.cjs.js",
+    "types": "dist/index.d.ts"
+  },
+  "backstage": {
+    "role": "backend-plugin-module",
+    "pluginId": "ai-assistant",
+    "pluginPackage": "@sweetoburrito/backstage-plugin-ai-assistant-backend",
+    "features": {
+      ".": "@backstage/BackendFeature"
+    }
+  },
+  "scripts": {
+    "start": "backstage-cli package start",
+    "build": "backstage-cli package build",
+    "lint": "backstage-cli package lint",
+    "test": "backstage-cli package test",
+    "clean": "backstage-cli package clean",
+    "prepack": "backstage-cli package prepack",
+    "postpack": "backstage-cli package postpack"
+  },
+  "dependencies": {
+    "@backstage/backend-plugin-api": "backstage:^",
+    "@langchain/ollama": "^0.2.3",
+    "@sweetoburrito/backstage-plugin-ai-assistant-node": "0.0.0-snapshot-20251029150521"
+  },
+  "devDependencies": {
+    "@backstage/backend-test-utils": "backstage:^",
+    "@backstage/cli": "backstage:^"
+  },
+  "configSchema": "config.d.ts",
+  "files": [
+    "dist",
+    "config.d.ts"
+  ],
+  "typesVersions": {
+    "*": {
+      "package.json": [
+        "package.json"
+      ]
+    }
+  }
+}