@robosystems/client 1.12.1 → 1.13.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/artifacts/OperationClient.d.ts +2 -0
- package/artifacts/OperationClient.ts +3 -0
- package/artifacts/OperatorClient.d.ts +39 -17
- package/artifacts/OperatorClient.js +171 -123
- package/artifacts/OperatorClient.ts +229 -165
- package/artifacts/QueryClient.d.ts +2 -0
- package/artifacts/QueryClient.ts +3 -0
- package/artifacts/SSEClient.d.ts +26 -0
- package/artifacts/SSEClient.js +28 -2
- package/artifacts/SSEClient.ts +51 -3
- package/artifacts/hooks.js +5 -0
- package/artifacts/hooks.ts +5 -0
- package/artifacts/index.d.ts +6 -4
- package/artifacts/index.js +10 -5
- package/artifacts/index.ts +15 -8
- package/package.json +1 -1
- package/sdk/sdk.gen.d.ts +2 -2
- package/sdk/sdk.gen.js +2 -2
- package/sdk/sdk.gen.ts +2 -2
- package/sdk/types.gen.d.ts +1 -1
- package/sdk/types.gen.ts +1 -1
- package/sdk.gen.d.ts +2 -2
- package/sdk.gen.js +2 -2
- package/sdk.gen.ts +2 -2
- package/types.gen.d.ts +1 -1
- package/types.gen.ts +1 -1
package/artifacts/hooks.js
CHANGED
|
@@ -45,6 +45,7 @@ function useQuery(graphId) {
|
|
|
45
45
|
credentials: sdkConfig.credentials,
|
|
46
46
|
headers: sdkConfig.headers,
|
|
47
47
|
token,
|
|
48
|
+
tokenProvider: sdkConfig.tokenProvider,
|
|
48
49
|
});
|
|
49
50
|
return () => {
|
|
50
51
|
clientRef.current?.close();
|
|
@@ -122,6 +123,7 @@ function useStreamingQuery(graphId) {
|
|
|
122
123
|
credentials: sdkConfig.credentials,
|
|
123
124
|
headers: sdkConfig.headers,
|
|
124
125
|
token: sdkConfig.token,
|
|
126
|
+
tokenProvider: sdkConfig.tokenProvider,
|
|
125
127
|
});
|
|
126
128
|
return () => {
|
|
127
129
|
clientRef.current?.close();
|
|
@@ -201,6 +203,7 @@ function useOperation(operationId) {
|
|
|
201
203
|
baseUrl: sdkConfig.baseUrl || clientConfig.baseUrl || 'http://localhost:8000',
|
|
202
204
|
credentials: sdkConfig.credentials,
|
|
203
205
|
token,
|
|
206
|
+
tokenProvider: sdkConfig.tokenProvider,
|
|
204
207
|
maxRetries: sdkConfig.maxRetries,
|
|
205
208
|
retryDelay: sdkConfig.retryDelay,
|
|
206
209
|
});
|
|
@@ -300,6 +303,7 @@ function useMultipleOperations() {
|
|
|
300
303
|
baseUrl: sdkConfig.baseUrl || clientConfig.baseUrl || 'http://localhost:8000',
|
|
301
304
|
credentials: sdkConfig.credentials,
|
|
302
305
|
token,
|
|
306
|
+
tokenProvider: sdkConfig.tokenProvider,
|
|
303
307
|
maxRetries: sdkConfig.maxRetries,
|
|
304
308
|
retryDelay: sdkConfig.retryDelay,
|
|
305
309
|
});
|
|
@@ -368,6 +372,7 @@ function useSDKClients() {
|
|
|
368
372
|
credentials: sdkConfig.credentials,
|
|
369
373
|
headers: sdkConfig.headers,
|
|
370
374
|
token,
|
|
375
|
+
tokenProvider: sdkConfig.tokenProvider,
|
|
371
376
|
};
|
|
372
377
|
const queryClient = new QueryClient_1.QueryClient(baseConfig);
|
|
373
378
|
const operationsClient = new OperationClient_1.OperationClient(baseConfig);
|
package/artifacts/hooks.ts
CHANGED
|
@@ -46,6 +46,7 @@ export function useQuery(graphId: string) {
|
|
|
46
46
|
credentials: sdkConfig.credentials,
|
|
47
47
|
headers: sdkConfig.headers,
|
|
48
48
|
token,
|
|
49
|
+
tokenProvider: sdkConfig.tokenProvider,
|
|
49
50
|
})
|
|
50
51
|
|
|
51
52
|
return () => {
|
|
@@ -143,6 +144,7 @@ export function useStreamingQuery(graphId: string) {
|
|
|
143
144
|
credentials: sdkConfig.credentials,
|
|
144
145
|
headers: sdkConfig.headers,
|
|
145
146
|
token: sdkConfig.token,
|
|
147
|
+
tokenProvider: sdkConfig.tokenProvider,
|
|
146
148
|
})
|
|
147
149
|
|
|
148
150
|
return () => {
|
|
@@ -240,6 +242,7 @@ export function useOperation<T = any>(operationId?: string) {
|
|
|
240
242
|
baseUrl: sdkConfig.baseUrl || clientConfig.baseUrl || 'http://localhost:8000',
|
|
241
243
|
credentials: sdkConfig.credentials,
|
|
242
244
|
token,
|
|
245
|
+
tokenProvider: sdkConfig.tokenProvider,
|
|
243
246
|
maxRetries: sdkConfig.maxRetries,
|
|
244
247
|
retryDelay: sdkConfig.retryDelay,
|
|
245
248
|
})
|
|
@@ -353,6 +356,7 @@ export function useMultipleOperations<T = any>() {
|
|
|
353
356
|
baseUrl: sdkConfig.baseUrl || clientConfig.baseUrl || 'http://localhost:8000',
|
|
354
357
|
credentials: sdkConfig.credentials,
|
|
355
358
|
token,
|
|
359
|
+
tokenProvider: sdkConfig.tokenProvider,
|
|
356
360
|
maxRetries: sdkConfig.maxRetries,
|
|
357
361
|
retryDelay: sdkConfig.retryDelay,
|
|
358
362
|
})
|
|
@@ -439,6 +443,7 @@ export function useSDKClients() {
|
|
|
439
443
|
credentials: sdkConfig.credentials,
|
|
440
444
|
headers: sdkConfig.headers,
|
|
441
445
|
token,
|
|
446
|
+
tokenProvider: sdkConfig.tokenProvider,
|
|
442
447
|
}
|
|
443
448
|
|
|
444
449
|
const queryClient = new QueryClient(baseConfig)
|
package/artifacts/index.d.ts
CHANGED
|
@@ -22,9 +22,12 @@ export interface RoboSystemsClientConfig {
|
|
|
22
22
|
*/
|
|
23
23
|
token?: string;
|
|
24
24
|
/**
|
|
25
|
-
* Dynamic credential callback invoked on every GraphQL request
|
|
26
|
-
* When set, JWT refreshes are picked up
|
|
27
|
-
* to rebuild or clear cached clients after a
|
|
25
|
+
* Dynamic credential callback invoked on every GraphQL request and
|
|
26
|
+
* every SSE connect. When set, JWT refreshes are picked up
|
|
27
|
+
* automatically — no need to rebuild or clear cached clients after a
|
|
28
|
+
* refresh. Browser sessions need this: the backend revokes the previous
|
|
29
|
+
* JWT on each refresh, so a static `token` captured at construction
|
|
30
|
+
* stops opening progress streams the moment the session rotates.
|
|
28
31
|
*/
|
|
29
32
|
tokenProvider?: TokenProvider;
|
|
30
33
|
headers?: Record<string, string>;
|
|
@@ -90,4 +93,3 @@ export declare const monitorOperation: (operationId: string, onProgress?: (progr
|
|
|
90
93
|
export declare const executeQuery: (graphId: string, query: string, parameters?: Record<string, any>) => Promise<import("./QueryClient").QueryResult>;
|
|
91
94
|
export declare const streamQuery: (graphId: string, query: string, parameters?: Record<string, any>, chunkSize?: number) => AsyncIterableIterator<any>;
|
|
92
95
|
export declare const operatorQuery: (graphId: string, message: string, context?: Record<string, any>) => Promise<import("./OperatorClient").OperatorResult>;
|
|
93
|
-
export declare const analyzeFinancials: (graphId: string, message: string) => Promise<import("./OperatorClient").OperatorResult>;
|
package/artifacts/index.js
CHANGED
|
@@ -18,7 +18,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
|
18
18
|
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
19
19
|
};
|
|
20
20
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
21
|
-
exports.
|
|
21
|
+
exports.operatorQuery = exports.streamQuery = exports.executeQuery = exports.monitorOperation = exports.clients = exports.useStreamingQuery = exports.useSDKClients = exports.useQuery = exports.useOperation = exports.useMultipleOperations = exports.SSEClient = exports.QueryClient = exports.OperatorClient = exports.OperationClient = exports.LibraryClient = exports.LedgerClient = exports.InvestorClient = exports.RoboSystemsClients = exports.GraphQLError = exports.DEFAULT_GRAPHQL_TIMEOUT_MS = void 0;
|
|
22
22
|
const client_gen_1 = require("../client.gen");
|
|
23
23
|
const config_1 = require("./config");
|
|
24
24
|
const InvestorClient_1 = require("./InvestorClient");
|
|
@@ -60,27 +60,33 @@ class RoboSystemsClients {
|
|
|
60
60
|
retryDelay: config.retryDelay || 1000,
|
|
61
61
|
timeout: config.timeout,
|
|
62
62
|
};
|
|
63
|
+
// Every client that opens an SSE stream gets the tokenProvider too:
|
|
64
|
+
// the stream endpoint authenticates the JWT from the URL, and a
|
|
65
|
+
// captured static token is dead after the first session refresh.
|
|
63
66
|
this.query = new QueryClient_1.QueryClient({
|
|
64
67
|
baseUrl: this.config.baseUrl,
|
|
65
68
|
credentials: this.config.credentials,
|
|
66
69
|
token: this.config.token,
|
|
70
|
+
tokenProvider: this.config.tokenProvider,
|
|
67
71
|
headers: this.config.headers,
|
|
68
72
|
});
|
|
69
73
|
this.operator = new OperatorClient_1.OperatorClient({
|
|
70
74
|
baseUrl: this.config.baseUrl,
|
|
71
75
|
credentials: this.config.credentials,
|
|
72
76
|
token: this.config.token,
|
|
77
|
+
tokenProvider: this.config.tokenProvider,
|
|
73
78
|
headers: this.config.headers,
|
|
74
79
|
});
|
|
75
80
|
this.operations = new OperationClient_1.OperationClient({
|
|
76
81
|
baseUrl: this.config.baseUrl,
|
|
77
82
|
credentials: this.config.credentials,
|
|
78
83
|
token: this.config.token,
|
|
84
|
+
tokenProvider: this.config.tokenProvider,
|
|
79
85
|
maxRetries: this.config.maxRetries,
|
|
80
86
|
retryDelay: this.config.retryDelay,
|
|
81
87
|
});
|
|
82
|
-
// LedgerClient / InvestorClient use GraphQL internally
|
|
83
|
-
//
|
|
88
|
+
// LedgerClient / InvestorClient / LibraryClient use GraphQL internally
|
|
89
|
+
// and consult the tokenProvider on every request.
|
|
84
90
|
this.ledger = new LedgerClient_1.LedgerClient({
|
|
85
91
|
baseUrl: this.config.baseUrl,
|
|
86
92
|
credentials: this.config.credentials,
|
|
@@ -125,6 +131,7 @@ class RoboSystemsClients {
|
|
|
125
131
|
baseUrl: this.config.baseUrl,
|
|
126
132
|
credentials: this.config.credentials,
|
|
127
133
|
token: this.config.token,
|
|
134
|
+
tokenProvider: this.config.tokenProvider,
|
|
128
135
|
headers: this.config.headers,
|
|
129
136
|
maxRetries: this.config.maxRetries,
|
|
130
137
|
retryDelay: this.config.retryDelay,
|
|
@@ -200,5 +207,3 @@ const streamQuery = (graphId, query, parameters, chunkSize) => getClients().quer
|
|
|
200
207
|
exports.streamQuery = streamQuery;
|
|
201
208
|
const operatorQuery = (graphId, message, context) => getClients().operator.query(graphId, message, context);
|
|
202
209
|
exports.operatorQuery = operatorQuery;
|
|
203
|
-
const analyzeFinancials = (graphId, message) => getClients().operator.analyzeFinancials(graphId, message);
|
|
204
|
-
exports.analyzeFinancials = analyzeFinancials;
|
package/artifacts/index.ts
CHANGED
|
@@ -34,9 +34,12 @@ export interface RoboSystemsClientConfig {
|
|
|
34
34
|
*/
|
|
35
35
|
token?: string
|
|
36
36
|
/**
|
|
37
|
-
* Dynamic credential callback invoked on every GraphQL request
|
|
38
|
-
* When set, JWT refreshes are picked up
|
|
39
|
-
* to rebuild or clear cached clients after a
|
|
37
|
+
* Dynamic credential callback invoked on every GraphQL request and
|
|
38
|
+
* every SSE connect. When set, JWT refreshes are picked up
|
|
39
|
+
* automatically — no need to rebuild or clear cached clients after a
|
|
40
|
+
* refresh. Browser sessions need this: the backend revokes the previous
|
|
41
|
+
* JWT on each refresh, so a static `token` captured at construction
|
|
42
|
+
* stops opening progress streams the moment the session rotates.
|
|
40
43
|
*/
|
|
41
44
|
tokenProvider?: TokenProvider
|
|
42
45
|
headers?: Record<string, string>
|
|
@@ -98,10 +101,14 @@ export class RoboSystemsClients {
|
|
|
98
101
|
timeout: config.timeout,
|
|
99
102
|
}
|
|
100
103
|
|
|
104
|
+
// Every client that opens an SSE stream gets the tokenProvider too:
|
|
105
|
+
// the stream endpoint authenticates the JWT from the URL, and a
|
|
106
|
+
// captured static token is dead after the first session refresh.
|
|
101
107
|
this.query = new QueryClient({
|
|
102
108
|
baseUrl: this.config.baseUrl,
|
|
103
109
|
credentials: this.config.credentials,
|
|
104
110
|
token: this.config.token,
|
|
111
|
+
tokenProvider: this.config.tokenProvider,
|
|
105
112
|
headers: this.config.headers,
|
|
106
113
|
})
|
|
107
114
|
|
|
@@ -109,6 +116,7 @@ export class RoboSystemsClients {
|
|
|
109
116
|
baseUrl: this.config.baseUrl,
|
|
110
117
|
credentials: this.config.credentials,
|
|
111
118
|
token: this.config.token,
|
|
119
|
+
tokenProvider: this.config.tokenProvider,
|
|
112
120
|
headers: this.config.headers,
|
|
113
121
|
})
|
|
114
122
|
|
|
@@ -116,12 +124,13 @@ export class RoboSystemsClients {
|
|
|
116
124
|
baseUrl: this.config.baseUrl,
|
|
117
125
|
credentials: this.config.credentials,
|
|
118
126
|
token: this.config.token,
|
|
127
|
+
tokenProvider: this.config.tokenProvider,
|
|
119
128
|
maxRetries: this.config.maxRetries,
|
|
120
129
|
retryDelay: this.config.retryDelay,
|
|
121
130
|
})
|
|
122
131
|
|
|
123
|
-
// LedgerClient / InvestorClient use GraphQL internally
|
|
124
|
-
//
|
|
132
|
+
// LedgerClient / InvestorClient / LibraryClient use GraphQL internally
|
|
133
|
+
// and consult the tokenProvider on every request.
|
|
125
134
|
this.ledger = new LedgerClient({
|
|
126
135
|
baseUrl: this.config.baseUrl,
|
|
127
136
|
credentials: this.config.credentials,
|
|
@@ -171,6 +180,7 @@ export class RoboSystemsClients {
|
|
|
171
180
|
baseUrl: this.config.baseUrl,
|
|
172
181
|
credentials: this.config.credentials,
|
|
173
182
|
token: this.config.token,
|
|
183
|
+
tokenProvider: this.config.tokenProvider,
|
|
174
184
|
headers: this.config.headers,
|
|
175
185
|
maxRetries: this.config.maxRetries,
|
|
176
186
|
retryDelay: this.config.retryDelay,
|
|
@@ -271,6 +281,3 @@ export const streamQuery = (
|
|
|
271
281
|
|
|
272
282
|
export const operatorQuery = (graphId: string, message: string, context?: Record<string, any>) =>
|
|
273
283
|
getClients().operator.query(graphId, message, context)
|
|
274
|
-
|
|
275
|
-
export const analyzeFinancials = (graphId: string, message: string) =>
|
|
276
|
-
getClients().operator.analyzeFinancials(graphId, message)
|
package/package.json
CHANGED
package/sdk/sdk.gen.d.ts
CHANGED
|
@@ -358,7 +358,7 @@ export declare const listOperators: <ThrowOnError extends boolean = false>(optio
|
|
|
358
358
|
/**
|
|
359
359
|
* Auto-select Operator for Query
|
|
360
360
|
*
|
|
361
|
-
* Routes to the best operator for your query. Operators: `
|
|
361
|
+
* Routes to the best operator for your query. Operators: `analyst` (answers natural-language questions over the graph — curated financial reads, documents, memory, and read-only Cypher; supports `quick`, `standard`, `extended`; `cypher` is accepted as its former name) and `mapping` (autonomous Chart of Accounts → rs-gaap mapping; roboledger graphs only, `extended` only). `GET /v1/graphs/{graph_id}/operator` lists what is registered. Credits are consumed by actual token usage, not a fixed price per mode. The run executes on the background worker: the default answer is 202 with the operation's `_links` (stream, status, cancel); `?mode=sync` waits up to 50s and answers 200 with the result.
|
|
362
362
|
*/
|
|
363
363
|
export declare const autoSelectOperator: <ThrowOnError extends boolean = false>(options: Options<AutoSelectOperatorData, ThrowOnError>) => import("./client").RequestResult<AutoSelectOperatorResponses, AutoSelectOperatorErrors, ThrowOnError, "fields">;
|
|
364
364
|
/**
|
|
@@ -368,7 +368,7 @@ export declare const getOperatorMetadata: <ThrowOnError extends boolean = false>
|
|
|
368
368
|
/**
|
|
369
369
|
* Execute Specific Operator
|
|
370
370
|
*
|
|
371
|
-
* Available: `
|
|
371
|
+
* Available: `analyst` (natural-language questions over the graph — curated financial reads, documents, memory, and read-only Cypher; RAG retrieval is one of its capabilities, not a separate operator; `cypher` is accepted as its former name) and `mapping` (Chart of Accounts → rs-gaap mapping, roboledger graphs only). `GET /v1/graphs/{graph_id}/operator` lists what is registered. The run executes on the background worker: the default answer is 202 with the operation's `_links` (stream, status, cancel); `?mode=sync` waits up to 50s and answers 200 with the result.
|
|
372
372
|
*/
|
|
373
373
|
export declare const executeSpecificOperator: <ThrowOnError extends boolean = false>(options: Options<ExecuteSpecificOperatorData, ThrowOnError>) => import("./client").RequestResult<ExecuteSpecificOperatorResponses, ExecuteSpecificOperatorErrors, ThrowOnError, "fields">;
|
|
374
374
|
/**
|
package/sdk/sdk.gen.js
CHANGED
|
@@ -708,7 +708,7 @@ exports.listOperators = listOperators;
|
|
|
708
708
|
/**
|
|
709
709
|
* Auto-select Operator for Query
|
|
710
710
|
*
|
|
711
|
-
* Routes to the best operator for your query. Operators: `
|
|
711
|
+
* Routes to the best operator for your query. Operators: `analyst` (answers natural-language questions over the graph — curated financial reads, documents, memory, and read-only Cypher; supports `quick`, `standard`, `extended`; `cypher` is accepted as its former name) and `mapping` (autonomous Chart of Accounts → rs-gaap mapping; roboledger graphs only, `extended` only). `GET /v1/graphs/{graph_id}/operator` lists what is registered. Credits are consumed by actual token usage, not a fixed price per mode. The run executes on the background worker: the default answer is 202 with the operation's `_links` (stream, status, cancel); `?mode=sync` waits up to 50s and answers 200 with the result.
|
|
712
712
|
*/
|
|
713
713
|
const autoSelectOperator = (options) => (options.client ?? client_gen_1.client).post({
|
|
714
714
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -732,7 +732,7 @@ exports.getOperatorMetadata = getOperatorMetadata;
|
|
|
732
732
|
/**
|
|
733
733
|
* Execute Specific Operator
|
|
734
734
|
*
|
|
735
|
-
* Available: `
|
|
735
|
+
* Available: `analyst` (natural-language questions over the graph — curated financial reads, documents, memory, and read-only Cypher; RAG retrieval is one of its capabilities, not a separate operator; `cypher` is accepted as its former name) and `mapping` (Chart of Accounts → rs-gaap mapping, roboledger graphs only). `GET /v1/graphs/{graph_id}/operator` lists what is registered. The run executes on the background worker: the default answer is 202 with the operation's `_links` (stream, status, cancel); `?mode=sync` waits up to 50s and answers 200 with the result.
|
|
736
736
|
*/
|
|
737
737
|
const executeSpecificOperator = (options) => (options.client ?? client_gen_1.client).post({
|
|
738
738
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
package/sdk/sdk.gen.ts
CHANGED
|
@@ -720,7 +720,7 @@ export const listOperators = <ThrowOnError extends boolean = false>(options: Opt
|
|
|
720
720
|
/**
|
|
721
721
|
* Auto-select Operator for Query
|
|
722
722
|
*
|
|
723
|
-
* Routes to the best operator for your query. Operators: `
|
|
723
|
+
* Routes to the best operator for your query. Operators: `analyst` (answers natural-language questions over the graph — curated financial reads, documents, memory, and read-only Cypher; supports `quick`, `standard`, `extended`; `cypher` is accepted as its former name) and `mapping` (autonomous Chart of Accounts → rs-gaap mapping; roboledger graphs only, `extended` only). `GET /v1/graphs/{graph_id}/operator` lists what is registered. Credits are consumed by actual token usage, not a fixed price per mode. The run executes on the background worker: the default answer is 202 with the operation's `_links` (stream, status, cancel); `?mode=sync` waits up to 50s and answers 200 with the result.
|
|
724
724
|
*/
|
|
725
725
|
export const autoSelectOperator = <ThrowOnError extends boolean = false>(options: Options<AutoSelectOperatorData, ThrowOnError>) => (options.client ?? client).post<AutoSelectOperatorResponses, AutoSelectOperatorErrors, ThrowOnError>({
|
|
726
726
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -744,7 +744,7 @@ export const getOperatorMetadata = <ThrowOnError extends boolean = false>(option
|
|
|
744
744
|
/**
|
|
745
745
|
* Execute Specific Operator
|
|
746
746
|
*
|
|
747
|
-
* Available: `
|
|
747
|
+
* Available: `analyst` (natural-language questions over the graph — curated financial reads, documents, memory, and read-only Cypher; RAG retrieval is one of its capabilities, not a separate operator; `cypher` is accepted as its former name) and `mapping` (Chart of Accounts → rs-gaap mapping, roboledger graphs only). `GET /v1/graphs/{graph_id}/operator` lists what is registered. The run executes on the background worker: the default answer is 202 with the operation's `_links` (stream, status, cancel); `?mode=sync` waits up to 50s and answers 200 with the result.
|
|
748
748
|
*/
|
|
749
749
|
export const executeSpecificOperator = <ThrowOnError extends boolean = false>(options: Options<ExecuteSpecificOperatorData, ThrowOnError>) => (options.client ?? client).post<ExecuteSpecificOperatorResponses, ExecuteSpecificOperatorErrors, ThrowOnError>({
|
|
750
750
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
package/sdk/types.gen.d.ts
CHANGED
|
@@ -20531,7 +20531,7 @@ export type GetOperatorMetadataData = {
|
|
|
20531
20531
|
/**
|
|
20532
20532
|
* Operator Type
|
|
20533
20533
|
*
|
|
20534
|
-
* Operator type identifier (e.g., '
|
|
20534
|
+
* Operator type identifier (e.g., 'analyst', 'mapping')
|
|
20535
20535
|
*/
|
|
20536
20536
|
operator_type: string;
|
|
20537
20537
|
};
|
package/sdk/types.gen.ts
CHANGED
|
@@ -21301,7 +21301,7 @@ export type GetOperatorMetadataData = {
|
|
|
21301
21301
|
/**
|
|
21302
21302
|
* Operator Type
|
|
21303
21303
|
*
|
|
21304
|
-
* Operator type identifier (e.g., '
|
|
21304
|
+
* Operator type identifier (e.g., 'analyst', 'mapping')
|
|
21305
21305
|
*/
|
|
21306
21306
|
operator_type: string;
|
|
21307
21307
|
};
|
package/sdk.gen.d.ts
CHANGED
|
@@ -358,7 +358,7 @@ export declare const listOperators: <ThrowOnError extends boolean = false>(optio
|
|
|
358
358
|
/**
|
|
359
359
|
* Auto-select Operator for Query
|
|
360
360
|
*
|
|
361
|
-
* Routes to the best operator for your query. Operators: `
|
|
361
|
+
* Routes to the best operator for your query. Operators: `analyst` (answers natural-language questions over the graph — curated financial reads, documents, memory, and read-only Cypher; supports `quick`, `standard`, `extended`; `cypher` is accepted as its former name) and `mapping` (autonomous Chart of Accounts → rs-gaap mapping; roboledger graphs only, `extended` only). `GET /v1/graphs/{graph_id}/operator` lists what is registered. Credits are consumed by actual token usage, not a fixed price per mode. The run executes on the background worker: the default answer is 202 with the operation's `_links` (stream, status, cancel); `?mode=sync` waits up to 50s and answers 200 with the result.
|
|
362
362
|
*/
|
|
363
363
|
export declare const autoSelectOperator: <ThrowOnError extends boolean = false>(options: Options<AutoSelectOperatorData, ThrowOnError>) => import("./client").RequestResult<AutoSelectOperatorResponses, AutoSelectOperatorErrors, ThrowOnError, "fields">;
|
|
364
364
|
/**
|
|
@@ -368,7 +368,7 @@ export declare const getOperatorMetadata: <ThrowOnError extends boolean = false>
|
|
|
368
368
|
/**
|
|
369
369
|
* Execute Specific Operator
|
|
370
370
|
*
|
|
371
|
-
* Available: `
|
|
371
|
+
* Available: `analyst` (natural-language questions over the graph — curated financial reads, documents, memory, and read-only Cypher; RAG retrieval is one of its capabilities, not a separate operator; `cypher` is accepted as its former name) and `mapping` (Chart of Accounts → rs-gaap mapping, roboledger graphs only). `GET /v1/graphs/{graph_id}/operator` lists what is registered. The run executes on the background worker: the default answer is 202 with the operation's `_links` (stream, status, cancel); `?mode=sync` waits up to 50s and answers 200 with the result.
|
|
372
372
|
*/
|
|
373
373
|
export declare const executeSpecificOperator: <ThrowOnError extends boolean = false>(options: Options<ExecuteSpecificOperatorData, ThrowOnError>) => import("./client").RequestResult<ExecuteSpecificOperatorResponses, ExecuteSpecificOperatorErrors, ThrowOnError, "fields">;
|
|
374
374
|
/**
|
package/sdk.gen.js
CHANGED
|
@@ -708,7 +708,7 @@ exports.listOperators = listOperators;
|
|
|
708
708
|
/**
|
|
709
709
|
* Auto-select Operator for Query
|
|
710
710
|
*
|
|
711
|
-
* Routes to the best operator for your query. Operators: `
|
|
711
|
+
* Routes to the best operator for your query. Operators: `analyst` (answers natural-language questions over the graph — curated financial reads, documents, memory, and read-only Cypher; supports `quick`, `standard`, `extended`; `cypher` is accepted as its former name) and `mapping` (autonomous Chart of Accounts → rs-gaap mapping; roboledger graphs only, `extended` only). `GET /v1/graphs/{graph_id}/operator` lists what is registered. Credits are consumed by actual token usage, not a fixed price per mode. The run executes on the background worker: the default answer is 202 with the operation's `_links` (stream, status, cancel); `?mode=sync` waits up to 50s and answers 200 with the result.
|
|
712
712
|
*/
|
|
713
713
|
const autoSelectOperator = (options) => (options.client ?? client_gen_1.client).post({
|
|
714
714
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -732,7 +732,7 @@ exports.getOperatorMetadata = getOperatorMetadata;
|
|
|
732
732
|
/**
|
|
733
733
|
* Execute Specific Operator
|
|
734
734
|
*
|
|
735
|
-
* Available: `
|
|
735
|
+
* Available: `analyst` (natural-language questions over the graph — curated financial reads, documents, memory, and read-only Cypher; RAG retrieval is one of its capabilities, not a separate operator; `cypher` is accepted as its former name) and `mapping` (Chart of Accounts → rs-gaap mapping, roboledger graphs only). `GET /v1/graphs/{graph_id}/operator` lists what is registered. The run executes on the background worker: the default answer is 202 with the operation's `_links` (stream, status, cancel); `?mode=sync` waits up to 50s and answers 200 with the result.
|
|
736
736
|
*/
|
|
737
737
|
const executeSpecificOperator = (options) => (options.client ?? client_gen_1.client).post({
|
|
738
738
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
package/sdk.gen.ts
CHANGED
|
@@ -720,7 +720,7 @@ export const listOperators = <ThrowOnError extends boolean = false>(options: Opt
|
|
|
720
720
|
/**
|
|
721
721
|
* Auto-select Operator for Query
|
|
722
722
|
*
|
|
723
|
-
* Routes to the best operator for your query. Operators: `
|
|
723
|
+
* Routes to the best operator for your query. Operators: `analyst` (answers natural-language questions over the graph — curated financial reads, documents, memory, and read-only Cypher; supports `quick`, `standard`, `extended`; `cypher` is accepted as its former name) and `mapping` (autonomous Chart of Accounts → rs-gaap mapping; roboledger graphs only, `extended` only). `GET /v1/graphs/{graph_id}/operator` lists what is registered. Credits are consumed by actual token usage, not a fixed price per mode. The run executes on the background worker: the default answer is 202 with the operation's `_links` (stream, status, cancel); `?mode=sync` waits up to 50s and answers 200 with the result.
|
|
724
724
|
*/
|
|
725
725
|
export const autoSelectOperator = <ThrowOnError extends boolean = false>(options: Options<AutoSelectOperatorData, ThrowOnError>) => (options.client ?? client).post<AutoSelectOperatorResponses, AutoSelectOperatorErrors, ThrowOnError>({
|
|
726
726
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
|
@@ -744,7 +744,7 @@ export const getOperatorMetadata = <ThrowOnError extends boolean = false>(option
|
|
|
744
744
|
/**
|
|
745
745
|
* Execute Specific Operator
|
|
746
746
|
*
|
|
747
|
-
* Available: `
|
|
747
|
+
* Available: `analyst` (natural-language questions over the graph — curated financial reads, documents, memory, and read-only Cypher; RAG retrieval is one of its capabilities, not a separate operator; `cypher` is accepted as its former name) and `mapping` (Chart of Accounts → rs-gaap mapping, roboledger graphs only). `GET /v1/graphs/{graph_id}/operator` lists what is registered. The run executes on the background worker: the default answer is 202 with the operation's `_links` (stream, status, cancel); `?mode=sync` waits up to 50s and answers 200 with the result.
|
|
748
748
|
*/
|
|
749
749
|
export const executeSpecificOperator = <ThrowOnError extends boolean = false>(options: Options<ExecuteSpecificOperatorData, ThrowOnError>) => (options.client ?? client).post<ExecuteSpecificOperatorResponses, ExecuteSpecificOperatorErrors, ThrowOnError>({
|
|
750
750
|
security: [{ name: 'X-API-Key', type: 'apiKey' }, { scheme: 'bearer', type: 'http' }],
|
package/types.gen.d.ts
CHANGED
|
@@ -20531,7 +20531,7 @@ export type GetOperatorMetadataData = {
|
|
|
20531
20531
|
/**
|
|
20532
20532
|
* Operator Type
|
|
20533
20533
|
*
|
|
20534
|
-
* Operator type identifier (e.g., '
|
|
20534
|
+
* Operator type identifier (e.g., 'analyst', 'mapping')
|
|
20535
20535
|
*/
|
|
20536
20536
|
operator_type: string;
|
|
20537
20537
|
};
|
package/types.gen.ts
CHANGED
|
@@ -21301,7 +21301,7 @@ export type GetOperatorMetadataData = {
|
|
|
21301
21301
|
/**
|
|
21302
21302
|
* Operator Type
|
|
21303
21303
|
*
|
|
21304
|
-
* Operator type identifier (e.g., '
|
|
21304
|
+
* Operator type identifier (e.g., 'analyst', 'mapping')
|
|
21305
21305
|
*/
|
|
21306
21306
|
operator_type: string;
|
|
21307
21307
|
};
|