@arizeai/phoenix-client 7.14.0 → 7.16.0

package/dist/src/prompts/deletePromptVersionTag.d.ts

@@ -0,0 +1,36 @@
+import type { ClientFn } from "../types/core";
+import type { GetPromptByVersionSelector } from "../types/prompts";
+/**
+ * Parameters for deleting a prompt version tag.
+ */
+export interface DeletePromptVersionTagParams extends ClientFn {
+    /** A version belonging to the prompt that owns the tag. */
+    prompt: GetPromptByVersionSelector;
+    /** The prompt-scoped tag name to delete. */
+    name: string;
+}
+/**
+ * Delete a tag from the prompt that owns the given prompt version.
+ *
+ * Tag names are unique within a prompt, so `name` identifies the tag across
+ * all versions of that prompt. The tag does not need to be attached to the
+ * selected version.
+ *
+ * @param params - The prompt version tag to delete.
+ * @param params.prompt - A version selector used to identify the prompt.
+ * @param params.name - The prompt-scoped tag name to delete.
+ * @returns A promise that resolves once the tag has been deleted.
+ * @throws {@link HttpError} when Phoenix rejects the request.
+ *
+ * @example
+ * ```ts
+ * import { deletePromptVersionTag } from "@arizeai/phoenix-client/prompts";
+ *
+ * await deletePromptVersionTag({
+ *   prompt: { versionId: "UHJvbXB0VmVyc2lvbjox" },
+ *   name: "production",
+ * });
+ * ```
+ */
+export declare function deletePromptVersionTag({ client: _client, prompt, name, }: DeletePromptVersionTagParams): Promise<void>;
+//# sourceMappingURL=deletePromptVersionTag.d.ts.map

package/dist/src/prompts/deletePromptVersionTag.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deletePromptVersionTag.d.ts","sourceRoot":"","sources":["../../../src/prompts/deletePromptVersionTag.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAC9C,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,kBAAkB,CAAC;AAInE;;GAEG;AACH,MAAM,WAAW,4BAA6B,SAAQ,QAAQ;IAC5D,2DAA2D;IAC3D,MAAM,EAAE,0BAA0B,CAAC;IACnC,4CAA4C;IAC5C,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAsB,sBAAsB,CAAC,EAC3C,MAAM,EAAE,OAAO,EACf,MAAM,EACN,IAAI,GACL,EAAE,4BAA4B,GAAG,OAAO,CAAC,IAAI,CAAC,CAmB9C"}

package/dist/src/prompts/deletePromptVersionTag.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deletePromptVersionTag = deletePromptVersionTag;
+const client_1 = require("../client");
+const serverRequirements_1 = require("../constants/serverRequirements");
+const resolvePromptVersionId_1 = require("../utils/resolvePromptVersionId");
+const serverVersionUtils_1 = require("../utils/serverVersionUtils");
+/**
+ * Delete a tag from the prompt that owns the given prompt version.
+ *
+ * Tag names are unique within a prompt, so `name` identifies the tag across
+ * all versions of that prompt. The tag does not need to be attached to the
+ * selected version.
+ *
+ * @param params - The prompt version tag to delete.
+ * @param params.prompt - A version selector used to identify the prompt.
+ * @param params.name - The prompt-scoped tag name to delete.
+ * @returns A promise that resolves once the tag has been deleted.
+ * @throws {@link HttpError} when Phoenix rejects the request.
+ *
+ * @example
+ * ```ts
+ * import { deletePromptVersionTag } from "@arizeai/phoenix-client/prompts";
+ *
+ * await deletePromptVersionTag({
+ *   prompt: { versionId: "UHJvbXB0VmVyc2lvbjox" },
+ *   name: "production",
+ * });
+ * ```
+ */
+async function deletePromptVersionTag({ client: _client, prompt, name, }) {
+    const promptVersionId = (0, resolvePromptVersionId_1.resolvePromptVersionId)(prompt);
+    const client = _client !== null && _client !== void 0 ? _client : (0, client_1.createClient)();
+    await (0, serverVersionUtils_1.ensureServerCapability)({
+        client,
+        requirement: serverRequirements_1.DELETE_PROMPT_VERSION_TAG,
+    });
+    await client.DELETE("/v1/prompt_versions/{prompt_version_id}/tags/{tag_name}", {
+        params: {
+            path: {
+                prompt_version_id: promptVersionId,
+                tag_name: name,
+            },
+        },
+    });
+}
+//# sourceMappingURL=deletePromptVersionTag.js.map

