llama-stack-client 0.2.16 → 0.2.17

package/src/resources/datasets.ts

@@ -85,27 +85,42 @@ export class Datasets extends APIResource {
   }
 }
 
+/**
+ * Response from listing datasets.
+ */
 export interface ListDatasetsResponse {
+  /**
+   * List of datasets
+   */
   data: DatasetListResponse;
 }
 
+/**
+ * Dataset resource for storing and accessing training or evaluation data.
+ */
 export interface DatasetRetrieveResponse {
   identifier: string;
 
+  /**
+   * Additional metadata for the dataset
+   */
   metadata: { [key: string]: boolean | number | string | Array<unknown> | unknown | null };
 
   provider_id: string;
 
   /**
-   * Purpose of the dataset. Each purpose has a required input data schema.
+   * Purpose of the dataset indicating its intended use
    */
   purpose: 'post-training/messages' | 'eval/question-answer' | 'eval/messages-answer';
 
   /**
-   * A dataset that can be obtained from a URI.
+   * Data source configuration for the dataset
    */
   source: DatasetRetrieveResponse.UriDataSource | DatasetRetrieveResponse.RowsDataSource;
 
+  /**
+   * Type of resource, always 'dataset' for datasets
+   */
   type: 'dataset';
 
   provider_resource_id?: string;
@@ -141,26 +156,38 @@ export namespace DatasetRetrieveResponse {
   }
 }
 
