@sweetoburrito/backstage-plugin-ai-assistant-backend 0.0.0-snapshot-20251029080430

package/README.md

@@ -0,0 +1,28 @@
+# ai-assistant
+
+This plugin backend was templated using the Backstage CLI. You should replace this text with a description of your plugin backend.
+
+## Installation
+
+This plugin is installed via the `@internal/plugin-ai-assistant-backend` package. To install it to your backend package, run the following command:
+
+```bash
+# From your root directory
+yarn --cwd packages/backend add @internal/plugin-ai-assistant-backend
+```
+
+Then add the plugin to your backend in `packages/backend/src/index.ts`:
+
+```ts
+const backend = createBackend();
+// ...
+backend.add(import('@internal/plugin-ai-assistant-backend'));
+```
+
+## Development
+
+This plugin backend can be started in a standalone mode from directly in this
+package with `yarn start`. It is a limited setup that is most convenient when
+developing the plugin backend itself.
+
+If you want to run the entire project, including the frontend, run `yarn start` from the root directory.

package/config.d.ts

@@ -0,0 +1,32 @@
+import { HumanDuration } from '@backstage/types';
+import { SchedulerServiceTaskScheduleDefinitionConfig } from '@backstage/backend-plugin-api';
+
+export interface Config {
+  aiAssistant: {
+    prompt?: {
+      system?: string;
+      prefix?: string;
+      suffix?: string;
+    };
+    conversation?: {
+      summaryModel?: string;
+      summaryPrompt?: string;
+    };
+    storage?: {
+      pgVector?: {
+        /**
+         * The size of the chunk to flush when storing embeddings to the DB
+         */
+        chunkSize?: number;
+
+        /**
+         * The default amount of embeddings to return when querying vectors with similarity search
+         */
+        amount?: number;
+      };
+    };
+    ingestion?: {
+      schedule?: SchedulerServiceTaskScheduleDefinitionConfig;
+    };
+  };
+}

package/dist/constants/prompts.cjs.js

@@ -0,0 +1,43 @@
+'use strict';
+
+const DEFAULT_SUMMARY_PROMPT = "Summarize this conversation in a concise manner. The summary should capture the main points. Return the summary only, without any additional text.";
+const DEFAULT_IDENTITY_PROMPT = `
+You are a helpful assistant that answers questions based on provided context from various documents. The context may come from sources such as internal wikis, code repositories, technical documentation, or other structured or unstructured data.
+`;
+const DEFAULT_FORMATTING_PROMPT = `
+CRITICAL FORMATTING RULES - MUST ALWAYS FOLLOW:
+1. **ALWAYS use proper markdown formatting in ALL responses**
+2. **NEVER output plain URLs** - ALWAYS convert them to clickable markdown links using [description](url) syntax
+3. **For images, ALWAYS use markdown image syntax**: ![alt text](image-url)
+4. **For all URLs, ALWAYS format as**: [descriptive text](url) - never just paste the raw URL
+5. Use headings (##, ###), bullet points, numbered lists, and **bold**/*italic* text appropriately
+6. Format code with backticks: \`inline code\` or \`\`\`language for code blocks
+7. Structure responses clearly with proper spacing and organization
+`;
+const DEFAULT_SYSTEM_PROMPT = `
+Content Rules:
+1. Always base your answers on the provided context. Do not make up information.
+2. When relevant, cite or reference the source information provided in the context.
+3. Maintain a professional, friendly, and helpful tone.
+4. Return only the relevant information without any filler or unnecessary details.
+5. If you don't know the answer, admit it and suggest ways to find the information.
+6. **Actively use available tools** to enhance your responses
+7. Adapt your approach based on the specific tools and capabilities available in the current session
+8. When you do not have the information needed to answer, use the tools provided to gather more context before responding.
+`;
+const DEFAULT_TOOL_GUIDELINE = `
+TOOL USAGE GUIDELINES:
+- Only use tools when explicitly needed to answer the user's question
+- Read tool descriptions carefully before using them
+- If you can answer without tools, do so
+- IMPORTANT: When using tools, always explain why you're using each tool
+- Use tools in logical sequence, not randomly
+- If a tool fails, try an alternative approach before using another tool
+`;
+
+exports.DEFAULT_FORMATTING_PROMPT = DEFAULT_FORMATTING_PROMPT;
+exports.DEFAULT_IDENTITY_PROMPT = DEFAULT_IDENTITY_PROMPT;
+exports.DEFAULT_SUMMARY_PROMPT = DEFAULT_SUMMARY_PROMPT;
+exports.DEFAULT_SYSTEM_PROMPT = DEFAULT_SYSTEM_PROMPT;
+exports.DEFAULT_TOOL_GUIDELINE = DEFAULT_TOOL_GUIDELINE;
+//# sourceMappingURL=prompts.cjs.js.map

package/dist/constants/prompts.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"prompts.cjs.js","sources":["../../src/constants/prompts.ts"],"sourcesContent":["export const DEFAULT_SUMMARY_PROMPT =\n  'Summarize this conversation in a concise manner. The summary should capture the main points. Return the summary only, without any additional text.';\n\nexport const DEFAULT_IDENTITY_PROMPT = `\nYou are a helpful assistant that answers questions based on provided context from various documents. The context may come from sources such as internal wikis, code repositories, technical documentation, or other structured or unstructured data.\n`;\n\nexport const DEFAULT_FORMATTING_PROMPT = `\nCRITICAL FORMATTING RULES - MUST ALWAYS FOLLOW:\n1. **ALWAYS use proper markdown formatting in ALL responses**\n2. **NEVER output plain URLs** - ALWAYS convert them to clickable markdown links using [description](url) syntax\n3. **For images, ALWAYS use markdown image syntax**: ![alt text](image-url)\n4. **For all URLs, ALWAYS format as**: [descriptive text](url) - never just paste the raw URL\n5. Use headings (##, ###), bullet points, numbered lists, and **bold**/*italic* text appropriately\n6. Format code with backticks: \\`inline code\\` or \\`\\`\\`language for code blocks\n7. Structure responses clearly with proper spacing and organization\n`;\n\nexport const DEFAULT_SYSTEM_PROMPT = `\nContent Rules:\n1. Always base your answers on the provided context. Do not make up information.\n2. When relevant, cite or reference the source information provided in the context.\n3. Maintain a professional, friendly, and helpful tone.\n4. Return only the relevant information without any filler or unnecessary details.\n5. If you don't know the answer, admit it and suggest ways to find the information.\n6. **Actively use available tools** to enhance your responses\n7. Adapt your approach based on the specific tools and capabilities available in the current session\n8. When you do not have the information needed to answer, use the tools provided to gather more context before responding.\n`;\n\nexport const DEFAULT_TOOL_GUIDELINE = `\nTOOL USAGE GUIDELINES:\n- Only use tools when explicitly needed to answer the user's question\n- Read tool descriptions carefully before using them\n- If you can answer without tools, do so\n- IMPORTANT: When using tools, always explain why you're using each tool\n- Use tools in logical sequence, not randomly\n- If a tool fails, try an alternative approach before using another tool\n`;\n"],"names":[],"mappings":";;AAAO,MAAM,sBAAA,GACX;AAEK,MAAM,uBAAA,GAA0B;AAAA;AAAA;AAIhC,MAAM,yBAAA,GAA4B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAWlC,MAAM,qBAAA,GAAwB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAY9B,MAAM,sBAAA,GAAyB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;;;;;;"}

package/dist/database/chat-store.cjs.js

