@mixedbread/sdk 0.6.0 → 0.8.0

package/src/resources/data-sources/data-sources.ts

@@ -118,9 +118,9 @@ export interface DataSource {
   metadata: unknown;
 
   /**
-   * Authentication parameters for a OAuth data source.
+   * Authentication parameters
    */
-  auth_params: DataSourceOauth2Params | null;
+  auth_params: DataSourceOauth2Params | DataSource.DataSourceAPIKeyParams | null;
 
   /**
    * The type of the object
@@ -128,6 +128,20 @@ export interface DataSource {
   object?: 'data_source';
 }
 
+export namespace DataSource {
+  /**
+   * Authentication parameters for a API key data source.
+   */
+  export interface DataSourceAPIKeyParams {
+    type?: 'api_key';
+
+    /**
+     * The API key
+     */
+    api_key: string;
+  }
+}
+
 /**
  * Authentication parameters for a OAuth data source.
  */
@@ -139,25 +153,10 @@ export interface DataSourceOauth2Params {
    */
   created_at?: string;
 
-  /**
-   * The OAuth2 client ID
-   */
-  client_id: string;
-
-  /**
-   * The OAuth2 client secret
-   */
-  client_secret: string;
-
-  /**
-   * The OAuth2 redirect URI
-   */
-  redirect_uri: string;
-
   /**
    * The OAuth2 scope
    */
-  scope: string;
+  scope?: string;
 
   /**
    * The OAuth2 access token
@@ -178,35 +177,48 @@ export interface DataSourceOauth2Params {
    * The OAuth2 token expiration timestamp
    */
   expires_on?: string | null;
+
+  /**
+   * Additional parameters for the OAuth2 flow
+   */
+  additional_params?: Record<string, unknown> | null;
 }
 
 export type DataSourceType = 'notion' | 'linear';
 
 /**
- * Deleted data source.
+ * Parameters for creating or updating a Linear data source.
  */
