ai 6.0.33 → 6.0.34

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.
Files changed (351) hide show
  1. package/CHANGELOG.md +10 -0
  2. package/dist/index.js +1 -1
  3. package/dist/index.mjs +1 -1
  4. package/dist/internal/index.js +1 -1
  5. package/dist/internal/index.mjs +1 -1
  6. package/docs/02-foundations/03-prompts.mdx +2 -2
  7. package/docs/03-ai-sdk-core/15-tools-and-tool-calling.mdx +1 -1
  8. package/docs/07-reference/01-ai-sdk-core/28-output.mdx +1 -1
  9. package/package.json +6 -4
  10. package/src/agent/agent.ts +116 -0
  11. package/src/agent/create-agent-ui-stream-response.test.ts +258 -0
  12. package/src/agent/create-agent-ui-stream-response.ts +50 -0
  13. package/src/agent/create-agent-ui-stream.ts +73 -0
  14. package/src/agent/index.ts +33 -0
  15. package/src/agent/infer-agent-tools.ts +7 -0
  16. package/src/agent/infer-agent-ui-message.test-d.ts +54 -0
  17. package/src/agent/infer-agent-ui-message.ts +11 -0
  18. package/src/agent/pipe-agent-ui-stream-to-response.ts +52 -0
  19. package/src/agent/tool-loop-agent-on-finish-callback.ts +31 -0
  20. package/src/agent/tool-loop-agent-on-step-finish-callback.ts +11 -0
  21. package/src/agent/tool-loop-agent-settings.ts +182 -0
  22. package/src/agent/tool-loop-agent.test-d.ts +114 -0
  23. package/src/agent/tool-loop-agent.test.ts +442 -0
  24. package/src/agent/tool-loop-agent.ts +114 -0
  25. package/src/embed/__snapshots__/embed-many.test.ts.snap +191 -0
  26. package/src/embed/__snapshots__/embed.test.ts.snap +81 -0
  27. package/src/embed/embed-many-result.ts +53 -0
  28. package/src/embed/embed-many.test.ts +653 -0
  29. package/src/embed/embed-many.ts +378 -0
  30. package/src/embed/embed-result.ts +50 -0
  31. package/src/embed/embed.test.ts +298 -0
  32. package/src/embed/embed.ts +211 -0
  33. package/src/embed/index.ts +4 -0
  34. package/src/error/index.ts +34 -0
  35. package/src/error/invalid-argument-error.ts +34 -0
  36. package/src/error/invalid-stream-part-error.ts +28 -0
  37. package/src/error/invalid-tool-approval-error.ts +26 -0
  38. package/src/error/invalid-tool-input-error.ts +33 -0
  39. package/src/error/no-image-generated-error.ts +39 -0
  40. package/src/error/no-object-generated-error.ts +70 -0
  41. package/src/error/no-output-generated-error.ts +26 -0
  42. package/src/error/no-speech-generated-error.ts +18 -0
  43. package/src/error/no-such-tool-error.ts +35 -0
  44. package/src/error/no-transcript-generated-error.ts +20 -0
  45. package/src/error/tool-call-not-found-for-approval-error.ts +32 -0
  46. package/src/error/tool-call-repair-error.ts +30 -0
  47. package/src/error/unsupported-model-version-error.ts +23 -0
  48. package/src/error/verify-no-object-generated-error.ts +27 -0
  49. package/src/generate-image/generate-image-result.ts +42 -0
  50. package/src/generate-image/generate-image.test.ts +1420 -0
  51. package/src/generate-image/generate-image.ts +360 -0
  52. package/src/generate-image/index.ts +18 -0
  53. package/src/generate-object/__snapshots__/generate-object.test.ts.snap +133 -0
  54. package/src/generate-object/__snapshots__/stream-object.test.ts.snap +297 -0
  55. package/src/generate-object/generate-object-result.ts +67 -0
  56. package/src/generate-object/generate-object.test-d.ts +49 -0
  57. package/src/generate-object/generate-object.test.ts +1191 -0
  58. package/src/generate-object/generate-object.ts +518 -0
  59. package/src/generate-object/index.ts +9 -0
  60. package/src/generate-object/inject-json-instruction.test.ts +181 -0
  61. package/src/generate-object/inject-json-instruction.ts +30 -0
  62. package/src/generate-object/output-strategy.ts +415 -0
  63. package/src/generate-object/parse-and-validate-object-result.ts +111 -0
  64. package/src/generate-object/repair-text.ts +12 -0
  65. package/src/generate-object/stream-object-result.ts +120 -0
  66. package/src/generate-object/stream-object.test-d.ts +74 -0
  67. package/src/generate-object/stream-object.test.ts +1950 -0
  68. package/src/generate-object/stream-object.ts +986 -0
  69. package/src/generate-object/validate-object-generation-input.ts +144 -0
  70. package/src/generate-speech/generate-speech-result.ts +30 -0
  71. package/src/generate-speech/generate-speech.test.ts +300 -0
  72. package/src/generate-speech/generate-speech.ts +190 -0
  73. package/src/generate-speech/generated-audio-file.ts +65 -0
  74. package/src/generate-speech/index.ts +3 -0
  75. package/src/generate-text/__snapshots__/generate-text.test.ts.snap +1872 -0
  76. package/src/generate-text/__snapshots__/stream-text.test.ts.snap +1255 -0
  77. package/src/generate-text/collect-tool-approvals.test.ts +553 -0
  78. package/src/generate-text/collect-tool-approvals.ts +116 -0
  79. package/src/generate-text/content-part.ts +25 -0
  80. package/src/generate-text/execute-tool-call.ts +129 -0
  81. package/src/generate-text/extract-reasoning-content.ts +17 -0
  82. package/src/generate-text/extract-text-content.ts +15 -0
  83. package/src/generate-text/generate-text-result.ts +168 -0
  84. package/src/generate-text/generate-text.test-d.ts +68 -0
  85. package/src/generate-text/generate-text.test.ts +7011 -0
  86. package/src/generate-text/generate-text.ts +1223 -0
  87. package/src/generate-text/generated-file.ts +70 -0
  88. package/src/generate-text/index.ts +57 -0
  89. package/src/generate-text/is-approval-needed.ts +29 -0
  90. package/src/generate-text/output-utils.ts +23 -0
  91. package/src/generate-text/output.test.ts +698 -0
  92. package/src/generate-text/output.ts +590 -0
  93. package/src/generate-text/parse-tool-call.test.ts +570 -0
  94. package/src/generate-text/parse-tool-call.ts +188 -0
  95. package/src/generate-text/prepare-step.ts +103 -0
  96. package/src/generate-text/prune-messages.test.ts +720 -0
  97. package/src/generate-text/prune-messages.ts +167 -0
  98. package/src/generate-text/reasoning-output.ts +20 -0
  99. package/src/generate-text/reasoning.ts +8 -0
  100. package/src/generate-text/response-message.ts +10 -0
  101. package/src/generate-text/run-tools-transformation.test.ts +1143 -0
  102. package/src/generate-text/run-tools-transformation.ts +420 -0
  103. package/src/generate-text/smooth-stream.test.ts +2101 -0
  104. package/src/generate-text/smooth-stream.ts +162 -0
  105. package/src/generate-text/step-result.ts +238 -0
  106. package/src/generate-text/stop-condition.ts +29 -0
  107. package/src/generate-text/stream-text-result.ts +463 -0
  108. package/src/generate-text/stream-text.test-d.ts +200 -0
  109. package/src/generate-text/stream-text.test.ts +19979 -0
  110. package/src/generate-text/stream-text.ts +2505 -0
  111. package/src/generate-text/to-response-messages.test.ts +922 -0
  112. package/src/generate-text/to-response-messages.ts +163 -0
  113. package/src/generate-text/tool-approval-request-output.ts +21 -0
  114. package/src/generate-text/tool-call-repair-function.ts +27 -0
  115. package/src/generate-text/tool-call.ts +47 -0
  116. package/src/generate-text/tool-error.ts +34 -0
  117. package/src/generate-text/tool-output-denied.ts +21 -0
  118. package/src/generate-text/tool-output.ts +7 -0
  119. package/src/generate-text/tool-result.ts +36 -0
  120. package/src/generate-text/tool-set.ts +14 -0
  121. package/src/global.ts +24 -0
  122. package/src/index.ts +50 -0
  123. package/src/logger/index.ts +6 -0
  124. package/src/logger/log-warnings.test.ts +351 -0
  125. package/src/logger/log-warnings.ts +119 -0
  126. package/src/middleware/__snapshots__/simulate-streaming-middleware.test.ts.snap +64 -0
  127. package/src/middleware/add-tool-input-examples-middleware.test.ts +476 -0
  128. package/src/middleware/add-tool-input-examples-middleware.ts +90 -0
  129. package/src/middleware/default-embedding-settings-middleware.test.ts +126 -0
  130. package/src/middleware/default-embedding-settings-middleware.ts +22 -0
  131. package/src/middleware/default-settings-middleware.test.ts +388 -0
  132. package/src/middleware/default-settings-middleware.ts +33 -0
  133. package/src/middleware/extract-json-middleware.test.ts +827 -0
  134. package/src/middleware/extract-json-middleware.ts +197 -0
  135. package/src/middleware/extract-reasoning-middleware.test.ts +1028 -0
  136. package/src/middleware/extract-reasoning-middleware.ts +238 -0
  137. package/src/middleware/index.ts +10 -0
  138. package/src/middleware/simulate-streaming-middleware.test.ts +911 -0
  139. package/src/middleware/simulate-streaming-middleware.ts +79 -0
  140. package/src/middleware/wrap-embedding-model.test.ts +358 -0
  141. package/src/middleware/wrap-embedding-model.ts +86 -0
  142. package/src/middleware/wrap-image-model.test.ts +423 -0
  143. package/src/middleware/wrap-image-model.ts +85 -0
  144. package/src/middleware/wrap-language-model.test.ts +518 -0
  145. package/src/middleware/wrap-language-model.ts +104 -0
  146. package/src/middleware/wrap-provider.test.ts +120 -0
  147. package/src/middleware/wrap-provider.ts +51 -0
  148. package/src/model/as-embedding-model-v3.test.ts +319 -0
  149. package/src/model/as-embedding-model-v3.ts +24 -0
  150. package/src/model/as-image-model-v3.test.ts +409 -0
  151. package/src/model/as-image-model-v3.ts +24 -0
  152. package/src/model/as-language-model-v3.test.ts +508 -0
  153. package/src/model/as-language-model-v3.ts +103 -0
  154. package/src/model/as-provider-v3.ts +36 -0
  155. package/src/model/as-speech-model-v3.test.ts +356 -0
  156. package/src/model/as-speech-model-v3.ts +24 -0
  157. package/src/model/as-transcription-model-v3.test.ts +529 -0
  158. package/src/model/as-transcription-model-v3.ts +24 -0
  159. package/src/model/resolve-model.test.ts +244 -0
  160. package/src/model/resolve-model.ts +126 -0
  161. package/src/prompt/call-settings.ts +148 -0
  162. package/src/prompt/content-part.ts +209 -0
  163. package/src/prompt/convert-to-language-model-prompt.test.ts +2018 -0
  164. package/src/prompt/convert-to-language-model-prompt.ts +442 -0
  165. package/src/prompt/create-tool-model-output.test.ts +508 -0
  166. package/src/prompt/create-tool-model-output.ts +34 -0
  167. package/src/prompt/data-content.test.ts +15 -0
  168. package/src/prompt/data-content.ts +134 -0
  169. package/src/prompt/index.ts +27 -0
  170. package/src/prompt/invalid-data-content-error.ts +29 -0
  171. package/src/prompt/invalid-message-role-error.ts +27 -0
  172. package/src/prompt/message-conversion-error.ts +28 -0
  173. package/src/prompt/message.ts +68 -0
  174. package/src/prompt/prepare-call-settings.test.ts +159 -0
  175. package/src/prompt/prepare-call-settings.ts +108 -0
  176. package/src/prompt/prepare-tools-and-tool-choice.test.ts +461 -0
  177. package/src/prompt/prepare-tools-and-tool-choice.ts +86 -0
  178. package/src/prompt/prompt.ts +43 -0
  179. package/src/prompt/split-data-url.ts +17 -0
  180. package/src/prompt/standardize-prompt.test.ts +82 -0
  181. package/src/prompt/standardize-prompt.ts +99 -0
  182. package/src/prompt/wrap-gateway-error.ts +29 -0
  183. package/src/registry/custom-provider.test.ts +211 -0
  184. package/src/registry/custom-provider.ts +155 -0
  185. package/src/registry/index.ts +7 -0
  186. package/src/registry/no-such-provider-error.ts +41 -0
  187. package/src/registry/provider-registry.test.ts +691 -0
  188. package/src/registry/provider-registry.ts +328 -0
  189. package/src/rerank/index.ts +2 -0
  190. package/src/rerank/rerank-result.ts +70 -0
  191. package/src/rerank/rerank.test.ts +516 -0
  192. package/src/rerank/rerank.ts +237 -0
  193. package/src/telemetry/assemble-operation-name.ts +21 -0
  194. package/src/telemetry/get-base-telemetry-attributes.ts +53 -0
  195. package/src/telemetry/get-tracer.ts +20 -0
  196. package/src/telemetry/noop-tracer.ts +69 -0
  197. package/src/telemetry/record-span.ts +63 -0
  198. package/src/telemetry/select-telemetry-attributes.ts +78 -0
  199. package/src/telemetry/select-temetry-attributes.test.ts +114 -0
  200. package/src/telemetry/stringify-for-telemetry.test.ts +114 -0
  201. package/src/telemetry/stringify-for-telemetry.ts +33 -0
  202. package/src/telemetry/telemetry-settings.ts +44 -0
  203. package/src/test/mock-embedding-model-v2.ts +35 -0
  204. package/src/test/mock-embedding-model-v3.ts +48 -0
  205. package/src/test/mock-image-model-v2.ts +28 -0
  206. package/src/test/mock-image-model-v3.ts +28 -0
  207. package/src/test/mock-language-model-v2.ts +72 -0
  208. package/src/test/mock-language-model-v3.ts +77 -0
  209. package/src/test/mock-provider-v2.ts +68 -0
  210. package/src/test/mock-provider-v3.ts +80 -0
  211. package/src/test/mock-reranking-model-v3.ts +25 -0
  212. package/src/test/mock-server-response.ts +69 -0
  213. package/src/test/mock-speech-model-v2.ts +24 -0
  214. package/src/test/mock-speech-model-v3.ts +24 -0
  215. package/src/test/mock-tracer.ts +156 -0
  216. package/src/test/mock-transcription-model-v2.ts +24 -0
  217. package/src/test/mock-transcription-model-v3.ts +24 -0
  218. package/src/test/mock-values.ts +4 -0
  219. package/src/test/not-implemented.ts +3 -0
  220. package/src/text-stream/create-text-stream-response.test.ts +38 -0
  221. package/src/text-stream/create-text-stream-response.ts +18 -0
  222. package/src/text-stream/index.ts +2 -0
  223. package/src/text-stream/pipe-text-stream-to-response.test.ts +38 -0
  224. package/src/text-stream/pipe-text-stream-to-response.ts +26 -0
  225. package/src/transcribe/index.ts +2 -0
  226. package/src/transcribe/transcribe-result.ts +60 -0
  227. package/src/transcribe/transcribe.test.ts +313 -0
  228. package/src/transcribe/transcribe.ts +173 -0
  229. package/src/types/embedding-model-middleware.ts +3 -0
  230. package/src/types/embedding-model.ts +18 -0
  231. package/src/types/image-model-middleware.ts +3 -0
  232. package/src/types/image-model-response-metadata.ts +16 -0
  233. package/src/types/image-model.ts +19 -0
  234. package/src/types/index.ts +29 -0
  235. package/src/types/json-value.ts +15 -0
  236. package/src/types/language-model-middleware.ts +3 -0
  237. package/src/types/language-model-request-metadata.ts +6 -0
  238. package/src/types/language-model-response-metadata.ts +21 -0
  239. package/src/types/language-model.ts +104 -0
  240. package/src/types/provider-metadata.ts +16 -0
  241. package/src/types/provider.ts +55 -0
  242. package/src/types/reranking-model.ts +6 -0
  243. package/src/types/speech-model-response-metadata.ts +21 -0
  244. package/src/types/speech-model.ts +6 -0
  245. package/src/types/transcription-model-response-metadata.ts +16 -0
  246. package/src/types/transcription-model.ts +9 -0
  247. package/src/types/usage.ts +200 -0
  248. package/src/types/warning.ts +7 -0
  249. package/src/ui/__snapshots__/append-response-messages.test.ts.snap +416 -0
  250. package/src/ui/__snapshots__/convert-to-model-messages.test.ts.snap +419 -0
  251. package/src/ui/__snapshots__/process-chat-text-response.test.ts.snap +142 -0
  252. package/src/ui/call-completion-api.ts +157 -0
  253. package/src/ui/chat-transport.ts +83 -0
  254. package/src/ui/chat.test-d.ts +233 -0
  255. package/src/ui/chat.test.ts +2695 -0
  256. package/src/ui/chat.ts +716 -0
  257. package/src/ui/convert-file-list-to-file-ui-parts.ts +36 -0
  258. package/src/ui/convert-to-model-messages.test.ts +2775 -0
  259. package/src/ui/convert-to-model-messages.ts +373 -0
  260. package/src/ui/default-chat-transport.ts +36 -0
  261. package/src/ui/direct-chat-transport.test.ts +446 -0
  262. package/src/ui/direct-chat-transport.ts +118 -0
  263. package/src/ui/http-chat-transport.test.ts +185 -0
  264. package/src/ui/http-chat-transport.ts +292 -0
  265. package/src/ui/index.ts +71 -0
  266. package/src/ui/last-assistant-message-is-complete-with-approval-responses.ts +44 -0
  267. package/src/ui/last-assistant-message-is-complete-with-tool-calls.test.ts +371 -0
  268. package/src/ui/last-assistant-message-is-complete-with-tool-calls.ts +39 -0
  269. package/src/ui/process-text-stream.test.ts +38 -0
  270. package/src/ui/process-text-stream.ts +16 -0
  271. package/src/ui/process-ui-message-stream.test.ts +8052 -0
  272. package/src/ui/process-ui-message-stream.ts +713 -0
  273. package/src/ui/text-stream-chat-transport.ts +23 -0
  274. package/src/ui/transform-text-to-ui-message-stream.test.ts +124 -0
  275. package/src/ui/transform-text-to-ui-message-stream.ts +27 -0
  276. package/src/ui/ui-messages.test.ts +48 -0
  277. package/src/ui/ui-messages.ts +534 -0
  278. package/src/ui/use-completion.ts +84 -0
  279. package/src/ui/validate-ui-messages.test.ts +1428 -0
  280. package/src/ui/validate-ui-messages.ts +476 -0
  281. package/src/ui-message-stream/create-ui-message-stream-response.test.ts +266 -0
  282. package/src/ui-message-stream/create-ui-message-stream-response.ts +32 -0
  283. package/src/ui-message-stream/create-ui-message-stream.test.ts +639 -0
  284. package/src/ui-message-stream/create-ui-message-stream.ts +124 -0
  285. package/src/ui-message-stream/get-response-ui-message-id.test.ts +55 -0
  286. package/src/ui-message-stream/get-response-ui-message-id.ts +24 -0
  287. package/src/ui-message-stream/handle-ui-message-stream-finish.test.ts +429 -0
  288. package/src/ui-message-stream/handle-ui-message-stream-finish.ts +135 -0
  289. package/src/ui-message-stream/index.ts +13 -0
  290. package/src/ui-message-stream/json-to-sse-transform-stream.ts +12 -0
  291. package/src/ui-message-stream/pipe-ui-message-stream-to-response.test.ts +90 -0
  292. package/src/ui-message-stream/pipe-ui-message-stream-to-response.ts +40 -0
  293. package/src/ui-message-stream/read-ui-message-stream.test.ts +122 -0
  294. package/src/ui-message-stream/read-ui-message-stream.ts +87 -0
  295. package/src/ui-message-stream/ui-message-chunks.test-d.ts +18 -0
  296. package/src/ui-message-stream/ui-message-chunks.ts +344 -0
  297. package/src/ui-message-stream/ui-message-stream-headers.ts +7 -0
  298. package/src/ui-message-stream/ui-message-stream-on-finish-callback.ts +32 -0
  299. package/src/ui-message-stream/ui-message-stream-response-init.ts +5 -0
  300. package/src/ui-message-stream/ui-message-stream-writer.ts +24 -0
  301. package/src/util/as-array.ts +3 -0
  302. package/src/util/async-iterable-stream.test.ts +241 -0
  303. package/src/util/async-iterable-stream.ts +94 -0
  304. package/src/util/consume-stream.ts +29 -0
  305. package/src/util/cosine-similarity.test.ts +57 -0
  306. package/src/util/cosine-similarity.ts +47 -0
  307. package/src/util/create-resolvable-promise.ts +30 -0
  308. package/src/util/create-stitchable-stream.test.ts +239 -0
  309. package/src/util/create-stitchable-stream.ts +112 -0
  310. package/src/util/data-url.ts +17 -0
  311. package/src/util/deep-partial.ts +84 -0
  312. package/src/util/detect-media-type.test.ts +670 -0
  313. package/src/util/detect-media-type.ts +184 -0
  314. package/src/util/download/download-function.ts +45 -0
  315. package/src/util/download/download.test.ts +69 -0
  316. package/src/util/download/download.ts +46 -0
  317. package/src/util/error-handler.ts +1 -0
  318. package/src/util/fix-json.test.ts +279 -0
  319. package/src/util/fix-json.ts +401 -0
  320. package/src/util/get-potential-start-index.test.ts +34 -0
  321. package/src/util/get-potential-start-index.ts +30 -0
  322. package/src/util/index.ts +11 -0
  323. package/src/util/is-deep-equal-data.test.ts +119 -0
  324. package/src/util/is-deep-equal-data.ts +48 -0
  325. package/src/util/is-non-empty-object.ts +5 -0
  326. package/src/util/job.ts +1 -0
  327. package/src/util/log-v2-compatibility-warning.ts +21 -0
  328. package/src/util/merge-abort-signals.test.ts +155 -0
  329. package/src/util/merge-abort-signals.ts +43 -0
  330. package/src/util/merge-objects.test.ts +118 -0
  331. package/src/util/merge-objects.ts +79 -0
  332. package/src/util/now.ts +4 -0
  333. package/src/util/parse-partial-json.test.ts +80 -0
  334. package/src/util/parse-partial-json.ts +30 -0
  335. package/src/util/prepare-headers.test.ts +51 -0
  336. package/src/util/prepare-headers.ts +14 -0
  337. package/src/util/prepare-retries.test.ts +10 -0
  338. package/src/util/prepare-retries.ts +47 -0
  339. package/src/util/retry-error.ts +41 -0
  340. package/src/util/retry-with-exponential-backoff.test.ts +446 -0
  341. package/src/util/retry-with-exponential-backoff.ts +154 -0
  342. package/src/util/serial-job-executor.test.ts +162 -0
  343. package/src/util/serial-job-executor.ts +36 -0
  344. package/src/util/simulate-readable-stream.test.ts +98 -0
  345. package/src/util/simulate-readable-stream.ts +39 -0
  346. package/src/util/split-array.test.ts +60 -0
  347. package/src/util/split-array.ts +20 -0
  348. package/src/util/value-of.ts +65 -0
  349. package/src/util/write-to-server-response.test.ts +266 -0
  350. package/src/util/write-to-server-response.ts +49 -0
  351. package/src/version.ts +5 -0
