@arizeai/phoenix-client 5.2.0 → 5.3.0

package/src/schemas/llm/schemas.ts

@@ -1,19 +1,20 @@
-import z from "zod";
 import { anthropicMessageSchema } from "./anthropic/messageSchemas";
+import { anthropicToolCallSchema } from "./anthropic/toolCallSchemas";
+import { anthropicToolChoiceSchema } from "./anthropic/toolChoiceSchemas";
+import { anthropicToolDefinitionSchema } from "./anthropic/toolSchemas";
 import { openAIMessageSchema } from "./openai/messageSchemas";
-import { phoenixMessageSchema } from "./phoenixPrompt/messageSchemas";
 import { openAIToolCallSchema } from "./openai/toolCallSchemas";
-import { anthropicToolCallSchema } from "./anthropic/toolCallSchemas";
 import { openAIToolChoiceSchema } from "./openai/toolChoiceSchemas";
-import { anthropicToolChoiceSchema } from "./anthropic/toolChoiceSchemas";
 import { openAIToolDefinitionSchema } from "./openai/toolSchemas";
-import { anthropicToolDefinitionSchema } from "./anthropic/toolSchemas";
-import { phoenixToolDefinitionSchema } from "./phoenixPrompt/toolSchemas";
-import { phoenixToolChoiceSchema } from "./phoenixPrompt/toolChoiceSchemas";
-import { vercelAIToolChoiceSchema } from "./vercel/toolChoiceSchemas";
+import { phoenixMessageSchema } from "./phoenixPrompt/messageSchemas";
 import { phoenixToolCallSchema } from "./phoenixPrompt/toolCallSchemas";
+import { phoenixToolChoiceSchema } from "./phoenixPrompt/toolChoiceSchemas";
+import { phoenixToolDefinitionSchema } from "./phoenixPrompt/toolSchemas";
 import { vercelAIChatPartToolCallSchema } from "./vercel/messagePartSchemas";
 import { vercelAIMessageSchema } from "./vercel/messageSchemas";
