@rudderjs/ai 1.4.0 → 1.6.0
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 +484 -7
- package/boost/guidelines.md +62 -2
- package/boost/skills/ai-tools/SKILL.md +14 -5
- package/dist/agent.d.ts +66 -15
- package/dist/agent.d.ts.map +1 -1
- package/dist/agent.js +529 -58
- package/dist/agent.js.map +1 -1
- package/dist/budget/pricing.d.ts +124 -0
- package/dist/budget/pricing.d.ts.map +1 -0
- package/dist/budget/pricing.js +175 -0
- package/dist/budget/pricing.js.map +1 -0
- package/dist/budget/storage.d.ts +104 -0
- package/dist/budget/storage.d.ts.map +1 -0
- package/dist/budget/storage.js +0 -0
- package/dist/budget/storage.js.map +1 -0
- package/dist/budget/with-budget.d.ts +119 -0
- package/dist/budget/with-budget.d.ts.map +1 -0
- package/dist/budget/with-budget.js +175 -0
- package/dist/budget/with-budget.js.map +1 -0
- package/dist/budget-orm/index.d.ts +96 -0
- package/dist/budget-orm/index.d.ts.map +1 -0
- package/dist/budget-orm/index.js +177 -0
- package/dist/budget-orm/index.js.map +1 -0
- package/dist/commands/ai-eval.d.ts +93 -0
- package/dist/commands/ai-eval.d.ts.map +1 -0
- package/dist/commands/ai-eval.js +378 -0
- package/dist/commands/ai-eval.js.map +1 -0
- package/dist/computer-use/actions.d.ts +214 -0
- package/dist/computer-use/actions.d.ts.map +1 -0
- package/dist/computer-use/actions.js +48 -0
- package/dist/computer-use/actions.js.map +1 -0
- package/dist/computer-use/errors.d.ts +57 -0
- package/dist/computer-use/errors.d.ts.map +1 -0
- package/dist/computer-use/errors.js +76 -0
- package/dist/computer-use/errors.js.map +1 -0
- package/dist/computer-use/index.d.ts +53 -0
- package/dist/computer-use/index.d.ts.map +1 -0
- package/dist/computer-use/index.js +51 -0
- package/dist/computer-use/index.js.map +1 -0
- package/dist/computer-use/playwright.d.ts +76 -0
- package/dist/computer-use/playwright.d.ts.map +1 -0
- package/dist/computer-use/playwright.js +270 -0
- package/dist/computer-use/playwright.js.map +1 -0
- package/dist/computer-use/tool.d.ts +154 -0
- package/dist/computer-use/tool.d.ts.map +1 -0
- package/dist/computer-use/tool.js +210 -0
- package/dist/computer-use/tool.js.map +1 -0
- package/dist/eval/fixtures.d.ts +65 -0
- package/dist/eval/fixtures.d.ts.map +1 -0
- package/dist/eval/fixtures.js +110 -0
- package/dist/eval/fixtures.js.map +1 -0
- package/dist/eval/html-reporter.d.ts +25 -0
- package/dist/eval/html-reporter.d.ts.map +1 -0
- package/dist/eval/html-reporter.js +209 -0
- package/dist/eval/html-reporter.js.map +1 -0
- package/dist/eval/index.d.ts +271 -0
- package/dist/eval/index.d.ts.map +1 -0
- package/dist/eval/index.js +510 -0
- package/dist/eval/index.js.map +1 -0
- package/dist/eval/json-reporter.d.ts +43 -0
- package/dist/eval/json-reporter.d.ts.map +1 -0
- package/dist/eval/json-reporter.js +40 -0
- package/dist/eval/json-reporter.js.map +1 -0
- package/dist/fake.d.ts +36 -1
- package/dist/fake.d.ts.map +1 -1
- package/dist/fake.js +49 -2
- package/dist/fake.js.map +1 -1
- package/dist/file-search.d.ts +168 -0
- package/dist/file-search.d.ts.map +1 -0
- package/dist/file-search.js +158 -0
- package/dist/file-search.js.map +1 -0
- package/dist/handoff.d.ts +95 -0
- package/dist/handoff.d.ts.map +1 -0
- package/dist/handoff.js +78 -0
- package/dist/handoff.js.map +1 -0
- package/dist/index.d.ts +29 -5
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +22 -2
- package/dist/index.js.map +1 -1
- package/dist/mcp/client-tools.d.ts +39 -0
- package/dist/mcp/client-tools.d.ts.map +1 -0
- package/dist/mcp/client-tools.js +147 -0
- package/dist/mcp/client-tools.js.map +1 -0
- package/dist/mcp/index.d.ts +16 -0
- package/dist/mcp/index.d.ts.map +1 -0
- package/dist/mcp/index.js +15 -0
- package/dist/mcp/index.js.map +1 -0
- package/dist/mcp/server-from-agent.d.ts +24 -0
- package/dist/mcp/server-from-agent.d.ts.map +1 -0
- package/dist/mcp/server-from-agent.js +113 -0
- package/dist/mcp/server-from-agent.js.map +1 -0
- package/dist/mcp/types.d.ts +64 -0
- package/dist/mcp/types.d.ts.map +1 -0
- package/dist/mcp/types.js +6 -0
- package/dist/mcp/types.js.map +1 -0
- package/dist/memory-embedding/index.d.ts +121 -0
- package/dist/memory-embedding/index.d.ts.map +1 -0
- package/dist/memory-embedding/index.js +229 -0
- package/dist/memory-embedding/index.js.map +1 -0
- package/dist/memory-extract.d.ts +60 -0
- package/dist/memory-extract.d.ts.map +1 -0
- package/dist/memory-extract.js +163 -0
- package/dist/memory-extract.js.map +1 -0
- package/dist/memory-inject.d.ts +39 -0
- package/dist/memory-inject.d.ts.map +1 -0
- package/dist/memory-inject.js +135 -0
- package/dist/memory-inject.js.map +1 -0
- package/dist/memory-orm/index.d.ts +118 -0
- package/dist/memory-orm/index.d.ts.map +1 -0
- package/dist/memory-orm/index.js +187 -0
- package/dist/memory-orm/index.js.map +1 -0
- package/dist/memory.d.ts +55 -0
- package/dist/memory.d.ts.map +1 -0
- package/dist/memory.js +132 -0
- package/dist/memory.js.map +1 -0
- package/dist/observers.d.ts +22 -0
- package/dist/observers.d.ts.map +1 -1
- package/dist/observers.js.map +1 -1
- package/dist/provider-tools.d.ts +15 -1
- package/dist/provider-tools.d.ts.map +1 -1
- package/dist/provider-tools.js +21 -1
- package/dist/provider-tools.js.map +1 -1
- package/dist/providers/anthropic.d.ts +9 -1
- package/dist/providers/anthropic.d.ts.map +1 -1
- package/dist/providers/anthropic.js +66 -11
- package/dist/providers/anthropic.js.map +1 -1
- package/dist/providers/bedrock.d.ts +60 -0
- package/dist/providers/bedrock.d.ts.map +1 -0
- package/dist/providers/bedrock.js +167 -0
- package/dist/providers/bedrock.js.map +1 -0
- package/dist/providers/elevenlabs.d.ts +98 -0
- package/dist/providers/elevenlabs.d.ts.map +1 -0
- package/dist/providers/elevenlabs.js +229 -0
- package/dist/providers/elevenlabs.js.map +1 -0
- package/dist/providers/google.d.ts +83 -1
- package/dist/providers/google.d.ts.map +1 -1
- package/dist/providers/google.js +491 -8
- package/dist/providers/google.js.map +1 -1
- package/dist/providers/openai.d.ts +8 -1
- package/dist/providers/openai.d.ts.map +1 -1
- package/dist/providers/openai.js +215 -5
- package/dist/providers/openai.js.map +1 -1
- package/dist/providers/openrouter.d.ts +43 -0
- package/dist/providers/openrouter.d.ts.map +1 -0
- package/dist/providers/openrouter.js +21 -0
- package/dist/providers/openrouter.js.map +1 -0
- package/dist/providers/voyage.d.ts +91 -0
- package/dist/providers/voyage.d.ts.map +1 -0
- package/dist/providers/voyage.js +166 -0
- package/dist/providers/voyage.js.map +1 -0
- package/dist/queue-job.d.ts +69 -4
- package/dist/queue-job.d.ts.map +1 -1
- package/dist/queue-job.js +114 -11
- package/dist/queue-job.js.map +1 -1
- package/dist/registry.d.ts +3 -1
- package/dist/registry.d.ts.map +1 -1
- package/dist/registry.js +10 -0
- package/dist/registry.js.map +1 -1
- package/dist/server/provider.d.ts.map +1 -1
- package/dist/server/provider.js +38 -1
- package/dist/server/provider.js.map +1 -1
- package/dist/similarity-search.d.ts +163 -0
- package/dist/similarity-search.d.ts.map +1 -0
- package/dist/similarity-search.js +147 -0
- package/dist/similarity-search.js.map +1 -0
- package/dist/sub-agent-run-store.d.ts +40 -3
- package/dist/sub-agent-run-store.d.ts.map +1 -1
- package/dist/sub-agent-run-store.js.map +1 -1
- package/dist/tool.d.ts +59 -0
- package/dist/tool.d.ts.map +1 -1
- package/dist/tool.js +45 -4
- package/dist/tool.js.map +1 -1
- package/dist/types.d.ts +285 -1
- package/dist/types.d.ts.map +1 -1
- package/dist/vector-stores/index.d.ts +96 -0
- package/dist/vector-stores/index.d.ts.map +1 -0
- package/dist/vector-stores/index.js +153 -0
- package/dist/vector-stores/index.js.map +1 -0
- package/package.json +43 -4
|
@@ -0,0 +1,163 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* `similaritySearch({ model, column, embedWith, ... })` — agent-tool
|
|
3
|
+
* factory that wraps an `@rudderjs/orm` Model + a vector column into a
|
|
4
|
+
* drop-in `Tool` an agent can call to retrieve semantically similar
|
|
5
|
+
* rows (#B7 Phase 2).
|
|
6
|
+
*
|
|
7
|
+
* Composes B7 Phase 1's ORM primitives (`whereVectorSimilarTo` +
|
|
8
|
+
* `selectVectorDistance`) with `AI.embed()`. The model emits a
|
|
9
|
+
* natural-language `query`; the tool embeds it, runs a vector search,
|
|
10
|
+
* and returns the top-K rows ranked by similarity.
|
|
11
|
+
*
|
|
12
|
+
* @example
|
|
13
|
+
* ```ts
|
|
14
|
+
* import { similaritySearch } from '@rudderjs/ai'
|
|
15
|
+
* import { Document } from './app/Models/Document.js'
|
|
16
|
+
*
|
|
17
|
+
* class KnowledgeAgent extends Agent {
|
|
18
|
+
* tools() {
|
|
19
|
+
* return [
|
|
20
|
+
* similaritySearch({
|
|
21
|
+
* model: Document,
|
|
22
|
+
* column: 'embedding',
|
|
23
|
+
* embedWith: 'openai/text-embedding-3-small',
|
|
24
|
+
* minSimilarity: 0.7,
|
|
25
|
+
* limit: 10,
|
|
26
|
+
* }),
|
|
27
|
+
* ]
|
|
28
|
+
* }
|
|
29
|
+
* }
|
|
30
|
+
* ```
|
|
31
|
+
*
|
|
32
|
+
* Phase 2 limitations (lifted in Phase 2.5):
|
|
33
|
+
* - **Standalone queries only.** No `scope`/`.where()` chaining yet —
|
|
34
|
+
* the underlying `whereVectorSimilarTo` query must run alone. Agents
|
|
35
|
+
* see every row in the corpus that matches the vector. Phase 2.5
|
|
36
|
+
* adds a `scope: (q) => q.where(...)` callback.
|
|
37
|
+
* - **Cosine-centric similarity.** `similarity` is reported as
|
|
38
|
+
* `1 - distance` regardless of `metric`. For non-cosine metrics
|
|
39
|
+
* (`l2`, `inner-product`) the value is internally consistent with
|
|
40
|
+
* the `minSimilarity` filter applied by the adapter but isn't a
|
|
41
|
+
* meaningful normalized score on its own.
|
|
42
|
+
*/
|
|
43
|
+
import type { ServerToolBuilder } from './tool.js';
|
|
44
|
+
/**
|
|
45
|
+
* Structural type for the model class similaritySearch accepts.
|
|
46
|
+
*
|
|
47
|
+
* Declared locally instead of importing `Model` from `@rudderjs/orm`
|
|
48
|
+
* so the main entry stays free of orm runtime — the tool calls
|
|
49
|
+
* `model.query()` and never references the `@rudderjs/orm` package
|
|
50
|
+
* itself. The user's app brings its own Model class.
|
|
51
|
+
*/
|
|
52
|
+
export interface SimilaritySearchModel<TInstance> {
|
|
53
|
+
readonly name: string;
|
|
54
|
+
query(): SimilaritySearchQueryBuilder<TInstance>;
|
|
55
|
+
}
|
|
56
|
+
/**
|
|
57
|
+
* WhereOperator strings the `scope` callback may pass to `.where()`.
|
|
58
|
+
* Mirrors `@rudderjs/contracts`'s `WhereOperator`. Duplicated here so the
|
|
59
|
+
* main entry has no compile-time `@rudderjs/contracts` dep.
|
|
60
|
+
*/
|
|
61
|
+
export type SimilaritySearchWhereOperator = '=' | '!=' | '>' | '>=' | '<' | '<=' | 'LIKE' | 'NOT LIKE' | 'IN' | 'NOT IN';
|
|
62
|
+
/**
|
|
63
|
+
* Structural type for the QueryBuilder methods similaritySearch needs.
|
|
64
|
+
* Mirrors a subset of `@rudderjs/contracts`'s `QueryBuilder<T>` so apps
|
|
65
|
+
* writing a `scope` callback get autocomplete on the methods that actually
|
|
66
|
+
* compose with `whereVectorSimilarTo` (#B7 Phase 2.5):
|
|
67
|
+
*
|
|
68
|
+
* - `.where()` / `.orWhere()` chains compose into the SQL with positional
|
|
69
|
+
* parameter binding.
|
|
70
|
+
* - `.with()` / `.orderBy()` / `.whereGroup()` / `.whereHas()` still throw
|
|
71
|
+
* when paired with a vector clause — out of scope for `scope`.
|
|
72
|
+
*/
|
|
73
|
+
export interface SimilaritySearchQueryBuilder<TInstance> {
|
|
74
|
+
where(column: string, value: unknown): SimilaritySearchQueryBuilder<TInstance>;
|
|
75
|
+
where(column: string, operator: SimilaritySearchWhereOperator, value: unknown): SimilaritySearchQueryBuilder<TInstance>;
|
|
76
|
+
orWhere(column: string, value: unknown): SimilaritySearchQueryBuilder<TInstance>;
|
|
77
|
+
orWhere(column: string, operator: SimilaritySearchWhereOperator, value: unknown): SimilaritySearchQueryBuilder<TInstance>;
|
|
78
|
+
withTrashed?(): SimilaritySearchQueryBuilder<TInstance>;
|
|
79
|
+
onlyTrashed?(): SimilaritySearchQueryBuilder<TInstance>;
|
|
80
|
+
whereVectorSimilarTo?(column: string, query: number[] | string, opts?: {
|
|
81
|
+
metric?: 'cosine' | 'l2' | 'inner-product';
|
|
82
|
+
minSimilarity?: number;
|
|
83
|
+
embedWith?: string;
|
|
84
|
+
}): SimilaritySearchQueryBuilder<TInstance>;
|
|
85
|
+
selectVectorDistance?(column: string, query: number[], alias: string): SimilaritySearchQueryBuilder<TInstance>;
|
|
86
|
+
limit(n: number): SimilaritySearchQueryBuilder<TInstance>;
|
|
87
|
+
get(): Promise<TInstance[]>;
|
|
88
|
+
}
|
|
89
|
+
export interface SimilarityHit<TInstance> {
|
|
90
|
+
readonly row: TInstance;
|
|
91
|
+
/**
|
|
92
|
+
* Higher = closer. For `metric: 'cosine'` (default) this is
|
|
93
|
+
* `1 - distance` ∈ [-1, 1]. For other metrics see the JSDoc on
|
|
94
|
+
* {@link similaritySearch}.
|
|
95
|
+
*/
|
|
96
|
+
readonly similarity: number;
|
|
97
|
+
}
|
|
98
|
+
export interface SimilaritySearchOptions<TInstance> {
|
|
99
|
+
/** The Model class whose rows will be searched. */
|
|
100
|
+
model: SimilaritySearchModel<TInstance>;
|
|
101
|
+
/** The column on `model` declared with the `vector({ dimensions })` cast. */
|
|
102
|
+
column: string;
|
|
103
|
+
/**
|
|
104
|
+
* Embedding model id (`<provider>/<model>`). Required — fails loud
|
|
105
|
+
* at factory construction time if missing so apps don't accidentally
|
|
106
|
+
* route to whatever `AiRegistry.getDefault()` happens to be.
|
|
107
|
+
*/
|
|
108
|
+
embedWith: string;
|
|
109
|
+
/** Default `'cosine'`. */
|
|
110
|
+
metric?: 'cosine' | 'l2' | 'inner-product';
|
|
111
|
+
/**
|
|
112
|
+
* Drops rows whose `1 - distance` falls below this threshold. Cosine
|
|
113
|
+
* range is `[-1, 1]` so values near `0.7–0.9` are typical for
|
|
114
|
+
* "relevant" documents.
|
|
115
|
+
*/
|
|
116
|
+
minSimilarity?: number;
|
|
117
|
+
/** Default `10`. */
|
|
118
|
+
limit?: number;
|
|
119
|
+
/**
|
|
120
|
+
* Pre-filter the query before the vector clause attaches. Receives a
|
|
121
|
+
* fresh `model.query()` builder; return the chained builder. Use for
|
|
122
|
+
* tenancy (`.where('tenantId', userId)`), publication state
|
|
123
|
+
* (`.where('published', true)`), or any flat predicate that should
|
|
124
|
+
* narrow the search corpus.
|
|
125
|
+
*
|
|
126
|
+
* **Phase 2.5 limits:** flat `.where()` / `.orWhere()` chains compose
|
|
127
|
+
* into the SQL. `whereGroup` / `whereHas` / `with()` still throw at
|
|
128
|
+
* terminal time — keep the scope flat.
|
|
129
|
+
*
|
|
130
|
+
* @example
|
|
131
|
+
* ```ts
|
|
132
|
+
* similaritySearch({
|
|
133
|
+
* model: KnowledgeArticle,
|
|
134
|
+
* column: 'embedding',
|
|
135
|
+
* embedWith: 'openai/text-embedding-3-small',
|
|
136
|
+
* scope: q => q.where('tenantId', currentTenant).where('published', true),
|
|
137
|
+
* })
|
|
138
|
+
* ```
|
|
139
|
+
*/
|
|
140
|
+
scope?: (q: SimilaritySearchQueryBuilder<TInstance>) => SimilaritySearchQueryBuilder<TInstance>;
|
|
141
|
+
/**
|
|
142
|
+
* Override the tool name. Default
|
|
143
|
+
* `similarity_search_<model_name_lowercase>`.
|
|
144
|
+
*/
|
|
145
|
+
name?: string;
|
|
146
|
+
/** Override the tool description. */
|
|
147
|
+
description?: string;
|
|
148
|
+
/**
|
|
149
|
+
* Custom string projection for each hit, replaces the default
|
|
150
|
+
* `(0.87) {"id":1,"content":"..."}` shape that the model sees on its
|
|
151
|
+
* next step. The structured array still flows to the UI via the
|
|
152
|
+
* `tool-result` chunk.
|
|
153
|
+
*/
|
|
154
|
+
projectResult?: (row: TInstance, similarity: number) => string;
|
|
155
|
+
}
|
|
156
|
+
/**
|
|
157
|
+
* Build a `Tool` that embeds a natural-language query and returns the
|
|
158
|
+
* top-K similar rows from `model.column`.
|
|
159
|
+
*/
|
|
160
|
+
export declare function similaritySearch<TInstance>(opts: SimilaritySearchOptions<TInstance>): ServerToolBuilder<{
|
|
161
|
+
query: string;
|
|
162
|
+
}, SimilarityHit<TInstance>[]>;
|
|
163
|
+
//# sourceMappingURL=similarity-search.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"similarity-search.d.ts","sourceRoot":"","sources":["../src/similarity-search.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AAKH,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAA;AAElD;;;;;;;GAOG;AACH,MAAM,WAAW,qBAAqB,CAAC,SAAS;IAC9C,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,KAAK,IAAI,4BAA4B,CAAC,SAAS,CAAC,CAAA;CACjD;AAED;;;;GAIG;AACH,MAAM,MAAM,6BAA6B,GACrC,GAAG,GAAG,IAAI,GAAG,GAAG,GAAG,IAAI,GAAG,GAAG,GAAG,IAAI,GACpC,MAAM,GAAG,UAAU,GACnB,IAAI,GAAG,QAAQ,CAAA;AAEnB;;;;;;;;;;GAUG;AACH,MAAM,WAAW,4BAA4B,CAAC,SAAS;IACrD,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,4BAA4B,CAAC,SAAS,CAAC,CAAA;IAC9E,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,6BAA6B,EAAE,KAAK,EAAE,OAAO,GAAG,4BAA4B,CAAC,SAAS,CAAC,CAAA;IACvH,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,4BAA4B,CAAC,SAAS,CAAC,CAAA;IAChF,OAAO,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,6BAA6B,EAAE,KAAK,EAAE,OAAO,GAAG,4BAA4B,CAAC,SAAS,CAAC,CAAA;IACzH,WAAW,CAAC,IAAI,4BAA4B,CAAC,SAAS,CAAC,CAAA;IACvD,WAAW,CAAC,IAAI,4BAA4B,CAAC,SAAS,CAAC,CAAA;IACvD,oBAAoB,CAAC,CACnB,MAAM,EAAE,MAAM,EACd,KAAK,EAAG,MAAM,EAAE,GAAG,MAAM,EACzB,IAAI,CAAC,EAAG;QAAE,MAAM,CAAC,EAAE,QAAQ,GAAG,IAAI,GAAG,eAAe,CAAC;QAAC,aAAa,CAAC,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAA;KAAE,GACjG,4BAA4B,CAAC,SAAS,CAAC,CAAA;IAC1C,oBAAoB,CAAC,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,MAAM,GAAG,4BAA4B,CAAC,SAAS,CAAC,CAAA;IAC9G,KAAK,CAAC,CAAC,EAAE,MAAM,GAAG,4BAA4B,CAAC,SAAS,CAAC,CAAA;IACzD,GAAG,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC,CAAA;CAC5B;AAED,MAAM,WAAW,aAAa,CAAC,SAAS;IACtC,QAAQ,CAAC,GAAG,EAAE,SAAS,CAAA;IACvB;;;;OAIG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;CAC5B;AAED,MAAM,WAAW,uBAAuB,CAAC,SAAS;IAChD,mDAAmD;IACnD,KAAK,EAAE,qBAAqB,CAAC,SAAS,CAAC,CAAA;IAEvC,6EAA6E;IAC7E,MAAM,EAAE,MAAM,CAAA;IAEd;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAA;IAEjB,0BAA0B;IAC1B,MAAM,CAAC,EAAE,QAAQ,GAAG,IAAI,GAAG,eAAe,CAAA;IAE1C;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IAEtB,oBAAoB;IACpB,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,KAAK,CAAC,EAAE,CAAC,CAAC,EAAE,4BAA4B,CAAC,SAAS,CAAC,KAAK,4BAA4B,CAAC,SAAS,CAAC,CAAA;IAE/F;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb,qCAAqC;IACrC,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;;;;OAKG;IACH,aAAa,CAAC,EAAE,CAAC,GAAG,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,KAAK,MAAM,CAAA;CAC/D;AAKD;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,SAAS,EACxC,IAAI,EAAE,uBAAuB,CAAC,SAAS,CAAC,GACvC,iBAAiB,CAAC;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,EAAE,aAAa,CAAC,SAAS,CAAC,EAAE,CAAC,CA0FlE"}
|
|
@@ -0,0 +1,147 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* `similaritySearch({ model, column, embedWith, ... })` — agent-tool
|
|
3
|
+
* factory that wraps an `@rudderjs/orm` Model + a vector column into a
|
|
4
|
+
* drop-in `Tool` an agent can call to retrieve semantically similar
|
|
5
|
+
* rows (#B7 Phase 2).
|
|
6
|
+
*
|
|
7
|
+
* Composes B7 Phase 1's ORM primitives (`whereVectorSimilarTo` +
|
|
8
|
+
* `selectVectorDistance`) with `AI.embed()`. The model emits a
|
|
9
|
+
* natural-language `query`; the tool embeds it, runs a vector search,
|
|
10
|
+
* and returns the top-K rows ranked by similarity.
|
|
11
|
+
*
|
|
12
|
+
* @example
|
|
13
|
+
* ```ts
|
|
14
|
+
* import { similaritySearch } from '@rudderjs/ai'
|
|
15
|
+
* import { Document } from './app/Models/Document.js'
|
|
16
|
+
*
|
|
17
|
+
* class KnowledgeAgent extends Agent {
|
|
18
|
+
* tools() {
|
|
19
|
+
* return [
|
|
20
|
+
* similaritySearch({
|
|
21
|
+
* model: Document,
|
|
22
|
+
* column: 'embedding',
|
|
23
|
+
* embedWith: 'openai/text-embedding-3-small',
|
|
24
|
+
* minSimilarity: 0.7,
|
|
25
|
+
* limit: 10,
|
|
26
|
+
* }),
|
|
27
|
+
* ]
|
|
28
|
+
* }
|
|
29
|
+
* }
|
|
30
|
+
* ```
|
|
31
|
+
*
|
|
32
|
+
* Phase 2 limitations (lifted in Phase 2.5):
|
|
33
|
+
* - **Standalone queries only.** No `scope`/`.where()` chaining yet —
|
|
34
|
+
* the underlying `whereVectorSimilarTo` query must run alone. Agents
|
|
35
|
+
* see every row in the corpus that matches the vector. Phase 2.5
|
|
36
|
+
* adds a `scope: (q) => q.where(...)` callback.
|
|
37
|
+
* - **Cosine-centric similarity.** `similarity` is reported as
|
|
38
|
+
* `1 - distance` regardless of `metric`. For non-cosine metrics
|
|
39
|
+
* (`l2`, `inner-product`) the value is internally consistent with
|
|
40
|
+
* the `minSimilarity` filter applied by the adapter but isn't a
|
|
41
|
+
* meaningful normalized score on its own.
|
|
42
|
+
*/
|
|
43
|
+
import { z } from 'zod';
|
|
44
|
+
import { toolDefinition } from './tool.js';
|
|
45
|
+
import { AI } from './facade.js';
|
|
46
|
+
/** Internal alias used to read distance back off each row. */
|
|
47
|
+
const SIMILARITY_DISTANCE_ALIAS = '__rudderjs_similarity_distance__';
|
|
48
|
+
/**
|
|
49
|
+
* Build a `Tool` that embeds a natural-language query and returns the
|
|
50
|
+
* top-K similar rows from `model.column`.
|
|
51
|
+
*/
|
|
52
|
+
export function similaritySearch(opts) {
|
|
53
|
+
const { model, column, embedWith, metric = 'cosine', minSimilarity, limit = 10, name, description, projectResult, scope, } = opts;
|
|
54
|
+
if (!embedWith || typeof embedWith !== 'string') {
|
|
55
|
+
throw new Error('[RudderJS AI] similaritySearch requires opts.embedWith (e.g. "openai/text-embedding-3-small"). ' +
|
|
56
|
+
'No default — fail loud so embeddings never silently route through whichever provider happens to be the AI default.');
|
|
57
|
+
}
|
|
58
|
+
if (!column || typeof column !== 'string') {
|
|
59
|
+
throw new Error('[RudderJS AI] similaritySearch requires opts.column — the Model column declared with vector({ dimensions }).');
|
|
60
|
+
}
|
|
61
|
+
if (!model || typeof model.query !== 'function') {
|
|
62
|
+
throw new Error('[RudderJS AI] similaritySearch requires opts.model — a Model class with a static query() method.');
|
|
63
|
+
}
|
|
64
|
+
if (limit <= 0 || !Number.isFinite(limit)) {
|
|
65
|
+
throw new Error(`[RudderJS AI] similaritySearch limit must be a positive finite number; got ${String(limit)}.`);
|
|
66
|
+
}
|
|
67
|
+
const toolName = name ?? `similarity_search_${model.name.toLowerCase()}`;
|
|
68
|
+
const toolDescription = description ?? `Semantic search over ${model.name} records. Pass a natural-language \`query\` string; the most similar rows are returned.`;
|
|
69
|
+
return toolDefinition({
|
|
70
|
+
name: toolName,
|
|
71
|
+
description: toolDescription,
|
|
72
|
+
inputSchema: z.object({
|
|
73
|
+
query: z.string().min(1).describe('Natural-language query to search for.'),
|
|
74
|
+
}),
|
|
75
|
+
})
|
|
76
|
+
.server(async ({ query }) => {
|
|
77
|
+
const embedResult = await AI.embed(query, { model: embedWith });
|
|
78
|
+
const vector = embedResult.embeddings[0];
|
|
79
|
+
if (!vector || vector.length === 0) {
|
|
80
|
+
throw new Error(`[RudderJS AI] similaritySearch: AI.embed("${query}", { model: "${embedWith}" }) returned no embedding.`);
|
|
81
|
+
}
|
|
82
|
+
const baseQb = model.query();
|
|
83
|
+
const scopedQb = scope ? scope(baseQb) : baseQb;
|
|
84
|
+
const whereVec = scopedQb.whereVectorSimilarTo;
|
|
85
|
+
const selectDist = scopedQb.selectVectorDistance;
|
|
86
|
+
if (typeof whereVec !== 'function' || typeof selectDist !== 'function') {
|
|
87
|
+
throw new Error(`[RudderJS AI] similaritySearch: ${model.name}'s ORM adapter does not implement vector queries. ` +
|
|
88
|
+
'Use @rudderjs/orm-prisma against a Postgres + pgvector connection.');
|
|
89
|
+
}
|
|
90
|
+
const vectorOpts = { metric };
|
|
91
|
+
if (minSimilarity !== undefined)
|
|
92
|
+
vectorOpts.minSimilarity = minSimilarity;
|
|
93
|
+
const filtered = whereVec.call(scopedQb, column, vector, vectorOpts);
|
|
94
|
+
const projected = selectDist.call(filtered, column, vector, SIMILARITY_DISTANCE_ALIAS);
|
|
95
|
+
const rows = await projected.limit(limit).get();
|
|
96
|
+
return rows.map((row) => {
|
|
97
|
+
const distance = readDistance(row);
|
|
98
|
+
return { row, similarity: 1 - distance };
|
|
99
|
+
});
|
|
100
|
+
})
|
|
101
|
+
.modelOutput((results) => {
|
|
102
|
+
if (results.length === 0) {
|
|
103
|
+
return `No similar ${model.name} records found.`;
|
|
104
|
+
}
|
|
105
|
+
if (projectResult) {
|
|
106
|
+
return results
|
|
107
|
+
.map(({ row, similarity }) => projectResult(row, similarity))
|
|
108
|
+
.join('\n');
|
|
109
|
+
}
|
|
110
|
+
return results
|
|
111
|
+
.map(({ row, similarity }) => {
|
|
112
|
+
const json = serializeRow(row);
|
|
113
|
+
return `(${similarity.toFixed(2)}) ${json}`;
|
|
114
|
+
})
|
|
115
|
+
.join('\n');
|
|
116
|
+
});
|
|
117
|
+
}
|
|
118
|
+
function readDistance(row) {
|
|
119
|
+
if (row === null || typeof row !== 'object')
|
|
120
|
+
return 0;
|
|
121
|
+
const raw = row[SIMILARITY_DISTANCE_ALIAS];
|
|
122
|
+
const n = typeof raw === 'number' ? raw : Number(raw);
|
|
123
|
+
return Number.isFinite(n) ? n : 0;
|
|
124
|
+
}
|
|
125
|
+
function serializeRow(row) {
|
|
126
|
+
if (row === null || typeof row !== 'object')
|
|
127
|
+
return JSON.stringify(row);
|
|
128
|
+
const candidate = row;
|
|
129
|
+
const toJSON = candidate.toJSON;
|
|
130
|
+
const data = typeof toJSON === 'function'
|
|
131
|
+
? toJSON.call(candidate)
|
|
132
|
+
: sanitizeRow(row);
|
|
133
|
+
return JSON.stringify(data);
|
|
134
|
+
}
|
|
135
|
+
/**
|
|
136
|
+
* Strip the internal distance alias from rows whose `toJSON` we can't
|
|
137
|
+
* call (plain objects, fakes). `toJSON()`-bearing Models already
|
|
138
|
+
* filter their own internal fields.
|
|
139
|
+
*/
|
|
140
|
+
function sanitizeRow(row) {
|
|
141
|
+
if (!(SIMILARITY_DISTANCE_ALIAS in row))
|
|
142
|
+
return row;
|
|
143
|
+
const { [SIMILARITY_DISTANCE_ALIAS]: _, ...rest } = row;
|
|
144
|
+
void _;
|
|
145
|
+
return rest;
|
|
146
|
+
}
|
|
147
|
+
//# sourceMappingURL=similarity-search.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"similarity-search.js","sourceRoot":"","sources":["../src/similarity-search.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AAEH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AACvB,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAA;AAC1C,OAAO,EAAE,EAAE,EAAE,MAAM,aAAa,CAAA;AAoIhC,8DAA8D;AAC9D,MAAM,yBAAyB,GAAG,kCAAkC,CAAA;AAEpE;;;GAGG;AACH,MAAM,UAAU,gBAAgB,CAC9B,IAAwC;IAExC,MAAM,EACJ,KAAK,EACL,MAAM,EACN,SAAS,EACT,MAAM,GAAG,QAAQ,EACjB,aAAa,EACb,KAAK,GAAG,EAAE,EACV,IAAI,EACJ,WAAW,EACX,aAAa,EACb,KAAK,GACN,GAAG,IAAI,CAAA;IAER,IAAI,CAAC,SAAS,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE,CAAC;QAChD,MAAM,IAAI,KAAK,CACb,iGAAiG;YACjG,oHAAoH,CACrH,CAAA;IACH,CAAC;IACD,IAAI,CAAC,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;QAC1C,MAAM,IAAI,KAAK,CAAC,8GAA8G,CAAC,CAAA;IACjI,CAAC;IACD,IAAI,CAAC,KAAK,IAAI,OAAO,KAAK,CAAC,KAAK,KAAK,UAAU,EAAE,CAAC;QAChD,MAAM,IAAI,KAAK,CAAC,kGAAkG,CAAC,CAAA;IACrH,CAAC;IACD,IAAI,KAAK,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QAC1C,MAAM,IAAI,KAAK,CAAC,8EAA8E,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IACjH,CAAC;IAED,MAAM,QAAQ,GAAG,IAAI,IAAI,qBAAqB,KAAK,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,CAAA;IACxE,MAAM,eAAe,GAAG,WAAW,IAAI,wBAAwB,KAAK,CAAC,IAAI,yFAAyF,CAAA;IAElK,OAAO,cAAc,CAAC;QACpB,IAAI,EAAS,QAAQ;QACrB,WAAW,EAAE,eAAe;QAC5B,WAAW,EAAE,CAAC,CAAC,MAAM,CAAC;YACpB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,uCAAuC,CAAC;SAC3E,CAAC;KACH,CAAC;SACC,MAAM,CAAC,KAAK,EAAE,EAAE,KAAK,EAAE,EAAuC,EAAE;QAC/D,MAAM,WAAW,GAAG,MAAM,EAAE,CAAC,KAAK,CAAC,KAAK,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAA;QAC/D,MAAM,MAAM,GAAG,WAAW,CAAC,UAAU,CAAC,CAAC,CAAC,CAAA;QACxC,IAAI,CAAC,MAAM,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACnC,MAAM,IAAI,KAAK,CACb,6CAA6C,KAAK,gBAAgB,SAAS,6BAA6B,CACzG,CAAA;QACH,CAAC;QAED,MAAM,MAAM,GAAG,KAAK,CAAC,KAAK,EAAE,CAAA;QAC5B,MAAM,QAAQ,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAA;QAC/C,MAAM,QAAQ,GAAG,QAAQ,CAAC,oBAAoB,CAAA;QAC9C,MAAM,UAAU,GAAG,QAAQ,CAAC,oBAAoB,CAAA;QAChD,IAAI,OAAO,QAAQ,KAAK,UAAU,IAAI,OAAO,UAAU,KAAK,UAAU,EAAE,CAAC;YACvE,MAAM,IAAI,KAAK,CACb,mCAAmC,KAAK,CAAC,IAAI,oDAAoD;gBACjG,oEAAoE,CACrE,CAAA;QACH,CAAC;QAED,MAAM,UAAU,GAA0E,EAAE,MAAM,EAAE,CAAA;QACpG,IAAI,aAAa,KAAK,SAAS;YAAE,UAAU,CAAC,aAAa,GAAG,aAAa,CAAA;QAEzE,MAAM,QAAQ,GAAG,QAAQ,CAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,CAAC,CAAA;QACpE,MAAM,SAAS,GAAG,UAAU,CAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,yBAAyB,CAAC,CAAA;QACtF,MAAM,IAAI,GAAG,MAAM,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,CAAA;QAE/C,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAA4B,EAAE;YAChD,MAAM,QAAQ,GAAG,YAAY,CAAC,GAAG,CAAC,CAAA;YAClC,OAAO,EAAE,GAAG,EAAE,UAAU,EAAE,CAAC,GAAG,QAAQ,EAAE,CAAA;QAC1C,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC;SACD,WAAW,CAAC,CAAC,OAAO,EAAE,EAAE;QACvB,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACzB,OAAO,cAAc,KAAK,CAAC,IAAI,iBAAiB,CAAA;QAClD,CAAC;QAED,IAAI,aAAa,EAAE,CAAC;YAClB,OAAO,OAAO;iBACX,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC,aAAa,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC;iBAC5D,IAAI,CAAC,IAAI,CAAC,CAAA;QACf,CAAC;QAED,OAAO,OAAO;aACX,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,UAAU,EAAE,EAAE,EAAE;YAC3B,MAAM,IAAI,GAAG,YAAY,CAAC,GAAG,CAAC,CAAA;YAC9B,OAAO,IAAI,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,IAAI,EAAE,CAAA;QAC7C,CAAC,CAAC;aACD,IAAI,CAAC,IAAI,CAAC,CAAA;IACf,CAAC,CAAC,CAAA;AACN,CAAC;AAED,SAAS,YAAY,CAAC,GAAY;IAChC,IAAI,GAAG,KAAK,IAAI,IAAI,OAAO,GAAG,KAAK,QAAQ;QAAE,OAAO,CAAC,CAAA;IACrD,MAAM,GAAG,GAAI,GAA+B,CAAC,yBAAyB,CAAC,CAAA;IACvE,MAAM,CAAC,GAAG,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;IACrD,OAAO,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;AACnC,CAAC;AAED,SAAS,YAAY,CAAC,GAAY;IAChC,IAAI,GAAG,KAAK,IAAI,IAAI,OAAO,GAAG,KAAK,QAAQ;QAAE,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAA;IACvE,MAAM,SAAS,GAAG,GAAiC,CAAA;IACnD,MAAM,MAAM,GAAG,SAAS,CAAC,MAAM,CAAA;IAC/B,MAAM,IAAI,GAAG,OAAO,MAAM,KAAK,UAAU;QACvC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC;QACxB,CAAC,CAAC,WAAW,CAAC,GAA8B,CAAC,CAAA;IAC/C,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAA;AAC7B,CAAC;AAED;;;;GAIG;AACH,SAAS,WAAW,CAAC,GAA4B;IAC/C,IAAI,CAAC,CAAC,yBAAyB,IAAI,GAAG,CAAC;QAAE,OAAO,GAAG,CAAA;IACnD,MAAM,EAAE,CAAC,yBAAyB,CAAC,EAAE,CAAC,EAAE,GAAG,IAAI,EAAE,GAAG,GAAG,CAAA;IACvD,KAAK,CAAC,CAAA;IACN,OAAO,IAAI,CAAA;AACb,CAAC"}
|
|
@@ -1,4 +1,16 @@
|
|
|
1
|
-
import type { AiMessage } from './types.js';
|
|
1
|
+
import type { AiMessage, ToolCall } from './types.js';
|
|
2
|
+
/**
|
|
3
|
+
* Discriminator for the kind of pause a snapshot represents. Determines
|
|
4
|
+
* what payload `Agent.resumeAsTool` expects on continuation:
|
|
5
|
+
*
|
|
6
|
+
* - `'client_tool'` — resume must carry one tool-result per id in
|
|
7
|
+
* `pendingToolCallIds`. This is the original v1.4 behaviour and the
|
|
8
|
+
* default when the field is absent.
|
|
9
|
+
* - `'approval'` — resume must carry `approvedToolCallIds` and/or
|
|
10
|
+
* `rejectedToolCallIds` covering the single id in `pendingToolCallIds`
|
|
11
|
+
* (the inner approval-gated tool call).
|
|
12
|
+
*/
|
|
13
|
+
export type SubAgentPauseKind = 'client_tool' | 'approval';
|
|
2
14
|
/**
|
|
3
15
|
* Snapshot of a paused sub-agent run, persisted between an
|
|
4
16
|
* {@link Agent.asTool} pause and an {@link Agent.resumeAsTool} resume.
|
|
@@ -6,17 +18,42 @@ import type { AiMessage } from './types.js';
|
|
|
6
18
|
* The shape is intentionally simple — `messages` is the full inner
|
|
7
19
|
* conversation up to the pause point (system prompt + user input +
|
|
8
20
|
* every interleaved tool result), so resume only needs to append the
|
|
9
|
-
* incoming client-tool results
|
|
21
|
+
* incoming client-tool results (or inject approval decisions) and
|
|
22
|
+
* re-enter the loop in `messages` mode.
|
|
10
23
|
*/
|
|
11
24
|
export interface SubAgentRunSnapshot {
|
|
12
25
|
/** Inner-agent message history at suspend time. */
|
|
13
26
|
messages: AiMessage[];
|
|
14
|
-
/**
|
|
27
|
+
/**
|
|
28
|
+
* Tool-call ids the sub-agent is waiting on.
|
|
29
|
+
*
|
|
30
|
+
* - `pauseKind === 'client_tool'` (default): one entry per client tool
|
|
31
|
+
* the inner loop surfaced; resume appends one result per id.
|
|
32
|
+
* - `pauseKind === 'approval'`: a single entry for the approval-gated
|
|
33
|
+
* tool call; resume injects the id into `approvedToolCallIds`
|
|
34
|
+
* (or `rejectedToolCallIds`).
|
|
35
|
+
*/
|
|
15
36
|
pendingToolCallIds: string[];
|
|
16
37
|
/** Total steps the inner agent has executed across all suspends so far. */
|
|
17
38
|
stepsSoFar: number;
|
|
18
39
|
/** Total prompt+completion tokens accumulated across all suspends. */
|
|
19
40
|
tokensSoFar: number;
|
|
41
|
+
/**
|
|
42
|
+
* Discriminator for the resume contract. Defaults to `'client_tool'`
|
|
43
|
+
* when absent so older v1.4 snapshots remain readable on disk/redis
|
|
44
|
+
* after the host upgrades to a version that knows about approval pauses.
|
|
45
|
+
*/
|
|
46
|
+
pauseKind?: SubAgentPauseKind;
|
|
47
|
+
/**
|
|
48
|
+
* Approval pauses only. The full pending tool-call payload (name + args
|
|
49
|
+
* + id) so a renderer can show "approve `delete_user(id=42)`?" without
|
|
50
|
+
* round-tripping back to the inner agent. Mirrors the structure of
|
|
51
|
+
* `AgentResponse.pendingApprovalToolCall`.
|
|
52
|
+
*/
|
|
53
|
+
pendingApprovalToolCall?: {
|
|
54
|
+
toolCall: ToolCall;
|
|
55
|
+
isClientTool: boolean;
|
|
56
|
+
};
|
|
20
57
|
/**
|
|
21
58
|
* Opaque metadata the host can pass through. The framework treats
|
|
22
59
|
* this as JSON and never reads it — useful for hosts that need to
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"sub-agent-run-store.d.ts","sourceRoot":"","sources":["../src/sub-agent-run-store.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,YAAY,CAAA;
|
|
1
|
+
{"version":3,"file":"sub-agent-run-store.d.ts","sourceRoot":"","sources":["../src/sub-agent-run-store.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAA;AAErD;;;;;;;;;;GAUG;AACH,MAAM,MAAM,iBAAiB,GAAG,aAAa,GAAG,UAAU,CAAA;AAE1D;;;;;;;;;GASG;AACH,MAAM,WAAW,mBAAmB;IAClC,mDAAmD;IACnD,QAAQ,EAAY,SAAS,EAAE,CAAA;IAC/B;;;;;;;;OAQG;IACH,kBAAkB,EAAE,MAAM,EAAE,CAAA;IAC5B,2EAA2E;IAC3E,UAAU,EAAU,MAAM,CAAA;IAC1B,sEAAsE;IACtE,WAAW,EAAS,MAAM,CAAA;IAC1B;;;;OAIG;IACH,SAAS,CAAC,EAAU,iBAAiB,CAAA;IACrC;;;;;OAKG;IACH,uBAAuB,CAAC,EAAE;QAAE,QAAQ,EAAE,QAAQ,CAAC;QAAC,YAAY,EAAE,OAAO,CAAA;KAAE,CAAA;IACvE;;;;;OAKG;IACH,IAAI,CAAC,EAAE,OAAO,CAAA;CACf;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,WAAW,gBAAgB;IAC/B,4EAA4E;IAC5E,KAAK,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IACrE;;;;OAIG;IACH,OAAO,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,GAAG,IAAI,CAAC,CAAA;CAC/D;AAID;;;;GAIG;AACH,qBAAa,wBAAyB,YAAW,gBAAgB;IAC/D,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAyC;IAE7D,KAAK,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC;IAIrE,OAAO,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,GAAG,IAAI,CAAC;IAOpE,4DAA4D;IAC5D,KAAK,IAAI,IAAI;CAGd;AAID;;;;GAIG;AACH,UAAU,cAAc;IACtB,GAAG,CAAC,CAAC,GAAG,OAAO,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC,CAAA;IAChD,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IACpE,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CACnC;AAED,MAAM,WAAW,6BAA6B;IAC5C;;;;OAIG;IACH,KAAK,CAAC,EAAM,cAAc,CAAA;IAC1B,oEAAoE;IACpE,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,kDAAkD;IAClD,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED;;;;;;;;GAQG;AACH,qBAAa,sBAAuB,YAAW,gBAAgB;IAC7D,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAgB;IAC/C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAa;IACvC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAY;IACvC,OAAO,CAAC,aAAa,CAAC,CAAyB;gBAEnC,IAAI,GAAE,6BAAkC;YAMtC,QAAQ;IAwBhB,KAAK,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC;IAKrE,OAAO,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,GAAG,IAAI,CAAC;CAQrE"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"sub-agent-run-store.js","sourceRoot":"","sources":["../src/sub-agent-run-store.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"sub-agent-run-store.js","sourceRoot":"","sources":["../src/sub-agent-run-store.ts"],"names":[],"mappings":"AAyFA,8DAA8D;AAE9D;;;;GAIG;AACH,MAAM,OAAO,wBAAwB;IAClB,SAAS,GAAG,IAAI,GAAG,EAA+B,CAAA;IAEnE,KAAK,CAAC,KAAK,CAAC,QAAgB,EAAE,QAA6B;QACzD,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAA;IACxC,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,QAAgB;QAC5B,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;QAC7C,IAAI,CAAC,QAAQ;YAAE,OAAO,IAAI,CAAA;QAC1B,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;QAC/B,OAAO,QAAQ,CAAA;IACjB,CAAC;IAED,4DAA4D;IAC5D,KAAK;QACH,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,CAAA;IACxB,CAAC;CACF;AA4BD;;;;;;;;GAQG;AACH,MAAM,OAAO,sBAAsB;IAChB,aAAa,CAAiB;IAC9B,SAAS,CAAa;IACtB,UAAU,CAAY;IAC/B,aAAa,CAA0B;IAE/C,YAAY,OAAsC,EAAE;QAClD,IAAI,IAAI,CAAC,KAAK;YAAE,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,KAAK,CAAA;QAC/C,IAAI,CAAC,SAAS,GAAI,IAAI,CAAC,SAAS,IAAK,4BAA4B,CAAA;QACjE,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,IAAI,CAAC,GAAG,EAAE,CAAA;IAC7C,CAAC;IAEO,KAAK,CAAC,QAAQ;QACpB,IAAI,IAAI,CAAC,aAAa;YAAE,OAAO,IAAI,CAAC,aAAa,CAAA;QACjD,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YACvB,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,aAAa,CAAA;YACvC,OAAO,IAAI,CAAC,aAAa,CAAA;QAC3B,CAAC;QACD,kEAAkE;QAClE,kEAAkE;QAClE,sEAAsE;QACtE,qEAAqE;QACrE,4DAA4D;QAC5D,sDAAsD;QACtD,MAAM,cAAc,GAAG,iBAAiB,CAAA;QACxC,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,kBAAkB,CAAC,cAAc,CAEzD,CAAA;QACD,MAAM,OAAO,GAAG,GAAG,CAAC,aAAa,EAAE,GAAG,EAAE,EAAE,CAAA;QAC1C,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,MAAM,IAAI,KAAK,CAAC,2IAA2I,CAAC,CAAA;QAC9J,CAAC;QACD,IAAI,CAAC,aAAa,GAAG,OAAO,CAAA;QAC5B,OAAO,OAAO,CAAA;IAChB,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,QAAgB,EAAE,QAA6B;QACzD,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,QAAQ,EAAE,CAAA;QACnC,MAAM,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,GAAG,QAAQ,EAAE,QAAQ,EAAE,IAAI,CAAC,UAAU,CAAC,CAAA;IACvE,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,QAAgB;QAC5B,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,QAAQ,EAAE,CAAA;QACnC,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAA;QACrC,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,CAAsB,GAAG,CAAC,CAAA;QAC1D,IAAI,CAAC,QAAQ;YAAE,OAAO,IAAI,CAAA;QAC1B,MAAM,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;QACvB,OAAO,QAAQ,CAAA;IACjB,CAAC;CACF"}
|
package/dist/tool.d.ts
CHANGED
|
@@ -67,6 +67,65 @@ export declare function pauseForClientTools(toolCalls: ToolCall[], resumeHandle?
|
|
|
67
67
|
* {@link pauseForClientTools} or construct the object literal directly.
|
|
68
68
|
*/
|
|
69
69
|
export declare function isPauseForClientToolsChunk(value: unknown): value is PauseForClientToolsChunk;
|
|
70
|
+
/**
|
|
71
|
+
* Control chunk a server tool can `yield` to pause the enclosing agent
|
|
72
|
+
* loop on an APPROVAL gate inside a sub-agent — the sibling of
|
|
73
|
+
* {@link PauseForClientToolsChunk} for the
|
|
74
|
+
* `finishReason === 'tool_approval_required'` case.
|
|
75
|
+
*
|
|
76
|
+
* The agent loop iterating the execute generator recognizes the shape
|
|
77
|
+
* via the reserved `__rudderjs` discriminator, sets
|
|
78
|
+
* `loopCtx.pendingApprovalToolCall` from `toolCall`/`isClientTool`,
|
|
79
|
+
* flips `loopCtx.loopFinishReason = 'tool_approval_required'` and
|
|
80
|
+
* `loopCtx.stopForApproval = true`, and SKIPS the tool_result emission
|
|
81
|
+
* for the yielding tool call — the sub-agent's call stays orphaned in
|
|
82
|
+
* the parent message history until the approve/reject decision arrives
|
|
83
|
+
* via {@link Agent.resumeAsTool}.
|
|
84
|
+
*
|
|
85
|
+
* The optional `resumeHandle` (typically the `subRunId` the wrapper just
|
|
86
|
+
* persisted) is opaque to the framework — tool authors own the lookup.
|
|
87
|
+
*
|
|
88
|
+
* **Primary use case:** a sub-agent surfaced through
|
|
89
|
+
* {@link Agent.asTool} whose model invokes a `.requireApproval(true)`
|
|
90
|
+
* tool. The sub-agent loop emits `pending-approval`, the wrapping
|
|
91
|
+
* `asTool` generator persists a snapshot with `pauseKind: 'approval'`
|
|
92
|
+
* and yields this chunk so the parent loop halts the same way it does
|
|
93
|
+
* for client-tool pauses.
|
|
94
|
+
*
|
|
95
|
+
* Tool authors should construct this via {@link pauseForApproval}, not
|
|
96
|
+
* by hand, so future shape changes stay source-compatible.
|
|
97
|
+
*/
|
|
98
|
+
export interface PauseForApprovalChunk {
|
|
99
|
+
/** Reserved discriminator. Namespaced to avoid colliding with user data. */
|
|
100
|
+
readonly __rudderjs: 'pause_for_approval';
|
|
101
|
+
readonly toolCall: ToolCall;
|
|
102
|
+
/**
|
|
103
|
+
* `true` when the gated call is a client tool (no `execute` on the
|
|
104
|
+
* server side); `false` for a server tool the sub-agent would have
|
|
105
|
+
* run if approval had been granted.
|
|
106
|
+
*/
|
|
107
|
+
readonly isClientTool: boolean;
|
|
108
|
+
readonly resumeHandle?: string;
|
|
109
|
+
}
|
|
110
|
+
/**
|
|
111
|
+
* Construct an approval-pause control chunk for `yield`ing from a server
|
|
112
|
+
* tool's async-generator execute.
|
|
113
|
+
*
|
|
114
|
+
* @example
|
|
115
|
+
* .server(async function* (input, ctx) {
|
|
116
|
+
* const subRunId = await persistSubRunState(...)
|
|
117
|
+
* yield pauseForApproval(innerToolCall, isClientTool, subRunId)
|
|
118
|
+
* return undefined as never
|
|
119
|
+
* })
|
|
120
|
+
*/
|
|
121
|
+
export declare function pauseForApproval(toolCall: ToolCall, isClientTool: boolean, resumeHandle?: string): PauseForApprovalChunk;
|
|
122
|
+
/**
|
|
123
|
+
* Structural typeguard for an approval-pause chunk. Mirrors
|
|
124
|
+
* {@link isPauseForClientToolsChunk} so the parent loop can recognize a
|
|
125
|
+
* pause without forcing tool authors to import any `@rudderjs/ai` symbol
|
|
126
|
+
* at the yield site.
|
|
127
|
+
*/
|
|
128
|
+
export declare function isPauseForApprovalChunk(value: unknown): value is PauseForApprovalChunk;
|
|
70
129
|
/**
|
|
71
130
|
* Builder returned by {@link toolDefinition}. The builder itself is a valid
|
|
72
131
|
* `Tool` — call `.server(execute)` to attach a server-side handler, or use
|
package/dist/tool.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"tool.d.ts","sourceRoot":"","sources":["../src/tool.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAE5B,OAAO,KAAK,EACV,IAAI,EACJ,QAAQ,EACR,eAAe,EACf,qBAAqB,EACrB,oBAAoB,EACpB,aAAa,EACd,MAAM,YAAY,CAAA;AAInB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AACH,MAAM,WAAW,wBAAwB;IACvC,4EAA4E;IAC5E,QAAQ,CAAC,UAAU,EAAE,wBAAwB,CAAA;IAC7C,QAAQ,CAAC,SAAS,EAAG,QAAQ,EAAE,CAAA;IAC/B,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAA;CAC/B;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,mBAAmB,CACjC,SAAS,EAAE,QAAQ,EAAE,EACrB,YAAY,CAAC,EAAE,MAAM,GACpB,wBAAwB,CAK1B;AAED;;;;;GAKG;AACH,wBAAgB,0BAA0B,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,wBAAwB,CAI5F;AAED;;;;GAIG;AACH,qBAAa,WAAW,CACtB,MAAM,SAAS,CAAC,CAAC,OAAO,GAAG,CAAC,CAAC,OAAO,EACpC,OAAO,SAAS,CAAC,CAAC,OAAO,GAAG,CAAC,CAAC,OAAO,CACrC,YAAW,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,KAAK,CAAC;IACvC,QAAQ,CAAC,OAAO,EAAE,qBAAqB,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACxD,QAAQ,CAAC,UAAU,EAAE,qBAAqB,CAAA;IAE1C,2EAA2E;IAC3E,QAAQ,CAAC,OAAO,CAAC,EAAE,SAAS,CAAA;gBAEhB,OAAO,EAAE,qBAAqB,CAAC,MAAM,EAAE,OAAO,CAAC;IAK3D;;;;;;;;;OASG;IAQH,MAAM,CAAC,OAAO,GAAG,OAAO,EAAE,OAAO,GAAG,OAAO,EACzC,OAAO,EAAE,CAAC,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,GAAG,CAAC,EAAE,eAAe,KAAK,cAAc,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,GACjG,iBAAiB,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC;IAC9C,MAAM,CAAC,OAAO,GAAG,OAAO,EACtB,OAAO,EAAE,CAAC,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,GAAG,CAAC,EAAE,eAAe,KAAK,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,GACrF,iBAAiB,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC;IAU9C,sDAAsD;IACtD,QAAQ,IAAI,oBAAoB;
|
|
1
|
+
{"version":3,"file":"tool.d.ts","sourceRoot":"","sources":["../src/tool.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAE5B,OAAO,KAAK,EACV,IAAI,EACJ,QAAQ,EACR,eAAe,EACf,qBAAqB,EACrB,oBAAoB,EACpB,aAAa,EACd,MAAM,YAAY,CAAA;AAInB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AACH,MAAM,WAAW,wBAAwB;IACvC,4EAA4E;IAC5E,QAAQ,CAAC,UAAU,EAAE,wBAAwB,CAAA;IAC7C,QAAQ,CAAC,SAAS,EAAG,QAAQ,EAAE,CAAA;IAC/B,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAA;CAC/B;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,mBAAmB,CACjC,SAAS,EAAE,QAAQ,EAAE,EACrB,YAAY,CAAC,EAAE,MAAM,GACpB,wBAAwB,CAK1B;AAED;;;;;GAKG;AACH,wBAAgB,0BAA0B,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,wBAAwB,CAI5F;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,WAAW,qBAAqB;IACpC,4EAA4E;IAC5E,QAAQ,CAAC,UAAU,EAAE,oBAAoB,CAAA;IACzC,QAAQ,CAAC,QAAQ,EAAK,QAAQ,CAAA;IAC9B;;;;OAIG;IACH,QAAQ,CAAC,YAAY,EAAE,OAAO,CAAA;IAC9B,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAA;CAC/B;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,gBAAgB,CAC9B,QAAQ,EAAM,QAAQ,EACtB,YAAY,EAAE,OAAO,EACrB,YAAY,CAAC,EAAE,MAAM,GACpB,qBAAqB,CAKvB;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,qBAAqB,CAStF;AAED;;;;GAIG;AACH,qBAAa,WAAW,CACtB,MAAM,SAAS,CAAC,CAAC,OAAO,GAAG,CAAC,CAAC,OAAO,EACpC,OAAO,SAAS,CAAC,CAAC,OAAO,GAAG,CAAC,CAAC,OAAO,CACrC,YAAW,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,KAAK,CAAC;IACvC,QAAQ,CAAC,OAAO,EAAE,qBAAqB,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACxD,QAAQ,CAAC,UAAU,EAAE,qBAAqB,CAAA;IAE1C,2EAA2E;IAC3E,QAAQ,CAAC,OAAO,CAAC,EAAE,SAAS,CAAA;gBAEhB,OAAO,EAAE,qBAAqB,CAAC,MAAM,EAAE,OAAO,CAAC;IAK3D;;;;;;;;;OASG;IAQH,MAAM,CAAC,OAAO,GAAG,OAAO,EAAE,OAAO,GAAG,OAAO,EACzC,OAAO,EAAE,CAAC,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,GAAG,CAAC,EAAE,eAAe,KAAK,cAAc,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,GACjG,iBAAiB,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC;IAC9C,MAAM,CAAC,OAAO,GAAG,OAAO,EACtB,OAAO,EAAE,CAAC,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,GAAG,CAAC,EAAE,eAAe,KAAK,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,GACrF,iBAAiB,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC;IAU9C,sDAAsD;IACtD,QAAQ,IAAI,oBAAoB;CASjC;AAED;;;;;;;GAOG;AACH,qBAAa,iBAAiB,CAAC,MAAM,GAAG,OAAO,EAAE,OAAO,GAAG,OAAO,CAChE,YAAW,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC;IAEhC,QAAQ,CAAC,UAAU,EAAE,qBAAqB,CAAA;IAC1C,QAAQ,CAAC,OAAO,EAAE,aAAa,CAAC,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,CAAA;IACzD,QAAQ,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,OAAO,KAAK,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,SAAS,CAAA;gBAGlF,UAAU,EAAE,qBAAqB,EACjC,OAAO,EAAE,aAAa,CAAC,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,EAChD,aAAa,CAAC,EAAE,CAAC,MAAM,EAAE,OAAO,KAAK,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAO/D;;;;;;;;;OASG;IACH,WAAW,CACT,EAAE,EAAE,CAAC,MAAM,EAAE,OAAO,KAAK,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,GAChD,iBAAiB,CAAC,MAAM,EAAE,OAAO,CAAC;CAGtC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,cAAc,CAC5B,MAAM,SAAS,CAAC,CAAC,OAAO,EACxB,OAAO,SAAS,CAAC,CAAC,OAAO,GAAG,CAAC,CAAC,YAAY,EAC1C,OAAO,EAAE,qBAAqB,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,WAAW,CAAC,MAAM,EAAE,OAAO,CAAC,CAE/E;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,WAAW,CACzB,OAAO,EAAE,qBAAqB,GAC7B,WAAW,CAEb;AAED,0EAA0E;AAC1E,wBAAgB,YAAY,CAAC,IAAI,EAAE;IAAE,UAAU,EAAE,qBAAqB,CAAA;CAAE,GAAG,oBAAoB,CAW9F"}
|
package/dist/tool.js
CHANGED
|
@@ -29,6 +29,38 @@ export function isPauseForClientToolsChunk(value) {
|
|
|
29
29
|
const v = value;
|
|
30
30
|
return v.__rudderjs === 'pause_for_client_tools' && Array.isArray(v.toolCalls);
|
|
31
31
|
}
|
|
32
|
+
/**
|
|
33
|
+
* Construct an approval-pause control chunk for `yield`ing from a server
|
|
34
|
+
* tool's async-generator execute.
|
|
35
|
+
*
|
|
36
|
+
* @example
|
|
37
|
+
* .server(async function* (input, ctx) {
|
|
38
|
+
* const subRunId = await persistSubRunState(...)
|
|
39
|
+
* yield pauseForApproval(innerToolCall, isClientTool, subRunId)
|
|
40
|
+
* return undefined as never
|
|
41
|
+
* })
|
|
42
|
+
*/
|
|
43
|
+
export function pauseForApproval(toolCall, isClientTool, resumeHandle) {
|
|
44
|
+
const chunk = resumeHandle !== undefined
|
|
45
|
+
? { __rudderjs: 'pause_for_approval', toolCall, isClientTool, resumeHandle }
|
|
46
|
+
: { __rudderjs: 'pause_for_approval', toolCall, isClientTool };
|
|
47
|
+
return chunk;
|
|
48
|
+
}
|
|
49
|
+
/**
|
|
50
|
+
* Structural typeguard for an approval-pause chunk. Mirrors
|
|
51
|
+
* {@link isPauseForClientToolsChunk} so the parent loop can recognize a
|
|
52
|
+
* pause without forcing tool authors to import any `@rudderjs/ai` symbol
|
|
53
|
+
* at the yield site.
|
|
54
|
+
*/
|
|
55
|
+
export function isPauseForApprovalChunk(value) {
|
|
56
|
+
if (value === null || typeof value !== 'object')
|
|
57
|
+
return false;
|
|
58
|
+
const v = value;
|
|
59
|
+
return (v.__rudderjs === 'pause_for_approval' &&
|
|
60
|
+
typeof v.toolCall === 'object' &&
|
|
61
|
+
v.toolCall !== null &&
|
|
62
|
+
typeof v.isClientTool === 'boolean');
|
|
63
|
+
}
|
|
32
64
|
/**
|
|
33
65
|
* Builder returned by {@link toolDefinition}. The builder itself is a valid
|
|
34
66
|
* `Tool` — call `.server(execute)` to attach a server-side handler, or use
|
|
@@ -48,11 +80,14 @@ export class ToolBuilder {
|
|
|
48
80
|
}
|
|
49
81
|
/** Convert to provider-friendly JSON Schema format */
|
|
50
82
|
toSchema() {
|
|
51
|
-
|
|
83
|
+
const schema = {
|
|
52
84
|
name: this.options.name,
|
|
53
85
|
description: this.options.description,
|
|
54
|
-
parameters: zodToJsonSchema(this.options.inputSchema),
|
|
86
|
+
parameters: this.options.jsonSchema ?? zodToJsonSchema(this.options.inputSchema),
|
|
55
87
|
};
|
|
88
|
+
if (this.options.providerHint)
|
|
89
|
+
schema.providerHint = this.options.providerHint;
|
|
90
|
+
return schema;
|
|
56
91
|
}
|
|
57
92
|
}
|
|
58
93
|
/**
|
|
@@ -125,10 +160,16 @@ export function dynamicTool(options) {
|
|
|
125
160
|
}
|
|
126
161
|
/** Convert any Tool to a ToolDefinitionSchema for provider consumption */
|
|
127
162
|
export function toolToSchema(tool) {
|
|
128
|
-
|
|
163
|
+
const schema = {
|
|
129
164
|
name: tool.definition.name,
|
|
130
165
|
description: tool.definition.description,
|
|
131
|
-
parameters: zodToJsonSchema(tool.definition.inputSchema),
|
|
166
|
+
parameters: tool.definition.jsonSchema ?? zodToJsonSchema(tool.definition.inputSchema),
|
|
132
167
|
};
|
|
168
|
+
// Propagate provider-specific hints so adapters that recognize the
|
|
169
|
+
// `providerHint.type` can substitute their native tool block (see
|
|
170
|
+
// `toAnthropicTools` for computer-use, `toOpenAITools` for file-search).
|
|
171
|
+
if (tool.definition.providerHint)
|
|
172
|
+
schema.providerHint = tool.definition.providerHint;
|
|
173
|
+
return schema;
|
|
133
174
|
}
|
|
134
175
|
//# sourceMappingURL=tool.js.map
|
package/dist/tool.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"tool.js","sourceRoot":"","sources":["../src/tool.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAA;AA4DzD;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,mBAAmB,CACjC,SAAqB,EACrB,YAAqB;IAErB,MAAM,KAAK,GAA6B,YAAY,KAAK,SAAS;QAChE,CAAC,CAAC,EAAE,UAAU,EAAE,wBAAwB,EAAE,SAAS,EAAE,YAAY,EAAE;QACnE,CAAC,CAAC,EAAE,UAAU,EAAE,wBAAwB,EAAE,SAAS,EAAE,CAAA;IACvD,OAAO,KAAK,CAAA;AACd,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,0BAA0B,CAAC,KAAc;IACvD,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAA;IAC7D,MAAM,CAAC,GAAG,KAAsD,CAAA;IAChE,OAAO,CAAC,CAAC,UAAU,KAAK,wBAAwB,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAA;AAChF,CAAC;AAED;;;;GAIG;AACH,MAAM,OAAO,WAAW;IAIb,OAAO,CAAwC;IAC/C,UAAU,CAAuB;IAE1C,2EAA2E;IAClE,OAAO,CAAY;IAE5B,YAAY,OAA+C;QACzD,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QACtB,IAAI,CAAC,UAAU,GAAG,OAA2C,CAAA;IAC/D,CAAC;IAyBD,MAAM,CACJ,OAAyD;QAEzD,OAAO,IAAI,iBAAiB,CAC1B,IAAI,CAAC,OAA2C,EAChD,OAA2D,CAC5D,CAAA;IACH,CAAC;IAED,sDAAsD;IACtD,QAAQ;QACN,
|
|
1
|
+
{"version":3,"file":"tool.js","sourceRoot":"","sources":["../src/tool.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAA;AA4DzD;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,mBAAmB,CACjC,SAAqB,EACrB,YAAqB;IAErB,MAAM,KAAK,GAA6B,YAAY,KAAK,SAAS;QAChE,CAAC,CAAC,EAAE,UAAU,EAAE,wBAAwB,EAAE,SAAS,EAAE,YAAY,EAAE;QACnE,CAAC,CAAC,EAAE,UAAU,EAAE,wBAAwB,EAAE,SAAS,EAAE,CAAA;IACvD,OAAO,KAAK,CAAA;AACd,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,0BAA0B,CAAC,KAAc;IACvD,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAA;IAC7D,MAAM,CAAC,GAAG,KAAsD,CAAA;IAChE,OAAO,CAAC,CAAC,UAAU,KAAK,wBAAwB,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAA;AAChF,CAAC;AA2CD;;;;;;;;;;GAUG;AACH,MAAM,UAAU,gBAAgB,CAC9B,QAAsB,EACtB,YAAqB,EACrB,YAAqB;IAErB,MAAM,KAAK,GAA0B,YAAY,KAAK,SAAS;QAC7D,CAAC,CAAC,EAAE,UAAU,EAAE,oBAAoB,EAAE,QAAQ,EAAE,YAAY,EAAE,YAAY,EAAE;QAC5E,CAAC,CAAC,EAAE,UAAU,EAAE,oBAAoB,EAAE,QAAQ,EAAE,YAAY,EAAE,CAAA;IAChE,OAAO,KAAK,CAAA;AACd,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,uBAAuB,CAAC,KAAc;IACpD,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAA;IAC7D,MAAM,CAAC,GAAG,KAA6E,CAAA;IACvF,OAAO,CACL,CAAC,CAAC,UAAU,KAAK,oBAAoB;QACrC,OAAO,CAAC,CAAC,QAAQ,KAAK,QAAQ;QAC9B,CAAC,CAAC,QAAQ,KAAK,IAAI;QACnB,OAAO,CAAC,CAAC,YAAY,KAAK,SAAS,CACpC,CAAA;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,OAAO,WAAW;IAIb,OAAO,CAAwC;IAC/C,UAAU,CAAuB;IAE1C,2EAA2E;IAClE,OAAO,CAAY;IAE5B,YAAY,OAA+C;QACzD,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QACtB,IAAI,CAAC,UAAU,GAAG,OAA2C,CAAA;IAC/D,CAAC;IAyBD,MAAM,CACJ,OAAyD;QAEzD,OAAO,IAAI,iBAAiB,CAC1B,IAAI,CAAC,OAA2C,EAChD,OAA2D,CAC5D,CAAA;IACH,CAAC;IAED,sDAAsD;IACtD,QAAQ;QACN,MAAM,MAAM,GAAyB;YACnC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI;YACvB,WAAW,EAAE,IAAI,CAAC,OAAO,CAAC,WAAW;YACrC,UAAU,EAAE,IAAI,CAAC,OAAO,CAAC,UAAU,IAAI,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC;SACjF,CAAA;QACD,IAAI,IAAI,CAAC,OAAO,CAAC,YAAY;YAAE,MAAM,CAAC,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,CAAA;QAC9E,OAAO,MAAM,CAAA;IACf,CAAC;CACF;AAED;;;;;;;GAOG;AACH,MAAM,OAAO,iBAAiB;IAGnB,UAAU,CAAuB;IACjC,OAAO,CAAyC;IAChD,aAAa,CAA8D;IAEpF,YACE,UAAiC,EACjC,OAAgD,EAChD,aAA6D;QAE7D,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;QAC5B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QACtB,IAAI,aAAa;YAAE,IAAI,CAAC,aAAa,GAAG,aAAa,CAAA;IACvD,CAAC;IAED;;;;;;;;;OASG;IACH,WAAW,CACT,EAAiD;QAEjD,OAAO,IAAI,iBAAiB,CAAkB,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,OAAO,EAAE,EAAE,CAAC,CAAA;IAClF,CAAC;CACF;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,cAAc,CAG5B,OAA+C;IAC/C,OAAO,IAAI,WAAW,CAAC,OAAO,CAAC,CAAA;AACjC,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,WAAW,CACzB,OAA8B;IAE9B,OAAO,IAAI,WAAW,CAAC,OAAsD,CAAC,CAAA;AAChF,CAAC;AAED,0EAA0E;AAC1E,MAAM,UAAU,YAAY,CAAC,IAA2C;IACtE,MAAM,MAAM,GAAyB;QACnC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,IAAI;QAC1B,WAAW,EAAE,IAAI,CAAC,UAAU,CAAC,WAAW;QACxC,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,UAAU,IAAI,eAAe,CAAC,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC;KACvF,CAAA;IACD,mEAAmE;IACnE,kEAAkE;IAClE,yEAAyE;IACzE,IAAI,IAAI,CAAC,UAAU,CAAC,YAAY;QAAE,MAAM,CAAC,YAAY,GAAG,IAAI,CAAC,UAAU,CAAC,YAAY,CAAA;IACpF,OAAO,MAAM,CAAA;AACf,CAAC"}
|