llama-stack-client 0.4.4 → 0.4.5

package/src/resources/alpha/eval/eval.ts

@@ -61,7 +61,7 @@ export class Eval extends APIResource {
  */
 export interface BenchmarkConfig {
   /**
-   * A model candidate for evaluation.
+   * The candidate to evaluate
    */
   eval_candidate: BenchmarkConfig.EvalCandidate;
 
@@ -85,13 +85,16 @@ export interface BenchmarkConfig {
 
 export namespace BenchmarkConfig {
   /**
-   * A model candidate for evaluation.
+   * The candidate to evaluate
    */
   export interface EvalCandidate {
+    /**
+     * The model ID to evaluate
+     */
     model: string;
 
     /**
-     * Sampling parameters.
+     * The sampling parameters for the model
      */
     sampling_params: Shared.SamplingParams;
 
@@ -164,8 +167,14 @@ export namespace BenchmarkConfig {
  * The response from an evaluation.
  */
 export interface EvaluateResponse {
+  /**
+   * The generations from the evaluation
+   */
   generations: Array<{ [key: string]: unknown }>;
 
+  /**
+   * The scores from the evaluation. Each key in the dict is a scoring function name
+   */
   scores: { [key: string]: Shared.ScoringResult };
 }
 
@@ -183,36 +192,48 @@ export interface Job {
 
 export interface EvalEvaluateRowsParams {
   /**
-   * A benchmark configuration for evaluation.
+   * The configuration for the benchmark
    */
   benchmark_config: BenchmarkConfig;
 
+  /**
+   * The rows to evaluate
+   */
   input_rows: Array<{ [key: string]: unknown }>;
 
+  /**
+   * The scoring functions to use for the evaluation
+   */
   scoring_functions: Array<string>;
 }
 
 export interface EvalEvaluateRowsAlphaParams {
   /**
-   * A benchmark configuration for evaluation.
+   * The configuration for the benchmark
    */
   benchmark_config: BenchmarkConfig;
 
+  /**
+   * The rows to evaluate
+   */
   input_rows: Array<{ [key: string]: unknown }>;
 
+  /**
+   * The scoring functions to use for the evaluation
+   */
   scoring_functions: Array<string>;
 }
 
 export interface EvalRunEvalParams {
   /**
-   * A benchmark configuration for evaluation.
+   * The configuration for the benchmark
    */
   benchmark_config: BenchmarkConfig;
 }
 
 export interface EvalRunEvalAlphaParams {
   /**
-   * A benchmark configuration for evaluation.
+   * The configuration for the benchmark
    */
   benchmark_config: BenchmarkConfig;
 }

package/src/resources/alpha/index.ts

@@ -6,6 +6,7 @@
 //
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
+export { Admin, type AdminListRoutesParams } from './admin';
 export { Alpha } from './alpha';
 export {
   Benchmarks,
@@ -28,6 +29,7 @@ export { Inference, type InferenceRerankResponse, type InferenceRerankParams } f
 export {
   PostTraining,
   type AlgorithmConfig,
+  type ListPostTrainingJobsResponse,
   type PostTrainingJob,
   type PostTrainingPreferenceOptimizeParams,
   type PostTrainingSupervisedFineTuneParams,

package/src/resources/alpha/inference.ts

@@ -25,6 +25,9 @@ export class Inference extends APIResource {
   }
 }
 
+/**
+ * List of rerank result objects, sorted by relevance score (descending).
+ */
 export type InferenceRerankResponse = Array<InferenceRerankResponse.InferenceRerankResponseItem>;
 
 export namespace InferenceRerankResponse {
@@ -32,29 +35,47 @@ export namespace InferenceRerankResponse {
    * A single rerank result from a reranking response.
    */
   export interface InferenceRerankResponseItem {
+    /**
+     * The original index of the document in the input list.
+     */
     index: number;
 
+    /**
+     * The relevance score from the model output. Higher scores indicate greater
+     * relevance.
+     */
     relevance_score: number;
   }
 }
 
 export interface InferenceRerankParams {
+  /**
+   * List of items to rerank. Each item can be a string, text content part, or image
+   * content part.
+   */
   items: Array<
     | string
     | InferenceRerankParams.OpenAIChatCompletionContentPartTextParam
     | InferenceRerankParams.OpenAIChatCompletionContentPartImageParam
   >;
 
+  /**
+   * The identifier of the reranking model to use.
+   */
   model: string;
 
   /**
-   * Text content part for OpenAI-compatible chat completion messages.
+   * The search query to rank items against. Can be a string, text content part, or
+   * image content part.
    */
   query:
     | string
     | InferenceRerankParams.OpenAIChatCompletionContentPartTextParam
     | InferenceRerankParams.OpenAIChatCompletionContentPartImageParam;
 
+  /**
+   * Maximum number of results to return. Default: returns all.
+   */
   max_num_results?: number | null;
 }
 
@@ -63,8 +84,14 @@ export namespace InferenceRerankParams {
    * Text content part for OpenAI-compatible chat completion messages.
    */
   export interface OpenAIChatCompletionContentPartTextParam {
+    /**
+     * The text content of the message.
+     */
     text: string;
 
+    /**
+     * Must be 'text' to identify this as text content.
+     */
     type?: 'text';
   }
 
@@ -73,21 +100,30 @@ export namespace InferenceRerankParams {
    */
   export interface OpenAIChatCompletionContentPartImageParam {
     /**
-     * Image URL specification for OpenAI-compatible chat completion messages.
+     * Image URL specification and processing details.
      */
     image_url: OpenAIChatCompletionContentPartImageParam.ImageURL;
 
+    /**
+     * Must be 'image_url' to identify this as image content.
+     */
     type?: 'image_url';
   }
 
   export namespace OpenAIChatCompletionContentPartImageParam {
     /**
-     * Image URL specification for OpenAI-compatible chat completion messages.
+     * Image URL specification and processing details.
      */
     export interface ImageURL {
+      /**
+       * URL of the image to include in the message.
+       */
       url: string;
 
-      detail?: string | null;
+      /**
+       * Level of detail for image processing. Can be 'low', 'high', or 'auto'.
+       */
+      detail?: 'low' | 'high' | 'auto' | null;
     }
   }
 
@@ -95,8 +131,14 @@ export namespace InferenceRerankParams {
    * Text content part for OpenAI-compatible chat completion messages.
    */
   export interface OpenAIChatCompletionContentPartTextParam {
+    /**
+     * The text content of the message.
+     */
     text: string;
 
+    /**
+     * Must be 'text' to identify this as text content.
+     */
     type?: 'text';
   }
 
@@ -105,21 +147,30 @@ export namespace InferenceRerankParams {
    */
   export interface OpenAIChatCompletionContentPartImageParam {
     /**
-     * Image URL specification for OpenAI-compatible chat completion messages.
+     * Image URL specification and processing details.
      */
     image_url: OpenAIChatCompletionContentPartImageParam.ImageURL;
 
+    /**
+     * Must be 'image_url' to identify this as image content.
+     */
     type?: 'image_url';
   }
 
   export namespace OpenAIChatCompletionContentPartImageParam {
     /**
-     * Image URL specification for OpenAI-compatible chat completion messages.
+     * Image URL specification and processing details.
      */
     export interface ImageURL {
+      /**
+       * URL of the image to include in the message.
+       */
       url: string;
 
-      detail?: string | null;
+      /**
+       * Level of detail for image processing. Can be 'low', 'high', or 'auto'.
+       */
+      detail?: 'low' | 'high' | 'auto' | null;
     }
   }
 }

package/src/resources/alpha/post-training/index.ts

@@ -6,19 +6,11 @@
 //
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-export {
-  Job,
-  type ListPostTrainingJobsResponse,
-  type JobListResponse,
-  type JobArtifactsResponse,
-  type JobStatusResponse,
-  type JobArtifactsParams,
-  type JobCancelParams,
-  type JobStatusParams,
-} from './job';
+export { Job, type JobListResponse, type JobArtifactsResponse, type JobStatusResponse } from './job';
 export {
   PostTraining,
   type AlgorithmConfig,
+  type ListPostTrainingJobsResponse,
   type PostTrainingJob,
   type PostTrainingPreferenceOptimizeParams,
   type PostTrainingSupervisedFineTuneParams,

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

@@ -23,16 +23,15 @@ export class Job extends APIResource {
   /**
    * Get the artifacts of a training job.
    */
-  artifacts(query: JobArtifactsParams, options?: Core.RequestOptions): Core.APIPromise<JobArtifactsResponse> {
-    return this._client.get('/v1alpha/post-training/job/artifacts', { query, ...options });
+  artifacts(options?: Core.RequestOptions): Core.APIPromise<JobArtifactsResponse> {
+    return this._client.get('/v1alpha/post-training/job/artifacts', options);
   }
 
   /**
    * Cancel a training job.
    */
-  cancel(body: JobCancelParams, options?: Core.RequestOptions): Core.APIPromise<void> {
+  cancel(options?: Core.RequestOptions): Core.APIPromise<void> {
     return this._client.post('/v1alpha/post-training/job/cancel', {
-      body,
       ...options,
       headers: { Accept: '*/*', ...options?.headers },
     });
@@ -41,15 +40,11 @@ export class Job extends APIResource {
   /**
    * Get the status of a training job.
    */
-  status(query: JobStatusParams, options?: Core.RequestOptions): Core.APIPromise<JobStatusResponse> {
-    return this._client.get('/v1alpha/post-training/job/status', { query, ...options });
+  status(options?: Core.RequestOptions): Core.APIPromise<JobStatusResponse> {
+    return this._client.get('/v1alpha/post-training/job/status', options);
   }
 }
 
-export interface ListPostTrainingJobsResponse {
-  data: JobListResponse;
-}
-
 export type JobListResponse = Array<PostTrainingAPI.PostTrainingJob>;
 
 /**
@@ -157,26 +152,10 @@ export namespace JobStatusResponse {
   }
 }
 
-export interface JobArtifactsParams {
-  job_uuid: string;
-}
-
-export interface JobCancelParams {
-  job_uuid: string;
-}
-
-export interface JobStatusParams {
-  job_uuid: string;
-}
-
 export declare namespace Job {
   export {
-    type ListPostTrainingJobsResponse as ListPostTrainingJobsResponse,
     type JobListResponse as JobListResponse,
     type JobArtifactsResponse as JobArtifactsResponse,
     type JobStatusResponse as JobStatusResponse,
-    type JobArtifactsParams as JobArtifactsParams,
-    type JobCancelParams as JobCancelParams,
-    type JobStatusParams as JobStatusParams,
   };
 }

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

@@ -9,16 +9,7 @@
 import { APIResource } from '../../../resource';
 import * as Core from '../../../core';
 import * as JobAPI from './job';
-import {
-  Job,
-  JobArtifactsParams,
-  JobArtifactsResponse,
-  JobCancelParams,
-  JobListResponse,
-  JobStatusParams,
-  JobStatusResponse,
-  ListPostTrainingJobsResponse,
-} from './job';
+import { Job, JobArtifactsResponse, JobListResponse, JobStatusResponse } from './job';
 
 export class PostTraining extends APIResource {
   job: JobAPI.Job = new JobAPI.Job(this._client);
@@ -83,33 +74,49 @@ export namespace AlgorithmConfig {
   }
 }
 
+export interface ListPostTrainingJobsResponse {
+  data: JobAPI.JobListResponse;
+}
+
 export interface PostTrainingJob {
   job_uuid: string;
 }
 
 export interface PostTrainingPreferenceOptimizeParams {
   /**
-   * Configuration for Direct Preference Optimization (DPO) alignment.
+   * The algorithm configuration.
    */
   algorithm_config: PostTrainingPreferenceOptimizeParams.AlgorithmConfig;
 
+  /**
+   * The model to fine-tune.
+   */
   finetuned_model: string;
 
+  /**
+   * The hyperparam search configuration.
+   */
   hyperparam_search_config: { [key: string]: unknown };
 
+  /**
+   * The UUID of the job to create.
+   */
   job_uuid: string;
 
+  /**
+   * The logger configuration.
+   */
   logger_config: { [key: string]: unknown };
 
   /**
-   * Comprehensive configuration for the training process.
+   * The training configuration.
    */
   training_config: PostTrainingPreferenceOptimizeParams.TrainingConfig;
 }
 
 export namespace PostTrainingPreferenceOptimizeParams {
   /**
-   * Configuration for Direct Preference Optimization (DPO) alignment.
+   * The algorithm configuration.
    */
   export interface AlgorithmConfig {
     beta: number;
@@ -118,7 +125,7 @@ export namespace PostTrainingPreferenceOptimizeParams {
   }
 
   /**
-   * Comprehensive configuration for the training process.
+   * The training configuration.
    */
   export interface TrainingConfig {
     n_epochs: number;
@@ -202,36 +209,48 @@ export namespace PostTrainingPreferenceOptimizeParams {
 }
 
 export interface PostTrainingSupervisedFineTuneParams {
+  /**
+   * The hyperparam search configuration.
+   */
   hyperparam_search_config: { [key: string]: unknown };
 
+  /**
+   * The UUID of the job to create.
+   */
   job_uuid: string;
 
+  /**
+   * The logger configuration.
+   */
   logger_config: { [key: string]: unknown };
 
   /**
-   * Comprehensive configuration for the training process.
+   * The training configuration.
    */
   training_config: PostTrainingSupervisedFineTuneParams.TrainingConfig;
 
   /**
-   * Configuration for Low-Rank Adaptation (LoRA) fine-tuning.
+   * The algorithm configuration.
    */
   algorithm_config?:
     | PostTrainingSupervisedFineTuneParams.LoraFinetuningConfig
     | PostTrainingSupervisedFineTuneParams.QatFinetuningConfig
     | null;
 
+  /**
+   * The directory to save checkpoint(s) to.
+   */
   checkpoint_dir?: string | null;
 
   /**
-   * Model descriptor for training if not in provider config`
+   * Model descriptor for training if not in provider config
    */
   model?: string | null;
 }
 
 export namespace PostTrainingSupervisedFineTuneParams {
   /**
-   * Comprehensive configuration for the training process.
+   * The training configuration.
    */
   export interface TrainingConfig {
     n_epochs: number;
@@ -351,6 +370,7 @@ PostTraining.Job = Job;
 export declare namespace PostTraining {
   export {
     type AlgorithmConfig as AlgorithmConfig,
+    type ListPostTrainingJobsResponse as ListPostTrainingJobsResponse,
     type PostTrainingJob as PostTrainingJob,
     type PostTrainingPreferenceOptimizeParams as PostTrainingPreferenceOptimizeParams,
     type PostTrainingSupervisedFineTuneParams as PostTrainingSupervisedFineTuneParams,
@@ -358,12 +378,8 @@ export declare namespace PostTraining {
 
   export {
     Job as Job,
-    type ListPostTrainingJobsResponse as ListPostTrainingJobsResponse,
     type JobListResponse as JobListResponse,
     type JobArtifactsResponse as JobArtifactsResponse,
     type JobStatusResponse as JobStatusResponse,
-    type JobArtifactsParams as JobArtifactsParams,
-    type JobCancelParams as JobCancelParams,
-    type JobStatusParams as JobStatusParams,
   };
 }