opik 1.8.19 → 1.8.21

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.
@@ -402,6 +402,8 @@ interface ExperimentItemsDelete {
402
402
  interface ExperimentItemBulkUploadExperimentItemBulkWriteView {
403
403
  experimentName: string;
404
404
  datasetName: string;
405
+ /** Optional experiment ID. If provided, items will be added to the existing experiment and experimentName will be ignored. If not provided or experiment with that ID doesn't exist, a new experiment will be created with the given experimentName */
406
+ experimentId?: string;
405
407
  items: ExperimentItemBulkRecordExperimentItemBulkWriteView[];
406
408
  }
407
409
 
@@ -430,6 +432,20 @@ interface FindExperimentGroupsRequest {
430
432
  filters?: string;
431
433
  }
432
434
 
435
+ /**
436
+ * This file was auto-generated by Fern from our API Definition.
437
+ */
438
+ /**
439
+ * @example
440
+ * {}
441
+ */
442
+ interface FindExperimentGroupsAggregationsRequest {
443
+ groups?: string;
444
+ types?: string;
445
+ name?: string;
446
+ filters?: string;
447
+ }
448
+
433
449
  /**
434
450
  * This file was auto-generated by Fern from our API Definition.
435
451
  */
@@ -2233,6 +2249,7 @@ interface FeedbackScore {
2233
2249
  lastUpdatedAt?: Date;
2234
2250
  createdBy?: string;
2235
2251
  lastUpdatedBy?: string;
2252
+ valueByAuthor?: Record<string, ValueEntry>;
2236
2253
  }
2237
2254
 
2238
2255
  /**
@@ -2240,6 +2257,28 @@ interface FeedbackScore {
2240
2257
  */
2241
2258
  type JsonListString = Record<string, unknown> | Record<string, unknown>[] | string;
2242
2259
 
2260
+ /**
2261
+ * This file was auto-generated by Fern from our API Definition.
2262
+ */
2263
+ type ValueEntrySource = "ui" | "sdk" | "online_scoring";
2264
+ declare const ValueEntrySource: {
2265
+ readonly Ui: "ui";
2266
+ readonly Sdk: "sdk";
2267
+ readonly OnlineScoring: "online_scoring";
2268
+ };
2269
+
2270
+ /**
2271
+ * This file was auto-generated by Fern from our API Definition.
2272
+ */
2273
+
2274
+ interface ValueEntry {
2275
+ value?: number;
2276
+ reason?: string;
2277
+ categoryName?: string;
2278
+ source?: ValueEntrySource;
2279
+ lastUpdatedAt?: Date;
2280
+ }
2281
+
2243
2282
  /**
2244
2283
  * This file was auto-generated by Fern from our API Definition.
2245
2284
  */
@@ -2397,6 +2436,7 @@ interface FeedbackScoreCompare {
2397
2436
  lastUpdatedAt?: Date;
2398
2437
  createdBy?: string;
2399
2438
  lastUpdatedBy?: string;
2439
+ valueByAuthor?: Record<string, ValueEntryCompare>;
2400
2440
  }
2401
2441
 
2402
2442
  /**
@@ -2404,6 +2444,28 @@ interface FeedbackScoreCompare {
2404
2444
  */
2405
2445
  type JsonListStringCompare = Record<string, unknown> | Record<string, unknown>[] | string;
2406
2446
 
2447
+ /**
2448
+ * This file was auto-generated by Fern from our API Definition.
2449
+ */
2450
+ type ValueEntryCompareSource = "ui" | "sdk" | "online_scoring";
2451
+ declare const ValueEntryCompareSource: {
2452
+ readonly Ui: "ui";
2453
+ readonly Sdk: "sdk";
2454
+ readonly OnlineScoring: "online_scoring";
2455
+ };
2456
+
2457
+ /**
2458
+ * This file was auto-generated by Fern from our API Definition.
2459
+ */
2460
+
2461
+ interface ValueEntryCompare {
2462
+ value?: number;
2463
+ reason?: string;
2464
+ categoryName?: string;
2465
+ source?: ValueEntryCompareSource;
2466
+ lastUpdatedAt?: Date;
2467
+ }
2468
+
2407
2469
  /**
2408
2470
  * This file was auto-generated by Fern from our API Definition.
2409
2471
  */
@@ -2802,6 +2864,7 @@ interface FeedbackScoreExperimentItemBulkWriteView {
2802
2864
  lastUpdatedAt?: Date;
2803
2865
  createdBy?: string;
2804
2866
  lastUpdatedBy?: string;
2867
+ valueByAuthor?: Record<string, ValueEntryExperimentItemBulkWriteView>;
2805
2868
  }
2806
2869
 
2807
2870
  /**
@@ -2872,6 +2935,28 @@ interface TraceExperimentItemBulkWriteView {
2872
2935
  threadId?: string;
2873
2936
  }
2874
2937
 
2938
+ /**
2939
+ * This file was auto-generated by Fern from our API Definition.
2940
+ */
2941
+ type ValueEntryExperimentItemBulkWriteViewSource = "ui" | "sdk" | "online_scoring";
2942
+ declare const ValueEntryExperimentItemBulkWriteViewSource: {
2943
+ readonly Ui: "ui";
2944
+ readonly Sdk: "sdk";
2945
+ readonly OnlineScoring: "online_scoring";
2946
+ };
2947
+
2948
+ /**
2949
+ * This file was auto-generated by Fern from our API Definition.
2950
+ */
2951
+
2952
+ interface ValueEntryExperimentItemBulkWriteView {
2953
+ value?: number;
2954
+ reason?: string;
2955
+ categoryName?: string;
2956
+ source?: ValueEntryExperimentItemBulkWriteViewSource;
2957
+ lastUpdatedAt?: Date;
2958
+ }
2959
+
2875
2960
  /**
2876
2961
  * This file was auto-generated by Fern from our API Definition.
2877
2962
  */
@@ -2979,6 +3064,35 @@ interface GroupContent {
2979
3064
  label?: string;
2980
3065
  }
2981
3066
 
3067
+ /**
3068
+ * This file was auto-generated by Fern from our API Definition.
3069
+ */
3070
+
3071
+ interface AggregationData {
3072
+ experimentCount?: number;
3073
+ traceCount?: number;
3074
+ totalEstimatedCost?: number;
3075
+ totalEstimatedCostAvg?: number;
3076
+ duration?: PercentageValues;
3077
+ feedbackScores?: FeedbackScoreAverage[];
3078
+ }
3079
+
3080
+ /**
3081
+ * This file was auto-generated by Fern from our API Definition.
3082
+ */
3083
+
3084
+ interface ExperimentGroupAggregationsResponse {
3085
+ content?: Record<string, GroupContentWithAggregations>;
3086
+ }
3087
+
3088
+ /**
3089
+ * This file was auto-generated by Fern from our API Definition.
3090
+ */
3091
+
3092
+ interface GroupContentWithAggregations {
3093
+ aggregations?: AggregationData;
3094
+ }
3095
+
2982
3096
  /**
2983
3097
  * This file was auto-generated by Fern from our API Definition.
2984
3098
  */
@@ -3726,6 +3840,7 @@ interface FeedbackScorePublic {
3726
3840
  lastUpdatedAt?: Date;
3727
3841
  createdBy?: string;
3728
3842
  lastUpdatedBy?: string;
3843
+ valueByAuthor?: Record<string, ValueEntryPublic>;
3729
3844
  }
3730
3845
 
3731
3846
  /**
@@ -3779,6 +3894,28 @@ interface SpanPublic {
3779
3894
  duration?: number;
3780
3895
  }
3781
3896
 
3897
+ /**
3898
+ * This file was auto-generated by Fern from our API Definition.
3899
+ */
3900
+ type ValueEntryPublicSource = "ui" | "sdk" | "online_scoring";
3901
+ declare const ValueEntryPublicSource: {
3902
+ readonly Ui: "ui";
3903
+ readonly Sdk: "sdk";
3904
+ readonly OnlineScoring: "online_scoring";
3905
+ };
3906
+
3907
+ /**
3908
+ * This file was auto-generated by Fern from our API Definition.
3909
+ */
3910
+
3911
+ interface ValueEntryPublic {
3912
+ value?: number;
3913
+ reason?: string;
3914
+ categoryName?: string;
3915
+ source?: ValueEntryPublicSource;
3916
+ lastUpdatedAt?: Date;
3917
+ }
3918
+
3782
3919
  /**
3783
3920
  * This file was auto-generated by Fern from our API Definition.
3784
3921
  */
@@ -5109,6 +5246,7 @@ declare class Experiments {
5109
5246
  * @param {Experiments.RequestOptions} requestOptions - Request-specific configuration.
5110
5247
  *
5111
5248
  * @throws {@link OpikApi.BadRequestError}
5249
+ * @throws {@link OpikApi.ConflictError}
5112
5250
  * @throws {@link OpikApi.UnprocessableEntityError}
5113
5251
  *
5114
5252
  * @example
@@ -5146,6 +5284,19 @@ declare class Experiments {
5146
5284
  */
5147
5285
  findExperimentGroups(request?: FindExperimentGroupsRequest, requestOptions?: Experiments.RequestOptions): HttpResponsePromise<ExperimentGroupResponse>;
5148
5286
  private __findExperimentGroups;
5287
+ /**
5288
+ * Find experiments grouped by specified fields with aggregation metrics
5289
+ *
5290
+ * @param {OpikApi.FindExperimentGroupsAggregationsRequest} request
5291
+ * @param {Experiments.RequestOptions} requestOptions - Request-specific configuration.
5292
+ *
5293
+ * @throws {@link OpikApi.BadRequestError}
5294
+ *
5295
+ * @example
5296
+ * await client.experiments.findExperimentGroupsAggregations()
5297
+ */
5298
+ findExperimentGroupsAggregations(request?: FindExperimentGroupsAggregationsRequest, requestOptions?: Experiments.RequestOptions): HttpResponsePromise<ExperimentGroupAggregationsResponse>;
5299
+ private __findExperimentGroupsAggregations;
5149
5300
  /**
5150
5301
  * Get experiment by id
5151
5302
  *
@@ -402,6 +402,8 @@ interface ExperimentItemsDelete {
402
402
  interface ExperimentItemBulkUploadExperimentItemBulkWriteView {
403
403
  experimentName: string;
404
404
  datasetName: string;
405
+ /** Optional experiment ID. If provided, items will be added to the existing experiment and experimentName will be ignored. If not provided or experiment with that ID doesn't exist, a new experiment will be created with the given experimentName */
406
+ experimentId?: string;
405
407
  items: ExperimentItemBulkRecordExperimentItemBulkWriteView[];
406
408
  }
407
409
 
@@ -430,6 +432,20 @@ interface FindExperimentGroupsRequest {
430
432
  filters?: string;
431
433
  }
432
434
 
435
+ /**
436
+ * This file was auto-generated by Fern from our API Definition.
437
+ */
438
+ /**
439
+ * @example
440
+ * {}
441
+ */
442
+ interface FindExperimentGroupsAggregationsRequest {
443
+ groups?: string;
444
+ types?: string;
445
+ name?: string;
446
+ filters?: string;
447
+ }
448
+
433
449
  /**
434
450
  * This file was auto-generated by Fern from our API Definition.
435
451
  */
@@ -2233,6 +2249,7 @@ interface FeedbackScore {
2233
2249
  lastUpdatedAt?: Date;
2234
2250
  createdBy?: string;
2235
2251
  lastUpdatedBy?: string;
2252
+ valueByAuthor?: Record<string, ValueEntry>;
2236
2253
  }
2237
2254
 
2238
2255
  /**
@@ -2240,6 +2257,28 @@ interface FeedbackScore {
2240
2257
  */
2241
2258
  type JsonListString = Record<string, unknown> | Record<string, unknown>[] | string;
2242
2259
 
2260
+ /**
2261
+ * This file was auto-generated by Fern from our API Definition.
2262
+ */
2263
+ type ValueEntrySource = "ui" | "sdk" | "online_scoring";
2264
+ declare const ValueEntrySource: {
2265
+ readonly Ui: "ui";
2266
+ readonly Sdk: "sdk";
2267
+ readonly OnlineScoring: "online_scoring";
2268
+ };
2269
+
2270
+ /**
2271
+ * This file was auto-generated by Fern from our API Definition.
2272
+ */
2273
+
2274
+ interface ValueEntry {
2275
+ value?: number;
2276
+ reason?: string;
2277
+ categoryName?: string;
2278
+ source?: ValueEntrySource;
2279
+ lastUpdatedAt?: Date;
2280
+ }
2281
+
2243
2282
  /**
2244
2283
  * This file was auto-generated by Fern from our API Definition.
2245
2284
  */
@@ -2397,6 +2436,7 @@ interface FeedbackScoreCompare {
2397
2436
  lastUpdatedAt?: Date;
2398
2437
  createdBy?: string;
2399
2438
  lastUpdatedBy?: string;
2439
+ valueByAuthor?: Record<string, ValueEntryCompare>;
2400
2440
  }
2401
2441
 
2402
2442
  /**
@@ -2404,6 +2444,28 @@ interface FeedbackScoreCompare {
2404
2444
  */
2405
2445
  type JsonListStringCompare = Record<string, unknown> | Record<string, unknown>[] | string;
2406
2446
 
2447
+ /**
2448
+ * This file was auto-generated by Fern from our API Definition.
2449
+ */
2450
+ type ValueEntryCompareSource = "ui" | "sdk" | "online_scoring";
2451
+ declare const ValueEntryCompareSource: {
2452
+ readonly Ui: "ui";
2453
+ readonly Sdk: "sdk";
2454
+ readonly OnlineScoring: "online_scoring";
2455
+ };
2456
+
2457
+ /**
2458
+ * This file was auto-generated by Fern from our API Definition.
2459
+ */
2460
+
2461
+ interface ValueEntryCompare {
2462
+ value?: number;
2463
+ reason?: string;
2464
+ categoryName?: string;
2465
+ source?: ValueEntryCompareSource;
2466
+ lastUpdatedAt?: Date;
2467
+ }
2468
+
2407
2469
  /**
2408
2470
  * This file was auto-generated by Fern from our API Definition.
2409
2471
  */
@@ -2802,6 +2864,7 @@ interface FeedbackScoreExperimentItemBulkWriteView {
2802
2864
  lastUpdatedAt?: Date;
2803
2865
  createdBy?: string;
2804
2866
  lastUpdatedBy?: string;
2867
+ valueByAuthor?: Record<string, ValueEntryExperimentItemBulkWriteView>;
2805
2868
  }
2806
2869
 
2807
2870
  /**
@@ -2872,6 +2935,28 @@ interface TraceExperimentItemBulkWriteView {
2872
2935
  threadId?: string;
2873
2936
  }
2874
2937
 
2938
+ /**
2939
+ * This file was auto-generated by Fern from our API Definition.
2940
+ */
2941
+ type ValueEntryExperimentItemBulkWriteViewSource = "ui" | "sdk" | "online_scoring";
2942
+ declare const ValueEntryExperimentItemBulkWriteViewSource: {
2943
+ readonly Ui: "ui";
2944
+ readonly Sdk: "sdk";
2945
+ readonly OnlineScoring: "online_scoring";
2946
+ };
2947
+
2948
+ /**
2949
+ * This file was auto-generated by Fern from our API Definition.
2950
+ */
2951
+
2952
+ interface ValueEntryExperimentItemBulkWriteView {
2953
+ value?: number;
2954
+ reason?: string;
2955
+ categoryName?: string;
2956
+ source?: ValueEntryExperimentItemBulkWriteViewSource;
2957
+ lastUpdatedAt?: Date;
2958
+ }
2959
+
2875
2960
  /**
2876
2961
  * This file was auto-generated by Fern from our API Definition.
2877
2962
  */
@@ -2979,6 +3064,35 @@ interface GroupContent {
2979
3064
  label?: string;
2980
3065
  }
2981
3066
 
3067
+ /**
3068
+ * This file was auto-generated by Fern from our API Definition.
3069
+ */
3070
+
3071
+ interface AggregationData {
3072
+ experimentCount?: number;
3073
+ traceCount?: number;
3074
+ totalEstimatedCost?: number;
3075
+ totalEstimatedCostAvg?: number;
3076
+ duration?: PercentageValues;
3077
+ feedbackScores?: FeedbackScoreAverage[];
3078
+ }
3079
+
3080
+ /**
3081
+ * This file was auto-generated by Fern from our API Definition.
3082
+ */
3083
+
3084
+ interface ExperimentGroupAggregationsResponse {
3085
+ content?: Record<string, GroupContentWithAggregations>;
3086
+ }
3087
+
3088
+ /**
3089
+ * This file was auto-generated by Fern from our API Definition.
3090
+ */
3091
+
3092
+ interface GroupContentWithAggregations {
3093
+ aggregations?: AggregationData;
3094
+ }
3095
+
2982
3096
  /**
2983
3097
  * This file was auto-generated by Fern from our API Definition.
2984
3098
  */
@@ -3726,6 +3840,7 @@ interface FeedbackScorePublic {
3726
3840
  lastUpdatedAt?: Date;
3727
3841
  createdBy?: string;
3728
3842
  lastUpdatedBy?: string;
3843
+ valueByAuthor?: Record<string, ValueEntryPublic>;
3729
3844
  }
3730
3845
 
3731
3846
  /**
@@ -3779,6 +3894,28 @@ interface SpanPublic {
3779
3894
  duration?: number;
3780
3895
  }
3781
3896
 
3897
+ /**
3898
+ * This file was auto-generated by Fern from our API Definition.
3899
+ */
3900
+ type ValueEntryPublicSource = "ui" | "sdk" | "online_scoring";
3901
+ declare const ValueEntryPublicSource: {
3902
+ readonly Ui: "ui";
3903
+ readonly Sdk: "sdk";
3904
+ readonly OnlineScoring: "online_scoring";
3905
+ };
3906
+
3907
+ /**
3908
+ * This file was auto-generated by Fern from our API Definition.
3909
+ */
3910
+
3911
+ interface ValueEntryPublic {
3912
+ value?: number;
3913
+ reason?: string;
3914
+ categoryName?: string;
3915
+ source?: ValueEntryPublicSource;
3916
+ lastUpdatedAt?: Date;
3917
+ }
3918
+
3782
3919
  /**
3783
3920
  * This file was auto-generated by Fern from our API Definition.
3784
3921
  */
@@ -5109,6 +5246,7 @@ declare class Experiments {
5109
5246
  * @param {Experiments.RequestOptions} requestOptions - Request-specific configuration.
5110
5247
  *
5111
5248
  * @throws {@link OpikApi.BadRequestError}
5249
+ * @throws {@link OpikApi.ConflictError}
5112
5250
  * @throws {@link OpikApi.UnprocessableEntityError}
5113
5251
  *
5114
5252
  * @example
@@ -5146,6 +5284,19 @@ declare class Experiments {
5146
5284
  */
5147
5285
  findExperimentGroups(request?: FindExperimentGroupsRequest, requestOptions?: Experiments.RequestOptions): HttpResponsePromise<ExperimentGroupResponse>;
5148
5286
  private __findExperimentGroups;
5287
+ /**
5288
+ * Find experiments grouped by specified fields with aggregation metrics
5289
+ *
5290
+ * @param {OpikApi.FindExperimentGroupsAggregationsRequest} request
5291
+ * @param {Experiments.RequestOptions} requestOptions - Request-specific configuration.
5292
+ *
5293
+ * @throws {@link OpikApi.BadRequestError}
5294
+ *
5295
+ * @example
5296
+ * await client.experiments.findExperimentGroupsAggregations()
5297
+ */
5298
+ findExperimentGroupsAggregations(request?: FindExperimentGroupsAggregationsRequest, requestOptions?: Experiments.RequestOptions): HttpResponsePromise<ExperimentGroupAggregationsResponse>;
5299
+ private __findExperimentGroupsAggregations;
5149
5300
  /**
5150
5301
  * Get experiment by id
5151
5302
  *