opik 2.0.39 → 2.0.41

package/dist/index.d.cts

@@ -1915,7 +1915,12 @@ type GetPromptByCommitRequest = {};
  * @example
  *     {}
  */
-type GetPromptByIdRequest = {};
+interface GetPromptByIdRequest {
+    /** Optional mask version id; when set, requestedVersion is the mask row for that id */
+    maskId?: string;
+    /** Optional environment name; when set, requestedVersion is the version mapped to that environment for the prompt */
+    environment?: string;
+}
 
 /**
  * @example
@@ -1990,6 +1995,24 @@ interface PromptVersionCommitsRequestPublic {
     commits: string[];
 }
 
+/**
+ * @example
+ *     {}
+ */
+interface PromptVersionEnvironmentUpdate {
+    environment?: string;
+}
+
+/**
+ * @example
+ *     {
+ *         ids: ["ids"]
+ *     }
+ */
+interface PromptVersionIdsRequestDetail {
+    ids: string[];
+}
+
 /**
  * @example
  *     {
@@ -1999,6 +2022,8 @@ interface PromptVersionCommitsRequestPublic {
 interface PromptVersionRetrieveDetail {
     name: string;
     commit?: string;
+    /** If provided, resolves to the version mapped to this environment for the prompt; mutually exclusive with commit */
+    environment?: string;
     /** If provided, scopes the search to the specified project */
     projectName?: string;
 }
@@ -2219,7 +2244,10 @@ interface CreateLocalRunnerJobRequest {
     agentName: string;
     inputs?: JsonNode;
     projectId: string;
+    /** Deprecated. Use prompt_masks to pass one or more mask overlays keyed by prompt id. */
     maskId?: string;
+    /** Mask overlays to apply during agent execution, keyed by prompt id. */
+    promptMasks?: Record<string, string>;
     blueprintName?: string;
     metadata?: LocalRunnerJobMetadata;
 }
