@mastra/voyageai 0.0.0

package/dist/types.d.ts

@@ -0,0 +1,251 @@
+/**
+ * VoyageAI Embeddings - Type Definitions
+ */
+/**
+ * VoyageAI text embedding models
+ */
+export type VoyageTextModel = 'voyage-4-large' | 'voyage-4' | 'voyage-4-lite' | 'voyage-3-large' | 'voyage-3.5' | 'voyage-3.5-lite' | 'voyage-code-3' | 'voyage-finance-2' | 'voyage-law-2';
+/**
+ * VoyageAI multimodal embedding models
+ */
+export type VoyageMultimodalModel = 'voyage-multimodal-3' | 'voyage-multimodal-3.5';
+/**
+ * VoyageAI contextualized chunk embedding models
+ */
+export type VoyageContextModel = 'voyage-context-3';
+/**
+ * All VoyageAI embedding models
+ */
+export type VoyageModel = VoyageTextModel | VoyageMultimodalModel | VoyageContextModel;
+/**
+ * Input type for retrieval optimization
+ * - 'query': For search queries - Voyage prepends a query-specific prompt
+ * - 'document': For documents being indexed - Voyage prepends a document-specific prompt
+ * - null/undefined: No prompt prepended
+ */
+export type VoyageInputType = 'query' | 'document' | null;
+/**
+ * Output data type options for embeddings
+ */
+export type VoyageOutputDtype = 'float' | 'int8' | 'uint8' | 'binary' | 'ubinary';
+/**
+ * Supported output dimensions for flexible dimensionality models
+ */
+export type VoyageOutputDimension = 256 | 512 | 1024 | 2048;
+/**
+ * Configuration for VoyageAI text embedding models
+ */
+export interface VoyageTextEmbeddingConfig {
+    /** The model to use for embeddings */
+    model: VoyageTextModel;
+    /** API key (defaults to VOYAGE_API_KEY env var) */
+    apiKey?: string;
+    /** Input type for retrieval optimization */
+    inputType?: VoyageInputType;
+    /** Output embedding dimension (model-dependent, default 1024) */
+    outputDimension?: VoyageOutputDimension;
+    /** Output data type (default 'float') */
+    outputDtype?: VoyageOutputDtype;
+    /** Whether to truncate inputs that exceed context length (default true) */
+    truncation?: boolean;
+}
+/**
+ * Text content for multimodal embeddings
+ */
+export interface VoyageTextContent {
+    type: 'text';
+    text: string;
+}
+/**
+ * Image URL content for multimodal embeddings
+ */
+export interface VoyageImageUrlContent {
+    type: 'image_url';
+    image_url: string;
+}
+/**
+ * Base64-encoded image content for multimodal embeddings
+ */
+export interface VoyageImageBase64Content {
+    type: 'image_base64';
+    image_base64: string;
+}
+/**
+ * Video URL content for multimodal embeddings (voyage-multimodal-3.5 only)
+ */
+export interface VoyageVideoUrlContent {
+    type: 'video_url';
+    video_url: string;
+}
+/**
+ * All multimodal content types
+ */
+export type VoyageMultimodalContent = VoyageTextContent | VoyageImageUrlContent | VoyageImageBase64Content | VoyageVideoUrlContent;
+/**
+ * Single multimodal input - an array of interleaved content
+ */
+export interface VoyageMultimodalInput {
+    content: VoyageMultimodalContent[];
+}
+/**
+ * Configuration for VoyageAI multimodal embedding models
+ */
+export interface VoyageMultimodalEmbeddingConfig {
+    /** The model to use (voyage-multimodal-3 or voyage-multimodal-3.5) */
+    model: VoyageMultimodalModel;
+    /** API key (defaults to VOYAGE_API_KEY env var) */
+    apiKey?: string;
+    /** Input type for retrieval optimization */
+    inputType?: VoyageInputType;
+    /** Whether to truncate inputs that exceed context length (default true) */
+    truncation?: boolean;
+}
+/**
+ * Configuration for VoyageAI contextualized chunk embedding models
+ */
+export interface VoyageContextualizedEmbeddingConfig {
+    /** The model to use (voyage-context-3) */
+    model: VoyageContextModel;
+    /** API key (defaults to VOYAGE_API_KEY env var) */
+    apiKey?: string;
+    /** Input type for retrieval optimization */
+    inputType?: VoyageInputType;
+    /** Output embedding dimension (default 1024) */
+    outputDimension?: VoyageOutputDimension;
+    /** Output data type (default 'float') */
+    outputDtype?: VoyageOutputDtype;
+}
+/**
+ * VoyageAI-specific provider options for runtime configuration
+ * Used with Mastra's providerOptions to override embedding config at call time
+ */
+export interface VoyageProviderOptions {
+    voyage?: {
+        /** Input type for retrieval optimization */
+        inputType?: VoyageInputType;
+        /** Output embedding dimension */
+        outputDimension?: VoyageOutputDimension;
+        /** Output data type */
+        outputDtype?: VoyageOutputDtype;
+        /** Whether to truncate inputs */
+        truncation?: boolean;
+    };
+}
+/**
+ * Metadata for VoyageAI embedding models
+ */
+export interface VoyageModelInfo {
+    id: VoyageModel;
+    maxInputTokens: number;
+    defaultDimension: number;
+    supportedDimensions?: VoyageOutputDimension[];
+    isMultimodal: boolean;
+    isContextualized: boolean;
+}
+/**
+ * Model metadata for all VoyageAI text embedding models
+ */
+export declare const TEXT_MODEL_INFO: Record<VoyageTextModel, Omit<VoyageModelInfo, 'id'>>;
+/**
+ * Model metadata for VoyageAI multimodal embedding models
+ */
+export declare const MULTIMODAL_MODEL_INFO: Record<VoyageMultimodalModel, Omit<VoyageModelInfo, 'id'>>;
+/**
+ * Model metadata for VoyageAI contextualized embedding models
+ */
+export declare const CONTEXTUALIZED_MODEL_INFO: Record<VoyageContextModel, Omit<VoyageModelInfo, 'id'>>;
+/**
+ * VoyageAI embedding response
+ */
+export interface VoyageEmbeddingResponse {
+    object: 'list';
+    data: Array<{
+        object: 'embedding';
+        embedding: number[];
+        index: number;
+    }>;
+    model: string;
+    usage: {
+        total_tokens: number;
+    };
+}
+/**
+ * Single chunk embedding from contextualized embeddings API
+ */
+export interface VoyageContextualizedChunkEmbedding {
+    /** The object type, which is always "embedding" */
+    object?: string;
+    /** The embedding vector for this chunk */
+    embedding?: number[];
+    /** The index of this chunk within the document */
+    index?: number;
+}
+/**
+ * Single document result from contextualized embeddings API
+ */
+export interface VoyageContextualizedDocumentResult {
+    /** The object type, which is always "list" */
+    object?: string;
+    /** Array of chunk embeddings for this document */
+    data?: VoyageContextualizedChunkEmbedding[];
+    /** The index of this document within the input list */
+    index?: number;
+}
+/**
+ * VoyageAI contextualized embedding response
+ * Structure: response.data[docIndex].data[chunkIndex].embedding
+ */
+export interface VoyageContextualizedEmbeddingResponse {
+    object: 'list';
+    /** Array of document results, each containing chunk embeddings */
+    data: VoyageContextualizedDocumentResult[];
+    model: string;
+    usage: {
+        total_tokens: number;
+    };
+}
+/**
+ * VoyageAI reranking models
+ */
+export type VoyageRerankerModel = 'rerank-2.5' | 'rerank-2.5-lite' | 'rerank-2' | 'rerank-2-lite' | 'rerank-1' | 'rerank-lite-1';
+/**
+ * Configuration for VoyageAI reranker
+ */
+export interface VoyageRerankerConfig {
+    /** The reranker model to use */
+    model: VoyageRerankerModel;
+    /** API key (defaults to VOYAGE_API_KEY env var) */
+    apiKey?: string;
+    /** Whether to truncate inputs that exceed context length (default true) */
+    truncation?: boolean;
+}
+/**
+ * Single reranking result from VoyageAI
+ */
+export interface VoyageRerankResult {
+    /** Index of the document in the original input array */
+    index: number;
+    /** The original document text */
+    document: string;
+    /** Relevance score (higher = more relevant) */
+    relevance_score: number;
+}
+/**
+ * VoyageAI reranking API response
+ */
+export interface VoyageRerankResponse {
+    object: 'list';
+    data: VoyageRerankResult[];
+    model: string;
+    usage: {
+        total_tokens: number;
+    };
+}
+/**
+ * Model metadata for VoyageAI reranker models
+ */
+export declare const RERANKER_MODEL_INFO: Record<VoyageRerankerModel, {
+    contextLength: number;
+    description: string;
+}>;
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AAMH;;GAEG;AACH,MAAM,MAAM,eAAe,GACvB,gBAAgB,GAChB,UAAU,GACV,eAAe,GACf,gBAAgB,GAChB,YAAY,GACZ,iBAAiB,GACjB,eAAe,GACf,kBAAkB,GAClB,cAAc,CAAC;AAEnB;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,qBAAqB,GAAG,uBAAuB,CAAC;AAEpF;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,kBAAkB,CAAC;AAEpD;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,eAAe,GAAG,qBAAqB,GAAG,kBAAkB,CAAC;AAMvF;;;;;GAKG;AACH,MAAM,MAAM,eAAe,GAAG,OAAO,GAAG,UAAU,GAAG,IAAI,CAAC;AAE1D;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,OAAO,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,SAAS,CAAC;AAElF;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,GAAG,GAAG,GAAG,GAAG,IAAI,GAAG,IAAI,CAAC;AAM5D;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,sCAAsC;IACtC,KAAK,EAAE,eAAe,CAAC;IACvB,mDAAmD;IACnD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,4CAA4C;IAC5C,SAAS,CAAC,EAAE,eAAe,CAAC;IAC5B,iEAAiE;IACjE,eAAe,CAAC,EAAE,qBAAqB,CAAC;IACxC,yCAAyC;IACzC,WAAW,CAAC,EAAE,iBAAiB,CAAC;IAChC,2EAA2E;IAC3E,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB;AAMD;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,WAAW,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE,cAAc,CAAC;IACrB,YAAY,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,WAAW,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAC/B,iBAAiB,GACjB,qBAAqB,GACrB,wBAAwB,GACxB,qBAAqB,CAAC;AAE1B;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,OAAO,EAAE,uBAAuB,EAAE,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,+BAA+B;IAC9C,sEAAsE;IACtE,KAAK,EAAE,qBAAqB,CAAC;IAC7B,mDAAmD;IACnD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,4CAA4C;IAC5C,SAAS,CAAC,EAAE,eAAe,CAAC;IAC5B,2EAA2E;IAC3E,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB;AAMD;;GAEG;AACH,MAAM,WAAW,mCAAmC;IAClD,0CAA0C;IAC1C,KAAK,EAAE,kBAAkB,CAAC;IAC1B,mDAAmD;IACnD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,4CAA4C;IAC5C,SAAS,CAAC,EAAE,eAAe,CAAC;IAC5B,gDAAgD;IAChD,eAAe,CAAC,EAAE,qBAAqB,CAAC;IACxC,yCAAyC;IACzC,WAAW,CAAC,EAAE,iBAAiB,CAAC;CACjC;AAMD;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC,MAAM,CAAC,EAAE;QACP,4CAA4C;QAC5C,SAAS,CAAC,EAAE,eAAe,CAAC;QAC5B,iCAAiC;QACjC,eAAe,CAAC,EAAE,qBAAqB,CAAC;QACxC,uBAAuB;QACvB,WAAW,CAAC,EAAE,iBAAiB,CAAC;QAChC,iCAAiC;QACjC,UAAU,CAAC,EAAE,OAAO,CAAC;KACtB,CAAC;CACH;AAMD;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,EAAE,EAAE,WAAW,CAAC;IAChB,cAAc,EAAE,MAAM,CAAC;IACvB,gBAAgB,EAAE,MAAM,CAAC;IACzB,mBAAmB,CAAC,EAAE,qBAAqB,EAAE,CAAC;IAC9C,YAAY,EAAE,OAAO,CAAC;IACtB,gBAAgB,EAAE,OAAO,CAAC;CAC3B;AAED;;GAEG;AACH,eAAO,MAAM,eAAe,EAAE,MAAM,CAAC,eAAe,EAAE,IAAI,CAAC,eAAe,EAAE,IAAI,CAAC,CA8DhF,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,qBAAqB,EAAE,MAAM,CAAC,qBAAqB,EAAE,IAAI,CAAC,eAAe,EAAE,IAAI,CAAC,CAa5F,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,yBAAyB,EAAE,MAAM,CAAC,kBAAkB,EAAE,IAAI,CAAC,eAAe,EAAE,IAAI,CAAC,CAQ7F,CAAC;AAMF;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,KAAK,CAAC;QACV,MAAM,EAAE,WAAW,CAAC;QACpB,SAAS,EAAE,MAAM,EAAE,CAAC;QACpB,KAAK,EAAE,MAAM,CAAC;KACf,CAAC,CAAC;IACH,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE;QACL,YAAY,EAAE,MAAM,CAAC;KACtB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,kCAAkC;IACjD,mDAAmD;IACnD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,0CAA0C;IAC1C,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,kDAAkD;IAClD,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,kCAAkC;IACjD,8CAA8C;IAC9C,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,kDAAkD;IAClD,IAAI,CAAC,EAAE,kCAAkC,EAAE,CAAC;IAC5C,uDAAuD;IACvD,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;GAGG;AACH,MAAM,WAAW,qCAAqC;IACpD,MAAM,EAAE,MAAM,CAAC;IACf,kEAAkE;IAClE,IAAI,EAAE,kCAAkC,EAAE,CAAC;IAC3C,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE;QACL,YAAY,EAAE,MAAM,CAAC;KACtB,CAAC;CACH;AAMD;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAC3B,YAAY,GACZ,iBAAiB,GACjB,UAAU,GACV,eAAe,GACf,UAAU,GACV,eAAe,CAAC;AAEpB;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,gCAAgC;IAChC,KAAK,EAAE,mBAAmB,CAAC;IAC3B,mDAAmD;IACnD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,2EAA2E;IAC3E,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,wDAAwD;IACxD,KAAK,EAAE,MAAM,CAAC;IACd,iCAAiC;IACjC,QAAQ,EAAE,MAAM,CAAC;IACjB,+CAA+C;IAC/C,eAAe,EAAE,MAAM,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,kBAAkB,EAAE,CAAC;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE;QACL,YAAY,EAAE,MAAM,CAAC;KACtB,CAAC;CACH;AAED;;GAEG;AACH,eAAO,MAAM,mBAAmB,EAAE,MAAM,CAAC,mBAAmB,EAAE;IAAE,aAAa,EAAE,MAAM,CAAC;IAAC,WAAW,EAAE,MAAM,CAAA;CAAE,CAyB3G,CAAC"}

