@mixedbread/sdk 0.16.0 → 0.18.0

package/src/internal/request-options.ts

@@ -9,17 +9,70 @@ import { type HeadersLike } from './headers';
 export type FinalRequestOptions = RequestOptions & { method: HTTPMethod; path: string };
 
 export type RequestOptions = {
+  /**
+   * The HTTP method for the request (e.g., 'get', 'post', 'put', 'delete').
+   */
   method?: HTTPMethod;
+
+  /**
+   * The URL path for the request.
+   *
+   * @example "/v1/foo"
+   */
   path?: string;
+
+  /**
+   * Query parameters to include in the request URL.
+   */
   query?: object | undefined | null;
+
+  /**
+   * The request body. Can be a string, JSON object, FormData, or other supported types.
+   */
   body?: unknown;
+
+  /**
+   * HTTP headers to include with the request. Can be a Headers object, plain object, or array of tuples.
+   */
   headers?: HeadersLike;
+
+  /**
+   * The maximum number of times that the client will retry a request in case of a
+   * temporary failure, like a network error or a 5XX error from the server.
+   *
+   * @default 2
+   */
   maxRetries?: number;
+
   stream?: boolean | undefined;
+
+  /**
+   * The maximum amount of time (in milliseconds) that the client should wait for a response
+   * from the server before timing out a single request.
+   *
+   * @unit milliseconds
+   */
   timeout?: number;
+
+  /**
+   * Additional `RequestInit` options to be passed to the underlying `fetch` call.
+   * These options will be merged with the client's default fetch options.
+   */
   fetchOptions?: MergedRequestInit;
+
+  /**
+   * An AbortSignal that can be used to cancel the request.
+   */
   signal?: AbortSignal | undefined | null;
+
+  /**
+   * A unique key for this request to enable idempotency.
+   */
   idempotencyKey?: string;
+
+  /**
+   * Override the default base URL for this specific request.
+   */
   defaultBaseURL?: string | undefined;
 
   __binaryResponse?: boolean | undefined;

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

@@ -156,7 +156,7 @@ export interface DataSourceOauth2Params {
   /**
    * The OAuth2 scope
    */
-  scope?: string;
+  scope?: string | null;
 
   /**
    * The OAuth2 access token
@@ -193,7 +193,7 @@ export interface LinearDataSource {
   /**
    * The type of data source to create
    */
-  type?: DataSourceType;
+  type?: 'linear';
 
   /**
    * The name of the data source
@@ -218,7 +218,7 @@ export interface NotionDataSource {
   /**
    * The type of data source to create
    */
-  type?: DataSourceType;
+  type?: 'notion';
 
   /**
    * The name of the data source
@@ -287,7 +287,7 @@ export declare namespace DataSourceCreateParams {
     /**
      * The type of data source to create
      */
-    type?: DataSourceType;
+    type?: 'notion';
 
     /**
      * The name of the data source
@@ -324,7 +324,7 @@ export declare namespace DataSourceCreateParams {
     /**
      * The type of data source to create
      */
-    type?: DataSourceType;
+    type?: 'linear';
 
     /**
      * The name of the data source
@@ -352,7 +352,7 @@ export declare namespace DataSourceUpdateParams {
     /**
      * The type of data source to create
      */
-    type?: DataSourceType;
+    type?: 'notion';
 
     /**
      * The name of the data source
@@ -389,7 +389,7 @@ export declare namespace DataSourceUpdateParams {
     /**
      * The type of data source to create
      */
-    type?: DataSourceType;
+    type?: 'linear';
 
     /**
      * The name of the data source

package/src/resources/embeddings.ts

@@ -39,7 +39,8 @@ export type ObjectType =
   | 'vector_store.file'
   | 'api_key'
   | 'data_source'
-  | 'data_source.connector';
+  | 'data_source.connector'
+  | 'vector_store.histogram';
 
 export interface EmbeddingCreateParams {
   /**

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

@@ -41,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,
+    });
   }
 
   /**
@@ -279,11 +282,6 @@ export interface ScoredVectorStoreFile {
    */
   object?: 'vector_store.file';
 
-  /**
-   * score of the file
-   */
-  score: number;
-
   /**
    * chunks
    */
@@ -293,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';
@@ -350,6 +353,166 @@ export interface VectorStoreFile {
    * Type of the object
    */
   object?: 'vector_store.file';
+
+  /**
+   * chunks
+   */
+  chunks?: Array<
+    | VectorStoreFile.TextInputChunk
+    | VectorStoreFile.ImageURLInputChunkBase
+    | VectorStoreFile.AudioURLInputChunkBase
+    | VectorStoreFile.VideoURLInputChunkBase
+  > | null;
+}
+
+export namespace VectorStoreFile {
+  export interface TextInputChunk {
+    /**
+     * 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?: '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;
+
+    /**
+     * metadata of the chunk
+     */
+    generated_metadata?: { [key: string]: unknown } | null;
+
+    /**
+     * model used for this chunk
+     */
+    model?: string | null;
+
+    /**
+     * Input type identifier
+     */
+    type?: 'image_url';
+
+    /**
+     * ocr text of the image
+     */
+    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;
+  }
 }
 
 /**
@@ -420,9 +583,14 @@ 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;
+
+  /**
+   * Query param: Whether to return the chunks for the file
+   */
+  return_chunks?: boolean;
 }
 
 export interface FileListParams extends CursorParams {

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

@@ -194,11 +194,6 @@ export interface ScoredAudioURLInputChunk {
    */
   type?: 'audio_url';
 
-  /**
-   * The audio input specification.
-   */
-  audio_url: ScoredAudioURLInputChunk.AudioURL;
-
   /**
    * speech recognition (sr) text of the audio
    */
@@ -208,6 +203,11 @@ export interface ScoredAudioURLInputChunk {
    * summary of the audio
    */
   summary?: string | null;
+
+  /**
+   * The audio input specification.
+   */
+  audio_url: ScoredAudioURLInputChunk.AudioURL;
 }
 
 export namespace ScoredAudioURLInputChunk {
@@ -273,11 +273,6 @@ export interface ScoredImageURLInputChunk {
    */
   type?: 'image_url';
 
-  /**
-   * The image input specification.
-   */
-  image_url: ScoredImageURLInputChunk.ImageURL;
-
   /**
    * ocr text of the image
    */
@@ -287,6 +282,11 @@ export interface ScoredImageURLInputChunk {
    * summary of the image
    */
   summary?: string | null;
+
+  /**
+   * The image input specification.
+   */
+  image_url: ScoredImageURLInputChunk.ImageURL;
 }
 
 export namespace ScoredImageURLInputChunk {
@@ -357,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
    */
@@ -414,11 +419,6 @@ export interface ScoredVideoURLInputChunk {
    */
   type?: 'video_url';
 
-  /**
-   * The video input specification.
-   */
-  video_url: ScoredVideoURLInputChunk.VideoURL;
-
   /**
    * speech recognition (sr) text of the video
    */
@@ -428,6 +428,11 @@ export interface ScoredVideoURLInputChunk {
    * summary of the video
    */
   summary?: string | null;
+
+  /**
+   * The video input specification.
+   */
+  video_url: ScoredVideoURLInputChunk.VideoURL;
 }
 
 export namespace ScoredVideoURLInputChunk {

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.16.0'; // x-release-please-version
+export const VERSION = '0.18.0'; // x-release-please-version

package/version.d.mts

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

package/version.d.ts

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

package/version.mjs

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