opik 1.8.46 → 1.8.47

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.
@@ -991,6 +991,25 @@ interface SpanSearchStreamRequestPublic {
991
991
  truncate?: boolean;
992
992
  }
993
993
 
994
+ /**
995
+ * This file was auto-generated by Fern from our API Definition.
996
+ */
997
+
998
+ /**
999
+ * @example
1000
+ * {
1001
+ * annotationQueues: [{
1002
+ * projectId: "project_id",
1003
+ * name: "name",
1004
+ * scope: "trace"
1005
+ * }]
1006
+ * }
1007
+ */
1008
+ interface AnnotationQueueBatchWrite {
1009
+ /** List of annotation queues to create */
1010
+ annotationQueues: AnnotationQueueWrite[];
1011
+ }
1012
+
994
1013
  /**
995
1014
  * This file was auto-generated by Fern from our API Definition.
996
1015
  */
@@ -1300,6 +1319,17 @@ interface TraceSearchStreamRequestPublic {
1300
1319
  truncate?: boolean;
1301
1320
  }
1302
1321
 
1322
+ /**
1323
+ * This file was auto-generated by Fern from our API Definition.
1324
+ */
1325
+ /**
1326
+ * @example
1327
+ * {}
1328
+ */
1329
+ interface TraceThreadUpdate {
1330
+ tags?: string[];
1331
+ }
1332
+
1303
1333
  /**
1304
1334
  * This file was auto-generated by Fern from our API Definition.
1305
1335
  */
@@ -1417,6 +1447,33 @@ interface WorkspaceTraceCount {
1417
1447
  traceCount?: number;
1418
1448
  }
1419
1449
 
1450
+ /**
1451
+ * This file was auto-generated by Fern from our API Definition.
1452
+ */
1453
+ type AnnotationQueueWriteScope = "trace" | "thread";
1454
+ declare const AnnotationQueueWriteScope: {
1455
+ readonly Trace: "trace";
1456
+ readonly Thread: "thread";
1457
+ };
1458
+
1459
+ /**
1460
+ * This file was auto-generated by Fern from our API Definition.
1461
+ */
1462
+
1463
+ /**
1464
+ * List of annotation queues to create
1465
+ */
1466
+ interface AnnotationQueueWrite {
1467
+ id?: string;
1468
+ projectId: string;
1469
+ name: string;
1470
+ description?: string;
1471
+ instructions?: string;
1472
+ scope: AnnotationQueueWriteScope;
1473
+ commentsEnabled?: boolean;
1474
+ feedbackDefinitions?: string[];
1475
+ }
1476
+
1420
1477
  /**
1421
1478
  * This file was auto-generated by Fern from our API Definition.
1422
1479
  */
@@ -4560,6 +4617,67 @@ declare class SystemUsage {
4560
4617
  }>;
4561
4618
  }
4562
4619
 
