feat(api): some updates to query metrics

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
-configured_endpoints: 106
+configured_endpoints: 107
 openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/llamastack%2Fllama-stack-client-f252873ea1e1f38fd207331ef2621c511154d5be3f4076e59cc15754fc58eee4.yml
 openapi_spec_hash: 10cbb4337a06a9fdd7d08612dd6044c3
-config_hash: ddcbd66d7ac80290da208232a746e30f
+config_hash: 17fe64b23723fc54f2ee61c80223c3e3

api.md

@@ -450,12 +450,14 @@ Methods:
 Types:
 
 - <code><a href="./src/resources/telemetry.ts">Event</a></code>
+- <code><a href="./src/resources/telemetry.ts">Metric</a></code>
 - <code><a href="./src/resources/telemetry.ts">QueryCondition</a></code>
 - <code><a href="./src/resources/telemetry.ts">QuerySpansResponse</a></code>
 - <code><a href="./src/resources/telemetry.ts">SpanWithStatus</a></code>
 - <code><a href="./src/resources/telemetry.ts">Trace</a></code>
 - <code><a href="./src/resources/telemetry.ts">TelemetryGetSpanResponse</a></code>
 - <code><a href="./src/resources/telemetry.ts">TelemetryGetSpanTreeResponse</a></code>
+- <code><a href="./src/resources/telemetry.ts">TelemetryQueryMetricsResponse</a></code>
 - <code><a href="./src/resources/telemetry.ts">TelemetryQuerySpansResponse</a></code>
 - <code><a href="./src/resources/telemetry.ts">TelemetryQueryTracesResponse</a></code>
 
@@ -465,6 +467,7 @@ Methods:
 - <code title="post /v1/telemetry/spans/{span_id}/tree">client.telemetry.<a href="./src/resources/telemetry.ts">getSpanTree</a>(spanId, { ...params }) -> TelemetryGetSpanTreeResponse</code>
 - <code title="get /v1/telemetry/traces/{trace_id}">client.telemetry.<a href="./src/resources/telemetry.ts">getTrace</a>(traceId) -> Trace</code>
 - <code title="post /v1/telemetry/events">client.telemetry.<a href="./src/resources/telemetry.ts">logEvent</a>({ ...params }) -> void</code>
+- <code title="post /v1/telemetry/metrics/{metric_name}">client.telemetry.<a href="./src/resources/telemetry.ts">queryMetrics</a>(metricName, { ...params }) -> TelemetryQueryMetricsResponse</code>
 - <code title="post /v1/telemetry/spans">client.telemetry.<a href="./src/resources/telemetry.ts">querySpans</a>({ ...params }) -> TelemetryQuerySpansResponse</code>
 - <code title="post /v1/telemetry/traces">client.telemetry.<a href="./src/resources/telemetry.ts">queryTraces</a>({ ...params }) -> TelemetryQueryTracesResponse</code>
 - <code title="post /v1/telemetry/spans/export">client.telemetry.<a href="./src/resources/telemetry.ts">saveSpansToDataset</a>({ ...params }) -> void</code>

src/index.ts

