@arizeai/phoenix-client 3.0.0 → 3.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arizeai/phoenix-client",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "description": "A client for the Phoenix API",
   "main": "dist/src/index.js",
   "module": "dist/esm/index.js",

package/src/__generated__/api/v1.ts

@@ -2351,11 +2351,11 @@ export interface components {
              * @description The end time of the evaluation in ISO format
              */
             end_time: string;
-            /** @description The result of the evaluation */
-            result: components["schemas"]["ExperimentEvaluationResult"];
+            /** @description The result of the evaluation. Either result or error must be provided. */
+            result?: components["schemas"]["ExperimentEvaluationResult"] | null;
             /**
              * Error
-             * @description Optional error message if the evaluation encountered an error
+             * @description Error message if the evaluation encountered an error. Either result or error must be provided.
              */
             error?: string | null;
             /**

package/src/experiments/instrumention.ts

@@ -1,10 +1,16 @@
 import { diag, DiagConsoleLogger, DiagLogLevel } from "@opentelemetry/api";
 import { OTLPTraceExporter } from "@opentelemetry/exporter-trace-otlp-proto";
 import { resourceFromAttributes } from "@opentelemetry/resources";
-import { NodeTracerProvider } from "@opentelemetry/sdk-trace-node";
+import {
+  NodeTracerProvider,
+  SpanProcessor,
+} from "@opentelemetry/sdk-trace-node";
 import { SEMRESATTRS_PROJECT_NAME } from "@arizeai/openinference-semantic-conventions";
 import { HeadersOptions } from "openapi-fetch";
-import { OpenInferenceSimpleSpanProcessor } from "@arizeai/openinference-vercel";
+import {
+  OpenInferenceBatchSpanProcessor,
+  OpenInferenceSimpleSpanProcessor,
+} from "@arizeai/openinference-vercel";
 
 /**
  * Creates a provider that exports traces to Phoenix.
@@ -13,9 +19,15 @@ export function createProvider({
   projectName,
   baseUrl,
   headers,
+  useBatchSpanProcessor = true,
 }: {
   projectName: string;
   headers: HeadersOptions;
+  /**
+   * Whether to use batching for the span processor.
+   * @default true
+   */
+  useBatchSpanProcessor: boolean;
   /**
    * The base URL of the Phoenix. Doesn't include the /v1/traces path.
    */
@@ -23,22 +35,23 @@ export function createProvider({
 }) {
   diag.setLogger(new DiagConsoleLogger(), DiagLogLevel.ERROR);
 
+  const exporter = new OTLPTraceExporter({
+    url: `${baseUrl}/v1/traces`,
+    headers: Array.isArray(headers) ? Object.fromEntries(headers) : headers,
+  });
+
+  let spanProcessor: SpanProcessor;
+  if (useBatchSpanProcessor) {
+    spanProcessor = new OpenInferenceBatchSpanProcessor({ exporter });
+  } else {
+    spanProcessor = new OpenInferenceSimpleSpanProcessor({ exporter });
+  }
+
   const provider = new NodeTracerProvider({
     resource: resourceFromAttributes({
       [SEMRESATTRS_PROJECT_NAME]: projectName,
     }),
-    spanProcessors: [
-      // We opt to use the OpenInferenceSimpleSpanProcessor instead of the SimpleSpanProcessor
-      // Since so many AI applications use the AI SDK
-      new OpenInferenceSimpleSpanProcessor({
-        exporter: new OTLPTraceExporter({
-          url: `${baseUrl}/v1/traces`,
-          headers: Array.isArray(headers)
-            ? Object.fromEntries(headers)
-            : headers,
-        }),
-      }),
-    ],
+    spanProcessors: [spanProcessor],
   });
 
   return provider;

package/src/experiments/runExperiment.ts

@@ -94,6 +94,11 @@ export type RunExperimentParams = ClientFn & {
    * @default true
    */
   setGlobalTracerProvider?: boolean;
+  /**
+   * Whether to use batching for the span processor.
+   * @default true
+   */
+  useBatchSpanProcessor?: boolean;
 };
 
 /**
@@ -141,6 +146,7 @@ export async function runExperiment({
   concurrency = 5,
   dryRun = false,
   setGlobalTracerProvider = true,
+  useBatchSpanProcessor = true,
 }: RunExperimentParams): Promise<RanExperiment> {
   let provider: NodeTracerProvider | undefined;
   const isDryRun = typeof dryRun === "number" || dryRun === true;
@@ -201,6 +207,7 @@ export async function runExperiment({
       projectName,
       baseUrl,
       headers: client.config.headers ?? {},
+      useBatchSpanProcessor,
     });
     // Register the provider
     if (setGlobalTracerProvider) {
@@ -276,6 +283,7 @@ export async function runExperiment({
     concurrency,
     dryRun,
     setGlobalTracerProvider,
+    useBatchSpanProcessor,
   });
   ranExperiment.evaluationRuns = evaluationRuns;
 
@@ -421,6 +429,7 @@ export async function evaluateExperiment({
   concurrency = 5,
   dryRun = false,
   setGlobalTracerProvider = true,
+  useBatchSpanProcessor = true,
 }: {
   /**
    * The experiment to evaluate
@@ -445,6 +454,11 @@ export async function evaluateExperiment({
    * @default true
    */
   setGlobalTracerProvider?: boolean;
+  /**
+   * Whether to use batching for the span processor.
+   * @default true
+   */
+  useBatchSpanProcessor?: boolean;
 }): Promise<RanExperiment> {
   const isDryRun = typeof dryRun === "number" || dryRun === true;
   const client = _client ?? createClient();
@@ -459,6 +473,7 @@ export async function evaluateExperiment({
       projectName: "evaluators",
       baseUrl,
       headers: client.config.headers ?? {},
+      useBatchSpanProcessor,
     });
     if (setGlobalTracerProvider) {
       provider.register();

package/src/schemas/llm/converters.ts

@@ -38,7 +38,7 @@ export const safelyConvertMessageToProvider = <
     );
     // convert the OpenAI format to the target provider format
     return fromOpenAIMessage({ message: openAIMessage, targetProvider });
-  } catch (e) {
+  } catch {
     return null;
   }
 };
@@ -64,7 +64,7 @@ export const safelyConvertToolCallToProvider = <
       toolCall: openAIToolCall,
       targetProvider,
     });
-  } catch (e) {
+  } catch {
     return null;
   }
 };
@@ -90,7 +90,7 @@ export const safelyConvertToolDefinitionToProvider = <
       toolDefinition: openAIToolDefinition,
       targetProvider,
     });
-  } catch (e) {
+  } catch {
     return null;
   }
 };
@@ -116,7 +116,7 @@ export const safelyConvertToolChoiceToProvider = <
       toolChoice: openAIToolChoice,
       targetProvider,
     });
-  } catch (e) {
+  } catch {
     return null;
   }
 };