0
Fork 0
mirror of https://github.com/TanStack/ai.git synced 2026-11-18 19:34:58 +00:00
ai/docs/reference/functions/getProviderExecutedMetadata.md
github-actions[bot] 5701bf5184
docs: regenerate API documentation (#1141)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2026-08-18 19:53:35 +02:00

774 B

id title
getProviderExecutedMetadata getProviderExecutedMetadata

Function: getProviderExecutedMetadata()

function getProviderExecutedMetadata(toolCall): 
  | ProviderExecutedToolMetadata
  | null;

Defined in: packages/ai/src/utilities/provider-executed.ts:9

Narrow a tool call's opaque metadata to the provider-executed convention. Returns the typed metadata when the call is provider-executed, else null.

Parameters

toolCall

| { metadata?: unknown; } | null | undefined

Returns

| ProviderExecutedToolMetadata | null

See

ProviderExecutedToolMetadata