@mixedbread/sdk 0.1.0-alpha.8 → 0.1.0

package/src/resources/shared.ts

@@ -39,3 +39,20 @@ export interface SearchFilterCondition {
    */
   operator: 'eq' | 'not_eq' | 'gt' | 'gte' | 'lt' | 'lte' | 'in' | 'not_in' | 'like' | 'not_like';
 }
+
+export interface Usage {
+  /**
+   * The number of tokens used for the prompt
+   */
+  prompt_tokens: number;
+
+  /**
+   * The total number of tokens used
+   */
+  total_tokens: number;
+
+  /**
+   * The number of tokens used for the completion
+   */
+  completion_tokens?: number | null;
+}

package/src/resources/top-level.ts

@@ -1,5 +1,117 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
+import * as Shared from './shared';
+
+export interface Embedding {
+  /**
+   * The encoded embedding.
+   */
+  embedding: Array<number> | Array<number> | string;
+
+  /**
+   * The index of the embedding.
+   */
+  index: number;
+
+  /**
+   * The object type of the embedding.
+   */
+  object?: 'embedding';
+}
+
+export interface EmbeddingCreateResponse {
+  /**
+   * The usage of the model
+   */
+  usage: Shared.Usage;
+
+  /**
+   * The model used
+   */
+  model: string;
+
+  /**
+   * The created embeddings.
+   */
+  data: Array<Embedding> | Array<MultiEncodingEmbedding>;
+
+  /**
+   * The object type of the response
+   */
+  object?:
+    | 'list'
+    | 'parsing_job'
+    | 'job'
+    | 'embedding'
+    | 'embedding_dict'
+    | 'rank_result'
+    | 'file'
+    | 'vector_store'
+    | 'vector_store.file'
+    | 'api_key';
+
+  /**
+   * Whether the embeddings are normalized.
+   */
+  normalized: boolean;
+
+  /**
+   * The encoding formats of the embeddings.
+   */
+  encoding_format:
+    | 'float'
+    | 'float16'
+    | 'base64'
+    | 'binary'
+    | 'ubinary'
+    | 'int8'
+    | 'uint8'
+    | Array<'float' | 'float16' | 'base64' | 'binary' | 'ubinary' | 'int8' | 'uint8'>;
+
+  /**
+   * The number of dimensions used for the embeddings.
+   */
+  dimensions: number | null;
+}
+
+export interface MultiEncodingEmbedding {
+  /**
+   * The encoded embedding data by encoding format.Returned, if more than one
+   * encoding format is used.
+   */
+  embedding: MultiEncodingEmbedding.Embedding;
+
+  /**
+   * The index of the embedding.
+   */
+  index: number;
+
+  /**
+   * The object type of the embedding.
+   */
+  object?: 'embedding_dict';
+}
+
+export namespace MultiEncodingEmbedding {
+  /**
+   * The encoded embedding data by encoding format.Returned, if more than one
+   * encoding format is used.
+   */
+  export interface Embedding {
+    float?: Array<number>;
+
+    int8?: Array<number>;
+
+    uint8?: Array<number>;
+
+    binary?: Array<number>;
+
+    ubinary?: Array<number>;
+
+    base64?: string;
+  }
+}
+
 /**
  * Info Pydantic Response Service Message
  */
@@ -9,6 +121,153 @@ export interface InfoResponse {
   version: string;
 }
 
