@arizeai/phoenix-client 0.0.1 → 1.0.0

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

@@ -0,0 +1,29 @@
+import { PromptSelector } from "../types/prompts";
+import { ClientFn } from "../types/core";
+/**
+ * Parameters for the getPromptBySelector function
+ */
+export type GetPromptBySelectorParams = ClientFn & {
+    prompt: PromptSelector;
+};
+/**
+ * Get a prompt from the Phoenix API.
+ *
+ * if the input is a prompt id, fetch the latest prompt version from the client.
+ * if the input is a prompt version id, fetch that prompt version.
+ * if the input is a prompt tag and name, fetch the prompt version that has that tag and name.
+ * if the input is a prompt name, fetch the latest prompt version from the client.
+ */
+export declare function getPromptBySelector({ client: _client, prompt, }: GetPromptBySelectorParams): Promise<{
+    description?: string | null;
+    model_provider: import("../__generated__/api/v1").components["schemas"]["ModelProvider"];
+    model_name: string;
+    template: import("../__generated__/api/v1").components["schemas"]["PromptChatTemplate"] | import("../__generated__/api/v1").components["schemas"]["PromptStringTemplate"];
+    template_type: import("../__generated__/api/v1").components["schemas"]["PromptTemplateType"];
+    template_format: import("../__generated__/api/v1").components["schemas"]["PromptTemplateFormat"];
+    invocation_parameters: import("../__generated__/api/v1").components["schemas"]["PromptOpenAIInvocationParameters"] | import("../__generated__/api/v1").components["schemas"]["PromptAzureOpenAIInvocationParameters"] | import("../__generated__/api/v1").components["schemas"]["PromptAnthropicInvocationParameters"] | import("../__generated__/api/v1").components["schemas"]["PromptGoogleInvocationParameters"];
+    tools?: import("../__generated__/api/v1").components["schemas"]["PromptTools"] | null;
+    response_format?: import("../__generated__/api/v1").components["schemas"]["PromptResponseFormatJSONSchema"] | null;
+    id: string;
+} | null>;
+//# sourceMappingURL=getPromptVersionLike.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"getPromptVersionLike.d.ts","sourceRoot":"","sources":["../../../src/utils/getPromptVersionLike.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAGzC;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG,QAAQ,GAAG;IACjD,MAAM,EAAE,cAAc,CAAC;CACxB,CAAC;AAEF;;;;;;;GAOG;AACH,wBAAsB,mBAAmB,CAAC,EACxC,MAAM,EAAE,OAAO,EACf,MAAM,GACP,EAAE,yBAAyB;;oBAkDmxsB,uDAAsB;;cAAkI,uDAAsB,yBAAwB,uDAAsB;mBAAoD,uDAAsB;qBAAoD,uDAAsB;2BAAqG,uDAAsB,uCAAsC,uDAAsB,4CAA2C,uDAAsB,0CAAyC,uDAAsB;YAAyD,uDAAsB;sBAAwF,uDAAsB;;UADlpuB"}

package/dist/src/utils/getPromptVersionLike.js

