@absolutejs/rag 0.0.4 → 0.0.5

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.
Files changed (91) hide show
  1. package/dist/src/ai/client/createRAGAnswerWorkflow.d.ts +32 -0
  2. package/dist/src/ai/client/createRAGStream.d.ts +2 -0
  3. package/dist/src/ai/client/createRAGWorkflow.d.ts +3 -0
  4. package/dist/src/ai/client/index.d.ts +8 -0
  5. package/dist/src/ai/client/ragClient.d.ts +349 -0
  6. package/dist/src/ai/client/ui.d.ts +5 -0
  7. package/dist/src/ai/rag/accessControl.d.ts +2 -0
  8. package/dist/src/ai/rag/adapters/filtering.d.ts +2 -0
  9. package/dist/src/ai/rag/adapters/inMemory.d.ts +8 -0
  10. package/dist/src/ai/rag/adapters/postgres.d.ts +20 -0
  11. package/dist/src/ai/rag/adapters/queryPlanning.d.ts +26 -0
  12. package/dist/src/ai/rag/adapters/sqlite.d.ts +24 -0
  13. package/dist/src/ai/rag/adapters/utils.d.ts +3 -0
  14. package/dist/src/ai/rag/chat.d.ts +1773 -0
  15. package/dist/src/ai/rag/collection.d.ts +15 -0
  16. package/dist/src/ai/rag/constants.d.ts +9 -0
  17. package/dist/src/ai/rag/emailProviders.d.ts +34 -0
  18. package/dist/src/ai/rag/embedding.d.ts +9 -0
  19. package/dist/src/ai/rag/embeddingProviders.d.ts +50 -0
  20. package/dist/src/ai/rag/extractorProviders.d.ts +58 -0
  21. package/dist/src/ai/rag/grounding.d.ts +6 -0
  22. package/dist/src/ai/rag/htmxConfig.d.ts +3 -0
  23. package/dist/src/ai/rag/htmxWorkflowRenderers.d.ts +3 -0
  24. package/dist/src/ai/rag/index.d.ts +31 -0
  25. package/dist/src/ai/rag/ingestion.d.ts +61 -0
  26. package/dist/src/ai/rag/jobState.d.ts +2 -0
  27. package/dist/src/ai/rag/lexical.d.ts +42 -0
  28. package/dist/src/ai/rag/presentation.d.ts +165 -0
  29. package/dist/src/ai/rag/quality.d.ts +607 -0
  30. package/dist/src/ai/rag/queryTransforms.d.ts +17 -0
  31. package/dist/src/ai/rag/reranking.d.ts +17 -0
  32. package/dist/src/ai/rag/resolveAbsoluteSQLiteVec.d.ts +3 -0
  33. package/dist/src/ai/rag/retrievalStrategies.d.ts +6 -0
  34. package/dist/src/ai/rag/sync.d.ts +37 -0
  35. package/dist/src/ai/rag/types.d.ts +11 -0
  36. package/dist/src/ai/rag/ui.d.ts +4 -0
  37. package/dist/src/ai/rag/workflowState.d.ts +1 -0
  38. package/dist/src/angular/ai/ai-rag-stream.service.d.ts +32 -0
  39. package/dist/src/angular/ai/ai-rag-workflow.service.d.ts +33 -0
  40. package/dist/src/angular/ai/index.d.ts +3 -0
  41. package/dist/src/angular/ai/rag-client.service.d.ts +243 -0
  42. package/dist/src/constants.d.ts +60 -0
  43. package/dist/src/react/ai/index.d.ts +18 -0
  44. package/dist/src/react/ai/useRAG.d.ts +341 -0
  45. package/dist/src/react/ai/useRAGChunkPreview.d.ts +20 -0
  46. package/dist/src/react/ai/useRAGCitations.d.ts +9 -0
  47. package/dist/src/react/ai/useRAGDocuments.d.ts +10 -0
  48. package/dist/src/react/ai/useRAGEvaluate.d.ts +28 -0
  49. package/dist/src/react/ai/useRAGGrounding.d.ts +10 -0
  50. package/dist/src/react/ai/useRAGIndexAdmin.d.ts +58 -0
  51. package/dist/src/react/ai/useRAGIngest.d.ts +16 -0
  52. package/dist/src/react/ai/useRAGOps.d.ts +20 -0
  53. package/dist/src/react/ai/useRAGSearch.d.ts +17 -0
  54. package/dist/src/react/ai/useRAGSources.d.ts +13 -0
  55. package/dist/src/react/ai/useRAGStatus.d.ts +10 -0
  56. package/dist/src/react/ai/useRAGStream.d.ts +55 -0
  57. package/dist/src/react/ai/useRAGStreamProgress.d.ts +9 -0
  58. package/dist/src/react/ai/useRAGWorkflow.d.ts +55 -0
  59. package/dist/src/svelte/ai/createRAG.d.ts +292 -0
  60. package/dist/src/svelte/ai/createRAGChunkPreview.d.ts +20 -0
  61. package/dist/src/svelte/ai/createRAGCitations.d.ts +10 -0
  62. package/dist/src/svelte/ai/createRAGDocuments.d.ts +10 -0
  63. package/dist/src/svelte/ai/createRAGEvaluate.d.ts +28 -0
  64. package/dist/src/svelte/ai/createRAGGrounding.d.ts +11 -0
  65. package/dist/src/svelte/ai/createRAGIndexAdmin.d.ts +58 -0
  66. package/dist/src/svelte/ai/createRAGIngest.d.ts +17 -0
  67. package/dist/src/svelte/ai/createRAGOps.d.ts +20 -0
  68. package/dist/src/svelte/ai/createRAGSearch.d.ts +15 -0
  69. package/dist/src/svelte/ai/createRAGSources.d.ts +14 -0
  70. package/dist/src/svelte/ai/createRAGStatus.d.ts +9 -0
  71. package/dist/src/svelte/ai/createRAGStream.d.ts +30 -0
  72. package/dist/src/svelte/ai/createRAGStreamProgress.d.ts +8 -0
  73. package/dist/src/svelte/ai/createRAGWorkflow.d.ts +30 -0
  74. package/dist/src/svelte/ai/index.d.ts +17 -0
  75. package/dist/src/vue/ai/index.d.ts +17 -0
  76. package/dist/src/vue/ai/useRAG.d.ts +2892 -0
  77. package/dist/src/vue/ai/useRAGChunkPreview.d.ts +152 -0
  78. package/dist/src/vue/ai/useRAGCitations.d.ts +10 -0
  79. package/dist/src/vue/ai/useRAGDocuments.d.ts +94 -0
  80. package/dist/src/vue/ai/useRAGEvaluate.d.ts +1002 -0
  81. package/dist/src/vue/ai/useRAGGrounding.d.ts +11 -0
  82. package/dist/src/vue/ai/useRAGIndexAdmin.d.ts +1104 -0
  83. package/dist/src/vue/ai/useRAGIngest.d.ts +27 -0
  84. package/dist/src/vue/ai/useRAGOps.d.ts +220 -0
  85. package/dist/src/vue/ai/useRAGSearch.d.ts +159 -0
  86. package/dist/src/vue/ai/useRAGSources.d.ts +14 -0
  87. package/dist/src/vue/ai/useRAGStatus.d.ts +9 -0
  88. package/dist/src/vue/ai/useRAGStream.d.ts +35 -0
  89. package/dist/src/vue/ai/useRAGStreamProgress.d.ts +8 -0
  90. package/dist/src/vue/ai/useRAGWorkflow.d.ts +35 -0
  91. package/package.json +131 -103