+export interface RerankResponse {
+  /**
+   * The usage of the model
+   */
+  usage: Shared.Usage;
+
+  /**
+   * The model used
+   */
+  model: string;
+
+  /**
+   * The ranked documents.
+   */
+  data: Array<RerankResponse.Data>;
+
+  /**
+   * The object type of the response
+   */
+  object?:
+    | 'list'
+    | 'parsing_job'
+    | 'job'
+    | 'embedding'
+    | 'embedding_dict'
+    | 'rank_result'
+    | 'file'
+    | 'vector_store'
+    | 'vector_store.file'
+    | 'api_key';
+
+  /**
+   * The number of documents to return.
+   */
+  top_k: number;
+
+  /**
+   * Whether to return the documents.
+   */
+  return_input: boolean;
+}
+
+export namespace RerankResponse {
+  export interface Data {
+    /**
+     * The index of the document.
+     */
+    index: number;
+
+    /**
+     * The score of the document.
+     */
+    score: number;
+
+    /**
+     * The input document.
+     */
+    input?: unknown;
+
+    /**
+     * The object type.
+     */
+    object?: 'rank_result';
+  }
+}
+
+export interface EmbedParams {
+  /**
+   * The model to use for creating embeddings.
+   */
+  model: string;
+
+  /**
+   * The input to create embeddings for.
+   */
+  input: Array<string>;
+
+  /**
+   * The number of dimensions to use for the embeddings.
+   */
+  dimensions?: number | null;
+
+  /**
+   * The prompt to use for the embedding creation.
+   */
+  prompt?: string | null;
+
+  /**
+   * Whether to normalize the embeddings.
+   */
+  normalized?: boolean;
+
+  /**
+   * The encoding format(s) of the embeddings. Can be a single format or a list of
+   * formats.
+   */
+  encoding_format?:
+    | 'float'
+    | 'float16'
+    | 'base64'
+    | 'binary'
+    | 'ubinary'
+    | 'int8'
+    | 'uint8'
+    | Array<'float' | 'float16' | 'base64' | 'binary' | 'ubinary' | 'int8' | 'uint8'>;
+}
+
+export interface RerankParams {
+  /**
+   * The model to use for reranking documents.
+   */
+  model?: string;
+
+  /**
+   * The query to rerank the documents.
+   */
+  query: string;
+
+  /**
+   * The input documents to rerank.
+   */
+  input: Array<string | unknown | Array<unknown>>;
+
+  /**
+   * The fields of the documents to rank.
+   */
+  rank_fields?: Array<string> | null;
+
+  /**
+   * The number of documents to return.
+   */
+  top_k?: number;
+
+  /**
+   * Whether to return the documents.
+   */
+  return_input?: boolean;
+}
+
 export declare namespace TopLevel {
-  export { type InfoResponse as InfoResponse };
+  export {
+    type Embedding as Embedding,
+    type EmbeddingCreateResponse as EmbeddingCreateResponse,
+    type MultiEncodingEmbedding as MultiEncodingEmbedding,
+    type InfoResponse as InfoResponse,
+    type RerankResponse as RerankResponse,
+    type EmbedParams as EmbedParams,
+    type RerankParams as RerankParams,
+  };
 }

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

@@ -223,6 +223,11 @@ export interface ScoredVectorStoreFile {
    */
   id: string;
 
+  /**
+   * Name of the file
+   */
+  filename?: string;
+
   /**
    * Optional file metadata
    */
@@ -271,7 +276,7 @@ export interface ScoredVectorStoreFile {
   /**
    * chunks
    */
-  chunks: Array<VectorStoresAPI.ScoredVectorStoreChunk>;
+  chunks: Array<VectorStoresAPI.ScoredVectorStoreChunk> | null;
 }
 
 /**
@@ -283,6 +288,11 @@ export interface VectorStoreFile {
    */
   id: string;
 
+  /**
+   * Name of the file
+   */
+  filename?: string;
+
   /**
    * Optional file metadata
    */
@@ -382,6 +392,11 @@ export namespace FileCreateParams {
      * Strategy for adding the file
      */
     parsing_strategy?: 'fast' | 'high_quality';
+
+    /**
+     * Whether to contextualize the file
+     */
+    contextualization?: boolean;
   }
 }
 
@@ -415,7 +430,7 @@ export interface FileSearchParams {
   /**
    * Search configuration options
    */
-  search_options?: VectorStoresAPI.VectorStoreSearchOptions;
+  search_options?: VectorStoresAPI.VectorStoreFileSearchOptions;
 }
 
 Files.VectorStoreFilesLimitOffset = VectorStoreFilesLimitOffset;

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

