llama-stack-client 0.2.10 → 0.2.11-rc1

package/src/resources/shared.ts

@@ -507,9 +507,50 @@ export interface QueryConfig {
   query_generator_config: QueryGeneratorConfig;
 
   /**
-   * Search mode for retrieval—either "vector" or "keyword". Default "vector".
+   * Search mode for retrieval—either "vector", "keyword", or "hybrid". Default
+   * "vector".
    */
   mode?: string;
+
+  /**
+   * Configuration for the ranker to use in hybrid search. Defaults to RRF ranker.
+   */
+  ranker?: QueryConfig.RrfRanker | QueryConfig.WeightedRanker;
+}
+
+export namespace QueryConfig {
+  /**
+   * Reciprocal Rank Fusion (RRF) ranker configuration.
+   */
+  export interface RrfRanker {
+    /**
+     * The impact factor for RRF scoring. Higher values give more weight to
+     * higher-ranked results. Must be greater than 0. Default of 60 is from the
+     * original RRF paper (Cormack et al., 2009).
+     */
+    impact_factor: number;
+
+    /**
+     * The type of ranker, always "rrf"
+     */
+    type: 'rrf';
+  }
+
+  /**
+   * Weighted ranker configuration that combines vector and keyword scores.
+   */
+  export interface WeightedRanker {
+    /**
+     * Weight factor between 0 and 1. 0 means only use keyword scores, 1 means only use
+     * vector scores, values in between blend both scores.
+     */
+    alpha: number;
+
+    /**
+     * The type of ranker, always "weighted"
+     */
+    type: 'weighted';
+  }
 }
 
 export type QueryGeneratorConfig =

package/src/resources/vector-io.ts

