@arizeai/phoenix-client 7.7.1 → 7.9.0

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.
Files changed (32) hide show
  1. package/CHANGELOG.md +12 -0
  2. package/dist/esm/__generated__/api/v1.d.ts +170 -6
  3. package/dist/esm/__generated__/api/v1.d.ts.map +1 -1
  4. package/dist/esm/prompts/constants.d.ts.map +1 -1
  5. package/dist/esm/prompts/constants.js +3 -0
  6. package/dist/esm/prompts/constants.js.map +1 -1
  7. package/dist/esm/prompts/sdks/toOpenAI.d.ts.map +1 -1
  8. package/dist/esm/prompts/sdks/toOpenAI.js +4 -0
  9. package/dist/esm/prompts/sdks/toOpenAI.js.map +1 -1
  10. package/dist/esm/tsconfig.esm.tsbuildinfo +1 -1
  11. package/dist/esm/types/prompts.d.ts +1 -1
  12. package/dist/esm/types/prompts.d.ts.map +1 -1
  13. package/dist/esm/types/prompts.js.map +1 -1
  14. package/dist/esm/utils/getPromptBySelector.d.ts +1 -1
  15. package/dist/src/__generated__/api/v1.d.ts +170 -6
  16. package/dist/src/__generated__/api/v1.d.ts.map +1 -1
  17. package/dist/src/prompts/constants.d.ts.map +1 -1
  18. package/dist/src/prompts/constants.js +3 -0
  19. package/dist/src/prompts/constants.js.map +1 -1
  20. package/dist/src/prompts/sdks/toOpenAI.d.ts.map +1 -1
  21. package/dist/src/prompts/sdks/toOpenAI.js +4 -0
  22. package/dist/src/prompts/sdks/toOpenAI.js.map +1 -1
  23. package/dist/src/types/prompts.d.ts +1 -1
  24. package/dist/src/types/prompts.d.ts.map +1 -1
  25. package/dist/src/types/prompts.js.map +1 -1
  26. package/dist/src/utils/getPromptBySelector.d.ts +1 -1
  27. package/dist/tsconfig.tsbuildinfo +1 -1
  28. package/package.json +2 -2
  29. package/src/__generated__/api/v1.ts +170 -6
  30. package/src/prompts/constants.ts +3 -0
  31. package/src/prompts/sdks/toOpenAI.ts +4 -0
  32. package/src/types/prompts.ts +4 -1
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@arizeai/phoenix-client",
3
- "version": "7.7.1",
3
+ "version": "7.9.0",
4
4
  "description": "A client for the Phoenix API",
5
5
  "keywords": [
6
6
  "arize",
@@ -127,7 +127,7 @@
127
127
  "openai": "^6.49.0",
128
128
  "openapi-typescript": "^7.13.0",
129
129
  "tsx": "^4.23.12",
130
- "vitest": "^4.1.11"
130
+ "vitest": "^5.0.0"
131
131
  },