package/dist/src/prompts/deletePromptVersionTag.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"deletePromptVersionTag.js","sourceRoot":"","sources":["../../../src/prompts/deletePromptVersionTag.ts"],"names":[],"mappings":";;;AAAA,sCAAyC;AACzC,wEAA4E;AAG5E,4EAAyE;AACzE,oEAAqE;AAYrE;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACI,KAAK,iCAAiC,EAC3C,MAAM,EAAE,OAAO,EACf,MAAM,EACN,IAAI,GACyB;IAC7B,MAAM,eAAe,GAAG,IAAA,+CAAsB,EAAC,MAAM,CAAC,CAAC;IACvD,MAAM,MAAM,GAAG,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,IAAA,qBAAY,GAAE,CAAC;IACzC,MAAM,IAAA,2CAAsB,EAAC;QAC3B,MAAM;QACN,WAAW,EAAE,8CAAyB;KACvC,CAAC,CAAC;IAEH,MAAM,MAAM,CAAC,MAAM,CACjB,yDAAyD,EACzD;QACE,MAAM,EAAE;YACN,IAAI,EAAE;gBACJ,iBAAiB,EAAE,eAAe;gBAClC,QAAQ,EAAE,IAAI;aACf;SACF;KACF,CACF,CAAC;AACJ,CAAC"}

package/dist/src/prompts/index.d.ts

@@ -1,7 +1,9 @@
 export * from "./getPrompt";
 export * from "./createPrompt";
 export * from "./deletePrompt";
+export * from "./deletePromptVersionTag";
 export * from "./listPrompts";
+export * from "./upsertPromptVersionTag";
 export * from "./updatePrompt";
 export * from "./sdks";
 //# sourceMappingURL=index.d.ts.map

package/dist/src/prompts/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/prompts/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,eAAe,CAAC;AAC9B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,QAAQ,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/prompts/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,0BAA0B,CAAC;AACzC,cAAc,eAAe,CAAC;AAC9B,cAAc,0BAA0B,CAAC;AACzC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,QAAQ,CAAC"}

package/dist/src/prompts/index.js

@@ -17,7 +17,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./getPrompt"), exports);
 __exportStar(require("./createPrompt"), exports);
 __exportStar(require("./deletePrompt"), exports);
+__exportStar(require("./deletePromptVersionTag"), exports);
 __exportStar(require("./listPrompts"), exports);
+__exportStar(require("./upsertPromptVersionTag"), exports);
 __exportStar(require("./updatePrompt"), exports);
 __exportStar(require("./sdks"), exports);
 //# sourceMappingURL=index.js.map

package/dist/src/prompts/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/prompts/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8CAA4B;AAC5B,iDAA+B;AAC/B,iDAA+B;AAC/B,gDAA8B;AAC9B,iDAA+B;AAC/B,yCAAuB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/prompts/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8CAA4B;AAC5B,iDAA+B;AAC/B,iDAA+B;AAC/B,2DAAyC;AACzC,gDAA8B;AAC9B,2DAAyC;AACzC,iDAA+B;AAC/B,yCAAuB"}

package/dist/src/prompts/upsertPromptVersionTag.d.ts

