ContextQMD
Back to Ai

InferUITool

content/docs/07-reference/02-ai-sdk-ui/47-infer-ui-tool.mdx

2.1.101.3 KB
Original Source

InferUITool

Infers the input and output types of a tool.

This type helper is useful when working with individual tools to ensure type safety for your tool inputs and outputs in UIMessages.

Import

tsx
import { InferUITool } from 'ai';

API Signature

Type Parameters

<PropertiesTable content={[ { name: 'TOOL', type: 'Tool', description: 'The tool to infer types from.', }, ]} />

Returns

A type that contains the inferred input and output types of the tool.

The resulting type has the shape:

typescript
{
  input: InferToolInput<TOOL>;
  output: InferToolOutput<TOOL>;
}

Examples

Basic Usage

tsx
import { InferUITool } from 'ai';
import { z } from 'zod';

const weatherTool = {
  description: 'Get the current weather',
  inputSchema: z.object({
    location: z.string().describe('The city and state'),
  }),
  execute: async ({ location }) => {
    return `The weather in ${location} is sunny.`;
  },
};

// Infer the types from the tool
type WeatherUITool = InferUITool<typeof weatherTool>;
// This creates a type with:
// {
//   input: { location: string };
//   output: string;
// }