@mixedbread/sdk 0.5.0 → 0.7.2

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

@@ -37,37 +37,38 @@ export class VectorStores extends APIResource {
   }
 
   /**
-   * Get a vector store by ID.
+   * Get a vector store by ID or name.
    *
-   * Args: vector_store_id: The ID of the vector store to retrieve.
+   * Args: vector_store_identifier: The ID or name of the vector store to retrieve.
    *
    * Returns: VectorStore: The response containing the vector store details.
    */
-  retrieve(vectorStoreID: string, options?: RequestOptions): APIPromise<VectorStore> {
-    return this._client.get(path`/v1/vector_stores/${vectorStoreID}`, options);
+  retrieve(vectorStoreIdentifier: string, options?: RequestOptions): APIPromise<VectorStore> {
+    return this._client.get(path`/v1/vector_stores/${vectorStoreIdentifier}`, options);
   }
 
   /**
-   * Update a vector store by ID.
+   * Update a vector store by ID or name.
    *
-   * Args: vector_store_id: The ID of the vector store to update.
+   * Args: vector_store_identifier: The ID or name of the vector store to update.
    * vector_store_update: VectorStoreCreate object containing the name, description,
    * and metadata.
    *
    * Returns: VectorStore: The response containing the updated vector store details.
    */
   update(
-    vectorStoreID: string,
+    vectorStoreIdentifier: string,
     body: VectorStoreUpdateParams,
     options?: RequestOptions,
   ): APIPromise<VectorStore> {
-    return this._client.put(path`/v1/vector_stores/${vectorStoreID}`, { body, ...options });
+    return this._client.put(path`/v1/vector_stores/${vectorStoreIdentifier}`, { body, ...options });
   }
 
   /**
-   * List all vector stores.
+   * List all vector stores with optional search.
    *
-   * Args: pagination: The pagination options.
+   * Args: pagination: The pagination options. q: Optional search query to filter
+   * vector stores.
    *
    * Returns: VectorStoreListResponse: The list of vector stores.
    */
@@ -79,14 +80,14 @@ export class VectorStores extends APIResource {
   }
 
   /**
-   * Delete a vector store by ID.
+   * Delete a vector store by ID or name.
    *
-   * Args: vector_store_id: The ID of the vector store to delete.
+   * Args: vector_store_identifier: The ID or name of the vector store to delete.
    *
    * Returns: VectorStore: The response containing the deleted vector store details.
    */
-  delete(vectorStoreID: string, options?: RequestOptions): APIPromise<VectorStoreDeleteResponse> {
-    return this._client.delete(path`/v1/vector_stores/${vectorStoreID}`, options);
+  delete(vectorStoreIdentifier: string, options?: RequestOptions): APIPromise<VectorStoreDeleteResponse> {
+    return this._client.delete(path`/v1/vector_stores/${vectorStoreIdentifier}`, options);
   }
 
   /**
@@ -107,7 +108,9 @@ export class VectorStores extends APIResource {
    * relevance-scored results.
    *
    * Args: search_params: Search configuration including: - query text or
-   * embeddings - metadata filters - pagination parameters - sorting preferences
+   * embeddings - vector_store_ids: List of vector stores to search - file_ids:
+   * Optional list of file IDs to filter chunks by (or tuple of list and condition
+   * operator) - metadata filters - pagination parameters - sorting preferences
    * \_state: API state dependency \_ctx: Service context dependency
    *
    * Returns: VectorStoreSearchChunkResponse containing: - List of matched chunks
@@ -138,56 +141,95 @@ export interface ExpiresAfter {
   days?: number;
 }
 
-/**
- * Tracks counts of files in different states within a vector store.
- */
-export interface FileCounts {
+export interface ScoredAudioURLInputChunk {
+  /**
+   * position of the chunk in a file
+   */
+  chunk_index: number;
+
+  /**
+   * mime type of the chunk
+   */
+  mime_type?: string;
+
+  /**
+   * model used for this chunk
+   */
+  model?: string | null;
+
+  /**
+   * score of the chunk
+   */
+  score: number;
+
+  /**
+   * file id
+   */
+  file_id: string;
+
+  /**
+   * filename
+   */
+  filename: string;
+
   /**
-   * Number of files currently being processed
+   * vector store id
+   */
+  vector_store_id: string;
+
+  /**
+   * file metadata
+   */
+  metadata?: unknown;
+
+  /**
+   * Input type identifier
    */
-  in_progress?: number;
+  type?: 'audio_url';
 
   /**
-   * Number of files whose processing was cancelled
+   * The audio input specification.
    */
-  cancelled?: number;
+  audio_url: ScoredAudioURLInputChunk.AudioURL;
 
   /**
-   * Number of successfully processed files
+   * speech recognition (sr) text of the audio
    */
-  completed?: number;
+  transcription?: string | null;
 
   /**
-   * Number of files that failed processing
+   * summary of the audio
    */
-  failed?: number;
+  summary?: string | null;
+}
 
+export namespace ScoredAudioURLInputChunk {
   /**
-   * Total number of files
+   * The audio input specification.
    */
-  total?: number;
+  export interface AudioURL {
+    /**
+     * The audio URL. Can be either a URL or a Data URI.
+     */
+    url: string;
+  }
 }
 
-export interface ScoredVectorStoreChunk {
+export interface ScoredImageURLInputChunk {
   /**
    * position of the chunk in a file
    */
-  position: number;
+  chunk_index: number;
 
   /**
-   * value of the chunk
+   * mime type of the chunk
    */
-  value?:
-    | string
-    | ScoredVectorStoreChunk.ImageURLInput
-    | ScoredVectorStoreChunk.TextInput
-    | Record<string, unknown>
-    | null;
+  mime_type?: string;
 
   /**
-   * content of the chunk
+   * model used for this chunk
    */
-  content?: string | null;
+  model?: string | null;
 
   /**
    * score of the chunk
@@ -213,52 +255,168 @@ export interface ScoredVectorStoreChunk {
    * file metadata
    */
   metadata?: unknown;
+
+  /**
+   * Input type identifier
+   */
+  type?: 'image_url';
+
+  /**
+   * The image input specification.
+   */
+  image_url: ScoredImageURLInputChunk.ImageURL;
+
+  /**
+   * ocr text of the image
+   */
+  ocr_text?: string | null;
+
+  /**
+   * summary of the image
+   */
+  summary?: string | null;
 }
 
-export namespace ScoredVectorStoreChunk {
+export namespace ScoredImageURLInputChunk {
   /**
-   * Model for image input validation.
+   * The image input specification.
    */
-  export interface ImageURLInput {
+  export interface ImageURL {
     /**
-     * Input type identifier
+     * The image URL. Can be either a URL or a Data URI.
      */
-    type?: 'image_url';
+    url: string;
 
     /**
-     * The image input specification.
+     * The image format/mimetype
      */
-    image_url: ImageURLInput.ImageURL;
+    format?: string;
   }
+}
 
-  export namespace ImageURLInput {
-    /**
-     * The image input specification.
-     */
-    export interface ImageURL {
-      /**
-       * The image URL. Can be either a URL or a Data URI.
-       */
-      url: string;
-    }
-  }
+export interface ScoredTextInputChunk {
+  /**
+   * position of the chunk in a file
+   */
+  chunk_index: number;
 
   /**
-   * Model for text input validation.
-   *
-   * Attributes: type: Input type identifier, always "text" text: The actual text
-   * content, with length and whitespace constraints
+   * mime type of the chunk
    */
-  export interface TextInput {
-    /**
-     * Input type identifier
-     */
-    type?: 'text';
+  mime_type?: string;
+
+  /**
+   * model used for this chunk
+   */
+  model?: string | null;
+
+  /**
+   * score of the chunk
+   */
+  score: number;
+
+  /**
+   * file id
+   */
+  file_id: string;
+
+  /**
+   * filename
+   */
+  filename: string;
+
+  /**
+   * vector store id
+   */
+  vector_store_id: string;
+
+  /**
+   * file metadata
+   */
+  metadata?: unknown;
+
+  /**
+   * Input type identifier
+   */
+  type?: 'text';
+
+  /**
+   * Text content to process
+   */
+  text: string;
+}
+
+export interface ScoredVideoURLInputChunk {
+  /**
+   * position of the chunk in a file
+   */
+  chunk_index: number;
+
+  /**
+   * mime type of the chunk
+   */
+  mime_type?: string;
+
+  /**
+   * model used for this chunk
+   */
+  model?: string | null;
+
+  /**
+   * score of the chunk
+   */
+  score: number;
+
+  /**
+   * file id
+   */
+  file_id: string;
+
+  /**
+   * filename
+   */
+  filename: string;
+
+  /**
+   * vector store id
+   */
+  vector_store_id: string;
+
+  /**
+   * file metadata
+   */
+  metadata?: unknown;
 
+  /**
+   * Input type identifier
+   */
+  type?: 'video_url';
+
+  /**
+   * The video input specification.
+   */
+  video_url: ScoredVideoURLInputChunk.VideoURL;
+
+  /**
+   * speech recognition (sr) text of the video
+   */
+  transcription?: string | null;
+
+  /**
+   * summary of the video
+   */
+  summary?: string | null;
+}
+
+export namespace ScoredVideoURLInputChunk {
+  /**
+   * The video input specification.
+   */
+  export interface VideoURL {
     /**
-     * Text content to process
+     * The video URL. Can be either a URL or a Data URI.
      */
-    text: string;
+    url: string;
   }
 }
 
@@ -289,7 +447,7 @@ export interface VectorStore {
   /**
    * Counts of files in different states
    */
-  file_counts?: FileCounts;
+  file_counts?: VectorStore.FileCounts;
 
   /**
    * Represents an expiration policy for a vector store.
@@ -332,30 +490,47 @@ export interface VectorStore {
   object?: 'vector_store';
 }
 
-/**
- * Options for configuring vector store chunk searches.
- */
-export interface VectorStoreChunkSearchOptions {
+export namespace VectorStore {
   /**
-   * Minimum similarity score threshold
+   * Counts of files in different states
    */
-  score_threshold?: number;
+  export interface FileCounts {
+    /**
+     * Number of files waiting to be processed
+     */
+    pending?: number;
 
-  /**
-   * Whether to rewrite the query
-   */
-  rewrite_query?: boolean;
+    /**
+     * Number of files currently being processed
+     */
+    in_progress?: number;
 
-  /**
-   * Whether to return file metadata
-   */
-  return_metadata?: boolean;
+    /**
+     * Number of files whose processing was cancelled
+     */
+    cancelled?: number;
+
+    /**
+     * Number of successfully processed files
+     */
+    completed?: number;
+
+    /**
+     * Number of files that failed processing
+     */
+    failed?: number;
+
+    /**
+     * Total number of files
+     */
+    total?: number;
+  }
 }
 
 /**
- * Options for configuring vector store file searches.
+ * Options for configuring vector store chunk searches.
  */
-export interface VectorStoreFileSearchOptions {
+export interface VectorStoreChunkSearchOptions {
   /**
    * Minimum similarity score threshold
    */
@@ -367,19 +542,37 @@ export interface VectorStoreFileSearchOptions {
   rewrite_query?: boolean;
 
   /**
-   * Whether to return file metadata
+   * Whether to rerank results and optional reranking configuration
    */
-  return_metadata?: boolean;
+  rerank?: boolean | VectorStoreChunkSearchOptions.RerankConfig | null;
 
   /**
-   * Whether to return matching text chunks
+   * Whether to return file metadata
    */
-  return_chunks?: boolean;
+  return_metadata?: boolean;
+}
 
+export namespace VectorStoreChunkSearchOptions {
   /**
-   * Number of chunks to return for each file
+   * Represents a reranking configuration.
    */
-  chunks_per_file?: number;
+  export interface RerankConfig {
+    /**
+     * The name of the reranking model
+     */
+    model?: string;
+
+    /**
+     * Whether to include metadata in the reranked results
+     */
+    with_metadata?: boolean | Array<string>;
+
+    /**
+     * Maximum number of results to return after reranking. If None, returns all
+     * reranked results.
+     */
+    top_k?: number | null;
+  }
 }
 
 /**
@@ -414,7 +607,9 @@ export interface VectorStoreQuestionAnsweringResponse {
   /**
    * Source documents used to generate the answer
    */
-  sources?: Array<ScoredVectorStoreChunk>;
+  sources?: Array<
+    ScoredTextInputChunk | ScoredImageURLInputChunk | ScoredAudioURLInputChunk | ScoredVideoURLInputChunk
+  >;
 }
 
 export interface VectorStoreSearchResponse {
@@ -426,7 +621,9 @@ export interface VectorStoreSearchResponse {
   /**
    * The list of scored vector store file chunks
    */
-  data: Array<ScoredVectorStoreChunk>;
+  data: Array<
+    ScoredTextInputChunk | ScoredImageURLInputChunk | ScoredAudioURLInputChunk | ScoredVideoURLInputChunk
+  >;
 }
 
 export interface VectorStoreCreateParams {
@@ -478,7 +675,12 @@ export interface VectorStoreUpdateParams {
   metadata?: unknown;
 }
 
-export interface VectorStoreListParams extends LimitOffsetParams {}
+export interface VectorStoreListParams extends LimitOffsetParams {
+  /**
+   * Search query for fuzzy matching over name and description fields
+   */
+  q?: string | null;
+}
 
 export interface VectorStoreQuestionAnsweringParams {
   /**
@@ -488,9 +690,14 @@ export interface VectorStoreQuestionAnsweringParams {
   query?: string;
 
   /**
-   * IDs of vector stores to search
+   * IDs or names of vector stores to search
+   */
+  vector_store_identifiers?: Array<string> | null;
+
+  /**
+   * @deprecated
    */
-  vector_store_ids: Array<string>;
+  vector_store_ids?: Array<string> | null;
 
   /**
    * Number of results to return
@@ -506,6 +713,11 @@ export interface VectorStoreQuestionAnsweringParams {
     | Array<Shared.SearchFilter | Shared.SearchFilterCondition>
     | null;
 
+  /**
+   * Optional list of file IDs to filter chunks by (inclusion filter)
+   */
+  file_ids?: Array<unknown> | Array<string> | null;
+
   /**
    * Search configuration options
    */
@@ -531,6 +743,11 @@ export namespace VectorStoreQuestionAnsweringParams {
      * Whether to use citations
      */
     cite?: boolean;
+
+    /**
+     * Whether to use multimodal context
+     */
+    multimodal?: boolean;
   }
 }
 
@@ -541,9 +758,14 @@ export interface VectorStoreSearchParams {
   query: string;
 
   /**
-   * IDs of vector stores to search
+   * IDs or names of vector stores to search
    */
-  vector_store_ids: Array<string>;
+  vector_store_identifiers?: Array<string> | null;
+
+  /**
+   * @deprecated
+   */
+  vector_store_ids?: Array<string> | null;
 
   /**
    * Number of results to return
@@ -559,6 +781,11 @@ export interface VectorStoreSearchParams {
     | Array<Shared.SearchFilter | Shared.SearchFilterCondition>
     | null;
 
+  /**
+   * Optional list of file IDs to filter chunks by (inclusion filter)
+   */
+  file_ids?: Array<unknown> | Array<string> | null;
+
   /**
    * Search configuration options
    */
@@ -570,11 +797,12 @@ VectorStores.Files = Files;
 export declare namespace VectorStores {
   export {
     type ExpiresAfter as ExpiresAfter,
-    type FileCounts as FileCounts,
-    type ScoredVectorStoreChunk as ScoredVectorStoreChunk,
+    type ScoredAudioURLInputChunk as ScoredAudioURLInputChunk,
+    type ScoredImageURLInputChunk as ScoredImageURLInputChunk,
+    type ScoredTextInputChunk as ScoredTextInputChunk,
+    type ScoredVideoURLInputChunk as ScoredVideoURLInputChunk,
     type VectorStore as VectorStore,
     type VectorStoreChunkSearchOptions as VectorStoreChunkSearchOptions,
-    type VectorStoreFileSearchOptions as VectorStoreFileSearchOptions,
     type VectorStoreDeleteResponse as VectorStoreDeleteResponse,
     type VectorStoreQuestionAnsweringResponse as VectorStoreQuestionAnsweringResponse,
     type VectorStoreSearchResponse as VectorStoreSearchResponse,

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.5.0'; // x-release-please-version
+export const VERSION = '0.7.2'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.5.0";
+export declare const VERSION = "0.7.2";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

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

package/version.js

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

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.5.0'; // x-release-please-version
+export const VERSION = '0.7.2'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map

package/src/internal/shim-types.d.ts

@@ -1,28 +0,0 @@
-// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
-
-/**
- * Shims for types that we can't always rely on being available globally.
- *
- * Note: these only exist at the type-level, there is no corresponding runtime
- * version for any of these symbols.
- */
-
-/**
- * In order to properly access the global `NodeJS` type, if it's available, we
- * need to make use of declaration shadowing. Without this, any checks for the
- * presence of `NodeJS.ReadableStream` will fail.
- */
-declare namespace NodeJS {
-  interface ReadableStream {}
-}
-
-type HasProperties<T> = keyof T extends never ? false : true;
-
-// @ts-ignore
-type _ReadableStream<R = any> =
-  // @ts-ignore
-  HasProperties<NodeJS.ReadableStream> extends true ? NodeJS.ReadableStream<R> : ReadableStream<R>;
-
-// @ts-ignore
-declare const _ReadableStream: unknown extends typeof ReadableStream ? never : typeof ReadableStream;
-export { _ReadableStream as ReadableStream };