@absolutejs/absolute-rag-sqlite 0.0.1 → 0.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +5 -5
- package/index.d.ts +4 -3
- package/index.js +3 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -29,16 +29,16 @@ support for them.
|
|
|
29
29
|
|
|
30
30
|
- `createSQLiteRAGStore(...)`: SQLite-backed RAG store
|
|
31
31
|
- `createSQLiteRAGCollection(...)`: convenience wrapper that creates the store and collection together
|
|
32
|
-
- `
|
|
32
|
+
- `createSQLiteRAG(...)`: one-shot SQLite RAG bundle with `store`, `collection`, and native support helpers
|
|
33
33
|
- `getSQLiteRAGNativeSupport()`: inspect whether the platform sqlite vec package is available
|
|
34
34
|
- `summarizeSQLiteRAGSupport(...)`: turn store diagnostics into an actionable backend summary
|
|
35
35
|
|
|
36
36
|
## Basic usage
|
|
37
37
|
|
|
38
38
|
```ts
|
|
39
|
-
import {
|
|
39
|
+
import { createSQLiteRAG, ragPlugin } from "@absolutejs/absolute-rag-sqlite";
|
|
40
40
|
|
|
41
|
-
const
|
|
41
|
+
const rag = createSQLiteRAG({
|
|
42
42
|
storeOptions: {
|
|
43
43
|
path: "./rag.sqlite",
|
|
44
44
|
native: {
|
|
@@ -50,7 +50,7 @@ const backend = createSQLiteRAGBackend({
|
|
|
50
50
|
app.use(
|
|
51
51
|
ragPlugin({
|
|
52
52
|
path: "/rag",
|
|
53
|
-
collection:
|
|
53
|
+
collection: rag.collection
|
|
54
54
|
})
|
|
55
55
|
);
|
|
56
56
|
```
|
|
@@ -66,7 +66,7 @@ app.use(
|
|
|
66
66
|
You can inspect what happened at runtime:
|
|
67
67
|
|
|
68
68
|
```ts
|
|
69
|
-
const support =
|
|
69
|
+
const support = rag.getNativeSupport();
|
|
70
70
|
console.log(support.actionableMessage);
|
|
71
71
|
```
|
|
72
72
|
|
package/index.d.ts
CHANGED
|
@@ -21,7 +21,7 @@ export type SQLiteRAGCollectionOptions = {
|
|
|
21
21
|
storeOptions?: SQLiteRAGStoreOptions;
|
|
22
22
|
};
|
|
23
23
|
|
|
24
|
-
export type
|
|
24
|
+
export type SQLiteRAGOptions = {
|
|
25
25
|
store?: RAGVectorStore;
|
|
26
26
|
collection?: RAGCollection;
|
|
27
27
|
storeOptions?: SQLiteRAGStoreOptions;
|
|
@@ -38,7 +38,7 @@ export type SQLiteRAGSupportSummary = {
|
|
|
38
38
|
actionableMessage: string;
|
|
39
39
|
};
|
|
40
40
|
|
|
41
|
-
export type
|
|
41
|
+
export type SQLiteRAG = {
|
|
42
42
|
store: RAGVectorStore;
|
|
43
43
|
collection: RAGCollection;
|
|
44
44
|
getStatus: () => RAGVectorStoreStatus | undefined;
|
|
@@ -48,7 +48,8 @@ export type SQLiteRAGBackend = {
|
|
|
48
48
|
|
|
49
49
|
export declare const createSQLiteRAGStore: typeof createCoreSQLiteRAGStore;
|
|
50
50
|
export declare const createSQLiteRAGCollection: (options?: SQLiteRAGCollectionOptions) => RAGCollection;
|
|
51
|
-
export declare const
|
|
51
|
+
export declare const createSQLiteRAG: (options?: SQLiteRAGOptions) => SQLiteRAG;
|
|
52
|
+
export declare const createSQLiteRAGBackend: typeof createSQLiteRAG;
|
|
52
53
|
export declare const getSQLiteRAGNativeSupport: typeof resolveAbsoluteSQLiteVec;
|
|
53
54
|
export declare const summarizeSQLiteRAGSupport: (target?: Pick<RAGCollection, 'getStatus' | 'getCapabilities'> | Pick<RAGVectorStore, 'getStatus' | 'getCapabilities'>) => SQLiteRAGSupportSummary;
|
|
54
55
|
|
package/index.js
CHANGED
|
@@ -34,7 +34,7 @@ export const createSQLiteRAGCollection = (options = {}) => {
|
|
|
34
34
|
return createRAGCollection({ store });
|
|
35
35
|
};
|
|
36
36
|
|
|
37
|
-
export const
|
|
37
|
+
export const createSQLiteRAG = (options = {}) => {
|
|
38
38
|
const store = options.store ?? createSQLiteRAGStore(options.storeOptions ?? {});
|
|
39
39
|
const collection = options.collection ?? createRAGCollection({ store });
|
|
40
40
|
|
|
@@ -47,6 +47,8 @@ export const createSQLiteRAGBackend = (options = {}) => {
|
|
|
47
47
|
};
|
|
48
48
|
};
|
|
49
49
|
|
|
50
|
+
export const createSQLiteRAGBackend = createSQLiteRAG;
|
|
51
|
+
|
|
50
52
|
export const getSQLiteRAGNativeSupport = () => resolveAbsoluteSQLiteVec();
|
|
51
53
|
|
|
52
54
|
export const summarizeSQLiteRAGSupport = (target) => {
|
package/package.json
CHANGED