@ai-sdk/provider 3.0.0-beta.31 → 3.0.0-beta.32
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/CHANGELOG.md +6 -0
- package/dist/index.d.mts +45 -40
- package/dist/index.d.ts +45 -40
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
package/dist/index.d.mts
CHANGED
|
@@ -150,7 +150,7 @@ type SharedV2ProviderMetadata = Record<string, Record<string, JSONValue>>;
|
|
|
150
150
|
*/
|
|
151
151
|
type SharedV2ProviderOptions = Record<string, Record<string, JSONValue>>;
|
|
152
152
|
|
|
153
|
-
type
|
|
153
|
+
type EmbeddingModelV3CallOptions = {
|
|
154
154
|
/**
|
|
155
155
|
List of text values to generate embeddings for.
|
|
156
156
|
*/
|
|
@@ -178,6 +178,45 @@ It is e.g. used to represent a text as a vector of word embeddings.
|
|
|
178
178
|
*/
|
|
179
179
|
type EmbeddingModelV3Embedding = Array<number>;
|
|
180
180
|
|
|
181
|
+
/**
|
|
182
|
+
* The result of a embedding model doEmbed call.
|
|
183
|
+
*/
|
|
184
|
+
type EmbeddingModelV3Result = {
|
|
185
|
+
/**
|
|
186
|
+
* Generated embeddings. They are in the same order as the input values.
|
|
187
|
+
*/
|
|
188
|
+
embeddings: Array<EmbeddingModelV3Embedding>;
|
|
189
|
+
/**
|
|
190
|
+
* Token usage. We only have input tokens for embeddings.
|
|
191
|
+
*/
|
|
192
|
+
usage?: {
|
|
193
|
+
tokens: number;
|
|
194
|
+
};
|
|
195
|
+
/**
|
|
196
|
+
* Additional provider-specific metadata. They are passed through
|
|
197
|
+
* from the provider to the AI SDK and enable provider-specific
|
|
198
|
+
* results that can be fully encapsulated in the provider.
|
|
199
|
+
*/
|
|
200
|
+
providerMetadata?: SharedV3ProviderMetadata;
|
|
201
|
+
/**
|
|
202
|
+
* Optional response information for debugging purposes.
|
|
203
|
+
*/
|
|
204
|
+
response?: {
|
|
205
|
+
/**
|
|
206
|
+
* Response headers.
|
|
207
|
+
*/
|
|
208
|
+
headers?: SharedV3Headers;
|
|
209
|
+
/**
|
|
210
|
+
The response body.
|
|
211
|
+
*/
|
|
212
|
+
body?: unknown;
|
|
213
|
+
};
|
|
214
|
+
/**
|
|
215
|
+
* Warnings for the call, e.g. unsupported settings.
|
|
216
|
+
*/
|
|
217
|
+
warnings: Array<SharedV3Warning>;
|
|
218
|
+
};
|
|
219
|
+
|
|
181
220
|
/**
|
|
182
221
|
Specification for an embedding model that implements the embedding model
|
|
183
222
|
interface version 3.
|
|
@@ -217,41 +256,7 @@ type EmbeddingModelV3 = {
|
|
|
217
256
|
Naming: "do" prefix to prevent accidental direct usage of the method
|
|
218
257
|
by the user.
|
|
219
258
|
*/
|
|
220
|
-
doEmbed(options:
|
|
221
|
-
/**
|
|
222
|
-
Generated embeddings. They are in the same order as the input values.
|
|
223
|
-
*/
|
|
224
|
-
embeddings: Array<EmbeddingModelV3Embedding>;
|
|
225
|
-
/**
|
|
226
|
-
Token usage. We only have input tokens for embeddings.
|
|
227
|
-
*/
|
|
228
|
-
usage?: {
|
|
229
|
-
tokens: number;
|
|
230
|
-
};
|
|
231
|
-
/**
|
|
232
|
-
Additional provider-specific metadata. They are passed through
|
|
233
|
-
from the provider to the AI SDK and enable provider-specific
|
|
234
|
-
results that can be fully encapsulated in the provider.
|
|
235
|
-
*/
|
|
236
|
-
providerMetadata?: SharedV3ProviderMetadata;
|
|
237
|
-
/**
|
|
238
|
-
Optional response information for debugging purposes.
|
|
239
|
-
*/
|
|
240
|
-
response?: {
|
|
241
|
-
/**
|
|
242
|
-
Response headers.
|
|
243
|
-
*/
|
|
244
|
-
headers?: SharedV3Headers;
|
|
245
|
-
/**
|
|
246
|
-
The response body.
|
|
247
|
-
*/
|
|
248
|
-
body?: unknown;
|
|
249
|
-
};
|
|
250
|
-
/**
|
|
251
|
-
Warnings for the call, e.g. unsupported settings.
|
|
252
|
-
*/
|
|
253
|
-
warnings: Array<SharedV3Warning>;
|
|
254
|
-
}>;
|
|
259
|
+
doEmbed(options: EmbeddingModelV3CallOptions): PromiseLike<EmbeddingModelV3Result>;
|
|
255
260
|
};
|
|
256
261
|
|
|
257
262
|
/**
|
|
@@ -2908,9 +2913,9 @@ type EmbeddingModelV3Middleware = {
|
|
|
2908
2913
|
* @returns A promise that resolves to the transformed parameters.
|
|
2909
2914
|
*/
|
|
2910
2915
|
transformParams?: (options: {
|
|
2911
|
-
params:
|
|
2916
|
+
params: EmbeddingModelV3CallOptions;
|
|
2912
2917
|
model: EmbeddingModelV3;
|
|
2913
|
-
}) => PromiseLike<
|
|
2918
|
+
}) => PromiseLike<EmbeddingModelV3CallOptions>;
|
|
2914
2919
|
/**
|
|
2915
2920
|
* Wraps the embed operation of the embedding model.
|
|
2916
2921
|
*
|
|
@@ -2923,7 +2928,7 @@ type EmbeddingModelV3Middleware = {
|
|
|
2923
2928
|
*/
|
|
2924
2929
|
wrapEmbed?: (options: {
|
|
2925
2930
|
doEmbed: () => ReturnType<EmbeddingModelV3['doEmbed']>;
|
|
2926
|
-
params:
|
|
2931
|
+
params: EmbeddingModelV3CallOptions;
|
|
2927
2932
|
model: EmbeddingModelV3;
|
|
2928
2933
|
}) => Promise<Awaited<ReturnType<EmbeddingModelV3['doEmbed']>>>;
|
|
2929
2934
|
};
|
|
@@ -3730,4 +3735,4 @@ interface ProviderV2 {
|
|
|
3730
3735
|
speechModel?(modelId: string): SpeechModelV2;
|
|
3731
3736
|
}
|
|
3732
3737
|
|
|
3733
|
-
export { AISDKError, APICallError, type
|
|
3738
|
+
export { AISDKError, APICallError, type EmbeddingModelV2, type EmbeddingModelV2Embedding, type EmbeddingModelV3, type EmbeddingModelV3CallOptions, type EmbeddingModelV3Embedding, type EmbeddingModelV3Middleware, type EmbeddingModelV3Result, EmptyResponseBodyError, type ImageModelV2, type ImageModelV2CallOptions, type ImageModelV2CallWarning, type ImageModelV2ProviderMetadata, type ImageModelV3, type ImageModelV3CallOptions, type ImageModelV3File, type ImageModelV3ProviderMetadata, type ImageModelV3Usage, InvalidArgumentError, InvalidPromptError, InvalidResponseDataError, type JSONArray, type JSONObject, JSONParseError, type JSONValue, type LanguageModelV2, type LanguageModelV2CallOptions, type LanguageModelV2CallWarning, type LanguageModelV2Content, type LanguageModelV2DataContent, type LanguageModelV2File, type LanguageModelV2FilePart, type LanguageModelV2FinishReason, type LanguageModelV2FunctionTool, type LanguageModelV2Message, type LanguageModelV2Middleware, type LanguageModelV2Prompt, type LanguageModelV2ProviderTool, type LanguageModelV2Reasoning, type LanguageModelV2ReasoningPart, type LanguageModelV2ResponseMetadata, type LanguageModelV2Source, type LanguageModelV2StreamPart, type LanguageModelV2Text, type LanguageModelV2TextPart, type LanguageModelV2ToolCall, type LanguageModelV2ToolCallPart, type LanguageModelV2ToolChoice, type LanguageModelV2ToolResultOutput, type LanguageModelV2ToolResultPart, type LanguageModelV2Usage, type LanguageModelV3, type LanguageModelV3CallOptions, type LanguageModelV3Content, type LanguageModelV3DataContent, type LanguageModelV3File, type LanguageModelV3FilePart, type LanguageModelV3FinishReason, type LanguageModelV3FunctionTool, type LanguageModelV3GenerateResult, type LanguageModelV3Message, type LanguageModelV3Middleware, type LanguageModelV3Prompt, type LanguageModelV3ProviderTool, type LanguageModelV3Reasoning, type LanguageModelV3ReasoningPart, type LanguageModelV3ResponseMetadata, type LanguageModelV3Source, type LanguageModelV3StreamPart, type LanguageModelV3StreamResult, type LanguageModelV3Text, type LanguageModelV3TextPart, type LanguageModelV3ToolApprovalRequest, type LanguageModelV3ToolApprovalResponsePart, type LanguageModelV3ToolCall, type LanguageModelV3ToolCallPart, type LanguageModelV3ToolChoice, type LanguageModelV3ToolResult, type LanguageModelV3ToolResultOutput, type LanguageModelV3ToolResultPart, type LanguageModelV3Usage, LoadAPIKeyError, LoadSettingError, NoContentGeneratedError, NoSuchModelError, type ProviderV2, type ProviderV3, type RerankingModelV3, type RerankingModelV3CallOptions, type SharedV2Headers, type SharedV2ProviderMetadata, type SharedV2ProviderOptions, type SharedV3Headers, type SharedV3ProviderMetadata, type SharedV3ProviderOptions, type SharedV3Warning, type SpeechModelV2, type SpeechModelV2CallOptions, type SpeechModelV2CallWarning, type SpeechModelV3, type SpeechModelV3CallOptions, TooManyEmbeddingValuesForCallError, type TranscriptionModelV2, type TranscriptionModelV2CallOptions, type TranscriptionModelV2CallWarning, type TranscriptionModelV3, type TranscriptionModelV3CallOptions, TypeValidationError, UnsupportedFunctionalityError, getErrorMessage, isJSONArray, isJSONObject, isJSONValue };
|
package/dist/index.d.ts
CHANGED
|
@@ -150,7 +150,7 @@ type SharedV2ProviderMetadata = Record<string, Record<string, JSONValue>>;
|
|
|
150
150
|
*/
|
|
151
151
|
type SharedV2ProviderOptions = Record<string, Record<string, JSONValue>>;
|
|
152
152
|
|
|
153
|
-
type
|
|
153
|
+
type EmbeddingModelV3CallOptions = {
|
|
154
154
|
/**
|
|
155
155
|
List of text values to generate embeddings for.
|
|
156
156
|
*/
|
|
@@ -178,6 +178,45 @@ It is e.g. used to represent a text as a vector of word embeddings.
|
|
|
178
178
|
*/
|
|
179
179
|
type EmbeddingModelV3Embedding = Array<number>;
|
|
180
180
|
|
|
181
|
+
/**
|
|
182
|
+
* The result of a embedding model doEmbed call.
|
|
183
|
+
*/
|
|
184
|
+
type EmbeddingModelV3Result = {
|
|
185
|
+
/**
|
|
186
|
+
* Generated embeddings. They are in the same order as the input values.
|
|
187
|
+
*/
|
|
188
|
+
embeddings: Array<EmbeddingModelV3Embedding>;
|
|
189
|
+
/**
|
|
190
|
+
* Token usage. We only have input tokens for embeddings.
|
|
191
|
+
*/
|
|
192
|
+
usage?: {
|
|
193
|
+
tokens: number;
|
|
194
|
+
};
|
|
195
|
+
/**
|
|
196
|
+
* Additional provider-specific metadata. They are passed through
|
|
197
|
+
* from the provider to the AI SDK and enable provider-specific
|
|
198
|
+
* results that can be fully encapsulated in the provider.
|
|
199
|
+
*/
|
|
200
|
+
providerMetadata?: SharedV3ProviderMetadata;
|
|
201
|
+
/**
|
|
202
|
+
* Optional response information for debugging purposes.
|
|
203
|
+
*/
|
|
204
|
+
response?: {
|
|
205
|
+
/**
|
|
206
|
+
* Response headers.
|
|
207
|
+
*/
|
|
208
|
+
headers?: SharedV3Headers;
|
|
209
|
+
/**
|
|
210
|
+
The response body.
|
|
211
|
+
*/
|
|
212
|
+
body?: unknown;
|
|
213
|
+
};
|
|
214
|
+
/**
|
|
215
|
+
* Warnings for the call, e.g. unsupported settings.
|
|
216
|
+
*/
|
|
217
|
+
warnings: Array<SharedV3Warning>;
|
|
218
|
+
};
|
|
219
|
+
|
|
181
220
|
/**
|
|
182
221
|
Specification for an embedding model that implements the embedding model
|
|
183
222
|
interface version 3.
|
|
@@ -217,41 +256,7 @@ type EmbeddingModelV3 = {
|
|
|
217
256
|
Naming: "do" prefix to prevent accidental direct usage of the method
|
|
218
257
|
by the user.
|
|
219
258
|
*/
|
|
220
|
-
doEmbed(options:
|
|
221
|
-
/**
|
|
222
|
-
Generated embeddings. They are in the same order as the input values.
|
|
223
|
-
*/
|
|
224
|
-
embeddings: Array<EmbeddingModelV3Embedding>;
|
|
225
|
-
/**
|
|
226
|
-
Token usage. We only have input tokens for embeddings.
|
|
227
|
-
*/
|
|
228
|
-
usage?: {
|
|
229
|
-
tokens: number;
|
|
230
|
-
};
|
|
231
|
-
/**
|
|
232
|
-
Additional provider-specific metadata. They are passed through
|
|
233
|
-
from the provider to the AI SDK and enable provider-specific
|
|
234
|
-
results that can be fully encapsulated in the provider.
|
|
235
|
-
*/
|
|
236
|
-
providerMetadata?: SharedV3ProviderMetadata;
|
|
237
|
-
/**
|
|
238
|
-
Optional response information for debugging purposes.
|
|
239
|
-
*/
|
|
240
|
-
response?: {
|
|
241
|
-
/**
|
|
242
|
-
Response headers.
|
|
243
|
-
*/
|
|
244
|
-
headers?: SharedV3Headers;
|
|
245
|
-
/**
|
|
246
|
-
The response body.
|
|
247
|
-
*/
|
|
248
|
-
body?: unknown;
|
|
249
|
-
};
|
|
250
|
-
/**
|
|
251
|
-
Warnings for the call, e.g. unsupported settings.
|
|
252
|
-
*/
|
|
253
|
-
warnings: Array<SharedV3Warning>;
|
|
254
|
-
}>;
|
|
259
|
+
doEmbed(options: EmbeddingModelV3CallOptions): PromiseLike<EmbeddingModelV3Result>;
|
|
255
260
|
};
|
|
256
261
|
|
|
257
262
|
/**
|
|
@@ -2908,9 +2913,9 @@ type EmbeddingModelV3Middleware = {
|
|
|
2908
2913
|
* @returns A promise that resolves to the transformed parameters.
|
|
2909
2914
|
*/
|
|
2910
2915
|
transformParams?: (options: {
|
|
2911
|
-
params:
|
|
2916
|
+
params: EmbeddingModelV3CallOptions;
|
|
2912
2917
|
model: EmbeddingModelV3;
|
|
2913
|
-
}) => PromiseLike<
|
|
2918
|
+
}) => PromiseLike<EmbeddingModelV3CallOptions>;
|
|
2914
2919
|
/**
|
|
2915
2920
|
* Wraps the embed operation of the embedding model.
|
|
2916
2921
|
*
|
|
@@ -2923,7 +2928,7 @@ type EmbeddingModelV3Middleware = {
|
|
|
2923
2928
|
*/
|
|
2924
2929
|
wrapEmbed?: (options: {
|
|
2925
2930
|
doEmbed: () => ReturnType<EmbeddingModelV3['doEmbed']>;
|
|
2926
|
-
params:
|
|
2931
|
+
params: EmbeddingModelV3CallOptions;
|
|
2927
2932
|
model: EmbeddingModelV3;
|
|
2928
2933
|
}) => Promise<Awaited<ReturnType<EmbeddingModelV3['doEmbed']>>>;
|
|
2929
2934
|
};
|
|
@@ -3730,4 +3735,4 @@ interface ProviderV2 {
|
|
|
3730
3735
|
speechModel?(modelId: string): SpeechModelV2;
|
|
3731
3736
|
}
|
|
3732
3737
|
|
|
3733
|
-
export { AISDKError, APICallError, type
|
|
3738
|
+
export { AISDKError, APICallError, type EmbeddingModelV2, type EmbeddingModelV2Embedding, type EmbeddingModelV3, type EmbeddingModelV3CallOptions, type EmbeddingModelV3Embedding, type EmbeddingModelV3Middleware, type EmbeddingModelV3Result, EmptyResponseBodyError, type ImageModelV2, type ImageModelV2CallOptions, type ImageModelV2CallWarning, type ImageModelV2ProviderMetadata, type ImageModelV3, type ImageModelV3CallOptions, type ImageModelV3File, type ImageModelV3ProviderMetadata, type ImageModelV3Usage, InvalidArgumentError, InvalidPromptError, InvalidResponseDataError, type JSONArray, type JSONObject, JSONParseError, type JSONValue, type LanguageModelV2, type LanguageModelV2CallOptions, type LanguageModelV2CallWarning, type LanguageModelV2Content, type LanguageModelV2DataContent, type LanguageModelV2File, type LanguageModelV2FilePart, type LanguageModelV2FinishReason, type LanguageModelV2FunctionTool, type LanguageModelV2Message, type LanguageModelV2Middleware, type LanguageModelV2Prompt, type LanguageModelV2ProviderTool, type LanguageModelV2Reasoning, type LanguageModelV2ReasoningPart, type LanguageModelV2ResponseMetadata, type LanguageModelV2Source, type LanguageModelV2StreamPart, type LanguageModelV2Text, type LanguageModelV2TextPart, type LanguageModelV2ToolCall, type LanguageModelV2ToolCallPart, type LanguageModelV2ToolChoice, type LanguageModelV2ToolResultOutput, type LanguageModelV2ToolResultPart, type LanguageModelV2Usage, type LanguageModelV3, type LanguageModelV3CallOptions, type LanguageModelV3Content, type LanguageModelV3DataContent, type LanguageModelV3File, type LanguageModelV3FilePart, type LanguageModelV3FinishReason, type LanguageModelV3FunctionTool, type LanguageModelV3GenerateResult, type LanguageModelV3Message, type LanguageModelV3Middleware, type LanguageModelV3Prompt, type LanguageModelV3ProviderTool, type LanguageModelV3Reasoning, type LanguageModelV3ReasoningPart, type LanguageModelV3ResponseMetadata, type LanguageModelV3Source, type LanguageModelV3StreamPart, type LanguageModelV3StreamResult, type LanguageModelV3Text, type LanguageModelV3TextPart, type LanguageModelV3ToolApprovalRequest, type LanguageModelV3ToolApprovalResponsePart, type LanguageModelV3ToolCall, type LanguageModelV3ToolCallPart, type LanguageModelV3ToolChoice, type LanguageModelV3ToolResult, type LanguageModelV3ToolResultOutput, type LanguageModelV3ToolResultPart, type LanguageModelV3Usage, LoadAPIKeyError, LoadSettingError, NoContentGeneratedError, NoSuchModelError, type ProviderV2, type ProviderV3, type RerankingModelV3, type RerankingModelV3CallOptions, type SharedV2Headers, type SharedV2ProviderMetadata, type SharedV2ProviderOptions, type SharedV3Headers, type SharedV3ProviderMetadata, type SharedV3ProviderOptions, type SharedV3Warning, type SpeechModelV2, type SpeechModelV2CallOptions, type SpeechModelV2CallWarning, type SpeechModelV3, type SpeechModelV3CallOptions, TooManyEmbeddingValuesForCallError, type TranscriptionModelV2, type TranscriptionModelV2CallOptions, type TranscriptionModelV2CallWarning, type TranscriptionModelV3, type TranscriptionModelV3CallOptions, TypeValidationError, UnsupportedFunctionalityError, getErrorMessage, isJSONArray, isJSONObject, isJSONValue };
|