4620
+ /**
4621
+ * This file was auto-generated by Fern from our API Definition.
4622
+ */
4623
+
4624
+ declare namespace AnnotationQueues {
4625
+ interface Options {
4626
+ environment?: Supplier<OpikApiEnvironment | string>;
4627
+ /** Specify a custom URL to connect the client to. */
4628
+ baseUrl?: Supplier<string>;
4629
+ /** Override the Authorization header */
4630
+ apiKey?: Supplier<string | undefined>;
4631
+ /** Override the Comet-Workspace header */
4632
+ workspaceName?: Supplier<string | undefined>;
4633
+ }
4634
+ interface RequestOptions {
4635
+ /** The maximum time to wait for a response in seconds. */
4636
+ timeoutInSeconds?: number;
4637
+ /** The number of times to retry the request. Defaults to 2. */
4638
+ maxRetries?: number;
4639
+ /** A hook to abort the request. */
4640
+ abortSignal?: AbortSignal;
4641
+ /** Override the Authorization header */
4642
+ apiKey?: string | undefined;
4643
+ /** Override the Comet-Workspace header */
4644
+ workspaceName?: string | undefined;
4645
+ /** Additional headers to include in the request. */
4646
+ headers?: Record<string, string>;
4647
+ }
4648
+ }
4649
+ /**
4650
+ * Private annotation queue operations
4651
+ */
4652
+ declare class AnnotationQueues {
4653
+ protected readonly _options: AnnotationQueues.Options;
4654
+ constructor(_options?: AnnotationQueues.Options);
4655
+ /**
4656
+ * Create multiple annotation queues for human annotation workflows
4657
+ *
4658
+ * @param {OpikApi.AnnotationQueueBatchWrite} request
4659
+ * @param {AnnotationQueues.RequestOptions} requestOptions - Request-specific configuration.
4660
+ *
4661
+ * @throws {@link OpikApi.BadRequestError}
4662
+ * @throws {@link OpikApi.ConflictError}
4663
+ * @throws {@link OpikApi.UnprocessableEntityError}
4664
+ *
4665
+ * @example
4666
+ * await client.annotationQueues.createAnnotationQueueBatch({
4667
+ * annotationQueues: [{
4668
+ * projectId: "project_id",
4669
+ * name: "name",
4670
+ * scope: "trace"
4671
+ * }]
4672
+ * })
4673
+ */
4674
+ createAnnotationQueueBatch(request: AnnotationQueueBatchWrite, requestOptions?: AnnotationQueues.RequestOptions): HttpResponsePromise<void>;
4675
+ private __createAnnotationQueueBatch;
4676
+ protected _getCustomAuthorizationHeaders(): Promise<{
4677
+ Authorization: string | undefined;
4678
+ }>;
4679
+ }
4680
+
4563
4681
  /**
4564
4682
  * This file was auto-generated by Fern from our API Definition.
4565
4683
  */
