Index of every page on this site: llms.txt
All skills
vercel avatar

/develop-ai-functions-example

@a8f0e9d official
by vercelvercel/ai28k stars
5,666
Run it yourself

Develop examples for AI SDK functions. Use when creating, running, or modifying examples under examples/ai-functions/src to validate provider support, demonstrate features, or create test fixtures.

Use this Skill: https://skilld.dev/gh/vercel/ai/develop-ai-functions-example

Nothing lands on disk. Nothing to clean up.

Fork this Skill

Edit a local copy. It keeps the author and licence.

SKILL.md

≈57 tokens for metadata: the name and description. ≈2.2k when used: this file.

Description uses 2.9% of example budget

Before choosing a Skill, your Agent reads its name and description. All available Skills share that space.

  • A shorter description leaves more room for other Skills. This entry exceeds our 1% size suggestion.

In our Claude Code example, all Skill names and descriptions share 8,000 characters. This Skill uses ≈228 characters, or 2.9%.

The 1% threshold is a size suggestion. Longer descriptions can still fit.

Your model, settings, and other Skills decide how much text your Agent can read.

Example settings and source

The example uses a 200k-token context and default Claude Code settings. The count includes the name, description, separators, and when_to_use when present. Codex also counts local file paths.

Skit's source and limits: Codex 0.160.1, Claude Code 2.1.292.

AI Functions Examples

The examples/ai-functions/ directory contains reusable scripts for validating, testing, and iterating on AI SDK functions across providers. Place examples under examples/ai-functions/src/<function>/<provider>/. Reproduction-only scripts belong only in the PR description's End-to-End Verification section and must never be committed; see Bug Reproductions.

Example Categories

Examples are organized by AI SDK function in examples/ai-functions/src/:

Directory Purpose
generate-text/ Non-streaming text generation with generateText()
stream-text/ Streaming text generation with streamText()
generate-object/ Structured output generation with generateObject()
stream-object/ Streaming structured output with streamObject()
agent/ ToolLoopAgent examples for agentic workflows
embed/ Single embedding generation with embed()
embed-many/ Batch embedding generation with embedMany()
generate-image/ Image generation with generateImage()
generate-speech/ Text-to-speech with generateSpeech()
transcribe/ Audio transcription with transcribe()
rerank/ Document reranking with rerank()
middleware/ Custom middleware implementations
registry/ Provider registry setup and usage
telemetry/ OpenTelemetry integration
complex/ Multi-component examples (agents, routers)
lib/ Shared utilities (not examples)
tools/ Reusable tool definitions

File Naming Convention

Group examples by function and provider. Name the entry example basic.ts and use descriptive kebab-case.ts names for additional examples:

Pattern Example Description
<function>/<provider>/basic.ts generate-text/openai/basic.ts Basic provider usage
<function>/<provider>/<feature>.ts stream-text/openai/tool-call.ts Specific feature
<function>/<provider>/<sub-provider>.ts stream-text/amazon-bedrock/anthropic.ts Provider with sub-provider
<function>/<provider>/<sub-provider>-<feature>.ts stream-text/google/vertex-anthropic-cache-control.ts Sub-provider with feature

Do not create flat provider files such as generate-text/openai.ts.

Example Structure

All examples use the run() wrapper from lib/run.ts which:

  • Loads environment variables from .env
  • Provides error handling with detailed API error logging

Basic Template

import { providerName } from '@ai-sdk/provider-name';
import { generateText } from 'ai';
import { run } from '../../lib/run';

run(async () => {
  const result = await generateText({
    model: providerName('model-id'),
    prompt: 'Your prompt here.',
  });

  console.log(result.text);
  console.log('Token usage:', result.usage);
  console.log('Finish reason:', result.finishReason);
});

Streaming Template

import { providerName } from '@ai-sdk/provider-name';
import { streamText } from 'ai';
import { printFullStream } from '../../lib/print-full-stream';
import { run } from '../../lib/run';

run(async () => {
  const result = streamText({
    model: providerName('model-id'),
    prompt: 'Your prompt here.',
  });

  await printFullStream({ result });
});

Tool Calling Template

import { providerName } from '@ai-sdk/provider-name';
import { generateText, tool } from 'ai';
import { z } from 'zod';
import { run } from '../../lib/run';

run(async () => {
  const result = await generateText({
    model: providerName('model-id'),
    tools: {
      myTool: tool({
        description: 'Tool description',
        inputSchema: z.object({
          param: z.string().describe('Parameter description'),
        }),
        execute: async ({ param }) => {
          return { result: `Processed: ${param}` };
        },
      }),
    },
    prompt: 'Use the tool to...',
  });

  console.log(JSON.stringify(result, null, 2));
});

Structured Output Template

import { providerName } from '@ai-sdk/provider-name';
import { generateObject } from 'ai';
import { z } from 'zod';
import { run } from '../../lib/run';

run(async () => {
  const result = await generateObject({
    model: providerName('model-id'),
    schema: z.object({
      name: z.string(),
      items: z.array(z.string()),
    }),
    prompt: 'Generate a...',
  });

  console.log(JSON.stringify(result.object, null, 2));
  console.log('Token usage:', result.usage);
});

