@mixedbread/sdk 0.15.0 → 0.17.0

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

@@ -5,6 +5,7 @@ import * as FilesAPI from './files';
 import * as Shared from '../shared';
 import * as VectorStoresAPI from './vector-stores';
 import { APIPromise } from '../../core/api-promise';
+import { Cursor, type CursorParams, PagePromise } from '../../core/pagination';
 import { RequestOptions } from '../../internal/request-options';
 import * as polling from '../../lib/polling';
 import { Uploadable } from '../../uploads';
@@ -40,8 +41,11 @@ export class Files extends APIResource {
     params: FileRetrieveParams,
     options?: RequestOptions,
   ): APIPromise<VectorStoreFile> {
-    const { vector_store_identifier } = params;
-    return this._client.get(path`/v1/vector_stores/${vector_store_identifier}/files/${fileID}`, options);
+    const { vector_store_identifier, ...query } = params;
+    return this._client.get(path`/v1/vector_stores/${vector_store_identifier}/files/${fileID}`, {
+      query,
+      ...options,
+    });
   }
 
   /**
@@ -56,8 +60,12 @@ export class Files extends APIResource {
     vectorStoreIdentifier: string,
     query: FileListParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<FileListResponse> {
-    return this._client.get(path`/v1/vector_stores/${vectorStoreIdentifier}/files`, { query, ...options });
+  ): PagePromise<VectorStoreFilesCursor, VectorStoreFile> {
+    return this._client.getAPIList(
+      path`/v1/vector_stores/${vectorStoreIdentifier}/files`,
+      Cursor<VectorStoreFile>,
+      { query, ...options },
+    );
   }
 
   /**
@@ -197,6 +205,8 @@ export class Files extends APIResource {
   }
 }
 
+export type VectorStoreFilesCursor = Cursor<VectorStoreFile>;
+
 /**
  * Represents a reranking configuration.
  */
