add-function-examples

✓ Official★ 25,366

by vercel · part of vercel/ai

Guide for adding new AI function examples, for testing specific features against the actual provider APIs.

🔥🔥✓ VerifiedFreeQuick setup

🔒 Repo-maintenance skill. It exists to help maintain vercel/ai itself — it's only useful if you contribute code to that project.

This is the playbook your agent receives when the skill activates — you don't need to read it to use the skill, but it's here to audit before installing.

Adding Function Examples

Review the changes in the current branch, and identify new or modified features or bug fixes that would benefit from having an example in the examples/ai-functions directory. These examples are used for testing specific features against the actual provider APIs, and can also serve as documentation for users.

Determine for which kind of model and top-level function the example should be added. For a language model, the example should be added in two variants, one for generateText and one for streamText. For any other models kinds, add the example for the relevant top-level function (e.g. generateImage, generateSpeech).

After creating the example, run pnpm type-check:full; fix any errors encountered.