@tryvira/sdk 0.1.12 → 0.1.14
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/LICENSE +21 -21
- package/README.md +90 -90
- package/dist/index.d.ts +1 -1
- package/dist/index.js +840 -831
- package/dist/js-client.d.ts +416 -407
- package/package.json +18 -18
package/dist/js-client.d.ts
CHANGED
|
@@ -1,407 +1,416 @@
|
|
|
1
|
-
export interface RuntimeRequest {
|
|
2
|
-
organizationId: string;
|
|
3
|
-
projectId: string;
|
|
4
|
-
environmentId: string;
|
|
5
|
-
revisionId: string;
|
|
6
|
-
idempotencyKey: string;
|
|
7
|
-
nonce: string;
|
|
8
|
-
expiresAt: number;
|
|
9
|
-
}
|
|
10
|
-
export interface SdkRequest {
|
|
11
|
-
method: "GET" | "POST" | "DELETE";
|
|
12
|
-
path: string;
|
|
13
|
-
query?: Readonly<Record<string, string>>;
|
|
14
|
-
body?: Readonly<Record<string, unknown>>;
|
|
15
|
-
}
|
|
16
|
-
export type SdkFailureMode = "throw" | "open";
|
|
17
|
-
export interface ViraClientOptions {
|
|
18
|
-
baseUrl: string;
|
|
19
|
-
apiKey?: string;
|
|
20
|
-
fetcher?: typeof fetch;
|
|
21
|
-
timeoutMs?: number;
|
|
22
|
-
retries?: number;
|
|
23
|
-
failureMode?: SdkFailureMode;
|
|
24
|
-
defaultHeaders?: Readonly<Record<string, string>>;
|
|
25
|
-
}
|
|
26
|
-
export interface ViraResponse<T = unknown> {
|
|
27
|
-
status: number;
|
|
28
|
-
body: T;
|
|
29
|
-
requestId: string;
|
|
30
|
-
}
|
|
31
|
-
export interface BehaviorProjection {
|
|
32
|
-
rendered: string;
|
|
33
|
-
projectionDigest: string;
|
|
34
|
-
programDigest: string;
|
|
35
|
-
[key: string]: unknown;
|
|
36
|
-
}
|
|
37
|
-
export interface ProjectionReceipt {
|
|
38
|
-
projectionDigest: string;
|
|
39
|
-
programDigest: string;
|
|
40
|
-
artifactDigest: string;
|
|
41
|
-
receiptDigest: string;
|
|
42
|
-
[key: string]: unknown;
|
|
43
|
-
}
|
|
44
|
-
export interface RuntimeResolution {
|
|
45
|
-
behaviorPoint: string;
|
|
46
|
-
strategySelection?: ClientBody | null;
|
|
47
|
-
behaviorProjection?: BehaviorProjection;
|
|
48
|
-
projectionReceipt?: ProjectionReceipt;
|
|
49
|
-
projectionMode?: "active" | "unavailable" | "not-applicable";
|
|
50
|
-
[key: string]: unknown;
|
|
51
|
-
}
|
|
52
|
-
export interface ConnectOnceResult {
|
|
53
|
-
system: ClientBody;
|
|
54
|
-
connection: ClientBody;
|
|
55
|
-
handshake: ClientBody;
|
|
56
|
-
}
|
|
57
|
-
export interface StrategyContinuationInput {
|
|
58
|
-
authorityDigest?: string;
|
|
59
|
-
state?: Readonly<Record<string, unknown>>;
|
|
60
|
-
references?: Readonly<Record<string, unknown>>;
|
|
61
|
-
}
|
|
62
|
-
export declare class ViraApiError extends Error {
|
|
63
|
-
readonly status: number;
|
|
64
|
-
readonly body: unknown;
|
|
65
|
-
readonly requestId: string;
|
|
66
|
-
constructor(message: string, status: number, body: unknown, requestId: string);
|
|
67
|
-
}
|
|
68
|
-
type ClientBody = Record<string, unknown>;
|
|
69
|
-
type ClientObservation = {
|
|
70
|
-
eventId: string;
|
|
71
|
-
eventType: string;
|
|
72
|
-
aiSystemId: string;
|
|
73
|
-
connectionId: string;
|
|
74
|
-
[key: string]: unknown;
|
|
75
|
-
};
|
|
76
|
-
/** Small, authority-aware client over the existing versioned control API. */
|
|
77
|
-
export declare class ViraClient {
|
|
78
|
-
private readonly baseUrl;
|
|
79
|
-
private readonly apiKey?;
|
|
80
|
-
private readonly fetcher;
|
|
81
|
-
private readonly timeoutMs;
|
|
82
|
-
private readonly retries;
|
|
83
|
-
private readonly failureMode;
|
|
84
|
-
private readonly defaultHeaders;
|
|
85
|
-
constructor(options: ViraClientOptions);
|
|
86
|
-
private request;
|
|
87
|
-
connectSystem(input: {
|
|
88
|
-
name: string;
|
|
89
|
-
systemType: string;
|
|
90
|
-
organizationId: string;
|
|
91
|
-
projectId: string;
|
|
92
|
-
environmentId: string;
|
|
93
|
-
idempotencyKey?: string;
|
|
94
|
-
}): Promise<ViraResponse<{
|
|
95
|
-
system: ClientBody;
|
|
96
|
-
}> | null>;
|
|
97
|
-
listAISystems(): Promise<ViraResponse<ClientBody> | null>;
|
|
98
|
-
deleteAISystem(systemId: string, options?: {
|
|
99
|
-
confirm?: boolean;
|
|
100
|
-
idempotencyKey?: string;
|
|
101
|
-
}): Promise<ViraResponse<ClientBody> | null>;
|
|
102
|
-
getAISystem(systemId: string): Promise<ViraResponse<ClientBody> | null>;
|
|
103
|
-
connectAdapter(systemId: string, input: {
|
|
104
|
-
adapterType: string;
|
|
105
|
-
adapterVersion: string;
|
|
106
|
-
capabilities?: readonly string[];
|
|
107
|
-
config?: unknown;
|
|
108
|
-
idempotencyKey?: string;
|
|
109
|
-
}): Promise<ViraResponse<{
|
|
110
|
-
connection: ClientBody;
|
|
111
|
-
handshake: ClientBody;
|
|
112
|
-
}> | null>;
|
|
113
|
-
connectOnce(input: {
|
|
114
|
-
name: string;
|
|
115
|
-
systemType: string;
|
|
116
|
-
organizationId: string;
|
|
117
|
-
projectId: string;
|
|
118
|
-
environmentId: string;
|
|
119
|
-
adapterType: string;
|
|
120
|
-
adapterVersion: string;
|
|
121
|
-
capabilities?: readonly string[];
|
|
122
|
-
config?: unknown;
|
|
123
|
-
idempotencyKey?: string;
|
|
124
|
-
}): Promise<ViraResponse<ConnectOnceResult> | null>;
|
|
125
|
-
observe(event: ClientObservation, options?: {
|
|
126
|
-
idempotencyKey?: string;
|
|
127
|
-
}): Promise<ViraResponse<ClientBody> | null>;
|
|
128
|
-
trace(event: {
|
|
129
|
-
eventId: string;
|
|
130
|
-
aiSystemId: string;
|
|
131
|
-
connectionId: string;
|
|
132
|
-
traceId?: string;
|
|
133
|
-
spanId?: string;
|
|
134
|
-
[key: string]: unknown;
|
|
135
|
-
}, options?: {
|
|
136
|
-
idempotencyKey?: string;
|
|
137
|
-
}): Promise<ViraResponse<ClientBody> | null>;
|
|
138
|
-
outcome(event: {
|
|
139
|
-
eventId: string;
|
|
140
|
-
aiSystemId: string;
|
|
141
|
-
connectionId: string;
|
|
142
|
-
[key: string]: unknown;
|
|
143
|
-
}, options?: {
|
|
144
|
-
idempotencyKey?: string;
|
|
145
|
-
}): Promise<ViraResponse<ClientBody> | null>;
|
|
146
|
-
feedback(event: {
|
|
147
|
-
eventId: string;
|
|
148
|
-
aiSystemId: string;
|
|
149
|
-
connectionId: string;
|
|
150
|
-
[key: string]: unknown;
|
|
151
|
-
}, options?: {
|
|
152
|
-
idempotencyKey?: string;
|
|
153
|
-
}): Promise<ViraResponse<ClientBody> | null>;
|
|
154
|
-
observeBatch(events: readonly {
|
|
155
|
-
eventId: string;
|
|
156
|
-
eventType: string;
|
|
157
|
-
aiSystemId: string;
|
|
158
|
-
connectionId: string;
|
|
159
|
-
[key: string]: unknown;
|
|
160
|
-
}[], options?: {
|
|
161
|
-
idempotencyKey?: string;
|
|
162
|
-
}): Promise<ViraResponse<ClientBody> | null>;
|
|
163
|
-
observeSdk(delivery: ClientBody, options?: {
|
|
164
|
-
idempotencyKey?: string;
|
|
165
|
-
}): Promise<ViraResponse<ClientBody> | null>;
|
|
166
|
-
discover(reviewState?: string): Promise<ViraResponse<{
|
|
167
|
-
candidates: readonly ClientBody[];
|
|
168
|
-
}> | null>;
|
|
169
|
-
createSignalDiscoveryProposal(input: ClientBody, options?: {
|
|
170
|
-
idempotencyKey?: string;
|
|
171
|
-
}): Promise<ViraResponse<ClientBody> | null>;
|
|
172
|
-
reviewSignalDiscoveryProposal(proposalId: string, decision: "APPROVE" | "REJECT", options?: {
|
|
173
|
-
idempotencyKey?: string;
|
|
174
|
-
}): Promise<ViraResponse<ClientBody> | null>;
|
|
175
|
-
materializeSignalDiscovery(proposalId: string, input?: ClientBody, options?: {
|
|
176
|
-
idempotencyKey?: string;
|
|
177
|
-
}): Promise<ViraResponse<ClientBody> | null>;
|
|
178
|
-
createSignalMapping(input: ClientBody, options?: {
|
|
179
|
-
idempotencyKey?: string;
|
|
180
|
-
}): Promise<ViraResponse<ClientBody> | null>;
|
|
181
|
-
getSignalMapping(mappingId: string): Promise<ViraResponse<ClientBody> | null>;
|
|
182
|
-
reviewSignalMapping(mappingId: string, input?: ClientBody, options?: {
|
|
183
|
-
idempotencyKey?: string;
|
|
184
|
-
}): Promise<ViraResponse<ClientBody> | null>;
|
|
185
|
-
connectionHealth(connectionId: string): Promise<ViraResponse<ClientBody> | null>;
|
|
186
|
-
inventory(systemId: string): Promise<ViraResponse<ClientBody> | null>;
|
|
187
|
-
listPacks(): Promise<ViraResponse<{
|
|
188
|
-
packs: readonly ClientBody[];
|
|
189
|
-
}> | null>;
|
|
190
|
-
importPack(input: {
|
|
191
|
-
manifest?: unknown;
|
|
192
|
-
objects?: Record<string, unknown>;
|
|
193
|
-
archiveBase64?: string;
|
|
194
|
-
fileName?: string;
|
|
195
|
-
idempotencyKey?: string;
|
|
196
|
-
}): Promise<ViraResponse<ClientBody> | null>;
|
|
197
|
-
installPack(packId: string, variables?: Record<string, unknown>): Promise<ViraResponse<ClientBody> | null>;
|
|
198
|
-
evaluatePack(packId: string, input: {
|
|
199
|
-
passed: boolean;
|
|
200
|
-
score?: number;
|
|
201
|
-
runId?: string;
|
|
202
|
-
}): Promise<ViraResponse<ClientBody> | null>;
|
|
203
|
-
approvePack(packId: string): Promise<ViraResponse<ClientBody> | null>;
|
|
204
|
-
releasePack(packId: string): Promise<ViraResponse<ClientBody> | null>;
|
|
205
|
-
previewPackUpgrade(packId: string, incoming: ClientBody): Promise<ViraResponse<ClientBody> | null>;
|
|
206
|
-
executeRuntime(input: RuntimeRequest & Record<string, unknown>): Promise<ViraResponse<ClientBody> | null>;
|
|
207
|
-
resolveRuntime(input: {
|
|
208
|
-
behaviorPoint?: string;
|
|
209
|
-
executionBoundary?: Record<string, unknown>;
|
|
210
|
-
semanticContext?: Record<string, unknown>;
|
|
211
|
-
idempotencyKey?: string;
|
|
212
|
-
}): Promise<ViraResponse<RuntimeResolution> | null>;
|
|
213
|
-
/** Resolve a runtime route from a governed execution boundary and semantic context. */
|
|
214
|
-
resolveBoundary(input: {
|
|
215
|
-
executionBoundary: Record<string, unknown>;
|
|
216
|
-
semanticContext?: Record<string, unknown>;
|
|
217
|
-
idempotencyKey?: string;
|
|
218
|
-
}): Promise<ViraResponse<RuntimeResolution> | null>;
|
|
219
|
-
resolveSemantic(input: {
|
|
220
|
-
input: string;
|
|
221
|
-
profile?: Record<string, unknown>;
|
|
222
|
-
sessionId?: string;
|
|
223
|
-
selection?: Record<string, unknown>;
|
|
224
|
-
candidates?: readonly string[];
|
|
225
|
-
timeoutMs?: number;
|
|
226
|
-
requestId?: string;
|
|
227
|
-
executionBoundary?: Record<string, unknown>;
|
|
228
|
-
idempotencyKey?: string;
|
|
229
|
-
}): Promise<ViraResponse<ClientBody> | null>;
|
|
230
|
-
resolveSemanticRuntime(input: {
|
|
231
|
-
input: string;
|
|
232
|
-
profile?: Record<string, unknown>;
|
|
233
|
-
sessionId?: string;
|
|
234
|
-
timeoutMs?: number;
|
|
235
|
-
requestId?: string;
|
|
236
|
-
executionBoundary?: Record<string, unknown>;
|
|
237
|
-
idempotencyKey?: string;
|
|
238
|
-
}): Promise<{
|
|
239
|
-
semantic: ViraResponse<ClientBody>;
|
|
240
|
-
runtime: ViraResponse<RuntimeResolution> | null;
|
|
241
|
-
} | null>;
|
|
242
|
-
listBehaviorStrategies(): Promise<ViraResponse<ClientBody> | null>;
|
|
243
|
-
deleteBehaviorStrategy(strategyId: string, options?: {
|
|
244
|
-
confirm?: boolean;
|
|
245
|
-
idempotencyKey?: string;
|
|
246
|
-
}): Promise<ViraResponse<ClientBody> | null>;
|
|
247
|
-
getBehaviorStrategy(strategyId: string): Promise<ViraResponse<ClientBody> | null>;
|
|
248
|
-
createBehaviorStrategy(definition: Record<string, unknown>, id?: string): Promise<ViraResponse<ClientBody> | null>;
|
|
249
|
-
listSemanticTasks(): Promise<ViraResponse<ClientBody> | null>;
|
|
250
|
-
deleteSemanticTask(taskId: string, options?: {
|
|
251
|
-
confirm?: boolean;
|
|
252
|
-
idempotencyKey?: string;
|
|
253
|
-
}): Promise<ViraResponse<ClientBody> | null>;
|
|
254
|
-
createSemanticTask(task: {
|
|
255
|
-
taskKey: string;
|
|
256
|
-
description?: string;
|
|
257
|
-
version?: number;
|
|
258
|
-
aliases?: readonly string[];
|
|
259
|
-
examples?: readonly string[];
|
|
260
|
-
negativeExamples?: readonly string[];
|
|
261
|
-
}, options?: {
|
|
262
|
-
id?: string;
|
|
263
|
-
idempotencyKey?: string;
|
|
264
|
-
}): Promise<ViraResponse<ClientBody> | null>;
|
|
265
|
-
listBehaviorPoints(): Promise<ViraResponse<ClientBody> | null>;
|
|
266
|
-
deleteBehaviorPoint(pointId: string, options?: {
|
|
267
|
-
confirm?: boolean;
|
|
268
|
-
idempotencyKey?: string;
|
|
269
|
-
}): Promise<ViraResponse<ClientBody> | null>;
|
|
270
|
-
createBehaviorPoint(point: {
|
|
271
|
-
key: string;
|
|
272
|
-
taskId?: string;
|
|
273
|
-
taskIds?: readonly string[];
|
|
274
|
-
constraints?: unknown;
|
|
275
|
-
}, options?: {
|
|
276
|
-
id?: string;
|
|
277
|
-
idempotencyKey?: string;
|
|
278
|
-
}): Promise<ViraResponse<ClientBody> | null>;
|
|
279
|
-
createBehaviorStrategyVariant(strategyId: string, variant: Record<string, unknown>, options?: {
|
|
280
|
-
idempotencyKey?: string;
|
|
281
|
-
}): Promise<ViraResponse<ClientBody> | null>;
|
|
282
|
-
validateBehaviorStrategy(strategyId: string): Promise<ViraResponse<ClientBody> | null>;
|
|
283
|
-
activateBehaviorStrategy(strategyId: string): Promise<ViraResponse<ClientBody> | null>;
|
|
284
|
-
simulateBehaviorStrategy(strategyId: string, initialState?: Record<string, unknown>): Promise<ViraResponse<ClientBody> | null>;
|
|
285
|
-
startStrategyExecution(input: {
|
|
286
|
-
artifactDigest: string;
|
|
287
|
-
organizationId: string;
|
|
288
|
-
projectId: string;
|
|
289
|
-
environmentId: string;
|
|
290
|
-
revisionId: string;
|
|
291
|
-
idempotencyKey: string;
|
|
292
|
-
nonce: string;
|
|
293
|
-
expiresAt: number;
|
|
294
|
-
decisionPlanId: string;
|
|
295
|
-
candidates: readonly Record<string, unknown>[];
|
|
296
|
-
policy: string;
|
|
297
|
-
behaviorPoint?: string;
|
|
298
|
-
executionBoundary?: Record<string, unknown>;
|
|
299
|
-
allowedIds?: readonly string[];
|
|
300
|
-
calibrationId?: string;
|
|
301
|
-
postModelJudge?: unknown;
|
|
302
|
-
shadow?: unknown;
|
|
303
|
-
traceId?: string;
|
|
304
|
-
executionId?: string;
|
|
305
|
-
state?: Record<string, unknown>;
|
|
306
|
-
}): Promise<ViraResponse<ClientBody> | null>;
|
|
307
|
-
getStrategyExecution(executionId: string): Promise<ViraResponse<ClientBody> | null>;
|
|
308
|
-
getStrategyExecutionTrace(executionId: string): Promise<ViraResponse<ClientBody> | null>;
|
|
309
|
-
continueStrategyExecution(executionId: string, continuation?: string | StrategyContinuationInput): Promise<ViraResponse<ClientBody> | null>;
|
|
310
|
-
cancelStrategyExecution(executionId: string): Promise<ViraResponse<ClientBody> | null>;
|
|
311
|
-
listBehaviorPrograms(): Promise<ViraResponse<{
|
|
312
|
-
programs: readonly ClientBody[];
|
|
313
|
-
}> | null>;
|
|
314
|
-
listCapabilities(options?: {
|
|
315
|
-
surface?: 'studio' | 'sdk' | 'python' | 'mcp' | 'api';
|
|
316
|
-
}): Promise<ViraResponse<{
|
|
317
|
-
capabilities: readonly ClientBody[];
|
|
318
|
-
scope: ClientBody;
|
|
319
|
-
}> | null>;
|
|
320
|
-
getBehaviorProgram(programId: string): Promise<ViraResponse<{
|
|
321
|
-
program: ClientBody;
|
|
322
|
-
}> | null>;
|
|
323
|
-
createBehaviorProgram(program: ClientBody, options?: {
|
|
324
|
-
idempotencyKey?: string;
|
|
325
|
-
}): Promise<ViraResponse<{
|
|
326
|
-
program: ClientBody;
|
|
327
|
-
}> | null>;
|
|
328
|
-
attestCapabilities(attestation: ClientBody, options?: {
|
|
329
|
-
idempotencyKey?: string;
|
|
330
|
-
}): Promise<ViraResponse<ClientBody> | null>;
|
|
331
|
-
resolveCapabilities(attestationId: string, request: ClientBody, options?: {
|
|
332
|
-
idempotencyKey?: string;
|
|
333
|
-
}): Promise<ViraResponse<ClientBody> | null>;
|
|
334
|
-
recordCapabilityTrace(decisionDigest: string, trace: ClientBody, options?: {
|
|
335
|
-
idempotencyKey?: string;
|
|
336
|
-
}): Promise<ViraResponse<ClientBody> | null>;
|
|
337
|
-
resolveModelServing(request: ClientBody, options?: {
|
|
338
|
-
idempotencyKey?: string;
|
|
339
|
-
}): Promise<ViraResponse<ClientBody> | null>;
|
|
340
|
-
recordModelServingTrace(trace: ClientBody, selection: ClientBody, options?: {
|
|
341
|
-
idempotencyKey?: string;
|
|
342
|
-
}): Promise<ViraResponse<ClientBody> | null>;
|
|
343
|
-
submitTeachEvidence(evidence: ClientBody, options?: {
|
|
344
|
-
idempotencyKey?: string;
|
|
345
|
-
}): Promise<ViraResponse<ClientBody> | null>;
|
|
346
|
-
createTeachProposal(input: ClientBody, options?: {
|
|
347
|
-
idempotencyKey?: string;
|
|
348
|
-
}): Promise<ViraResponse<ClientBody> | null>;
|
|
349
|
-
transitionTeachProposal(proposalId: string, transition: 'review' | 'evaluate' | 'promote', input?: ClientBody, options?: {
|
|
350
|
-
idempotencyKey?: string;
|
|
351
|
-
}): Promise<ViraResponse<ClientBody> | null>;
|
|
352
|
-
startEvaluation(input: ClientBody, options?: {
|
|
353
|
-
idempotencyKey?: string;
|
|
354
|
-
}): Promise<ViraResponse<ClientBody> | null>;
|
|
355
|
-
evaluateQuality(input: ClientBody, options?: {
|
|
356
|
-
idempotencyKey?: string;
|
|
357
|
-
}): Promise<ViraResponse<ClientBody> | null>;
|
|
358
|
-
getEvaluation(evaluationId: string): Promise<ViraResponse<ClientBody> | null>;
|
|
359
|
-
createRelease(input: ClientBody, options?: {
|
|
360
|
-
idempotencyKey?: string;
|
|
361
|
-
}): Promise<ViraResponse<ClientBody> | null>;
|
|
362
|
-
|
|
363
|
-
idempotencyKey?: string;
|
|
364
|
-
}): Promise<ViraResponse<ClientBody> | null>;
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
|
|
383
|
-
}
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
}
|
|
393
|
-
export declare function
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
|
|
407
|
-
|
|
1
|
+
export interface RuntimeRequest {
|
|
2
|
+
organizationId: string;
|
|
3
|
+
projectId: string;
|
|
4
|
+
environmentId: string;
|
|
5
|
+
revisionId: string;
|
|
6
|
+
idempotencyKey: string;
|
|
7
|
+
nonce: string;
|
|
8
|
+
expiresAt: number;
|
|
9
|
+
}
|
|
10
|
+
export interface SdkRequest {
|
|
11
|
+
method: "GET" | "POST" | "DELETE";
|
|
12
|
+
path: string;
|
|
13
|
+
query?: Readonly<Record<string, string>>;
|
|
14
|
+
body?: Readonly<Record<string, unknown>>;
|
|
15
|
+
}
|
|
16
|
+
export type SdkFailureMode = "throw" | "open";
|
|
17
|
+
export interface ViraClientOptions {
|
|
18
|
+
baseUrl: string;
|
|
19
|
+
apiKey?: string;
|
|
20
|
+
fetcher?: typeof fetch;
|
|
21
|
+
timeoutMs?: number;
|
|
22
|
+
retries?: number;
|
|
23
|
+
failureMode?: SdkFailureMode;
|
|
24
|
+
defaultHeaders?: Readonly<Record<string, string>>;
|
|
25
|
+
}
|
|
26
|
+
export interface ViraResponse<T = unknown> {
|
|
27
|
+
status: number;
|
|
28
|
+
body: T;
|
|
29
|
+
requestId: string;
|
|
30
|
+
}
|
|
31
|
+
export interface BehaviorProjection {
|
|
32
|
+
rendered: string;
|
|
33
|
+
projectionDigest: string;
|
|
34
|
+
programDigest: string;
|
|
35
|
+
[key: string]: unknown;
|
|
36
|
+
}
|
|
37
|
+
export interface ProjectionReceipt {
|
|
38
|
+
projectionDigest: string;
|
|
39
|
+
programDigest: string;
|
|
40
|
+
artifactDigest: string;
|
|
41
|
+
receiptDigest: string;
|
|
42
|
+
[key: string]: unknown;
|
|
43
|
+
}
|
|
44
|
+
export interface RuntimeResolution {
|
|
45
|
+
behaviorPoint: string;
|
|
46
|
+
strategySelection?: ClientBody | null;
|
|
47
|
+
behaviorProjection?: BehaviorProjection;
|
|
48
|
+
projectionReceipt?: ProjectionReceipt;
|
|
49
|
+
projectionMode?: "active" | "unavailable" | "not-applicable";
|
|
50
|
+
[key: string]: unknown;
|
|
51
|
+
}
|
|
52
|
+
export interface ConnectOnceResult {
|
|
53
|
+
system: ClientBody;
|
|
54
|
+
connection: ClientBody;
|
|
55
|
+
handshake: ClientBody;
|
|
56
|
+
}
|
|
57
|
+
export interface StrategyContinuationInput {
|
|
58
|
+
authorityDigest?: string;
|
|
59
|
+
state?: Readonly<Record<string, unknown>>;
|
|
60
|
+
references?: Readonly<Record<string, unknown>>;
|
|
61
|
+
}
|
|
62
|
+
export declare class ViraApiError extends Error {
|
|
63
|
+
readonly status: number;
|
|
64
|
+
readonly body: unknown;
|
|
65
|
+
readonly requestId: string;
|
|
66
|
+
constructor(message: string, status: number, body: unknown, requestId: string);
|
|
67
|
+
}
|
|
68
|
+
type ClientBody = Record<string, unknown>;
|
|
69
|
+
type ClientObservation = {
|
|
70
|
+
eventId: string;
|
|
71
|
+
eventType: string;
|
|
72
|
+
aiSystemId: string;
|
|
73
|
+
connectionId: string;
|
|
74
|
+
[key: string]: unknown;
|
|
75
|
+
};
|
|
76
|
+
/** Small, authority-aware client over the existing versioned control API. */
|
|
77
|
+
export declare class ViraClient {
|
|
78
|
+
private readonly baseUrl;
|
|
79
|
+
private readonly apiKey?;
|
|
80
|
+
private readonly fetcher;
|
|
81
|
+
private readonly timeoutMs;
|
|
82
|
+
private readonly retries;
|
|
83
|
+
private readonly failureMode;
|
|
84
|
+
private readonly defaultHeaders;
|
|
85
|
+
constructor(options: ViraClientOptions);
|
|
86
|
+
private request;
|
|
87
|
+
connectSystem(input: {
|
|
88
|
+
name: string;
|
|
89
|
+
systemType: string;
|
|
90
|
+
organizationId: string;
|
|
91
|
+
projectId: string;
|
|
92
|
+
environmentId: string;
|
|
93
|
+
idempotencyKey?: string;
|
|
94
|
+
}): Promise<ViraResponse<{
|
|
95
|
+
system: ClientBody;
|
|
96
|
+
}> | null>;
|
|
97
|
+
listAISystems(): Promise<ViraResponse<ClientBody> | null>;
|
|
98
|
+
deleteAISystem(systemId: string, options?: {
|
|
99
|
+
confirm?: boolean;
|
|
100
|
+
idempotencyKey?: string;
|
|
101
|
+
}): Promise<ViraResponse<ClientBody> | null>;
|
|
102
|
+
getAISystem(systemId: string): Promise<ViraResponse<ClientBody> | null>;
|
|
103
|
+
connectAdapter(systemId: string, input: {
|
|
104
|
+
adapterType: string;
|
|
105
|
+
adapterVersion: string;
|
|
106
|
+
capabilities?: readonly string[];
|
|
107
|
+
config?: unknown;
|
|
108
|
+
idempotencyKey?: string;
|
|
109
|
+
}): Promise<ViraResponse<{
|
|
110
|
+
connection: ClientBody;
|
|
111
|
+
handshake: ClientBody;
|
|
112
|
+
}> | null>;
|
|
113
|
+
connectOnce(input: {
|
|
114
|
+
name: string;
|
|
115
|
+
systemType: string;
|
|
116
|
+
organizationId: string;
|
|
117
|
+
projectId: string;
|
|
118
|
+
environmentId: string;
|
|
119
|
+
adapterType: string;
|
|
120
|
+
adapterVersion: string;
|
|
121
|
+
capabilities?: readonly string[];
|
|
122
|
+
config?: unknown;
|
|
123
|
+
idempotencyKey?: string;
|
|
124
|
+
}): Promise<ViraResponse<ConnectOnceResult> | null>;
|
|
125
|
+
observe(event: ClientObservation, options?: {
|
|
126
|
+
idempotencyKey?: string;
|
|
127
|
+
}): Promise<ViraResponse<ClientBody> | null>;
|
|
128
|
+
trace(event: {
|
|
129
|
+
eventId: string;
|
|
130
|
+
aiSystemId: string;
|
|
131
|
+
connectionId: string;
|
|
132
|
+
traceId?: string;
|
|
133
|
+
spanId?: string;
|
|
134
|
+
[key: string]: unknown;
|
|
135
|
+
}, options?: {
|
|
136
|
+
idempotencyKey?: string;
|
|
137
|
+
}): Promise<ViraResponse<ClientBody> | null>;
|
|
138
|
+
outcome(event: {
|
|
139
|
+
eventId: string;
|
|
140
|
+
aiSystemId: string;
|
|
141
|
+
connectionId: string;
|
|
142
|
+
[key: string]: unknown;
|
|
143
|
+
}, options?: {
|
|
144
|
+
idempotencyKey?: string;
|
|
145
|
+
}): Promise<ViraResponse<ClientBody> | null>;
|
|
146
|
+
feedback(event: {
|
|
147
|
+
eventId: string;
|
|
148
|
+
aiSystemId: string;
|
|
149
|
+
connectionId: string;
|
|
150
|
+
[key: string]: unknown;
|
|
151
|
+
}, options?: {
|
|
152
|
+
idempotencyKey?: string;
|
|
153
|
+
}): Promise<ViraResponse<ClientBody> | null>;
|
|
154
|
+
observeBatch(events: readonly {
|
|
155
|
+
eventId: string;
|
|
156
|
+
eventType: string;
|
|
157
|
+
aiSystemId: string;
|
|
158
|
+
connectionId: string;
|
|
159
|
+
[key: string]: unknown;
|
|
160
|
+
}[], options?: {
|
|
161
|
+
idempotencyKey?: string;
|
|
162
|
+
}): Promise<ViraResponse<ClientBody> | null>;
|
|
163
|
+
observeSdk(delivery: ClientBody, options?: {
|
|
164
|
+
idempotencyKey?: string;
|
|
165
|
+
}): Promise<ViraResponse<ClientBody> | null>;
|
|
166
|
+
discover(reviewState?: string): Promise<ViraResponse<{
|
|
167
|
+
candidates: readonly ClientBody[];
|
|
168
|
+
}> | null>;
|
|
169
|
+
createSignalDiscoveryProposal(input: ClientBody, options?: {
|
|
170
|
+
idempotencyKey?: string;
|
|
171
|
+
}): Promise<ViraResponse<ClientBody> | null>;
|
|
172
|
+
reviewSignalDiscoveryProposal(proposalId: string, decision: "APPROVE" | "REJECT", options?: {
|
|
173
|
+
idempotencyKey?: string;
|
|
174
|
+
}): Promise<ViraResponse<ClientBody> | null>;
|
|
175
|
+
materializeSignalDiscovery(proposalId: string, input?: ClientBody, options?: {
|
|
176
|
+
idempotencyKey?: string;
|
|
177
|
+
}): Promise<ViraResponse<ClientBody> | null>;
|
|
178
|
+
createSignalMapping(input: ClientBody, options?: {
|
|
179
|
+
idempotencyKey?: string;
|
|
180
|
+
}): Promise<ViraResponse<ClientBody> | null>;
|
|
181
|
+
getSignalMapping(mappingId: string): Promise<ViraResponse<ClientBody> | null>;
|
|
182
|
+
reviewSignalMapping(mappingId: string, input?: ClientBody, options?: {
|
|
183
|
+
idempotencyKey?: string;
|
|
184
|
+
}): Promise<ViraResponse<ClientBody> | null>;
|
|
185
|
+
connectionHealth(connectionId: string): Promise<ViraResponse<ClientBody> | null>;
|
|
186
|
+
inventory(systemId: string): Promise<ViraResponse<ClientBody> | null>;
|
|
187
|
+
listPacks(): Promise<ViraResponse<{
|
|
188
|
+
packs: readonly ClientBody[];
|
|
189
|
+
}> | null>;
|
|
190
|
+
importPack(input: {
|
|
191
|
+
manifest?: unknown;
|
|
192
|
+
objects?: Record<string, unknown>;
|
|
193
|
+
archiveBase64?: string;
|
|
194
|
+
fileName?: string;
|
|
195
|
+
idempotencyKey?: string;
|
|
196
|
+
}): Promise<ViraResponse<ClientBody> | null>;
|
|
197
|
+
installPack(packId: string, variables?: Record<string, unknown>): Promise<ViraResponse<ClientBody> | null>;
|
|
198
|
+
evaluatePack(packId: string, input: {
|
|
199
|
+
passed: boolean;
|
|
200
|
+
score?: number;
|
|
201
|
+
runId?: string;
|
|
202
|
+
}): Promise<ViraResponse<ClientBody> | null>;
|
|
203
|
+
approvePack(packId: string): Promise<ViraResponse<ClientBody> | null>;
|
|
204
|
+
releasePack(packId: string): Promise<ViraResponse<ClientBody> | null>;
|
|
205
|
+
previewPackUpgrade(packId: string, incoming: ClientBody): Promise<ViraResponse<ClientBody> | null>;
|
|
206
|
+
executeRuntime(input: RuntimeRequest & Record<string, unknown>): Promise<ViraResponse<ClientBody> | null>;
|
|
207
|
+
resolveRuntime(input: {
|
|
208
|
+
behaviorPoint?: string;
|
|
209
|
+
executionBoundary?: Record<string, unknown>;
|
|
210
|
+
semanticContext?: Record<string, unknown>;
|
|
211
|
+
idempotencyKey?: string;
|
|
212
|
+
}): Promise<ViraResponse<RuntimeResolution> | null>;
|
|
213
|
+
/** Resolve a runtime route from a governed execution boundary and semantic context. */
|
|
214
|
+
resolveBoundary(input: {
|
|
215
|
+
executionBoundary: Record<string, unknown>;
|
|
216
|
+
semanticContext?: Record<string, unknown>;
|
|
217
|
+
idempotencyKey?: string;
|
|
218
|
+
}): Promise<ViraResponse<RuntimeResolution> | null>;
|
|
219
|
+
resolveSemantic(input: {
|
|
220
|
+
input: string;
|
|
221
|
+
profile?: Record<string, unknown>;
|
|
222
|
+
sessionId?: string;
|
|
223
|
+
selection?: Record<string, unknown>;
|
|
224
|
+
candidates?: readonly string[];
|
|
225
|
+
timeoutMs?: number;
|
|
226
|
+
requestId?: string;
|
|
227
|
+
executionBoundary?: Record<string, unknown>;
|
|
228
|
+
idempotencyKey?: string;
|
|
229
|
+
}): Promise<ViraResponse<ClientBody> | null>;
|
|
230
|
+
resolveSemanticRuntime(input: {
|
|
231
|
+
input: string;
|
|
232
|
+
profile?: Record<string, unknown>;
|
|
233
|
+
sessionId?: string;
|
|
234
|
+
timeoutMs?: number;
|
|
235
|
+
requestId?: string;
|
|
236
|
+
executionBoundary?: Record<string, unknown>;
|
|
237
|
+
idempotencyKey?: string;
|
|
238
|
+
}): Promise<{
|
|
239
|
+
semantic: ViraResponse<ClientBody>;
|
|
240
|
+
runtime: ViraResponse<RuntimeResolution> | null;
|
|
241
|
+
} | null>;
|
|
242
|
+
listBehaviorStrategies(): Promise<ViraResponse<ClientBody> | null>;
|
|
243
|
+
deleteBehaviorStrategy(strategyId: string, options?: {
|
|
244
|
+
confirm?: boolean;
|
|
245
|
+
idempotencyKey?: string;
|
|
246
|
+
}): Promise<ViraResponse<ClientBody> | null>;
|
|
247
|
+
getBehaviorStrategy(strategyId: string): Promise<ViraResponse<ClientBody> | null>;
|
|
248
|
+
createBehaviorStrategy(definition: Record<string, unknown>, id?: string): Promise<ViraResponse<ClientBody> | null>;
|
|
249
|
+
listSemanticTasks(): Promise<ViraResponse<ClientBody> | null>;
|
|
250
|
+
deleteSemanticTask(taskId: string, options?: {
|
|
251
|
+
confirm?: boolean;
|
|
252
|
+
idempotencyKey?: string;
|
|
253
|
+
}): Promise<ViraResponse<ClientBody> | null>;
|
|
254
|
+
createSemanticTask(task: {
|
|
255
|
+
taskKey: string;
|
|
256
|
+
description?: string;
|
|
257
|
+
version?: number;
|
|
258
|
+
aliases?: readonly string[];
|
|
259
|
+
examples?: readonly string[];
|
|
260
|
+
negativeExamples?: readonly string[];
|
|
261
|
+
}, options?: {
|
|
262
|
+
id?: string;
|
|
263
|
+
idempotencyKey?: string;
|
|
264
|
+
}): Promise<ViraResponse<ClientBody> | null>;
|
|
265
|
+
listBehaviorPoints(): Promise<ViraResponse<ClientBody> | null>;
|
|
266
|
+
deleteBehaviorPoint(pointId: string, options?: {
|
|
267
|
+
confirm?: boolean;
|
|
268
|
+
idempotencyKey?: string;
|
|
269
|
+
}): Promise<ViraResponse<ClientBody> | null>;
|
|
270
|
+
createBehaviorPoint(point: {
|
|
271
|
+
key: string;
|
|
272
|
+
taskId?: string;
|
|
273
|
+
taskIds?: readonly string[];
|
|
274
|
+
constraints?: unknown;
|
|
275
|
+
}, options?: {
|
|
276
|
+
id?: string;
|
|
277
|
+
idempotencyKey?: string;
|
|
278
|
+
}): Promise<ViraResponse<ClientBody> | null>;
|
|
279
|
+
createBehaviorStrategyVariant(strategyId: string, variant: Record<string, unknown>, options?: {
|
|
280
|
+
idempotencyKey?: string;
|
|
281
|
+
}): Promise<ViraResponse<ClientBody> | null>;
|
|
282
|
+
validateBehaviorStrategy(strategyId: string): Promise<ViraResponse<ClientBody> | null>;
|
|
283
|
+
activateBehaviorStrategy(strategyId: string): Promise<ViraResponse<ClientBody> | null>;
|
|
284
|
+
simulateBehaviorStrategy(strategyId: string, initialState?: Record<string, unknown>): Promise<ViraResponse<ClientBody> | null>;
|
|
285
|
+
startStrategyExecution(input: {
|
|
286
|
+
artifactDigest: string;
|
|
287
|
+
organizationId: string;
|
|
288
|
+
projectId: string;
|
|
289
|
+
environmentId: string;
|
|
290
|
+
revisionId: string;
|
|
291
|
+
idempotencyKey: string;
|
|
292
|
+
nonce: string;
|
|
293
|
+
expiresAt: number;
|
|
294
|
+
decisionPlanId: string;
|
|
295
|
+
candidates: readonly Record<string, unknown>[];
|
|
296
|
+
policy: string;
|
|
297
|
+
behaviorPoint?: string;
|
|
298
|
+
executionBoundary?: Record<string, unknown>;
|
|
299
|
+
allowedIds?: readonly string[];
|
|
300
|
+
calibrationId?: string;
|
|
301
|
+
postModelJudge?: unknown;
|
|
302
|
+
shadow?: unknown;
|
|
303
|
+
traceId?: string;
|
|
304
|
+
executionId?: string;
|
|
305
|
+
state?: Record<string, unknown>;
|
|
306
|
+
}): Promise<ViraResponse<ClientBody> | null>;
|
|
307
|
+
getStrategyExecution(executionId: string): Promise<ViraResponse<ClientBody> | null>;
|
|
308
|
+
getStrategyExecutionTrace(executionId: string): Promise<ViraResponse<ClientBody> | null>;
|
|
309
|
+
continueStrategyExecution(executionId: string, continuation?: string | StrategyContinuationInput): Promise<ViraResponse<ClientBody> | null>;
|
|
310
|
+
cancelStrategyExecution(executionId: string): Promise<ViraResponse<ClientBody> | null>;
|
|
311
|
+
listBehaviorPrograms(): Promise<ViraResponse<{
|
|
312
|
+
programs: readonly ClientBody[];
|
|
313
|
+
}> | null>;
|
|
314
|
+
listCapabilities(options?: {
|
|
315
|
+
surface?: 'studio' | 'sdk' | 'python' | 'mcp' | 'api';
|
|
316
|
+
}): Promise<ViraResponse<{
|
|
317
|
+
capabilities: readonly ClientBody[];
|
|
318
|
+
scope: ClientBody;
|
|
319
|
+
}> | null>;
|
|
320
|
+
getBehaviorProgram(programId: string): Promise<ViraResponse<{
|
|
321
|
+
program: ClientBody;
|
|
322
|
+
}> | null>;
|
|
323
|
+
createBehaviorProgram(program: ClientBody, options?: {
|
|
324
|
+
idempotencyKey?: string;
|
|
325
|
+
}): Promise<ViraResponse<{
|
|
326
|
+
program: ClientBody;
|
|
327
|
+
}> | null>;
|
|
328
|
+
attestCapabilities(attestation: ClientBody, options?: {
|
|
329
|
+
idempotencyKey?: string;
|
|
330
|
+
}): Promise<ViraResponse<ClientBody> | null>;
|
|
331
|
+
resolveCapabilities(attestationId: string, request: ClientBody, options?: {
|
|
332
|
+
idempotencyKey?: string;
|
|
333
|
+
}): Promise<ViraResponse<ClientBody> | null>;
|
|
334
|
+
recordCapabilityTrace(decisionDigest: string, trace: ClientBody, options?: {
|
|
335
|
+
idempotencyKey?: string;
|
|
336
|
+
}): Promise<ViraResponse<ClientBody> | null>;
|
|
337
|
+
resolveModelServing(request: ClientBody, options?: {
|
|
338
|
+
idempotencyKey?: string;
|
|
339
|
+
}): Promise<ViraResponse<ClientBody> | null>;
|
|
340
|
+
recordModelServingTrace(trace: ClientBody, selection: ClientBody, options?: {
|
|
341
|
+
idempotencyKey?: string;
|
|
342
|
+
}): Promise<ViraResponse<ClientBody> | null>;
|
|
343
|
+
submitTeachEvidence(evidence: ClientBody, options?: {
|
|
344
|
+
idempotencyKey?: string;
|
|
345
|
+
}): Promise<ViraResponse<ClientBody> | null>;
|
|
346
|
+
createTeachProposal(input: ClientBody, options?: {
|
|
347
|
+
idempotencyKey?: string;
|
|
348
|
+
}): Promise<ViraResponse<ClientBody> | null>;
|
|
349
|
+
transitionTeachProposal(proposalId: string, transition: 'review' | 'evaluate' | 'promote', input?: ClientBody, options?: {
|
|
350
|
+
idempotencyKey?: string;
|
|
351
|
+
}): Promise<ViraResponse<ClientBody> | null>;
|
|
352
|
+
startEvaluation(input: ClientBody, options?: {
|
|
353
|
+
idempotencyKey?: string;
|
|
354
|
+
}): Promise<ViraResponse<ClientBody> | null>;
|
|
355
|
+
evaluateQuality(input: ClientBody, options?: {
|
|
356
|
+
idempotencyKey?: string;
|
|
357
|
+
}): Promise<ViraResponse<ClientBody> | null>;
|
|
358
|
+
getEvaluation(evaluationId: string): Promise<ViraResponse<ClientBody> | null>;
|
|
359
|
+
createRelease(input: ClientBody, options?: {
|
|
360
|
+
idempotencyKey?: string;
|
|
361
|
+
}): Promise<ViraResponse<ClientBody> | null>;
|
|
362
|
+
createManualRelease(input: ClientBody, options?: {
|
|
363
|
+
idempotencyKey?: string;
|
|
364
|
+
}): Promise<ViraResponse<ClientBody> | null>;
|
|
365
|
+
releaseProgramManually(input: {
|
|
366
|
+
programId: string;
|
|
367
|
+
reason: string;
|
|
368
|
+
}, options?: {
|
|
369
|
+
idempotencyKey?: string;
|
|
370
|
+
}): Promise<ViraResponse<ClientBody> | null>;
|
|
371
|
+
recordDeploymentComparison(deploymentId: string, comparison: ClientBody, options?: {
|
|
372
|
+
idempotencyKey?: string;
|
|
373
|
+
}): Promise<ViraResponse<ClientBody> | null>;
|
|
374
|
+
recordDeploymentHealth(deploymentId: string, health: ClientBody, options?: {
|
|
375
|
+
idempotencyKey?: string;
|
|
376
|
+
}): Promise<ViraResponse<ClientBody> | null>;
|
|
377
|
+
compileBehaviorCapsule(input: {
|
|
378
|
+
programId: string;
|
|
379
|
+
input: string;
|
|
380
|
+
selection?: Record<string, unknown>;
|
|
381
|
+
candidates?: readonly string[];
|
|
382
|
+
idempotencyKey?: string;
|
|
383
|
+
}): Promise<ViraResponse<ClientBody> | null>;
|
|
384
|
+
serveBehaviorProjection(input: {
|
|
385
|
+
programId?: string;
|
|
386
|
+
input: string;
|
|
387
|
+
provider: string;
|
|
388
|
+
protocol?: string;
|
|
389
|
+
idempotencyKey?: string;
|
|
390
|
+
}): Promise<ViraResponse<ClientBody> | null>;
|
|
391
|
+
testConnection(connectionId: string): Promise<ViraResponse<ClientBody> | null>;
|
|
392
|
+
}
|
|
393
|
+
export declare function buildRuntimeRequest(input: RuntimeRequest & Record<string, unknown>): RuntimeRequest & Record<string, unknown>;
|
|
394
|
+
export declare function buildPublicContentRequest(input: {
|
|
395
|
+
slug: string;
|
|
396
|
+
version?: string;
|
|
397
|
+
}): SdkRequest;
|
|
398
|
+
export declare function buildDocsQueryRequest(input: {
|
|
399
|
+
query: string;
|
|
400
|
+
operation?: "search" | "ask";
|
|
401
|
+
}): SdkRequest;
|
|
402
|
+
export declare function buildAISystemRequest(input: {
|
|
403
|
+
name: string;
|
|
404
|
+
systemType: string;
|
|
405
|
+
organizationId: string;
|
|
406
|
+
projectId: string;
|
|
407
|
+
environmentId: string;
|
|
408
|
+
}): SdkRequest;
|
|
409
|
+
export declare function buildObservationRequest(event: {
|
|
410
|
+
eventId: string;
|
|
411
|
+
eventType: string;
|
|
412
|
+
aiSystemId: string;
|
|
413
|
+
connectionId: string;
|
|
414
|
+
[key: string]: unknown;
|
|
415
|
+
}): SdkRequest;
|
|
416
|
+
export {};
|