@@ -0,0 +1,40 @@
+import type { ClientFn } from "../types/core";
+import type { GetPromptByVersionSelector } from "../types/prompts";
+/**
+ * Parameters for creating or moving a prompt version tag.
+ */
+export interface UpsertPromptVersionTagParams extends ClientFn {
+    /** The prompt version that should own the tag. */
+    prompt: GetPromptByVersionSelector;
+    /** The prompt-scoped tag name. */
+    name: string;
+    /** An optional description for the tag. */
+    description?: string | null;
+}
+/**
+ * Create a prompt version tag or move an existing tag to another version.
+ *
+ * Tag names are unique within a prompt. If another version of the same prompt
+ * already has `name`, the tag is moved to the selected version and its
+ * description is updated.
+ *
+ * @param params - The prompt version tag to create or move.
+ * @param params.prompt - The target prompt, selected by version ID.
+ * @param params.name - The prompt-scoped tag name.
+ * @param params.description - An optional description for the tag.
+ * @returns A promise that resolves once the tag has been created or moved.
+ * @throws {@link HttpError} when Phoenix rejects the request.
+ *
+ * @example
+ * ```ts
+ * import { upsertPromptVersionTag } from "@arizeai/phoenix-client/prompts";
+ *
+ * await upsertPromptVersionTag({
+ *   prompt: { versionId: "UHJvbXB0VmVyc2lvbjox" },
+ *   name: "production",
+ *   description: "Currently deployed version",
+ * });
+ * ```
+ */
+export declare function upsertPromptVersionTag({ client: _client, prompt, name, description, }: UpsertPromptVersionTagParams): Promise<void>;
+//# sourceMappingURL=upsertPromptVersionTag.d.ts.map

package/dist/src/prompts/upsertPromptVersionTag.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"upsertPromptVersionTag.d.ts","sourceRoot":"","sources":["../../../src/prompts/upsertPromptVersionTag.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAC9C,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,kBAAkB,CAAC;AAInE;;GAEG;AACH,MAAM,WAAW,4BAA6B,SAAQ,QAAQ;IAC5D,kDAAkD;IAClD,MAAM,EAAE,0BAA0B,CAAC;IACnC,kCAAkC;IAClC,IAAI,EAAE,MAAM,CAAC;IACb,2CAA2C;IAC3C,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAsB,sBAAsB,CAAC,EAC3C,MAAM,EAAE,OAAO,EACf,MAAM,EACN,IAAI,EACJ,WAAW,GACZ,EAAE,4BAA4B,GAAG,OAAO,CAAC,IAAI,CAAC,CAmB9C"}

package/dist/src/prompts/upsertPromptVersionTag.js

@@ -0,0 +1,52 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.upsertPromptVersionTag = upsertPromptVersionTag;
+const client_1 = require("../client");
+const serverRequirements_1 = require("../constants/serverRequirements");
+const resolvePromptVersionId_1 = require("../utils/resolvePromptVersionId");
+const serverVersionUtils_1 = require("../utils/serverVersionUtils");
+/**
+ * Create a prompt version tag or move an existing tag to another version.
+ *
+ * Tag names are unique within a prompt. If another version of the same prompt
+ * already has `name`, the tag is moved to the selected version and its
+ * description is updated.
+ *
+ * @param params - The prompt version tag to create or move.
+ * @param params.prompt - The target prompt, selected by version ID.
+ * @param params.name - The prompt-scoped tag name.
+ * @param params.description - An optional description for the tag.
+ * @returns A promise that resolves once the tag has been created or moved.
+ * @throws {@link HttpError} when Phoenix rejects the request.
+ *
+ * @example
+ * ```ts
+ * import { upsertPromptVersionTag } from "@arizeai/phoenix-client/prompts";
+ *
+ * await upsertPromptVersionTag({
+ *   prompt: { versionId: "UHJvbXB0VmVyc2lvbjox" },
+ *   name: "production",
+ *   description: "Currently deployed version",
+ * });
+ * ```
+ */
+async function upsertPromptVersionTag({ client: _client, prompt, name, description, }) {
+    const promptVersionId = (0, resolvePromptVersionId_1.resolvePromptVersionId)(prompt);
+    const client = _client !== null && _client !== void 0 ? _client : (0, client_1.createClient)();
+    await (0, serverVersionUtils_1.ensureServerCapability)({
+        client,
+        requirement: serverRequirements_1.UPSERT_PROMPT_VERSION_TAG,
+    });
+    await client.POST("/v1/prompt_versions/{prompt_version_id}/tags", {
+        params: {
+            path: {
+                prompt_version_id: promptVersionId,
+            },
+        },
+        body: {
+            name,
+            description,
+        },
+    });
+}
+//# sourceMappingURL=upsertPromptVersionTag.js.map