Running Examples

From the examples/ai-functions directory:

pnpm tsx src/generate-text/openai/basic.ts
pnpm tsx src/stream-text/openai/tool-call.ts
pnpm tsx src/agent/openai/generate.ts

When to Write Examples

Write examples when:

  1. Adding a new provider: Create basic examples for each supported API (generateText, streamText, generateObject, etc.)

  2. Implementing a new feature: Demonstrate the feature with at least one provider example

  3. Adding provider-specific options: Show how to use providerOptions for provider-specific settings

  4. Creating test fixtures: Use examples to generate API response fixtures (see capture-api-response-test-fixture skill)

Bug Reproductions

Follow the bug-fix workflow in AGENTS.md. Use a temporary script outside the checkout to reproduce the failure end-to-end, then rerun it to verify the fix. Build and use the checkout's local packages for both runs. Publish reproduction-only code only in the PR description's End-to-End Verification section, in a collapsible <details> block with the complete runnable script, commands, and observed before/after results, following .github/pull_request_template.md. Never commit reproduction-only files, including under examples/ai-functions or elsewhere in the repository.

Regression tests remain alongside the affected source files. Reusable examples that demonstrate supported usage (including fixed behavior) belong under examples/ai-functions/src/<function>/<provider>/, using the naming conventions above.

Utility Helpers

The lib/ directory contains shared utilities:

File Purpose
run.ts Error-handling wrapper with .env loading
print.ts Clean object printing (removes undefined values)
print-full-stream.ts Colored streaming output for tool calls, reasoning, text
save-raw-chunks.ts Save streaming chunks for test fixtures
present-image.ts Display images in terminal
save-audio.ts Save audio files to disk

Using print utilities

import { print } from '../lib/print';

// Pretty print objects without undefined values
print('Result:', result);
print('Usage:', result.usage, { depth: 2 });

Using printFullStream

import { printFullStream } from '../lib/print-full-stream';

const result = streamText({ ... });
await printFullStream({ result }); // Colored output for text, tool calls, reasoning

Reusable Tools

The tools/ directory contains reusable tool definitions:

import { weatherTool } from '../tools/weather-tool';

const result = await generateText({
  model: openai('gpt-4o'),
  tools: { weather: weatherTool },
  prompt: 'What is the weather in San Francisco?',
});

Best Practices

  1. Keep examples focused: Each example should demonstrate one feature or use case

  2. Use descriptive prompts: Make it clear what the example is testing

  3. Handle errors gracefully: The run() wrapper handles this automatically

  4. Use realistic model IDs: Use actual model IDs that work with the provider

  5. Add comments for complex logic: Explain non-obvious code patterns

  6. Reuse tools when appropriate: Use weatherTool or create new reusable tools in tools/

Source: SKILL.md on GitHub

skilld matched fixed text patterns in SKILL.md and file names. Patterns miss obfuscated code.

skilld run checks every file with the same patterns. It asks for approval before it loads a Skill with a behavior marked Needs approval.

1 warning7mo5 checks · Risk SAFE
  • Gen Agent Trust Hub8mo

    This skill provides a structured framework and guidelines for developing AI SDK function examples. It follows standard development practices, such as using environment variables for configuration and local script execution for testing. No security issues were detected.

  • Socket8mo

    No alerts

  • Snyk8mo

    Risk: LOW · No issues

  • Runlayer9mo

    1/1 file flagged

  • ZeroLeaks7mo

    Score: 93/100 · 2 sections analyzed

Signed by skilld at a8f0e9d. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub yesterday.

Activeupdated 2 weeks ago
metadata
{
  "internal": true
}
  • TypeScript
  • vercel-ai
  • ai-sdk
  • examples
  • generatetext
  • streamtext
  • generateobject
  • tool-calling
  • embeddings

README badge

README badge for vercel/ai/develop-ai-functions-example

Develops and validates examples for Vercel AI SDK functions across providers. Use when creating test fixtures, demonstrating provider features like text generation, structured output, tool calling, or embeddings, or iterating on examples in the examples/ai-functions directory.

Generated from the current SKILL.md.

What is this skill for?
This skill helps develop and validate examples for Vercel AI SDK functions across different AI providers. Use it when creating, modifying, or running example scripts in the examples/ai-functions directory.
Which AI SDK functions does this cover?
The skill covers generateText, streamText, generateObject, streamObject, embed, embedMany, generateImage, generateSpeech, transcribe, rerank, and agent workflows via ToolLoopAgent.
Do the examples support multiple providers?
Yes. Examples follow a naming convention like openai.ts, amazon-bedrock-anthropic.ts, and google-vertex-anthropic-cache-control.ts to demonstrate provider-specific implementations.
What utilities are available for running examples?
The skill includes shared utilities like run.ts for error handling and environment loading, printFullStream for colored streaming output, and helpers for saving images and audio.
Can I reuse tool definitions across examples?
Yes. The skill includes a tools/ directory with reusable tool definitions like weatherTool that can be imported into multiple examples.

Generated from the current SKILL.md. These answers refresh after source changes.