@@ -18,7 +18,8 @@ export {
   type FileCounts,
   type ScoredVectorStoreChunk,
   type VectorStore,
-  type VectorStoreSearchOptions,
+  type VectorStoreChunkSearchOptions,
+  type VectorStoreFileSearchOptions,
   type VectorStoreDeleteResponse,
   type VectorStoreQuestionAnsweringResponse,
   type VectorStoreSearchResponse,

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

@@ -207,6 +207,11 @@ export interface ScoredVectorStoreChunk {
    */
   file_id: string;
 
+  /**
+   * filename
+   */
+  filename: string;
+
   /**
    * vector store id
    */
@@ -319,6 +324,11 @@ export interface VectorStore {
    */
   last_active_at?: string | null;
 
+  /**
+   * Total storage usage in bytes
+   */
+  usage_bytes?: number;
+
   /**
    * Optional expiration timestamp for the vector store
    */
@@ -331,19 +341,29 @@ export interface VectorStore {
 }
 
 /**
- * Options for configuring vector store searches.
+ * Options for configuring vector store chunk searches.
  */
-export interface VectorStoreSearchOptions {
+export interface VectorStoreChunkSearchOptions {
   /**
-   * Whether to return file metadata
+   * Minimum similarity score threshold
    */
-  return_metadata?: boolean;
+  score_threshold?: number;
 
   /**
-   * Whether to return matching text chunks
+   * Whether to rewrite the query
    */
-  return_chunks?: boolean;
+  rewrite_query?: boolean;
 
+  /**
+   * Whether to return file metadata
+   */
+  return_metadata?: boolean;
+}
+
+/**
+ * Options for configuring vector store file searches.
+ */
+export interface VectorStoreFileSearchOptions {
   /**
    * Minimum similarity score threshold
    */
@@ -353,6 +373,21 @@ export interface VectorStoreSearchOptions {
    * Whether to rewrite the query
    */
   rewrite_query?: boolean;
+
+  /**
+   * Whether to return file metadata
+   */
+  return_metadata?: boolean;
+
+  /**
+   * Whether to return matching text chunks
+   */
+  return_chunks?: boolean;
+
+  /**
+   * Number of chunks to return for each file
+   */
+  chunks_per_file?: number;
 }
 
 /**
@@ -469,7 +504,7 @@ export interface VectorStoreQuestionAnsweringParams {
   /**
    * Search configuration options
    */
-  search_options?: VectorStoreSearchOptions;
+  search_options?: VectorStoreFileSearchOptions;
 
   /**
    * Whether to stream the answer
@@ -522,7 +557,7 @@ export interface VectorStoreSearchParams {
   /**
    * Search configuration options
    */
-  search_options?: VectorStoreSearchOptions;
+  search_options?: VectorStoreChunkSearchOptions;
 }
 
 VectorStores.VectorStoresLimitOffset = VectorStoresLimitOffset;
@@ -535,7 +570,8 @@ export declare namespace VectorStores {
     type FileCounts as FileCounts,
     type ScoredVectorStoreChunk as ScoredVectorStoreChunk,
     type VectorStore as VectorStore,
-    type VectorStoreSearchOptions as VectorStoreSearchOptions,
+    type VectorStoreChunkSearchOptions as VectorStoreChunkSearchOptions,
+    type VectorStoreFileSearchOptions as VectorStoreFileSearchOptions,
     type VectorStoreDeleteResponse as VectorStoreDeleteResponse,
     type VectorStoreQuestionAnsweringResponse as VectorStoreQuestionAnsweringResponse,
     type VectorStoreSearchResponse as VectorStoreSearchResponse,

package/src/resources/vector-stores.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './vector-stores/index';

package/src/resources.ts

@@ -0,0 +1 @@
+export * from './resources/index';

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.1.0-alpha.8'; // x-release-please-version
+export const VERSION = '0.1.0'; // x-release-please-version

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.1.0-alpha.8";
+export declare const VERSION = "0.1.0";
 //# sourceMappingURL=version.d.ts.map

package/version.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,kBAAkB,CAAC"}
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,UAAU,CAAC"}

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.1.0-alpha.8'; // x-release-please-version
+exports.VERSION = '0.1.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.js.map

@@ -1 +1 @@
-{"version":3,"file":"version.js","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":";;;AAAa,QAAA,OAAO,GAAG,eAAe,CAAC,CAAC,2BAA2B"}
+{"version":3,"file":"version.js","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":";;;AAAa,QAAA,OAAO,GAAG,OAAO,CAAC,CAAC,2BAA2B"}

package/version.mjs

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

package/version.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"version.mjs","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,OAAO,GAAG,eAAe,CAAC,CAAC,2BAA2B"}
+{"version":3,"file":"version.mjs","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,OAAO,GAAG,OAAO,CAAC,CAAC,2BAA2B"}