opik 2.0.51 → 2.0.53

package/dist/index.d.cts

@@ -5312,7 +5312,9 @@ interface KpiCardResponse {
 
 interface KpiMetric {
     type?: KpiMetricType;
+    /** Metric value for the current period. Unit depends on `type`: `count` is an integer count; `errors` is a percentage in [0, 100]; `avg_duration` is milliseconds; `total_cost` is in USD. */
     currentValue?: number;
+    /** Metric value for the immediately preceding period of equal length. Same unit as `current_value`. */
     previousValue?: number;
 }
 
@@ -6055,6 +6057,8 @@ interface PromptVersionDetail {
     type?: PromptVersionDetailType;
     /** version type discriminator; defaults to prompt_version */
     versionType?: PromptVersionDetailVersionType;
+    /** Deprecated: use 'environments' instead */
+    environment?: string;
     environments?: string[];
     changeDescription?: string;
     tags?: string[];
@@ -6087,6 +6091,8 @@ type PromptVersionDetailVersionType = (typeof PromptVersionDetailVersionType)[ke
 interface PromptVersionLink {
     id: string;
     commit?: string;
+    /** sequential version number in the format v<N>; null for masks */
+    versionNumber?: string;
     promptId?: string;
     promptName?: string;
 }
@@ -6123,6 +6129,8 @@ interface PromptVersionPublic {
     type?: PromptVersionPublicType;
     /** version type discriminator; defaults to prompt_version */
     versionType?: PromptVersionPublicVersionType;
+    /** Deprecated: use 'environments' instead */
+    environment?: string;
     environments?: string[];
     changeDescription?: string;
     tags?: string[];
@@ -12182,6 +12190,11 @@ interface GetPromptOptions {
     version?: string;
     /** Optional project name to scope the lookup. */
     projectName?: string;
+    /**
+     * Optional environment name. Resolves to the version currently owned by that
+     * workspace environment. Mutually exclusive with `commit`.
+     */
+    environment?: string;
 }
 /**
  * Variables to be substituted into prompt template.
@@ -12258,7 +12271,6 @@ declare class PromptVersion {
     readonly commit: string;
     /**
      * Sequential version identifier of this prompt version (e.g. `"v3"`).
-     * Undefined for mask versions, which do not carry a version number.
      */
     readonly version?: string;
     readonly type: PromptType;
@@ -12279,7 +12291,7 @@ declare class PromptVersion {
     /**
      * Get formatted version information string.
      * Format: "[v3] YYYY-MM-DD by user@email.com - Change description"
-     * (falls back to the commit hash for mask versions, which have no version number).
+     * (falls back to the commit hash when no version number is present).
      */
     getVersionInfo(): string;
     /**
@@ -12333,6 +12345,8 @@ interface BasePromptData {
     templateStructure?: PromptTemplateStructure;
     synced?: boolean;
     projectName?: string;
+    /** Optional environments that own this prompt version. */
+    environments?: string[];
 }
 /**
  * Abstract base class for all prompt types.
@@ -12346,6 +12360,7 @@ declare abstract class BasePrompt {
     private _synced;
     private _changeDescription;
     private _projectName;
+    private _environments;
     readonly type: PromptType;
     readonly templateStructure: PromptTemplateStructure;
     protected _name: string;
@@ -12363,6 +12378,11 @@ declare abstract class BasePrompt {
     get synced(): boolean;
     get changeDescription(): string | undefined;
     get projectName(): string | undefined;
+    /**
+     * The environments that own this prompt version. Returns an empty array
+     * if the version is not associated with any environment.
+     */
+    get environments(): readonly string[];
     constructor(data: BasePromptData, opik?: OpikClient);
     /**
      * Updates internal state after a successful background sync.
@@ -12375,6 +12395,7 @@ declare abstract class BasePrompt {
         changeDescription?: string;
         tags?: string[];
         projectName?: string;
+        environments?: string[];
     }): void;
     /**
      * Shared background-sync helper for subclass constructors.
@@ -14310,14 +14331,18 @@ declare class OpikClient {
      * default 300s). When called inside a track() context the prompt reference
      * is injected into the active trace/span metadata.
      *
-     * @param options - Prompt name and optional version pin
+     * @param options - Prompt name and optional version pin or environment
      * @param options.name - Name of the prompt
      * @param options.version - Sequential version identifier (e.g. `"v3"`). If not
      *   provided, the latest version is returned.
      * @param options.commit - **Deprecated.** Use `version` instead.
      * @param options.projectName - Optional project scope.
+     * @param options.environment - Optional environment name. Resolves to the version
+     *   currently owned by that workspace environment. Mutually exclusive with both
+     *   `commit` and `version`.
      * @returns Promise resolving to Prompt or null if not found
-     * @throws Error if both `commit` and `version` are provided
+     * @throws Error if both `commit` and `version` are provided, or if `environment` is
+     *   combined with either `commit` or `version`
      * @throws PromptTemplateStructureMismatch if prompt exists but is a chat prompt
      */
     getPrompt: (options: GetPromptOptions) => Promise<Prompt | null>;
@@ -14327,14 +14352,18 @@ declare class OpikClient {
      * default 300s). When called inside a track() context the prompt reference
      * is injected into the active trace/span metadata.
      *
-     * @param options - Prompt name and optional version pin
+     * @param options - Prompt name and optional version pin or environment
      * @param options.name - Name of the prompt
      * @param options.version - Sequential version identifier (e.g. `"v3"`). If not
      *   provided, the latest version is returned.
      * @param options.commit - **Deprecated.** Use `version` instead.
      * @param options.projectName - Optional project scope.
+     * @param options.environment - Optional environment name. Resolves to the version
+     *   currently owned by that workspace environment. Mutually exclusive with both
+     *   `commit` and `version`.
      * @returns Promise resolving to ChatPrompt or null if not found
-     * @throws Error if both `commit` and `version` are provided
+     * @throws Error if both `commit` and `version` are provided, or if `environment` is
+     *   combined with either `commit` or `version`
      * @throws PromptTemplateStructureMismatch if prompt exists but is a text prompt
      *
      * @example
@@ -14405,6 +14434,30 @@ declare class OpikClient {
      * @param ids - Array of prompt container IDs to delete
      */
     deletePrompts: (ids: string[]) => Promise<void>;
+    /**
+     * Assigns a prompt version to an environment, or clears the assignment.
+     *
+     * Replace the full set of environments owned by a prompt version. The
+     * provided list becomes the resolved version's complete set of environments.
+     * Pass an empty array to clear all environments. Any other version of the
+     * same prompt that previously owned one of the listed environments is
+     * cleared. Existing prompt objects already in memory are not mutated —
+     * re-fetch with `client.getPrompt(...)` to see the change.
+     *
+     * @param options.promptName - Name of the prompt
+     * @param options.environments - Environments to assign. Each must already be registered in the workspace. Pass `[]` to clear.
+     * @param options.version - Sequential version selector in the wire format `"v<N>"` (e.g. `"v3"`). Defaults to the latest version.
+     * @param options.projectName - Project the prompt belongs to. Defaults to the client's project.
+     *
+     * @throws {PromptNotFoundError} The prompt name (or the supplied `version`) does not exist in the resolved project.
+     * @throws {EnvironmentNotFoundError} One of `environments` is not registered in the workspace.
+     */
+    setPromptEnvironments: (options: {
+        promptName: string;
+        environments: string[];
+        version?: string;
+        projectName?: string;
+    }) => Promise<void>;
     /**
      * Search for traces in the given project. Optionally, you can wait for at least a certain number of traces
      * to be found before returning within the specified timeout.

package/dist/index.d.ts

@@ -5312,7 +5312,9 @@ interface KpiCardResponse {
 
 interface KpiMetric {
     type?: KpiMetricType;
+    /** Metric value for the current period. Unit depends on `type`: `count` is an integer count; `errors` is a percentage in [0, 100]; `avg_duration` is milliseconds; `total_cost` is in USD. */
     currentValue?: number;
+    /** Metric value for the immediately preceding period of equal length. Same unit as `current_value`. */
     previousValue?: number;
 }
 
@@ -6055,6 +6057,8 @@ interface PromptVersionDetail {
     type?: PromptVersionDetailType;
     /** version type discriminator; defaults to prompt_version */
     versionType?: PromptVersionDetailVersionType;
+    /** Deprecated: use 'environments' instead */
+    environment?: string;
     environments?: string[];
     changeDescription?: string;
     tags?: string[];
@@ -6087,6 +6091,8 @@ type PromptVersionDetailVersionType = (typeof PromptVersionDetailVersionType)[ke
 interface PromptVersionLink {
     id: string;
     commit?: string;
+    /** sequential version number in the format v<N>; null for masks */
+    versionNumber?: string;
     promptId?: string;
     promptName?: string;
 }
@@ -6123,6 +6129,8 @@ interface PromptVersionPublic {
     type?: PromptVersionPublicType;
     /** version type discriminator; defaults to prompt_version */
     versionType?: PromptVersionPublicVersionType;
+    /** Deprecated: use 'environments' instead */
+    environment?: string;
     environments?: string[];
     changeDescription?: string;
     tags?: string[];
@@ -12182,6 +12190,11 @@ interface GetPromptOptions {
     version?: string;
     /** Optional project name to scope the lookup. */
     projectName?: string;
+    /**
+     * Optional environment name. Resolves to the version currently owned by that
+     * workspace environment. Mutually exclusive with `commit`.
+     */
+    environment?: string;
 }
 /**
  * Variables to be substituted into prompt template.
@@ -12258,7 +12271,6 @@ declare class PromptVersion {
     readonly commit: string;
     /**
      * Sequential version identifier of this prompt version (e.g. `"v3"`).
-     * Undefined for mask versions, which do not carry a version number.
      */
     readonly version?: string;
     readonly type: PromptType;
@@ -12279,7 +12291,7 @@ declare class PromptVersion {
     /**
      * Get formatted version information string.
      * Format: "[v3] YYYY-MM-DD by user@email.com - Change description"
-     * (falls back to the commit hash for mask versions, which have no version number).
+     * (falls back to the commit hash when no version number is present).
      */
     getVersionInfo(): string;
     /**
@@ -12333,6 +12345,8 @@ interface BasePromptData {
     templateStructure?: PromptTemplateStructure;
     synced?: boolean;
     projectName?: string;
+    /** Optional environments that own this prompt version. */
+    environments?: string[];
 }
 /**
  * Abstract base class for all prompt types.
@@ -12346,6 +12360,7 @@ declare abstract class BasePrompt {
     private _synced;
     private _changeDescription;
     private _projectName;
+    private _environments;
     readonly type: PromptType;
     readonly templateStructure: PromptTemplateStructure;
     protected _name: string;
@@ -12363,6 +12378,11 @@ declare abstract class BasePrompt {
     get synced(): boolean;
     get changeDescription(): string | undefined;
     get projectName(): string | undefined;
+    /**
+     * The environments that own this prompt version. Returns an empty array
+     * if the version is not associated with any environment.
+     */
+    get environments(): readonly string[];
     constructor(data: BasePromptData, opik?: OpikClient);
     /**
      * Updates internal state after a successful background sync.
@@ -12375,6 +12395,7 @@ declare abstract class BasePrompt {
         changeDescription?: string;
         tags?: string[];
         projectName?: string;
+        environments?: string[];
     }): void;
     /**
      * Shared background-sync helper for subclass constructors.
@@ -14310,14 +14331,18 @@ declare class OpikClient {
      * default 300s). When called inside a track() context the prompt reference
      * is injected into the active trace/span metadata.
      *
-     * @param options - Prompt name and optional version pin
+     * @param options - Prompt name and optional version pin or environment
      * @param options.name - Name of the prompt
      * @param options.version - Sequential version identifier (e.g. `"v3"`). If not
      *   provided, the latest version is returned.
      * @param options.commit - **Deprecated.** Use `version` instead.
      * @param options.projectName - Optional project scope.
+     * @param options.environment - Optional environment name. Resolves to the version
+     *   currently owned by that workspace environment. Mutually exclusive with both
+     *   `commit` and `version`.
      * @returns Promise resolving to Prompt or null if not found
-     * @throws Error if both `commit` and `version` are provided
+     * @throws Error if both `commit` and `version` are provided, or if `environment` is
+     *   combined with either `commit` or `version`
      * @throws PromptTemplateStructureMismatch if prompt exists but is a chat prompt
      */
     getPrompt: (options: GetPromptOptions) => Promise<Prompt | null>;
@@ -14327,14 +14352,18 @@ declare class OpikClient {
      * default 300s). When called inside a track() context the prompt reference
      * is injected into the active trace/span metadata.
      *
-     * @param options - Prompt name and optional version pin
+     * @param options - Prompt name and optional version pin or environment
      * @param options.name - Name of the prompt
      * @param options.version - Sequential version identifier (e.g. `"v3"`). If not
      *   provided, the latest version is returned.
      * @param options.commit - **Deprecated.** Use `version` instead.
      * @param options.projectName - Optional project scope.
+     * @param options.environment - Optional environment name. Resolves to the version
+     *   currently owned by that workspace environment. Mutually exclusive with both
+     *   `commit` and `version`.
      * @returns Promise resolving to ChatPrompt or null if not found
-     * @throws Error if both `commit` and `version` are provided
+     * @throws Error if both `commit` and `version` are provided, or if `environment` is
+     *   combined with either `commit` or `version`
      * @throws PromptTemplateStructureMismatch if prompt exists but is a text prompt
      *
      * @example
@@ -14405,6 +14434,30 @@ declare class OpikClient {
      * @param ids - Array of prompt container IDs to delete
      */
     deletePrompts: (ids: string[]) => Promise<void>;
+    /**
+     * Assigns a prompt version to an environment, or clears the assignment.
+     *
+     * Replace the full set of environments owned by a prompt version. The
+     * provided list becomes the resolved version's complete set of environments.
+     * Pass an empty array to clear all environments. Any other version of the
+     * same prompt that previously owned one of the listed environments is
+     * cleared. Existing prompt objects already in memory are not mutated —
+     * re-fetch with `client.getPrompt(...)` to see the change.
+     *
+     * @param options.promptName - Name of the prompt
+     * @param options.environments - Environments to assign. Each must already be registered in the workspace. Pass `[]` to clear.
+     * @param options.version - Sequential version selector in the wire format `"v<N>"` (e.g. `"v3"`). Defaults to the latest version.
+     * @param options.projectName - Project the prompt belongs to. Defaults to the client's project.
+     *
+     * @throws {PromptNotFoundError} The prompt name (or the supplied `version`) does not exist in the resolved project.
+     * @throws {EnvironmentNotFoundError} One of `environments` is not registered in the workspace.
+     */
+    setPromptEnvironments: (options: {
+        promptName: string;
+        environments: string[];
+        version?: string;
+        projectName?: string;
+    }) => Promise<void>;
     /**
      * Search for traces in the given project. Optionally, you can wait for at least a certain number of traces
      * to be found before returning within the specified timeout.

package/dist/index.js

@@ -1 +1 @@
-import {Fa}from'./chunk-NA3QFMTH.js';export{sa as AgentTaskCompletionJudge,ra as AgentToolCorrectnessJudge,fa as AnswerRelevance,ba as BaseLLMJudgeMetric,C as BaseMetric,D as BaseSuiteEvaluator,p as ChatPrompt,ua as ComplianceRiskJudge,i as ConfigMismatchError,h as ConfigNotFoundError,_ as Contains,y as DEFAULT_EXECUTION_POLICY,j as Dataset,f as DatasetVersion,g as DatasetVersionNotFoundError,ma as DemographicBiasJudge,ka as DialogueHelpfulnessJudge,Z as ExactMatch,ga as GEval,ha as GEvalPreset,oa as GenderBiasJudge,ea as Hallucination,aa as IsJson,Q as LLMJudge,H as ModelConfigurationError,F as ModelError,G as ModelGenerationError,ca as Moderation,Ca as OPIK_PARENT_SPAN_ID_HEADER,Ba as OPIK_TRACE_ID_HEADER,Aa as Opik,E as OpikBaseModel,q as OpikQueryLanguage,d as OpikSpanType,na as PoliticalBiasJudge,o as Prompt,k as PromptType,ta as PromptUncertaintyJudge,la as QARelevanceJudge,$ as RegexMatch,qa as RegionalBiasJudge,pa as ReligiousBiasJudge,P as ResponseSchema,N as SYSTEM_PROMPT,ja as SummarizationCoherenceJudge,ia as SummarizationConsistencyJudge,B as TASK_ERROR_SCORE_NAME,ya as TestSuite,z as TestSuiteResult,s as ThreadsAnnotationQueue,r as TracesAnnotationQueue,O as USER_PROMPT_TEMPLATE,da as Usefulness,J as VercelAIChatModel,v as activateRunner,t as agentConfigContext,A as buildSuiteResult,K as createModel,L as createModelFromInstance,S as deserializeEvaluators,I as detectProvider,c as disableLogger,X as evaluate,Y as evaluatePrompt,V as evaluateTestSuite,u as flushAll,e as generateId,Da as getDistributedTraceHeaders,l as getGlobalClient,w as getTrackContext,a as logger,n as resetGlobalClient,va as resolveEvaluators,T as resolveExecutionPolicy,U as resolveItemExecutionPolicy,M as resolveModel,W as runTests,R as serializeEvaluators,m as setGlobalClient,b as setLoggerLevel,x as track,wa as validateEvaluators,xa as validateExecutionPolicy,Ea as z}from'./chunk-NA3QFMTH.js';Fa();
+import {Fa}from'./chunk-ESJEX6P3.js';export{sa as AgentTaskCompletionJudge,ra as AgentToolCorrectnessJudge,fa as AnswerRelevance,ba as BaseLLMJudgeMetric,C as BaseMetric,D as BaseSuiteEvaluator,p as ChatPrompt,ua as ComplianceRiskJudge,i as ConfigMismatchError,h as ConfigNotFoundError,_ as Contains,y as DEFAULT_EXECUTION_POLICY,j as Dataset,f as DatasetVersion,g as DatasetVersionNotFoundError,ma as DemographicBiasJudge,ka as DialogueHelpfulnessJudge,Z as ExactMatch,ga as GEval,ha as GEvalPreset,oa as GenderBiasJudge,ea as Hallucination,aa as IsJson,Q as LLMJudge,H as ModelConfigurationError,F as ModelError,G as ModelGenerationError,ca as Moderation,Ca as OPIK_PARENT_SPAN_ID_HEADER,Ba as OPIK_TRACE_ID_HEADER,Aa as Opik,E as OpikBaseModel,q as OpikQueryLanguage,d as OpikSpanType,na as PoliticalBiasJudge,o as Prompt,k as PromptType,ta as PromptUncertaintyJudge,la as QARelevanceJudge,$ as RegexMatch,qa as RegionalBiasJudge,pa as ReligiousBiasJudge,P as ResponseSchema,N as SYSTEM_PROMPT,ja as SummarizationCoherenceJudge,ia as SummarizationConsistencyJudge,B as TASK_ERROR_SCORE_NAME,ya as TestSuite,z as TestSuiteResult,s as ThreadsAnnotationQueue,r as TracesAnnotationQueue,O as USER_PROMPT_TEMPLATE,da as Usefulness,J as VercelAIChatModel,v as activateRunner,t as agentConfigContext,A as buildSuiteResult,K as createModel,L as createModelFromInstance,S as deserializeEvaluators,I as detectProvider,c as disableLogger,X as evaluate,Y as evaluatePrompt,V as evaluateTestSuite,u as flushAll,e as generateId,Da as getDistributedTraceHeaders,l as getGlobalClient,w as getTrackContext,a as logger,n as resetGlobalClient,va as resolveEvaluators,T as resolveExecutionPolicy,U as resolveItemExecutionPolicy,M as resolveModel,W as runTests,R as serializeEvaluators,m as setGlobalClient,b as setLoggerLevel,x as track,wa as validateEvaluators,xa as validateExecutionPolicy,Ea as z}from'./chunk-ESJEX6P3.js';Fa();

package/dist/{suite-GXAXIC24.js → suite-QQADPYMX.js}

@@ -1 +1 @@
-import {za}from'./chunk-NA3QFMTH.js';export{y as DEFAULT_EXECUTION_POLICY,ya as TestSuite,z as TestSuiteResult,A as buildSuiteResult,S as deserializeEvaluators,V as evaluateTestSuite,T as resolveExecutionPolicy,U as resolveItemExecutionPolicy,W as runTests,R as serializeEvaluators}from'./chunk-NA3QFMTH.js';za();
+import {za}from'./chunk-ESJEX6P3.js';export{y as DEFAULT_EXECUTION_POLICY,ya as TestSuite,z as TestSuiteResult,A as buildSuiteResult,S as deserializeEvaluators,V as evaluateTestSuite,T as resolveExecutionPolicy,U as resolveItemExecutionPolicy,W as runTests,R as serializeEvaluators}from'./chunk-ESJEX6P3.js';za();

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "opik",
   "description": "Opik TypeScript and JavaScript SDK",
-  "version": "2.0.51",
+  "version": "2.0.53",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/comet-ml/opik.git",