@mixedbread/sdk 0.3.0 → 0.5.0

package/src/resources/top-level.ts

@@ -41,14 +41,16 @@ export interface EmbeddingCreateResponse {
   object?:
     | 'list'
     | 'parsing_job'
-    | 'job'
+    | 'extraction_job'
     | 'embedding'
     | 'embedding_dict'
     | 'rank_result'
     | 'file'
     | 'vector_store'
     | 'vector_store.file'
-    | 'api_key';
+    | 'api_key'
+    | 'data_source'
+    | 'data_source.connector';
 
   /**
    * Whether the embeddings are normalized.
@@ -143,14 +145,16 @@ export interface RerankResponse {
   object?:
     | 'list'
     | 'parsing_job'
-    | 'job'
+    | 'extraction_job'
     | 'embedding'
     | 'embedding_dict'
     | 'rank_result'
     | 'file'
     | 'vector_store'
     | 'vector_store.file'
-    | 'api_key';
+    | 'api_key'
+    | 'data_source'
+    | 'data_source.connector';
 
   /**
    * The number of documents to return.
@@ -258,6 +262,11 @@ export interface RerankParams {
    * Whether to return the documents.
    */
   return_input?: boolean;
+
+  /**
+   * Wether or not to rewrite the query before passing it to the reranking model
+   */
+  rewrite_query?: boolean;
 }
 
 export declare namespace TopLevel {

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

@@ -1,11 +1,12 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../resource';
-import { isRequestOptions } from '../../core';
-import * as Core from '../../core';
+import { APIResource } from '../../core/resource';
 import * as Shared from '../shared';
 import * as VectorStoresAPI from './vector-stores';
-import { LimitOffset, type LimitOffsetParams } from '../../pagination';
+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';
 
@@ -19,11 +20,11 @@ export class Files extends APIResource {
    * Returns: VectorStoreFile: Details of the uploaded and indexed file
    */
   create(
-    vectorStoreId: string,
+    vectorStoreID: string,
     body: FileCreateParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<VectorStoreFile> {
-    return this._client.post(`/v1/vector_stores/${vectorStoreId}/files`, { body, ...options });
+    options?: RequestOptions,
+  ): APIPromise<VectorStoreFile> {
+    return this._client.post(path`/v1/vector_stores/${vectorStoreID}/files`, { body, ...options });
   }
 
   /**
@@ -34,11 +35,12 @@ export class Files extends APIResource {
    * Returns: VectorStoreFile: Details of the vector store file
    */
   retrieve(
-    vectorStoreId: string,
-    fileId: string,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<VectorStoreFile> {
-    return this._client.get(`/v1/vector_stores/${vectorStoreId}/files/${fileId}`, options);
+    fileID: string,
+    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);
   }
 
   /**
@@ -50,26 +52,15 @@ export class Files extends APIResource {
    * Returns: VectorStoreFileListResponse: Paginated list of vector store files
    */
   list(
-    vectorStoreId: string,
-    query?: FileListParams,
-    options?: Core.RequestOptions,
-  ): Core.PagePromise<VectorStoreFilesLimitOffset, VectorStoreFile>;
-  list(
-    vectorStoreId: string,
-    options?: Core.RequestOptions,
-  ): Core.PagePromise<VectorStoreFilesLimitOffset, VectorStoreFile>;
-  list(
-    vectorStoreId: string,
-    query: FileListParams | Core.RequestOptions = {},
-    options?: Core.RequestOptions,
-  ): Core.PagePromise<VectorStoreFilesLimitOffset, VectorStoreFile> {
-    if (isRequestOptions(query)) {
-      return this.list(vectorStoreId, {}, query);
-    }
-    return this._client.getAPIList(`/v1/vector_stores/${vectorStoreId}/files`, VectorStoreFilesLimitOffset, {
-      query,
-      ...options,
-    });
+    vectorStoreID: string,
+    query: FileListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<VectorStoreFilesLimitOffset, VectorStoreFile> {
+    return this._client.getAPIList(
+      path`/v1/vector_stores/${vectorStoreID}/files`,
+      LimitOffset<VectorStoreFile>,
+      { query, ...options },
+    );
   }
 
   /**
@@ -80,12 +71,9 @@ export class Files extends APIResource {
    *
    * Returns: VectorStoreFileDeleted: The deleted file
    */
-  delete(
-    vectorStoreId: string,
-    fileId: string,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<FileDeleteResponse> {
-    return this._client.delete(`/v1/vector_stores/${vectorStoreId}/files/${fileId}`, options);
+  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);
   }
 
   /**
@@ -106,7 +94,7 @@ export class Files extends APIResource {
    * Raises: HTTPException (400): If search parameters are invalid HTTPException
    * (404): If no vector stores are found to search
    */
-  search(body: FileSearchParams, options?: Core.RequestOptions): Core.APIPromise<FileSearchResponse> {
+  search(body: FileSearchParams, options?: RequestOptions): APIPromise<FileSearchResponse> {
     return this._client.post('/v1/vector_stores/files/search', { body, ...options });
   }
 
@@ -125,13 +113,13 @@ export class Files extends APIResource {
     fileId: string,
     pollIntervalMs?: number,
     pollTimeoutMs?: number,
-    options?: Core.RequestOptions,
+    options?: RequestOptions,
   ): Promise<VectorStoreFile> {
     const pollingIntervalMs = pollIntervalMs || 500;
     const pollingTimeoutMs = pollTimeoutMs;
 
     return polling.poll({
-      fn: () => this.retrieve(vectorStoreId, fileId, options),
+      fn: () => this.retrieve(fileId, { vector_store_id: vectorStoreId, ...options }),
       condition: (result) =>
         result.status === 'completed' || result.status === 'failed' || result.status === 'error',
       intervalSeconds: pollingIntervalMs / 1000,
@@ -154,7 +142,7 @@ export class Files extends APIResource {
     body: FileCreateParams,
     pollIntervalMs?: number,
     pollTimeoutMs?: number,
-    options?: Core.RequestOptions,
+    options?: RequestOptions,
   ): Promise<VectorStoreFile> {
     const file = await this.create(vectorStoreId, body, options);
     return this.poll(vectorStoreId, file.id, pollIntervalMs, pollTimeoutMs, options);
@@ -174,7 +162,7 @@ export class Files extends APIResource {
     vectorStoreId: string,
     file: Uploadable,
     body?: Omit<FileCreateParams, 'file_id'>,
-    options?: Core.RequestOptions,
+    options?: RequestOptions,
   ): Promise<VectorStoreFile> {
     const fileUploadResponse = await this._client.files.create({ file }, options);
 
@@ -205,14 +193,14 @@ export class Files extends APIResource {
     body?: Omit<FileCreateParams, 'file_id'>,
     pollIntervalMs?: number,
     pollTimeoutMs?: number,
-    options?: Core.RequestOptions,
+    options?: RequestOptions,
   ): Promise<VectorStoreFile> {
     const vectorStoreFile = await this.upload(vectorStoreId, file, body, options);
     return this.poll(vectorStoreId, vectorStoreFile.id, pollIntervalMs, pollTimeoutMs, options);
   }
 }
 
-export class VectorStoreFilesLimitOffset extends LimitOffset<VectorStoreFile> {}
+export type VectorStoreFilesLimitOffset = LimitOffset<VectorStoreFile>;
 
 /**
  * Represents a scored file stored in a vector store.
@@ -400,8 +388,22 @@ export namespace FileCreateParams {
   }
 }
 
+export interface FileRetrieveParams {
+  /**
+   * The ID of the vector store
+   */
+  vector_store_id: string;
+}
+
 export interface FileListParams extends LimitOffsetParams {}
 
+export interface FileDeleteParams {
+  /**
+   * The ID of the vector store
+   */
+  vector_store_id: string;
+}
+
 export interface FileSearchParams {
   /**
    * Search query text
@@ -433,17 +435,17 @@ export interface FileSearchParams {
   search_options?: VectorStoresAPI.VectorStoreFileSearchOptions;
 }
 
-Files.VectorStoreFilesLimitOffset = VectorStoreFilesLimitOffset;
-
 export declare namespace Files {
   export {
     type ScoredVectorStoreFile as ScoredVectorStoreFile,
     type VectorStoreFile as VectorStoreFile,
     type FileDeleteResponse as FileDeleteResponse,
     type FileSearchResponse as FileSearchResponse,
-    VectorStoreFilesLimitOffset as VectorStoreFilesLimitOffset,
+    type VectorStoreFilesLimitOffset as VectorStoreFilesLimitOffset,
     type FileCreateParams as FileCreateParams,
+    type FileRetrieveParams as FileRetrieveParams,
     type FileListParams as FileListParams,
+    type FileDeleteParams as FileDeleteParams,
     type FileSearchParams as FileSearchParams,
   };
 }

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

@@ -1,18 +1,19 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 export {
-  VectorStoreFilesLimitOffset,
   Files,
   type ScoredVectorStoreFile,
   type VectorStoreFile,
   type FileDeleteResponse,
   type FileSearchResponse,
   type FileCreateParams,
+  type FileRetrieveParams,
   type FileListParams,
+  type FileDeleteParams,
   type FileSearchParams,
+  type VectorStoreFilesLimitOffset,
 } from './files';
 export {
-  VectorStoresLimitOffset,
   VectorStores,
   type ExpiresAfter,
   type FileCounts,
@@ -28,4 +29,5 @@ export {
   type VectorStoreListParams,
   type VectorStoreQuestionAnsweringParams,
   type VectorStoreSearchParams,
+  type VectorStoresLimitOffset,
 } from './vector-stores';

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

@@ -1,14 +1,14 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../resource';
-import { isRequestOptions } from '../../core';
-import * as Core from '../../core';
+import { APIResource } from '../../core/resource';
 import * as Shared from '../shared';
 import * as FilesAPI from './files';
 import {
   FileCreateParams,
+  FileDeleteParams,
   FileDeleteResponse,
   FileListParams,
+  FileRetrieveParams,
   FileSearchParams,
   FileSearchResponse,
   Files,
@@ -16,7 +16,10 @@ import {
   VectorStoreFile,
   VectorStoreFilesLimitOffset,
 } from './files';
-import { LimitOffset, type LimitOffsetParams } from '../../pagination';
+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';
 
 export class VectorStores extends APIResource {
   files: FilesAPI.Files = new FilesAPI.Files(this._client);
@@ -29,7 +32,7 @@ export class VectorStores extends APIResource {
    *
    * Returns: VectorStore: The response containing the created vector store details.
    */
-  create(body: VectorStoreCreateParams, options?: Core.RequestOptions): Core.APIPromise<VectorStore> {
+  create(body: VectorStoreCreateParams, options?: RequestOptions): APIPromise<VectorStore> {
     return this._client.post('/v1/vector_stores', { body, ...options });
   }
 
@@ -40,8 +43,8 @@ export class VectorStores extends APIResource {
    *
    * Returns: VectorStore: The response containing the vector store details.
    */
-  retrieve(vectorStoreId: string, options?: Core.RequestOptions): Core.APIPromise<VectorStore> {
-    return this._client.get(`/v1/vector_stores/${vectorStoreId}`, options);
+  retrieve(vectorStoreID: string, options?: RequestOptions): APIPromise<VectorStore> {
+    return this._client.get(path`/v1/vector_stores/${vectorStoreID}`, options);
   }
 
   /**
@@ -54,11 +57,11 @@ export class VectorStores extends APIResource {
    * Returns: VectorStore: The response containing the updated vector store details.
    */
   update(
-    vectorStoreId: string,
+    vectorStoreID: string,
     body: VectorStoreUpdateParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<VectorStore> {
-    return this._client.put(`/v1/vector_stores/${vectorStoreId}`, { body, ...options });
+    options?: RequestOptions,
+  ): APIPromise<VectorStore> {
+    return this._client.put(path`/v1/vector_stores/${vectorStoreID}`, { body, ...options });
   }
 
   /**
@@ -69,18 +72,10 @@ export class VectorStores extends APIResource {
    * Returns: VectorStoreListResponse: The list of vector stores.
    */
   list(
-    query?: VectorStoreListParams,
-    options?: Core.RequestOptions,
-  ): Core.PagePromise<VectorStoresLimitOffset, VectorStore>;
-  list(options?: Core.RequestOptions): Core.PagePromise<VectorStoresLimitOffset, VectorStore>;
-  list(
-    query: VectorStoreListParams | Core.RequestOptions = {},
-    options?: Core.RequestOptions,
-  ): Core.PagePromise<VectorStoresLimitOffset, VectorStore> {
-    if (isRequestOptions(query)) {
-      return this.list({}, query);
-    }
-    return this._client.getAPIList('/v1/vector_stores', VectorStoresLimitOffset, { query, ...options });
+    query: VectorStoreListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): PagePromise<VectorStoresLimitOffset, VectorStore> {
+    return this._client.getAPIList('/v1/vector_stores', LimitOffset<VectorStore>, { query, ...options });
   }
 
   /**
@@ -90,8 +85,8 @@ export class VectorStores extends APIResource {
    *
    * Returns: VectorStore: The response containing the deleted vector store details.
    */
-  delete(vectorStoreId: string, options?: Core.RequestOptions): Core.APIPromise<VectorStoreDeleteResponse> {
-    return this._client.delete(`/v1/vector_stores/${vectorStoreId}`, options);
+  delete(vectorStoreID: string, options?: RequestOptions): APIPromise<VectorStoreDeleteResponse> {
+    return this._client.delete(path`/v1/vector_stores/${vectorStoreID}`, options);
   }
 
   /**
@@ -99,8 +94,8 @@ export class VectorStores extends APIResource {
    */
   questionAnswering(
     body: VectorStoreQuestionAnsweringParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<unknown> {
+    options?: RequestOptions,
+  ): APIPromise<VectorStoreQuestionAnsweringResponse> {
     return this._client.post('/v1/vector_stores/question-answering', { body, ...options });
   }
 
@@ -121,15 +116,12 @@ export class VectorStores extends APIResource {
    * Raises: HTTPException (400): If search parameters are invalid HTTPException
    * (404): If no vector stores are found to search
    */
-  search(
-    body: VectorStoreSearchParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<VectorStoreSearchResponse> {
+  search(body: VectorStoreSearchParams, options?: RequestOptions): APIPromise<VectorStoreSearchResponse> {
     return this._client.post('/v1/vector_stores/search', { body, ...options });
   }
 }
 
-export class VectorStoresLimitOffset extends LimitOffset<VectorStore> {}
+export type VectorStoresLimitOffset = LimitOffset<VectorStore>;
 
 /**
  * Represents an expiration policy for a vector store.
@@ -236,14 +228,14 @@ export namespace ScoredVectorStoreChunk {
     /**
      * The image input specification.
      */
-    image: ImageURLInput.Image;
+    image_url: ImageURLInput.ImageURL;
   }
 
   export namespace ImageURLInput {
     /**
      * The image input specification.
      */
-    export interface Image {
+    export interface ImageURL {
       /**
        * The image URL. Can be either a URL or a Data URI.
        */
@@ -410,7 +402,20 @@ export interface VectorStoreDeleteResponse {
   object?: 'vector_store';
 }
 
-export type VectorStoreQuestionAnsweringResponse = unknown;
+/**
+ * Results from a question answering operation.
+ */
+export interface VectorStoreQuestionAnsweringResponse {
+  /**
+   * The answer generated by the LLM
+   */
+  answer: string;
+
+  /**
+   * Source documents used to generate the answer
+   */
+  sources?: Array<ScoredVectorStoreChunk>;
+}
 
 export interface VectorStoreSearchResponse {
   /**
@@ -504,7 +509,7 @@ export interface VectorStoreQuestionAnsweringParams {
   /**
    * Search configuration options
    */
-  search_options?: VectorStoreFileSearchOptions;
+  search_options?: VectorStoreChunkSearchOptions;
 
   /**
    * Whether to stream the answer
@@ -560,9 +565,7 @@ export interface VectorStoreSearchParams {
   search_options?: VectorStoreChunkSearchOptions;
 }
 
-VectorStores.VectorStoresLimitOffset = VectorStoresLimitOffset;
 VectorStores.Files = Files;
-VectorStores.VectorStoreFilesLimitOffset = VectorStoreFilesLimitOffset;
 
 export declare namespace VectorStores {
   export {
@@ -575,7 +578,7 @@ export declare namespace VectorStores {
     type VectorStoreDeleteResponse as VectorStoreDeleteResponse,
     type VectorStoreQuestionAnsweringResponse as VectorStoreQuestionAnsweringResponse,
     type VectorStoreSearchResponse as VectorStoreSearchResponse,
-    VectorStoresLimitOffset as VectorStoresLimitOffset,
+    type VectorStoresLimitOffset as VectorStoresLimitOffset,
     type VectorStoreCreateParams as VectorStoreCreateParams,
     type VectorStoreUpdateParams as VectorStoreUpdateParams,
     type VectorStoreListParams as VectorStoreListParams,
@@ -589,9 +592,11 @@ export declare namespace VectorStores {
     type VectorStoreFile as VectorStoreFile,
     type FileDeleteResponse as FileDeleteResponse,
     type FileSearchResponse as FileSearchResponse,
-    VectorStoreFilesLimitOffset as VectorStoreFilesLimitOffset,
+    type VectorStoreFilesLimitOffset as VectorStoreFilesLimitOffset,
     type FileCreateParams as FileCreateParams,
+    type FileRetrieveParams as FileRetrieveParams,
     type FileListParams as FileListParams,
+    type FileDeleteParams as FileDeleteParams,
     type FileSearchParams as FileSearchParams,
   };
 }

package/src/tsconfig.json

@@ -4,8 +4,8 @@
   // via declaration maps
   "include": ["index.ts"],
   "compilerOptions": {
-    "target": "es2015",
-    "lib": ["DOM"],
+    "target": "ES2015",
+    "lib": ["DOM", "DOM.Iterable", "ES2018"],
     "moduleResolution": "node"
   }
 }