llama-stack-client 0.4.4 → 0.4.5

package/dist/src/resources/beta/datasets.ts

@@ -101,6 +101,9 @@ export class Datasets extends APIResource {
  * Response from listing datasets.
  */
 export interface ListDatasetsResponse {
+  /**
+   * List of datasets
+   */
   data: DatasetListResponse;
 }
 
@@ -119,12 +122,12 @@ export interface DatasetRetrieveResponse {
   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;
 
@@ -138,6 +141,9 @@ export interface DatasetRetrieveResponse {
    */
   provider_resource_id?: string | null;
 
+  /**
+   * Type of resource, always 'dataset' for datasets
+   */
   type?: 'dataset';
 }
 
@@ -146,8 +152,16 @@ export namespace DatasetRetrieveResponse {
    * A dataset that can be obtained from a URI.
    */
   export interface UriDataSource {
+    /**
+     * The dataset can be obtained from a URI. E.g.
+     * "https://mywebsite.com/mydata.jsonl", "lsfs://mydata.jsonl",
+     * "data:csv;base64,{base64_content}"
+     */
     uri: string;
 
+    /**
+     * The type of data source.
+     */
     type?: 'uri';
   }
 
@@ -155,12 +169,22 @@ export namespace DatasetRetrieveResponse {
    * A dataset stored in rows.
    */
   export interface RowsDataSource {
+    /**
+     * The dataset is stored in rows. E.g. [{"messages": [{"role": "user", "content":
+     * "Hello, world!"}, {"role": "assistant", "content": "Hello, world!"}]}]
+     */
     rows: Array<{ [key: string]: unknown }>;
 
+    /**
+     * The type of data source.
+     */
     type?: 'rows';
   }
 }
 
+/**
+ * List of datasets
+ */
 export type DatasetListResponse = Array<DatasetListResponse.DatasetListResponseItem>;
 
 export namespace DatasetListResponse {
@@ -179,12 +203,12 @@ export namespace DatasetListResponse {
     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;
 
@@ -198,6 +222,9 @@ export namespace DatasetListResponse {
      */
     provider_resource_id?: string | null;
 
+    /**
+     * Type of resource, always 'dataset' for datasets
+     */
     type?: 'dataset';
   }
 
@@ -206,8 +233,16 @@ export namespace DatasetListResponse {
      * A dataset that can be obtained from a URI.
      */
     export interface UriDataSource {
+      /**
+       * The dataset can be obtained from a URI. E.g.
+       * "https://mywebsite.com/mydata.jsonl", "lsfs://mydata.jsonl",
+       * "data:csv;base64,{base64_content}"
+       */
       uri: string;
 
+      /**
+       * The type of data source.
+       */
       type?: 'uri';
     }
 
@@ -215,8 +250,15 @@ export namespace DatasetListResponse {
      * A dataset stored in rows.
      */
     export interface RowsDataSource {
+      /**
+       * The dataset is stored in rows. E.g. [{"messages": [{"role": "user", "content":
+       * "Hello, world!"}, {"role": "assistant", "content": "Hello, world!"}]}]
+       */
       rows: Array<{ [key: string]: unknown }>;
 
+      /**
+       * The type of data source.
+       */
       type?: 'rows';
     }
   }
@@ -248,12 +290,12 @@ export interface DatasetRegisterResponse {
   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;
 
@@ -267,6 +309,9 @@ export interface DatasetRegisterResponse {
    */
   provider_resource_id?: string | null;
 
+  /**
+   * Type of resource, always 'dataset' for datasets
+   */
   type?: 'dataset';
 }
 
@@ -275,8 +320,16 @@ export namespace DatasetRegisterResponse {
    * A dataset that can be obtained from a URI.
    */
   export interface UriDataSource {
+    /**
+     * The dataset can be obtained from a URI. E.g.
+     * "https://mywebsite.com/mydata.jsonl", "lsfs://mydata.jsonl",
+     * "data:csv;base64,{base64_content}"
+     */
     uri: string;
 
+    /**
+     * The type of data source.
+     */
     type?: 'uri';
   }
 
@@ -284,35 +337,62 @@ export namespace DatasetRegisterResponse {
    * A dataset stored in rows.
    */
   export interface RowsDataSource {
+    /**
+     * The dataset is stored in rows. E.g. [{"messages": [{"role": "user", "content":
+     * "Hello, world!"}, {"role": "assistant", "content": "Hello, world!"}]}]
+     */
     rows: Array<{ [key: string]: unknown }>;
 
+    /**
+     * The type of data source.
+     */
     type?: 'rows';
   }
 }
 
 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;
 }
 
 export interface DatasetRegisterParams {
   /**
-   * Purpose of the dataset. Each purpose has a required input data schema.
+   * The purpose of the dataset.
    */
   purpose: 'post-training/messages' | 'eval/question-answer' | 'eval/messages-answer';
 
   /**
-   * A dataset that can be obtained from a URI.
+   * The data source of the dataset.
    */
   source: DatasetRegisterParams.UriDataSource | DatasetRegisterParams.RowsDataSource;
 
+  /**
+   * The ID of the dataset. If not provided, an ID will be generated.
+   */
   dataset_id?: string | null;
 
+  /**
+   * The metadata for the dataset.
+   */
   metadata?: { [key: string]: unknown } | null;
 }
 
@@ -321,8 +401,16 @@ export namespace DatasetRegisterParams {
    * A dataset that can be obtained from a URI.
    */
   export interface UriDataSource {
+    /**
+     * The dataset can be obtained from a URI. E.g.
+     * "https://mywebsite.com/mydata.jsonl", "lsfs://mydata.jsonl",
+     * "data:csv;base64,{base64_content}"
+     */
     uri: string;
 
+    /**
+     * The type of data source.
+     */
     type?: 'uri';
   }
 
@@ -330,8 +418,15 @@ export namespace DatasetRegisterParams {
    * A dataset stored in rows.
    */
   export interface RowsDataSource {
+    /**
+     * The dataset is stored in rows. E.g. [{"messages": [{"role": "user", "content":
+     * "Hello, world!"}, {"role": "assistant", "content": "Hello, world!"}]}]
+     */
     rows: Array<{ [key: string]: unknown }>;
 
+    /**
+     * The type of data source.
+     */
     type?: 'rows';
   }
 }

package/dist/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,33 +180,48 @@ 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;
 
-        top_logprobs: Array<Content.TopLogprob>;
-
+        /**
+         * The bytes for the token.
+         */
         bytes?: Array<number> | null;
+
+        /**
+         * The top log probabilities for the token.
+         */
+        top_logprobs?: Array<Content.TopLogprob> | null;
       }
 
       export namespace Content {
         /**
          * 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,33 +229,48 @@ 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;
 
-        top_logprobs: Array<Refusal.TopLogprob>;
-
+        /**
+         * The bytes for the token.
+         */
         bytes?: Array<number> | null;
+
+        /**
+         * The top log probabilities for the token.
+         */
+        top_logprobs?: Array<Refusal.TopLogprob> | null;
       }
 
       export namespace Refusal {
         /**
          * 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;
     }
   }