@@ -0,0 +1,96 @@
+'use strict';
+
+const MESSAGE_TABLE_NAME = "message";
+const CONVERSATION_TABLE_NAME = "conversation";
+class ChatStore {
+  /**
+   * Creates an instance of ChatStore.
+   * @param client - The Knex client to interact with the PostgreSQL database.
+   */
+  constructor(client) {
+    this.client = client;
+  }
+  static async fromConfig({ database }) {
+    const client = await database.getClient();
+    return new ChatStore(client);
+  }
+  messageTable() {
+    return this.client(MESSAGE_TABLE_NAME);
+  }
+  conversationTable() {
+    return this.client(CONVERSATION_TABLE_NAME);
+  }
+  async getChatMessages(conversationId, userRef, limit, excludeRoles) {
+    let query = this.messageTable().where({ conversation_id: conversationId, userRef }).select("*").orderBy("created_at", "asc");
+    if (typeof limit === "number") {
+      query = query.limit(limit).orderBy("created_at", "desc");
+    }
+    if (excludeRoles && excludeRoles.length > 0) {
+      query = query.whereNotIn("role", excludeRoles);
+    }
+    const rows = await query;
+    const chatMessages = rows.map((row) => ({
+      role: row.role,
+      content: row.content,
+      id: row.id,
+      metadata: row.metadata
+    }));
+    return chatMessages;
+  }
+  async addChatMessage(messages, userRef, conversationId) {
+    const rows = messages.map((msg) => ({
+      id: msg.id,
+      conversation_id: conversationId,
+      role: msg.role,
+      content: msg.content,
+      metadata: msg.metadata,
+      userRef,
+      created_at: this.client.fn.now()
+    }));
+    await this.messageTable().insert(rows);
+  }
+  async updateMessage(message) {
+    await this.messageTable().where({ id: message.id }).update({
+      role: message.role,
+      content: message.content,
+      metadata: message.metadata
+    });
+  }
+  async getConversation(conversationId, userRef) {
+    const row = await this.conversationTable().where({ id: conversationId, userRef }).first();
+    if (!row) {
+      throw new Error("Conversation not found");
+    }
+    const conversation = {
+      id: row.id,
+      title: row.title,
+      userRef: row.userRef
+    };
+    return conversation;
+  }
+  async createConversation(conversation) {
+    await this.conversationTable().insert({
+      id: conversation.id,
+      title: conversation.title,
+      userRef: conversation.userRef
+    });
+  }
+  async updateConversation(conversation) {
+    await this.conversationTable().where({ id: conversation.id }).update({
+      title: conversation.title,
+      userRef: conversation.userRef
+    });
+  }
+  async getConversations(userRef) {
+    const rows = await this.conversationTable().where({ userRef }).select("*").orderBy("created_at", "desc");
+    const conversations = rows.map((row) => ({
+      id: row.id,
+      title: row.title,
+      userRef: row.userRef
+    }));
+    return conversations;
+  }
+}
+
+exports.ChatStore = ChatStore;
+//# sourceMappingURL=chat-store.cjs.js.map

