opik 1.6.9 → 1.6.10
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/dist/{Client-BaUfACuw.d.cts → Client-b-rflrP-.d.cts} +433 -165
- package/dist/{Client-BaUfACuw.d.ts → Client-b-rflrP-.d.ts} +433 -165
- package/dist/chunk-5DWIBQL7.js +4 -0
- package/dist/index.cjs +4 -4
- package/dist/index.d.cts +2 -2
- package/dist/index.d.ts +2 -2
- package/dist/index.js +1 -1
- package/dist/vercel/index.cjs +4 -4
- package/dist/vercel/index.d.cts +1 -1
- package/dist/vercel/index.d.ts +1 -1
- package/dist/vercel/index.js +1 -1
- package/package.json +1 -1
- package/dist/chunk-VKSRW22X.js +0 -4
|
@@ -7,6 +7,112 @@ interface OpikConfig {
|
|
|
7
7
|
workspaceName: string;
|
|
8
8
|
}
|
|
9
9
|
|
|
10
|
+
/**
|
|
11
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
12
|
+
*/
|
|
13
|
+
type CompleteMultipartUploadRequestEntityType = "trace" | "span";
|
|
14
|
+
declare const CompleteMultipartUploadRequestEntityType: {
|
|
15
|
+
readonly Trace: "trace";
|
|
16
|
+
readonly Span: "span";
|
|
17
|
+
};
|
|
18
|
+
|
|
19
|
+
/**
|
|
20
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
21
|
+
*/
|
|
22
|
+
type StartMultipartUploadRequestEntityType = "trace" | "span";
|
|
23
|
+
declare const StartMultipartUploadRequestEntityType: {
|
|
24
|
+
readonly Trace: "trace";
|
|
25
|
+
readonly Span: "span";
|
|
26
|
+
};
|
|
27
|
+
|
|
28
|
+
/**
|
|
29
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
30
|
+
*/
|
|
31
|
+
type UploadAttachmentRequestEntityType = "trace" | "span";
|
|
32
|
+
declare const UploadAttachmentRequestEntityType: {
|
|
33
|
+
readonly Trace: "trace";
|
|
34
|
+
readonly Span: "span";
|
|
35
|
+
};
|
|
36
|
+
|
|
37
|
+
/**
|
|
38
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
39
|
+
*/
|
|
40
|
+
|
|
41
|
+
/**
|
|
42
|
+
* @example
|
|
43
|
+
* {
|
|
44
|
+
* fileName: "file_name",
|
|
45
|
+
* entityType: "trace",
|
|
46
|
+
* entityId: "entity_id",
|
|
47
|
+
* fileSize: 1000000,
|
|
48
|
+
* uploadId: "upload_id",
|
|
49
|
+
* uploadedFileParts: [{
|
|
50
|
+
* eTag: "e_tag",
|
|
51
|
+
* partNumber: 1
|
|
52
|
+
* }]
|
|
53
|
+
* }
|
|
54
|
+
*/
|
|
55
|
+
interface CompleteMultipartUploadRequest {
|
|
56
|
+
fileName: string;
|
|
57
|
+
/** If null, the default project is used */
|
|
58
|
+
projectName?: string;
|
|
59
|
+
entityType: CompleteMultipartUploadRequestEntityType;
|
|
60
|
+
entityId: string;
|
|
61
|
+
fileSize: number;
|
|
62
|
+
mimeType?: string;
|
|
63
|
+
uploadId: string;
|
|
64
|
+
uploadedFileParts: MultipartUploadPart[];
|
|
65
|
+
}
|
|
66
|
+
|
|
67
|
+
/**
|
|
68
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
69
|
+
*/
|
|
70
|
+
|
|
71
|
+
/**
|
|
72
|
+
* @example
|
|
73
|
+
* {
|
|
74
|
+
* fileName: "file_name",
|
|
75
|
+
* numOfFileParts: 1,
|
|
76
|
+
* entityType: "trace",
|
|
77
|
+
* entityId: "entity_id",
|
|
78
|
+
* path: "path"
|
|
79
|
+
* }
|
|
80
|
+
*/
|
|
81
|
+
interface StartMultipartUploadRequest {
|
|
82
|
+
fileName: string;
|
|
83
|
+
numOfFileParts: number;
|
|
84
|
+
mimeType?: string;
|
|
85
|
+
/** If null, the default project is used */
|
|
86
|
+
projectName?: string;
|
|
87
|
+
entityType: StartMultipartUploadRequestEntityType;
|
|
88
|
+
entityId: string;
|
|
89
|
+
path: string;
|
|
90
|
+
}
|
|
91
|
+
|
|
92
|
+
/**
|
|
93
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
94
|
+
*/
|
|
95
|
+
|
|
96
|
+
/**
|
|
97
|
+
* @example
|
|
98
|
+
* {
|
|
99
|
+
* fileName: "file_name",
|
|
100
|
+
* entityType: "trace",
|
|
101
|
+
* entityId: "entity_id",
|
|
102
|
+
* body: {
|
|
103
|
+
* "key": "value"
|
|
104
|
+
* }
|
|
105
|
+
* }
|
|
106
|
+
*/
|
|
107
|
+
interface UploadAttachmentRequest {
|
|
108
|
+
fileName: string;
|
|
109
|
+
projectName?: string;
|
|
110
|
+
mimeType?: string;
|
|
111
|
+
entityType: UploadAttachmentRequestEntityType;
|
|
112
|
+
entityId: string;
|
|
113
|
+
body: Record<string, unknown>;
|
|
114
|
+
}
|
|
115
|
+
|
|
10
116
|
/**
|
|
11
117
|
* This file was auto-generated by Fern from our API Definition.
|
|
12
118
|
*/
|
|
@@ -345,6 +451,7 @@ interface GetSpansByProjectRequest {
|
|
|
345
451
|
type?: GetSpansByProjectRequestType;
|
|
346
452
|
filters?: string;
|
|
347
453
|
truncate?: boolean;
|
|
454
|
+
sorting?: string;
|
|
348
455
|
}
|
|
349
456
|
|
|
350
457
|
/**
|
|
@@ -434,6 +541,7 @@ interface SpanSearchStreamRequestPublic {
|
|
|
434
541
|
projectId?: string;
|
|
435
542
|
type?: SpanSearchStreamRequestPublicType;
|
|
436
543
|
filters?: SpanFilterPublic[];
|
|
544
|
+
/** Max number of spans to be streamed */
|
|
437
545
|
limit?: number;
|
|
438
546
|
lastRetrievedId?: string;
|
|
439
547
|
/** Truncate image included in either input, output or metadata */
|
|
@@ -461,14 +569,13 @@ interface FindEvaluatorsRequest {
|
|
|
461
569
|
/**
|
|
462
570
|
* @example
|
|
463
571
|
* {
|
|
464
|
-
* projectId: "project_id",
|
|
465
572
|
* body: {
|
|
466
573
|
* ids: ["ids"]
|
|
467
574
|
* }
|
|
468
575
|
* }
|
|
469
576
|
*/
|
|
470
577
|
interface DeleteAutomationRuleEvaluatorBatchRequest {
|
|
471
|
-
projectId
|
|
578
|
+
projectId?: string;
|
|
472
579
|
body: BatchDelete;
|
|
473
580
|
}
|
|
474
581
|
|
|
@@ -494,30 +601,6 @@ interface GetEvaluatorLogsByIdRequest {
|
|
|
494
601
|
size?: number;
|
|
495
602
|
}
|
|
496
603
|
|
|
497
|
-
/**
|
|
498
|
-
* This file was auto-generated by Fern from our API Definition.
|
|
499
|
-
*/
|
|
500
|
-
/**
|
|
501
|
-
* @example
|
|
502
|
-
* {}
|
|
503
|
-
*/
|
|
504
|
-
interface FindEvaluatorsDeprecatedRequest {
|
|
505
|
-
name?: string;
|
|
506
|
-
page?: number;
|
|
507
|
-
size?: number;
|
|
508
|
-
}
|
|
509
|
-
|
|
510
|
-
/**
|
|
511
|
-
* This file was auto-generated by Fern from our API Definition.
|
|
512
|
-
*/
|
|
513
|
-
/**
|
|
514
|
-
* @example
|
|
515
|
-
* {}
|
|
516
|
-
*/
|
|
517
|
-
interface GetEvaluatorLogsByIdDeprecatedRequest {
|
|
518
|
-
size?: number;
|
|
519
|
-
}
|
|
520
|
-
|
|
521
604
|
/**
|
|
522
605
|
* This file was auto-generated by Fern from our API Definition.
|
|
523
606
|
*/
|
|
@@ -949,6 +1032,71 @@ interface GetTraceThreadsRequest {
|
|
|
949
1032
|
filters?: string;
|
|
950
1033
|
}
|
|
951
1034
|
|
|
1035
|
+
/**
|
|
1036
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
1037
|
+
*/
|
|
1038
|
+
|
|
1039
|
+
interface TraceSearchStreamRequestPublic {
|
|
1040
|
+
projectName?: string;
|
|
1041
|
+
projectId?: string;
|
|
1042
|
+
filters?: TraceFilterPublic[];
|
|
1043
|
+
lastRetrievedId?: string;
|
|
1044
|
+
/** Max number of traces to be streamed */
|
|
1045
|
+
limit?: number;
|
|
1046
|
+
/** Truncate image included in either input, output or metadata */
|
|
1047
|
+
truncate?: boolean;
|
|
1048
|
+
}
|
|
1049
|
+
|
|
1050
|
+
/**
|
|
1051
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
1052
|
+
*/
|
|
1053
|
+
/**
|
|
1054
|
+
* @example
|
|
1055
|
+
* {
|
|
1056
|
+
* datasetId: "dataset_id",
|
|
1057
|
+
* path: "path"
|
|
1058
|
+
* }
|
|
1059
|
+
*/
|
|
1060
|
+
interface DatasetsRedirectRequest {
|
|
1061
|
+
datasetId: string;
|
|
1062
|
+
workspaceName?: string;
|
|
1063
|
+
path: string;
|
|
1064
|
+
}
|
|
1065
|
+
|
|
1066
|
+
/**
|
|
1067
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
1068
|
+
*/
|
|
1069
|
+
/**
|
|
1070
|
+
* @example
|
|
1071
|
+
* {
|
|
1072
|
+
* datasetId: "dataset_id",
|
|
1073
|
+
* experimentId: "experiment_id",
|
|
1074
|
+
* path: "path"
|
|
1075
|
+
* }
|
|
1076
|
+
*/
|
|
1077
|
+
interface ExperimentsRedirectRequest {
|
|
1078
|
+
datasetId: string;
|
|
1079
|
+
experimentId: string;
|
|
1080
|
+
workspaceName?: string;
|
|
1081
|
+
path: string;
|
|
1082
|
+
}
|
|
1083
|
+
|
|
1084
|
+
/**
|
|
1085
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
1086
|
+
*/
|
|
1087
|
+
/**
|
|
1088
|
+
* @example
|
|
1089
|
+
* {
|
|
1090
|
+
* traceId: "trace_id",
|
|
1091
|
+
* path: "path"
|
|
1092
|
+
* }
|
|
1093
|
+
*/
|
|
1094
|
+
interface ProjectsRedirectRequest {
|
|
1095
|
+
traceId: string;
|
|
1096
|
+
workspaceName?: string;
|
|
1097
|
+
path: string;
|
|
1098
|
+
}
|
|
1099
|
+
|
|
952
1100
|
/**
|
|
953
1101
|
* This file was auto-generated by Fern from our API Definition.
|
|
954
1102
|
*/
|
|
@@ -966,6 +1114,22 @@ interface BiInformationResponse {
|
|
|
966
1114
|
biInformation?: BiInformation[];
|
|
967
1115
|
}
|
|
968
1116
|
|
|
1117
|
+
/**
|
|
1118
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
1119
|
+
*/
|
|
1120
|
+
|
|
1121
|
+
interface SpansCountResponse {
|
|
1122
|
+
workspacesSpansCount?: WorkspaceSpansCount[];
|
|
1123
|
+
}
|
|
1124
|
+
|
|
1125
|
+
/**
|
|
1126
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
1127
|
+
*/
|
|
1128
|
+
interface WorkspaceSpansCount {
|
|
1129
|
+
workspace?: string;
|
|
1130
|
+
spanCount?: number;
|
|
1131
|
+
}
|
|
1132
|
+
|
|
969
1133
|
/**
|
|
970
1134
|
* This file was auto-generated by Fern from our API Definition.
|
|
971
1135
|
*/
|
|
@@ -982,11 +1146,34 @@ interface WorkspaceTraceCount {
|
|
|
982
1146
|
traceCount?: number;
|
|
983
1147
|
}
|
|
984
1148
|
|
|
1149
|
+
/**
|
|
1150
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
1151
|
+
*/
|
|
1152
|
+
interface MultipartUploadPart {
|
|
1153
|
+
eTag: string;
|
|
1154
|
+
partNumber: number;
|
|
1155
|
+
}
|
|
1156
|
+
|
|
1157
|
+
/**
|
|
1158
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
1159
|
+
*/
|
|
1160
|
+
interface StartMultipartUploadResponse {
|
|
1161
|
+
uploadId: string;
|
|
1162
|
+
preSignUrls: string[];
|
|
1163
|
+
}
|
|
1164
|
+
|
|
985
1165
|
/**
|
|
986
1166
|
* This file was auto-generated by Fern from our API Definition.
|
|
987
1167
|
*/
|
|
988
1168
|
type AuthDetailsHolder = Record<string, unknown>;
|
|
989
1169
|
|
|
1170
|
+
/**
|
|
1171
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
1172
|
+
*/
|
|
1173
|
+
interface WorkspaceNameHolder {
|
|
1174
|
+
workspaceName?: string;
|
|
1175
|
+
}
|
|
1176
|
+
|
|
990
1177
|
/**
|
|
991
1178
|
* This file was auto-generated by Fern from our API Definition.
|
|
992
1179
|
*/
|
|
@@ -2348,6 +2535,7 @@ interface SpanPagePublic {
|
|
|
2348
2535
|
size?: number;
|
|
2349
2536
|
total?: number;
|
|
2350
2537
|
content?: SpanPublic[];
|
|
2538
|
+
sortableBy?: string[];
|
|
2351
2539
|
}
|
|
2352
2540
|
|
|
2353
2541
|
/**
|
|
@@ -2445,7 +2633,7 @@ interface FeedbackScoreBatchItem {
|
|
|
2445
2633
|
/**
|
|
2446
2634
|
* This file was auto-generated by Fern from our API Definition.
|
|
2447
2635
|
*/
|
|
2448
|
-
type SpanFilterPublicOperator = "contains" | "not_contains" | "starts_with" | "ends_with" | "=" | "!=" | ">" | ">=" | "<" | "<=";
|
|
2636
|
+
type SpanFilterPublicOperator = "contains" | "not_contains" | "starts_with" | "ends_with" | "=" | "!=" | ">" | ">=" | "<" | "<=" | "is_empty" | "is_not_empty";
|
|
2449
2637
|
declare const SpanFilterPublicOperator: {
|
|
2450
2638
|
readonly Contains: "contains";
|
|
2451
2639
|
readonly NotContains: "not_contains";
|
|
@@ -2457,6 +2645,8 @@ declare const SpanFilterPublicOperator: {
|
|
|
2457
2645
|
readonly GreaterThanOrEqualTo: ">=";
|
|
2458
2646
|
readonly LessThan: "<";
|
|
2459
2647
|
readonly LessThanOrEqualTo: "<=";
|
|
2648
|
+
readonly IsEmpty: "is_empty";
|
|
2649
|
+
readonly IsNotEmpty: "is_not_empty";
|
|
2460
2650
|
};
|
|
2461
2651
|
|
|
2462
2652
|
/**
|
|
@@ -2495,6 +2685,7 @@ interface Trace$1 {
|
|
|
2495
2685
|
feedbackScores?: FeedbackScore[];
|
|
2496
2686
|
comments?: Comment[];
|
|
2497
2687
|
totalEstimatedCost?: number;
|
|
2688
|
+
spanCount?: number;
|
|
2498
2689
|
/** Duration in milliseconds as a decimal number to support sub-millisecond precision */
|
|
2499
2690
|
duration?: number;
|
|
2500
2691
|
threadId?: string;
|
|
@@ -2542,6 +2733,7 @@ interface TracePublic {
|
|
|
2542
2733
|
feedbackScores?: FeedbackScorePublic[];
|
|
2543
2734
|
comments?: CommentPublic[];
|
|
2544
2735
|
totalEstimatedCost?: number;
|
|
2736
|
+
spanCount?: number;
|
|
2545
2737
|
/** Duration in milliseconds as a decimal number to support sub-millisecond precision */
|
|
2546
2738
|
duration?: number;
|
|
2547
2739
|
threadId?: string;
|
|
@@ -2591,8 +2783,31 @@ interface TracePagePublic {
|
|
|
2591
2783
|
/**
|
|
2592
2784
|
* This file was auto-generated by Fern from our API Definition.
|
|
2593
2785
|
*/
|
|
2594
|
-
|
|
2595
|
-
|
|
2786
|
+
type TraceFilterPublicOperator = "contains" | "not_contains" | "starts_with" | "ends_with" | "=" | "!=" | ">" | ">=" | "<" | "<=" | "is_empty" | "is_not_empty";
|
|
2787
|
+
declare const TraceFilterPublicOperator: {
|
|
2788
|
+
readonly Contains: "contains";
|
|
2789
|
+
readonly NotContains: "not_contains";
|
|
2790
|
+
readonly StartsWith: "starts_with";
|
|
2791
|
+
readonly EndsWith: "ends_with";
|
|
2792
|
+
readonly EqualTo: "=";
|
|
2793
|
+
readonly NotEquals: "!=";
|
|
2794
|
+
readonly GreaterThan: ">";
|
|
2795
|
+
readonly GreaterThanOrEqualTo: ">=";
|
|
2796
|
+
readonly LessThan: "<";
|
|
2797
|
+
readonly LessThanOrEqualTo: "<=";
|
|
2798
|
+
readonly IsEmpty: "is_empty";
|
|
2799
|
+
readonly IsNotEmpty: "is_not_empty";
|
|
2800
|
+
};
|
|
2801
|
+
|
|
2802
|
+
/**
|
|
2803
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
2804
|
+
*/
|
|
2805
|
+
|
|
2806
|
+
interface TraceFilterPublic {
|
|
2807
|
+
field?: string;
|
|
2808
|
+
operator?: TraceFilterPublicOperator;
|
|
2809
|
+
key?: string;
|
|
2810
|
+
value?: string;
|
|
2596
2811
|
}
|
|
2597
2812
|
|
|
2598
2813
|
/**
|
|
@@ -2661,6 +2876,15 @@ declare class SystemUsage {
|
|
|
2661
2876
|
* await client.systemUsage.getExperimentBiInfo()
|
|
2662
2877
|
*/
|
|
2663
2878
|
getExperimentBiInfo(requestOptions?: SystemUsage.RequestOptions): Promise<BiInformationResponse>;
|
|
2879
|
+
/**
|
|
2880
|
+
* Get spans count on previous day for all available workspaces
|
|
2881
|
+
*
|
|
2882
|
+
* @param {SystemUsage.RequestOptions} requestOptions - Request-specific configuration.
|
|
2883
|
+
*
|
|
2884
|
+
* @example
|
|
2885
|
+
* await client.systemUsage.getSpansCountForWorkspaces()
|
|
2886
|
+
*/
|
|
2887
|
+
getSpansCountForWorkspaces(requestOptions?: SystemUsage.RequestOptions): Promise<SpansCountResponse>;
|
|
2664
2888
|
/**
|
|
2665
2889
|
* Get traces information for BI events per user per workspace
|
|
2666
2890
|
*
|
|
@@ -2684,6 +2908,108 @@ declare class SystemUsage {
|
|
|
2684
2908
|
}>;
|
|
2685
2909
|
}
|
|
2686
2910
|
|
|
2911
|
+
/**
|
|
2912
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
2913
|
+
*/
|
|
2914
|
+
|
|
2915
|
+
declare namespace Attachments {
|
|
2916
|
+
interface Options {
|
|
2917
|
+
environment?: Supplier<OpikApiEnvironment | string>;
|
|
2918
|
+
/** Specify a custom URL to connect the client to. */
|
|
2919
|
+
baseUrl?: Supplier<string>;
|
|
2920
|
+
/** Override the Authorization header */
|
|
2921
|
+
apiKey?: Supplier<string | undefined>;
|
|
2922
|
+
/** Override the Comet-Workspace header */
|
|
2923
|
+
workspaceName?: Supplier<string | undefined>;
|
|
2924
|
+
}
|
|
2925
|
+
interface RequestOptions {
|
|
2926
|
+
/** The maximum time to wait for a response in seconds. */
|
|
2927
|
+
timeoutInSeconds?: number;
|
|
2928
|
+
/** The number of times to retry the request. Defaults to 2. */
|
|
2929
|
+
maxRetries?: number;
|
|
2930
|
+
/** A hook to abort the request. */
|
|
2931
|
+
abortSignal?: AbortSignal;
|
|
2932
|
+
/** Override the Authorization header */
|
|
2933
|
+
apiKey?: string | undefined;
|
|
2934
|
+
/** Override the Comet-Workspace header */
|
|
2935
|
+
workspaceName?: string | undefined;
|
|
2936
|
+
/** Additional headers to include in the request. */
|
|
2937
|
+
headers?: Record<string, string>;
|
|
2938
|
+
}
|
|
2939
|
+
}
|
|
2940
|
+
/**
|
|
2941
|
+
* Attachments related resources
|
|
2942
|
+
*/
|
|
2943
|
+
declare class Attachments {
|
|
2944
|
+
protected readonly _options: Attachments.Options;
|
|
2945
|
+
constructor(_options?: Attachments.Options);
|
|
2946
|
+
/**
|
|
2947
|
+
* Start multipart attachment upload
|
|
2948
|
+
*
|
|
2949
|
+
* @param {OpikApi.CompleteMultipartUploadRequest} request
|
|
2950
|
+
* @param {Attachments.RequestOptions} requestOptions - Request-specific configuration.
|
|
2951
|
+
*
|
|
2952
|
+
* @throws {@link OpikApi.UnauthorizedError}
|
|
2953
|
+
* @throws {@link OpikApi.ForbiddenError}
|
|
2954
|
+
*
|
|
2955
|
+
* @example
|
|
2956
|
+
* await client.attachments.startMultiPartUpload({
|
|
2957
|
+
* fileName: "file_name",
|
|
2958
|
+
* entityType: "trace",
|
|
2959
|
+
* entityId: "entity_id",
|
|
2960
|
+
* fileSize: 1000000,
|
|
2961
|
+
* uploadId: "upload_id",
|
|
2962
|
+
* uploadedFileParts: [{
|
|
2963
|
+
* eTag: "e_tag",
|
|
2964
|
+
* partNumber: 1
|
|
2965
|
+
* }]
|
|
2966
|
+
* })
|
|
2967
|
+
*/
|
|
2968
|
+
startMultiPartUpload(request: CompleteMultipartUploadRequest, requestOptions?: Attachments.RequestOptions): Promise<void>;
|
|
2969
|
+
/**
|
|
2970
|
+
* Start multipart attachment upload
|
|
2971
|
+
*
|
|
2972
|
+
* @param {OpikApi.StartMultipartUploadRequest} request
|
|
2973
|
+
* @param {Attachments.RequestOptions} requestOptions - Request-specific configuration.
|
|
2974
|
+
*
|
|
2975
|
+
* @throws {@link OpikApi.UnauthorizedError}
|
|
2976
|
+
* @throws {@link OpikApi.ForbiddenError}
|
|
2977
|
+
*
|
|
2978
|
+
* @example
|
|
2979
|
+
* await client.attachments.startMultiPartUpload1({
|
|
2980
|
+
* fileName: "file_name",
|
|
2981
|
+
* numOfFileParts: 1,
|
|
2982
|
+
* entityType: "trace",
|
|
2983
|
+
* entityId: "entity_id",
|
|
2984
|
+
* path: "path"
|
|
2985
|
+
* })
|
|
2986
|
+
*/
|
|
2987
|
+
startMultiPartUpload1(request: StartMultipartUploadRequest, requestOptions?: Attachments.RequestOptions): Promise<StartMultipartUploadResponse>;
|
|
2988
|
+
/**
|
|
2989
|
+
* Upload attachment to MinIO
|
|
2990
|
+
*
|
|
2991
|
+
* @param {OpikApi.UploadAttachmentRequest} request
|
|
2992
|
+
* @param {Attachments.RequestOptions} requestOptions - Request-specific configuration.
|
|
2993
|
+
*
|
|
2994
|
+
* @throws {@link OpikApi.UnauthorizedError}
|
|
2995
|
+
* @throws {@link OpikApi.ForbiddenError}
|
|
2996
|
+
*
|
|
2997
|
+
* @example
|
|
2998
|
+
* await client.attachments.uploadAttachment({
|
|
2999
|
+
* fileName: "file_name",
|
|
3000
|
+
* entityType: "trace",
|
|
3001
|
+
* entityId: "entity_id",
|
|
3002
|
+
* body: {
|
|
3003
|
+
* "key": "value"
|
|
3004
|
+
* }
|
|
3005
|
+
* })
|
|
3006
|
+
*/
|
|
3007
|
+
uploadAttachment(request: UploadAttachmentRequest, requestOptions?: Attachments.RequestOptions): Promise<void>;
|
|
3008
|
+
protected _getCustomAuthorizationHeaders(): Promise<{
|
|
3009
|
+
Authorization: string | undefined;
|
|
3010
|
+
}>;
|
|
3011
|
+
}
|
|
3012
|
+
|
|
2687
3013
|
/**
|
|
2688
3014
|
* This file was auto-generated by Fern from our API Definition.
|
|
2689
3015
|
*/
|
|
@@ -2734,6 +3060,18 @@ declare class Check {
|
|
|
2734
3060
|
* })
|
|
2735
3061
|
*/
|
|
2736
3062
|
access(request: AuthDetailsHolder, requestOptions?: Check.RequestOptions): Promise<void>;
|
|
3063
|
+
/**
|
|
3064
|
+
* User's default workspace name
|
|
3065
|
+
*
|
|
3066
|
+
* @param {Check.RequestOptions} requestOptions - Request-specific configuration.
|
|
3067
|
+
*
|
|
3068
|
+
* @throws {@link OpikApi.UnauthorizedError}
|
|
3069
|
+
* @throws {@link OpikApi.ForbiddenError}
|
|
3070
|
+
*
|
|
3071
|
+
* @example
|
|
3072
|
+
* await client.check.getWorkspaceName()
|
|
3073
|
+
*/
|
|
3074
|
+
getWorkspaceName(requestOptions?: Check.RequestOptions): Promise<WorkspaceNameHolder>;
|
|
2737
3075
|
protected _getCustomAuthorizationHeaders(): Promise<{
|
|
2738
3076
|
Authorization: string | undefined;
|
|
2739
3077
|
}>;
|
|
@@ -2804,7 +3142,6 @@ declare class AutomationRuleEvaluators {
|
|
|
2804
3142
|
*
|
|
2805
3143
|
* @example
|
|
2806
3144
|
* await client.automationRuleEvaluators.deleteAutomationRuleEvaluatorBatch({
|
|
2807
|
-
* projectId: "project_id",
|
|
2808
3145
|
* body: {
|
|
2809
3146
|
* ids: ["ids"]
|
|
2810
3147
|
* }
|
|
@@ -2846,80 +3183,6 @@ declare class AutomationRuleEvaluators {
|
|
|
2846
3183
|
* await client.automationRuleEvaluators.getEvaluatorLogsById("id")
|
|
2847
3184
|
*/
|
|
2848
3185
|
getEvaluatorLogsById(id: string, request?: GetEvaluatorLogsByIdRequest, requestOptions?: AutomationRuleEvaluators.RequestOptions): Promise<LogPage>;
|
|
2849
|
-
/**
|
|
2850
|
-
* Find project Evaluators Deprecated
|
|
2851
|
-
*
|
|
2852
|
-
* @param {string} projectId
|
|
2853
|
-
* @param {OpikApi.FindEvaluatorsDeprecatedRequest} request
|
|
2854
|
-
* @param {AutomationRuleEvaluators.RequestOptions} requestOptions - Request-specific configuration.
|
|
2855
|
-
*
|
|
2856
|
-
* @example
|
|
2857
|
-
* await client.automationRuleEvaluators.findEvaluatorsDeprecated("projectId")
|
|
2858
|
-
*/
|
|
2859
|
-
findEvaluatorsDeprecated(projectId: string, request?: FindEvaluatorsDeprecatedRequest, requestOptions?: AutomationRuleEvaluators.RequestOptions): Promise<AutomationRuleEvaluatorPagePublic>;
|
|
2860
|
-
/**
|
|
2861
|
-
* Create automation rule evaluator Deprecated
|
|
2862
|
-
*
|
|
2863
|
-
* @param {string} projectId
|
|
2864
|
-
* @param {unknown} request
|
|
2865
|
-
* @param {AutomationRuleEvaluators.RequestOptions} requestOptions - Request-specific configuration.
|
|
2866
|
-
*
|
|
2867
|
-
* @example
|
|
2868
|
-
* await client.automationRuleEvaluators.createAutomationRuleEvaluatorDeprecated("projectId", {
|
|
2869
|
-
* "key": "value"
|
|
2870
|
-
* })
|
|
2871
|
-
*/
|
|
2872
|
-
createAutomationRuleEvaluatorDeprecated(projectId: string, request?: unknown, requestOptions?: AutomationRuleEvaluators.RequestOptions): Promise<void>;
|
|
2873
|
-
/**
|
|
2874
|
-
* Delete automation rule evaluators batch Deprecated
|
|
2875
|
-
*
|
|
2876
|
-
* @param {string} projectId
|
|
2877
|
-
* @param {OpikApi.BatchDelete} request
|
|
2878
|
-
* @param {AutomationRuleEvaluators.RequestOptions} requestOptions - Request-specific configuration.
|
|
2879
|
-
*
|
|
2880
|
-
* @example
|
|
2881
|
-
* await client.automationRuleEvaluators.deleteAutomationRuleEvaluatorBatchDeprecated("projectId", {
|
|
2882
|
-
* ids: ["ids"]
|
|
2883
|
-
* })
|
|
2884
|
-
*/
|
|
2885
|
-
deleteAutomationRuleEvaluatorBatchDeprecated(projectId: string, request: BatchDelete, requestOptions?: AutomationRuleEvaluators.RequestOptions): Promise<void>;
|
|
2886
|
-
/**
|
|
2887
|
-
* Get automation rule by id Deprecated
|
|
2888
|
-
*
|
|
2889
|
-
* @param {string} projectId
|
|
2890
|
-
* @param {string} id
|
|
2891
|
-
* @param {AutomationRuleEvaluators.RequestOptions} requestOptions - Request-specific configuration.
|
|
2892
|
-
*
|
|
2893
|
-
* @example
|
|
2894
|
-
* await client.automationRuleEvaluators.getEvaluatorByIdDeprecated("projectId", "id")
|
|
2895
|
-
*/
|
|
2896
|
-
getEvaluatorByIdDeprecated(projectId: string, id: string, requestOptions?: AutomationRuleEvaluators.RequestOptions): Promise<unknown>;
|
|
2897
|
-
/**
|
|
2898
|
-
* update Automation Rule Evaluator by id Deprecated
|
|
2899
|
-
*
|
|
2900
|
-
* @param {string} id
|
|
2901
|
-
* @param {string} projectId
|
|
2902
|
-
* @param {unknown} request
|
|
2903
|
-
* @param {AutomationRuleEvaluators.RequestOptions} requestOptions - Request-specific configuration.
|
|
2904
|
-
*
|
|
2905
|
-
* @example
|
|
2906
|
-
* await client.automationRuleEvaluators.updateAutomationRuleEvaluatorDeprecated("id", "projectId", {
|
|
2907
|
-
* "key": "value"
|
|
2908
|
-
* })
|
|
2909
|
-
*/
|
|
2910
|
-
updateAutomationRuleEvaluatorDeprecated(id: string, projectId: string, request?: unknown, requestOptions?: AutomationRuleEvaluators.RequestOptions): Promise<void>;
|
|
2911
|
-
/**
|
|
2912
|
-
* Get automation rule evaluator logs by id Deprecated
|
|
2913
|
-
*
|
|
2914
|
-
* @param {string} projectId
|
|
2915
|
-
* @param {string} id
|
|
2916
|
-
* @param {OpikApi.GetEvaluatorLogsByIdDeprecatedRequest} request
|
|
2917
|
-
* @param {AutomationRuleEvaluators.RequestOptions} requestOptions - Request-specific configuration.
|
|
2918
|
-
*
|
|
2919
|
-
* @example
|
|
2920
|
-
* await client.automationRuleEvaluators.getEvaluatorLogsByIdDeprecated("projectId", "id")
|
|
2921
|
-
*/
|
|
2922
|
-
getEvaluatorLogsByIdDeprecated(projectId: string, id: string, request?: GetEvaluatorLogsByIdDeprecatedRequest, requestOptions?: AutomationRuleEvaluators.RequestOptions): Promise<LogPage>;
|
|
2923
3186
|
protected _getCustomAuthorizationHeaders(): Promise<{
|
|
2924
3187
|
Authorization: string | undefined;
|
|
2925
3188
|
}>;
|
|
@@ -3391,7 +3654,7 @@ declare class FeedbackDefinitions {
|
|
|
3391
3654
|
*
|
|
3392
3655
|
* @example
|
|
3393
3656
|
* await client.feedbackDefinitions.createFeedbackDefinition({
|
|
3394
|
-
* type: "
|
|
3657
|
+
* type: "numerical"
|
|
3395
3658
|
* })
|
|
3396
3659
|
*/
|
|
3397
3660
|
createFeedbackDefinition(request: FeedbackCreate, requestOptions?: FeedbackDefinitions.RequestOptions): Promise<void>;
|
|
@@ -3414,7 +3677,7 @@ declare class FeedbackDefinitions {
|
|
|
3414
3677
|
*
|
|
3415
3678
|
* @example
|
|
3416
3679
|
* await client.feedbackDefinitions.updateFeedbackDefinition("id", {
|
|
3417
|
-
* type: "
|
|
3680
|
+
* type: "numerical"
|
|
3418
3681
|
* })
|
|
3419
3682
|
*/
|
|
3420
3683
|
updateFeedbackDefinition(id: string, request: FeedbackUpdate, requestOptions?: FeedbackDefinitions.RequestOptions): Promise<void>;
|
|
@@ -3424,6 +3687,8 @@ declare class FeedbackDefinitions {
|
|
|
3424
3687
|
* @param {string} id
|
|
3425
3688
|
* @param {FeedbackDefinitions.RequestOptions} requestOptions - Request-specific configuration.
|
|
3426
3689
|
*
|
|
3690
|
+
* @throws {@link OpikApi.ConflictError}
|
|
3691
|
+
*
|
|
3427
3692
|
* @example
|
|
3428
3693
|
* await client.feedbackDefinitions.deleteFeedbackDefinitionById("id")
|
|
3429
3694
|
*/
|
|
@@ -3434,6 +3699,8 @@ declare class FeedbackDefinitions {
|
|
|
3434
3699
|
* @param {OpikApi.BatchDelete} request
|
|
3435
3700
|
* @param {FeedbackDefinitions.RequestOptions} requestOptions - Request-specific configuration.
|
|
3436
3701
|
*
|
|
3702
|
+
* @throws {@link OpikApi.ConflictError}
|
|
3703
|
+
*
|
|
3437
3704
|
* @example
|
|
3438
3705
|
* await client.feedbackDefinitions.deleteFeedbackDefinitionsBatch({
|
|
3439
3706
|
* ids: ["ids"]
|
|
@@ -3551,53 +3818,6 @@ declare class LlmProviderKey {
|
|
|
3551
3818
|
}>;
|
|
3552
3819
|
}
|
|
3553
3820
|
|
|
3554
|
-
/**
|
|
3555
|
-
* This file was auto-generated by Fern from our API Definition.
|
|
3556
|
-
*/
|
|
3557
|
-
|
|
3558
|
-
declare namespace OpenTelemetryIngestion {
|
|
3559
|
-
interface Options {
|
|
3560
|
-
environment?: Supplier<OpikApiEnvironment | string>;
|
|
3561
|
-
/** Specify a custom URL to connect the client to. */
|
|
3562
|
-
baseUrl?: Supplier<string>;
|
|
3563
|
-
/** Override the Authorization header */
|
|
3564
|
-
apiKey?: Supplier<string | undefined>;
|
|
3565
|
-
/** Override the Comet-Workspace header */
|
|
3566
|
-
workspaceName?: Supplier<string | undefined>;
|
|
3567
|
-
}
|
|
3568
|
-
interface RequestOptions {
|
|
3569
|
-
/** The maximum time to wait for a response in seconds. */
|
|
3570
|
-
timeoutInSeconds?: number;
|
|
3571
|
-
/** The number of times to retry the request. Defaults to 2. */
|
|
3572
|
-
maxRetries?: number;
|
|
3573
|
-
/** A hook to abort the request. */
|
|
3574
|
-
abortSignal?: AbortSignal;
|
|
3575
|
-
/** Override the Authorization header */
|
|
3576
|
-
apiKey?: string | undefined;
|
|
3577
|
-
/** Override the Comet-Workspace header */
|
|
3578
|
-
workspaceName?: string | undefined;
|
|
3579
|
-
/** Additional headers to include in the request. */
|
|
3580
|
-
headers?: Record<string, string>;
|
|
3581
|
-
}
|
|
3582
|
-
}
|
|
3583
|
-
/**
|
|
3584
|
-
* Resource to ingest Traces and Spans via OpenTelemetry
|
|
3585
|
-
*/
|
|
3586
|
-
declare class OpenTelemetryIngestion {
|
|
3587
|
-
protected readonly _options: OpenTelemetryIngestion.Options;
|
|
3588
|
-
constructor(_options?: OpenTelemetryIngestion.Options);
|
|
3589
|
-
/**
|
|
3590
|
-
* @param {OpenTelemetryIngestion.RequestOptions} requestOptions - Request-specific configuration.
|
|
3591
|
-
*
|
|
3592
|
-
* @example
|
|
3593
|
-
* await client.openTelemetryIngestion.receiveTraces()
|
|
3594
|
-
*/
|
|
3595
|
-
receiveTraces(requestOptions?: OpenTelemetryIngestion.RequestOptions): Promise<unknown>;
|
|
3596
|
-
protected _getCustomAuthorizationHeaders(): Promise<{
|
|
3597
|
-
Authorization: string | undefined;
|
|
3598
|
-
}>;
|
|
3599
|
-
}
|
|
3600
|
-
|
|
3601
3821
|
/**
|
|
3602
3822
|
* This file was auto-generated by Fern from our API Definition.
|
|
3603
3823
|
*/
|
|
@@ -4016,6 +4236,8 @@ declare class Spans {
|
|
|
4016
4236
|
* @param {OpikApi.SpanWrite} request
|
|
4017
4237
|
* @param {Spans.RequestOptions} requestOptions - Request-specific configuration.
|
|
4018
4238
|
*
|
|
4239
|
+
* @throws {@link OpikApi.ConflictError}
|
|
4240
|
+
*
|
|
4019
4241
|
* @example
|
|
4020
4242
|
* await client.spans.createSpan({
|
|
4021
4243
|
* traceId: "trace_id",
|
|
@@ -4437,6 +4659,12 @@ declare class Traces {
|
|
|
4437
4659
|
* })
|
|
4438
4660
|
*/
|
|
4439
4661
|
scoreBatchOfTraces(request: FeedbackScoreBatch, requestOptions?: Traces.RequestOptions): Promise<void>;
|
|
4662
|
+
/**
|
|
4663
|
+
* Search traces
|
|
4664
|
+
* @throws {@link OpikApi.BadRequestError}
|
|
4665
|
+
* @throws {@link OpikApi.UnauthorizedError}
|
|
4666
|
+
*/
|
|
4667
|
+
searchTraces(request?: TraceSearchStreamRequestPublic, requestOptions?: Traces.RequestOptions): Promise<stream.Readable>;
|
|
4440
4668
|
/**
|
|
4441
4669
|
* Update trace comment by id
|
|
4442
4670
|
*
|
|
@@ -4461,7 +4689,7 @@ declare class Traces {
|
|
|
4461
4689
|
* This file was auto-generated by Fern from our API Definition.
|
|
4462
4690
|
*/
|
|
4463
4691
|
|
|
4464
|
-
declare namespace
|
|
4692
|
+
declare namespace Redirect {
|
|
4465
4693
|
interface Options {
|
|
4466
4694
|
environment?: Supplier<OpikApiEnvironment | string>;
|
|
4467
4695
|
/** Specify a custom URL to connect the client to. */
|
|
@@ -4487,20 +4715,60 @@ declare namespace Workspaces {
|
|
|
4487
4715
|
}
|
|
4488
4716
|
}
|
|
4489
4717
|
/**
|
|
4490
|
-
*
|
|
4718
|
+
* Redirects for SDK generated links
|
|
4491
4719
|
*/
|
|
4492
|
-
declare class
|
|
4493
|
-
protected readonly _options:
|
|
4494
|
-
constructor(_options?:
|
|
4720
|
+
declare class Redirect {
|
|
4721
|
+
protected readonly _options: Redirect.Options;
|
|
4722
|
+
constructor(_options?: Redirect.Options);
|
|
4723
|
+
/**
|
|
4724
|
+
* Create dataset redirect url
|
|
4725
|
+
*
|
|
4726
|
+
* @param {OpikApi.DatasetsRedirectRequest} request
|
|
4727
|
+
* @param {Redirect.RequestOptions} requestOptions - Request-specific configuration.
|
|
4728
|
+
*
|
|
4729
|
+
* @throws {@link OpikApi.BadRequestError}
|
|
4730
|
+
* @throws {@link OpikApi.NotFoundError}
|
|
4731
|
+
*
|
|
4732
|
+
* @example
|
|
4733
|
+
* await client.redirect.datasetsRedirect({
|
|
4734
|
+
* datasetId: "dataset_id",
|
|
4735
|
+
* path: "path"
|
|
4736
|
+
* })
|
|
4737
|
+
*/
|
|
4738
|
+
datasetsRedirect(request: DatasetsRedirectRequest, requestOptions?: Redirect.RequestOptions): Promise<void>;
|
|
4495
4739
|
/**
|
|
4496
|
-
*
|
|
4740
|
+
* Create experiment redirect url
|
|
4741
|
+
*
|
|
4742
|
+
* @param {OpikApi.ExperimentsRedirectRequest} request
|
|
4743
|
+
* @param {Redirect.RequestOptions} requestOptions - Request-specific configuration.
|
|
4497
4744
|
*
|
|
4745
|
+
* @throws {@link OpikApi.BadRequestError}
|
|
4498
4746
|
* @throws {@link OpikApi.NotFoundError}
|
|
4499
4747
|
*
|
|
4500
4748
|
* @example
|
|
4501
|
-
* await client.
|
|
4749
|
+
* await client.redirect.experimentsRedirect({
|
|
4750
|
+
* datasetId: "dataset_id",
|
|
4751
|
+
* experimentId: "experiment_id",
|
|
4752
|
+
* path: "path"
|
|
4753
|
+
* })
|
|
4754
|
+
*/
|
|
4755
|
+
experimentsRedirect(request: ExperimentsRedirectRequest, requestOptions?: Redirect.RequestOptions): Promise<void>;
|
|
4756
|
+
/**
|
|
4757
|
+
* Create project redirect url
|
|
4758
|
+
*
|
|
4759
|
+
* @param {OpikApi.ProjectsRedirectRequest} request
|
|
4760
|
+
* @param {Redirect.RequestOptions} requestOptions - Request-specific configuration.
|
|
4761
|
+
*
|
|
4762
|
+
* @throws {@link OpikApi.BadRequestError}
|
|
4763
|
+
* @throws {@link OpikApi.NotFoundError}
|
|
4764
|
+
*
|
|
4765
|
+
* @example
|
|
4766
|
+
* await client.redirect.projectsRedirect({
|
|
4767
|
+
* traceId: "trace_id",
|
|
4768
|
+
* path: "path"
|
|
4769
|
+
* })
|
|
4502
4770
|
*/
|
|
4503
|
-
|
|
4771
|
+
projectsRedirect(request: ProjectsRedirectRequest, requestOptions?: Redirect.RequestOptions): Promise<void>;
|
|
4504
4772
|
protected _getCustomAuthorizationHeaders(): Promise<{
|
|
4505
4773
|
Authorization: string | undefined;
|
|
4506
4774
|
}>;
|
|
@@ -4538,6 +4806,7 @@ declare namespace OpikApiClient {
|
|
|
4538
4806
|
declare class OpikApiClient {
|
|
4539
4807
|
protected readonly _options: OpikApiClient.Options;
|
|
4540
4808
|
protected _systemUsage: SystemUsage | undefined;
|
|
4809
|
+
protected _attachments: Attachments | undefined;
|
|
4541
4810
|
protected _check: Check | undefined;
|
|
4542
4811
|
protected _automationRuleEvaluators: AutomationRuleEvaluators | undefined;
|
|
4543
4812
|
protected _chatCompletions: ChatCompletions | undefined;
|
|
@@ -4545,14 +4814,14 @@ declare class OpikApiClient {
|
|
|
4545
4814
|
protected _experiments: Experiments | undefined;
|
|
4546
4815
|
protected _feedbackDefinitions: FeedbackDefinitions | undefined;
|
|
4547
4816
|
protected _llmProviderKey: LlmProviderKey | undefined;
|
|
4548
|
-
protected _openTelemetryIngestion: OpenTelemetryIngestion | undefined;
|
|
4549
4817
|
protected _projects: Projects | undefined;
|
|
4550
4818
|
protected _prompts: Prompts | undefined;
|
|
4551
4819
|
protected _spans: Spans | undefined;
|
|
4552
4820
|
protected _traces: Traces | undefined;
|
|
4553
|
-
protected
|
|
4821
|
+
protected _redirect: Redirect | undefined;
|
|
4554
4822
|
constructor(_options?: OpikApiClient.Options);
|
|
4555
4823
|
get systemUsage(): SystemUsage;
|
|
4824
|
+
get attachments(): Attachments;
|
|
4556
4825
|
get check(): Check;
|
|
4557
4826
|
get automationRuleEvaluators(): AutomationRuleEvaluators;
|
|
4558
4827
|
get chatCompletions(): ChatCompletions;
|
|
@@ -4560,12 +4829,11 @@ declare class OpikApiClient {
|
|
|
4560
4829
|
get experiments(): Experiments;
|
|
4561
4830
|
get feedbackDefinitions(): FeedbackDefinitions;
|
|
4562
4831
|
get llmProviderKey(): LlmProviderKey;
|
|
4563
|
-
get openTelemetryIngestion(): OpenTelemetryIngestion;
|
|
4564
4832
|
get projects(): Projects;
|
|
4565
4833
|
get prompts(): Prompts;
|
|
4566
4834
|
get spans(): Spans;
|
|
4567
4835
|
get traces(): Traces;
|
|
4568
|
-
get
|
|
4836
|
+
get redirect(): Redirect;
|
|
4569
4837
|
/**
|
|
4570
4838
|
* @param {OpikApiClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
4571
4839
|
*
|