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

buildBaseUsage.md

46 lines943 Bytes

1---
2id: buildBaseUsage
3title: buildBaseUsage
4---
5​
6# Function: buildBaseUsage()
7​
8```ts
9function buildBaseUsage<TProviderDetails>(input): TokenUsage<TProviderDetails>;
10```
11​
12Defined in: [packages/ai/src/utilities/usage.ts:33](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/usage.ts#L33)
13​
14Builds the base TokenUsage object with core fields.
15Provider-specific functions should use this and then add their own details.
16​
17## Type Parameters
18​
19### TProviderDetails
20​
21`TProviderDetails` = `ProviderUsageDetails`
22​
23## Parameters
24​
25### input
26​
27[`BaseUsageInput`](../interfaces/BaseUsageInput.md)
28​
29The base token counts
30​
31## Returns
32​
33`TokenUsage`\<`TProviderDetails`\>
34​
35A TokenUsage object with promptTokens, completionTokens, totalTokens
36​
37## Example
38​
39```typescript
40const base = buildBaseUsage({
41 promptTokens: 100,
42 completionTokens: 50,
43 totalTokens: 150
44});
45// Returns: { promptTokens: 100, completionTokens: 50, totalTokens: 150 }
46```