@@ -6905,17 +7023,15 @@ declare class Traces {
6905
7023
  * Update thread
6906
7024
  *
6907
7025
  * @param {string} threadModelId
6908
- * @param {OpikApi.Comment} request
7026
+ * @param {OpikApi.TraceThreadUpdate} request
6909
7027
  * @param {Traces.RequestOptions} requestOptions - Request-specific configuration.
6910
7028
  *
6911
7029
  * @throws {@link OpikApi.NotFoundError}
6912
7030
  *
6913
7031
  * @example
6914
- * await client.traces.updateThread("threadModelId", {
6915
- * text: "text"
6916
- * })
7032
+ * await client.traces.updateThread("threadModelId")
6917
7033
  */
6918
- updateThread(threadModelId: string, request: Comment, requestOptions?: Traces.RequestOptions): HttpResponsePromise<void>;
7034
+ updateThread(threadModelId: string, request?: TraceThreadUpdate, requestOptions?: Traces.RequestOptions): HttpResponsePromise<void>;
6919
7035
  private __updateThread;
6920
7036
  /**
6921
7037
  * Update thread comment by id
@@ -7238,6 +7354,7 @@ declare namespace OpikApiClient {
7238
7354
  declare class OpikApiClient {
7239
7355
  protected readonly _options: OpikApiClient.Options;
7240
7356
  protected _systemUsage: SystemUsage | undefined;
7357
+ protected _annotationQueues: AnnotationQueues | undefined;
7241
7358
  protected _attachments: Attachments | undefined;
7242
7359
  protected _check: Check | undefined;
7243
7360
  protected _automationRuleEvaluators: AutomationRuleEvaluators | undefined;
@@ -7258,6 +7375,7 @@ declare class OpikApiClient {
7258
7375
  protected _redirect: Redirect | undefined;
7259
7376
  constructor(_options?: OpikApiClient.Options);
7260
7377
  get systemUsage(): SystemUsage;
7378
+ get annotationQueues(): AnnotationQueues;
7261
7379
  get attachments(): Attachments;
7262
7380
  get check(): Check;
7263
7381
  get automationRuleEvaluators(): AutomationRuleEvaluators;
@@ -991,6 +991,25 @@ interface SpanSearchStreamRequestPublic {
991
991
  truncate?: boolean;
992
992
  }
993
993
 
994
+ /**
995
+ * This file was auto-generated by Fern from our API Definition.
996
+ */
997
+
998
+ /**
999
+ * @example
1000
+ * {
1001
+ * annotationQueues: [{
1002
+ * projectId: "project_id",
1003
+ * name: "name",
1004
+ * scope: "trace"
1005
+ * }]
1006
+ * }
1007
+ */
1008
+ interface AnnotationQueueBatchWrite {
1009
+ /** List of annotation queues to create */
1010
+ annotationQueues: AnnotationQueueWrite[];
1011
+ }
1012
+
994
1013
  /**
995
1014
  * This file was auto-generated by Fern from our API Definition.
996
1015
  */
@@ -1300,6 +1319,17 @@ interface TraceSearchStreamRequestPublic {
1300
1319
  truncate?: boolean;
1301
1320
  }
1302
1321
 
1322
+ /**
1323
+ * This file was auto-generated by Fern from our API Definition.
1324
+ */
1325
+ /**
1326
+ * @example
1327
+ * {}
1328
+ */
1329
+ interface TraceThreadUpdate {
1330
+ tags?: string[];
1331
+ }
1332
+
1303
1333
  /**
1304
1334
  * This file was auto-generated by Fern from our API Definition.
1305
1335
  */
@@ -1417,6 +1447,33 @@ interface WorkspaceTraceCount {
1417
1447
  traceCount?: number;
1418
1448
  }
1419
1449
 
1450
+ /**
1451
+ * This file was auto-generated by Fern from our API Definition.
1452
+ */
1453
+ type AnnotationQueueWriteScope = "trace" | "thread";
1454
+ declare const AnnotationQueueWriteScope: {
1455
+ readonly Trace: "trace";
1456
+ readonly Thread: "thread";
1457
+ };
1458
+
1459
+ /**
1460
+ * This file was auto-generated by Fern from our API Definition.
1461
+ */
1462
+
1463
+ /**
1464
+ * List of annotation queues to create
1465
+ */
1466
+ interface AnnotationQueueWrite {
1467
+ id?: string;
1468
+ projectId: string;
1469
+ name: string;
1470
+ description?: string;
1471
+ instructions?: string;
1472
+ scope: AnnotationQueueWriteScope;
1473
+ commentsEnabled?: boolean;
1474
+ feedbackDefinitions?: string[];
1475
+ }
1476
+
1420
1477
  /**
1421
1478
  * This file was auto-generated by Fern from our API Definition.
1422
1479
  */
@@ -4560,6 +4617,67 @@ declare class SystemUsage {
4560
4617
  }>;
4561
4618
  }
4562
4619
 
