opik 1.9.47 → 1.9.49
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 +27 -27
- package/dist/index.d.cts +104 -0
- package/dist/index.d.ts +104 -0
- package/dist/index.js +25 -25
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -1111,6 +1111,29 @@ interface CreatePromptVersionDetail {
|
|
|
1111
1111
|
templateStructure?: CreatePromptVersionDetailTemplateStructure;
|
|
1112
1112
|
}
|
|
1113
1113
|
|
|
1114
|
+
/**
|
|
1115
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
1116
|
+
*/
|
|
1117
|
+
|
|
1118
|
+
/**
|
|
1119
|
+
* @example
|
|
1120
|
+
* {
|
|
1121
|
+
* ids: ["ids"],
|
|
1122
|
+
* update: {}
|
|
1123
|
+
* }
|
|
1124
|
+
*/
|
|
1125
|
+
interface PromptVersionBatchUpdate {
|
|
1126
|
+
/** IDs of prompt versions to update */
|
|
1127
|
+
ids: string[];
|
|
1128
|
+
update: PromptVersionUpdate;
|
|
1129
|
+
/**
|
|
1130
|
+
* Tag merge behavior:
|
|
1131
|
+
* - true: Add new tags to existing tags (union)
|
|
1132
|
+
* - false: Replace all existing tags with new tags (default behaviour if not provided)
|
|
1133
|
+
*/
|
|
1134
|
+
mergeTags?: boolean;
|
|
1135
|
+
}
|
|
1136
|
+
|
|
1114
1137
|
/**
|
|
1115
1138
|
* This file was auto-generated by Fern from our API Definition.
|
|
1116
1139
|
*/
|
|
@@ -1136,6 +1159,12 @@ interface PromptUpdatable {
|
|
|
1136
1159
|
interface GetPromptVersionsRequest {
|
|
1137
1160
|
page?: number;
|
|
1138
1161
|
size?: number;
|
|
1162
|
+
/**
|
|
1163
|
+
* Search text to find in template or change description fields
|
|
1164
|
+
*/
|
|
1165
|
+
search?: string;
|
|
1166
|
+
sorting?: string;
|
|
1167
|
+
filters?: string;
|
|
1139
1168
|
}
|
|
1140
1169
|
|
|
1141
1170
|
/**
|
|
@@ -1705,6 +1734,21 @@ interface GetTraceStatsRequest {
|
|
|
1705
1734
|
toTime?: Date;
|
|
1706
1735
|
}
|
|
1707
1736
|
|
|
1737
|
+
/**
|
|
1738
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
1739
|
+
*/
|
|
1740
|
+
/**
|
|
1741
|
+
* @example
|
|
1742
|
+
* {}
|
|
1743
|
+
*/
|
|
1744
|
+
interface GetTraceThreadStatsRequest {
|
|
1745
|
+
projectId?: string;
|
|
1746
|
+
projectName?: string;
|
|
1747
|
+
filters?: string;
|
|
1748
|
+
fromTime?: Date;
|
|
1749
|
+
toTime?: Date;
|
|
1750
|
+
}
|
|
1751
|
+
|
|
1708
1752
|
/**
|
|
1709
1753
|
* This file was auto-generated by Fern from our API Definition.
|
|
1710
1754
|
*/
|
|
@@ -5648,6 +5692,7 @@ interface PromptVersionDetail {
|
|
|
5648
5692
|
metadata?: JsonNodeDetail;
|
|
5649
5693
|
type?: PromptVersionDetailType;
|
|
5650
5694
|
changeDescription?: string;
|
|
5695
|
+
tags?: string[];
|
|
5651
5696
|
variables?: string[];
|
|
5652
5697
|
templateStructure?: PromptVersionDetailTemplateStructure;
|
|
5653
5698
|
createdAt?: Date;
|
|
@@ -5694,6 +5739,7 @@ interface PromptVersionPagePublic {
|
|
|
5694
5739
|
size?: number;
|
|
5695
5740
|
total?: number;
|
|
5696
5741
|
content?: PromptVersionPublic[];
|
|
5742
|
+
sortableBy?: string[];
|
|
5697
5743
|
}
|
|
5698
5744
|
|
|
5699
5745
|
/**
|
|
@@ -5728,6 +5774,7 @@ interface PromptVersionPublic {
|
|
|
5728
5774
|
metadata?: JsonNodePublic;
|
|
5729
5775
|
type?: PromptVersionPublicType;
|
|
5730
5776
|
changeDescription?: string;
|
|
5777
|
+
tags?: string[];
|
|
5731
5778
|
templateStructure?: PromptVersionPublicTemplateStructure;
|
|
5732
5779
|
createdAt?: Date;
|
|
5733
5780
|
createdBy?: string;
|
|
@@ -5775,6 +5822,26 @@ interface PromptPublic {
|
|
|
5775
5822
|
versionCount?: number;
|
|
5776
5823
|
}
|
|
5777
5824
|
|
|
5825
|
+
/**
|
|
5826
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
5827
|
+
*/
|
|
5828
|
+
/**
|
|
5829
|
+
* Update to apply to prompt versions.
|
|
5830
|
+
* Note: Prompt versions are immutable by design.
|
|
5831
|
+
* Only organizational properties (such as tags etc.) can be updated.
|
|
5832
|
+
* Core properties like template, metadata etc. cannot be modified after creation.
|
|
5833
|
+
*/
|
|
5834
|
+
interface PromptVersionUpdate {
|
|
5835
|
+
/**
|
|
5836
|
+
* Tags to set or merge with existing tags. Follows PATCH semantics:
|
|
5837
|
+
* - If merge_tags is true, these tags will be added to existing tags.
|
|
5838
|
+
* - If merge_tags is false, these tags will replace all existing tags.
|
|
5839
|
+
* - null: preserve existing tags (no change).
|
|
5840
|
+
* - empty set: clear all tags merge_tags is false.
|
|
5841
|
+
*/
|
|
5842
|
+
tags?: string[];
|
|
5843
|
+
}
|
|
5844
|
+
|
|
5778
5845
|
/**
|
|
5779
5846
|
* This file was auto-generated by Fern from our API Definition.
|
|
5780
5847
|
*/
|
|
@@ -5799,6 +5866,7 @@ interface ServiceTogglesConfig {
|
|
|
5799
5866
|
vertexaiProviderEnabled: boolean;
|
|
5800
5867
|
customllmProviderEnabled: boolean;
|
|
5801
5868
|
opikbuiltinProviderEnabled: boolean;
|
|
5869
|
+
collaboratorsTabEnabled: boolean;
|
|
5802
5870
|
}
|
|
5803
5871
|
|
|
5804
5872
|
/**
|
|
@@ -8869,6 +8937,31 @@ declare class Prompts {
|
|
|
8869
8937
|
*/
|
|
8870
8938
|
createPromptVersion(request: CreatePromptVersionDetail, requestOptions?: Prompts.RequestOptions): HttpResponsePromise<PromptVersionDetail>;
|
|
8871
8939
|
private __createPromptVersion;
|
|
8940
|
+
/**
|
|
8941
|
+
* Update one or more prompt versions.
|
|
8942
|
+
*
|
|
8943
|
+
* Note: Prompt versions are immutable by design.
|
|
8944
|
+
* Only organizational properties, such as tags etc., can be updated.
|
|
8945
|
+
* Core properties like template and metadata cannot be modified after creation.
|
|
8946
|
+
*
|
|
8947
|
+
* PATCH semantics:
|
|
8948
|
+
* - non-empty values update the field
|
|
8949
|
+
* - null values preserve existing field values (no change)
|
|
8950
|
+
* - empty values explicitly clear the field
|
|
8951
|
+
*
|
|
8952
|
+
* @param {OpikApi.PromptVersionBatchUpdate} request
|
|
8953
|
+
* @param {Prompts.RequestOptions} requestOptions - Request-specific configuration.
|
|
8954
|
+
*
|
|
8955
|
+
* @throws {@link OpikApi.BadRequestError}
|
|
8956
|
+
*
|
|
8957
|
+
* @example
|
|
8958
|
+
* await client.prompts.updatePromptVersions({
|
|
8959
|
+
* ids: ["ids"],
|
|
8960
|
+
* update: {}
|
|
8961
|
+
* })
|
|
8962
|
+
*/
|
|
8963
|
+
updatePromptVersions(request: PromptVersionBatchUpdate, requestOptions?: Prompts.RequestOptions): HttpResponsePromise<void>;
|
|
8964
|
+
private __updatePromptVersions;
|
|
8872
8965
|
/**
|
|
8873
8966
|
* Get prompt by id
|
|
8874
8967
|
*
|
|
@@ -9638,6 +9731,17 @@ declare class Traces {
|
|
|
9638
9731
|
*/
|
|
9639
9732
|
getThreadComment(commentId: string, threadId: string, requestOptions?: Traces.RequestOptions): HttpResponsePromise<Comment>;
|
|
9640
9733
|
private __getThreadComment;
|
|
9734
|
+
/**
|
|
9735
|
+
* Get trace thread stats
|
|
9736
|
+
*
|
|
9737
|
+
* @param {OpikApi.GetTraceThreadStatsRequest} request
|
|
9738
|
+
* @param {Traces.RequestOptions} requestOptions - Request-specific configuration.
|
|
9739
|
+
*
|
|
9740
|
+
* @example
|
|
9741
|
+
* await client.traces.getTraceThreadStats()
|
|
9742
|
+
*/
|
|
9743
|
+
getTraceThreadStats(request?: GetTraceThreadStatsRequest, requestOptions?: Traces.RequestOptions): HttpResponsePromise<ProjectStatsPublic>;
|
|
9744
|
+
private __getTraceThreadStats;
|
|
9641
9745
|
/**
|
|
9642
9746
|
* Get trace comment
|
|
9643
9747
|
*
|
package/dist/index.d.ts
CHANGED
|
@@ -1111,6 +1111,29 @@ interface CreatePromptVersionDetail {
|
|
|
1111
1111
|
templateStructure?: CreatePromptVersionDetailTemplateStructure;
|
|
1112
1112
|
}
|
|
1113
1113
|
|
|
1114
|
+
/**
|
|
1115
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
1116
|
+
*/
|
|
1117
|
+
|
|
1118
|
+
/**
|
|
1119
|
+
* @example
|
|
1120
|
+
* {
|
|
1121
|
+
* ids: ["ids"],
|
|
1122
|
+
* update: {}
|
|
1123
|
+
* }
|
|
1124
|
+
*/
|
|
1125
|
+
interface PromptVersionBatchUpdate {
|
|
1126
|
+
/** IDs of prompt versions to update */
|
|
1127
|
+
ids: string[];
|
|
1128
|
+
update: PromptVersionUpdate;
|
|
1129
|
+
/**
|
|
1130
|
+
* Tag merge behavior:
|
|
1131
|
+
* - true: Add new tags to existing tags (union)
|
|
1132
|
+
* - false: Replace all existing tags with new tags (default behaviour if not provided)
|
|
1133
|
+
*/
|
|
1134
|
+
mergeTags?: boolean;
|
|
1135
|
+
}
|
|
1136
|
+
|
|
1114
1137
|
/**
|
|
1115
1138
|
* This file was auto-generated by Fern from our API Definition.
|
|
1116
1139
|
*/
|
|
@@ -1136,6 +1159,12 @@ interface PromptUpdatable {
|
|
|
1136
1159
|
interface GetPromptVersionsRequest {
|
|
1137
1160
|
page?: number;
|
|
1138
1161
|
size?: number;
|
|
1162
|
+
/**
|
|
1163
|
+
* Search text to find in template or change description fields
|
|
1164
|
+
*/
|
|
1165
|
+
search?: string;
|
|
1166
|
+
sorting?: string;
|
|
1167
|
+
filters?: string;
|
|
1139
1168
|
}
|
|
1140
1169
|
|
|
1141
1170
|
/**
|
|
@@ -1705,6 +1734,21 @@ interface GetTraceStatsRequest {
|
|
|
1705
1734
|
toTime?: Date;
|
|
1706
1735
|
}
|
|
1707
1736
|
|
|
1737
|
+
/**
|
|
1738
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
1739
|
+
*/
|
|
1740
|
+
/**
|
|
1741
|
+
* @example
|
|
1742
|
+
* {}
|
|
1743
|
+
*/
|
|
1744
|
+
interface GetTraceThreadStatsRequest {
|
|
1745
|
+
projectId?: string;
|
|
1746
|
+
projectName?: string;
|
|
1747
|
+
filters?: string;
|
|
1748
|
+
fromTime?: Date;
|
|
1749
|
+
toTime?: Date;
|
|
1750
|
+
}
|
|
1751
|
+
|
|
1708
1752
|
/**
|
|
1709
1753
|
* This file was auto-generated by Fern from our API Definition.
|
|
1710
1754
|
*/
|
|
@@ -5648,6 +5692,7 @@ interface PromptVersionDetail {
|
|
|
5648
5692
|
metadata?: JsonNodeDetail;
|
|
5649
5693
|
type?: PromptVersionDetailType;
|
|
5650
5694
|
changeDescription?: string;
|
|
5695
|
+
tags?: string[];
|
|
5651
5696
|
variables?: string[];
|
|
5652
5697
|
templateStructure?: PromptVersionDetailTemplateStructure;
|
|
5653
5698
|
createdAt?: Date;
|
|
@@ -5694,6 +5739,7 @@ interface PromptVersionPagePublic {
|
|
|
5694
5739
|
size?: number;
|
|
5695
5740
|
total?: number;
|
|
5696
5741
|
content?: PromptVersionPublic[];
|
|
5742
|
+
sortableBy?: string[];
|
|
5697
5743
|
}
|
|
5698
5744
|
|
|
5699
5745
|
/**
|
|
@@ -5728,6 +5774,7 @@ interface PromptVersionPublic {
|
|
|
5728
5774
|
metadata?: JsonNodePublic;
|
|
5729
5775
|
type?: PromptVersionPublicType;
|
|
5730
5776
|
changeDescription?: string;
|
|
5777
|
+
tags?: string[];
|
|
5731
5778
|
templateStructure?: PromptVersionPublicTemplateStructure;
|
|
5732
5779
|
createdAt?: Date;
|
|
5733
5780
|
createdBy?: string;
|
|
@@ -5775,6 +5822,26 @@ interface PromptPublic {
|
|
|
5775
5822
|
versionCount?: number;
|
|
5776
5823
|
}
|
|
5777
5824
|
|
|
5825
|
+
/**
|
|
5826
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
5827
|
+
*/
|
|
5828
|
+
/**
|
|
5829
|
+
* Update to apply to prompt versions.
|
|
5830
|
+
* Note: Prompt versions are immutable by design.
|
|
5831
|
+
* Only organizational properties (such as tags etc.) can be updated.
|
|
5832
|
+
* Core properties like template, metadata etc. cannot be modified after creation.
|
|
5833
|
+
*/
|
|
5834
|
+
interface PromptVersionUpdate {
|
|
5835
|
+
/**
|
|
5836
|
+
* Tags to set or merge with existing tags. Follows PATCH semantics:
|
|
5837
|
+
* - If merge_tags is true, these tags will be added to existing tags.
|
|
5838
|
+
* - If merge_tags is false, these tags will replace all existing tags.
|
|
5839
|
+
* - null: preserve existing tags (no change).
|
|
5840
|
+
* - empty set: clear all tags merge_tags is false.
|
|
5841
|
+
*/
|
|
5842
|
+
tags?: string[];
|
|
5843
|
+
}
|
|
5844
|
+
|
|
5778
5845
|
/**
|
|
5779
5846
|
* This file was auto-generated by Fern from our API Definition.
|
|
5780
5847
|
*/
|
|
@@ -5799,6 +5866,7 @@ interface ServiceTogglesConfig {
|
|
|
5799
5866
|
vertexaiProviderEnabled: boolean;
|
|
5800
5867
|
customllmProviderEnabled: boolean;
|
|
5801
5868
|
opikbuiltinProviderEnabled: boolean;
|
|
5869
|
+
collaboratorsTabEnabled: boolean;
|
|
5802
5870
|
}
|
|
5803
5871
|
|
|
5804
5872
|
/**
|
|
@@ -8869,6 +8937,31 @@ declare class Prompts {
|
|
|
8869
8937
|
*/
|
|
8870
8938
|
createPromptVersion(request: CreatePromptVersionDetail, requestOptions?: Prompts.RequestOptions): HttpResponsePromise<PromptVersionDetail>;
|
|
8871
8939
|
private __createPromptVersion;
|
|
8940
|
+
/**
|
|
8941
|
+
* Update one or more prompt versions.
|
|
8942
|
+
*
|
|
8943
|
+
* Note: Prompt versions are immutable by design.
|
|
8944
|
+
* Only organizational properties, such as tags etc., can be updated.
|
|
8945
|
+
* Core properties like template and metadata cannot be modified after creation.
|
|
8946
|
+
*
|
|
8947
|
+
* PATCH semantics:
|
|
8948
|
+
* - non-empty values update the field
|
|
8949
|
+
* - null values preserve existing field values (no change)
|
|
8950
|
+
* - empty values explicitly clear the field
|
|
8951
|
+
*
|
|
8952
|
+
* @param {OpikApi.PromptVersionBatchUpdate} request
|
|
8953
|
+
* @param {Prompts.RequestOptions} requestOptions - Request-specific configuration.
|
|
8954
|
+
*
|
|
8955
|
+
* @throws {@link OpikApi.BadRequestError}
|
|
8956
|
+
*
|
|
8957
|
+
* @example
|
|
8958
|
+
* await client.prompts.updatePromptVersions({
|
|
8959
|
+
* ids: ["ids"],
|
|
8960
|
+
* update: {}
|
|
8961
|
+
* })
|
|
8962
|
+
*/
|
|
8963
|
+
updatePromptVersions(request: PromptVersionBatchUpdate, requestOptions?: Prompts.RequestOptions): HttpResponsePromise<void>;
|
|
8964
|
+
private __updatePromptVersions;
|
|
8872
8965
|
/**
|
|
8873
8966
|
* Get prompt by id
|
|
8874
8967
|
*
|
|
@@ -9638,6 +9731,17 @@ declare class Traces {
|
|
|
9638
9731
|
*/
|
|
9639
9732
|
getThreadComment(commentId: string, threadId: string, requestOptions?: Traces.RequestOptions): HttpResponsePromise<Comment>;
|
|
9640
9733
|
private __getThreadComment;
|
|
9734
|
+
/**
|
|
9735
|
+
* Get trace thread stats
|
|
9736
|
+
*
|
|
9737
|
+
* @param {OpikApi.GetTraceThreadStatsRequest} request
|
|
9738
|
+
* @param {Traces.RequestOptions} requestOptions - Request-specific configuration.
|
|
9739
|
+
*
|
|
9740
|
+
* @example
|
|
9741
|
+
* await client.traces.getTraceThreadStats()
|
|
9742
|
+
*/
|
|
9743
|
+
getTraceThreadStats(request?: GetTraceThreadStatsRequest, requestOptions?: Traces.RequestOptions): HttpResponsePromise<ProjectStatsPublic>;
|
|
9744
|
+
private __getTraceThreadStats;
|
|
9641
9745
|
/**
|
|
9642
9746
|
* Get trace comment
|
|
9643
9747
|
*
|