@@ -0,0 +1,68 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPromptBySelector = getPromptBySelector;
+const tiny_invariant_1 = __importDefault(require("tiny-invariant"));
+const client_1 = require("../client");
+/**
+ * Get a prompt from the Phoenix API.
+ *
+ * if the input is a prompt id, fetch the latest prompt version from the client.
+ * if the input is a prompt version id, fetch that prompt version.
+ * if the input is a prompt tag and name, fetch the prompt version that has that tag and name.
+ * if the input is a prompt name, fetch the latest prompt version from the client.
+ */
+function getPromptBySelector(_a) {
+    return __awaiter(this, arguments, void 0, function* ({ client: _client, prompt, }) {
+        var _b, _c, _d;
+        try {
+            const client = _client !== null && _client !== void 0 ? _client : (0, client_1.createClient)();
+            if ("promptId" in prompt) {
+                throw new Error("Prompt by id not implemented");
+            }
+            if ("versionId" in prompt) {
+                const response = yield client.GET(`/v1/prompt_versions/{prompt_version_id}`, {
+                    params: { path: { prompt_version_id: prompt.versionId } },
+                });
+                (0, tiny_invariant_1.default)((_b = response.data) === null || _b === void 0 ? void 0 : _b.data, `Prompt version ${prompt.versionId} not found`);
+                return response.data.data;
+            }
+            if ("tag" in prompt && "name" in prompt) {
+                const response = yield client.GET(`/v1/prompts/{prompt_identifier}/tags/{tag_name}`, {
+                    params: {
+                        path: { prompt_identifier: prompt.name, tag_name: prompt.tag },
+                    },
+                });
+                (0, tiny_invariant_1.default)((_c = response.data) === null || _c === void 0 ? void 0 : _c.data, `Prompt tag ${prompt.tag} not found`);
+                return response.data.data;
+            }
+            if ("name" in prompt) {
+                const response = yield client.GET(`/v1/prompts/{prompt_identifier}/latest`, {
+                    params: {
+                        path: { prompt_identifier: prompt.name },
+                    },
+                });
+                (0, tiny_invariant_1.default)((_d = response.data) === null || _d === void 0 ? void 0 : _d.data, `Prompt ${prompt.name} not found`);
+                return response.data.data;
+            }
+            throw new Error("Invalid prompt");
+        }
+        catch (error) {
+            // eslint-disable-next-line no-console
+            console.error(error);
+            return null;
+        }
+    });
+}
+//# sourceMappingURL=getPromptVersionLike.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"getPromptVersionLike.js","sourceRoot":"","sources":["../../../src/utils/getPromptVersionLike.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAoBA,kDAoDC;AAxED,oEAAuC;AAGvC,sCAAyC;AASzC;;;;;;;GAOG;AACH,SAAsB,mBAAmB;yDAAC,EACxC,MAAM,EAAE,OAAO,EACf,MAAM,GACoB;;QAC1B,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,IAAA,qBAAY,GAAE,CAAC;YACzC,IAAI,UAAU,IAAI,MAAM,EAAE,CAAC;gBACzB,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;YAClD,CAAC;YACD,IAAI,WAAW,IAAI,MAAM,EAAE,CAAC;gBAC1B,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,GAAG,CAC/B,yCAAyC,EACzC;oBACE,MAAM,EAAE,EAAE,IAAI,EAAE,EAAE,iBAAiB,EAAE,MAAM,CAAC,SAAS,EAAE,EAAE;iBAC1D,CACF,CAAC;gBACF,IAAA,wBAAS,EACP,MAAA,QAAQ,CAAC,IAAI,0CAAE,IAAI,EACnB,kBAAkB,MAAM,CAAC,SAAS,YAAY,CAC/C,CAAC;gBACF,OAAO,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC;YAC5B,CAAC;YACD,IAAI,KAAK,IAAI,MAAM,IAAI,MAAM,IAAI,MAAM,EAAE,CAAC;gBACxC,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,GAAG,CAC/B,iDAAiD,EACjD;oBACE,MAAM,EAAE;wBACN,IAAI,EAAE,EAAE,iBAAiB,EAAE,MAAM,CAAC,IAAI,EAAE,QAAQ,EAAE,MAAM,CAAC,GAAG,EAAE;qBAC/D;iBACF,CACF,CAAC;gBACF,IAAA,wBAAS,EAAC,MAAA,QAAQ,CAAC,IAAI,0CAAE,IAAI,EAAE,cAAc,MAAM,CAAC,GAAG,YAAY,CAAC,CAAC;gBACrE,OAAO,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC;YAC5B,CAAC;YACD,IAAI,MAAM,IAAI,MAAM,EAAE,CAAC;gBACrB,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,GAAG,CAC/B,wCAAwC,EACxC;oBACE,MAAM,EAAE;wBACN,IAAI,EAAE,EAAE,iBAAiB,EAAE,MAAM,CAAC,IAAI,EAAE;qBACzC;iBACF,CACF,CAAC;gBACF,IAAA,wBAAS,EAAC,MAAA,QAAQ,CAAC,IAAI,0CAAE,IAAI,EAAE,UAAU,MAAM,CAAC,IAAI,YAAY,CAAC,CAAC;gBAClE,OAAO,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC;YAC5B,CAAC;YACD,MAAM,IAAI,KAAK,CAAC,gBAAgB,CAAC,CAAC;QACpC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,sCAAsC;YACtC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YACrB,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;CAAA"}

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