package/package.json

@@ -0,0 +1,73 @@
+{
+  "name": "@mastra/voyageai",
+  "version": "0.0.0",
+  "description": "VoyageAI embeddings integration for Mastra - text, multimodal, and contextualized chunk embeddings",
+  "license": "Apache-2.0",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "CHANGELOG.md"
+  ],
+  "homepage": "https://mastra.ai",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/mastra-ai/mastra.git",
+    "directory": "embedders/voyageai"
+  },
+  "bugs": {
+    "url": "https://github.com/mastra-ai/mastra/issues"
+  },
+  "scripts": {
+    "build": "tsup --silent --config tsup.config.ts",
+    "build:watch": "tsup --watch --silent --config tsup.config.ts",
+    "test": "vitest run"
+  },
+  "dependencies": {
+    "voyageai": "^0.2.1"
+  },
+  "peerDependencies": {
+    "zod": "^3.25.0 || ^4.0.0"
+  },
+  "devDependencies": {
+    "@internal/ai-sdk-v4": "workspace:*",
+    "@internal/ai-sdk-v5": "workspace:*",
+    "@internal/ai-v6": "workspace:*",
+    "@internal/lint": "workspace:*",
+    "@internal/types-builder": "workspace:*",
+    "@types/node": "22.19.15",
+    "@vitest/coverage-v8": "catalog:",
+    "@vitest/ui": "catalog:",
+    "tsup": "^8.5.0",
+    "typescript": "catalog:",
+    "vitest": "catalog:",
+    "zod": "catalog:"
+  },
+  "engines": {
+    "node": ">=22.13.0"
+  },
+  "keywords": [
+    "mastra",
+    "voyage",
+    "voyageai",
+    "embeddings",
+    "multimodal",
+    "ai",
+    "rag",
+    "vector"
+  ]
+}