llama-stack-client 0.4.3 → 0.4.5

package/src/resources/vector-io.ts

@@ -11,7 +11,7 @@ import * as Core from '../core';
 
 export class VectorIo extends APIResource {
   /**
-   * Insert chunks into a vector database.
+   * Insert embedded chunks into a vector database.
    */
   insert(body: VectorIoInsertParams, options?: Core.RequestOptions): Core.APIPromise<void> {
     return this._client.post('/v1/vector-io/insert', {
@@ -40,11 +40,22 @@ export interface QueryChunksResponse {
 
 export namespace QueryChunksResponse {
   /**
-   * A chunk of content that can be inserted into a vector database.
+   * A chunk of content with its embedding vector for vector database operations.
+   * Inherits all fields from Chunk and adds embedding-related fields.
    */
   export interface Chunk {
     chunk_id: string;
 
+    /**
+     * `ChunkMetadata` is backend metadata for a `Chunk` that is used to store
+     * additional information about the chunk that will not be used in the context
+     * during inference, but is required for backend functionality. The `ChunkMetadata`
+     * is set during chunk creation in `MemoryToolRuntimeImpl().insert()`and is not
+     * expected to change after. Use `Chunk.metadata` for metadata that will be used in
+     * the context during inference.
+     */
+    chunk_metadata: Chunk.ChunkMetadata;
+
     /**
      * A image content item
      */
@@ -54,6 +65,16 @@ export namespace QueryChunksResponse {
       | Chunk.TextContentItem
       | Array<Chunk.ImageContentItemOutput | Chunk.TextContentItem>;
 
+    embedding: Array<number>;
+
+    embedding_dimension: number;
+
+    embedding_model: string;
+
+    metadata?: { [key: string]: unknown };
+  }
+
+  export namespace Chunk {
     /**
      * `ChunkMetadata` is backend metadata for a `Chunk` that is used to store
      * additional information about the chunk that will not be used in the context
@@ -62,14 +83,26 @@ export namespace QueryChunksResponse {
      * expected to change after. Use `Chunk.metadata` for metadata that will be used in
      * the context during inference.
      */
-    chunk_metadata?: Chunk.ChunkMetadata | null;
+    export interface ChunkMetadata {
+      chunk_id?: string | null;
 
-    embedding?: Array<number> | null;
+      chunk_tokenizer?: string | null;
 
-    metadata?: { [key: string]: unknown };
-  }
+      chunk_window?: string | null;
+
+      content_token_count?: number | null;
+
+      created_timestamp?: number | null;
+
+      document_id?: string | null;
+
+      metadata_token_count?: number | null;
+
+      source?: string | null;
+
+      updated_timestamp?: number | null;
+    }
 
-  export namespace Chunk {
     /**
      * A image content item
      */
@@ -157,56 +190,44 @@ export namespace QueryChunksResponse {
 
       type?: 'text';
     }
-
-    /**
-     * `ChunkMetadata` is backend metadata for a `Chunk` that is used to store
-     * additional information about the chunk that will not be used in the context
-     * during inference, but is required for backend functionality. The `ChunkMetadata`
-     * is set during chunk creation in `MemoryToolRuntimeImpl().insert()`and is not
-     * expected to change after. Use `Chunk.metadata` for metadata that will be used in
-     * the context during inference.
-     */
-    export interface ChunkMetadata {
-      chunk_embedding_dimension?: number | null;
-
-      chunk_embedding_model?: string | null;
-
-      chunk_id?: string | null;
-
-      chunk_tokenizer?: string | null;
-
-      chunk_window?: string | null;
-
-      content_token_count?: number | null;
-
-      created_timestamp?: number | null;
-
-      document_id?: string | null;
-
-      metadata_token_count?: number | null;
-
-      source?: string | null;
-
-      updated_timestamp?: number | null;
-    }
   }
 }
 
 export interface VectorIoInsertParams {
+  /**
+   * The list of embedded chunks to insert.
+   */
   chunks: Array<VectorIoInsertParams.Chunk>;
 
+  /**
+   * The ID of the vector store to insert chunks into.
+   */
   vector_store_id: string;
 
+  /**
+   * Time-to-live in seconds for the inserted chunks.
+   */
   ttl_seconds?: number | null;
 }
 
 export namespace VectorIoInsertParams {
   /**
-   * A chunk of content that can be inserted into a vector database.
+   * A chunk of content with its embedding vector for vector database operations.
+   * Inherits all fields from Chunk and adds embedding-related fields.
    */
   export interface Chunk {
     chunk_id: string;
 
+    /**
+     * `ChunkMetadata` is backend metadata for a `Chunk` that is used to store
+     * additional information about the chunk that will not be used in the context
+     * during inference, but is required for backend functionality. The `ChunkMetadata`
+     * is set during chunk creation in `MemoryToolRuntimeImpl().insert()`and is not
+     * expected to change after. Use `Chunk.metadata` for metadata that will be used in
+     * the context during inference.
+     */
+    chunk_metadata: Chunk.ChunkMetadata;
+
     /**
      * A image content item
      */
@@ -216,6 +237,16 @@ export namespace VectorIoInsertParams {
       | Chunk.TextContentItem
       | Array<Chunk.ImageContentItemInput | Chunk.TextContentItem>;
 
+    embedding: Array<number>;
+
+    embedding_dimension: number;
+
+    embedding_model: string;
+
+    metadata?: { [key: string]: unknown };
+  }
+
+  export namespace Chunk {
     /**
      * `ChunkMetadata` is backend metadata for a `Chunk` that is used to store
      * additional information about the chunk that will not be used in the context
@@ -224,14 +255,26 @@ export namespace VectorIoInsertParams {
      * expected to change after. Use `Chunk.metadata` for metadata that will be used in
      * the context during inference.
      */
-    chunk_metadata?: Chunk.ChunkMetadata | null;
+    export interface ChunkMetadata {
+      chunk_id?: string | null;
 
-    embedding?: Array<number> | null;
+      chunk_tokenizer?: string | null;
 
-    metadata?: { [key: string]: unknown };
-  }
+      chunk_window?: string | null;
+
+      content_token_count?: number | null;
+
+      created_timestamp?: number | null;
+
+      document_id?: string | null;
+
+      metadata_token_count?: number | null;
+
+      source?: string | null;
+
+      updated_timestamp?: number | null;
+    }
 
-  export namespace Chunk {
     /**
      * A image content item
      */
@@ -319,44 +362,12 @@ export namespace VectorIoInsertParams {
 
       type?: 'text';
     }
-
-    /**
-     * `ChunkMetadata` is backend metadata for a `Chunk` that is used to store
-     * additional information about the chunk that will not be used in the context
-     * during inference, but is required for backend functionality. The `ChunkMetadata`
-     * is set during chunk creation in `MemoryToolRuntimeImpl().insert()`and is not
-     * expected to change after. Use `Chunk.metadata` for metadata that will be used in
-     * the context during inference.
-     */
-    export interface ChunkMetadata {
-      chunk_embedding_dimension?: number | null;
-
-      chunk_embedding_model?: string | null;
-
-      chunk_id?: string | null;
-
-      chunk_tokenizer?: string | null;
-
-      chunk_window?: string | null;
-
-      content_token_count?: number | null;
-
-      created_timestamp?: number | null;
-
-      document_id?: string | null;
-
-      metadata_token_count?: number | null;
-
-      source?: string | null;
-
-      updated_timestamp?: number | null;
-    }
   }
 }
 
 export interface VectorIoQueryParams {
   /**
-   * A image content item
+   * The query content to search for.
    */
   query:
     | string
@@ -364,8 +375,14 @@ export interface VectorIoQueryParams {
     | VectorIoQueryParams.TextContentItem
     | Array<VectorIoQueryParams.ImageContentItemInput | VectorIoQueryParams.TextContentItem>;
 
+  /**
+   * The ID of the vector store to query.
+   */
   vector_store_id: string;
 
+  /**
+   * Additional query parameters.
+   */
   params?: { [key: string]: unknown } | null;
 }
 

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

@@ -15,10 +15,7 @@ import { type OpenAICursorPageParams } from '../../pagination';
 
 export class FileBatches extends APIResource {
   /**
-   * Create a vector store file batch.
-   *
-   * Generate an OpenAI-compatible vector store file batch for the given vector
-   * store.
+   * Create a vector store file batch (OpenAI-compatible).
    */
   create(
     vectorStoreId: string,
@@ -29,7 +26,7 @@ export class FileBatches extends APIResource {
   }
 
   /**
-   * Retrieve a vector store file batch.
+   * Retrieve a vector store file batch (OpenAI-compatible).
    */
   retrieve(
     vectorStoreId: string,
@@ -40,7 +37,7 @@ export class FileBatches extends APIResource {
   }
 
   /**
-   * Cancels a vector store file batch.
+   * Cancel a vector store file batch (OpenAI-compatible).
    */
   cancel(
     vectorStoreId: string,
@@ -51,7 +48,7 @@ export class FileBatches extends APIResource {
   }
 
   /**
-   * Returns a list of vector store files in a batch.
+   * List files in a vector store file batch (OpenAI-compatible).
    */
   listFiles(
     vectorStoreId: string,
@@ -182,10 +179,19 @@ export namespace FileBatchCreateParams {
 }
 
 export interface FileBatchListFilesParams extends OpenAICursorPageParams {
+  /**
+   * Pagination cursor (before).
+   */
   before?: string | null;
 
+  /**
+   * Filter by file status.
+   */
   filter?: string | null;
 
+  /**
+   * Sort order by created_at: asc or desc.
+   */
   order?: string | null;
 }
 

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

@@ -13,7 +13,7 @@ import { OpenAICursorPage, type OpenAICursorPageParams } from '../../pagination'
 
 export class Files extends APIResource {
   /**
-   * Attach a file to a vector store.
+   * Attach a file to a vector store (OpenAI-compatible).
    */
   create(
     vectorStoreId: string,
@@ -24,7 +24,7 @@ export class Files extends APIResource {
   }
 
   /**
-   * Retrieves a vector store file.
+   * Retrieve a vector store file (OpenAI-compatible).
    */
   retrieve(
     vectorStoreId: string,
@@ -35,7 +35,7 @@ export class Files extends APIResource {
   }
 
   /**
-   * Updates a vector store file.
+   * Update a vector store file (OpenAI-compatible).
    */
   update(
     vectorStoreId: string,
@@ -47,7 +47,7 @@ export class Files extends APIResource {
   }
 
   /**
-   * List files in a vector store.
+   * List files in a vector store (OpenAI-compatible).
    */
   list(
     vectorStoreId: string,
@@ -74,7 +74,7 @@ export class Files extends APIResource {
   }
 
   /**
-   * Delete a vector store file.
+   * Delete a vector store file (OpenAI-compatible).
    */
   delete(
     vectorStoreId: string,
@@ -85,7 +85,7 @@ export class Files extends APIResource {
   }
 
   /**
-   * Retrieves the contents of a vector store file.
+   * Retrieve vector store file contents (OpenAI-compatible).
    */
   content(
     vectorStoreId: string,
@@ -253,10 +253,6 @@ export namespace FileContentResponse {
      * the context during inference.
      */
     export interface ChunkMetadata {
-      chunk_embedding_dimension?: number | null;
-
-      chunk_embedding_model?: string | null;
-
       chunk_id?: string | null;
 
       chunk_tokenizer?: string | null;
@@ -279,12 +275,18 @@ export namespace FileContentResponse {
 }
 
 export interface FileCreateParams {
+  /**
+   * The ID of the file to attach.
+   */
   file_id: string;
 
+  /**
+   * Attributes to associate with the file.
+   */
   attributes?: { [key: string]: unknown } | null;
 
   /**
-   * Automatic chunking strategy for vector store files.
+   * Strategy for chunking the file content.
    */
   chunking_strategy?:
     | FileCreateParams.VectorStoreChunkingStrategyAuto
@@ -325,20 +327,38 @@ export namespace FileCreateParams {
 }
 
 export interface FileUpdateParams {
+  /**
+   * The new attributes for the file.
+   */
   attributes: { [key: string]: unknown };
 }
 
 export interface FileListParams extends OpenAICursorPageParams {
+  /**
+   * Pagination cursor (before).
+   */
   before?: string | null;
 
+  /**
+   * Filter by file status.
+   */
   filter?: 'completed' | 'in_progress' | 'cancelled' | 'failed' | null;
 
+  /**
+   * Sort order by created_at: asc or desc.
+   */
   order?: string | null;
 }
 
 export interface FileContentParams {
+  /**
+   * Include embedding vectors.
+   */
   include_embeddings?: boolean | null;
 
+  /**
+   * Include chunk metadata.
+   */
   include_metadata?: boolean | null;
 }
 

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

@@ -36,23 +36,21 @@ export class VectorStores extends APIResource {
   fileBatches: FileBatchesAPI.FileBatches = new FileBatchesAPI.FileBatches(this._client);
 
   /**
-   * Creates a vector store.
-   *
-   * Generate an OpenAI-compatible vector store with the given parameters.
+   * Create a vector store (OpenAI-compatible).
    */
   create(body: VectorStoreCreateParams, options?: Core.RequestOptions): Core.APIPromise<VectorStore> {
     return this._client.post('/v1/vector_stores', { body, ...options });
   }
 
   /**
-   * Retrieves a vector store.
+   * Retrieve a vector store (OpenAI-compatible).
    */
   retrieve(vectorStoreId: string, options?: Core.RequestOptions): Core.APIPromise<VectorStore> {
     return this._client.get(`/v1/vector_stores/${vectorStoreId}`, options);
   }
 
   /**
-   * Updates a vector store.
+   * Update a vector store (OpenAI-compatible).
    */
   update(
     vectorStoreId: string,
@@ -63,7 +61,7 @@ export class VectorStores extends APIResource {
   }
 
   /**
-   * Returns a list of vector stores.
+   * List vector stores (OpenAI-compatible).
    */
   list(
     query?: VectorStoreListParams,
@@ -81,17 +79,14 @@ export class VectorStores extends APIResource {
   }
 
   /**
-   * Delete a vector store.
+   * Delete a vector store (OpenAI-compatible).
    */
   delete(vectorStoreId: string, options?: Core.RequestOptions): Core.APIPromise<VectorStoreDeleteResponse> {
     return this._client.delete(`/v1/vector_stores/${vectorStoreId}`, options);
   }
 
   /**
-   * Search for chunks in a vector store.
-   *
-   * Searches a vector store for relevant chunks based on a query and optional file
-   * attribute filters.
+   * Search a vector store (OpenAI-compatible).
    */
   search(
     vectorStoreId: string,
@@ -242,10 +237,6 @@ export namespace VectorStoreSearchResponse {
        * the context during inference.
        */
       export interface ChunkMetadata {
-        chunk_embedding_dimension?: number | null;
-
-        chunk_embedding_model?: string | null;
-
         chunk_id?: string | null;
 
         chunk_tokenizer?: string | null;
@@ -321,44 +312,127 @@ export namespace VectorStoreCreateParams {
 }
 
 export interface VectorStoreUpdateParams {
+  /**
+   * Expiration policy for the vector store.
+   */
   expires_after?: { [key: string]: unknown } | null;
 
+  /**
+   * Metadata to associate with the vector store.
+   */
   metadata?: { [key: string]: unknown } | null;
 
+  /**
+   * The new name for the vector store.
+   */
   name?: string | null;
 }
 
 export interface VectorStoreListParams extends OpenAICursorPageParams {
+  /**
+   * Pagination cursor (before).
+   */
   before?: string | null;
 
+  /**
+   * Sort order by created_at: asc or desc.
+   */
   order?: string | null;
 }
 
 export interface VectorStoreSearchParams {
+  /**
+   * The search query string or list of query strings.
+   */
   query: string | Array<string>;
 
+  /**
+   * Filters to apply to the search.
+   */
   filters?: { [key: string]: unknown } | null;
 
+  /**
+   * Maximum number of results to return.
+   */
   max_num_results?: number | null;
 
   /**
    * Options for ranking and filtering search results.
+   *
+   * This class configures how search results are ranked and filtered. You can use
+   * algorithm-based rerankers (weighted, RRF) or neural rerankers. Defaults from
+   * VectorStoresConfig are used when parameters are not provided.
+   *
+   * Examples: # Weighted ranker with custom alpha
+   * SearchRankingOptions(ranker="weighted", alpha=0.7)
+   *
+   *     # RRF ranker with custom impact factor
+   *     SearchRankingOptions(ranker="rrf", impact_factor=50.0)
+   *
+   *     # Use config defaults (just specify ranker type)
+   *     SearchRankingOptions(ranker="weighted")  # Uses alpha from VectorStoresConfig
+   *
+   *     # Score threshold filtering
+   *     SearchRankingOptions(ranker="weighted", score_threshold=0.5)
    */
   ranking_options?: VectorStoreSearchParams.RankingOptions | null;
 
+  /**
+   * Whether to rewrite the query for better results.
+   */
   rewrite_query?: boolean | null;
 
+  /**
+   * The search mode to use (e.g., 'vector', 'keyword').
+   */
   search_mode?: string | null;
 }
 
 export namespace VectorStoreSearchParams {
   /**
    * Options for ranking and filtering search results.
+   *
+   * This class configures how search results are ranked and filtered. You can use
+   * algorithm-based rerankers (weighted, RRF) or neural rerankers. Defaults from
+   * VectorStoresConfig are used when parameters are not provided.
+   *
+   * Examples: # Weighted ranker with custom alpha
+   * SearchRankingOptions(ranker="weighted", alpha=0.7)
+   *
+   *     # RRF ranker with custom impact factor
+   *     SearchRankingOptions(ranker="rrf", impact_factor=50.0)
+   *
+   *     # Use config defaults (just specify ranker type)
+   *     SearchRankingOptions(ranker="weighted")  # Uses alpha from VectorStoresConfig
+   *
+   *     # Score threshold filtering
+   *     SearchRankingOptions(ranker="weighted", score_threshold=0.5)
    */
   export interface RankingOptions {
+    /**
+     * Weight factor for weighted ranker
+     */
+    alpha?: number | null;
+
+    /**
+     * Impact factor for RRF algorithm
+     */
+    impact_factor?: number | null;
+
+    /**
+     * Model identifier for neural reranker
+     */
+    model?: string | null;
+
     ranker?: string | null;
 
     score_threshold?: number | null;
+
+    /**
+     * Weights for combining vector, keyword, and neural scores. Keys: 'vector',
+     * 'keyword', 'neural'
+     */
+    weights?: { [key: string]: number } | null;
   }
 }
 

package/src/version.ts

@@ -4,4 +4,4 @@
 // This source code is licensed under the terms described in the LICENSE file in
 // the root directory of this source tree.
 
-export const VERSION = '0.4.3'; // x-release-please-version
+export const VERSION = '0.4.5'; // x-release-please-version