@@ -0,0 +1,5 @@
+/**
+ * A type guard for checking if a value is an object
+ */
+export declare function isObject(value: unknown): value is object;
+//# sourceMappingURL=isObject.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"isObject.d.ts","sourceRoot":"","sources":["../../../src/utils/isObject.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,wBAAgB,QAAQ,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAExD"}

package/dist/src/utils/isObject.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isObject = isObject;
+/**
+ * A type guard for checking if a value is an object
+ */
+function isObject(value) {
+    return typeof value === "object" && value !== null;
+}
+//# sourceMappingURL=isObject.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"isObject.js","sourceRoot":"","sources":["../../../src/utils/isObject.ts"],"names":[],"mappings":";;AAGA,4BAEC;AALD;;GAEG;AACH,SAAgB,QAAQ,CAAC,KAAc;IACrC,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,CAAC;AACrD,CAAC"}

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

@@ -0,0 +1,9 @@
+/**
+ * A logger that does nothing
+ */
+export declare const noopLogger: {
+    info: () => undefined;
+    error: () => undefined;
+    log: () => undefined;
+};
+//# sourceMappingURL=noopLogger.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"noopLogger.d.ts","sourceRoot":"","sources":["../../../src/utils/noopLogger.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,eAAO,MAAM,UAAU;;;;CAIL,CAAC"}

package/dist/src/utils/noopLogger.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.noopLogger = void 0;
+/**
+ * A logger that does nothing
+ */
+exports.noopLogger = {
+    info: () => undefined,
+    error: () => undefined,
+    log: () => undefined,
+};
+//# sourceMappingURL=noopLogger.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"noopLogger.js","sourceRoot":"","sources":["../../../src/utils/noopLogger.ts"],"names":[],"mappings":";;;AAEA;;GAEG;AACU,QAAA,UAAU,GAAG;IACxB,IAAI,EAAE,GAAG,EAAE,CAAC,SAAS;IACrB,KAAK,EAAE,GAAG,EAAE,CAAC,SAAS;IACtB,GAAG,EAAE,GAAG,EAAE,CAAC,SAAS;CACJ,CAAC"}

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

@@ -0,0 +1,14 @@
+/**
+ * Safely parse a JSON string
+ *
+ * @param str - The string to parse
+ * @returns An object containing both the parsed JSON and the error if there was one
+ */
+export declare function safelyParseJSON(str: string): {
+    json: any;
+    parseError?: undefined;
+} | {
+    json: null;
+    parseError: unknown;
+};
+//# sourceMappingURL=safelyParseJSON.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"safelyParseJSON.d.ts","sourceRoot":"","sources":["../../../src/utils/safelyParseJSON.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,GAAG,EAAE,MAAM;;;;;;EAM1C"}

package/dist/src/utils/safelyParseJSON.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.safelyParseJSON = safelyParseJSON;
+/**
+ * Safely parse a JSON string
+ *
+ * @param str - The string to parse
+ * @returns An object containing both the parsed JSON and the error if there was one
+ */
+function safelyParseJSON(str) {
+    try {
+        return { json: JSON.parse(str) };
+    }
+    catch (e) {
+        return { json: null, parseError: e };
+    }
+}
+//# sourceMappingURL=safelyParseJSON.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"safelyParseJSON.js","sourceRoot":"","sources":["../../../src/utils/safelyParseJSON.ts"],"names":[],"mappings":";;AAMA,0CAMC;AAZD;;;;;GAKG;AACH,SAAgB,eAAe,CAAC,GAAW;IACzC,IAAI,CAAC;QACH,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;IACnC,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,EAAE,CAAC;IACvC,CAAC;AACH,CAAC"}

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

