ai 4.0.22 → 4.0.24
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 +12 -0
- package/dist/index.d.mts +49 -21
- package/dist/index.d.ts +49 -21
- package/dist/index.js +307 -180
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +293 -164
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
@@ -1,5 +1,17 @@
|
|
1
1
|
# ai
|
2
2
|
|
3
|
+
## 4.0.24
|
4
|
+
|
5
|
+
### Patch Changes
|
6
|
+
|
7
|
+
- ae0485b: feat (ai/core): add experimental output setting to streamText
|
8
|
+
|
9
|
+
## 4.0.23
|
10
|
+
|
11
|
+
### Patch Changes
|
12
|
+
|
13
|
+
- bc4cd19: feat (ai/core): consolidate whitespace in smooth stream
|
14
|
+
|
3
15
|
## 4.0.22
|
4
16
|
|
5
17
|
### Patch Changes
|
package/dist/index.d.mts
CHANGED
@@ -1535,7 +1535,7 @@ interface GenerateTextResult<TOOLS extends Record<string, CoreTool>, OUTPUT> {
|
|
1535
1535
|
*/
|
1536
1536
|
readonly text: string;
|
1537
1537
|
/**
|
1538
|
-
|
1538
|
+
The generated structured output. It uses the `experimental_output` specification.
|
1539
1539
|
*/
|
1540
1540
|
readonly experimental_output: OUTPUT;
|
1541
1541
|
/**
|
@@ -1597,7 +1597,7 @@ interface GenerateTextResult<TOOLS extends Record<string, CoreTool>, OUTPUT> {
|
|
1597
1597
|
readonly experimental_providerMetadata: ProviderMetadata | undefined;
|
1598
1598
|
}
|
1599
1599
|
|
1600
|
-
interface Output<OUTPUT> {
|
1600
|
+
interface Output<OUTPUT, PARTIAL> {
|
1601
1601
|
readonly type: 'object' | 'text';
|
1602
1602
|
injectIntoSystemPrompt(options: {
|
1603
1603
|
system: string | undefined;
|
@@ -1606,6 +1606,11 @@ interface Output<OUTPUT> {
|
|
1606
1606
|
responseFormat: (options: {
|
1607
1607
|
model: LanguageModel;
|
1608
1608
|
}) => LanguageModelV1CallOptions['responseFormat'];
|
1609
|
+
parsePartial(options: {
|
1610
|
+
text: string;
|
1611
|
+
}): {
|
1612
|
+
partial: PARTIAL;
|
1613
|
+
} | undefined;
|
1609
1614
|
parseOutput(options: {
|
1610
1615
|
text: string;
|
1611
1616
|
}, context: {
|
@@ -1613,12 +1618,12 @@ interface Output<OUTPUT> {
|
|
1613
1618
|
usage: LanguageModelUsage;
|
1614
1619
|
}): OUTPUT;
|
1615
1620
|
}
|
1616
|
-
declare const text: () => Output<string>;
|
1621
|
+
declare const text: () => Output<string, string>;
|
1617
1622
|
declare const object: <OUTPUT>({ schema: inputSchema, }: {
|
1618
1623
|
schema: z.Schema<OUTPUT, z.ZodTypeDef, any> | Schema<OUTPUT>;
|
1619
|
-
}) => Output<OUTPUT
|
1624
|
+
}) => Output<OUTPUT, DeepPartial<OUTPUT>>;
|
1620
1625
|
|
1621
|
-
type output_Output<OUTPUT> = Output<OUTPUT>;
|
1626
|
+
type output_Output<OUTPUT, PARTIAL> = Output<OUTPUT, PARTIAL>;
|
1622
1627
|
declare const output_object: typeof object;
|
1623
1628
|
declare const output_text: typeof text;
|
1624
1629
|
declare namespace output {
|
@@ -1629,9 +1634,9 @@ declare namespace output {
|
|
1629
1634
|
};
|
1630
1635
|
}
|
1631
1636
|
|
1632
|
-
declare const symbol$
|
1637
|
+
declare const symbol$c: unique symbol;
|
1633
1638
|
declare class InvalidToolArgumentsError extends AISDKError {
|
1634
|
-
private readonly [symbol$
|
1639
|
+
private readonly [symbol$c];
|
1635
1640
|
readonly toolName: string;
|
1636
1641
|
readonly toolArgs: string;
|
1637
1642
|
constructor({ toolArgs, toolName, cause, message, }: {
|
@@ -1643,9 +1648,9 @@ declare class InvalidToolArgumentsError extends AISDKError {
|
|
1643
1648
|
static isInstance(error: unknown): error is InvalidToolArgumentsError;
|
1644
1649
|
}
|
1645
1650
|
|
1646
|
-
declare const symbol$
|
1651
|
+
declare const symbol$b: unique symbol;
|
1647
1652
|
declare class NoSuchToolError extends AISDKError {
|
1648
|
-
private readonly [symbol$
|
1653
|
+
private readonly [symbol$b];
|
1649
1654
|
readonly toolName: string;
|
1650
1655
|
readonly availableTools: string[] | undefined;
|
1651
1656
|
constructor({ toolName, availableTools, message, }: {
|
@@ -1726,7 +1731,7 @@ If set and supported by the model, calls will generate deterministic results.
|
|
1726
1731
|
@returns
|
1727
1732
|
A result object that contains the generated text, the results of the tool calls, and additional information.
|
1728
1733
|
*/
|
1729
|
-
declare function generateText<TOOLS extends Record<string, CoreTool>, OUTPUT = never>({ model, tools, toolChoice, system, prompt, messages, maxRetries: maxRetriesArg, abortSignal, headers, maxSteps, experimental_output: output, experimental_continueSteps: continueSteps, experimental_telemetry: telemetry, experimental_providerMetadata: providerMetadata, experimental_activeTools: activeTools, experimental_repairToolCall: repairToolCall, _internal: { generateId, currentDate, }, onStepFinish, ...settings }: CallSettings & Prompt & {
|
1734
|
+
declare function generateText<TOOLS extends Record<string, CoreTool>, OUTPUT = never, OUTPUT_PARTIAL = never>({ model, tools, toolChoice, system, prompt, messages, maxRetries: maxRetriesArg, abortSignal, headers, maxSteps, experimental_output: output, experimental_continueSteps: continueSteps, experimental_telemetry: telemetry, experimental_providerMetadata: providerMetadata, experimental_activeTools: activeTools, experimental_repairToolCall: repairToolCall, _internal: { generateId, currentDate, }, onStepFinish, ...settings }: CallSettings & Prompt & {
|
1730
1735
|
/**
|
1731
1736
|
The language model to use.
|
1732
1737
|
*/
|
@@ -1768,7 +1773,10 @@ Limits the tools that are available for the model to call without
|
|
1768
1773
|
changing the tool call and result types in the result.
|
1769
1774
|
*/
|
1770
1775
|
experimental_activeTools?: Array<keyof TOOLS>;
|
1771
|
-
|
1776
|
+
/**
|
1777
|
+
Optional specification for parsing structured outputs from the LLM response.
|
1778
|
+
*/
|
1779
|
+
experimental_output?: Output<OUTPUT, OUTPUT_PARTIAL>;
|
1772
1780
|
/**
|
1773
1781
|
A function that attempts to repair a tool call that failed to parse.
|
1774
1782
|
*/
|
@@ -1806,7 +1814,7 @@ declare class StreamData {
|
|
1806
1814
|
/**
|
1807
1815
|
A result object for accessing different stream types and additional information.
|
1808
1816
|
*/
|
1809
|
-
interface StreamTextResult<TOOLS extends Record<string, CoreTool
|
1817
|
+
interface StreamTextResult<TOOLS extends Record<string, CoreTool>, PARTIAL_OUTPUT> {
|
1810
1818
|
/**
|
1811
1819
|
Warnings from the model provider (e.g. unsupported settings) for the first step.
|
1812
1820
|
*/
|
@@ -1886,6 +1894,10 @@ interface StreamTextResult<TOOLS extends Record<string, CoreTool>> {
|
|
1886
1894
|
*/
|
1887
1895
|
readonly fullStream: AsyncIterableStream<TextStreamPart<TOOLS>>;
|
1888
1896
|
/**
|
1897
|
+
A stream of partial outputs. It uses the `experimental_output` specification.
|
1898
|
+
*/
|
1899
|
+
readonly experimental_partialOutputStream: AsyncIterableStream<PARTIAL_OUTPUT>;
|
1900
|
+
/**
|
1889
1901
|
Converts the result to a data stream.
|
1890
1902
|
|
1891
1903
|
@param data an optional StreamData object that will be merged into the stream.
|
@@ -2042,7 +2054,7 @@ If set and supported by the model, calls will generate deterministic results.
|
|
2042
2054
|
@return
|
2043
2055
|
A result object for accessing different stream types and additional information.
|
2044
2056
|
*/
|
2045
|
-
declare function streamText<TOOLS extends Record<string, CoreTool
|
2057
|
+
declare function streamText<TOOLS extends Record<string, CoreTool>, OUTPUT = never, PARTIAL_OUTPUT = never>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, headers, maxSteps, experimental_output: output, experimental_continueSteps: continueSteps, experimental_telemetry: telemetry, experimental_providerMetadata: providerMetadata, experimental_toolCallStreaming: toolCallStreaming, experimental_activeTools: activeTools, experimental_repairToolCall: repairToolCall, experimental_transform: transform, onChunk, onFinish, onStepFinish, _internal: { now, generateId, currentDate, }, ...settings }: CallSettings & Prompt & {
|
2046
2058
|
/**
|
2047
2059
|
The language model to use.
|
2048
2060
|
*/
|
@@ -2085,6 +2097,10 @@ changing the tool call and result types in the result.
|
|
2085
2097
|
*/
|
2086
2098
|
experimental_activeTools?: Array<keyof TOOLS>;
|
2087
2099
|
/**
|
2100
|
+
Optional specification for parsing structured outputs from the LLM response.
|
2101
|
+
*/
|
2102
|
+
experimental_output?: Output<OUTPUT, PARTIAL_OUTPUT>;
|
2103
|
+
/**
|
2088
2104
|
A function that attempts to repair a tool call that failed to parse.
|
2089
2105
|
*/
|
2090
2106
|
experimental_repairToolCall?: ToolCallRepairFunction<TOOLS>;
|
@@ -2130,7 +2146,7 @@ Details for all steps.
|
|
2130
2146
|
generateId?: () => string;
|
2131
2147
|
currentDate?: () => Date;
|
2132
2148
|
};
|
2133
|
-
}): StreamTextResult<TOOLS>;
|
2149
|
+
}): StreamTextResult<TOOLS, PARTIAL_OUTPUT>;
|
2134
2150
|
|
2135
2151
|
/**
|
2136
2152
|
* Smooths text streaming output.
|
@@ -2233,9 +2249,9 @@ declare function experimental_customProvider({ languageModels, textEmbeddingMode
|
|
2233
2249
|
fallbackProvider?: Provider;
|
2234
2250
|
}): Provider;
|
2235
2251
|
|
2236
|
-
declare const symbol$
|
2252
|
+
declare const symbol$a: unique symbol;
|
2237
2253
|
declare class NoSuchProviderError extends NoSuchModelError {
|
2238
|
-
private readonly [symbol$
|
2254
|
+
private readonly [symbol$a];
|
2239
2255
|
readonly providerId: string;
|
2240
2256
|
readonly availableProviders: string[];
|
2241
2257
|
constructor({ modelId, modelType, providerId, availableProviders, message, }: {
|
@@ -2265,9 +2281,9 @@ declare function experimental_createProviderRegistry(providers: Record<string, P
|
|
2265
2281
|
*/
|
2266
2282
|
declare function cosineSimilarity(vector1: number[], vector2: number[]): number;
|
2267
2283
|
|
2268
|
-
declare const symbol$
|
2284
|
+
declare const symbol$9: unique symbol;
|
2269
2285
|
declare class InvalidArgumentError extends AISDKError {
|
2270
|
-
private readonly [symbol$
|
2286
|
+
private readonly [symbol$9];
|
2271
2287
|
readonly parameter: string;
|
2272
2288
|
readonly value: unknown;
|
2273
2289
|
constructor({ parameter, value, message, }: {
|
@@ -2278,7 +2294,7 @@ declare class InvalidArgumentError extends AISDKError {
|
|
2278
2294
|
static isInstance(error: unknown): error is InvalidArgumentError;
|
2279
2295
|
}
|
2280
2296
|
|
2281
|
-
declare const symbol$
|
2297
|
+
declare const symbol$8: unique symbol;
|
2282
2298
|
/**
|
2283
2299
|
Thrown when no object could be generated. This can have several causes:
|
2284
2300
|
|
@@ -2291,7 +2307,7 @@ The error contains the following properties:
|
|
2291
2307
|
- `text`: The text that was generated by the model. This can be the raw text or the tool call text, depending on the model.
|
2292
2308
|
*/
|
2293
2309
|
declare class NoObjectGeneratedError extends AISDKError {
|
2294
|
-
private readonly [symbol$
|
2310
|
+
private readonly [symbol$8];
|
2295
2311
|
/**
|
2296
2312
|
The text that was generated by the model. This can be the raw text or the tool call text, depending on the model.
|
2297
2313
|
*/
|
@@ -2314,6 +2330,18 @@ declare class NoObjectGeneratedError extends AISDKError {
|
|
2314
2330
|
static isInstance(error: unknown): error is NoObjectGeneratedError;
|
2315
2331
|
}
|
2316
2332
|
|
2333
|
+
declare const symbol$7: unique symbol;
|
2334
|
+
/**
|
2335
|
+
Thrown when no output type is specified and output-related methods are called.
|
2336
|
+
*/
|
2337
|
+
declare class NoOutputSpecifiedError extends AISDKError {
|
2338
|
+
private readonly [symbol$7];
|
2339
|
+
constructor({ message }?: {
|
2340
|
+
message?: string;
|
2341
|
+
});
|
2342
|
+
static isInstance(error: unknown): error is NoOutputSpecifiedError;
|
2343
|
+
}
|
2344
|
+
|
2317
2345
|
declare const symbol$6: unique symbol;
|
2318
2346
|
declare class ToolCallRepairError extends AISDKError {
|
2319
2347
|
private readonly [symbol$6];
|
@@ -2538,4 +2566,4 @@ declare namespace llamaindexAdapter {
|
|
2538
2566
|
};
|
2539
2567
|
}
|
2540
2568
|
|
2541
|
-
export { AssistantContent, AssistantResponse, CallWarning, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreTool, ToolCallUnion as CoreToolCallUnion, CoreToolChoice, CoreToolMessage, ToolResultUnion as CoreToolResultUnion, CoreUserMessage, DataContent, DataStreamWriter, DownloadError, EmbedManyResult, EmbedResult, Embedding, EmbeddingModel, EmbeddingModelUsage, GenerateImageResult as Experimental_GenerateImageResult, GeneratedImage as Experimental_GeneratedImage, Experimental_LanguageModelV1Middleware, FilePart, FinishReason, GenerateObjectResult, GenerateTextResult, ImagePart, InvalidArgumentError, InvalidDataContentError, InvalidMessageRoleError, InvalidToolArgumentsError, langchainAdapter as LangChainAdapter, LanguageModel, LanguageModelRequestMetadata, LanguageModelResponseMetadata, LanguageModelUsage, llamaindexAdapter as LlamaIndexAdapter, LogProbs, MessageConversionError, NoObjectGeneratedError, NoSuchProviderError, NoSuchToolError, ObjectStreamPart, output as Output, Provider, ProviderMetadata, RetryError, StepResult, StreamData, StreamObjectResult, StreamTextResult, TextPart, TextStreamPart, ToolCallPart, ToolCallRepairError, ToolCallRepairFunction, ToolContent, ToolExecutionError, ToolExecutionOptions, ToolResultPart, UserContent, convertToCoreMessages, cosineSimilarity, createDataStream, createDataStreamResponse, embed, embedMany, experimental_createProviderRegistry, experimental_customProvider, generateImage as experimental_generateImage, experimental_wrapLanguageModel, generateObject, generateText, pipeDataStreamToResponse, smoothStream, streamObject, streamText, tool };
|
2569
|
+
export { AssistantContent, AssistantResponse, CallWarning, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreTool, ToolCallUnion as CoreToolCallUnion, CoreToolChoice, CoreToolMessage, ToolResultUnion as CoreToolResultUnion, CoreUserMessage, DataContent, DataStreamWriter, DownloadError, EmbedManyResult, EmbedResult, Embedding, EmbeddingModel, EmbeddingModelUsage, GenerateImageResult as Experimental_GenerateImageResult, GeneratedImage as Experimental_GeneratedImage, Experimental_LanguageModelV1Middleware, FilePart, FinishReason, GenerateObjectResult, GenerateTextResult, ImagePart, InvalidArgumentError, InvalidDataContentError, InvalidMessageRoleError, InvalidToolArgumentsError, langchainAdapter as LangChainAdapter, LanguageModel, LanguageModelRequestMetadata, LanguageModelResponseMetadata, LanguageModelUsage, llamaindexAdapter as LlamaIndexAdapter, LogProbs, MessageConversionError, NoObjectGeneratedError, NoOutputSpecifiedError, NoSuchProviderError, NoSuchToolError, ObjectStreamPart, output as Output, Provider, ProviderMetadata, RetryError, StepResult, StreamData, StreamObjectResult, StreamTextResult, TextPart, TextStreamPart, ToolCallPart, ToolCallRepairError, ToolCallRepairFunction, ToolContent, ToolExecutionError, ToolExecutionOptions, ToolResultPart, UserContent, convertToCoreMessages, cosineSimilarity, createDataStream, createDataStreamResponse, embed, embedMany, experimental_createProviderRegistry, experimental_customProvider, generateImage as experimental_generateImage, experimental_wrapLanguageModel, generateObject, generateText, pipeDataStreamToResponse, smoothStream, streamObject, streamText, tool };
|
package/dist/index.d.ts
CHANGED
@@ -1535,7 +1535,7 @@ interface GenerateTextResult<TOOLS extends Record<string, CoreTool>, OUTPUT> {
|
|
1535
1535
|
*/
|
1536
1536
|
readonly text: string;
|
1537
1537
|
/**
|
1538
|
-
|
1538
|
+
The generated structured output. It uses the `experimental_output` specification.
|
1539
1539
|
*/
|
1540
1540
|
readonly experimental_output: OUTPUT;
|
1541
1541
|
/**
|
@@ -1597,7 +1597,7 @@ interface GenerateTextResult<TOOLS extends Record<string, CoreTool>, OUTPUT> {
|
|
1597
1597
|
readonly experimental_providerMetadata: ProviderMetadata | undefined;
|
1598
1598
|
}
|
1599
1599
|
|
1600
|
-
interface Output<OUTPUT> {
|
1600
|
+
interface Output<OUTPUT, PARTIAL> {
|
1601
1601
|
readonly type: 'object' | 'text';
|
1602
1602
|
injectIntoSystemPrompt(options: {
|
1603
1603
|
system: string | undefined;
|
@@ -1606,6 +1606,11 @@ interface Output<OUTPUT> {
|
|
1606
1606
|
responseFormat: (options: {
|
1607
1607
|
model: LanguageModel;
|
1608
1608
|
}) => LanguageModelV1CallOptions['responseFormat'];
|
1609
|
+
parsePartial(options: {
|
1610
|
+
text: string;
|
1611
|
+
}): {
|
1612
|
+
partial: PARTIAL;
|
1613
|
+
} | undefined;
|
1609
1614
|
parseOutput(options: {
|
1610
1615
|
text: string;
|
1611
1616
|
}, context: {
|
@@ -1613,12 +1618,12 @@ interface Output<OUTPUT> {
|
|
1613
1618
|
usage: LanguageModelUsage;
|
1614
1619
|
}): OUTPUT;
|
1615
1620
|
}
|
1616
|
-
declare const text: () => Output<string>;
|
1621
|
+
declare const text: () => Output<string, string>;
|
1617
1622
|
declare const object: <OUTPUT>({ schema: inputSchema, }: {
|
1618
1623
|
schema: z.Schema<OUTPUT, z.ZodTypeDef, any> | Schema<OUTPUT>;
|
1619
|
-
}) => Output<OUTPUT
|
1624
|
+
}) => Output<OUTPUT, DeepPartial<OUTPUT>>;
|
1620
1625
|
|
1621
|
-
type output_Output<OUTPUT> = Output<OUTPUT>;
|
1626
|
+
type output_Output<OUTPUT, PARTIAL> = Output<OUTPUT, PARTIAL>;
|
1622
1627
|
declare const output_object: typeof object;
|
1623
1628
|
declare const output_text: typeof text;
|
1624
1629
|
declare namespace output {
|
@@ -1629,9 +1634,9 @@ declare namespace output {
|
|
1629
1634
|
};
|
1630
1635
|
}
|
1631
1636
|
|
1632
|
-
declare const symbol$
|
1637
|
+
declare const symbol$c: unique symbol;
|
1633
1638
|
declare class InvalidToolArgumentsError extends AISDKError {
|
1634
|
-
private readonly [symbol$
|
1639
|
+
private readonly [symbol$c];
|
1635
1640
|
readonly toolName: string;
|
1636
1641
|
readonly toolArgs: string;
|
1637
1642
|
constructor({ toolArgs, toolName, cause, message, }: {
|
@@ -1643,9 +1648,9 @@ declare class InvalidToolArgumentsError extends AISDKError {
|
|
1643
1648
|
static isInstance(error: unknown): error is InvalidToolArgumentsError;
|
1644
1649
|
}
|
1645
1650
|
|
1646
|
-
declare const symbol$
|
1651
|
+
declare const symbol$b: unique symbol;
|
1647
1652
|
declare class NoSuchToolError extends AISDKError {
|
1648
|
-
private readonly [symbol$
|
1653
|
+
private readonly [symbol$b];
|
1649
1654
|
readonly toolName: string;
|
1650
1655
|
readonly availableTools: string[] | undefined;
|
1651
1656
|
constructor({ toolName, availableTools, message, }: {
|
@@ -1726,7 +1731,7 @@ If set and supported by the model, calls will generate deterministic results.
|
|
1726
1731
|
@returns
|
1727
1732
|
A result object that contains the generated text, the results of the tool calls, and additional information.
|
1728
1733
|
*/
|
1729
|
-
declare function generateText<TOOLS extends Record<string, CoreTool>, OUTPUT = never>({ model, tools, toolChoice, system, prompt, messages, maxRetries: maxRetriesArg, abortSignal, headers, maxSteps, experimental_output: output, experimental_continueSteps: continueSteps, experimental_telemetry: telemetry, experimental_providerMetadata: providerMetadata, experimental_activeTools: activeTools, experimental_repairToolCall: repairToolCall, _internal: { generateId, currentDate, }, onStepFinish, ...settings }: CallSettings & Prompt & {
|
1734
|
+
declare function generateText<TOOLS extends Record<string, CoreTool>, OUTPUT = never, OUTPUT_PARTIAL = never>({ model, tools, toolChoice, system, prompt, messages, maxRetries: maxRetriesArg, abortSignal, headers, maxSteps, experimental_output: output, experimental_continueSteps: continueSteps, experimental_telemetry: telemetry, experimental_providerMetadata: providerMetadata, experimental_activeTools: activeTools, experimental_repairToolCall: repairToolCall, _internal: { generateId, currentDate, }, onStepFinish, ...settings }: CallSettings & Prompt & {
|
1730
1735
|
/**
|
1731
1736
|
The language model to use.
|
1732
1737
|
*/
|
@@ -1768,7 +1773,10 @@ Limits the tools that are available for the model to call without
|
|
1768
1773
|
changing the tool call and result types in the result.
|
1769
1774
|
*/
|
1770
1775
|
experimental_activeTools?: Array<keyof TOOLS>;
|
1771
|
-
|
1776
|
+
/**
|
1777
|
+
Optional specification for parsing structured outputs from the LLM response.
|
1778
|
+
*/
|
1779
|
+
experimental_output?: Output<OUTPUT, OUTPUT_PARTIAL>;
|
1772
1780
|
/**
|
1773
1781
|
A function that attempts to repair a tool call that failed to parse.
|
1774
1782
|
*/
|
@@ -1806,7 +1814,7 @@ declare class StreamData {
|
|
1806
1814
|
/**
|
1807
1815
|
A result object for accessing different stream types and additional information.
|
1808
1816
|
*/
|
1809
|
-
interface StreamTextResult<TOOLS extends Record<string, CoreTool
|
1817
|
+
interface StreamTextResult<TOOLS extends Record<string, CoreTool>, PARTIAL_OUTPUT> {
|
1810
1818
|
/**
|
1811
1819
|
Warnings from the model provider (e.g. unsupported settings) for the first step.
|
1812
1820
|
*/
|
@@ -1886,6 +1894,10 @@ interface StreamTextResult<TOOLS extends Record<string, CoreTool>> {
|
|
1886
1894
|
*/
|
1887
1895
|
readonly fullStream: AsyncIterableStream<TextStreamPart<TOOLS>>;
|
1888
1896
|
/**
|
1897
|
+
A stream of partial outputs. It uses the `experimental_output` specification.
|
1898
|
+
*/
|
1899
|
+
readonly experimental_partialOutputStream: AsyncIterableStream<PARTIAL_OUTPUT>;
|
1900
|
+
/**
|
1889
1901
|
Converts the result to a data stream.
|
1890
1902
|
|
1891
1903
|
@param data an optional StreamData object that will be merged into the stream.
|
@@ -2042,7 +2054,7 @@ If set and supported by the model, calls will generate deterministic results.
|
|
2042
2054
|
@return
|
2043
2055
|
A result object for accessing different stream types and additional information.
|
2044
2056
|
*/
|
2045
|
-
declare function streamText<TOOLS extends Record<string, CoreTool
|
2057
|
+
declare function streamText<TOOLS extends Record<string, CoreTool>, OUTPUT = never, PARTIAL_OUTPUT = never>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, headers, maxSteps, experimental_output: output, experimental_continueSteps: continueSteps, experimental_telemetry: telemetry, experimental_providerMetadata: providerMetadata, experimental_toolCallStreaming: toolCallStreaming, experimental_activeTools: activeTools, experimental_repairToolCall: repairToolCall, experimental_transform: transform, onChunk, onFinish, onStepFinish, _internal: { now, generateId, currentDate, }, ...settings }: CallSettings & Prompt & {
|
2046
2058
|
/**
|
2047
2059
|
The language model to use.
|
2048
2060
|
*/
|
@@ -2085,6 +2097,10 @@ changing the tool call and result types in the result.
|
|
2085
2097
|
*/
|
2086
2098
|
experimental_activeTools?: Array<keyof TOOLS>;
|
2087
2099
|
/**
|
2100
|
+
Optional specification for parsing structured outputs from the LLM response.
|
2101
|
+
*/
|
2102
|
+
experimental_output?: Output<OUTPUT, PARTIAL_OUTPUT>;
|
2103
|
+
/**
|
2088
2104
|
A function that attempts to repair a tool call that failed to parse.
|
2089
2105
|
*/
|
2090
2106
|
experimental_repairToolCall?: ToolCallRepairFunction<TOOLS>;
|
@@ -2130,7 +2146,7 @@ Details for all steps.
|
|
2130
2146
|
generateId?: () => string;
|
2131
2147
|
currentDate?: () => Date;
|
2132
2148
|
};
|
2133
|
-
}): StreamTextResult<TOOLS>;
|
2149
|
+
}): StreamTextResult<TOOLS, PARTIAL_OUTPUT>;
|
2134
2150
|
|
2135
2151
|
/**
|
2136
2152
|
* Smooths text streaming output.
|
@@ -2233,9 +2249,9 @@ declare function experimental_customProvider({ languageModels, textEmbeddingMode
|
|
2233
2249
|
fallbackProvider?: Provider;
|
2234
2250
|
}): Provider;
|
2235
2251
|
|
2236
|
-
declare const symbol$
|
2252
|
+
declare const symbol$a: unique symbol;
|
2237
2253
|
declare class NoSuchProviderError extends NoSuchModelError {
|
2238
|
-
private readonly [symbol$
|
2254
|
+
private readonly [symbol$a];
|
2239
2255
|
readonly providerId: string;
|
2240
2256
|
readonly availableProviders: string[];
|
2241
2257
|
constructor({ modelId, modelType, providerId, availableProviders, message, }: {
|
@@ -2265,9 +2281,9 @@ declare function experimental_createProviderRegistry(providers: Record<string, P
|
|
2265
2281
|
*/
|
2266
2282
|
declare function cosineSimilarity(vector1: number[], vector2: number[]): number;
|
2267
2283
|
|
2268
|
-
declare const symbol$
|
2284
|
+
declare const symbol$9: unique symbol;
|
2269
2285
|
declare class InvalidArgumentError extends AISDKError {
|
2270
|
-
private readonly [symbol$
|
2286
|
+
private readonly [symbol$9];
|
2271
2287
|
readonly parameter: string;
|
2272
2288
|
readonly value: unknown;
|
2273
2289
|
constructor({ parameter, value, message, }: {
|
@@ -2278,7 +2294,7 @@ declare class InvalidArgumentError extends AISDKError {
|
|
2278
2294
|
static isInstance(error: unknown): error is InvalidArgumentError;
|
2279
2295
|
}
|
2280
2296
|
|
2281
|
-
declare const symbol$
|
2297
|
+
declare const symbol$8: unique symbol;
|
2282
2298
|
/**
|
2283
2299
|
Thrown when no object could be generated. This can have several causes:
|
2284
2300
|
|
@@ -2291,7 +2307,7 @@ The error contains the following properties:
|
|
2291
2307
|
- `text`: The text that was generated by the model. This can be the raw text or the tool call text, depending on the model.
|
2292
2308
|
*/
|
2293
2309
|
declare class NoObjectGeneratedError extends AISDKError {
|
2294
|
-
private readonly [symbol$
|
2310
|
+
private readonly [symbol$8];
|
2295
2311
|
/**
|
2296
2312
|
The text that was generated by the model. This can be the raw text or the tool call text, depending on the model.
|
2297
2313
|
*/
|
@@ -2314,6 +2330,18 @@ declare class NoObjectGeneratedError extends AISDKError {
|
|
2314
2330
|
static isInstance(error: unknown): error is NoObjectGeneratedError;
|
2315
2331
|
}
|
2316
2332
|
|
2333
|
+
declare const symbol$7: unique symbol;
|
2334
|
+
/**
|
2335
|
+
Thrown when no output type is specified and output-related methods are called.
|
2336
|
+
*/
|
2337
|
+
declare class NoOutputSpecifiedError extends AISDKError {
|
2338
|
+
private readonly [symbol$7];
|
2339
|
+
constructor({ message }?: {
|
2340
|
+
message?: string;
|
2341
|
+
});
|
2342
|
+
static isInstance(error: unknown): error is NoOutputSpecifiedError;
|
2343
|
+
}
|
2344
|
+
|
2317
2345
|
declare const symbol$6: unique symbol;
|
2318
2346
|
declare class ToolCallRepairError extends AISDKError {
|
2319
2347
|
private readonly [symbol$6];
|
@@ -2538,4 +2566,4 @@ declare namespace llamaindexAdapter {
|
|
2538
2566
|
};
|
2539
2567
|
}
|
2540
2568
|
|
2541
|
-
export { AssistantContent, AssistantResponse, CallWarning, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreTool, ToolCallUnion as CoreToolCallUnion, CoreToolChoice, CoreToolMessage, ToolResultUnion as CoreToolResultUnion, CoreUserMessage, DataContent, DataStreamWriter, DownloadError, EmbedManyResult, EmbedResult, Embedding, EmbeddingModel, EmbeddingModelUsage, GenerateImageResult as Experimental_GenerateImageResult, GeneratedImage as Experimental_GeneratedImage, Experimental_LanguageModelV1Middleware, FilePart, FinishReason, GenerateObjectResult, GenerateTextResult, ImagePart, InvalidArgumentError, InvalidDataContentError, InvalidMessageRoleError, InvalidToolArgumentsError, langchainAdapter as LangChainAdapter, LanguageModel, LanguageModelRequestMetadata, LanguageModelResponseMetadata, LanguageModelUsage, llamaindexAdapter as LlamaIndexAdapter, LogProbs, MessageConversionError, NoObjectGeneratedError, NoSuchProviderError, NoSuchToolError, ObjectStreamPart, output as Output, Provider, ProviderMetadata, RetryError, StepResult, StreamData, StreamObjectResult, StreamTextResult, TextPart, TextStreamPart, ToolCallPart, ToolCallRepairError, ToolCallRepairFunction, ToolContent, ToolExecutionError, ToolExecutionOptions, ToolResultPart, UserContent, convertToCoreMessages, cosineSimilarity, createDataStream, createDataStreamResponse, embed, embedMany, experimental_createProviderRegistry, experimental_customProvider, generateImage as experimental_generateImage, experimental_wrapLanguageModel, generateObject, generateText, pipeDataStreamToResponse, smoothStream, streamObject, streamText, tool };
|
2569
|
+
export { AssistantContent, AssistantResponse, CallWarning, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreTool, ToolCallUnion as CoreToolCallUnion, CoreToolChoice, CoreToolMessage, ToolResultUnion as CoreToolResultUnion, CoreUserMessage, DataContent, DataStreamWriter, DownloadError, EmbedManyResult, EmbedResult, Embedding, EmbeddingModel, EmbeddingModelUsage, GenerateImageResult as Experimental_GenerateImageResult, GeneratedImage as Experimental_GeneratedImage, Experimental_LanguageModelV1Middleware, FilePart, FinishReason, GenerateObjectResult, GenerateTextResult, ImagePart, InvalidArgumentError, InvalidDataContentError, InvalidMessageRoleError, InvalidToolArgumentsError, langchainAdapter as LangChainAdapter, LanguageModel, LanguageModelRequestMetadata, LanguageModelResponseMetadata, LanguageModelUsage, llamaindexAdapter as LlamaIndexAdapter, LogProbs, MessageConversionError, NoObjectGeneratedError, NoOutputSpecifiedError, NoSuchProviderError, NoSuchToolError, ObjectStreamPart, output as Output, Provider, ProviderMetadata, RetryError, StepResult, StreamData, StreamObjectResult, StreamTextResult, TextPart, TextStreamPart, ToolCallPart, ToolCallRepairError, ToolCallRepairFunction, ToolContent, ToolExecutionError, ToolExecutionOptions, ToolResultPart, UserContent, convertToCoreMessages, cosineSimilarity, createDataStream, createDataStreamResponse, embed, embedMany, experimental_createProviderRegistry, experimental_customProvider, generateImage as experimental_generateImage, experimental_wrapLanguageModel, generateObject, generateText, pipeDataStreamToResponse, smoothStream, streamObject, streamText, tool };
|