-export interface DataSourceDeleteResponse {
+export interface LinearDataSource {
   /**
-   * The ID of the data source
+   * The type of data source to create
    */
-  id: string;
+  type?: DataSourceType;
 
   /**
-   * Whether the data source was deleted
+   * The name of the data source
    */
-  deleted?: boolean;
+  name: string;
 
   /**
-   * The type of the object
+   * The metadata of the data source
    */
-  object?: 'data_source';
+  metadata?: unknown;
+
+  /**
+   * Base class for OAuth2 create or update parameters.
+   */
+  auth_params?: Oauth2Params | null;
 }
 
-export interface DataSourceCreateParams {
+/**
+ * Parameters for creating or updating a Notion data source.
+ */
+export interface NotionDataSource {
   /**
    * The type of data source to create
    */
-  type: DataSourceType;
+  type?: DataSourceType;
 
   /**
    * The name of the data source
@@ -219,26 +231,181 @@ export interface DataSourceCreateParams {
   metadata?: unknown;
 
   /**
-   * Authentication parameters for a OAuth data source.
+   * The authentication parameters of the data source. Notion supports OAuth2 and API
+   * key.
    */
-  auth_params?: DataSourceOauth2Params | null;
+  auth_params?: Oauth2Params | NotionDataSource.APIKeyCreateOrUpdateParams | null;
 }
 
-export interface DataSourceUpdateParams {
+export namespace NotionDataSource {
   /**
-   * The name of the data source
+   * Base class for API key create or update parameters.
    */
-  name?: string | null;
+  export interface APIKeyCreateOrUpdateParams {
+    type?: 'api_key';
 
+    /**
+     * The API key
+     */
+    api_key: string;
+  }
+}
+
+/**
+ * Base class for OAuth2 create or update parameters.
+ */
+export interface Oauth2Params {
+  type?: 'oauth2';
+}
+
+/**
+ * Deleted data source.
+ */
+export interface DataSourceDeleteResponse {
   /**
-   * The metadata of the data source
+   * The ID of the data source
    */
-  metadata?: unknown;
+  id: string;
 
   /**
-   * Authentication parameters for a OAuth data source.
+   * Whether the data source was deleted
    */
-  auth_params?: DataSourceOauth2Params | null;
+  deleted?: boolean;
+
+  /**
+   * The type of the object
+   */
+  object?: 'data_source';
+}
+
+export type DataSourceCreateParams =
+  | DataSourceCreateParams.NotionDataSource
+  | DataSourceCreateParams.LinearDataSource;
+
+export declare namespace DataSourceCreateParams {
+  export interface NotionDataSource {
+    /**
+     * The type of data source to create
+     */
+    type?: DataSourceType;
+
+    /**
+     * The name of the data source
+     */
+    name: string;
+
+    /**
+     * The metadata of the data source
+     */
+    metadata?: unknown;
+
+    /**
+     * The authentication parameters of the data source. Notion supports OAuth2 and API
+     * key.
+     */
+    auth_params?: Oauth2Params | NotionDataSource.APIKeyCreateOrUpdateParams | null;
+  }
+
+  export namespace NotionDataSource {
+    /**
+     * Base class for API key create or update parameters.
+     */
+    export interface APIKeyCreateOrUpdateParams {
+      type?: 'api_key';
+
+      /**
+       * The API key
+       */
+      api_key: string;
+    }
+  }
+
+  export interface LinearDataSource {
+    /**
+     * The type of data source to create
+     */
+    type?: DataSourceType;
+
+    /**
+     * The name of the data source
+     */
+    name: string;
+
+    /**
+     * The metadata of the data source
+     */
+    metadata?: unknown;
+
+    /**
+     * Base class for OAuth2 create or update parameters.
+     */
+    auth_params?: Oauth2Params | null;
+  }
+}
+
+export type DataSourceUpdateParams =
+  | DataSourceUpdateParams.NotionDataSource
+  | DataSourceUpdateParams.LinearDataSource;
+
+export declare namespace DataSourceUpdateParams {
+  export interface NotionDataSource {
+    /**
+     * The type of data source to create
+     */
+    type?: DataSourceType;
+
+    /**
+     * The name of the data source
+     */
+    name: string;
+
+    /**
+     * The metadata of the data source
+     */
+    metadata?: unknown;
+
+    /**
+     * The authentication parameters of the data source. Notion supports OAuth2 and API
+     * key.
+     */
+    auth_params?: Oauth2Params | NotionDataSource.APIKeyCreateOrUpdateParams | null;
+  }
+
+  export namespace NotionDataSource {
+    /**
+     * Base class for API key create or update parameters.
+     */
+    export interface APIKeyCreateOrUpdateParams {
+      type?: 'api_key';
+
+      /**
+       * The API key
+       */
+      api_key: string;
+    }
+  }
+
+  export interface LinearDataSource {
+    /**
+     * The type of data source to create
+     */
+    type?: DataSourceType;
+
+    /**
+     * The name of the data source
+     */
+    name: string;
+
+    /**
+     * The metadata of the data source
+     */
+    metadata?: unknown;
+
+    /**
+     * Base class for OAuth2 create or update parameters.
+     */
+    auth_params?: Oauth2Params | null;
+  }
 }
 
 export interface DataSourceListParams extends LimitOffsetParams {}
@@ -250,6 +417,9 @@ export declare namespace DataSources {
     type DataSource as DataSource,
     type DataSourceOauth2Params as DataSourceOauth2Params,
     type DataSourceType as DataSourceType,
+    type LinearDataSource as LinearDataSource,
+    type NotionDataSource as NotionDataSource,
+    type Oauth2Params as Oauth2Params,
     type DataSourceDeleteResponse as DataSourceDeleteResponse,
     type DataSourcesLimitOffset as DataSourcesLimitOffset,
     type DataSourceCreateParams as DataSourceCreateParams,

package/src/resources/data-sources/index.ts

@@ -16,6 +16,9 @@ export {
   type DataSource,
   type DataSourceOauth2Params,
   type DataSourceType,
+  type LinearDataSource,
+  type NotionDataSource,
+  type Oauth2Params,
   type DataSourceDeleteResponse,
   type DataSourceCreateParams,
   type DataSourceUpdateParams,

package/src/resources/extractions/content.ts

@@ -50,6 +50,11 @@ export namespace ImageURLInput {
      * The image URL. Can be either a URL or a Data URI.
      */
     url: string;
+
+    /**
+     * The image format/mimetype
+     */
+    format?: string;
   }
 }
 

package/src/resources/index.ts

@@ -16,6 +16,9 @@ export {
   type DataSource,
   type DataSourceOauth2Params,
   type DataSourceType,
+  type LinearDataSource,
+  type NotionDataSource,
+  type Oauth2Params,
   type DataSourceDeleteResponse,
   type DataSourceCreateParams,
   type DataSourceUpdateParams,

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

@@ -1,36 +1,38 @@
 // 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';
 import { LimitOffset, type LimitOffsetParams, PagePromise } from '../../core/pagination';
 import { RequestOptions } from '../../internal/request-options';
-import { path } from '../../internal/utils/path';
 import * as polling from '../../lib/polling';
 import { Uploadable } from '../../uploads';
+import { path } from '../../internal/utils/path';
 
 export class Files extends APIResource {
   /**
    * Upload a new file to a vector store for indexing.
    *
-   * Args: vector_store_id: The ID of the vector store to upload to file: The file to
-   * upload and index
+   * Args: vector_store_identifier: The ID or name of the vector store to upload to
+   * file: The file to upload and index
    *
    * Returns: VectorStoreFile: Details of the uploaded and indexed file
    */
   create(
-    vectorStoreID: string,
+    vectorStoreIdentifier: string,
     body: FileCreateParams,
     options?: RequestOptions,
   ): APIPromise<VectorStoreFile> {
-    return this._client.post(path`/v1/vector_stores/${vectorStoreID}/files`, { body, ...options });
+    return this._client.post(path`/v1/vector_stores/${vectorStoreIdentifier}/files`, { body, ...options });
   }
 
   /**
    * Get details of a specific file in a vector store.
    *
-   * Args: vector_store_id: The ID of the vector store file_id: The ID of the file
+   * Args: vector_store_identifier: The ID or name of the vector store file_id: The
+   * ID of the file
    *
    * Returns: VectorStoreFile: Details of the vector store file
    */
@@ -39,25 +41,25 @@ export class Files extends APIResource {
     params: FileRetrieveParams,
     options?: RequestOptions,
   ): APIPromise<VectorStoreFile> {
-    const { vector_store_id } = params;
-    return this._client.get(path`/v1/vector_stores/${vector_store_id}/files/${fileID}`, options);
+    const { vector_store_identifier } = params;
+    return this._client.get(path`/v1/vector_stores/${vector_store_identifier}/files/${fileID}`, options);
   }
 
   /**
    * List files indexed in a vector store with pagination.
    *
-   * Args: vector_store_id: The ID of the vector store pagination: Pagination
-   * parameters
+   * Args: vector_store_identifier: The ID or name of the vector store pagination:
+   * Pagination parameters
    *
    * Returns: VectorStoreFileListResponse: Paginated list of vector store files
    */
   list(
-    vectorStoreID: string,
+    vectorStoreIdentifier: string,
     query: FileListParams | null | undefined = {},
     options?: RequestOptions,
   ): PagePromise<VectorStoreFilesLimitOffset, VectorStoreFile> {
     return this._client.getAPIList(
-      path`/v1/vector_stores/${vectorStoreID}/files`,
+      path`/v1/vector_stores/${vectorStoreIdentifier}/files`,
       LimitOffset<VectorStoreFile>,
       { query, ...options },
     );
@@ -66,14 +68,14 @@ export class Files extends APIResource {
   /**
    * Delete a file from a vector store.
    *
-   * Args: vector_store_id: The ID of the vector store file_id: The ID of the file to
-   * delete
+   * Args: vector_store_identifier: The ID or name of the vector store file_id: The
+   * ID of the file to delete
    *
    * Returns: VectorStoreFileDeleted: The deleted file
    */
   delete(fileID: string, params: FileDeleteParams, options?: RequestOptions): APIPromise<FileDeleteResponse> {
-    const { vector_store_id } = params;
-    return this._client.delete(path`/v1/vector_stores/${vector_store_id}/files/${fileID}`, options);
+    const { vector_store_identifier } = params;
+    return this._client.delete(path`/v1/vector_stores/${vector_store_identifier}/files/${fileID}`, options);
   }
 
   /**
@@ -101,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)
@@ -109,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,
@@ -119,9 +121,9 @@ export class Files extends APIResource {
     const pollingTimeoutMs = pollTimeoutMs;
 
     return polling.poll({
-      fn: () => this.retrieve(fileId, { vector_store_id: vectorStoreId, ...options }),
+      fn: () => this.retrieve(fileId, { vector_store_identifier: vectorStoreIdentifier, ...options }),
       condition: (result) =>
-        result.status === 'completed' || result.status === 'failed' || result.status === 'error',
+        result.status === 'completed' || result.status === 'failed' || result.status === 'cancelled',
       intervalSeconds: pollingIntervalMs / 1000,
       ...(pollingTimeoutMs && { timeoutSeconds: pollingTimeoutMs / 1000 }),
     });
@@ -130,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)
@@ -138,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,
@@ -167,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,
@@ -179,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)
@@ -188,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.
  */
@@ -224,7 +247,7 @@ export interface ScoredVectorStoreFile {
   /**
    * Processing status of the file
    */
-  status?: string;
+  status?: VectorStoreFileStatus;
 
   /**
    * Last error message if processing failed
@@ -272,6 +295,8 @@ export interface ScoredVectorStoreFile {
   > | null;
 }
 
+export type VectorStoreFileStatus = 'pending' | 'in_progress' | 'cancelled' | 'completed' | 'failed';
+
 /**
  * Represents a file stored in a vector store.
  */
@@ -294,7 +319,7 @@ export interface VectorStoreFile {
   /**
    * Processing status of the file
    */
-  status?: string;
+  status?: VectorStoreFileStatus;
 
   /**
    * Last error message if processing failed
@@ -395,18 +420,18 @@ export namespace FileCreateParams {
 
 export interface FileRetrieveParams {
   /**
-   * The ID of the vector store
+   * The ID or name of the vector store
    */
-  vector_store_id: string;
+  vector_store_identifier: string;
 }
 
 export interface FileListParams extends LimitOffsetParams {}
 
 export interface FileDeleteParams {
   /**
-   * The ID of the vector store
+   * The ID or name of the vector store
    */
-  vector_store_id: string;
+  vector_store_identifier: string;
 }
 
 export interface FileSearchParams {
@@ -416,9 +441,14 @@ export interface FileSearchParams {
   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
@@ -434,6 +464,11 @@ export interface FileSearchParams {
     | 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
    */
@@ -455,6 +490,11 @@ export namespace FileSearchParams {
      */
     rewrite_query?: boolean;
 
+    /**
+     * Whether to rerank results and optional reranking configuration
+     */
+    rerank?: boolean | FilesAPI.RerankConfig | null;
+
     /**
      * Whether to return file metadata
      */
@@ -474,7 +514,9 @@ export namespace FileSearchParams {
 
 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,