opik 1.7.36 → 1.7.37

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.
@@ -863,7 +863,6 @@ interface GetSpansByProjectRequest {
863
863
  * @example
864
864
  * {
865
865
  * spans: [{
866
- * traceId: "trace_id",
867
866
  * startTime: "2024-01-15T09:30:00Z"
868
867
  * }]
869
868
  * }
@@ -1161,21 +1160,6 @@ interface GetTraceStatsRequest {
1161
1160
  filters?: string;
1162
1161
  }
1163
1162
 
1164
- /**
1165
- * This file was auto-generated by Fern from our API Definition.
1166
- */
1167
- /**
1168
- * @example
1169
- * {
1170
- * projectId: "project_id",
1171
- * threadId: "thread_id"
1172
- * }
1173
- */
1174
- interface TraceThreadIdentifier {
1175
- projectId: string;
1176
- threadId: string;
1177
- }
1178
-
1179
1163
  /**
1180
1164
  * This file was auto-generated by Fern from our API Definition.
1181
1165
  */
@@ -1208,6 +1192,22 @@ interface TraceSearchStreamRequestPublic {
1208
1192
  truncate?: boolean;
1209
1193
  }
1210
1194
 
1195
+ /**
1196
+ * This file was auto-generated by Fern from our API Definition.
1197
+ */
1198
+ /**
1199
+ * @example
1200
+ * {
1201
+ * intervalStart: "2024-01-15T09:30:00Z",
1202
+ * intervalEnd: "2024-01-15T09:30:00Z"
1203
+ * }
1204
+ */
1205
+ interface WorkspaceMetricsSummaryRequest {
1206
+ projectIds?: string[];
1207
+ intervalStart: Date;
1208
+ intervalEnd: Date;
1209
+ }
1210
+
1211
1211
  /**
1212
1212
  * This file was auto-generated by Fern from our API Definition.
1213
1213
  */
@@ -2484,7 +2484,7 @@ interface Span$1 {
2484
2484
  /** If null, the default project is used */
2485
2485
  projectName?: string;
2486
2486
  projectId?: string;
2487
- traceId: string;
2487
+ traceId?: string;
2488
2488
  parentSpanId?: string;
2489
2489
  name?: string;
2490
2490
  type?: SpanType;
@@ -3440,7 +3440,7 @@ interface SpanWrite {
3440
3440
  id?: string;
3441
3441
  /** If null, the default project is used */
3442
3442
  projectName?: string;
3443
- traceId: string;
3443
+ traceId?: string;
3444
3444
  parentSpanId?: string;
3445
3445
  name?: string;
3446
3446
  type?: SpanWriteType;
@@ -3526,7 +3526,7 @@ interface SpanPublic {
3526
3526
  /** If null, the default project is used */
3527
3527
  projectName?: string;
3528
3528
  projectId?: string;
3529
- traceId: string;
3529
+ traceId?: string;
3530
3530
  parentSpanId?: string;
3531
3531
  name?: string;
3532
3532
  type?: SpanPublicType;
@@ -3677,6 +3677,15 @@ interface SpanFilterPublic {
3677
3677
  value?: string;
3678
3678
  }
3679
3679
 
3680
+ /**
3681
+ * This file was auto-generated by Fern from our API Definition.
3682
+ */
3683
+ interface TraceThreadIdentifier {
3684
+ projectName?: string;
3685
+ projectId?: string;
3686
+ threadId: string;
3687
+ }
3688
+
3680
3689
  /**
3681
3690
  * This file was auto-generated by Fern from our API Definition.
3682
3691
  */
@@ -3848,6 +3857,23 @@ interface TraceFilterPublic {
3848
3857
  value?: string;
3849
3858
  }
3850
3859
 
3860
+ /**
3861
+ * This file was auto-generated by Fern from our API Definition.
3862
+ */
3863
+ interface Result {
3864
+ name?: string;
3865
+ current?: number;
3866
+ previous?: number;
3867
+ }
3868
+
3869
+ /**
3870
+ * This file was auto-generated by Fern from our API Definition.
3871
+ */
3872
+
3873
+ interface WorkspaceMetricsSummaryResponse {
3874
+ results?: Result[];
3875
+ }
3876
+
3851
3877
  /**
3852
3878
  * The raw response from the fetch call excluding the body.
3853
3879
  */
@@ -5781,7 +5807,6 @@ declare class Spans {
5781
5807
  *
5782
5808
  * @example
5783
5809
  * await client.spans.createSpan({
5784
- * traceId: "trace_id",
5785
5810
  * startTime: "2024-01-15T09:30:00Z"
5786
5811
  * })
5787
5812
  */
@@ -5796,7 +5821,6 @@ declare class Spans {
5796
5821
  * @example
5797
5822
  * await client.spans.createSpans({
5798
5823
  * spans: [{
5799
- * traceId: "trace_id",
5800
5824
  * startTime: "2024-01-15T09:30:00Z"
5801
5825
  * }]
5802
5826
  * })
@@ -6018,6 +6042,19 @@ declare class Traces {
6018
6042
  */
6019
6043
  addTraceFeedbackScore(id: string, request: FeedbackScore, requestOptions?: Traces.RequestOptions): HttpResponsePromise<void>;
6020
6044
  private __addTraceFeedbackScore;
6045
+ /**
6046
+ * Close trace thread
6047
+ *
6048
+ * @param {OpikApi.TraceThreadIdentifier} request
6049
+ * @param {Traces.RequestOptions} requestOptions - Request-specific configuration.
6050
+ *
6051
+ * @example
6052
+ * await client.traces.closeTraceThread({
6053
+ * threadId: "thread_id"
6054
+ * })
6055
+ */
6056
+ closeTraceThread(request: TraceThreadIdentifier, requestOptions?: Traces.RequestOptions): HttpResponsePromise<void>;
6057
+ private __closeTraceThread;
6021
6058
  /**
6022
6059
  * Get traces by project_name or project_id
6023
6060
  *
@@ -6190,7 +6227,6 @@ declare class Traces {
6190
6227
  *
6191
6228
  * @example
6192
6229
  * await client.traces.getTraceThread({
6193
- * projectId: "project_id",
6194
6230
  * threadId: "thread_id"
6195
6231
  * })
6196
6232
  */
@@ -6207,6 +6243,19 @@ declare class Traces {
6207
6243
  */
6208
6244
  getTraceThreads(request?: GetTraceThreadsRequest, requestOptions?: Traces.RequestOptions): HttpResponsePromise<TraceThreadPage>;
6209
6245
  private __getTraceThreads;
6246
+ /**
6247
+ * Open trace thread
6248
+ *
6249
+ * @param {OpikApi.TraceThreadIdentifier} request
6250
+ * @param {Traces.RequestOptions} requestOptions - Request-specific configuration.
6251
+ *
6252
+ * @example
6253
+ * await client.traces.openTraceThread({
6254
+ * threadId: "thread_id"
6255
+ * })
6256
+ */
6257
+ openTraceThread(request: TraceThreadIdentifier, requestOptions?: Traces.RequestOptions): HttpResponsePromise<void>;
6258
+ private __openTraceThread;
6210
6259
  /**
6211
6260
  * Batch feedback scoring for traces
6212
6261
  *
@@ -6253,6 +6302,62 @@ declare class Traces {
6253
6302
  }>;
6254
6303
  }
6255
6304
 
6305
+ /**
6306
+ * This file was auto-generated by Fern from our API Definition.
6307
+ */
6308
+
6309
+ declare namespace Workspaces {
6310
+ interface Options {
6311
+ environment?: Supplier<OpikApiEnvironment | string>;
6312
+ /** Specify a custom URL to connect the client to. */
6313
+ baseUrl?: Supplier<string>;
6314
+ /** Override the Authorization header */
6315
+ apiKey?: Supplier<string | undefined>;
6316
+ /** Override the Comet-Workspace header */
6317
+ workspaceName?: Supplier<string | undefined>;
6318
+ }
6319
+ interface RequestOptions {
6320
+ /** The maximum time to wait for a response in seconds. */
6321
+ timeoutInSeconds?: number;
6322
+ /** The number of times to retry the request. Defaults to 2. */
6323
+ maxRetries?: number;
6324
+ /** A hook to abort the request. */
6325
+ abortSignal?: AbortSignal;
6326
+ /** Override the Authorization header */
6327
+ apiKey?: string | undefined;
6328
+ /** Override the Comet-Workspace header */
6329
+ workspaceName?: string | undefined;
6330
+ /** Additional headers to include in the request. */
6331
+ headers?: Record<string, string>;
6332
+ }
6333
+ }
6334
+ /**
6335
+ * Workspace related resources
6336
+ */
6337
+ declare class Workspaces {
6338
+ protected readonly _options: Workspaces.Options;
6339
+ constructor(_options?: Workspaces.Options);
6340
+ /**
6341
+ * Get metrics summary
6342
+ *
6343
+ * @param {OpikApi.WorkspaceMetricsSummaryRequest} request
6344
+ * @param {Workspaces.RequestOptions} requestOptions - Request-specific configuration.
6345
+ *
6346
+ * @throws {@link OpikApi.BadRequestError}
6347
+ *
6348
+ * @example
6349
+ * await client.workspaces.metricsSummary({
6350
+ * intervalStart: "2024-01-15T09:30:00Z",
6351
+ * intervalEnd: "2024-01-15T09:30:00Z"
6352
+ * })
6353
+ */
6354
+ metricsSummary(request: WorkspaceMetricsSummaryRequest, requestOptions?: Workspaces.RequestOptions): HttpResponsePromise<WorkspaceMetricsSummaryResponse>;
6355
+ private __metricsSummary;
6356
+ protected _getCustomAuthorizationHeaders(): Promise<{
6357
+ Authorization: string | undefined;
6358
+ }>;
6359
+ }
6360
+
6256
6361
  /**
6257
6362
  * This file was auto-generated by Fern from our API Definition.
6258
6363
  */
@@ -6411,6 +6516,7 @@ declare class OpikApiClient {
6411
6516
  protected _serviceToggles: ServiceToggles | undefined;
6412
6517
  protected _spans: Spans | undefined;
6413
6518
  protected _traces: Traces | undefined;
6519
+ protected _workspaces: Workspaces | undefined;
6414
6520
  protected _redirect: Redirect | undefined;
6415
6521
  constructor(_options?: OpikApiClient.Options);
6416
6522
  get systemUsage(): SystemUsage;
@@ -6430,6 +6536,7 @@ declare class OpikApiClient {
6430
6536
  get serviceToggles(): ServiceToggles;
6431
6537
  get spans(): Spans;
6432
6538
  get traces(): Traces;
6539
+ get workspaces(): Workspaces;
6433
6540
  get redirect(): Redirect;
6434
6541
  /**
6435
6542
  * @param {OpikApiClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -863,7 +863,6 @@ interface GetSpansByProjectRequest {
863
863
  * @example
864
864
  * {
865
865
  * spans: [{
866
- * traceId: "trace_id",
867
866
  * startTime: "2024-01-15T09:30:00Z"
868
867
  * }]
869
868
  * }
@@ -1161,21 +1160,6 @@ interface GetTraceStatsRequest {
1161
1160
  filters?: string;
1162
1161
  }
1163
1162
 
1164
- /**
1165
- * This file was auto-generated by Fern from our API Definition.
1166
- */
1167
- /**
1168
- * @example
1169
- * {
1170
- * projectId: "project_id",
1171
- * threadId: "thread_id"
1172
- * }
1173
- */
1174
- interface TraceThreadIdentifier {
1175
- projectId: string;
1176
- threadId: string;
1177
- }
1178
-
1179
1163
  /**
1180
1164
  * This file was auto-generated by Fern from our API Definition.
1181
1165
  */
@@ -1208,6 +1192,22 @@ interface TraceSearchStreamRequestPublic {
1208
1192
  truncate?: boolean;
1209
1193
  }
1210
1194
 
1195
+ /**
1196
+ * This file was auto-generated by Fern from our API Definition.
1197
+ */
1198
+ /**
1199
+ * @example
1200
+ * {
1201
+ * intervalStart: "2024-01-15T09:30:00Z",
1202
+ * intervalEnd: "2024-01-15T09:30:00Z"
1203
+ * }
1204
+ */
1205
+ interface WorkspaceMetricsSummaryRequest {
1206
+ projectIds?: string[];
1207
+ intervalStart: Date;
1208
+ intervalEnd: Date;
1209
+ }
1210
+
1211
1211
  /**
1212
1212
  * This file was auto-generated by Fern from our API Definition.
1213
1213
  */
@@ -2484,7 +2484,7 @@ interface Span$1 {
2484
2484
  /** If null, the default project is used */
2485
2485
  projectName?: string;
2486
2486
  projectId?: string;
2487
- traceId: string;
2487
+ traceId?: string;
2488
2488
  parentSpanId?: string;
2489
2489
  name?: string;
2490
2490
  type?: SpanType;
@@ -3440,7 +3440,7 @@ interface SpanWrite {
3440
3440
  id?: string;
3441
3441
  /** If null, the default project is used */
3442
3442
  projectName?: string;
3443
- traceId: string;
3443
+ traceId?: string;
3444
3444
  parentSpanId?: string;
3445
3445
  name?: string;
3446
3446
  type?: SpanWriteType;
@@ -3526,7 +3526,7 @@ interface SpanPublic {
3526
3526
  /** If null, the default project is used */
3527
3527
  projectName?: string;
3528
3528
  projectId?: string;
3529
- traceId: string;
3529
+ traceId?: string;
3530
3530
  parentSpanId?: string;
3531
3531
  name?: string;
3532
3532
  type?: SpanPublicType;
@@ -3677,6 +3677,15 @@ interface SpanFilterPublic {
3677
3677
  value?: string;
3678
3678
  }
3679
3679
 
3680
+ /**
3681
+ * This file was auto-generated by Fern from our API Definition.
3682
+ */
3683
+ interface TraceThreadIdentifier {
3684
+ projectName?: string;
3685
+ projectId?: string;
3686
+ threadId: string;
3687
+ }
3688
+
3680
3689
  /**
3681
3690
  * This file was auto-generated by Fern from our API Definition.
3682
3691
  */
@@ -3848,6 +3857,23 @@ interface TraceFilterPublic {
3848
3857
  value?: string;
3849
3858
  }
3850
3859
 
3860
+ /**
3861
+ * This file was auto-generated by Fern from our API Definition.
3862
+ */
3863
+ interface Result {
3864
+ name?: string;
3865
+ current?: number;
3866
+ previous?: number;
3867
+ }
3868
+
3869
+ /**
3870
+ * This file was auto-generated by Fern from our API Definition.
3871
+ */
3872
+
3873
+ interface WorkspaceMetricsSummaryResponse {
3874
+ results?: Result[];
3875
+ }
3876
+
3851
3877
  /**
3852
3878
  * The raw response from the fetch call excluding the body.
3853
3879
  */
@@ -5781,7 +5807,6 @@ declare class Spans {
5781
5807
  *
5782
5808
  * @example
5783
5809
  * await client.spans.createSpan({
5784
- * traceId: "trace_id",
5785
5810
  * startTime: "2024-01-15T09:30:00Z"
5786
5811
  * })
5787
5812
  */
@@ -5796,7 +5821,6 @@ declare class Spans {
5796
5821
  * @example
5797
5822
  * await client.spans.createSpans({
5798
5823
  * spans: [{
5799
- * traceId: "trace_id",
5800
5824
  * startTime: "2024-01-15T09:30:00Z"
5801
5825
  * }]
5802
5826
  * })
@@ -6018,6 +6042,19 @@ declare class Traces {
6018
6042
  */
6019
6043
  addTraceFeedbackScore(id: string, request: FeedbackScore, requestOptions?: Traces.RequestOptions): HttpResponsePromise<void>;
6020
6044
  private __addTraceFeedbackScore;
6045
+ /**
6046
+ * Close trace thread
6047
+ *
6048
+ * @param {OpikApi.TraceThreadIdentifier} request
6049
+ * @param {Traces.RequestOptions} requestOptions - Request-specific configuration.
6050
+ *
6051
+ * @example
6052
+ * await client.traces.closeTraceThread({
6053
+ * threadId: "thread_id"
6054
+ * })
6055
+ */
6056
+ closeTraceThread(request: TraceThreadIdentifier, requestOptions?: Traces.RequestOptions): HttpResponsePromise<void>;
6057
+ private __closeTraceThread;
6021
6058
  /**
6022
6059
  * Get traces by project_name or project_id
6023
6060
  *
@@ -6190,7 +6227,6 @@ declare class Traces {
6190
6227
  *
6191
6228
  * @example
6192
6229
  * await client.traces.getTraceThread({
6193
- * projectId: "project_id",
6194
6230
  * threadId: "thread_id"
6195
6231
  * })
6196
6232
  */
@@ -6207,6 +6243,19 @@ declare class Traces {
6207
6243
  */
6208
6244
  getTraceThreads(request?: GetTraceThreadsRequest, requestOptions?: Traces.RequestOptions): HttpResponsePromise<TraceThreadPage>;
6209
6245
  private __getTraceThreads;
6246
+ /**
6247
+ * Open trace thread
6248
+ *
6249
+ * @param {OpikApi.TraceThreadIdentifier} request
6250
+ * @param {Traces.RequestOptions} requestOptions - Request-specific configuration.
6251
+ *
6252
+ * @example
6253
+ * await client.traces.openTraceThread({
6254
+ * threadId: "thread_id"
6255
+ * })
6256
+ */
6257
+ openTraceThread(request: TraceThreadIdentifier, requestOptions?: Traces.RequestOptions): HttpResponsePromise<void>;
6258
+ private __openTraceThread;
6210
6259
  /**
6211
6260
  * Batch feedback scoring for traces
6212
6261
  *
@@ -6253,6 +6302,62 @@ declare class Traces {
6253
6302
  }>;
6254
6303
  }
6255
6304
 
6305
+ /**
6306
+ * This file was auto-generated by Fern from our API Definition.
6307
+ */
6308
+
6309
+ declare namespace Workspaces {
6310
+ interface Options {
6311
+ environment?: Supplier<OpikApiEnvironment | string>;
6312
+ /** Specify a custom URL to connect the client to. */
6313
+ baseUrl?: Supplier<string>;
6314
+ /** Override the Authorization header */
6315
+ apiKey?: Supplier<string | undefined>;
6316
+ /** Override the Comet-Workspace header */
6317
+ workspaceName?: Supplier<string | undefined>;
6318
+ }
6319
+ interface RequestOptions {
6320
+ /** The maximum time to wait for a response in seconds. */
6321
+ timeoutInSeconds?: number;
6322
+ /** The number of times to retry the request. Defaults to 2. */
6323
+ maxRetries?: number;
6324
+ /** A hook to abort the request. */
6325
+ abortSignal?: AbortSignal;
6326
+ /** Override the Authorization header */
6327
+ apiKey?: string | undefined;
6328
+ /** Override the Comet-Workspace header */
6329
+ workspaceName?: string | undefined;
6330
+ /** Additional headers to include in the request. */
6331
+ headers?: Record<string, string>;
6332
+ }
6333
+ }
6334
+ /**
6335
+ * Workspace related resources
6336
+ */
6337
+ declare class Workspaces {
6338
+ protected readonly _options: Workspaces.Options;
6339
+ constructor(_options?: Workspaces.Options);
6340
+ /**
6341
+ * Get metrics summary
6342
+ *
6343
+ * @param {OpikApi.WorkspaceMetricsSummaryRequest} request
6344
+ * @param {Workspaces.RequestOptions} requestOptions - Request-specific configuration.
6345
+ *
6346
+ * @throws {@link OpikApi.BadRequestError}
6347
+ *
6348
+ * @example
6349
+ * await client.workspaces.metricsSummary({
6350
+ * intervalStart: "2024-01-15T09:30:00Z",
6351
+ * intervalEnd: "2024-01-15T09:30:00Z"
6352
+ * })
6353
+ */
6354
+ metricsSummary(request: WorkspaceMetricsSummaryRequest, requestOptions?: Workspaces.RequestOptions): HttpResponsePromise<WorkspaceMetricsSummaryResponse>;
6355
+ private __metricsSummary;
6356
+ protected _getCustomAuthorizationHeaders(): Promise<{
6357
+ Authorization: string | undefined;
6358
+ }>;
6359
+ }
6360
+
6256
6361
  /**
6257
6362
  * This file was auto-generated by Fern from our API Definition.
6258
6363
  */
@@ -6411,6 +6516,7 @@ declare class OpikApiClient {
6411
6516
  protected _serviceToggles: ServiceToggles | undefined;
6412
6517
  protected _spans: Spans | undefined;
6413
6518
  protected _traces: Traces | undefined;
6519
+ protected _workspaces: Workspaces | undefined;
6414
6520
  protected _redirect: Redirect | undefined;
6415
6521
  constructor(_options?: OpikApiClient.Options);
6416
6522
  get systemUsage(): SystemUsage;
@@ -6430,6 +6536,7 @@ declare class OpikApiClient {
6430
6536
  get serviceToggles(): ServiceToggles;
6431
6537
  get spans(): Spans;
6432
6538
  get traces(): Traces;
6539
+ get workspaces(): Workspaces;
6433
6540
  get redirect(): Redirect;
6434
6541
  /**
6435
6542
  * @param {OpikApiClient.RequestOptions} requestOptions - Request-specific configuration.