opik 1.9.75 → 1.9.76

package/dist/index.d.cts

@@ -614,6 +614,7 @@ interface ExperimentWrite {
     datasetName: string;
     name?: string;
     metadata?: JsonListStringWrite;
+    tags?: string[];
     type?: ExperimentWriteType;
     optimizationId?: string;
     status?: ExperimentWriteStatus;
@@ -727,6 +728,7 @@ interface FindExperimentGroupsAggregationsRequest {
 interface ExperimentUpdate {
     name?: string;
     metadata?: JsonNode;
+    tags?: string[];
     type?: ExperimentUpdateType;
     /** The status of the experiment */
     status?: ExperimentUpdateStatus;
@@ -4796,6 +4798,7 @@ interface ExperimentPublic {
     projectId?: string;
     name?: string;
     metadata?: JsonListStringPublic;
+    tags?: string[];
     type?: ExperimentPublicType;
     optimizationId?: string;
     feedbackScores?: FeedbackScoreAveragePublic[];
@@ -10404,6 +10407,7 @@ interface PromptVersionData {
     type: PromptType;
     metadata?: JsonNode;
     changeDescription?: string;
+    tags?: string[];
     createdAt?: Date;
     createdBy?: string;
 }
@@ -10420,6 +10424,7 @@ declare class PromptVersion {
     readonly type: PromptType;
     readonly metadata?: JsonNode;
     readonly changeDescription?: string;
+    readonly tags?: string[];
     readonly createdAt?: Date;
     readonly createdBy?: string;
     constructor(data: PromptVersionData);
@@ -10572,21 +10577,36 @@ declare class Prompt {
      * Fetches and returns complete version history, sorted by creation date (newest first).
      * Automatically handles pagination to fetch all versions.
      *
+     * @param options - Optional filtering, sorting, and search parameters
+     * @param options.search - Search text to find in template or change description fields
+     * @param options.sorting - Sorting specification (e.g., JSON array of sort criteria)
+     * @param options.filters - Filter specification (e.g., JSON array of filter criteria)
      * @returns Promise resolving to array of all PromptVersion instances for this prompt
      * @throws OpikApiError if REST API call fails
      *
      * @example
      * ```typescript
      * const prompt = await client.getPrompt({ name: "my-prompt" });
-     * const versions = await prompt.getVersions();
      *
-     * console.log(`Found ${versions.length} versions`);
-     * versions.forEach(v => {
-     *   console.log(`Commit: ${v.commit}, Age: ${v.getVersionAge()}`);
+     * // Get all versions
+     * const allVersions = await prompt.getVersions();
+     *
+     * // Get versions with tags filter
+     * const prodVersions = await prompt.getVersions({
+     *   filters: JSON.stringify([{ field: "tags", operator: "contains", value: "production" }])
+     * });
+     *
+     * // Search in templates
+     * const searchResults = await prompt.getVersions({
+     *   search: "greeting"
      * });
      * ```
      */
-    getVersions(): Promise<PromptVersion[]>;
+    getVersions(options?: {
+        search?: string;
+        sorting?: string;
+        filters?: string;
+    }): Promise<PromptVersion[]>;
     /**
      * Restores a specific version by creating a new version with content from the specified version.
      * The version must be obtained from the backend (e.g., via getVersions()).
@@ -11240,6 +11260,41 @@ declare class OpikClient {
         waitForTimeout?: number;
     }) => Promise<TracePublic[]>;
     flush: () => Promise<void>;
+    /**
+     * Updates tags for one or more prompt versions in a single batch operation.
+     *
+     * @param versionIds - Array of prompt version IDs to update
+     * @param options - Update options
+     * @param options.tags - Tags to set or merge:
+     *   - `[]`: Clear all tags (when mergeTags is false or unspecified)
+     *   - `['tag1', 'tag2']`: Set or merge tags (based on mergeTags)
+     * @param options.mergeTags - If true, adds new tags to existing tags (union). If false, replaces all existing tags (default: false)
+     * @returns Promise that resolves when update is complete
+     * @throws OpikApiError if update fails
+     *
+     * @example
+     * ```typescript
+     * // Replace tags on multiple versions (default behavior)
+     * await client.updatePromptVersionTags(["version-id-1", "version-id-2"], {
+     *   tags: ["production", "v2"]
+     * });
+     *
+     * // Merge new tags with existing tags
+     * await client.updatePromptVersionTags(["version-id-1"], {
+     *   tags: ["hotfix"],
+     *   mergeTags: true
+     * });
+     *
+     * // Clear all tags
+     * await client.updatePromptVersionTags(["version-id-1"], {
+     *   tags: []
+     * });
+     * ```
+     */
+    updatePromptVersionTags: (versionIds: string[], options?: {
+        tags?: string[] | null;
+        mergeTags?: boolean;
+    }) => Promise<void>;
 }
 
 type TrackContext = {

package/dist/index.d.ts

@@ -614,6 +614,7 @@ interface ExperimentWrite {
     datasetName: string;
     name?: string;
     metadata?: JsonListStringWrite;
+    tags?: string[];
     type?: ExperimentWriteType;
     optimizationId?: string;
     status?: ExperimentWriteStatus;
@@ -727,6 +728,7 @@ interface FindExperimentGroupsAggregationsRequest {
 interface ExperimentUpdate {
     name?: string;
     metadata?: JsonNode;
+    tags?: string[];
     type?: ExperimentUpdateType;
     /** The status of the experiment */
     status?: ExperimentUpdateStatus;
@@ -4796,6 +4798,7 @@ interface ExperimentPublic {
     projectId?: string;
     name?: string;
     metadata?: JsonListStringPublic;
+    tags?: string[];
     type?: ExperimentPublicType;
     optimizationId?: string;
     feedbackScores?: FeedbackScoreAveragePublic[];
@@ -10404,6 +10407,7 @@ interface PromptVersionData {
     type: PromptType;
     metadata?: JsonNode;
     changeDescription?: string;
+    tags?: string[];
     createdAt?: Date;
     createdBy?: string;
 }
@@ -10420,6 +10424,7 @@ declare class PromptVersion {
     readonly type: PromptType;
     readonly metadata?: JsonNode;
     readonly changeDescription?: string;
+    readonly tags?: string[];
     readonly createdAt?: Date;
     readonly createdBy?: string;
     constructor(data: PromptVersionData);
@@ -10572,21 +10577,36 @@ declare class Prompt {
      * Fetches and returns complete version history, sorted by creation date (newest first).
      * Automatically handles pagination to fetch all versions.
      *
+     * @param options - Optional filtering, sorting, and search parameters
+     * @param options.search - Search text to find in template or change description fields
+     * @param options.sorting - Sorting specification (e.g., JSON array of sort criteria)
+     * @param options.filters - Filter specification (e.g., JSON array of filter criteria)
      * @returns Promise resolving to array of all PromptVersion instances for this prompt
      * @throws OpikApiError if REST API call fails
      *
      * @example
      * ```typescript
      * const prompt = await client.getPrompt({ name: "my-prompt" });
-     * const versions = await prompt.getVersions();
      *
-     * console.log(`Found ${versions.length} versions`);
-     * versions.forEach(v => {
-     *   console.log(`Commit: ${v.commit}, Age: ${v.getVersionAge()}`);
+     * // Get all versions
+     * const allVersions = await prompt.getVersions();
+     *
+     * // Get versions with tags filter
+     * const prodVersions = await prompt.getVersions({
+     *   filters: JSON.stringify([{ field: "tags", operator: "contains", value: "production" }])
+     * });
+     *
+     * // Search in templates
+     * const searchResults = await prompt.getVersions({
+     *   search: "greeting"
      * });
      * ```
      */
-    getVersions(): Promise<PromptVersion[]>;
+    getVersions(options?: {
+        search?: string;
+        sorting?: string;
+        filters?: string;
+    }): Promise<PromptVersion[]>;
     /**
      * Restores a specific version by creating a new version with content from the specified version.
      * The version must be obtained from the backend (e.g., via getVersions()).
@@ -11240,6 +11260,41 @@ declare class OpikClient {
         waitForTimeout?: number;
     }) => Promise<TracePublic[]>;
     flush: () => Promise<void>;
+    /**
+     * Updates tags for one or more prompt versions in a single batch operation.
+     *
+     * @param versionIds - Array of prompt version IDs to update
+     * @param options - Update options
+     * @param options.tags - Tags to set or merge:
+     *   - `[]`: Clear all tags (when mergeTags is false or unspecified)
+     *   - `['tag1', 'tag2']`: Set or merge tags (based on mergeTags)
+     * @param options.mergeTags - If true, adds new tags to existing tags (union). If false, replaces all existing tags (default: false)
+     * @returns Promise that resolves when update is complete
+     * @throws OpikApiError if update fails
+     *
+     * @example
+     * ```typescript
+     * // Replace tags on multiple versions (default behavior)
+     * await client.updatePromptVersionTags(["version-id-1", "version-id-2"], {
+     *   tags: ["production", "v2"]
+     * });
+     *
+     * // Merge new tags with existing tags
+     * await client.updatePromptVersionTags(["version-id-1"], {
+     *   tags: ["hotfix"],
+     *   mergeTags: true
+     * });
+     *
+     * // Clear all tags
+     * await client.updatePromptVersionTags(["version-id-1"], {
+     *   tags: []
+     * });
+     * ```
+     */
+    updatePromptVersionTags: (versionIds: string[], options?: {
+        tags?: string[] | null;
+        mergeTags?: boolean;
+    }) => Promise<void>;
 }
 
 type TrackContext = {