@arizeai/phoenix-client 2.0.1 → 2.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arizeai/phoenix-client",
-  "version": "2.0.1",
+  "version": "2.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

@@ -318,6 +318,26 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/projects/{project_identifier}/spans/otlpv1": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Search spans with simple filters (no DSL)
+         * @description Return spans within a project filtered by time range, annotation names, and ordered by start_time. Supports cursor-based pagination.
+         */
+        get: operations["spanSearch"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/span_annotations": {
         parameters: {
             query?: never;
@@ -1083,12 +1103,205 @@ export interface components {
          * ModelProvider
          * @enum {string}
          */
-        ModelProvider: "OPENAI" | "AZURE_OPENAI" | "ANTHROPIC" | "GOOGLE";
+        ModelProvider: "OPENAI" | "AZURE_OPENAI" | "ANTHROPIC" | "GOOGLE" | "DEEPSEEK";
         /**
          * OptimizationDirection
          * @enum {string}
          */
         OptimizationDirection: "MINIMIZE" | "MAXIMIZE" | "NONE";
+        /** OtlpAnyValue */
+        OtlpAnyValue: {
+            array_value?: components["schemas"]["OtlpArrayValue"] | null;
+            /** Bool Value */
+            bool_value?: boolean | null;
+            /** Bytes Value */
+            bytes_value?: string | null;
+            /** Double Value */
+            double_value?: number | components["schemas"]["OtlpDoubleValue"] | string | null;
+            /** Int Value */
+            int_value?: number | string | null;
+            /** Kvlist Value */
+            kvlist_value?: null;
+            /** String Value */
+            string_value?: string | null;
+        };
+        /** OtlpArrayValue */
+        OtlpArrayValue: {
+            /**
+             * Values
+             * @description Array of values. The array may be empty (contain 0 elements).
+             */
+            values?: components["schemas"]["OtlpAnyValue"][] | null;
+        };
+        /**
+         * OtlpDoubleValue
+         * @enum {string}
+         */
+        OtlpDoubleValue: "Infinity" | "-Infinity" | "NaN";
+        /** OtlpEvent */
+        OtlpEvent: {
+            /**
+             * Attributes
+             * @description attributes is a collection of attribute key/value pairs on the event. Attribute keys MUST be unique (it is not allowed to have more than one attribute with the same key).
+             */
+            attributes?: components["schemas"]["OtlpKeyValue"][] | null;
+            /**
+             * Dropped Attributes Count
+             * @description dropped_attributes_count is the number of dropped attributes. If the value is 0, then no attributes were dropped.
+             */
+            dropped_attributes_count?: number | null;
+            /**
+             * Name
+             * @description name of the event. This field is semantically required to be set to non-empty string.
+             */
+            name?: string | null;
+            /**
+             * Time Unix Nano
+             * @description time_unix_nano is the time the event occurred. Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January 1970.
+             */
+            time_unix_nano?: number | string | null;
+        };
+        /** OtlpKeyValue */
+        OtlpKeyValue: {
+            /** Key */
+            key?: string | null;
+            value?: components["schemas"]["OtlpAnyValue"] | null;
+        };
+        /**
+         * OtlpKind
+         * @enum {string}
+         */
+        OtlpKind: "SPAN_KIND_UNSPECIFIED" | "SPAN_KIND_INTERNAL" | "SPAN_KIND_SERVER" | "SPAN_KIND_CLIENT" | "SPAN_KIND_PRODUCER" | "SPAN_KIND_CONSUMER";
+        /** OtlpSpan */
+        OtlpSpan: {
+            /**
+             * Attributes
+             * @description attributes is a collection of key/value pairs. Note, global attributes like server name can be set using the resource API. Examples of attributes:
+             *
+             *         "/http/user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/71.0.3578.98 Safari/537.36"
+             *         "/http/server_latency": 300
+             *         "example.com/myattribute": true
+             *         "example.com/score": 10.239
+             *
+             *     The OpenTelemetry API specification further restricts the allowed value types:
+             *     https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/common/README.md#attribute
+             *     Attribute keys MUST be unique (it is not allowed to have more than one attribute with the same key).
+             */
+            attributes?: components["schemas"]["OtlpKeyValue"][] | null;
+            /**
+             * Dropped Attributes Count
+             * @description dropped_attributes_count is the number of attributes that were discarded. Attributes can be discarded because their keys are too long or because there are too many attributes. If this value is 0, then no attributes were dropped.
+             */
+            dropped_attributes_count?: number | null;
+            /**
+             * Dropped Events Count
+             * @description dropped_events_count is the number of dropped events. If the value is 0, then no events were dropped.
+             */
+            dropped_events_count?: number | null;
+            /**
+             * Dropped Links Count
+             * @description dropped_links_count is the number of dropped links after the maximum size was enforced. If this value is 0, then no links were dropped.
+             */
+            dropped_links_count?: number | null;
+            /**
+             * End Time Unix Nano
+             * @description end_time_unix_nano is the end time of the span. On the client side, this is the time kept by the local machine where the span execution ends. On the server side, this is the time when the server application handler stops running.
+             *     Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January 1970.
+             *
+             *     This field is semantically required and it is expected that end_time >= start_time.
+             */
+            end_time_unix_nano?: number | string | null;
+            /**
+             * Events
+             * @description events is a collection of Event items. A span with no events is valid.
+             */
+            events?: components["schemas"]["OtlpEvent"][] | null;
+            /**
+             * Flags
+             * @description Flags, a bit field.
+             *
+             *     Bits 0-7 (8 least significant bits) are the trace flags as defined in W3C Trace Context specification. To read the 8-bit W3C trace flag, use `flags & SPAN_FLAGS_TRACE_FLAGS_MASK`.
+             *
+             *     See https://www.w3.org/TR/trace-context-2/#trace-flags for the flag definitions.
+             *
+             *     Bits 8 and 9 represent the 3 states of whether a span's parent is remote. The states are (unknown, is not remote, is remote).
+             *     To read whether the value is known, use `(flags & SPAN_FLAGS_CONTEXT_HAS_IS_REMOTE_MASK) != 0`.
+             *     To read whether the span is remote, use `(flags & SPAN_FLAGS_CONTEXT_IS_REMOTE_MASK) != 0`.
+             *
+             *     When creating span messages, if the message is logically forwarded from another source with an equivalent flags fields (i.e., usually another OTLP span message), the field SHOULD be copied as-is. If creating from a source that does not have an equivalent flags field (such as a runtime representation of an OpenTelemetry span), the high 22 bits MUST be set to zero.
+             *     Readers MUST NOT assume that bits 10-31 (22 most significant bits) will be zero.
+             *
+             *     [Optional].
+             */
+            flags?: number | null;
+            /**
+             * Kind
+             * @description Distinguishes between spans generated in a particular context. For example, two spans with the same name may be distinguished using `CLIENT` (caller) and `SERVER` (callee) to identify queueing latency associated with the span.
+             * @default SPAN_KIND_INTERNAL
+             */
+            kind?: components["schemas"]["OtlpKind"] | number | null;
+            /** Links */
+            links?: null;
+            /**
+             * Name
+             * @description A description of the span's operation.
+             *
+             *     For example, the name can be a qualified method name or a file name and a line number where the operation is called. A best practice is to use the same display name at the same call point in an application. This makes it easier to correlate spans in different traces.
+             *
+             *     This field is semantically required to be set to non-empty string. Empty value is equivalent to an unknown span name.
+             *
+             *     This field is required.
+             */
+            name?: string | null;
+            /**
+             * Parent Span Id
+             * @description The `span_id` of this span's parent span. If this is a root span, then this field must be empty. The ID is an 8-byte array.
+             */
+            parent_span_id?: string | null;
+            /**
+             * Span Id
+             * @description A unique identifier for a span within a trace, assigned when the span is created. The ID is an 8-byte array. An ID with all zeroes OR of length other than 8 bytes is considered invalid (empty string in OTLP/JSON is zero-length and thus is also invalid).
+             *
+             *     This field is required.
+             */
+            span_id?: string | null;
+            /**
+             * Start Time Unix Nano
+             * @description start_time_unix_nano is the start time of the span. On the client side, this is the time kept by the local machine where the span execution starts. On the server side, this is the time when the server's application handler starts running.
+             *     Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January 1970.
+             *
+             *     This field is semantically required and it is expected that end_time >= start_time.
+             */
+            start_time_unix_nano?: number | string | null;
+            /** @description An optional final status for this span. Semantically when Status isn't set, it means span's status code is unset, i.e. assume STATUS_CODE_UNSET (code = 0). */
+            status?: components["schemas"]["OtlpStatus"] | null;
+            /**
+             * Trace Id
+             * @description A unique identifier for a trace. All spans from the same trace share the same `trace_id`. The ID is a 16-byte array. An ID with all zeroes OR of length other than 16 bytes is considered invalid (empty string in OTLP/JSON is zero-length and thus is also invalid).
+             *
+             *     This field is required.
+             */
+            trace_id?: string | null;
+            /**
+             * Trace State
+             * @description trace_state conveys information about request position in multiple distributed tracing graphs. It is a trace_state in w3c-trace-context format: https://www.w3.org/TR/trace-context/#tracestate-header
+             *     See also https://github.com/w3c/distributed-tracing for more details about this field.
+             */
+            trace_state?: string | null;
+        };
+        /** OtlpStatus */
+        OtlpStatus: {
+            /**
+             * Code
+             * @description The status code.
+             */
+            code?: number | null;
+            /**
+             * Message
+             * @description A developer-facing human readable error message.
+             */
+            message?: string | null;
+        };
         /** Project */
         Project: {
             /** Name */
@@ -1197,6 +1410,37 @@ export interface components {
             /** Source Prompt Id */
             source_prompt_id?: string | null;
         };
+        /** PromptDeepSeekInvocationParameters */
+        PromptDeepSeekInvocationParameters: {
+            /**
+             * @description discriminator enum property added by openapi-typescript
+             * @enum {string}
+             */
+            type: "deepseek";
+            deepseek: components["schemas"]["PromptDeepSeekInvocationParametersContent"];
+        };
+        /** PromptDeepSeekInvocationParametersContent */
+        PromptDeepSeekInvocationParametersContent: {
+            /** Temperature */
+            temperature?: number;
+            /** Max Tokens */
+            max_tokens?: number;
+            /** Max Completion Tokens */
+            max_completion_tokens?: number;
+            /** Frequency Penalty */
+            frequency_penalty?: number;
+            /** Presence Penalty */
+            presence_penalty?: number;
+            /** Top P */
+            top_p?: number;
+            /** Seed */
+            seed?: number;
+            /**
+             * Reasoning Effort
+             * @enum {string}
+             */
+            reasoning_effort?: "low" | "medium" | "high";
+        };
         /** PromptGoogleInvocationParameters */
         PromptGoogleInvocationParameters: {
             /**
@@ -1388,7 +1632,7 @@ export interface components {
             template_type: components["schemas"]["PromptTemplateType"];
             template_format: components["schemas"]["PromptTemplateFormat"];
             /** Invocation Parameters */
-            invocation_parameters: components["schemas"]["PromptOpenAIInvocationParameters"] | components["schemas"]["PromptAzureOpenAIInvocationParameters"] | components["schemas"]["PromptAnthropicInvocationParameters"] | components["schemas"]["PromptGoogleInvocationParameters"];
+            invocation_parameters: components["schemas"]["PromptOpenAIInvocationParameters"] | components["schemas"]["PromptAzureOpenAIInvocationParameters"] | components["schemas"]["PromptAnthropicInvocationParameters"] | components["schemas"]["PromptGoogleInvocationParameters"] | components["schemas"]["PromptDeepSeekInvocationParameters"];
             tools?: components["schemas"]["PromptTools"] | null;
             /** Response Format */
             response_format?: components["schemas"]["PromptResponseFormatJSONSchema"] | null;
@@ -1407,7 +1651,7 @@ export interface components {
             template_type: components["schemas"]["PromptTemplateType"];
             template_format: components["schemas"]["PromptTemplateFormat"];
             /** Invocation Parameters */
-            invocation_parameters: components["schemas"]["PromptOpenAIInvocationParameters"] | components["schemas"]["PromptAzureOpenAIInvocationParameters"] | components["schemas"]["PromptAnthropicInvocationParameters"] | components["schemas"]["PromptGoogleInvocationParameters"];
+            invocation_parameters: components["schemas"]["PromptOpenAIInvocationParameters"] | components["schemas"]["PromptAzureOpenAIInvocationParameters"] | components["schemas"]["PromptAnthropicInvocationParameters"] | components["schemas"]["PromptGoogleInvocationParameters"] | components["schemas"]["PromptDeepSeekInvocationParameters"];
             tools?: components["schemas"]["PromptTools"] | null;
             /** Response Format */
             response_format?: components["schemas"]["PromptResponseFormatJSONSchema"] | null;
@@ -1538,6 +1782,16 @@ export interface components {
             /** Next Cursor */
             next_cursor: string | null;
         };
+        /**
+         * SpanSearchResponseBody
+         * @description Paginated response where each span follows OTLP JSON structure.
+         */
+        SpanSearchResponseBody: {
+            /** Data */
+            data: components["schemas"]["OtlpSpan"][];
+            /** Next Cursor */
+            next_cursor: string | null;
+        };
         /** TextContentPart */
         TextContentPart: {
             /**
@@ -1604,6 +1858,8 @@ export interface components {
         UploadDatasetData: {
             /** Dataset Id */
             dataset_id: string;
+            /** Version Id */
+            version_id: string;
         };
         /** UploadDatasetResponseBody */
         UploadDatasetResponseBody: {
@@ -2728,6 +2984,15 @@ export interface operations {
                     "text/plain": string;
                 };
             };
+            /** @description This experiment run has already been submitted */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
             /** @description Validation Error */
             422: {
                 headers: {
@@ -2790,6 +3055,69 @@ export interface operations {
             };
         };
     };
+    spanSearch: {
+        parameters: {
+            query?: {
+                /** @description Pagination cursor (GlobalID of Span) */
+                cursor?: string | null;
+                /** @description Maximum number of spans to return */
+                limit?: number;
+                /** @description Sort direction for the sort field */
+                sort_direction?: "asc" | "desc";
+                /** @description Inclusive lower bound time */
+                start_time?: string | null;
+                /** @description Exclusive upper bound time */
+                end_time?: string | null;
+                /** @description If provided, only include spans that have at least one annotation with one of these names. */
+                annotationNames?: string[] | null;
+            };
+            header?: never;
+            path: {
+                /** @description The project identifier: either project ID or project name. If using a project name, it cannot contain slash (/), question mark (?), or pound sign (#) characters. */
+                project_identifier: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["SpanSearchResponseBody"];
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** @description Unprocessable Entity */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+        };
+    };
     annotateSpans: {
         parameters: {
             query?: {

package/src/prompts/createPrompt.ts

@@ -102,11 +102,17 @@ interface GooglePromptVersionInput extends PromptVersionInputBase {
   invocationParameters?: GoogleInvocationParameters;
 }
 
+interface DeepSeekPromptVersionInput extends PromptVersionInputBase {
+  modelProvider: "DEEPSEEK";
+  invocationParameters?: OpenAIInvocationParameters;
+}
+
 type PromptVersionInput =
   | OpenAIPromptVersionInput
   | AzureOpenAIPromptVersionInput
   | AnthropicPromptVersionInput
-  | GooglePromptVersionInput;
+  | GooglePromptVersionInput
+  | DeepSeekPromptVersionInput;
 
 /**
  * A helper function to construct a prompt version declaratively.
@@ -190,6 +196,22 @@ export function promptVersion(params: PromptVersionInput): PromptVersionData {
           google: invocation_parameters ?? {},
         },
       };
+    case "DEEPSEEK":
+      return {
+        description,
+        model_provider,
+        model_name,
+        template_type: "CHAT",
+        template_format,
+        template: {
+          type: "chat",
+          messages: templateMessages,
+        },
+        invocation_parameters: {
+          type: "deepseek",
+          deepseek: invocation_parameters ?? {},
+        },
+      };
     default:
       assertUnreachable(model_provider);
   }