@arizeai/phoenix-client 7.5.0 → 7.6.0

package/dist/esm/types/prompts.d.ts

@@ -44,6 +44,15 @@ export interface GetPromptByTagSelector {
  * Can be a prompt id, a prompt name, a prompt version id, or a prompt name + tag.
  */
 export type PromptSelector = GetPromptByIdSelector | GetPromptByNameSelector | GetPromptByVersionSelector | GetPromptByTagSelector;
+/**
+ * A selector for a prompt as a whole, rather than for one of its versions.
+ *
+ * Narrower than {@link PromptSelector}: a version id or a name + tag picks out a
+ * single version, which is not what operations on the prompt itself act on. Use
+ * this wherever the API needs the `{prompt_identifier}` path segment — the name
+ * and the prompt id are the two things the Phoenix REST API accepts there.
+ */
+export type PromptIdentifier = GetPromptByIdSelector | GetPromptByNameSelector;
 /**
  * The prompt data needed to create a prompt.
  */

package/dist/esm/types/prompts.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"prompts.d.ts","sourceRoot":"","sources":["../../../src/types/prompts.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAE1D;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAC3B,QAAQ,GACR,cAAc,GACd,WAAW,GACX,QAAQ,GACR,UAAU,GACV,KAAK,GACL,QAAQ,GACR,KAAK,GACL,UAAU,GACV,WAAW,GACX,MAAM,GACN,UAAU,GACV,YAAY,CAAC;AAEjB;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAC1B,SAAS,GACT,cAAc,GACd,QAAQ,GACR,WAAW,GACX,WAAW,CAAC;AAEhB;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,MAAM,GAAG,QAAQ,GAAG,IAAI,GAAG,MAAM,CAAC;AAEtE;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;;GAIG;AACH,MAAM,MAAM,cAAc,GACtB,qBAAqB,GACrB,uBAAuB,GACvB,0BAA0B,GAC1B,sBAAsB,CAAC;AAE3B;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,YAAY,CAAC,CAAC;AAE7D;;;;GAIG;AACH,MAAM,MAAM,aAAa,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,eAAe,CAAC,CAAC;AAEnE;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,mBAAmB,CAAC,CAAC;AAE3E;;GAEG;AACH,MAAM,MAAM,0BAA0B,GACpC,UAAU,CAAC,SAAS,CAAC,CAAC,yCAAyC,CAAC,CAAC;AAEnE;;GAEG;AACH,MAAM,MAAM,+BAA+B,GACzC,UAAU,CAAC,SAAS,CAAC,CAAC,8CAA8C,CAAC,CAAC;AAExE;;GAEG;AACH,MAAM,MAAM,6BAA6B,GACvC,UAAU,CAAC,SAAS,CAAC,CAAC,4CAA4C,CAAC,CAAC;AAEtE;;GAEG;AACH,MAAM,MAAM,0BAA0B,GACpC,UAAU,CAAC,SAAS,CAAC,CAAC,yCAAyC,CAAC,CAAC;AAEnE;;GAEG;AACH,MAAM,MAAM,4BAA4B,GACtC,UAAU,CAAC,SAAS,CAAC,CAAC,2CAA2C,CAAC,CAAC;AAErE;;GAEG;AACH,MAAM,MAAM,uBAAuB,GACjC,UAAU,CAAC,SAAS,CAAC,CAAC,sCAAsC,CAAC,CAAC;AAEhE;;GAEG;AACH,MAAM,MAAM,0BAA0B,GACpC,UAAU,CAAC,SAAS,CAAC,CAAC,yCAAyC,CAAC,CAAC;AAEnE;;GAEG;AACH,MAAM,MAAM,uBAAuB,GACjC,UAAU,CAAC,SAAS,CAAC,CAAC,sCAAsC,CAAC,CAAC;AAEhE;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,aAAa,CAAC,iBAAiB,CAAC,CAAC;AAEpE;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,OAAO,CACrC,aAAa,CAAC,UAAU,CAAC,EACzB;IAAE,QAAQ,EAAE,OAAO,EAAE,CAAA;CAAE,CACxB,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,CAAC;AAEtB;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAC7B,UAAU,CAAC,SAAS,CAAC,CAAC,iBAAiB,CAAC,GACxC,UAAU,CAAC,SAAS,CAAC,CAAC,qBAAqB,CAAC,GAC5C,UAAU,CAAC,SAAS,CAAC,CAAC,uBAAuB,CAAC,CAAC;AAEnD,MAAM,MAAM,kBAAkB,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,oBAAoB,CAAC,CAAC;AAC7E,MAAM,MAAM,aAAa,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,eAAe,CAAC,CAAC;AAEnE;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC;AAE/E,wBAAgB,eAAe,CAAC,IAAI,EAAE,UAAU,GAAG,IAAI,IAAI,aAAa,CAEvE;AAED,wBAAgB,oBAAoB,CAClC,IAAI,EAAE,UAAU,GACf,IAAI,IAAI,kBAAkB,CAE5B;AAED;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,WAAW,CACxC,UAAU,CAAC,SAAS,CAAC,CAAC,aAAa,CAAC,CAAC,aAAa,CAAC,CACpD,CAAC;AACF;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAC9B,UAAU,CAAC,SAAS,CAAC,CAAC,gCAAgC,CAAC,CAAC;AAE1D;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC,CAAC"}
+{"version":3,"file":"prompts.d.ts","sourceRoot":"","sources":["../../../src/types/prompts.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAE1D;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAC3B,QAAQ,GACR,cAAc,GACd,WAAW,GACX,QAAQ,GACR,UAAU,GACV,KAAK,GACL,QAAQ,GACR,KAAK,GACL,UAAU,GACV,WAAW,GACX,MAAM,GACN,UAAU,GACV,YAAY,CAAC;AAEjB;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAC1B,SAAS,GACT,cAAc,GACd,QAAQ,GACR,WAAW,GACX,WAAW,CAAC;AAEhB;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,MAAM,GAAG,QAAQ,GAAG,IAAI,GAAG,MAAM,CAAC;AAEtE;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;;GAIG;AACH,MAAM,MAAM,cAAc,GACtB,qBAAqB,GACrB,uBAAuB,GACvB,0BAA0B,GAC1B,sBAAsB,CAAC;AAE3B;;;;;;;GAOG;AACH,MAAM,MAAM,gBAAgB,GAAG,qBAAqB,GAAG,uBAAuB,CAAC;AAE/E;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,YAAY,CAAC,CAAC;AAE7D;;;;GAIG;AACH,MAAM,MAAM,aAAa,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,eAAe,CAAC,CAAC;AAEnE;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,mBAAmB,CAAC,CAAC;AAE3E;;GAEG;AACH,MAAM,MAAM,0BAA0B,GACpC,UAAU,CAAC,SAAS,CAAC,CAAC,yCAAyC,CAAC,CAAC;AAEnE;;GAEG;AACH,MAAM,MAAM,+BAA+B,GACzC,UAAU,CAAC,SAAS,CAAC,CAAC,8CAA8C,CAAC,CAAC;AAExE;;GAEG;AACH,MAAM,MAAM,6BAA6B,GACvC,UAAU,CAAC,SAAS,CAAC,CAAC,4CAA4C,CAAC,CAAC;AAEtE;;GAEG;AACH,MAAM,MAAM,0BAA0B,GACpC,UAAU,CAAC,SAAS,CAAC,CAAC,yCAAyC,CAAC,CAAC;AAEnE;;GAEG;AACH,MAAM,MAAM,4BAA4B,GACtC,UAAU,CAAC,SAAS,CAAC,CAAC,2CAA2C,CAAC,CAAC;AAErE;;GAEG;AACH,MAAM,MAAM,uBAAuB,GACjC,UAAU,CAAC,SAAS,CAAC,CAAC,sCAAsC,CAAC,CAAC;AAEhE;;GAEG;AACH,MAAM,MAAM,0BAA0B,GACpC,UAAU,CAAC,SAAS,CAAC,CAAC,yCAAyC,CAAC,CAAC;AAEnE;;GAEG;AACH,MAAM,MAAM,uBAAuB,GACjC,UAAU,CAAC,SAAS,CAAC,CAAC,sCAAsC,CAAC,CAAC;AAEhE;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,aAAa,CAAC,iBAAiB,CAAC,CAAC;AAEpE;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,OAAO,CACrC,aAAa,CAAC,UAAU,CAAC,EACzB;IAAE,QAAQ,EAAE,OAAO,EAAE,CAAA;CAAE,CACxB,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,CAAC;AAEtB;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAC7B,UAAU,CAAC,SAAS,CAAC,CAAC,iBAAiB,CAAC,GACxC,UAAU,CAAC,SAAS,CAAC,CAAC,qBAAqB,CAAC,GAC5C,UAAU,CAAC,SAAS,CAAC,CAAC,uBAAuB,CAAC,CAAC;AAEnD,MAAM,MAAM,kBAAkB,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,oBAAoB,CAAC,CAAC;AAC7E,MAAM,MAAM,aAAa,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,eAAe,CAAC,CAAC;AAEnE;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC;AAE/E,wBAAgB,eAAe,CAAC,IAAI,EAAE,UAAU,GAAG,IAAI,IAAI,aAAa,CAEvE;AAED,wBAAgB,oBAAoB,CAClC,IAAI,EAAE,UAAU,GACf,IAAI,IAAI,kBAAkB,CAE5B;AAED;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,WAAW,CACxC,UAAU,CAAC,SAAS,CAAC,CAAC,aAAa,CAAC,CAAC,aAAa,CAAC,CACpD,CAAC;AACF;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAC9B,UAAU,CAAC,SAAS,CAAC,CAAC,gCAAgC,CAAC,CAAC;AAE1D;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC,CAAC"}

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

@@ -1 +1 @@
-{"version":3,"file":"prompts.js","sourceRoot":"","sources":["../../../src/types/prompts.ts"],"names":[],"mappings":"AA2KA,MAAM,UAAU,eAAe,CAAC,IAAgB;IAC9C,OAAO,IAAI,CAAC,IAAI,KAAK,KAAK,CAAC;AAC7B,CAAC;AAED,MAAM,UAAU,oBAAoB,CAClC,IAAgB;IAEhB,OAAO,IAAI,CAAC,IAAI,KAAK,UAAU,CAAC;AAClC,CAAC"}
+{"version":3,"file":"prompts.js","sourceRoot":"","sources":["../../../src/types/prompts.ts"],"names":[],"mappings":"AAqLA,MAAM,UAAU,eAAe,CAAC,IAAgB;IAC9C,OAAO,IAAI,CAAC,IAAI,KAAK,KAAK,CAAC;AAC7B,CAAC;AAED,MAAM,UAAU,oBAAoB,CAClC,IAAgB;IAEhB,OAAO,IAAI,CAAC,IAAI,KAAK,UAAU,CAAC;AAClC,CAAC"}

package/dist/esm/utils/resolvePromptIdentifier.d.ts

@@ -0,0 +1,17 @@
+import type { PromptIdentifier } from "../types/prompts.js";
+/**
+ * Resolve a prompt-level selector to the `{prompt_identifier}` path segment the
+ * Phoenix REST API expects.
+ *
+ * Version-level selectors are rejected rather than silently widened: structural
+ * typing lets a `{ name, tag }` or `{ versionId }` value reach a
+ * {@link PromptIdentifier} parameter, and quietly dropping the version would
+ * point the caller at the whole prompt instead of the version they named.
+ *
+ * @param prompt - the prompt, selected by `name` or by `promptId`
+ * @returns The identifier to interpolate into the request path.
+ * @throws An error if the selector is empty, or selects a version rather than a
+ * prompt.
+ */
+export declare function resolvePromptIdentifier(prompt: PromptIdentifier): string;
+//# sourceMappingURL=resolvePromptIdentifier.d.ts.map

package/dist/esm/utils/resolvePromptIdentifier.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"resolvePromptIdentifier.d.ts","sourceRoot":"","sources":["../../../src/utils/resolvePromptIdentifier.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAEzD;;;;;;;;;;;;;GAaG;AACH,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,gBAAgB,GAAG,MAAM,CAwBxE"}

package/dist/esm/utils/resolvePromptIdentifier.js

@@ -0,0 +1,36 @@
+/**
+ * Resolve a prompt-level selector to the `{prompt_identifier}` path segment the
+ * Phoenix REST API expects.
+ *
+ * Version-level selectors are rejected rather than silently widened: structural
+ * typing lets a `{ name, tag }` or `{ versionId }` value reach a
+ * {@link PromptIdentifier} parameter, and quietly dropping the version would
+ * point the caller at the whole prompt instead of the version they named.
+ *
+ * @param prompt - the prompt, selected by `name` or by `promptId`
+ * @returns The identifier to interpolate into the request path.
+ * @throws An error if the selector is empty, or selects a version rather than a
+ * prompt.
+ */
+export function resolvePromptIdentifier(prompt) {
+    if ("versionId" in prompt) {
+        throw new Error("A prompt version id selects a single version, not a prompt. Select the prompt by name or promptId.");
+    }
+    if ("tag" in prompt) {
+        throw new Error("A tag selects a single version, not a prompt. Select the prompt by name or promptId.");
+    }
+    if ("promptId" in prompt) {
+        if (!prompt.promptId) {
+            throw new Error("promptId must be a non-empty prompt id.");
+        }
+        return prompt.promptId;
+    }
+    if ("name" in prompt) {
+        if (!prompt.name) {
+            throw new Error("name must be a non-empty prompt name.");
+        }
+        return prompt.name;
+    }
+    throw new Error("A prompt must be selected by either name or promptId.");
+}
+//# sourceMappingURL=resolvePromptIdentifier.js.map

package/dist/esm/utils/resolvePromptIdentifier.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resolvePromptIdentifier.js","sourceRoot":"","sources":["../../../src/utils/resolvePromptIdentifier.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,uBAAuB,CAAC,MAAwB;IAC9D,IAAI,WAAW,IAAI,MAAM,EAAE,CAAC;QAC1B,MAAM,IAAI,KAAK,CACb,oGAAoG,CACrG,CAAC;IACJ,CAAC;IACD,IAAI,KAAK,IAAI,MAAM,EAAE,CAAC;QACpB,MAAM,IAAI,KAAK,CACb,sFAAsF,CACvF,CAAC;IACJ,CAAC;IACD,IAAI,UAAU,IAAI,MAAM,EAAE,CAAC;QACzB,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;YACrB,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;QAC7D,CAAC;QACD,OAAO,MAAM,CAAC,QAAQ,CAAC;IACzB,CAAC;IACD,IAAI,MAAM,IAAI,MAAM,EAAE,CAAC;QACrB,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;QAC3D,CAAC;QACD,OAAO,MAAM,CAAC,IAAI,CAAC;IACrB,CAAC;IACD,MAAM,IAAI,KAAK,CAAC,uDAAuD,CAAC,CAAC;AAC3E,CAAC"}