@mixedbread/sdk 0.1.0-alpha.8

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

@@ -0,0 +1,561 @@
+// 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 * as Shared from '../shared';
+import * as FilesAPI from './files';
+import {
+  FileCreateParams,
+  FileDeleteResponse,
+  FileListParams,
+  FileSearchParams,
+  FileSearchResponse,
+  Files,
+  ScoredVectorStoreFile,
+  VectorStoreFile,
+  VectorStoreFilesLimitOffset,
+} from './files';
+import { LimitOffset, type LimitOffsetParams } from '../../pagination';
+
+export class VectorStores extends APIResource {
+  files: FilesAPI.Files = new FilesAPI.Files(this._client);
+
+  /**
+   * Create a new vector store.
+   *
+   * Args: vector_store_create: VectorStoreCreate object containing the name,
+   * description, and metadata.
+   *
+   * Returns: VectorStore: The response containing the created vector store details.
+   */
+  create(body: VectorStoreCreateParams, options?: Core.RequestOptions): Core.APIPromise<VectorStore> {
+    return this._client.post('/v1/vector_stores', { body, ...options });
+  }
+
+  /**
+   * Get a vector store by ID.
+   *
+   * Args: vector_store_id: The ID of the vector store to retrieve.
+   *
+   * 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);
+  }
+
+  /**
+   * Update a vector store by ID.
+   *
+   * Args: vector_store_id: The ID of the vector store to update.
+   * vector_store_update: VectorStoreCreate object containing the name, description,
+   * and metadata.
+   *
+   * Returns: VectorStore: The response containing the updated vector store details.
+   */
+  update(
+    vectorStoreId: string,
+    body: VectorStoreUpdateParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<VectorStore> {
+    return this._client.put(`/v1/vector_stores/${vectorStoreId}`, { body, ...options });
+  }
+
+  /**
+   * List all vector stores.
+   *
+   * Args: pagination: The pagination options.
+   *
+   * 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 });
+  }
+
+  /**
+   * Delete a vector store by ID.
+   *
+   * Args: vector_store_id: The ID of the vector store to delete.
+   *
+   * 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);
+  }
+
+  /**
+   * Question answering
+   */
+  questionAnswering(
+    body: VectorStoreQuestionAnsweringParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<unknown> {
+    return this._client.post('/v1/vector_stores/question-answering', { body, ...options });
+  }
+
+  /**
+   * Perform semantic search across vector store chunks.
+   *
+   * This endpoint searches through vector store chunks using semantic similarity
+   * matching. It supports complex search queries with filters and returns
+   * relevance-scored results.
+   *
+   * Args: search_params: Search configuration including: - query text or
+   * embeddings - metadata filters - pagination parameters - sorting preferences
+   * \_state: API state dependency \_ctx: Service context dependency
+   *
+   * Returns: VectorStoreSearchChunkResponse containing: - List of matched chunks
+   * with relevance scores - Pagination details including total result count
+   *
+   * 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> {
+    return this._client.post('/v1/vector_stores/search', { body, ...options });
+  }
+}
+
+export class VectorStoresLimitOffset extends LimitOffset<VectorStore> {}
+
+/**
+ * Represents an expiration policy for a vector store.
+ */
+export interface ExpiresAfter {
+  /**
+   * Anchor date for the expiration policy
+   */
+  anchor?: 'last_active_at';
+
+  /**
+   * Number of days after which the vector store expires
+   */
+  days?: number;
+}
+
+/**
+ * Tracks counts of files in different states within a vector store.
+ */
+export interface FileCounts {
+  /**
+   * Number of files currently being processed
+   */
+  in_progress?: number;
+
+  /**
+   * Number of files whose processing was cancelled
+   */
+  cancelled?: number;
+
+  /**
+   * Number of successfully processed files
+   */
+  completed?: number;
+
+  /**
+   * Number of files that failed processing
+   */
+  failed?: number;
+
+  /**
+   * Total number of files
+   */
+  total?: number;
+}
+
+export interface ScoredVectorStoreChunk {
+  /**
+   * position of the chunk in a file
+   */
+  position: number;
+
+  /**
+   * value of the chunk
+   */
+  value?:
+    | string
+    | ScoredVectorStoreChunk.ImageURLInput
+    | ScoredVectorStoreChunk.TextInput
+    | Record<string, unknown>
+    | null;
+
+  /**
+   * content of the chunk
+   */
+  content?: string | null;
+
+  /**
+   * score of the chunk
+   */
+  score: number;
+
+  /**
+   * file id
+   */
+  file_id: string;
+
+  /**
+   * vector store id
+   */
+  vector_store_id: string;
+
+  /**
+   * file metadata
+   */
+  metadata?: unknown;
+}
+
+export namespace ScoredVectorStoreChunk {
+  /**
+   * Model for image input validation.
+   */
+  export interface ImageURLInput {
+    /**
+     * Input type identifier
+     */
+    type?: 'image_url';
+
+    /**
+     * The image input specification.
+     */
+    image: ImageURLInput.Image;
+  }
+
+  export namespace ImageURLInput {
+    /**
+     * The image input specification.
+     */
+    export interface Image {
+      /**
+       * The image URL. Can be either a URL or a Data URI.
+       */
+      url: string;
+    }
+  }
+
+  /**
+   * Model for text input validation.
+   *
+   * Attributes: type: Input type identifier, always "text" text: The actual text
+   * content, with length and whitespace constraints
+   */
+  export interface TextInput {
+    /**
+     * Input type identifier
+     */
+    type?: 'text';
+
+    /**
+     * Text content to process
+     */
+    text: string;
+  }
+}
+
+/**
+ * Model representing a vector store with its metadata and timestamps.
+ */
+export interface VectorStore {
+  /**
+   * Unique identifier for the vector store
+   */
+  id: string;
+
+  /**
+   * Name of the vector store
+   */
+  name: string;
+
+  /**
+   * Detailed description of the vector store's purpose and contents
+   */
+  description?: string | null;
+
+  /**
+   * Additional metadata associated with the vector store
+   */
+  metadata?: unknown;
+
+  /**
+   * Counts of files in different states
+   */
+  file_counts?: FileCounts;
+
+  /**
+   * Represents an expiration policy for a vector store.
+   */
+  expires_after?: ExpiresAfter | null;
+
+  /**
+   * Processing status of the vector store
+   */
+  status?: 'expired' | 'in_progress' | 'completed';
+
+  /**
+   * Timestamp when the vector store was created
+   */
+  created_at: string;
+
+  /**
+   * Timestamp when the vector store was last updated
+   */
+  updated_at: string;
+
+  /**
+   * Timestamp when the vector store was last used
+   */
+  last_active_at?: string | null;
+
+  /**
+   * Optional expiration timestamp for the vector store
+   */
+  expires_at?: string | null;
+
+  /**
+   * Type of the object
+   */
+  object?: 'vector_store';
+}
+
+/**
+ * Options for configuring vector store searches.
+ */
+export interface VectorStoreSearchOptions {
+  /**
+   * Whether to return file metadata
+   */
+  return_metadata?: boolean;
+
+  /**
+   * Whether to return matching text chunks
+   */
+  return_chunks?: boolean;
+
+  /**
+   * Minimum similarity score threshold
+   */
+  score_threshold?: number;
+
+  /**
+   * Whether to rewrite the query
+   */
+  rewrite_query?: boolean;
+}
+
+/**
+ * Response model for vector store deletion.
+ */
+export interface VectorStoreDeleteResponse {
+  /**
+   * ID of the deleted vector store
+   */
+  id: string;
+
+  /**
+   * Whether the deletion was successful
+   */
+  deleted: boolean;
+
+  /**
+   * Type of the deleted object
+   */
+  object?: 'vector_store';
+}
+
+export type VectorStoreQuestionAnsweringResponse = unknown;
+
+export interface VectorStoreSearchResponse {
+  /**
+   * The object type of the response
+   */
+  object?: 'list';
+
+  /**
+   * The list of scored vector store file chunks
+   */
+  data: Array<ScoredVectorStoreChunk>;
+}
+
+export interface VectorStoreCreateParams {
+  /**
+   * Name for the new vector store
+   */
+  name?: string | null;
+
+  /**
+   * Description of the vector store
+   */
+  description?: string | null;
+
+  /**
+   * Represents an expiration policy for a vector store.
+   */
+  expires_after?: ExpiresAfter | null;
+
+  /**
+   * Optional metadata key-value pairs
+   */
+  metadata?: unknown;
+
+  /**
+   * Optional list of file IDs
+   */
+  file_ids?: Array<string> | null;
+}
+
+export interface VectorStoreUpdateParams {
+  /**
+   * New name for the vector store
+   */
+  name?: string | null;
+
+  /**
+   * New description
+   */
+  description?: string | null;
+
+  /**
+   * Represents an expiration policy for a vector store.
+   */
+  expires_after?: ExpiresAfter | null;
+
+  /**
+   * Optional metadata key-value pairs
+   */
+  metadata?: unknown;
+}
+
+export interface VectorStoreListParams extends LimitOffsetParams {}
+
+export interface VectorStoreQuestionAnsweringParams {
+  /**
+   * Question to answer. If not provided, the question will be extracted from the
+   * passed messages.
+   */
+  query?: string;
+
+  /**
+   * IDs of vector stores to search
+   */
+  vector_store_ids: Array<string>;
+
+  /**
+   * Number of results to return
+   */
+  top_k?: number;
+
+  /**
+   * Optional filter conditions
+   */
+  filters?:
+    | Shared.SearchFilter
+    | Shared.SearchFilterCondition
+    | Array<Shared.SearchFilter | Shared.SearchFilterCondition>
+    | null;
+
+  /**
+   * Search configuration options
+   */
+  search_options?: VectorStoreSearchOptions;
+
+  /**
+   * Whether to stream the answer
+   */
+  stream?: boolean;
+
+  /**
+   * Question answering configuration options
+   */
+  qa_options?: VectorStoreQuestionAnsweringParams.QaOptions;
+}
+
+export namespace VectorStoreQuestionAnsweringParams {
+  /**
+   * Question answering configuration options
+   */
+  export interface QaOptions {
+    /**
+     * Whether to use citations
+     */
+    cite?: boolean;
+  }
+}
+
+export interface VectorStoreSearchParams {
+  /**
+   * Search query text
+   */
+  query: string;
+
+  /**
+   * IDs of vector stores to search
+   */
+  vector_store_ids: Array<string>;
+
+  /**
+   * Number of results to return
+   */
+  top_k?: number;
+
+  /**
+   * Optional filter conditions
+   */
+  filters?:
+    | Shared.SearchFilter
+    | Shared.SearchFilterCondition
+    | Array<Shared.SearchFilter | Shared.SearchFilterCondition>
+    | null;
+
+  /**
+   * Search configuration options
+   */
+  search_options?: VectorStoreSearchOptions;
+}
+
+VectorStores.VectorStoresLimitOffset = VectorStoresLimitOffset;
+VectorStores.Files = Files;
+VectorStores.VectorStoreFilesLimitOffset = VectorStoreFilesLimitOffset;
+
+export declare namespace VectorStores {
+  export {
+    type ExpiresAfter as ExpiresAfter,
+    type FileCounts as FileCounts,
+    type ScoredVectorStoreChunk as ScoredVectorStoreChunk,
+    type VectorStore as VectorStore,
+    type VectorStoreSearchOptions as VectorStoreSearchOptions,
+    type VectorStoreDeleteResponse as VectorStoreDeleteResponse,
+    type VectorStoreQuestionAnsweringResponse as VectorStoreQuestionAnsweringResponse,
+    type VectorStoreSearchResponse as VectorStoreSearchResponse,
+    VectorStoresLimitOffset as VectorStoresLimitOffset,
+    type VectorStoreCreateParams as VectorStoreCreateParams,
+    type VectorStoreUpdateParams as VectorStoreUpdateParams,
+    type VectorStoreListParams as VectorStoreListParams,
+    type VectorStoreQuestionAnsweringParams as VectorStoreQuestionAnsweringParams,
+    type VectorStoreSearchParams as VectorStoreSearchParams,
+  };
+
+  export {
+    Files as Files,
+    type ScoredVectorStoreFile as ScoredVectorStoreFile,
+    type VectorStoreFile as VectorStoreFile,
+    type FileDeleteResponse as FileDeleteResponse,
+    type FileSearchResponse as FileSearchResponse,
+    VectorStoreFilesLimitOffset as VectorStoreFilesLimitOffset,
+    type FileCreateParams as FileCreateParams,
+    type FileListParams as FileListParams,
+    type FileSearchParams as FileSearchParams,
+  };
+}

package/src/shims/node.ts

@@ -0,0 +1,50 @@
+// @ts-ignore
+import * as types from '../_shims/node-types';
+import { setShims } from '../_shims/registry';
+import { getRuntime } from '../_shims/node-runtime';
+setShims(getRuntime());
+
+declare module '../_shims/manual-types' {
+  export namespace manual {
+    // @ts-ignore
+    export type Agent = types.Agent;
+    // @ts-ignore
+    export import fetch = types.fetch;
+    // @ts-ignore
+    export type Request = types.Request;
+    // @ts-ignore
+    export type RequestInfo = types.RequestInfo;
+    // @ts-ignore
+    export type RequestInit = types.RequestInit;
+    // @ts-ignore
+    export type Response = types.Response;
+    // @ts-ignore
+    export type ResponseInit = types.ResponseInit;
+    // @ts-ignore
+    export type ResponseType = types.ResponseType;
+    // @ts-ignore
+    export type BodyInit = types.BodyInit;
+    // @ts-ignore
+    export type Headers = types.Headers;
+    // @ts-ignore
+    export type HeadersInit = types.HeadersInit;
+    // @ts-ignore
+    export type BlobPropertyBag = types.BlobPropertyBag;
+    // @ts-ignore
+    export type FilePropertyBag = types.FilePropertyBag;
+    // @ts-ignore
+    export type FileFromPathOptions = types.FileFromPathOptions;
+    // @ts-ignore
+    export import FormData = types.FormData;
+    // @ts-ignore
+    export import File = types.File;
+    // @ts-ignore
+    export import Blob = types.Blob;
+    // @ts-ignore
+    export type Readable = types.Readable;
+    // @ts-ignore
+    export type FsReadStream = types.FsReadStream;
+    // @ts-ignore
+    export import ReadableStream = types.ReadableStream;
+  }
+}

package/src/shims/web.ts

@@ -0,0 +1,50 @@
+// @ts-ignore
+import * as types from '../_shims/web-types';
+import { setShims } from '../_shims/registry';
+import { getRuntime } from '../_shims/web-runtime';
+setShims(getRuntime({ manuallyImported: true }));
+
+declare module '../_shims/manual-types' {
+  export namespace manual {
+    // @ts-ignore
+    export type Agent = types.Agent;
+    // @ts-ignore
+    export import fetch = types.fetch;
+    // @ts-ignore
+    export type Request = types.Request;
+    // @ts-ignore
+    export type RequestInfo = types.RequestInfo;
+    // @ts-ignore
+    export type RequestInit = types.RequestInit;
+    // @ts-ignore
+    export type Response = types.Response;
+    // @ts-ignore
+    export type ResponseInit = types.ResponseInit;
+    // @ts-ignore
+    export type ResponseType = types.ResponseType;
+    // @ts-ignore
+    export type BodyInit = types.BodyInit;
+    // @ts-ignore
+    export type Headers = types.Headers;
+    // @ts-ignore
+    export type HeadersInit = types.HeadersInit;
+    // @ts-ignore
+    export type BlobPropertyBag = types.BlobPropertyBag;
+    // @ts-ignore
+    export type FilePropertyBag = types.FilePropertyBag;
+    // @ts-ignore
+    export type FileFromPathOptions = types.FileFromPathOptions;
+    // @ts-ignore
+    export import FormData = types.FormData;
+    // @ts-ignore
+    export import File = types.File;
+    // @ts-ignore
+    export import Blob = types.Blob;
+    // @ts-ignore
+    export type Readable = types.Readable;
+    // @ts-ignore
+    export type FsReadStream = types.FsReadStream;
+    // @ts-ignore
+    export import ReadableStream = types.ReadableStream;
+  }
+}

package/src/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  // this config is included in the published src directory to prevent TS errors
+  // from appearing when users go to source, and VSCode opens the source .ts file
+  // via declaration maps
+  "include": ["index.ts"],
+  "compilerOptions": {
+    "target": "es2015",
+    "lib": ["DOM"],
+    "moduleResolution": "node"
+  }
+}