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

package/README.md

@@ -0,0 +1,80 @@
+# @sweetoburrito/backstage-plugin-ai-assistant-backend-module-embeddings-provider-azure-open-ai
+
+An embeddings provider module that lets the Backstage AI Assistant backend create vector embeddings
+using Azure-hosted embedding models (Azure OpenAI / Azure AI Foundry).
+
+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 Azure OpenAI / Azure AI Foundry
+  embedding deployments.
+- Exposes a provider implementation compatible with the AI Assistant backend so different
+  embeddings services can be swapped without changing the rest of the app.
+- Handles basic batching and optional configuration for deployment name / endpoint selection.
+
+## When to use
+
+Use this module if you run Azure-hosted embedding models and want the AI Assistant to build
+semantic search indices, vector stores, or provide retrieval-augmented generation (RAG)
+capabilities in Backstage.
+
+## Configuration
+
+Add the provider configuration to your Backstage `app-config.yaml` or `app-config.local.yaml` under
+`aiAssistant.embeddings.azureOpenAI`.
+
+Minimum configuration keys (example):
+
+```yaml
+aiAssistant:
+  embeddings:
+    azureOpenAI:
+      endpoint: 'https://eastus.api.cognitive.microsoft.com/openai/deployments/text-embedding-3-large/embeddings?api-version=2023-05-15'
+      openAIApiVersion: 2024-12-01-preview
+      deploymentName: 'text-embedding-3-large'
+      instanceName: 'eastus'
+      apiKey: ${AZURE_OPENAI_API_KEY}
+```
+
+Field descriptions:
+
+- `endpoint` - The full Azure endpoint URL for the embeddings deployment. This may include
+  the deployment path and api-version query parameter depending on your Azure setup.
+- `deploymentName` - The name of the deployment that provides the embeddings model.
+- `instanceName` - The Azure instance / region name (used for telemetry or constructing alternate
+  endpoint forms in some setups).
+- `apiKey` - Your Azure OpenAI or Azure AI API key. Marked as secret in configuration.
+- `openAIApiVersion` -
+
+The exact keys available and required depend on your Azure configuration. 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-azure-open-ai
+```
+
+## 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 Azure OpenAI embeddings provider
+++backend.add(
+++ import(
+++  '@sweetoburrito/backstage-plugin-ai-assistant-backend-module-embeddings-provider-azure-open-ai'
+++ ),
+++);
+```
+
+Restart your backend after adding the provider so it registers with the AI Assistant plugin.

package/config.d.ts

