@arizeai/phoenix-client 7.14.0 → 7.16.0

package/dist/esm/types/annotationConfigs.d.ts

@@ -0,0 +1,35 @@
+import type { components } from "../__generated__/api/v1.js";
+/**
+ * An annotation configuration as returned by the Phoenix REST API.
+ */
+export type AnnotationConfig = components["schemas"]["CategoricalAnnotationConfig"] | components["schemas"]["ContinuousAnnotationConfig"] | components["schemas"]["FreeformAnnotationConfig"];
+/**
+ * Identifies an annotation configuration. Accepts any of:
+ * - `config` — an annotation config ID or name (the server accepts either)
+ * - `configId` — an explicit annotation config ID
+ * - `configName` — an explicit annotation config name
+ *
+ * Exactly one of these may be given. All three are sent to the server as the
+ * same `config_identifier`, which is tried as a GlobalID before a name. Prefer
+ * `configId` when a name may contain `/`, which the server cannot route in a
+ * path parameter.
+ */
+export type AnnotationConfigIdentifier = {
+    config: string;
+    configId?: never;
+    configName?: never;
+} | {
+    configId: string;
+    config?: never;
+    configName?: never;
+} | {
+    configName: string;
+    config?: never;
+    configId?: never;
+};
+/**
+ * Resolves an {@link AnnotationConfigIdentifier} union to a plain string
+ * suitable for the REST `config_identifier` path parameter.
+ */
+export declare function resolveAnnotationConfigIdentifier(identifier: AnnotationConfigIdentifier): string;
+//# sourceMappingURL=annotationConfigs.d.ts.map

package/dist/esm/types/annotationConfigs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"annotationConfigs.d.ts","sourceRoot":"","sources":["../../../src/types/annotationConfigs.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAE1D;;GAEG;AACH,MAAM,MAAM,gBAAgB,GACxB,UAAU,CAAC,SAAS,CAAC,CAAC,6BAA6B,CAAC,GACpD,UAAU,CAAC,SAAS,CAAC,CAAC,4BAA4B,CAAC,GACnD,UAAU,CAAC,SAAS,CAAC,CAAC,0BAA0B,CAAC,CAAC;AAEtD;;;;;;;;;;GAUG;AACH,MAAM,MAAM,0BAA0B,GAClC;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,KAAK,CAAC;IAAC,UAAU,CAAC,EAAE,KAAK,CAAA;CAAE,GACxD;IAAE,QAAQ,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,KAAK,CAAC;IAAC,UAAU,CAAC,EAAE,KAAK,CAAA;CAAE,GACxD;IAAE,UAAU,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,KAAK,CAAC;IAAC,QAAQ,CAAC,EAAE,KAAK,CAAA;CAAE,CAAC;AAE7D;;;GAGG;AACH,wBAAgB,iCAAiC,CAC/C,UAAU,EAAE,0BAA0B,GACrC,MAAM,CAIR"}

package/dist/esm/types/annotationConfigs.js

@@ -0,0 +1,12 @@
+/**
+ * Resolves an {@link AnnotationConfigIdentifier} union to a plain string
+ * suitable for the REST `config_identifier` path parameter.
+ */
+export function resolveAnnotationConfigIdentifier(identifier) {
+    if (identifier.config !== undefined)
+        return identifier.config;
+    if (identifier.configId !== undefined)
+        return identifier.configId;
+    return identifier.configName;
+}
+//# sourceMappingURL=annotationConfigs.js.map

package/dist/esm/types/annotationConfigs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"annotationConfigs.js","sourceRoot":"","sources":["../../../src/types/annotationConfigs.ts"],"names":[],"mappings":"AA0BA;;;GAGG;AACH,MAAM,UAAU,iCAAiC,CAC/C,UAAsC;IAEtC,IAAI,UAAU,CAAC,MAAM,KAAK,SAAS;QAAE,OAAO,UAAU,CAAC,MAAM,CAAC;IAC9D,IAAI,UAAU,CAAC,QAAQ,KAAK,SAAS;QAAE,OAAO,UAAU,CAAC,QAAQ,CAAC;IAClE,OAAO,UAAU,CAAC,UAAU,CAAC;AAC/B,CAAC"}

package/dist/esm/utils/resolvePromptVersionId.d.ts

@@ -0,0 +1,11 @@
+import type { GetPromptByVersionSelector } from "../types/prompts.js";
+/**
+ * Resolve a version selector to the `{prompt_version_id}` path segment used by
+ * the Phoenix REST API.
+ *
+ * @param prompt - The prompt, selected by version ID.
+ * @returns The prompt version ID to interpolate into the request path.
+ * @throws An error if the selector does not contain a non-empty version ID.
+ */
+export declare function resolvePromptVersionId(prompt: GetPromptByVersionSelector): string;
+//# sourceMappingURL=resolvePromptVersionId.d.ts.map

package/dist/esm/utils/resolvePromptVersionId.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"resolvePromptVersionId.d.ts","sourceRoot":"","sources":["../../../src/utils/resolvePromptVersionId.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,kBAAkB,CAAC;AAEnE;;;;;;;GAOG;AACH,wBAAgB,sBAAsB,CACpC,MAAM,EAAE,0BAA0B,GACjC,MAAM,CAKR"}

package/dist/esm/utils/resolvePromptVersionId.js

@@ -0,0 +1,15 @@
+/**
+ * Resolve a version selector to the `{prompt_version_id}` path segment used by
+ * the Phoenix REST API.
+ *
+ * @param prompt - The prompt, selected by version ID.
+ * @returns The prompt version ID to interpolate into the request path.
+ * @throws An error if the selector does not contain a non-empty version ID.
+ */
+export function resolvePromptVersionId(prompt) {
+    if (!prompt.versionId) {
+        throw new Error("versionId must be a non-empty prompt version id.");
+    }
+    return prompt.versionId;
+}
+//# sourceMappingURL=resolvePromptVersionId.js.map

package/dist/esm/utils/resolvePromptVersionId.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resolvePromptVersionId.js","sourceRoot":"","sources":["../../../src/utils/resolvePromptVersionId.ts"],"names":[],"mappings":"AAEA;;;;;;;GAOG;AACH,MAAM,UAAU,sBAAsB,CACpC,MAAkC;IAElC,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC;QACtB,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;IACtE,CAAC;IACD,OAAO,MAAM,CAAC,SAAS,CAAC;AAC1B,CAAC"}

package/dist/src/__generated__/api/v1.d.ts

@@ -10579,10 +10579,14 @@ export interface operations {
     getSpans: {
         parameters: {
             query?: {
-                /** @description Pagination cursor (Span Global ID) */
+                /** @description Pagination cursor: the next_cursor of a previous response with the same sort */
                 cursor?: string | null;
                 /** @description Maximum number of spans to return */
                 limit?: number;
+                /** @description Sort field. 'id' orders by insertion; 'start_time' orders by when the span started, breaking ties by id. */
+                sort?: "id" | "start_time";
+                /** @description Sort direction */
+                order?: "asc" | "desc";
                 /** @description Inclusive lower bound time */
                 start_time?: string | null;
                 /** @description Exclusive upper bound time */