package/dist/database/chat-store.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"chat-store.cjs.js","sources":["../../src/database/chat-store.ts"],"sourcesContent":["import { DatabaseService } from '@backstage/backend-plugin-api';\nimport {\n  Message,\n  Conversation,\n} from '@sweetoburrito/backstage-plugin-ai-assistant-common';\n\nimport { Knex } from 'knex';\n\nconst MESSAGE_TABLE_NAME = 'message';\nconst CONVERSATION_TABLE_NAME = 'conversation';\n\nexport type ChatStoreOptions = {\n  database: DatabaseService;\n};\n\nexport class ChatStore {\n  /**\n   * Creates an instance of ChatStore.\n   * @param client - The Knex client to interact with the PostgreSQL database.\n   */\n  constructor(private readonly client: Knex) {}\n\n  static async fromConfig({ database }: ChatStoreOptions) {\n    const client = await database.getClient();\n    return new ChatStore(client);\n  }\n\n  messageTable() {\n    return this.client(MESSAGE_TABLE_NAME);\n  }\n\n  conversationTable() {\n    return this.client(CONVERSATION_TABLE_NAME);\n  }\n\n  async getChatMessages(\n    conversationId: string,\n    userRef: string,\n    limit?: number,\n    excludeRoles?: Message['role'][],\n  ): Promise<Required<Message>[]> {\n    let query = this.messageTable()\n      .where({ conversation_id: conversationId, userRef })\n      .select('*')\n      .orderBy('created_at', 'asc');\n\n    if (typeof limit === 'number') {\n      query = query.limit(limit).orderBy('created_at', 'desc');\n    }\n\n    if (excludeRoles && excludeRoles.length > 0) {\n      query = query.whereNotIn('role', excludeRoles);\n    }\n\n    const rows = await query;\n\n    const chatMessages: Required<Message>[] = rows.map(row => ({\n      role: row.role,\n      content: row.content,\n      id: row.id,\n      metadata: row.metadata,\n    }));\n\n    return chatMessages;\n  }\n\n  async addChatMessage(\n    messages: Message[],\n    userRef: string,\n    conversationId: string,\n  ): Promise<void> {\n    const rows = messages.map(msg => ({\n      id: msg.id,\n      conversation_id: conversationId,\n      role: msg.role,\n      content: msg.content,\n      metadata: msg.metadata,\n      userRef,\n      created_at: this.client.fn.now(),\n    }));\n\n    await this.messageTable().insert(rows);\n  }\n\n  async updateMessage(message: Required<Message>) {\n    await this.messageTable().where({ id: message.id }).update({\n      role: message.role,\n      content: message.content,\n      metadata: message.metadata,\n    });\n  }\n\n  async getConversation(\n    conversationId: string,\n    userRef: string,\n  ): Promise<Conversation> {\n    const row = await this.conversationTable()\n      .where({ id: conversationId, userRef })\n      .first();\n\n    if (!row) {\n      throw new Error('Conversation not found');\n    }\n\n    const conversation: Conversation = {\n      id: row.id,\n      title: row.title,\n      userRef: row.userRef,\n    };\n\n    return conversation;\n  }\n\n  async createConversation(conversation: Conversation) {\n    await this.conversationTable().insert({\n      id: conversation.id,\n      title: conversation.title,\n      userRef: conversation.userRef,\n    });\n  }\n\n  async updateConversation(conversation: Conversation) {\n    await this.conversationTable().where({ id: conversation.id }).update({\n      title: conversation.title,\n      userRef: conversation.userRef,\n    });\n  }\n\n  async getConversations(userRef: string): Promise<Conversation[]> {\n    const rows = await this.conversationTable()\n      .where({ userRef })\n      .select('*')\n      .orderBy('created_at', 'desc');\n\n    const conversations: Conversation[] = rows.map(row => ({\n      id: row.id,\n      title: row.title,\n      userRef: row.userRef,\n    }));\n\n    return conversations;\n  }\n}\n"],"names":[],"mappings":";;AAQA,MAAM,kBAAA,GAAqB,SAAA;AAC3B,MAAM,uBAAA,GAA0B,cAAA;AAMzB,MAAM,SAAA,CAAU;AAAA;AAAA;AAAA;AAAA;AAAA,EAKrB,YAA6B,MAAA,EAAc;AAAd,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA;AAAA,EAAe;AAAA,EAE5C,aAAa,UAAA,CAAW,EAAE,QAAA,EAAS,EAAqB;AACtD,IAAA,MAAM,MAAA,GAAS,MAAM,QAAA,CAAS,SAAA,EAAU;AACxC,IAAA,OAAO,IAAI,UAAU,MAAM,CAAA;AAAA,EAC7B;AAAA,EAEA,YAAA,GAAe;AACb,IAAA,OAAO,IAAA,CAAK,OAAO,kBAAkB,CAAA;AAAA,EACvC;AAAA,EAEA,iBAAA,GAAoB;AAClB,IAAA,OAAO,IAAA,CAAK,OAAO,uBAAuB,CAAA;AAAA,EAC5C;AAAA,EAEA,MAAM,eAAA,CACJ,cAAA,EACA,OAAA,EACA,OACA,YAAA,EAC8B;AAC9B,IAAA,IAAI,QAAQ,IAAA,CAAK,YAAA,EAAa,CAC3B,KAAA,CAAM,EAAE,eAAA,EAAiB,cAAA,EAAgB,OAAA,EAAS,EAClD,MAAA,CAAO,GAAG,CAAA,CACV,OAAA,CAAQ,cAAc,KAAK,CAAA;AAE9B,IAAA,IAAI,OAAO,UAAU,QAAA,EAAU;AAC7B,MAAA,KAAA,GAAQ,MAAM,KAAA,CAAM,KAAK,CAAA,CAAE,OAAA,CAAQ,cAAc,MAAM,CAAA;AAAA,IACzD;AAEA,IAAA,IAAI,YAAA,IAAgB,YAAA,CAAa,MAAA,GAAS,CAAA,EAAG;AAC3C,MAAA,KAAA,GAAQ,KAAA,CAAM,UAAA,CAAW,MAAA,EAAQ,YAAY,CAAA;AAAA,IAC/C;AAEA,IAAA,MAAM,OAAO,MAAM,KAAA;AAEnB,IAAA,MAAM,YAAA,GAAoC,IAAA,CAAK,GAAA,CAAI,CAAA,GAAA,MAAQ;AAAA,MACzD,MAAM,GAAA,CAAI,IAAA;AAAA,MACV,SAAS,GAAA,CAAI,OAAA;AAAA,MACb,IAAI,GAAA,CAAI,EAAA;AAAA,MACR,UAAU,GAAA,CAAI;AAAA,KAChB,CAAE,CAAA;AAEF,IAAA,OAAO,YAAA;AAAA,EACT;AAAA,EAEA,MAAM,cAAA,CACJ,QAAA,EACA,OAAA,EACA,cAAA,EACe;AACf,IAAA,MAAM,IAAA,GAAO,QAAA,CAAS,GAAA,CAAI,CAAA,GAAA,MAAQ;AAAA,MAChC,IAAI,GAAA,CAAI,EAAA;AAAA,MACR,eAAA,EAAiB,cAAA;AAAA,MACjB,MAAM,GAAA,CAAI,IAAA;AAAA,MACV,SAAS,GAAA,CAAI,OAAA;AAAA,MACb,UAAU,GAAA,CAAI,QAAA;AAAA,MACd,OAAA;AAAA,MACA,UAAA,EAAY,IAAA,CAAK,MAAA,CAAO,EAAA,CAAG,GAAA;AAAI,KACjC,CAAE,CAAA;AAEF,IAAA,MAAM,IAAA,CAAK,YAAA,EAAa,CAAE,MAAA,CAAO,IAAI,CAAA;AAAA,EACvC;AAAA,EAEA,MAAM,cAAc,OAAA,EAA4B;AAC9C,IAAA,MAAM,IAAA,CAAK,YAAA,EAAa,CAAE,KAAA,CAAM,EAAE,IAAI,OAAA,CAAQ,EAAA,EAAI,CAAA,CAAE,MAAA,CAAO;AAAA,MACzD,MAAM,OAAA,CAAQ,IAAA;AAAA,MACd,SAAS,OAAA,CAAQ,OAAA;AAAA,MACjB,UAAU,OAAA,CAAQ;AAAA,KACnB,CAAA;AAAA,EACH;AAAA,EAEA,MAAM,eAAA,CACJ,cAAA,EACA,OAAA,EACuB;AACvB,IAAA,MAAM,GAAA,GAAM,MAAM,IAAA,CAAK,iBAAA,EAAkB,CACtC,KAAA,CAAM,EAAE,EAAA,EAAI,cAAA,EAAgB,OAAA,EAAS,CAAA,CACrC,KAAA,EAAM;AAET,IAAA,IAAI,CAAC,GAAA,EAAK;AACR,MAAA,MAAM,IAAI,MAAM,wBAAwB,CAAA;AAAA,IAC1C;AAEA,IAAA,MAAM,YAAA,GAA6B;AAAA,MACjC,IAAI,GAAA,CAAI,EAAA;AAAA,MACR,OAAO,GAAA,CAAI,KAAA;AAAA,MACX,SAAS,GAAA,CAAI;AAAA,KACf;AAEA,IAAA,OAAO,YAAA;AAAA,EACT;AAAA,EAEA,MAAM,mBAAmB,YAAA,EAA4B;AACnD,IAAA,MAAM,IAAA,CAAK,iBAAA,EAAkB,CAAE,MAAA,CAAO;AAAA,MACpC,IAAI,YAAA,CAAa,EAAA;AAAA,MACjB,OAAO,YAAA,CAAa,KAAA;AAAA,MACpB,SAAS,YAAA,CAAa;AAAA,KACvB,CAAA;AAAA,EACH;AAAA,EAEA,MAAM,mBAAmB,YAAA,EAA4B;AACnD,IAAA,MAAM,IAAA,CAAK,iBAAA,EAAkB,CAAE,KAAA,CAAM,EAAE,IAAI,YAAA,CAAa,EAAA,EAAI,CAAA,CAAE,MAAA,CAAO;AAAA,MACnE,OAAO,YAAA,CAAa,KAAA;AAAA,MACpB,SAAS,YAAA,CAAa;AAAA,KACvB,CAAA;AAAA,EACH;AAAA,EAEA,MAAM,iBAAiB,OAAA,EAA0C;AAC/D,IAAA,MAAM,IAAA,GAAO,MAAM,IAAA,CAAK,iBAAA,GACrB,KAAA,CAAM,EAAE,OAAA,EAAS,EACjB,MAAA,CAAO,GAAG,CAAA,CACV,OAAA,CAAQ,cAAc,MAAM,CAAA;AAE/B,IAAA,MAAM,aAAA,GAAgC,IAAA,CAAK,GAAA,CAAI,CAAA,GAAA,MAAQ;AAAA,MACrD,IAAI,GAAA,CAAI,EAAA;AAAA,MACR,OAAO,GAAA,CAAI,KAAA;AAAA,MACX,SAAS,GAAA,CAAI;AAAA,KACf,CAAE,CAAA;AAEF,IAAA,OAAO,aAAA;AAAA,EACT;AACF;;;;"}

package/dist/database/migrations.cjs.js

@@ -0,0 +1,16 @@
+'use strict';
+
+var backendPluginApi = require('@backstage/backend-plugin-api');
+
+async function applyDatabaseMigrations(knex) {
+  const migrationsDir = backendPluginApi.resolvePackagePath(
+    "@sweetoburrito/backstage-plugin-ai-assistant-backend",
+    "migrations"
+  );
+  await knex.migrate.latest({
+    directory: migrationsDir
+  });
+}
+
+exports.applyDatabaseMigrations = applyDatabaseMigrations;
+//# sourceMappingURL=migrations.cjs.js.map

package/dist/database/migrations.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"migrations.cjs.js","sources":["../../src/database/migrations.ts"],"sourcesContent":["import { resolvePackagePath } from '@backstage/backend-plugin-api';\nimport { Knex } from 'knex';\n\nexport async function applyDatabaseMigrations(knex: Knex): Promise<void> {\n  const migrationsDir = resolvePackagePath(\n    '@sweetoburrito/backstage-plugin-ai-assistant-backend',\n    'migrations',\n  );\n\n  await knex.migrate.latest({\n    directory: migrationsDir,\n  });\n}\n"],"names":["resolvePackagePath"],"mappings":";;;;AAGA,eAAsB,wBAAwB,IAAA,EAA2B;AACvE,EAAA,MAAM,aAAA,GAAgBA,mCAAA;AAAA,IACpB,sDAAA;AAAA,IACA;AAAA,GACF;AAEA,EAAA,MAAM,IAAA,CAAK,QAAQ,MAAA,CAAO;AAAA,IACxB,SAAA,EAAW;AAAA,GACZ,CAAA;AACH;;;;"}

package/dist/database/pg-vector-store.cjs.js

