opik 1.7.28 → 1.7.30

package/dist/{Client-C7xyHzcm.d.cts → Client-CB3-ejaS.d.cts}

@@ -1,12 +1,5 @@
 import * as stream from 'stream';
 
-interface OpikConfig {
-    apiKey: string;
-    apiUrl?: string;
-    projectName: string;
-    workspaceName: string;
-}
-
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
@@ -1196,6 +1189,7 @@ interface GetTraceThreadsRequest {
     projectId?: string;
     truncate?: boolean;
     filters?: string;
+    sorting?: string;
 }
 
 /**
@@ -1247,6 +1241,24 @@ interface ExperimentsRedirectRequest {
     path: string;
 }
 
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         datasetId: "dataset_id",
+ *         optimizationId: "optimization_id",
+ *         path: "path"
+ *     }
+ */
+interface OptimizationsRedirectRequest {
+    datasetId: string;
+    optimizationId: string;
+    workspaceName?: string;
+    path: string;
+}
+
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
@@ -1962,6 +1974,15 @@ interface Comment {
     lastUpdatedBy?: string;
 }
 
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+type ExperimentItemTraceVisibilityMode = "default" | "hidden";
+declare const ExperimentItemTraceVisibilityMode: {
+    readonly Default: "default";
+    readonly Hidden: "hidden";
+};
+
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
@@ -1982,6 +2003,7 @@ interface ExperimentItem {
     lastUpdatedAt?: Date;
     createdBy?: string;
     lastUpdatedBy?: string;
+    traceVisibilityMode?: ExperimentItemTraceVisibilityMode;
 }
 
 /**
@@ -2116,6 +2138,15 @@ interface DatasetItemCompare {
     lastUpdatedBy?: string;
 }
 
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+type ExperimentItemCompareTraceVisibilityMode = "default" | "hidden";
+declare const ExperimentItemCompareTraceVisibilityMode: {
+    readonly Default: "default";
+    readonly Hidden: "hidden";
+};
+
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
@@ -2136,6 +2167,7 @@ interface ExperimentItemCompare {
     lastUpdatedAt?: Date;
     createdBy?: string;
     lastUpdatedBy?: string;
+    traceVisibilityMode?: ExperimentItemCompareTraceVisibilityMode;
 }
 
 /**
@@ -2243,6 +2275,16 @@ interface DatasetItemPublic {
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+type ExperimentItemPublicTraceVisibilityMode = "default" | "hidden";
+declare const ExperimentItemPublicTraceVisibilityMode: {
+    readonly Default: "default";
+    readonly Hidden: "hidden";
+};
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
 interface ExperimentItemPublic {
     id?: string;
     experimentId: string;
@@ -2252,6 +2294,7 @@ interface ExperimentItemPublic {
     lastUpdatedAt?: Date;
     createdBy?: string;
     lastUpdatedBy?: string;
+    traceVisibilityMode?: ExperimentItemPublicTraceVisibilityMode;
 }
 
 /**
@@ -2496,6 +2539,7 @@ interface Trace$1 {
     duration?: number;
     threadId?: string;
     visibilityMode?: TraceVisibilityMode;
+    llmSpanCount?: number;
 }
 
 /**
@@ -2513,6 +2557,7 @@ interface ErrorInfoExperimentItemBulkWriteView {
 
 interface ExperimentItemBulkRecordExperimentItemBulkWriteView {
     datasetItemId: string;
+    evaluateTaskResult?: JsonListStringExperimentItemBulkWriteView;
     trace?: TraceExperimentItemBulkWriteView;
     spans?: SpanExperimentItemBulkWriteView[];
     feedbackScores?: FeedbackScoreExperimentItemBulkWriteView[];
@@ -2593,6 +2638,9 @@ interface SpanExperimentItemBulkWriteView {
  * This file was auto-generated by Fern from our API Definition.
  */
 
