opik 1.6.13 → 1.6.15

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.
@@ -193,6 +193,24 @@ interface ProviderApiKeyUpdate {
193
193
  name?: string;
194
194
  }
195
195
 
196
+ /**
197
+ * This file was auto-generated by Fern from our API Definition.
198
+ */
199
+ type ProjectWriteVisibility = "private" | "public";
200
+ declare const ProjectWriteVisibility: {
201
+ readonly Private: "private";
202
+ readonly Public: "public";
203
+ };
204
+
205
+ /**
206
+ * This file was auto-generated by Fern from our API Definition.
207
+ */
208
+ type ProjectUpdateVisibility = "private" | "public";
209
+ declare const ProjectUpdateVisibility: {
210
+ readonly Private: "private";
211
+ readonly Public: "public";
212
+ };
213
+
196
214
  /**
197
215
  * This file was auto-generated by Fern from our API Definition.
198
216
  */
@@ -232,6 +250,7 @@ interface FindProjectsRequest {
232
250
  /**
233
251
  * This file was auto-generated by Fern from our API Definition.
234
252
  */
253
+
235
254
  /**
236
255
  * @example
237
256
  * {
@@ -240,12 +259,14 @@ interface FindProjectsRequest {
240
259
  */
241
260
  interface ProjectWrite {
242
261
  name: string;
262
+ visibility?: ProjectWriteVisibility;
243
263
  description?: string;
244
264
  }
245
265
 
246
266
  /**
247
267
  * This file was auto-generated by Fern from our API Definition.
248
268
  */
269
+
249
270
  /**
250
271
  * @example
251
272
  * {}
@@ -253,6 +274,7 @@ interface ProjectWrite {
253
274
  interface ProjectUpdate {
254
275
  name?: string;
255
276
  description?: string;
277
+ visibility?: ProjectUpdateVisibility;
256
278
  }
257
279
 
258
280
  /**
@@ -411,41 +433,45 @@ interface PromptVersionRetrieveDetail {
411
433
  /**
412
434
  * This file was auto-generated by Fern from our API Definition.
413
435
  */
414
- type GetSpansByProjectRequestType = "general" | "tool" | "llm";
436
+ type GetSpansByProjectRequestType = "general" | "tool" | "llm" | "guardrail";
415
437
  declare const GetSpansByProjectRequestType: {
416
438
  readonly General: "general";
417
439
  readonly Tool: "tool";
418
440
  readonly Llm: "llm";
441
+ readonly Guardrail: "guardrail";
419
442
  };
420
443
 
421
444
  /**
422
445
  * This file was auto-generated by Fern from our API Definition.
423
446
  */
424
- type FindFeedbackScoreNames1RequestType = "general" | "tool" | "llm";
447
+ type FindFeedbackScoreNames1RequestType = "general" | "tool" | "llm" | "guardrail";
425
448
  declare const FindFeedbackScoreNames1RequestType: {
426
449
  readonly General: "general";
427
450
  readonly Tool: "tool";
428
451
  readonly Llm: "llm";
452
+ readonly Guardrail: "guardrail";
429
453
  };
430
454
 
431
455
  /**
432
456
  * This file was auto-generated by Fern from our API Definition.
433
457
  */
434
- type GetSpanStatsRequestType = "general" | "tool" | "llm";
458
+ type GetSpanStatsRequestType = "general" | "tool" | "llm" | "guardrail";
435
459
  declare const GetSpanStatsRequestType: {
436
460
  readonly General: "general";
437
461
  readonly Tool: "tool";
438
462
  readonly Llm: "llm";
463
+ readonly Guardrail: "guardrail";
439
464
  };
440
465
 
441
466
  /**
442
467
  * This file was auto-generated by Fern from our API Definition.
443
468
  */
444
- type SpanSearchStreamRequestPublicType = "general" | "tool" | "llm";
469
+ type SpanSearchStreamRequestPublicType = "general" | "tool" | "llm" | "guardrail";
445
470
  declare const SpanSearchStreamRequestPublicType: {
446
471
  readonly General: "general";
447
472
  readonly Tool: "tool";
448
473
  readonly Llm: "llm";
474
+ readonly Guardrail: "guardrail";
449
475
  };
450
476
 
451
477
  /**
@@ -898,25 +924,21 @@ interface FindFeedbackScoreNamesRequest {
898
924
  /**
899
925
  * This file was auto-generated by Fern from our API Definition.
900
926
  */
901
- /**
902
- * @example
903
- * {
904
- * name: "name"
905
- * }
906
- */
907
- interface IdentifierPublic {
908
- name: string;
927
+ interface ExperimentItemStreamRequest {
928
+ experimentName: string;
929
+ limit?: number;
930
+ lastRetrievedId?: string;
931
+ /** Truncate image included in either input, output or metadata */
932
+ truncate?: boolean;
909
933
  }
910
934
 
911
935
  /**
912
936
  * This file was auto-generated by Fern from our API Definition.
913
937
  */
914
- interface ExperimentItemStreamRequest {
915
- experimentName: string;
938
+ interface ExperimentStreamRequestPublic {
939
+ name: string;
916
940
  limit?: number;
917
941
  lastRetrievedId?: string;
918
- /** Truncate image included in either input, output or metadata */
919
- truncate?: boolean;
920
942
  }
921
943
 
922
944
  /**
@@ -2513,9 +2535,20 @@ interface ProjectPagePublic {
2513
2535
  /**
2514
2536
  * This file was auto-generated by Fern from our API Definition.
2515
2537
  */
2538
+ type ProjectPublicVisibility = "private" | "public";
2539
+ declare const ProjectPublicVisibility: {
2540
+ readonly Private: "private";
2541
+ readonly Public: "public";
2542
+ };
2543
+
2544
+ /**
2545
+ * This file was auto-generated by Fern from our API Definition.
2546
+ */
2547
+
2516
2548
  interface ProjectPublic {
2517
2549
  id?: string;
2518
2550
  name: string;
2551
+ visibility?: ProjectPublicVisibility;
2519
2552
  description?: string;
2520
2553
  createdAt?: Date;
2521
2554
  createdBy?: string;
@@ -2627,6 +2660,15 @@ interface PercentageValuesDetailed {
2627
2660
  p99?: number;
2628
2661
  }
2629
2662
 
2663
+ /**
2664
+ * This file was auto-generated by Fern from our API Definition.
2665
+ */
2666
+ type ProjectDetailedVisibility = "private" | "public";
2667
+ declare const ProjectDetailedVisibility: {
2668
+ readonly Private: "private";
2669
+ readonly Public: "public";
2670
+ };
2671
+
2630
2672
  /**
2631
2673
  * This file was auto-generated by Fern from our API Definition.
2632
2674
  */
@@ -2634,6 +2676,7 @@ interface PercentageValuesDetailed {
2634
2676
  interface ProjectDetailed {
2635
2677
  id?: string;
2636
2678
  name: string;
2679
+ visibility?: ProjectDetailedVisibility;
2637
2680
  description?: string;
2638
2681
  createdAt?: Date;
2639
2682
  createdBy?: string;
@@ -2759,6 +2802,13 @@ interface PromptPublic {
2759
2802
  versionCount?: number;
2760
2803
  }
2761
2804
 
2805
+ /**
2806
+ * This file was auto-generated by Fern from our API Definition.
2807
+ */
2808
+ interface ServiceTogglesConfig {
2809
+ pythonEvaluatorEnabled: boolean;
2810
+ }
2811
+
2762
2812
  /**
2763
2813
  * This file was auto-generated by Fern from our API Definition.
2764
2814
  */
@@ -2771,11 +2821,12 @@ interface ErrorInfo {
2771
2821
  /**
2772
2822
  * This file was auto-generated by Fern from our API Definition.
2773
2823
  */
2774
- type SpanType = "general" | "tool" | "llm";
2824
+ type SpanType = "general" | "tool" | "llm" | "guardrail";
2775
2825
  declare const SpanType: {
2776
2826
  readonly General: "general";
2777
2827
  readonly Tool: "tool";
2778
2828
  readonly Llm: "llm";
2829
+ readonly Guardrail: "guardrail";
2779
2830
  };
2780
2831
 
2781
2832
  /**
@@ -2825,11 +2876,12 @@ interface ErrorInfoWrite {
2825
2876
  /**
2826
2877
  * This file was auto-generated by Fern from our API Definition.
2827
2878
  */
2828
- type SpanWriteType = "general" | "tool" | "llm";
2879
+ type SpanWriteType = "general" | "tool" | "llm" | "guardrail";
2829
2880
  declare const SpanWriteType: {
2830
2881
  readonly General: "general";
2831
2882
  readonly Tool: "tool";
2832
2883
  readonly Llm: "llm";
2884
+ readonly Guardrail: "guardrail";
2833
2885
  };
2834
2886
 
2835
2887
  /**
@@ -2903,11 +2955,12 @@ interface FeedbackScorePublic {
2903
2955
  /**
2904
2956
  * This file was auto-generated by Fern from our API Definition.
2905
2957
  */
2906
- type SpanPublicType = "general" | "tool" | "llm";
2958
+ type SpanPublicType = "general" | "tool" | "llm" | "guardrail";
2907
2959
  declare const SpanPublicType: {
2908
2960
  readonly General: "general";
2909
2961
  readonly Tool: "tool";
2910
2962
  readonly Llm: "llm";
2963
+ readonly Guardrail: "guardrail";
2911
2964
  };
2912
2965
 
2913
2966
  /**
@@ -3381,7 +3434,7 @@ declare class Attachments {
3381
3434
  */
3382
3435
  attachmentList(request: AttachmentListRequest, requestOptions?: Attachments.RequestOptions): Promise<AttachmentPage>;
3383
3436
  /**
3384
- * Start multipart attachment upload
3437
+ * Complete multipart attachment upload
3385
3438
  *
3386
3439
  * @param {OpikApi.CompleteMultipartUploadRequest} request
3387
3440
  * @param {Attachments.RequestOptions} requestOptions - Request-specific configuration.
@@ -3390,7 +3443,7 @@ declare class Attachments {
3390
3443
  * @throws {@link OpikApi.ForbiddenError}
3391
3444
  *
3392
3445
  * @example
3393
- * await client.attachments.startMultiPartUpload({
3446
+ * await client.attachments.completeMultiPartUpload({
3394
3447
  * fileName: "file_name",
3395
3448
  * entityType: "trace",
3396
3449
  * entityId: "entity_id",
@@ -3402,7 +3455,7 @@ declare class Attachments {
3402
3455
  * }]
3403
3456
  * })
3404
3457
  */
3405
- startMultiPartUpload(request: CompleteMultipartUploadRequest, requestOptions?: Attachments.RequestOptions): Promise<void>;
3458
+ completeMultiPartUpload(request: CompleteMultipartUploadRequest, requestOptions?: Attachments.RequestOptions): Promise<void>;
3406
3459
  /**
3407
3460
  * Delete attachments
3408
3461
  *
@@ -3442,7 +3495,7 @@ declare class Attachments {
3442
3495
  * @throws {@link OpikApi.ForbiddenError}
3443
3496
  *
3444
3497
  * @example
3445
- * await client.attachments.startMultiPartUpload1({
3498
+ * await client.attachments.startMultiPartUpload({
3446
3499
  * fileName: "file_name",
3447
3500
  * numOfFileParts: 1,
3448
3501
  * entityType: "trace",
@@ -3450,7 +3503,7 @@ declare class Attachments {
3450
3503
  * path: "path"
3451
3504
  * })
3452
3505
  */
3453
- startMultiPartUpload1(request: StartMultipartUploadRequest, requestOptions?: Attachments.RequestOptions): Promise<StartMultipartUploadResponse>;
3506
+ startMultiPartUpload(request: StartMultipartUploadRequest, requestOptions?: Attachments.RequestOptions): Promise<StartMultipartUploadResponse>;
3454
3507
  /**
3455
3508
  * Upload attachment to MinIO
3456
3509
  *
@@ -4034,20 +4087,6 @@ declare class Experiments {
4034
4087
  * await client.experiments.getExperimentById("id")
4035
4088
  */
4036
4089
  getExperimentById(id: string, requestOptions?: Experiments.RequestOptions): Promise<ExperimentPublic>;
4037
- /**
4038
- * Get experiment by name
4039
- *
4040
- * @param {OpikApi.IdentifierPublic} request
4041
- * @param {Experiments.RequestOptions} requestOptions - Request-specific configuration.
4042
- *
4043
- * @throws {@link OpikApi.NotFoundError}
4044
- *
4045
- * @example
4046
- * await client.experiments.getExperimentByName({
4047
- * name: "name"
4048
- * })
4049
- */
4050
- getExperimentByName(request: IdentifierPublic, requestOptions?: Experiments.RequestOptions): Promise<ExperimentPublic>;
4051
4090
  /**
4052
4091
  * Get experiment item by id
4053
4092
  *
@@ -4064,6 +4103,10 @@ declare class Experiments {
4064
4103
  * Stream experiment items
4065
4104
  */
4066
4105
  streamExperimentItems(request: ExperimentItemStreamRequest, requestOptions?: Experiments.RequestOptions): Promise<stream.Readable>;
4106
+ /**
4107
+ * Stream experiments
4108
+ */
4109
+ streamExperiments(request: ExperimentStreamRequestPublic, requestOptions?: Experiments.RequestOptions): Promise<stream.Readable>;
4067
4110
  protected _getCustomAuthorizationHeaders(): Promise<{
4068
4111
  Authorization: string | undefined;
4069
4112
  }>;
@@ -4672,6 +4715,55 @@ declare class Prompts {
4672
4715
  }>;
4673
4716
  }
4674
4717
 
4718
+ /**
4719
+ * This file was auto-generated by Fern from our API Definition.
4720
+ */
4721
+
4722
+ declare namespace ServiceToggles {
4723
+ interface Options {
4724
+ environment?: Supplier<OpikApiEnvironment | string>;
4725
+ /** Specify a custom URL to connect the client to. */
4726
+ baseUrl?: Supplier<string>;
4727
+ /** Override the Authorization header */
4728
+ apiKey?: Supplier<string | undefined>;
4729
+ /** Override the Comet-Workspace header */
4730
+ workspaceName?: Supplier<string | undefined>;
4731
+ }
4732
+ interface RequestOptions {
4733
+ /** The maximum time to wait for a response in seconds. */
4734
+ timeoutInSeconds?: number;
4735
+ /** The number of times to retry the request. Defaults to 2. */
4736
+ maxRetries?: number;
4737
+ /** A hook to abort the request. */
4738
+ abortSignal?: AbortSignal;
4739
+ /** Override the Authorization header */
4740
+ apiKey?: string | undefined;
4741
+ /** Override the Comet-Workspace header */
4742
+ workspaceName?: string | undefined;
4743
+ /** Additional headers to include in the request. */
4744
+ headers?: Record<string, string>;
4745
+ }
4746
+ }
4747
+ /**
4748
+ * Service Toggles resources
4749
+ */
4750
+ declare class ServiceToggles {
4751
+ protected readonly _options: ServiceToggles.Options;
4752
+ constructor(_options?: ServiceToggles.Options);
4753
+ /**
4754
+ * Get Service Toggles
4755
+ *
4756
+ * @param {ServiceToggles.RequestOptions} requestOptions - Request-specific configuration.
4757
+ *
4758
+ * @example
4759
+ * await client.serviceToggles.getServiceToggles()
4760
+ */
4761
+ getServiceToggles(requestOptions?: ServiceToggles.RequestOptions): Promise<ServiceTogglesConfig>;
4762
+ protected _getCustomAuthorizationHeaders(): Promise<{
4763
+ Authorization: string | undefined;
4764
+ }>;
4765
+ }
4766
+
4675
4767
  /**
4676
4768
  * This file was auto-generated by Fern from our API Definition.
4677
4769
  */
@@ -5332,6 +5424,7 @@ declare class OpikApiClient {
5332
5424
  protected _openTelemetryIngestion: OpenTelemetryIngestion | undefined;
5333
5425
  protected _projects: Projects | undefined;
5334
5426
  protected _prompts: Prompts | undefined;
5427
+ protected _serviceToggles: ServiceToggles | undefined;
5335
5428
  protected _spans: Spans | undefined;
5336
5429
  protected _traces: Traces | undefined;
5337
5430
  protected _redirect: Redirect | undefined;
@@ -5348,6 +5441,7 @@ declare class OpikApiClient {
5348
5441
  get openTelemetryIngestion(): OpenTelemetryIngestion;
5349
5442
  get projects(): Projects;
5350
5443
  get prompts(): Prompts;
5444
+ get serviceToggles(): ServiceToggles;
5351
5445
  get spans(): Spans;
5352
5446
  get traces(): Traces;
5353
5447
  get redirect(): Redirect;
@@ -5506,4 +5600,4 @@ declare class OpikClient {
5506
5600
  flush: () => Promise<void>;
5507
5601
  }
5508
5602
 
5509
- export { type JsonNode as J, OpikClient as O, Span as S, Trace as T, SpanType as a, type OpikConfig as b };
5603
+ export { OpikClient as O, Span as S, Trace as T, SpanType as a, type OpikConfig as b };