+import { vercelAIToolChoiceSchema } from "./vercel/toolChoiceSchemas";
+
+import z from "zod";
 
 /**
  * Union of all message formats

package/src/schemas/llm/types.ts

@@ -1,29 +1,30 @@
-import { ZodType, ZodTypeAny, ZodTypeDef } from "zod";
+import { PromptProviderSDKs, PromptToolChoice } from "../../types/prompts";
 
-import type { OpenAIChatPart } from "./openai/messagePartSchemas";
 import type { AnthropicMessagePart } from "./anthropic/messagePartSchemas";
+import { AnthropicMessage } from "./anthropic/messageSchemas";
+import { AnthropicToolCall } from "./anthropic/toolCallSchemas";
+import { AnthropicToolChoice } from "./anthropic/toolChoiceSchemas";
+import { AnthropicToolDefinition } from "./anthropic/toolSchemas";
+import type { OpenAIChatPart } from "./openai/messagePartSchemas";
+import { OpenAIMessage } from "./openai/messageSchemas";
+import { OpenAIResponseFormat } from "./openai/responseFormatSchema";
+import { OpenAIToolCall } from "./openai/toolCallSchemas";
+import { OpenaiToolChoice } from "./openai/toolChoiceSchemas";
+import { OpenAIToolDefinition } from "./openai/toolSchemas";
+import { PhoenixContentPart } from "./phoenixPrompt/messagePartSchemas";
+import { PhoenixMessage } from "./phoenixPrompt/messageSchemas";
+import { PhoenixToolCall } from "./phoenixPrompt/toolCallSchemas";
+import { PhoenixToolDefinition } from "./phoenixPrompt/toolSchemas";
 import type {
   VercelAIChatPart,
   VercelAIChatPartToolCall,
 } from "./vercel/messagePartSchemas";
-import { PromptProviderSDKs, PromptToolChoice } from "../../types/prompts";
-import { OpenAIMessage } from "./openai/messageSchemas";
-import { AnthropicMessage } from "./anthropic/messageSchemas";
-import { OpenAIToolCall } from "./openai/toolCallSchemas";
-import { AnthropicToolCall } from "./anthropic/toolCallSchemas";
-import { OpenaiToolChoice } from "./openai/toolChoiceSchemas";
-import { AnthropicToolChoice } from "./anthropic/toolChoiceSchemas";
 import { VercelAIMessage } from "./vercel/messageSchemas";
-import { PhoenixToolCall } from "./phoenixPrompt/toolCallSchemas";
-import { PhoenixMessage } from "./phoenixPrompt/messageSchemas";
 import { VercelAIToolChoice } from "./vercel/toolChoiceSchemas";
-import { OpenAIToolDefinition } from "./openai/toolSchemas";
-import { OpenAIResponseFormat } from "./openai/responseFormatSchema";
-import { AnthropicToolDefinition } from "./anthropic/toolSchemas";
-import { PhoenixToolDefinition } from "./phoenixPrompt/toolSchemas";
-import { PhoenixContentPart } from "./phoenixPrompt/messagePartSchemas";
 import { VercelAIToolDefinition } from "./vercel/toolSchemas";
 
+import { ZodType, ZodTypeAny, ZodTypeDef } from "zod";
+
 export type PromptSDKFormat = PromptProviderSDKs | null;
 
 export type LLMMessagePart =

package/src/schemas/llm/utils.ts

@@ -1,13 +1,22 @@
+import { isObject } from "../../utils/isObject";
+
 import { anthropicMessagePartSchema } from "./anthropic/messagePartSchemas";
 import { anthropicMessageSchema } from "./anthropic/messageSchemas";
-import { openAIToolCallSchema } from "./openai/toolCallSchemas";
+import { anthropicToolCallSchema } from "./anthropic/toolCallSchemas";
+import { anthropicToolChoiceSchema } from "./anthropic/toolChoiceSchemas";
+import { anthropicToolDefinitionSchema } from "./anthropic/toolSchemas";
 import { openaiChatPartSchema } from "./openai/messagePartSchemas";
 import { openAIMessageSchema } from "./openai/messageSchemas";
+import { openAIToolCallSchema } from "./openai/toolCallSchemas";
 import { openAIToolChoiceSchema } from "./openai/toolChoiceSchemas";
-import { anthropicToolChoiceSchema } from "./anthropic/toolChoiceSchemas";
 import { openAIToolDefinitionSchema } from "./openai/toolSchemas";
-import { anthropicToolDefinitionSchema } from "./anthropic/toolSchemas";
-import { anthropicToolCallSchema } from "./anthropic/toolCallSchemas";
+import { phoenixContentPartSchema } from "./phoenixPrompt/messagePartSchemas";
+import { phoenixMessageSchema } from "./phoenixPrompt/messageSchemas";
+import { phoenixToolCallSchema } from "./phoenixPrompt/toolCallSchemas";
+import { phoenixToolChoiceSchema } from "./phoenixPrompt/toolChoiceSchemas";
+import { phoenixToolDefinitionSchema } from "./phoenixPrompt/toolSchemas";
+import { vercelAIMessageSchema } from "./vercel/messageSchemas";
+import { vercelAIToolDefinitionSchema } from "./vercel/toolSchemas";
 import { llmProviderToolDefinitionSchema } from "./schemas";
 import type {
   LLMMessagePart,
@@ -18,15 +27,8 @@ import type {
   ToolChoiceWithProvider,
   ToolDefinitionWithProvider,
 } from "./types";
-import { isObject } from "../../utils/isObject";
+
 import type { ZodTypeAny } from "zod";
-import { vercelAIMessageSchema } from "./vercel/messageSchemas";
-import { phoenixMessageSchema } from "./phoenixPrompt/messageSchemas";
-import { phoenixToolCallSchema } from "./phoenixPrompt/toolCallSchemas";
-import { phoenixToolChoiceSchema } from "./phoenixPrompt/toolChoiceSchemas";
-import { phoenixToolDefinitionSchema } from "./phoenixPrompt/toolSchemas";
-import { phoenixContentPartSchema } from "./phoenixPrompt/messagePartSchemas";
-import { vercelAIToolDefinitionSchema } from "./vercel/toolSchemas";
 
 export const makeSDKConverters = <
   MessageSchema extends ZodTypeAny,

package/src/schemas/llm/vercel/messagePartSchemas.ts

@@ -1,6 +1,7 @@
-import z from "zod";
 import { jsonLiteralSchema } from "../../jsonLiteralSchema";
 
+import z from "zod";
+
 /*
  *
  * Vercel AI SDK Message Part Schemas

package/src/schemas/llm/vercel/messageSchemas.ts

@@ -1,5 +1,3 @@
-import z from "zod";
-
 import {
   vercelAIChatPartImageSchema,
   vercelAIChatPartTextSchema,
@@ -7,6 +5,8 @@ import {
   vercelAIChatPartToolResultSchema,
 } from "./messagePartSchemas";
 
+import z from "zod";
+
 /*
  *
  * Vercel AI SDK Message Schemas

package/src/sessions/addSessionAnnotation.ts

@@ -1,5 +1,6 @@
 import { createClient } from "../client";
 import { ClientFn } from "../types/core";
+
 import { SessionAnnotation, toSessionAnnotationData } from "./types";
 
 /**

package/src/sessions/logSessionAnnotations.ts

@@ -1,5 +1,6 @@
 import { createClient } from "../client";
 import { ClientFn } from "../types/core";
+
 import { SessionAnnotation, toSessionAnnotationData } from "./types";
 
 /**

package/src/spans/addDocumentAnnotation.ts

@@ -1,5 +1,6 @@
 import { createClient } from "../client";
 import { ClientFn } from "../types/core";
+
 import { DocumentAnnotation, toDocumentAnnotationData } from "./types";
 
 /**

package/src/spans/addSpanAnnotation.ts

@@ -1,5 +1,6 @@
 import { createClient } from "../client";
 import { ClientFn } from "../types/core";
+
 import { SpanAnnotation, toSpanAnnotationData } from "./types";
 
 /**

package/src/spans/getSpanAnnotations.ts

@@ -1,6 +1,6 @@
+import { operations } from "../__generated__/api/v1";
 import { createClient } from "../client";
 import { ClientFn } from "../types/core";
-import { operations } from "../__generated__/api/v1";
 import { ProjectSelector } from "../types/projects";
 
 /**

package/src/spans/getSpans.ts

@@ -1,6 +1,6 @@
+import { operations } from "../__generated__/api/v1";
 import { createClient } from "../client";
 import { ClientFn } from "../types/core";
-import { operations } from "../__generated__/api/v1";
 import { ProjectSelector } from "../types/projects";
 
 /**

package/src/spans/logDocumentAnnotations.ts

@@ -1,5 +1,6 @@
 import { createClient } from "../client";
 import { ClientFn } from "../types/core";
+
 import { DocumentAnnotation, toDocumentAnnotationData } from "./types";
 
 /**

package/src/spans/logSpanAnnotations.ts

@@ -1,5 +1,6 @@
 import { createClient } from "../client";
 import { ClientFn } from "../types/core";
+
 import { SpanAnnotation, toSpanAnnotationData } from "./types";
 
 /**

package/src/types/experiments.ts

@@ -1,6 +1,6 @@
 import { AnnotatorKind } from "./annotations";
 import { Node } from "./core";
-import { Example } from "./datasets";
+import { Example, ExampleWithId } from "./datasets";
 
 /**
  * An experiment is a set of task runs on a dataset version
@@ -11,18 +11,77 @@ export interface ExperimentInfo extends Node {
   // @todo: mark this as required when experiment API returns it
   datasetSplits?: string[];
   /**
-   * The project under which the experiment task traces are recorded
+   * Number of times the experiment is repeated
    */
