llama-stack-client 0.4.3 → 0.4.5

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,15 +6,7 @@
 //
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-export {
-  Job,
-  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,

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,8 +40,8 @@ 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);
   }
 }
 
@@ -153,25 +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 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,15 +9,7 @@
 import { APIResource } from '../../../resource';
 import * as Core from '../../../core';
 import * as JobAPI from './job';
-import {
-  Job,
-  JobArtifactsParams,
-  JobArtifactsResponse,
-  JobCancelParams,
-  JobListResponse,
-  JobStatusParams,
-  JobStatusResponse,
-} from './job';
+import { Job, JobArtifactsResponse, JobListResponse, JobStatusResponse } from './job';
 
 export class PostTraining extends APIResource {
   job: JobAPI.Job = new JobAPI.Job(this._client);
@@ -92,27 +84,39 @@ export interface PostTrainingJob {
 
 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;
@@ -121,7 +125,7 @@ export namespace PostTrainingPreferenceOptimizeParams {
   }
 
   /**
-   * Comprehensive configuration for the training process.
+   * The training configuration.
    */
   export interface TrainingConfig {
     n_epochs: number;
@@ -205,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;
@@ -365,8 +381,5 @@ export declare namespace PostTraining {
     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/beta/datasets.ts

@@ -351,12 +351,26 @@ export namespace DatasetRegisterResponse {
 }
 
 export interface DatasetAppendrowsParams {
+  /**
+   * The ID of the dataset to append the rows to.
+   */
+  body_dataset_id: string;
+
+  /**
+   * The rows to append to the dataset.
+   */
   rows: Array<{ [key: string]: unknown }>;
 }
 
 export interface DatasetIterrowsParams {
+  /**
+   * The number of rows to get.
+   */
   limit?: number | null;
 
+  /**
+   * Index into dataset for the first row to get. Get all rows if None.
+   */
   start_index?: number | null;
 }
 

package/src/resources/chat/chat.ts

@@ -27,14 +27,29 @@ export class Chat extends APIResource {
  * Chunk from a streaming response to an OpenAI-compatible chat completion request.
  */
 export interface ChatCompletionChunk {
+  /**
+   * The ID of the chat completion.
+   */
   id: string;
 
+  /**
+   * List of choices.
+   */
   choices: Array<ChatCompletionChunk.Choice>;
 
+  /**
+   * The Unix timestamp in seconds when the chat completion was created.
+   */
   created: number;
 
+  /**
+   * The model that was used to generate the chat completion.
+   */
   model: string;
 
+  /**
+   * The object type.
+   */
   object?: 'chat.completion.chunk';
 
   /**
@@ -49,14 +64,20 @@ export namespace ChatCompletionChunk {
    */
   export interface Choice {
     /**
-     * A delta from an OpenAI-compatible chat completion streaming response.
+     * The delta from the chunk.
      */
     delta: Choice.Delta;
 
-    finish_reason: string;
-
+    /**
+     * The index of the choice.
+     */
     index: number;
 
+    /**
+     * The reason the model stopped generating.
+     */
+    finish_reason?: 'stop' | 'length' | 'tool_calls' | 'content_filter' | 'function_call' | null;
+
     /**
      * The log probabilities for the tokens in the message from an OpenAI-compatible
      * chat completion response.
@@ -66,17 +87,32 @@ export namespace ChatCompletionChunk {
 
   export namespace Choice {
     /**
-     * A delta from an OpenAI-compatible chat completion streaming response.
+     * The delta from the chunk.
      */
     export interface Delta {
+      /**
+       * The content of the delta.
+       */
       content?: string | null;
 
+      /**
+       * The reasoning content from the model (for o1/o3 models).
+       */
       reasoning_content?: string | null;
 
+      /**
+       * The refusal of the delta.
+       */
       refusal?: string | null;
 
+      /**
+       * The role of the delta.
+       */
       role?: string | null;
 
+      /**
+       * The tool calls of the delta.
+       */
       tool_calls?: Array<Delta.ToolCall> | null;
     }
 
@@ -85,6 +121,9 @@ export namespace ChatCompletionChunk {
        * Tool call specification for OpenAI-compatible chat completion responses.
        */
       export interface ToolCall {
+        /**
+         * Unique identifier for the tool call.
+         */
         id?: string | null;
 
         /**
@@ -92,8 +131,14 @@ export namespace ChatCompletionChunk {
          */
         function?: ToolCall.Function | null;
 
+        /**
+         * Index of the tool call in the list.
+         */
         index?: number | null;
 
+        /**
+         * Must be 'function' to identify this as a function call.
+         */
         type?: 'function';
       }
 
@@ -102,8 +147,14 @@ export namespace ChatCompletionChunk {
          * Function call details for OpenAI-compatible tool calls.
          */
         export interface Function {
+          /**
+           * Arguments to pass to the function as a JSON string.
+           */
           arguments?: string | null;
 
+          /**
+           * Name of the function to call.
+           */
           name?: string | null;
         }
       }
@@ -114,8 +165,14 @@ export namespace ChatCompletionChunk {
      * chat completion response.
      */
     export interface Logprobs {
+      /**
+       * The log probabilities for the tokens in the message.
+       */
       content?: Array<Logprobs.Content> | null;
 
+      /**
+       * The log probabilities for the refusal tokens.
+       */
       refusal?: Array<Logprobs.Refusal> | null;
     }
 
@@ -123,17 +180,26 @@ export namespace ChatCompletionChunk {
       /**
        * The log probability for a token from an OpenAI-compatible chat completion
        * response.
-       *
-       * :token: The token :bytes: (Optional) The bytes for the token :logprob: The log
-       * probability of the token :top_logprobs: The top log probabilities for the token
        */
       export interface Content {
+        /**
+         * The token.
+         */
         token: string;
 
+        /**
+         * The log probability of the token.
+         */
         logprob: number;
 
+        /**
+         * The bytes for the token.
+         */
         bytes?: Array<number> | null;
 
+        /**
+         * The top log probabilities for the token.
+         */
         top_logprobs?: Array<Content.TopLogprob> | null;
       }
 
@@ -141,15 +207,21 @@ export namespace ChatCompletionChunk {
         /**
          * The top log probability for a token from an OpenAI-compatible chat completion
          * response.
-         *
-         * :token: The token :bytes: (Optional) The bytes for the token :logprob: The log
-         * probability of the token
          */
         export interface TopLogprob {
+          /**
+           * The token.
+           */
           token: string;
 
+          /**
+           * The log probability of the token.
+           */
           logprob: number;
 
+          /**
+           * The bytes for the token.
+           */
           bytes?: Array<number> | null;
         }
       }
@@ -157,17 +229,26 @@ export namespace ChatCompletionChunk {
       /**
        * The log probability for a token from an OpenAI-compatible chat completion
        * response.
-       *
-       * :token: The token :bytes: (Optional) The bytes for the token :logprob: The log
-       * probability of the token :top_logprobs: The top log probabilities for the token
        */
       export interface Refusal {
+        /**
+         * The token.
+         */
         token: string;
 
+        /**
+         * The log probability of the token.
+         */
         logprob: number;
 
+        /**
+         * The bytes for the token.
+         */
         bytes?: Array<number> | null;
 
+        /**
+         * The top log probabilities for the token.
+         */
         top_logprobs?: Array<Refusal.TopLogprob> | null;
       }
 
@@ -175,15 +256,21 @@ export namespace ChatCompletionChunk {
         /**
          * The top log probability for a token from an OpenAI-compatible chat completion
          * response.
-         *
-         * :token: The token :bytes: (Optional) The bytes for the token :logprob: The log
-         * probability of the token
          */
         export interface TopLogprob {
+          /**
+           * The token.
+           */
           token: string;
 
+          /**
+           * The log probability of the token.
+           */
           logprob: number;
 
+          /**
+           * The bytes for the token.
+           */
           bytes?: Array<number> | null;
         }
       }
@@ -194,10 +281,19 @@ export namespace ChatCompletionChunk {
    * Usage information for OpenAI chat completion.
    */
   export interface Usage {
+    /**
+     * Number of tokens in the completion.
+     */
     completion_tokens: number;
 
+    /**
+     * Number of tokens in the prompt.
+     */
     prompt_tokens: number;
 
+    /**
+     * Total tokens used (prompt + completion).
+     */
     total_tokens: number;
 
     /**
@@ -216,6 +312,9 @@ export namespace ChatCompletionChunk {
      * Token details for output tokens in OpenAI chat completion usage.
      */
     export interface CompletionTokensDetails {
+      /**
+       * Number of tokens used for reasoning (o1/o3 models).
+       */
       reasoning_tokens?: number | null;
     }
 
@@ -223,6 +322,9 @@ export namespace ChatCompletionChunk {
      * Token details for prompt tokens in OpenAI chat completion usage.
      */
     export interface PromptTokensDetails {
+      /**
+       * Number of tokens retrieved from cache.
+       */
       cached_tokens?: number | null;
     }
   }