@@ -106,6 +106,7 @@ import {
 } from './resources/synthetic-data-generation';
 import {
   Event,
+  Metric,
   QueryCondition,
   QuerySpansResponse,
   SpanWithStatus,
@@ -114,6 +115,8 @@ import {
   TelemetryGetSpanTreeParams,
   TelemetryGetSpanTreeResponse,
   TelemetryLogEventParams,
+  TelemetryQueryMetricsParams,
+  TelemetryQueryMetricsResponse,
   TelemetryQuerySpansParams,
   TelemetryQuerySpansResponse,
   TelemetryQueryTracesParams,
@@ -645,16 +648,19 @@ export declare namespace LlamaStackClient {
   export {
     Telemetry as Telemetry,
     type Event as Event,
+    type Metric as Metric,
     type QueryCondition as QueryCondition,
     type QuerySpansResponse as QuerySpansResponse,
     type SpanWithStatus as SpanWithStatus,
     type Trace as Trace,
     type TelemetryGetSpanResponse as TelemetryGetSpanResponse,
     type TelemetryGetSpanTreeResponse as TelemetryGetSpanTreeResponse,
+    type TelemetryQueryMetricsResponse as TelemetryQueryMetricsResponse,
     type TelemetryQuerySpansResponse as TelemetryQuerySpansResponse,
     type TelemetryQueryTracesResponse as TelemetryQueryTracesResponse,
     type TelemetryGetSpanTreeParams as TelemetryGetSpanTreeParams,
     type TelemetryLogEventParams as TelemetryLogEventParams,
+    type TelemetryQueryMetricsParams as TelemetryQueryMetricsParams,
     type TelemetryQuerySpansParams as TelemetryQuerySpansParams,
     type TelemetryQueryTracesParams as TelemetryQueryTracesParams,
     type TelemetrySaveSpansToDatasetParams as TelemetrySaveSpansToDatasetParams,

src/resources/index.ts

@@ -139,16 +139,19 @@ export {
 export {
   Telemetry,
   type Event,
+  type Metric,
   type QueryCondition,
   type QuerySpansResponse,
   type SpanWithStatus,
   type Trace,
   type TelemetryGetSpanResponse,
   type TelemetryGetSpanTreeResponse,
+  type TelemetryQueryMetricsResponse,
   type TelemetryQuerySpansResponse,
   type TelemetryQueryTracesResponse,
   type TelemetryGetSpanTreeParams,
   type TelemetryLogEventParams,
+  type TelemetryQueryMetricsParams,
   type TelemetryQuerySpansParams,
   type TelemetryQueryTracesParams,
   type TelemetrySaveSpansToDatasetParams,

src/resources/inference.ts

@@ -5,6 +5,7 @@ import { APIPromise } from '../core';
 import * as Core from '../core';
 import * as InferenceAPI from './inference';
 import * as Shared from './shared';
+import * as TelemetryAPI from './telemetry';
 import { Stream } from '../streaming';
 
 export class Inference extends APIResource {
@@ -109,7 +110,7 @@ export interface ChatCompletionResponseStreamChunk {
   /**
    * (Optional) List of metrics associated with the API response
    */
-  metrics?: Array<ChatCompletionResponseStreamChunk.Metric>;
+  metrics?: Array<TelemetryAPI.Metric>;
 }
 
 export namespace ChatCompletionResponseStreamChunk {
@@ -138,26 +139,6 @@ export namespace ChatCompletionResponseStreamChunk {
      */
     stop_reason?: 'end_of_turn' | 'end_of_message' | 'out_of_tokens';
   }
-
-  /**
-   * A metric value included in API responses.
-   */
-  export interface Metric {
-    /**
-     * The name of the metric
-     */
-    metric: string;
-
-    /**
-     * The numeric value of the metric
-     */
-    value: number;
-
-    /**
-     * (Optional) The unit of measurement for the metric value
-     */
-    unit?: string;
-  }
 }
 
 /**

src/resources/shared.ts

@@ -1,6 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import * as Shared from './shared';
+import * as TelemetryAPI from './telemetry';
 
 /**
  * Configuration for an agent.
@@ -193,29 +194,7 @@ export namespace BatchCompletion {
     /**
      * (Optional) List of metrics associated with the API response
      */
-    metrics?: Array<Batch.Metric>;
-  }
-
-  export namespace Batch {
-    /**
-     * A metric value included in API responses.
-     */
-    export interface Metric {
-      /**
-       * The name of the metric
-       */
-      metric: string;
-
-      /**
-       * The numeric value of the metric
-       */
-      value: number;
-
-      /**
-       * (Optional) The unit of measurement for the metric value
-       */
-      unit?: string;
-    }
+    metrics?: Array<TelemetryAPI.Metric>;
   }
 }
 
@@ -236,29 +215,7 @@ export interface ChatCompletionResponse {
   /**
    * (Optional) List of metrics associated with the API response
    */
-  metrics?: Array<ChatCompletionResponse.Metric>;
-}
-
-export namespace ChatCompletionResponse {
-  /**
-   * A metric value included in API responses.
-   */
-  export interface Metric {
-    /**
-     * The name of the metric
-     */
-    metric: string;
-
-    /**
-     * The numeric value of the metric
-     */
-    value: number;
-
-    /**
-     * (Optional) The unit of measurement for the metric value
-     */
-    unit?: string;
-  }
+  metrics?: Array<TelemetryAPI.Metric>;
 }
 
 /**

src/resources/telemetry.ts

@@ -48,6 +48,21 @@ export class Telemetry extends APIResource {
     });
   }
 
+  /**
+   * Query metrics.
+   */
+  queryMetrics(
+    metricName: string,
+    body: TelemetryQueryMetricsParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<TelemetryQueryMetricsResponse> {
+    return (
+      this._client.post(`/v1/telemetry/metrics/${metricName}`, { body, ...options }) as Core.APIPromise<{
+        data: TelemetryQueryMetricsResponse;
+      }>
+    )._thenUnwrap((obj) => obj.data);
+  }
+
   /**
    * Query spans.
    */
@@ -255,6 +270,26 @@ export namespace Event {
   }
 }
 
+/**
+ * A metric value included in API responses.
+ */
+export interface Metric {
+  /**
+   * The name of the metric
+   */
+  metric: string;
+
+  /**
+   * The numeric value of the metric
+   */
+  value: number;
+
+  /**
+   * (Optional) The unit of measurement for the metric value
+   */
+  unit?: string;
+}
+
 /**
  * A condition for filtering query results.
  */
@@ -401,6 +436,68 @@ export interface TelemetryGetSpanResponse {
  */
 export type TelemetryGetSpanTreeResponse = { [key: string]: SpanWithStatus };
 
+/**
+ * List of metric series matching the query criteria
+ */
+export type TelemetryQueryMetricsResponse =
+  Array<TelemetryQueryMetricsResponse.TelemetryQueryMetricsResponseItem>;
+
+export namespace TelemetryQueryMetricsResponse {
+  /**
+   * A time series of metric data points.
+   */
+  export interface TelemetryQueryMetricsResponseItem {
+    /**
+     * List of labels associated with this metric series
+     */
+    labels: Array<TelemetryQueryMetricsResponseItem.Label>;
+
+    /**
+     * The name of the metric
+     */
+    metric: string;
+
+    /**
+     * List of data points in chronological order
+     */
+    values: Array<TelemetryQueryMetricsResponseItem.Value>;
+  }
+
+  export namespace TelemetryQueryMetricsResponseItem {
+    /**
+     * A label associated with a metric.
+     */
+    export interface Label {
+      /**
+       * The name of the label
+       */
+      name: string;
+
+      /**
+       * The value of the label
+       */
+      value: string;
+    }
+
+    /**
+     * A single data point in a metric time series.
+     */
+    export interface Value {
+      /**
+       * Unix timestamp when the metric value was recorded
+       */
+      timestamp: number;
+
+      unit: string;
+
+      /**
+       * The numeric value of the metric at this timestamp
+       */
+      value: number;
+    }
+  }
+}
+
 /**
  * List of spans matching the query criteria
  */
@@ -477,6 +574,55 @@ export interface TelemetryLogEventParams {
   ttl_seconds: number;
 }
 
+export interface TelemetryQueryMetricsParams {
+  /**
+   * The type of query to perform.
+   */
+  query_type: 'range' | 'instant';
+
+  /**
+   * The start time of the metric to query.
+   */
+  start_time: number;
+
+  /**
+   * The end time of the metric to query.
+   */
+  end_time?: number;
+
+  /**
+   * The granularity of the metric to query.
+   */
+  granularity?: string;
+
+  /**
+   * The label matchers to apply to the metric.
+   */
+  label_matchers?: Array<TelemetryQueryMetricsParams.LabelMatcher>;
+}
+
+export namespace TelemetryQueryMetricsParams {
+  /**
+   * A matcher for filtering metrics by label values.
+   */
+  export interface LabelMatcher {
+    /**
+     * The name of the label to match
+     */
+    name: string;
+
+    /**
+     * The comparison operator to use for matching
+     */
+    operator: '=' | '!=' | '=~' | '!~';
+
+    /**
+     * The value to match against
+     */
+    value: string;
+  }
+}
+
 export interface TelemetryQuerySpansParams {
   /**
    * The attribute filters to apply to the spans.
@@ -541,16 +687,19 @@ export interface TelemetrySaveSpansToDatasetParams {
 export declare namespace Telemetry {
   export {
     type Event as Event,
+    type Metric as Metric,
     type QueryCondition as QueryCondition,
     type QuerySpansResponse as QuerySpansResponse,
     type SpanWithStatus as SpanWithStatus,
     type Trace as Trace,
     type TelemetryGetSpanResponse as TelemetryGetSpanResponse,
     type TelemetryGetSpanTreeResponse as TelemetryGetSpanTreeResponse,
+    type TelemetryQueryMetricsResponse as TelemetryQueryMetricsResponse,
     type TelemetryQuerySpansResponse as TelemetryQuerySpansResponse,
     type TelemetryQueryTracesResponse as TelemetryQueryTracesResponse,
     type TelemetryGetSpanTreeParams as TelemetryGetSpanTreeParams,
     type TelemetryLogEventParams as TelemetryLogEventParams,
+    type TelemetryQueryMetricsParams as TelemetryQueryMetricsParams,
     type TelemetryQuerySpansParams as TelemetryQuerySpansParams,
     type TelemetryQueryTracesParams as TelemetryQueryTracesParams,
     type TelemetrySaveSpansToDatasetParams as TelemetrySaveSpansToDatasetParams,