@convex-dev/rag 0.1.7

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1.  Definitions.
+
+    "License" shall mean the terms and conditions for use, reproduction,
+    and distribution as defined by Sections 1 through 9 of this document.
+
+    "Licensor" shall mean the copyright owner or entity authorized by
+    the copyright owner that is granting the License.
+
+    "Legal Entity" shall mean the union of the acting entity and all
+    other entities that control, are controlled by, or are under common
+    control with that entity. For the purposes of this definition,
+    "control" means (i) the power, direct or indirect, to cause the
+    direction or management of such entity, whether by contract or
+    otherwise, or (ii) ownership of fifty percent (50%) or more of the
+    outstanding shares, or (iii) beneficial ownership of such entity.
+
+    "You" (or "Your") shall mean an individual or Legal Entity
+    exercising permissions granted by this License.
+
+    "Source" form shall mean the preferred form for making modifications,
+    including but not limited to software source code, documentation
+    source, and configuration files.
+
+    "Object" form shall mean any form resulting from mechanical
+    transformation or translation of a Source form, including but
+    not limited to compiled object code, generated documentation,
+    and conversions to other media types.
+
+    "Work" shall mean the work of authorship, whether in Source or
+    Object form, made available under the License, as indicated by a
+    copyright notice that is included in or attached to the work
+    (an example is provided in the Appendix below).
+
+    "Derivative Works" shall mean any work, whether in Source or Object
+    form, that is based on (or derived from) the Work and for which the
+    editorial revisions, annotations, elaborations, or other modifications
+    represent, as a whole, an original work of authorship. For the purposes
+    of this License, Derivative Works shall not include works that remain
+    separable from, or merely link (or bind by name) to the interfaces of,
+    the Work and Derivative Works thereof.
+
+    "Contribution" shall mean any work of authorship, including
+    the original version of the Work and any modifications or additions
+    to that Work or Derivative Works thereof, that is intentionally
+    submitted to Licensor for inclusion in the Work by the copyright owner
+    or by an individual or Legal Entity authorized to submit on behalf of
+    the copyright owner. For the purposes of this definition, "submitted"
+    means any form of electronic, verbal, or written communication sent
+    to the Licensor or its representatives, including but not limited to
+    communication on electronic mailing lists, source code control systems,
+    and issue tracking systems that are managed by, or on behalf of, the
+    Licensor for the purpose of discussing and improving the Work, but
+    excluding communication that is conspicuously marked or otherwise
+    designated in writing by the copyright owner as "Not a Contribution."
+
+    "Contributor" shall mean Licensor and any individual or Legal Entity
+    on behalf of whom a Contribution has been received by Licensor and
+    subsequently incorporated within the Work.
+
+2.  Grant of Copyright License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    copyright license to reproduce, prepare Derivative Works of,
+    publicly display, publicly perform, sublicense, and distribute the
+    Work and such Derivative Works in Source or Object form.
+
+3.  Grant of Patent License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    (except as stated in this section) patent license to make, have made,
+    use, offer to sell, sell, import, and otherwise transfer the Work,
+    where such license applies only to those patent claims licensable
+    by such Contributor that are necessarily infringed by their
+    Contribution(s) alone or by combination of their Contribution(s)
+    with the Work to which such Contribution(s) was submitted. If You
+    institute patent litigation against any entity (including a
+    cross-claim or counterclaim in a lawsuit) alleging that the Work
+    or a Contribution incorporated within the Work constitutes direct
+    or contributory patent infringement, then any patent licenses
+    granted to You under this License for that Work shall terminate
+    as of the date such litigation is filed.
+
+4.  Redistribution. You may reproduce and distribute copies of the
+    Work or Derivative Works thereof in any medium, with or without
+    modifications, and in Source or Object form, provided that You
+    meet the following conditions:
+
+    (a) You must give any other recipients of the Work or
+    Derivative Works a copy of this License; and
+
+    (b) You must cause any modified files to carry prominent notices
+    stating that You changed the files; and
+
+    (c) You must retain, in the Source form of any Derivative Works
+    that You distribute, all copyright, patent, trademark, and
+    attribution notices from the Source form of the Work,
+    excluding those notices that do not pertain to any part of
+    the Derivative Works; and
+
+    (d) If the Work includes a "NOTICE" text file as part of its
+    distribution, then any Derivative Works that You distribute must
+    include a readable copy of the attribution notices contained
+    within such NOTICE file, excluding those notices that do not
+    pertain to any part of the Derivative Works, in at least one
+    of the following places: within a NOTICE text file distributed
+    as part of the Derivative Works; within the Source form or
+    documentation, if provided along with the Derivative Works; or,
+    within a display generated by the Derivative Works, if and
+    wherever such third-party notices normally appear. The contents
+    of the NOTICE file are for informational purposes only and
+    do not modify the License. You may add Your own attribution
+    notices within Derivative Works that You distribute, alongside
+    or as an addendum to the NOTICE text from the Work, provided
+    that such additional attribution notices cannot be construed
+    as modifying the License.
+
+    You may add Your own copyright statement to Your modifications and
+    may provide additional or different license terms and conditions
+    for use, reproduction, or distribution of Your modifications, or
+    for any such Derivative Works as a whole, provided Your use,
+    reproduction, and distribution of the Work otherwise complies with
+    the conditions stated in this License.
+
+5.  Submission of Contributions. Unless You explicitly state otherwise,
+    any Contribution intentionally submitted for inclusion in the Work
+    by You to the Licensor shall be under the terms and conditions of
+    this License, without any additional terms or conditions.
+    Notwithstanding the above, nothing herein shall supersede or modify
+    the terms of any separate license agreement you may have executed
+    with Licensor regarding such Contributions.
+
+6.  Trademarks. This License does not grant permission to use the trade
+    names, trademarks, service marks, or product names of the Licensor,
+    except as required for reasonable and customary use in describing the
+    origin of the Work and reproducing the content of the NOTICE file.
+
+7.  Disclaimer of Warranty. Unless required by applicable law or
+    agreed to in writing, Licensor provides the Work (and each
+    Contributor provides its Contributions) on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+    implied, including, without limitation, any warranties or conditions
+    of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+    PARTICULAR PURPOSE. You are solely responsible for determining the
+    appropriateness of using or redistributing the Work and assume any
+    risks associated with Your exercise of permissions under this License.
+
+8.  Limitation of Liability. In no event and under no legal theory,
+    whether in tort (including negligence), contract, or otherwise,
+    unless required by applicable law (such as deliberate and grossly
+    negligent acts) or agreed to in writing, shall any Contributor be
+    liable to You for damages, including any direct, indirect, special,
+    incidental, or consequential damages of any character arising as a
+    result of this License or out of the use or inability to use the
+    Work (including but not limited to damages for loss of goodwill,
+    work stoppage, computer failure or malfunction, or any and all
+    other commercial damages or losses), even if such Contributor
+    has been advised of the possibility of such damages.
+
+9.  Accepting Warranty or Additional Liability. While redistributing
+    the Work or Derivative Works thereof, You may choose to offer,
+    and charge a fee for, acceptance of support, warranty, indemnity,
+    or other liability obligations and/or rights consistent with this
+    License. However, in accepting such obligations, You may act only
+    on Your own behalf and on Your sole responsibility, not on behalf
+    of any other Contributor, and only if You agree to indemnify,
+    defend, and hold each Contributor harmless for any liability
+    incurred by, or claims asserted against, such Contributor by reason
+    of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -0,0 +1,371 @@
+# Convex Agent RAG Component
+
+[![npm version](https://badge.fury.io/js/@convex-dev%2Fmemory.svg)](https://badge.fury.io/js/@convex-dev%2Fmemory)
+
+<!-- START: Include on https://convex.dev/components -->
+
+A component for semantic search, usually used to look up context for LLMs.
+Use with an Agent for Retrieval-Augmented Generation (RAG).
+
+## ✨ Key Features
+
+- **Add Content**: Add or replace content with text chunks and embeddings.
+- **Semantic Search**: Vector-based search using configurable embedding models
+- **Namespaces**: Organize content into namespaces for per-user search.
+- **Custom Filtering**: Filter content with custom indexed fields.
+- **Importance Weighting**: Weight content by providing a 0 to 1 "importance".
+- **Chunk Context**: Get surrounding chunks for better context.
+- **Graceful Migrations**: Migrate content or whole namespaces without disruption.
+
+Found a bug? Feature request? [File it here](https://github.com/get-convex/rag/issues).
+
+## Pre-requisite: Convex
+
+You'll need an existing Convex project to use the component.
+Convex is a hosted backend platform, including a database, serverless functions,
+and a ton more you can learn about [here](https://docs.convex.dev/get-started).
+
+Run `npm create convex` or follow any of the [quickstarts](https://docs.convex.dev/home) to set one up.
+
+## Installation
+
+Install the component package:
+
+```ts
+npm install @convex-dev/rag
+```
+
+Create a `convex.config.ts` file in your app's `convex/` folder and install the component by calling `use`:
+
+```ts
+// convex/convex.config.ts
+import { defineApp } from "convex/server";
+import rag from "@convex-dev/rag/convex.config";
+
+const app = defineApp();
+app.use(rag);
+
+export default app;
+```
+
+## Basic Setup
+
+```ts
+// convex/example.ts
+import { components } from "./_generated/api";
+import { RAG } from "@convex-dev/rag";
+// Any AI SDK model that supports embeddings will work.
+import { openai } from "@ai-sdk/openai";
+
+const rag = new RAG<FilterTypes>(components.rag, {
+  filterNames: ["category", "contentType", "categoryAndType"],
+  textEmbeddingModel: openai.embedding("text-embedding-3-small"),
+  embeddingDimension: 1536,
+});
+
+// Optional: Add type safety to your filters.
+type FilterTypes = {
+  category: string;
+  contentType: string;
+  categoryAndType: { category: string; contentType: string };
+};
+```
+
+## Usage Examples
+
+### Add RAG Entries
+
+Add content with text chunks.
+It will embed the chunks automatically if you don't provide them.
+
+```ts
+export const add = action({
+  args: { text: v.string() },
+  handler: async (ctx, { text }) => {
+    // Add the text to a namespace shared by all users.
+    await rag.add(ctx, {
+      namespace: "all-users",
+      chunks: text.split("\n\n"),
+    });
+  },
+});
+```
+
+### Add Entries with filters from a URL
+
+Here's a simple example fetching content from a URL to add.
+
+It also adds filters to the entry, so you can search for it later by
+category, contentType, or both.
+
+```ts
+export const add = action({
+  args: { url: v.string(), category: v.string() },
+  handler: async (ctx, { url, category }) => {
+    const response = await fetch(url);
+    const content = await response.text();
+    const contentType = response.headers.get("content-type");
+
+    const { entryId } = await rag.add(ctx, {
+      namespace: "global", // namespace can be any string
+      key: url,
+      chunks: content.split("\n\n"),
+      filterValues: [
+        { name: "category", value: category },
+        { name: "contentType", value: contentType },
+        // To get an AND filter, use a filter with a more complex value.
+        { name: "categoryAndType", value: { category, contentType } },
+      ],
+    });
+
+    return { entryId };
+  },
+});
+```
+
+Note: The `textSplitter` here could be LangChain, Mastra, or otherwise.
+See below for more details.
+
+### Add Entries Asynchronously using File Storage
+
+For large files, you can upload them to file storage, then provide a chunker
+action to split them into chunks.
+
+In `convex/http.ts`:
+```ts
+import { corsRouter } from "convex-helpers/server/cors";
+import { httpRouter } from "convex/server";
+import { internal } from "./_generated/api.js";
+import { DataModel } from "./_generated/dataModel.js";
+import { httpAction } from "./_generated/server.js";
+import { rag } from "./example.js";
+
+const cors = corsRouter(httpRouter());
+
+cors.route({
+  path: "/upload",
+  method: "POST",
+  handler: httpAction(async (ctx, request) => {
+    const storageId = await ctx.storage.store(await request.blob());
+    await rag.addAsync(ctx, {
+      namespace: "all-files",
+      chunkerAction: internal.http.chunkerAction,
+      onComplete: internal.http.handleEntryComplete,
+      metadata: { storageId },
+    });
+    return new Response();
+  }),
+});
+
+export const chunkerAction = rag.defineChunkerAction(async (ctx, args) => {
+  const storageId = args.entry.metadata!.storageId;
+  const file = await ctx.storage.get(storageId);
+  const text = await new TextDecoder().decode(await file!.arrayBuffer());
+  return { chunks: text.split("\n\n") };
+});
+
+export const handleEntryComplete = rag.defineOnComplete<DataModel>(
+  async (ctx, { replacedEntry, entry, namespace, error }) => {
+    if (error) {
+      await rag.delete(ctx, { entryId: entry.entryId });
+      return;
+    }
+    // You can associate the entry with your own data here. This will commit
+    // in the same transaction as the entry becoming ready.
+  }
+);
+
+export default cors.http;
+```
+
+You can upload files directly to a Convex action, httpAction, or upload url.
+See the [docs](https://docs.convex.dev/file-storage/upload-files) for details.
+
+### Semantic Search
+
+Search across content with vector similarity
+
+- `text` is a string with the full content of the results, for convenience.
+  It is in order of the entries, with titles at each entry boundary, and
+  separators between non-sequential chunks. See below for more details.
+- `results` is an array of matching chunks with scores and more metadata.
+- `entries` is an array of the entries that matched the query.
+  Each result has a `entryId` referencing one of these source entries.
+
+```ts
+export const search = action({
+  args: {
+    query: v.string(),
+  },
+  handler: async (ctx, args) => {
+
+    const { results, text, entries } = await rag.search(ctx, {
+      namespace: "global",
+      query: args.query,
+      limit: 10
+      vectorScoreThreshold: 0.5, // Only return results with a score >= 0.5
+    });
+
+    return { results, text, entries };
+  },
+});
+```
+
+### Filtered Search
+
+Search with metadata filters:
+
+```ts
+export const searchByCategory = action({
+  args: {
+    query: v.string(),
+    category: v.string(),
+  },
+  handler: async (ctx, args) => {
+    const userId = await getUserId(ctx);
+    if (!userId) throw new Error("Unauthorized");
+
+    const results = await rag.search(ctx, {
+      namespace: userId,
+      query: args.query,
+      filters: [{ name: "category", value: args.category }],
+      limit: 10,
+    });
+
+    return results;
+  },
+});
+```
+
+### Add surrounding chunks to results for context
+
+Instead of getting just the single matching chunk, you can request
+surrounding chunks so there's more context to the result.
+
+Note: If there are results that have overlapping ranges, it will not return
+duplicate chunks, but instead give priority to adding the "before" context
+to each chunk.
+For example if you requested 2 before and 1 after, and your results were for
+the same entryId indexes 1, 4, and 7, the results would be:
+```ts
+[
+  // Only one before chunk available, and leaves chunk2 for the next result.
+  { order: 1, content: [chunk0, chunk1], startOrder: 0, ... },
+  // 2 before chunks available, but leaves chunk5 for the next result.
+  { order: 4, content: [chunk2, chunk3, chunk4], startOrder: 2, ... },
+  // 2 before chunks available, and includes one after chunk.
+  { order: 7, content: [chunk5, chunk6, chunk7, chunk8], startOrder: 5, ... },
+]
+```
+
+```ts
+export const searchWithContext = action({
+  args: {
+    query: v.string(),
+    userId: v.string(),
+  },
+  handler: async (ctx, args) => {
+    const { results, text, entries } = await rag.search(ctx, {
+      namespace: args.userId,
+      query: args.query,
+      chunkContext: { before: 2, after: 1 }, // Include 2 chunks before, 1 after
+      limit: 5,
+    });
+
+    return { results, text, entries };
+  },
+});
+```
+
+### Formatting results
+
+Formatting the results for use in a prompt depends a bit on the use case.
+By default, the results will be sorted by score, not necessarily in the order
+they appear in the original text. You may want to sort them by the order they
+appear in the original text so they follow the flow of the original document.
+
+For convenienct, the `text` field of the search results is a string formatted
+with `...` separating non-sequential chunks, `---` separating entries, and
+`# Title:` at each entry boundary (if titles are available).
+
+```ts
+const { text } = await rag.search(ctx, { ... });
+console.log(text);
+```
+
+```txt
+# Title 1:
+Chunk 1 contents
+Chunk 2 contents
+...
+Chunk 8 contents
+Chunk 9 contents
+---
+# Title 2:
+Chunk 4 contents
+Chunk 5 contents
+```
+
+There is also a `text` field on each entry that is the full text of the entry,
+similarly formatted with `...` separating non-sequential chunks, if you want
+to format each entry differently.
+
+For a fully custom format, you can use the `results` field and entries directly:
+
+```ts
+const { results, text, entries } = await rag.search(ctx, {
+  namespace: args.userId,
+  query: args.query,
+  chunkContext: { before: 2, after: 1 }, // Include 2 chunks before, 1 after
+  limit: 5,
+  vectorScoreThreshold: 0.5, // Only return results with a score >= 0.5
+});
+
+// Get results in the order of the entries (highest score first)
+const contexts = entries.map((e) => {
+  const ranges = results
+    .filter((r) => r.entryId === e.entryId)
+    .sort((a, b) => a.startOrder - b.startOrder);
+  let text = (e.title ?? "") + ":\n\n";
+  let previousEnd = 0;
+  for (const range of ranges) {
+    if (range.startOrder !== previousEnd) {
+      text += "\n...\n";
+    }
+    text += range.content.map((c) => c.text).join("\n");
+    previousEnd = range.startOrder + range.content.length;
+  }
+  return {
+    ...e,
+    entryId: e.entryId as EntryId,
+    filterValues: e.filterValues as EntryFilterValues<FitlerSchemas>[],
+    text,
+  };
+}).map((e) => (e.title ? `# ${e.title}:\n${e.text}` : e.text));
+
+await generateText({
+  model: openai.chat("gpt-4o-mini"),
+  prompt: "Use the following context:\n\n" + contexts.join("\n---\n") +
+    "\n\n---\n\n Based on the context, answer the question:\n\n" + args.query,
+});
+```
+
+### Lifecycle Management
+
+Delete an entry:
+
+```ts
+export const delete = mutation({
+  args: { entryId: vEntry },
+  handler: async (ctx, args) => {
+    await rag.delete(ctx, {
+      entryId: args.entryId,
+    });
+  },
+});
+```
+
+See more example usage in [example.ts](./example/convex/example.ts).
+
+Run the example with `npm i && npm run example`.
+<!-- END: Include on https://convex.dev/components -->

package/dist/client/_generated/_ignore.d.ts

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

package/dist/client/_generated/_ignore.d.ts.map

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

package/dist/client/_generated/_ignore.js

@@ -0,0 +1,3 @@
+"use strict";
+// This is only here so convex-test can detect a _generated folder
+//# sourceMappingURL=_ignore.js.map

package/dist/client/_generated/_ignore.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"_ignore.js","sourceRoot":"","sources":["../../../src/client/_generated/_ignore.ts"],"names":[],"mappings":";AAAA,kEAAkE"}

package/dist/client/defaultChunker.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Chunk text for embedding.
+ *
+ * By default, it will chunk into paragraphs and target
+ * 200-2000 characters per chunk (only less than 1 line if the hard limit is reached).
+ */
+export declare function defaultChunker(text: string, { minLines, minCharsSoftLimit, maxCharsSoftLimit, maxCharsHardLimit, delimiter, }?: {
+    minLines?: number;
+    minCharsSoftLimit?: number;
+    maxCharsSoftLimit?: number;
+    maxCharsHardLimit?: number;
+    delimiter?: string;
+}): string[];
+export default defaultChunker;
+//# sourceMappingURL=defaultChunker.d.ts.map

package/dist/client/defaultChunker.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"defaultChunker.d.ts","sourceRoot":"","sources":["../../src/client/defaultChunker.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,wBAAgB,cAAc,CAC5B,IAAI,EAAE,MAAM,EACZ,EACE,QAAY,EACZ,iBAAuB,EACvB,iBAAwB,EACxB,iBAAyB,EACzB,SAAkB,GACnB,GAAE;IACD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,SAAS,CAAC,EAAE,MAAM,CAAC;CACf,GACL,MAAM,EAAE,CA6FV;AAoED,eAAe,cAAc,CAAC"}