Skip to content
Source
Sign inSign up
TanStack/ai
Open History to see the last commit

getProviderExecutedMetadata.md

34 lines761 Bytes

1---
2id: getProviderExecutedMetadata
3title: getProviderExecutedMetadata
4---
5​
6# Function: getProviderExecutedMetadata()
7​
8```ts
9function getProviderExecutedMetadata(toolCall):
10 | ProviderExecutedToolMetadata
11 | null;
12```
13​
14Defined in: [packages/ai/src/utilities/provider-executed.ts:9](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/provider-executed.ts#L9)
15​
16Narrow a tool call's opaque `metadata` to the provider-executed convention.
17Returns the typed metadata when the call is provider-executed, else `null`.
18​
19## Parameters
20​
21### toolCall
22​
23\{
24`metadata?`: `unknown`;
25\} | `null` | `undefined`
26​
27## Returns
28​
29 \| [`ProviderExecutedToolMetadata`](../interfaces/ProviderExecutedToolMetadata.md)
30 \| `null`
31​
32## See
33​
34ProviderExecutedToolMetadata