@fairyhunter13/ai-sdk 6.0.116-fork.18 → 6.0.116-fork.19
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 +35 -0
- package/dist/index.d.mts +197 -117
- package/dist/index.d.ts +197 -117
- package/dist/index.js +367 -241
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +367 -241
- package/dist/index.mjs.map +1 -1
- package/dist/internal/index.js +2 -2
- package/dist/internal/index.js.map +1 -1
- package/dist/internal/index.mjs +2 -2
- package/dist/internal/index.mjs.map +1 -1
- package/package.json +2 -2
- package/src/error/invalid-stream-part-error.ts +3 -3
- package/src/generate-text/content-part.ts +1 -1
- package/src/generate-text/create-execute-tools-transformation.ts +47 -61
- package/src/generate-text/index.ts +4 -1
- package/src/generate-text/invoke-tool-callbacks-from-stream.ts +3 -3
- package/src/generate-text/stream-model-call.ts +307 -16
- package/src/generate-text/stream-text-result.ts +1 -1
- package/src/generate-text/stream-text.ts +5 -6
- package/src/prompt/content-part.ts +1 -1
- package/src/rerank/index.ts +6 -1
- package/src/rerank/rerank-events.ts +69 -0
- package/src/rerank/rerank.ts +109 -131
- package/src/telemetry/get-global-telemetry-integration.ts +8 -0
- package/src/telemetry/open-telemetry-integration.ts +162 -2
- package/src/telemetry/telemetry-integration.ts +24 -2
- package/src/ui/ui-messages.ts +2 -2
- package/src/ui-message-stream/ui-message-chunks.ts +2 -2
- package/src/generate-text/create-stream-text-part-transform.ts +0 -240
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,40 @@
|
|
|
1
1
|
# ai
|
|
2
2
|
|
|
3
|
+
## 7.0.0-beta.42
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- a3fd75b: feat(ai): expose Experimental_ModelCallStreamPart type
|
|
8
|
+
|
|
9
|
+
## 7.0.0-beta.41
|
|
10
|
+
|
|
11
|
+
### Patch Changes
|
|
12
|
+
|
|
13
|
+
- Updated dependencies [7ceff62]
|
|
14
|
+
- @ai-sdk/gateway@4.0.0-beta.22
|
|
15
|
+
|
|
16
|
+
## 7.0.0-beta.40
|
|
17
|
+
|
|
18
|
+
### Patch Changes
|
|
19
|
+
|
|
20
|
+
- 989d3d2: fix(ai): include generated files in OTEL response attributes
|
|
21
|
+
|
|
22
|
+
## 7.0.0-beta.39
|
|
23
|
+
|
|
24
|
+
### Patch Changes
|
|
25
|
+
|
|
26
|
+
- f4cfccd: feat(ai): decouple otel from rerank function
|
|
27
|
+
|
|
28
|
+
## 7.0.0-beta.38
|
|
29
|
+
|
|
30
|
+
### Patch Changes
|
|
31
|
+
|
|
32
|
+
- 1f509d4: fix(ai): force template check on 'kind' param
|
|
33
|
+
- Updated dependencies [1f509d4]
|
|
34
|
+
- @ai-sdk/provider-utils@5.0.0-beta.7
|
|
35
|
+
- @ai-sdk/provider@4.0.0-beta.5
|
|
36
|
+
- @ai-sdk/gateway@4.0.0-beta.21
|
|
37
|
+
|
|
3
38
|
## 7.0.0-beta.37
|
|
4
39
|
|
|
5
40
|
### Patch Changes
|
package/dist/index.d.mts
CHANGED
|
@@ -4,7 +4,7 @@ import * as _ai_sdk_provider_utils from '@ai-sdk/provider-utils';
|
|
|
4
4
|
import { Tool, InferToolInput, InferToolOutput, FlexibleSchema, InferSchema, SystemModelMessage, ModelMessage, AssistantModelMessage, ToolModelMessage, ReasoningPart, ReasoningFilePart, ProviderOptions, UserModelMessage, IdGenerator, ToolCall, MaybePromiseLike, TextPart, FilePart, Resolvable, FetchFunction, DataContent } from '@ai-sdk/provider-utils';
|
|
5
5
|
export { AssistantContent, AssistantModelMessage, DataContent, DownloadError, FilePart, FlexibleSchema, IdGenerator, ImagePart, InferSchema, InferToolInput, InferToolOutput, ModelMessage, Schema, SystemModelMessage, TextPart, Tool, ToolApprovalRequest, ToolApprovalResponse, ToolCallOptions, ToolCallPart, ToolContent, ToolExecuteFunction, ToolExecutionOptions, ToolModelMessage, ToolResultPart, UserContent, UserModelMessage, asSchema, createIdGenerator, dynamicTool, generateId, jsonSchema, parseJsonEventStream, tool, zodSchema } from '@ai-sdk/provider-utils';
|
|
6
6
|
import * as _ai_sdk_provider from '@ai-sdk/provider';
|
|
7
|
-
import { EmbeddingModelV4, EmbeddingModelV3, EmbeddingModelV2, EmbeddingModelV4Embedding, EmbeddingModelV4Middleware, ImageModelV4, ImageModelV3, ImageModelV2, ImageModelV4ProviderMetadata, ImageModelV2ProviderMetadata, ImageModelV4Middleware, JSONValue as JSONValue$1, LanguageModelV4, LanguageModelV3, LanguageModelV2, SharedV4Warning, LanguageModelV4Source, LanguageModelV4Middleware, RerankingModelV4, RerankingModelV3, SharedV4ProviderMetadata, SpeechModelV4, SpeechModelV3, SpeechModelV2, TranscriptionModelV4, TranscriptionModelV3, TranscriptionModelV2, JSONObject, ImageModelV4Usage, LanguageModelV4CallOptions, AISDKError, LanguageModelV4ToolCall, JSONSchema7,
|
|
7
|
+
import { EmbeddingModelV4, EmbeddingModelV3, EmbeddingModelV2, EmbeddingModelV4Embedding, EmbeddingModelV4Middleware, ImageModelV4, ImageModelV3, ImageModelV2, ImageModelV4ProviderMetadata, ImageModelV2ProviderMetadata, ImageModelV4Middleware, JSONValue as JSONValue$1, LanguageModelV4, LanguageModelV3, LanguageModelV2, SharedV4Warning, LanguageModelV4Source, LanguageModelV4Middleware, RerankingModelV4, RerankingModelV3, SharedV4ProviderMetadata, SpeechModelV4, SpeechModelV3, SpeechModelV2, TranscriptionModelV4, TranscriptionModelV3, TranscriptionModelV2, JSONObject, ImageModelV4Usage, LanguageModelV4CallOptions, AISDKError, LanguageModelV4ToolCall, JSONSchema7, LanguageModelV4Prompt, SharedV4Headers, LanguageModelV4ToolChoice, JSONParseError, TypeValidationError, Experimental_VideoModelV4, Experimental_VideoModelV3, EmbeddingModelV4CallOptions, ProviderV4, ProviderV3, ProviderV2, NoSuchModelError } from '@ai-sdk/provider';
|
|
8
8
|
export { AISDKError, APICallError, EmptyResponseBodyError, InvalidPromptError, InvalidResponseDataError, JSONParseError, JSONSchema7, LoadAPIKeyError, LoadSettingError, NoContentGeneratedError, NoSuchModelError, TooManyEmbeddingValuesForCallError, TypeValidationError, UnsupportedFunctionalityError } from '@ai-sdk/provider';
|
|
9
9
|
import { Tracer } from '@opentelemetry/api';
|
|
10
10
|
import { ServerResponse } from 'node:http';
|
|
@@ -589,7 +589,7 @@ type ContentPart<TOOLS extends ToolSet> = {
|
|
|
589
589
|
providerMetadata?: ProviderMetadata;
|
|
590
590
|
} | {
|
|
591
591
|
type: 'custom';
|
|
592
|
-
kind: string
|
|
592
|
+
kind: `${string}.${string}`;
|
|
593
593
|
providerMetadata?: ProviderMetadata;
|
|
594
594
|
} | ReasoningOutput | ReasoningFileOutput | ({
|
|
595
595
|
type: 'source';
|
|
@@ -1377,21 +1377,38 @@ declare function smoothStream<TOOLS extends ToolSet>({ delayInMs, chunking, _int
|
|
|
1377
1377
|
tools: TOOLS;
|
|
1378
1378
|
}) => TransformStream<TextStreamPart<TOOLS>, TextStreamPart<TOOLS>>;
|
|
1379
1379
|
|
|
1380
|
-
|
|
1380
|
+
/**
|
|
1381
|
+
* A type that combines AsyncIterable and ReadableStream.
|
|
1382
|
+
* This allows a ReadableStream to be consumed using for-await-of syntax.
|
|
1383
|
+
*/
|
|
1384
|
+
type AsyncIterableStream<T> = AsyncIterable<T> & ReadableStream<T>;
|
|
1385
|
+
|
|
1386
|
+
type ModelCallStreamPart<TOOLS extends ToolSet = ToolSet> = Exclude<TextStreamPart<TOOLS>, {
|
|
1381
1387
|
type: 'finish' | 'stream-start' | 'tool-output-denied' | 'start-step' | 'finish-step' | 'start' | 'abort';
|
|
1382
1388
|
}> | TextStreamTextDeltaPart | TextStreamReasoningDeltaPart | TextStreamFilePart | TextStreamReasoningFilePart | TextStreamToolApprovalRequestPart<TOOLS> | TextStreamToolCallPart<TOOLS> | TextStreamToolResultPart<TOOLS> | TextStreamToolErrorPart<TOOLS> | {
|
|
1383
|
-
type: '
|
|
1389
|
+
type: 'model-call-end';
|
|
1384
1390
|
finishReason: FinishReason;
|
|
1385
1391
|
rawFinishReason: string | undefined;
|
|
1386
1392
|
usage: LanguageModelUsage;
|
|
1387
1393
|
providerMetadata?: ProviderMetadata;
|
|
1388
1394
|
} | {
|
|
1389
|
-
type: '
|
|
1390
|
-
warnings: Array<
|
|
1391
|
-
} |
|
|
1392
|
-
type: 'response-metadata';
|
|
1393
|
-
|
|
1394
|
-
|
|
1395
|
+
type: 'model-call-start';
|
|
1396
|
+
warnings: Array<CallWarning>;
|
|
1397
|
+
} | {
|
|
1398
|
+
type: 'model-call-response-metadata';
|
|
1399
|
+
/**
|
|
1400
|
+
* ID for the generated response, if the provider sends one.
|
|
1401
|
+
*/
|
|
1402
|
+
id?: string;
|
|
1403
|
+
/**
|
|
1404
|
+
* Timestamp for the start of the generated response, if the provider sends one.
|
|
1405
|
+
*/
|
|
1406
|
+
timestamp?: Date;
|
|
1407
|
+
/**
|
|
1408
|
+
* The ID of the response model that was used to generate the response, if the provider sends one.
|
|
1409
|
+
*/
|
|
1410
|
+
modelId?: string;
|
|
1411
|
+
};
|
|
1395
1412
|
declare function streamModelCall<TOOLS extends ToolSet, OUTPUT extends Output = Output>({ model, tools, output, toolChoice, activeTools, prompt, system, messages, download, maxRetries, abortSignal, headers, includeRawChunks, providerOptions, repairToolCall, onStart, ...callSettings }: {
|
|
1396
1413
|
model: LanguageModel;
|
|
1397
1414
|
tools?: TOOLS;
|
|
@@ -1407,13 +1424,19 @@ declare function streamModelCall<TOOLS extends ToolSet, OUTPUT extends Output =
|
|
|
1407
1424
|
promptMessages: LanguageModelV4Prompt;
|
|
1408
1425
|
}) => Promise<void> | void;
|
|
1409
1426
|
} & Prompt & CallSettings): Promise<{
|
|
1410
|
-
stream: AsyncIterableStream<
|
|
1411
|
-
|
|
1412
|
-
|
|
1413
|
-
|
|
1414
|
-
|
|
1427
|
+
stream: AsyncIterableStream<ModelCallStreamPart<TOOLS>>;
|
|
1428
|
+
request?: {
|
|
1429
|
+
/**
|
|
1430
|
+
* Request HTTP body that was sent to the provider API.
|
|
1431
|
+
*/
|
|
1415
1432
|
body?: unknown;
|
|
1416
|
-
}
|
|
1433
|
+
};
|
|
1434
|
+
response?: {
|
|
1435
|
+
/**
|
|
1436
|
+
* Response headers.
|
|
1437
|
+
*/
|
|
1438
|
+
headers?: SharedV4Headers;
|
|
1439
|
+
};
|
|
1417
1440
|
}>;
|
|
1418
1441
|
|
|
1419
1442
|
/**
|
|
@@ -1508,9 +1531,9 @@ type TextUIPart = {
|
|
|
1508
1531
|
type CustomContentUIPart = {
|
|
1509
1532
|
type: 'custom';
|
|
1510
1533
|
/**
|
|
1511
|
-
* The kind of custom content, in the format `{provider}
|
|
1534
|
+
* The kind of custom content, in the format `{provider}.{provider-type}`.
|
|
1512
1535
|
*/
|
|
1513
|
-
kind: string
|
|
1536
|
+
kind: `${string}.${string}`;
|
|
1514
1537
|
/**
|
|
1515
1538
|
* The provider metadata.
|
|
1516
1539
|
*/
|
|
@@ -1953,7 +1976,7 @@ declare const uiMessageChunkSchema: _ai_sdk_provider_utils.LazySchema<{
|
|
|
1953
1976
|
providerMetadata?: _ai_sdk_provider.SharedV4ProviderMetadata | undefined;
|
|
1954
1977
|
} | {
|
|
1955
1978
|
type: "custom";
|
|
1956
|
-
kind: string
|
|
1979
|
+
kind: `${string}.${string}`;
|
|
1957
1980
|
providerMetadata?: _ai_sdk_provider.SharedV4ProviderMetadata | undefined;
|
|
1958
1981
|
} | {
|
|
1959
1982
|
type: "source-url";
|
|
@@ -2038,7 +2061,7 @@ type UIMessageChunk<METADATA = unknown, DATA_TYPES extends UIDataTypes = UIDataT
|
|
|
2038
2061
|
providerMetadata?: ProviderMetadata;
|
|
2039
2062
|
} | {
|
|
2040
2063
|
type: 'custom';
|
|
2041
|
-
kind: string
|
|
2064
|
+
kind: `${string}.${string}`;
|
|
2042
2065
|
providerMetadata?: ProviderMetadata;
|
|
2043
2066
|
} | {
|
|
2044
2067
|
type: 'error';
|
|
@@ -2180,12 +2203,6 @@ type UIMessageStreamResponseInit = ResponseInit & {
|
|
|
2180
2203
|
}) => PromiseLike<void> | void;
|
|
2181
2204
|
};
|
|
2182
2205
|
|
|
2183
|
-
/**
|
|
2184
|
-
* A type that combines AsyncIterable and ReadableStream.
|
|
2185
|
-
* This allows a ReadableStream to be consumed using for-await-of syntax.
|
|
2186
|
-
*/
|
|
2187
|
-
type AsyncIterableStream<T> = AsyncIterable<T> & ReadableStream<T>;
|
|
2188
|
-
|
|
2189
2206
|
type ErrorHandler = (error: unknown) => void;
|
|
2190
2207
|
|
|
2191
2208
|
type UIMessageStreamOptions<UI_MESSAGE extends UIMessage> = {
|
|
@@ -2495,7 +2512,7 @@ type TextStreamReasoningDeltaPart = {
|
|
|
2495
2512
|
};
|
|
2496
2513
|
type TextStreamCustomPart = {
|
|
2497
2514
|
type: 'custom';
|
|
2498
|
-
kind: string
|
|
2515
|
+
kind: `${string}.${string}`;
|
|
2499
2516
|
providerMetadata?: ProviderMetadata;
|
|
2500
2517
|
};
|
|
2501
2518
|
type TextStreamToolInputStartPart = {
|
|
@@ -2982,6 +2999,144 @@ interface EmbedFinishEvent {
|
|
|
2982
2999
|
readonly usage: EmbeddingModelUsage;
|
|
2983
3000
|
}
|
|
2984
3001
|
|
|
3002
|
+
/**
|
|
3003
|
+
* Event passed to the `onStart` callback for rerank operations.
|
|
3004
|
+
*
|
|
3005
|
+
* Called when the operation begins, before the reranking model is called.
|
|
3006
|
+
*/
|
|
3007
|
+
interface RerankOnStartEvent {
|
|
3008
|
+
/** Unique identifier for this rerank call, used to correlate events. */
|
|
3009
|
+
readonly callId: string;
|
|
3010
|
+
/** Identifies the operation type ('ai.rerank'). */
|
|
3011
|
+
readonly operationId: string;
|
|
3012
|
+
readonly provider: string;
|
|
3013
|
+
/** The specific model identifier (e.g., 'gpt-4o'). */
|
|
3014
|
+
readonly modelId: string;
|
|
3015
|
+
/** The documents being reranked. */
|
|
3016
|
+
readonly documents: Array<JSONObject | string>;
|
|
3017
|
+
/** The query to rerank the documents against. */
|
|
3018
|
+
readonly query: string;
|
|
3019
|
+
/** Number of top documents to return. */
|
|
3020
|
+
readonly topN: number | undefined;
|
|
3021
|
+
/** Maximum number of retries for failed requests. */
|
|
3022
|
+
readonly maxRetries: number;
|
|
3023
|
+
/** Abort signal for cancelling the operation. */
|
|
3024
|
+
readonly abortSignal: AbortSignal | undefined;
|
|
3025
|
+
/** Additional HTTP headers sent with the request. */
|
|
3026
|
+
readonly headers: Record<string, string | undefined> | undefined;
|
|
3027
|
+
/** Additional provider-specific options. */
|
|
3028
|
+
readonly providerOptions: ProviderOptions | undefined;
|
|
3029
|
+
/** Whether telemetry is enabled. */
|
|
3030
|
+
readonly isEnabled: boolean | undefined;
|
|
3031
|
+
/** Whether to record inputs in telemetry. Enabled by default. */
|
|
3032
|
+
readonly recordInputs: boolean | undefined;
|
|
3033
|
+
/** Whether to record outputs in telemetry. Enabled by default. */
|
|
3034
|
+
readonly recordOutputs: boolean | undefined;
|
|
3035
|
+
/** Identifier from telemetry settings for grouping related operations. */
|
|
3036
|
+
readonly functionId: string | undefined;
|
|
3037
|
+
/** Additional metadata from telemetry settings. */
|
|
3038
|
+
readonly metadata: Record<string, JSONValue$1> | undefined;
|
|
3039
|
+
}
|
|
3040
|
+
/**
|
|
3041
|
+
* Event passed to the `onFinish` callback for rerank operations.
|
|
3042
|
+
*
|
|
3043
|
+
* Called when the operation completes, after the reranking model returns.
|
|
3044
|
+
*/
|
|
3045
|
+
interface RerankOnFinishEvent {
|
|
3046
|
+
/** Unique identifier for this rerank call, used to correlate events. */
|
|
3047
|
+
readonly callId: string;
|
|
3048
|
+
/** Identifies the operation type ('ai.rerank'). */
|
|
3049
|
+
readonly operationId: string;
|
|
3050
|
+
readonly provider: string;
|
|
3051
|
+
/** The specific model identifier (e.g., 'gpt-4o'). */
|
|
3052
|
+
readonly modelId: string;
|
|
3053
|
+
/** The documents that were reranked. */
|
|
3054
|
+
readonly documents: Array<JSONObject | string>;
|
|
3055
|
+
/** The query that documents were reranked against. */
|
|
3056
|
+
readonly query: string;
|
|
3057
|
+
/** The reranked results sorted by relevance score in descending order. */
|
|
3058
|
+
readonly ranking: Array<{
|
|
3059
|
+
originalIndex: number;
|
|
3060
|
+
score: number;
|
|
3061
|
+
document: JSONObject | string;
|
|
3062
|
+
}>;
|
|
3063
|
+
/** Warnings from the reranking model. */
|
|
3064
|
+
readonly warnings: Array<Warning>;
|
|
3065
|
+
/** Optional provider-specific metadata. */
|
|
3066
|
+
readonly providerMetadata: ProviderMetadata | undefined;
|
|
3067
|
+
/** Response data including headers and body. */
|
|
3068
|
+
readonly response: {
|
|
3069
|
+
id?: string;
|
|
3070
|
+
timestamp: Date;
|
|
3071
|
+
modelId: string;
|
|
3072
|
+
headers?: Record<string, string>;
|
|
3073
|
+
body?: unknown;
|
|
3074
|
+
};
|
|
3075
|
+
/** Whether telemetry is enabled. */
|
|
3076
|
+
readonly isEnabled: boolean | undefined;
|
|
3077
|
+
/** Whether to record inputs in telemetry. Enabled by default. */
|
|
3078
|
+
readonly recordInputs: boolean | undefined;
|
|
3079
|
+
/** Whether to record outputs in telemetry. Enabled by default. */
|
|
3080
|
+
readonly recordOutputs: boolean | undefined;
|
|
3081
|
+
/** Identifier from telemetry settings for grouping related operations. */
|
|
3082
|
+
readonly functionId: string | undefined;
|
|
3083
|
+
/** Additional metadata from telemetry settings. */
|
|
3084
|
+
readonly metadata: Record<string, JSONValue$1> | undefined;
|
|
3085
|
+
}
|
|
3086
|
+
/**
|
|
3087
|
+
* Event fired when an individual reranking model call (inner doRerank) begins.
|
|
3088
|
+
*/
|
|
3089
|
+
interface RerankStartEvent {
|
|
3090
|
+
/** Unique identifier for this rerank call, used to correlate events. */
|
|
3091
|
+
readonly callId: string;
|
|
3092
|
+
/** Identifies the inner operation ('ai.rerank.doRerank'). */
|
|
3093
|
+
readonly operationId: string;
|
|
3094
|
+
/** The provider identifier. */
|
|
3095
|
+
readonly provider: string;
|
|
3096
|
+
/** The specific model identifier. */
|
|
3097
|
+
readonly modelId: string;
|
|
3098
|
+
/** The documents being reranked. */
|
|
3099
|
+
readonly documents: Array<JSONObject | string>;
|
|
3100
|
+
/** The type of documents ('text' or 'object'). */
|
|
3101
|
+
readonly documentsType: string;
|
|
3102
|
+
/** The query to rerank against. */
|
|
3103
|
+
readonly query: string;
|
|
3104
|
+
/** Number of top documents to return. */
|
|
3105
|
+
readonly topN: number | undefined;
|
|
3106
|
+
/** Whether telemetry is enabled. */
|
|
3107
|
+
readonly isEnabled: boolean | undefined;
|
|
3108
|
+
/** Whether to record inputs in telemetry. Enabled by default. */
|
|
3109
|
+
readonly recordInputs: boolean | undefined;
|
|
3110
|
+
/** Whether to record outputs in telemetry. Enabled by default. */
|
|
3111
|
+
readonly recordOutputs: boolean | undefined;
|
|
3112
|
+
/** Identifier from telemetry settings for grouping related operations. */
|
|
3113
|
+
readonly functionId: string | undefined;
|
|
3114
|
+
/** Additional metadata from telemetry settings. */
|
|
3115
|
+
readonly metadata: Record<string, JSONValue$1> | undefined;
|
|
3116
|
+
}
|
|
3117
|
+
/**
|
|
3118
|
+
* Event fired when an individual reranking model call (doRerank) completes.
|
|
3119
|
+
*
|
|
3120
|
+
* Contains the ranking results from the model response.
|
|
3121
|
+
*/
|
|
3122
|
+
interface RerankFinishEvent {
|
|
3123
|
+
/** Unique identifier for this rerank call, used to correlate events. */
|
|
3124
|
+
readonly callId: string;
|
|
3125
|
+
/** Identifies the inner operation ('ai.rerank.doRerank'). */
|
|
3126
|
+
readonly operationId: string;
|
|
3127
|
+
/** The provider identifier. */
|
|
3128
|
+
readonly provider: string;
|
|
3129
|
+
/** The specific model identifier. */
|
|
3130
|
+
readonly modelId: string;
|
|
3131
|
+
/** The type of documents ('text' or 'object'). */
|
|
3132
|
+
readonly documentsType: string;
|
|
3133
|
+
/** The ranking results from the model. */
|
|
3134
|
+
readonly ranking: Array<{
|
|
3135
|
+
index: number;
|
|
3136
|
+
relevanceScore: number;
|
|
3137
|
+
}>;
|
|
3138
|
+
}
|
|
3139
|
+
|
|
2985
3140
|
/**
|
|
2986
3141
|
* A callback function that can be used to notify listeners.
|
|
2987
3142
|
*/
|
|
@@ -2998,7 +3153,7 @@ interface TelemetryIntegration {
|
|
|
2998
3153
|
*
|
|
2999
3154
|
* Use the `operationId` field to distinguish between operation types.
|
|
3000
3155
|
*/
|
|
3001
|
-
onStart?: Listener<OnStartEvent<ToolSet, Output> | EmbedOnStartEvent>;
|
|
3156
|
+
onStart?: Listener<OnStartEvent<ToolSet, Output> | EmbedOnStartEvent | RerankOnStartEvent>;
|
|
3002
3157
|
/**
|
|
3003
3158
|
* Called when an individual step (single LLM invocation) begins.
|
|
3004
3159
|
* A generation may consist of multiple steps (e.g. when tool calls trigger
|
|
@@ -3045,13 +3200,23 @@ interface TelemetryIntegration {
|
|
|
3045
3200
|
* Contains the embeddings, usage, and any warnings from the model response.
|
|
3046
3201
|
*/
|
|
3047
3202
|
onEmbedFinish?: Listener<EmbedFinishEvent>;
|
|
3203
|
+
/**
|
|
3204
|
+
* Called when an individual reranking model call (doRerank) begins.
|
|
3205
|
+
* There is one call per `rerank` invocation.
|
|
3206
|
+
*/
|
|
3207
|
+
onRerankStart?: Listener<RerankStartEvent>;
|
|
3208
|
+
/**
|
|
3209
|
+
* Called when an individual reranking model call (doRerank) completes.
|
|
3210
|
+
* Contains the ranking results from the model response.
|
|
3211
|
+
*/
|
|
3212
|
+
onRerankFinish?: Listener<RerankFinishEvent>;
|
|
3048
3213
|
/**
|
|
3049
3214
|
* Called when an operation completes. Fired for both text generation
|
|
3050
3215
|
* (generateText/streamText) and embedding (embed/embedMany) operations.
|
|
3051
3216
|
*
|
|
3052
3217
|
* Use the event shape or `operationId` to distinguish between operation types.
|
|
3053
3218
|
*/
|
|
3054
|
-
onFinish?: Listener<OnFinishEvent<ToolSet> | EmbedOnFinishEvent>;
|
|
3219
|
+
onFinish?: Listener<OnFinishEvent<ToolSet> | EmbedOnFinishEvent | RerankOnFinishEvent>;
|
|
3055
3220
|
/**
|
|
3056
3221
|
* Called when an unrecoverable error occurs during the generation lifecycle.
|
|
3057
3222
|
* The error value is untyped — it may be an `Error` instance, an `AISDKError`,
|
|
@@ -5051,9 +5216,9 @@ declare class InvalidArgumentError extends AISDKError {
|
|
|
5051
5216
|
declare const symbol$g: unique symbol;
|
|
5052
5217
|
declare class InvalidStreamPartError extends AISDKError {
|
|
5053
5218
|
private readonly [symbol$g];
|
|
5054
|
-
readonly chunk:
|
|
5219
|
+
readonly chunk: ModelCallStreamPart<any>;
|
|
5055
5220
|
constructor({ chunk, message, }: {
|
|
5056
|
-
chunk:
|
|
5221
|
+
chunk: ModelCallStreamPart<any>;
|
|
5057
5222
|
message: string;
|
|
5058
5223
|
});
|
|
5059
5224
|
static isInstance(error: unknown): error is InvalidStreamPartError;
|
|
@@ -6547,91 +6712,6 @@ declare function createProviderRegistry<PROVIDERS extends Record<string, Provide
|
|
|
6547
6712
|
*/
|
|
6548
6713
|
declare const experimental_createProviderRegistry: typeof createProviderRegistry;
|
|
6549
6714
|
|
|
6550
|
-
/**
|
|
6551
|
-
* Event passed to the `onStart` callback for rerank operations.
|
|
6552
|
-
*
|
|
6553
|
-
* Called when the operation begins, before the reranking model is called.
|
|
6554
|
-
*/
|
|
6555
|
-
interface RerankOnStartEvent {
|
|
6556
|
-
/** Unique identifier for this rerank call, used to correlate events. */
|
|
6557
|
-
readonly callId: string;
|
|
6558
|
-
/** Identifies the operation type ('ai.rerank'). */
|
|
6559
|
-
readonly operationId: string;
|
|
6560
|
-
readonly provider: string;
|
|
6561
|
-
/** The specific model identifier (e.g., 'gpt-4o'). */
|
|
6562
|
-
readonly modelId: string;
|
|
6563
|
-
/** The documents being reranked. */
|
|
6564
|
-
readonly documents: Array<JSONObject | string>;
|
|
6565
|
-
/** The query to rerank the documents against. */
|
|
6566
|
-
readonly query: string;
|
|
6567
|
-
/** Number of top documents to return. */
|
|
6568
|
-
readonly topN: number | undefined;
|
|
6569
|
-
/** Maximum number of retries for failed requests. */
|
|
6570
|
-
readonly maxRetries: number;
|
|
6571
|
-
/** Abort signal for cancelling the operation. */
|
|
6572
|
-
readonly abortSignal: AbortSignal | undefined;
|
|
6573
|
-
/** Additional HTTP headers sent with the request. */
|
|
6574
|
-
readonly headers: Record<string, string | undefined> | undefined;
|
|
6575
|
-
/** Additional provider-specific options. */
|
|
6576
|
-
readonly providerOptions: ProviderOptions | undefined;
|
|
6577
|
-
/** Whether telemetry is enabled. */
|
|
6578
|
-
readonly isEnabled: boolean | undefined;
|
|
6579
|
-
/** Whether to record inputs in telemetry. Enabled by default. */
|
|
6580
|
-
readonly recordInputs: boolean | undefined;
|
|
6581
|
-
/** Whether to record outputs in telemetry. Enabled by default. */
|
|
6582
|
-
readonly recordOutputs: boolean | undefined;
|
|
6583
|
-
/** Identifier from telemetry settings for grouping related operations. */
|
|
6584
|
-
readonly functionId: string | undefined;
|
|
6585
|
-
/** Additional metadata from telemetry settings. */
|
|
6586
|
-
readonly metadata: Record<string, JSONValue$1> | undefined;
|
|
6587
|
-
}
|
|
6588
|
-
/**
|
|
6589
|
-
* Event passed to the `onFinish` callback for rerank operations.
|
|
6590
|
-
*
|
|
6591
|
-
* Called when the operation completes, after the reranking model returns.
|
|
6592
|
-
*/
|
|
6593
|
-
interface RerankOnFinishEvent {
|
|
6594
|
-
/** Unique identifier for this rerank call, used to correlate events. */
|
|
6595
|
-
readonly callId: string;
|
|
6596
|
-
/** Identifies the operation type ('ai.rerank'). */
|
|
6597
|
-
readonly operationId: string;
|
|
6598
|
-
readonly provider: string;
|
|
6599
|
-
/** The specific model identifier (e.g., 'gpt-4o'). */
|
|
6600
|
-
readonly modelId: string;
|
|
6601
|
-
/** The documents that were reranked. */
|
|
6602
|
-
readonly documents: Array<JSONObject | string>;
|
|
6603
|
-
/** The query that documents were reranked against. */
|
|
6604
|
-
readonly query: string;
|
|
6605
|
-
/** The reranked results sorted by relevance score in descending order. */
|
|
6606
|
-
readonly ranking: Array<{
|
|
6607
|
-
originalIndex: number;
|
|
6608
|
-
score: number;
|
|
6609
|
-
document: JSONObject | string;
|
|
6610
|
-
}>;
|
|
6611
|
-
/** Warnings from the reranking model. */
|
|
6612
|
-
readonly warnings: Array<Warning>;
|
|
6613
|
-
/** Optional provider-specific metadata. */
|
|
6614
|
-
readonly providerMetadata: ProviderMetadata | undefined;
|
|
6615
|
-
/** Response data including headers and body. */
|
|
6616
|
-
readonly response: {
|
|
6617
|
-
id?: string;
|
|
6618
|
-
timestamp: Date;
|
|
6619
|
-
modelId: string;
|
|
6620
|
-
headers?: Record<string, string>;
|
|
6621
|
-
body?: unknown;
|
|
6622
|
-
};
|
|
6623
|
-
/** Whether telemetry is enabled. */
|
|
6624
|
-
readonly isEnabled: boolean | undefined;
|
|
6625
|
-
/** Whether to record inputs in telemetry. Enabled by default. */
|
|
6626
|
-
readonly recordInputs: boolean | undefined;
|
|
6627
|
-
/** Whether to record outputs in telemetry. Enabled by default. */
|
|
6628
|
-
readonly recordOutputs: boolean | undefined;
|
|
6629
|
-
/** Identifier from telemetry settings for grouping related operations. */
|
|
6630
|
-
readonly functionId: string | undefined;
|
|
6631
|
-
/** Additional metadata from telemetry settings. */
|
|
6632
|
-
readonly metadata: Record<string, JSONValue$1> | undefined;
|
|
6633
|
-
}
|
|
6634
|
-
|
|
6635
6715
|
/**
|
|
6636
6716
|
* The result of a `rerank` call.
|
|
6637
6717
|
* It contains the original documents, the reranked documents, and additional information.
|
|
@@ -6949,4 +7029,4 @@ declare global {
|
|
|
6949
7029
|
var AI_SDK_TELEMETRY_INTEGRATIONS: TelemetryIntegration[] | undefined;
|
|
6950
7030
|
}
|
|
6951
7031
|
|
|
6952
|
-
export { AbstractChat, Agent, AgentCallParameters, AgentStreamParameters, AsyncIterableStream, CallSettings, CallWarning, ChatAddToolApproveResponseFunction, ChatAddToolOutputFunction, ChatInit, ChatOnDataCallback, ChatOnErrorCallback, ChatOnFinishCallback, ChatOnToolCallCallback, ChatRequestOptions, ChatState, ChatStatus, ChatTransport, ChunkDetector, CompletionRequestOptions, ContentPart, CreateUIMessage, CustomContentUIPart, DataUIPart, DeepPartial, DefaultChatTransport, DefaultGeneratedFile, DirectChatTransport, DirectChatTransportOptions, DynamicToolCall, DynamicToolError, DynamicToolResult, DynamicToolUIPart, EmbedFinishEvent, EmbedManyResult, EmbedOnFinishEvent, EmbedOnStartEvent, EmbedResult, EmbedStartEvent, Embedding, EmbeddingModel, EmbeddingModelMiddleware, EmbeddingModelUsage, ErrorHandler, ToolLoopAgent as Experimental_Agent, ToolLoopAgentSettings as Experimental_AgentSettings, DownloadFunction as Experimental_DownloadFunction, Experimental_GenerateImageResult, GeneratedFile as Experimental_GeneratedImage, InferAgentUIMessage as Experimental_InferAgentUIMessage, LogWarningsFunction as Experimental_LogWarningsFunction, SpeechResult as Experimental_SpeechResult, TranscriptionResult as Experimental_TranscriptionResult, FileUIPart, FinishReason, GenerateImageResult, GenerateObjectResult, GenerateTextOnFinishCallback, GenerateTextOnStartCallback, GenerateTextOnStepFinishCallback, GenerateTextOnStepStartCallback, GenerateTextOnToolCallFinishCallback, GenerateTextOnToolCallStartCallback, GenerateTextResult, GenerateVideoPrompt, GenerateVideoResult, GeneratedAudioFile, GeneratedFile, HttpChatTransport, HttpChatTransportInitOptions, ImageModel, ImageModelMiddleware, ImageModelProviderMetadata, ImageModelResponseMetadata, ImageModelUsage, InferAgentUIMessage, InferCompleteOutput as InferGenerateOutput, InferPartialOutput as InferStreamOutput, InferUIDataParts, InferUIMessageChunk, InferUITool, InferUITools, InvalidArgumentError, InvalidDataContentError, InvalidMessageRoleError, InvalidStreamPartError, InvalidToolApprovalError, InvalidToolInputError, JSONValue, JsonToSseTransformStream, LanguageModel, LanguageModelMiddleware, LanguageModelRequestMetadata, LanguageModelResponseMetadata, LanguageModelUsage, LogWarningsFunction, MessageConversionError, MissingToolResultsError, NoImageGeneratedError, NoObjectGeneratedError, NoOutputGeneratedError, NoSpeechGeneratedError, NoSuchProviderError, NoSuchToolError, NoTranscriptGeneratedError, NoVideoGeneratedError, ObjectStreamPart, OnFinishEvent, OnStartEvent, OnStepFinishEvent, OnStepStartEvent, OnToolCallFinishEvent, OnToolCallStartEvent, output as Output, PrepareReconnectToStreamRequest, PrepareSendMessagesRequest, PrepareStepFunction, PrepareStepResult, Prompt, Provider, ProviderMetadata, ProviderRegistryProvider, ReasoningFileOutput, ReasoningFileUIPart, ReasoningOutput, ReasoningUIPart, RepairTextFunction, RerankOnFinishEvent, RerankOnStartEvent, RerankResult, RerankingModel, RetryError, SafeValidateUIMessagesResult, SerialJobExecutor, SourceDocumentUIPart, SourceUrlUIPart, SpeechModel, SpeechModelResponseMetadata, StaticToolCall, StaticToolError, StaticToolOutputDenied, StaticToolResult, StepResult, StepStartUIPart, StopCondition, StreamObjectOnFinishCallback, StreamObjectResult, StreamTextOnChunkCallback, StreamTextOnErrorCallback, StreamTextOnFinishCallback, StreamTextOnStartCallback, StreamTextOnStepFinishCallback, StreamTextOnStepStartCallback, StreamTextOnToolCallFinishCallback, StreamTextOnToolCallStartCallback, StreamTextResult, StreamTextTransform, TelemetryIntegration, TelemetrySettings, TextStreamChatTransport, TextStreamPart, TextUIPart, TimeoutConfiguration, ToolApprovalRequestOutput, ToolCallNotFoundForApprovalError, ToolCallRepairError, ToolCallRepairFunction, ToolChoice, ToolLoopAgent, ToolLoopAgentOnFinishCallback, ToolLoopAgentOnStartCallback, ToolLoopAgentOnStepFinishCallback, ToolLoopAgentOnStepStartCallback, ToolLoopAgentOnToolCallFinishCallback, ToolLoopAgentOnToolCallStartCallback, ToolLoopAgentSettings, ToolSet, ToolUIPart, TranscriptionModel, TranscriptionModelResponseMetadata, TypedToolCall, TypedToolError, TypedToolOutputDenied, TypedToolResult, UIDataPartSchemas, UIDataTypes, UIMessage, UIMessageChunk, UIMessagePart, UIMessageStreamError, UIMessageStreamOnFinishCallback, UIMessageStreamOnStepFinishCallback, UIMessageStreamOptions, UIMessageStreamWriter, UITool, UIToolInvocation, UITools, UI_MESSAGE_STREAM_HEADERS, UnsupportedModelVersionError, UseCompletionOptions, Warning, addToolInputExamplesMiddleware, assistantModelMessageSchema, bindTelemetryIntegration, callCompletionApi, consumeStream, convertFileListToFileUIParts, convertToModelMessages, cosineSimilarity, createAgentUIStream, createAgentUIStreamResponse, createDownload, createProviderRegistry, createTextStreamResponse, createUIMessageStream, createUIMessageStreamResponse, customProvider, defaultEmbeddingSettingsMiddleware, defaultSettingsMiddleware, embed, embedMany, experimental_createProviderRegistry, experimental_customProvider, experimental_generateImage, generateSpeech as experimental_generateSpeech, experimental_generateVideo, streamModelCall as experimental_streamModelCall, transcribe as experimental_transcribe, extractJsonMiddleware, extractReasoningMiddleware, generateImage, generateObject, generateText, getStaticToolName, getTextFromDataUrl, getToolName, getToolOrDynamicToolName, hasToolCall, isCustomContentUIPart, isDataUIPart, isDeepEqualData, isFileUIPart, isReasoningFileUIPart, isReasoningUIPart, isStaticToolUIPart, isTextUIPart, isToolOrDynamicToolUIPart, isToolUIPart, lastAssistantMessageIsCompleteWithApprovalResponses, lastAssistantMessageIsCompleteWithToolCalls, modelMessageSchema, parsePartialJson, pipeAgentUIStreamToResponse, pipeTextStreamToResponse, pipeUIMessageStreamToResponse, pruneMessages, readUIMessageStream, registerTelemetryIntegration, rerank, safeValidateUIMessages, simulateReadableStream, simulateStreamingMiddleware, smoothStream, stepCountIs, streamObject, streamText, systemModelMessageSchema, toolModelMessageSchema, uiMessageChunkSchema, userModelMessageSchema, validateUIMessages, wrapEmbeddingModel, wrapImageModel, wrapLanguageModel, wrapProvider };
|
|
7032
|
+
export { AbstractChat, Agent, AgentCallParameters, AgentStreamParameters, AsyncIterableStream, CallSettings, CallWarning, ChatAddToolApproveResponseFunction, ChatAddToolOutputFunction, ChatInit, ChatOnDataCallback, ChatOnErrorCallback, ChatOnFinishCallback, ChatOnToolCallCallback, ChatRequestOptions, ChatState, ChatStatus, ChatTransport, ChunkDetector, CompletionRequestOptions, ContentPart, CreateUIMessage, CustomContentUIPart, DataUIPart, DeepPartial, DefaultChatTransport, DefaultGeneratedFile, DirectChatTransport, DirectChatTransportOptions, DynamicToolCall, DynamicToolError, DynamicToolResult, DynamicToolUIPart, EmbedFinishEvent, EmbedManyResult, EmbedOnFinishEvent, EmbedOnStartEvent, EmbedResult, EmbedStartEvent, Embedding, EmbeddingModel, EmbeddingModelMiddleware, EmbeddingModelUsage, ErrorHandler, ToolLoopAgent as Experimental_Agent, ToolLoopAgentSettings as Experimental_AgentSettings, DownloadFunction as Experimental_DownloadFunction, Experimental_GenerateImageResult, GeneratedFile as Experimental_GeneratedImage, InferAgentUIMessage as Experimental_InferAgentUIMessage, LogWarningsFunction as Experimental_LogWarningsFunction, ModelCallStreamPart as Experimental_ModelCallStreamPart, SpeechResult as Experimental_SpeechResult, TranscriptionResult as Experimental_TranscriptionResult, FileUIPart, FinishReason, GenerateImageResult, GenerateObjectResult, GenerateTextOnFinishCallback, GenerateTextOnStartCallback, GenerateTextOnStepFinishCallback, GenerateTextOnStepStartCallback, GenerateTextOnToolCallFinishCallback, GenerateTextOnToolCallStartCallback, GenerateTextResult, GenerateVideoPrompt, GenerateVideoResult, GeneratedAudioFile, GeneratedFile, HttpChatTransport, HttpChatTransportInitOptions, ImageModel, ImageModelMiddleware, ImageModelProviderMetadata, ImageModelResponseMetadata, ImageModelUsage, InferAgentUIMessage, InferCompleteOutput as InferGenerateOutput, InferPartialOutput as InferStreamOutput, InferUIDataParts, InferUIMessageChunk, InferUITool, InferUITools, InvalidArgumentError, InvalidDataContentError, InvalidMessageRoleError, InvalidStreamPartError, InvalidToolApprovalError, InvalidToolInputError, JSONValue, JsonToSseTransformStream, LanguageModel, LanguageModelMiddleware, LanguageModelRequestMetadata, LanguageModelResponseMetadata, LanguageModelUsage, LogWarningsFunction, MessageConversionError, MissingToolResultsError, NoImageGeneratedError, NoObjectGeneratedError, NoOutputGeneratedError, NoSpeechGeneratedError, NoSuchProviderError, NoSuchToolError, NoTranscriptGeneratedError, NoVideoGeneratedError, ObjectStreamPart, OnFinishEvent, OnStartEvent, OnStepFinishEvent, OnStepStartEvent, OnToolCallFinishEvent, OnToolCallStartEvent, output as Output, PrepareReconnectToStreamRequest, PrepareSendMessagesRequest, PrepareStepFunction, PrepareStepResult, Prompt, Provider, ProviderMetadata, ProviderRegistryProvider, ReasoningFileOutput, ReasoningFileUIPart, ReasoningOutput, ReasoningUIPart, RepairTextFunction, RerankFinishEvent, RerankOnFinishEvent, RerankOnStartEvent, RerankResult, RerankStartEvent, RerankingModel, RetryError, SafeValidateUIMessagesResult, SerialJobExecutor, SourceDocumentUIPart, SourceUrlUIPart, SpeechModel, SpeechModelResponseMetadata, StaticToolCall, StaticToolError, StaticToolOutputDenied, StaticToolResult, StepResult, StepStartUIPart, StopCondition, StreamObjectOnFinishCallback, StreamObjectResult, StreamTextOnChunkCallback, StreamTextOnErrorCallback, StreamTextOnFinishCallback, StreamTextOnStartCallback, StreamTextOnStepFinishCallback, StreamTextOnStepStartCallback, StreamTextOnToolCallFinishCallback, StreamTextOnToolCallStartCallback, StreamTextResult, StreamTextTransform, TelemetryIntegration, TelemetrySettings, TextStreamChatTransport, TextStreamPart, TextUIPart, TimeoutConfiguration, ToolApprovalRequestOutput, ToolCallNotFoundForApprovalError, ToolCallRepairError, ToolCallRepairFunction, ToolChoice, ToolLoopAgent, ToolLoopAgentOnFinishCallback, ToolLoopAgentOnStartCallback, ToolLoopAgentOnStepFinishCallback, ToolLoopAgentOnStepStartCallback, ToolLoopAgentOnToolCallFinishCallback, ToolLoopAgentOnToolCallStartCallback, ToolLoopAgentSettings, ToolSet, ToolUIPart, TranscriptionModel, TranscriptionModelResponseMetadata, TypedToolCall, TypedToolError, TypedToolOutputDenied, TypedToolResult, UIDataPartSchemas, UIDataTypes, UIMessage, UIMessageChunk, UIMessagePart, UIMessageStreamError, UIMessageStreamOnFinishCallback, UIMessageStreamOnStepFinishCallback, UIMessageStreamOptions, UIMessageStreamWriter, UITool, UIToolInvocation, UITools, UI_MESSAGE_STREAM_HEADERS, UnsupportedModelVersionError, UseCompletionOptions, Warning, addToolInputExamplesMiddleware, assistantModelMessageSchema, bindTelemetryIntegration, callCompletionApi, consumeStream, convertFileListToFileUIParts, convertToModelMessages, cosineSimilarity, createAgentUIStream, createAgentUIStreamResponse, createDownload, createProviderRegistry, createTextStreamResponse, createUIMessageStream, createUIMessageStreamResponse, customProvider, defaultEmbeddingSettingsMiddleware, defaultSettingsMiddleware, embed, embedMany, experimental_createProviderRegistry, experimental_customProvider, experimental_generateImage, generateSpeech as experimental_generateSpeech, experimental_generateVideo, streamModelCall as experimental_streamModelCall, transcribe as experimental_transcribe, extractJsonMiddleware, extractReasoningMiddleware, generateImage, generateObject, generateText, getStaticToolName, getTextFromDataUrl, getToolName, getToolOrDynamicToolName, hasToolCall, isCustomContentUIPart, isDataUIPart, isDeepEqualData, isFileUIPart, isReasoningFileUIPart, isReasoningUIPart, isStaticToolUIPart, isTextUIPart, isToolOrDynamicToolUIPart, isToolUIPart, lastAssistantMessageIsCompleteWithApprovalResponses, lastAssistantMessageIsCompleteWithToolCalls, modelMessageSchema, parsePartialJson, pipeAgentUIStreamToResponse, pipeTextStreamToResponse, pipeUIMessageStreamToResponse, pruneMessages, readUIMessageStream, registerTelemetryIntegration, rerank, safeValidateUIMessages, simulateReadableStream, simulateStreamingMiddleware, smoothStream, stepCountIs, streamObject, streamText, systemModelMessageSchema, toolModelMessageSchema, uiMessageChunkSchema, userModelMessageSchema, validateUIMessages, wrapEmbeddingModel, wrapImageModel, wrapLanguageModel, wrapProvider };
|