package/dist/src/prompts/upsertPromptVersionTag.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"upsertPromptVersionTag.js","sourceRoot":"","sources":["../../../src/prompts/upsertPromptVersionTag.ts"],"names":[],"mappings":";;;AAAA,sCAAyC;AACzC,wEAA4E;AAG5E,4EAAyE;AACzE,oEAAqE;AAcrE;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACI,KAAK,iCAAiC,EAC3C,MAAM,EAAE,OAAO,EACf,MAAM,EACN,IAAI,EACJ,WAAW,GACkB;IAC7B,MAAM,eAAe,GAAG,IAAA,+CAAsB,EAAC,MAAM,CAAC,CAAC;IACvD,MAAM,MAAM,GAAG,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,IAAA,qBAAY,GAAE,CAAC;IACzC,MAAM,IAAA,2CAAsB,EAAC;QAC3B,MAAM;QACN,WAAW,EAAE,8CAAyB;KACvC,CAAC,CAAC;IAEH,MAAM,MAAM,CAAC,IAAI,CAAC,8CAA8C,EAAE;QAChE,MAAM,EAAE;YACN,IAAI,EAAE;gBACJ,iBAAiB,EAAE,eAAe;aACnC;SACF;QACD,IAAI,EAAE;YACJ,IAAI;YACJ,WAAW;SACZ;KACF,CAAC,CAAC;AACL,CAAC"}

package/dist/src/types/annotationConfigs.d.ts

@@ -0,0 +1,35 @@
+import type { components } from "../__generated__/api/v1";
+/**
+ * An annotation configuration as returned by the Phoenix REST API.
+ */
+export type AnnotationConfig = components["schemas"]["CategoricalAnnotationConfig"] | components["schemas"]["ContinuousAnnotationConfig"] | components["schemas"]["FreeformAnnotationConfig"];
+/**
+ * Identifies an annotation configuration. Accepts any of:
+ * - `config` — an annotation config ID or name (the server accepts either)
+ * - `configId` — an explicit annotation config ID
+ * - `configName` — an explicit annotation config name
+ *
+ * Exactly one of these may be given. All three are sent to the server as the
+ * same `config_identifier`, which is tried as a GlobalID before a name. Prefer
+ * `configId` when a name may contain `/`, which the server cannot route in a
+ * path parameter.
+ */
+export type AnnotationConfigIdentifier = {
+    config: string;
+    configId?: never;
+    configName?: never;
+} | {
+    configId: string;
+    config?: never;
+    configName?: never;
+} | {
+    configName: string;
+    config?: never;
+    configId?: never;
+};
+/**
+ * Resolves an {@link AnnotationConfigIdentifier} union to a plain string
+ * suitable for the REST `config_identifier` path parameter.
+ */
+export declare function resolveAnnotationConfigIdentifier(identifier: AnnotationConfigIdentifier): string;
+//# sourceMappingURL=annotationConfigs.d.ts.map

package/dist/src/types/annotationConfigs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"annotationConfigs.d.ts","sourceRoot":"","sources":["../../../src/types/annotationConfigs.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAE1D;;GAEG;AACH,MAAM,MAAM,gBAAgB,GACxB,UAAU,CAAC,SAAS,CAAC,CAAC,6BAA6B,CAAC,GACpD,UAAU,CAAC,SAAS,CAAC,CAAC,4BAA4B,CAAC,GACnD,UAAU,CAAC,SAAS,CAAC,CAAC,0BAA0B,CAAC,CAAC;AAEtD;;;;;;;;;;GAUG;AACH,MAAM,MAAM,0BAA0B,GAClC;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,KAAK,CAAC;IAAC,UAAU,CAAC,EAAE,KAAK,CAAA;CAAE,GACxD;IAAE,QAAQ,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,KAAK,CAAC;IAAC,UAAU,CAAC,EAAE,KAAK,CAAA;CAAE,GACxD;IAAE,UAAU,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,KAAK,CAAC;IAAC,QAAQ,CAAC,EAAE,KAAK,CAAA;CAAE,CAAC;AAE7D;;;GAGG;AACH,wBAAgB,iCAAiC,CAC/C,UAAU,EAAE,0BAA0B,GACrC,MAAM,CAIR"}

