@tanstack/ai-mistral 0.2.3 → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/esm/adapters/embedding.d.ts +76 -0
- package/dist/esm/adapters/embedding.js +122 -0
- package/dist/esm/adapters/embedding.js.map +1 -0
- package/dist/esm/adapters/text.js +702 -731
- package/dist/esm/adapters/text.js.map +1 -1
- package/dist/esm/embedding/embedding-provider-options.d.ts +29 -0
- package/dist/esm/index.d.ts +4 -2
- package/dist/esm/index.js +3 -8
- package/dist/esm/model-meta.d.ts +31 -4
- package/dist/esm/model-meta.js +253 -49
- package/dist/esm/model-meta.js.map +1 -1
- package/dist/esm/tools/function-tool.js +33 -23
- package/dist/esm/tools/function-tool.js.map +1 -1
- package/dist/esm/tools/tool-converter.js +11 -7
- package/dist/esm/tools/tool-converter.js.map +1 -1
- package/dist/esm/utils/client.js +36 -37
- package/dist/esm/utils/client.js.map +1 -1
- package/dist/esm/utils/schema-converter.js +73 -89
- package/dist/esm/utils/schema-converter.js.map +1 -1
- package/package.json +10 -6
- package/src/adapters/embedding.ts +177 -0
- package/src/adapters/text.ts +11 -2
- package/src/embedding/embedding-provider-options.ts +32 -0
- package/src/index.ts +17 -1
- package/src/model-meta.ts +42 -5
- package/src/utils/schema-converter.ts +2 -2
- package/dist/esm/index.js.map +0 -1
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
import { BaseEmbeddingAdapter } from '@tanstack/ai/adapters';
|
|
2
|
+
import { EmbeddingOptions, EmbeddingResult } from '@tanstack/ai';
|
|
3
|
+
import { Mistral } from '@mistralai/mistralai';
|
|
4
|
+
import { MistralEmbeddingModel, MistralEmbeddingModelInputModalitiesByName, MistralEmbeddingModelProviderOptionsByName } from '../model-meta.js';
|
|
5
|
+
import { MistralEmbeddingProviderOptions } from '../embedding/embedding-provider-options.js';
|
|
6
|
+
import { MistralClientConfig } from '../utils/client.js';
|
|
7
|
+
/**
|
|
8
|
+
* Configuration for Mistral embedding adapter.
|
|
9
|
+
*/
|
|
10
|
+
export type MistralEmbeddingConfig = MistralClientConfig;
|
|
11
|
+
/**
|
|
12
|
+
* Mistral Embedding Adapter
|
|
13
|
+
*
|
|
14
|
+
* Tree-shakeable adapter for Mistral text embeddings.
|
|
15
|
+
* Supports mistral-embed and codestral-embed.
|
|
16
|
+
*
|
|
17
|
+
* Features:
|
|
18
|
+
* - Batch embedding (one request for the whole input array)
|
|
19
|
+
* - Dimension reduction for codestral-embed via the top-level `dimensions`
|
|
20
|
+
* option (mapped to Mistral's `outputDimension`); mistral-embed has a fixed
|
|
21
|
+
* 1024-dimension output and rejects `dimensions`.
|
|
22
|
+
*/
|
|
23
|
+
export declare class MistralEmbeddingAdapter<TModel extends MistralEmbeddingModel> extends BaseEmbeddingAdapter<TModel, MistralEmbeddingProviderOptions, MistralEmbeddingModelProviderOptionsByName, MistralEmbeddingModelInputModalitiesByName> {
|
|
24
|
+
readonly name: "mistral";
|
|
25
|
+
protected client: Mistral;
|
|
26
|
+
constructor(config: MistralEmbeddingConfig, model: TModel);
|
|
27
|
+
createEmbeddings(options: EmbeddingOptions<MistralEmbeddingProviderOptions>): Promise<EmbeddingResult>;
|
|
28
|
+
}
|
|
29
|
+
/**
|
|
30
|
+
* Creates a Mistral embedding adapter with explicit API key.
|
|
31
|
+
* Type resolution happens here at the call site.
|
|
32
|
+
*
|
|
33
|
+
* @param model - The model name (e.g., 'mistral-embed')
|
|
34
|
+
* @param apiKey - Your Mistral API key
|
|
35
|
+
* @param config - Optional additional configuration
|
|
36
|
+
* @returns Configured Mistral embedding adapter instance with resolved types
|
|
37
|
+
*
|
|
38
|
+
* @example
|
|
39
|
+
* ```typescript
|
|
40
|
+
* const adapter = createMistralEmbedding('mistral-embed', 'api_key');
|
|
41
|
+
*
|
|
42
|
+
* const result = await embed({
|
|
43
|
+
* adapter,
|
|
44
|
+
* input: 'a red guitar'
|
|
45
|
+
* });
|
|
46
|
+
* ```
|
|
47
|
+
*/
|
|
48
|
+
export declare function createMistralEmbedding<TModel extends MistralEmbeddingModel>(model: TModel, apiKey: string, config?: Omit<MistralEmbeddingConfig, 'apiKey'>): MistralEmbeddingAdapter<TModel>;
|
|
49
|
+
/**
|
|
50
|
+
* Creates a Mistral embedding adapter using the `MISTRAL_API_KEY` environment variable.
|
|
51
|
+
* Type resolution happens here at the call site.
|
|
52
|
+
*
|
|
53
|
+
* Looks for `MISTRAL_API_KEY` in:
|
|
54
|
+
* - `process.env` (Node.js)
|
|
55
|
+
* - `window.env` (Browser with injected env)
|
|
56
|
+
*
|
|
57
|
+
* @param model - The model name (e.g., 'codestral-embed')
|
|
58
|
+
* @param config - Optional configuration (excluding apiKey which is auto-detected)
|
|
59
|
+
* @returns Configured Mistral embedding adapter instance with resolved types
|
|
60
|
+
* @throws Error if MISTRAL_API_KEY is not found in environment
|
|
61
|
+
*
|
|
62
|
+
* @example
|
|
63
|
+
* ```typescript
|
|
64
|
+
* // Automatically uses MISTRAL_API_KEY from environment
|
|
65
|
+
* const adapter = mistralEmbedding('codestral-embed');
|
|
66
|
+
*
|
|
67
|
+
* const result = await embed({
|
|
68
|
+
* adapter,
|
|
69
|
+
* input: ['a red guitar', 'a blue drum kit'],
|
|
70
|
+
* dimensions: 256
|
|
71
|
+
* });
|
|
72
|
+
*
|
|
73
|
+
* console.log(result.embeddings[0].vector)
|
|
74
|
+
* ```
|
|
75
|
+
*/
|
|
76
|
+
export declare function mistralEmbedding<TModel extends MistralEmbeddingModel>(model: TModel, config?: Omit<MistralEmbeddingConfig, 'apiKey'>): MistralEmbeddingAdapter<TModel>;
|
|
@@ -0,0 +1,122 @@
|
|
|
1
|
+
import { createMistralClient, generateId, getMistralApiKeyFromEnv } from "../utils/client.js";
|
|
2
|
+
import { BaseEmbeddingAdapter } from "@tanstack/ai/adapters";
|
|
3
|
+
import { toRunErrorPayload } from "@tanstack/ai/adapter-internals";
|
|
4
|
+
import { requireTextOnlyEmbeddingInput } from "@tanstack/ai";
|
|
5
|
+
//#region src/adapters/embedding.ts
|
|
6
|
+
/**
|
|
7
|
+
* Mistral Embedding Adapter
|
|
8
|
+
*
|
|
9
|
+
* Tree-shakeable adapter for Mistral text embeddings.
|
|
10
|
+
* Supports mistral-embed and codestral-embed.
|
|
11
|
+
*
|
|
12
|
+
* Features:
|
|
13
|
+
* - Batch embedding (one request for the whole input array)
|
|
14
|
+
* - Dimension reduction for codestral-embed via the top-level `dimensions`
|
|
15
|
+
* option (mapped to Mistral's `outputDimension`); mistral-embed has a fixed
|
|
16
|
+
* 1024-dimension output and rejects `dimensions`.
|
|
17
|
+
*/
|
|
18
|
+
var MistralEmbeddingAdapter = class extends BaseEmbeddingAdapter {
|
|
19
|
+
name = "mistral";
|
|
20
|
+
client;
|
|
21
|
+
constructor(config, model) {
|
|
22
|
+
super(model, {});
|
|
23
|
+
this.client = createMistralClient(config);
|
|
24
|
+
}
|
|
25
|
+
async createEmbeddings(options) {
|
|
26
|
+
const { model, logger, modelOptions } = options;
|
|
27
|
+
const texts = requireTextOnlyEmbeddingInput(options.input, this.name, model);
|
|
28
|
+
if (options.dimensions !== void 0 && model === "mistral-embed") throw new Error("mistral-embed does not support requesting dimensions (output is a fixed 1024-dimension vector). Use codestral-embed for dimension reduction, or omit `dimensions`.");
|
|
29
|
+
try {
|
|
30
|
+
const request = {
|
|
31
|
+
...modelOptions,
|
|
32
|
+
model,
|
|
33
|
+
inputs: texts
|
|
34
|
+
};
|
|
35
|
+
if (options.dimensions !== void 0) request.outputDimension = options.dimensions;
|
|
36
|
+
logger.request(`activity=embed provider=${this.name} model=${model} inputs=${texts.length}`, {
|
|
37
|
+
provider: this.name,
|
|
38
|
+
model
|
|
39
|
+
});
|
|
40
|
+
const response = await this.client.embeddings.create(request);
|
|
41
|
+
const usage = {
|
|
42
|
+
promptTokens: response.usage.promptTokens ?? 0,
|
|
43
|
+
completionTokens: 0,
|
|
44
|
+
totalTokens: response.usage.totalTokens ?? 0
|
|
45
|
+
};
|
|
46
|
+
return {
|
|
47
|
+
id: generateId(this.name),
|
|
48
|
+
model,
|
|
49
|
+
embeddings: response.data.map((item, arrayIndex) => ({
|
|
50
|
+
vector: item.embedding ?? [],
|
|
51
|
+
index: item.index ?? arrayIndex
|
|
52
|
+
})),
|
|
53
|
+
usage
|
|
54
|
+
};
|
|
55
|
+
} catch (error) {
|
|
56
|
+
logger.errors(`${this.name}.createEmbeddings fatal`, {
|
|
57
|
+
error: toRunErrorPayload(error, `${this.name}.createEmbeddings failed`),
|
|
58
|
+
source: `${this.name}.createEmbeddings`
|
|
59
|
+
});
|
|
60
|
+
throw error;
|
|
61
|
+
}
|
|
62
|
+
}
|
|
63
|
+
};
|
|
64
|
+
/**
|
|
65
|
+
* Creates a Mistral embedding adapter with explicit API key.
|
|
66
|
+
* Type resolution happens here at the call site.
|
|
67
|
+
*
|
|
68
|
+
* @param model - The model name (e.g., 'mistral-embed')
|
|
69
|
+
* @param apiKey - Your Mistral API key
|
|
70
|
+
* @param config - Optional additional configuration
|
|
71
|
+
* @returns Configured Mistral embedding adapter instance with resolved types
|
|
72
|
+
*
|
|
73
|
+
* @example
|
|
74
|
+
* ```typescript
|
|
75
|
+
* const adapter = createMistralEmbedding('mistral-embed', 'api_key');
|
|
76
|
+
*
|
|
77
|
+
* const result = await embed({
|
|
78
|
+
* adapter,
|
|
79
|
+
* input: 'a red guitar'
|
|
80
|
+
* });
|
|
81
|
+
* ```
|
|
82
|
+
*/
|
|
83
|
+
function createMistralEmbedding(model, apiKey, config) {
|
|
84
|
+
return new MistralEmbeddingAdapter({
|
|
85
|
+
apiKey,
|
|
86
|
+
...config
|
|
87
|
+
}, model);
|
|
88
|
+
}
|
|
89
|
+
/**
|
|
90
|
+
* Creates a Mistral embedding adapter using the `MISTRAL_API_KEY` environment variable.
|
|
91
|
+
* Type resolution happens here at the call site.
|
|
92
|
+
*
|
|
93
|
+
* Looks for `MISTRAL_API_KEY` in:
|
|
94
|
+
* - `process.env` (Node.js)
|
|
95
|
+
* - `window.env` (Browser with injected env)
|
|
96
|
+
*
|
|
97
|
+
* @param model - The model name (e.g., 'codestral-embed')
|
|
98
|
+
* @param config - Optional configuration (excluding apiKey which is auto-detected)
|
|
99
|
+
* @returns Configured Mistral embedding adapter instance with resolved types
|
|
100
|
+
* @throws Error if MISTRAL_API_KEY is not found in environment
|
|
101
|
+
*
|
|
102
|
+
* @example
|
|
103
|
+
* ```typescript
|
|
104
|
+
* // Automatically uses MISTRAL_API_KEY from environment
|
|
105
|
+
* const adapter = mistralEmbedding('codestral-embed');
|
|
106
|
+
*
|
|
107
|
+
* const result = await embed({
|
|
108
|
+
* adapter,
|
|
109
|
+
* input: ['a red guitar', 'a blue drum kit'],
|
|
110
|
+
* dimensions: 256
|
|
111
|
+
* });
|
|
112
|
+
*
|
|
113
|
+
* console.log(result.embeddings[0].vector)
|
|
114
|
+
* ```
|
|
115
|
+
*/
|
|
116
|
+
function mistralEmbedding(model, config) {
|
|
117
|
+
return createMistralEmbedding(model, getMistralApiKeyFromEnv(), config);
|
|
118
|
+
}
|
|
119
|
+
//#endregion
|
|
120
|
+
export { MistralEmbeddingAdapter, createMistralEmbedding, mistralEmbedding };
|
|
121
|
+
|
|
122
|
+
//# sourceMappingURL=embedding.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"embedding.js","names":[],"sources":["../../../src/adapters/embedding.ts"],"sourcesContent":["import { BaseEmbeddingAdapter } from '@tanstack/ai/adapters'\nimport { toRunErrorPayload } from '@tanstack/ai/adapter-internals'\nimport { requireTextOnlyEmbeddingInput } from '@tanstack/ai'\nimport {\n createMistralClient,\n generateId,\n getMistralApiKeyFromEnv,\n} from '../utils/client'\nimport type {\n EmbeddingOptions,\n EmbeddingResult,\n TokenUsage,\n} from '@tanstack/ai'\nimport type { Mistral } from '@mistralai/mistralai'\nimport type { EmbeddingRequest } from '@mistralai/mistralai/models/components'\nimport type {\n MistralEmbeddingModel,\n MistralEmbeddingModelInputModalitiesByName,\n MistralEmbeddingModelProviderOptionsByName,\n} from '../model-meta'\nimport type { MistralEmbeddingProviderOptions } from '../embedding/embedding-provider-options'\nimport type { MistralClientConfig } from '../utils/client'\n\n/**\n * Configuration for Mistral embedding adapter.\n */\nexport type MistralEmbeddingConfig = MistralClientConfig\n\n/**\n * Mistral Embedding Adapter\n *\n * Tree-shakeable adapter for Mistral text embeddings.\n * Supports mistral-embed and codestral-embed.\n *\n * Features:\n * - Batch embedding (one request for the whole input array)\n * - Dimension reduction for codestral-embed via the top-level `dimensions`\n * option (mapped to Mistral's `outputDimension`); mistral-embed has a fixed\n * 1024-dimension output and rejects `dimensions`.\n */\nexport class MistralEmbeddingAdapter<\n TModel extends MistralEmbeddingModel,\n> extends BaseEmbeddingAdapter<\n TModel,\n MistralEmbeddingProviderOptions,\n MistralEmbeddingModelProviderOptionsByName,\n MistralEmbeddingModelInputModalitiesByName\n> {\n readonly name = 'mistral' as const\n\n protected client: Mistral\n\n constructor(config: MistralEmbeddingConfig, model: TModel) {\n super(model, {})\n this.client = createMistralClient(config)\n }\n\n async createEmbeddings(\n options: EmbeddingOptions<MistralEmbeddingProviderOptions>,\n ): Promise<EmbeddingResult> {\n const { model, logger, modelOptions } = options\n const texts = requireTextOnlyEmbeddingInput(options.input, this.name, model)\n\n if (options.dimensions !== undefined && model === 'mistral-embed') {\n throw new Error(\n 'mistral-embed does not support requesting dimensions (output is a fixed 1024-dimension vector). Use codestral-embed for dimension reduction, or omit `dimensions`.',\n )\n }\n\n try {\n // Spread modelOptions first so it can never override the validated\n // fields (server routes often pass modelOptions through from untyped\n // client input).\n const request: EmbeddingRequest = {\n ...modelOptions,\n model,\n inputs: texts,\n }\n if (options.dimensions !== undefined) {\n request.outputDimension = options.dimensions\n }\n\n logger.request(\n `activity=embed provider=${this.name} model=${model} inputs=${texts.length}`,\n { provider: this.name, model },\n )\n\n const response = await this.client.embeddings.create(request)\n\n const usage: TokenUsage = {\n promptTokens: response.usage.promptTokens ?? 0,\n completionTokens: 0,\n totalTokens: response.usage.totalTokens ?? 0,\n }\n\n return {\n id: generateId(this.name),\n model,\n // Mistral returns one entry per input; `index` is optional in the SDK\n // types, so fall back to array order when it's absent.\n embeddings: response.data.map((item, arrayIndex) => ({\n vector: item.embedding ?? [],\n index: item.index ?? arrayIndex,\n })),\n usage,\n }\n } catch (error: unknown) {\n logger.errors(`${this.name}.createEmbeddings fatal`, {\n error: toRunErrorPayload(error, `${this.name}.createEmbeddings failed`),\n source: `${this.name}.createEmbeddings`,\n })\n throw error\n }\n }\n}\n\n/**\n * Creates a Mistral embedding adapter with explicit API key.\n * Type resolution happens here at the call site.\n *\n * @param model - The model name (e.g., 'mistral-embed')\n * @param apiKey - Your Mistral API key\n * @param config - Optional additional configuration\n * @returns Configured Mistral embedding adapter instance with resolved types\n *\n * @example\n * ```typescript\n * const adapter = createMistralEmbedding('mistral-embed', 'api_key');\n *\n * const result = await embed({\n * adapter,\n * input: 'a red guitar'\n * });\n * ```\n */\nexport function createMistralEmbedding<TModel extends MistralEmbeddingModel>(\n model: TModel,\n apiKey: string,\n config?: Omit<MistralEmbeddingConfig, 'apiKey'>,\n): MistralEmbeddingAdapter<TModel> {\n return new MistralEmbeddingAdapter({ apiKey, ...config }, model)\n}\n\n/**\n * Creates a Mistral embedding adapter using the `MISTRAL_API_KEY` environment variable.\n * Type resolution happens here at the call site.\n *\n * Looks for `MISTRAL_API_KEY` in:\n * - `process.env` (Node.js)\n * - `window.env` (Browser with injected env)\n *\n * @param model - The model name (e.g., 'codestral-embed')\n * @param config - Optional configuration (excluding apiKey which is auto-detected)\n * @returns Configured Mistral embedding adapter instance with resolved types\n * @throws Error if MISTRAL_API_KEY is not found in environment\n *\n * @example\n * ```typescript\n * // Automatically uses MISTRAL_API_KEY from environment\n * const adapter = mistralEmbedding('codestral-embed');\n *\n * const result = await embed({\n * adapter,\n * input: ['a red guitar', 'a blue drum kit'],\n * dimensions: 256\n * });\n *\n * console.log(result.embeddings[0].vector)\n * ```\n */\nexport function mistralEmbedding<TModel extends MistralEmbeddingModel>(\n model: TModel,\n config?: Omit<MistralEmbeddingConfig, 'apiKey'>,\n): MistralEmbeddingAdapter<TModel> {\n const apiKey = getMistralApiKeyFromEnv()\n return createMistralEmbedding(model, apiKey, config)\n}\n"],"mappings":";;;;;;;;;;;;;;;;;AAwCA,IAAa,0BAAb,cAEU,qBAKR;CACA,OAAgB;CAEhB;CAEA,YAAY,QAAgC,OAAe;EACzD,MAAM,OAAO,CAAC,CAAC;EACf,KAAK,SAAS,oBAAoB,MAAM;CAC1C;CAEA,MAAM,iBACJ,SAC0B;EAC1B,MAAM,EAAE,OAAO,QAAQ,iBAAiB;EACxC,MAAM,QAAQ,8BAA8B,QAAQ,OAAO,KAAK,MAAM,KAAK;EAE3E,IAAI,QAAQ,eAAe,KAAA,KAAa,UAAU,iBAChD,MAAM,IAAI,MACR,oKACF;EAGF,IAAI;GAIF,MAAM,UAA4B;IAChC,GAAG;IACH;IACA,QAAQ;GACV;GACA,IAAI,QAAQ,eAAe,KAAA,GACzB,QAAQ,kBAAkB,QAAQ;GAGpC,OAAO,QACL,2BAA2B,KAAK,KAAK,SAAS,MAAM,UAAU,MAAM,UACpE;IAAE,UAAU,KAAK;IAAM;GAAM,CAC/B;GAEA,MAAM,WAAW,MAAM,KAAK,OAAO,WAAW,OAAO,OAAO;GAE5D,MAAM,QAAoB;IACxB,cAAc,SAAS,MAAM,gBAAgB;IAC7C,kBAAkB;IAClB,aAAa,SAAS,MAAM,eAAe;GAC7C;GAEA,OAAO;IACL,IAAI,WAAW,KAAK,IAAI;IACxB;IAGA,YAAY,SAAS,KAAK,KAAK,MAAM,gBAAgB;KACnD,QAAQ,KAAK,aAAa,CAAC;KAC3B,OAAO,KAAK,SAAS;IACvB,EAAE;IACF;GACF;EACF,SAAS,OAAgB;GACvB,OAAO,OAAO,GAAG,KAAK,KAAK,0BAA0B;IACnD,OAAO,kBAAkB,OAAO,GAAG,KAAK,KAAK,yBAAyB;IACtE,QAAQ,GAAG,KAAK,KAAK;GACvB,CAAC;GACD,MAAM;EACR;CACF;AACF;;;;;;;;;;;;;;;;;;;;AAqBA,SAAgB,uBACd,OACA,QACA,QACiC;CACjC,OAAO,IAAI,wBAAwB;EAAE;EAAQ,GAAG;CAAO,GAAG,KAAK;AACjE;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA6BA,SAAgB,iBACd,OACA,QACiC;CAEjC,OAAO,uBAAuB,OADf,wBACsB,GAAQ,MAAM;AACrD"}
|