+/**
+ * Please provide either none, only one of evaluate_task_result or trace, but never both
+ */
 interface TraceExperimentItemBulkWriteView {
     id?: string;
     /** If null, the default project is used */
@@ -3691,6 +3739,7 @@ interface TracePublic {
     duration?: number;
     threadId?: string;
     visibilityMode?: TracePublicVisibilityMode;
+    llmSpanCount?: number;
 }
 
 /**
@@ -3706,6 +3755,8 @@ interface TraceThread {
     firstMessage?: JsonNode;
     lastMessage?: JsonNode;
     numberOfMessages?: number;
+    totalEstimatedCost?: number;
+    usage?: Record<string, number>;
     lastUpdatedAt?: Date;
     createdBy?: string;
     createdAt?: Date;
@@ -3720,6 +3771,7 @@ interface TraceThreadPage {
     size?: number;
     total?: number;
     content?: TraceThread[];
+    sortableBy?: string[];
 }
 
 /**
@@ -6229,6 +6281,24 @@ declare class Redirect {
      */
     experimentsRedirect(request: ExperimentsRedirectRequest, requestOptions?: Redirect.RequestOptions): HttpResponsePromise<void>;
     private __experimentsRedirect;
+    /**
+     * Create optimization redirect url
+     *
+     * @param {OpikApi.OptimizationsRedirectRequest} request
+     * @param {Redirect.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link OpikApi.BadRequestError}
+     * @throws {@link OpikApi.NotFoundError}
+     *
+     * @example
+     *     await client.redirect.optimizationsRedirect({
+     *         datasetId: "dataset_id",
+     *         optimizationId: "optimization_id",
+     *         path: "path"
+     *     })
+     */
+    optimizationsRedirect(request: OptimizationsRedirectRequest, requestOptions?: Redirect.RequestOptions): HttpResponsePromise<void>;
+    private __optimizationsRedirect;
     /**
      * Create project redirect url
      *
@@ -6340,6 +6410,19 @@ declare class OpikApiClient {
     }>;
 }
 
+type RequestOptions = OpikApiClient.RequestOptions;
+
+interface OpikConfig {
+    apiKey: string;
+    apiUrl?: string;
+    projectName: string;
+    workspaceName: string;
+    requestOptions?: RequestOptions;
+}
+interface ConstructorOpikConfig extends OpikConfig {
+    headers?: Record<string, string>;
+}
+
 interface SavedSpan extends Span$1 {
     id: string;
 }
@@ -6406,12 +6489,21 @@ declare abstract class BatchQueue<EntityData = object, EntityId = string> {
     flush: () => Promise<void>;
 }
 
+interface OpikApiClientTempOptions extends OpikApiClient.Options {
+    requestOptions?: RequestOptions;
+}
+declare class OpikApiClientTemp extends OpikApiClient {
+    requestOptions: RequestOptions;
+    constructor(options?: OpikApiClientTempOptions);
+    setHeaders: (headers: Record<string, string>) => void;
+}
+
 type SpanUpdate = Partial<SavedSpan> & {
     traceId: string;
 };
 declare class SpanBatchQueue extends BatchQueue<SavedSpan> {
     private readonly api;
-    constructor(api: OpikApiClient, delay?: number);
+    constructor(api: OpikApiClientTemp, delay?: number);
     protected getId(entity: SavedSpan): string;
     protected createEntities(spans: SavedSpan[]): Promise<void>;
     protected getEntity(id: string): Promise<SavedSpan>;
@@ -6425,7 +6517,7 @@ type FeedbackScoreId$1 = {
 };
 declare class SpanFeedbackScoresBatchQueue extends BatchQueue<FeedbackScoreBatchItem, FeedbackScoreId$1> {
     private readonly api;
-    constructor(api: OpikApiClient, delay?: number);
+    constructor(api: OpikApiClientTemp, delay?: number);
     protected getId(entity: FeedbackScoreBatchItem): {
         id: string;
         name: string;
@@ -6438,7 +6530,7 @@ declare class SpanFeedbackScoresBatchQueue extends BatchQueue<FeedbackScoreBatch
 
 declare class TraceBatchQueue extends BatchQueue<SavedTrace> {
     private readonly api;
-    constructor(api: OpikApiClient, delay?: number);
+    constructor(api: OpikApiClientTemp, delay?: number);
     protected getId(entity: SavedTrace): string;
     protected createEntities(traces: SavedTrace[]): Promise<void>;
     protected getEntity(id: string): Promise<SavedTrace>;
@@ -6452,7 +6544,7 @@ type FeedbackScoreId = {
 };
 declare class TraceFeedbackScoresBatchQueue extends BatchQueue<FeedbackScoreBatchItem, FeedbackScoreId> {
     private readonly api;
-    constructor(api: OpikApiClient, delay?: number);
+    constructor(api: OpikApiClientTemp, delay?: number);
     protected getId(entity: FeedbackScoreBatchItem): {
         id: string;
         name: string;
@@ -6475,7 +6567,7 @@ declare class DatasetBatchQueue extends BatchQueue<DatasetWrite> {
      * @param api The OpikApiClient instance used to communicate with the API
      * @param delay Optional delay in milliseconds before flushing the queue (defaults to 300ms)
      */
-    constructor(api: OpikApiClient, delay?: number);
+    constructor(api: OpikApiClientTemp, delay?: number);
     /**
      * Gets the ID of a dataset entity.
      *
@@ -6594,7 +6686,7 @@ interface TraceData extends Omit<Trace$1, "startTime"> {
     startTime?: Date;
 }
 declare class OpikClient {
-    api: OpikApiClient;
+    api: OpikApiClientTemp;
     config: OpikConfig;
     spanBatchQueue: SpanBatchQueue;
     traceBatchQueue: TraceBatchQueue;
@@ -6602,7 +6694,7 @@ declare class OpikClient {
     traceFeedbackScoresBatchQueue: TraceFeedbackScoresBatchQueue;
     datasetBatchQueue: DatasetBatchQueue;
     private lastProjectNameLogged;
-    constructor(explicitConfig?: Partial<OpikConfig>);
+    constructor(explicitConfig?: Partial<ConstructorOpikConfig>);
     private displayTraceLog;
     trace: (traceData: TraceData) => Trace;
     /**

package/dist/{Client-C7xyHzcm.d.ts → Client-CB3-ejaS.d.ts}

@@ -1,12 +1,5 @@
 import * as stream from 'stream';
 
-interface OpikConfig {
-    apiKey: string;
-    apiUrl?: string;
-    projectName: string;
-    workspaceName: string;
-}
-
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
@@ -1196,6 +1189,7 @@ interface GetTraceThreadsRequest {
     projectId?: string;
     truncate?: boolean;
     filters?: string;
+    sorting?: string;
 }
 
 /**
@@ -1247,6 +1241,24 @@ interface ExperimentsRedirectRequest {
     path: string;
 }
 
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         datasetId: "dataset_id",
+ *         optimizationId: "optimization_id",
+ *         path: "path"
+ *     }
+ */
+interface OptimizationsRedirectRequest {
+    datasetId: string;
+    optimizationId: string;
+    workspaceName?: string;
+    path: string;
+}
+
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
@@ -1962,6 +1974,15 @@ interface Comment {
     lastUpdatedBy?: string;
 }
 
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+type ExperimentItemTraceVisibilityMode = "default" | "hidden";
+declare const ExperimentItemTraceVisibilityMode: {
+    readonly Default: "default";
+    readonly Hidden: "hidden";
+};
+
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
@@ -1982,6 +2003,7 @@ interface ExperimentItem {
     lastUpdatedAt?: Date;
     createdBy?: string;
     lastUpdatedBy?: string;
+    traceVisibilityMode?: ExperimentItemTraceVisibilityMode;
 }
 
 /**
@@ -2116,6 +2138,15 @@ interface DatasetItemCompare {
     lastUpdatedBy?: string;
 }
 
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+type ExperimentItemCompareTraceVisibilityMode = "default" | "hidden";
+declare const ExperimentItemCompareTraceVisibilityMode: {
+    readonly Default: "default";
+    readonly Hidden: "hidden";
+};
+
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
@@ -2136,6 +2167,7 @@ interface ExperimentItemCompare {
     lastUpdatedAt?: Date;
     createdBy?: string;
     lastUpdatedBy?: string;
+    traceVisibilityMode?: ExperimentItemCompareTraceVisibilityMode;
 }
 
 /**
@@ -2243,6 +2275,16 @@ interface DatasetItemPublic {
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+type ExperimentItemPublicTraceVisibilityMode = "default" | "hidden";
+declare const ExperimentItemPublicTraceVisibilityMode: {
+    readonly Default: "default";
+    readonly Hidden: "hidden";
+};
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
 interface ExperimentItemPublic {
     id?: string;
     experimentId: string;
@@ -2252,6 +2294,7 @@ interface ExperimentItemPublic {
     lastUpdatedAt?: Date;
     createdBy?: string;
     lastUpdatedBy?: string;
+    traceVisibilityMode?: ExperimentItemPublicTraceVisibilityMode;
 }
 
 /**
@@ -2496,6 +2539,7 @@ interface Trace$1 {
     duration?: number;
     threadId?: string;
     visibilityMode?: TraceVisibilityMode;
+    llmSpanCount?: number;
 }
 
 /**
@@ -2513,6 +2557,7 @@ interface ErrorInfoExperimentItemBulkWriteView {
 
 interface ExperimentItemBulkRecordExperimentItemBulkWriteView {
     datasetItemId: string;
+    evaluateTaskResult?: JsonListStringExperimentItemBulkWriteView;
     trace?: TraceExperimentItemBulkWriteView;
     spans?: SpanExperimentItemBulkWriteView[];
     feedbackScores?: FeedbackScoreExperimentItemBulkWriteView[];
@@ -2593,6 +2638,9 @@ interface SpanExperimentItemBulkWriteView {
  * This file was auto-generated by Fern from our API Definition.
  */
 
+/**
+ * Please provide either none, only one of evaluate_task_result or trace, but never both
+ */
 interface TraceExperimentItemBulkWriteView {
     id?: string;
     /** If null, the default project is used */
@@ -3691,6 +3739,7 @@ interface TracePublic {
     duration?: number;
     threadId?: string;
     visibilityMode?: TracePublicVisibilityMode;
+    llmSpanCount?: number;
 }
 
 /**
@@ -3706,6 +3755,8 @@ interface TraceThread {
     firstMessage?: JsonNode;
     lastMessage?: JsonNode;
     numberOfMessages?: number;
+    totalEstimatedCost?: number;
+    usage?: Record<string, number>;
     lastUpdatedAt?: Date;
     createdBy?: string;
     createdAt?: Date;
@@ -3720,6 +3771,7 @@ interface TraceThreadPage {
     size?: number;
     total?: number;
     content?: TraceThread[];
+    sortableBy?: string[];
 }
 
 /**
@@ -6229,6 +6281,24 @@ declare class Redirect {
      */
     experimentsRedirect(request: ExperimentsRedirectRequest, requestOptions?: Redirect.RequestOptions): HttpResponsePromise<void>;
     private __experimentsRedirect;
+    /**
+     * Create optimization redirect url
+     *
+     * @param {OpikApi.OptimizationsRedirectRequest} request
+     * @param {Redirect.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link OpikApi.BadRequestError}
+     * @throws {@link OpikApi.NotFoundError}
+     *
+     * @example
+     *     await client.redirect.optimizationsRedirect({
+     *         datasetId: "dataset_id",
+     *         optimizationId: "optimization_id",
+     *         path: "path"
+     *     })
+     */
+    optimizationsRedirect(request: OptimizationsRedirectRequest, requestOptions?: Redirect.RequestOptions): HttpResponsePromise<void>;
+    private __optimizationsRedirect;
     /**
      * Create project redirect url
      *
@@ -6340,6 +6410,19 @@ declare class OpikApiClient {
     }>;
 }
 
+type RequestOptions = OpikApiClient.RequestOptions;
+
+interface OpikConfig {
+    apiKey: string;
+    apiUrl?: string;
+    projectName: string;
+    workspaceName: string;
+    requestOptions?: RequestOptions;
+}
+interface ConstructorOpikConfig extends OpikConfig {
+    headers?: Record<string, string>;
+}
+
 interface SavedSpan extends Span$1 {
     id: string;
 }
@@ -6406,12 +6489,21 @@ declare abstract class BatchQueue<EntityData = object, EntityId = string> {
     flush: () => Promise<void>;
 }
 
+interface OpikApiClientTempOptions extends OpikApiClient.Options {
+    requestOptions?: RequestOptions;
+}
+declare class OpikApiClientTemp extends OpikApiClient {
+    requestOptions: RequestOptions;
+    constructor(options?: OpikApiClientTempOptions);
+    setHeaders: (headers: Record<string, string>) => void;
+}
+
 type SpanUpdate = Partial<SavedSpan> & {
     traceId: string;
 };
 declare class SpanBatchQueue extends BatchQueue<SavedSpan> {
     private readonly api;
-    constructor(api: OpikApiClient, delay?: number);
+    constructor(api: OpikApiClientTemp, delay?: number);
     protected getId(entity: SavedSpan): string;
     protected createEntities(spans: SavedSpan[]): Promise<void>;
     protected getEntity(id: string): Promise<SavedSpan>;
@@ -6425,7 +6517,7 @@ type FeedbackScoreId$1 = {
 };
 declare class SpanFeedbackScoresBatchQueue extends BatchQueue<FeedbackScoreBatchItem, FeedbackScoreId$1> {
     private readonly api;
-    constructor(api: OpikApiClient, delay?: number);
+    constructor(api: OpikApiClientTemp, delay?: number);
     protected getId(entity: FeedbackScoreBatchItem): {
         id: string;
         name: string;
@@ -6438,7 +6530,7 @@ declare class SpanFeedbackScoresBatchQueue extends BatchQueue<FeedbackScoreBatch
 
 declare class TraceBatchQueue extends BatchQueue<SavedTrace> {
     private readonly api;
-    constructor(api: OpikApiClient, delay?: number);
+    constructor(api: OpikApiClientTemp, delay?: number);
     protected getId(entity: SavedTrace): string;
     protected createEntities(traces: SavedTrace[]): Promise<void>;
     protected getEntity(id: string): Promise<SavedTrace>;
@@ -6452,7 +6544,7 @@ type FeedbackScoreId = {
 };
 declare class TraceFeedbackScoresBatchQueue extends BatchQueue<FeedbackScoreBatchItem, FeedbackScoreId> {
     private readonly api;
-    constructor(api: OpikApiClient, delay?: number);
+    constructor(api: OpikApiClientTemp, delay?: number);
     protected getId(entity: FeedbackScoreBatchItem): {
         id: string;
         name: string;
@@ -6475,7 +6567,7 @@ declare class DatasetBatchQueue extends BatchQueue<DatasetWrite> {
      * @param api The OpikApiClient instance used to communicate with the API
      * @param delay Optional delay in milliseconds before flushing the queue (defaults to 300ms)
      */
-    constructor(api: OpikApiClient, delay?: number);
+    constructor(api: OpikApiClientTemp, delay?: number);
     /**
      * Gets the ID of a dataset entity.
      *
@@ -6594,7 +6686,7 @@ interface TraceData extends Omit<Trace$1, "startTime"> {
     startTime?: Date;
 }
 declare class OpikClient {
-    api: OpikApiClient;
+    api: OpikApiClientTemp;
     config: OpikConfig;
     spanBatchQueue: SpanBatchQueue;
     traceBatchQueue: TraceBatchQueue;
@@ -6602,7 +6694,7 @@ declare class OpikClient {
     traceFeedbackScoresBatchQueue: TraceFeedbackScoresBatchQueue;
     datasetBatchQueue: DatasetBatchQueue;
     private lastProjectNameLogged;
-    constructor(explicitConfig?: Partial<OpikConfig>);
+    constructor(explicitConfig?: Partial<ConstructorOpikConfig>);
     private displayTraceLog;
     trace: (traceData: TraceData) => Trace;
     /**