package/dist/src/types/annotationConfigs.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.resolveAnnotationConfigIdentifier = resolveAnnotationConfigIdentifier;
+/**
+ * Resolves an {@link AnnotationConfigIdentifier} union to a plain string
+ * suitable for the REST `config_identifier` path parameter.
+ */
+function resolveAnnotationConfigIdentifier(identifier) {
+    if (identifier.config !== undefined)
+        return identifier.config;
+    if (identifier.configId !== undefined)
+        return identifier.configId;
+    return identifier.configName;
+}
+//# sourceMappingURL=annotationConfigs.js.map

package/dist/src/types/annotationConfigs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"annotationConfigs.js","sourceRoot":"","sources":["../../../src/types/annotationConfigs.ts"],"names":[],"mappings":";;;AA0BA;;;GAGG;AACH,2CACE,UAAsC;IAEtC,IAAI,UAAU,CAAC,MAAM,KAAK,SAAS;QAAE,OAAO,UAAU,CAAC,MAAM,CAAC;IAC9D,IAAI,UAAU,CAAC,QAAQ,KAAK,SAAS;QAAE,OAAO,UAAU,CAAC,QAAQ,CAAC;IAClE,OAAO,UAAU,CAAC,UAAU,CAAC;AAC/B,CAAC"}

package/dist/src/utils/resolvePromptVersionId.d.ts

@@ -0,0 +1,11 @@
+import type { GetPromptByVersionSelector } from "../types/prompts";
+/**
+ * Resolve a version selector to the `{prompt_version_id}` path segment used by
+ * the Phoenix REST API.
+ *
+ * @param prompt - The prompt, selected by version ID.
+ * @returns The prompt version ID to interpolate into the request path.
+ * @throws An error if the selector does not contain a non-empty version ID.
+ */
+export declare function resolvePromptVersionId(prompt: GetPromptByVersionSelector): string;
+//# sourceMappingURL=resolvePromptVersionId.d.ts.map

package/dist/src/utils/resolvePromptVersionId.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"resolvePromptVersionId.d.ts","sourceRoot":"","sources":["../../../src/utils/resolvePromptVersionId.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,kBAAkB,CAAC;AAEnE;;;;;;;GAOG;AACH,wBAAgB,sBAAsB,CACpC,MAAM,EAAE,0BAA0B,GACjC,MAAM,CAKR"}

package/dist/src/utils/resolvePromptVersionId.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.resolvePromptVersionId = resolvePromptVersionId;
+/**
+ * Resolve a version selector to the `{prompt_version_id}` path segment used by
+ * the Phoenix REST API.
+ *
+ * @param prompt - The prompt, selected by version ID.
+ * @returns The prompt version ID to interpolate into the request path.
+ * @throws An error if the selector does not contain a non-empty version ID.
+ */
+function resolvePromptVersionId(prompt) {
+    if (!prompt.versionId) {
+        throw new Error("versionId must be a non-empty prompt version id.");
+    }
+    return prompt.versionId;
+}
+//# sourceMappingURL=resolvePromptVersionId.js.map

package/dist/src/utils/resolvePromptVersionId.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resolvePromptVersionId.js","sourceRoot":"","sources":["../../../src/utils/resolvePromptVersionId.ts"],"names":[],"mappings":";;;AAEA;;;;;;;GAOG;AACH,gCACE,MAAkC;IAElC,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC;QACtB,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;IACtE,CAAC;IACD,OAAO,MAAM,CAAC,SAAS,CAAC;AAC1B,CAAC"}