@@ -0,0 +1,1191 @@
1
+ import {
2
+ JSONParseError,
3
+ SharedV3Warning,
4
+ TypeValidationError,
5
+ } from '@ai-sdk/provider';
6
+ import { jsonSchema } from '@ai-sdk/provider-utils';
7
+ import { convertReadableStreamToArray } from '@ai-sdk/provider-utils/test';
8
+ import assert, { fail } from 'node:assert';
9
+ import {
10
+ afterEach,
11
+ beforeEach,
12
+ describe,
13
+ expect,
14
+ it,
15
+ vitest,
16
+ vi,
17
+ } from 'vitest';
18
+ import { z } from 'zod/v4';
19
+ import { verifyNoObjectGeneratedError as originalVerifyNoObjectGeneratedError } from '../error/verify-no-object-generated-error';
20
+ import * as logWarningsModule from '../logger/log-warnings';
21
+ import { MockLanguageModelV3 } from '../test/mock-language-model-v3';
22
+ import { MockTracer } from '../test/mock-tracer';
23
+ import { generateObject } from './generate-object';
24
+
25
+ vi.mock('../version', () => {
26
+ return {
27
+ VERSION: '0.0.0-test',
28
+ };
29
+ });
30
+
31
+ const dummyResponseValues = {
32
+ finishReason: { unified: 'stop', raw: 'stop' } as const,
33
+ usage: {
34
+ inputTokens: {
35
+ total: 10,
36
+ noCache: 10,
37
+ cacheRead: undefined,
38
+ cacheWrite: undefined,
39
+ },
40
+ outputTokens: {
41
+ total: 20,
42
+ text: 20,
43
+ reasoning: undefined,
44
+ },
45
+ },
46
+ response: { id: 'id-1', timestamp: new Date(123), modelId: 'm-1' },
47
+ warnings: [],
48
+ };
49
+
50
+ describe('generateObject', () => {
51
+ let logWarningsSpy: ReturnType<typeof vitest.spyOn>;
52
+
53
+ beforeEach(() => {
54
+ logWarningsSpy = vitest
55
+ .spyOn(logWarningsModule, 'logWarnings')
56
+ .mockImplementation(() => {});
57
+ });
58
+
59
+ afterEach(() => {
60
+ logWarningsSpy.mockRestore();
61
+ });
62
+
63
+ describe('output = "object"', () => {
64
+ describe('result.object', () => {
65
+ it('should generate object', async () => {
66
+ const model = new MockLanguageModelV3({
67
+ doGenerate: {
68
+ ...dummyResponseValues,
69
+ content: [{ type: 'text', text: '{ "content": "Hello, world!" }' }],
70
+ },
71
+ });
72
+ const result = await generateObject({
73
+ model,
74
+ schema: z.object({ content: z.string() }),
75
+ prompt: 'prompt',
76
+ });
77
+
78
+ expect(result.object).toMatchInlineSnapshot(`
79
+ {
80
+ "content": "Hello, world!",
81
+ }
82
+ `);
83
+ expect(model.doGenerateCalls[0].prompt).toMatchInlineSnapshot(`
84
+ [
85
+ {
86
+ "content": [
87
+ {
88
+ "text": "prompt",
89
+ "type": "text",
90
+ },
91
+ ],
92
+ "providerOptions": undefined,
93
+ "role": "user",
94
+ },
95
+ ]
96
+ `);
97
+ expect(model.doGenerateCalls[0].responseFormat).toMatchInlineSnapshot(`
98
+ {
99
+ "description": undefined,
100
+ "name": undefined,
101
+ "schema": {
102
+ "$schema": "http://json-schema.org/draft-07/schema#",
103
+ "additionalProperties": false,
104
+ "properties": {
105
+ "content": {
106
+ "type": "string",
107
+ },
108
+ },
109
+ "required": [
110
+ "content",
111
+ ],
112
+ "type": "object",
113
+ },
114
+ "type": "json",
115
+ }
116
+ `);
117
+ });
118
+
119
+ it('should use name and description', async () => {
120
+ const result = await generateObject({
121
+ model: new MockLanguageModelV3({
122
+ doGenerate: async ({ prompt, responseFormat }) => {
123
+ expect(responseFormat).toStrictEqual({
124
+ type: 'json',
125
+ name: 'test-name',
126
+ description: 'test description',
127
+ schema: {
128
+ $schema: 'http://json-schema.org/draft-07/schema#',
129
+ additionalProperties: false,
130
+ properties: { content: { type: 'string' } },
131
+ required: ['content'],
132
+ type: 'object',
133
+ },
134
+ });
135
+
136
+ expect(prompt).toStrictEqual([
137
+ {
138
+ role: 'user',
139
+ content: [{ type: 'text', text: 'prompt' }],
140
+ providerOptions: undefined,
141
+ },
142
+ ]);
143
+
144
+ return {
145
+ ...dummyResponseValues,
146
+ content: [
147
+ { type: 'text', text: '{ "content": "Hello, world!" }' },
148
+ ],
149
+ };
150
+ },
151
+ }),
152
+ schema: z.object({ content: z.string() }),
153
+ schemaName: 'test-name',
154
+ schemaDescription: 'test description',
155
+ prompt: 'prompt',
156
+ });
157
+
158
+ assert.deepStrictEqual(result.object, { content: 'Hello, world!' });
159
+ });
160
+ });
161
+
162
+ it('should return warnings', async () => {
163
+ const result = await generateObject({
164
+ model: new MockLanguageModelV3({
165
+ doGenerate: async () => ({
166
+ ...dummyResponseValues,
167
+ content: [{ type: 'text', text: '{ "content": "Hello, world!" }' }],
168
+ warnings: [
169
+ {
170
+ type: 'other',
171
+ message: 'Setting is not supported',
172
+ },
173
+ ],
174
+ }),
175
+ }),
176
+ schema: z.object({ content: z.string() }),
177
+ prompt: 'prompt',
178
+ });
179
+
180
+ expect(result.warnings).toStrictEqual([
181
+ {
182
+ type: 'other',
183
+ message: 'Setting is not supported',
184
+ },
185
+ ]);
186
+ });
187
+
188
+ it('should call logWarnings with the correct warnings', async () => {
189
+ const expectedWarnings: SharedV3Warning[] = [
190
+ {
191
+ type: 'other',
192
+ message: 'Setting is not supported',
193
+ },
194
+ {
195
+ type: 'unsupported',
196
+ feature: 'temperature',
197
+ details: 'Temperature parameter not supported',
198
+ },
199
+ ];
200
+
201
+ await generateObject({
202
+ model: new MockLanguageModelV3({
203
+ doGenerate: async () => ({
204
+ ...dummyResponseValues,
205
+ content: [{ type: 'text', text: '{ "content": "Hello, world!" }' }],
206
+ warnings: expectedWarnings,
207
+ }),
208
+ }),
209
+ schema: z.object({ content: z.string() }),
210
+ prompt: 'prompt',
211
+ });
212
+
213
+ expect(logWarningsSpy).toHaveBeenCalledOnce();
214
+ expect(logWarningsSpy).toHaveBeenCalledWith({
215
+ warnings: expectedWarnings,
216
+ provider: 'mock-provider',
217
+ model: 'mock-model-id',
218
+ });
219
+ });
220
+
221
+ it('should call logWarnings with empty array when no warnings are present', async () => {
222
+ await generateObject({
223
+ model: new MockLanguageModelV3({
224
+ doGenerate: async () => ({
225
+ ...dummyResponseValues,
226
+ content: [{ type: 'text', text: '{ "content": "Hello, world!" }' }],
227
+ warnings: [], // no warnings
228
+ }),
229
+ }),
230
+ schema: z.object({ content: z.string() }),
231
+ prompt: 'prompt',
232
+ });
233
+
234
+ expect(logWarningsSpy).toHaveBeenCalledOnce();
235
+ expect(logWarningsSpy).toHaveBeenCalledWith({
236
+ warnings: [],
237
+ provider: 'mock-provider',
238
+ model: 'mock-model-id',
239
+ });
240
+ });
241
+
242
+ describe('result.request', () => {
243
+ it('should contain request information', async () => {
244
+ const result = await generateObject({
245
+ model: new MockLanguageModelV3({
246
+ doGenerate: async () => ({
247
+ ...dummyResponseValues,
248
+ content: [
249
+ { type: 'text', text: '{ "content": "Hello, world!" }' },
250
+ ],
251
+ request: {
252
+ body: 'test body',
253
+ },
254
+ }),
255
+ }),
256
+ schema: z.object({ content: z.string() }),
257
+ prompt: 'prompt',
258
+ });
259
+
260
+ expect(result.request).toStrictEqual({
261
+ body: 'test body',
262
+ });
263
+ });
264
+ });
265
+
266
+ describe('result.response', () => {
267
+ it('should contain response information', async () => {
268
+ const result = await generateObject({
269
+ model: new MockLanguageModelV3({
270
+ doGenerate: async () => ({
271
+ ...dummyResponseValues,
272
+ content: [
273
+ { type: 'text', text: '{ "content": "Hello, world!" }' },
274
+ ],
275
+ response: {
276
+ id: 'test-id-from-model',
277
+ timestamp: new Date(10000),
278
+ modelId: 'test-response-model-id',
279
+ headers: {
280
+ 'custom-response-header': 'response-header-value',
281
+ 'user-agent': 'ai/0.0.0-test',
282
+ },
283
+ body: 'test body',
284
+ },
285
+ }),
286
+ }),
287
+ schema: z.object({ content: z.string() }),
288
+ prompt: 'prompt',
289
+ });
290
+
291
+ expect(result.response).toStrictEqual({
292
+ id: 'test-id-from-model',
293
+ timestamp: new Date(10000),
294
+ modelId: 'test-response-model-id',
295
+ headers: {
296
+ 'custom-response-header': 'response-header-value',
297
+ 'user-agent': 'ai/0.0.0-test',
298
+ },
299
+ body: 'test body',
300
+ });
301
+ });
302
+ });
303
+
304
+ describe('zod schema', () => {
305
+ it('should generate object when using zod transform', async () => {
306
+ const model = new MockLanguageModelV3({
307
+ doGenerate: {
308
+ ...dummyResponseValues,
309
+ content: [{ type: 'text', text: '{ "content": "Hello, world!" }' }],
310
+ },
311
+ });
312
+
313
+ const result = await generateObject({
314
+ model,
315
+ schema: z.object({
316
+ content: z
317
+ .string()
318
+ .transform(value => value.length)
319
+ .pipe(z.number()),
320
+ }),
321
+ prompt: 'prompt',
322
+ });
323
+
324
+ expect(result.object).toMatchInlineSnapshot(`
325
+ {
326
+ "content": 13,
327
+ }
328
+ `);
329
+ expect(model.doGenerateCalls[0].prompt).toMatchInlineSnapshot(`
330
+ [
331
+ {
332
+ "content": [
333
+ {
334
+ "text": "prompt",
335
+ "type": "text",
336
+ },
337
+ ],
338
+ "providerOptions": undefined,
339
+ "role": "user",
340
+ },
341
+ ]
342
+ `);
343
+ expect(model.doGenerateCalls[0].responseFormat).toMatchInlineSnapshot(`
344
+ {
345
+ "description": undefined,
346
+ "name": undefined,
347
+ "schema": {
348
+ "$schema": "http://json-schema.org/draft-07/schema#",
349
+ "additionalProperties": false,
350
+ "properties": {
351
+ "content": {
352
+ "type": "string",
353
+ },
354
+ },
355
+ "required": [
356
+ "content",
357
+ ],
358
+ "type": "object",
359
+ },
360
+ "type": "json",
361
+ }
362
+ `);
363
+ });
364
+
365
+ it('should generate object when using zod prePreprocess', async () => {
366
+ const model = new MockLanguageModelV3({
367
+ doGenerate: {
368
+ ...dummyResponseValues,
369
+ content: [{ type: 'text', text: '{ "content": "Hello, world!" }' }],
370
+ },
371
+ });
372
+
373
+ const result = await generateObject({
374
+ model,
375
+ schema: z.object({
376
+ content: z.preprocess(
377
+ val => (typeof val === 'number' ? String(val) : val),
378
+ z.string(),
379
+ ),
380
+ }),
381
+ prompt: 'prompt',
382
+ });
383
+
384
+ expect(result.object).toMatchInlineSnapshot(`
385
+ {
386
+ "content": "Hello, world!",
387
+ }
388
+ `);
389
+ expect(model.doGenerateCalls[0].prompt).toMatchInlineSnapshot(`
390
+ [
391
+ {
392
+ "content": [
393
+ {
394
+ "text": "prompt",
395
+ "type": "text",
396
+ },
397
+ ],
398
+ "providerOptions": undefined,
399
+ "role": "user",
400
+ },
401
+ ]
402
+ `);
403
+ expect(model.doGenerateCalls[0].responseFormat).toMatchInlineSnapshot(`
404
+ {
405
+ "description": undefined,
406
+ "name": undefined,
407
+ "schema": {
408
+ "$schema": "http://json-schema.org/draft-07/schema#",
409
+ "additionalProperties": false,
410
+ "properties": {
411
+ "content": {
412
+ "type": "string",
413
+ },
414
+ },
415
+ "required": [
416
+ "content",
417
+ ],
418
+ "type": "object",
419
+ },
420
+ "type": "json",
421
+ }
422
+ `);
423
+ });
424
+ });
425
+
426
+ describe('custom schema', () => {
427
+ it('should generate object', async () => {
428
+ const model = new MockLanguageModelV3({
429
+ doGenerate: {
430
+ ...dummyResponseValues,
431
+ content: [{ type: 'text', text: '{ "content": "Hello, world!" }' }],
432
+ },
433
+ });
434
+
435
+ const result = await generateObject({
436
+ model,
437
+ schema: jsonSchema({
438
+ type: 'object',
439
+ properties: { content: { type: 'string' } },
440
+ required: ['content'],
441
+ additionalProperties: false,
442
+ }),
443
+ prompt: 'prompt',
444
+ });
445
+
446
+ expect(result.object).toMatchInlineSnapshot(`
447
+ {
448
+ "content": "Hello, world!",
449
+ }
450
+ `);
451
+ expect(model.doGenerateCalls[0].prompt).toMatchInlineSnapshot(`
452
+ [
453
+ {
454
+ "content": [
455
+ {
456
+ "text": "prompt",
457
+ "type": "text",
458
+ },
459
+ ],
460
+ "providerOptions": undefined,
461
+ "role": "user",
462
+ },
463
+ ]
464
+ `);
465
+ expect(model.doGenerateCalls[0].responseFormat).toMatchInlineSnapshot(`
466
+ {
467
+ "description": undefined,
468
+ "name": undefined,
469
+ "schema": {
470
+ "additionalProperties": false,
471
+ "properties": {
472
+ "content": {
473
+ "type": "string",
474
+ },
475
+ },
476
+ "required": [
477
+ "content",
478
+ ],
479
+ "type": "object",
480
+ },
481
+ "type": "json",
482
+ }
483
+ `);
484
+ });
485
+ });
486
+
487
+ describe('result.toJsonResponse', () => {
488
+ it('should return JSON response', async () => {
489
+ const result = await generateObject({
490
+ model: new MockLanguageModelV3({
491
+ doGenerate: async ({}) => ({
492
+ ...dummyResponseValues,
493
+ content: [
494
+ { type: 'text', text: '{ "content": "Hello, world!" }' },
495
+ ],
496
+ }),
497
+ }),
498
+ schema: z.object({ content: z.string() }),
499
+ prompt: 'prompt',
500
+ });
501
+
502
+ const response = result.toJsonResponse();
503
+
504
+ assert.strictEqual(response.status, 200);
505
+ assert.strictEqual(
506
+ response.headers.get('Content-Type'),
507
+ 'application/json; charset=utf-8',
508
+ );
509
+
510
+ assert.deepStrictEqual(
511
+ await convertReadableStreamToArray(
512
+ response.body!.pipeThrough(new TextDecoderStream()),
513
+ ),
514
+ ['{"content":"Hello, world!"}'],
515
+ );
516
+ });
517
+ });
518
+
519
+ describe('result.providerMetadata', () => {
520
+ it('should contain provider metadata', async () => {
521
+ const result = await generateObject({
522
+ model: new MockLanguageModelV3({
523
+ doGenerate: async ({}) => ({
524
+ ...dummyResponseValues,
525
+ content: [
526
+ { type: 'text', text: '{ "content": "Hello, world!" }' },
527
+ ],
528
+ providerMetadata: {
529
+ exampleProvider: {
530
+ a: 10,
531
+ b: 20,
532
+ },
533
+ },
534
+ }),
535
+ }),
536
+ schema: z.object({ content: z.string() }),
537
+ prompt: 'prompt',
538
+ });
539
+
540
+ expect(result.providerMetadata).toStrictEqual({
541
+ exampleProvider: {
542
+ a: 10,
543
+ b: 20,
544
+ },
545
+ });
546
+ });
547
+ });
548
+
549
+ describe('options.headers', () => {
550
+ it('should pass headers to model', async () => {
551
+ const result = await generateObject({
552
+ model: new MockLanguageModelV3({
553
+ doGenerate: async ({ headers }) => {
554
+ expect(headers).toStrictEqual({
555
+ 'custom-request-header': 'request-header-value',
556
+ 'user-agent': 'ai/0.0.0-test',
557
+ });
558
+
559
+ return {
560
+ ...dummyResponseValues,
561
+ content: [
562
+ { type: 'text', text: '{ "content": "headers test" }' },
563
+ ],
564
+ };
565
+ },
566
+ }),
567
+ schema: z.object({ content: z.string() }),
568
+ prompt: 'prompt',
569
+ headers: { 'custom-request-header': 'request-header-value' },
570
+ });
571
+
572
+ expect(result.object).toStrictEqual({ content: 'headers test' });
573
+ });
574
+ });
575
+
576
+ describe('options.repairText', () => {
577
+ it('should be able to repair a JSONParseError', async () => {
578
+ const result = await generateObject({
579
+ model: new MockLanguageModelV3({
580
+ doGenerate: async ({}) => {
581
+ return {
582
+ ...dummyResponseValues,
583
+ content: [
584
+ {
585
+ type: 'text',
586
+ text: '{ "content": "provider metadata test" ',
587
+ },
588
+ ],
589
+ };
590
+ },
591
+ }),
592
+ schema: z.object({ content: z.string() }),
593
+ prompt: 'prompt',
594
+ experimental_repairText: async ({ text, error }) => {
595
+ expect(error).toBeInstanceOf(JSONParseError);
596
+ expect(text).toStrictEqual(
597
+ '{ "content": "provider metadata test" ',
598
+ );
599
+ return text + '}';
600
+ },
601
+ });
602
+
603
+ expect(result.object).toStrictEqual({
604
+ content: 'provider metadata test',
605
+ });
606
+ });
607
+
608
+ it('should be able to repair a TypeValidationError', async () => {
609
+ const result = await generateObject({
610
+ model: new MockLanguageModelV3({
611
+ doGenerate: async ({}) => {
612
+ return {
613
+ ...dummyResponseValues,
614
+ content: [
615
+ {
616
+ type: 'text',
617
+ text: '{ "content-a": "provider metadata test" }',
618
+ },
619
+ ],
620
+ };
621
+ },
622
+ }),
623
+ schema: z.object({ content: z.string() }),
624
+ prompt: 'prompt',
625
+ experimental_repairText: async ({ text, error }) => {
626
+ expect(error).toBeInstanceOf(TypeValidationError);
627
+ expect(text).toStrictEqual(
628
+ '{ "content-a": "provider metadata test" }',
629
+ );
630
+ return `{ "content": "provider metadata test" }`;
631
+ },
632
+ });
633
+
634
+ expect(result.object).toStrictEqual({
635
+ content: 'provider metadata test',
636
+ });
637
+ });
638
+
639
+ it('should be able to handle repair that returns null', async () => {
640
+ const result = generateObject({
641
+ model: new MockLanguageModelV3({
642
+ doGenerate: async ({}) => {
643
+ return {
644
+ ...dummyResponseValues,
645
+ content: [
646
+ {
647
+ type: 'text',
648
+ text: '{ "content-a": "provider metadata test" }',
649
+ },
650
+ ],
651
+ };
652
+ },
653
+ }),
654
+ schema: z.object({ content: z.string() }),
655
+ prompt: 'prompt',
656
+ experimental_repairText: async ({ text, error }) => {
657
+ expect(error).toBeInstanceOf(TypeValidationError);
658
+ expect(text).toStrictEqual(
659
+ '{ "content-a": "provider metadata test" }',
660
+ );
661
+ return null;
662
+ },
663
+ });
664
+
665
+ expect(result).rejects.toThrow(
666
+ 'No object generated: response did not match schema.',
667
+ );
668
+ });
669
+ });
670
+
671
+ describe('options.providerOptions', () => {
672
+ it('should pass provider options to model', async () => {
673
+ const result = await generateObject({
674
+ model: new MockLanguageModelV3({
675
+ doGenerate: async ({ providerOptions }) => {
676
+ expect(providerOptions).toStrictEqual({
677
+ aProvider: { someKey: 'someValue' },
678
+ });
679
+
680
+ return {
681
+ ...dummyResponseValues,
682
+ content: [
683
+ {
684
+ type: 'text',
685
+ text: '{ "content": "provider metadata test" }',
686
+ },
687
+ ],
688
+ };
689
+ },
690
+ }),
691
+ schema: z.object({ content: z.string() }),
692
+ prompt: 'prompt',
693
+ providerOptions: {
694
+ aProvider: { someKey: 'someValue' },
695
+ },
696
+ });
697
+
698
+ expect(result.object).toStrictEqual({
699
+ content: 'provider metadata test',
700
+ });
701
+ });
702
+ });
703
+
704
+ describe('error handling', () => {
705
+ function verifyNoObjectGeneratedError(
706
+ error: unknown,
707
+ { message }: { message: string },
708
+ ) {
709
+ originalVerifyNoObjectGeneratedError(error, {
710
+ message,
711
+ response: {
712
+ id: 'id-1',
713
+ timestamp: new Date(123),
714
+ modelId: 'm-1',
715
+ },
716
+ usage: {
717
+ inputTokens: 10,
718
+ inputTokenDetails: {
719
+ noCacheTokens: 10,
720
+ cacheReadTokens: undefined,
721
+ cacheWriteTokens: undefined,
722
+ },
723
+ outputTokens: 20,
724
+ outputTokenDetails: {
725
+ textTokens: 20,
726
+ reasoningTokens: undefined,
727
+ },
728
+ totalTokens: 30,
729
+ reasoningTokens: undefined,
730
+ cachedInputTokens: undefined,
731
+ },
732
+ finishReason: 'stop',
733
+ });
734
+ }
735
+
736
+ it('should throw NoObjectGeneratedError when schema validation fails', async () => {
737
+ try {
738
+ await generateObject({
739
+ model: new MockLanguageModelV3({
740
+ doGenerate: async ({}) => ({
741
+ ...dummyResponseValues,
742
+ content: [{ type: 'text', text: '{ "content": 123 }' }],
743
+ }),
744
+ }),
745
+ schema: z.object({ content: z.string() }),
746
+ prompt: 'prompt',
747
+ });
748
+
749
+ fail('must throw error');
750
+ } catch (error) {
751
+ verifyNoObjectGeneratedError(error, {
752
+ message: 'No object generated: response did not match schema.',
753
+ });
754
+ }
755
+ });
756
+
757
+ it('should throw NoObjectGeneratedError when parsing fails', async () => {
758
+ try {
759
+ await generateObject({
760
+ model: new MockLanguageModelV3({
761
+ doGenerate: async ({}) => ({
762
+ ...dummyResponseValues,
763
+ content: [{ type: 'text', text: '{ broken json' }],
764
+ }),
765
+ }),
766
+ schema: z.object({ content: z.string() }),
767
+ prompt: 'prompt',
768
+ });
769
+
770
+ fail('must throw error');
771
+ } catch (error) {
772
+ verifyNoObjectGeneratedError(error, {
773
+ message: 'No object generated: could not parse the response.',
774
+ });
775
+ }
776
+ });
777
+
778
+ it('should throw NoObjectGeneratedError when parsing fails with repairResponse', async () => {
779
+ try {
780
+ await generateObject({
781
+ model: new MockLanguageModelV3({
782
+ doGenerate: async ({}) => ({
783
+ ...dummyResponseValues,
784
+ content: [{ type: 'text', text: '{ broken json' }],
785
+ }),
786
+ }),
787
+ schema: z.object({ content: z.string() }),
788
+ prompt: 'prompt',
789
+ experimental_repairText: async ({ text }) => text + '{',
790
+ });
791
+
792
+ fail('must throw error');
793
+ } catch (error) {
794
+ verifyNoObjectGeneratedError(error, {
795
+ message: 'No object generated: could not parse the response.',
796
+ });
797
+ }
798
+ });
799
+
800
+ it('should throw NoObjectGeneratedError when no text is available', async () => {
801
+ try {
802
+ await generateObject({
803
+ model: new MockLanguageModelV3({
804
+ doGenerate: async ({}) => ({
805
+ ...dummyResponseValues,
806
+ content: [],
807
+ }),
808
+ }),
809
+ schema: z.object({ content: z.string() }),
810
+ prompt: 'prompt',
811
+ });
812
+
813
+ fail('must throw error');
814
+ } catch (error) {
815
+ verifyNoObjectGeneratedError(error, {
816
+ message:
817
+ 'No object generated: the model did not return a response.',
818
+ });
819
+ }
820
+ });
821
+ });
822
+ });
823
+
824
+ describe('output = "array"', () => {
825
+ it('should generate an array with 3 elements', async () => {
826
+ const model = new MockLanguageModelV3({
827
+ doGenerate: {
828
+ ...dummyResponseValues,
829
+ content: [
830
+ {
831
+ type: 'text',
832
+ text: JSON.stringify({
833
+ elements: [
834
+ { content: 'element 1' },
835
+ { content: 'element 2' },
836
+ { content: 'element 3' },
837
+ ],
838
+ }),
839
+ },
840
+ ],
841
+ },
842
+ });
843
+
844
+ const result = await generateObject({
845
+ model,
846
+ schema: z.object({ content: z.string() }),
847
+ output: 'array',
848
+ prompt: 'prompt',
849
+ });
850
+
851
+ expect(result.object).toMatchInlineSnapshot(`
852
+ [
853
+ {
854
+ "content": "element 1",
855
+ },
856
+ {
857
+ "content": "element 2",
858
+ },
859
+ {
860
+ "content": "element 3",
861
+ },
862
+ ]
863
+ `);
864
+ expect(model.doGenerateCalls[0].prompt).toMatchInlineSnapshot(`
865
+ [
866
+ {
867
+ "content": [
868
+ {
869
+ "text": "prompt",
870
+ "type": "text",
871
+ },
872
+ ],
873
+ "providerOptions": undefined,
874
+ "role": "user",
875
+ },
876
+ ]
877
+ `);
878
+ expect(model.doGenerateCalls[0].responseFormat).toMatchInlineSnapshot(`
879
+ {
880
+ "description": undefined,
881
+ "name": undefined,
882
+ "schema": {
883
+ "$schema": "http://json-schema.org/draft-07/schema#",
884
+ "additionalProperties": false,
885
+ "properties": {
886
+ "elements": {
887
+ "items": {
888
+ "additionalProperties": false,
889
+ "properties": {
890
+ "content": {
891
+ "type": "string",
892
+ },
893
+ },
894
+ "required": [
895
+ "content",
896
+ ],
897
+ "type": "object",
898
+ },
899
+ "type": "array",
900
+ },
901
+ },
902
+ "required": [
903
+ "elements",
904
+ ],
905
+ "type": "object",
906
+ },
907
+ "type": "json",
908
+ }
909
+ `);
910
+ });
911
+ });
912
+
913
+ describe('output = "enum"', () => {
914
+ it('should generate an enum value', async () => {
915
+ const model = new MockLanguageModelV3({
916
+ doGenerate: {
917
+ ...dummyResponseValues,
918
+ content: [
919
+ {
920
+ type: 'text',
921
+ text: JSON.stringify({ result: 'sunny' }),
922
+ },
923
+ ],
924
+ },
925
+ });
926
+
927
+ const result = await generateObject({
928
+ model,
929
+ output: 'enum',
930
+ enum: ['sunny', 'rainy', 'snowy'],
931
+ prompt: 'prompt',
932
+ });
933
+
934
+ expect(result.object).toEqual('sunny');
935
+ expect(model.doGenerateCalls[0].prompt).toMatchInlineSnapshot(`
936
+ [
937
+ {
938
+ "content": [
939
+ {
940
+ "text": "prompt",
941
+ "type": "text",
942
+ },
943
+ ],
944
+ "providerOptions": undefined,
945
+ "role": "user",
946
+ },
947
+ ]
948
+ `);
949
+ expect(model.doGenerateCalls[0].responseFormat).toMatchInlineSnapshot(`
950
+ {
951
+ "description": undefined,
952
+ "name": undefined,
953
+ "schema": {
954
+ "$schema": "http://json-schema.org/draft-07/schema#",
955
+ "additionalProperties": false,
956
+ "properties": {
957
+ "result": {
958
+ "enum": [
959
+ "sunny",
960
+ "rainy",
961
+ "snowy",
962
+ ],
963
+ "type": "string",
964
+ },
965
+ },
966
+ "required": [
967
+ "result",
968
+ ],
969
+ "type": "object",
970
+ },
971
+ "type": "json",
972
+ }
973
+ `);
974
+ });
975
+ });
976
+
977
+ describe('output = "no-schema"', () => {
978
+ it('should generate object', async () => {
979
+ const model = new MockLanguageModelV3({
980
+ doGenerate: {
981
+ ...dummyResponseValues,
982
+ content: [{ type: 'text', text: '{ "content": "Hello, world!" }' }],
983
+ },
984
+ });
985
+
986
+ const result = await generateObject({
987
+ model,
988
+ output: 'no-schema',
989
+ prompt: 'prompt',
990
+ });
991
+
992
+ expect(result.object).toMatchInlineSnapshot(`
993
+ {
994
+ "content": "Hello, world!",
995
+ }
996
+ `);
997
+ expect(model.doGenerateCalls[0].prompt).toMatchInlineSnapshot(`
998
+ [
999
+ {
1000
+ "content": [
1001
+ {
1002
+ "text": "prompt",
1003
+ "type": "text",
1004
+ },
1005
+ ],
1006
+ "providerOptions": undefined,
1007
+ "role": "user",
1008
+ },
1009
+ ]
1010
+ `);
1011
+ expect(model.doGenerateCalls[0].responseFormat).toMatchInlineSnapshot(`
1012
+ {
1013
+ "description": undefined,
1014
+ "name": undefined,
1015
+ "schema": undefined,
1016
+ "type": "json",
1017
+ }
1018
+ `);
1019
+ });
1020
+ });
1021
+
1022
+ describe('telemetry', () => {
1023
+ let tracer: MockTracer;
1024
+
1025
+ beforeEach(() => {
1026
+ tracer = new MockTracer();
1027
+ });
1028
+
1029
+ it('should not record any telemetry data when not explicitly enabled', async () => {
1030
+ await generateObject({
1031
+ model: new MockLanguageModelV3({
1032
+ doGenerate: async () => ({
1033
+ ...dummyResponseValues,
1034
+ content: [{ type: 'text', text: '{ "content": "Hello, world!" }' }],
1035
+ }),
1036
+ }),
1037
+ schema: z.object({ content: z.string() }),
1038
+ prompt: 'prompt',
1039
+ });
1040
+
1041
+ assert.deepStrictEqual(tracer.jsonSpans, []);
1042
+ });
1043
+
1044
+ it('should record telemetry data when enabled', async () => {
1045
+ await generateObject({
1046
+ model: new MockLanguageModelV3({
1047
+ doGenerate: async () => ({
1048
+ ...dummyResponseValues,
1049
+ content: [{ type: 'text', text: '{ "content": "Hello, world!" }' }],
1050
+ response: {
1051
+ id: 'test-id-from-model',
1052
+ timestamp: new Date(10000),
1053
+ modelId: 'test-response-model-id',
1054
+ },
1055
+ providerMetadata: {
1056
+ testProvider: {
1057
+ testKey: 'testValue',
1058
+ },
1059
+ },
1060
+ }),
1061
+ }),
1062
+ schema: z.object({ content: z.string() }),
1063
+ schemaName: 'test-name',
1064
+ schemaDescription: 'test description',
1065
+ prompt: 'prompt',
1066
+ topK: 0.1,
1067
+ topP: 0.2,
1068
+ frequencyPenalty: 0.3,
1069
+ presencePenalty: 0.4,
1070
+ temperature: 0.5,
1071
+ headers: {
1072
+ header1: 'value1',
1073
+ header2: 'value2',
1074
+ },
1075
+ experimental_telemetry: {
1076
+ isEnabled: true,
1077
+ functionId: 'test-function-id',
1078
+ metadata: {
1079
+ test1: 'value1',
1080
+ test2: false,
1081
+ },
1082
+ tracer,
1083
+ },
1084
+ });
1085
+
1086
+ expect(tracer.jsonSpans).toMatchSnapshot();
1087
+ });
1088
+
1089
+ it('should not record telemetry inputs / outputs when disabled', async () => {
1090
+ await generateObject({
1091
+ model: new MockLanguageModelV3({
1092
+ doGenerate: async () => ({
1093
+ ...dummyResponseValues,
1094
+ content: [{ type: 'text', text: '{ "content": "Hello, world!" }' }],
1095
+ response: {
1096
+ id: 'test-id-from-model',
1097
+ timestamp: new Date(10000),
1098
+ modelId: 'test-response-model-id',
1099
+ },
1100
+ }),
1101
+ }),
1102
+ schema: z.object({ content: z.string() }),
1103
+ prompt: 'prompt',
1104
+ experimental_telemetry: {
1105
+ isEnabled: true,
1106
+ recordInputs: false,
1107
+ recordOutputs: false,
1108
+ tracer,
1109
+ },
1110
+ });
1111
+
1112
+ expect(tracer.jsonSpans).toMatchSnapshot();
1113
+ });
1114
+ });
1115
+
1116
+ describe('options.messages', () => {
1117
+ it('should support models that use "this" context in supportedUrls', async () => {
1118
+ let supportedUrlsCalled = false;
1119
+ class MockLanguageModelWithImageSupport extends MockLanguageModelV3 {
1120
+ constructor() {
1121
+ super({
1122
+ supportedUrls: () => {
1123
+ supportedUrlsCalled = true;
1124
+ // Reference 'this' to verify context
1125
+ return this.modelId === 'mock-model-id'
1126
+ ? ({ 'image/*': [/^https:\/\/.*$/] } as Record<
1127
+ string,
1128
+ RegExp[]
1129
+ >)
1130
+ : {};
1131
+ },
1132
+ doGenerate: async () => ({
1133
+ ...dummyResponseValues,
1134
+ content: [
1135
+ { type: 'text', text: '{ "content": "Hello, world!" }' },
1136
+ ],
1137
+ }),
1138
+ });
1139
+ }
1140
+ }
1141
+
1142
+ const model = new MockLanguageModelWithImageSupport();
1143
+
1144
+ const result = await generateObject({
1145
+ model,
1146
+ schema: z.object({ content: z.string() }),
1147
+ messages: [
1148
+ {
1149
+ role: 'user',
1150
+ content: [{ type: 'image', image: 'https://example.com/test.jpg' }],
1151
+ },
1152
+ ],
1153
+ });
1154
+
1155
+ expect(result.object).toStrictEqual({ content: 'Hello, world!' });
1156
+ expect(supportedUrlsCalled).toBe(true);
1157
+ });
1158
+ });
1159
+
1160
+ describe('reasoning', () => {
1161
+ it('should include reasoning in the result', async () => {
1162
+ const model = new MockLanguageModelV3({
1163
+ doGenerate: async () => ({
1164
+ ...dummyResponseValues,
1165
+ content: [
1166
+ { type: 'reasoning', text: 'This is a test reasoning.' },
1167
+ { type: 'reasoning', text: 'This is another test reasoning.' },
1168
+ { type: 'text', text: '{ "content": "Hello, world!" }' },
1169
+ ],
1170
+ }),
1171
+ });
1172
+
1173
+ const result = await generateObject({
1174
+ model,
1175
+ schema: z.object({ content: z.string() }),
1176
+ prompt: 'prompt',
1177
+ });
1178
+
1179
+ expect(result.reasoning).toMatchInlineSnapshot(`
1180
+ "This is a test reasoning.
1181
+ This is another test reasoning."
1182
+ `);
1183
+
1184
+ expect(result.object).toMatchInlineSnapshot(`
1185
+ {
1186
+ "content": "Hello, world!",
1187
+ }
1188
+ `);
1189
+ });
1190
+ });
1191
+ });