@arizeai/phoenix-client 6.11.1 → 6.11.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1306,7 +1306,24 @@ export interface paths {
1306
1306
  };
1307
1307
  get?: never;
1308
1308
  put?: never;
1309
- /** Run Server Agent */
1309
+ /**
1310
+ * Run Server Agent
1311
+ * @description Stream a chat turn from the GraphQL server agent.
1312
+ *
1313
+ * This is the endpoint the PXI CLI talks to directly (no pre-configured
1314
+ * agent record): it builds a fresh server agent per request from the
1315
+ * caller-supplied model and contexts, then streams the reply back as
1316
+ * Vercel-AI chunks.
1317
+ *
1318
+ * The request contexts gate capabilities — GraphQL mutations, web access,
1319
+ * and subagents — and mutations are refused for viewer users. When trace
1320
+ * recording is enabled (and permitted by system settings), the run is
1321
+ * traced; locally ingested traces are persisted to the agent's project
1322
+ * once the stream completes.
1323
+ *
1324
+ * Returns ``403`` if agents or the server agent are disabled, or if a
1325
+ * viewer requests mutations.
1326
+ */
1310
1327
  post: operations["run_server_agent_agents_server_sessions__session_id__chat_post"];
1311
1328
  delete?: never;
1312
1329
  options?: never;