@@ -5457,7 +5485,10 @@ interface LocalRunnerJob {
     error?: string;
     projectId?: string;
     traceId?: string;
+    /** Deprecated. Use prompt_masks to read one or more mask overlays keyed by prompt id. */
     maskId?: string;
+    /** Mask overlays to apply during agent execution, keyed by prompt id. */
+    promptMasks?: Record<string, string>;
     blueprintName?: string;
     metadata?: LocalRunnerJobMetadata;
     timeout?: number;
@@ -5999,6 +6030,9 @@ interface PromptVersionDetail {
     template: string;
     metadata?: JsonNodeDetail;
     type?: PromptVersionDetailType;
+    /** version type discriminator; defaults to prompt_version */
+    versionType?: PromptVersionDetailVersionType;
+    environment?: string;
     changeDescription?: string;
     tags?: string[];
     variables?: string[];
@@ -6020,6 +6054,13 @@ declare const PromptVersionDetailType: {
 };
 type PromptVersionDetailType = (typeof PromptVersionDetailType)[keyof typeof PromptVersionDetailType];
 
+/** version type discriminator; defaults to prompt_version */
+declare const PromptVersionDetailVersionType: {
+    readonly PromptVersion: "prompt_version";
+    readonly Mask: "mask";
+};
+type PromptVersionDetailVersionType = (typeof PromptVersionDetailVersionType)[keyof typeof PromptVersionDetailVersionType];
+
 interface PromptVersionLink {
     id: string;
     commit?: string;
@@ -6055,6 +6096,9 @@ interface PromptVersionPublic {
     template: string;
     metadata?: JsonNodePublic;
     type?: PromptVersionPublicType;
+    /** version type discriminator; defaults to prompt_version */
+    versionType?: PromptVersionPublicVersionType;
+    environment?: string;
     changeDescription?: string;
     tags?: string[];
     templateStructure?: PromptVersionPublicTemplateStructure;
@@ -6075,6 +6119,13 @@ declare const PromptVersionPublicType: {
 };
 type PromptVersionPublicType = (typeof PromptVersionPublicType)[keyof typeof PromptVersionPublicType];
 
+/** version type discriminator; defaults to prompt_version */
+declare const PromptVersionPublicVersionType: {
+    readonly PromptVersion: "prompt_version";
+    readonly Mask: "mask";
+};
+type PromptVersionPublicVersionType = (typeof PromptVersionPublicVersionType)[keyof typeof PromptVersionPublicVersionType];
+
 /**
  * Update to apply to prompt versions.
  * Note: Prompt versions are immutable by design.
@@ -10233,12 +10284,13 @@ declare class PromptsClient {
     updatePromptVersions(request: PromptVersionBatchUpdate, requestOptions?: PromptsClient.RequestOptions): HttpResponsePromise<void>;
     private __updatePromptVersions;
     /**
-     * Get prompt by id
+     * Get prompt by id; when mask_id or environment is provided, requestedVersion is populated with the resolved version. mask_id and environment are mutually exclusive.
      *
      * @param {string} id
      * @param {OpikApi.GetPromptByIdRequest} request
      * @param {PromptsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link OpikApi.BadRequestError}
      * @throws {@link OpikApi.NotFoundError}
      *
      * @example
@@ -10378,6 +10430,40 @@ declare class PromptsClient {
      */
     retrievePromptVersion(request: PromptVersionRetrieveDetail, requestOptions?: PromptsClient.RequestOptions): HttpResponsePromise<PromptVersionDetail>;
     private __retrievePromptVersion;
+    /**
+     * Retrieve a batch of prompt versions by their ids. Typically used by the UI to resolve mask overlays.
+     *
+     * @param {OpikApi.PromptVersionIdsRequestDetail} request
+     * @param {PromptsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link OpikApi.BadRequestError}
+     *
+     * @example
+     *     await client.prompts.retrievePromptVersionsByIds({
+     *         ids: ["ids"]
+     *     })
+     */
+    retrievePromptVersionsByIds(request: PromptVersionIdsRequestDetail, requestOptions?: PromptsClient.RequestOptions): HttpResponsePromise<PromptVersionDetail[]>;
+    private __retrievePromptVersionsByIds;
+    /**
+     * Set or clear the environment owned by a prompt version.
+     * Setting a non-null environment moves ownership atomically: any previous owner of that
+     * environment for the same prompt has its environment cleared in the same transaction.
+     * Setting null clears the environment from the version.
+     * The environment must already exist in the workspace registry; unknown names return 404.
+     *
+     * @param {string} versionId
+     * @param {OpikApi.PromptVersionEnvironmentUpdate} request
+     * @param {PromptsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link OpikApi.BadRequestError}
+     * @throws {@link OpikApi.NotFoundError}
+     *
+     * @example
+     *     await client.prompts.setPromptVersionEnvironment("versionId")
+     */
+    setPromptVersionEnvironment(versionId: string, request?: PromptVersionEnvironmentUpdate, requestOptions?: PromptsClient.RequestOptions): HttpResponsePromise<void>;
+    private __setPromptVersionEnvironment;
 }
 
 declare namespace RedirectClient {

package/dist/index.d.ts

@@ -1915,7 +1915,12 @@ type GetPromptByCommitRequest = {};
  * @example
  *     {}
  */
-type GetPromptByIdRequest = {};
+interface GetPromptByIdRequest {
+    /** Optional mask version id; when set, requestedVersion is the mask row for that id */
+    maskId?: string;
+    /** Optional environment name; when set, requestedVersion is the version mapped to that environment for the prompt */
+    environment?: string;
+}
 
 /**
  * @example
@@ -1990,6 +1995,24 @@ interface PromptVersionCommitsRequestPublic {
     commits: string[];
 }
 
+/**
+ * @example
+ *     {}
+ */
+interface PromptVersionEnvironmentUpdate {
+    environment?: string;
+}
+
+/**
+ * @example
+ *     {
+ *         ids: ["ids"]
+ *     }
+ */
+interface PromptVersionIdsRequestDetail {
+    ids: string[];
+}
+
 /**
  * @example
  *     {
@@ -1999,6 +2022,8 @@ interface PromptVersionCommitsRequestPublic {
 interface PromptVersionRetrieveDetail {
     name: string;
     commit?: string;
+    /** If provided, resolves to the version mapped to this environment for the prompt; mutually exclusive with commit */
+    environment?: string;
     /** If provided, scopes the search to the specified project */
     projectName?: string;
 }
@@ -2219,7 +2244,10 @@ interface CreateLocalRunnerJobRequest {
     agentName: string;
     inputs?: JsonNode;
     projectId: string;
+    /** Deprecated. Use prompt_masks to pass one or more mask overlays keyed by prompt id. */
     maskId?: string;
+    /** Mask overlays to apply during agent execution, keyed by prompt id. */
+    promptMasks?: Record<string, string>;
     blueprintName?: string;
     metadata?: LocalRunnerJobMetadata;
 }
@@ -5457,7 +5485,10 @@ interface LocalRunnerJob {
     error?: string;
     projectId?: string;
     traceId?: string;
+    /** Deprecated. Use prompt_masks to read one or more mask overlays keyed by prompt id. */
     maskId?: string;
+    /** Mask overlays to apply during agent execution, keyed by prompt id. */
+    promptMasks?: Record<string, string>;
     blueprintName?: string;
     metadata?: LocalRunnerJobMetadata;
     timeout?: number;
@@ -5999,6 +6030,9 @@ interface PromptVersionDetail {
     template: string;
     metadata?: JsonNodeDetail;
     type?: PromptVersionDetailType;
+    /** version type discriminator; defaults to prompt_version */
+    versionType?: PromptVersionDetailVersionType;
+    environment?: string;
     changeDescription?: string;
     tags?: string[];
     variables?: string[];
@@ -6020,6 +6054,13 @@ declare const PromptVersionDetailType: {
 };
 type PromptVersionDetailType = (typeof PromptVersionDetailType)[keyof typeof PromptVersionDetailType];
 
+/** version type discriminator; defaults to prompt_version */
+declare const PromptVersionDetailVersionType: {
+    readonly PromptVersion: "prompt_version";
+    readonly Mask: "mask";
+};
+type PromptVersionDetailVersionType = (typeof PromptVersionDetailVersionType)[keyof typeof PromptVersionDetailVersionType];
+
 interface PromptVersionLink {
     id: string;
     commit?: string;
@@ -6055,6 +6096,9 @@ interface PromptVersionPublic {
     template: string;
     metadata?: JsonNodePublic;
     type?: PromptVersionPublicType;
+    /** version type discriminator; defaults to prompt_version */
+    versionType?: PromptVersionPublicVersionType;
+    environment?: string;
     changeDescription?: string;
     tags?: string[];
     templateStructure?: PromptVersionPublicTemplateStructure;
@@ -6075,6 +6119,13 @@ declare const PromptVersionPublicType: {
 };
 type PromptVersionPublicType = (typeof PromptVersionPublicType)[keyof typeof PromptVersionPublicType];
 
+/** version type discriminator; defaults to prompt_version */
+declare const PromptVersionPublicVersionType: {
+    readonly PromptVersion: "prompt_version";
+    readonly Mask: "mask";
+};
+type PromptVersionPublicVersionType = (typeof PromptVersionPublicVersionType)[keyof typeof PromptVersionPublicVersionType];
+
 /**
  * Update to apply to prompt versions.
  * Note: Prompt versions are immutable by design.
@@ -10233,12 +10284,13 @@ declare class PromptsClient {
     updatePromptVersions(request: PromptVersionBatchUpdate, requestOptions?: PromptsClient.RequestOptions): HttpResponsePromise<void>;
     private __updatePromptVersions;
     /**
-     * Get prompt by id
+     * Get prompt by id; when mask_id or environment is provided, requestedVersion is populated with the resolved version. mask_id and environment are mutually exclusive.
      *
      * @param {string} id
      * @param {OpikApi.GetPromptByIdRequest} request
      * @param {PromptsClient.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link OpikApi.BadRequestError}
      * @throws {@link OpikApi.NotFoundError}
      *
      * @example
@@ -10378,6 +10430,40 @@ declare class PromptsClient {
      */
     retrievePromptVersion(request: PromptVersionRetrieveDetail, requestOptions?: PromptsClient.RequestOptions): HttpResponsePromise<PromptVersionDetail>;
     private __retrievePromptVersion;
+    /**
+     * Retrieve a batch of prompt versions by their ids. Typically used by the UI to resolve mask overlays.
+     *
+     * @param {OpikApi.PromptVersionIdsRequestDetail} request
+     * @param {PromptsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link OpikApi.BadRequestError}
+     *
+     * @example
+     *     await client.prompts.retrievePromptVersionsByIds({
+     *         ids: ["ids"]
+     *     })
+     */
+    retrievePromptVersionsByIds(request: PromptVersionIdsRequestDetail, requestOptions?: PromptsClient.RequestOptions): HttpResponsePromise<PromptVersionDetail[]>;
+    private __retrievePromptVersionsByIds;
+    /**
+     * Set or clear the environment owned by a prompt version.
+     * Setting a non-null environment moves ownership atomically: any previous owner of that
+     * environment for the same prompt has its environment cleared in the same transaction.
+     * Setting null clears the environment from the version.
+     * The environment must already exist in the workspace registry; unknown names return 404.
+     *
+     * @param {string} versionId
+     * @param {OpikApi.PromptVersionEnvironmentUpdate} request
+     * @param {PromptsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link OpikApi.BadRequestError}
+     * @throws {@link OpikApi.NotFoundError}
+     *
+     * @example
+     *     await client.prompts.setPromptVersionEnvironment("versionId")
+     */
+    setPromptVersionEnvironment(versionId: string, request?: PromptVersionEnvironmentUpdate, requestOptions?: PromptsClient.RequestOptions): HttpResponsePromise<void>;
+    private __setPromptVersionEnvironment;
 }
 
 declare namespace RedirectClient {

package/dist/index.js

@@ -1 +1 @@
-import {Fa}from'./chunk-EHVVWQKE.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-EHVVWQKE.js';Fa();
+import {Fa}from'./chunk-SINZQROK.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-SINZQROK.js';Fa();

package/dist/{suite-QT7UL6WD.js → suite-7A4H75A5.js}

@@ -1 +1 @@
-import {za}from'./chunk-EHVVWQKE.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-EHVVWQKE.js';za();
+import {za}from'./chunk-SINZQROK.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-SINZQROK.js';za();

package/package.json

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