Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
18 changes: 9 additions & 9 deletions docs/reference/classes/BaseEvaluateAdapter.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: BaseEvaluateAdapter
title: BaseEvaluateAdapter
---

Defined in: packages/ai/src/activities/evaluate/adapter.ts:189
Defined in: [packages/ai/src/activities/evaluate/adapter.ts:265](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/evaluate/adapter.ts#L265)

Abstract base class for evaluate adapters.
Extend this class to implement an evaluate adapter for a specific provider.
Expand Down Expand Up @@ -32,7 +32,7 @@ Generic parameters match EvaluateAdapter. The provider function resolves them.
new BaseEvaluateAdapter<TModel, TProviderOptions>(config?, model): BaseEvaluateAdapter<TModel, TProviderOptions>;
```

Defined in: packages/ai/src/activities/evaluate/adapter.ts:204
Defined in: [packages/ai/src/activities/evaluate/adapter.ts:280](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/evaluate/adapter.ts#L280)

#### Parameters

Expand All @@ -56,7 +56,7 @@ Defined in: packages/ai/src/activities/evaluate/adapter.ts:204
~types: object;
```

Defined in: packages/ai/src/activities/evaluate/adapter.ts:198
Defined in: [packages/ai/src/activities/evaluate/adapter.ts:274](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/evaluate/adapter.ts#L274)

**`Internal`**

Expand All @@ -80,7 +80,7 @@ providerOptions: TProviderOptions;
protected config: EvaluateAdapterConfig;
```

Defined in: packages/ai/src/activities/evaluate/adapter.ts:202
Defined in: [packages/ai/src/activities/evaluate/adapter.ts:278](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/evaluate/adapter.ts#L278)

***

Expand All @@ -90,7 +90,7 @@ Defined in: packages/ai/src/activities/evaluate/adapter.ts:202
readonly kind: "evaluate";
```

Defined in: packages/ai/src/activities/evaluate/adapter.ts:193
Defined in: [packages/ai/src/activities/evaluate/adapter.ts:269](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/evaluate/adapter.ts#L269)

Discriminator for adapter kind

Expand All @@ -106,7 +106,7 @@ Discriminator for adapter kind
readonly model: TModel;
```

Defined in: packages/ai/src/activities/evaluate/adapter.ts:195
Defined in: [packages/ai/src/activities/evaluate/adapter.ts:271](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/evaluate/adapter.ts#L271)

The model this adapter is configured for

Expand All @@ -122,7 +122,7 @@ The model this adapter is configured for
abstract readonly name: string;
```

Defined in: packages/ai/src/activities/evaluate/adapter.ts:194
Defined in: [packages/ai/src/activities/evaluate/adapter.ts:270](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/evaluate/adapter.ts#L270)

Adapter name identifier

Expand All @@ -138,7 +138,7 @@ Adapter name identifier
abstract evaluate(options): Promise<EvaluateAdapterResult>;
```

Defined in: packages/ai/src/activities/evaluate/adapter.ts:209
Defined in: [packages/ai/src/activities/evaluate/adapter.ts:285](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/evaluate/adapter.ts#L285)

Evaluate typed questions against `state`. Return the provider payload.
Do not invent unified `.value` fields. The activity maps wire answers.
Expand All @@ -165,7 +165,7 @@ Do not invent unified `.value` fields. The activity maps wire answers.
protected generateId(): string;
```

Defined in: packages/ai/src/activities/evaluate/adapter.ts:213
Defined in: [packages/ai/src/activities/evaluate/adapter.ts:289](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/evaluate/adapter.ts#L289)

#### Returns

Expand Down
18 changes: 9 additions & 9 deletions docs/reference/classes/BaseRerankAdapter.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: BaseRerankAdapter
title: BaseRerankAdapter
---

Defined in: packages/ai/src/activities/rerank/adapter.ts:63
Defined in: [packages/ai/src/activities/rerank/adapter.ts:63](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/rerank/adapter.ts#L63)

Abstract base class for rerank adapters.
Extend this class to implement a rerank adapter for a specific provider.
Expand Down Expand Up @@ -32,7 +32,7 @@ Generic parameters match RerankAdapter - all pre-resolved by the provider functi
new BaseRerankAdapter<TModel, TProviderOptions>(config?, model): BaseRerankAdapter<TModel, TProviderOptions>;
```

Defined in: packages/ai/src/activities/rerank/adapter.ts:78
Defined in: [packages/ai/src/activities/rerank/adapter.ts:78](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/rerank/adapter.ts#L78)

#### Parameters

Expand All @@ -56,7 +56,7 @@ Defined in: packages/ai/src/activities/rerank/adapter.ts:78
~types: object;
```

Defined in: packages/ai/src/activities/rerank/adapter.ts:72
Defined in: [packages/ai/src/activities/rerank/adapter.ts:72](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/rerank/adapter.ts#L72)

**`Internal`**

Expand All @@ -80,7 +80,7 @@ providerOptions: TProviderOptions;
protected config: RerankAdapterConfig;
```

Defined in: packages/ai/src/activities/rerank/adapter.ts:76
Defined in: [packages/ai/src/activities/rerank/adapter.ts:76](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/rerank/adapter.ts#L76)

***

Expand All @@ -90,7 +90,7 @@ Defined in: packages/ai/src/activities/rerank/adapter.ts:76
readonly kind: "rerank";
```

Defined in: packages/ai/src/activities/rerank/adapter.ts:67
Defined in: [packages/ai/src/activities/rerank/adapter.ts:67](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/rerank/adapter.ts#L67)

Discriminator for adapter kind

Expand All @@ -106,7 +106,7 @@ Discriminator for adapter kind
readonly model: TModel;
```

Defined in: packages/ai/src/activities/rerank/adapter.ts:69
Defined in: [packages/ai/src/activities/rerank/adapter.ts:69](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/rerank/adapter.ts#L69)

The model this adapter is configured for

Expand All @@ -122,7 +122,7 @@ The model this adapter is configured for
abstract readonly name: string;
```

Defined in: packages/ai/src/activities/rerank/adapter.ts:68
Defined in: [packages/ai/src/activities/rerank/adapter.ts:68](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/rerank/adapter.ts#L68)

Adapter name identifier

Expand All @@ -138,7 +138,7 @@ Adapter name identifier
protected generateId(): string;
```

Defined in: packages/ai/src/activities/rerank/adapter.ts:87
Defined in: [packages/ai/src/activities/rerank/adapter.ts:87](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/rerank/adapter.ts#L87)

#### Returns

Expand All @@ -152,7 +152,7 @@ Defined in: packages/ai/src/activities/rerank/adapter.ts:87
abstract rerank(options): Promise<RerankAdapterResult>;
```

Defined in: packages/ai/src/activities/rerank/adapter.ts:83
Defined in: [packages/ai/src/activities/rerank/adapter.ts:83](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/rerank/adapter.ts#L83)

Rerank the given (pre-serialized) documents against the query, returning
scored indices into `options.documents`. The activity layer maps these
Expand Down
8 changes: 4 additions & 4 deletions docs/reference/classes/BatchStrategy.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: BatchStrategy
title: BatchStrategy
---

Defined in: packages/ai/src/activities/chat/stream/strategies.ts:34
Defined in: [packages/ai/src/activities/chat/stream/strategies.ts:34](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/strategies.ts#L34)

Batch Strategy - emit every N chunks
Useful for reducing UI update frequency
Expand All @@ -20,7 +20,7 @@ Useful for reducing UI update frequency
new BatchStrategy(batchSize?): BatchStrategy;
```

Defined in: packages/ai/src/activities/chat/stream/strategies.ts:37
Defined in: [packages/ai/src/activities/chat/stream/strategies.ts:37](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/strategies.ts#L37)

#### Parameters

Expand All @@ -40,7 +40,7 @@ Defined in: packages/ai/src/activities/chat/stream/strategies.ts:37
reset(): void;
```

Defined in: packages/ai/src/activities/chat/stream/strategies.ts:48
Defined in: [packages/ai/src/activities/chat/stream/strategies.ts:48](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/strategies.ts#L48)

Optional: Reset strategy state (called when streaming starts)

Expand All @@ -60,7 +60,7 @@ Optional: Reset strategy state (called when streaming starts)
shouldEmit(_chunk, _accumulated): boolean;
```

Defined in: packages/ai/src/activities/chat/stream/strategies.ts:39
Defined in: [packages/ai/src/activities/chat/stream/strategies.ts:39](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/strategies.ts#L39)

Called for each text chunk received

Expand Down
8 changes: 4 additions & 4 deletions docs/reference/classes/CapabilityRegistry.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: CapabilityRegistry
title: CapabilityRegistry
---

Defined in: packages/ai/src/activities/chat/middleware/capabilities.ts:61
Defined in: [packages/ai/src/activities/chat/middleware/capabilities.ts:61](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/capabilities.ts#L61)

Per-request bookkeeping: which capabilities were provided, plus the
duplicate-provide notification. Capability VALUES live in per-capability
Expand All @@ -29,7 +29,7 @@ new CapabilityRegistry(): CapabilityRegistry;
has(handle): boolean;
```

Defined in: packages/ai/src/activities/chat/middleware/capabilities.ts:76
Defined in: [packages/ai/src/activities/chat/middleware/capabilities.ts:76](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/capabilities.ts#L76)

#### Parameters

Expand All @@ -49,7 +49,7 @@ Defined in: packages/ai/src/activities/chat/middleware/capabilities.ts:76
markProvided(handle): void;
```

Defined in: packages/ai/src/activities/chat/middleware/capabilities.ts:71
Defined in: [packages/ai/src/activities/chat/middleware/capabilities.ts:71](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/capabilities.ts#L71)

Record that `handle` was provided; fire the duplicate callback on repeats.

Expand All @@ -71,7 +71,7 @@ Record that `handle` was provided; fire the duplicate callback on repeats.
setOnDuplicate(cb): void;
```

Defined in: packages/ai/src/activities/chat/middleware/capabilities.ts:66
Defined in: [packages/ai/src/activities/chat/middleware/capabilities.ts:66](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/capabilities.ts#L66)

Register a callback fired when a handle is provided more than once.

Expand Down
8 changes: 4 additions & 4 deletions docs/reference/classes/CompositeStrategy.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: CompositeStrategy
title: CompositeStrategy
---

Defined in: packages/ai/src/activities/chat/stream/strategies.ts:68
Defined in: [packages/ai/src/activities/chat/stream/strategies.ts:68](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/strategies.ts#L68)

Composite Strategy - combine multiple strategies (OR logic)
Emits if ANY strategy says to emit
Expand All @@ -20,7 +20,7 @@ Emits if ANY strategy says to emit
new CompositeStrategy(strategies): CompositeStrategy;
```

Defined in: packages/ai/src/activities/chat/stream/strategies.ts:69
Defined in: [packages/ai/src/activities/chat/stream/strategies.ts:69](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/strategies.ts#L69)

#### Parameters

Expand All @@ -40,7 +40,7 @@ Defined in: packages/ai/src/activities/chat/stream/strategies.ts:69
reset(): void;
```

Defined in: packages/ai/src/activities/chat/stream/strategies.ts:75
Defined in: [packages/ai/src/activities/chat/stream/strategies.ts:75](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/strategies.ts#L75)

Optional: Reset strategy state (called when streaming starts)

Expand All @@ -60,7 +60,7 @@ Optional: Reset strategy state (called when streaming starts)
shouldEmit(chunk, accumulated): boolean;
```

Defined in: packages/ai/src/activities/chat/stream/strategies.ts:71
Defined in: [packages/ai/src/activities/chat/stream/strategies.ts:71](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/strategies.ts#L71)

Called for each text chunk received

Expand Down
10 changes: 5 additions & 5 deletions docs/reference/classes/ConsoleLogger.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: ConsoleLogger
title: ConsoleLogger
---

Defined in: packages/ai/src/logger/console-logger.ts:101
Defined in: [packages/ai/src/logger/console-logger.ts:101](https://github.com/TanStack/ai/blob/main/packages/ai/src/logger/console-logger.ts#L101)

Default `Logger` implementation that routes each level to the matching
`console` method:
Expand Down Expand Up @@ -45,7 +45,7 @@ new ConsoleLogger(): ConsoleLogger;
debug(message, meta?): void;
```

Defined in: packages/ai/src/logger/console-logger.ts:103
Defined in: [packages/ai/src/logger/console-logger.ts:103](https://github.com/TanStack/ai/blob/main/packages/ai/src/logger/console-logger.ts#L103)

Log a debug-level message; forwards to `console.debug`.

Expand Down Expand Up @@ -75,7 +75,7 @@ Log a debug-level message; forwards to `console.debug`.
error(message, meta?): void;
```

Defined in: packages/ai/src/logger/console-logger.ts:118
Defined in: [packages/ai/src/logger/console-logger.ts:118](https://github.com/TanStack/ai/blob/main/packages/ai/src/logger/console-logger.ts#L118)

Log an error-level message; forwards to `console.error`.

Expand Down Expand Up @@ -105,7 +105,7 @@ Log an error-level message; forwards to `console.error`.
info(message, meta?): void;
```

Defined in: packages/ai/src/logger/console-logger.ts:108
Defined in: [packages/ai/src/logger/console-logger.ts:108](https://github.com/TanStack/ai/blob/main/packages/ai/src/logger/console-logger.ts#L108)

Log an info-level message; forwards to `console.info`.

Expand Down Expand Up @@ -135,7 +135,7 @@ Log an info-level message; forwards to `console.info`.
warn(message, meta?): void;
```

Defined in: packages/ai/src/logger/console-logger.ts:113
Defined in: [packages/ai/src/logger/console-logger.ts:113](https://github.com/TanStack/ai/blob/main/packages/ai/src/logger/console-logger.ts#L113)

Log a warning-level message; forwards to `console.warn`.

Expand Down
6 changes: 3 additions & 3 deletions docs/reference/classes/DuplicateToolNameError.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: DuplicateToolNameError
title: DuplicateToolNameError
---

Defined in: packages/ai/src/activities/chat/tools/unique-tool-names.ts:11
Defined in: [packages/ai/src/activities/chat/tools/unique-tool-names.ts:11](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/unique-tool-names.ts#L11)

Thrown when `chat({ tools })` (or a provider converter) receives two tools
with the same public `name`.
Expand All @@ -24,7 +24,7 @@ reject that pair, so we fail before the request is built.
new DuplicateToolNameError(toolName, message): DuplicateToolNameError;
```

Defined in: packages/ai/src/activities/chat/tools/unique-tool-names.ts:14
Defined in: [packages/ai/src/activities/chat/tools/unique-tool-names.ts:14](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/unique-tool-names.ts#L14)

#### Parameters

Expand Down Expand Up @@ -54,4 +54,4 @@ Error.constructor
readonly toolName: string;
```

Defined in: packages/ai/src/activities/chat/tools/unique-tool-names.ts:12
Defined in: [packages/ai/src/activities/chat/tools/unique-tool-names.ts:12](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/unique-tool-names.ts#L12)
Loading