@flurin17/rapidata-typescript-sdk 0.1.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.
@@ -0,0 +1,789 @@
1
+ import { I as ISelection, a as IUserFilterModel, b as IAudienceFilter, F as FeatureFlag, c as FeatureFlagModel, d as IOrderWorkflowModel, e as IRapidPayload, f as IRefereeModel, g as IAssetInput, h as IValidationTruthModel } from './index-DH4HyFFk.js';
2
+ export { i as types } from './index-DH4HyFFk.js';
3
+
4
+ type DataType = "text" | "media";
5
+ type JsonObject = Record<string, unknown>;
6
+ declare enum AgeGroup {
7
+ Age0To17 = "0-17",
8
+ Age18To29 = "18-29",
9
+ Age30To39 = "30-39",
10
+ Age40To49 = "40-49",
11
+ Age50To64 = "50-64",
12
+ Age65Plus = "65+"
13
+ }
14
+ declare enum Gender {
15
+ Male = "Male",
16
+ Female = "Female",
17
+ Other = "Other"
18
+ }
19
+ declare enum DeviceType {
20
+ Unknown = "Unknown",
21
+ Phone = "Phone",
22
+ Tablet = "Tablet"
23
+ }
24
+ declare enum TranslationBehaviourOptions {
25
+ BOTH = "both",
26
+ ONLY_ORIGINAL = "only original",
27
+ ONLY_TRANSLATED = "only translated"
28
+ }
29
+ declare enum RapidataRetrievalMode {
30
+ Shuffled = "Shuffled",
31
+ Sequential = "Sequential",
32
+ Random = "Random"
33
+ }
34
+ declare class Datapoint {
35
+ readonly asset: string | string[];
36
+ readonly dataType: DataType;
37
+ readonly context?: string;
38
+ readonly mediaContext?: string;
39
+ readonly sentence?: string;
40
+ readonly privateMetadata?: Record<string, string>;
41
+ readonly group?: string;
42
+ constructor(options: {
43
+ asset: string | string[];
44
+ dataType: DataType;
45
+ context?: string;
46
+ mediaContext?: string;
47
+ sentence?: string;
48
+ privateMetadata?: Record<string, string>;
49
+ group?: string;
50
+ });
51
+ getAssetType(): "None" | "Image" | "Video" | "Audio" | "Text";
52
+ getPromptTypes(): string[];
53
+ }
54
+ declare class Box {
55
+ readonly xMin: number;
56
+ readonly yMin: number;
57
+ readonly xMax: number;
58
+ readonly yMax: number;
59
+ constructor(xMin: number, yMin: number, xMax: number, yMax: number);
60
+ toModel(): {
61
+ xMin: number;
62
+ yMin: number;
63
+ xMax: number;
64
+ yMax: number;
65
+ };
66
+ }
67
+ declare class RapidataResults {
68
+ readonly data: Record<string, unknown>;
69
+ constructor(data: Record<string, unknown>);
70
+ toPandas(splitDetails?: boolean): Array<Record<string, unknown>>;
71
+ toJson(filePath?: string): Promise<void>;
72
+ private flatten;
73
+ }
74
+ declare abstract class RapidataSetting {
75
+ readonly key: string;
76
+ readonly value: unknown;
77
+ constructor(key: string, value: unknown);
78
+ toFeatureFlag(): FeatureFlag;
79
+ toFeatureFlagModel(): FeatureFlagModel;
80
+ }
81
+ declare class AlertOnFastResponseSetting extends RapidataSetting {
82
+ constructor(threshold: number);
83
+ }
84
+ declare class AlertOnFastResponse extends AlertOnFastResponseSetting {
85
+ }
86
+ declare class TranslationBehaviourSetting extends RapidataSetting {
87
+ constructor(value: TranslationBehaviourOptions);
88
+ }
89
+ declare class TranslationBehaviour extends TranslationBehaviourSetting {
90
+ }
91
+ declare class FreeTextMinimumCharactersSetting extends RapidataSetting {
92
+ constructor(value: number);
93
+ }
94
+ declare class FreeTextMinimumCharacters extends FreeTextMinimumCharactersSetting {
95
+ }
96
+ declare class NoShuffleSetting extends RapidataSetting {
97
+ constructor(value?: boolean);
98
+ }
99
+ declare class NoShuffle extends NoShuffleSetting {
100
+ }
101
+ declare class PlayVideoUntilTheEndSetting extends RapidataSetting {
102
+ constructor(additionalTime?: number);
103
+ }
104
+ declare class PlayVideoUntilTheEnd extends PlayVideoUntilTheEndSetting {
105
+ }
106
+ declare class MuteVideoSetting extends RapidataSetting {
107
+ constructor(value?: boolean);
108
+ }
109
+ declare class MuteVideo extends MuteVideoSetting {
110
+ }
111
+ declare class MarkdownSetting extends RapidataSetting {
112
+ constructor(value?: boolean);
113
+ }
114
+ declare class Markdown extends MarkdownSetting {
115
+ }
116
+ declare class AllowNeitherBothSetting extends RapidataSetting {
117
+ constructor(value?: boolean);
118
+ }
119
+ declare class AllowNeitherBoth extends AllowNeitherBothSetting {
120
+ }
121
+ declare class SwapContextInstructionSetting extends RapidataSetting {
122
+ constructor(value?: boolean);
123
+ }
124
+ declare class SwapContextInstruction extends SwapContextInstructionSetting {
125
+ }
126
+ declare class CustomSetting extends RapidataSetting {
127
+ constructor(key: string, value: string);
128
+ }
129
+ declare class RapidataSettings {
130
+ static readonly AlertOnFastResponse: typeof AlertOnFastResponseSetting;
131
+ static readonly TranslationBehaviour: typeof TranslationBehaviourSetting;
132
+ static readonly FreeTextMinimumCharacters: typeof FreeTextMinimumCharactersSetting;
133
+ static readonly NoShuffle: typeof NoShuffleSetting;
134
+ static readonly PlayVideoUntilTheEnd: typeof PlayVideoUntilTheEndSetting;
135
+ static readonly AllowNeitherBoth: typeof AllowNeitherBothSetting;
136
+ static readonly SwapContextInstruction: typeof SwapContextInstructionSetting;
137
+ static readonly MuteVideo: typeof MuteVideoSetting;
138
+ static readonly Markdown: typeof MarkdownSetting;
139
+ }
140
+ declare abstract class RapidataFilter {
141
+ abstract toModel(): IUserFilterModel;
142
+ toAudienceModel(): IAudienceFilter;
143
+ and(other: RapidataFilter): AndFilter;
144
+ or(other: RapidataFilter): OrFilter;
145
+ not(): NotFilter;
146
+ }
147
+ declare class CountryFilter extends RapidataFilter {
148
+ readonly countryCodes: string[];
149
+ constructor(countryCodes: string[]);
150
+ toModel(): IUserFilterModel;
151
+ toAudienceModel(): IAudienceFilter;
152
+ }
153
+ declare class LanguageFilter extends RapidataFilter {
154
+ readonly languageCodes: string[];
155
+ constructor(languageCodes: string[]);
156
+ toModel(): IUserFilterModel;
157
+ toAudienceModel(): IAudienceFilter;
158
+ }
159
+ declare class AgeFilter extends RapidataFilter {
160
+ readonly ageGroups: AgeGroup[];
161
+ constructor(ageGroups: AgeGroup[]);
162
+ toModel(): IUserFilterModel;
163
+ }
164
+ declare class GenderFilter extends RapidataFilter {
165
+ readonly genders: Gender[];
166
+ constructor(genders: Gender[]);
167
+ toModel(): IUserFilterModel;
168
+ }
169
+ declare class DeviceFilter extends RapidataFilter {
170
+ readonly deviceTypes: DeviceType[];
171
+ constructor(deviceTypes: DeviceType[]);
172
+ toModel(): IUserFilterModel;
173
+ }
174
+ declare class UserScoreFilter extends RapidataFilter {
175
+ readonly lowerBound: number;
176
+ readonly upperBound: number;
177
+ readonly dimension?: string | undefined;
178
+ constructor(lowerBound?: number, upperBound?: number, dimension?: string | undefined);
179
+ toModel(): IUserFilterModel;
180
+ }
181
+ declare class CampaignFilter extends RapidataFilter {
182
+ readonly campaignIds: string[];
183
+ constructor(campaignIds: string[]);
184
+ toModel(): IUserFilterModel;
185
+ }
186
+ declare class CustomFilter extends RapidataFilter {
187
+ readonly identifier: string;
188
+ readonly values: string[];
189
+ constructor(identifier: string, values: string[]);
190
+ toModel(): IUserFilterModel;
191
+ }
192
+ declare class NotFilter extends RapidataFilter {
193
+ readonly filter: RapidataFilter;
194
+ constructor(filter: RapidataFilter);
195
+ toModel(): IUserFilterModel;
196
+ toAudienceModel(): IAudienceFilter;
197
+ }
198
+ declare class AndFilter extends RapidataFilter {
199
+ readonly filters: RapidataFilter[];
200
+ constructor(filters: RapidataFilter[]);
201
+ toModel(): IUserFilterModel;
202
+ toAudienceModel(): IAudienceFilter;
203
+ }
204
+ declare class OrFilter extends RapidataFilter {
205
+ readonly filters: RapidataFilter[];
206
+ constructor(filters: RapidataFilter[]);
207
+ toModel(): IUserFilterModel;
208
+ toAudienceModel(): IAudienceFilter;
209
+ }
210
+ declare class RapidataFilters {
211
+ static readonly Country: typeof CountryFilter;
212
+ static readonly Language: typeof LanguageFilter;
213
+ static readonly UserScore: typeof UserScoreFilter;
214
+ static readonly Campaign: typeof CampaignFilter;
215
+ static readonly Age: typeof AgeFilter;
216
+ static readonly Gender: typeof GenderFilter;
217
+ static readonly Custom: typeof CustomFilter;
218
+ static readonly Device: typeof DeviceFilter;
219
+ static readonly Not: typeof NotFilter;
220
+ static readonly Or: typeof OrFilter;
221
+ static readonly And: typeof AndFilter;
222
+ }
223
+ declare abstract class RapidataSelection {
224
+ abstract toModel(): ISelection;
225
+ }
226
+ declare class LabelingSelection extends RapidataSelection {
227
+ readonly amount: number;
228
+ readonly retrievalMode: RapidataRetrievalMode;
229
+ readonly maxIterations?: number | undefined;
230
+ constructor(amount: number, retrievalMode?: RapidataRetrievalMode, maxIterations?: number | undefined);
231
+ toModel(): ISelection;
232
+ }
233
+ declare class ValidationSelection extends RapidataSelection {
234
+ readonly validationSetId: string;
235
+ readonly amount: number;
236
+ constructor(validationSetId: string, amount?: number);
237
+ toModel(): ISelection;
238
+ }
239
+ declare class ConditionalValidationSelection extends RapidataSelection {
240
+ readonly validationSetId: string;
241
+ readonly thresholds: number[];
242
+ readonly chances: number[];
243
+ readonly rapidCounts: number[];
244
+ readonly dimensions?: string[] | undefined;
245
+ constructor(validationSetId: string, thresholds: number[], chances: number[], rapidCounts: number[], dimensions?: string[] | undefined);
246
+ toModel(): ISelection;
247
+ }
248
+ declare class DemographicSelection extends RapidataSelection {
249
+ readonly keys: string[];
250
+ readonly maxRapids: number;
251
+ constructor(keys: string[], maxRapids: number);
252
+ toModel(): ISelection;
253
+ }
254
+ declare class CappedSelection extends RapidataSelection {
255
+ readonly selections: RapidataSelection[];
256
+ readonly maxRapids: number;
257
+ constructor(selections: RapidataSelection[], maxRapids: number);
258
+ toModel(): ISelection;
259
+ }
260
+ declare class ShufflingSelection extends RapidataSelection {
261
+ readonly selections: RapidataSelection[];
262
+ constructor(selections: RapidataSelection[]);
263
+ toModel(): ISelection;
264
+ }
265
+ declare class EffortSelection extends RapidataSelection {
266
+ readonly effortBudget: number;
267
+ readonly retrievalMode: RapidataRetrievalMode;
268
+ readonly maxIterations?: number | undefined;
269
+ constructor(effortBudget: number, retrievalMode?: RapidataRetrievalMode, maxIterations?: number | undefined);
270
+ toModel(): ISelection;
271
+ }
272
+ declare class StaticSelection extends RapidataSelection {
273
+ readonly rapidIds: string[];
274
+ constructor(rapidIds: string[]);
275
+ toModel(): ISelection;
276
+ }
277
+ declare class AbTestSelection extends RapidataSelection {
278
+ readonly aSelections: RapidataSelection[];
279
+ readonly bSelections: RapidataSelection[];
280
+ constructor(aSelections: RapidataSelection[], bSelections: RapidataSelection[]);
281
+ toModel(): ISelection;
282
+ }
283
+ declare class RapidataSelections {
284
+ static readonly Labeling: typeof LabelingSelection;
285
+ static readonly Validation: typeof ValidationSelection;
286
+ static readonly ConditionalValidation: typeof ConditionalValidationSelection;
287
+ static readonly Demographic: typeof DemographicSelection;
288
+ static readonly Capped: typeof CappedSelection;
289
+ static readonly Shuffling: typeof ShufflingSelection;
290
+ }
291
+ declare abstract class Referee {
292
+ abstract toModel(): IRefereeModel;
293
+ }
294
+ declare class NaiveReferee extends Referee {
295
+ readonly responses: number;
296
+ constructor(responses?: number);
297
+ toModel(): IRefereeModel;
298
+ }
299
+ declare class EarlyStoppingReferee extends Referee {
300
+ readonly threshold: number;
301
+ readonly maxResponses: number;
302
+ constructor(threshold?: number, maxResponses?: number);
303
+ toModel(): IRefereeModel;
304
+ }
305
+ declare class QuorumReferee extends Referee {
306
+ readonly threshold: number;
307
+ readonly maxVotes: number;
308
+ constructor(threshold?: number, maxVotes?: number);
309
+ toModel(): IRefereeModel;
310
+ }
311
+ declare abstract class Workflow {
312
+ readonly type: string;
313
+ constructor(type: string);
314
+ abstract toModel(): IOrderWorkflowModel;
315
+ abstract toPayload(datapoint: Datapoint): IRapidPayload;
316
+ abstract getInstruction(): string;
317
+ }
318
+ declare class ClassifyWorkflow extends Workflow {
319
+ readonly instruction: string;
320
+ readonly answerOptions: string[];
321
+ constructor(instruction: string, answerOptions: string[]);
322
+ toModel(): IOrderWorkflowModel;
323
+ toPayload(): IRapidPayload;
324
+ getInstruction(): string;
325
+ }
326
+ declare class CompareWorkflow extends Workflow {
327
+ readonly instruction: string;
328
+ readonly abNames?: string[] | undefined;
329
+ constructor(instruction: string, abNames?: string[] | undefined);
330
+ toModel(): IOrderWorkflowModel;
331
+ toPayload(): IRapidPayload;
332
+ getInstruction(): string;
333
+ }
334
+ declare class FreeTextWorkflow extends Workflow {
335
+ readonly instruction: string;
336
+ readonly validationSystemPrompt?: string | undefined;
337
+ constructor(instruction: string, validationSystemPrompt?: string | undefined);
338
+ toModel(): IOrderWorkflowModel;
339
+ toPayload(): IRapidPayload;
340
+ getInstruction(): string;
341
+ }
342
+ declare class SelectWordsWorkflow extends Workflow {
343
+ readonly instruction: string;
344
+ constructor(instruction: string);
345
+ toModel(): IOrderWorkflowModel;
346
+ toPayload(datapoint: Datapoint): IRapidPayload;
347
+ getInstruction(): string;
348
+ }
349
+ declare class LocateWorkflow extends Workflow {
350
+ readonly instruction: string;
351
+ constructor(instruction: string);
352
+ toModel(): IOrderWorkflowModel;
353
+ toPayload(): IRapidPayload;
354
+ getInstruction(): string;
355
+ }
356
+ declare class DrawWorkflow extends Workflow {
357
+ readonly instruction: string;
358
+ constructor(instruction: string);
359
+ toModel(): IOrderWorkflowModel;
360
+ toPayload(): IRapidPayload;
361
+ getInstruction(): string;
362
+ }
363
+ declare class TimestampWorkflow extends Workflow {
364
+ readonly instruction: string;
365
+ constructor(instruction: string);
366
+ toModel(): IOrderWorkflowModel;
367
+ toPayload(): IRapidPayload;
368
+ getInstruction(): string;
369
+ }
370
+ declare class MultiRankingWorkflow extends Workflow {
371
+ readonly instruction: string;
372
+ readonly comparisonBudgetPerRanking: number;
373
+ readonly randomComparisonsRatio: number;
374
+ readonly eloStart: number;
375
+ readonly eloKFactor: number;
376
+ readonly eloScalingFactor: number;
377
+ readonly contexts?: Record<string, string> | undefined;
378
+ readonly mediaContexts?: Record<string, IAssetInput> | undefined;
379
+ constructor(instruction: string, comparisonBudgetPerRanking: number, randomComparisonsRatio: number, eloStart?: number, eloKFactor?: number, eloScalingFactor?: number, contexts?: Record<string, string> | undefined, mediaContexts?: Record<string, IAssetInput> | undefined);
380
+ toModel(): IOrderWorkflowModel;
381
+ toPayload(): IRapidPayload;
382
+ getInstruction(): string;
383
+ }
384
+ interface ValidationRapid {
385
+ asset: string | string[];
386
+ payload: IRapidPayload;
387
+ dataType: DataType;
388
+ truth?: IValidationTruthModel;
389
+ context?: string;
390
+ mediaContext?: string;
391
+ sentence?: string;
392
+ randomCorrectProbability?: number;
393
+ explanation?: string;
394
+ settings?: RapidataSetting[];
395
+ }
396
+ declare class RapidsManager {
397
+ classificationRapid(options: {
398
+ instruction: string;
399
+ answerOptions: string[];
400
+ datapoint: string;
401
+ truths: string[];
402
+ dataType?: DataType;
403
+ context?: string;
404
+ mediaContext?: string;
405
+ explanation?: string;
406
+ }): ValidationRapid;
407
+ compareRapid(options: {
408
+ instruction: string;
409
+ truth: string;
410
+ datapoint: string[];
411
+ dataType?: DataType;
412
+ context?: string;
413
+ mediaContext?: string;
414
+ explanation?: string;
415
+ }): ValidationRapid;
416
+ selectWordsRapid(options: {
417
+ instruction: string;
418
+ truths: number[];
419
+ datapoint: string;
420
+ sentence: string;
421
+ requiredPrecision?: number;
422
+ requiredCompleteness?: number;
423
+ explanation?: string;
424
+ }): ValidationRapid;
425
+ locateRapid(options: {
426
+ instruction: string;
427
+ truths: Box[];
428
+ datapoint: string;
429
+ context?: string;
430
+ mediaContext?: string;
431
+ explanation?: string;
432
+ }): ValidationRapid;
433
+ drawRapid(options: {
434
+ instruction: string;
435
+ truths: Box[];
436
+ datapoint: string;
437
+ context?: string;
438
+ mediaContext?: string;
439
+ explanation?: string;
440
+ }): ValidationRapid;
441
+ timestampRapid(options: {
442
+ instruction: string;
443
+ truths: Array<[number, number]>;
444
+ datapoint: string;
445
+ context?: string;
446
+ mediaContext?: string;
447
+ explanation?: string;
448
+ }): ValidationRapid;
449
+ }
450
+ declare function mapDatapoints(options: {
451
+ datapoints: Array<string | string[]>;
452
+ contexts?: string[];
453
+ mediaContexts?: string[];
454
+ sentences?: string[];
455
+ privateMetadata?: Array<Record<string, string>>;
456
+ groups?: string[];
457
+ dataType?: DataType;
458
+ multiAsset?: boolean;
459
+ }): Datapoint[];
460
+ declare function createTextInput(assets: string | string[]): IAssetInput;
461
+ declare function createExistingAssetInput(uploadedNames: string | string[]): IAssetInput;
462
+
463
+ interface RapidataToken {
464
+ accessToken?: string;
465
+ access_token?: string;
466
+ tokenType?: string;
467
+ token_type?: string;
468
+ refreshToken?: string | null;
469
+ refresh_token?: string | null;
470
+ expiresIn?: number;
471
+ expires_in?: number;
472
+ expiresAt?: number;
473
+ expires_at?: number;
474
+ scope?: string | null;
475
+ obtainedAt?: number;
476
+ }
477
+ interface RapidataApiClientOptions {
478
+ clientId?: string;
479
+ clientSecret?: string;
480
+ environment?: string;
481
+ oauthScope?: string;
482
+ certPath?: string;
483
+ token?: RapidataToken;
484
+ leeway?: number;
485
+ }
486
+ interface RapidataClientOptions extends RapidataApiClientOptions {
487
+ }
488
+ declare class AssetUploader {
489
+ private readonly api;
490
+ private readonly cache;
491
+ constructor(api: RapidataApiClient);
492
+ clearCache(): void;
493
+ createAssetInput(asset: string | string[], dataType: DataType): Promise<IAssetInput>;
494
+ uploadAsset(asset: string): Promise<string>;
495
+ }
496
+ declare class RapidataApiClient {
497
+ readonly environment: string;
498
+ readonly apiBaseUrl: string;
499
+ readonly authBaseUrl: string;
500
+ readonly appBaseUrl: string;
501
+ readonly certPath?: string;
502
+ private readonly tokenProvider;
503
+ private readonly services;
504
+ private readonly credentialManager;
505
+ private readonly xClientHeader;
506
+ constructor(options?: RapidataApiClientOptions);
507
+ get asset(): any;
508
+ get audience(): any;
509
+ get benchmark(): any;
510
+ get campaign(): any;
511
+ get dataset(): any;
512
+ get examples(): any;
513
+ get flow(): any;
514
+ get identity(): any;
515
+ get job(): any;
516
+ get leaderboard(): any;
517
+ get order(): any;
518
+ get pipeline(): any;
519
+ get rapid(): any;
520
+ get rankingFlow(): any;
521
+ get rankingFlowItem(): any;
522
+ get flowItem(): any;
523
+ get validation(): any;
524
+ get workflow(): any;
525
+ getAccessToken(): Promise<string>;
526
+ getUserInfo(): Promise<Record<string, unknown>>;
527
+ resetCredentials(): Promise<void>;
528
+ fetch(url: string, init?: RequestInit): Promise<Response>;
529
+ private getService;
530
+ private withGeneratedConfiguration;
531
+ private getHeaders;
532
+ private readUnknownBody;
533
+ private dispatcherPromise?;
534
+ private getDispatcher;
535
+ }
536
+ type ClientContext = {
537
+ api: RapidataApiClient;
538
+ uploader: AssetUploader;
539
+ ready: Promise<void>;
540
+ appBaseUrl: string;
541
+ apiBaseUrl: string;
542
+ };
543
+ declare abstract class BaseEntity {
544
+ protected readonly context: ClientContext;
545
+ constructor(context: ClientContext);
546
+ protected openUrl(url: string): Promise<void>;
547
+ }
548
+ declare class RapidataOrder extends BaseEntity {
549
+ readonly id: string;
550
+ readonly name: string;
551
+ readonly orderDetailsPage: string;
552
+ createdAt?: Date;
553
+ pipelineId?: string;
554
+ campaignId?: string;
555
+ constructor(id: string, name: string, context: ClientContext, options?: {
556
+ createdAt?: Date;
557
+ pipelineId?: string;
558
+ campaignId?: string;
559
+ });
560
+ run(after?: RapidataOrder | string | null): Promise<this>;
561
+ pause(): Promise<void>;
562
+ unpause(): Promise<void>;
563
+ delete(): Promise<void>;
564
+ getStatus(): Promise<any>;
565
+ displayProgressBar(refreshRate?: number): Promise<void>;
566
+ getResults(preliminaryResults?: boolean): Promise<RapidataResults>;
567
+ view(): Promise<void>;
568
+ preview(): Promise<this>;
569
+ private getPreliminaryResults;
570
+ private getWorkflowProgress;
571
+ private loadPipelineArtifactIds;
572
+ }
573
+ declare class RapidataJobDefinition extends BaseEntity {
574
+ readonly id: string;
575
+ readonly name: string;
576
+ private readonly jobDetailsPage;
577
+ constructor(id: string, name: string, context: ClientContext);
578
+ preview(): Promise<this>;
579
+ updateDataset(datapoints: string[] | string[][], dataType?: DataType, contexts?: string[], mediaContexts?: string[], sentences?: string[], privateMetadata?: Array<Record<string, string>>): Promise<this>;
580
+ }
581
+ declare class RapidataJob extends BaseEntity {
582
+ readonly id: string;
583
+ readonly name: string;
584
+ readonly audienceId: string;
585
+ readonly jobDetailsPage: string;
586
+ completedAt?: Date;
587
+ pipelineId?: string;
588
+ constructor(id: string, name: string, audienceId: string, context: ClientContext, options?: {
589
+ completedAt?: Date;
590
+ pipelineId?: string;
591
+ });
592
+ getStatus(): Promise<any>;
593
+ getResults(): Promise<RapidataResults>;
594
+ displayProgressBar(refreshRate?: number): Promise<void>;
595
+ view(): Promise<void>;
596
+ private getWorkflowProgress;
597
+ }
598
+ declare class RapidataAudience extends BaseEntity {
599
+ readonly id: string;
600
+ private _name;
601
+ private _filters;
602
+ constructor(id: string, name: string, filters: IAudienceFilter[], context: ClientContext);
603
+ get name(): string;
604
+ get filters(): IAudienceFilter[];
605
+ updateFilters(filters: RapidataFilter[]): Promise<this>;
606
+ updateName(name: string): Promise<this>;
607
+ assignJob(jobDefinition: RapidataJobDefinition | string, options?: {
608
+ name?: string;
609
+ priority?: number;
610
+ revisionNumber?: number;
611
+ }): Promise<RapidataJob>;
612
+ addClassificationExample(instruction: string, answerOptions: string[], datapoint: string, truth: string, dataType?: DataType, context?: string, mediaContext?: string, explanation?: string): Promise<this>;
613
+ addCompareExample(instruction: string, truth: string, datapoint: string[], dataType?: DataType, context?: string, mediaContext?: string, explanation?: string): Promise<this>;
614
+ findJobs(name?: string, amount?: number): Promise<any>;
615
+ }
616
+ declare class RapidataValidationSet extends BaseEntity {
617
+ readonly id: string;
618
+ readonly name: string;
619
+ readonly dimensions: string[];
620
+ readonly validationSetDetailsPage: string;
621
+ constructor(id: string, name: string, dimensions: string[], context: ClientContext);
622
+ addRapid(rapid: ValidationRapid): Promise<this>;
623
+ updateDimensions(dimensions: string[]): Promise<this>;
624
+ updateShouldAlert(shouldAlert: boolean): Promise<this>;
625
+ updateCanBeFlagged(canBeFlagged: boolean): Promise<this>;
626
+ view(): Promise<void>;
627
+ delete(): Promise<void>;
628
+ }
629
+ declare class RapidataFlowItem extends BaseEntity {
630
+ readonly id: string;
631
+ readonly flowId: string;
632
+ constructor(id: string, flowId: string, context: ClientContext);
633
+ getResults(): Promise<any>;
634
+ stop(): Promise<void>;
635
+ }
636
+ declare class RapidataFlow extends BaseEntity {
637
+ readonly id: string;
638
+ readonly name: string;
639
+ constructor(id: string, name: string, context: ClientContext);
640
+ createNewFlowBatch(datapoints: string[] | string[][], contextText?: string, dataType?: DataType, privateMetadata?: Array<Record<string, string>>, acceptFailedUploads?: boolean, timeToLive?: number): Promise<RapidataFlowItem>;
641
+ getFlowItems(): Promise<any>;
642
+ updateConfig(instruction?: string, startingElo?: number, kFactor?: number, scalingFactor?: number): Promise<this>;
643
+ delete(): Promise<void>;
644
+ }
645
+ declare class RapidataOrderManager {
646
+ private readonly context;
647
+ constructor(context: ClientContext);
648
+ createClassificationOrder(name: string, instruction: string, answerOptions: string[], datapoints: string[], dataType?: DataType, responsesPerDatapoint?: number, contexts?: string[], mediaContexts?: string[], validationSetId?: string, confidenceThreshold?: number, quorumThreshold?: number, filters?: RapidataFilter[], settings?: RapidataSetting[], selections?: RapidataSelection[], privateMetadata?: Array<Record<string, string>>): Promise<RapidataOrder>;
649
+ createCompareOrder(name: string, instruction: string, datapoints: string[][], dataType?: DataType, responsesPerDatapoint?: number, contexts?: string[], mediaContexts?: string[], abNames?: string[], validationSetId?: string, confidenceThreshold?: number, quorumThreshold?: number, filters?: RapidataFilter[], settings?: RapidataSetting[], selections?: RapidataSelection[], privateMetadata?: Array<Record<string, string>>): Promise<RapidataOrder>;
650
+ createRankingOrder(name: string, instruction: string, datapoints: string[][], comparisonBudgetPerRanking: number, responsesPerComparison?: number, dataType?: DataType, randomComparisonsRatio?: number, contexts?: string[], mediaContexts?: string[], validationSetId?: string, filters?: RapidataFilter[], settings?: RapidataSetting[], selections?: RapidataSelection[]): Promise<RapidataOrder>;
651
+ createFreeTextOrder(name: string, instruction: string, datapoints: string[], dataType?: DataType, responsesPerDatapoint?: number, contexts?: string[], mediaContexts?: string[], filters?: RapidataFilter[], settings?: RapidataSetting[], selections?: RapidataSelection[], privateMetadata?: Array<Record<string, string>>): Promise<RapidataOrder>;
652
+ createSelectWordsOrder(name: string, instruction: string, datapoints: string[], sentences: string[], responsesPerDatapoint?: number, mediaContexts?: string[], validationSetId?: string, filters?: RapidataFilter[], settings?: RapidataSetting[], selections?: RapidataSelection[], privateMetadata?: Array<Record<string, string>>): Promise<RapidataOrder>;
653
+ createLocateOrder(name: string, instruction: string, datapoints: string[], responsesPerDatapoint?: number, contexts?: string[], mediaContexts?: string[], validationSetId?: string, filters?: RapidataFilter[], settings?: RapidataSetting[], selections?: RapidataSelection[], privateMetadata?: Array<Record<string, string>>): Promise<RapidataOrder>;
654
+ createDrawOrder(name: string, instruction: string, datapoints: string[], responsesPerDatapoint?: number, contexts?: string[], mediaContexts?: string[], validationSetId?: string, filters?: RapidataFilter[], settings?: RapidataSetting[], selections?: RapidataSelection[], privateMetadata?: Array<Record<string, string>>): Promise<RapidataOrder>;
655
+ createTimestampOrder(name: string, instruction: string, datapoints: string[], responsesPerDatapoint?: number, contexts?: string[], mediaContexts?: string[], validationSetId?: string, filters?: RapidataFilter[], settings?: RapidataSetting[], selections?: RapidataSelection[], privateMetadata?: Array<Record<string, string>>): Promise<RapidataOrder>;
656
+ getOrderById(orderId: string): Promise<RapidataOrder>;
657
+ findOrders(name?: string, amount?: number): Promise<any>;
658
+ }
659
+ declare class RapidataAudienceManager {
660
+ private readonly context;
661
+ constructor(context: ClientContext);
662
+ createAudience(name: string, filters?: RapidataFilter[]): Promise<RapidataAudience>;
663
+ getAudienceById(audienceId: string): Promise<RapidataAudience>;
664
+ findAudiences(name?: string, amount?: number): Promise<any>;
665
+ }
666
+ declare class RapidataJobManager {
667
+ private readonly context;
668
+ constructor(context: ClientContext);
669
+ createClassificationJobDefinition(name: string, instruction: string, answerOptions: string[], datapoints: string[], dataType?: DataType, responsesPerDatapoint?: number, contexts?: string[], mediaContexts?: string[], confidenceThreshold?: number, quorumThreshold?: number, settings?: RapidataSetting[], privateMetadata?: Array<Record<string, string>>): Promise<RapidataJobDefinition>;
670
+ createCompareJobDefinition(name: string, instruction: string, datapoints: string[][], dataType?: DataType, responsesPerDatapoint?: number, contexts?: string[], mediaContexts?: string[], abNames?: string[], confidenceThreshold?: number, quorumThreshold?: number, settings?: RapidataSetting[], privateMetadata?: Array<Record<string, string>>): Promise<RapidataJobDefinition>;
671
+ getJobDefinitionById(jobDefinitionId: string): Promise<RapidataJobDefinition>;
672
+ findJobDefinitions(name?: string, amount?: number): Promise<any>;
673
+ getJobById(jobId: string): Promise<RapidataJob>;
674
+ findJobs(name?: string, amount?: number): Promise<any>;
675
+ }
676
+ declare class ValidationSetManager {
677
+ private readonly context;
678
+ readonly rapids: RapidsManager;
679
+ constructor(context: ClientContext);
680
+ createClassificationSet(name: string, instruction: string, answerOptions: string[], datapoints: string[], truths: string[][], dataType?: DataType, contexts?: string[], mediaContexts?: string[], explanations?: string[], dimensions?: string[]): Promise<RapidataValidationSet>;
681
+ createCompareSet(name: string, instruction: string, datapoints: string[][], truths: string[], dataType?: DataType, contexts?: string[], mediaContexts?: string[], explanation?: string, dimensions?: string[]): Promise<RapidataValidationSet>;
682
+ createSelectWordsSet(name: string, instruction: string, truths: number[][], datapoints: string[], sentences: string[], requiredPrecision?: number, requiredCompleteness?: number, explanation?: string, dimensions?: string[]): Promise<RapidataValidationSet>;
683
+ createLocateSet(name: string, instruction: string, truths: Box[][], datapoints: string[], contexts?: string[], mediaContexts?: string[], explanation?: string, dimensions?: string[]): Promise<RapidataValidationSet>;
684
+ createDrawSet(name: string, instruction: string, truths: Box[][], datapoints: string[], contexts?: string[], mediaContexts?: string[], explanation?: string, dimensions?: string[]): Promise<RapidataValidationSet>;
685
+ createTimestampSet(name: string, instruction: string, truths: Array<Array<[number, number]>>, datapoints: string[], contexts?: string[], mediaContexts?: string[], explanation?: string, dimensions?: string[]): Promise<RapidataValidationSet>;
686
+ createMixedSet(name: string, rapids: ValidationRapid[], dimensions?: string[]): Promise<RapidataValidationSet>;
687
+ getValidationSetById(validationSetId: string): Promise<RapidataValidationSet>;
688
+ findValidationSets(name?: string, amount?: number): Promise<any>;
689
+ }
690
+ declare class RapidataFlowManager {
691
+ private readonly context;
692
+ constructor(context: ClientContext);
693
+ createRankingFlow(name: string, instruction: string, maxResponseThreshold?: number, minResponseThreshold?: number, validationSetId?: string, settings?: RapidataSetting[]): Promise<RapidataFlow>;
694
+ getFlowById(flowId: string): Promise<RapidataFlow>;
695
+ findFlows(amount?: number): Promise<any>;
696
+ }
697
+ declare class RapidataBenchmarkManager {
698
+ readonly api: Pick<RapidataApiClient, "benchmark" | "leaderboard">;
699
+ constructor(api: Pick<RapidataApiClient, "benchmark" | "leaderboard">);
700
+ }
701
+ declare class RapidataClient {
702
+ readonly api: RapidataApiClient;
703
+ readonly order: RapidataOrderManager;
704
+ readonly validation: ValidationSetManager;
705
+ readonly flow: RapidataFlowManager;
706
+ readonly job: RapidataJobManager;
707
+ readonly mri: RapidataBenchmarkManager;
708
+ readonly audience: RapidataAudienceManager;
709
+ private readonly uploader;
710
+ private readonly context;
711
+ readonly ready: Promise<void>;
712
+ constructor(options?: RapidataClientOptions);
713
+ resetCredentials(): Promise<void>;
714
+ clearAllCaches(): void;
715
+ private initialize;
716
+ private checkBetaFeatures;
717
+ private checkVersion;
718
+ }
719
+
720
+ type LogLevel = "debug" | "info" | "warn" | "error";
721
+ interface RapidataRuntimeConfig {
722
+ enableBetaFeatures: boolean;
723
+ logging: {
724
+ level: LogLevel;
725
+ silentMode: boolean;
726
+ enableOtlp: boolean;
727
+ };
728
+ upload: {
729
+ cacheToDisk: boolean;
730
+ cacheLocation: string;
731
+ maxWorkers: number;
732
+ batchSize: number;
733
+ batchPollInterval: number;
734
+ };
735
+ }
736
+ declare const rapidataConfig: RapidataRuntimeConfig;
737
+ declare const logger: {
738
+ debug(message: string, ...args: unknown[]): void;
739
+ info(message: string, ...args: unknown[]): void;
740
+ warn(message: string, ...args: unknown[]): void;
741
+ error(message: string, ...args: unknown[]): void;
742
+ };
743
+ declare function managedPrint(...args: unknown[]): void;
744
+ declare class RapidataTracer {
745
+ private readonly tracer;
746
+ private sessionId?;
747
+ private userInfo?;
748
+ setSessionId(sessionId: string): void;
749
+ setUserInfo(userInfo: {
750
+ clientId?: string;
751
+ email?: string;
752
+ }): void;
753
+ startActiveSpan<T>(name: string, fn: () => Promise<T>): Promise<T>;
754
+ }
755
+ declare const tracer: RapidataTracer;
756
+
757
+ declare class RapidataError extends Error {
758
+ readonly statusCode?: number;
759
+ readonly details?: unknown;
760
+ readonly originalError?: unknown;
761
+ constructor(message: string, options?: {
762
+ statusCode?: number;
763
+ details?: unknown;
764
+ originalError?: unknown;
765
+ });
766
+ }
767
+ declare class FailedUpload<T> {
768
+ readonly item: T;
769
+ readonly errorType: string;
770
+ readonly errorMessage: string;
771
+ constructor(item: T, errorType: string, errorMessage: string);
772
+ static fromException<T>(item: T, error: unknown): FailedUpload<T>;
773
+ }
774
+ declare class FailedUploadException<T> extends Error {
775
+ readonly failedUploads: Array<FailedUpload<T>>;
776
+ readonly datasetId?: string;
777
+ readonly orderId?: string;
778
+ readonly jobDefinitionId?: string;
779
+ constructor(message: string, options: {
780
+ failedUploads: Array<FailedUpload<T>>;
781
+ datasetId?: string;
782
+ orderId?: string;
783
+ jobDefinitionId?: string;
784
+ });
785
+ }
786
+
787
+ declare const SDK_VERSION = "0.1.0";
788
+
789
+ export { AbTestSelection, AgeFilter, AgeGroup, AlertOnFastResponse, AlertOnFastResponseSetting, AllowNeitherBoth, AllowNeitherBothSetting, AndFilter, Box, CampaignFilter, CappedSelection, ClassifyWorkflow, CompareWorkflow, ConditionalValidationSelection, CountryFilter, CustomFilter, CustomSetting, type DataType, Datapoint, DemographicSelection, DeviceFilter, DeviceType, DrawWorkflow, EarlyStoppingReferee, EffortSelection, FailedUpload, FailedUploadException, FreeTextMinimumCharacters, FreeTextMinimumCharactersSetting, FreeTextWorkflow, Gender, GenderFilter, type JsonObject, LabelingSelection, LanguageFilter, LocateWorkflow, type LogLevel, Markdown, MarkdownSetting, MultiRankingWorkflow, MuteVideo, MuteVideoSetting, NaiveReferee, NoShuffle, NoShuffleSetting, NotFilter, OrFilter, PlayVideoUntilTheEnd, PlayVideoUntilTheEndSetting, QuorumReferee, RapidataApiClient, RapidataAudience, RapidataAudienceManager, RapidataBenchmarkManager, RapidataClient, RapidataError, RapidataFilters, RapidataFlow, RapidataFlowItem, RapidataFlowManager, RapidataJob, RapidataJobDefinition, RapidataJobManager, RapidataOrder, RapidataOrderManager, RapidataResults, RapidataRetrievalMode, type RapidataRuntimeConfig, RapidataSelection, RapidataSelections, RapidataSetting, RapidataSettings, RapidataValidationSet, RapidsManager, SDK_VERSION, SelectWordsWorkflow, ShufflingSelection, StaticSelection, SwapContextInstruction, SwapContextInstructionSetting, TimestampWorkflow, TranslationBehaviour, TranslationBehaviourOptions, TranslationBehaviourSetting, UserScoreFilter, type ValidationRapid, ValidationSelection, ValidationSetManager, Workflow, createExistingAssetInput, createTextInput, logger, managedPrint, mapDatapoints, rapidataConfig, tracer };