-  projectName: string;
+  repetitions: number;
   /**
    * Metadata about the experiment as an object of key values
    * e.x. model name
    */
   metadata: Record<string, unknown>;
+  /**
+   * The project under which the experiment task traces are recorded
+   * Note: This can be null when no project is associated with the experiment
+   */
+  projectName: string | null;
+  /**
+   * The creation timestamp of the experiment
+   */
+  createdAt: string;
+  /**
+   * The last update timestamp of the experiment
+   */
+  updatedAt: string;
+  /**
+   * Number of examples in the experiment
+   */
+  exampleCount: number;
+  /**
+   * Number of successful runs in the experiment
+   */
+  successfulRunCount: number;
+  /**
+   * Number of failed runs in the experiment
+   */
+  failedRunCount: number;
+  /**
+   * Number of missing (not yet executed) runs in the experiment
+   */
+  missingRunCount: number;
 }
 
 export type ExperimentRunID = string;
 
+/**
+ * Represents incomplete experiment runs for a dataset example
+ * Groups all incomplete repetitions for a single example
+ */
+export interface IncompleteRun {
+  /**
+   * The dataset example that has incomplete runs
+   */
+  datasetExample: Example;
+  /**
+   * List of repetition numbers that need to be run for this example
+   */
+  repetitionNumbers: number[];
+}
+
+export interface IncompleteEvaluation {
+  /**
+   * The experiment run with incomplete evaluations
+   */
+  experimentRun: ExperimentRun;
+  /**
+   * The dataset example for this run
+   */
+  datasetExample: ExampleWithId;
+  /**
+   * List of evaluation names that are incomplete (either missing or failed)
+   */
+  evaluationNames: string[];
+}
+
 /**
  * A map of an experiment runId to the run
  */