132
132
  "peerDependencies": {
133
133
  "@anthropic-ai/sdk": "^0.35.0",
@@ -761,7 +761,11 @@ export interface paths {
761
761
  get: operations["listProjectTraces"];
762
762
  put?: never;
763
763
  post?: never;
764
- delete?: never;
764
+ /**
765
+ * Delete traces from a project
766
+ * @description Delete traces from a project without deleting the project or its configuration. Only traces whose start time is within the required `[start_time, end_time)` interval are deleted. Associated spans are cascade deleted, and project sessions left with no remaining traces are also deleted. Naive datetimes are interpreted as UTC.
767
+ */
768
+ delete: operations["deleteProjectTraces"];
765
769
  options?: never;
766
770
  head?: never;
767
771
  patch?: never;
@@ -1568,7 +1572,7 @@ export interface paths {
1568
1572
  put?: never;
1569
1573
  /**
1570
1574
  * OpenAI-compatible chat completions
1571
- * @description Creates a chat completion using the OpenAI wire format, proxying to the selected provider with credentials resolved on the server (secret store first, environment second) — callers never handle provider API keys. Model must be '{provider}:{model_name}' for a built-in provider (one of anthropic, aws, azure_openai, cerebras, deepseek, fireworks, google, groq, moonshot, ollama, openai, perplexity, together, xai) or 'custom:{provider_id}:{model_name}' for a stored custom provider, e.g. 'openai:gpt-4o' or 'anthropic:claude-sonnet-4-5'. Set `stream: true` for server-sent events of `chat.completion.chunk` payloads terminated by `data: [DONE]`. Tool calling is not supported.
1575
+ * @description Creates a chat completion using the OpenAI wire format, proxying to the selected provider with credentials resolved on the server (secret store first, environment second) — callers never handle provider API keys. Model must be '{provider}:{model_name}' for a built-in provider (one of anthropic, aws, azure_openai, cerebras, deepseek, fireworks, google, groq, meta, minimax, moonshot, ollama, openai, perplexity, together, xai, zai) or 'custom:{provider_id}:{model_name}' for a stored custom provider, e.g. 'openai:gpt-4o' or 'anthropic:claude-sonnet-4-5'. Set `stream: true` for server-sent events of `chat.completion.chunk` payloads terminated by `data: [DONE]`. Tool calling is not supported.
1572
1576
  *
1573
1577
  * **Phoenix is not an AI gateway.** The same server also takes on trace ingestion traffic, so routing production LLM calls through it competes with ingestion. Use this endpoint only to quickly try out different models in non-production environments.
1574
1578
  */
@@ -2424,6 +2428,11 @@ export interface components {
2424
2428
  * @description The id of the last transcript message the client has rendered, used for optimistic concurrency. Omit when the session has no messages; required (and validated against the persisted transcript) once it does. On mismatch the server rejects the send with HTTP 409 and code ``agent_session_messages_stale`` — the client should refetch the session before retrying.
2425
2429
  */
2426
2430
  lastMessageId?: string | null;
2431
+ /**
2432
+ * Credentials
2433
+ * @description Client-held credentials for optional integrations (e.g. the user's own GitHub personal access token under the key ``GITHUB_PERSONAL_ACCESS_TOKEN``), used only for the duration of the turn and never persisted. Unknown keys are rejected.
2434
+ */
2435
+ credentials?: components["schemas"]["ChatRequestCredential"][];
2427
2436
  /**
2428
2437
  * Recordlocaltraces
2429
2438
  * @default false
@@ -2441,6 +2450,28 @@ export interface components {
2441
2450
  */
2442
2451
  instrumentUserId?: boolean;
2443
2452
  };
2453
+ /**
2454
+ * ChatRequestCredential
2455
+ * @description One client-held credential riding the request for the duration of a turn.
2456
+ *
2457
+ * The value is ephemeral: it is injected server-side as transport auth for
2458
+ * the matching integration and is never persisted, traced, or echoed. It is
2459
+ * top-level on the request body — never part of the message — so it cannot
2460
+ * reach the session transcript.
2461
+ */
2462
+ ChatRequestCredential: {
2463
+ /**
2464
+ * Key
2465
+ * @description The credential's secret-key name.
2466
+ * @constant
2467
+ */
2468
+ key: "GITHUB_PERSONAL_ACCESS_TOKEN";
2469
+ /**
2470
+ * Value
2471
+ * Format: password
2472
+ */
2473
+ value: string;
2474
+ };
2444
2475
  /** CodeEvaluatorUIContext */
2445
2476
  CodeEvaluatorUIContext: {
2446
2477
  /**
@@ -2561,7 +2592,7 @@ export interface components {
2561
2592
  CreateChatCompletionRequestBody: {
2562
2593
  /**
2563
2594
  * Model
2564
- * @description Model must be '{provider}:{model_name}' for a built-in provider (one of anthropic, aws, azure_openai, cerebras, deepseek, fireworks, google, groq, moonshot, ollama, openai, perplexity, together, xai) or 'custom:{provider_id}:{model_name}' for a stored custom provider, e.g. 'openai:gpt-4o' or 'anthropic:claude-sonnet-4-5'.
2595
+ * @description Model must be '{provider}:{model_name}' for a built-in provider (one of anthropic, aws, azure_openai, cerebras, deepseek, fireworks, google, groq, meta, minimax, moonshot, ollama, openai, perplexity, together, xai, zai) or 'custom:{provider_id}:{model_name}' for a stored custom provider, e.g. 'openai:gpt-4o' or 'anthropic:claude-sonnet-4-5'.
2565
2596
  */
2566
2597
  model: string;
2567
2598
  /** Messages */
@@ -4057,7 +4088,7 @@ export interface components {
4057
4088
  * ModelProvider
4058
4089
  * @enum {string}
4059
4090
  */
4060
- ModelProvider: "OPENAI" | "AZURE_OPENAI" | "ANTHROPIC" | "GOOGLE" | "DEEPSEEK" | "XAI" | "OLLAMA" | "AWS" | "CEREBRAS" | "FIREWORKS" | "GROQ" | "MOONSHOT" | "PERPLEXITY" | "TOGETHER";
4091
+ ModelProvider: "OPENAI" | "AZURE_OPENAI" | "ANTHROPIC" | "GOOGLE" | "DEEPSEEK" | "XAI" | "OLLAMA" | "AWS" | "CEREBRAS" | "FIREWORKS" | "GROQ" | "MOONSHOT" | "MINIMAX" | "PERPLEXITY" | "TOGETHER" | "ZAI" | "META";
4061
4092
  /** OAuth2User */
4062
4093
  OAuth2User: {
4063
4094
  /** Id */
@@ -4905,6 +4936,43 @@ export interface components {
4905
4936
  /** Content */
4906
4937
  content: string | (components["schemas"]["TextContentPart"] | components["schemas"]["ToolCallContentPart"] | components["schemas"]["ToolResultContentPart"])[];
4907
4938
  };
4939
+ /** PromptMetaInvocationParameters */
4940
+ PromptMetaInvocationParameters: {
4941
+ /**
4942
+ * @description discriminator enum property added by openapi-typescript
4943
+ * @enum {string}
4944
+ */
4945
+ type: "meta";
4946
+ meta: components["schemas"]["PromptMetaInvocationParametersContent"];
4947
+ };
4948
+ /** PromptMetaInvocationParametersContent */
4949
+ PromptMetaInvocationParametersContent: {
4950
+ /** Temperature */
4951
+ temperature?: number;
4952
+ /** Max Tokens */
4953
+ max_tokens?: number;
4954
+ /** Max Completion Tokens */
4955
+ max_completion_tokens?: number;
4956
+ /** Frequency Penalty */
4957
+ frequency_penalty?: number;
4958
+ /** Presence Penalty */
4959
+ presence_penalty?: number;
4960
+ /** Top P */
4961
+ top_p?: number;
4962
+ /** Seed */
4963
+ seed?: number;
4964
+ /** Stop */
4965
+ stop?: string[];
4966
+ /**
4967
+ * Reasoning Effort
4968
+ * @enum {string}
4969
+ */
4970
+ reasoning_effort?: "none" | "minimal" | "low" | "medium" | "high" | "xhigh";
4971
+ /** Extra Body */
4972
+ extra_body?: {
4973
+ [key: string]: unknown;
4974
+ };
4975
+ };
4908
4976
  /** PromptMoonshotInvocationParameters */
4909
4977
  PromptMoonshotInvocationParameters: {
4910
4978
  /**
@@ -5236,7 +5304,7 @@ export interface components {
5236
5304
  template_type: components["schemas"]["PromptTemplateType"];
5237
5305
  template_format: components["schemas"]["PromptTemplateFormat"];
5238
5306
  /** Invocation Parameters */
5239
- invocation_parameters: components["schemas"]["PromptOpenAIInvocationParameters"] | components["schemas"]["PromptAzureOpenAIInvocationParameters"] | components["schemas"]["PromptAnthropicInvocationParameters"] | components["schemas"]["PromptGoogleInvocationParameters"] | components["schemas"]["PromptDeepSeekInvocationParameters"] | components["schemas"]["PromptXAIInvocationParameters"] | components["schemas"]["PromptOllamaInvocationParameters"] | components["schemas"]["PromptAwsInvocationParameters"] | components["schemas"]["PromptCerebrasInvocationParameters"] | components["schemas"]["PromptFireworksInvocationParameters"] | components["schemas"]["PromptGroqInvocationParameters"] | components["schemas"]["PromptMoonshotInvocationParameters"] | components["schemas"]["PromptPerplexityInvocationParameters"] | components["schemas"]["PromptTogetherInvocationParameters"];
5307
+ invocation_parameters: components["schemas"]["PromptOpenAIInvocationParameters"] | components["schemas"]["PromptAzureOpenAIInvocationParameters"] | components["schemas"]["PromptAnthropicInvocationParameters"] | components["schemas"]["PromptGoogleInvocationParameters"] | components["schemas"]["PromptDeepSeekInvocationParameters"] | components["schemas"]["PromptXAIInvocationParameters"] | components["schemas"]["PromptOllamaInvocationParameters"] | components["schemas"]["PromptAwsInvocationParameters"] | components["schemas"]["PromptCerebrasInvocationParameters"] | components["schemas"]["PromptFireworksInvocationParameters"] | components["schemas"]["PromptGroqInvocationParameters"] | components["schemas"]["PromptMoonshotInvocationParameters"] | components["schemas"]["PromptPerplexityInvocationParameters"] | components["schemas"]["PromptTogetherInvocationParameters"] | components["schemas"]["PromptZAIInvocationParameters"] | components["schemas"]["PromptMetaInvocationParameters"];
5240
5308
  tools?: components["schemas"]["PromptTools"] | null;
5241
5309
  /** Response Format */
5242
5310
  response_format?: components["schemas"]["PromptResponseFormatJSONSchema"] | null;
@@ -5255,7 +5323,7 @@ export interface components {
5255
5323
  template_type: components["schemas"]["PromptTemplateType"];
5256
5324
  template_format: components["schemas"]["PromptTemplateFormat"];
5257
5325
  /** Invocation Parameters */
5258
- invocation_parameters: components["schemas"]["PromptOpenAIInvocationParameters"] | components["schemas"]["PromptAzureOpenAIInvocationParameters"] | components["schemas"]["PromptAnthropicInvocationParameters"] | components["schemas"]["PromptGoogleInvocationParameters"] | components["schemas"]["PromptDeepSeekInvocationParameters"] | components["schemas"]["PromptXAIInvocationParameters"] | components["schemas"]["PromptOllamaInvocationParameters"] | components["schemas"]["PromptAwsInvocationParameters"] | components["schemas"]["PromptCerebrasInvocationParameters"] | components["schemas"]["PromptFireworksInvocationParameters"] | components["schemas"]["PromptGroqInvocationParameters"] | components["schemas"]["PromptMoonshotInvocationParameters"] | components["schemas"]["PromptPerplexityInvocationParameters"] | components["schemas"]["PromptTogetherInvocationParameters"];
5326
+ invocation_parameters: components["schemas"]["PromptOpenAIInvocationParameters"] | components["schemas"]["PromptAzureOpenAIInvocationParameters"] | components["schemas"]["PromptAnthropicInvocationParameters"] | components["schemas"]["PromptGoogleInvocationParameters"] | components["schemas"]["PromptDeepSeekInvocationParameters"] | components["schemas"]["PromptXAIInvocationParameters"] | components["schemas"]["PromptOllamaInvocationParameters"] | components["schemas"]["PromptAwsInvocationParameters"] | components["schemas"]["PromptCerebrasInvocationParameters"] | components["schemas"]["PromptFireworksInvocationParameters"] | components["schemas"]["PromptGroqInvocationParameters"] | components["schemas"]["PromptMoonshotInvocationParameters"] | components["schemas"]["PromptPerplexityInvocationParameters"] | components["schemas"]["PromptTogetherInvocationParameters"] | components["schemas"]["PromptZAIInvocationParameters"] | components["schemas"]["PromptMetaInvocationParameters"];
5259
5327
  tools?: components["schemas"]["PromptTools"] | null;
5260
5328
  /** Response Format */
5261
5329
  response_format?: components["schemas"]["PromptResponseFormatJSONSchema"] | null;
@@ -5323,6 +5391,43 @@ export interface components {
5323
5391
  [key: string]: unknown;
5324
5392
  };
5325
5393
  };
5394
+ /** PromptZAIInvocationParameters */
5395
+ PromptZAIInvocationParameters: {
5396
+ /**
5397
+ * @description discriminator enum property added by openapi-typescript
5398
+ * @enum {string}
5399
+ */
5400
+ type: "zai";
5401
+ zai: components["schemas"]["PromptZAIInvocationParametersContent"];
5402
+ };
5403
+ /** PromptZAIInvocationParametersContent */
5404
+ PromptZAIInvocationParametersContent: {
5405
+ /** Temperature */
5406
+ temperature?: number;
5407
+ /** Max Tokens */
5408
+ max_tokens?: number;
5409
+ /** Max Completion Tokens */
5410
+ max_completion_tokens?: number;
5411
+ /** Frequency Penalty */
5412
+ frequency_penalty?: number;
5413
+ /** Presence Penalty */
5414
+ presence_penalty?: number;
5415
+ /** Top P */
5416
+ top_p?: number;
5417
+ /** Seed */
5418
+ seed?: number;
5419
+ /** Stop */
5420
+ stop?: string[];
5421
+ /**
5422
+ * Reasoning Effort
5423
+ * @enum {string}
5424
+ */
5425
+ reasoning_effort?: "none" | "minimal" | "low" | "medium" | "high" | "xhigh";
5426
+ /** Extra Body */
5427
+ extra_body?: {
5428
+ [key: string]: unknown;
5429
+ };
5430
+ };
5326
5431
  /**
5327
5432
  * PydanticAIMessageMetadata
5328
5433
  * @description Local pin of pydantic-ai's message-level ``pydantic_ai`` metadata
@@ -9993,6 +10098,12 @@ export interface operations {
9993
10098
  include_spans?: boolean;
9994
10099
  /** @description List of session identifiers to filter traces by. Each value can be either a session_id string or a session GlobalID. Only traces belonging to the specified sessions will be returned. */
9995
10100
  session_identifier?: string[] | null;
10101
+ /** @description Filter by trace error status. If true, only return traces that contain at least one span with `status_code == ERROR`. If false, only return traces with no errored spans. If omitted, traces are not filtered by error status. Matches the error indicator shown in the UI. */
10102
+ error?: boolean | null;
10103
+ /** @description Inclusive lower bound on trace latency in milliseconds. */
10104
+ min_latency_ms?: number | null;
10105
+ /** @description Inclusive upper bound on trace latency in milliseconds. */
10106
+ max_latency_ms?: number | null;
9996
10107
  };
9997
10108
  header?: never;
9998
10109
  path: {
@@ -10041,6 +10152,59 @@ export interface operations {
10041
10152
  };
10042
10153
  };
10043
10154
  };
10155
+ deleteProjectTraces: {
10156
+ parameters: {
10157
+ query: {
10158
+ /** @description Required inclusive lower bound on trace start time (ISO 8601). */
10159
+ start_time: string;
10160
+ /** @description Required exclusive upper bound on trace start time (ISO 8601). */
10161
+ end_time: string;
10162
+ };
10163
+ header?: never;
10164
+ path: {
10165
+ /** @description The project identifier: either project ID or project name. */
10166
+ project_identifier: string;
10167
+ };
10168
+ cookie?: never;
10169
+ };
10170
+ requestBody?: never;
10171
+ responses: {
10172
+ /** @description No content returned after the matching traces are deleted */
10173
+ 204: {
10174
+ headers: {
10175
+ [name: string]: unknown;
10176
+ };
10177
+ content?: never;
10178
+ };
10179
+ /** @description Forbidden */
10180
+ 403: {
10181
+ headers: {
10182
+ [name: string]: unknown;
10183
+ };
10184
+ content: {
10185
+ "text/plain": string;
10186
+ };
10187
+ };
10188
+ /** @description Not Found */
10189
+ 404: {
10190
+ headers: {
10191
+ [name: string]: unknown;
10192
+ };
10193
+ content: {
10194
+ "text/plain": string;
10195
+ };
10196
+ };
10197
+ /** @description Unprocessable Entity */
10198
+ 422: {
10199
+ headers: {
10200
+ [name: string]: unknown;
10201
+ };
10202
+ content: {
10203
+ "text/plain": string;
10204
+ };
10205
+ };
10206
+ };
10207
+ };
10044
10208
  annotateTraces: {
10045
10209
  parameters: {
10046
10210
  query?: {
@@ -16,5 +16,8 @@ export const PromptModelProviders: Record<PromptModelProvider, string> = {
16
16
  FIREWORKS: "Fireworks",
17
17
  GROQ: "Groq",
18
18
  MOONSHOT: "Moonshot",
19
+ MINIMAX: "MiniMax",
19
20
  PERPLEXITY: "Perplexity",
21
+ ZAI: "Z.ai",
22
+ META: "Meta",
20
23
  };
@@ -55,6 +55,10 @@ function getInvocationParameters(
55
55
  return parameters.perplexity;
56
56
  case "together":
57
57
  return parameters.together;
58
+ case "zai":
59
+ return parameters.zai;
60
+ case "meta":
61
+ return parameters.meta;
58
62
  default:
59
63
  // eslint-disable-next-line no-console
60
64
  console.warn(
@@ -16,7 +16,10 @@ export type PromptModelProvider =
16
16
  | "FIREWORKS"
17
17
  | "GROQ"
18
18
  | "MOONSHOT"
19
- | "PERPLEXITY";
19
+ | "MINIMAX"
20
+ | "PERPLEXITY"
21
+ | "ZAI"
22
+ | "META";
20
23
 
21
24
  /**
22
25
  * Supported prompt provider SDKs