@@ -272,11 +282,6 @@ export interface ScoredVectorStoreFile {
    */
   object?: 'vector_store.file';
 
-  /**
-   * score of the file
-   */
-  score: number;
-
   /**
    * chunks
    */
@@ -286,6 +291,11 @@ export interface ScoredVectorStoreFile {
     | VectorStoresAPI.ScoredAudioURLInputChunk
     | VectorStoresAPI.ScoredVideoURLInputChunk
   > | null;
+
+  /**
+   * score of the file
+   */
+  score: number;
 }
 
 export type VectorStoreFileStatus = 'pending' | 'in_progress' | 'cancelled' | 'completed' | 'failed';
@@ -343,94 +353,165 @@ export interface VectorStoreFile {
    * Type of the object
    */
   object?: 'vector_store.file';
-}
 
-export interface FileListResponse {
   /**
-   * Response model for cursor-based pagination.
-   *
-   * Examples: Forward pagination response: { "has_more": true, "first_cursor":
-   * "eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMSIsImlkIjoiYWJjMTIzIn0=", "last_cursor":
-   * "eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMCIsImlkIjoieHl6Nzg5In0=", "total": null }
-   *
-   *     Final page response:
-   *         {
-   *             "has_more": false,
-   *             "first_cursor": "eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0yOSIsImlkIjoibGFzdDEyMyJ9",
-   *             "last_cursor": "eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0yOCIsImlkIjoiZmluYWw0NTYifQ==",
-   *             "total": 42
-   *         }
-   *
-   *     Empty results:
-   *         {
-   *             "has_more": false,
-   *             "first_cursor": null,
-   *             "last_cursor": null,
-   *             "total": 0
-   *         }
+   * chunks
    */
-  pagination: FileListResponse.Pagination;
+  chunks?: Array<
+    | VectorStoreFile.TextInputChunk
+    | VectorStoreFile.ImageURLInputChunkBase
+    | VectorStoreFile.AudioURLInputChunkBase
+    | VectorStoreFile.VideoURLInputChunkBase
+  > | null;
+}
 
-  /**
-   * The object type of the response
-   */
-  object?: 'list';
+export namespace VectorStoreFile {
+  export interface TextInputChunk {
+    /**
+     * position of the chunk in a file
+     */
+    chunk_index: number;
 
-  /**
-   * The list of vector store files
-   */
-  data: Array<VectorStoreFile>;
-}
+    /**
+     * mime type of the chunk
+     */
+    mime_type?: string;
+
+    /**
+     * metadata of the chunk
+     */
+    generated_metadata?: { [key: string]: unknown } | null;
+
+    /**
+     * model used for this chunk
+     */
+    model?: string | null;
+
+    /**
+     * Input type identifier
+     */
+    type?: 'text';
+
+    /**
+     * The offset of the text in the file relative to the start of the file.
+     */
+    offset?: number;
+
+    /**
+     * Text content to process
+     */
+    text: string;
+  }
+
+  export interface ImageURLInputChunkBase {
+    /**
+     * position of the chunk in a file
+     */
+    chunk_index: number;
+
+    /**
+     * mime type of the chunk
+     */
+    mime_type?: string;
 
-export namespace FileListResponse {
-  /**
-   * Response model for cursor-based pagination.
-   *
-   * Examples: Forward pagination response: { "has_more": true, "first_cursor":
-   * "eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMSIsImlkIjoiYWJjMTIzIn0=", "last_cursor":
-   * "eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMCIsImlkIjoieHl6Nzg5In0=", "total": null }
-   *
-   *     Final page response:
-   *         {
-   *             "has_more": false,
-   *             "first_cursor": "eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0yOSIsImlkIjoibGFzdDEyMyJ9",
-   *             "last_cursor": "eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0yOCIsImlkIjoiZmluYWw0NTYifQ==",
-   *             "total": 42
-   *         }
-   *
-   *     Empty results:
-   *         {
-   *             "has_more": false,
-   *             "first_cursor": null,
-   *             "last_cursor": null,
-   *             "total": 0
-   *         }
-   */
-  export interface Pagination {
     /**
-     * Contextual direction-aware flag: True if more items exist in the requested
-     * pagination direction. For 'after': more items after this page. For 'before':
-     * more items before this page.
+     * metadata of the chunk
      */
-    has_more: boolean;
+    generated_metadata?: { [key: string]: unknown } | null;
 
     /**
-     * Cursor of the first item in this page. Use for backward pagination. None if page
-     * is empty.
+     * model used for this chunk
      */
-    first_cursor: string | null;
+    model?: string | null;
 
     /**
-     * Cursor of the last item in this page. Use for forward pagination. None if page
-     * is empty.
+     * Input type identifier
      */
-    last_cursor: string | null;
+    type?: 'image_url';
 
     /**
-     * Total number of items available across all pages. Only included when
-     * include_total=true was requested. Expensive operation - use sparingly.
+     * ocr text of the image
      */
-    total?: number | null;
+    ocr_text?: string | null;
+
+    /**
+     * summary of the image
+     */
+    summary?: string | null;
+  }
+
+  export interface AudioURLInputChunkBase {
+    /**
+     * position of the chunk in a file
+     */
+    chunk_index: number;
+
+    /**
+     * mime type of the chunk
+     */
+    mime_type?: string;
+
+    /**
+     * metadata of the chunk
+     */
+    generated_metadata?: { [key: string]: unknown } | null;
+
+    /**
+     * model used for this chunk
+     */
+    model?: string | null;
+
+    /**
+     * Input type identifier
+     */
+    type?: 'audio_url';
+
+    /**
+     * speech recognition (sr) text of the audio
+     */
+    transcription?: string | null;
+
+    /**
+     * summary of the audio
+     */
+    summary?: string | null;
+  }
+
+  export interface VideoURLInputChunkBase {
+    /**
+     * position of the chunk in a file
+     */
+    chunk_index: number;
+
+    /**
+     * mime type of the chunk
+     */
+    mime_type?: string;
+
+    /**
+     * metadata of the chunk
+     */
+    generated_metadata?: { [key: string]: unknown } | null;
+
+    /**
+     * model used for this chunk
+     */
+    model?: string | null;
+
+    /**
+     * Input type identifier
+     */
+    type?: 'video_url';
+
+    /**
+     * speech recognition (sr) text of the video
+     */
+    transcription?: string | null;
+
+    /**
+     * summary of the video
+     */
+    summary?: string | null;
   }
 }
 
@@ -502,34 +583,17 @@ export namespace FileCreateParams {
 
 export interface FileRetrieveParams {
   /**
-   * The ID or name of the vector store
+   * Path param: The ID or name of the vector store
    */
   vector_store_identifier: string;
-}
-
-export interface FileListParams {
-  /**
-   * Maximum number of items to return per page (1-100)
-   */
-  limit?: number;
 
   /**
-   * Cursor for forward pagination - get items after this position. Use last_cursor
-   * from previous response.
+   * Query param: Whether to return the chunks for the file
    */
-  after?: string | null;
-
-  /**
-   * Cursor for backward pagination - get items before this position. Use
-   * first_cursor from previous response.
-   */
-  before?: string | null;
-
-  /**
-   * Whether to include total count in response (expensive operation)
-   */
-  include_total?: boolean;
+  return_chunks?: boolean;
+}
 
+export interface FileListParams extends CursorParams {
   /**
    * Status to filter by
    */
@@ -627,9 +691,9 @@ export declare namespace Files {
     type ScoredVectorStoreFile as ScoredVectorStoreFile,
     type VectorStoreFileStatus as VectorStoreFileStatus,
     type VectorStoreFile as VectorStoreFile,
-    type FileListResponse as FileListResponse,
     type FileDeleteResponse as FileDeleteResponse,
     type FileSearchResponse as FileSearchResponse,
+    type VectorStoreFilesCursor as VectorStoreFilesCursor,
     type FileCreateParams as FileCreateParams,
     type FileRetrieveParams as FileRetrieveParams,
     type FileListParams as FileListParams,

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

@@ -6,7 +6,6 @@ export {
   type ScoredVectorStoreFile,
   type VectorStoreFileStatus,
   type VectorStoreFile,
-  type FileListResponse,
   type FileDeleteResponse,
   type FileSearchResponse,
   type FileCreateParams,
@@ -14,6 +13,7 @@ export {
   type FileListParams,
   type FileDeleteParams,
   type FileSearchParams,
+  type VectorStoreFilesCursor,
 } from './files';
 export {
   VectorStores,
@@ -24,7 +24,6 @@ export {
   type ScoredVideoURLInputChunk,
   type VectorStore,
   type VectorStoreChunkSearchOptions,
-  type VectorStoreListResponse,
   type VectorStoreDeleteResponse,
   type VectorStoreQuestionAnsweringResponse,
   type VectorStoreSearchResponse,
@@ -33,4 +32,5 @@ export {
   type VectorStoreListParams,
   type VectorStoreQuestionAnsweringParams,
   type VectorStoreSearchParams,
+  type VectorStoresCursor,
 } from './vector-stores';

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

@@ -8,7 +8,6 @@ import {
   FileDeleteParams,
   FileDeleteResponse,
   FileListParams,
-  FileListResponse,
   FileRetrieveParams,
   FileSearchParams,
   FileSearchResponse,
@@ -17,8 +16,10 @@ import {
   ScoredVectorStoreFile,
   VectorStoreFile,
   VectorStoreFileStatus,
+  VectorStoreFilesCursor,
 } from './files';
 import { APIPromise } from '../../core/api-promise';
+import { Cursor, type CursorParams, PagePromise } from '../../core/pagination';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
 
@@ -76,8 +77,8 @@ export class VectorStores extends APIResource {
   list(
     query: VectorStoreListParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<VectorStoreListResponse> {
-    return this._client.get('/v1/vector_stores', { query, ...options });
+  ): PagePromise<VectorStoresCursor, VectorStore> {
+    return this._client.getAPIList('/v1/vector_stores', Cursor<VectorStore>, { query, ...options });
   }
 
   /**
@@ -125,6 +126,8 @@ export class VectorStores extends APIResource {
   }
 }
 
+export type VectorStoresCursor = Cursor<VectorStore>;
+
 /**
  * Represents an expiration policy for a vector store.
  */
@@ -191,11 +194,6 @@ export interface ScoredAudioURLInputChunk {
    */
   type?: 'audio_url';
 
-  /**
-   * The audio input specification.
-   */
-  audio_url: ScoredAudioURLInputChunk.AudioURL;
-
   /**
    * speech recognition (sr) text of the audio
    */
@@ -205,6 +203,11 @@ export interface ScoredAudioURLInputChunk {
    * summary of the audio
    */
   summary?: string | null;
+
+  /**
+   * The audio input specification.
+   */
+  audio_url: ScoredAudioURLInputChunk.AudioURL;
 }
 
 export namespace ScoredAudioURLInputChunk {
@@ -270,11 +273,6 @@ export interface ScoredImageURLInputChunk {
    */
   type?: 'image_url';
 
-  /**
-   * The image input specification.
-   */
-  image_url: ScoredImageURLInputChunk.ImageURL;
-
   /**
    * ocr text of the image
    */
@@ -284,6 +282,11 @@ export interface ScoredImageURLInputChunk {
    * summary of the image
    */
   summary?: string | null;
+
+  /**
+   * The image input specification.
+   */
+  image_url: ScoredImageURLInputChunk.ImageURL;
 }
 
 export namespace ScoredImageURLInputChunk {
@@ -354,6 +357,11 @@ export interface ScoredTextInputChunk {
    */
   type?: 'text';
 
+  /**
+   * The offset of the text in the file relative to the start of the file.
+   */
+  offset?: number;
+
   /**
    * Text content to process
    */
@@ -411,11 +419,6 @@ export interface ScoredVideoURLInputChunk {
    */
   type?: 'video_url';
 
-  /**
-   * The video input specification.
-   */
-  video_url: ScoredVideoURLInputChunk.VideoURL;
-
   /**
    * speech recognition (sr) text of the video
    */
@@ -425,6 +428,11 @@ export interface ScoredVideoURLInputChunk {
    * summary of the video
    */
   summary?: string | null;
+
+  /**
+   * The video input specification.
+   */
+  video_url: ScoredVideoURLInputChunk.VideoURL;
 }
 
 export namespace ScoredVideoURLInputChunk {
@@ -576,95 +584,6 @@ export interface VectorStoreChunkSearchOptions {
   return_metadata?: boolean;
 }
 
-export interface VectorStoreListResponse {
-  /**
-   * Response model for cursor-based pagination.
-   *
-   * Examples: Forward pagination response: { "has_more": true, "first_cursor":
-   * "eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMSIsImlkIjoiYWJjMTIzIn0=", "last_cursor":
-   * "eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMCIsImlkIjoieHl6Nzg5In0=", "total": null }
-   *
-   *     Final page response:
-   *         {
-   *             "has_more": false,
-   *             "first_cursor": "eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0yOSIsImlkIjoibGFzdDEyMyJ9",
-   *             "last_cursor": "eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0yOCIsImlkIjoiZmluYWw0NTYifQ==",
-   *             "total": 42
-   *         }
-   *
-   *     Empty results:
-   *         {
-   *             "has_more": false,
-   *             "first_cursor": null,
-   *             "last_cursor": null,
-   *             "total": 0
-   *         }
-   */
-  pagination: VectorStoreListResponse.Pagination;
-
-  /**
-   * The object type of the response
-   */
-  object?: 'list';
-
-  /**
-   * The list of vector stores
-   */
-  data: Array<VectorStore>;
-}
-
-export namespace VectorStoreListResponse {
-  /**
-   * Response model for cursor-based pagination.
-   *
-   * Examples: Forward pagination response: { "has_more": true, "first_cursor":
-   * "eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMSIsImlkIjoiYWJjMTIzIn0=", "last_cursor":
-   * "eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0zMCIsImlkIjoieHl6Nzg5In0=", "total": null }
-   *
-   *     Final page response:
-   *         {
-   *             "has_more": false,
-   *             "first_cursor": "eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0yOSIsImlkIjoibGFzdDEyMyJ9",
-   *             "last_cursor": "eyJjcmVhdGVkX2F0IjoiMjAyNC0xMi0yOCIsImlkIjoiZmluYWw0NTYifQ==",
-   *             "total": 42
-   *         }
-   *
-   *     Empty results:
-   *         {
-   *             "has_more": false,
-   *             "first_cursor": null,
-   *             "last_cursor": null,
-   *             "total": 0
-   *         }
-   */
-  export interface Pagination {
-    /**
-     * Contextual direction-aware flag: True if more items exist in the requested
-     * pagination direction. For 'after': more items after this page. For 'before':
-     * more items before this page.
-     */
-    has_more: boolean;
-
-    /**
-     * Cursor of the first item in this page. Use for backward pagination. None if page
-     * is empty.
-     */
-    first_cursor: string | null;
-
-    /**
-     * Cursor of the last item in this page. Use for forward pagination. None if page
-     * is empty.
-     */
-    last_cursor: string | null;
-
-    /**
-     * Total number of items available across all pages. Only included when
-     * include_total=true was requested. Expensive operation - use sparingly.
-     */
-    total?: number | null;
-  }
-}
-
 /**
  * Response model for vector store deletion.
  */
@@ -775,29 +694,7 @@ export interface VectorStoreUpdateParams {
   metadata?: unknown;
 }
 
-export interface VectorStoreListParams {
-  /**
-   * Maximum number of items to return per page (1-100)
-   */
-  limit?: number;
-
-  /**
-   * Cursor for forward pagination - get items after this position. Use last_cursor
-   * from previous response.
-   */
-  after?: string | null;
-
-  /**
-   * Cursor for backward pagination - get items before this position. Use
-   * first_cursor from previous response.
-   */
-  before?: string | null;
-
-  /**
-   * Whether to include total count in response (expensive operation)
-   */
-  include_total?: boolean;
-
+export interface VectorStoreListParams extends CursorParams {
   /**
    * Search query for fuzzy matching over name and description fields
    */
@@ -925,10 +822,10 @@ export declare namespace VectorStores {
     type ScoredVideoURLInputChunk as ScoredVideoURLInputChunk,
     type VectorStore as VectorStore,
     type VectorStoreChunkSearchOptions as VectorStoreChunkSearchOptions,
-    type VectorStoreListResponse as VectorStoreListResponse,
     type VectorStoreDeleteResponse as VectorStoreDeleteResponse,
     type VectorStoreQuestionAnsweringResponse as VectorStoreQuestionAnsweringResponse,
     type VectorStoreSearchResponse as VectorStoreSearchResponse,
+    type VectorStoresCursor as VectorStoresCursor,
     type VectorStoreCreateParams as VectorStoreCreateParams,
     type VectorStoreUpdateParams as VectorStoreUpdateParams,
     type VectorStoreListParams as VectorStoreListParams,
@@ -942,9 +839,9 @@ export declare namespace VectorStores {
     type ScoredVectorStoreFile as ScoredVectorStoreFile,
     type VectorStoreFileStatus as VectorStoreFileStatus,
     type VectorStoreFile as VectorStoreFile,
-    type FileListResponse as FileListResponse,
     type FileDeleteResponse as FileDeleteResponse,
     type FileSearchResponse as FileSearchResponse,
+    type VectorStoreFilesCursor as VectorStoreFilesCursor,
     type FileCreateParams as FileCreateParams,
     type FileRetrieveParams as FileRetrieveParams,
     type FileListParams as FileListParams,

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.15.0'; // x-release-please-version
+export const VERSION = '0.17.0'; // x-release-please-version

package/version.d.mts

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

package/version.d.ts

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

package/version.mjs

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