@arizeai/phoenix-client 7.14.0 → 7.16.0

package/dist/esm/prompts/deletePromptVersionTag.js

@@ -0,0 +1,44 @@
+import { createClient } from "../client.js";
+import { DELETE_PROMPT_VERSION_TAG } from "../constants/serverRequirements.js";
+import { resolvePromptVersionId } from "../utils/resolvePromptVersionId.js";
+import { ensureServerCapability } from "../utils/serverVersionUtils.js";
+/**
+ * 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 async function deletePromptVersionTag({ client: _client, prompt, name, }) {
+    const promptVersionId = resolvePromptVersionId(prompt);
+    const client = _client ?? createClient();
+    await ensureServerCapability({
+        client,
+        requirement: 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/esm/prompts/deletePromptVersionTag.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"deletePromptVersionTag.js","sourceRoot":"","sources":["../../../src/prompts/deletePromptVersionTag.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AACzC,OAAO,EAAE,yBAAyB,EAAE,MAAM,iCAAiC,CAAC;AAG5E,OAAO,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AACzE,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AAYrE;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAAC,EAC3C,MAAM,EAAE,OAAO,EACf,MAAM,EACN,IAAI,GACyB;IAC7B,MAAM,eAAe,GAAG,sBAAsB,CAAC,MAAM,CAAC,CAAC;IACvD,MAAM,MAAM,GAAG,OAAO,IAAI,YAAY,EAAE,CAAC;IACzC,MAAM,sBAAsB,CAAC;QAC3B,MAAM;QACN,WAAW,EAAE,yBAAyB;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/esm/prompts/index.d.ts

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

package/dist/esm/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/esm/prompts/index.js

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

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","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.js","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/esm/prompts/upsertPromptVersionTag.d.ts

@@ -0,0 +1,40 @@
+import type { ClientFn } from "../types/core.js";
+import type { GetPromptByVersionSelector } from "../types/prompts.js";
+/**
+ * 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/esm/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/esm/prompts/upsertPromptVersionTag.js

@@ -0,0 +1,49 @@
+import { createClient } from "../client.js";
+import { UPSERT_PROMPT_VERSION_TAG } from "../constants/serverRequirements.js";
+import { resolvePromptVersionId } from "../utils/resolvePromptVersionId.js";
+import { ensureServerCapability } from "../utils/serverVersionUtils.js";
+/**
+ * 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 async function upsertPromptVersionTag({ client: _client, prompt, name, description, }) {
+    const promptVersionId = resolvePromptVersionId(prompt);
+    const client = _client ?? createClient();
+    await ensureServerCapability({
+        client,
+        requirement: 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/esm/prompts/upsertPromptVersionTag.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"upsertPromptVersionTag.js","sourceRoot":"","sources":["../../../src/prompts/upsertPromptVersionTag.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AACzC,OAAO,EAAE,yBAAyB,EAAE,MAAM,iCAAiC,CAAC;AAG5E,OAAO,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AACzE,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AAcrE;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,CAAC,KAAK,UAAU,sBAAsB,CAAC,EAC3C,MAAM,EAAE,OAAO,EACf,MAAM,EACN,IAAI,EACJ,WAAW,GACkB;IAC7B,MAAM,eAAe,GAAG,sBAAsB,CAAC,MAAM,CAAC,CAAC;IACvD,MAAM,MAAM,GAAG,OAAO,IAAI,YAAY,EAAE,CAAC;IACzC,MAAM,sBAAsB,CAAC;QAC3B,MAAM;QACN,WAAW,EAAE,yBAAyB;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"}