@@ -0,0 +1,152 @@
1
+ import type { RAGDocumentChunkPreview } from "@absolutejs/ai";
2
+ export declare const useRAGChunkPreview: (path: string) => {
3
+ activeChunkId: import("vue").Ref<string | null, string | null>;
4
+ activeSectionDiagnostic: import("vue").ComputedRef<import("@absolutejs/ai").RAGSectionRetrievalDiagnostic | null>;
5
+ clear: () => void;
6
+ chunkGraph: import("vue").ComputedRef<import("@absolutejs/ai").RAGChunkGraph | null>;
7
+ error: import("vue").Ref<string | null, string | null>;
8
+ inspect: (id: string) => Promise<{
9
+ ok: true;
10
+ } & RAGDocumentChunkPreview>;
11
+ isLoading: import("vue").Ref<boolean, boolean>;
12
+ navigation: import("vue").ComputedRef<import("@absolutejs/ai").RAGChunkGraphNavigation | null>;
13
+ preview: import("vue").Ref<{
14
+ document: {
15
+ kind?: string | undefined;
16
+ source: string;
17
+ title: string;
18
+ corpusKey?: string | undefined;
19
+ labels?: {
20
+ contextLabel?: string | undefined;
21
+ locatorLabel?: string | undefined;
22
+ provenanceLabel?: string | undefined;
23
+ } | undefined;
24
+ id: string;
25
+ createdAt?: number | undefined;
26
+ chunkCount?: number | undefined;
27
+ format?: import("@absolutejs/ai").RAGContentFormat | undefined;
28
+ chunkStrategy?: import("@absolutejs/ai").RAGChunkingStrategy | undefined;
29
+ chunkSize?: number | undefined;
30
+ updatedAt?: number | undefined;
31
+ metadata?: Record<string, unknown> | undefined;
32
+ };
33
+ normalizedText: string;
34
+ chunks: {
35
+ chunkId: string;
36
+ corpusKey?: string | undefined;
37
+ text: string;
38
+ title?: string | undefined;
39
+ source?: string | undefined;
40
+ metadata?: Record<string, unknown> | undefined;
41
+ embedding?: number[] | undefined;
42
+ embeddingVariants?: {
43
+ id: string;
44
+ label?: string | undefined;
45
+ text?: string | undefined;
46
+ metadata?: Record<string, unknown> | undefined;
47
+ embedding?: number[] | undefined;
48
+ }[] | undefined;
49
+ structure?: {
50
+ section?: {
51
+ title?: string | undefined;
52
+ path?: string[] | undefined;
53
+ depth?: number | undefined;
54
+ kind?: "markdown_heading" | "html_heading" | "office_heading" | "office_block" | "pdf_block" | "spreadsheet_rows" | "presentation_slide" | undefined;
55
+ } | undefined;
56
+ sequence?: {
57
+ sectionChunkId?: string | undefined;
58
+ sectionChunkIndex?: number | undefined;
59
+ sectionChunkCount?: number | undefined;
60
+ previousChunkId?: string | undefined;
61
+ nextChunkId?: string | undefined;
62
+ } | undefined;
63
+ } | undefined;
64
+ labels?: {
65
+ contextLabel?: string | undefined;
66
+ locatorLabel?: string | undefined;
67
+ provenanceLabel?: string | undefined;
68
+ } | undefined;
69
+ excerpts?: {
70
+ chunkExcerpt: string;
71
+ windowExcerpt: string;
72
+ sectionExcerpt: string;
73
+ } | undefined;
74
+ excerptSelection?: {
75
+ mode: import("@absolutejs/ai").RAGExcerptMode;
76
+ reason: import("@absolutejs/ai").RAGExcerptPromotionReason;
77
+ } | undefined;
78
+ }[];
79
+ } | null, RAGDocumentChunkPreview | {
80
+ document: {
81
+ kind?: string | undefined;
82
+ source: string;
83
+ title: string;
84
+ corpusKey?: string | undefined;
85
+ labels?: {
86
+ contextLabel?: string | undefined;
87
+ locatorLabel?: string | undefined;
88
+ provenanceLabel?: string | undefined;
89
+ } | undefined;
90
+ id: string;
91
+ createdAt?: number | undefined;
92
+ chunkCount?: number | undefined;
93
+ format?: import("@absolutejs/ai").RAGContentFormat | undefined;
94
+ chunkStrategy?: import("@absolutejs/ai").RAGChunkingStrategy | undefined;
95
+ chunkSize?: number | undefined;
96
+ updatedAt?: number | undefined;
97
+ metadata?: Record<string, unknown> | undefined;
98
+ };
99
+ normalizedText: string;
100
+ chunks: {
101
+ chunkId: string;
102
+ corpusKey?: string | undefined;
103
+ text: string;
104
+ title?: string | undefined;
105
+ source?: string | undefined;
106
+ metadata?: Record<string, unknown> | undefined;
107
+ embedding?: number[] | undefined;
108
+ embeddingVariants?: {
109
+ id: string;
110
+ label?: string | undefined;
111
+ text?: string | undefined;
112
+ metadata?: Record<string, unknown> | undefined;
113
+ embedding?: number[] | undefined;
114
+ }[] | undefined;
115
+ structure?: {
116
+ section?: {
117
+ title?: string | undefined;
118
+ path?: string[] | undefined;
119
+ depth?: number | undefined;
120
+ kind?: "markdown_heading" | "html_heading" | "office_heading" | "office_block" | "pdf_block" | "spreadsheet_rows" | "presentation_slide" | undefined;
121
+ } | undefined;
122
+ sequence?: {
123
+ sectionChunkId?: string | undefined;
124
+ sectionChunkIndex?: number | undefined;
125
+ sectionChunkCount?: number | undefined;
126
+ previousChunkId?: string | undefined;
127
+ nextChunkId?: string | undefined;
128
+ } | undefined;
129
+ } | undefined;
130
+ labels?: {
131
+ contextLabel?: string | undefined;
132
+ locatorLabel?: string | undefined;
133
+ provenanceLabel?: string | undefined;
134
+ } | undefined;
135
+ excerpts?: {
136
+ chunkExcerpt: string;
137
+ windowExcerpt: string;
138
+ sectionExcerpt: string;
139
+ } | undefined;
140
+ excerptSelection?: {
141
+ mode: import("@absolutejs/ai").RAGExcerptMode;
142
+ reason: import("@absolutejs/ai").RAGExcerptPromotionReason;
143
+ } | undefined;
144
+ }[];
145
+ } | null>;
146
+ sectionDiagnostics: import("vue").ComputedRef<import("@absolutejs/ai").RAGSectionRetrievalDiagnostic[]>;
147
+ selectChildSection: (sectionId: string) => void;
148
+ selectChunk: (id: string | null) => void;
149
+ selectParentSection: () => void;
150
+ selectSiblingSection: (sectionId: string) => void;
151
+ };
152
+ export type UseRAGChunkPreviewResult = ReturnType<typeof useRAGChunkPreview>;
@@ -0,0 +1,10 @@
1
+ import { type Ref } from "vue";
2
+ import type { RAGSource } from "@absolutejs/ai";
3
+ export declare const useRAGCitations: (sources: Ref<RAGSource[]>) => {
4
+ citationReferenceMap: import("vue").ComputedRef<import("@absolutejs/ai").RAGCitationReferenceMap>;
5
+ citations: import("vue").ComputedRef<import("@absolutejs/ai").RAGCitation[]>;
6
+ hasCitations: import("vue").ComputedRef<boolean>;
7
+ sourceGroups: import("vue").ComputedRef<import("@absolutejs/ai").RAGSourceGroup[]>;
8
+ sourceSummaries: import("vue").ComputedRef<import("@absolutejs/ai").RAGSourceSummary[]>;
9
+ };
10
+ export type UseRAGCitationsResult = ReturnType<typeof useRAGCitations>;
@@ -0,0 +1,94 @@
1
+ import type { RAGDocumentsResponse, RAGIndexedDocument } from "@absolutejs/ai";
2
+ export declare const useRAGDocuments: (path: string) => {
3
+ documents: import("vue").Ref<{
4
+ corpusKey?: string | undefined;
5
+ id: string;
6
+ title: string;
7
+ source: string;
8
+ text?: string | undefined;
9
+ kind?: string | undefined;
10
+ format?: import("@absolutejs/ai").RAGContentFormat | undefined;
11
+ chunkStrategy?: import("@absolutejs/ai").RAGChunkingStrategy | undefined;
12
+ chunkSize?: number | undefined;
13
+ chunkCount?: number | undefined;
14
+ createdAt?: number | undefined;
15
+ updatedAt?: number | undefined;
16
+ metadata?: Record<string, unknown> | undefined;
17
+ labels?: {
18
+ contextLabel?: string | undefined;
19
+ locatorLabel?: string | undefined;
20
+ provenanceLabel?: string | undefined;
21
+ } | undefined;
22
+ }[], RAGIndexedDocument[] | {
23
+ corpusKey?: string | undefined;
24
+ id: string;
25
+ title: string;
26
+ source: string;
27
+ text?: string | undefined;
28
+ kind?: string | undefined;
29
+ format?: import("@absolutejs/ai").RAGContentFormat | undefined;
30
+ chunkStrategy?: import("@absolutejs/ai").RAGChunkingStrategy | undefined;
31
+ chunkSize?: number | undefined;
32
+ chunkCount?: number | undefined;
33
+ createdAt?: number | undefined;
34
+ updatedAt?: number | undefined;
35
+ metadata?: Record<string, unknown> | undefined;
36
+ labels?: {
37
+ contextLabel?: string | undefined;
38
+ locatorLabel?: string | undefined;
39
+ provenanceLabel?: string | undefined;
40
+ } | undefined;
41
+ }[]>;
42
+ error: import("vue").Ref<string | null, string | null>;
43
+ isLoading: import("vue").Ref<boolean, boolean>;
44
+ lastResponse: import("vue").Ref<{
45
+ ok: true;
46
+ documents: {
47
+ corpusKey?: string | undefined;
48
+ id: string;
49
+ title: string;
50
+ source: string;
51
+ text?: string | undefined;
52
+ kind?: string | undefined;
53
+ format?: import("@absolutejs/ai").RAGContentFormat | undefined;
54
+ chunkStrategy?: import("@absolutejs/ai").RAGChunkingStrategy | undefined;
55
+ chunkSize?: number | undefined;
56
+ chunkCount?: number | undefined;
57
+ createdAt?: number | undefined;
58
+ updatedAt?: number | undefined;
59
+ metadata?: Record<string, unknown> | undefined;
60
+ labels?: {
61
+ contextLabel?: string | undefined;
62
+ locatorLabel?: string | undefined;
63
+ provenanceLabel?: string | undefined;
64
+ } | undefined;
65
+ }[];
66
+ lastSeedMsByMode?: Record<string, number> | undefined;
67
+ } | null, RAGDocumentsResponse | {
68
+ ok: true;
69
+ documents: {
70
+ corpusKey?: string | undefined;
71
+ id: string;
72
+ title: string;
73
+ source: string;
74
+ text?: string | undefined;
75
+ kind?: string | undefined;
76
+ format?: import("@absolutejs/ai").RAGContentFormat | undefined;
77
+ chunkStrategy?: import("@absolutejs/ai").RAGChunkingStrategy | undefined;
78
+ chunkSize?: number | undefined;
79
+ chunkCount?: number | undefined;
80
+ createdAt?: number | undefined;
81
+ updatedAt?: number | undefined;
82
+ metadata?: Record<string, unknown> | undefined;
83
+ labels?: {
84
+ contextLabel?: string | undefined;
85
+ locatorLabel?: string | undefined;
86
+ provenanceLabel?: string | undefined;
87
+ } | undefined;
88
+ }[];
89
+ lastSeedMsByMode?: Record<string, number> | undefined;
90
+ } | null>;
91
+ load: (kind?: string) => Promise<RAGDocumentsResponse>;
92
+ reset: () => void;
93
+ };
94
+ export type UseRAGDocumentsResult = ReturnType<typeof useRAGDocuments>;