4620
+ /**
4621
+ * This file was auto-generated by Fern from our API Definition.
4622
+ */
4623
+
4624
+ declare namespace AnnotationQueues {
4625
+ interface Options {
4626
+ environment?: Supplier<OpikApiEnvironment | string>;
4627
+ /** Specify a custom URL to connect the client to. */
4628
+ baseUrl?: Supplier<string>;
4629
+ /** Override the Authorization header */
4630
+ apiKey?: Supplier<string | undefined>;
4631
+ /** Override the Comet-Workspace header */
4632
+ workspaceName?: Supplier<string | undefined>;
4633
+ }
4634
+ interface RequestOptions {
4635
+ /** The maximum time to wait for a response in seconds. */
4636
+ timeoutInSeconds?: number;
4637
+ /** The number of times to retry the request. Defaults to 2. */
4638
+ maxRetries?: number;
4639
+ /** A hook to abort the request. */
4640
+ abortSignal?: AbortSignal;
4641
+ /** Override the Authorization header */
4642
+ apiKey?: string | undefined;
4643
+ /** Override the Comet-Workspace header */
4644
+ workspaceName?: string | undefined;
4645
+ /** Additional headers to include in the request. */
4646
+ headers?: Record<string, string>;
4647
+ }
4648
+ }
4649
+ /**
4650
+ * Private annotation queue operations
4651
+ */
4652
+ declare class AnnotationQueues {
4653
+ protected readonly _options: AnnotationQueues.Options;
4654
+ constructor(_options?: AnnotationQueues.Options);
4655
+ /**
4656
+ * Create multiple annotation queues for human annotation workflows
4657
+ *
4658
+ * @param {OpikApi.AnnotationQueueBatchWrite} request
4659
+ * @param {AnnotationQueues.RequestOptions} requestOptions - Request-specific configuration.
4660
+ *
4661
+ * @throws {@link OpikApi.BadRequestError}
4662
+ * @throws {@link OpikApi.ConflictError}
4663
+ * @throws {@link OpikApi.UnprocessableEntityError}
4664
+ *
4665
+ * @example
4666
+ * await client.annotationQueues.createAnnotationQueueBatch({
4667
+ * annotationQueues: [{
4668
+ * projectId: "project_id",
4669
+ * name: "name",
4670
+ * scope: "trace"
4671
+ * }]
4672
+ * })
4673
+ */
4674
+ createAnnotationQueueBatch(request: AnnotationQueueBatchWrite, requestOptions?: AnnotationQueues.RequestOptions): HttpResponsePromise<void>;
4675
+ private __createAnnotationQueueBatch;
4676
+ protected _getCustomAuthorizationHeaders(): Promise<{
4677
+ Authorization: string | undefined;
4678
+ }>;
4679
+ }
4680
+
4563
4681
  /**
4564
4682
  * This file was auto-generated by Fern from our API Definition.
4565
4683
  */
@@ -6905,17 +7023,15 @@ declare class Traces {
6905
7023
  * Update thread
6906
7024
  *
6907
7025
  * @param {string} threadModelId
6908
- * @param {OpikApi.Comment} request
7026
+ * @param {OpikApi.TraceThreadUpdate} request
6909
7027
  * @param {Traces.RequestOptions} requestOptions - Request-specific configuration.
6910
7028
  *
6911
7029
  * @throws {@link OpikApi.NotFoundError}
6912
7030
  *
6913
7031
  * @example
6914
- * await client.traces.updateThread("threadModelId", {
6915
- * text: "text"
6916
- * })
7032
+ * await client.traces.updateThread("threadModelId")
6917
7033
  */
6918
- updateThread(threadModelId: string, request: Comment, requestOptions?: Traces.RequestOptions): HttpResponsePromise<void>;
7034
+ updateThread(threadModelId: string, request?: TraceThreadUpdate, requestOptions?: Traces.RequestOptions): HttpResponsePromise<void>;
6919
7035
  private __updateThread;
6920
7036
  /**
6921
7037
  * Update thread comment by id
@@ -7238,6 +7354,7 @@ declare namespace OpikApiClient {
7238
7354
  declare class OpikApiClient {
7239
7355
  protected readonly _options: OpikApiClient.Options;
7240
7356
  protected _systemUsage: SystemUsage | undefined;
7357
+ protected _annotationQueues: AnnotationQueues | undefined;
7241
7358
  protected _attachments: Attachments | undefined;
7242
7359
  protected _check: Check | undefined;
7243
7360
  protected _automationRuleEvaluators: AutomationRuleEvaluators | undefined;
@@ -7258,6 +7375,7 @@ declare class OpikApiClient {
7258
7375
  protected _redirect: Redirect | undefined;
7259
7376
  constructor(_options?: OpikApiClient.Options);
7260
7377
  get systemUsage(): SystemUsage;
7378
+ get annotationQueues(): AnnotationQueues;
7261
7379
  get attachments(): Attachments;
7262
7380
  get check(): Check;
7263
7381
  get automationRuleEvaluators(): AutomationRuleEvaluators;