+/**
+ * List of datasets
+ */
 export type DatasetListResponse = Array<DatasetListResponse.DatasetListResponseItem>;
 
 export namespace DatasetListResponse {
+  /**
+   * Dataset resource for storing and accessing training or evaluation data.
+   */
   export interface DatasetListResponseItem {
     identifier: string;
 
+    /**
+     * Additional metadata for the dataset
+     */
     metadata: { [key: string]: boolean | number | string | Array<unknown> | unknown | null };
 
     provider_id: string;
 
     /**
-     * Purpose of the dataset. Each purpose has a required input data schema.
+     * Purpose of the dataset indicating its intended use
      */
     purpose: 'post-training/messages' | 'eval/question-answer' | 'eval/messages-answer';
 
     /**
-     * A dataset that can be obtained from a URI.
+     * Data source configuration for the dataset
      */
     source: DatasetListResponseItem.UriDataSource | DatasetListResponseItem.RowsDataSource;
 
+    /**
+     * Type of resource, always 'dataset' for datasets
+     */
     type: 'dataset';
 
     provider_resource_id?: string;
@@ -217,23 +244,32 @@ export interface DatasetIterrowsResponse {
   url?: string;
 }
 
+/**
+ * Dataset resource for storing and accessing training or evaluation data.
+ */
 export interface DatasetRegisterResponse {
   identifier: string;
 
+  /**
+   * Additional metadata for the dataset
+   */
   metadata: { [key: string]: boolean | number | string | Array<unknown> | unknown | null };
 
   provider_id: string;
 
   /**
-   * Purpose of the dataset. Each purpose has a required input data schema.
+   * Purpose of the dataset indicating its intended use
    */
   purpose: 'post-training/messages' | 'eval/question-answer' | 'eval/messages-answer';
 
   /**
-   * A dataset that can be obtained from a URI.
+   * Data source configuration for the dataset
    */
   source: DatasetRegisterResponse.UriDataSource | DatasetRegisterResponse.RowsDataSource;
 
+  /**
+   * Type of resource, always 'dataset' for datasets
+   */
   type: 'dataset';
 
   provider_resource_id?: string;

package/src/resources/eval/eval.ts

@@ -129,9 +129,18 @@ export interface EvaluateResponse {
   scores: { [key: string]: Shared.ScoringResult };
 }
 
+/**
+ * A job execution instance with status tracking.
+ */
 export interface Job {
+  /**
+   * Unique identifier for the job
+   */
   job_id: string;
 
+  /**
+   * Current execution status of the job
+   */
   status: 'completed' | 'in_progress' | 'failed' | 'scheduled' | 'cancelled';
 }
 

package/src/resources/files.ts

@@ -122,10 +122,19 @@ export interface ListFilesResponse {
    */
   data: Array<File>;
 
+  /**
+   * ID of the first file in the list for pagination
+   */
   first_id: string;
 
+  /**
+   * Whether there are more files available beyond this page
+   */
   has_more: boolean;
 
+  /**
+   * ID of the last file in the list for pagination
+   */
   last_id: string;
 
   /**

package/src/resources/index.ts

@@ -106,7 +106,13 @@ export {
   type ResponseListParams,
 } from './responses/responses';
 export { Routes, type ListRoutesResponse, type RouteListResponse } from './routes';
-export { Safety, type RunShieldResponse, type SafetyRunShieldParams } from './safety';
+export {
+  Safety,
+  type CreateResponse,
+  type RunShieldResponse,
+  type SafetyCreateParams,
+  type SafetyRunShieldParams,
+} from './safety';
 export {
   Scoring,
   type ScoringScoreResponse,

package/src/resources/inference.ts

@@ -106,6 +106,9 @@ export interface ChatCompletionResponseStreamChunk {
    */
   event: ChatCompletionResponseStreamChunk.Event;
 
+  /**
+   * (Optional) List of metrics associated with the API response
+   */
   metrics?: Array<ChatCompletionResponseStreamChunk.Metric>;
 }
 
@@ -136,11 +139,23 @@ 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;
   }
 }
@@ -164,15 +179,30 @@ export interface CompletionResponse {
    */
   logprobs?: Array<TokenLogProbs>;
 
+  /**
+   * (Optional) List of metrics associated with the API response
+   */
   metrics?: Array<CompletionResponse.Metric>;
 }
 
 export namespace CompletionResponse {
+  /**
+   * 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;
   }
 }
@@ -199,7 +229,13 @@ export interface TokenLogProbs {
   logprobs_by_token: { [key: string]: number };
 }
 
+/**
+ * Response from a batch chat completion request.
+ */
 export interface InferenceBatchChatCompletionResponse {
+  /**
+   * List of chat completion responses, one for each conversation in the batch
+   */
   batch: Array<Shared.ChatCompletionResponse>;
 }
 

package/src/resources/inspect.ts

@@ -5,7 +5,7 @@ import * as Core from '../core';
 
 export class Inspect extends APIResource {
   /**
-   * Get the health of the service.
+   * Get the current health status of the service.
    */
   health(options?: Core.RequestOptions): Core.APIPromise<HealthInfo> {
     return this._client.get('/v1/health', options);
@@ -19,31 +19,75 @@ export class Inspect extends APIResource {
   }
 }
 
+/**
+ * Health status information for the service.
+ */
 export interface HealthInfo {
+  /**
+   * Current health status of the service
+   */
   status: 'OK' | 'Error' | 'Not Implemented';
 }
 
+/**
+ * Information about a registered provider including its configuration and health
+ * status.
+ */
 export interface ProviderInfo {
+  /**
+   * The API name this provider implements
+   */
   api: string;
 
+  /**
+   * Configuration parameters for the provider
+   */
   config: { [key: string]: boolean | number | string | Array<unknown> | unknown | null };
 
+  /**
+   * Current health status of the provider
+   */
   health: { [key: string]: boolean | number | string | Array<unknown> | unknown | null };
 
+  /**
+   * Unique identifier for the provider
+   */
   provider_id: string;
 
+  /**
+   * The type of provider implementation
+   */
   provider_type: string;
 }
 
+/**
+ * Information about an API route including its path, method, and implementing
+ * providers.
+ */
 export interface RouteInfo {
+  /**
+   * HTTP method for the route
+   */
   method: string;
 
+  /**
+   * List of provider types that implement this route
+   */
   provider_types: Array<string>;
 
+  /**
+   * The API endpoint path
+   */
   route: string;
 }
 
+/**
+ * Version information for the service.
+ */
 export interface VersionInfo {
+  /**
+   * Version number of the service
+   */
   version: string;
 }
 

package/src/resources/models.ts

@@ -42,17 +42,38 @@ export interface ListModelsResponse {
   data: ModelListResponse;
 }
 
+/**
+ * A model resource representing an AI model registered in Llama Stack.
+ */
 export interface Model {
+  /**
+   * Unique identifier for this resource in llama stack
+   */
   identifier: string;
 
+  /**
+   * Any additional metadata for this model
+   */
   metadata: { [key: string]: boolean | number | string | Array<unknown> | unknown | null };
 
+  /**
+   * The type of model (LLM or embedding model)
+   */
   model_type: 'llm' | 'embedding';
 
+  /**
+   * ID of the provider that owns this resource
+   */
   provider_id: string;
 
+  /**
+   * The resource type, always 'model' for model resources
+   */
   type: 'model';
 
+  /**
+   * Unique identifier for this resource in the provider
+   */
   provider_resource_id?: string;
 }
 

package/src/resources/post-training/job.ts

@@ -56,37 +56,76 @@ export namespace JobListResponse {
  * Artifacts of a finetuning job.
  */
 export interface JobArtifactsResponse {
+  /**
+   * List of model checkpoints created during training
+   */
   checkpoints: Array<JobArtifactsResponse.Checkpoint>;
 
+  /**
+   * Unique identifier for the training job
+   */
   job_uuid: string;
 }
 
 export namespace JobArtifactsResponse {
   /**
-   * Checkpoint created during training runs
+   * Checkpoint created during training runs.
    */
   export interface Checkpoint {
+    /**
+     * Timestamp when the checkpoint was created
+     */
     created_at: string;
 
+    /**
+     * Training epoch when the checkpoint was saved
+     */
     epoch: number;
 
+    /**
+     * Unique identifier for the checkpoint
+     */
     identifier: string;
 
+    /**
+     * File system path where the checkpoint is stored
+     */
     path: string;
 
+    /**
+     * Identifier of the training job that created this checkpoint
+     */
     post_training_job_id: string;
 
+    /**
+     * (Optional) Training metrics associated with this checkpoint
+     */
     training_metrics?: Checkpoint.TrainingMetrics;
   }
 
   export namespace Checkpoint {
+    /**
+     * (Optional) Training metrics associated with this checkpoint
+     */
     export interface TrainingMetrics {
+      /**
+       * Training epoch number
+       */
       epoch: number;
 
+      /**
+       * Perplexity metric indicating model confidence
+       */
       perplexity: number;
 
+      /**
+       * Loss value on the training dataset
+       */
       train_loss: number;
 
+      /**
+       * Loss value on the validation dataset
+       */
       validation_loss: number;
     }
   }
@@ -96,47 +135,101 @@ export namespace JobArtifactsResponse {
  * Status of a finetuning job.
  */
 export interface JobStatusResponse {
+  /**
+   * List of model checkpoints created during training
+   */
   checkpoints: Array<JobStatusResponse.Checkpoint>;
 
+  /**
+   * Unique identifier for the training job
+   */
   job_uuid: string;
 
+  /**
+   * Current status of the training job
+   */
   status: 'completed' | 'in_progress' | 'failed' | 'scheduled' | 'cancelled';
 
+  /**
+   * (Optional) Timestamp when the job finished, if completed
+   */
   completed_at?: string;
 
+  /**
+   * (Optional) Information about computational resources allocated to the job
+   */
   resources_allocated?: { [key: string]: boolean | number | string | Array<unknown> | unknown | null };
 
+  /**
+   * (Optional) Timestamp when the job was scheduled
+   */
   scheduled_at?: string;
 
+  /**
+   * (Optional) Timestamp when the job execution began
+   */
   started_at?: string;
 }
 
 export namespace JobStatusResponse {
   /**
-   * Checkpoint created during training runs
+   * Checkpoint created during training runs.
    */
   export interface Checkpoint {
+    /**
+     * Timestamp when the checkpoint was created
+     */
     created_at: string;
 
+    /**
+     * Training epoch when the checkpoint was saved
+     */
     epoch: number;
 
+    /**
+     * Unique identifier for the checkpoint
+     */
     identifier: string;
 
+    /**
+     * File system path where the checkpoint is stored
+     */
     path: string;
 
+    /**
+     * Identifier of the training job that created this checkpoint
+     */
     post_training_job_id: string;
 
+    /**
+     * (Optional) Training metrics associated with this checkpoint
+     */
     training_metrics?: Checkpoint.TrainingMetrics;
   }
 
   export namespace Checkpoint {
+    /**
+     * (Optional) Training metrics associated with this checkpoint
+     */
     export interface TrainingMetrics {
+      /**
+       * Training epoch number
+       */
       epoch: number;
 
+      /**
+       * Perplexity metric indicating model confidence
+       */
       perplexity: number;
 
+      /**
+       * Loss value on the training dataset
+       */
       train_loss: number;
 
+      /**
+       * Loss value on the validation dataset
+       */
       validation_loss: number;
     }
   }