@mixedbread/sdk 0.7.2 → 0.9.0

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

@@ -1,6 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../core/resource';
+import * as FilesAPI from './files';
 import * as Shared from '../shared';
 import * as VectorStoresAPI from './vector-stores';
 import { APIPromise } from '../../core/api-promise';
@@ -102,7 +103,7 @@ export class Files extends APIResource {
   /**
    * Poll for a file's processing status until it reaches a terminal state.
    *
-   * @param vectorStoreId - The ID of the vector store
+   * @param vectorStoreIdentifier - The identifier of the vector store
    * @param fileId - The ID of the file to poll
    * @param pollIntervalMs - The interval between polls in milliseconds (default: 500)
    * @param pollTimeoutMs - The maximum time to poll for in milliseconds (default: no timeout)
@@ -110,7 +111,7 @@ export class Files extends APIResource {
    * @returns The file object once it reaches a terminal state
    */
   async poll(
-    vectorStoreId: string,
+    vectorStoreIdentifier: string,
     fileId: string,
     pollIntervalMs?: number,
     pollTimeoutMs?: number,
@@ -120,7 +121,7 @@ export class Files extends APIResource {
     const pollingTimeoutMs = pollTimeoutMs;
 
     return polling.poll({
-      fn: () => this.retrieve(fileId, { vector_store_identifier: vectorStoreId, ...options }),
+      fn: () => this.retrieve(fileId, { vector_store_identifier: vectorStoreIdentifier, ...options }),
       condition: (result) =>
         result.status === 'completed' || result.status === 'failed' || result.status === 'cancelled',
       intervalSeconds: pollingIntervalMs / 1000,
@@ -131,7 +132,7 @@ export class Files extends APIResource {
   /**
    * Create a file in a vector store and wait for it to be processed.
    *
-   * @param vectorStoreId - The ID of the vector store to upload to
+   * @param vectorStoreIdentifier - The identifier of the vector store to upload to
    * @param body - The file creation parameters
    * @param pollIntervalMs - The interval between polls in milliseconds (default: 500)
    * @param pollTimeoutMs - The maximum time to poll for in milliseconds (default: no timeout)
@@ -139,28 +140,28 @@ export class Files extends APIResource {
    * @returns The file object once it reaches a terminal state
    */
   async createAndPoll(
-    vectorStoreId: string,
+    vectorStoreIdentifier: string,
     body: FileCreateParams,
     pollIntervalMs?: number,
     pollTimeoutMs?: number,
     options?: RequestOptions,
   ): Promise<VectorStoreFile> {
-    const file = await this.create(vectorStoreId, body, options);
-    return this.poll(vectorStoreId, file.id, pollIntervalMs, pollTimeoutMs, options);
+    const file = await this.create(vectorStoreIdentifier, body, options);
+    return this.poll(vectorStoreIdentifier, file.id, pollIntervalMs, pollTimeoutMs, options);
   }
 
   /**
    * Upload a file to the files API and then create a file in a vector store.
    * Note the file will be asynchronously processed.
    *
-   * @param vectorStoreId - The ID of the vector store to add the file to
+   * @param vectorStoreIdentifier - The identifier of the vector store to add the file to
    * @param file - The file to upload
    * @param body - Additional parameters for the vector store file
    * @param options - Additional request options
    * @returns The created vector store file
    */
   async upload(
-    vectorStoreId: string,
+    vectorStoreIdentifier: string,
     file: Uploadable,
     body?: Omit<FileCreateParams, 'file_id'>,
     options?: RequestOptions,
@@ -168,7 +169,7 @@ export class Files extends APIResource {
     const fileUploadResponse = await this._client.files.create({ file }, options);
 
     return this.create(
-      vectorStoreId,
+      vectorStoreIdentifier,
       {
         file_id: fileUploadResponse.id,
         ...body,
@@ -180,7 +181,7 @@ export class Files extends APIResource {
   /**
    * Upload a file to files API, create a file in a vector store, and poll until processing is complete.
    *
-   * @param vectorStoreId - The ID of the vector store to add the file to
+   * @param vectorStoreIdentifier - The identifier of the vector store to add the file to
    * @param file - The file to upload
    * @param body - Additional parameters for the vector store file
    * @param pollIntervalMs - The interval between polls in milliseconds (default: 500)
@@ -189,20 +190,41 @@ export class Files extends APIResource {
    * @returns The vector store file object once it reaches a terminal state
    */
   async uploadAndPoll(
-    vectorStoreId: string,
+    vectorStoreIdentifier: string,
     file: Uploadable,
     body?: Omit<FileCreateParams, 'file_id'>,
     pollIntervalMs?: number,
     pollTimeoutMs?: number,
     options?: RequestOptions,
   ): Promise<VectorStoreFile> {
-    const vectorStoreFile = await this.upload(vectorStoreId, file, body, options);
-    return this.poll(vectorStoreId, vectorStoreFile.id, pollIntervalMs, pollTimeoutMs, options);
+    const vectorStoreFile = await this.upload(vectorStoreIdentifier, file, body, options);
+    return this.poll(vectorStoreIdentifier, vectorStoreFile.id, pollIntervalMs, pollTimeoutMs, options);
   }
 }
 
 export type VectorStoreFilesLimitOffset = LimitOffset<VectorStoreFile>;
 
+/**
+ * Represents a reranking configuration.
+ */
+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;
+}
+
 /**
  * Represents a scored file stored in a vector store.
  */
@@ -225,7 +247,7 @@ export interface ScoredVectorStoreFile {
   /**
    * Processing status of the file
    */
-  status?: 'pending' | 'in_progress' | 'cancelled' | 'completed' | 'failed';
+  status?: VectorStoreFileStatus;
 
   /**
    * Last error message if processing failed
@@ -273,6 +295,8 @@ export interface ScoredVectorStoreFile {
   > | null;
 }
 
+export type VectorStoreFileStatus = 'pending' | 'in_progress' | 'cancelled' | 'completed' | 'failed';
+
 /**
  * Represents a file stored in a vector store.
  */
@@ -295,7 +319,7 @@ export interface VectorStoreFile {
   /**
    * Processing status of the file
    */
-  status?: 'pending' | 'in_progress' | 'cancelled' | 'completed' | 'failed';
+  status?: VectorStoreFileStatus;
 
   /**
    * Last error message if processing failed
@@ -469,7 +493,7 @@ export namespace FileSearchParams {
     /**
      * Whether to rerank results and optional reranking configuration
      */
-    rerank?: boolean | SearchOptions.RerankConfig | null;
+    rerank?: boolean | FilesAPI.RerankConfig | null;
 
     /**
      * Whether to return file metadata
@@ -486,34 +510,13 @@ export namespace FileSearchParams {
      */
     chunks_per_file?: number;
   }
-
-  export namespace SearchOptions {
-    /**
-     * Represents a reranking configuration.
-     */
-    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;
-    }
-  }
 }
 
 export declare namespace Files {
   export {
+    type RerankConfig as RerankConfig,
     type ScoredVectorStoreFile as ScoredVectorStoreFile,
+    type VectorStoreFileStatus as VectorStoreFileStatus,
     type VectorStoreFile as VectorStoreFile,
     type FileDeleteResponse as FileDeleteResponse,
     type FileSearchResponse as FileSearchResponse,

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

@@ -2,7 +2,9 @@
 
 export {
   Files,
+  type RerankConfig,
   type ScoredVectorStoreFile,
+  type VectorStoreFileStatus,
   type VectorStoreFile,
   type FileDeleteResponse,
   type FileSearchResponse,

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

@@ -12,8 +12,10 @@ import {
   FileSearchParams,
   FileSearchResponse,
   Files,
+  RerankConfig,
   ScoredVectorStoreFile,
   VectorStoreFile,
+  VectorStoreFileStatus,
   VectorStoreFilesLimitOffset,
 } from './files';
 import { APIPromise } from '../../core/api-promise';
@@ -439,6 +441,11 @@ export interface VectorStore {
    */
   description?: string | null;
 
+  /**
+   * Whether the vector store can be accessed by anyone with valid login credentials
+   */
+  is_public?: boolean;
+
   /**
    * Additional metadata associated with the vector store
    */
@@ -544,7 +551,7 @@ export interface VectorStoreChunkSearchOptions {
   /**
    * Whether to rerank results and optional reranking configuration
    */
-  rerank?: boolean | VectorStoreChunkSearchOptions.RerankConfig | null;
+  rerank?: boolean | FilesAPI.RerankConfig | null;
 
   /**
    * Whether to return file metadata
@@ -552,29 +559,6 @@ export interface VectorStoreChunkSearchOptions {
   return_metadata?: boolean;
 }
 
-export namespace VectorStoreChunkSearchOptions {
-  /**
-   * Represents a reranking configuration.
-   */
-  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;
-  }
-}
-
 /**
  * Response model for vector store deletion.
  */
@@ -637,6 +621,11 @@ export interface VectorStoreCreateParams {
    */
   description?: string | null;
 
+  /**
+   * Whether the vector store can be accessed by anyone with valid login credentials
+   */
+  is_public?: boolean;
+
   /**
    * Represents an expiration policy for a vector store.
    */
@@ -664,6 +653,11 @@ export interface VectorStoreUpdateParams {
    */
   description?: string | null;
 
+  /**
+   * Whether the vector store can be accessed by anyone with valid login credentials
+   */
+  is_public?: boolean | null;
+
   /**
    * Represents an expiration policy for a vector store.
    */
@@ -816,7 +810,9 @@ export declare namespace VectorStores {
 
   export {
     Files as Files,
+    type RerankConfig as RerankConfig,
     type ScoredVectorStoreFile as ScoredVectorStoreFile,
+    type VectorStoreFileStatus as VectorStoreFileStatus,
     type VectorStoreFile as VectorStoreFile,
     type FileDeleteResponse as FileDeleteResponse,
     type FileSearchResponse as FileSearchResponse,

package/src/version.ts

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

package/version.d.mts

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

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.7.2";
+export declare const VERSION = "0.9.0";
 //# 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.7.2'; // x-release-please-version
+exports.VERSION = '0.9.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

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