@arizeai/phoenix-client 5.7.0 → 5.8.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arizeai/phoenix-client",
-  "version": "5.7.0",
+  "version": "5.8.0",
   "description": "A client for the Phoenix API",
   "main": "dist/src/index.js",
   "module": "dist/esm/index.js",
@@ -85,8 +85,8 @@
     "tiny-invariant": "^1.3.3",
     "zod": "^3.24.3",
     "zod-to-json-schema": "^3.24.3",
-    "@arizeai/phoenix-otel": "0.3.4",
-    "@arizeai/phoenix-config": "0.1.0"
+    "@arizeai/phoenix-config": "0.1.0",
+    "@arizeai/phoenix-otel": "0.3.4"
   },
   "engines": {
     "node": ">=18"

package/src/prompts/index.ts

@@ -1,3 +1,4 @@
 export * from "./getPrompt";
 export * from "./createPrompt";
+export * from "./listPrompts";
 export * from "./sdks";

package/src/prompts/listPrompts.ts

@@ -0,0 +1,29 @@
+import { createClient } from "../client";
+import { ClientFn } from "../types/core";
+import { Prompt } from "../types/prompts";
+
+import invariant from "tiny-invariant";
+
+export type ListPromptsParams = ClientFn;
+
+/**
+ * List all prompts available to the client.
+ *
+ * @example
+ * ```ts
+ * import { listPrompts } from "@arizeai/phoenix-client/prompts";
+ *
+ * const prompts = await listPrompts({});
+ * console.log(prompts);
+ * ```
+ *
+ * @throws {Error} If the prompts cannot be listed or the response is invalid.
+ */
+export async function listPrompts({
+  client: _client,
+}: ListPromptsParams): Promise<Prompt[]> {
+  const client = _client || createClient();
+  const response = await client.GET("/v1/prompts");
+  invariant(response.data?.data, "Failed to list prompts");
+  return response.data.data;
+}