@@ -0,0 +1,193 @@
+'use strict';
+
+class PgVectorStore {
+  /**
+   * Creates an instance of PgVectorStore.
+   * @param client - The Knex client to interact with the PostgreSQL database.
+   * @param [amount=4] - The number of embeddings to store.
+   * @param [chunkSize=500] - The size of each chunk of embeddings.
+   */
+  constructor(client, logger, amount = 4, chunkSize = 500) {
+    this.client = client;
+    this.logger = logger;
+    this.amount = amount;
+    this.chunkSize = chunkSize;
+  }
+  tableName = "embeddings";
+  embeddings;
+  static async fromConfig({ config, database, logger }) {
+    const client = await database.getClient();
+    const chunkSize = config.getOptionalNumber(
+      "aiAssistant.storage.pgVector.chunkSize"
+    );
+    const amount = config.getOptionalNumber(
+      "aiAssistant.storage.pgVector.amount"
+    );
+    return new PgVectorStore(client, logger, amount, chunkSize);
+  }
+  connectEmbeddings(embeddings) {
+    if (this.embeddings) {
+      this.logger.warn("Embeddings already connected, overwriting.");
+    }
+    this.embeddings = embeddings;
+  }
+  table() {
+    return this.client(this.tableName);
+  }
+  /**
+   * Add documents to the vector store.
+   *
+   * @param {EmbeddingDocument[]} documents - The array of documents to be added.
+   * @throws {Error} When no embeddings are configured for the vector store.
+   * @returns {Promise<void>} Resolves when the documents have been added successfully.
+   */
+  async addDocuments(documents) {
+    if (documents.length === 0) {
+      return;
+    }
+    const texts = documents.map(({ content }) => content);
+    if (!this.embeddings) {
+      throw new Error("No Embeddings configured for the vector store.");
+    }
+    const vectors = await this.embeddings.embedDocuments(texts);
+    this.logger.info(
+      `Received ${vectors.length} vectors from embeddings creation.`
+    );
+    this.addVectors(vectors, documents);
+  }
+  /**
+   * Adds vectors to the database along with corresponding documents.
+   *
+   * @param {number[][]} vectors - The vectors to be added.
+   * @param {EmbeddingDoc[]} documents - The corresponding documents.
+   * @return {Promise<void>} - A promise that resolves when the vectors are added successfully.
+   * @throws {Error} - If there is an error inserting the vectors.
+   */
+  async addVectors(vectors, documents) {
+    try {
+      const rows = [];
+      for (let i = 0; i < vectors.length; i += 1) {
+        const embedding = vectors[i];
+        const embeddingString = `[${embedding.join(",")}]`;
+        const values = {
+          content: documents[i].content.replace(/\0/g, ""),
+          vector: embeddingString.replace(/\0/g, ""),
+          metadata: documents[i].metadata
+        };
+        rows.push(values);
+      }
+      await this.client.batchInsert(this.tableName, rows, this.chunkSize);
+    } catch (e) {
+      this.logger.error(e.message);
+      throw new Error(`Error inserting: ${e.message}`);
+    }
+  }
+  /**
+   * Deletes records from the database table by their ids.
+   *
+   * @param {string[]} ids - The array of ids of the records to be deleted.
+   * @returns {Promise<void>} - A promise that resolves when the deletion is complete.
+   */
+  async deleteById(ids) {
+    await this.table().delete().whereIn("id", ids);
+  }
+  /**
+   * Deletes rows from the table based on the specified filter.
+   *
+   * @param {EmbeddingDocMetadata} filter - The filter to apply for deletion.
+   * @returns {Promise} - A Promise that resolves when the deletion is complete.
+   */
+  async deleteByFilter(filter) {
+    const queryString = `
+      DELETE FROM ${this.tableName}
+      WHERE metadata::jsonb @> :filter
+    `;
+    return this.client.raw(queryString, { filter });
+  }
+  /**
+   * Deletes documents based on the provided deletion parameters.
+   * Either `ids` or `filter` must be specified.
+   *
+   * @param {Object} deletionParams - The deletion parameters.
+   * @param {Array<string>} [deletionParams.ids] - The document IDs to delete.
+   * @param {EmbeddingDocMetadata} [deletionParams.filter] - The filter to match documents to be deleted.
+   *
+   * @return {Promise<void>} - A Promise that resolves once the documents have been deleted.
+   */
+  async deleteDocuments(deletionParams) {
+    const { ids, filter } = deletionParams;
+    if (!(ids || filter)) {
+      throw new Error(
+        "You must specify either ids or a filter when deleting documents."
+      );
+    }
+    if (ids && filter) {
+      throw new Error(
+        "You cannot specify both ids and a filter when deleting documents."
+      );
+    }
+    if (ids) {
+      await this.deleteById(ids);
+    } else if (filter) {
+      await this.deleteByFilter(filter);
+    }
+  }
+  /**
+   * Finds the most similar documents to a given query vector, along with their similarity scores.
+   *
+   * @param {number[]} query - The query vector to compare against.
+   * @param {number} amount - The maximum number of results to return.
+   * @param {EmbeddingDocumentMetadata} [filter] - Optional filter to limit the search results.
+   * @returns {Promise<[EmbeddingDocument, number][]>} - An array of document similarity results, where each
+   * result is a tuple containing the document and its similarity score.
+   */
+  async similaritySearchVectorWithScore(query, amount, filter) {
+    const embeddingString = `[${query.join(",")}]`;
+    const queryString = `
+      SELECT *, vector <=> :embeddingString as "_distance"
+      FROM ${this.tableName}
+      WHERE metadata::jsonb @> :filter
+      ORDER BY "_distance" ASC
+      LIMIT :amount
+    `;
+    const documents = (await this.client.raw(queryString, {
+      embeddingString,
+      filter: JSON.stringify(filter ?? {}),
+      amount
+    })).rows;
+    const results = [];
+    for (const doc of documents) {
+      if (doc._distance !== null && doc.content !== null) {
+        const document = {
+          content: doc.content,
+          metadata: doc.metadata
+        };
+        results.push([document, doc._distance]);
+      }
+    }
+    return results;
+  }
+  /**
+   * Performs a similarity search using the given query and filter.
+   *
+   * @param {string} query - The query to perform the similarity search on.
+   * @param {EmbeddingDocMetadata} filter - The filter to apply to the search results.
+   * @param {number} [amount=4] - The number of results to return.
+   * @return {Promise<EmbeddingDoc[]>} - A promise that resolves to an array of RoadieEmbeddingDoc objects representing the search results.
+   * @throws {Error} - Throws an error if there are no embeddings configured for the vector store.
+   */
+  async similaritySearch(query, filter, amount = this.amount) {
+    if (!this.embeddings) {
+      throw new Error("No Embeddings configured for the vector store.");
+    }
+    const results = await this.similaritySearchVectorWithScore(
+      await this.embeddings.embedQuery(query),
+      amount,
+      filter
+    );
+    return results.map((result) => result[0]);
+  }
+}
+
+exports.PgVectorStore = PgVectorStore;
+//# sourceMappingURL=pg-vector-store.cjs.js.map

