@ai-sdk/provider 3.0.0-beta.28 → 3.0.0-beta.29
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 +109 -96
- package/dist/index.d.ts +109 -96
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
package/dist/index.d.mts
CHANGED
|
@@ -1700,6 +1700,56 @@ type LanguageModelV3Usage = {
|
|
|
1700
1700
|
raw?: JSONObject;
|
|
1701
1701
|
};
|
|
1702
1702
|
|
|
1703
|
+
/**
|
|
1704
|
+
* The result of a language model doGenerate call.
|
|
1705
|
+
*/
|
|
1706
|
+
type LanguageModelV3GenerateResult = {
|
|
1707
|
+
/**
|
|
1708
|
+
* Ordered content that the model has generated.
|
|
1709
|
+
*/
|
|
1710
|
+
content: Array<LanguageModelV3Content>;
|
|
1711
|
+
/**
|
|
1712
|
+
* The finish reason.
|
|
1713
|
+
*/
|
|
1714
|
+
finishReason: LanguageModelV3FinishReason;
|
|
1715
|
+
/**
|
|
1716
|
+
* The usage information.
|
|
1717
|
+
*/
|
|
1718
|
+
usage: LanguageModelV3Usage;
|
|
1719
|
+
/**
|
|
1720
|
+
* Additional provider-specific metadata. They are passed through
|
|
1721
|
+
* from the provider to the AI SDK and enable provider-specific
|
|
1722
|
+
* results that can be fully encapsulated in the provider.
|
|
1723
|
+
*/
|
|
1724
|
+
providerMetadata?: SharedV3ProviderMetadata;
|
|
1725
|
+
/**
|
|
1726
|
+
* Optional request information for telemetry and debugging purposes.
|
|
1727
|
+
*/
|
|
1728
|
+
request?: {
|
|
1729
|
+
/**
|
|
1730
|
+
* Request HTTP body that was sent to the provider API.
|
|
1731
|
+
*/
|
|
1732
|
+
body?: unknown;
|
|
1733
|
+
};
|
|
1734
|
+
/**
|
|
1735
|
+
* Optional response information for telemetry and debugging purposes.
|
|
1736
|
+
*/
|
|
1737
|
+
response?: LanguageModelV3ResponseMetadata & {
|
|
1738
|
+
/**
|
|
1739
|
+
* Response headers.
|
|
1740
|
+
*/
|
|
1741
|
+
headers?: SharedV3Headers;
|
|
1742
|
+
/**
|
|
1743
|
+
* Response HTTP body.
|
|
1744
|
+
*/
|
|
1745
|
+
body?: unknown;
|
|
1746
|
+
};
|
|
1747
|
+
/**
|
|
1748
|
+
* Warnings for the call, e.g. unsupported settings.
|
|
1749
|
+
*/
|
|
1750
|
+
warnings: Array<SharedV3Warning>;
|
|
1751
|
+
};
|
|
1752
|
+
|
|
1703
1753
|
type LanguageModelV3StreamPart = {
|
|
1704
1754
|
type: 'text-start';
|
|
1705
1755
|
providerMetadata?: SharedV3ProviderMetadata;
|
|
@@ -1762,115 +1812,78 @@ type LanguageModelV3StreamPart = {
|
|
|
1762
1812
|
};
|
|
1763
1813
|
|
|
1764
1814
|
/**
|
|
1765
|
-
|
|
1815
|
+
* The result of a language model doStream call.
|
|
1816
|
+
*/
|
|
1817
|
+
type LanguageModelV3StreamResult = {
|
|
1818
|
+
/**
|
|
1819
|
+
* The stream.
|
|
1820
|
+
*/
|
|
1821
|
+
stream: ReadableStream<LanguageModelV3StreamPart>;
|
|
1822
|
+
/**
|
|
1823
|
+
* Optional request information for telemetry and debugging purposes.
|
|
1824
|
+
*/
|
|
1825
|
+
request?: {
|
|
1826
|
+
/**
|
|
1827
|
+
* Request HTTP body that was sent to the provider API.
|
|
1828
|
+
*/
|
|
1829
|
+
body?: unknown;
|
|
1830
|
+
};
|
|
1831
|
+
/**
|
|
1832
|
+
* Optional response data.
|
|
1833
|
+
*/
|
|
1834
|
+
response?: {
|
|
1835
|
+
/**
|
|
1836
|
+
* Response headers.
|
|
1837
|
+
*/
|
|
1838
|
+
headers?: SharedV3Headers;
|
|
1839
|
+
};
|
|
1840
|
+
};
|
|
1841
|
+
|
|
1842
|
+
/**
|
|
1843
|
+
* Specification for a language model that implements the language model interface version 3.
|
|
1766
1844
|
*/
|
|
1767
1845
|
type LanguageModelV3 = {
|
|
1768
1846
|
/**
|
|
1769
|
-
|
|
1847
|
+
* The language model must specify which language model interface version it implements.
|
|
1770
1848
|
*/
|
|
1771
1849
|
readonly specificationVersion: 'v3';
|
|
1772
1850
|
/**
|
|
1773
|
-
|
|
1851
|
+
* Provider ID.
|
|
1774
1852
|
*/
|
|
1775
1853
|
readonly provider: string;
|
|
1776
1854
|
/**
|
|
1777
|
-
|
|
1855
|
+
* Provider-specific model ID.
|
|
1778
1856
|
*/
|
|
1779
1857
|
readonly modelId: string;
|
|
1780
1858
|
/**
|
|
1781
|
-
|
|
1782
|
-
|
|
1783
|
-
|
|
1784
|
-
|
|
1785
|
-
|
|
1786
|
-
|
|
1787
|
-
|
|
1788
|
-
|
|
1789
|
-
|
|
1790
|
-
|
|
1859
|
+
* Supported URL patterns by media type for the provider.
|
|
1860
|
+
*
|
|
1861
|
+
* The keys are media type patterns or full media types (e.g. `*\/*` for everything, `audio/*`, `video/*`, or `application/pdf`).
|
|
1862
|
+
* and the values are arrays of regular expressions that match the URL paths.
|
|
1863
|
+
*
|
|
1864
|
+
* The matching should be against lower-case URLs.
|
|
1865
|
+
*
|
|
1866
|
+
* Matched URLs are supported natively by the model and are not downloaded.
|
|
1867
|
+
*
|
|
1868
|
+
* @returns A map of supported URL patterns by media type (as a promise or a plain object).
|
|
1791
1869
|
*/
|
|
1792
1870
|
supportedUrls: PromiseLike<Record<string, RegExp[]>> | Record<string, RegExp[]>;
|
|
1793
1871
|
/**
|
|
1794
|
-
|
|
1872
|
+
* Generates a language model output (non-streaming).
|
|
1795
1873
|
|
|
1796
|
-
|
|
1797
|
-
|
|
1874
|
+
* Naming: "do" prefix to prevent accidental direct usage of the method
|
|
1875
|
+
* by the user.
|
|
1798
1876
|
*/
|
|
1799
|
-
doGenerate(options: LanguageModelV3CallOptions): PromiseLike<
|
|
1800
|
-
/**
|
|
1801
|
-
Ordered content that the model has generated.
|
|
1802
|
-
*/
|
|
1803
|
-
content: Array<LanguageModelV3Content>;
|
|
1804
|
-
/**
|
|
1805
|
-
Finish reason.
|
|
1806
|
-
*/
|
|
1807
|
-
finishReason: LanguageModelV3FinishReason;
|
|
1808
|
-
/**
|
|
1809
|
-
Usage information.
|
|
1810
|
-
*/
|
|
1811
|
-
usage: LanguageModelV3Usage;
|
|
1812
|
-
/**
|
|
1813
|
-
Additional provider-specific metadata. They are passed through
|
|
1814
|
-
from the provider to the AI SDK and enable provider-specific
|
|
1815
|
-
results that can be fully encapsulated in the provider.
|
|
1816
|
-
*/
|
|
1817
|
-
providerMetadata?: SharedV3ProviderMetadata;
|
|
1818
|
-
/**
|
|
1819
|
-
Optional request information for telemetry and debugging purposes.
|
|
1820
|
-
*/
|
|
1821
|
-
request?: {
|
|
1822
|
-
/**
|
|
1823
|
-
Request HTTP body that was sent to the provider API.
|
|
1824
|
-
*/
|
|
1825
|
-
body?: unknown;
|
|
1826
|
-
};
|
|
1827
|
-
/**
|
|
1828
|
-
Optional response information for telemetry and debugging purposes.
|
|
1829
|
-
*/
|
|
1830
|
-
response?: LanguageModelV3ResponseMetadata & {
|
|
1831
|
-
/**
|
|
1832
|
-
Response headers.
|
|
1833
|
-
*/
|
|
1834
|
-
headers?: SharedV3Headers;
|
|
1835
|
-
/**
|
|
1836
|
-
Response HTTP body.
|
|
1837
|
-
*/
|
|
1838
|
-
body?: unknown;
|
|
1839
|
-
};
|
|
1840
|
-
/**
|
|
1841
|
-
Warnings for the call, e.g. unsupported settings.
|
|
1842
|
-
*/
|
|
1843
|
-
warnings: Array<SharedV3Warning>;
|
|
1844
|
-
}>;
|
|
1877
|
+
doGenerate(options: LanguageModelV3CallOptions): PromiseLike<LanguageModelV3GenerateResult>;
|
|
1845
1878
|
/**
|
|
1846
|
-
|
|
1847
|
-
|
|
1848
|
-
Naming: "do" prefix to prevent accidental direct usage of the method
|
|
1849
|
-
by the user.
|
|
1879
|
+
* Generates a language model output (streaming).
|
|
1850
1880
|
*
|
|
1851
|
-
|
|
1881
|
+
* Naming: "do" prefix to prevent accidental direct usage of the method
|
|
1882
|
+
* by the user.
|
|
1883
|
+
*
|
|
1884
|
+
* @return A stream of higher-level language model output parts.
|
|
1852
1885
|
*/
|
|
1853
|
-
doStream(options: LanguageModelV3CallOptions): PromiseLike<
|
|
1854
|
-
stream: ReadableStream<LanguageModelV3StreamPart>;
|
|
1855
|
-
/**
|
|
1856
|
-
Optional request information for telemetry and debugging purposes.
|
|
1857
|
-
*/
|
|
1858
|
-
request?: {
|
|
1859
|
-
/**
|
|
1860
|
-
Request HTTP body that was sent to the provider API.
|
|
1861
|
-
*/
|
|
1862
|
-
body?: unknown;
|
|
1863
|
-
};
|
|
1864
|
-
/**
|
|
1865
|
-
Optional response data.
|
|
1866
|
-
*/
|
|
1867
|
-
response?: {
|
|
1868
|
-
/**
|
|
1869
|
-
Response headers.
|
|
1870
|
-
*/
|
|
1871
|
-
headers?: SharedV3Headers;
|
|
1872
|
-
};
|
|
1873
|
-
}>;
|
|
1886
|
+
doStream(options: LanguageModelV3CallOptions): PromiseLike<LanguageModelV3StreamResult>;
|
|
1874
1887
|
};
|
|
1875
1888
|
|
|
1876
1889
|
/**
|
|
@@ -1927,11 +1940,11 @@ type LanguageModelV3Middleware = {
|
|
|
1927
1940
|
* @returns A promise that resolves to the result of the generate operation.
|
|
1928
1941
|
*/
|
|
1929
1942
|
wrapGenerate?: (options: {
|
|
1930
|
-
doGenerate: () =>
|
|
1931
|
-
doStream: () =>
|
|
1943
|
+
doGenerate: () => PromiseLike<LanguageModelV3GenerateResult>;
|
|
1944
|
+
doStream: () => PromiseLike<LanguageModelV3StreamResult>;
|
|
1932
1945
|
params: LanguageModelV3CallOptions;
|
|
1933
1946
|
model: LanguageModelV3;
|
|
1934
|
-
}) =>
|
|
1947
|
+
}) => PromiseLike<LanguageModelV3GenerateResult>;
|
|
1935
1948
|
/**
|
|
1936
1949
|
* Wraps the stream operation of the language model.
|
|
1937
1950
|
*
|
|
@@ -1944,11 +1957,11 @@ type LanguageModelV3Middleware = {
|
|
|
1944
1957
|
* @returns A promise that resolves to the result of the stream operation.
|
|
1945
1958
|
*/
|
|
1946
1959
|
wrapStream?: (options: {
|
|
1947
|
-
doGenerate: () =>
|
|
1948
|
-
doStream: () =>
|
|
1960
|
+
doGenerate: () => PromiseLike<LanguageModelV3GenerateResult>;
|
|
1961
|
+
doStream: () => PromiseLike<LanguageModelV3StreamResult>;
|
|
1949
1962
|
params: LanguageModelV3CallOptions;
|
|
1950
1963
|
model: LanguageModelV3;
|
|
1951
|
-
}) => PromiseLike<
|
|
1964
|
+
}) => PromiseLike<LanguageModelV3StreamResult>;
|
|
1952
1965
|
};
|
|
1953
1966
|
|
|
1954
1967
|
/**
|
|
@@ -3656,4 +3669,4 @@ interface ProviderV2 {
|
|
|
3656
3669
|
speechModel?(modelId: string): SpeechModelV2;
|
|
3657
3670
|
}
|
|
3658
3671
|
|
|
3659
|
-
export { AISDKError, APICallError, type EmbeddingModelCallOptions, type EmbeddingModelV2, type EmbeddingModelV2Embedding, type EmbeddingModelV3, type EmbeddingModelV3Embedding, type EmbeddingModelV3Middleware, 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 LanguageModelV3Message, type LanguageModelV3Middleware, type LanguageModelV3Prompt, type LanguageModelV3ProviderTool, type LanguageModelV3Reasoning, type LanguageModelV3ReasoningPart, type LanguageModelV3ResponseMetadata, type LanguageModelV3Source, type LanguageModelV3StreamPart, type LanguageModelV3Text, type LanguageModelV3TextPart, 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 };
|
|
3672
|
+
export { AISDKError, APICallError, type EmbeddingModelCallOptions, type EmbeddingModelV2, type EmbeddingModelV2Embedding, type EmbeddingModelV3, type EmbeddingModelV3Embedding, type EmbeddingModelV3Middleware, 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 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
|
@@ -1700,6 +1700,56 @@ type LanguageModelV3Usage = {
|
|
|
1700
1700
|
raw?: JSONObject;
|
|
1701
1701
|
};
|
|
1702
1702
|
|
|
1703
|
+
/**
|
|
1704
|
+
* The result of a language model doGenerate call.
|
|
1705
|
+
*/
|
|
1706
|
+
type LanguageModelV3GenerateResult = {
|
|
1707
|
+
/**
|
|
1708
|
+
* Ordered content that the model has generated.
|
|
1709
|
+
*/
|
|
1710
|
+
content: Array<LanguageModelV3Content>;
|
|
1711
|
+
/**
|
|
1712
|
+
* The finish reason.
|
|
1713
|
+
*/
|
|
1714
|
+
finishReason: LanguageModelV3FinishReason;
|
|
1715
|
+
/**
|
|
1716
|
+
* The usage information.
|
|
1717
|
+
*/
|
|
1718
|
+
usage: LanguageModelV3Usage;
|
|
1719
|
+
/**
|
|
1720
|
+
* Additional provider-specific metadata. They are passed through
|
|
1721
|
+
* from the provider to the AI SDK and enable provider-specific
|
|
1722
|
+
* results that can be fully encapsulated in the provider.
|
|
1723
|
+
*/
|
|
1724
|
+
providerMetadata?: SharedV3ProviderMetadata;
|
|
1725
|
+
/**
|
|
1726
|
+
* Optional request information for telemetry and debugging purposes.
|
|
1727
|
+
*/
|
|
1728
|
+
request?: {
|
|
1729
|
+
/**
|
|
1730
|
+
* Request HTTP body that was sent to the provider API.
|
|
1731
|
+
*/
|
|
1732
|
+
body?: unknown;
|
|
1733
|
+
};
|
|
1734
|
+
/**
|
|
1735
|
+
* Optional response information for telemetry and debugging purposes.
|
|
1736
|
+
*/
|
|
1737
|
+
response?: LanguageModelV3ResponseMetadata & {
|
|
1738
|
+
/**
|
|
1739
|
+
* Response headers.
|
|
1740
|
+
*/
|
|
1741
|
+
headers?: SharedV3Headers;
|
|
1742
|
+
/**
|
|
1743
|
+
* Response HTTP body.
|
|
1744
|
+
*/
|
|
1745
|
+
body?: unknown;
|
|
1746
|
+
};
|
|
1747
|
+
/**
|
|
1748
|
+
* Warnings for the call, e.g. unsupported settings.
|
|
1749
|
+
*/
|
|
1750
|
+
warnings: Array<SharedV3Warning>;
|
|
1751
|
+
};
|
|
1752
|
+
|
|
1703
1753
|
type LanguageModelV3StreamPart = {
|
|
1704
1754
|
type: 'text-start';
|
|
1705
1755
|
providerMetadata?: SharedV3ProviderMetadata;
|
|
@@ -1762,115 +1812,78 @@ type LanguageModelV3StreamPart = {
|
|
|
1762
1812
|
};
|
|
1763
1813
|
|
|
1764
1814
|
/**
|
|
1765
|
-
|
|
1815
|
+
* The result of a language model doStream call.
|
|
1816
|
+
*/
|
|
1817
|
+
type LanguageModelV3StreamResult = {
|
|
1818
|
+
/**
|
|
1819
|
+
* The stream.
|
|
1820
|
+
*/
|
|
1821
|
+
stream: ReadableStream<LanguageModelV3StreamPart>;
|
|
1822
|
+
/**
|
|
1823
|
+
* Optional request information for telemetry and debugging purposes.
|
|
1824
|
+
*/
|
|
1825
|
+
request?: {
|
|
1826
|
+
/**
|
|
1827
|
+
* Request HTTP body that was sent to the provider API.
|
|
1828
|
+
*/
|
|
1829
|
+
body?: unknown;
|
|
1830
|
+
};
|
|
1831
|
+
/**
|
|
1832
|
+
* Optional response data.
|
|
1833
|
+
*/
|
|
1834
|
+
response?: {
|
|
1835
|
+
/**
|
|
1836
|
+
* Response headers.
|
|
1837
|
+
*/
|
|
1838
|
+
headers?: SharedV3Headers;
|
|
1839
|
+
};
|
|
1840
|
+
};
|
|
1841
|
+
|
|
1842
|
+
/**
|
|
1843
|
+
* Specification for a language model that implements the language model interface version 3.
|
|
1766
1844
|
*/
|
|
1767
1845
|
type LanguageModelV3 = {
|
|
1768
1846
|
/**
|
|
1769
|
-
|
|
1847
|
+
* The language model must specify which language model interface version it implements.
|
|
1770
1848
|
*/
|
|
1771
1849
|
readonly specificationVersion: 'v3';
|
|
1772
1850
|
/**
|
|
1773
|
-
|
|
1851
|
+
* Provider ID.
|
|
1774
1852
|
*/
|
|
1775
1853
|
readonly provider: string;
|
|
1776
1854
|
/**
|
|
1777
|
-
|
|
1855
|
+
* Provider-specific model ID.
|
|
1778
1856
|
*/
|
|
1779
1857
|
readonly modelId: string;
|
|
1780
1858
|
/**
|
|
1781
|
-
|
|
1782
|
-
|
|
1783
|
-
|
|
1784
|
-
|
|
1785
|
-
|
|
1786
|
-
|
|
1787
|
-
|
|
1788
|
-
|
|
1789
|
-
|
|
1790
|
-
|
|
1859
|
+
* Supported URL patterns by media type for the provider.
|
|
1860
|
+
*
|
|
1861
|
+
* The keys are media type patterns or full media types (e.g. `*\/*` for everything, `audio/*`, `video/*`, or `application/pdf`).
|
|
1862
|
+
* and the values are arrays of regular expressions that match the URL paths.
|
|
1863
|
+
*
|
|
1864
|
+
* The matching should be against lower-case URLs.
|
|
1865
|
+
*
|
|
1866
|
+
* Matched URLs are supported natively by the model and are not downloaded.
|
|
1867
|
+
*
|
|
1868
|
+
* @returns A map of supported URL patterns by media type (as a promise or a plain object).
|
|
1791
1869
|
*/
|
|
1792
1870
|
supportedUrls: PromiseLike<Record<string, RegExp[]>> | Record<string, RegExp[]>;
|
|
1793
1871
|
/**
|
|
1794
|
-
|
|
1872
|
+
* Generates a language model output (non-streaming).
|
|
1795
1873
|
|
|
1796
|
-
|
|
1797
|
-
|
|
1874
|
+
* Naming: "do" prefix to prevent accidental direct usage of the method
|
|
1875
|
+
* by the user.
|
|
1798
1876
|
*/
|
|
1799
|
-
doGenerate(options: LanguageModelV3CallOptions): PromiseLike<
|
|
1800
|
-
/**
|
|
1801
|
-
Ordered content that the model has generated.
|
|
1802
|
-
*/
|
|
1803
|
-
content: Array<LanguageModelV3Content>;
|
|
1804
|
-
/**
|
|
1805
|
-
Finish reason.
|
|
1806
|
-
*/
|
|
1807
|
-
finishReason: LanguageModelV3FinishReason;
|
|
1808
|
-
/**
|
|
1809
|
-
Usage information.
|
|
1810
|
-
*/
|
|
1811
|
-
usage: LanguageModelV3Usage;
|
|
1812
|
-
/**
|
|
1813
|
-
Additional provider-specific metadata. They are passed through
|
|
1814
|
-
from the provider to the AI SDK and enable provider-specific
|
|
1815
|
-
results that can be fully encapsulated in the provider.
|
|
1816
|
-
*/
|
|
1817
|
-
providerMetadata?: SharedV3ProviderMetadata;
|
|
1818
|
-
/**
|
|
1819
|
-
Optional request information for telemetry and debugging purposes.
|
|
1820
|
-
*/
|
|
1821
|
-
request?: {
|
|
1822
|
-
/**
|
|
1823
|
-
Request HTTP body that was sent to the provider API.
|
|
1824
|
-
*/
|
|
1825
|
-
body?: unknown;
|
|
1826
|
-
};
|
|
1827
|
-
/**
|
|
1828
|
-
Optional response information for telemetry and debugging purposes.
|
|
1829
|
-
*/
|
|
1830
|
-
response?: LanguageModelV3ResponseMetadata & {
|
|
1831
|
-
/**
|
|
1832
|
-
Response headers.
|
|
1833
|
-
*/
|
|
1834
|
-
headers?: SharedV3Headers;
|
|
1835
|
-
/**
|
|
1836
|
-
Response HTTP body.
|
|
1837
|
-
*/
|
|
1838
|
-
body?: unknown;
|
|
1839
|
-
};
|
|
1840
|
-
/**
|
|
1841
|
-
Warnings for the call, e.g. unsupported settings.
|
|
1842
|
-
*/
|
|
1843
|
-
warnings: Array<SharedV3Warning>;
|
|
1844
|
-
}>;
|
|
1877
|
+
doGenerate(options: LanguageModelV3CallOptions): PromiseLike<LanguageModelV3GenerateResult>;
|
|
1845
1878
|
/**
|
|
1846
|
-
|
|
1847
|
-
|
|
1848
|
-
Naming: "do" prefix to prevent accidental direct usage of the method
|
|
1849
|
-
by the user.
|
|
1879
|
+
* Generates a language model output (streaming).
|
|
1850
1880
|
*
|
|
1851
|
-
|
|
1881
|
+
* Naming: "do" prefix to prevent accidental direct usage of the method
|
|
1882
|
+
* by the user.
|
|
1883
|
+
*
|
|
1884
|
+
* @return A stream of higher-level language model output parts.
|
|
1852
1885
|
*/
|
|
1853
|
-
doStream(options: LanguageModelV3CallOptions): PromiseLike<
|
|
1854
|
-
stream: ReadableStream<LanguageModelV3StreamPart>;
|
|
1855
|
-
/**
|
|
1856
|
-
Optional request information for telemetry and debugging purposes.
|
|
1857
|
-
*/
|
|
1858
|
-
request?: {
|
|
1859
|
-
/**
|
|
1860
|
-
Request HTTP body that was sent to the provider API.
|
|
1861
|
-
*/
|
|
1862
|
-
body?: unknown;
|
|
1863
|
-
};
|
|
1864
|
-
/**
|
|
1865
|
-
Optional response data.
|
|
1866
|
-
*/
|
|
1867
|
-
response?: {
|
|
1868
|
-
/**
|
|
1869
|
-
Response headers.
|
|
1870
|
-
*/
|
|
1871
|
-
headers?: SharedV3Headers;
|
|
1872
|
-
};
|
|
1873
|
-
}>;
|
|
1886
|
+
doStream(options: LanguageModelV3CallOptions): PromiseLike<LanguageModelV3StreamResult>;
|
|
1874
1887
|
};
|
|
1875
1888
|
|
|
1876
1889
|
/**
|
|
@@ -1927,11 +1940,11 @@ type LanguageModelV3Middleware = {
|
|
|
1927
1940
|
* @returns A promise that resolves to the result of the generate operation.
|
|
1928
1941
|
*/
|
|
1929
1942
|
wrapGenerate?: (options: {
|
|
1930
|
-
doGenerate: () =>
|
|
1931
|
-
doStream: () =>
|
|
1943
|
+
doGenerate: () => PromiseLike<LanguageModelV3GenerateResult>;
|
|
1944
|
+
doStream: () => PromiseLike<LanguageModelV3StreamResult>;
|
|
1932
1945
|
params: LanguageModelV3CallOptions;
|
|
1933
1946
|
model: LanguageModelV3;
|
|
1934
|
-
}) =>
|
|
1947
|
+
}) => PromiseLike<LanguageModelV3GenerateResult>;
|
|
1935
1948
|
/**
|
|
1936
1949
|
* Wraps the stream operation of the language model.
|
|
1937
1950
|
*
|
|
@@ -1944,11 +1957,11 @@ type LanguageModelV3Middleware = {
|
|
|
1944
1957
|
* @returns A promise that resolves to the result of the stream operation.
|
|
1945
1958
|
*/
|
|
1946
1959
|
wrapStream?: (options: {
|
|
1947
|
-
doGenerate: () =>
|
|
1948
|
-
doStream: () =>
|
|
1960
|
+
doGenerate: () => PromiseLike<LanguageModelV3GenerateResult>;
|
|
1961
|
+
doStream: () => PromiseLike<LanguageModelV3StreamResult>;
|
|
1949
1962
|
params: LanguageModelV3CallOptions;
|
|
1950
1963
|
model: LanguageModelV3;
|
|
1951
|
-
}) => PromiseLike<
|
|
1964
|
+
}) => PromiseLike<LanguageModelV3StreamResult>;
|
|
1952
1965
|
};
|
|
1953
1966
|
|
|
1954
1967
|
/**
|
|
@@ -3656,4 +3669,4 @@ interface ProviderV2 {
|
|
|
3656
3669
|
speechModel?(modelId: string): SpeechModelV2;
|
|
3657
3670
|
}
|
|
3658
3671
|
|
|
3659
|
-
export { AISDKError, APICallError, type EmbeddingModelCallOptions, type EmbeddingModelV2, type EmbeddingModelV2Embedding, type EmbeddingModelV3, type EmbeddingModelV3Embedding, type EmbeddingModelV3Middleware, 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 LanguageModelV3Message, type LanguageModelV3Middleware, type LanguageModelV3Prompt, type LanguageModelV3ProviderTool, type LanguageModelV3Reasoning, type LanguageModelV3ReasoningPart, type LanguageModelV3ResponseMetadata, type LanguageModelV3Source, type LanguageModelV3StreamPart, type LanguageModelV3Text, type LanguageModelV3TextPart, 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 };
|
|
3672
|
+
export { AISDKError, APICallError, type EmbeddingModelCallOptions, type EmbeddingModelV2, type EmbeddingModelV2Embedding, type EmbeddingModelV3, type EmbeddingModelV3Embedding, type EmbeddingModelV3Middleware, 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 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 };
|