llama-stack-client 0.2.16 → 0.2.17-rc1

package/src/resources/synthetic-data-generation.ts

@@ -5,6 +5,9 @@ import * as Core from '../core';
 import * as Shared from './shared';
 
 export class SyntheticDataGeneration extends APIResource {
+  /**
+   * Generate synthetic data based on input dialogs and apply filtering.
+   */
   generate(
     body: SyntheticDataGenerationGenerateParams,
     options?: Core.RequestOptions,
@@ -18,19 +21,33 @@ export class SyntheticDataGeneration extends APIResource {
  * tuples that pass the threshold.
  */
 export interface SyntheticDataGenerationResponse {
+  /**
+   * List of generated synthetic data samples that passed the filtering criteria
+   */
   synthetic_data: Array<{ [key: string]: boolean | number | string | Array<unknown> | unknown | null }>;
 
+  /**
+   * (Optional) Statistical information about the generation process and filtering
+   * results
+   */
   statistics?: { [key: string]: boolean | number | string | Array<unknown> | unknown | null };
 }
 
 export interface SyntheticDataGenerationGenerateParams {
+  /**
+   * List of conversation messages to use as input for synthetic data generation
+   */
   dialogs: Array<Shared.Message>;
 
   /**
-   * The type of filtering function.
+   * Type of filtering to apply to generated synthetic data samples
    */
   filtering_function: 'none' | 'random' | 'top_k' | 'top_p' | 'top_k_top_p' | 'sigmoid';
 
+  /**
+   * (Optional) The identifier of the model to use. The model must be registered with
+   * Llama Stack and available via the /models endpoint
+   */
   model?: string;
 }
 

package/src/resources/telemetry.ts

@@ -91,152 +91,366 @@ export class Telemetry extends APIResource {
   }
 }
 
+/**
+ * An unstructured log event containing a simple text message.
+ */
 export type Event = Event.UnstructuredLogEvent | Event.MetricEvent | Event.StructuredLogEvent;
 
 export namespace Event {
+  /**
+   * An unstructured log event containing a simple text message.
+   */
   export interface UnstructuredLogEvent {
+    /**
+     * The log message text
+     */
     message: string;
 
+    /**
+     * The severity level of the log message
+     */
     severity: 'verbose' | 'debug' | 'info' | 'warn' | 'error' | 'critical';
 
+    /**
+     * Unique identifier for the span this event belongs to
+     */
     span_id: string;
 
+    /**
+     * Timestamp when the event occurred
+     */
     timestamp: string;
 
+    /**
+     * Unique identifier for the trace this event belongs to
+     */
     trace_id: string;
 
+    /**
+     * Event type identifier set to UNSTRUCTURED_LOG
+     */
     type: 'unstructured_log';
 
+    /**
+     * (Optional) Key-value pairs containing additional metadata about the event
+     */
     attributes?: { [key: string]: string | number | boolean | null };
   }
 
+  /**
+   * A metric event containing a measured value.
+   */
   export interface MetricEvent {
+    /**
+     * The name of the metric being measured
+     */
     metric: string;
 
+    /**
+     * Unique identifier for the span this event belongs to
+     */
     span_id: string;
 
+    /**
+     * Timestamp when the event occurred
+     */
     timestamp: string;
 
+    /**
+     * Unique identifier for the trace this event belongs to
+     */
     trace_id: string;
 
+    /**
+     * Event type identifier set to METRIC
+     */
     type: 'metric';
 
+    /**
+     * The unit of measurement for the metric value
+     */
     unit: string;
 
+    /**
+     * The numeric value of the metric measurement
+     */
     value: number;
 
+    /**
+     * (Optional) Key-value pairs containing additional metadata about the event
+     */
     attributes?: { [key: string]: string | number | boolean | null };
   }
 
+  /**
+   * A structured log event containing typed payload data.
+   */
   export interface StructuredLogEvent {
+    /**
+     * The structured payload data for the log event
+     */
     payload: StructuredLogEvent.SpanStartPayload | StructuredLogEvent.SpanEndPayload;
 
+    /**
+     * Unique identifier for the span this event belongs to
+     */
     span_id: string;
 
+    /**
+     * Timestamp when the event occurred
+     */
     timestamp: string;
 
+    /**
+     * Unique identifier for the trace this event belongs to
+     */
     trace_id: string;
 
+    /**
+     * Event type identifier set to STRUCTURED_LOG
+     */
     type: 'structured_log';
 
+    /**
+     * (Optional) Key-value pairs containing additional metadata about the event
+     */
     attributes?: { [key: string]: string | number | boolean | null };
   }
 
   export namespace StructuredLogEvent {
+    /**
+     * Payload for a span start event.
+     */
     export interface SpanStartPayload {
+      /**
+       * Human-readable name describing the operation this span represents
+       */
       name: string;
 
+      /**
+       * Payload type identifier set to SPAN_START
+       */
       type: 'span_start';
 
+      /**
+       * (Optional) Unique identifier for the parent span, if this is a child span
+       */
       parent_span_id?: string;
     }
 
+    /**
+     * Payload for a span end event.
+     */
     export interface SpanEndPayload {
+      /**
+       * The final status of the span indicating success or failure
+       */
       status: 'ok' | 'error';
 
+      /**
+       * Payload type identifier set to SPAN_END
+       */
       type: 'span_end';
     }
   }
 }
 
+/**
+ * A condition for filtering query results.
+ */
 export interface QueryCondition {
+  /**
+   * The attribute key to filter on
+   */
   key: string;
 
+  /**
+   * The comparison operator to apply
+   */
   op: 'eq' | 'ne' | 'gt' | 'lt';
 
+  /**
+   * The value to compare against
+   */
   value: boolean | number | string | Array<unknown> | unknown | null;
 }
 
+/**
+ * Response containing a list of spans.
+ */
 export interface QuerySpansResponse {
+  /**
+   * List of spans matching the query criteria
+   */
   data: TelemetryQuerySpansResponse;
 }
 
+/**
+ * A span that includes status information.
+ */
 export interface SpanWithStatus {
+  /**
+   * Human-readable name describing the operation this span represents
+   */
   name: string;
 
+  /**
+   * Unique identifier for the span
+   */
   span_id: string;
 
+  /**
+   * Timestamp when the operation began
+   */
   start_time: string;
 
+  /**
+   * Unique identifier for the trace this span belongs to
+   */
   trace_id: string;
 
+  /**
+   * (Optional) Key-value pairs containing additional metadata about the span
+   */
   attributes?: { [key: string]: boolean | number | string | Array<unknown> | unknown | null };
 
+  /**
+   * (Optional) Timestamp when the operation finished, if completed
+   */
   end_time?: string;
 
+  /**
+   * (Optional) Unique identifier for the parent span, if this is a child span
+   */
   parent_span_id?: string;
 
+  /**
+   * (Optional) The current status of the span
+   */
   status?: 'ok' | 'error';
 }
 
+/**
+ * A trace representing the complete execution path of a request across multiple
+ * operations.
+ */
 export interface Trace {
+  /**
+   * Unique identifier for the root span that started this trace
+   */
   root_span_id: string;
 
+  /**
+   * Timestamp when the trace began
+   */
   start_time: string;
 
+  /**
+   * Unique identifier for the trace
+   */
   trace_id: string;
 
+  /**
+   * (Optional) Timestamp when the trace finished, if completed
+   */
   end_time?: string;
 }
 
+/**
+ * A span representing a single operation within a trace.
+ */
 export interface TelemetryGetSpanResponse {
+  /**
+   * Human-readable name describing the operation this span represents
+   */
   name: string;
 
+  /**
+   * Unique identifier for the span
+   */
   span_id: string;
 
+  /**
+   * Timestamp when the operation began
+   */
   start_time: string;
 
+  /**
+   * Unique identifier for the trace this span belongs to
+   */
   trace_id: string;
 
+  /**
+   * (Optional) Key-value pairs containing additional metadata about the span
+   */
   attributes?: { [key: string]: boolean | number | string | Array<unknown> | unknown | null };
 
+  /**
+   * (Optional) Timestamp when the operation finished, if completed
+   */
   end_time?: string;
 
+  /**
+   * (Optional) Unique identifier for the parent span, if this is a child span
+   */
   parent_span_id?: string;
 }
 
+/**
+ * Dictionary mapping span IDs to spans with status information
+ */
 export type TelemetryGetSpanTreeResponse = { [key: string]: SpanWithStatus };
 
+/**
+ * List of spans matching the query criteria
+ */
 export type TelemetryQuerySpansResponse = Array<TelemetryQuerySpansResponse.TelemetryQuerySpansResponseItem>;
 
 export namespace TelemetryQuerySpansResponse {
+  /**
+   * A span representing a single operation within a trace.
+   */
   export interface TelemetryQuerySpansResponseItem {
+    /**
+     * Human-readable name describing the operation this span represents
+     */
     name: string;
 
+    /**
+     * Unique identifier for the span
+     */
     span_id: string;
 
+    /**
+     * Timestamp when the operation began
+     */
     start_time: string;
 
+    /**
+     * Unique identifier for the trace this span belongs to
+     */
     trace_id: string;
 
+    /**
+     * (Optional) Key-value pairs containing additional metadata about the span
+     */
     attributes?: { [key: string]: boolean | number | string | Array<unknown> | unknown | null };
 
+    /**
+     * (Optional) Timestamp when the operation finished, if completed
+     */
     end_time?: string;
 
+    /**
+     * (Optional) Unique identifier for the parent span, if this is a child span
+     */
     parent_span_id?: string;
   }
 }
 
+/**
+ * List of traces matching the query criteria
+ */
 export type TelemetryQueryTracesResponse = Array<Trace>;
 
 export interface TelemetryGetSpanTreeParams {

package/src/resources/tool-runtime/rag-tool.ts

@@ -6,7 +6,7 @@ import * as Shared from '../shared';
 
 export class RagTool extends APIResource {
   /**
-   * Index documents so they can be used by the RAG system
+   * Index documents so they can be used by the RAG system.
    */
   insert(body: RagToolInsertParams, options?: Core.RequestOptions): Core.APIPromise<void> {
     return this._client.post('/v1/tool-runtime/rag-tool/insert', {
@@ -17,7 +17,7 @@ export class RagTool extends APIResource {
   }
 
   /**
-   * Query the RAG system for context; typically invoked by the agent
+   * Query the RAG system for context; typically invoked by the agent.
    */
   query(body: RagToolQueryParams, options?: Core.RequestOptions): Core.APIPromise<Shared.QueryResult> {
     return this._client.post('/v1/tool-runtime/rag-tool/query', { body, ...options });
@@ -25,23 +25,35 @@ export class RagTool extends APIResource {
 }
 
 export interface RagToolInsertParams {
+  /**
+   * (Optional) Size in tokens for document chunking during indexing
+   */
   chunk_size_in_tokens: number;
 
+  /**
+   * List of documents to index in the RAG system
+   */
   documents: Array<Shared.Document>;
 
+  /**
+   * ID of the vector database to store the document embeddings
+   */
   vector_db_id: string;
 }
 
 export interface RagToolQueryParams {
   /**
-   * A image content item
+   * The query content to search for in the indexed documents
    */
   content: Shared.InterleavedContent;
 
+  /**
+   * List of vector database IDs to search within
+   */
   vector_db_ids: Array<string>;
 
   /**
-   * Configuration for the RAG query generation.
+   * (Optional) Configuration parameters for the query operation
    */
   query_config?: Shared.QueryConfig;
 }

package/src/resources/tool-runtime/tool-runtime.ts

@@ -43,43 +43,91 @@ export class ToolRuntime extends APIResource {
   }
 }
 
+/**
+ * Tool definition used in runtime contexts.
+ */
 export interface ToolDef {
+  /**
+   * Name of the tool
+   */
   name: string;
 
+  /**
+   * (Optional) Human-readable description of what the tool does
+   */
   description?: string;
 
+  /**
+   * (Optional) Additional metadata about the tool
+   */
   metadata?: { [key: string]: boolean | number | string | Array<unknown> | unknown | null };
 
+  /**
+   * (Optional) List of parameters this tool accepts
+   */
   parameters?: Array<ToolDef.Parameter>;
 }
 
 export namespace ToolDef {
+  /**
+   * Parameter definition for a tool.
+   */
   export interface Parameter {
+    /**
+     * Human-readable description of what the parameter does
+     */
     description: string;
 
+    /**
+     * Name of the parameter
+     */
     name: string;
 
+    /**
+     * Type of the parameter (e.g., string, integer)
+     */
     parameter_type: string;
 
+    /**
+     * Whether this parameter is required for tool invocation
+     */
     required: boolean;
 
+    /**
+     * (Optional) Default value for the parameter if not provided
+     */
     default?: boolean | number | string | Array<unknown> | unknown | null;
   }
 }
 
+/**
+ * Result of a tool invocation.
+ */
 export interface ToolInvocationResult {
   /**
-   * A image content item
+   * (Optional) The output content from the tool execution
    */
   content?: Shared.InterleavedContent;
 
+  /**
+   * (Optional) Numeric error code if the tool execution failed
+   */
   error_code?: number;
 
+  /**
+   * (Optional) Error message if the tool execution failed
+   */
   error_message?: string;
 
+  /**
+   * (Optional) Additional metadata about the tool execution
+   */
   metadata?: { [key: string]: boolean | number | string | Array<unknown> | unknown | null };
 }
 
+/**
+ * List of tool definitions
+ */
 export type ToolRuntimeListToolsResponse = Array<ToolDef>;
 
 export interface ToolRuntimeInvokeToolParams {
@@ -111,6 +159,9 @@ export namespace ToolRuntimeListToolsParams {
    * The MCP endpoint to use for the tool group.
    */
   export interface McpEndpoint {
+    /**
+     * The URL string pointing to the resource
+     */
     uri: string;
   }
 }

package/src/resources/toolgroups.ts

@@ -42,30 +42,57 @@ export class Toolgroups extends APIResource {
   }
 }
 
+/**
+ * Response containing a list of tool groups.
+ */
 export interface ListToolGroupsResponse {
+  /**
+   * List of tool groups
+   */
   data: ToolgroupListResponse;
 }
 
+/**
+ * A group of related tools managed together.
+ */
 export interface ToolGroup {
   identifier: string;
 
   provider_id: string;
 
+  /**
+   * Type of resource, always 'tool_group'
+   */
   type: 'tool_group';
 
+  /**
+   * (Optional) Additional arguments for the tool group
+   */
   args?: { [key: string]: boolean | number | string | Array<unknown> | unknown | null };
 
+  /**
+   * (Optional) Model Context Protocol endpoint for remote tools
+   */
   mcp_endpoint?: ToolGroup.McpEndpoint;
 
   provider_resource_id?: string;
 }
 
 export namespace ToolGroup {
+  /**
+   * (Optional) Model Context Protocol endpoint for remote tools
+   */
   export interface McpEndpoint {
+    /**
+     * The URL string pointing to the resource
+     */
     uri: string;
   }
 }
 
+/**
+ * List of tool groups
+ */
 export type ToolgroupListResponse = Array<ToolGroup>;
 
 export interface ToolgroupRegisterParams {
@@ -95,6 +122,9 @@ export namespace ToolgroupRegisterParams {
    * The MCP endpoint to use for the tool group.
    */
   export interface McpEndpoint {
+    /**
+     * The URL string pointing to the resource
+     */
     uri: string;
   }
 }