package/dist/database/pg-vector-store.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pg-vector-store.cjs.js","sources":["../../src/database/pg-vector-store.ts"],"sourcesContent":["import {\n  DatabaseService,\n  LoggerService,\n  RootConfigService,\n} from '@backstage/backend-plugin-api';\nimport {\n  VectorStore,\n  EmbeddingDocument,\n  EmbeddingDocumentMetadata,\n} from '@sweetoburrito/backstage-plugin-ai-assistant-node';\nimport { Embeddings } from '@langchain/core/embeddings';\nimport { Knex } from 'knex';\n\nexport type PgVectorStoreOptions = {\n  database: DatabaseService;\n  logger: LoggerService;\n  config: RootConfigService;\n};\n\nexport class PgVectorStore implements VectorStore {\n  private readonly tableName: string = 'embeddings';\n  private embeddings?: Omit<Embeddings, 'caller'>;\n\n  /**\n   * Creates an instance of PgVectorStore.\n   * @param client - The Knex client to interact with the PostgreSQL database.\n   * @param [amount=4] - The number of embeddings to store.\n   * @param [chunkSize=500] - The size of each chunk of embeddings.\n   */\n  constructor(\n    private readonly client: Knex,\n    private readonly logger: LoggerService,\n    private readonly amount: number = 4,\n    private readonly chunkSize: number = 500,\n  ) {}\n\n  static async fromConfig({ config, database, logger }: PgVectorStoreOptions) {\n    const client = await database.getClient();\n    const chunkSize = config.getOptionalNumber(\n      'aiAssistant.storage.pgVector.chunkSize',\n    );\n    const amount = config.getOptionalNumber(\n      'aiAssistant.storage.pgVector.amount',\n    );\n\n    return new PgVectorStore(client, logger, amount, chunkSize);\n  }\n\n  connectEmbeddings(embeddings: Omit<Embeddings, 'caller'>) {\n    if (this.embeddings) {\n      this.logger.warn('Embeddings already connected, overwriting.');\n    }\n    this.embeddings = embeddings;\n  }\n\n  table() {\n    return this.client(this.tableName);\n  }\n\n  /**\n   * Add documents to the vector store.\n   *\n   * @param {EmbeddingDocument[]} documents - The array of documents to be added.\n   * @throws {Error} When no embeddings are configured for the vector store.\n   * @returns {Promise<void>} Resolves when the documents have been added successfully.\n   */\n  async addDocuments(documents: EmbeddingDocument[]): Promise<void> {\n    if (documents.length === 0) {\n      return;\n    }\n    const texts = documents.map(({ content }) => content);\n    if (!this.embeddings) {\n      throw new Error('No Embeddings configured for the vector store.');\n    }\n\n    const vectors = await this.embeddings.embedDocuments(texts);\n    this.logger.info(\n      `Received ${vectors.length} vectors from embeddings creation.`,\n    );\n    this.addVectors(vectors, documents);\n  }\n\n  /**\n   * Adds vectors to the database along with corresponding documents.\n   *\n   * @param {number[][]} vectors - The vectors to be added.\n   * @param {EmbeddingDoc[]} documents - The corresponding documents.\n   * @return {Promise<void>} - A promise that resolves when the vectors are added successfully.\n   * @throws {Error} - If there is an error inserting the vectors.\n   */\n  private async addVectors(\n    vectors: number[][],\n    documents: EmbeddingDocument[],\n  ): Promise<void> {\n    try {\n      const rows = [];\n      for (let i = 0; i < vectors.length; i += 1) {\n        const embedding = vectors[i];\n        const embeddingString = `[${embedding.join(',')}]`;\n        const values = {\n          content: documents[i].content.replace(/\\0/g, ''),\n          vector: embeddingString.replace(/\\0/g, ''),\n          metadata: documents[i].metadata,\n        };\n        rows.push(values);\n      }\n\n      await this.client.batchInsert(this.tableName, rows, this.chunkSize);\n    } catch (e) {\n      this.logger.error((e as Error).message);\n      throw new Error(`Error inserting: ${(e as Error).message}`);\n    }\n  }\n\n  /**\n   * Deletes records from the database table by their ids.\n   *\n   * @param {string[]} ids - The array of ids of the records to be deleted.\n   * @returns {Promise<void>} - A promise that resolves when the deletion is complete.\n   */\n  private async deleteById(ids: string[]) {\n    await this.table().delete().whereIn('id', ids);\n  }\n\n  /**\n   * Deletes rows from the table based on the specified filter.\n   *\n   * @param {EmbeddingDocMetadata} filter - The filter to apply for deletion.\n   * @returns {Promise} - A Promise that resolves when the deletion is complete.\n   */\n  private async deleteByFilter(filter: EmbeddingDocumentMetadata) {\n    const queryString = `\n      DELETE FROM ${this.tableName}\n      WHERE metadata::jsonb @> :filter\n    `;\n    return this.client.raw(queryString, { filter });\n  }\n\n  /**\n   * Deletes documents based on the provided deletion parameters.\n   * Either `ids` or `filter` must be specified.\n   *\n   * @param {Object} deletionParams - The deletion parameters.\n   * @param {Array<string>} [deletionParams.ids] - The document IDs to delete.\n   * @param {EmbeddingDocMetadata} [deletionParams.filter] - The filter to match documents to be deleted.\n   *\n   * @return {Promise<void>} - A Promise that resolves once the documents have been deleted.\n   */\n  async deleteDocuments(deletionParams: {\n    ids?: string[];\n    filter?: EmbeddingDocumentMetadata;\n  }): Promise<void> {\n    const { ids, filter } = deletionParams;\n\n    if (!(ids || filter)) {\n      throw new Error(\n        'You must specify either ids or a filter when deleting documents.',\n      );\n    }\n\n    if (ids && filter) {\n      throw new Error(\n        'You cannot specify both ids and a filter when deleting documents.',\n      );\n    }\n\n    if (ids) {\n      await this.deleteById(ids);\n    } else if (filter) {\n      await this.deleteByFilter(filter);\n    }\n  }\n\n  /**\n   * Finds the most similar documents to a given query vector, along with their similarity scores.\n   *\n   * @param {number[]} query - The query vector to compare against.\n   * @param {number} amount - The maximum number of results to return.\n   * @param {EmbeddingDocumentMetadata} [filter] - Optional filter to limit the search results.\n   * @returns {Promise<[EmbeddingDocument, number][]>} - An array of document similarity results, where each\n   * result is a tuple containing the document and its similarity score.\n   */\n  private async similaritySearchVectorWithScore(\n    query: number[],\n    amount: number,\n    filter?: EmbeddingDocumentMetadata,\n  ): Promise<[EmbeddingDocument, number][]> {\n    const embeddingString = `[${query.join(',')}]`;\n    const queryString = `\n      SELECT *, vector <=> :embeddingString as \"_distance\"\n      FROM ${this.tableName}\n      WHERE metadata::jsonb @> :filter\n      ORDER BY \"_distance\" ASC\n      LIMIT :amount\n    `;\n\n    const documents = (\n      await this.client.raw(queryString, {\n        embeddingString,\n        filter: JSON.stringify(filter ?? {}),\n        amount,\n      })\n    ).rows;\n\n    const results = [] as [EmbeddingDocument, number][];\n    for (const doc of documents) {\n      // eslint-ignore-next-line\n      if (doc._distance !== null && doc.content !== null) {\n        const document = {\n          content: doc.content,\n          metadata: doc.metadata,\n        };\n        results.push([document, doc._distance]);\n      }\n    }\n    return results;\n  }\n\n  /**\n   * Performs a similarity search using the given query and filter.\n   *\n   * @param {string} query - The query to perform the similarity search on.\n   * @param {EmbeddingDocMetadata} filter - The filter to apply to the search results.\n   * @param {number} [amount=4] - The number of results to return.\n   * @return {Promise<EmbeddingDoc[]>} - A promise that resolves to an array of RoadieEmbeddingDoc objects representing the search results.\n   * @throws {Error} - Throws an error if there are no embeddings configured for the vector store.\n   */\n  async similaritySearch(\n    query: string,\n    filter?: EmbeddingDocumentMetadata,\n    amount: number = this.amount,\n  ): Promise<EmbeddingDocument[]> {\n    if (!this.embeddings) {\n      throw new Error('No Embeddings configured for the vector store.');\n    }\n    const results = await this.similaritySearchVectorWithScore(\n      await this.embeddings.embedQuery(query),\n      amount,\n      filter,\n    );\n\n    return results.map(result => result[0]);\n  }\n}\n"],"names":[],"mappings":";;AAmBO,MAAM,aAAA,CAAqC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUhD,YACmB,MAAA,EACA,MAAA,EACA,MAAA,GAAiB,CAAA,EACjB,YAAoB,GAAA,EACrC;AAJiB,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA;AACA,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA;AACA,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA;AACA,IAAA,IAAA,CAAA,SAAA,GAAA,SAAA;AAAA,EAChB;AAAA,EAdc,SAAA,GAAoB,YAAA;AAAA,EAC7B,UAAA;AAAA,EAeR,aAAa,UAAA,CAAW,EAAE,MAAA,EAAQ,QAAA,EAAU,QAAO,EAAyB;AAC1E,IAAA,MAAM,MAAA,GAAS,MAAM,QAAA,CAAS,SAAA,EAAU;AACxC,IAAA,MAAM,YAAY,MAAA,CAAO,iBAAA;AAAA,MACvB;AAAA,KACF;AACA,IAAA,MAAM,SAAS,MAAA,CAAO,iBAAA;AAAA,MACpB;AAAA,KACF;AAEA,IAAA,OAAO,IAAI,aAAA,CAAc,MAAA,EAAQ,MAAA,EAAQ,QAAQ,SAAS,CAAA;AAAA,EAC5D;AAAA,EAEA,kBAAkB,UAAA,EAAwC;AACxD,IAAA,IAAI,KAAK,UAAA,EAAY;AACnB,MAAA,IAAA,CAAK,MAAA,CAAO,KAAK,4CAA4C,CAAA;AAAA,IAC/D;AACA,IAAA,IAAA,CAAK,UAAA,GAAa,UAAA;AAAA,EACpB;AAAA,EAEA,KAAA,GAAQ;AACN,IAAA,OAAO,IAAA,CAAK,MAAA,CAAO,IAAA,CAAK,SAAS,CAAA;AAAA,EACnC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAM,aAAa,SAAA,EAA+C;AAChE,IAAA,IAAI,SAAA,CAAU,WAAW,CAAA,EAAG;AAC1B,MAAA;AAAA,IACF;AACA,IAAA,MAAM,QAAQ,SAAA,CAAU,GAAA,CAAI,CAAC,EAAE,OAAA,OAAc,OAAO,CAAA;AACpD,IAAA,IAAI,CAAC,KAAK,UAAA,EAAY;AACpB,MAAA,MAAM,IAAI,MAAM,gDAAgD,CAAA;AAAA,IAClE;AAEA,IAAA,MAAM,OAAA,GAAU,MAAM,IAAA,CAAK,UAAA,CAAW,eAAe,KAAK,CAAA;AAC1D,IAAA,IAAA,CAAK,MAAA,CAAO,IAAA;AAAA,MACV,CAAA,SAAA,EAAY,QAAQ,MAAM,CAAA,kCAAA;AAAA,KAC5B;AACA,IAAA,IAAA,CAAK,UAAA,CAAW,SAAS,SAAS,CAAA;AAAA,EACpC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,MAAc,UAAA,CACZ,OAAA,EACA,SAAA,EACe;AACf,IAAA,IAAI;AACF,MAAA,MAAM,OAAO,EAAC;AACd,MAAA,KAAA,IAAS,IAAI,CAAA,EAAG,CAAA,GAAI,OAAA,CAAQ,MAAA,EAAQ,KAAK,CAAA,EAAG;AAC1C,QAAA,MAAM,SAAA,GAAY,QAAQ,CAAC,CAAA;AAC3B,QAAA,MAAM,eAAA,GAAkB,CAAA,CAAA,EAAI,SAAA,CAAU,IAAA,CAAK,GAAG,CAAC,CAAA,CAAA,CAAA;AAC/C,QAAA,MAAM,MAAA,GAAS;AAAA,UACb,SAAS,SAAA,CAAU,CAAC,EAAE,OAAA,CAAQ,OAAA,CAAQ,OAAO,EAAE,CAAA;AAAA,UAC/C,MAAA,EAAQ,eAAA,CAAgB,OAAA,CAAQ,KAAA,EAAO,EAAE,CAAA;AAAA,UACzC,QAAA,EAAU,SAAA,CAAU,CAAC,CAAA,CAAE;AAAA,SACzB;AACA,QAAA,IAAA,CAAK,KAAK,MAAM,CAAA;AAAA,MAClB;AAEA,MAAA,MAAM,KAAK,MAAA,CAAO,WAAA,CAAY,KAAK,SAAA,EAAW,IAAA,EAAM,KAAK,SAAS,CAAA;AAAA,IACpE,SAAS,CAAA,EAAG;AACV,MAAA,IAAA,CAAK,MAAA,CAAO,KAAA,CAAO,CAAA,CAAY,OAAO,CAAA;AACtC,MAAA,MAAM,IAAI,KAAA,CAAM,CAAA,iBAAA,EAAqB,CAAA,CAAY,OAAO,CAAA,CAAE,CAAA;AAAA,IAC5D;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAc,WAAW,GAAA,EAAe;AACtC,IAAA,MAAM,KAAK,KAAA,EAAM,CAAE,QAAO,CAAE,OAAA,CAAQ,MAAM,GAAG,CAAA;AAAA,EAC/C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAc,eAAe,MAAA,EAAmC;AAC9D,IAAA,MAAM,WAAA,GAAc;AAAA,kBAAA,EACJ,KAAK,SAAS;AAAA;AAAA,IAAA,CAAA;AAG9B,IAAA,OAAO,KAAK,MAAA,CAAO,GAAA,CAAI,WAAA,EAAa,EAAE,QAAQ,CAAA;AAAA,EAChD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYA,MAAM,gBAAgB,cAAA,EAGJ;AAChB,IAAA,MAAM,EAAE,GAAA,EAAK,MAAA,EAAO,GAAI,cAAA;AAExB,IAAA,IAAI,EAAE,OAAO,MAAA,CAAA,EAAS;AACpB,MAAA,MAAM,IAAI,KAAA;AAAA,QACR;AAAA,OACF;AAAA,IACF;AAEA,IAAA,IAAI,OAAO,MAAA,EAAQ;AACjB,MAAA,MAAM,IAAI,KAAA;AAAA,QACR;AAAA,OACF;AAAA,IACF;AAEA,IAAA,IAAI,GAAA,EAAK;AACP,MAAA,MAAM,IAAA,CAAK,WAAW,GAAG,CAAA;AAAA,IAC3B,WAAW,MAAA,EAAQ;AACjB,MAAA,MAAM,IAAA,CAAK,eAAe,MAAM,CAAA;AAAA,IAClC;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA,MAAc,+BAAA,CACZ,KAAA,EACA,MAAA,EACA,MAAA,EACwC;AACxC,IAAA,MAAM,eAAA,GAAkB,CAAA,CAAA,EAAI,KAAA,CAAM,IAAA,CAAK,GAAG,CAAC,CAAA,CAAA,CAAA;AAC3C,IAAA,MAAM,WAAA,GAAc;AAAA;AAAA,WAAA,EAEX,KAAK,SAAS;AAAA;AAAA;AAAA;AAAA,IAAA,CAAA;AAMvB,IAAA,MAAM,SAAA,GAAA,CACJ,MAAM,IAAA,CAAK,MAAA,CAAO,IAAI,WAAA,EAAa;AAAA,MACjC,eAAA;AAAA,MACA,MAAA,EAAQ,IAAA,CAAK,SAAA,CAAU,MAAA,IAAU,EAAE,CAAA;AAAA,MACnC;AAAA,KACD,CAAA,EACD,IAAA;AAEF,IAAA,MAAM,UAAU,EAAC;AACjB,IAAA,KAAA,MAAW,OAAO,SAAA,EAAW;AAE3B,MAAA,IAAI,GAAA,CAAI,SAAA,KAAc,IAAA,IAAQ,GAAA,CAAI,YAAY,IAAA,EAAM;AAClD,QAAA,MAAM,QAAA,GAAW;AAAA,UACf,SAAS,GAAA,CAAI,OAAA;AAAA,UACb,UAAU,GAAA,CAAI;AAAA,SAChB;AACA,QAAA,OAAA,CAAQ,IAAA,CAAK,CAAC,QAAA,EAAU,GAAA,CAAI,SAAS,CAAC,CAAA;AAAA,MACxC;AAAA,IACF;AACA,IAAA,OAAO,OAAA;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA,MAAM,gBAAA,CACJ,KAAA,EACA,MAAA,EACA,MAAA,GAAiB,KAAK,MAAA,EACQ;AAC9B,IAAA,IAAI,CAAC,KAAK,UAAA,EAAY;AACpB,MAAA,MAAM,IAAI,MAAM,gDAAgD,CAAA;AAAA,IAClE;AACA,IAAA,MAAM,OAAA,GAAU,MAAM,IAAA,CAAK,+BAAA;AAAA,MACzB,MAAM,IAAA,CAAK,UAAA,CAAW,UAAA,CAAW,KAAK,CAAA;AAAA,MACtC,MAAA;AAAA,MACA;AAAA,KACF;AAEA,IAAA,OAAO,OAAA,CAAQ,GAAA,CAAI,CAAA,MAAA,KAAU,MAAA,CAAO,CAAC,CAAC,CAAA;AAAA,EACxC;AACF;;;;"}

package/dist/index.cjs.js

@@ -0,0 +1,10 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var plugin = require('./plugin.cjs.js');
+
+
+
+exports.default = plugin.aiAssistantPlugin;
+//# 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,10 @@
+import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
+
+/**
+ * aiAssistantPlugin backend plugin
+ *
+ * @public
+ */
+declare const aiAssistantPlugin: _backstage_backend_plugin_api.BackendFeature;
+
+export { aiAssistantPlugin as default };

package/dist/plugin.cjs.js

@@ -0,0 +1,101 @@
+'use strict';
+
+var backendPluginApi = require('@backstage/backend-plugin-api');
+var index = require('./services/router/index.cjs.js');
+var backstagePluginAiAssistantNode = require('@sweetoburrito/backstage-plugin-ai-assistant-node');
+var ingestor = require('./services/ingestor.cjs.js');
+var chat = require('./services/chat.cjs.js');
+var migrations = require('./database/migrations.cjs.js');
+var pgVectorStore = require('./database/pg-vector-store.cjs.js');
+var pluginSignalsNode = require('@backstage/plugin-signals-node');
+var searchKnowledge = require('./services/tools/searchKnowledge.cjs.js');
+var pluginCatalogNode = require('@backstage/plugin-catalog-node');
+var langfuse = require('./services/langfuse.cjs.js');
+
+const aiAssistantPlugin = backendPluginApi.createBackendPlugin({
+  pluginId: "ai-assistant",
+  register(env) {
+    const ingestors = [];
+    const models = [];
+    const tools = [];
+    let embeddingsProvider;
+    env.registerExtensionPoint(backstagePluginAiAssistantNode.dataIngestorExtensionPoint, {
+      registerIngestor: (ingestor) => {
+        const existingIngestor = ingestors.find((i) => i.id === ingestor.id);
+        if (existingIngestor) {
+          throw new Error(
+            `Ingestor with id ${ingestor.id} is already registered.`
+          );
+        }
+        ingestors.push(ingestor);
+      }
+    });
+    env.registerExtensionPoint(backstagePluginAiAssistantNode.embeddingsProviderExtensionPoint, {
+      register: (provider) => {
+        embeddingsProvider = provider;
+      }
+    });
+    env.registerExtensionPoint(backstagePluginAiAssistantNode.modelProviderExtensionPoint, {
+      register: (model) => {
+        const existingModel = models.find((m) => m.id === model.id);
+        if (existingModel) {
+          throw new Error(`Model with id ${model.id} is already registered.`);
+        }
+        models.push(model);
+      }
+    });
+    env.registerExtensionPoint(backstagePluginAiAssistantNode.toolExtensionPoint, {
+      register: (tool) => {
+        const existingTool = tools.find((t) => t.name === tool.name);
+        if (existingTool) {
+          throw new Error(`Tool with name ${tool.name} is already registered.`);
+        }
+        tools.push(tool);
+      }
+    });
+    env.registerInit({
+      deps: {
+        httpRouter: backendPluginApi.coreServices.httpRouter,
+        database: backendPluginApi.coreServices.database,
+        logger: backendPluginApi.coreServices.logger,
+        config: backendPluginApi.coreServices.rootConfig,
+        scheduler: backendPluginApi.coreServices.scheduler,
+        httpAuth: backendPluginApi.coreServices.httpAuth,
+        userInfo: backendPluginApi.coreServices.userInfo,
+        signals: pluginSignalsNode.signalsServiceRef,
+        catalog: pluginCatalogNode.catalogServiceRef,
+        cache: backendPluginApi.coreServices.cache,
+        auth: backendPluginApi.coreServices.auth
+      },
+      async init(options) {
+        const { httpRouter, database, config, logger } = options;
+        const langfuseEnabled = langfuse.initLangfuse(config, logger);
+        const client = await database.getClient();
+        await migrations.applyDatabaseMigrations(client);
+        const vectorStore = await pgVectorStore.PgVectorStore.fromConfig(options);
+        if (!embeddingsProvider) {
+          throw new Error("No Embeddings Provider was registered.");
+        }
+        vectorStore.connectEmbeddings(await embeddingsProvider.getEmbeddings());
+        const dataIngestionPipeline = ingestor.createDataIngestionPipeline({
+          ...options,
+          vectorStore,
+          ingestors
+        });
+        const searchKnowledgeTool = searchKnowledge.createSearchKnowledgeTool({ vectorStore });
+        tools.push(searchKnowledgeTool);
+        const chat$1 = await chat.createChatService({
+          ...options,
+          models,
+          tools,
+          langfuseEnabled
+        });
+        httpRouter.use(await index.createRouter({ ...options, chat: chat$1 }));
+        dataIngestionPipeline.start();
+      }
+    });
+  }
+});
+
+exports.aiAssistantPlugin = aiAssistantPlugin;
+//# sourceMappingURL=plugin.cjs.js.map

package/dist/plugin.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.cjs.js","sources":["../src/plugin.ts"],"sourcesContent":["import {\n  coreServices,\n  createBackendPlugin,\n} from '@backstage/backend-plugin-api';\nimport { createRouter } from './services/router';\nimport {\n  dataIngestorExtensionPoint,\n  EmbeddingsProvider,\n  embeddingsProviderExtensionPoint,\n  Ingestor,\n  Model,\n  modelProviderExtensionPoint,\n  Tool,\n  toolExtensionPoint,\n} from '@sweetoburrito/backstage-plugin-ai-assistant-node';\nimport { createDataIngestionPipeline } from './services/ingestor';\nimport { createChatService } from './services/chat';\nimport { applyDatabaseMigrations } from './database/migrations';\nimport { PgVectorStore } from './database';\nimport { signalsServiceRef } from '@backstage/plugin-signals-node';\nimport { createSearchKnowledgeTool } from './services/tools/searchKnowledge';\nimport { catalogServiceRef } from '@backstage/plugin-catalog-node';\nimport { initLangfuse } from './services/langfuse';\n/**\n * aiAssistantPlugin backend plugin\n *\n * @public\n */\n\nexport const aiAssistantPlugin = createBackendPlugin({\n  pluginId: 'ai-assistant',\n  register(env) {\n    const ingestors: Ingestor[] = [];\n    const models: Model[] = [];\n    const tools: Tool[] = [];\n\n    let embeddingsProvider: EmbeddingsProvider;\n\n    env.registerExtensionPoint(dataIngestorExtensionPoint, {\n      registerIngestor: ingestor => {\n        const existingIngestor = ingestors.find(i => i.id === ingestor.id);\n        if (existingIngestor) {\n          throw new Error(\n            `Ingestor with id ${ingestor.id} is already registered.`,\n          );\n        }\n        ingestors.push(ingestor);\n      },\n    });\n\n    env.registerExtensionPoint(embeddingsProviderExtensionPoint, {\n      register: provider => {\n        embeddingsProvider = provider;\n      },\n    });\n\n    env.registerExtensionPoint(modelProviderExtensionPoint, {\n      register: model => {\n        const existingModel = models.find(m => m.id === model.id);\n        if (existingModel) {\n          throw new Error(`Model with id ${model.id} is already registered.`);\n        }\n        models.push(model);\n      },\n    });\n\n    env.registerExtensionPoint(toolExtensionPoint, {\n      register: tool => {\n        const existingTool = tools.find(t => t.name === tool.name);\n        if (existingTool) {\n          throw new Error(`Tool with name ${tool.name} is already registered.`);\n        }\n        tools.push(tool);\n      },\n    });\n\n    env.registerInit({\n      deps: {\n        httpRouter: coreServices.httpRouter,\n        database: coreServices.database,\n        logger: coreServices.logger,\n        config: coreServices.rootConfig,\n        scheduler: coreServices.scheduler,\n        httpAuth: coreServices.httpAuth,\n        userInfo: coreServices.userInfo,\n        signals: signalsServiceRef,\n        catalog: catalogServiceRef,\n        cache: coreServices.cache,\n        auth: coreServices.auth,\n      },\n\n      async init(options) {\n        const { httpRouter, database, config, logger } = options;\n\n        const langfuseEnabled = initLangfuse(config, logger);\n\n        const client = await database.getClient();\n\n        await applyDatabaseMigrations(client);\n\n        const vectorStore = await PgVectorStore.fromConfig(options);\n\n        if (!embeddingsProvider) {\n          throw new Error('No Embeddings Provider was registered.');\n        }\n\n        vectorStore.connectEmbeddings(await embeddingsProvider.getEmbeddings());\n\n        const dataIngestionPipeline = createDataIngestionPipeline({\n          ...options,\n          vectorStore,\n          ingestors,\n        });\n\n        const searchKnowledgeTool = createSearchKnowledgeTool({ vectorStore });\n        tools.push(searchKnowledgeTool);\n\n        const chat = await createChatService({\n          ...options,\n          models,\n          tools,\n          langfuseEnabled,\n        });\n\n        httpRouter.use(await createRouter({ ...options, chat }));\n        dataIngestionPipeline.start();\n      },\n    });\n  },\n});\n"],"names":["createBackendPlugin","dataIngestorExtensionPoint","embeddingsProviderExtensionPoint","modelProviderExtensionPoint","toolExtensionPoint","coreServices","signalsServiceRef","catalogServiceRef","initLangfuse","applyDatabaseMigrations","PgVectorStore","createDataIngestionPipeline","createSearchKnowledgeTool","chat","createChatService","createRouter"],"mappings":";;;;;;;;;;;;;;AA6BO,MAAM,oBAAoBA,oCAAA,CAAoB;AAAA,EACnD,QAAA,EAAU,cAAA;AAAA,EACV,SAAS,GAAA,EAAK;AACZ,IAAA,MAAM,YAAwB,EAAC;AAC/B,IAAA,MAAM,SAAkB,EAAC;AACzB,IAAA,MAAM,QAAgB,EAAC;AAEvB,IAAA,IAAI,kBAAA;AAEJ,IAAA,GAAA,CAAI,uBAAuBC,yDAAA,EAA4B;AAAA,MACrD,kBAAkB,CAAA,QAAA,KAAY;AAC5B,QAAA,MAAM,mBAAmB,SAAA,CAAU,IAAA,CAAK,OAAK,CAAA,CAAE,EAAA,KAAO,SAAS,EAAE,CAAA;AACjE,QAAA,IAAI,gBAAA,EAAkB;AACpB,UAAA,MAAM,IAAI,KAAA;AAAA,YACR,CAAA,iBAAA,EAAoB,SAAS,EAAE,CAAA,uBAAA;AAAA,WACjC;AAAA,QACF;AACA,QAAA,SAAA,CAAU,KAAK,QAAQ,CAAA;AAAA,MACzB;AAAA,KACD,CAAA;AAED,IAAA,GAAA,CAAI,uBAAuBC,+DAAA,EAAkC;AAAA,MAC3D,UAAU,CAAA,QAAA,KAAY;AACpB,QAAA,kBAAA,GAAqB,QAAA;AAAA,MACvB;AAAA,KACD,CAAA;AAED,IAAA,GAAA,CAAI,uBAAuBC,0DAAA,EAA6B;AAAA,MACtD,UAAU,CAAA,KAAA,KAAS;AACjB,QAAA,MAAM,gBAAgB,MAAA,CAAO,IAAA,CAAK,OAAK,CAAA,CAAE,EAAA,KAAO,MAAM,EAAE,CAAA;AACxD,QAAA,IAAI,aAAA,EAAe;AACjB,UAAA,MAAM,IAAI,KAAA,CAAM,CAAA,cAAA,EAAiB,KAAA,CAAM,EAAE,CAAA,uBAAA,CAAyB,CAAA;AAAA,QACpE;AACA,QAAA,MAAA,CAAO,KAAK,KAAK,CAAA;AAAA,MACnB;AAAA,KACD,CAAA;AAED,IAAA,GAAA,CAAI,uBAAuBC,iDAAA,EAAoB;AAAA,MAC7C,UAAU,CAAA,IAAA,KAAQ;AAChB,QAAA,MAAM,eAAe,KAAA,CAAM,IAAA,CAAK,OAAK,CAAA,CAAE,IAAA,KAAS,KAAK,IAAI,CAAA;AACzD,QAAA,IAAI,YAAA,EAAc;AAChB,UAAA,MAAM,IAAI,KAAA,CAAM,CAAA,eAAA,EAAkB,IAAA,CAAK,IAAI,CAAA,uBAAA,CAAyB,CAAA;AAAA,QACtE;AACA,QAAA,KAAA,CAAM,KAAK,IAAI,CAAA;AAAA,MACjB;AAAA,KACD,CAAA;AAED,IAAA,GAAA,CAAI,YAAA,CAAa;AAAA,MACf,IAAA,EAAM;AAAA,QACJ,YAAYC,6BAAA,CAAa,UAAA;AAAA,QACzB,UAAUA,6BAAA,CAAa,QAAA;AAAA,QACvB,QAAQA,6BAAA,CAAa,MAAA;AAAA,QACrB,QAAQA,6BAAA,CAAa,UAAA;AAAA,QACrB,WAAWA,6BAAA,CAAa,SAAA;AAAA,QACxB,UAAUA,6BAAA,CAAa,QAAA;AAAA,QACvB,UAAUA,6BAAA,CAAa,QAAA;AAAA,QACvB,OAAA,EAASC,mCAAA;AAAA,QACT,OAAA,EAASC,mCAAA;AAAA,QACT,OAAOF,6BAAA,CAAa,KAAA;AAAA,QACpB,MAAMA,6BAAA,CAAa;AAAA,OACrB;AAAA,MAEA,MAAM,KAAK,OAAA,EAAS;AAClB,QAAA,MAAM,EAAE,UAAA,EAAY,QAAA,EAAU,MAAA,EAAQ,QAAO,GAAI,OAAA;AAEjD,QAAA,MAAM,eAAA,GAAkBG,qBAAA,CAAa,MAAA,EAAQ,MAAM,CAAA;AAEnD,QAAA,MAAM,MAAA,GAAS,MAAM,QAAA,CAAS,SAAA,EAAU;AAExC,QAAA,MAAMC,mCAAwB,MAAM,CAAA;AAEpC,QAAA,MAAM,WAAA,GAAc,MAAMC,2BAAA,CAAc,UAAA,CAAW,OAAO,CAAA;AAE1D,QAAA,IAAI,CAAC,kBAAA,EAAoB;AACvB,UAAA,MAAM,IAAI,MAAM,wCAAwC,CAAA;AAAA,QAC1D;AAEA,QAAA,WAAA,CAAY,iBAAA,CAAkB,MAAM,kBAAA,CAAmB,aAAA,EAAe,CAAA;AAEtE,QAAA,MAAM,wBAAwBC,oCAAA,CAA4B;AAAA,UACxD,GAAG,OAAA;AAAA,UACH,WAAA;AAAA,UACA;AAAA,SACD,CAAA;AAED,QAAA,MAAM,mBAAA,GAAsBC,yCAAA,CAA0B,EAAE,WAAA,EAAa,CAAA;AACrE,QAAA,KAAA,CAAM,KAAK,mBAAmB,CAAA;AAE9B,QAAA,MAAMC,MAAA,GAAO,MAAMC,sBAAA,CAAkB;AAAA,UACnC,GAAG,OAAA;AAAA,UACH,MAAA;AAAA,UACA,KAAA;AAAA,UACA;AAAA,SACD,CAAA;AAED,QAAA,UAAA,CAAW,GAAA,CAAI,MAAMC,kBAAA,CAAa,EAAE,GAAG,OAAA,QAASF,MAAA,EAAM,CAAC,CAAA;AACvD,QAAA,qBAAA,CAAsB,KAAA,EAAM;AAAA,MAC9B;AAAA,KACD,CAAA;AAAA,EACH;AACF,CAAC;;;;"}