llama-stack-client 0.2.16 → 0.2.17-rc1

package/src/resources/tools.ts

@@ -30,42 +30,87 @@ export class Tools extends APIResource {
   }
 }
 
+/**
+ * Response containing a list of tools.
+ */
 export interface ListToolsResponse {
+  /**
+   * List of tools
+   */
   data: ToolListResponse;
 }
 
+/**
+ * A tool that can be invoked by agents.
+ */
 export interface Tool {
+  /**
+   * Human-readable description of what the tool does
+   */
   description: string;
 
   identifier: string;
 
+  /**
+   * List of parameters this tool accepts
+   */
   parameters: Array<Tool.Parameter>;
 
   provider_id: string;
 
+  /**
+   * ID of the tool group this tool belongs to
+   */
   toolgroup_id: string;
 
+  /**
+   * Type of resource, always 'tool'
+   */
   type: 'tool';
 
+  /**
+   * (Optional) Additional metadata about the tool
+   */
   metadata?: { [key: string]: boolean | number | string | Array<unknown> | unknown | null };
 
   provider_resource_id?: string;
 }
 
 export namespace Tool {
+  /**
+   * 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;
   }
 }
 
+/**
+ * List of tools
+ */
 export type ToolListResponse = Array<Tool>;
 
 export interface ToolListParams {

package/src/resources/vector-dbs.ts

@@ -41,19 +41,37 @@ export class VectorDBs extends APIResource {
   }
 }
 
+/**
+ * Response from listing vector databases.
+ */
 export interface ListVectorDBsResponse {
+  /**
+   * List of vector databases
+   */
   data: VectorDBListResponse;
 }
 
+/**
+ * Vector database resource for storing and querying vector embeddings.
+ */
 export interface VectorDBRetrieveResponse {
+  /**
+   * Dimension of the embedding vectors
+   */
   embedding_dimension: number;
 
+  /**
+   * Name of the embedding model to use for vector generation
+   */
   embedding_model: string;
 
   identifier: string;
 
   provider_id: string;
 
+  /**
+   * Type of resource, always 'vector_db' for vector databases
+   */
   type: 'vector_db';
 
   provider_resource_id?: string;
@@ -61,18 +79,33 @@ export interface VectorDBRetrieveResponse {
   vector_db_name?: string;
 }
 
+/**
+ * List of vector databases
+ */
 export type VectorDBListResponse = Array<VectorDBListResponse.VectorDBListResponseItem>;
 
 export namespace VectorDBListResponse {
+  /**
+   * Vector database resource for storing and querying vector embeddings.
+   */
   export interface VectorDBListResponseItem {
+    /**
+     * Dimension of the embedding vectors
+     */
     embedding_dimension: number;
 
+    /**
+     * Name of the embedding model to use for vector generation
+     */
     embedding_model: string;
 
     identifier: string;
 
     provider_id: string;
 
+    /**
+     * Type of resource, always 'vector_db' for vector databases
+     */
     type: 'vector_db';
 
     provider_resource_id?: string;
@@ -81,15 +114,27 @@ export namespace VectorDBListResponse {
   }
 }
 
+/**
+ * Vector database resource for storing and querying vector embeddings.
+ */
 export interface VectorDBRegisterResponse {
+  /**
+   * Dimension of the embedding vectors
+   */
   embedding_dimension: number;
 
+  /**
+   * Name of the embedding model to use for vector generation
+   */
   embedding_model: string;
 
   identifier: string;
 
   provider_id: string;
 
+  /**
+   * Type of resource, always 'vector_db' for vector databases
+   */
   type: 'vector_db';
 
   provider_resource_id?: string;

package/src/resources/vector-io.ts

@@ -24,9 +24,18 @@ export class VectorIo extends APIResource {
   }
 }
 
+/**
+ * Response from querying chunks in a vector database.
+ */
 export interface QueryChunksResponse {
+  /**
+   * List of content chunks returned from the query
+   */
   chunks: Array<QueryChunksResponse.Chunk>;
 
+  /**
+   * Relevance scores corresponding to each returned chunk
+   */
   scores: Array<number>;
 }
 

package/src/resources/vector-stores/files.ts

@@ -89,65 +89,140 @@ export class Files extends APIResource {
  * OpenAI Vector Store File object.
  */
 export interface VectorStoreFile {
+  /**
+   * Unique identifier for the file
+   */
   id: string;
 
+  /**
+   * Key-value attributes associated with the file
+   */
   attributes: { [key: string]: boolean | number | string | Array<unknown> | unknown | null };
 
+  /**
+   * Strategy used for splitting the file into chunks
+   */
   chunking_strategy:
     | VectorStoreFile.VectorStoreChunkingStrategyAuto
     | VectorStoreFile.VectorStoreChunkingStrategyStatic;
 
+  /**
+   * Timestamp when the file was added to the vector store
+   */
   created_at: number;
 
+  /**
+   * Object type identifier, always "vector_store.file"
+   */
   object: string;
 
+  /**
+   * Current processing status of the file
+   */
   status: 'completed' | 'in_progress' | 'cancelled' | 'failed';
 
+  /**
+   * Storage space used by this file in bytes
+   */
   usage_bytes: number;
 
+  /**
+   * ID of the vector store containing this file
+   */
   vector_store_id: string;
 
+  /**
+   * (Optional) Error information if file processing failed
+   */
   last_error?: VectorStoreFile.LastError;
 }
 
 export namespace VectorStoreFile {
+  /**
+   * Automatic chunking strategy for vector store files.
+   */
   export interface VectorStoreChunkingStrategyAuto {
+    /**
+     * Strategy type, always "auto" for automatic chunking
+     */
     type: 'auto';
   }
 
+  /**
+   * Static chunking strategy with configurable parameters.
+   */
   export interface VectorStoreChunkingStrategyStatic {
+    /**
+     * Configuration parameters for the static chunking strategy
+     */
     static: VectorStoreChunkingStrategyStatic.Static;
 
+    /**
+     * Strategy type, always "static" for static chunking
+     */
     type: 'static';
   }
 
   export namespace VectorStoreChunkingStrategyStatic {
+    /**
+     * Configuration parameters for the static chunking strategy
+     */
     export interface Static {
+      /**
+       * Number of tokens to overlap between adjacent chunks
+       */
       chunk_overlap_tokens: number;
 
+      /**
+       * Maximum number of tokens per chunk, must be between 100 and 4096
+       */
       max_chunk_size_tokens: number;
     }
   }
 
+  /**
+   * (Optional) Error information if file processing failed
+   */
   export interface LastError {
+    /**
+     * Error code indicating the type of failure
+     */
     code: 'server_error' | 'rate_limit_exceeded';
 
+    /**
+     * Human-readable error message describing the failure
+     */
     message: string;
   }
 }
 
 /**
- * Response from listing vector stores.
+ * Response from listing files in a vector store.
  */
 export interface FileListResponse {
+  /**
+   * List of vector store file objects
+   */
   data: Array<VectorStoreFile>;
 
+  /**
+   * Whether there are more files available beyond this page
+   */
   has_more: boolean;
 
+  /**
+   * Object type identifier, always "list"
+   */
   object: string;
 
+  /**
+   * (Optional) ID of the first file in the list for pagination
+   */
   first_id?: string;
 
+  /**
+   * (Optional) ID of the last file in the list for pagination
+   */
   last_id?: string;
 }
 
@@ -155,10 +230,19 @@ export interface FileListResponse {
  * Response from deleting a vector store file.
  */
 export interface FileDeleteResponse {
+  /**
+   * Unique identifier of the deleted file
+   */
   id: string;
 
+  /**
+   * Whether the deletion operation was successful
+   */
   deleted: boolean;
 
+  /**
+   * Object type identifier for the deletion response
+   */
   object: string;
 }
 
@@ -166,19 +250,40 @@ export interface FileDeleteResponse {
  * Response from retrieving the contents of a vector store file.
  */
 export interface FileContentResponse {
+  /**
+   * Key-value attributes associated with the file
+   */
   attributes: { [key: string]: boolean | number | string | Array<unknown> | unknown | null };
 
+  /**
+   * List of content items from the file
+   */
   content: Array<FileContentResponse.Content>;
 
+  /**
+   * Unique identifier for the file
+   */
   file_id: string;
 
+  /**
+   * Name of the file
+   */
   filename: string;
 }
 
 export namespace FileContentResponse {
+  /**
+   * Content item from a vector store file or search result.
+   */
   export interface Content {
+    /**
+     * The actual text content
+     */
     text: string;
 
+    /**
+     * Content type, currently only "text" is supported
+     */
     type: 'text';
   }
 }
@@ -203,20 +308,44 @@ export interface FileCreateParams {
 }
 
 export namespace FileCreateParams {
+  /**
+   * Automatic chunking strategy for vector store files.
+   */
   export interface VectorStoreChunkingStrategyAuto {
+    /**
+     * Strategy type, always "auto" for automatic chunking
+     */
     type: 'auto';
   }
 
+  /**
+   * Static chunking strategy with configurable parameters.
+   */
   export interface VectorStoreChunkingStrategyStatic {
+    /**
+     * Configuration parameters for the static chunking strategy
+     */
     static: VectorStoreChunkingStrategyStatic.Static;
 
+    /**
+     * Strategy type, always "static" for static chunking
+     */
     type: 'static';
   }
 
   export namespace VectorStoreChunkingStrategyStatic {
+    /**
+     * Configuration parameters for the static chunking strategy
+     */
     export interface Static {
+      /**
+       * Number of tokens to overlap between adjacent chunks
+       */
       chunk_overlap_tokens: number;
 
+      /**
+       * Maximum number of tokens per chunk, must be between 100 and 4096
+       */
       max_chunk_size_tokens: number;
     }
   }
@@ -230,14 +359,33 @@ export interface FileUpdateParams {
 }
 
 export interface FileListParams {
+  /**
+   * (Optional) A cursor for use in pagination. `after` is an object ID that defines
+   * your place in the list.
+   */
   after?: string;
 
+  /**
+   * (Optional) A cursor for use in pagination. `before` is an object ID that defines
+   * your place in the list.
+   */
   before?: string;
 
+  /**
+   * (Optional) Filter by file status to only return files with the specified status.
+   */
   filter?: 'completed' | 'in_progress' | 'cancelled' | 'failed';
 
+  /**
+   * (Optional) A limit on the number of objects to be returned. Limit can range
+   * between 1 and 100, and the default is 20.
+   */
   limit?: number;
 
+  /**
+   * (Optional) Sort order by the `created_at` timestamp of the objects. `asc` for
+   * ascending order and `desc` for descending order.
+   */
   order?: string;
 }
 

package/src/resources/vector-stores/vector-stores.ts

@@ -85,14 +85,29 @@ export class VectorStores extends APIResource {
  * Response from listing vector stores.
  */
 export interface ListVectorStoresResponse {
+  /**
+   * List of vector store objects
+   */
   data: Array<VectorStore>;
 
+  /**
+   * Whether there are more vector stores available beyond this page
+   */
   has_more: boolean;
 
+  /**
+   * Object type identifier, always "list"
+   */
   object: string;
 
+  /**
+   * (Optional) ID of the first vector store in the list for pagination
+   */
   first_id?: string;
 
+  /**
+   * (Optional) ID of the last vector store in the list for pagination
+   */
   last_id?: string;
 }
 
@@ -100,39 +115,90 @@ export interface ListVectorStoresResponse {
  * OpenAI Vector Store object.
  */
 export interface VectorStore {
+  /**
+   * Unique identifier for the vector store
+   */
   id: string;
 
+  /**
+   * Timestamp when the vector store was created
+   */
   created_at: number;
 
+  /**
+   * File processing status counts for the vector store
+   */
   file_counts: VectorStore.FileCounts;
 
+  /**
+   * Set of key-value pairs that can be attached to the vector store
+   */
   metadata: { [key: string]: boolean | number | string | Array<unknown> | unknown | null };
 
+  /**
+   * Object type identifier, always "vector_store"
+   */
   object: string;
 
+  /**
+   * Current status of the vector store
+   */
   status: string;
 
+  /**
+   * Storage space used by the vector store in bytes
+   */
   usage_bytes: number;
 
+  /**
+   * (Optional) Expiration policy for the vector store
+   */
   expires_after?: { [key: string]: boolean | number | string | Array<unknown> | unknown | null };
 
+  /**
+   * (Optional) Timestamp when the vector store will expire
+   */
   expires_at?: number;
 
+  /**
+   * (Optional) Timestamp of last activity on the vector store
+   */
   last_active_at?: number;
 
+  /**
+   * (Optional) Name of the vector store
+   */
   name?: string;
 }
 
 export namespace VectorStore {
+  /**
+   * File processing status counts for the vector store
+   */
   export interface FileCounts {
+    /**
+     * Number of files that had their processing cancelled
+     */
     cancelled: number;
 
+    /**
+     * Number of files that have been successfully processed
+     */
     completed: number;
 
+    /**
+     * Number of files that failed to process
+     */
     failed: number;
 
+    /**
+     * Number of files currently being processed
+     */
     in_progress: number;
 
+    /**
+     * Total number of files in the vector store
+     */
     total: number;
   }
 }
@@ -141,25 +207,49 @@ export namespace VectorStore {
  * Response from deleting a vector store.
  */
 export interface VectorStoreDeleteResponse {
+  /**
+   * Unique identifier of the deleted vector store
+   */
   id: string;
 
+  /**
+   * Whether the deletion operation was successful
+   */
   deleted: boolean;
 
+  /**
+   * Object type identifier for the deletion response
+   */
   object: string;
 }
 
 /**
- * Response from searching a vector store.
+ * Paginated response from searching a vector store.
  */
 export interface VectorStoreSearchResponse {
+  /**
+   * List of search result objects
+   */
   data: Array<VectorStoreSearchResponse.Data>;
 
+  /**
+   * Whether there are more results available beyond this page
+   */
   has_more: boolean;
 
+  /**
+   * Object type identifier for the search results page
+   */
   object: string;
 
+  /**
+   * The original search query that was executed
+   */
   search_query: string;
 
+  /**
+   * (Optional) Token for retrieving the next page of results
+   */
   next_page?: string;
 }
 
@@ -168,21 +258,45 @@ export namespace VectorStoreSearchResponse {
    * Response from searching a vector store.
    */
   export interface Data {
+    /**
+     * List of content items matching the search query
+     */
     content: Array<Data.Content>;
 
+    /**
+     * Unique identifier of the file containing the result
+     */
     file_id: string;
 
+    /**
+     * Name of the file containing the result
+     */
     filename: string;
 
+    /**
+     * Relevance score for this search result
+     */
     score: number;
 
+    /**
+     * (Optional) Key-value attributes associated with the file
+     */
     attributes?: { [key: string]: string | number | boolean };
   }
 
   export namespace Data {
+    /**
+     * Content item from a vector store file or search result.
+     */
     export interface Content {
+      /**
+       * The actual text content
+       */
       text: string;
 
+      /**
+       * Content type, currently only "text" is supported
+       */
       type: 'text';
     }
   }
@@ -312,8 +426,14 @@ export namespace VectorStoreSearchParams {
    * Ranking options for fine-tuning the search results.
    */
   export interface RankingOptions {
+    /**
+     * (Optional) Name of the ranking algorithm to use
+     */
     ranker?: string;
 
+    /**
+     * (Optional) Minimum relevance score threshold for results
+     */
     score_threshold?: number;
   }
 }

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.2.16'; // x-release-please-version
+export const VERSION = '0.2.17rc1'; // x-release-please-version