@mixedbread/sdk 0.61.0 → 0.62.0

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

@@ -27,6 +27,13 @@ export class DataSources extends APIResource {
    * Args: params: The data source to create.
    *
    * Returns: The created data source.
+   *
+   * @example
+   * ```ts
+   * const dataSource = await client.dataSources.create({
+   *   name: 'name',
+   * });
+   * ```
    */
   create(body: DataSourceCreateParams, options?: RequestOptions): APIPromise<DataSource> {
     return this._client.post('/v1/data_sources/', { body, ...options });
@@ -38,6 +45,13 @@ export class DataSources extends APIResource {
    * Args: data_source_id: The ID of the data source to fetch.
    *
    * Returns: The data source.
+   *
+   * @example
+   * ```ts
+   * const dataSource = await client.dataSources.retrieve(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   * );
+   * ```
    */
   retrieve(dataSourceID: string, options?: RequestOptions): APIPromise<DataSource> {
     return this._client.get(path`/v1/data_sources/${dataSourceID}`, options);
@@ -50,6 +64,14 @@ export class DataSources extends APIResource {
    * source to update.
    *
    * Returns: The updated data source.
+   *
+   * @example
+   * ```ts
+   * const dataSource = await client.dataSources.update(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   { name: 'name' },
+   * );
+   * ```
    */
   update(
     dataSourceID: string,
@@ -63,6 +85,14 @@ export class DataSources extends APIResource {
    * Get all data sources.
    *
    * Returns: The list of data sources.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const dataSource of client.dataSources.list()) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     query: DataSourceListParams | null | undefined = {},
@@ -75,6 +105,13 @@ export class DataSources extends APIResource {
    * Delete a data source.
    *
    * Args: data_source_id: The ID of the data source to delete.
+   *
+   * @example
+   * ```ts
+   * const dataSource = await client.dataSources.delete(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   * );
+   * ```
    */
   delete(dataSourceID: string, options?: RequestOptions): APIPromise<DataSourceDeleteResponse> {
     return this._client.delete(path`/v1/data_sources/${dataSourceID}`, options);
@@ -83,6 +120,18 @@ export class DataSources extends APIResource {
 
 export type DataSourcesCursor = Cursor<DataSource>;
 
+/**
+ * Base class for API key create or update parameters.
+ */
+export interface APIKeyCreateOrUpdateParams {
+  type?: 'api_key';
+
+  /**
+   * The API key
+   */
+  api_key: string;
+}
+
 /**
  * Service-level representation of a data source.
  */
@@ -120,7 +169,7 @@ export interface DataSource {
   /**
    * Authentication parameters
    */
-  auth_params: DataSourceOauth2Params | DataSource.DataSourceAPIKeyParams | null;
+  auth_params: DataSourceOauth2Params | DataSourceAPIKeyParams | null;
 
   /**
    * The type of the object
@@ -128,18 +177,16 @@ export interface DataSource {
   object?: 'data_source';
 }
 
-export namespace DataSource {
+/**
+ * Authentication parameters for a API key data source.
+ */
+export interface DataSourceAPIKeyParams {
+  type?: 'api_key';
+
   /**
-   * Authentication parameters for a API key data source.
+   * The API key
    */
-  export interface DataSourceAPIKeyParams {
-    type?: 'api_key';
-
-    /**
-     * The API key
-     */
-    api_key: string;
-  }
+  api_key: string;
 }
 
 /**
@@ -234,21 +281,7 @@ export interface NotionDataSource {
    * 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;
-  }
+  auth_params?: Oauth2Params | APIKeyCreateOrUpdateParams | null;
 }
 
 /**
@@ -303,21 +336,7 @@ export declare namespace DataSourceCreateParams {
      * 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;
-    }
+    auth_params?: Oauth2Params | APIKeyCreateOrUpdateParams | null;
   }
 
   export interface LinearDataSource {
@@ -368,21 +387,7 @@ export declare namespace DataSourceUpdateParams {
      * 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;
-    }
+    auth_params?: Oauth2Params | APIKeyCreateOrUpdateParams | null;
   }
 
   export interface LinearDataSource {
@@ -414,7 +419,9 @@ DataSources.Connectors = Connectors;
 
 export declare namespace DataSources {
   export {
+    type APIKeyCreateOrUpdateParams as APIKeyCreateOrUpdateParams,
     type DataSource as DataSource,
+    type DataSourceAPIKeyParams as DataSourceAPIKeyParams,
     type DataSourceOauth2Params as DataSourceOauth2Params,
     type DataSourceType as DataSourceType,
     type LinearDataSource as LinearDataSource,

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

@@ -13,7 +13,9 @@ export {
 } from './connectors';
 export {
   DataSources,
+  type APIKeyCreateOrUpdateParams,
   type DataSource,
+  type DataSourceAPIKeyParams,
   type DataSourceOauth2Params,
   type DataSourceType,
   type LinearDataSource,

package/src/resources/embeddings.ts

@@ -13,6 +13,15 @@ export class Embeddings extends APIResource {
    * Args: params: The parameters for creating embeddings.
    *
    * Returns: EmbeddingCreateResponse: The response containing the embeddings.
+   *
+   * @example
+   * ```ts
+   * const embeddingCreateResponse =
+   *   await client.embeddings.create({
+   *     model: 'mixedbread-ai/mxbai-embed-large-v1',
+   *     input: 'x',
+   *   });
+   * ```
    */
   create(
     body: EmbeddingCreateParams,

package/src/resources/files/files.ts

@@ -31,6 +31,13 @@ export class Files extends APIResource {
    * Args: file: The file to upload.
    *
    * Returns: FileResponse: The response containing the details of the uploaded file.
+   *
+   * @example
+   * ```ts
+   * const fileObject = await client.files.create({
+   *   file: fs.createReadStream('path/to/file'),
+   * });
+   * ```
    */
   create(body: FileCreateParams, options?: RequestOptions): APIPromise<FileObject> {
     return handleFileCreate(this._client, body, options);
@@ -42,6 +49,13 @@ export class Files extends APIResource {
    * Args: file_id: The ID of the file to retrieve.
    *
    * Returns: FileResponse: The response containing the file details.
+   *
+   * @example
+   * ```ts
+   * const fileObject = await client.files.retrieve(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   * );
+   * ```
    */
   retrieve(fileID: string, options?: RequestOptions): APIPromise<FileObject> {
     return this._client.get(path`/v1/files/${fileID}`, options);
@@ -53,6 +67,14 @@ export class Files extends APIResource {
    * Args: file_id: The ID of the file to update. file: The new details for the file.
    *
    * Returns: FileObject: The updated file details.
+   *
+   * @example
+   * ```ts
+   * const fileObject = await client.files.update(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   { file: fs.createReadStream('path/to/file') },
+   * );
+   * ```
    */
   update(fileID: string, body: FileUpdateParams, options?: RequestOptions): APIPromise<FileObject> {
     return this._client.post(
@@ -67,6 +89,14 @@ export class Files extends APIResource {
    * Args: pagination: The pagination options
    *
    * Returns: A list of files belonging to the user.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const fileObject of client.files.list()) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     query: FileListParams | null | undefined = {},
@@ -81,6 +111,13 @@ export class Files extends APIResource {
    * Args: file_id: The ID of the file to delete.
    *
    * Returns: FileDeleted: The response containing the details of the deleted file.
+   *
+   * @example
+   * ```ts
+   * const file = await client.files.delete(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   * );
+   * ```
    */
   delete(fileID: string, options?: RequestOptions): APIPromise<FileDeleteResponse> {
     return this._client.delete(path`/v1/files/${fileID}`, options);
@@ -92,6 +129,16 @@ export class Files extends APIResource {
    * Args: file_id: The ID of the file to download.
    *
    * Returns: FileStreamResponse: The response containing the file to be downloaded.
+   *
+   * @example
+   * ```ts
+   * const response = await client.files.content(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   * );
+   *
+   * const content = await response.blob();
+   * console.log(content);
+   * ```
    */
   content(fileID: string, options?: RequestOptions): APIPromise<Response> {
     return this._client.get(path`/v1/files/${fileID}/content`, {

package/src/resources/files/uploads.ts

@@ -10,6 +10,15 @@ export class Uploads extends APIResource {
   /**
    * Initiate a multipart upload and receive presigned URLs for uploading parts
    * directly to storage.
+   *
+   * @example
+   * ```ts
+   * const upload = await client.files.uploads.create({
+   *   filename: 'document.pdf',
+   *   file_size: 10485760,
+   *   mime_type: 'application/pdf',
+   * });
+   * ```
    */
   create(body: UploadCreateParams, options?: RequestOptions): APIPromise<UploadCreateResponse> {
     return this._client.post('/v1/files/uploads', { body, ...options });
@@ -18,6 +27,13 @@ export class Uploads extends APIResource {
   /**
    * Get a multipart upload's details with fresh presigned URLs for any parts not yet
    * uploaded.
+   *
+   * @example
+   * ```ts
+   * const upload = await client.files.uploads.retrieve(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   * );
+   * ```
    */
   retrieve(uploadID: string, options?: RequestOptions): APIPromise<UploadRetrieveResponse> {
     return this._client.get(path`/v1/files/uploads/${uploadID}`, options);
@@ -25,6 +41,11 @@ export class Uploads extends APIResource {
 
   /**
    * List all in-progress multipart uploads for the authenticated organization.
+   *
+   * @example
+   * ```ts
+   * const uploads = await client.files.uploads.list();
+   * ```
    */
   list(options?: RequestOptions): APIPromise<UploadListResponse> {
     return this._client.get('/v1/files/uploads', options);
@@ -32,6 +53,13 @@ export class Uploads extends APIResource {
 
   /**
    * Abort a multipart upload and clean up any uploaded parts.
+   *
+   * @example
+   * ```ts
+   * const response = await client.files.uploads.abort(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   * );
+   * ```
    */
   abort(uploadID: string, options?: RequestOptions): APIPromise<UploadAbortResponse> {
     return this._client.post(path`/v1/files/uploads/${uploadID}/abort`, options);
@@ -40,6 +68,14 @@ export class Uploads extends APIResource {
   /**
    * Complete a multipart upload after all parts have been uploaded. Creates the file
    * object and returns it.
+   *
+   * @example
+   * ```ts
+   * const fileObject = await client.files.uploads.complete(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   { parts: [{ part_number: 1, etag: 'etag' }] },
+   * );
+   * ```
    */
   complete(
     uploadID: string,

package/src/resources/index.ts

@@ -5,6 +5,7 @@ export {
   APIKeys,
   type APIKey,
   type APIKeyCreated,
+  type Scope,
   type APIKeyDeleteResponse,
   type APIKeyCreateParams,
   type APIKeyListParams,
@@ -13,7 +14,9 @@ export {
 export { Chat, type ChatCreateCompletionResponse } from './chat';
 export {
   DataSources,
+  type APIKeyCreateOrUpdateParams,
   type DataSource,
+  type DataSourceAPIKeyParams,
   type DataSourceOauth2Params,
   type DataSourceType,
   type LinearDataSource,
@@ -40,13 +43,29 @@ export {
 export { Parsing } from './parsing/parsing';
 export {
   Stores,
+  type AgenticSearchConfig,
+  type AudioChunkGeneratedMetadata,
+  type AudioURL,
+  type CodeChunkGeneratedMetadata,
+  type ContextualizationConfig,
   type ExpiresAfter,
+  type FileCounts,
+  type ImageChunkGeneratedMetadata,
+  type ImageURLOutput,
+  type MarkdownChunkGeneratedMetadata,
+  type MarkdownHeading,
+  type PdfChunkGeneratedMetadata,
+  type RerankConfig,
   type ScoredAudioURLInputChunk,
   type ScoredImageURLInputChunk,
   type ScoredTextInputChunk,
   type ScoredVideoURLInputChunk,
   type Store,
   type StoreChunkSearchOptions,
+  type StoreConfig,
+  type TextChunkGeneratedMetadata,
+  type VideoChunkGeneratedMetadata,
+  type VideoURL,
   type StoreDeleteResponse,
   type StoreMetadataFacetsResponse,
   type StoreQuestionAnsweringResponse,

package/src/resources/parsing/index.ts

@@ -2,10 +2,13 @@
 
 export {
   Jobs,
+  type Chunk,
+  type ChunkElement,
   type ChunkingStrategy,
+  type DocumentParserResult,
   type ElementType,
-  type ParsingJobStatus,
   type ParsingJob,
+  type ParsingJobStatus,
   type ReturnFormat,
   type JobListResponse,
   type JobDeleteResponse,

package/src/resources/parsing/jobs.ts

@@ -1,7 +1,6 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../core/resource';
-import * as JobsAPI from './jobs';
 import { APIPromise } from '../../core/api-promise';
 import { Cursor, type CursorParams, PagePromise } from '../../core/pagination';
 import { RequestOptions } from '../../internal/request-options';
@@ -163,11 +162,101 @@ export class Jobs extends APIResource {
 
 export type JobListResponsesCursor = Cursor<JobListResponse>;
 
+/**
+ * A chunk of text extracted from a document page.
+ */
+export interface Chunk {
+  /**
+   * The full content of the chunk
+   */
+  content?: string | null;
+
+  /**
+   * The content of the chunk to embed
+   */
+  content_to_embed: string;
+
+  /**
+   * List of elements contained in this chunk
+   */
+  elements: Array<ChunkElement>;
+}
+
+/**
+ * Represents an extracted element from a document with its content and metadata.
+ */
+export interface ChunkElement {
+  /**
+   * The type of the extracted element
+   */
+  type: ElementType;
+
+  /**
+   * The confidence score of the extraction
+   */
+  confidence: number;
+
+  /**
+   * The bounding box coordinates [x1, y1, x2, y2]
+   */
+  bbox: Array<unknown>;
+
+  /**
+   * The page number where the element was found
+   */
+  page: number;
+
+  /**
+   * The extracted text content of the element
+   */
+  content: string;
+
+  /**
+   * A brief summary of the element's content
+   */
+  summary?: string | null;
+
+  /**
+   * The base64-encoded image data for figure elements
+   */
+  image?: string | null;
+}
+
 /**
  * Strategy used for chunking document content.
  */
 export type ChunkingStrategy = 'page';
 
+/**
+ * Result of document parsing operation.
+ */
+export interface DocumentParserResult {
+  /**
+   * The strategy used for chunking the document
+   */
+  chunking_strategy: ChunkingStrategy;
+
+  /**
+   * The format of the returned content
+   */
+  return_format: ReturnFormat;
+
+  /**
+   * The types of elements extracted
+   */
+  element_types: Array<ElementType>;
+
+  /**
+   * List of extracted chunks from the document
+   */
+  chunks: Array<Chunk>;
+
+  /**
+   * List of (width, height) tuples for each page
+   */
+  page_sizes?: Array<Array<unknown>>;
+}
+
 /**
  * Types of elements that can be extracted from a document.
  */
@@ -184,8 +273,6 @@ export type ElementType =
   | 'text'
   | 'footnote';
 
-export type ParsingJobStatus = 'pending' | 'in_progress' | 'cancelled' | 'completed' | 'failed';
-
 /**
  * A job for parsing documents with its current state and result.
  */
@@ -218,7 +305,7 @@ export interface ParsingJob {
   /**
    * Result of document parsing operation.
    */
-  result?: ParsingJob.Result | null;
+  result?: DocumentParserResult | null;
 
   /**
    * The started time of the job
@@ -246,101 +333,7 @@ export interface ParsingJob {
   object?: 'parsing_job';
 }
 
-export namespace ParsingJob {
-  /**
-   * Result of document parsing operation.
-   */
-  export interface Result {
-    /**
-     * The strategy used for chunking the document
-     */
-    chunking_strategy: JobsAPI.ChunkingStrategy;
-
-    /**
-     * The format of the returned content
-     */
-    return_format: JobsAPI.ReturnFormat;
-
-    /**
-     * The types of elements extracted
-     */
-    element_types: Array<JobsAPI.ElementType>;
-
-    /**
-     * List of extracted chunks from the document
-     */
-    chunks: Array<Result.Chunk>;
-
-    /**
-     * List of (width, height) tuples for each page
-     */
-    page_sizes?: Array<Array<unknown>>;
-  }
-
-  export namespace Result {
-    /**
-     * A chunk of text extracted from a document page.
-     */
-    export interface Chunk {
-      /**
-       * The full content of the chunk
-       */
-      content?: string | null;
-
-      /**
-       * The content of the chunk to embed
-       */
-      content_to_embed: string;
-
-      /**
-       * List of elements contained in this chunk
-       */
-      elements: Array<Chunk.Element>;
-    }
-
-    export namespace Chunk {
-      /**
-       * Represents an extracted element from a document with its content and metadata.
-       */
-      export interface Element {
-        /**
-         * The type of the extracted element
-         */
-        type: JobsAPI.ElementType;
-
-        /**
-         * The confidence score of the extraction
-         */
-        confidence: number;
-
-        /**
-         * The bounding box coordinates [x1, y1, x2, y2]
-         */
-        bbox: Array<unknown>;
-
-        /**
-         * The page number where the element was found
-         */
-        page: number;
-
-        /**
-         * The extracted text content of the element
-         */
-        content: string;
-
-        /**
-         * A brief summary of the element's content
-         */
-        summary?: string | null;
-
-        /**
-         * The base64-encoded image data for figure elements
-         */
-        image?: string | null;
-      }
-    }
-  }
-}
+export type ParsingJobStatus = 'pending' | 'in_progress' | 'cancelled' | 'completed' | 'failed';
 
 /**
  * Format options for the returned document content.
@@ -463,10 +456,13 @@ export interface JobListParams extends CursorParams {
 
 export declare namespace Jobs {
   export {
+    type Chunk as Chunk,
+    type ChunkElement as ChunkElement,
     type ChunkingStrategy as ChunkingStrategy,
+    type DocumentParserResult as DocumentParserResult,
     type ElementType as ElementType,
-    type ParsingJobStatus as ParsingJobStatus,
     type ParsingJob as ParsingJob,
+    type ParsingJobStatus as ParsingJobStatus,
     type ReturnFormat as ReturnFormat,
     type JobListResponse as JobListResponse,
     type JobDeleteResponse as JobDeleteResponse,