@@ -0,0 +1,16 @@
+export interface Config {
+  aiAssistant: {
+    embeddings: {
+      azureOpenAi: {
+        endpoint: string;
+        deploymentName: string;
+        instanceName: string;
+        openAIApiVersion: 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.aiAssistantModuleEmbeddingsProviderAzureOpenAi;
+//# 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 aiAssistantModuleEmbeddingsProviderAzureOpenAi: _backstage_backend_plugin_api.BackendFeature;
+
+export { aiAssistantModuleEmbeddingsProviderAzureOpenAi as default };

package/dist/module.cjs.js

@@ -0,0 +1,49 @@
+'use strict';
+
+var backendPluginApi = require('@backstage/backend-plugin-api');
+var backstagePluginAiAssistantNode = require('@sweetoburrito/backstage-plugin-ai-assistant-node');
+var openai = require('@langchain/openai');
+
+const aiAssistantModuleEmbeddingsProviderAzureOpenAi = backendPluginApi.createBackendModule({
+  pluginId: "ai-assistant",
+  moduleId: "embeddings-provider-azure-openai",
+  register(reg) {
+    reg.registerInit({
+      deps: {
+        logger: backendPluginApi.coreServices.logger,
+        config: backendPluginApi.coreServices.rootConfig,
+        embeddingsProvider: backstagePluginAiAssistantNode.embeddingsProviderExtensionPoint
+      },
+      async init({ embeddingsProvider, config }) {
+        const deploymentName = config.getString(
+          "aiAssistant.embeddings.azureOpenAi.deploymentName"
+        );
+        const instanceName = config.getString(
+          "aiAssistant.embeddings.azureOpenAi.instanceName"
+        );
+        const apiKey = config.getString(
+          "aiAssistant.embeddings.azureOpenAi.apiKey"
+        );
+        const endpoint = config.getString(
+          "aiAssistant.embeddings.azureOpenAi.endpoint"
+        );
+        const openAIApiVersion = config.getString(
+          "aiAssistant.embeddings.azureOpenAi.openAIApiVersion"
+        );
+        const embeddings = new openai.AzureOpenAIEmbeddings({
+          azureOpenAIApiEmbeddingsDeploymentName: deploymentName,
+          azureOpenAIApiInstanceName: instanceName,
+          azureOpenAIEndpoint: endpoint,
+          azureOpenAIApiKey: apiKey,
+          openAIApiVersion
+        });
+        return embeddingsProvider.register({
+          getEmbeddings: async () => embeddings
+        });
+      }
+    });
+  }
+});
+
+exports.aiAssistantModuleEmbeddingsProviderAzureOpenAi = aiAssistantModuleEmbeddingsProviderAzureOpenAi;
+//# 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 { AzureOpenAIEmbeddings } from '@langchain/openai';\n\nexport const aiAssistantModuleEmbeddingsProviderAzureOpenAi =\n  createBackendModule({\n    pluginId: 'ai-assistant',\n    moduleId: 'embeddings-provider-azure-openai',\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 deploymentName = config.getString(\n            'aiAssistant.embeddings.azureOpenAi.deploymentName',\n          );\n\n          const instanceName = config.getString(\n            'aiAssistant.embeddings.azureOpenAi.instanceName',\n          );\n          const apiKey = config.getString(\n            'aiAssistant.embeddings.azureOpenAi.apiKey',\n          );\n          const endpoint = config.getString(\n            'aiAssistant.embeddings.azureOpenAi.endpoint',\n          );\n\n          const openAIApiVersion = config.getString(\n            'aiAssistant.embeddings.azureOpenAi.openAIApiVersion',\n          );\n\n          const embeddings = new AzureOpenAIEmbeddings({\n            azureOpenAIApiEmbeddingsDeploymentName: deploymentName,\n            azureOpenAIApiInstanceName: instanceName,\n            azureOpenAIEndpoint: endpoint,\n            azureOpenAIApiKey: apiKey,\n            openAIApiVersion: openAIApiVersion,\n          });\n\n          return embeddingsProvider.register({\n            getEmbeddings: async () => embeddings,\n          });\n        },\n      });\n    },\n  });\n"],"names":["createBackendModule","coreServices","embeddingsProviderExtensionPoint","AzureOpenAIEmbeddings"],"mappings":";;;;;;AAOO,MAAM,iDACXA,oCAAA,CAAoB;AAAA,EAClB,QAAA,EAAU,cAAA;AAAA,EACV,QAAA,EAAU,kCAAA;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,iBAAiB,MAAA,CAAO,SAAA;AAAA,UAC5B;AAAA,SACF;AAEA,QAAA,MAAM,eAAe,MAAA,CAAO,SAAA;AAAA,UAC1B;AAAA,SACF;AACA,QAAA,MAAM,SAAS,MAAA,CAAO,SAAA;AAAA,UACpB;AAAA,SACF;AACA,QAAA,MAAM,WAAW,MAAA,CAAO,SAAA;AAAA,UACtB;AAAA,SACF;AAEA,QAAA,MAAM,mBAAmB,MAAA,CAAO,SAAA;AAAA,UAC9B;AAAA,SACF;AAEA,QAAA,MAAM,UAAA,GAAa,IAAIC,4BAAA,CAAsB;AAAA,UAC3C,sCAAA,EAAwC,cAAA;AAAA,UACxC,0BAAA,EAA4B,YAAA;AAAA,UAC5B,mBAAA,EAAqB,QAAA;AAAA,UACrB,iBAAA,EAAmB,MAAA;AAAA,UACnB;AAAA,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-azure-open-ai",
+  "version": "0.0.0-snapshot-20251029150521",
+  "license": "Apache-2.0",
+  "description": "The embeddings-provider-azure-open-ai 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/openai": "^0.6.11",
+    "@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"
+      ]
+    }
+  }
+}