@@ -0,0 +1,14 @@
+/**
+ * Safely stringify a JSON object
+ *
+ * @param args - The arguments to pass to JSON.stringify
+ * @returns An object containing both the stringified JSON and the error if there was one
+ */
+export declare function safelyStringifyJSON(...args: Parameters<typeof JSON.stringify>): {
+    json: string;
+    stringifyError?: undefined;
+} | {
+    json: null;
+    stringifyError: unknown;
+};
+//# sourceMappingURL=safelyStringifyJSON.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"safelyStringifyJSON.d.ts","sourceRoot":"","sources":["../../../src/utils/safelyStringifyJSON.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,wBAAgB,mBAAmB,CACjC,GAAG,IAAI,EAAE,UAAU,CAAC,OAAO,IAAI,CAAC,SAAS,CAAC;;;;;;EAO3C"}

package/dist/src/utils/safelyStringifyJSON.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.safelyStringifyJSON = safelyStringifyJSON;
+/**
+ * Safely stringify a JSON object
+ *
+ * @param args - The arguments to pass to JSON.stringify
+ * @returns An object containing both the stringified JSON and the error if there was one
+ */
+function safelyStringifyJSON(...args) {
+    try {
+        return { json: JSON.stringify(...args) };
+    }
+    catch (e) {
+        return { json: null, stringifyError: e };
+    }
+}
+//# sourceMappingURL=safelyStringifyJSON.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"safelyStringifyJSON.js","sourceRoot":"","sources":["../../../src/utils/safelyStringifyJSON.ts"],"names":[],"mappings":";;AAMA,kDAQC;AAdD;;;;;GAKG;AACH,SAAgB,mBAAmB,CACjC,GAAG,IAAuC;IAE1C,IAAI,CAAC;QACH,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,EAAE,CAAC;IAC3C,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,cAAc,EAAE,CAAC,EAAE,CAAC;IAC3C,CAAC;AACH,CAAC"}

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

@@ -0,0 +1,17 @@
+import { z } from "zod";
+/**
+ * Simple utility to check if two types are exactly equivalent
+ */
+export type AssertEqual<T, U> = (<V>() => V extends T ? 1 : 2) extends <V>() => V extends U ? 1 : 2 ? true : false;
+/**
+ * Zod utility to check if a schema is defined correctly against a given type
+ *
+ * @see https://github.com/colinhacks/zod/issues/372#issuecomment-2445439772
+ */
+export declare const schemaMatches: <T>() => <S extends z.ZodType<T, z.ZodTypeDef, unknown>>(schema: AssertEqual<S["_output"], T> extends true ? S : S & {
+    "types do not match": {
+        expected: T;
+        received: S["_output"];
+    };
+}) => S;
+//# sourceMappingURL=schemaMatches.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"schemaMatches.d.ts","sourceRoot":"","sources":["../../../src/utils/schemaMatches.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;GAEG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,EAAE,CAAC,IAC1B,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,GAC/D,IAAI,GACJ,KAAK,CAAC;AAEZ;;;;GAIG;AACH,eAAO,MAAM,aAAa,GACvB,CAAC,QACD,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,UAAU,EAAE,OAAO,CAAC,UACpC,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,SAAS,IAAI,GAC7C,CAAC,GACD,CAAC,GAAG;IACF,oBAAoB,EAAE;QACpB,QAAQ,EAAE,CAAC,CAAC;QACZ,QAAQ,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC;KACxB,CAAC;CACH,KACJ,CAEF,CAAC"}

package/dist/src/utils/schemaMatches.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.schemaMatches = void 0;
+/**
+ * Zod utility to check if a schema is defined correctly against a given type
+ *
+ * @see https://github.com/colinhacks/zod/issues/372#issuecomment-2445439772
+ */
+const schemaMatches = () => (schema) => {
+    return schema;
+};
+exports.schemaMatches = schemaMatches;
+//# sourceMappingURL=schemaMatches.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"schemaMatches.js","sourceRoot":"","sources":["../../../src/utils/schemaMatches.ts"],"names":[],"mappings":";;;AAUA;;;;GAIG;AACI,MAAM,aAAa,GACxB,GAAM,EAAE,CACR,CACE,MAOK,EACF,EAAE;IACL,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAbS,QAAA,aAAa,iBAatB"}