@@ -31,19 +31,35 @@ export interface QueryChunksResponse {
 }
 
 export namespace QueryChunksResponse {
+  /**
+   * A chunk of content that can be inserted into a vector database.
+   */
   export interface Chunk {
     /**
-     * A image content item
+     * The content of the chunk, which can be interleaved text, images, or other types.
      */
     content: Shared.InterleavedContent;
 
+    /**
+     * Metadata associated with the chunk, such as document ID, source, or other
+     * relevant information.
+     */
     metadata: Record<string, boolean | number | string | Array<unknown> | unknown | null>;
+
+    /**
+     * Optional embedding for the chunk. If not provided, it will be computed later.
+     */
+    embedding?: Array<number>;
   }
 }
 
 export interface VectorIoInsertParams {
   /**
-   * The chunks to insert.
+   * The chunks to insert. Each `Chunk` should contain content which can be
+   * interleaved text, images, or other types. `metadata`: `dict[str, Any]` and
+   * `embedding`: `List[float]` are optional. If `metadata` is provided, you
+   * configure how Llama Stack formats the chunk during generation. If `embedding` is
+   * not provided, it will be computed later.
    */
   chunks: Array<VectorIoInsertParams.Chunk>;
 
@@ -59,13 +75,25 @@ export interface VectorIoInsertParams {
 }
 
 export namespace VectorIoInsertParams {
+  /**
+   * A chunk of content that can be inserted into a vector database.
+   */
   export interface Chunk {
     /**
-     * A image content item
+     * The content of the chunk, which can be interleaved text, images, or other types.
      */
     content: Shared.InterleavedContent;
 
+    /**
+     * Metadata associated with the chunk, such as document ID, source, or other
+     * relevant information.
+     */
     metadata: Record<string, boolean | number | string | Array<unknown> | unknown | null>;
+
+    /**
+     * Optional embedding for the chunk. If not provided, it will be computed later.
+     */
+    embedding?: Array<number>;
   }
 }
 

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

@@ -0,0 +1,111 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../resource';
+import * as Core from '../../core';
+
+export class Files extends APIResource {
+  /**
+   * Attach a file to a vector store.
+   */
+  create(
+    vectorStoreId: string,
+    body: FileCreateParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<VectorStoreFile> {
+    return this._client.post(`/v1/openai/v1/vector_stores/${vectorStoreId}/files`, { body, ...options });
+  }
+}
+
+/**
+ * OpenAI Vector Store File object.
+ */
+export interface VectorStoreFile {
+  id: string;
+
+  attributes: Record<string, boolean | number | string | Array<unknown> | unknown | null>;
+
+  chunking_strategy:
+    | VectorStoreFile.VectorStoreChunkingStrategyAuto
+    | VectorStoreFile.VectorStoreChunkingStrategyStatic;
+
+  created_at: number;
+
+  object: string;
+
+  status: 'completed' | 'in_progress' | 'cancelled' | 'failed';
+
+  usage_bytes: number;
+
+  vector_store_id: string;
+
+  last_error?: VectorStoreFile.LastError;
+}
+
+export namespace VectorStoreFile {
+  export interface VectorStoreChunkingStrategyAuto {
+    type: 'auto';
+  }
+
+  export interface VectorStoreChunkingStrategyStatic {
+    static: VectorStoreChunkingStrategyStatic.Static;
+
+    type: 'static';
+  }
+
+  export namespace VectorStoreChunkingStrategyStatic {
+    export interface Static {
+      chunk_overlap_tokens: number;
+
+      max_chunk_size_tokens: number;
+    }
+  }
+
+  export interface LastError {
+    code: 'server_error' | 'rate_limit_exceeded';
+
+    message: string;
+  }
+}
+
+export interface FileCreateParams {
+  /**
+   * The ID of the file to attach to the vector store.
+   */
+  file_id: string;
+
+  /**
+   * The key-value attributes stored with the file, which can be used for filtering.
+   */
+  attributes?: Record<string, boolean | number | string | Array<unknown> | unknown | null>;
+
+  /**
+   * The chunking strategy to use for the file.
+   */
+  chunking_strategy?:
+    | FileCreateParams.VectorStoreChunkingStrategyAuto
+    | FileCreateParams.VectorStoreChunkingStrategyStatic;
+}
+
+export namespace FileCreateParams {
+  export interface VectorStoreChunkingStrategyAuto {
+    type: 'auto';
+  }
+
+  export interface VectorStoreChunkingStrategyStatic {
+    static: VectorStoreChunkingStrategyStatic.Static;
+
+    type: 'static';
+  }
+
+  export namespace VectorStoreChunkingStrategyStatic {
+    export interface Static {
+      chunk_overlap_tokens: number;
+
+      max_chunk_size_tokens: number;
+    }
+  }
+}
+
+export declare namespace Files {
+  export { type VectorStoreFile as VectorStoreFile, type FileCreateParams as FileCreateParams };
+}

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

@@ -0,0 +1,14 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { Files, type VectorStoreFile, type FileCreateParams } from './files';
+export {
+  VectorStores,
+  type ListVectorStoresResponse,
+  type VectorStore,
+  type VectorStoreDeleteResponse,
+  type VectorStoreSearchResponse,
+  type VectorStoreCreateParams,
+  type VectorStoreUpdateParams,
+  type VectorStoreListParams,
+  type VectorStoreSearchParams,
+} from './vector-stores';

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

@@ -0,0 +1,306 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../resource';
+import { isRequestOptions } from '../../core';
+import * as Core from '../../core';
+import * as FilesAPI from './files';
+import { FileCreateParams, Files, VectorStoreFile } from './files';
+
+export class VectorStores extends APIResource {
+  files: FilesAPI.Files = new FilesAPI.Files(this._client);
+
+  /**
+   * Creates a vector store.
+   */
+  create(body: VectorStoreCreateParams, options?: Core.RequestOptions): Core.APIPromise<VectorStore> {
+    return this._client.post('/v1/openai/v1/vector_stores', { body, ...options });
+  }
+
+  /**
+   * Retrieves a vector store.
+   */
+  retrieve(vectorStoreId: string, options?: Core.RequestOptions): Core.APIPromise<VectorStore> {
+    return this._client.get(`/v1/openai/v1/vector_stores/${vectorStoreId}`, options);
+  }
+
+  /**
+   * Updates a vector store.
+   */
+  update(
+    vectorStoreId: string,
+    body: VectorStoreUpdateParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<VectorStore> {
+    return this._client.post(`/v1/openai/v1/vector_stores/${vectorStoreId}`, { body, ...options });
+  }
+
+  /**
+   * Returns a list of vector stores.
+   */
+  list(
+    query?: VectorStoreListParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<ListVectorStoresResponse>;
+  list(options?: Core.RequestOptions): Core.APIPromise<ListVectorStoresResponse>;
+  list(
+    query: VectorStoreListParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<ListVectorStoresResponse> {
+    if (isRequestOptions(query)) {
+      return this.list({}, query);
+    }
+    return this._client.get('/v1/openai/v1/vector_stores', { query, ...options });
+  }
+
+  /**
+   * Delete a vector store.
+   */
+  delete(vectorStoreId: string, options?: Core.RequestOptions): Core.APIPromise<VectorStoreDeleteResponse> {
+    return this._client.delete(`/v1/openai/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(
+    vectorStoreId: string,
+    body: VectorStoreSearchParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<VectorStoreSearchResponse> {
+    return this._client.post(`/v1/openai/v1/vector_stores/${vectorStoreId}/search`, { body, ...options });
+  }
+}
+
+/**
+ * Response from listing vector stores.
+ */
+export interface ListVectorStoresResponse {
+  data: Array<VectorStore>;
+
+  has_more: boolean;
+
+  object: string;
+
+  first_id?: string;
+
+  last_id?: string;
+}
+
+/**
+ * OpenAI Vector Store object.
+ */
+export interface VectorStore {
+  id: string;
+
+  created_at: number;
+
+  file_counts: Record<string, number>;
+
+  metadata: Record<string, boolean | number | string | Array<unknown> | unknown | null>;
+
+  object: string;
+
+  status: string;
+
+  usage_bytes: number;
+
+  expires_after?: Record<string, boolean | number | string | Array<unknown> | unknown | null>;
+
+  expires_at?: number;
+
+  last_active_at?: number;
+
+  name?: string;
+}
+
+/**
+ * Response from deleting a vector store.
+ */
+export interface VectorStoreDeleteResponse {
+  id: string;
+
+  deleted: boolean;
+
+  object: string;
+}
+
+/**
+ * Response from searching a vector store.
+ */
+export interface VectorStoreSearchResponse {
+  data: Array<VectorStoreSearchResponse.Data>;
+
+  has_more: boolean;
+
+  object: string;
+
+  search_query: string;
+
+  next_page?: string;
+}
+
+export namespace VectorStoreSearchResponse {
+  /**
+   * Response from searching a vector store.
+   */
+  export interface Data {
+    content: Array<Data.Content>;
+
+    file_id: string;
+
+    filename: string;
+
+    score: number;
+
+    attributes?: Record<string, string | number | boolean>;
+  }
+
+  export namespace Data {
+    export interface Content {
+      text: string;
+
+      type: 'text';
+    }
+  }
+}
+
+export interface VectorStoreCreateParams {
+  /**
+   * A name for the vector store.
+   */
+  name: string;
+
+  /**
+   * The chunking strategy used to chunk the file(s). If not set, will use the `auto`
+   * strategy.
+   */
+  chunking_strategy?: Record<string, boolean | number | string | Array<unknown> | unknown | null>;
+
+  /**
+   * The dimension of the embedding vectors (default: 384).
+   */
+  embedding_dimension?: number;
+
+  /**
+   * The embedding model to use for this vector store.
+   */
+  embedding_model?: string;
+
+  /**
+   * The expiration policy for a vector store.
+   */
+  expires_after?: Record<string, boolean | number | string | Array<unknown> | unknown | null>;
+
+  /**
+   * A list of File IDs that the vector store should use. Useful for tools like
+   * `file_search` that can access files.
+   */
+  file_ids?: Array<string>;
+
+  /**
+   * Set of 16 key-value pairs that can be attached to an object.
+   */
+  metadata?: Record<string, boolean | number | string | Array<unknown> | unknown | null>;
+
+  /**
+   * The ID of the provider to use for this vector store.
+   */
+  provider_id?: string;
+
+  /**
+   * The provider-specific vector database ID.
+   */
+  provider_vector_db_id?: string;
+}
+
+export interface VectorStoreUpdateParams {
+  /**
+   * The expiration policy for a vector store.
+   */
+  expires_after?: Record<string, boolean | number | string | Array<unknown> | unknown | null>;
+
+  /**
+   * Set of 16 key-value pairs that can be attached to an object.
+   */
+  metadata?: Record<string, boolean | number | string | Array<unknown> | unknown | null>;
+
+  /**
+   * The name of the vector store.
+   */
+  name?: string;
+}
+
+export interface VectorStoreListParams {
+  /**
+   * A cursor for use in pagination. `after` is an object ID that defines your place
+   * in the list.
+   */
+  after?: string;
+
+  /**
+   * A cursor for use in pagination. `before` is an object ID that defines your place
+   * in the list.
+   */
+  before?: string;
+
+  /**
+   * A limit on the number of objects to be returned. Limit can range between 1 and
+   * 100, and the default is 20.
+   */
+  limit?: number;
+
+  /**
+   * Sort order by the `created_at` timestamp of the objects. `asc` for ascending
+   * order and `desc` for descending order.
+   */
+  order?: string;
+}
+
+export interface VectorStoreSearchParams {
+  /**
+   * The query string or array for performing the search.
+   */
+  query: string | Array<string>;
+
+  /**
+   * Filters based on file attributes to narrow the search results.
+   */
+  filters?: Record<string, boolean | number | string | Array<unknown> | unknown | null>;
+
+  /**
+   * Maximum number of results to return (1 to 50 inclusive, default 10).
+   */
+  max_num_results?: number;
+
+  /**
+   * Ranking options for fine-tuning the search results.
+   */
+  ranking_options?: Record<string, boolean | number | string | Array<unknown> | unknown | null>;
+
+  /**
+   * Whether to rewrite the natural language query for vector search (default false)
+   */
+  rewrite_query?: boolean;
+}
+
+VectorStores.Files = Files;
+
+export declare namespace VectorStores {
+  export {
+    type ListVectorStoresResponse as ListVectorStoresResponse,
+    type VectorStore as VectorStore,
+    type VectorStoreDeleteResponse as VectorStoreDeleteResponse,
+    type VectorStoreSearchResponse as VectorStoreSearchResponse,
+    type VectorStoreCreateParams as VectorStoreCreateParams,
+    type VectorStoreUpdateParams as VectorStoreUpdateParams,
+    type VectorStoreListParams as VectorStoreListParams,
+    type VectorStoreSearchParams as VectorStoreSearchParams,
+  };
+
+  export {
+    Files as Files,
+    type VectorStoreFile as VectorStoreFile,
+    type FileCreateParams as FileCreateParams,
+  };
+}

package/src/resources/vector-stores.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './vector-stores/index';

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.2.10';
+export const VERSION = '0.2.11rc1';

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.2.10";
+export declare const VERSION = "0.2.11rc1";
 //# sourceMappingURL=version.d.ts.map

package/version.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,WAAW,CAAC"}
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,cAAc,CAAC"}

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.2.10';
+exports.VERSION = '0.2.11rc1';
 //# sourceMappingURL=version.js.map

package/version.js.map

@@ -1 +1 @@
-{"version":3,"file":"version.js","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":";;;AAAa,QAAA,OAAO,GAAG,QAAQ,CAAC"}
+{"version":3,"file":"version.js","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":";;;AAAa,QAAA,OAAO,GAAG,WAAW,CAAC"}

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.2.10';
+export const VERSION = '0.2.11rc1';
 //# sourceMappingURL=version.mjs.map

package/version.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"version.mjs","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,OAAO,GAAG,QAAQ,CAAC"}
+{"version":3,"file":"version.mjs","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,OAAO,GAAG,WAAW,CAAC"}