opik 1.8.98 → 1.8.100
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.
- package/dist/index.cjs +24 -24
- package/dist/index.d.cts +72 -2
- package/dist/index.d.ts +72 -2
- package/dist/index.js +24 -24
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -242,6 +242,23 @@ interface DatasetItemBatchWrite {
|
|
|
242
242
|
items: DatasetItemWrite[];
|
|
243
243
|
}
|
|
244
244
|
|
|
245
|
+
/**
|
|
246
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
247
|
+
*/
|
|
248
|
+
|
|
249
|
+
/**
|
|
250
|
+
* @example
|
|
251
|
+
* {
|
|
252
|
+
* traceIds: ["trace_ids"],
|
|
253
|
+
* enrichmentOptions: {}
|
|
254
|
+
* }
|
|
255
|
+
*/
|
|
256
|
+
interface CreateDatasetItemsFromTracesRequest {
|
|
257
|
+
/** Set of trace IDs to add to the dataset */
|
|
258
|
+
traceIds: string[];
|
|
259
|
+
enrichmentOptions: TraceEnrichmentOptions;
|
|
260
|
+
}
|
|
261
|
+
|
|
245
262
|
/**
|
|
246
263
|
* This file was auto-generated by Fern from our API Definition.
|
|
247
264
|
*/
|
|
@@ -1334,6 +1351,8 @@ interface GetTracesByProjectRequest {
|
|
|
1334
1351
|
stripAttachments?: boolean;
|
|
1335
1352
|
sorting?: string;
|
|
1336
1353
|
exclude?: string;
|
|
1354
|
+
fromTime?: Date;
|
|
1355
|
+
toTime?: Date;
|
|
1337
1356
|
}
|
|
1338
1357
|
|
|
1339
1358
|
/**
|
|
@@ -1456,6 +1475,8 @@ interface GetTraceStatsRequest {
|
|
|
1456
1475
|
projectId?: string;
|
|
1457
1476
|
projectName?: string;
|
|
1458
1477
|
filters?: string;
|
|
1478
|
+
fromTime?: Date;
|
|
1479
|
+
toTime?: Date;
|
|
1459
1480
|
}
|
|
1460
1481
|
|
|
1461
1482
|
/**
|
|
@@ -1697,7 +1718,7 @@ interface AlertTriggerConfigWrite {
|
|
|
1697
1718
|
/**
|
|
1698
1719
|
* This file was auto-generated by Fern from our API Definition.
|
|
1699
1720
|
*/
|
|
1700
|
-
type AlertTriggerWriteEventType = "trace:errors" | "trace:feedback_score" | "trace_thread:feedback_score" | "prompt:created" | "prompt:committed" | "trace:guardrails_triggered" | "prompt:deleted";
|
|
1721
|
+
type AlertTriggerWriteEventType = "trace:errors" | "trace:feedback_score" | "trace_thread:feedback_score" | "prompt:created" | "prompt:committed" | "trace:guardrails_triggered" | "prompt:deleted" | "experiment:finished";
|
|
1701
1722
|
declare const AlertTriggerWriteEventType: {
|
|
1702
1723
|
readonly TraceErrors: "trace:errors";
|
|
1703
1724
|
readonly TraceFeedbackScore: "trace:feedback_score";
|
|
@@ -1706,6 +1727,7 @@ declare const AlertTriggerWriteEventType: {
|
|
|
1706
1727
|
readonly PromptCommitted: "prompt:committed";
|
|
1707
1728
|
readonly TraceGuardrailsTriggered: "trace:guardrails_triggered";
|
|
1708
1729
|
readonly PromptDeleted: "prompt:deleted";
|
|
1730
|
+
readonly ExperimentFinished: "experiment:finished";
|
|
1709
1731
|
};
|
|
1710
1732
|
|
|
1711
1733
|
/**
|
|
@@ -1799,7 +1821,7 @@ interface AlertTriggerConfigPublic {
|
|
|
1799
1821
|
/**
|
|
1800
1822
|
* This file was auto-generated by Fern from our API Definition.
|
|
1801
1823
|
*/
|
|
1802
|
-
type AlertTriggerPublicEventType = "trace:errors" | "trace:feedback_score" | "trace_thread:feedback_score" | "prompt:created" | "prompt:committed" | "trace:guardrails_triggered" | "prompt:deleted";
|
|
1824
|
+
type AlertTriggerPublicEventType = "trace:errors" | "trace:feedback_score" | "trace_thread:feedback_score" | "prompt:created" | "prompt:committed" | "trace:guardrails_triggered" | "prompt:deleted" | "experiment:finished";
|
|
1803
1825
|
declare const AlertTriggerPublicEventType: {
|
|
1804
1826
|
readonly TraceErrors: "trace:errors";
|
|
1805
1827
|
readonly TraceFeedbackScore: "trace:feedback_score";
|
|
@@ -1808,6 +1830,7 @@ declare const AlertTriggerPublicEventType: {
|
|
|
1808
1830
|
readonly PromptCommitted: "prompt:committed";
|
|
1809
1831
|
readonly TraceGuardrailsTriggered: "trace:guardrails_triggered";
|
|
1810
1832
|
readonly PromptDeleted: "prompt:deleted";
|
|
1833
|
+
readonly ExperimentFinished: "experiment:finished";
|
|
1811
1834
|
};
|
|
1812
1835
|
|
|
1813
1836
|
/**
|
|
@@ -3003,6 +3026,21 @@ interface DatasetItemWrite {
|
|
|
3003
3026
|
data: JsonNode;
|
|
3004
3027
|
}
|
|
3005
3028
|
|
|
3029
|
+
/**
|
|
3030
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3031
|
+
*/
|
|
3032
|
+
/**
|
|
3033
|
+
* Options for enriching trace data
|
|
3034
|
+
*/
|
|
3035
|
+
interface TraceEnrichmentOptions {
|
|
3036
|
+
includeSpans?: boolean;
|
|
3037
|
+
includeTags?: boolean;
|
|
3038
|
+
includeFeedbackScores?: boolean;
|
|
3039
|
+
includeComments?: boolean;
|
|
3040
|
+
includeUsage?: boolean;
|
|
3041
|
+
includeMetadata?: boolean;
|
|
3042
|
+
}
|
|
3043
|
+
|
|
3006
3044
|
/**
|
|
3007
3045
|
* This file was auto-generated by Fern from our API Definition.
|
|
3008
3046
|
*/
|
|
@@ -5111,6 +5149,8 @@ interface WorkspaceMetricResponse {
|
|
|
5111
5149
|
interface WorkspaceConfiguration {
|
|
5112
5150
|
/** Duration in ISO-8601 format (e.g., PT30M for 30 minutes, PT2H for 2 hours, P1D for 1 day). Minimum precision supported is seconds, please use a duration with seconds precision or higher. Also, the max duration allowed is 7 days. */
|
|
5113
5151
|
timeoutToMarkThreadAsInactive?: string;
|
|
5152
|
+
/** Enable or disable data truncation in table views. When disabled, the frontend will limit pagination to prevent performance issues. Default: true (truncation enabled). */
|
|
5153
|
+
truncationOnTables?: boolean;
|
|
5114
5154
|
}
|
|
5115
5155
|
|
|
5116
5156
|
/**
|
|
@@ -6085,6 +6125,21 @@ declare class Datasets {
|
|
|
6085
6125
|
*/
|
|
6086
6126
|
createOrUpdateDatasetItems(request: DatasetItemBatchWrite, requestOptions?: Datasets.RequestOptions): HttpResponsePromise<void>;
|
|
6087
6127
|
private __createOrUpdateDatasetItems;
|
|
6128
|
+
/**
|
|
6129
|
+
* Create dataset items from traces with enriched metadata
|
|
6130
|
+
*
|
|
6131
|
+
* @param {string} datasetId
|
|
6132
|
+
* @param {OpikApi.CreateDatasetItemsFromTracesRequest} request
|
|
6133
|
+
* @param {Datasets.RequestOptions} requestOptions - Request-specific configuration.
|
|
6134
|
+
*
|
|
6135
|
+
* @example
|
|
6136
|
+
* await client.datasets.createDatasetItemsFromTraces("dataset_id", {
|
|
6137
|
+
* traceIds: ["trace_ids"],
|
|
6138
|
+
* enrichmentOptions: {}
|
|
6139
|
+
* })
|
|
6140
|
+
*/
|
|
6141
|
+
createDatasetItemsFromTraces(datasetId: string, request: CreateDatasetItemsFromTracesRequest, requestOptions?: Datasets.RequestOptions): HttpResponsePromise<void>;
|
|
6142
|
+
private __createDatasetItemsFromTraces;
|
|
6088
6143
|
/**
|
|
6089
6144
|
* Get dataset by id
|
|
6090
6145
|
*
|
|
@@ -6422,6 +6477,21 @@ declare class Experiments {
|
|
|
6422
6477
|
*/
|
|
6423
6478
|
findExperimentGroupsAggregations(request?: FindExperimentGroupsAggregationsRequest, requestOptions?: Experiments.RequestOptions): HttpResponsePromise<ExperimentGroupAggregationsResponse>;
|
|
6424
6479
|
private __findExperimentGroupsAggregations;
|
|
6480
|
+
/**
|
|
6481
|
+
* Finish experiments and trigger alert events
|
|
6482
|
+
*
|
|
6483
|
+
* @param {OpikApi.DeleteIdsHolder} request
|
|
6484
|
+
* @param {Experiments.RequestOptions} requestOptions - Request-specific configuration.
|
|
6485
|
+
*
|
|
6486
|
+
* @throws {@link OpikApi.BadRequestError}
|
|
6487
|
+
*
|
|
6488
|
+
* @example
|
|
6489
|
+
* await client.experiments.finishExperiments({
|
|
6490
|
+
* ids: ["ids"]
|
|
6491
|
+
* })
|
|
6492
|
+
*/
|
|
6493
|
+
finishExperiments(request: DeleteIdsHolder, requestOptions?: Experiments.RequestOptions): HttpResponsePromise<void>;
|
|
6494
|
+
private __finishExperiments;
|
|
6425
6495
|
/**
|
|
6426
6496
|
* Get experiment by id
|
|
6427
6497
|
*
|
package/dist/index.d.ts
CHANGED
|
@@ -242,6 +242,23 @@ interface DatasetItemBatchWrite {
|
|
|
242
242
|
items: DatasetItemWrite[];
|
|
243
243
|
}
|
|
244
244
|
|
|
245
|
+
/**
|
|
246
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
247
|
+
*/
|
|
248
|
+
|
|
249
|
+
/**
|
|
250
|
+
* @example
|
|
251
|
+
* {
|
|
252
|
+
* traceIds: ["trace_ids"],
|
|
253
|
+
* enrichmentOptions: {}
|
|
254
|
+
* }
|
|
255
|
+
*/
|
|
256
|
+
interface CreateDatasetItemsFromTracesRequest {
|
|
257
|
+
/** Set of trace IDs to add to the dataset */
|
|
258
|
+
traceIds: string[];
|
|
259
|
+
enrichmentOptions: TraceEnrichmentOptions;
|
|
260
|
+
}
|
|
261
|
+
|
|
245
262
|
/**
|
|
246
263
|
* This file was auto-generated by Fern from our API Definition.
|
|
247
264
|
*/
|
|
@@ -1334,6 +1351,8 @@ interface GetTracesByProjectRequest {
|
|
|
1334
1351
|
stripAttachments?: boolean;
|
|
1335
1352
|
sorting?: string;
|
|
1336
1353
|
exclude?: string;
|
|
1354
|
+
fromTime?: Date;
|
|
1355
|
+
toTime?: Date;
|
|
1337
1356
|
}
|
|
1338
1357
|
|
|
1339
1358
|
/**
|
|
@@ -1456,6 +1475,8 @@ interface GetTraceStatsRequest {
|
|
|
1456
1475
|
projectId?: string;
|
|
1457
1476
|
projectName?: string;
|
|
1458
1477
|
filters?: string;
|
|
1478
|
+
fromTime?: Date;
|
|
1479
|
+
toTime?: Date;
|
|
1459
1480
|
}
|
|
1460
1481
|
|
|
1461
1482
|
/**
|
|
@@ -1697,7 +1718,7 @@ interface AlertTriggerConfigWrite {
|
|
|
1697
1718
|
/**
|
|
1698
1719
|
* This file was auto-generated by Fern from our API Definition.
|
|
1699
1720
|
*/
|
|
1700
|
-
type AlertTriggerWriteEventType = "trace:errors" | "trace:feedback_score" | "trace_thread:feedback_score" | "prompt:created" | "prompt:committed" | "trace:guardrails_triggered" | "prompt:deleted";
|
|
1721
|
+
type AlertTriggerWriteEventType = "trace:errors" | "trace:feedback_score" | "trace_thread:feedback_score" | "prompt:created" | "prompt:committed" | "trace:guardrails_triggered" | "prompt:deleted" | "experiment:finished";
|
|
1701
1722
|
declare const AlertTriggerWriteEventType: {
|
|
1702
1723
|
readonly TraceErrors: "trace:errors";
|
|
1703
1724
|
readonly TraceFeedbackScore: "trace:feedback_score";
|
|
@@ -1706,6 +1727,7 @@ declare const AlertTriggerWriteEventType: {
|
|
|
1706
1727
|
readonly PromptCommitted: "prompt:committed";
|
|
1707
1728
|
readonly TraceGuardrailsTriggered: "trace:guardrails_triggered";
|
|
1708
1729
|
readonly PromptDeleted: "prompt:deleted";
|
|
1730
|
+
readonly ExperimentFinished: "experiment:finished";
|
|
1709
1731
|
};
|
|
1710
1732
|
|
|
1711
1733
|
/**
|
|
@@ -1799,7 +1821,7 @@ interface AlertTriggerConfigPublic {
|
|
|
1799
1821
|
/**
|
|
1800
1822
|
* This file was auto-generated by Fern from our API Definition.
|
|
1801
1823
|
*/
|
|
1802
|
-
type AlertTriggerPublicEventType = "trace:errors" | "trace:feedback_score" | "trace_thread:feedback_score" | "prompt:created" | "prompt:committed" | "trace:guardrails_triggered" | "prompt:deleted";
|
|
1824
|
+
type AlertTriggerPublicEventType = "trace:errors" | "trace:feedback_score" | "trace_thread:feedback_score" | "prompt:created" | "prompt:committed" | "trace:guardrails_triggered" | "prompt:deleted" | "experiment:finished";
|
|
1803
1825
|
declare const AlertTriggerPublicEventType: {
|
|
1804
1826
|
readonly TraceErrors: "trace:errors";
|
|
1805
1827
|
readonly TraceFeedbackScore: "trace:feedback_score";
|
|
@@ -1808,6 +1830,7 @@ declare const AlertTriggerPublicEventType: {
|
|
|
1808
1830
|
readonly PromptCommitted: "prompt:committed";
|
|
1809
1831
|
readonly TraceGuardrailsTriggered: "trace:guardrails_triggered";
|
|
1810
1832
|
readonly PromptDeleted: "prompt:deleted";
|
|
1833
|
+
readonly ExperimentFinished: "experiment:finished";
|
|
1811
1834
|
};
|
|
1812
1835
|
|
|
1813
1836
|
/**
|
|
@@ -3003,6 +3026,21 @@ interface DatasetItemWrite {
|
|
|
3003
3026
|
data: JsonNode;
|
|
3004
3027
|
}
|
|
3005
3028
|
|
|
3029
|
+
/**
|
|
3030
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3031
|
+
*/
|
|
3032
|
+
/**
|
|
3033
|
+
* Options for enriching trace data
|
|
3034
|
+
*/
|
|
3035
|
+
interface TraceEnrichmentOptions {
|
|
3036
|
+
includeSpans?: boolean;
|
|
3037
|
+
includeTags?: boolean;
|
|
3038
|
+
includeFeedbackScores?: boolean;
|
|
3039
|
+
includeComments?: boolean;
|
|
3040
|
+
includeUsage?: boolean;
|
|
3041
|
+
includeMetadata?: boolean;
|
|
3042
|
+
}
|
|
3043
|
+
|
|
3006
3044
|
/**
|
|
3007
3045
|
* This file was auto-generated by Fern from our API Definition.
|
|
3008
3046
|
*/
|
|
@@ -5111,6 +5149,8 @@ interface WorkspaceMetricResponse {
|
|
|
5111
5149
|
interface WorkspaceConfiguration {
|
|
5112
5150
|
/** Duration in ISO-8601 format (e.g., PT30M for 30 minutes, PT2H for 2 hours, P1D for 1 day). Minimum precision supported is seconds, please use a duration with seconds precision or higher. Also, the max duration allowed is 7 days. */
|
|
5113
5151
|
timeoutToMarkThreadAsInactive?: string;
|
|
5152
|
+
/** Enable or disable data truncation in table views. When disabled, the frontend will limit pagination to prevent performance issues. Default: true (truncation enabled). */
|
|
5153
|
+
truncationOnTables?: boolean;
|
|
5114
5154
|
}
|
|
5115
5155
|
|
|
5116
5156
|
/**
|
|
@@ -6085,6 +6125,21 @@ declare class Datasets {
|
|
|
6085
6125
|
*/
|
|
6086
6126
|
createOrUpdateDatasetItems(request: DatasetItemBatchWrite, requestOptions?: Datasets.RequestOptions): HttpResponsePromise<void>;
|
|
6087
6127
|
private __createOrUpdateDatasetItems;
|
|
6128
|
+
/**
|
|
6129
|
+
* Create dataset items from traces with enriched metadata
|
|
6130
|
+
*
|
|
6131
|
+
* @param {string} datasetId
|
|
6132
|
+
* @param {OpikApi.CreateDatasetItemsFromTracesRequest} request
|
|
6133
|
+
* @param {Datasets.RequestOptions} requestOptions - Request-specific configuration.
|
|
6134
|
+
*
|
|
6135
|
+
* @example
|
|
6136
|
+
* await client.datasets.createDatasetItemsFromTraces("dataset_id", {
|
|
6137
|
+
* traceIds: ["trace_ids"],
|
|
6138
|
+
* enrichmentOptions: {}
|
|
6139
|
+
* })
|
|
6140
|
+
*/
|
|
6141
|
+
createDatasetItemsFromTraces(datasetId: string, request: CreateDatasetItemsFromTracesRequest, requestOptions?: Datasets.RequestOptions): HttpResponsePromise<void>;
|
|
6142
|
+
private __createDatasetItemsFromTraces;
|
|
6088
6143
|
/**
|
|
6089
6144
|
* Get dataset by id
|
|
6090
6145
|
*
|
|
@@ -6422,6 +6477,21 @@ declare class Experiments {
|
|
|
6422
6477
|
*/
|
|
6423
6478
|
findExperimentGroupsAggregations(request?: FindExperimentGroupsAggregationsRequest, requestOptions?: Experiments.RequestOptions): HttpResponsePromise<ExperimentGroupAggregationsResponse>;
|
|
6424
6479
|
private __findExperimentGroupsAggregations;
|
|
6480
|
+
/**
|
|
6481
|
+
* Finish experiments and trigger alert events
|
|
6482
|
+
*
|
|
6483
|
+
* @param {OpikApi.DeleteIdsHolder} request
|
|
6484
|
+
* @param {Experiments.RequestOptions} requestOptions - Request-specific configuration.
|
|
6485
|
+
*
|
|
6486
|
+
* @throws {@link OpikApi.BadRequestError}
|
|
6487
|
+
*
|
|
6488
|
+
* @example
|
|
6489
|
+
* await client.experiments.finishExperiments({
|
|
6490
|
+
* ids: ["ids"]
|
|
6491
|
+
* })
|
|
6492
|
+
*/
|
|
6493
|
+
finishExperiments(request: DeleteIdsHolder, requestOptions?: Experiments.RequestOptions): HttpResponsePromise<void>;
|
|
6494
|
+
private __finishExperiments;
|
|
6425
6495
|
/**
|
|
6426
6496
|
* Get experiment by id
|
|
6427
6497
|
*
|