diff --git a/docs/reference/classes/BaseEvaluateAdapter.md b/docs/reference/classes/BaseEvaluateAdapter.md index 43b6789ebe..3b4d2270ca 100644 --- a/docs/reference/classes/BaseEvaluateAdapter.md +++ b/docs/reference/classes/BaseEvaluateAdapter.md @@ -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. @@ -32,7 +32,7 @@ Generic parameters match EvaluateAdapter. The provider function resolves them. new BaseEvaluateAdapter(config?, model): BaseEvaluateAdapter; ``` -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 @@ -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`** @@ -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) *** @@ -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 @@ -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 @@ -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 @@ -138,7 +138,7 @@ Adapter name identifier abstract evaluate(options): Promise; ``` -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. @@ -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 diff --git a/docs/reference/classes/BaseRerankAdapter.md b/docs/reference/classes/BaseRerankAdapter.md index 2126773e0f..9264ad5112 100644 --- a/docs/reference/classes/BaseRerankAdapter.md +++ b/docs/reference/classes/BaseRerankAdapter.md @@ -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. @@ -32,7 +32,7 @@ Generic parameters match RerankAdapter - all pre-resolved by the provider functi new BaseRerankAdapter(config?, model): BaseRerankAdapter; ``` -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 @@ -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`** @@ -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) *** @@ -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 @@ -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 @@ -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 @@ -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 @@ -152,7 +152,7 @@ Defined in: packages/ai/src/activities/rerank/adapter.ts:87 abstract rerank(options): Promise; ``` -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 diff --git a/docs/reference/classes/BatchStrategy.md b/docs/reference/classes/BatchStrategy.md index 7d4efafed3..2c3ce8580b 100644 --- a/docs/reference/classes/BatchStrategy.md +++ b/docs/reference/classes/BatchStrategy.md @@ -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 @@ -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 @@ -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) @@ -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 diff --git a/docs/reference/classes/CapabilityRegistry.md b/docs/reference/classes/CapabilityRegistry.md index 76b4b17aa3..fbc63313fa 100644 --- a/docs/reference/classes/CapabilityRegistry.md +++ b/docs/reference/classes/CapabilityRegistry.md @@ -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 @@ -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 @@ -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. @@ -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. diff --git a/docs/reference/classes/CompositeStrategy.md b/docs/reference/classes/CompositeStrategy.md index 50002e2319..b48f8416e2 100644 --- a/docs/reference/classes/CompositeStrategy.md +++ b/docs/reference/classes/CompositeStrategy.md @@ -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 @@ -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 @@ -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) @@ -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 diff --git a/docs/reference/classes/ConsoleLogger.md b/docs/reference/classes/ConsoleLogger.md index fdaa5ab126..6a7bd3a872 100644 --- a/docs/reference/classes/ConsoleLogger.md +++ b/docs/reference/classes/ConsoleLogger.md @@ -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: @@ -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`. @@ -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`. @@ -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`. @@ -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`. diff --git a/docs/reference/classes/DuplicateToolNameError.md b/docs/reference/classes/DuplicateToolNameError.md index 3738c3bac2..fb14b9bea4 100644 --- a/docs/reference/classes/DuplicateToolNameError.md +++ b/docs/reference/classes/DuplicateToolNameError.md @@ -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`. @@ -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 @@ -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) diff --git a/docs/reference/classes/EvaluateError.md b/docs/reference/classes/EvaluateError.md new file mode 100644 index 0000000000..865bcdbcff --- /dev/null +++ b/docs/reference/classes/EvaluateError.md @@ -0,0 +1,95 @@ +--- +id: EvaluateError +title: EvaluateError +--- + +Defined in: [packages/ai/src/activities/evaluate/adapter.ts:171](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/evaluate/adapter.ts#L171) + +Thrown by an evaluate adapter when the provider answered, but the call +cannot become a result. It carries what the provider already returned, +so callers can still read the billed usage and the answers that came back. + +The `name` is always `EvaluateError`. +Another package can read this shape without an import of this class. +Use [isEvaluateError](../functions/isEvaluateError.md) to narrow a caught value. `instanceof` fails +when the app has more than one copy of `@tanstack/ai`. + +## Extends + +- `Error` + +## Constructors + +### Constructor + +```ts +new EvaluateError(init): EvaluateError; +``` + +Defined in: [packages/ai/src/activities/evaluate/adapter.ts:185](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/evaluate/adapter.ts#L185) + +#### Parameters + +##### init + +[`EvaluateErrorInit`](../interfaces/EvaluateErrorInit.md) + +#### Returns + +`EvaluateError` + +#### Overrides + +```ts +Error.constructor +``` + +## Properties + +### answers? + +```ts +readonly optional answers?: Record; +``` + +Defined in: [packages/ai/src/activities/evaluate/adapter.ts:183](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/evaluate/adapter.ts#L183) + +Wire answers the provider did return, before `decide()` maps them. A +`choice()` answer has `choice`, and a `boolean()` answer is +`{ type: 'noul', noul }`. A refused question has no key. + +*** + +### code + +```ts +readonly code: string; +``` + +Defined in: [packages/ai/src/activities/evaluate/adapter.ts:173](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/evaluate/adapter.ts#L173) + +Stable code to branch on, for example `EVALUATE_REFUSAL_CODE`. + +*** + +### model? + +```ts +readonly optional model?: string; +``` + +Defined in: [packages/ai/src/activities/evaluate/adapter.ts:177](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/evaluate/adapter.ts#L177) + +Resolved model id from the provider. + +*** + +### usage? + +```ts +readonly optional usage?: TokenUsage; +``` + +Defined in: [packages/ai/src/activities/evaluate/adapter.ts:175](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/evaluate/adapter.ts#L175) + +Tokens the provider reported for this call. diff --git a/docs/reference/classes/ImmediateStrategy.md b/docs/reference/classes/ImmediateStrategy.md index 8f5bab551c..eec63eae10 100644 --- a/docs/reference/classes/ImmediateStrategy.md +++ b/docs/reference/classes/ImmediateStrategy.md @@ -3,7 +3,7 @@ id: ImmediateStrategy title: ImmediateStrategy --- -Defined in: packages/ai/src/activities/chat/stream/strategies.ts:12 +Defined in: [packages/ai/src/activities/chat/stream/strategies.ts:12](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/strategies.ts#L12) Immediate Strategy - emit on every chunk (default behavior) @@ -31,7 +31,7 @@ new ImmediateStrategy(): ImmediateStrategy; shouldEmit(_chunk, _accumulated): boolean; ``` -Defined in: packages/ai/src/activities/chat/stream/strategies.ts:13 +Defined in: [packages/ai/src/activities/chat/stream/strategies.ts:13](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/strategies.ts#L13) Called for each text chunk received diff --git a/docs/reference/classes/InMemoryRunStore.md b/docs/reference/classes/InMemoryRunStore.md index c769e2fd6e..1089706c67 100644 --- a/docs/reference/classes/InMemoryRunStore.md +++ b/docs/reference/classes/InMemoryRunStore.md @@ -3,7 +3,7 @@ id: InMemoryRunStore title: InMemoryRunStore --- -Defined in: packages/ai/src/activities/chat/middleware/run-store.ts:423 +Defined in: [packages/ai/src/activities/chat/middleware/run-store.ts:423](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/run-store.ts#L423) In-memory [RunStore](../interfaces/RunStore.md). Single process only. @@ -31,7 +31,7 @@ new InMemoryRunStore(): InMemoryRunStore; createOrResume(input): Promise; ``` -Defined in: packages/ai/src/activities/chat/middleware/run-store.ts:426 +Defined in: [packages/ai/src/activities/chat/middleware/run-store.ts:426](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/run-store.ts#L426) Create a run record, or return the existing one unchanged if `runId` is already present. @@ -64,7 +64,7 @@ link fields are copied only on the first insert. findActiveRun(threadId): Promise; ``` -Defined in: packages/ai/src/activities/chat/middleware/run-store.ts:493 +Defined in: [packages/ai/src/activities/chat/middleware/run-store.ts:493](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/run-store.ts#L493) The most recent `'running'` run for `threadId`, or `null` if none is active. @@ -101,7 +101,7 @@ tiers belong at the store level, not the method level. get(runId): Promise; ``` -Defined in: packages/ai/src/activities/chat/middleware/run-store.ts:461 +Defined in: [packages/ai/src/activities/chat/middleware/run-store.ts:461](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/run-store.ts#L461) Current record, or null when unknown. @@ -127,7 +127,7 @@ Current record, or null when unknown. listByParentRun(parentRunId): Promise; ``` -Defined in: packages/ai/src/activities/chat/middleware/run-store.ts:472 +Defined in: [packages/ai/src/activities/chat/middleware/run-store.ts:472](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/run-store.ts#L472) Child runs started by `parentRunId`, ascending by `startedAt`. OPTIONAL. `reconstructChat` uses this to put subagent cards back @@ -156,7 +156,7 @@ text and not the cards. listByThread(threadId): Promise; ``` -Defined in: packages/ai/src/activities/chat/middleware/run-store.ts:465 +Defined in: [packages/ai/src/activities/chat/middleware/run-store.ts:465](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/run-store.ts#L465) Every run in a conversation, ascending by `startedAt`. OPTIONAL. `reconstructChat` calls it to find the parent runs of children that a @@ -185,7 +185,7 @@ Consumers feature-detect. listReclaimable(opts): Promise; ``` -Defined in: packages/ai/src/activities/chat/middleware/run-store.ts:479 +Defined in: [packages/ai/src/activities/chat/middleware/run-store.ts:479](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/run-store.ts#L479) Runs that may be reclaimed: ALL THREE of `status === 'running'`, `detachedSince` is set, and `detachedSince <= now - ttlMs`. The cutoff is @@ -229,7 +229,7 @@ method cannot be reaped at all. update(runId, patch): Promise; ``` -Defined in: packages/ai/src/activities/chat/middleware/run-store.ts:452 +Defined in: [packages/ai/src/activities/chat/middleware/run-store.ts:452](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/run-store.ts#L452) Patch a record's mutable fields. diff --git a/docs/reference/classes/InterruptResumeValidationError.md b/docs/reference/classes/InterruptResumeValidationError.md index 55b8842c15..8e99dc7119 100644 --- a/docs/reference/classes/InterruptResumeValidationError.md +++ b/docs/reference/classes/InterruptResumeValidationError.md @@ -3,7 +3,7 @@ id: InterruptResumeValidationError title: InterruptResumeValidationError --- -Defined in: packages/ai/src/interrupt-resume.ts:78 +Defined in: [packages/ai/src/interrupt-resume.ts:78](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupt-resume.ts#L78) ## Extends @@ -17,7 +17,7 @@ Defined in: packages/ai/src/interrupt-resume.ts:78 new InterruptResumeValidationError(errors): InterruptResumeValidationError; ``` -Defined in: packages/ai/src/interrupt-resume.ts:81 +Defined in: [packages/ai/src/interrupt-resume.ts:81](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupt-resume.ts#L81) #### Parameters @@ -43,7 +43,7 @@ Error.constructor readonly errors: readonly InterruptSubmissionError[]; ``` -Defined in: packages/ai/src/interrupt-resume.ts:81 +Defined in: [packages/ai/src/interrupt-resume.ts:81](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupt-resume.ts#L81) *** @@ -53,7 +53,7 @@ Defined in: packages/ai/src/interrupt-resume.ts:81 readonly name: "InterruptResumeValidationError" = 'InterruptResumeValidationError'; ``` -Defined in: packages/ai/src/interrupt-resume.ts:79 +Defined in: [packages/ai/src/interrupt-resume.ts:79](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupt-resume.ts#L79) #### Overrides diff --git a/docs/reference/classes/MCPDuplicateToolNameError.md b/docs/reference/classes/MCPDuplicateToolNameError.md index e79bcebe4c..2cbc5046d4 100644 --- a/docs/reference/classes/MCPDuplicateToolNameError.md +++ b/docs/reference/classes/MCPDuplicateToolNameError.md @@ -3,7 +3,7 @@ id: MCPDuplicateToolNameError title: MCPDuplicateToolNameError --- -Defined in: packages/ai/src/activities/chat/mcp/manager.ts:31 +Defined in: [packages/ai/src/activities/chat/mcp/manager.ts:31](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/mcp/manager.ts#L31) ## Extends @@ -17,7 +17,7 @@ Defined in: packages/ai/src/activities/chat/mcp/manager.ts:31 new MCPDuplicateToolNameError(toolName): MCPDuplicateToolNameError; ``` -Defined in: packages/ai/src/activities/chat/mcp/manager.ts:32 +Defined in: [packages/ai/src/activities/chat/mcp/manager.ts:32](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/mcp/manager.ts#L32) #### Parameters @@ -43,4 +43,4 @@ Error.constructor readonly toolName: string; ``` -Defined in: packages/ai/src/activities/chat/mcp/manager.ts:32 +Defined in: [packages/ai/src/activities/chat/mcp/manager.ts:32](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/mcp/manager.ts#L32) diff --git a/docs/reference/classes/PartialJSONParser.md b/docs/reference/classes/PartialJSONParser.md index 203bfbeb26..373dca94fe 100644 --- a/docs/reference/classes/PartialJSONParser.md +++ b/docs/reference/classes/PartialJSONParser.md @@ -3,7 +3,7 @@ id: PartialJSONParser title: PartialJSONParser --- -Defined in: packages/ai/src/activities/chat/stream/json-parser.ts:25 +Defined in: [packages/ai/src/activities/chat/stream/json-parser.ts:25](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/json-parser.ts#L25) Partial JSON Parser implementation using the partial-json library This parser can handle incomplete JSON strings during streaming @@ -32,7 +32,7 @@ new PartialJSONParser(): PartialJSONParser; parse(jsonString): any; ``` -Defined in: packages/ai/src/activities/chat/stream/json-parser.ts:31 +Defined in: [packages/ai/src/activities/chat/stream/json-parser.ts:31](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/json-parser.ts#L31) Parse a potentially incomplete JSON string diff --git a/docs/reference/classes/PunctuationStrategy.md b/docs/reference/classes/PunctuationStrategy.md index f77a6a1b74..1ed11929bb 100644 --- a/docs/reference/classes/PunctuationStrategy.md +++ b/docs/reference/classes/PunctuationStrategy.md @@ -3,7 +3,7 @@ id: PunctuationStrategy title: PunctuationStrategy --- -Defined in: packages/ai/src/activities/chat/stream/strategies.ts:22 +Defined in: [packages/ai/src/activities/chat/stream/strategies.ts:22](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/strategies.ts#L22) Punctuation Strategy - emit when chunk contains punctuation Useful for natural text flow in UI @@ -32,7 +32,7 @@ new PunctuationStrategy(): PunctuationStrategy; shouldEmit(chunk, _accumulated): boolean; ``` -Defined in: packages/ai/src/activities/chat/stream/strategies.ts:25 +Defined in: [packages/ai/src/activities/chat/stream/strategies.ts:25](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/strategies.ts#L25) Called for each text chunk received diff --git a/docs/reference/classes/SkillLimitError.md b/docs/reference/classes/SkillLimitError.md index 065425a220..f8fdffb14f 100644 --- a/docs/reference/classes/SkillLimitError.md +++ b/docs/reference/classes/SkillLimitError.md @@ -3,7 +3,7 @@ id: SkillLimitError title: SkillLimitError --- -Defined in: packages/ai/src/utilities/errors.ts:22 +Defined in: [packages/ai/src/utilities/errors.ts:22](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/errors.ts#L22) ## Extends @@ -17,7 +17,7 @@ Defined in: packages/ai/src/utilities/errors.ts:22 new SkillLimitError(init): SkillLimitError; ``` -Defined in: packages/ai/src/utilities/errors.ts:30 +Defined in: [packages/ai/src/utilities/errors.ts:30](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/errors.ts#L30) #### Parameters @@ -43,7 +43,7 @@ Error.constructor readonly actual: number; ``` -Defined in: packages/ai/src/utilities/errors.ts:27 +Defined in: [packages/ai/src/utilities/errors.ts:27](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/errors.ts#L27) *** @@ -53,7 +53,7 @@ Defined in: packages/ai/src/utilities/errors.ts:27 readonly allowed: number; ``` -Defined in: packages/ai/src/utilities/errors.ts:26 +Defined in: [packages/ai/src/utilities/errors.ts:26](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/errors.ts#L26) *** @@ -63,7 +63,7 @@ Defined in: packages/ai/src/utilities/errors.ts:26 readonly limit: string; ``` -Defined in: packages/ai/src/utilities/errors.ts:25 +Defined in: [packages/ai/src/utilities/errors.ts:25](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/errors.ts#L25) *** @@ -73,7 +73,7 @@ Defined in: packages/ai/src/utilities/errors.ts:25 readonly offending: string[]; ``` -Defined in: packages/ai/src/utilities/errors.ts:28 +Defined in: [packages/ai/src/utilities/errors.ts:28](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/errors.ts#L28) *** @@ -83,7 +83,7 @@ Defined in: packages/ai/src/utilities/errors.ts:28 readonly path: "native" | "portable"; ``` -Defined in: packages/ai/src/utilities/errors.ts:24 +Defined in: [packages/ai/src/utilities/errors.ts:24](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/errors.ts#L24) *** @@ -93,4 +93,4 @@ Defined in: packages/ai/src/utilities/errors.ts:24 readonly provider: "anthropic" | "openai" | "gemini" | "other"; ``` -Defined in: packages/ai/src/utilities/errors.ts:23 +Defined in: [packages/ai/src/utilities/errors.ts:23](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/errors.ts#L23) diff --git a/docs/reference/classes/StandardSchemaValidationError.md b/docs/reference/classes/StandardSchemaValidationError.md index 11451e21ca..cca3c8fc52 100644 --- a/docs/reference/classes/StandardSchemaValidationError.md +++ b/docs/reference/classes/StandardSchemaValidationError.md @@ -3,7 +3,7 @@ id: StandardSchemaValidationError title: StandardSchemaValidationError --- -Defined in: packages/ai/src/activities/chat/tools/schema-converter.ts:443 +Defined in: [packages/ai/src/activities/chat/tools/schema-converter.ts:443](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/schema-converter.ts#L443) Error thrown when Standard Schema validation fails. Carries the original `issues` array so consumers (middleware `onError`, callers catching from @@ -21,7 +21,7 @@ Error thrown when Standard Schema validation fails. Carries the original new StandardSchemaValidationError(issues): StandardSchemaValidationError; ``` -Defined in: packages/ai/src/activities/chat/tools/schema-converter.ts:447 +Defined in: [packages/ai/src/activities/chat/tools/schema-converter.ts:447](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/schema-converter.ts#L447) #### Parameters @@ -47,7 +47,7 @@ Error.constructor readonly issues: readonly Issue[]; ``` -Defined in: packages/ai/src/activities/chat/tools/schema-converter.ts:445 +Defined in: [packages/ai/src/activities/chat/tools/schema-converter.ts:445](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/schema-converter.ts#L445) *** @@ -57,7 +57,7 @@ Defined in: packages/ai/src/activities/chat/tools/schema-converter.ts:445 readonly name: "StandardSchemaValidationError" = 'StandardSchemaValidationError'; ``` -Defined in: packages/ai/src/activities/chat/tools/schema-converter.ts:444 +Defined in: [packages/ai/src/activities/chat/tools/schema-converter.ts:444](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/schema-converter.ts#L444) #### Overrides diff --git a/docs/reference/classes/StreamProcessor.md b/docs/reference/classes/StreamProcessor.md index 2ef0e64f70..0819c659f7 100644 --- a/docs/reference/classes/StreamProcessor.md +++ b/docs/reference/classes/StreamProcessor.md @@ -3,7 +3,7 @@ id: StreamProcessor title: StreamProcessor --- -Defined in: packages/ai/src/activities/chat/stream/processor.ts:237 +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:237](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L237) StreamProcessor - State machine for processing AI response streams @@ -30,7 +30,7 @@ State tracking: new StreamProcessor(options?): StreamProcessor; ``` -Defined in: packages/ai/src/activities/chat/stream/processor.ts:302 +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:302](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L302) #### Parameters @@ -50,7 +50,7 @@ Defined in: packages/ai/src/activities/chat/stream/processor.ts:302 addToolApprovalResponse(approvalId, approved): void; ``` -Defined in: packages/ai/src/activities/chat/stream/processor.ts:494 +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:494](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L494) Add an approval response (called by client after handling onApprovalRequest) @@ -79,7 +79,7 @@ addToolResult( error?): void; ``` -Defined in: packages/ai/src/activities/chat/stream/processor.ts:443 +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:443](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L443) Add a tool result (called by client after handling onToolCall) @@ -112,7 +112,7 @@ addUserMessage( metadata?): UIMessage; ``` -Defined in: packages/ai/src/activities/chat/stream/processor.ts:382 +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:382](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L382) Add a user message to the conversation. Supports both simple string content and multimodal content arrays. @@ -167,7 +167,7 @@ processor.addUserMessage('Hello!', 'custom-id-123') areAllToolsComplete(): boolean; ``` -Defined in: packages/ai/src/activities/chat/stream/processor.ts:534 +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:534](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L534) Check if all tool calls in the last assistant message are complete Useful for auto-continue logic @@ -184,7 +184,7 @@ Useful for auto-continue logic clearMessages(): void; ``` -Defined in: packages/ai/src/activities/chat/stream/processor.ts:624 +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:624](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L624) Clear all messages @@ -200,7 +200,7 @@ Clear all messages finalizeStream(): void; ``` -Defined in: packages/ai/src/activities/chat/stream/processor.ts:3446 +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:3446](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L3446) Finalize the stream — complete all pending operations. @@ -224,7 +224,7 @@ docs/chat-architecture.md#single-shot-text-response — Finalization step getCurrentAssistantMessageId(): string | null; ``` -Defined in: packages/ai/src/activities/chat/stream/processor.ts:427 +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:427](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L427) Get the current assistant message ID (if one has been created). Returns null if prepareAssistantMessage() was called but no content @@ -242,7 +242,7 @@ has arrived yet. getMessages(): UIMessage[]; ``` -Defined in: packages/ai/src/activities/chat/stream/processor.ts:526 +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:526](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L526) Get current messages @@ -258,7 +258,7 @@ Get current messages getRecording(): ChunkRecording | null; ``` -Defined in: packages/ai/src/activities/chat/stream/processor.ts:3614 +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:3614](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L3614) Get the current recording @@ -274,7 +274,7 @@ Get the current recording getState(): ProcessorState; ``` -Defined in: packages/ai/src/activities/chat/stream/processor.ts:3571 +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:3571](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L3571) Get current processor state (aggregated across all messages) @@ -290,7 +290,7 @@ Get current processor state (aggregated across all messages) prepareAssistantMessage(): void; ``` -Defined in: packages/ai/src/activities/chat/stream/processor.ts:417 +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:417](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L417) Prepare for a new assistant message stream. Does NOT create the message immediately -- the message is created lazily @@ -310,7 +310,7 @@ auto-continuation produces no content. prependMessages(messages): void; ``` -Defined in: packages/ai/src/activities/chat/stream/processor.ts:343 +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:343](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L343) Put older UI messages at the front of the conversation. @@ -346,7 +346,7 @@ processor.prependMessages([oldest]) process(stream): Promise; ``` -Defined in: packages/ai/src/activities/chat/stream/processor.ts:650 +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:650](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L650) Process a stream and emit events through handlers @@ -368,7 +368,7 @@ Process a stream and emit events through handlers processChunk(chunk): void; ``` -Defined in: packages/ai/src/activities/chat/stream/processor.ts:684 +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:684](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L684) Process a single chunk from the stream. @@ -398,7 +398,7 @@ docs/chat-architecture.md#adapter-contract — Expected event types and ordering removeMessagesAfter(index): void; ``` -Defined in: packages/ai/src/activities/chat/stream/processor.ts:574 +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:574](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L574) Remove messages after a certain index (for reload/retry) @@ -420,7 +420,7 @@ Remove messages after a certain index (for reload/retry) reset(): void; ``` -Defined in: packages/ai/src/activities/chat/stream/processor.ts:3644 +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:3644](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L3644) Full reset (including messages) @@ -436,7 +436,7 @@ Full reset (including messages) setMessages(messages): void; ``` -Defined in: packages/ai/src/activities/chat/stream/processor.ts:322 +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:322](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L322) Set the messages array (e.g., from persisted state) @@ -458,7 +458,7 @@ Set the messages array (e.g., from persisted state) startRecording(): void; ``` -Defined in: packages/ai/src/activities/chat/stream/processor.ts:3601 +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:3601](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L3601) Start recording chunks @@ -477,7 +477,7 @@ toModelMessages(): ModelMessage< | null>[]; ``` -Defined in: packages/ai/src/activities/chat/stream/processor.ts:515 +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:515](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L515) Get the conversation as ModelMessages (for sending to LLM) @@ -496,7 +496,7 @@ Get the conversation as ModelMessages (for sending to LLM) static replay(recording, options?): Promise; ``` -Defined in: packages/ai/src/activities/chat/stream/processor.ts:3665 +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:3665](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L3665) Replay a recording through the processor diff --git a/docs/reference/classes/SubagentBudget.md b/docs/reference/classes/SubagentBudget.md index 6fda3f8c71..6f1343eade 100644 --- a/docs/reference/classes/SubagentBudget.md +++ b/docs/reference/classes/SubagentBudget.md @@ -3,7 +3,7 @@ id: SubagentBudget title: SubagentBudget --- -Defined in: packages/ai/src/activities/chat/agents/limits.ts:17 +Defined in: [packages/ai/src/activities/chat/agents/limits.ts:17](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/limits.ts#L17) The shared budget of one subagent tree. @@ -15,7 +15,7 @@ The shared budget of one subagent tree. readonly deadline: number | undefined; ``` -Defined in: packages/ai/src/activities/chat/agents/limits.ts:24 +Defined in: [packages/ai/src/activities/chat/agents/limits.ts:24](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/limits.ts#L24) Epoch ms after which this run's children must stop, if any. @@ -27,7 +27,7 @@ Epoch ms after which this run's children must stop, if any. readonly depth: number; ``` -Defined in: packages/ai/src/activities/chat/agents/limits.ts:21 +Defined in: [packages/ai/src/activities/chat/agents/limits.ts:21](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/limits.ts#L21) The depth of the run that owns this budget view. @@ -39,7 +39,7 @@ The depth of the run that owns this budget view. readonly limits: SubagentLimits; ``` -Defined in: packages/ai/src/activities/chat/agents/limits.ts:19 +Defined in: [packages/ai/src/activities/chat/agents/limits.ts:19](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/limits.ts#L19) ## Accessors @@ -51,7 +51,7 @@ Defined in: packages/ai/src/activities/chat/agents/limits.ts:19 get calls(): number; ``` -Defined in: packages/ai/src/activities/chat/agents/limits.ts:33 +Defined in: [packages/ai/src/activities/chat/agents/limits.ts:33](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/limits.ts#L33) How many children the tree started so far. @@ -67,7 +67,7 @@ How many children the tree started so far. child(deadline?): SubagentBudget; ``` -Defined in: packages/ai/src/activities/chat/agents/limits.ts:72 +Defined in: [packages/ai/src/activities/chat/agents/limits.ts:72](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/limits.ts#L72) The budget a child's own subagents use: one level deeper, same counters. @@ -89,7 +89,7 @@ The budget a child's own subagents use: one level deeper, same counters. childTimeout(now?): number | undefined; ``` -Defined in: packages/ai/src/activities/chat/agents/limits.ts:63 +Defined in: [packages/ai/src/activities/chat/agents/limits.ts:63](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/limits.ts#L63) Milliseconds a child started now may run, or `undefined` for no limit. @@ -111,7 +111,7 @@ Milliseconds a child started now may run, or `undefined` for no limit. release(): void; ``` -Defined in: packages/ai/src/activities/chat/agents/limits.ts:58 +Defined in: [packages/ai/src/activities/chat/agents/limits.ts:58](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/limits.ts#L58) Undo one `reserve`. A background start that throws never began. @@ -127,7 +127,7 @@ Undo one `reserve`. A background start that throws never began. reserve(active): string | undefined; ``` -Defined in: packages/ai/src/activities/chat/agents/limits.ts:42 +Defined in: [packages/ai/src/activities/chat/agents/limits.ts:42](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/limits.ts#L42) Reserve one child spawn. Returns the refusal message the model sees, or `undefined` when the child may start. `active` is how many children this @@ -151,7 +151,7 @@ run has running now. static root(limits?): SubagentBudget; ``` -Defined in: packages/ai/src/activities/chat/agents/limits.ts:28 +Defined in: [packages/ai/src/activities/chat/agents/limits.ts:28](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/limits.ts#L28) A budget for a root run. diff --git a/docs/reference/classes/ToolCallManager.md b/docs/reference/classes/ToolCallManager.md index cb953d3a9b..a58b1de89a 100644 --- a/docs/reference/classes/ToolCallManager.md +++ b/docs/reference/classes/ToolCallManager.md @@ -3,7 +3,7 @@ id: ToolCallManager title: ToolCallManager --- -Defined in: packages/ai/src/activities/chat/tools/tool-calls.ts:290 +Defined in: [packages/ai/src/activities/chat/tools/tool-calls.ts:297](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-calls.ts#L297) Manages tool call accumulation and execution for the chat() method's automatic tool execution loop. @@ -57,7 +57,7 @@ if (manager.hasToolCalls()) { new ToolCallManager(tools): ToolCallManager; ``` -Defined in: packages/ai/src/activities/chat/tools/tool-calls.ts:301 +Defined in: [packages/ai/src/activities/chat/tools/tool-calls.ts:308](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-calls.ts#L308) #### Parameters @@ -77,7 +77,7 @@ Defined in: packages/ai/src/activities/chat/tools/tool-calls.ts:301 addToolCallArgsEvent(event): void; ``` -Defined in: packages/ai/src/activities/chat/tools/tool-calls.ts:338 +Defined in: [packages/ai/src/activities/chat/tools/tool-calls.ts:345](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-calls.ts#L345) Add a TOOL_CALL_ARGS event to accumulate arguments (AG-UI) @@ -99,7 +99,7 @@ Add a TOOL_CALL_ARGS event to accumulate arguments (AG-UI) addToolCallStartEvent(event): void; ``` -Defined in: packages/ai/src/activities/chat/tools/tool-calls.ts:312 +Defined in: [packages/ai/src/activities/chat/tools/tool-calls.ts:319](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-calls.ts#L319) Add a TOOL_CALL_START event to begin tracking a tool call (AG-UI) @@ -121,7 +121,7 @@ Add a TOOL_CALL_START event to begin tracking a tool call (AG-UI) clear(): void; ``` -Defined in: packages/ai/src/activities/chat/tools/tool-calls.ts:497 +Defined in: [packages/ai/src/activities/chat/tools/tool-calls.ts:504](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-calls.ts#L504) Clear the tool calls map for the next iteration @@ -142,7 +142,7 @@ completeToolCall(event): | undefined; ``` -Defined in: packages/ai/src/activities/chat/tools/tool-calls.ts:356 +Defined in: [packages/ai/src/activities/chat/tools/tool-calls.ts:363](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-calls.ts#L363) Complete a tool call with its final input Called when TOOL_CALL_END is received @@ -172,7 +172,7 @@ executeTools(finishEvent, ...contextArgs): AsyncGenerator[], void>; ``` -Defined in: packages/ai/src/activities/chat/tools/tool-calls.ts:389 +Defined in: [packages/ai/src/activities/chat/tools/tool-calls.ts:396](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-calls.ts#L396) Execute all tool calls and return tool result messages Yields TOOL_CALL_END events for streaming @@ -204,7 +204,7 @@ RUN_FINISHED event from the stream getToolCalls(): ToolCall[]; ``` -Defined in: packages/ai/src/activities/chat/tools/tool-calls.ts:378 +Defined in: [packages/ai/src/activities/chat/tools/tool-calls.ts:385](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-calls.ts#L385) Get all complete tool calls (filtered for valid ID and name) @@ -220,7 +220,7 @@ Get all complete tool calls (filtered for valid ID and name) hasToolCalls(): boolean; ``` -Defined in: packages/ai/src/activities/chat/tools/tool-calls.ts:371 +Defined in: [packages/ai/src/activities/chat/tools/tool-calls.ts:378](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-calls.ts#L378) Check if there are any complete tool calls to execute diff --git a/docs/reference/classes/WordBoundaryStrategy.md b/docs/reference/classes/WordBoundaryStrategy.md index 6430e9981d..6e160dc2de 100644 --- a/docs/reference/classes/WordBoundaryStrategy.md +++ b/docs/reference/classes/WordBoundaryStrategy.md @@ -3,7 +3,7 @@ id: WordBoundaryStrategy title: WordBoundaryStrategy --- -Defined in: packages/ai/src/activities/chat/stream/strategies.ts:57 +Defined in: [packages/ai/src/activities/chat/stream/strategies.ts:57](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/strategies.ts#L57) Word Boundary Strategy - emit at word boundaries Prevents cutting words in half @@ -32,7 +32,7 @@ new WordBoundaryStrategy(): WordBoundaryStrategy; shouldEmit(chunk, _accumulated): boolean; ``` -Defined in: packages/ai/src/activities/chat/stream/strategies.ts:58 +Defined in: [packages/ai/src/activities/chat/stream/strategies.ts:58](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/strategies.ts#L58) Called for each text chunk received diff --git a/docs/reference/functions/assertMessagesFileSourceSupport.md b/docs/reference/functions/assertMessagesFileSourceSupport.md index 865b1c403b..8b7af68a90 100644 --- a/docs/reference/functions/assertMessagesFileSourceSupport.md +++ b/docs/reference/functions/assertMessagesFileSourceSupport.md @@ -7,7 +7,7 @@ title: assertMessagesFileSourceSupport function assertMessagesFileSourceSupport(adapter, messages): void; ``` -Defined in: packages/ai/src/utilities/content-source.ts:123 +Defined in: [packages/ai/src/utilities/content-source.ts:123](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/content-source.ts#L123) Fail-closed preflight for chat messages: throws when any message content part carries a `{ type: 'file' }` source and the adapter hasn't declared diff --git a/docs/reference/functions/assertPromptFileSourceSupport.md b/docs/reference/functions/assertPromptFileSourceSupport.md index 7e0a3e366d..4c5e8d30ff 100644 --- a/docs/reference/functions/assertPromptFileSourceSupport.md +++ b/docs/reference/functions/assertPromptFileSourceSupport.md @@ -7,7 +7,7 @@ title: assertPromptFileSourceSupport function assertPromptFileSourceSupport(adapter, prompt): void; ``` -Defined in: packages/ai/src/utilities/content-source.ts:108 +Defined in: [packages/ai/src/utilities/content-source.ts:108](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/content-source.ts#L108) Fail-closed preflight for media prompts and embedding inputs (`generateImage` / `generateVideo` / `embed`): throws when the input diff --git a/docs/reference/functions/boolean.md b/docs/reference/functions/boolean.md index a5c65be030..ff303fd754 100644 --- a/docs/reference/functions/boolean.md +++ b/docs/reference/functions/boolean.md @@ -20,7 +20,7 @@ function boolean(options): }; ``` -Defined in: packages/ai/src/activities/evaluate/index.ts:423 +Defined in: [packages/ai/src/activities/evaluate/index.ts:424](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/evaluate/index.ts#L424) Build a yes/no question. diff --git a/docs/reference/functions/brandProviderTool.md b/docs/reference/functions/brandProviderTool.md index 5428a3bf36..00df238340 100644 --- a/docs/reference/functions/brandProviderTool.md +++ b/docs/reference/functions/brandProviderTool.md @@ -7,7 +7,7 @@ title: brandProviderTool function brandProviderTool(tool): T; ``` -Defined in: packages/ai/src/tools/provider-tool.ts:35 +Defined in: [packages/ai/src/tools/provider-tool.ts:35](https://github.com/TanStack/ai/blob/main/packages/ai/src/tools/provider-tool.ts#L35) Attach the `ProviderTool` phantom brand to a plain `Tool`-shaped object. diff --git a/docs/reference/functions/buildBaseUsage.md b/docs/reference/functions/buildBaseUsage.md index 1b52066ec8..4b1078e336 100644 --- a/docs/reference/functions/buildBaseUsage.md +++ b/docs/reference/functions/buildBaseUsage.md @@ -7,7 +7,7 @@ title: buildBaseUsage function buildBaseUsage(input): TokenUsage; ``` -Defined in: packages/ai/src/utilities/usage.ts:33 +Defined in: [packages/ai/src/utilities/usage.ts:33](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/usage.ts#L33) Builds the base TokenUsage object with core fields. Provider-specific functions should use this and then add their own details. diff --git a/docs/reference/functions/canonicalInterruptJson.md b/docs/reference/functions/canonicalInterruptJson.md index a9bbd60c64..dac07ae748 100644 --- a/docs/reference/functions/canonicalInterruptJson.md +++ b/docs/reference/functions/canonicalInterruptJson.md @@ -7,7 +7,7 @@ title: canonicalInterruptJson function canonicalInterruptJson(value): string; ``` -Defined in: packages/ai/src/interrupt-serialization.ts:157 +Defined in: [packages/ai/src/interrupt-serialization.ts:157](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupt-serialization.ts#L157) ## Parameters diff --git a/docs/reference/functions/canonicalizeInterruptResolutions.md b/docs/reference/functions/canonicalizeInterruptResolutions.md index 356f9b6a52..5477052ee5 100644 --- a/docs/reference/functions/canonicalizeInterruptResolutions.md +++ b/docs/reference/functions/canonicalizeInterruptResolutions.md @@ -7,7 +7,7 @@ title: canonicalizeInterruptResolutions function canonicalizeInterruptResolutions(resolutions): object; ``` -Defined in: packages/ai/src/interrupts.ts:137 +Defined in: [packages/ai/src/interrupts.ts:137](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupts.ts#L137) ## Parameters diff --git a/docs/reference/functions/chat.md b/docs/reference/functions/chat.md index c5f02c1055..4f16477997 100644 --- a/docs/reference/functions/chat.md +++ b/docs/reference/functions/chat.md @@ -7,7 +7,7 @@ title: chat function chat(options): TextActivityResult; ``` -Defined in: packages/ai/src/activities/chat/index.ts:5864 +Defined in: [packages/ai/src/activities/chat/index.ts:6128](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/index.ts#L6128) Text activity - handles agentic text generation, one-shot text generation, and agentic structured output. diff --git a/docs/reference/functions/chatParamsFromRequest.md b/docs/reference/functions/chatParamsFromRequest.md index 2966aa6048..9b2dcc012b 100644 --- a/docs/reference/functions/chatParamsFromRequest.md +++ b/docs/reference/functions/chatParamsFromRequest.md @@ -22,7 +22,7 @@ function chatParamsFromRequest(req): Promise<{ }>; ``` -Defined in: packages/ai/src/utilities/chat-params.ts:276 +Defined in: [packages/ai/src/utilities/chat-params.ts:276](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/chat-params.ts#L276) Read an HTTP `Request`, parse its JSON body, and validate it as an AG-UI `RunAgentInput` — collapsing the standard `req.json()` + diff --git a/docs/reference/functions/chatParamsFromRequestBody.md b/docs/reference/functions/chatParamsFromRequestBody.md index ad80479033..a7e4903304 100644 --- a/docs/reference/functions/chatParamsFromRequestBody.md +++ b/docs/reference/functions/chatParamsFromRequestBody.md @@ -22,7 +22,7 @@ function chatParamsFromRequestBody(body): Promise<{ }>; ``` -Defined in: packages/ai/src/utilities/chat-params.ts:204 +Defined in: [packages/ai/src/utilities/chat-params.ts:204](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/chat-params.ts#L204) Parse and validate an HTTP request body as an AG-UI `RunAgentInput`. diff --git a/docs/reference/functions/choice.md b/docs/reference/functions/choice.md index 36db370718..af30f913ab 100644 --- a/docs/reference/functions/choice.md +++ b/docs/reference/functions/choice.md @@ -7,7 +7,7 @@ title: choice function choice(options): object; ``` -Defined in: packages/ai/src/activities/evaluate/index.ts:365 +Defined in: [packages/ai/src/activities/evaluate/index.ts:366](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/evaluate/index.ts#L366) Build a choice question. The model picks one key from `options`. diff --git a/docs/reference/functions/clampReasoningLevel.md b/docs/reference/functions/clampReasoningLevel.md index 5c74358136..8d866e3537 100644 --- a/docs/reference/functions/clampReasoningLevel.md +++ b/docs/reference/functions/clampReasoningLevel.md @@ -7,7 +7,7 @@ title: clampReasoningLevel function clampReasoningLevel(reasoning, level): ReasoningLevel; ``` -Defined in: packages/ai/src/reasoning.ts:128 +Defined in: [packages/ai/src/reasoning.ts:128](https://github.com/TanStack/ai/blob/main/packages/ai/src/reasoning.ts#L128) A level the model supports: the level itself, else the nearest supported level above it, else the nearest below it, else `off`. The same rule as pi. diff --git a/docs/reference/functions/cloneAndDeepFreezeJson.md b/docs/reference/functions/cloneAndDeepFreezeJson.md index f112357f29..abd91a2254 100644 --- a/docs/reference/functions/cloneAndDeepFreezeJson.md +++ b/docs/reference/functions/cloneAndDeepFreezeJson.md @@ -7,7 +7,7 @@ title: cloneAndDeepFreezeJson function cloneAndDeepFreezeJson(value): T; ``` -Defined in: packages/ai/src/interrupt-serialization.ts:179 +Defined in: [packages/ai/src/interrupt-serialization.ts:179](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupt-serialization.ts#L179) ## Type Parameters diff --git a/docs/reference/functions/combineStrategies.md b/docs/reference/functions/combineStrategies.md index 25a4b3878f..c0db345fa8 100644 --- a/docs/reference/functions/combineStrategies.md +++ b/docs/reference/functions/combineStrategies.md @@ -7,7 +7,7 @@ title: combineStrategies function combineStrategies(strategies): AgentLoopStrategy; ``` -Defined in: packages/ai/src/activities/chat/agent-loop-strategies.ts:85 +Defined in: [packages/ai/src/activities/chat/agent-loop-strategies.ts:85](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agent-loop-strategies.ts#L85) Creates a strategy that combines multiple strategies with AND logic All strategies must return true to continue diff --git a/docs/reference/functions/compactForModel.md b/docs/reference/functions/compactForModel.md index 70172d4aaf..da43c40a8b 100644 --- a/docs/reference/functions/compactForModel.md +++ b/docs/reference/functions/compactForModel.md @@ -7,7 +7,7 @@ title: compactForModel function compactForModel(value, depth?): unknown; ``` -Defined in: packages/ai/src/activities/chat/tools/tool-calls.ts:96 +Defined in: [packages/ai/src/activities/chat/tools/tool-calls.ts:97](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-calls.ts#L97) A copy of a subagent result that is safe to send to the parent model. A string longer than MODEL\_RESULT\_MAX\_STRING (for example a base64 diff --git a/docs/reference/functions/convertMessagesToModelMessages.md b/docs/reference/functions/convertMessagesToModelMessages.md index bdaf8155d1..5f508eadb3 100644 --- a/docs/reference/functions/convertMessagesToModelMessages.md +++ b/docs/reference/functions/convertMessagesToModelMessages.md @@ -10,7 +10,7 @@ function convertMessagesToModelMessages(messages): ModelMessage< | null>[]; ``` -Defined in: packages/ai/src/activities/chat/messages.ts:195 +Defined in: [packages/ai/src/activities/chat/messages.ts:195](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/messages.ts#L195) Convert UIMessages or ModelMessages to ModelMessages diff --git a/docs/reference/functions/convertSchemaToJsonSchema.md b/docs/reference/functions/convertSchemaToJsonSchema.md index 6241ddf37c..603c960d67 100644 --- a/docs/reference/functions/convertSchemaToJsonSchema.md +++ b/docs/reference/functions/convertSchemaToJsonSchema.md @@ -7,7 +7,7 @@ title: convertSchemaToJsonSchema function convertSchemaToJsonSchema(schema, options?): JSONSchema | undefined; ``` -Defined in: packages/ai/src/activities/chat/tools/schema-converter.ts:349 +Defined in: [packages/ai/src/activities/chat/tools/schema-converter.ts:349](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/schema-converter.ts#L349) Converts a Standard JSON Schema compliant schema or plain JSONSchema to JSON Schema format compatible with LLM providers. diff --git a/docs/reference/functions/countEmbeddingInputModalities.md b/docs/reference/functions/countEmbeddingInputModalities.md index ee847fa264..b6d68ec2a3 100644 --- a/docs/reference/functions/countEmbeddingInputModalities.md +++ b/docs/reference/functions/countEmbeddingInputModalities.md @@ -7,7 +7,7 @@ title: countEmbeddingInputModalities function countEmbeddingInputModalities(input): object; ``` -Defined in: packages/ai/src/utilities/embedding-input.ts:73 +Defined in: [packages/ai/src/utilities/embedding-input.ts:73](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/embedding-input.ts#L73) Count text-only and image-carrying items for observability events. Never exposes input content. diff --git a/docs/reference/functions/createAudioOptions.md b/docs/reference/functions/createAudioOptions.md index f4381119a7..0d8624cc70 100644 --- a/docs/reference/functions/createAudioOptions.md +++ b/docs/reference/functions/createAudioOptions.md @@ -7,7 +7,7 @@ title: createAudioOptions function createAudioOptions(options): AudioActivityOptions; ``` -Defined in: packages/ai/src/activities/generateAudio/index.ts:318 +Defined in: [packages/ai/src/activities/generateAudio/index.ts:318](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateAudio/index.ts#L318) Create typed options for the generateAudio() function without executing. diff --git a/docs/reference/functions/createCapability.md b/docs/reference/functions/createCapability.md index d0032b3b26..236e05dfe1 100644 --- a/docs/reference/functions/createCapability.md +++ b/docs/reference/functions/createCapability.md @@ -7,7 +7,7 @@ title: createCapability function createCapability(): (name) => Capability; ``` -Defined in: packages/ai/src/activities/chat/middleware/capabilities.ts:114 +Defined in: [packages/ai/src/activities/chat/middleware/capabilities.ts:114](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/capabilities.ts#L114) Create a capability. Returns a hybrid handle that destructures to `[get, provide]` and is itself the identity for `requires`/`provides`. diff --git a/docs/reference/functions/createChatMiddleware.md b/docs/reference/functions/createChatMiddleware.md index 09c9ec5eb6..41b7684613 100644 --- a/docs/reference/functions/createChatMiddleware.md +++ b/docs/reference/functions/createChatMiddleware.md @@ -7,7 +7,7 @@ title: createChatMiddleware function createChatMiddleware(): ChatMiddlewareBuilder; ``` -Defined in: packages/ai/src/activities/chat/middleware/builder.ts:114 +Defined in: [packages/ai/src/activities/chat/middleware/builder.ts:114](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/builder.ts#L114) Create an order-aware middleware builder. diff --git a/docs/reference/functions/createChatOptions.md b/docs/reference/functions/createChatOptions.md index f0a8a74ed8..9b6797f94c 100644 --- a/docs/reference/functions/createChatOptions.md +++ b/docs/reference/functions/createChatOptions.md @@ -4,10 +4,10 @@ title: createChatOptions --- ```ts -function createChatOptions(options): Omit, readonly DefinedAgent[], any, unknown, AgentProduces | undefined>[]>, "middleware" | "tools" | "threadId" | "interrupts" | "context"> & object & RuntimeContextOption; +function createChatOptions(options): Omit, readonly DefinedAgent[], any, unknown, AgentProduces | undefined>[]>, "middleware" | "tools" | "context" | "interrupts">, "threadId"> & object & object & RuntimeContextOption; ``` -Defined in: packages/ai/src/activities/chat/index.ts:834 +Defined in: [packages/ai/src/activities/chat/index.ts:845](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/index.ts#L845) Create typed options for the chat() function without executing. This is useful for pre-defining configurations with full type inference. @@ -56,17 +56,11 @@ call. ### options -`Omit`\<`TextActivityOptions`\<`TAdapter`, `TSchema`, `TStream`, `any`, readonly [`DefinedAgent`](../interfaces/DefinedAgent.md)\<`string`, readonly `SubagentTool`[], [`SchemaInput`](../type-aliases/SchemaInput.md) \| `undefined`, readonly [`InterruptDefinition`](../interfaces/InterruptDefinition.md)\<`any`, `any`, `any`, `any`, `any`\>[], `any`, `unknown`, [`AgentProduces`](../type-aliases/AgentProduces.md) \| `undefined`\>[]\>, - \| `"middleware"` - \| `"tools"` - \| `"threadId"` - \| `"toolChoice"` - \| `"interrupts"` - \| `"context"`\> & `object` & `object` & `RuntimeContextOption`\<`TTools`, `TMiddleware`, `TContext`\> +`BoundTextActivityOptions`\<`TAdapter`, `TSchema`, `TStream`, `TTools`, `TInterrupts`, `TContext`, `TMiddleware`\> ## Returns -`Omit`\<`TextActivityOptions`\<`TAdapter`, `TSchema`, `TStream`, `InferredContext`\<`TTools`, `TMiddleware`\>, readonly [`DefinedAgent`](../interfaces/DefinedAgent.md)\<`string`, readonly `SubagentTool`[], [`SchemaInput`](../type-aliases/SchemaInput.md) \| `undefined`, readonly [`InterruptDefinition`](../interfaces/InterruptDefinition.md)\<`any`, `any`, `any`, `any`, `any`\>[], `any`, `unknown`, [`AgentProduces`](../type-aliases/AgentProduces.md) \| `undefined`\>[]\>, `"middleware"` \| `"tools"` \| `"threadId"` \| `"interrupts"` \| `"context"`\> & `object` & `RuntimeContextOption`\<`TTools`, `TMiddleware`, `TContext`\> +`Omit`\<`Omit`\<`TextActivityOptions`\<`TAdapter`, `TSchema`, `TStream`, `InferredContext`\<`TTools`, `TMiddleware`\>, readonly [`DefinedAgent`](../interfaces/DefinedAgent.md)\<`string`, readonly `SubagentTool`[], [`SchemaInput`](../type-aliases/SchemaInput.md) \| `undefined`, readonly [`InterruptDefinition`](../interfaces/InterruptDefinition.md)\<`any`, `any`, `any`, `any`, `any`\>[], `any`, `unknown`, [`AgentProduces`](../type-aliases/AgentProduces.md) \| `undefined`\>[]\>, `"middleware"` \| `"tools"` \| `"context"` \| `"interrupts"`\>, `"threadId"`\> & `object` & `object` & `RuntimeContextOption`\<`TTools`, `TMiddleware`, `TContext`\> ## Example diff --git a/docs/reference/functions/createEmbedOptions.md b/docs/reference/functions/createEmbedOptions.md index 10e98572eb..582dc12f95 100644 --- a/docs/reference/functions/createEmbedOptions.md +++ b/docs/reference/functions/createEmbedOptions.md @@ -7,7 +7,7 @@ title: createEmbedOptions function createEmbedOptions(options): EmbedOptions; ``` -Defined in: packages/ai/src/activities/embed/index.ts:311 +Defined in: [packages/ai/src/activities/embed/index.ts:311](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/embed/index.ts#L311) Create typed options for the embed() function without executing. diff --git a/docs/reference/functions/createFrozenRegistry.md b/docs/reference/functions/createFrozenRegistry.md index bd13519e5e..50c404e533 100644 --- a/docs/reference/functions/createFrozenRegistry.md +++ b/docs/reference/functions/createFrozenRegistry.md @@ -7,7 +7,7 @@ title: createFrozenRegistry function createFrozenRegistry(tools?): ToolRegistry; ``` -Defined in: packages/ai/src/tool-registry.ts:119 +Defined in: [packages/ai/src/tool-registry.ts:119](https://github.com/TanStack/ai/blob/main/packages/ai/src/tool-registry.ts#L119) Create a frozen (immutable) tool registry from a tools array. diff --git a/docs/reference/functions/createImageOptions.md b/docs/reference/functions/createImageOptions.md index 090d945ebc..0501175218 100644 --- a/docs/reference/functions/createImageOptions.md +++ b/docs/reference/functions/createImageOptions.md @@ -7,7 +7,7 @@ title: createImageOptions function createImageOptions(options): ImageActivityOptions; ``` -Defined in: packages/ai/src/activities/generateImage/index.ts:424 +Defined in: [packages/ai/src/activities/generateImage/index.ts:424](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateImage/index.ts#L424) Create typed options for the generateImage() function without executing. diff --git a/docs/reference/functions/createInterruptBinding.md b/docs/reference/functions/createInterruptBinding.md index 3558400095..0a571ba55b 100644 --- a/docs/reference/functions/createInterruptBinding.md +++ b/docs/reference/functions/createInterruptBinding.md @@ -7,7 +7,7 @@ title: createInterruptBinding function createInterruptBinding(request, fields?): InterruptPreEmissionData; ``` -Defined in: packages/ai/src/interrupt-definition.ts:221 +Defined in: [packages/ai/src/interrupt-definition.ts:221](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupt-definition.ts#L221) ## Parameters diff --git a/docs/reference/functions/createLiveVideoOptions.md b/docs/reference/functions/createLiveVideoOptions.md index b1937b914e..faafe234a8 100644 --- a/docs/reference/functions/createLiveVideoOptions.md +++ b/docs/reference/functions/createLiveVideoOptions.md @@ -7,7 +7,7 @@ title: createLiveVideoOptions function createLiveVideoOptions(options): LiveVideoActivityOptions; ``` -Defined in: packages/ai/src/activities/generateLiveVideo/index.ts:324 +Defined in: [packages/ai/src/activities/generateLiveVideo/index.ts:324](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateLiveVideo/index.ts#L324) Create typed options for the generateLiveVideo() function without executing. diff --git a/docs/reference/functions/createModel.md b/docs/reference/functions/createModel.md index 8db53dd298..6aa31d5769 100644 --- a/docs/reference/functions/createModel.md +++ b/docs/reference/functions/createModel.md @@ -9,7 +9,7 @@ title: createModel function createModel(name, input): ExtendedModelDef; ``` -Defined in: packages/ai/src/extend-adapter.ts:91 +Defined in: [packages/ai/src/extend-adapter.ts:91](https://github.com/TanStack/ai/blob/main/packages/ai/src/extend-adapter.ts#L91) Creates a custom model definition for use with `extendAdapter`. @@ -80,7 +80,7 @@ const reasoner = createModel('reasoner', { function createModel(name, capabilities): ExtendedModelDef; ``` -Defined in: packages/ai/src/extend-adapter.ts:96 +Defined in: [packages/ai/src/extend-adapter.ts:96](https://github.com/TanStack/ai/blob/main/packages/ai/src/extend-adapter.ts#L96) Creates a custom model definition for use with `extendAdapter`. diff --git a/docs/reference/functions/createRealtimeEventEmitter.md b/docs/reference/functions/createRealtimeEventEmitter.md index 770efeddb4..3c04e616a0 100644 --- a/docs/reference/functions/createRealtimeEventEmitter.md +++ b/docs/reference/functions/createRealtimeEventEmitter.md @@ -7,7 +7,7 @@ title: createRealtimeEventEmitter function createRealtimeEventEmitter(): object; ``` -Defined in: packages/ai/src/realtime/event-emitter.ts:16 +Defined in: [packages/ai/src/realtime/event-emitter.ts:16](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/event-emitter.ts#L16) ## Returns diff --git a/docs/reference/functions/createReplayStream.md b/docs/reference/functions/createReplayStream.md index 9615b34630..624662cdbc 100644 --- a/docs/reference/functions/createReplayStream.md +++ b/docs/reference/functions/createReplayStream.md @@ -7,7 +7,7 @@ title: createReplayStream function createReplayStream(recording): AsyncIterable; ``` -Defined in: packages/ai/src/activities/chat/stream/processor.ts:3677 +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:3677](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L3677) Create an async iterable from a recording diff --git a/docs/reference/functions/createRerankOptions.md b/docs/reference/functions/createRerankOptions.md index 4b0508600e..6351903dbc 100644 --- a/docs/reference/functions/createRerankOptions.md +++ b/docs/reference/functions/createRerankOptions.md @@ -7,7 +7,7 @@ title: createRerankOptions function createRerankOptions(options): RerankActivityOptions; ``` -Defined in: packages/ai/src/activities/rerank/index.ts:287 +Defined in: [packages/ai/src/activities/rerank/index.ts:287](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/rerank/index.ts#L287) Create typed options for the rerank() function without executing. diff --git a/docs/reference/functions/createSpeechOptions.md b/docs/reference/functions/createSpeechOptions.md index a8ca61b6d6..54f5df7f27 100644 --- a/docs/reference/functions/createSpeechOptions.md +++ b/docs/reference/functions/createSpeechOptions.md @@ -7,7 +7,7 @@ title: createSpeechOptions function createSpeechOptions(options): TTSActivityOptions; ``` -Defined in: packages/ai/src/activities/generateSpeech/index.ts:475 +Defined in: [packages/ai/src/activities/generateSpeech/index.ts:475](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateSpeech/index.ts#L475) Create typed options for the generateSpeech() function without executing. diff --git a/docs/reference/functions/createSubagentId.md b/docs/reference/functions/createSubagentId.md index 948d7e9008..695e33014a 100644 --- a/docs/reference/functions/createSubagentId.md +++ b/docs/reference/functions/createSubagentId.md @@ -7,7 +7,7 @@ title: createSubagentId function createSubagentId(): string; ``` -Defined in: packages/ai/src/activities/chat/agents/spawn.ts:251 +Defined in: [packages/ai/src/activities/chat/agents/spawn.ts:269](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/spawn.ts#L269) ## Returns diff --git a/docs/reference/functions/createSubagentSink.md b/docs/reference/functions/createSubagentSink.md index 19f72a01dc..f6bcb44ca2 100644 --- a/docs/reference/functions/createSubagentSink.md +++ b/docs/reference/functions/createSubagentSink.md @@ -7,7 +7,7 @@ title: createSubagentSink function createSubagentSink(): SubagentSink; ``` -Defined in: packages/ai/src/activities/chat/agents/spawn.ts:213 +Defined in: [packages/ai/src/activities/chat/agents/spawn.ts:231](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/spawn.ts#L231) ## Returns diff --git a/docs/reference/functions/createSummarizeOptions.md b/docs/reference/functions/createSummarizeOptions.md index b553b04af4..5b34be8ab4 100644 --- a/docs/reference/functions/createSummarizeOptions.md +++ b/docs/reference/functions/createSummarizeOptions.md @@ -7,7 +7,7 @@ title: createSummarizeOptions function createSummarizeOptions(options): SummarizeActivityOptions; ``` -Defined in: packages/ai/src/activities/summarize/index.ts:528 +Defined in: [packages/ai/src/activities/summarize/index.ts:528](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/summarize/index.ts#L528) Create typed options for the summarize() function without executing. diff --git a/docs/reference/functions/createToolRegistry.md b/docs/reference/functions/createToolRegistry.md index 12fc8b6d21..2db7ebff94 100644 --- a/docs/reference/functions/createToolRegistry.md +++ b/docs/reference/functions/createToolRegistry.md @@ -7,7 +7,7 @@ title: createToolRegistry function createToolRegistry(initialTools?): ToolRegistry; ``` -Defined in: packages/ai/src/tool-registry.ts:78 +Defined in: [packages/ai/src/tool-registry.ts:78](https://github.com/TanStack/ai/blob/main/packages/ai/src/tool-registry.ts#L78) Create a mutable tool registry for dynamic tool scenarios. diff --git a/docs/reference/functions/createTranscriptionOptions.md b/docs/reference/functions/createTranscriptionOptions.md index b658b22145..7a5cbf62c9 100644 --- a/docs/reference/functions/createTranscriptionOptions.md +++ b/docs/reference/functions/createTranscriptionOptions.md @@ -7,7 +7,7 @@ title: createTranscriptionOptions function createTranscriptionOptions(options): TranscriptionActivityOptions; ``` -Defined in: packages/ai/src/activities/generateTranscription/index.ts:362 +Defined in: [packages/ai/src/activities/generateTranscription/index.ts:362](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateTranscription/index.ts#L362) Create typed options for the generateTranscription() function without executing. diff --git a/docs/reference/functions/createVideoOptions.md b/docs/reference/functions/createVideoOptions.md index 6d51fd3f13..968fb7ab78 100644 --- a/docs/reference/functions/createVideoOptions.md +++ b/docs/reference/functions/createVideoOptions.md @@ -7,7 +7,7 @@ title: createVideoOptions function createVideoOptions(options): VideoCreateOptions; ``` -Defined in: packages/ai/src/activities/generateVideo/index.ts:1113 +Defined in: [packages/ai/src/activities/generateVideo/index.ts:1095](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateVideo/index.ts#L1095) Create typed options for the generateVideo() function without executing. diff --git a/docs/reference/functions/createVoiceOptions.md b/docs/reference/functions/createVoiceOptions.md index f516a49ffa..07dfb4a5c6 100644 --- a/docs/reference/functions/createVoiceOptions.md +++ b/docs/reference/functions/createVoiceOptions.md @@ -7,7 +7,7 @@ title: createVoiceOptions function createVoiceOptions(options): VoiceActivityOptions; ``` -Defined in: packages/ai/src/activities/generateVoice/index.ts:359 +Defined in: [packages/ai/src/activities/generateVoice/index.ts:359](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateVoice/index.ts#L359) Create typed options for the generateVoice() function without executing. diff --git a/docs/reference/functions/createWorldOptions.md b/docs/reference/functions/createWorldOptions.md index c6ae84cfec..10b670d221 100644 --- a/docs/reference/functions/createWorldOptions.md +++ b/docs/reference/functions/createWorldOptions.md @@ -7,7 +7,7 @@ title: createWorldOptions function createWorldOptions(options): WorldActivityOptions; ``` -Defined in: packages/ai/src/activities/generateWorld/index.ts:326 +Defined in: [packages/ai/src/activities/generateWorld/index.ts:326](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateWorld/index.ts#L326) Create typed options for the generateWorld() function without executing. diff --git a/docs/reference/functions/decide.md b/docs/reference/functions/decide.md index 456a8f8f35..8ce12ec9fb 100644 --- a/docs/reference/functions/decide.md +++ b/docs/reference/functions/decide.md @@ -7,7 +7,7 @@ title: decide function decide(options): Promise<{ [K in string | number | symbol]: InferEvaluateAnswer } & object>; ``` -Defined in: packages/ai/src/activities/evaluate/index.ts:497 +Defined in: [packages/ai/src/activities/evaluate/index.ts:502](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/evaluate/index.ts#L502) Ask typed questions about `state` and get answers your code can branch on. @@ -18,6 +18,10 @@ branch on `result.queue.value` in ordinary TypeScript. The question key `meta` is reserved. Throws if `questions` is empty or uses that key. +When the adapter throws an `EvaluateError` that carries `usage`, `decide()` +reports that usage through `onUsage` and the `evaluate:usage` event, then +runs `onError` and rethrows the same error. + ## Type Parameters ### TAdapter diff --git a/docs/reference/functions/decodeWsFrame.md b/docs/reference/functions/decodeWsFrame.md index b9c6ee776e..41de6e6944 100644 --- a/docs/reference/functions/decodeWsFrame.md +++ b/docs/reference/functions/decodeWsFrame.md @@ -7,7 +7,7 @@ title: decodeWsFrame function decodeWsFrame(data): InboundFrame; ``` -Defined in: packages/ai/src/stream-to-websocket.ts:48 +Defined in: [packages/ai/src/stream-to-websocket.ts:54](https://github.com/TanStack/ai/blob/main/packages/ai/src/stream-to-websocket.ts#L54) Decode one client→server frame. An `{ type: 'abort', runId }` object is a control frame; anything else is treated as a `RunAgentInput` and validated diff --git a/docs/reference/functions/defineAgent.md b/docs/reference/functions/defineAgent.md index eda7ec595c..3578f09485 100644 --- a/docs/reference/functions/defineAgent.md +++ b/docs/reference/functions/defineAgent.md @@ -7,7 +7,7 @@ title: defineAgent function defineAgent(agent): DefinedAgent; ``` -Defined in: packages/ai/src/activities/chat/agents/define-agent.ts:171 +Defined in: [packages/ai/src/activities/chat/agents/define-agent.ts:180](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/define-agent.ts#L180) Define a named child agent. Pass the same object to `chat({ subagents })`. Pass the agents array to `useChat({ subagents })` when you render parts diff --git a/docs/reference/functions/defineChatMiddleware.md b/docs/reference/functions/defineChatMiddleware.md index 1ae68f3b16..0dde00d0fe 100644 --- a/docs/reference/functions/defineChatMiddleware.md +++ b/docs/reference/functions/defineChatMiddleware.md @@ -7,7 +7,7 @@ title: defineChatMiddleware function defineChatMiddleware(middleware): DefinedChatMiddleware; ``` -Defined in: packages/ai/src/activities/chat/middleware/define.ts:27 +Defined in: [packages/ai/src/activities/chat/middleware/define.ts:27](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/define.ts#L27) Identity helper for authoring middleware with precise capability inference. Returns the middleware unchanged at runtime; only sharpens its type so the diff --git a/docs/reference/functions/defineInterrupt.md b/docs/reference/functions/defineInterrupt.md index 1b000ec486..5d63ef4c0b 100644 --- a/docs/reference/functions/defineInterrupt.md +++ b/docs/reference/functions/defineInterrupt.md @@ -9,7 +9,7 @@ title: defineInterrupt function defineInterrupt(options): DefinedInterruptDefinition, InferSchemaInput>; ``` -Defined in: packages/ai/src/interrupt-definition.ts:418 +Defined in: [packages/ai/src/interrupt-definition.ts:418](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupt-definition.ts#L418) ### Type Parameters @@ -51,7 +51,7 @@ Defined in: packages/ai/src/interrupt-definition.ts:418 function defineInterrupt(options): DefinedInterruptDefinition, InferSchemaInput>; ``` -Defined in: packages/ai/src/interrupt-definition.ts:433 +Defined in: [packages/ai/src/interrupt-definition.ts:433](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupt-definition.ts#L433) ### Type Parameters @@ -89,7 +89,7 @@ Defined in: packages/ai/src/interrupt-definition.ts:433 function defineInterrupt(options): DefinedInterruptDefinition; ``` -Defined in: packages/ai/src/interrupt-definition.ts:447 +Defined in: [packages/ai/src/interrupt-definition.ts:447](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupt-definition.ts#L447) ### Type Parameters diff --git a/docs/reference/functions/defineRunStore.md b/docs/reference/functions/defineRunStore.md index f0f9cc44af..65a3e8aa1e 100644 --- a/docs/reference/functions/defineRunStore.md +++ b/docs/reference/functions/defineRunStore.md @@ -7,7 +7,7 @@ title: defineRunStore function defineRunStore(store): T; ``` -Defined in: packages/ai/src/activities/chat/middleware/run-store.ts:352 +Defined in: [packages/ai/src/activities/chat/middleware/run-store.ts:352](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/run-store.ts#L352) Type a [RunStore](../interfaces/RunStore.md) implementation inline: pass the object and get autocomplete plus contract checking with no separate annotation. Mirrors diff --git a/docs/reference/functions/deleteFile.md b/docs/reference/functions/deleteFile.md index 41d44affbd..9b6cd6dfeb 100644 --- a/docs/reference/functions/deleteFile.md +++ b/docs/reference/functions/deleteFile.md @@ -7,7 +7,7 @@ title: deleteFile function deleteFile(options): Promise; ``` -Defined in: packages/ai/src/activities/files/index.ts:72 +Defined in: [packages/ai/src/activities/files/index.ts:72](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/files/index.ts#L72) Delete a previously uploaded file. Accepts the handle itself (preferred — the provider-literal type rejects a foreign provider's handle at compile diff --git a/docs/reference/functions/detectImageMimeType.md b/docs/reference/functions/detectImageMimeType.md index 45b671ff4b..39cf5b6715 100644 --- a/docs/reference/functions/detectImageMimeType.md +++ b/docs/reference/functions/detectImageMimeType.md @@ -7,7 +7,7 @@ title: detectImageMimeType function detectImageMimeType(base64Data): "image/jpeg" | "image/png" | "image/gif" | "image/webp" | undefined; ``` -Defined in: packages/ai/src/utils.ts:17 +Defined in: [packages/ai/src/utils.ts:17](https://github.com/TanStack/ai/blob/main/packages/ai/src/utils.ts#L17) Detect image mime type from base64 data using magic bytes. Returns undefined if the format cannot be detected. diff --git a/docs/reference/functions/digestInterruptJson.md b/docs/reference/functions/digestInterruptJson.md index e6bb1d95fe..a460cdfdbc 100644 --- a/docs/reference/functions/digestInterruptJson.md +++ b/docs/reference/functions/digestInterruptJson.md @@ -7,7 +7,7 @@ title: digestInterruptJson function digestInterruptJson(canonicalJson, hash?): string; ``` -Defined in: packages/ai/src/interrupt-serialization.ts:161 +Defined in: [packages/ai/src/interrupt-serialization.ts:161](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupt-serialization.ts#L161) ## Parameters diff --git a/docs/reference/functions/embed.md b/docs/reference/functions/embed.md index bd1a46429f..6c53f3a4a5 100644 --- a/docs/reference/functions/embed.md +++ b/docs/reference/functions/embed.md @@ -7,7 +7,7 @@ title: embed function embed(options): Promise; ``` -Defined in: packages/ai/src/activities/embed/index.ts:190 +Defined in: [packages/ai/src/activities/embed/index.ts:190](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/embed/index.ts#L190) Embed activity - generates embedding vectors from text and image inputs. diff --git a/docs/reference/functions/encodeWsFrame.md b/docs/reference/functions/encodeWsFrame.md index ec7a492217..4825aec8ed 100644 --- a/docs/reference/functions/encodeWsFrame.md +++ b/docs/reference/functions/encodeWsFrame.md @@ -7,7 +7,7 @@ title: encodeWsFrame function encodeWsFrame(chunk, id): string; ``` -Defined in: packages/ai/src/stream-to-websocket.ts:35 +Defined in: [packages/ai/src/stream-to-websocket.ts:41](https://github.com/TanStack/ai/blob/main/packages/ai/src/stream-to-websocket.ts#L41) Encode one server→client frame. Durable frames carry the opaque offset in an `{ id, chunk }` envelope (identical to the NDJSON wire); non-durable frames diff --git a/docs/reference/functions/extendAdapter.md b/docs/reference/functions/extendAdapter.md index 7a2bccf361..e4756412eb 100644 --- a/docs/reference/functions/extendAdapter.md +++ b/docs/reference/functions/extendAdapter.md @@ -7,7 +7,7 @@ title: extendAdapter function extendAdapter(factory, _customModels): ExtendedFactory; ``` -Defined in: packages/ai/src/extend-adapter.ts:247 +Defined in: [packages/ai/src/extend-adapter.ts:247](https://github.com/TanStack/ai/blob/main/packages/ai/src/extend-adapter.ts#L247) Extends an existing adapter factory with additional custom models. diff --git a/docs/reference/functions/fileReferenceFor.md b/docs/reference/functions/fileReferenceFor.md index 790b9151e7..42ee2aa24e 100644 --- a/docs/reference/functions/fileReferenceFor.md +++ b/docs/reference/functions/fileReferenceFor.md @@ -7,7 +7,7 @@ title: fileReferenceFor function fileReferenceFor(source, providerName): string; ``` -Defined in: packages/ai/src/utilities/content-source.ts:27 +Defined in: [packages/ai/src/utilities/content-source.ts:27](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/content-source.ts#L27) Resolve the handle `providerName` should send for a file source. diff --git a/docs/reference/functions/fileSourceFromHandle.md b/docs/reference/functions/fileSourceFromHandle.md index 261cf78375..19d28c119c 100644 --- a/docs/reference/functions/fileSourceFromHandle.md +++ b/docs/reference/functions/fileSourceFromHandle.md @@ -7,7 +7,7 @@ title: fileSourceFromHandle function fileSourceFromHandle(handle): ContentPartFileSource; ``` -Defined in: packages/ai/src/activities/files/index.ts:104 +Defined in: [packages/ai/src/activities/files/index.ts:104](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/files/index.ts#L104) Build a `{ type: 'file' }` content source from an uploaded [FileHandle](../interfaces/FileHandle.md), for use in a chat message (image/audio/document part diff --git a/docs/reference/functions/firstSentence.md b/docs/reference/functions/firstSentence.md index c0a21dfa3e..f6eb66164b 100644 --- a/docs/reference/functions/firstSentence.md +++ b/docs/reference/functions/firstSentence.md @@ -7,7 +7,7 @@ title: firstSentence function firstSentence(text): string; ``` -Defined in: packages/ai/src/activities/chat/tools/lazy-tools.ts:8 +Defined in: [packages/ai/src/activities/chat/tools/lazy-tools.ts:8](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/lazy-tools.ts#L8) Extract the first sentence of a description (up to the first ., !, or ? followed by whitespace or end-of-string). Falls back to the whole trimmed diff --git a/docs/reference/functions/fromSpecTokenUsage.md b/docs/reference/functions/fromSpecTokenUsage.md index 3757bac3cc..2767dd8117 100644 --- a/docs/reference/functions/fromSpecTokenUsage.md +++ b/docs/reference/functions/fromSpecTokenUsage.md @@ -7,7 +7,7 @@ title: fromSpecTokenUsage function fromSpecTokenUsage(usage, leftover?): TokenUsage | undefined; ``` -Defined in: packages/ai/src/utilities/ag-ui-usage.ts:175 +Defined in: [packages/ai/src/utilities/ag-ui-usage.ts:175](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/ag-ui-usage.ts#L175) ## Parameters diff --git a/docs/reference/functions/generateAudio.md b/docs/reference/functions/generateAudio.md index 01f01baf62..362023acce 100644 --- a/docs/reference/functions/generateAudio.md +++ b/docs/reference/functions/generateAudio.md @@ -7,7 +7,7 @@ title: generateAudio function generateAudio(options): AudioActivityResult; ``` -Defined in: packages/ai/src/activities/generateAudio/index.ts:155 +Defined in: [packages/ai/src/activities/generateAudio/index.ts:155](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateAudio/index.ts#L155) Audio generation activity - generates audio from text prompts. diff --git a/docs/reference/functions/generateImage.md b/docs/reference/functions/generateImage.md index 3f4a566e87..d488c10319 100644 --- a/docs/reference/functions/generateImage.md +++ b/docs/reference/functions/generateImage.md @@ -7,7 +7,7 @@ title: generateImage function generateImage(options): ImageActivityResult; ``` -Defined in: packages/ai/src/activities/generateImage/index.ts:249 +Defined in: [packages/ai/src/activities/generateImage/index.ts:249](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateImage/index.ts#L249) Image activity - generates images from text prompts. diff --git a/docs/reference/functions/generateLiveVideo.md b/docs/reference/functions/generateLiveVideo.md index 4b5d5e6c80..fb61a1e6eb 100644 --- a/docs/reference/functions/generateLiveVideo.md +++ b/docs/reference/functions/generateLiveVideo.md @@ -7,7 +7,7 @@ title: generateLiveVideo function generateLiveVideo(options): LiveVideoActivityResult; ``` -Defined in: packages/ai/src/activities/generateLiveVideo/index.ts:155 +Defined in: [packages/ai/src/activities/generateLiveVideo/index.ts:155](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateLiveVideo/index.ts#L155) **`Experimental`** diff --git a/docs/reference/functions/generateMessageId.md b/docs/reference/functions/generateMessageId.md index 398c1215e8..3dc0380819 100644 --- a/docs/reference/functions/generateMessageId.md +++ b/docs/reference/functions/generateMessageId.md @@ -7,7 +7,7 @@ title: generateMessageId function generateMessageId(): string; ``` -Defined in: packages/ai/src/activities/chat/messages.ts:1560 +Defined in: [packages/ai/src/activities/chat/messages.ts:1560](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/messages.ts#L1560) Generate a unique message ID diff --git a/docs/reference/functions/generateSpeech.md b/docs/reference/functions/generateSpeech.md index cd6f8d0f5a..76c6ddb965 100644 --- a/docs/reference/functions/generateSpeech.md +++ b/docs/reference/functions/generateSpeech.md @@ -7,7 +7,7 @@ title: generateSpeech function generateSpeech(options): TTSActivityResult; ``` -Defined in: packages/ai/src/activities/generateSpeech/index.ts:257 +Defined in: [packages/ai/src/activities/generateSpeech/index.ts:257](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateSpeech/index.ts#L257) TTS activity - generates speech from text. diff --git a/docs/reference/functions/generateTranscription.md b/docs/reference/functions/generateTranscription.md index f477a48bcc..bc42b7e7da 100644 --- a/docs/reference/functions/generateTranscription.md +++ b/docs/reference/functions/generateTranscription.md @@ -7,7 +7,7 @@ title: generateTranscription function generateTranscription(options): TranscriptionActivityResult; ``` -Defined in: packages/ai/src/activities/generateTranscription/index.ts:192 +Defined in: [packages/ai/src/activities/generateTranscription/index.ts:192](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateTranscription/index.ts#L192) Transcription activity - converts audio to text. diff --git a/docs/reference/functions/generateVideo.md b/docs/reference/functions/generateVideo.md index 1d28ba82fe..7dfc2ccb75 100644 --- a/docs/reference/functions/generateVideo.md +++ b/docs/reference/functions/generateVideo.md @@ -7,7 +7,7 @@ title: generateVideo function generateVideo(options): TStream extends true ? AsyncIterable : Promise; ``` -Defined in: packages/ai/src/activities/generateVideo/index.ts:413 +Defined in: [packages/ai/src/activities/generateVideo/index.ts:413](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateVideo/index.ts#L413) Generate video - creates a video generation job from a text prompt. diff --git a/docs/reference/functions/generateVoice.md b/docs/reference/functions/generateVoice.md index 0853fbc1a5..c4530c5d17 100644 --- a/docs/reference/functions/generateVoice.md +++ b/docs/reference/functions/generateVoice.md @@ -7,7 +7,7 @@ title: generateVoice function generateVoice(options): VoiceActivityResult; ``` -Defined in: packages/ai/src/activities/generateVoice/index.ts:188 +Defined in: [packages/ai/src/activities/generateVoice/index.ts:188](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateVoice/index.ts#L188) Voice activity - creates a reusable voice. diff --git a/docs/reference/functions/generateWorld.md b/docs/reference/functions/generateWorld.md index d7dfcc78b9..f2e1ed64b6 100644 --- a/docs/reference/functions/generateWorld.md +++ b/docs/reference/functions/generateWorld.md @@ -7,7 +7,7 @@ title: generateWorld function generateWorld(options): WorldActivityResult; ``` -Defined in: packages/ai/src/activities/generateWorld/index.ts:157 +Defined in: [packages/ai/src/activities/generateWorld/index.ts:157](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateWorld/index.ts#L157) **`Experimental`** diff --git a/docs/reference/functions/generationParamsFromBody.md b/docs/reference/functions/generationParamsFromBody.md index f5c962adb1..1fb4fcbab7 100644 --- a/docs/reference/functions/generationParamsFromBody.md +++ b/docs/reference/functions/generationParamsFromBody.md @@ -7,7 +7,10 @@ title: generationParamsFromBody function generationParamsFromBody(kind, body): GenerationParams; ``` -Defined in: packages/ai/src/client.ts:158 +Defined in: [packages/ai/src/client.ts:118](https://github.com/TanStack/ai/blob/main/packages/ai/src/client.ts#L118) + +Read a generation request: the AG-UI `RunAgentInput` body that the +generation hooks send. The input is in `forwardedProps`. ## Type Parameters @@ -28,3 +31,8 @@ Defined in: packages/ai/src/client.ts:158 ## Returns `GenerationParams`\<`TKind`\> + +## Throws + +When the body has no `threadId` or `runId`, or its input does not fit + the kind. diff --git a/docs/reference/functions/generationParamsFromRequest.md b/docs/reference/functions/generationParamsFromRequest.md index 0bb8bf3b2c..1a31b1cced 100644 --- a/docs/reference/functions/generationParamsFromRequest.md +++ b/docs/reference/functions/generationParamsFromRequest.md @@ -7,7 +7,7 @@ title: generationParamsFromRequest function generationParamsFromRequest(kind, request): Promise>; ``` -Defined in: packages/ai/src/client.ts:193 +Defined in: [packages/ai/src/client.ts:146](https://github.com/TanStack/ai/blob/main/packages/ai/src/client.ts#L146) ## Type Parameters diff --git a/docs/reference/functions/genericInterruptContinuationFromDescriptor.md b/docs/reference/functions/genericInterruptContinuationFromDescriptor.md index f8db2accd5..5ee064172c 100644 --- a/docs/reference/functions/genericInterruptContinuationFromDescriptor.md +++ b/docs/reference/functions/genericInterruptContinuationFromDescriptor.md @@ -9,7 +9,7 @@ function genericInterruptContinuationFromDescriptor(interrupt): | undefined; ``` -Defined in: packages/ai/src/generic-interrupt-continuation.ts:123 +Defined in: [packages/ai/src/generic-interrupt-continuation.ts:123](https://github.com/TanStack/ai/blob/main/packages/ai/src/generic-interrupt-continuation.ts#L123) Build the resume-metadata continuation from an outbound AG-UI interrupt. diff --git a/docs/reference/functions/getChunkRunId.md b/docs/reference/functions/getChunkRunId.md index 3ed23123aa..4fd3fc8156 100644 --- a/docs/reference/functions/getChunkRunId.md +++ b/docs/reference/functions/getChunkRunId.md @@ -7,7 +7,7 @@ title: getChunkRunId function getChunkRunId(chunk): string | undefined; ``` -Defined in: packages/ai/src/utilities/chunk-ids.ts:9 +Defined in: [packages/ai/src/utilities/chunk-ids.ts:9](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/chunk-ids.ts#L9) Run id on the spec event, or `metadata.tanstack.runId` after normalize. diff --git a/docs/reference/functions/getChunkThreadId.md b/docs/reference/functions/getChunkThreadId.md index d9c6f7eb03..ef52491c88 100644 --- a/docs/reference/functions/getChunkThreadId.md +++ b/docs/reference/functions/getChunkThreadId.md @@ -7,7 +7,7 @@ title: getChunkThreadId function getChunkThreadId(chunk): string | undefined; ``` -Defined in: packages/ai/src/utilities/chunk-ids.ts:18 +Defined in: [packages/ai/src/utilities/chunk-ids.ts:18](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/chunk-ids.ts#L18) Thread id on the spec event, or `metadata.tanstack.threadId` after normalize. diff --git a/docs/reference/functions/getFile.md b/docs/reference/functions/getFile.md index a4c6af2887..15efbe8462 100644 --- a/docs/reference/functions/getFile.md +++ b/docs/reference/functions/getFile.md @@ -7,7 +7,7 @@ title: getFile function getFile(options): Promise>; ``` -Defined in: packages/ai/src/activities/files/index.ts:49 +Defined in: [packages/ai/src/activities/files/index.ts:49](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/files/index.ts#L49) Fetch metadata for a previously uploaded file. Accepts the handle itself (preferred — the provider-literal type rejects a foreign provider's handle diff --git a/docs/reference/functions/getProviderExecutedMetadata.md b/docs/reference/functions/getProviderExecutedMetadata.md index bc8bfbb9ed..63de7984f5 100644 --- a/docs/reference/functions/getProviderExecutedMetadata.md +++ b/docs/reference/functions/getProviderExecutedMetadata.md @@ -9,7 +9,7 @@ function getProviderExecutedMetadata(toolCall): | null; ``` -Defined in: packages/ai/src/utilities/provider-executed.ts:9 +Defined in: [packages/ai/src/utilities/provider-executed.ts:9](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/provider-executed.ts#L9) Narrow a tool call's opaque `metadata` to the provider-executed convention. Returns the typed metadata when the call is provider-executed, else `null`. diff --git a/docs/reference/functions/getVideoJobStatus.md b/docs/reference/functions/getVideoJobStatus.md index 820c7d68d2..d13a3fff44 100644 --- a/docs/reference/functions/getVideoJobStatus.md +++ b/docs/reference/functions/getVideoJobStatus.md @@ -7,7 +7,7 @@ title: getVideoJobStatus function getVideoJobStatus(options): Promise; ``` -Defined in: packages/ai/src/activities/generateVideo/index.ts:919 +Defined in: [packages/ai/src/activities/generateVideo/index.ts:919](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateVideo/index.ts#L919) Get video job status - returns the current status, progress, and URL if available. diff --git a/docs/reference/functions/hashSchemaInput.md b/docs/reference/functions/hashSchemaInput.md index 98a9984f67..bac7b404a8 100644 --- a/docs/reference/functions/hashSchemaInput.md +++ b/docs/reference/functions/hashSchemaInput.md @@ -7,7 +7,7 @@ title: hashSchemaInput function hashSchemaInput(schema): string; ``` -Defined in: packages/ai/src/activities/chat/tools/approval-schema.ts:198 +Defined in: [packages/ai/src/activities/chat/tools/approval-schema.ts:198](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/approval-schema.ts#L198) ## Parameters diff --git a/docs/reference/functions/interleaveActivityRecords.md b/docs/reference/functions/interleaveActivityRecords.md index 0655afa560..5691c4416f 100644 --- a/docs/reference/functions/interleaveActivityRecords.md +++ b/docs/reference/functions/interleaveActivityRecords.md @@ -7,7 +7,7 @@ title: interleaveActivityRecords function interleaveActivityRecords(modelUI, records): UIMessage[]; ``` -Defined in: packages/ai/src/activities/chat/activity-records.ts:46 +Defined in: [packages/ai/src/activities/chat/activity-records.ts:46](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/activity-records.ts#L46) Insert activity rows into a model-derived UI transcript at each record's stored `index`. Earlier records are inserted first so later indexes stay diff --git a/docs/reference/functions/interruptItemError.md b/docs/reference/functions/interruptItemError.md index f88e570858..7b9dc34911 100644 --- a/docs/reference/functions/interruptItemError.md +++ b/docs/reference/functions/interruptItemError.md @@ -12,7 +12,7 @@ function interruptItemError( options?): InterruptSubmissionError; ``` -Defined in: packages/ai/src/interrupt-resume.ts:140 +Defined in: [packages/ai/src/interrupt-resume.ts:140](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupt-resume.ts#L140) ## Parameters diff --git a/docs/reference/functions/isCancelRequestedReason.md b/docs/reference/functions/isCancelRequestedReason.md index edadfe8e45..61865e7b3f 100644 --- a/docs/reference/functions/isCancelRequestedReason.md +++ b/docs/reference/functions/isCancelRequestedReason.md @@ -7,7 +7,7 @@ title: isCancelRequestedReason function isCancelRequestedReason(reason): boolean; ``` -Defined in: packages/ai/src/activities/chat/cancel.ts:33 +Defined in: [packages/ai/src/activities/chat/cancel.ts:33](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/cancel.ts#L33) Whether an abort reason means "the user explicitly cancelled this run". diff --git a/docs/reference/functions/isContentPart.md b/docs/reference/functions/isContentPart.md index 17ffbba4d0..0a6b0a8eb1 100644 --- a/docs/reference/functions/isContentPart.md +++ b/docs/reference/functions/isContentPart.md @@ -7,7 +7,7 @@ title: isContentPart function isContentPart(value): value is ContentPart; ``` -Defined in: packages/ai/src/utilities/tool-result.ts:23 +Defined in: [packages/ai/src/utilities/tool-result.ts:23](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/tool-result.ts#L23) Structural check for a single `ContentPart`. A text part must carry a string `content`. Every other part carries a source with a string `value`; a file diff --git a/docs/reference/functions/isContentPartArray.md b/docs/reference/functions/isContentPartArray.md index 0d97016b99..6e46c08de0 100644 --- a/docs/reference/functions/isContentPartArray.md +++ b/docs/reference/functions/isContentPartArray.md @@ -7,7 +7,7 @@ title: isContentPartArray function isContentPartArray(value): value is ContentPart[]; ``` -Defined in: packages/ai/src/utilities/tool-result.ts:57 +Defined in: [packages/ai/src/utilities/tool-result.ts:57](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/tool-result.ts#L57) True iff `value` is a NON-EMPTY array whose every element is a valid `ContentPart`. Empty arrays and mixed arrays return false so they continue diff --git a/docs/reference/functions/isCustomEvent.md b/docs/reference/functions/isCustomEvent.md index 2800124b67..d2ce6169ff 100644 --- a/docs/reference/functions/isCustomEvent.md +++ b/docs/reference/functions/isCustomEvent.md @@ -7,7 +7,7 @@ title: isCustomEvent function isCustomEvent(chunk, name): chunk is WellKnownCustomEvent; ``` -Defined in: packages/ai/src/custom-events.ts:102 +Defined in: [packages/ai/src/custom-events.ts:102](https://github.com/TanStack/ai/blob/main/packages/ai/src/custom-events.ts#L102) Type guard: is `chunk` a CUSTOM event with the given well-known `name`? Narrows the payload type when true, so consumers read `chunk.value` typed. diff --git a/docs/reference/functions/isEvaluateError.md b/docs/reference/functions/isEvaluateError.md new file mode 100644 index 0000000000..ff86f97e4a --- /dev/null +++ b/docs/reference/functions/isEvaluateError.md @@ -0,0 +1,37 @@ +--- +id: isEvaluateError +title: isEvaluateError +--- + +```ts +function isEvaluateError(value): value is EvaluateError; +``` + +Defined in: [packages/ai/src/activities/evaluate/adapter.ts:210](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/evaluate/adapter.ts#L210) + +This function returns true when `value` has the evaluate error shape. + +The check reads `name` and `code`. +A plain object with those fields passes. +The check does not use `instanceof`, so it also matches an error from +another copy of `@tanstack/ai`. + +## Parameters + +### value + +`unknown` + +A thrown value, or a plain object + +## Returns + +`value is EvaluateError` + +## Example + +```ts +if (isEvaluateError(error) && error.code === EVALUATE_REFUSAL_CODE) { + error.usage +} +``` diff --git a/docs/reference/functions/isFileSource.md b/docs/reference/functions/isFileSource.md index e015c02c73..b93e4e7bf4 100644 --- a/docs/reference/functions/isFileSource.md +++ b/docs/reference/functions/isFileSource.md @@ -7,7 +7,7 @@ title: isFileSource function isFileSource(source): source is ContentPartFileSource; ``` -Defined in: packages/ai/src/utilities/content-source.ts:11 +Defined in: [packages/ai/src/utilities/content-source.ts:11](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/content-source.ts#L11) Narrow a [ContentPartSource](../type-aliases/ContentPartSource.md) to the provider-file-reference arm. diff --git a/docs/reference/functions/isKeyedAdapter.md b/docs/reference/functions/isKeyedAdapter.md index 6941a75be6..4cf0989152 100644 --- a/docs/reference/functions/isKeyedAdapter.md +++ b/docs/reference/functions/isKeyedAdapter.md @@ -7,7 +7,7 @@ title: isKeyedAdapter function isKeyedAdapter(value): value is KeyedAdapter; ``` -Defined in: packages/ai/src/byok/keyed.ts:83 +Defined in: [packages/ai/src/byok/keyed.ts:83](https://github.com/TanStack/ai/blob/main/packages/ai/src/byok/keyed.ts#L83) True when `value` came from [keyedAdapter](keyedAdapter.md). A host uses it to decide if an adapter needs a key first. diff --git a/docs/reference/functions/isProviderExecutedToolCall.md b/docs/reference/functions/isProviderExecutedToolCall.md index 1d7210b918..ad4638db68 100644 --- a/docs/reference/functions/isProviderExecutedToolCall.md +++ b/docs/reference/functions/isProviderExecutedToolCall.md @@ -7,7 +7,7 @@ title: isProviderExecutedToolCall function isProviderExecutedToolCall(toolCall): boolean; ``` -Defined in: packages/ai/src/utilities/provider-executed.ts:28 +Defined in: [packages/ai/src/utilities/provider-executed.ts:28](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/provider-executed.ts#L28) True when a tool call was executed by the provider (e.g. Anthropic `web_search` / `web_fetch` server tools) rather than the agent loop. Such diff --git a/docs/reference/functions/isRunStatus.md b/docs/reference/functions/isRunStatus.md index ea256eab00..3e56d3243f 100644 --- a/docs/reference/functions/isRunStatus.md +++ b/docs/reference/functions/isRunStatus.md @@ -7,7 +7,7 @@ title: isRunStatus function isRunStatus(value): value is RunStatus; ``` -Defined in: packages/ai/src/activities/chat/middleware/run-store.ts:69 +Defined in: [packages/ai/src/activities/chat/middleware/run-store.ts:69](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/run-store.ts#L69) Whether `value` is a [RunStatus](../type-aliases/RunStatus.md) — the guard a backend validates a row with at DESERIALIZATION. diff --git a/docs/reference/functions/isStandardSchema.md b/docs/reference/functions/isStandardSchema.md index cfd9a2bfda..7699de0707 100644 --- a/docs/reference/functions/isStandardSchema.md +++ b/docs/reference/functions/isStandardSchema.md @@ -7,7 +7,7 @@ title: isStandardSchema function isStandardSchema(schema): schema is StandardSchemaV1; ``` -Defined in: packages/ai/src/activities/chat/tools/schema-converter.ts:73 +Defined in: [packages/ai/src/activities/chat/tools/schema-converter.ts:73](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/schema-converter.ts#L73) Check if a value is a Standard Schema compliant schema (for validation). Standard Schema compliant libraries implement the '~standard' property with a validate function. diff --git a/docs/reference/functions/isTerminalRunStatus.md b/docs/reference/functions/isTerminalRunStatus.md index 51cfda46ca..d61328ed53 100644 --- a/docs/reference/functions/isTerminalRunStatus.md +++ b/docs/reference/functions/isTerminalRunStatus.md @@ -7,7 +7,7 @@ title: isTerminalRunStatus function isTerminalRunStatus(status): status is TerminalRunStatus; ``` -Defined in: packages/ai/src/activities/chat/middleware/run-store.ts:86 +Defined in: [packages/ai/src/activities/chat/middleware/run-store.ts:86](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/run-store.ts#L86) Whether `status` means no further events will be appended. Narrows, so a caller inside the guard can pass `status` where a [TerminalRunStatus](../type-aliases/TerminalRunStatus.md) diff --git a/docs/reference/functions/isToolResultOutcome.md b/docs/reference/functions/isToolResultOutcome.md index 67998d9fb1..050cc0245d 100644 --- a/docs/reference/functions/isToolResultOutcome.md +++ b/docs/reference/functions/isToolResultOutcome.md @@ -7,7 +7,7 @@ title: isToolResultOutcome function isToolResultOutcome(value): value is ToolResultOutcome; ``` -Defined in: packages/ai/src/utilities/tool-result.ts:11 +Defined in: [packages/ai/src/utilities/tool-result.ts:11](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/tool-result.ts#L11) ## Parameters diff --git a/docs/reference/functions/keyedAdapter.md b/docs/reference/functions/keyedAdapter.md index b67c620c02..c26123c6c9 100644 --- a/docs/reference/functions/keyedAdapter.md +++ b/docs/reference/functions/keyedAdapter.md @@ -7,7 +7,7 @@ title: keyedAdapter function keyedAdapter(provider, create): KeyedAdapter; ``` -Defined in: packages/ai/src/byok/keyed.ts:63 +Defined in: [packages/ai/src/byok/keyed.ts:63](https://github.com/TanStack/ai/blob/main/packages/ai/src/byok/keyed.ts#L63) Wrap an adapter factory that needs a provider key. The host finds the key and calls `create` just before each call, so the key is not in your code diff --git a/docs/reference/functions/keyedAdapters.md b/docs/reference/functions/keyedAdapters.md index 6e6d6331dc..f75e804da3 100644 --- a/docs/reference/functions/keyedAdapters.md +++ b/docs/reference/functions/keyedAdapters.md @@ -7,7 +7,7 @@ title: keyedAdapters function keyedAdapters(map): { [K in string | number | symbol]: TMap[K] extends KeyedAdapter ? KeyedAdapter : TMap[K] extends (key: string) => A ? KeyedAdapter : never }; ``` -Defined in: packages/ai/src/byok/keyed.ts:113 +Defined in: [packages/ai/src/byok/keyed.ts:113](https://github.com/TanStack/ai/blob/main/packages/ai/src/byok/keyed.ts#L113) Keyed adapters for several providers in one map. The map key is the provider id, so a key goes only to the factory of its own provider. An diff --git a/docs/reference/functions/listVoices.md b/docs/reference/functions/listVoices.md index 026ee7d1ca..c70071aa06 100644 --- a/docs/reference/functions/listVoices.md +++ b/docs/reference/functions/listVoices.md @@ -7,7 +7,7 @@ title: listVoices function listVoices(options): Promise; ``` -Defined in: packages/ai/src/activities/generateSpeech/index.ts:453 +Defined in: [packages/ai/src/activities/generateSpeech/index.ts:453](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateSpeech/index.ts#L453) List the voices an account can pass to `generateSpeech()`. diff --git a/docs/reference/functions/maxIterations.md b/docs/reference/functions/maxIterations.md index 26d24cdcc6..9c5f2ec8d4 100644 --- a/docs/reference/functions/maxIterations.md +++ b/docs/reference/functions/maxIterations.md @@ -7,7 +7,7 @@ title: maxIterations function maxIterations(max): AgentLoopStrategy; ``` -Defined in: packages/ai/src/activities/chat/agent-loop-strategies.ts:26 +Defined in: [packages/ai/src/activities/chat/agent-loop-strategies.ts:26](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agent-loop-strategies.ts#L26) Creates a strategy that continues for a maximum number of **model turns** (iterations), not tool calls. diff --git a/docs/reference/functions/memoryStream.md b/docs/reference/functions/memoryStream.md index f4df2c7144..6b5b6b1573 100644 --- a/docs/reference/functions/memoryStream.md +++ b/docs/reference/functions/memoryStream.md @@ -7,7 +7,7 @@ title: memoryStream function memoryStream(source, options?): UpsertableStreamDurability; ``` -Defined in: packages/ai/src/stream-durability.ts:331 +Defined in: [packages/ai/src/stream-durability.ts:331](https://github.com/TanStack/ai/blob/main/packages/ai/src/stream-durability.ts#L331) The zero-infrastructure delivery-durability backend. Its versioned cursor is deliberately private: callers and core only pass the returned string back. diff --git a/docs/reference/functions/mergeAgentTools.md b/docs/reference/functions/mergeAgentTools.md index 98d629cbb4..a6bef55a43 100644 --- a/docs/reference/functions/mergeAgentTools.md +++ b/docs/reference/functions/mergeAgentTools.md @@ -9,7 +9,7 @@ title: mergeAgentTools function mergeAgentTools(serverTools, clientTools): TServerTools; ``` -Defined in: packages/ai/src/utilities/chat-params.ts:349 +Defined in: [packages/ai/src/utilities/chat-params.ts:349](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/chat-params.ts#L349) Merge a server-side tool array with the AG-UI client-declared tools received in the request body. @@ -65,7 +65,7 @@ A merged array suitable for `chat({ tools })`. function mergeAgentTools(serverTools, clientTools): MergedAgentTools; ``` -Defined in: packages/ai/src/utilities/chat-params.ts:352 +Defined in: [packages/ai/src/utilities/chat-params.ts:352](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/chat-params.ts#L352) Merge a server-side tool array with the AG-UI client-declared tools received in the request body. diff --git a/docs/reference/functions/mergeMetadata.md b/docs/reference/functions/mergeMetadata.md index 383f9ec1d9..8285f914d8 100644 --- a/docs/reference/functions/mergeMetadata.md +++ b/docs/reference/functions/mergeMetadata.md @@ -7,7 +7,7 @@ title: mergeMetadata function mergeMetadata(current, incoming): MetadataRecord | undefined; ``` -Defined in: packages/ai/src/utilities/merge-metadata.ts:12 +Defined in: [packages/ai/src/utilities/merge-metadata.ts:12](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/merge-metadata.ts#L12) ## Parameters diff --git a/docs/reference/functions/modelMessageToUIMessage.md b/docs/reference/functions/modelMessageToUIMessage.md index 3cc6cc150b..d48f0bdc4f 100644 --- a/docs/reference/functions/modelMessageToUIMessage.md +++ b/docs/reference/functions/modelMessageToUIMessage.md @@ -7,7 +7,7 @@ title: modelMessageToUIMessage function modelMessageToUIMessage(modelMessage, id?): UIMessage; ``` -Defined in: packages/ai/src/activities/chat/messages.ts:1074 +Defined in: [packages/ai/src/activities/chat/messages.ts:1074](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/messages.ts#L1074) Convert a ModelMessage to UIMessage diff --git a/docs/reference/functions/modelMessagesToUIMessages.md b/docs/reference/functions/modelMessagesToUIMessages.md index cfbb767244..4dcd04c3f3 100644 --- a/docs/reference/functions/modelMessagesToUIMessages.md +++ b/docs/reference/functions/modelMessagesToUIMessages.md @@ -7,7 +7,7 @@ title: modelMessagesToUIMessages function modelMessagesToUIMessages(modelMessages): UIMessage[]; ``` -Defined in: packages/ai/src/activities/chat/messages.ts:1444 +Defined in: [packages/ai/src/activities/chat/messages.ts:1444](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/messages.ts#L1444) Convert an array of ModelMessages to UIMessages diff --git a/docs/reference/functions/normalizeApprovalSchema.md b/docs/reference/functions/normalizeApprovalSchema.md index 510f01b4eb..57307c5594 100644 --- a/docs/reference/functions/normalizeApprovalSchema.md +++ b/docs/reference/functions/normalizeApprovalSchema.md @@ -7,7 +7,7 @@ title: normalizeApprovalSchema function normalizeApprovalSchema(approvalSchema, inputSchema?): NormalizedApprovalSchema; ``` -Defined in: packages/ai/src/activities/chat/tools/approval-schema.ts:141 +Defined in: [packages/ai/src/activities/chat/tools/approval-schema.ts:141](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/approval-schema.ts#L141) ## Parameters diff --git a/docs/reference/functions/normalizeStreamChunk.md b/docs/reference/functions/normalizeStreamChunk.md index bd99d8b8d4..fa3734a45a 100644 --- a/docs/reference/functions/normalizeStreamChunk.md +++ b/docs/reference/functions/normalizeStreamChunk.md @@ -7,7 +7,7 @@ title: normalizeStreamChunk function normalizeStreamChunk(chunk): AGUIEvent[]; ``` -Defined in: packages/ai/src/utilities/normalize-stream-chunk.ts:50 +Defined in: [packages/ai/src/utilities/normalize-stream-chunk.ts:50](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/normalize-stream-chunk.ts#L50) ## Parameters diff --git a/docs/reference/functions/normalizeSystemPrompts.md b/docs/reference/functions/normalizeSystemPrompts.md index 32dc24dd01..5714d95eb9 100644 --- a/docs/reference/functions/normalizeSystemPrompts.md +++ b/docs/reference/functions/normalizeSystemPrompts.md @@ -7,7 +7,7 @@ title: normalizeSystemPrompts function normalizeSystemPrompts(prompts): NormalizedSystemPrompt[]; ``` -Defined in: packages/ai/src/system-prompts.ts:70 +Defined in: [packages/ai/src/system-prompts.ts:70](https://github.com/TanStack/ai/blob/main/packages/ai/src/system-prompts.ts#L70) Normalise the public `systemPrompts` shape (`Array`) to a homogenous `Array<{ content, metadata? }>`. Adapters use this so they diff --git a/docs/reference/functions/normalizeToUIMessage.md b/docs/reference/functions/normalizeToUIMessage.md index df674297e7..70072a0a94 100644 --- a/docs/reference/functions/normalizeToUIMessage.md +++ b/docs/reference/functions/normalizeToUIMessage.md @@ -7,7 +7,7 @@ title: normalizeToUIMessage function normalizeToUIMessage(message, generateId): UIMessage; ``` -Defined in: packages/ai/src/activities/chat/messages.ts:1535 +Defined in: [packages/ai/src/activities/chat/messages.ts:1535](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/messages.ts#L1535) Normalize a message (UIMessage or ModelMessage) to a UIMessage Ensures the message has an ID and createdAt timestamp diff --git a/docs/reference/functions/normalizeToolResult.md b/docs/reference/functions/normalizeToolResult.md index 7463e84640..6eb8083cce 100644 --- a/docs/reference/functions/normalizeToolResult.md +++ b/docs/reference/functions/normalizeToolResult.md @@ -7,7 +7,7 @@ title: normalizeToolResult function normalizeToolResult(result): string | ContentPart[]; ``` -Defined in: packages/ai/src/utilities/tool-result.ts:96 +Defined in: [packages/ai/src/utilities/tool-result.ts:96](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/tool-result.ts#L96) Normalize a tool's return value for transport: - string → unchanged diff --git a/docs/reference/functions/orderedAssistantBlocks.md b/docs/reference/functions/orderedAssistantBlocks.md index 870e04b26f..38c87ed116 100644 --- a/docs/reference/functions/orderedAssistantBlocks.md +++ b/docs/reference/functions/orderedAssistantBlocks.md @@ -9,7 +9,7 @@ function orderedAssistantBlocks(message): | undefined; ``` -Defined in: packages/ai/src/utilities/block-order.ts:58 +Defined in: [packages/ai/src/utilities/block-order.ts:58](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/block-order.ts#L58) The blocks of an assistant message in map order, or undefined when the message has no map or the map does not match the message. A map matches diff --git a/docs/reference/functions/parsePartialJSON.md b/docs/reference/functions/parsePartialJSON.md index 8aeedfa5ae..6730a6d884 100644 --- a/docs/reference/functions/parsePartialJSON.md +++ b/docs/reference/functions/parsePartialJSON.md @@ -7,7 +7,7 @@ title: parsePartialJSON function parsePartialJSON(jsonString): any; ``` -Defined in: packages/ai/src/activities/chat/stream/json-parser.ts:56 +Defined in: [packages/ai/src/activities/chat/stream/json-parser.ts:56](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/json-parser.ts#L56) Parse partial JSON string (convenience function) diff --git a/docs/reference/functions/parseWithStandardSchema.md b/docs/reference/functions/parseWithStandardSchema.md index 6e966c4f15..ff32cb6646 100644 --- a/docs/reference/functions/parseWithStandardSchema.md +++ b/docs/reference/functions/parseWithStandardSchema.md @@ -7,7 +7,7 @@ title: parseWithStandardSchema function parseWithStandardSchema(schema, data): T; ``` -Defined in: packages/ai/src/activities/chat/tools/schema-converter.ts:468 +Defined in: [packages/ai/src/activities/chat/tools/schema-converter.ts:468](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/schema-converter.ts#L468) Synchronously validates data against a Standard Schema compliant schema. Note: Some Standard Schema implementations may only support async validation. diff --git a/docs/reference/functions/readGenericInterruptContinuation.md b/docs/reference/functions/readGenericInterruptContinuation.md index c240e34802..66562f111c 100644 --- a/docs/reference/functions/readGenericInterruptContinuation.md +++ b/docs/reference/functions/readGenericInterruptContinuation.md @@ -7,7 +7,7 @@ title: readGenericInterruptContinuation function readGenericInterruptContinuation(metadata): GenericInterruptContinuationReadResult; ``` -Defined in: packages/ai/src/generic-interrupt-continuation.ts:50 +Defined in: [packages/ai/src/generic-interrupt-continuation.ts:50](https://github.com/TanStack/ai/blob/main/packages/ai/src/generic-interrupt-continuation.ts#L50) Read one generic request from `resume[].metadata`. diff --git a/docs/reference/functions/readInterruptBinding.md b/docs/reference/functions/readInterruptBinding.md index 0f161a6c56..f967914d13 100644 --- a/docs/reference/functions/readInterruptBinding.md +++ b/docs/reference/functions/readInterruptBinding.md @@ -7,7 +7,7 @@ title: readInterruptBinding function readInterruptBinding(descriptor): InterruptBinding | undefined; ``` -Defined in: packages/ai/src/interrupt-resume.ts:978 +Defined in: [packages/ai/src/interrupt-resume.ts:969](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupt-resume.ts#L969) Read the opened resume binding off a descriptor, or `undefined` when the descriptor carries no binding of a version we understand. diff --git a/docs/reference/functions/readUnopenedInterruptBinding.md b/docs/reference/functions/readUnopenedInterruptBinding.md index c8e071fcd2..16aba10748 100644 --- a/docs/reference/functions/readUnopenedInterruptBinding.md +++ b/docs/reference/functions/readUnopenedInterruptBinding.md @@ -11,7 +11,7 @@ function readUnopenedInterruptBinding(descriptor): | undefined; ``` -Defined in: packages/ai/src/interrupt-resume.ts:856 +Defined in: [packages/ai/src/interrupt-resume.ts:847](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupt-resume.ts#L847) ## Parameters diff --git a/docs/reference/functions/realtimeToken.md b/docs/reference/functions/realtimeToken.md index 7668ac7199..89790d02cb 100644 --- a/docs/reference/functions/realtimeToken.md +++ b/docs/reference/functions/realtimeToken.md @@ -7,7 +7,7 @@ title: realtimeToken function realtimeToken(options): Promise; ``` -Defined in: packages/ai/src/realtime/index.ts:29 +Defined in: [packages/ai/src/realtime/index.ts:29](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/index.ts#L29) Generate a realtime token using the provided adapter. diff --git a/docs/reference/functions/renderLazyCatalogEntry.md b/docs/reference/functions/renderLazyCatalogEntry.md index e4a440926a..7771d55f9f 100644 --- a/docs/reference/functions/renderLazyCatalogEntry.md +++ b/docs/reference/functions/renderLazyCatalogEntry.md @@ -10,7 +10,7 @@ function renderLazyCatalogEntry( includeDescription?): string; ``` -Defined in: packages/ai/src/activities/chat/tools/lazy-tools.ts:22 +Defined in: [packages/ai/src/activities/chat/tools/lazy-tools.ts:22](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/lazy-tools.ts#L22) Render one entry in a lazy-tool catalog according to `includeDescription`. - 'none' (default) → bare name (preserves legacy chat behavior) diff --git a/docs/reference/functions/replayRunStream.md b/docs/reference/functions/replayRunStream.md index 87733fd8eb..959849cb13 100644 --- a/docs/reference/functions/replayRunStream.md +++ b/docs/reference/functions/replayRunStream.md @@ -10,7 +10,7 @@ function replayRunStream( signal?): AsyncGenerator; ``` -Defined in: packages/ai/src/stream-durability.ts:588 +Defined in: [packages/ai/src/stream-durability.ts:588](https://github.com/TanStack/ai/blob/main/packages/ai/src/stream-durability.ts#L588) Replay a run's delivery-durability log as a bare stream of chunks, for callers that serve a `joinRun` handler without an HTTP `Response` — e.g. a diff --git a/docs/reference/functions/requestRunCancel.md b/docs/reference/functions/requestRunCancel.md index ad97aa913d..f5422b75d9 100644 --- a/docs/reference/functions/requestRunCancel.md +++ b/docs/reference/functions/requestRunCancel.md @@ -7,7 +7,7 @@ title: requestRunCancel function requestRunCancel(runs, runId): Promise; ``` -Defined in: packages/ai/src/activities/chat/cancel.ts:48 +Defined in: [packages/ai/src/activities/chat/cancel.ts:48](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/cancel.ts#L48) Record an explicit cancel on the run record. diff --git a/docs/reference/functions/requireTextOnlyEmbeddingInput.md b/docs/reference/functions/requireTextOnlyEmbeddingInput.md index 3578ffc4ed..8ad225401f 100644 --- a/docs/reference/functions/requireTextOnlyEmbeddingInput.md +++ b/docs/reference/functions/requireTextOnlyEmbeddingInput.md @@ -10,7 +10,7 @@ function requireTextOnlyEmbeddingInput( model): string[]; ``` -Defined in: packages/ai/src/utilities/embedding-input.ts:53 +Defined in: [packages/ai/src/utilities/embedding-input.ts:53](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/embedding-input.ts#L53) Extract plain text inputs for a text-only embedding model, throwing a uniform error if any item carries an image. The per-model modality typing diff --git a/docs/reference/functions/rerank.md b/docs/reference/functions/rerank.md index 5105dc5153..e0e03e54a2 100644 --- a/docs/reference/functions/rerank.md +++ b/docs/reference/functions/rerank.md @@ -7,7 +7,7 @@ title: rerank function rerank(options): Promise>; ``` -Defined in: packages/ai/src/activities/rerank/index.ts:152 +Defined in: [packages/ai/src/activities/rerank/index.ts:152](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/rerank/index.ts#L152) Rerank activity - reorders documents by relevance to a query. diff --git a/docs/reference/functions/resolveEmbeddingInput.md b/docs/reference/functions/resolveEmbeddingInput.md index 0de9a5f251..253487be39 100644 --- a/docs/reference/functions/resolveEmbeddingInput.md +++ b/docs/reference/functions/resolveEmbeddingInput.md @@ -7,7 +7,7 @@ title: resolveEmbeddingInput function resolveEmbeddingInput(input): ResolvedEmbeddingItem[]; ``` -Defined in: packages/ai/src/utilities/embedding-input.ts:42 +Defined in: [packages/ai/src/utilities/embedding-input.ts:42](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/embedding-input.ts#L42) Resolve each embedding input item into its text and image constituents, preserving input order (result[i] corresponds to input[i] and to the diff --git a/docs/reference/functions/resolveMediaPrompt.md b/docs/reference/functions/resolveMediaPrompt.md index 6203fa15b2..41e537f218 100644 --- a/docs/reference/functions/resolveMediaPrompt.md +++ b/docs/reference/functions/resolveMediaPrompt.md @@ -7,7 +7,7 @@ title: resolveMediaPrompt function resolveMediaPrompt(prompt): ResolvedMediaPrompt; ``` -Defined in: packages/ai/src/utilities/media-prompt.ts:45 +Defined in: [packages/ai/src/utilities/media-prompt.ts:45](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/media-prompt.ts#L45) Decompose a [MediaPrompt](../type-aliases/MediaPrompt.md) into flattened text and per-modality part buckets, preserving prompt order everywhere. This is the single downrev diff --git a/docs/reference/functions/resolveResumeRunId.md b/docs/reference/functions/resolveResumeRunId.md index be45b8dedb..ac1c5b7740 100644 --- a/docs/reference/functions/resolveResumeRunId.md +++ b/docs/reference/functions/resolveResumeRunId.md @@ -7,7 +7,7 @@ title: resolveResumeRunId function resolveResumeRunId(request): string | null; ``` -Defined in: packages/ai/src/stream-durability.ts:141 +Defined in: [packages/ai/src/stream-durability.ts:141](https://github.com/TanStack/ai/blob/main/packages/ai/src/stream-durability.ts#L141) The run id a request names: `X-Run-Id` header first, then `?runId`. diff --git a/docs/reference/functions/resumeHttpResponse.md b/docs/reference/functions/resumeHttpResponse.md index d877d96c53..e19f44c5d4 100644 --- a/docs/reference/functions/resumeHttpResponse.md +++ b/docs/reference/functions/resumeHttpResponse.md @@ -7,7 +7,7 @@ title: resumeHttpResponse function resumeHttpResponse(options): Response; ``` -Defined in: packages/ai/src/stream-to-response.ts:1572 +Defined in: [packages/ai/src/stream-to-response.ts:1572](https://github.com/TanStack/ai/blob/main/packages/ai/src/stream-to-response.ts#L1572) Serve a resumable run from its durability log over NDJSON, without re-running the model. The NDJSON counterpart of [resumeServerSentEventsResponse](resumeServerSentEventsResponse.md); diff --git a/docs/reference/functions/resumeJsonResponse.md b/docs/reference/functions/resumeJsonResponse.md index 7bbd4ba24a..db9d42954f 100644 --- a/docs/reference/functions/resumeJsonResponse.md +++ b/docs/reference/functions/resumeJsonResponse.md @@ -7,7 +7,7 @@ title: resumeJsonResponse function resumeJsonResponse(options): Promise; ``` -Defined in: packages/ai/src/stream-to-response.ts:1815 +Defined in: [packages/ai/src/stream-to-response.ts:1815](https://github.com/TanStack/ai/blob/main/packages/ai/src/stream-to-response.ts#L1815) Serve a resumable run from its durability log as one JSON body, without re-running the model. The JSON counterpart of diff --git a/docs/reference/functions/resumeServerSentEventsResponse.md b/docs/reference/functions/resumeServerSentEventsResponse.md index f5c040f9d6..4cbd493a2e 100644 --- a/docs/reference/functions/resumeServerSentEventsResponse.md +++ b/docs/reference/functions/resumeServerSentEventsResponse.md @@ -7,7 +7,7 @@ title: resumeServerSentEventsResponse function resumeServerSentEventsResponse(options): Response; ``` -Defined in: packages/ai/src/stream-to-response.ts:1368 +Defined in: [packages/ai/src/stream-to-response.ts:1368](https://github.com/TanStack/ai/blob/main/packages/ai/src/stream-to-response.ts#L1368) Serve a resumable run from its durability log over Server-Sent Events, without re-running the model. Use this in a `GET` handler so a reload or a second tab diff --git a/docs/reference/functions/resumeWebSocketResponse.md b/docs/reference/functions/resumeWebSocketResponse.md index 2911e6ef56..969246fed3 100644 --- a/docs/reference/functions/resumeWebSocketResponse.md +++ b/docs/reference/functions/resumeWebSocketResponse.md @@ -7,7 +7,7 @@ title: resumeWebSocketResponse function resumeWebSocketResponse(options): Response; ``` -Defined in: packages/ai/src/stream-to-websocket.ts:419 +Defined in: [packages/ai/src/stream-to-websocket.ts:425](https://github.com/TanStack/ai/blob/main/packages/ai/src/stream-to-websocket.ts#L425) Cloudflare wrapper (Workers/Durable Objects): creates a `WebSocketPair`, accepts the server socket, delegates to [resumeWebSocketStream](resumeWebSocketStream.md), and diff --git a/docs/reference/functions/resumeWebSocketStream.md b/docs/reference/functions/resumeWebSocketStream.md index 354329af0d..a7dbbbd64b 100644 --- a/docs/reference/functions/resumeWebSocketStream.md +++ b/docs/reference/functions/resumeWebSocketStream.md @@ -7,7 +7,7 @@ title: resumeWebSocketStream function resumeWebSocketStream(socket, options): void; ``` -Defined in: packages/ai/src/stream-to-websocket.ts:307 +Defined in: [packages/ai/src/stream-to-websocket.ts:313](https://github.com/TanStack/ai/blob/main/packages/ai/src/stream-to-websocket.ts#L313) Read-only replay of a run's durability log over a socket (mirrors `resumeServerSentEventsResponse`). The adapter captures the offset from the diff --git a/docs/reference/functions/runAgentStream.md b/docs/reference/functions/runAgentStream.md index f520ed3fc9..a757ac4fad 100644 --- a/docs/reference/functions/runAgentStream.md +++ b/docs/reference/functions/runAgentStream.md @@ -12,7 +12,7 @@ function runAgentStream( binding?): AsyncIterable; ``` -Defined in: packages/ai/src/activities/chat/agents/spawn.ts:732 +Defined in: [packages/ai/src/activities/chat/agents/spawn.ts:752](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/spawn.ts#L752) Run one agent and stream its chunks, from `SUBAGENT_STARTED` to `SUBAGENT_FINISHED` or `SUBAGENT_ERROR`. The package root exports this diff --git a/docs/reference/functions/score.md b/docs/reference/functions/score.md index a6b6d7cdbb..d08958acae 100644 --- a/docs/reference/functions/score.md +++ b/docs/reference/functions/score.md @@ -7,7 +7,7 @@ title: score function score(options): object; ``` -Defined in: packages/ai/src/activities/evaluate/index.ts:393 +Defined in: [packages/ai/src/activities/evaluate/index.ts:394](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/evaluate/index.ts#L394) Build a score question. The model rates `state` on ordered `levels`. diff --git a/docs/reference/functions/splitMidConversationChanges.md b/docs/reference/functions/splitMidConversationChanges.md index ec56870268..34670908c4 100644 --- a/docs/reference/functions/splitMidConversationChanges.md +++ b/docs/reference/functions/splitMidConversationChanges.md @@ -9,7 +9,7 @@ function splitMidConversationChanges(input): | undefined; ``` -Defined in: packages/ai/src/utilities/mid-conversation.ts:129 +Defined in: [packages/ai/src/utilities/mid-conversation.ts:129](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/mid-conversation.ts#L129) For adapters: resolve the names and counts of `changes` against the current `tools` and `systemPrompts`. Returns `undefined` when a name is missing, a diff --git a/docs/reference/functions/streamToText.md b/docs/reference/functions/streamToText.md index b10b787bef..e86ec38eee 100644 --- a/docs/reference/functions/streamToText.md +++ b/docs/reference/functions/streamToText.md @@ -7,7 +7,7 @@ title: streamToText function streamToText(stream): Promise; ``` -Defined in: packages/ai/src/stream-to-response.ts:60 +Defined in: [packages/ai/src/stream-to-response.ts:60](https://github.com/TanStack/ai/blob/main/packages/ai/src/stream-to-response.ts#L60) Read a StreamChunk async iterable to the end and return its text and chunks. diff --git a/docs/reference/functions/subagentHostMessageId.md b/docs/reference/functions/subagentHostMessageId.md index 10182ad0d1..88f9f1b1d7 100644 --- a/docs/reference/functions/subagentHostMessageId.md +++ b/docs/reference/functions/subagentHostMessageId.md @@ -7,7 +7,7 @@ title: subagentHostMessageId function subagentHostMessageId(runId): string; ``` -Defined in: packages/ai/src/utilities/subagent-wire.ts:194 +Defined in: [packages/ai/src/utilities/subagent-wire.ts:194](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/subagent-wire.ts#L194) The id of the parent assistant message that hosts a routed turn's cards. The persistence recorder writes that message, and a handoff run passes the diff --git a/docs/reference/functions/subagentInputOf.md b/docs/reference/functions/subagentInputOf.md index ce0b9e0dca..dbbdffce69 100644 --- a/docs/reference/functions/subagentInputOf.md +++ b/docs/reference/functions/subagentInputOf.md @@ -7,7 +7,7 @@ title: subagentInputOf function subagentInputOf(metadata): unknown; ``` -Defined in: packages/ai/src/utilities/subagent-wire.ts:44 +Defined in: [packages/ai/src/utilities/subagent-wire.ts:44](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/subagent-wire.ts#L44) The checked input of a child that an agent with `inputSchema` got, read from the `metadata` of its card or of its `SUBAGENT_STARTED` event. diff --git a/docs/reference/functions/subagentRoute.md b/docs/reference/functions/subagentRoute.md index b4f5fe3413..6014db766f 100644 --- a/docs/reference/functions/subagentRoute.md +++ b/docs/reference/functions/subagentRoute.md @@ -7,7 +7,7 @@ title: subagentRoute function subagentRoute(agents, options?): object; ``` -Defined in: packages/ai/src/activities/chat/agents/route.ts:94 +Defined in: [packages/ai/src/activities/chat/agents/route.ts:94](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/route.ts#L94) Build `decide()` questions for a subagent router. diff --git a/docs/reference/functions/summarize.md b/docs/reference/functions/summarize.md index 84bae6d639..18ea4ab3ec 100644 --- a/docs/reference/functions/summarize.md +++ b/docs/reference/functions/summarize.md @@ -7,7 +7,7 @@ title: summarize function summarize(options): SummarizeActivityResult; ``` -Defined in: packages/ai/src/activities/summarize/index.ts:210 +Defined in: [packages/ai/src/activities/summarize/index.ts:210](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/summarize/index.ts#L210) Summarize activity - generates summaries from text. diff --git a/docs/reference/functions/supportedReasoningLevels.md b/docs/reference/functions/supportedReasoningLevels.md index 76d4e2ea86..43b8e98222 100644 --- a/docs/reference/functions/supportedReasoningLevels.md +++ b/docs/reference/functions/supportedReasoningLevels.md @@ -7,7 +7,7 @@ title: supportedReasoningLevels function supportedReasoningLevels(reasoning): readonly ReasoningLevel[]; ``` -Defined in: packages/ai/src/reasoning.ts:117 +Defined in: [packages/ai/src/reasoning.ts:117](https://github.com/TanStack/ai/blob/main/packages/ai/src/reasoning.ts#L117) The levels a model supports, from least to most thinking: the levels in its data. A model that does not reason, or has no data, supports only `off`. diff --git a/docs/reference/functions/toHttpResponse.md b/docs/reference/functions/toHttpResponse.md index ea0a85153e..a613ad0967 100644 --- a/docs/reference/functions/toHttpResponse.md +++ b/docs/reference/functions/toHttpResponse.md @@ -7,7 +7,7 @@ title: toHttpResponse function toHttpResponse(stream, init?): Response; ``` -Defined in: packages/ai/src/stream-to-response.ts:1482 +Defined in: [packages/ai/src/stream-to-response.ts:1482](https://github.com/TanStack/ai/blob/main/packages/ai/src/stream-to-response.ts#L1482) Convert a StreamChunk async iterable to a Response in HTTP stream format (newline-delimited JSON) diff --git a/docs/reference/functions/toHttpStream.md b/docs/reference/functions/toHttpStream.md index 2105ca59c1..935831d59a 100644 --- a/docs/reference/functions/toHttpStream.md +++ b/docs/reference/functions/toHttpStream.md @@ -10,7 +10,7 @@ function toHttpStream( getId?): ReadableStream>; ``` -Defined in: packages/ai/src/stream-to-response.ts:1416 +Defined in: [packages/ai/src/stream-to-response.ts:1416](https://github.com/TanStack/ai/blob/main/packages/ai/src/stream-to-response.ts#L1416) Convert a StreamChunk async iterable to a ReadableStream in HTTP stream format (newline-delimited JSON) diff --git a/docs/reference/functions/toJsonResponse.md b/docs/reference/functions/toJsonResponse.md index bbd93a4972..a4b7066be1 100644 --- a/docs/reference/functions/toJsonResponse.md +++ b/docs/reference/functions/toJsonResponse.md @@ -9,7 +9,7 @@ title: toJsonResponse function toJsonResponse(result, init?): Promise; ``` -Defined in: packages/ai/src/stream-to-response.ts:1684 +Defined in: [packages/ai/src/stream-to-response.ts:1684](https://github.com/TanStack/ai/blob/main/packages/ai/src/stream-to-response.ts#L1684) Send a chat run as one JSON body, for hosts that cannot stream a response. Pair it with the `fetchJson` connection adapter. @@ -86,7 +86,7 @@ export async function POST(request: Request) { function toJsonResponse(stream, init?): Promise; ``` -Defined in: packages/ai/src/stream-to-response.ts:1688 +Defined in: [packages/ai/src/stream-to-response.ts:1688](https://github.com/TanStack/ai/blob/main/packages/ai/src/stream-to-response.ts#L1688) Send a chat run as one JSON body, for hosts that cannot stream a response. Pair it with the `fetchJson` connection adapter. @@ -169,7 +169,7 @@ export async function POST(request: Request) { function toJsonResponse(structuredOutput, init?): Promise; ``` -Defined in: packages/ai/src/stream-to-response.ts:1692 +Defined in: [packages/ai/src/stream-to-response.ts:1692](https://github.com/TanStack/ai/blob/main/packages/ai/src/stream-to-response.ts#L1692) Send a chat run as one JSON body, for hosts that cannot stream a response. Pair it with the `fetchJson` connection adapter. diff --git a/docs/reference/functions/toServerSentEventsResponse.md b/docs/reference/functions/toServerSentEventsResponse.md index df68b2b9c1..aaeb14e9ee 100644 --- a/docs/reference/functions/toServerSentEventsResponse.md +++ b/docs/reference/functions/toServerSentEventsResponse.md @@ -7,7 +7,7 @@ title: toServerSentEventsResponse function toServerSentEventsResponse(stream, init?): Response; ``` -Defined in: packages/ai/src/stream-to-response.ts:1059 +Defined in: [packages/ai/src/stream-to-response.ts:1059](https://github.com/TanStack/ai/blob/main/packages/ai/src/stream-to-response.ts#L1059) Convert a StreamChunk async iterable to a Response in Server-Sent Events format diff --git a/docs/reference/functions/toServerSentEventsStream.md b/docs/reference/functions/toServerSentEventsStream.md index ca26eacd27..3b39e4128c 100644 --- a/docs/reference/functions/toServerSentEventsStream.md +++ b/docs/reference/functions/toServerSentEventsStream.md @@ -10,7 +10,7 @@ function toServerSentEventsStream( getId?): ReadableStream>; ``` -Defined in: packages/ai/src/stream-to-response.ts:473 +Defined in: [packages/ai/src/stream-to-response.ts:473](https://github.com/TanStack/ai/blob/main/packages/ai/src/stream-to-response.ts#L473) Convert a StreamChunk async iterable to a ReadableStream in Server-Sent Events format diff --git a/docs/reference/functions/toSpecTokenUsage.md b/docs/reference/functions/toSpecTokenUsage.md index 8a63ece753..37245f2d4a 100644 --- a/docs/reference/functions/toSpecTokenUsage.md +++ b/docs/reference/functions/toSpecTokenUsage.md @@ -7,7 +7,7 @@ title: toSpecTokenUsage function toSpecTokenUsage(usage, options?): object; ``` -Defined in: packages/ai/src/utilities/ag-ui-usage.ts:40 +Defined in: [packages/ai/src/utilities/ag-ui-usage.ts:40](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/ag-ui-usage.ts#L40) ## Parameters diff --git a/docs/reference/functions/toWebSocketResponse.md b/docs/reference/functions/toWebSocketResponse.md index d0a7ec1e73..72044972fa 100644 --- a/docs/reference/functions/toWebSocketResponse.md +++ b/docs/reference/functions/toWebSocketResponse.md @@ -7,7 +7,7 @@ title: toWebSocketResponse function toWebSocketResponse(request, init): Response; ``` -Defined in: packages/ai/src/stream-to-websocket.ts:398 +Defined in: [packages/ai/src/stream-to-websocket.ts:404](https://github.com/TanStack/ai/blob/main/packages/ai/src/stream-to-websocket.ts#L404) Cloudflare wrapper (Workers/Durable Objects): creates a `WebSocketPair`, accepts the server socket, delegates to [toWebSocketStream](toWebSocketStream.md), and diff --git a/docs/reference/functions/toWebSocketStream.md b/docs/reference/functions/toWebSocketStream.md index cfb10714ef..2e2ae711d1 100644 --- a/docs/reference/functions/toWebSocketStream.md +++ b/docs/reference/functions/toWebSocketStream.md @@ -10,7 +10,7 @@ function toWebSocketStream( init): void; ``` -Defined in: packages/ai/src/stream-to-websocket.ts:120 +Defined in: [packages/ai/src/stream-to-websocket.ts:126](https://github.com/TanStack/ai/blob/main/packages/ai/src/stream-to-websocket.ts#L126) Run a full-duplex, conversation-scoped chat over an already-accepted server socket. Each inbound RunAgentInput frame starts one chat() turn (via onRun) diff --git a/docs/reference/functions/toolDefinition.md b/docs/reference/functions/toolDefinition.md index c5a799c413..f2534b2ad3 100644 --- a/docs/reference/functions/toolDefinition.md +++ b/docs/reference/functions/toolDefinition.md @@ -7,7 +7,7 @@ title: toolDefinition function toolDefinition(config): ToolDefinition; ``` -Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:343 +Defined in: [packages/ai/src/activities/chat/tools/tool-definition.ts:343](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-definition.ts#L343) Create an isomorphic tool definition that can be used directly or instantiated for server/client diff --git a/docs/reference/functions/uiMessageToModelMessages.md b/docs/reference/functions/uiMessageToModelMessages.md index ae0ffe2901..6877a3bdfe 100644 --- a/docs/reference/functions/uiMessageToModelMessages.md +++ b/docs/reference/functions/uiMessageToModelMessages.md @@ -10,7 +10,7 @@ function uiMessageToModelMessages(uiMessage): ModelMessage< | null>[]; ``` -Defined in: packages/ai/src/activities/chat/messages.ts:715 +Defined in: [packages/ai/src/activities/chat/messages.ts:715](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/messages.ts#L715) Convert a UIMessage to ModelMessage(s) diff --git a/docs/reference/functions/uiMessagesToWire.md b/docs/reference/functions/uiMessagesToWire.md index 68fcdec0ce..f8282c9e21 100644 --- a/docs/reference/functions/uiMessagesToWire.md +++ b/docs/reference/functions/uiMessagesToWire.md @@ -7,7 +7,7 @@ title: uiMessagesToWire function uiMessagesToWire(messages, options?): WireMessage[]; ``` -Defined in: packages/ai/src/utilities/ag-ui-wire.ts:101 +Defined in: [packages/ai/src/utilities/ag-ui-wire.ts:101](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/ag-ui-wire.ts#L101) Serialize TanStack `UIMessage`s and `ModelMessage`s into the AG-UI `RunAgentInput.messages` wire shape. Anchors are spec-only (`id`, `role`, diff --git a/docs/reference/functions/unsupportedFileSourceError.md b/docs/reference/functions/unsupportedFileSourceError.md index 609f0911da..70d46a44e4 100644 --- a/docs/reference/functions/unsupportedFileSourceError.md +++ b/docs/reference/functions/unsupportedFileSourceError.md @@ -7,7 +7,7 @@ title: unsupportedFileSourceError function unsupportedFileSourceError(providerName, detail?): Error; ``` -Defined in: packages/ai/src/utilities/content-source.ts:53 +Defined in: [packages/ai/src/utilities/content-source.ts:53](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/content-source.ts#L53) Build the standard error a non-issuer adapter throws when it encounters a `{ type: 'file' }` source it can't consume — either because the provider has diff --git a/docs/reference/functions/untilFinishReason.md b/docs/reference/functions/untilFinishReason.md index 95423f3d55..4cd584befb 100644 --- a/docs/reference/functions/untilFinishReason.md +++ b/docs/reference/functions/untilFinishReason.md @@ -7,7 +7,7 @@ title: untilFinishReason function untilFinishReason(stopReasons): AgentLoopStrategy; ``` -Defined in: packages/ai/src/activities/chat/agent-loop-strategies.ts:47 +Defined in: [packages/ai/src/activities/chat/agent-loop-strategies.ts:47](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agent-loop-strategies.ts#L47) Creates a strategy that continues until a specific finish reason is encountered diff --git a/docs/reference/functions/uploadFile.md b/docs/reference/functions/uploadFile.md index a93c5ddeb7..69c5d764b9 100644 --- a/docs/reference/functions/uploadFile.md +++ b/docs/reference/functions/uploadFile.md @@ -7,7 +7,7 @@ title: uploadFile function uploadFile(options): Promise>; ``` -Defined in: packages/ai/src/activities/files/index.ts:27 +Defined in: [packages/ai/src/activities/files/index.ts:27](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/files/index.ts#L27) Upload a file to a provider's Files API and return its handle. The handle carries the provider name as a literal type, so passing it to another diff --git a/docs/reference/functions/validateInterruptResumeBatch.md b/docs/reference/functions/validateInterruptResumeBatch.md index 15dd04a546..3b310cceef 100644 --- a/docs/reference/functions/validateInterruptResumeBatch.md +++ b/docs/reference/functions/validateInterruptResumeBatch.md @@ -7,7 +7,7 @@ title: validateInterruptResumeBatch function validateInterruptResumeBatch(input): Promise; ``` -Defined in: packages/ai/src/interrupt-resume.ts:295 +Defined in: [packages/ai/src/interrupt-resume.ts:295](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupt-resume.ts#L295) Validate and translate a complete interrupt batch before any tool executes. Used by ephemeral chat resume; a durable layer may share the same validator. diff --git a/docs/reference/functions/validateJsonSchema.md b/docs/reference/functions/validateJsonSchema.md new file mode 100644 index 0000000000..7bcaa897a6 --- /dev/null +++ b/docs/reference/functions/validateJsonSchema.md @@ -0,0 +1,36 @@ +--- +id: validateJsonSchema +title: validateJsonSchema +--- + +```ts +function validateJsonSchema(schema, value): Result; +``` + +Defined in: [packages/ai/src/activities/chat/tools/input-validation.ts:427](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/input-validation.ts#L427) + +Check `value` against the JSON Schema `schema` with `@cfworker/json-schema`, +as a tool input is checked, with no repair. Every keyword that the +validator knows is checked. `format` is an annotation only. The result has +the Standard Schema shape: `{ value }` when it fits, else `{ issues }`. + +## Parameters + +### schema + +`boolean` \| `AnySchema` + +### value + +`unknown` + +## Returns + +`Result`\<`unknown`\> + +## Example + +```ts +const result = validateJsonSchema({ type: 'string', pattern: '^a' }, 'b') +if (result.issues) console.log(result.issues.map((issue) => issue.message)) +``` diff --git a/docs/reference/functions/validateWithStandardSchema.md b/docs/reference/functions/validateWithStandardSchema.md index dc2c24fafc..b0ac1de02e 100644 --- a/docs/reference/functions/validateWithStandardSchema.md +++ b/docs/reference/functions/validateWithStandardSchema.md @@ -15,7 +15,7 @@ function validateWithStandardSchema(schema, data): Promise< }>; ``` -Defined in: packages/ai/src/activities/chat/tools/schema-converter.ts:408 +Defined in: [packages/ai/src/activities/chat/tools/schema-converter.ts:408](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/schema-converter.ts#L408) Validates data against a Standard Schema compliant schema. diff --git a/docs/reference/functions/wasCancelRequested.md b/docs/reference/functions/wasCancelRequested.md index f933e693d7..e3c4932362 100644 --- a/docs/reference/functions/wasCancelRequested.md +++ b/docs/reference/functions/wasCancelRequested.md @@ -7,7 +7,7 @@ title: wasCancelRequested function wasCancelRequested(runs, runId): Promise; ``` -Defined in: packages/ai/src/activities/chat/cancel.ts:71 +Defined in: [packages/ai/src/activities/chat/cancel.ts:71](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/cancel.ts#L71) Whether an explicit cancel has been recorded for `runId`. diff --git a/docs/reference/functions/wireSubagentInfo.md b/docs/reference/functions/wireSubagentInfo.md index 9f30f54ee2..edd33c022e 100644 --- a/docs/reference/functions/wireSubagentInfo.md +++ b/docs/reference/functions/wireSubagentInfo.md @@ -7,7 +7,7 @@ title: wireSubagentInfo function wireSubagentInfo(message): SubagentWireInfo | undefined; ``` -Defined in: packages/ai/src/utilities/subagent-wire.ts:55 +Defined in: [packages/ai/src/utilities/subagent-wire.ts:55](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/subagent-wire.ts#L55) ## Parameters diff --git a/docs/reference/functions/withInterruptBinding.md b/docs/reference/functions/withInterruptBinding.md index cd10a6ca1a..1f3bfd473b 100644 --- a/docs/reference/functions/withInterruptBinding.md +++ b/docs/reference/functions/withInterruptBinding.md @@ -7,7 +7,7 @@ title: withInterruptBinding function withInterruptBinding(descriptor, binding): Interrupt; ``` -Defined in: packages/ai/src/interrupt-resume.ts:954 +Defined in: [packages/ai/src/interrupt-resume.ts:945](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupt-resume.ts#L945) Attach a resume binding to an interrupt descriptor, under [INTERRUPT\_BINDING\_METADATA\_KEY](../variables/INTERRUPT_BINDING_METADATA_KEY.md). diff --git a/docs/reference/functions/withTanstackMetadata.md b/docs/reference/functions/withTanstackMetadata.md index 28486ae83c..c01c09dd37 100644 --- a/docs/reference/functions/withTanstackMetadata.md +++ b/docs/reference/functions/withTanstackMetadata.md @@ -7,7 +7,7 @@ title: withTanstackMetadata function withTanstackMetadata(value, tanstack): Omit & object; ``` -Defined in: packages/ai/src/utilities/merge-metadata.ts:46 +Defined in: [packages/ai/src/utilities/merge-metadata.ts:46](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/merge-metadata.ts#L46) ## Type Parameters diff --git a/docs/reference/functions/withoutInterruptBinding.md b/docs/reference/functions/withoutInterruptBinding.md index 179931b310..101bf71583 100644 --- a/docs/reference/functions/withoutInterruptBinding.md +++ b/docs/reference/functions/withoutInterruptBinding.md @@ -7,7 +7,7 @@ title: withoutInterruptBinding function withoutInterruptBinding(descriptor): Interrupt; ``` -Defined in: packages/ai/src/interrupt-resume.ts:1001 +Defined in: [packages/ai/src/interrupt-resume.ts:992](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupt-resume.ts#L992) ## Parameters diff --git a/docs/reference/functions/wrapGenericInterruptContinuation.md b/docs/reference/functions/wrapGenericInterruptContinuation.md index d5326ad119..c806ba4484 100644 --- a/docs/reference/functions/wrapGenericInterruptContinuation.md +++ b/docs/reference/functions/wrapGenericInterruptContinuation.md @@ -7,7 +7,7 @@ title: wrapGenericInterruptContinuation function wrapGenericInterruptContinuation(continuation): Record; ``` -Defined in: packages/ai/src/generic-interrupt-continuation.ts:112 +Defined in: [packages/ai/src/generic-interrupt-continuation.ts:112](https://github.com/TanStack/ai/blob/main/packages/ai/src/generic-interrupt-continuation.ts#L112) Put a parsed continuation on `ResumeEntry.metadata`. diff --git a/docs/reference/index.md b/docs/reference/index.md index c6c2b31e7d..942283f398 100644 --- a/docs/reference/index.md +++ b/docs/reference/index.md @@ -12,6 +12,7 @@ title: "@tanstack/ai" - [CompositeStrategy](classes/CompositeStrategy.md) - [ConsoleLogger](classes/ConsoleLogger.md) - [DuplicateToolNameError](classes/DuplicateToolNameError.md) +- [EvaluateError](classes/EvaluateError.md) - [ImmediateStrategy](classes/ImmediateStrategy.md) - [InMemoryRunStore](classes/InMemoryRunStore.md) - [InterruptResumeValidationError](classes/InterruptResumeValidationError.md) @@ -86,6 +87,7 @@ title: "@tanstack/ai" - [EmitCustomEventOptions](interfaces/EmitCustomEventOptions.md) - [ErrorInfo](interfaces/ErrorInfo.md) - [EvaluateAdapter](interfaces/EvaluateAdapter.md) +- [EvaluateErrorInit](interfaces/EvaluateErrorInit.md) - [ExtendedModelDef](interfaces/ExtendedModelDef.md) - [FileChangedEvent](interfaces/FileChangedEvent.md) - [FileChangedPayload](interfaces/FileChangedPayload.md) @@ -216,6 +218,7 @@ title: "@tanstack/ai" - [StructuredOutputMiddlewareConfig](interfaces/StructuredOutputMiddlewareConfig.md) - [StructuredOutputStartEvent](interfaces/StructuredOutputStartEvent.md) - [SubagentBinding](interfaces/SubagentBinding.md) +- [SubagentContextExtension](interfaces/SubagentContextExtension.md) - [SubagentErrorEvent](interfaces/SubagentErrorEvent.md) - [SubagentFinishedEvent](interfaces/SubagentFinishedEvent.md) - [SubagentForward](interfaces/SubagentForward.md) @@ -363,6 +366,7 @@ title: "@tanstack/ai" - [GenericInterruptContinuationReadResult](type-aliases/GenericInterruptContinuationReadResult.md) - [GenericInterruptRequest](type-aliases/GenericInterruptRequest.md) - [GenericInterruptResolution](type-aliases/GenericInterruptResolution.md) +- [GuardToolCallDecision](type-aliases/GuardToolCallDecision.md) - [InboundFrame](type-aliases/InboundFrame.md) - [InferSchemaType](type-aliases/InferSchemaType.md) - [InferToolInput](type-aliases/InferToolInput.md) @@ -455,6 +459,7 @@ title: "@tanstack/ai" - [defaultJSONParser](variables/defaultJSONParser.md) - [DetachableRunCapability](variables/DetachableRunCapability.md) - [DISCOVERY\_TOOL\_NAME](variables/DISCOVERY_TOOL_NAME.md) +- [EVALUATE\_REFUSAL\_CODE](variables/EVALUATE_REFUSAL_CODE.md) - [getDetachableRun](variables/getDetachableRun.md) - [getLoadChild](variables/getLoadChild.md) - [getLogRecords](variables/getLogRecords.md) @@ -562,6 +567,7 @@ title: "@tanstack/ai" - [isContentPart](functions/isContentPart.md) - [isContentPartArray](functions/isContentPartArray.md) - [isCustomEvent](functions/isCustomEvent.md) +- [isEvaluateError](functions/isEvaluateError.md) - [isFileSource](functions/isFileSource.md) - [isKeyedAdapter](functions/isKeyedAdapter.md) - [isProviderExecutedToolCall](functions/isProviderExecutedToolCall.md) @@ -627,6 +633,7 @@ title: "@tanstack/ai" - [untilFinishReason](functions/untilFinishReason.md) - [uploadFile](functions/uploadFile.md) - [validateInterruptResumeBatch](functions/validateInterruptResumeBatch.md) +- [validateJsonSchema](functions/validateJsonSchema.md) - [validateWithStandardSchema](functions/validateWithStandardSchema.md) - [wasCancelRequested](functions/wasCancelRequested.md) - [wireSubagentInfo](functions/wireSubagentInfo.md) diff --git a/docs/reference/interfaces/AbortInfo.md b/docs/reference/interfaces/AbortInfo.md index 00b0b50091..ece1266f5e 100644 --- a/docs/reference/interfaces/AbortInfo.md +++ b/docs/reference/interfaces/AbortInfo.md @@ -3,7 +3,7 @@ id: AbortInfo title: AbortInfo --- -Defined in: packages/ai/src/activities/chat/middleware/types.ts:576 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:606](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L606) Information passed to onAbort. @@ -15,7 +15,7 @@ Information passed to onAbort. optional cancelRequested?: boolean; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:596 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:626](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L626) True only when the abort came from an explicit, out-of-band cancel (e.g. a cancel endpoint setting `RunRecord.cancelRequested`), never from a mere @@ -39,7 +39,7 @@ host reads `RunRecord.cancelRequested` in addition to this flag. duration: number; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:580 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:610](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L610) Duration until abort in milliseconds @@ -51,6 +51,6 @@ Duration until abort in milliseconds optional reason?: string; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:578 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:608](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L608) The reason for the abort, if provided diff --git a/docs/reference/interfaces/ActivityDeltaEvent.md b/docs/reference/interfaces/ActivityDeltaEvent.md index 2006231d53..d50a698297 100644 --- a/docs/reference/interfaces/ActivityDeltaEvent.md +++ b/docs/reference/interfaces/ActivityDeltaEvent.md @@ -3,7 +3,7 @@ id: ActivityDeltaEvent title: ActivityDeltaEvent --- -Defined in: packages/ai/src/types.ts:2012 +Defined in: [packages/ai/src/types.ts:2070](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2070) RFC 6902 JSON Patch against an existing activity's `content`. @@ -22,4 +22,4 @@ RFC 6902 JSON Patch against an existing activity's `content`. type: "ACTIVITY_DELTA"; ``` -Defined in: packages/ai/src/types.ts:2016 +Defined in: [packages/ai/src/types.ts:2074](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2074) diff --git a/docs/reference/interfaces/ActivityPart.md b/docs/reference/interfaces/ActivityPart.md index 532431b052..46ab940c7a 100644 --- a/docs/reference/interfaces/ActivityPart.md +++ b/docs/reference/interfaces/ActivityPart.md @@ -3,7 +3,7 @@ id: ActivityPart title: ActivityPart --- -Defined in: packages/ai/src/types.ts:563 +Defined in: [packages/ai/src/types.ts:566](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L566) Frontend-only AG-UI activity. Never converted into ModelMessage input. Mirrors [ActivityMessage](https://docs.ag-ui.com/concepts/messages): @@ -21,4 +21,4 @@ Mirrors [ActivityMessage](https://docs.ag-ui.com/concepts/messages): type: "activity"; ``` -Defined in: packages/ai/src/types.ts:567 +Defined in: [packages/ai/src/types.ts:570](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L570) diff --git a/docs/reference/interfaces/ActivityRecord.md b/docs/reference/interfaces/ActivityRecord.md index f25fafe15b..c1e4c0980d 100644 --- a/docs/reference/interfaces/ActivityRecord.md +++ b/docs/reference/interfaces/ActivityRecord.md @@ -3,7 +3,7 @@ id: ActivityRecord title: ActivityRecord --- -Defined in: packages/ai/src/types.ts:574 +Defined in: [packages/ai/src/types.ts:577](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L577) Durable sidecar row for frontend-only AG-UI activity. Never a ModelMessage. `index` is the insert position in the reconstructed UI transcript. @@ -20,4 +20,4 @@ Durable sidecar row for frontend-only AG-UI activity. Never a ModelMessage. index: number; ``` -Defined in: packages/ai/src/types.ts:575 +Defined in: [packages/ai/src/types.ts:578](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L578) diff --git a/docs/reference/interfaces/ActivitySnapshotEvent.md b/docs/reference/interfaces/ActivitySnapshotEvent.md index 17e4028a9e..69685511c3 100644 --- a/docs/reference/interfaces/ActivitySnapshotEvent.md +++ b/docs/reference/interfaces/ActivitySnapshotEvent.md @@ -3,7 +3,7 @@ id: ActivitySnapshotEvent title: ActivitySnapshotEvent --- -Defined in: packages/ai/src/types.ts:1999 +Defined in: [packages/ai/src/types.ts:2057](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2057) Full activity state for an `ActivityMessage`. @@ -22,4 +22,4 @@ Full activity state for an `ActivityMessage`. type: "ACTIVITY_SNAPSHOT"; ``` -Defined in: packages/ai/src/types.ts:2003 +Defined in: [packages/ai/src/types.ts:2061](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2061) diff --git a/docs/reference/interfaces/AfterToolCallInfo.md b/docs/reference/interfaces/AfterToolCallInfo.md index 6a57a81ed6..83fe1e8dd4 100644 --- a/docs/reference/interfaces/AfterToolCallInfo.md +++ b/docs/reference/interfaces/AfterToolCallInfo.md @@ -3,7 +3,7 @@ id: AfterToolCallInfo title: AfterToolCallInfo --- -Defined in: packages/ai/src/activities/chat/middleware/types.ts:464 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:494](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L494) Outcome information provided to onAfterToolCall. @@ -15,7 +15,7 @@ Outcome information provided to onAfterToolCall. duration: number; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:476 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:506](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L506) Duration of tool execution in milliseconds @@ -27,7 +27,7 @@ Duration of tool execution in milliseconds optional error?: unknown; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:479 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:509](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L509) *** @@ -37,7 +37,7 @@ Defined in: packages/ai/src/activities/chat/middleware/types.ts:479 ok: boolean; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:474 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:504](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L504) Whether the execution succeeded @@ -49,7 +49,7 @@ Whether the execution succeeded optional result?: unknown; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:478 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:508](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L508) The result (if ok) or error (if not ok) @@ -63,7 +63,7 @@ tool: | undefined; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:468 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:498](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L498) The resolved tool definition @@ -75,7 +75,7 @@ The resolved tool definition toolCall: ToolCall; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:466 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:496](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L496) The tool call that was executed @@ -87,7 +87,7 @@ The tool call that was executed toolCallId: string; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:472 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:502](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L502) ID of the tool call @@ -99,6 +99,6 @@ ID of the tool call toolName: string; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:470 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:500](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L500) Name of the tool diff --git a/docs/reference/interfaces/AgentLoopState.md b/docs/reference/interfaces/AgentLoopState.md index 643e9a9f85..ab9b159d1a 100644 --- a/docs/reference/interfaces/AgentLoopState.md +++ b/docs/reference/interfaces/AgentLoopState.md @@ -3,7 +3,7 @@ id: AgentLoopState title: AgentLoopState --- -Defined in: packages/ai/src/types.ts:1208 +Defined in: [packages/ai/src/types.ts:1248](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1248) State passed to agent loop strategy for determining whether to continue @@ -15,7 +15,7 @@ State passed to agent loop strategy for determining whether to continue finishReason: string | null; ``` -Defined in: packages/ai/src/types.ts:1214 +Defined in: [packages/ai/src/types.ts:1254](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1254) Finish reason from the last response @@ -27,7 +27,7 @@ Finish reason from the last response iterationCount: number; ``` -Defined in: packages/ai/src/types.ts:1210 +Defined in: [packages/ai/src/types.ts:1250](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1250) Current iteration count (0-indexed). One iteration = one model turn. @@ -39,7 +39,7 @@ Current iteration count (0-indexed). One iteration = one model turn. lastTurnToolCallCount: number; ``` -Defined in: packages/ai/src/types.ts:1226 +Defined in: [packages/ai/src/types.ts:1266](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1266) Tool calls in the most recent batch — a live model turn or a pending/resume batch (0 when the last phase produced no tool calls). @@ -55,7 +55,7 @@ messages: ModelMessage< | null>[]; ``` -Defined in: packages/ai/src/types.ts:1212 +Defined in: [packages/ai/src/types.ts:1252](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1252) Current messages array @@ -67,7 +67,7 @@ Current messages array toolCallCount: number; ``` -Defined in: packages/ai/src/types.ts:1221 +Defined in: [packages/ai/src/types.ts:1261](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1261) Cumulative tool calls counted so far in this run (model-emitted during the agent loop, including ones skipped by middleware, and pending tools from diff --git a/docs/reference/interfaces/ApprovalRequestedPayload.md b/docs/reference/interfaces/ApprovalRequestedPayload.md index 311ba24b89..edafca33a3 100644 --- a/docs/reference/interfaces/ApprovalRequestedPayload.md +++ b/docs/reference/interfaces/ApprovalRequestedPayload.md @@ -3,7 +3,7 @@ id: ApprovalRequestedPayload title: ApprovalRequestedPayload --- -Defined in: packages/ai/src/custom-events.ts:57 +Defined in: [packages/ai/src/custom-events.ts:57](https://github.com/TanStack/ai/blob/main/packages/ai/src/custom-events.ts#L57) ## Indexable @@ -21,7 +21,7 @@ Free-form detail describing the action awaiting approval. approvalId: string; ``` -Defined in: packages/ai/src/custom-events.ts:58 +Defined in: [packages/ai/src/custom-events.ts:58](https://github.com/TanStack/ai/blob/main/packages/ai/src/custom-events.ts#L58) *** @@ -31,4 +31,4 @@ Defined in: packages/ai/src/custom-events.ts:58 title: string; ``` -Defined in: packages/ai/src/custom-events.ts:59 +Defined in: [packages/ai/src/custom-events.ts:59](https://github.com/TanStack/ai/blob/main/packages/ai/src/custom-events.ts#L59) diff --git a/docs/reference/interfaces/ApprovalResolvedPayload.md b/docs/reference/interfaces/ApprovalResolvedPayload.md index d6a8be1dec..f43d558280 100644 --- a/docs/reference/interfaces/ApprovalResolvedPayload.md +++ b/docs/reference/interfaces/ApprovalResolvedPayload.md @@ -3,7 +3,7 @@ id: ApprovalResolvedPayload title: ApprovalResolvedPayload --- -Defined in: packages/ai/src/custom-events.ts:64 +Defined in: [packages/ai/src/custom-events.ts:64](https://github.com/TanStack/ai/blob/main/packages/ai/src/custom-events.ts#L64) ## Properties @@ -13,7 +13,7 @@ Defined in: packages/ai/src/custom-events.ts:64 approvalId: string; ``` -Defined in: packages/ai/src/custom-events.ts:65 +Defined in: [packages/ai/src/custom-events.ts:65](https://github.com/TanStack/ai/blob/main/packages/ai/src/custom-events.ts#L65) *** @@ -23,4 +23,4 @@ Defined in: packages/ai/src/custom-events.ts:65 granted: boolean; ``` -Defined in: packages/ai/src/custom-events.ts:66 +Defined in: [packages/ai/src/custom-events.ts:66](https://github.com/TanStack/ai/blob/main/packages/ai/src/custom-events.ts#L66) diff --git a/docs/reference/interfaces/ArtifactCreatedPayload.md b/docs/reference/interfaces/ArtifactCreatedPayload.md index c4b2214d8f..71121f2e08 100644 --- a/docs/reference/interfaces/ArtifactCreatedPayload.md +++ b/docs/reference/interfaces/ArtifactCreatedPayload.md @@ -3,7 +3,7 @@ id: ArtifactCreatedPayload title: ArtifactCreatedPayload --- -Defined in: packages/ai/src/custom-events.ts:69 +Defined in: [packages/ai/src/custom-events.ts:69](https://github.com/TanStack/ai/blob/main/packages/ai/src/custom-events.ts#L69) ## Properties @@ -13,7 +13,7 @@ Defined in: packages/ai/src/custom-events.ts:69 artifactId: string; ``` -Defined in: packages/ai/src/custom-events.ts:70 +Defined in: [packages/ai/src/custom-events.ts:70](https://github.com/TanStack/ai/blob/main/packages/ai/src/custom-events.ts#L70) *** @@ -23,7 +23,7 @@ Defined in: packages/ai/src/custom-events.ts:70 mimeType: string; ``` -Defined in: packages/ai/src/custom-events.ts:72 +Defined in: [packages/ai/src/custom-events.ts:72](https://github.com/TanStack/ai/blob/main/packages/ai/src/custom-events.ts#L72) *** @@ -33,7 +33,7 @@ Defined in: packages/ai/src/custom-events.ts:72 name: string; ``` -Defined in: packages/ai/src/custom-events.ts:71 +Defined in: [packages/ai/src/custom-events.ts:71](https://github.com/TanStack/ai/blob/main/packages/ai/src/custom-events.ts#L71) *** @@ -43,4 +43,4 @@ Defined in: packages/ai/src/custom-events.ts:71 size: number; ``` -Defined in: packages/ai/src/custom-events.ts:73 +Defined in: [packages/ai/src/custom-events.ts:73](https://github.com/TanStack/ai/blob/main/packages/ai/src/custom-events.ts#L73) diff --git a/docs/reference/interfaces/AudioAdapter.md b/docs/reference/interfaces/AudioAdapter.md index aa60d7c11e..14db949f8e 100644 --- a/docs/reference/interfaces/AudioAdapter.md +++ b/docs/reference/interfaces/AudioAdapter.md @@ -3,7 +3,7 @@ id: AudioAdapter title: AudioAdapter --- -Defined in: packages/ai/src/activities/generateAudio/adapter.ts:24 +Defined in: [packages/ai/src/activities/generateAudio/adapter.ts:24](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateAudio/adapter.ts#L24) Audio generation adapter interface with pre-resolved generics. @@ -32,7 +32,7 @@ Generic parameters: ~types: object; ``` -Defined in: packages/ai/src/activities/generateAudio/adapter.ts:38 +Defined in: [packages/ai/src/activities/generateAudio/adapter.ts:38](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateAudio/adapter.ts#L38) **`Internal`** @@ -52,7 +52,7 @@ providerOptions: TProviderOptions; generateAudio: (options) => Promise; ``` -Defined in: packages/ai/src/activities/generateAudio/adapter.ts:45 +Defined in: [packages/ai/src/activities/generateAudio/adapter.ts:45](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateAudio/adapter.ts#L45) Generate audio from a text prompt @@ -74,7 +74,7 @@ Generate audio from a text prompt readonly kind: "audio"; ``` -Defined in: packages/ai/src/activities/generateAudio/adapter.ts:29 +Defined in: [packages/ai/src/activities/generateAudio/adapter.ts:29](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateAudio/adapter.ts#L29) Discriminator for adapter kind - used to determine API shape @@ -86,7 +86,7 @@ Discriminator for adapter kind - used to determine API shape readonly model: TModel; ``` -Defined in: packages/ai/src/activities/generateAudio/adapter.ts:33 +Defined in: [packages/ai/src/activities/generateAudio/adapter.ts:33](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateAudio/adapter.ts#L33) The model this adapter is configured for @@ -98,6 +98,6 @@ The model this adapter is configured for readonly name: string; ``` -Defined in: packages/ai/src/activities/generateAudio/adapter.ts:31 +Defined in: [packages/ai/src/activities/generateAudio/adapter.ts:31](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateAudio/adapter.ts#L31) Adapter name identifier diff --git a/docs/reference/interfaces/AudioGenerationOptions.md b/docs/reference/interfaces/AudioGenerationOptions.md index 7e6d191569..8286681fbc 100644 --- a/docs/reference/interfaces/AudioGenerationOptions.md +++ b/docs/reference/interfaces/AudioGenerationOptions.md @@ -3,7 +3,7 @@ id: AudioGenerationOptions title: AudioGenerationOptions --- -Defined in: packages/ai/src/types.ts:2473 +Defined in: [packages/ai/src/types.ts:2531](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2531) Options for audio generation (music, sound effects, etc.). These are the common options supported across providers. @@ -22,7 +22,7 @@ These are the common options supported across providers. optional abortSignal?: AbortSignal; ``` -Defined in: packages/ai/src/types.ts:2495 +Defined in: [packages/ai/src/types.ts:2553](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2553) Effective abort signal composed by the activity from caller `abortSignal` and/or `timeout`. Adapters should forward this to the provider SDK when @@ -36,7 +36,7 @@ supported. Request-specific — never store on a global client config. optional duration?: number; ``` -Defined in: packages/ai/src/types.ts:2481 +Defined in: [packages/ai/src/types.ts:2539](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2539) Desired duration in seconds @@ -48,7 +48,7 @@ Desired duration in seconds logger: InternalLogger; ``` -Defined in: packages/ai/src/types.ts:2489 +Defined in: [packages/ai/src/types.ts:2547](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2547) Internal logger threaded from the generateAudio() entry point. Adapters must call logger.request() before the SDK call and logger.errors() in @@ -62,7 +62,7 @@ catch blocks. model: string; ``` -Defined in: packages/ai/src/types.ts:2477 +Defined in: [packages/ai/src/types.ts:2535](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2535) The model to use for audio generation @@ -74,7 +74,7 @@ The model to use for audio generation optional modelOptions?: TProviderOptions; ``` -Defined in: packages/ai/src/types.ts:2483 +Defined in: [packages/ai/src/types.ts:2541](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2541) Model-specific options for audio generation @@ -86,6 +86,6 @@ Model-specific options for audio generation prompt: string; ``` -Defined in: packages/ai/src/types.ts:2479 +Defined in: [packages/ai/src/types.ts:2537](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2537) Text description of the desired audio diff --git a/docs/reference/interfaces/AudioGenerationResult.md b/docs/reference/interfaces/AudioGenerationResult.md index d3934041fe..6dc3c9ec73 100644 --- a/docs/reference/interfaces/AudioGenerationResult.md +++ b/docs/reference/interfaces/AudioGenerationResult.md @@ -3,7 +3,7 @@ id: AudioGenerationResult title: AudioGenerationResult --- -Defined in: packages/ai/src/types.ts:2511 +Defined in: [packages/ai/src/types.ts:2569](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2569) Result of audio generation @@ -15,7 +15,7 @@ Result of audio generation optional artifacts?: PersistedArtifactRef[]; ``` -Defined in: packages/ai/src/types.ts:2521 +Defined in: [packages/ai/src/types.ts:2579](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2579) Persisted artifact references for generated assets, when available @@ -27,7 +27,7 @@ Persisted artifact references for generated assets, when available audio: GeneratedAudio; ``` -Defined in: packages/ai/src/types.ts:2517 +Defined in: [packages/ai/src/types.ts:2575](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2575) The generated audio @@ -39,7 +39,7 @@ The generated audio id: string; ``` -Defined in: packages/ai/src/types.ts:2513 +Defined in: [packages/ai/src/types.ts:2571](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2571) Unique identifier for the generation @@ -51,7 +51,7 @@ Unique identifier for the generation model: string; ``` -Defined in: packages/ai/src/types.ts:2515 +Defined in: [packages/ai/src/types.ts:2573](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2573) Model used for generation @@ -63,6 +63,6 @@ Model used for generation optional usage?: TokenUsage; ``` -Defined in: packages/ai/src/types.ts:2519 +Defined in: [packages/ai/src/types.ts:2577](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2577) Token usage information (if available) diff --git a/docs/reference/interfaces/AudioPart.md b/docs/reference/interfaces/AudioPart.md index c0a41d8e0a..06446a0f18 100644 --- a/docs/reference/interfaces/AudioPart.md +++ b/docs/reference/interfaces/AudioPart.md @@ -3,7 +3,7 @@ id: AudioPart title: AudioPart --- -Defined in: packages/ai/src/types.ts:297 +Defined in: [packages/ai/src/types.ts:300](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L300) Audio content part for multimodal messages. AG-UI `AudioPart` with typed metadata. @@ -27,7 +27,7 @@ Provider-specific metadata type optional metadata?: TMetadata; ``` -Defined in: packages/ai/src/types.ts:299 +Defined in: [packages/ai/src/types.ts:302](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L302) Provider-specific metadata (e.g., format, sample rate) diff --git a/docs/reference/interfaces/AudioVisualization.md b/docs/reference/interfaces/AudioVisualization.md index 96a539151b..3257cd3027 100644 --- a/docs/reference/interfaces/AudioVisualization.md +++ b/docs/reference/interfaces/AudioVisualization.md @@ -3,7 +3,7 @@ id: AudioVisualization title: AudioVisualization --- -Defined in: packages/ai/src/realtime/types.ts:205 +Defined in: [packages/ai/src/realtime/types.ts:205](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L205) Interface for accessing audio visualization data @@ -15,7 +15,7 @@ Interface for accessing audio visualization data getInputFrequencyData: () => Uint8Array; ``` -Defined in: packages/ai/src/realtime/types.ts:212 +Defined in: [packages/ai/src/realtime/types.ts:212](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L212) Get frequency data for input audio visualization @@ -31,7 +31,7 @@ Get frequency data for input audio visualization getInputTimeDomainData: () => Uint8Array; ``` -Defined in: packages/ai/src/realtime/types.ts:217 +Defined in: [packages/ai/src/realtime/types.ts:217](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L217) Get time domain data for input waveform @@ -47,7 +47,7 @@ Get time domain data for input waveform getOutputFrequencyData: () => Uint8Array; ``` -Defined in: packages/ai/src/realtime/types.ts:214 +Defined in: [packages/ai/src/realtime/types.ts:214](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L214) Get frequency data for output audio visualization @@ -63,7 +63,7 @@ Get frequency data for output audio visualization getOutputTimeDomainData: () => Uint8Array; ``` -Defined in: packages/ai/src/realtime/types.ts:219 +Defined in: [packages/ai/src/realtime/types.ts:219](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L219) Get time domain data for output waveform @@ -79,7 +79,7 @@ Get time domain data for output waveform readonly inputLevel: number; ``` -Defined in: packages/ai/src/realtime/types.ts:207 +Defined in: [packages/ai/src/realtime/types.ts:207](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L207) Input volume level (0-1 normalized) @@ -91,7 +91,7 @@ Input volume level (0-1 normalized) readonly inputSampleRate: number; ``` -Defined in: packages/ai/src/realtime/types.ts:222 +Defined in: [packages/ai/src/realtime/types.ts:222](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L222) Input sample rate @@ -103,7 +103,7 @@ Input sample rate optional onInputAudio?: (callback) => () => void; ``` -Defined in: packages/ai/src/realtime/types.ts:227 +Defined in: [packages/ai/src/realtime/types.ts:227](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L227) Subscribe to raw input audio samples @@ -125,7 +125,7 @@ Subscribe to raw input audio samples optional onOutputAudio?: (callback) => () => void; ``` -Defined in: packages/ai/src/realtime/types.ts:231 +Defined in: [packages/ai/src/realtime/types.ts:231](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L231) Subscribe to raw output audio samples @@ -147,7 +147,7 @@ Subscribe to raw output audio samples readonly outputLevel: number; ``` -Defined in: packages/ai/src/realtime/types.ts:209 +Defined in: [packages/ai/src/realtime/types.ts:209](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L209) Output volume level (0-1 normalized) @@ -159,6 +159,6 @@ Output volume level (0-1 normalized) readonly outputSampleRate: number; ``` -Defined in: packages/ai/src/realtime/types.ts:224 +Defined in: [packages/ai/src/realtime/types.ts:224](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L224) Output sample rate diff --git a/docs/reference/interfaces/BaseAGUIEvent.md b/docs/reference/interfaces/BaseAGUIEvent.md index 1576ffd2eb..4e94a83380 100644 --- a/docs/reference/interfaces/BaseAGUIEvent.md +++ b/docs/reference/interfaces/BaseAGUIEvent.md @@ -3,7 +3,7 @@ id: BaseAGUIEvent title: BaseAGUIEvent --- -Defined in: packages/ai/src/types.ts:1557 +Defined in: [packages/ai/src/types.ts:1597](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1597) Base structure for AG-UI events. Extends @ag-ui/core BaseEvent. TanStack extras ride in `metadata`. @@ -28,7 +28,7 @@ Extends @ag-ui/core BaseEvent. TanStack extras ride in `metadata`. optional metadata?: Record; ``` -Defined in: packages/ai/src/types.ts:1558 +Defined in: [packages/ai/src/types.ts:1598](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1598) Extra information attached to this event. diff --git a/docs/reference/interfaces/BaseUsageInput.md b/docs/reference/interfaces/BaseUsageInput.md index bc36ba840d..4993ee5ee3 100644 --- a/docs/reference/interfaces/BaseUsageInput.md +++ b/docs/reference/interfaces/BaseUsageInput.md @@ -3,7 +3,7 @@ id: BaseUsageInput title: BaseUsageInput --- -Defined in: packages/ai/src/utilities/usage.ts:7 +Defined in: [packages/ai/src/utilities/usage.ts:7](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/usage.ts#L7) Input parameters for building base TokenUsage. Provider functions should extract these from their SDK's response. @@ -16,7 +16,7 @@ Provider functions should extract these from their SDK's response. completionTokens: number; ``` -Defined in: packages/ai/src/utilities/usage.ts:11 +Defined in: [packages/ai/src/utilities/usage.ts:11](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/usage.ts#L11) Total output/completion tokens @@ -28,7 +28,7 @@ Total output/completion tokens promptTokens: number; ``` -Defined in: packages/ai/src/utilities/usage.ts:9 +Defined in: [packages/ai/src/utilities/usage.ts:9](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/usage.ts#L9) Total input/prompt tokens @@ -40,6 +40,6 @@ Total input/prompt tokens totalTokens: number; ``` -Defined in: packages/ai/src/utilities/usage.ts:13 +Defined in: [packages/ai/src/utilities/usage.ts:13](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/usage.ts#L13) Total tokens (prompt + completion) diff --git a/docs/reference/interfaces/BatchInterruptError.md b/docs/reference/interfaces/BatchInterruptError.md index 4edfedc238..c38dab78e3 100644 --- a/docs/reference/interfaces/BatchInterruptError.md +++ b/docs/reference/interfaces/BatchInterruptError.md @@ -3,7 +3,7 @@ id: BatchInterruptError title: BatchInterruptError --- -Defined in: packages/ai/src/interrupts.ts:51 +Defined in: [packages/ai/src/interrupts.ts:51](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupts.ts#L51) ## Extends @@ -17,7 +17,7 @@ Defined in: packages/ai/src/interrupts.ts:51 code: BatchInterruptErrorCode; ``` -Defined in: packages/ai/src/interrupts.ts:53 +Defined in: [packages/ai/src/interrupts.ts:53](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupts.ts#L53) *** @@ -27,7 +27,7 @@ Defined in: packages/ai/src/interrupts.ts:53 optional continuationRunId?: string; ``` -Defined in: packages/ai/src/interrupts.ts:13 +Defined in: [packages/ai/src/interrupts.ts:13](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupts.ts#L13) #### Inherited from @@ -41,7 +41,7 @@ Defined in: packages/ai/src/interrupts.ts:13 generation: number; ``` -Defined in: packages/ai/src/interrupts.ts:11 +Defined in: [packages/ai/src/interrupts.ts:11](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupts.ts#L11) #### Inherited from @@ -55,7 +55,7 @@ Defined in: packages/ai/src/interrupts.ts:11 interruptedRunId: string; ``` -Defined in: packages/ai/src/interrupts.ts:10 +Defined in: [packages/ai/src/interrupts.ts:10](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupts.ts#L10) #### Inherited from @@ -69,7 +69,7 @@ Defined in: packages/ai/src/interrupts.ts:10 interruptIds: readonly string[]; ``` -Defined in: packages/ai/src/interrupts.ts:57 +Defined in: [packages/ai/src/interrupts.ts:57](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupts.ts#L57) *** @@ -79,7 +79,7 @@ Defined in: packages/ai/src/interrupts.ts:57 message: string; ``` -Defined in: packages/ai/src/interrupts.ts:54 +Defined in: [packages/ai/src/interrupts.ts:54](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupts.ts#L54) *** @@ -89,7 +89,7 @@ Defined in: packages/ai/src/interrupts.ts:54 retryable: boolean; ``` -Defined in: packages/ai/src/interrupts.ts:56 +Defined in: [packages/ai/src/interrupts.ts:56](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupts.ts#L56) *** @@ -99,7 +99,7 @@ Defined in: packages/ai/src/interrupts.ts:56 scope: "batch"; ``` -Defined in: packages/ai/src/interrupts.ts:52 +Defined in: [packages/ai/src/interrupts.ts:52](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupts.ts#L52) *** @@ -109,7 +109,7 @@ Defined in: packages/ai/src/interrupts.ts:52 source: "transport" | "server" | "client"; ``` -Defined in: packages/ai/src/interrupts.ts:55 +Defined in: [packages/ai/src/interrupts.ts:55](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupts.ts#L55) *** @@ -119,7 +119,7 @@ Defined in: packages/ai/src/interrupts.ts:55 optional submissionId?: string; ``` -Defined in: packages/ai/src/interrupts.ts:12 +Defined in: [packages/ai/src/interrupts.ts:12](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupts.ts#L12) #### Inherited from @@ -133,7 +133,7 @@ Defined in: packages/ai/src/interrupts.ts:12 threadId: string; ``` -Defined in: packages/ai/src/interrupts.ts:9 +Defined in: [packages/ai/src/interrupts.ts:9](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupts.ts#L9) #### Inherited from diff --git a/docs/reference/interfaces/BooleanAnswer.md b/docs/reference/interfaces/BooleanAnswer.md index f3b3112378..d70bdced18 100644 --- a/docs/reference/interfaces/BooleanAnswer.md +++ b/docs/reference/interfaces/BooleanAnswer.md @@ -3,7 +3,7 @@ id: BooleanAnswer title: BooleanAnswer --- -Defined in: packages/ai/src/activities/evaluate/index.ts:92 +Defined in: [packages/ai/src/activities/evaluate/index.ts:93](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/evaluate/index.ts#L93) Public yes/no answer. `.value` is `true` when P(true) is 0.5 or more. There is no `.confidence`. @@ -16,7 +16,7 @@ There is no `.confidence`. probability: number; ``` -Defined in: packages/ai/src/activities/evaluate/index.ts:96 +Defined in: [packages/ai/src/activities/evaluate/index.ts:97](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/evaluate/index.ts#L97) P(true), from the wire `noul` field. @@ -28,7 +28,7 @@ P(true), from the wire `noul` field. type: "boolean"; ``` -Defined in: packages/ai/src/activities/evaluate/index.ts:93 +Defined in: [packages/ai/src/activities/evaluate/index.ts:94](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/evaluate/index.ts#L94) *** @@ -38,4 +38,4 @@ Defined in: packages/ai/src/activities/evaluate/index.ts:93 value: boolean; ``` -Defined in: packages/ai/src/activities/evaluate/index.ts:94 +Defined in: [packages/ai/src/activities/evaluate/index.ts:95](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/evaluate/index.ts#L95) diff --git a/docs/reference/interfaces/BoundActivities.md b/docs/reference/interfaces/BoundActivities.md index ade3ff5ab6..ef50007532 100644 --- a/docs/reference/interfaces/BoundActivities.md +++ b/docs/reference/interfaces/BoundActivities.md @@ -3,7 +3,7 @@ id: BoundActivities title: BoundActivities --- -Defined in: packages/ai/src/activities/chat/agents/bound.ts:164 +Defined in: [packages/ai/src/activities/chat/agents/bound.ts:197](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/bound.ts#L197) Activity functions bound to one child run. Each takes the same options as the plain function, but `threadId` is optional: the child run fills it. @@ -17,7 +17,7 @@ Options you pass win over the bound defaults. chat: (options) => TextActivityResult; ``` -Defined in: packages/ai/src/activities/chat/agents/bound.ts:165 +Defined in: [packages/ai/src/activities/chat/agents/bound.ts:198](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/bound.ts#L198) #### Type Parameters @@ -79,7 +79,7 @@ Defined in: packages/ai/src/activities/chat/agents/bound.ts:165 decide: (options) => Promise<{ [K in string | number | symbol]: InferEvaluateAnswer } & object>; ``` -Defined in: packages/ai/src/activities/chat/agents/bound.ts:259 +Defined in: [packages/ai/src/activities/chat/agents/bound.ts:292](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/bound.ts#L292) Ask typed questions about `state` and get answers your code can branch on. @@ -90,6 +90,10 @@ branch on `result.queue.value` in ordinary TypeScript. The question key `meta` is reserved. Throws if `questions` is empty or uses that key. +When the adapter throws an `EvaluateError` that carries `usage`, `decide()` +reports that usage through `onUsage` and the `evaluate:usage` event, then +runs `onError` and rethrows the same error. + #### Type Parameters ##### TAdapter @@ -153,7 +157,7 @@ result.meta.usage embed: (options) => Promise; ``` -Defined in: packages/ai/src/activities/chat/agents/bound.ts:257 +Defined in: [packages/ai/src/activities/chat/agents/bound.ts:290](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/bound.ts#L290) Embed activity - generates embedding vectors from text and image inputs. @@ -229,7 +233,7 @@ const result = await embed({ generateAudio: (options) => AudioActivityResult; ``` -Defined in: packages/ai/src/activities/chat/agents/bound.ts:212 +Defined in: [packages/ai/src/activities/chat/agents/bound.ts:245](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/bound.ts#L245) #### Type Parameters @@ -259,7 +263,7 @@ Defined in: packages/ai/src/activities/chat/agents/bound.ts:212 generateImage: (options) => ImageActivityResult; ``` -Defined in: packages/ai/src/activities/chat/agents/bound.ts:200 +Defined in: [packages/ai/src/activities/chat/agents/bound.ts:233](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/bound.ts#L233) #### Type Parameters @@ -289,7 +293,7 @@ Defined in: packages/ai/src/activities/chat/agents/bound.ts:200 generateLiveVideo: (options) => LiveVideoActivityResult; ``` -Defined in: packages/ai/src/activities/chat/agents/bound.ts:248 +Defined in: [packages/ai/src/activities/chat/agents/bound.ts:281](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/bound.ts#L281) #### Type Parameters @@ -319,7 +323,7 @@ Defined in: packages/ai/src/activities/chat/agents/bound.ts:248 generateSpeech: (options) => TTSActivityResult; ``` -Defined in: packages/ai/src/activities/chat/agents/bound.ts:218 +Defined in: [packages/ai/src/activities/chat/agents/bound.ts:251](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/bound.ts#L251) #### Type Parameters @@ -349,7 +353,7 @@ Defined in: packages/ai/src/activities/chat/agents/bound.ts:218 generateTranscription: (options) => TranscriptionActivityResult; ``` -Defined in: packages/ai/src/activities/chat/agents/bound.ts:231 +Defined in: [packages/ai/src/activities/chat/agents/bound.ts:264](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/bound.ts#L264) #### Type Parameters @@ -379,7 +383,7 @@ Defined in: packages/ai/src/activities/chat/agents/bound.ts:231 generateVideo: (options) => TStream extends true ? AsyncIterable : Promise; ``` -Defined in: packages/ai/src/activities/chat/agents/bound.ts:206 +Defined in: [packages/ai/src/activities/chat/agents/bound.ts:239](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/bound.ts#L239) #### Type Parameters @@ -409,7 +413,7 @@ Defined in: packages/ai/src/activities/chat/agents/bound.ts:206 generateVoice: (options) => VoiceActivityResult; ``` -Defined in: packages/ai/src/activities/chat/agents/bound.ts:225 +Defined in: [packages/ai/src/activities/chat/agents/bound.ts:258](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/bound.ts#L258) #### Type Parameters @@ -439,7 +443,7 @@ Defined in: packages/ai/src/activities/chat/agents/bound.ts:225 generateWorld: (options) => WorldActivityResult; ``` -Defined in: packages/ai/src/activities/chat/agents/bound.ts:242 +Defined in: [packages/ai/src/activities/chat/agents/bound.ts:275](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/bound.ts#L275) #### Type Parameters @@ -469,7 +473,7 @@ Defined in: packages/ai/src/activities/chat/agents/bound.ts:242 rerank: (options) => Promise>; ``` -Defined in: packages/ai/src/activities/chat/agents/bound.ts:258 +Defined in: [packages/ai/src/activities/chat/agents/bound.ts:291](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/bound.ts#L291) Rerank activity - reorders documents by relevance to a query. @@ -535,7 +539,7 @@ console.log(ranking[0].document.id) summarize: (options) => SummarizeActivityResult; ``` -Defined in: packages/ai/src/activities/chat/agents/bound.ts:194 +Defined in: [packages/ai/src/activities/chat/agents/bound.ts:227](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/bound.ts#L227) #### Type Parameters diff --git a/docs/reference/interfaces/CapabilityContext.md b/docs/reference/interfaces/CapabilityContext.md index c2470f01f8..9c271bd8c1 100644 --- a/docs/reference/interfaces/CapabilityContext.md +++ b/docs/reference/interfaces/CapabilityContext.md @@ -3,7 +3,7 @@ id: CapabilityContext title: CapabilityContext --- -Defined in: packages/ai/src/activities/chat/middleware/capabilities.ts:12 +Defined in: [packages/ai/src/activities/chat/middleware/capabilities.ts:12](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/capabilities.ts#L12) The minimal context shape a capability accessor needs. The full `ChatMiddlewareContext` satisfies this (it has `capabilities`), so accessors @@ -17,4 +17,4 @@ accept any middleware context without referencing `any`. capabilities: CapabilityRegistry; ``` -Defined in: packages/ai/src/activities/chat/middleware/capabilities.ts:13 +Defined in: [packages/ai/src/activities/chat/middleware/capabilities.ts:13](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/capabilities.ts#L13) diff --git a/docs/reference/interfaces/CapabilityGetter.md b/docs/reference/interfaces/CapabilityGetter.md index db7ba2dff7..9e2773a3b2 100644 --- a/docs/reference/interfaces/CapabilityGetter.md +++ b/docs/reference/interfaces/CapabilityGetter.md @@ -3,7 +3,7 @@ id: CapabilityGetter title: CapabilityGetter --- -Defined in: packages/ai/src/activities/chat/middleware/capabilities.ts:17 +Defined in: [packages/ai/src/activities/chat/middleware/capabilities.ts:17](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/capabilities.ts#L17) Reads a capability value off a context. Overloaded so the flag narrows the return. @@ -19,7 +19,7 @@ Reads a capability value off a context. Overloaded so the flag narrows the retur CapabilityGetter(ctx): TValue; ``` -Defined in: packages/ai/src/activities/chat/middleware/capabilities.ts:18 +Defined in: [packages/ai/src/activities/chat/middleware/capabilities.ts:18](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/capabilities.ts#L18) Reads a capability value off a context. Overloaded so the flag narrows the return. @@ -39,7 +39,7 @@ Reads a capability value off a context. Overloaded so the flag narrows the retur CapabilityGetter(ctx, opts): TValue | undefined; ``` -Defined in: packages/ai/src/activities/chat/middleware/capabilities.ts:19 +Defined in: [packages/ai/src/activities/chat/middleware/capabilities.ts:19](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/capabilities.ts#L19) Reads a capability value off a context. Overloaded so the flag narrows the return. diff --git a/docs/reference/interfaces/CatalogVoice.md b/docs/reference/interfaces/CatalogVoice.md index 783d84955b..74b50c8c2b 100644 --- a/docs/reference/interfaces/CatalogVoice.md +++ b/docs/reference/interfaces/CatalogVoice.md @@ -3,7 +3,7 @@ id: CatalogVoice title: CatalogVoice --- -Defined in: packages/ai/src/types.ts:2971 +Defined in: [packages/ai/src/types.ts:3019](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3019) One voice from a provider's catalog. @@ -15,7 +15,7 @@ One voice from a provider's catalog. optional description?: string; ``` -Defined in: packages/ai/src/types.ts:2979 +Defined in: [packages/ai/src/types.ts:3027](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3027) Provider description of the voice @@ -27,7 +27,7 @@ Provider description of the voice optional labels?: Record; ``` -Defined in: packages/ai/src/types.ts:2983 +Defined in: [packages/ai/src/types.ts:3031](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3031) Provider labels, such as accent, age, or use case @@ -39,7 +39,7 @@ Provider labels, such as accent, age, or use case optional name?: string; ``` -Defined in: packages/ai/src/types.ts:2975 +Defined in: [packages/ai/src/types.ts:3023](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3023) Display name, when the provider stores one @@ -51,7 +51,7 @@ Display name, when the provider stores one optional origin?: VoiceOrigin; ``` -Defined in: packages/ai/src/types.ts:2977 +Defined in: [packages/ai/src/types.ts:3025](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3025) Where the voice came from @@ -63,7 +63,7 @@ Where the voice came from optional previewUrl?: string; ``` -Defined in: packages/ai/src/types.ts:2981 +Defined in: [packages/ai/src/types.ts:3029](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3029) URL of a sample, when the provider hosts one @@ -75,6 +75,6 @@ URL of a sample, when the provider hosts one voiceId: string; ``` -Defined in: packages/ai/src/types.ts:2973 +Defined in: [packages/ai/src/types.ts:3021](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3021) Pass this to `generateSpeech()` as `voice` diff --git a/docs/reference/interfaces/ChatMCPOptions.md b/docs/reference/interfaces/ChatMCPOptions.md index 0b6757c337..5e1138bb61 100644 --- a/docs/reference/interfaces/ChatMCPOptions.md +++ b/docs/reference/interfaces/ChatMCPOptions.md @@ -3,7 +3,7 @@ id: ChatMCPOptions title: ChatMCPOptions --- -Defined in: packages/ai/src/activities/chat/mcp/types.ts:55 +Defined in: [packages/ai/src/activities/chat/mcp/types.ts:55](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/mcp/types.ts#L55) Options controlling MCP tool discovery and lifecycle for a `chat()` call. @@ -15,7 +15,7 @@ Options controlling MCP tool discovery and lifecycle for a `chat()` call. clients: MCPToolSource[]; ``` -Defined in: packages/ai/src/activities/chat/mcp/types.ts:59 +Defined in: [packages/ai/src/activities/chat/mcp/types.ts:59](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/mcp/types.ts#L59) The MCP clients or client pools to discover tools from and manage. @@ -27,7 +27,7 @@ The MCP clients or client pools to discover tools from and manage. optional connection?: MCPConnectionPolicy; ``` -Defined in: packages/ai/src/activities/chat/mcp/types.ts:66 +Defined in: [packages/ai/src/activities/chat/mcp/types.ts:66](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/mcp/types.ts#L66) Connection lifecycle policy applied to all clients when the run ends. @@ -41,7 +41,7 @@ Defaults to `'close'`. optional lazyTools?: boolean; ``` -Defined in: packages/ai/src/activities/chat/mcp/types.ts:74 +Defined in: [packages/ai/src/activities/chat/mcp/types.ts:74](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/mcp/types.ts#L74) When `true`, tool schemas are fetched lazily (forwarded to `tools({ lazy: true })`). @@ -56,7 +56,7 @@ Defaults to `false`. optional onDiscoveryError?: (error, source) => void | Promise; ``` -Defined in: packages/ai/src/activities/chat/mcp/types.ts:85 +Defined in: [packages/ai/src/activities/chat/mcp/types.ts:85](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/mcp/types.ts#L85) Called when tool discovery fails for a single source. diff --git a/docs/reference/interfaces/ChatMiddleware.md b/docs/reference/interfaces/ChatMiddleware.md index d2435e2afe..471a4396ba 100644 --- a/docs/reference/interfaces/ChatMiddleware.md +++ b/docs/reference/interfaces/ChatMiddleware.md @@ -3,7 +3,7 @@ id: ChatMiddleware title: ChatMiddleware --- -Defined in: packages/ai/src/activities/chat/middleware/types.ts:676 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:706](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L706) Chat middleware interface. @@ -59,7 +59,7 @@ const redactionMiddleware: ChatMiddleware = { optional name?: string; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:681 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:711](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L711) Optional name for debugging and identification @@ -71,7 +71,7 @@ Optional name for debugging and identification optional onAbort?: (ctx, info) => void | Promise; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:900 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:948](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L948) Called when the chat run is aborted. Exactly one of onFinish/onAbort/onError will be called per run. @@ -100,7 +100,7 @@ optional onAfterToolCall?: (ctx, info) => | Promise; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:864 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:912](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L912) Called after a tool execution completes (success or failure). Return `{ type: 'replaceResult', result }` to change the result that the @@ -136,7 +136,7 @@ optional onBeforeToolCall?: (ctx, hookCtx) => | Promise; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:849 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:879](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L879) Called before a server tool runs and before a client tool is sent to the client. Not called while the call waits for approval. @@ -171,7 +171,7 @@ optional onChunk?: (ctx, chunk) => | null; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:833 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:863](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L863) Called for every chunk yielded by chat(). Can observe, transform, expand, or drop chunks. @@ -211,7 +211,7 @@ optional onConfig?: (ctx, config) => | null; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:745 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:775](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L775) Called to observe or transform the chat configuration. Called at init and at the beginning of each agent iteration. @@ -247,7 +247,7 @@ Only the fields you return are overwritten — everything else is preserved. optional onError?: (ctx, info) => void | Promise; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:909 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:957](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L957) Called when the chat run encounters an unhandled error. Exactly one of onFinish/onAbort/onError will be called per run. @@ -274,7 +274,7 @@ Exactly one of onFinish/onAbort/onError will be called per run. optional onFinish?: (ctx, info) => void | Promise; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:891 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:939](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L939) Called when the chat run completes normally. Exactly one of onFinish/onAbort/onError will be called per run. @@ -295,6 +295,45 @@ Exactly one of onFinish/onAbort/onError will be called per run. *** +### onGuardToolCall? + +```ts +optional onGuardToolCall?: (ctx, hookCtx) => + | GuardToolCallDecision +| Promise; +``` + +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:897](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L897) + +The guard tier. Called for every tool call, just before a server tool +runs and before a client tool is sent to the client. Not called while +the call waits for approval. + +It runs after all `onBeforeToolCall` hooks and after the `inputSchema` +check, so `hookCtx.args` holds the final checked args that the tool gets. +It also runs for calls that `onBeforeToolCall` let through unchanged. + +It is not first-win. The guard of each middleware runs in order, until +one returns a decision. Use it for checks that must not be skipped, such +as permissions. + +#### Parameters + +##### ctx + +[`ChatMiddlewareContext`](ChatMiddlewareContext.md)\<`TContext`\> + +##### hookCtx + +[`ToolCallHookContext`](ToolCallHookContext.md) + +#### Returns + + \| [`GuardToolCallDecision`](../type-aliases/GuardToolCallDecision.md) + \| `Promise`\<[`GuardToolCallDecision`](../type-aliases/GuardToolCallDecision.md)\> + +*** + ### onInterruptBoundary? ```ts @@ -303,7 +342,7 @@ optional onInterruptBoundary?: (ctx) => | Promise>; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:693 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:723](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L723) Called at a lifecycle boundary. Return interrupt requests to pause the run. Requests from every middleware in the same boundary form one batch. @@ -329,7 +368,7 @@ optional onInterruptResolution?: (ctx, resolutions) => | Promise; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:703 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:733](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L733) Called on a continuation run after the client answers registered interrupts. Return `toolResume` to decide whether pending tools continue, cancel, or stop. @@ -357,7 +396,7 @@ Return `toolResume` to decide whether pending tools continue, cancel, or stop. optional onIteration?: (ctx, info) => void | Promise; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:787 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:817](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L817) Called at the start of each agent loop iteration, after a new assistant message ID is created. Use this to observe iteration boundaries. @@ -384,7 +423,7 @@ is created. Use this to observe iteration boundaries. optional onModelError?: (ctx, error) => void | Promise; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:822 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:852](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L852) Called when the adapter sends a `RUN_ERROR` before any output of the model call. The error does not reach `onChunk` or the caller yet. An @@ -418,7 +457,7 @@ way. The structured-output call is not retried. optional onShouldContinue?: (ctx, state) => boolean | void | Promise; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:806 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:836](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L836) Called when the engine is deciding whether to start another agent-loop iteration (after a tool phase or between model turns). @@ -455,7 +494,7 @@ Receives the same [AgentLoopState](AgentLoopState.md) passed to strategies optional onStart?: (ctx) => void | Promise; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:781 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:811](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L811) Called when the chat run starts (after initial onConfig). @@ -484,7 +523,7 @@ optional onStructuredOutputConfig?: (ctx, config) => | null; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:769 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:799](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L799) Called at the start of the final structured-output call (when the chat was invoked with outputSchema). Pipes through middleware in order, like @@ -528,7 +567,7 @@ outputSchema or apply structured-output-specific behavior. optional onToolPhaseComplete?: (ctx, info) => void | Promise; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:873 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:921](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L921) Called after all tool calls in an iteration have been processed. Provides aggregate data about tool execution results, approvals, and client tools. @@ -555,7 +594,7 @@ Provides aggregate data about tool execution results, approvals, and client tool optional onUsage?: (ctx, usage) => void | Promise; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:882 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:930](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L930) Called when usage data is available from a RUN_FINISHED chunk. Called once per model iteration that reports usage. @@ -582,7 +621,7 @@ Called once per model iteration that reports usage. optional optionalRequires?: readonly CapabilityHandle[]; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:728 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:758](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L758) Capabilities this middleware uses if present but does not require. Non-gating: never causes a validation error. Read with @@ -596,7 +635,7 @@ Non-gating: never causes a validation error. Read with optional provides?: readonly CapabilityHandle[]; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:721 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:751](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L751) Capabilities this middleware provides. Each declared capability MUST be provided (via its `provide` accessor) inside `setup`, or `chat()` throws @@ -610,7 +649,7 @@ after the setup phase. optional requires?: readonly CapabilityHandle[]; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:714 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:744](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L744) Capabilities this middleware requires. `chat()` validates that some middleware (or the adapter) provides each one; unsatisfied requirements are @@ -625,7 +664,7 @@ the adapter runs. optional routedSubagentPersistence?: RoutedSubagentPersistence; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:687 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:717](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L717) Present when this middleware stores subagent runs. The router calls it. An app does not set it. @@ -638,7 +677,7 @@ The router calls it. An app does not set it. optional sandbox?: ChatSandboxHooks; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:918 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:966](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L966) Sandbox file-event hooks. Fire when a sandbox provided by `withSandbox` is active during the run and a file is created/changed/deleted. Server-side. @@ -651,7 +690,7 @@ active during the run and a file is created/changed/deleted. Server-side. optional setup?: (ctx) => void | Promise; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:736 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:766](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L766) Provisioning hook. Runs FIRST — before `onConfig` (init) — across all middleware in array order. Use it to call `provide` accessors so later diff --git a/docs/reference/interfaces/ChatMiddlewareConfig.md b/docs/reference/interfaces/ChatMiddlewareConfig.md index f968913620..a4e49a59ac 100644 --- a/docs/reference/interfaces/ChatMiddlewareConfig.md +++ b/docs/reference/interfaces/ChatMiddlewareConfig.md @@ -3,7 +3,7 @@ id: ChatMiddlewareConfig title: ChatMiddlewareConfig --- -Defined in: packages/ai/src/activities/chat/middleware/types.ts:340 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:354](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L354) Chat configuration that middleware can observe or transform. This is a subset of the chat engine's effective configuration @@ -17,7 +17,7 @@ that middleware is allowed to modify. optional activities?: ActivityRecord[]; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:347 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:361](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L361) Frontend-only AG-UI activity sidecar. Persistence loads and saves this when an ActivityStore is configured. Never model input. @@ -33,7 +33,7 @@ messages: ModelMessage< | null>[]; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:342 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:356](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L356) Canonical conversation history. Middleware and persistence read this. @@ -45,7 +45,7 @@ Canonical conversation history. Middleware and persistence read this. optional metadata?: Record; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:354 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:368](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L368) *** @@ -55,7 +55,7 @@ Defined in: packages/ai/src/activities/chat/middleware/types.ts:354 optional modelOptions?: Record; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:355 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:369](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L369) *** @@ -65,7 +65,7 @@ Defined in: packages/ai/src/activities/chat/middleware/types.ts:355 optional promptCache?: ResolvedPromptCache; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:368 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:382](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L382) The prompt cache of the next model call. A returned value stays until a middleware changes it. @@ -81,7 +81,7 @@ optional providerMessages?: ModelMessage< | null>[]; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:349 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:363](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L363) Provider-only context. Defaults to `messages` when it is not set. @@ -93,7 +93,7 @@ Provider-only context. Defaults to `messages` when it is not set. optional reasoning?: ReasoningRequest; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:357 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:371](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L371) How hard the model thinks at this call. A middleware can set or change it. @@ -105,7 +105,7 @@ How hard the model thinks at this call. A middleware can set or change it. optional resume?: RunAgentResumeItem[]; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:352 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:366](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L366) *** @@ -115,7 +115,7 @@ Defined in: packages/ai/src/activities/chat/middleware/types.ts:352 optional resumeToolState?: ChatResumeToolState; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:353 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:367](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L367) *** @@ -125,7 +125,7 @@ Defined in: packages/ai/src/activities/chat/middleware/types.ts:353 systemPrompts: SystemPrompt[]; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:350 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:364](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L364) *** @@ -135,7 +135,7 @@ Defined in: packages/ai/src/activities/chat/middleware/types.ts:350 optional toolChoice?: ToolChoice; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:363 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:377](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L377) How the model uses the tools of the next model call. A returned value applies to that call only. The next call starts again from the `chat()` @@ -149,7 +149,7 @@ option. A call with no tools sends no tool choice. tools: Tool[]; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:351 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:365](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L365) *** @@ -159,7 +159,7 @@ Defined in: packages/ai/src/activities/chat/middleware/types.ts:351 optional wrapFetch?: FetchWrapper; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:374 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:388](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L388) Wraps the fetch of the next model call. A returned wrapper chains inside the wrappers before it, so it does not replace them. It applies to that diff --git a/docs/reference/interfaces/ChatMiddlewareContext.md b/docs/reference/interfaces/ChatMiddlewareContext.md index 55e3e77712..2862665277 100644 --- a/docs/reference/interfaces/ChatMiddlewareContext.md +++ b/docs/reference/interfaces/ChatMiddlewareContext.md @@ -3,7 +3,7 @@ id: ChatMiddlewareContext title: ChatMiddlewareContext --- -Defined in: packages/ai/src/activities/chat/middleware/types.ts:193 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:194](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L194) Stable context object passed to all middleware hooks. Created once per chat() invocation and shared across all hooks. @@ -22,7 +22,7 @@ Created once per chat() invocation and shared across all hooks. abort: (reason?) => void; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:226 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:240](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L240) Abort the chat run with a reason @@ -44,7 +44,7 @@ Abort the chat run with a reason accumulatedContent: string; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:293 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:307](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L307) Accumulated text content for the current iteration @@ -56,7 +56,7 @@ Accumulated text content for the current iteration optional activities?: readonly ActivityRecord[]; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:304 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:318](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L318) Frontend-only AG-UI activity sidecar. Never model input. Persistence writes this when an ActivityStore is configured. Optional so code that @@ -70,7 +70,7 @@ builds its own context keeps working; the engine always sets it. activity: "chat"; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:260 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:274](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L274) Which activity this context describes — always `'chat'`. Present so the chat context structurally satisfies the base `GenerationMiddlewareContext`, @@ -79,13 +79,27 @@ letting an observe-only middleware authored against the base (e.g. *** +### callMetadata + +```ts +callMetadata: Readonly; +``` + +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:236](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L236) + +The `metadata.tanstack` of the current model call: source, stop reason, +response id, and so on. It changes as chunks arrive. Each assistant +message of the call gets a copy of it. + +*** + ### capabilities ```ts capabilities: CapabilityRegistry; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:313 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:327](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L327) Capability bookkeeping for this request. Populated by middleware `setup` hooks (via `provide` accessors) and read by later middleware (via `get` @@ -94,13 +108,28 @@ this directly. Orthogonal to `context` (the user runtime context). *** +### childResumeIds? + +```ts +optional childResumeIds?: ReadonlySet; +``` + +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:218](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L218) + +Interrupt ids in `resume` that a subagent tool call of this run answers. +This run does not answer them itself. They come from the subagent cards in +the messages the client sent. `undefined` when no child is resumed, and +for a router turn. + +*** + ### chunkIndex ```ts chunkIndex: number; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:222 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:230](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L230) Running count of chunks yielded so far @@ -112,7 +141,7 @@ Running count of chunks yielded so far context: TContext; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:244 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:258](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L258) Runtime context provided by chat() options @@ -124,7 +153,7 @@ Runtime context provided by chat() options createId: (prefix) => string; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:306 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:320](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L320) Generate a unique ID with the given prefix @@ -146,7 +175,7 @@ Generate a unique ID with the given prefix currentMessageId: string | null; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:291 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:305](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L305) Current assistant message ID (changes per iteration) @@ -158,7 +187,7 @@ Current assistant message ID (changes per iteration) defer: (promise) => void; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:250 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:264](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L264) Defer a non-blocking side-effect promise. Deferred promises do not block streaming and are awaited @@ -182,7 +211,7 @@ after the terminal hook (onFinish/onAbort/onError). emitCustomEvent: (name, value, options?) => void; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:238 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:252](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L252) Push a `CUSTOM` chunk onto the chat stream immediately. The engine yields it as soon as it can (including while `onConfig` @@ -215,7 +244,7 @@ flushes the event on its own, unless you pass `{ batch: true }`. get: (capability) => TValue; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:318 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:332](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L332) Read a provided capability by its handle. Equivalent to the handle's own `get` accessor (`getX(ctx)`); throws if the capability was never provided. @@ -244,7 +273,7 @@ Read a provided capability by its handle. Equivalent to the handle's own getOptional: (capability) => TValue | undefined; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:323 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:337](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L337) Read a capability by its handle, returning `undefined` if it was never provided (never throws). @@ -273,7 +302,7 @@ provided (never throws). hasTools: boolean; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:286 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:300](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L300) Whether tools are configured @@ -285,7 +314,7 @@ Whether tools are configured iteration: number; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:220 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:228](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L228) Current agent loop iteration (0-indexed) @@ -297,7 +326,7 @@ Current agent loop iteration (0-indexed) messageCount: number; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:284 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:298](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L298) Number of messages at the start of the request @@ -312,7 +341,7 @@ messages: readonly ModelMessage< | null>[]; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:298 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:312](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L312) Current messages array (read-only view) @@ -324,7 +353,7 @@ Current messages array (read-only view) model: string; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:264 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:278](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L278) Model identifier (e.g., 'gpt-5.5') @@ -336,7 +365,7 @@ Model identifier (e.g., 'gpt-5.5') optional modelOptions?: Record; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:279 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:293](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L293) Provider-specific model options @@ -348,7 +377,7 @@ Provider-specific model options optional options?: Record; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:277 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:291](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L291) Flattened generation options (metadata) @@ -360,7 +389,7 @@ Flattened generation options (metadata) optional parentRunId?: string; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:201 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:202](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L202) Interrupted or parent run correlated with this continuation. @@ -372,7 +401,7 @@ Interrupted or parent run correlated with this continuation. optional parentSubagentRunId?: string; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:210 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:211](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L211) The subagentRunId of the child that started this one, for a nested child. @@ -384,7 +413,7 @@ The subagentRunId of the child that started this one, for a nested child. phase: ChatMiddlewarePhase; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:218 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:226](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L226) Current lifecycle phase @@ -396,7 +425,7 @@ Current lifecycle phase provide: (capability, value) => void; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:328 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:342](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L342) Provide a capability value. Equivalent to the handle's own `provide` accessor (`provideX(ctx, value)`). Typically called from `setup`. @@ -429,7 +458,7 @@ accessor (`provideX(ctx, value)`). Typically called from `setup`. provider: string; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:262 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:276](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L276) Provider name (e.g., 'openai', 'anthropic') @@ -441,7 +470,7 @@ Provider name (e.g., 'openai', 'anthropic') requestId: string; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:195 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:196](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L196) Unique identifier for this chat request @@ -453,7 +482,7 @@ Unique identifier for this chat request retry: () => void; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:231 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:245](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L245) Call the model again. Works only in `onModelError`, and throws in any other hook. `onConfig` runs again before the new call. @@ -470,7 +499,7 @@ other hook. `onConfig` runs again before the new call. runId: string; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:199 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:200](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L200) AG-UI run identifier for correlating client and server events @@ -482,7 +511,7 @@ AG-UI run identifier for correlating client and server events optional signal?: AbortSignal; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:224 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:238](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L238) Abort signal from the chat request @@ -494,7 +523,7 @@ Abort signal from the chat request source: "server" | "client"; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:266 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:280](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L280) Source of the chat invocation — always 'server' for server-side chat @@ -506,7 +535,7 @@ Source of the chat invocation — always 'server' for server-side chat streamId: string; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:197 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:198](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L198) Unique identifier for this stream @@ -518,7 +547,7 @@ Unique identifier for this stream streaming: boolean; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:268 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:282](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L282) Whether the chat is streaming @@ -530,7 +559,7 @@ Whether the chat is streaming optional subagentName?: string; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:208 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:209](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L209) The agent name when this run is a subagent. @@ -542,7 +571,7 @@ The agent name when this run is a subagent. optional subagentRunId?: string; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:206 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:207](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L207) Set when this run is a subagent. The id on the child's `SUBAGENT_STARTED` and on every chunk it streams. Absent on a top-level run. @@ -555,7 +584,7 @@ and on every chunk it streams. Absent on a top-level run. systemPrompts: SystemPrompt[]; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:273 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:287](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L287) System prompts configured for this chat @@ -567,7 +596,7 @@ System prompts configured for this chat threadId: string; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:216 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:224](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L224) AG-UI thread identifier — a stable per-conversation ID used to correlate client and server devtools events. It is the caller's @@ -581,6 +610,6 @@ correlate client and server devtools events. It is the caller's optional toolNames?: string[]; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:275 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:289](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L289) Names of configured tools, if any diff --git a/docs/reference/interfaces/ChatResult.md b/docs/reference/interfaces/ChatResult.md index c87fdc9979..ae8a306f71 100644 --- a/docs/reference/interfaces/ChatResult.md +++ b/docs/reference/interfaces/ChatResult.md @@ -3,7 +3,7 @@ id: ChatResult title: ChatResult --- -Defined in: packages/ai/src/stream-to-response.ts:33 +Defined in: [packages/ai/src/stream-to-response.ts:33](https://github.com/TanStack/ai/blob/main/packages/ai/src/stream-to-response.ts#L33) The result of a run that was read to the end, such as `chat({ stream: false })`. @@ -15,7 +15,7 @@ The result of a run that was read to the end, such as `chat({ stream: false })`. chunks: AGUIEvent[]; ``` -Defined in: packages/ai/src/stream-to-response.ts:37 +Defined in: [packages/ai/src/stream-to-response.ts:37](https://github.com/TanStack/ai/blob/main/packages/ai/src/stream-to-response.ts#L37) Every chunk the run produced, in order. @@ -27,6 +27,6 @@ Every chunk the run produced, in order. text: string; ``` -Defined in: packages/ai/src/stream-to-response.ts:35 +Defined in: [packages/ai/src/stream-to-response.ts:35](https://github.com/TanStack/ai/blob/main/packages/ai/src/stream-to-response.ts#L35) Concatenated TEXT_MESSAGE_CONTENT deltas. diff --git a/docs/reference/interfaces/ChatResumeToolState.md b/docs/reference/interfaces/ChatResumeToolState.md index 2947105fff..623f16197e 100644 --- a/docs/reference/interfaces/ChatResumeToolState.md +++ b/docs/reference/interfaces/ChatResumeToolState.md @@ -3,7 +3,7 @@ id: ChatResumeToolState title: ChatResumeToolState --- -Defined in: packages/ai/src/activities/chat/middleware/types.ts:382 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:396](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L396) Tool decisions reconstructed by server-side middleware from validated resume entries. This lets empty-message interrupt resumes continue tool execution @@ -17,7 +17,7 @@ without relying on client message history. optional approvals?: ReadonlyMap; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:383 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:397](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L397) *** @@ -27,7 +27,7 @@ Defined in: packages/ai/src/activities/chat/middleware/types.ts:383 optional cancelledToolCallIds?: ReadonlySet; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:397 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:411](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L411) *** @@ -37,7 +37,7 @@ Defined in: packages/ai/src/activities/chat/middleware/types.ts:397 optional clientToolErrors?: ReadonlyMap; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:385 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:399](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L399) *** @@ -47,7 +47,7 @@ Defined in: packages/ai/src/activities/chat/middleware/types.ts:385 optional clientToolResults?: ReadonlyMap; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:384 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:398](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L398) *** @@ -57,7 +57,7 @@ Defined in: packages/ai/src/activities/chat/middleware/types.ts:384 optional deniedToolResults?: ReadonlyMap; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:396 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:410](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L410) *** @@ -67,7 +67,7 @@ Defined in: packages/ai/src/activities/chat/middleware/types.ts:396 optional genericInterruptRequests?: ReadonlyMap>>; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:390 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:404](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L404) Durable generic requests reconstructed by server middleware. @@ -79,4 +79,4 @@ Durable generic requests reconstructed by server middleware. optional genericInterrupts?: ReadonlyMap; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:386 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:400](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L400) diff --git a/docs/reference/interfaces/ChatSandboxHooks.md b/docs/reference/interfaces/ChatSandboxHooks.md index 707393d457..b4e1a19ee6 100644 --- a/docs/reference/interfaces/ChatSandboxHooks.md +++ b/docs/reference/interfaces/ChatSandboxHooks.md @@ -3,7 +3,7 @@ id: ChatSandboxHooks title: ChatSandboxHooks --- -Defined in: packages/ai/src/activities/chat/middleware/types.ts:61 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:62](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L62) Sandbox file-event hooks a chat middleware can declare. Fire server-side for every file create/change/delete observed in the sandbox during the run. @@ -22,7 +22,7 @@ every file create/change/delete observed in the sandbox during the run. optional onFile?: (ctx, e) => void | Promise; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:62 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:63](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L63) #### Parameters @@ -46,7 +46,7 @@ Defined in: packages/ai/src/activities/chat/middleware/types.ts:62 optional onFileChange?: (ctx, e) => void | Promise; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:70 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:71](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L71) #### Parameters @@ -70,7 +70,7 @@ Defined in: packages/ai/src/activities/chat/middleware/types.ts:70 optional onFileCreate?: (ctx, e) => void | Promise; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:66 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:67](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L67) #### Parameters @@ -94,7 +94,7 @@ Defined in: packages/ai/src/activities/chat/middleware/types.ts:66 optional onFileDelete?: (ctx, e) => void | Promise; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:74 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:75](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L75) #### Parameters diff --git a/docs/reference/interfaces/ChoiceAnswer.md b/docs/reference/interfaces/ChoiceAnswer.md index 9483d84a24..8932e7c2f7 100644 --- a/docs/reference/interfaces/ChoiceAnswer.md +++ b/docs/reference/interfaces/ChoiceAnswer.md @@ -3,7 +3,7 @@ id: ChoiceAnswer title: ChoiceAnswer --- -Defined in: packages/ai/src/activities/evaluate/index.ts:64 +Defined in: [packages/ai/src/activities/evaluate/index.ts:65](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/evaluate/index.ts#L65) Public choice answer. `.value` is the selected option key. @@ -21,7 +21,7 @@ Public choice answer. `.value` is the selected option key. confidence: number; ``` -Defined in: packages/ai/src/activities/evaluate/index.ts:69 +Defined in: [packages/ai/src/activities/evaluate/index.ts:70](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/evaluate/index.ts#L70) *** @@ -31,7 +31,7 @@ Defined in: packages/ai/src/activities/evaluate/index.ts:69 probabilities: Record; ``` -Defined in: packages/ai/src/activities/evaluate/index.ts:70 +Defined in: [packages/ai/src/activities/evaluate/index.ts:71](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/evaluate/index.ts#L71) *** @@ -41,7 +41,7 @@ Defined in: packages/ai/src/activities/evaluate/index.ts:70 probability: number; ``` -Defined in: packages/ai/src/activities/evaluate/index.ts:68 +Defined in: [packages/ai/src/activities/evaluate/index.ts:69](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/evaluate/index.ts#L69) P(selected option). @@ -53,7 +53,7 @@ P(selected option). type: "choice"; ``` -Defined in: packages/ai/src/activities/evaluate/index.ts:65 +Defined in: [packages/ai/src/activities/evaluate/index.ts:66](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/evaluate/index.ts#L66) *** @@ -63,4 +63,4 @@ Defined in: packages/ai/src/activities/evaluate/index.ts:65 value: TValue; ``` -Defined in: packages/ai/src/activities/evaluate/index.ts:66 +Defined in: [packages/ai/src/activities/evaluate/index.ts:67](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/evaluate/index.ts#L67) diff --git a/docs/reference/interfaces/ChunkRecording.md b/docs/reference/interfaces/ChunkRecording.md index 513822dfed..1ee05ee4af 100644 --- a/docs/reference/interfaces/ChunkRecording.md +++ b/docs/reference/interfaces/ChunkRecording.md @@ -3,7 +3,7 @@ id: ChunkRecording title: ChunkRecording --- -Defined in: packages/ai/src/activities/chat/stream/types.ts:99 +Defined in: [packages/ai/src/activities/chat/stream/types.ts:99](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/types.ts#L99) Recording format for replay testing @@ -15,7 +15,7 @@ Recording format for replay testing chunks: object[]; ``` -Defined in: packages/ai/src/activities/chat/stream/types.ts:104 +Defined in: [packages/ai/src/activities/chat/stream/types.ts:104](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/types.ts#L104) #### chunk @@ -43,7 +43,7 @@ timestamp: number; optional model?: string; ``` -Defined in: packages/ai/src/activities/chat/stream/types.ts:102 +Defined in: [packages/ai/src/activities/chat/stream/types.ts:102](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/types.ts#L102) *** @@ -53,7 +53,7 @@ Defined in: packages/ai/src/activities/chat/stream/types.ts:102 optional provider?: string; ``` -Defined in: packages/ai/src/activities/chat/stream/types.ts:103 +Defined in: [packages/ai/src/activities/chat/stream/types.ts:103](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/types.ts#L103) *** @@ -63,7 +63,7 @@ Defined in: packages/ai/src/activities/chat/stream/types.ts:103 optional result?: ProcessorResult; ``` -Defined in: packages/ai/src/activities/chat/stream/types.ts:109 +Defined in: [packages/ai/src/activities/chat/stream/types.ts:109](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/types.ts#L109) *** @@ -73,7 +73,7 @@ Defined in: packages/ai/src/activities/chat/stream/types.ts:109 timestamp: number; ``` -Defined in: packages/ai/src/activities/chat/stream/types.ts:101 +Defined in: [packages/ai/src/activities/chat/stream/types.ts:101](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/types.ts#L101) *** @@ -83,4 +83,4 @@ Defined in: packages/ai/src/activities/chat/stream/types.ts:101 version: "1.0"; ``` -Defined in: packages/ai/src/activities/chat/stream/types.ts:100 +Defined in: [packages/ai/src/activities/chat/stream/types.ts:100](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/types.ts#L100) diff --git a/docs/reference/interfaces/ChunkStrategy.md b/docs/reference/interfaces/ChunkStrategy.md index 75ffde4927..fab29c7875 100644 --- a/docs/reference/interfaces/ChunkStrategy.md +++ b/docs/reference/interfaces/ChunkStrategy.md @@ -3,7 +3,7 @@ id: ChunkStrategy title: ChunkStrategy --- -Defined in: packages/ai/src/activities/chat/stream/types.ts:38 +Defined in: [packages/ai/src/activities/chat/stream/types.ts:38](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/types.ts#L38) Strategy for determining when to emit text updates @@ -15,7 +15,7 @@ Strategy for determining when to emit text updates optional reset?: () => void; ``` -Defined in: packages/ai/src/activities/chat/stream/types.ts:50 +Defined in: [packages/ai/src/activities/chat/stream/types.ts:50](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/types.ts#L50) Optional: Reset strategy state (called when streaming starts) @@ -31,7 +31,7 @@ Optional: Reset strategy state (called when streaming starts) shouldEmit: (chunk, accumulated) => boolean; ``` -Defined in: packages/ai/src/activities/chat/stream/types.ts:45 +Defined in: [packages/ai/src/activities/chat/stream/types.ts:45](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/types.ts#L45) Called for each text chunk received diff --git a/docs/reference/interfaces/ClientTool.md b/docs/reference/interfaces/ClientTool.md index fea5322c58..73ae66ead8 100644 --- a/docs/reference/interfaces/ClientTool.md +++ b/docs/reference/interfaces/ClientTool.md @@ -3,7 +3,7 @@ id: ClientTool title: ClientTool --- -Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:108 +Defined in: [packages/ai/src/activities/chat/tools/tool-definition.ts:108](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-definition.ts#L108) Marker type for client-side tools @@ -47,7 +47,7 @@ Marker type for client-side tools __toolSide: "client"; ``` -Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:119 +Defined in: [packages/ai/src/activities/chat/tools/tool-definition.ts:119](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-definition.ts#L119) *** @@ -57,7 +57,7 @@ Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:119 readonly optional [toolApprovalCapability]?: object; ``` -Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:26 +Defined in: [packages/ai/src/activities/chat/tools/tool-definition.ts:26](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-definition.ts#L26) #### approvalSchema @@ -85,7 +85,7 @@ ToolApprovalCapabilityMarker.[toolApprovalCapability] optional approvalSchema?: TApprovalSchema; ``` -Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:130 +Defined in: [packages/ai/src/activities/chat/tools/tool-definition.ts:130](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-definition.ts#L130) *** @@ -95,7 +95,7 @@ Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:130 description: string; ``` -Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:121 +Defined in: [packages/ai/src/activities/chat/tools/tool-definition.ts:121](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-definition.ts#L121) *** @@ -105,7 +105,7 @@ Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:121 optional execute?: ToolExecuteFunction; ``` -Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:135 +Defined in: [packages/ai/src/activities/chat/tools/tool-definition.ts:135](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-definition.ts#L135) *** @@ -115,7 +115,7 @@ Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:135 optional execution?: "task"; ``` -Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:131 +Defined in: [packages/ai/src/activities/chat/tools/tool-definition.ts:131](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-definition.ts#L131) *** @@ -125,7 +125,7 @@ Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:131 optional inputSchema?: TInput; ``` -Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:127 +Defined in: [packages/ai/src/activities/chat/tools/tool-definition.ts:127](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-definition.ts#L127) *** @@ -135,7 +135,7 @@ Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:127 optional lazy?: boolean; ``` -Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:132 +Defined in: [packages/ai/src/activities/chat/tools/tool-definition.ts:132](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-definition.ts#L132) *** @@ -145,7 +145,7 @@ Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:132 optional metadata?: Record; ``` -Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:134 +Defined in: [packages/ai/src/activities/chat/tools/tool-definition.ts:134](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-definition.ts#L134) *** @@ -155,7 +155,7 @@ Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:134 name: TName; ``` -Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:120 +Defined in: [packages/ai/src/activities/chat/tools/tool-definition.ts:120](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-definition.ts#L120) *** @@ -165,7 +165,7 @@ Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:120 optional needsApproval?: TNeedsApproval; ``` -Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:129 +Defined in: [packages/ai/src/activities/chat/tools/tool-definition.ts:129](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-definition.ts#L129) *** @@ -175,7 +175,7 @@ Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:129 optional outputSchema?: TOutput; ``` -Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:128 +Defined in: [packages/ai/src/activities/chat/tools/tool-definition.ts:128](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-definition.ts#L128) *** @@ -185,4 +185,4 @@ Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:128 optional replay?: "safe" | "never"; ``` -Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:133 +Defined in: [packages/ai/src/activities/chat/tools/tool-definition.ts:133](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-definition.ts#L133) diff --git a/docs/reference/interfaces/CodeModeConsoleEvent.md b/docs/reference/interfaces/CodeModeConsoleEvent.md index c9a083dcc2..5363e6f31b 100644 --- a/docs/reference/interfaces/CodeModeConsoleEvent.md +++ b/docs/reference/interfaces/CodeModeConsoleEvent.md @@ -3,7 +3,7 @@ id: CodeModeConsoleEvent title: CodeModeConsoleEvent --- -Defined in: packages/ai/src/types.ts:1839 +Defined in: [packages/ai/src/types.ts:1897](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1897) Custom event for extensibility. @@ -21,7 +21,7 @@ Custom event for extensibility. optional metadata?: Record; ``` -Defined in: packages/ai/src/types.ts:1756 +Defined in: [packages/ai/src/types.ts:1814](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1814) Extra information attached to this event. @@ -37,7 +37,7 @@ Extra information attached to this event. name: "code_mode:console"; ``` -Defined in: packages/ai/src/types.ts:1840 +Defined in: [packages/ai/src/types.ts:1898](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1898) What this custom event is. Required: without it a consumer cannot route the value. @@ -56,7 +56,7 @@ CustomEvent.name type: "CUSTOM"; ``` -Defined in: packages/ai/src/types.ts:1755 +Defined in: [packages/ai/src/types.ts:1813](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1813) #### Inherited from @@ -70,7 +70,7 @@ Defined in: packages/ai/src/types.ts:1755 value: object; ``` -Defined in: packages/ai/src/types.ts:1841 +Defined in: [packages/ai/src/types.ts:1899](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1899) The payload. Any JSON value, and required. diff --git a/docs/reference/interfaces/CodeModeExecutionStartedEvent.md b/docs/reference/interfaces/CodeModeExecutionStartedEvent.md index 1b6f7791ad..adfbdbfc44 100644 --- a/docs/reference/interfaces/CodeModeExecutionStartedEvent.md +++ b/docs/reference/interfaces/CodeModeExecutionStartedEvent.md @@ -3,7 +3,7 @@ id: CodeModeExecutionStartedEvent title: CodeModeExecutionStartedEvent --- -Defined in: packages/ai/src/types.ts:1835 +Defined in: [packages/ai/src/types.ts:1893](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1893) Custom event for extensibility. @@ -21,7 +21,7 @@ Custom event for extensibility. optional metadata?: Record; ``` -Defined in: packages/ai/src/types.ts:1756 +Defined in: [packages/ai/src/types.ts:1814](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1814) Extra information attached to this event. @@ -37,7 +37,7 @@ Extra information attached to this event. name: "code_mode:execution_started"; ``` -Defined in: packages/ai/src/types.ts:1836 +Defined in: [packages/ai/src/types.ts:1894](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1894) What this custom event is. Required: without it a consumer cannot route the value. @@ -56,7 +56,7 @@ CustomEvent.name type: "CUSTOM"; ``` -Defined in: packages/ai/src/types.ts:1755 +Defined in: [packages/ai/src/types.ts:1813](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1813) #### Inherited from @@ -70,7 +70,7 @@ Defined in: packages/ai/src/types.ts:1755 value: object; ``` -Defined in: packages/ai/src/types.ts:1837 +Defined in: [packages/ai/src/types.ts:1895](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1895) The payload. Any JSON value, and required. diff --git a/docs/reference/interfaces/CodeModeExternalCallEvent.md b/docs/reference/interfaces/CodeModeExternalCallEvent.md index 66a0d0c428..2a93d4089b 100644 --- a/docs/reference/interfaces/CodeModeExternalCallEvent.md +++ b/docs/reference/interfaces/CodeModeExternalCallEvent.md @@ -3,7 +3,7 @@ id: CodeModeExternalCallEvent title: CodeModeExternalCallEvent --- -Defined in: packages/ai/src/types.ts:1847 +Defined in: [packages/ai/src/types.ts:1905](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1905) Custom event for extensibility. @@ -21,7 +21,7 @@ Custom event for extensibility. optional metadata?: Record; ``` -Defined in: packages/ai/src/types.ts:1756 +Defined in: [packages/ai/src/types.ts:1814](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1814) Extra information attached to this event. @@ -37,7 +37,7 @@ Extra information attached to this event. name: "code_mode:external_call"; ``` -Defined in: packages/ai/src/types.ts:1848 +Defined in: [packages/ai/src/types.ts:1906](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1906) What this custom event is. Required: without it a consumer cannot route the value. @@ -56,7 +56,7 @@ CustomEvent.name type: "CUSTOM"; ``` -Defined in: packages/ai/src/types.ts:1755 +Defined in: [packages/ai/src/types.ts:1813](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1813) #### Inherited from @@ -70,7 +70,7 @@ Defined in: packages/ai/src/types.ts:1755 value: object; ``` -Defined in: packages/ai/src/types.ts:1849 +Defined in: [packages/ai/src/types.ts:1907](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1907) The payload. Any JSON value, and required. diff --git a/docs/reference/interfaces/CodeModeExternalErrorEvent.md b/docs/reference/interfaces/CodeModeExternalErrorEvent.md index 34e664bf2b..7b67699593 100644 --- a/docs/reference/interfaces/CodeModeExternalErrorEvent.md +++ b/docs/reference/interfaces/CodeModeExternalErrorEvent.md @@ -3,7 +3,7 @@ id: CodeModeExternalErrorEvent title: CodeModeExternalErrorEvent --- -Defined in: packages/ai/src/types.ts:1855 +Defined in: [packages/ai/src/types.ts:1913](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1913) Custom event for extensibility. @@ -21,7 +21,7 @@ Custom event for extensibility. optional metadata?: Record; ``` -Defined in: packages/ai/src/types.ts:1756 +Defined in: [packages/ai/src/types.ts:1814](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1814) Extra information attached to this event. @@ -37,7 +37,7 @@ Extra information attached to this event. name: "code_mode:external_error"; ``` -Defined in: packages/ai/src/types.ts:1856 +Defined in: [packages/ai/src/types.ts:1914](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1914) What this custom event is. Required: without it a consumer cannot route the value. @@ -56,7 +56,7 @@ CustomEvent.name type: "CUSTOM"; ``` -Defined in: packages/ai/src/types.ts:1755 +Defined in: [packages/ai/src/types.ts:1813](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1813) #### Inherited from @@ -70,7 +70,7 @@ Defined in: packages/ai/src/types.ts:1755 value: object; ``` -Defined in: packages/ai/src/types.ts:1857 +Defined in: [packages/ai/src/types.ts:1915](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1915) The payload. Any JSON value, and required. diff --git a/docs/reference/interfaces/CodeModeExternalResultEvent.md b/docs/reference/interfaces/CodeModeExternalResultEvent.md index e7d21ab328..cd29c58667 100644 --- a/docs/reference/interfaces/CodeModeExternalResultEvent.md +++ b/docs/reference/interfaces/CodeModeExternalResultEvent.md @@ -3,7 +3,7 @@ id: CodeModeExternalResultEvent title: CodeModeExternalResultEvent --- -Defined in: packages/ai/src/types.ts:1851 +Defined in: [packages/ai/src/types.ts:1909](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1909) Custom event for extensibility. @@ -21,7 +21,7 @@ Custom event for extensibility. optional metadata?: Record; ``` -Defined in: packages/ai/src/types.ts:1756 +Defined in: [packages/ai/src/types.ts:1814](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1814) Extra information attached to this event. @@ -37,7 +37,7 @@ Extra information attached to this event. name: "code_mode:external_result"; ``` -Defined in: packages/ai/src/types.ts:1852 +Defined in: [packages/ai/src/types.ts:1910](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1910) What this custom event is. Required: without it a consumer cannot route the value. @@ -56,7 +56,7 @@ CustomEvent.name type: "CUSTOM"; ``` -Defined in: packages/ai/src/types.ts:1755 +Defined in: [packages/ai/src/types.ts:1813](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1813) #### Inherited from @@ -70,7 +70,7 @@ Defined in: packages/ai/src/types.ts:1755 value: object; ``` -Defined in: packages/ai/src/types.ts:1853 +Defined in: [packages/ai/src/types.ts:1911](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1911) The payload. Any JSON value, and required. diff --git a/docs/reference/interfaces/CodeModeSnippetCallEvent.md b/docs/reference/interfaces/CodeModeSnippetCallEvent.md index d2db636359..6cd8fdf7af 100644 --- a/docs/reference/interfaces/CodeModeSnippetCallEvent.md +++ b/docs/reference/interfaces/CodeModeSnippetCallEvent.md @@ -3,7 +3,7 @@ id: CodeModeSnippetCallEvent title: CodeModeSnippetCallEvent --- -Defined in: packages/ai/src/types.ts:1859 +Defined in: [packages/ai/src/types.ts:1917](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1917) Custom event for extensibility. @@ -21,7 +21,7 @@ Custom event for extensibility. optional metadata?: Record; ``` -Defined in: packages/ai/src/types.ts:1756 +Defined in: [packages/ai/src/types.ts:1814](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1814) Extra information attached to this event. @@ -37,7 +37,7 @@ Extra information attached to this event. name: "code_mode:snippet_call"; ``` -Defined in: packages/ai/src/types.ts:1860 +Defined in: [packages/ai/src/types.ts:1918](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1918) What this custom event is. Required: without it a consumer cannot route the value. @@ -56,7 +56,7 @@ CustomEvent.name type: "CUSTOM"; ``` -Defined in: packages/ai/src/types.ts:1755 +Defined in: [packages/ai/src/types.ts:1813](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1813) #### Inherited from @@ -70,7 +70,7 @@ Defined in: packages/ai/src/types.ts:1755 value: object; ``` -Defined in: packages/ai/src/types.ts:1861 +Defined in: [packages/ai/src/types.ts:1919](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1919) The payload. Any JSON value, and required. diff --git a/docs/reference/interfaces/CodeModeSnippetErrorEvent.md b/docs/reference/interfaces/CodeModeSnippetErrorEvent.md index 3ea4df1bcb..362a079c48 100644 --- a/docs/reference/interfaces/CodeModeSnippetErrorEvent.md +++ b/docs/reference/interfaces/CodeModeSnippetErrorEvent.md @@ -3,7 +3,7 @@ id: CodeModeSnippetErrorEvent title: CodeModeSnippetErrorEvent --- -Defined in: packages/ai/src/types.ts:1872 +Defined in: [packages/ai/src/types.ts:1930](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1930) Custom event for extensibility. @@ -21,7 +21,7 @@ Custom event for extensibility. optional metadata?: Record; ``` -Defined in: packages/ai/src/types.ts:1756 +Defined in: [packages/ai/src/types.ts:1814](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1814) Extra information attached to this event. @@ -37,7 +37,7 @@ Extra information attached to this event. name: "code_mode:snippet_error"; ``` -Defined in: packages/ai/src/types.ts:1873 +Defined in: [packages/ai/src/types.ts:1931](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1931) What this custom event is. Required: without it a consumer cannot route the value. @@ -56,7 +56,7 @@ CustomEvent.name type: "CUSTOM"; ``` -Defined in: packages/ai/src/types.ts:1755 +Defined in: [packages/ai/src/types.ts:1813](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1813) #### Inherited from @@ -70,7 +70,7 @@ Defined in: packages/ai/src/types.ts:1755 value: object; ``` -Defined in: packages/ai/src/types.ts:1874 +Defined in: [packages/ai/src/types.ts:1932](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1932) The payload. Any JSON value, and required. diff --git a/docs/reference/interfaces/CodeModeSnippetResultEvent.md b/docs/reference/interfaces/CodeModeSnippetResultEvent.md index 0b1aa986d8..d2fff55752 100644 --- a/docs/reference/interfaces/CodeModeSnippetResultEvent.md +++ b/docs/reference/interfaces/CodeModeSnippetResultEvent.md @@ -3,7 +3,7 @@ id: CodeModeSnippetResultEvent title: CodeModeSnippetResultEvent --- -Defined in: packages/ai/src/types.ts:1863 +Defined in: [packages/ai/src/types.ts:1921](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1921) Custom event for extensibility. @@ -21,7 +21,7 @@ Custom event for extensibility. optional metadata?: Record; ``` -Defined in: packages/ai/src/types.ts:1756 +Defined in: [packages/ai/src/types.ts:1814](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1814) Extra information attached to this event. @@ -37,7 +37,7 @@ Extra information attached to this event. name: "code_mode:snippet_result"; ``` -Defined in: packages/ai/src/types.ts:1864 +Defined in: [packages/ai/src/types.ts:1922](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1922) What this custom event is. Required: without it a consumer cannot route the value. @@ -56,7 +56,7 @@ CustomEvent.name type: "CUSTOM"; ``` -Defined in: packages/ai/src/types.ts:1755 +Defined in: [packages/ai/src/types.ts:1813](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1813) #### Inherited from @@ -70,7 +70,7 @@ Defined in: packages/ai/src/types.ts:1755 value: object; ``` -Defined in: packages/ai/src/types.ts:1865 +Defined in: [packages/ai/src/types.ts:1923](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1923) The payload. Any JSON value, and required. diff --git a/docs/reference/interfaces/ContentPartDataSource.md b/docs/reference/interfaces/ContentPartDataSource.md index 55e39a3f73..513015497d 100644 --- a/docs/reference/interfaces/ContentPartDataSource.md +++ b/docs/reference/interfaces/ContentPartDataSource.md @@ -3,7 +3,7 @@ id: ContentPartDataSource title: ContentPartDataSource --- -Defined in: packages/ai/src/types.ts:246 +Defined in: [packages/ai/src/types.ts:249](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L249) Inline base64 content. AG-UI `DataSource`: `mimeType` is required. diff --git a/docs/reference/interfaces/ContentPartFileSource.md b/docs/reference/interfaces/ContentPartFileSource.md index 071852a299..23d4d3d598 100644 --- a/docs/reference/interfaces/ContentPartFileSource.md +++ b/docs/reference/interfaces/ContentPartFileSource.md @@ -3,7 +3,7 @@ id: ContentPartFileSource title: ContentPartFileSource --- -Defined in: packages/ai/src/types.ts:264 +Defined in: [packages/ai/src/types.ts:267](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L267) A provider-issued file handle (Files API). AG-UI `FileSource`: the handle is opaque, do not fetch or parse it. @@ -33,7 +33,7 @@ by the activity-layer preflight before mapping starts. optional provider?: TProvider; ``` -Defined in: packages/ai/src/types.ts:272 +Defined in: [packages/ai/src/types.ts:275](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L275) The adapter name of the provider that issued the handle (`'openai'`, `'gemini'`, ...), the same id TanStack reports as the usage provider. diff --git a/docs/reference/interfaces/ContentPartUrlSource.md b/docs/reference/interfaces/ContentPartUrlSource.md index 39c6c111d4..8e7105f3df 100644 --- a/docs/reference/interfaces/ContentPartUrlSource.md +++ b/docs/reference/interfaces/ContentPartUrlSource.md @@ -3,7 +3,7 @@ id: ContentPartUrlSource title: ContentPartUrlSource --- -Defined in: packages/ai/src/types.ts:251 +Defined in: [packages/ai/src/types.ts:254](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L254) URL-referenced content. AG-UI `UrlSource`: `mimeType` is optional. diff --git a/docs/reference/interfaces/CustomEvent.md b/docs/reference/interfaces/CustomEvent.md index 89da26f988..375f9f0fa7 100644 --- a/docs/reference/interfaces/CustomEvent.md +++ b/docs/reference/interfaces/CustomEvent.md @@ -3,7 +3,7 @@ id: CustomEvent title: CustomEvent --- -Defined in: packages/ai/src/types.ts:1754 +Defined in: [packages/ai/src/types.ts:1812](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1812) Custom event for extensibility. @@ -40,7 +40,7 @@ Custom event for extensibility. optional metadata?: Record; ``` -Defined in: packages/ai/src/types.ts:1756 +Defined in: [packages/ai/src/types.ts:1814](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1814) Extra information attached to this event. @@ -58,4 +58,4 @@ Omit.metadata type: "CUSTOM"; ``` -Defined in: packages/ai/src/types.ts:1755 +Defined in: [packages/ai/src/types.ts:1813](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1813) diff --git a/docs/reference/interfaces/DebugCategories.md b/docs/reference/interfaces/DebugCategories.md index 7c8eeca454..fbb6bb0419 100644 --- a/docs/reference/interfaces/DebugCategories.md +++ b/docs/reference/interfaces/DebugCategories.md @@ -3,7 +3,7 @@ id: DebugCategories title: DebugCategories --- -Defined in: packages/ai/src/logger/types.ts:30 +Defined in: [packages/ai/src/logger/types.ts:30](https://github.com/TanStack/ai/blob/main/packages/ai/src/logger/types.ts#L30) Per-category toggles for debug logging. Each flag enables or disables one class of log message. Unspecified flags default to `true` when `DebugConfig` is partially specified; `undefined` on the `debug` option defaults all flags to `false` except `errors`. @@ -19,7 +19,7 @@ Per-category toggles for debug logging. Each flag enables or disables one class optional agentLoop?: boolean; ``` -Defined in: packages/ai/src/logger/types.ts:50 +Defined in: [packages/ai/src/logger/types.ts:50](https://github.com/TanStack/ai/blob/main/packages/ai/src/logger/types.ts#L50) Iteration markers and phase transitions in the chat agent loop. Chat-only. @@ -31,7 +31,7 @@ Iteration markers and phase transitions in the chat agent loop. Chat-only. optional config?: boolean; ``` -Defined in: packages/ai/src/logger/types.ts:54 +Defined in: [packages/ai/src/logger/types.ts:54](https://github.com/TanStack/ai/blob/main/packages/ai/src/logger/types.ts#L54) Config transforms returned by middleware `onConfig` hooks. Chat-only. @@ -43,7 +43,7 @@ Config transforms returned by middleware `onConfig` hooks. Chat-only. optional errors?: boolean; ``` -Defined in: packages/ai/src/logger/types.ts:58 +Defined in: [packages/ai/src/logger/types.ts:58](https://github.com/TanStack/ai/blob/main/packages/ai/src/logger/types.ts#L58) Caught errors throughout the pipeline. Unlike other categories, defaults to `true` even when `debug` is unspecified. Explicitly set `errors: false` or `debug: false` to silence. @@ -55,7 +55,7 @@ Caught errors throughout the pipeline. Unlike other categories, defaults to `tru optional middleware?: boolean; ``` -Defined in: packages/ai/src/logger/types.ts:42 +Defined in: [packages/ai/src/logger/types.ts:42](https://github.com/TanStack/ai/blob/main/packages/ai/src/logger/types.ts#L42) Inputs and outputs around each middleware hook invocation. Chat-only. @@ -67,7 +67,7 @@ Inputs and outputs around each middleware hook invocation. Chat-only. optional output?: boolean; ``` -Defined in: packages/ai/src/logger/types.ts:38 +Defined in: [packages/ai/src/logger/types.ts:38](https://github.com/TanStack/ai/blob/main/packages/ai/src/logger/types.ts#L38) Chunks/results yielded to the consumer after all middleware. For streaming activities this fires per chunk; for non-streaming activities it fires once per result. @@ -79,7 +79,7 @@ Chunks/results yielded to the consumer after all middleware. For streaming activ optional provider?: boolean; ``` -Defined in: packages/ai/src/logger/types.ts:34 +Defined in: [packages/ai/src/logger/types.ts:34](https://github.com/TanStack/ai/blob/main/packages/ai/src/logger/types.ts#L34) Raw chunks/frames received from a provider SDK (OpenAI, Anthropic, Gemini, Ollama, Grok, Groq, OpenRouter, fal, ElevenLabs, BytePlus). Emitted inside every streaming adapter's chunk loop. @@ -91,7 +91,7 @@ Raw chunks/frames received from a provider SDK (OpenAI, Anthropic, Gemini, Ollam optional request?: boolean; ``` -Defined in: packages/ai/src/logger/types.ts:62 +Defined in: [packages/ai/src/logger/types.ts:62](https://github.com/TanStack/ai/blob/main/packages/ai/src/logger/types.ts#L62) Outgoing call metadata (provider, model, message/tool counts) emitted before each adapter SDK call. @@ -103,7 +103,7 @@ Outgoing call metadata (provider, model, message/tool counts) emitted before eac optional sandbox?: boolean; ``` -Defined in: packages/ai/src/logger/types.ts:67 +Defined in: [packages/ai/src/logger/types.ts:67](https://github.com/TanStack/ai/blob/main/packages/ai/src/logger/types.ts#L67) Sandbox internals: watcher start/stop + mechanism, file events, sandbox hook dispatch, ensure/bootstrap and lifecycle transitions. Chat-only. @@ -116,6 +116,6 @@ hook dispatch, ensure/bootstrap and lifecycle transitions. Chat-only. optional tools?: boolean; ``` -Defined in: packages/ai/src/logger/types.ts:46 +Defined in: [packages/ai/src/logger/types.ts:46](https://github.com/TanStack/ai/blob/main/packages/ai/src/logger/types.ts#L46) Before/after tool-call execution in the chat agent loop. Chat-only. diff --git a/docs/reference/interfaces/DebugConfig.md b/docs/reference/interfaces/DebugConfig.md index c15bed2306..6666e2595a 100644 --- a/docs/reference/interfaces/DebugConfig.md +++ b/docs/reference/interfaces/DebugConfig.md @@ -3,7 +3,7 @@ id: DebugConfig title: DebugConfig --- -Defined in: packages/ai/src/logger/types.ts:73 +Defined in: [packages/ai/src/logger/types.ts:73](https://github.com/TanStack/ai/blob/main/packages/ai/src/logger/types.ts#L73) Granular debug configuration combining per-category toggles with an optional custom logger. Any unspecified category flag defaults to `true`. @@ -19,7 +19,7 @@ Granular debug configuration combining per-category toggles with an optional cus optional agentLoop?: boolean; ``` -Defined in: packages/ai/src/logger/types.ts:50 +Defined in: [packages/ai/src/logger/types.ts:50](https://github.com/TanStack/ai/blob/main/packages/ai/src/logger/types.ts#L50) Iteration markers and phase transitions in the chat agent loop. Chat-only. @@ -35,7 +35,7 @@ Iteration markers and phase transitions in the chat agent loop. Chat-only. optional config?: boolean; ``` -Defined in: packages/ai/src/logger/types.ts:54 +Defined in: [packages/ai/src/logger/types.ts:54](https://github.com/TanStack/ai/blob/main/packages/ai/src/logger/types.ts#L54) Config transforms returned by middleware `onConfig` hooks. Chat-only. @@ -51,7 +51,7 @@ Config transforms returned by middleware `onConfig` hooks. Chat-only. optional errors?: boolean; ``` -Defined in: packages/ai/src/logger/types.ts:58 +Defined in: [packages/ai/src/logger/types.ts:58](https://github.com/TanStack/ai/blob/main/packages/ai/src/logger/types.ts#L58) Caught errors throughout the pipeline. Unlike other categories, defaults to `true` even when `debug` is unspecified. Explicitly set `errors: false` or `debug: false` to silence. @@ -67,7 +67,7 @@ Caught errors throughout the pipeline. Unlike other categories, defaults to `tru optional logger?: Logger; ``` -Defined in: packages/ai/src/logger/types.ts:77 +Defined in: [packages/ai/src/logger/types.ts:77](https://github.com/TanStack/ai/blob/main/packages/ai/src/logger/types.ts#L77) Custom `Logger` implementation. When omitted, a default `ConsoleLogger` routes output to `console.debug`/`info`/`warn`/`error`. @@ -79,7 +79,7 @@ Custom `Logger` implementation. When omitted, a default `ConsoleLogger` routes o optional middleware?: boolean; ``` -Defined in: packages/ai/src/logger/types.ts:42 +Defined in: [packages/ai/src/logger/types.ts:42](https://github.com/TanStack/ai/blob/main/packages/ai/src/logger/types.ts#L42) Inputs and outputs around each middleware hook invocation. Chat-only. @@ -95,7 +95,7 @@ Inputs and outputs around each middleware hook invocation. Chat-only. optional output?: boolean; ``` -Defined in: packages/ai/src/logger/types.ts:38 +Defined in: [packages/ai/src/logger/types.ts:38](https://github.com/TanStack/ai/blob/main/packages/ai/src/logger/types.ts#L38) Chunks/results yielded to the consumer after all middleware. For streaming activities this fires per chunk; for non-streaming activities it fires once per result. @@ -111,7 +111,7 @@ Chunks/results yielded to the consumer after all middleware. For streaming activ optional provider?: boolean; ``` -Defined in: packages/ai/src/logger/types.ts:34 +Defined in: [packages/ai/src/logger/types.ts:34](https://github.com/TanStack/ai/blob/main/packages/ai/src/logger/types.ts#L34) Raw chunks/frames received from a provider SDK (OpenAI, Anthropic, Gemini, Ollama, Grok, Groq, OpenRouter, fal, ElevenLabs, BytePlus). Emitted inside every streaming adapter's chunk loop. @@ -127,7 +127,7 @@ Raw chunks/frames received from a provider SDK (OpenAI, Anthropic, Gemini, Ollam optional request?: boolean; ``` -Defined in: packages/ai/src/logger/types.ts:62 +Defined in: [packages/ai/src/logger/types.ts:62](https://github.com/TanStack/ai/blob/main/packages/ai/src/logger/types.ts#L62) Outgoing call metadata (provider, model, message/tool counts) emitted before each adapter SDK call. @@ -143,7 +143,7 @@ Outgoing call metadata (provider, model, message/tool counts) emitted before eac optional sandbox?: boolean; ``` -Defined in: packages/ai/src/logger/types.ts:67 +Defined in: [packages/ai/src/logger/types.ts:67](https://github.com/TanStack/ai/blob/main/packages/ai/src/logger/types.ts#L67) Sandbox internals: watcher start/stop + mechanism, file events, sandbox hook dispatch, ensure/bootstrap and lifecycle transitions. Chat-only. @@ -160,7 +160,7 @@ hook dispatch, ensure/bootstrap and lifecycle transitions. Chat-only. optional tools?: boolean; ``` -Defined in: packages/ai/src/logger/types.ts:46 +Defined in: [packages/ai/src/logger/types.ts:46](https://github.com/TanStack/ai/blob/main/packages/ai/src/logger/types.ts#L46) Before/after tool-call execution in the chat agent loop. Chat-only. diff --git a/docs/reference/interfaces/DefaultMessageMetadataByModality.md b/docs/reference/interfaces/DefaultMessageMetadataByModality.md index 2b4b68adca..731d1516a3 100644 --- a/docs/reference/interfaces/DefaultMessageMetadataByModality.md +++ b/docs/reference/interfaces/DefaultMessageMetadataByModality.md @@ -3,7 +3,7 @@ id: DefaultMessageMetadataByModality title: DefaultMessageMetadataByModality --- -Defined in: packages/ai/src/types.ts:3340 +Defined in: [packages/ai/src/types.ts:3388](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3388) Default metadata type for adapters that don't define custom metadata. Uses unknown for all modalities. @@ -16,7 +16,7 @@ Uses unknown for all modalities. audio: unknown; ``` -Defined in: packages/ai/src/types.ts:3343 +Defined in: [packages/ai/src/types.ts:3391](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3391) *** @@ -26,7 +26,7 @@ Defined in: packages/ai/src/types.ts:3343 document: unknown; ``` -Defined in: packages/ai/src/types.ts:3345 +Defined in: [packages/ai/src/types.ts:3393](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3393) *** @@ -36,7 +36,7 @@ Defined in: packages/ai/src/types.ts:3345 image: unknown; ``` -Defined in: packages/ai/src/types.ts:3342 +Defined in: [packages/ai/src/types.ts:3390](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3390) *** @@ -46,7 +46,7 @@ Defined in: packages/ai/src/types.ts:3342 text: unknown; ``` -Defined in: packages/ai/src/types.ts:3341 +Defined in: [packages/ai/src/types.ts:3389](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3389) *** @@ -56,4 +56,4 @@ Defined in: packages/ai/src/types.ts:3341 video: unknown; ``` -Defined in: packages/ai/src/types.ts:3344 +Defined in: [packages/ai/src/types.ts:3392](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3392) diff --git a/docs/reference/interfaces/DefinedAgent.md b/docs/reference/interfaces/DefinedAgent.md index 0720ddc454..baaad65a11 100644 --- a/docs/reference/interfaces/DefinedAgent.md +++ b/docs/reference/interfaces/DefinedAgent.md @@ -3,7 +3,7 @@ id: DefinedAgent title: DefinedAgent --- -Defined in: packages/ai/src/activities/chat/agents/define-agent.ts:101 +Defined in: [packages/ai/src/activities/chat/agents/define-agent.ts:110](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/define-agent.ts#L110) A named child agent. `run` is a `chat()` call (or any stream of AG-UI chunks), or a promise of a plain value such as an image result. A @@ -53,7 +53,7 @@ type that child's parts. `TResult` is the value a promise `run` resolves to. description: string; ``` -Defined in: packages/ai/src/activities/chat/agents/define-agent.ts:113 +Defined in: [packages/ai/src/activities/chat/agents/define-agent.ts:122](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/define-agent.ts#L122) Required here: the router and the synthetic tool both read it. @@ -71,7 +71,7 @@ AGUISubagentInfo.description optional inputSchema?: TInput; ``` -Defined in: packages/ai/src/activities/chat/agents/define-agent.ts:133 +Defined in: [packages/ai/src/activities/chat/agents/define-agent.ts:142](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/define-agent.ts#L142) The input this agent needs, such as a short brief. `run` reads it as `ctx.input`, and the client card as `part.subagent.input`. In tool mode, @@ -91,7 +91,7 @@ only. A turn with a router input cannot resume after an interrupt. optional interrupts?: TInterrupts; ``` -Defined in: packages/ai/src/activities/chat/agents/define-agent.ts:135 +Defined in: [packages/ai/src/activities/chat/agents/define-agent.ts:144](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/define-agent.ts#L144) *** @@ -101,7 +101,7 @@ Defined in: packages/ai/src/activities/chat/agents/define-agent.ts:135 name: TName; ``` -Defined in: packages/ai/src/activities/chat/agents/define-agent.ts:111 +Defined in: [packages/ai/src/activities/chat/agents/define-agent.ts:120](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/define-agent.ts#L120) Unique name or identifier of the subagent. @@ -119,7 +119,7 @@ AGUISubagentInfo.name optional outputSchema?: TSchema; ``` -Defined in: packages/ai/src/activities/chat/agents/define-agent.ts:136 +Defined in: [packages/ai/src/activities/chat/agents/define-agent.ts:145](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/define-agent.ts#L145) *** @@ -129,7 +129,7 @@ Defined in: packages/ai/src/activities/chat/agents/define-agent.ts:136 optional produces?: TProduces; ``` -Defined in: packages/ai/src/activities/chat/agents/define-agent.ts:121 +Defined in: [packages/ai/src/activities/chat/agents/define-agent.ts:130](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/define-agent.ts#L130) What this agent makes. See [AgentProduces](../type-aliases/AgentProduces.md). @@ -144,7 +144,7 @@ run: (ctx) => | Promise; ``` -Defined in: packages/ai/src/activities/chat/agents/define-agent.ts:114 +Defined in: [packages/ai/src/activities/chat/agents/define-agent.ts:123](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/define-agent.ts#L123) #### Parameters @@ -166,7 +166,7 @@ Defined in: packages/ai/src/activities/chat/agents/define-agent.ts:114 optional subagents?: unknown; ``` -Defined in: packages/ai/src/activities/chat/agents/define-agent.ts:137 +Defined in: [packages/ai/src/activities/chat/agents/define-agent.ts:146](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/define-agent.ts#L146) *** @@ -176,4 +176,4 @@ Defined in: packages/ai/src/activities/chat/agents/define-agent.ts:137 optional tools?: TTools; ``` -Defined in: packages/ai/src/activities/chat/agents/define-agent.ts:134 +Defined in: [packages/ai/src/activities/chat/agents/define-agent.ts:143](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/define-agent.ts#L143) diff --git a/docs/reference/interfaces/DefinedChatMiddleware.md b/docs/reference/interfaces/DefinedChatMiddleware.md index 903c5db8fa..018d7068dc 100644 --- a/docs/reference/interfaces/DefinedChatMiddleware.md +++ b/docs/reference/interfaces/DefinedChatMiddleware.md @@ -3,7 +3,7 @@ id: DefinedChatMiddleware title: DefinedChatMiddleware --- -Defined in: packages/ai/src/activities/chat/middleware/define.ts:11 +Defined in: [packages/ai/src/activities/chat/middleware/define.ts:11](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/define.ts#L11) A middleware whose `requires`/`provides` tuple types are captured precisely (via `const` inference) for the array coverage check and the builder. @@ -38,7 +38,7 @@ A middleware whose `requires`/`provides` tuple types are captured precisely optional name?: string; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:681 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:711](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L711) Optional name for debugging and identification @@ -54,7 +54,7 @@ Optional name for debugging and identification optional onAbort?: (ctx, info) => void | Promise; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:900 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:948](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L948) Called when the chat run is aborted. Exactly one of onFinish/onAbort/onError will be called per run. @@ -87,7 +87,7 @@ optional onAfterToolCall?: (ctx, info) => | Promise; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:864 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:912](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L912) Called after a tool execution completes (success or failure). Return `{ type: 'replaceResult', result }` to change the result that the @@ -127,7 +127,7 @@ optional onBeforeToolCall?: (ctx, hookCtx) => | Promise; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:849 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:879](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L879) Called before a server tool runs and before a client tool is sent to the client. Not called while the call waits for approval. @@ -166,7 +166,7 @@ optional onChunk?: (ctx, chunk) => | null; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:833 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:863](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L863) Called for every chunk yielded by chat(). Can observe, transform, expand, or drop chunks. @@ -210,7 +210,7 @@ optional onConfig?: (ctx, config) => | null; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:745 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:775](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L775) Called to observe or transform the chat configuration. Called at init and at the beginning of each agent iteration. @@ -250,7 +250,7 @@ Only the fields you return are overwritten — everything else is preserved. optional onError?: (ctx, info) => void | Promise; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:909 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:957](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L957) Called when the chat run encounters an unhandled error. Exactly one of onFinish/onAbort/onError will be called per run. @@ -281,7 +281,7 @@ Exactly one of onFinish/onAbort/onError will be called per run. optional onFinish?: (ctx, info) => void | Promise; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:891 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:939](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L939) Called when the chat run completes normally. Exactly one of onFinish/onAbort/onError will be called per run. @@ -306,6 +306,49 @@ Exactly one of onFinish/onAbort/onError will be called per run. *** +### onGuardToolCall? + +```ts +optional onGuardToolCall?: (ctx, hookCtx) => + | GuardToolCallDecision +| Promise; +``` + +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:897](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L897) + +The guard tier. Called for every tool call, just before a server tool +runs and before a client tool is sent to the client. Not called while +the call waits for approval. + +It runs after all `onBeforeToolCall` hooks and after the `inputSchema` +check, so `hookCtx.args` holds the final checked args that the tool gets. +It also runs for calls that `onBeforeToolCall` let through unchanged. + +It is not first-win. The guard of each middleware runs in order, until +one returns a decision. Use it for checks that must not be skipped, such +as permissions. + +#### Parameters + +##### ctx + +[`ChatMiddlewareContext`](ChatMiddlewareContext.md)\<`TContext`\> + +##### hookCtx + +[`ToolCallHookContext`](ToolCallHookContext.md) + +#### Returns + + \| [`GuardToolCallDecision`](../type-aliases/GuardToolCallDecision.md) + \| `Promise`\<[`GuardToolCallDecision`](../type-aliases/GuardToolCallDecision.md)\> + +#### Inherited from + +[`ChatMiddleware`](ChatMiddleware.md).[`onGuardToolCall`](ChatMiddleware.md#onguardtoolcall) + +*** + ### onInterruptBoundary? ```ts @@ -314,7 +357,7 @@ optional onInterruptBoundary?: (ctx) => | Promise>; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:693 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:723](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L723) Called at a lifecycle boundary. Return interrupt requests to pause the run. Requests from every middleware in the same boundary form one batch. @@ -344,7 +387,7 @@ optional onInterruptResolution?: (ctx, resolutions) => | Promise; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:703 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:733](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L733) Called on a continuation run after the client answers registered interrupts. Return `toolResume` to decide whether pending tools continue, cancel, or stop. @@ -376,7 +419,7 @@ Return `toolResume` to decide whether pending tools continue, cancel, or stop. optional onIteration?: (ctx, info) => void | Promise; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:787 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:817](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L817) Called at the start of each agent loop iteration, after a new assistant message ID is created. Use this to observe iteration boundaries. @@ -407,7 +450,7 @@ is created. Use this to observe iteration boundaries. optional onModelError?: (ctx, error) => void | Promise; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:822 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:852](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L852) Called when the adapter sends a `RUN_ERROR` before any output of the model call. The error does not reach `onChunk` or the caller yet. An @@ -445,7 +488,7 @@ way. The structured-output call is not retried. optional onShouldContinue?: (ctx, state) => boolean | void | Promise; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:806 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:836](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L836) Called when the engine is deciding whether to start another agent-loop iteration (after a tool phase or between model turns). @@ -486,7 +529,7 @@ Receives the same [AgentLoopState](AgentLoopState.md) passed to strategies optional onStart?: (ctx) => void | Promise; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:781 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:811](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L811) Called when the chat run starts (after initial onConfig). @@ -519,7 +562,7 @@ optional onStructuredOutputConfig?: (ctx, config) => | null; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:769 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:799](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L799) Called at the start of the final structured-output call (when the chat was invoked with outputSchema). Pipes through middleware in order, like @@ -567,7 +610,7 @@ outputSchema or apply structured-output-specific behavior. optional onToolPhaseComplete?: (ctx, info) => void | Promise; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:873 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:921](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L921) Called after all tool calls in an iteration have been processed. Provides aggregate data about tool execution results, approvals, and client tools. @@ -598,7 +641,7 @@ Provides aggregate data about tool execution results, approvals, and client tool optional onUsage?: (ctx, usage) => void | Promise; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:882 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:930](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L930) Called when usage data is available from a RUN_FINISHED chunk. Called once per model iteration that reports usage. @@ -629,7 +672,7 @@ Called once per model iteration that reports usage. optional optionalRequires?: readonly CapabilityHandle[]; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:728 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:758](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L758) Capabilities this middleware uses if present but does not require. Non-gating: never causes a validation error. Read with @@ -647,7 +690,7 @@ Non-gating: never causes a validation error. Read with optional provides?: TProvides; ``` -Defined in: packages/ai/src/activities/chat/middleware/define.ts:18 +Defined in: [packages/ai/src/activities/chat/middleware/define.ts:18](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/define.ts#L18) Capabilities this middleware provides. Each declared capability MUST be provided (via its `provide` accessor) inside `setup`, or `chat()` throws @@ -665,7 +708,7 @@ after the setup phase. optional requires?: TRequires; ``` -Defined in: packages/ai/src/activities/chat/middleware/define.ts:17 +Defined in: [packages/ai/src/activities/chat/middleware/define.ts:17](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/define.ts#L17) Capabilities this middleware requires. `chat()` validates that some middleware (or the adapter) provides each one; unsatisfied requirements are @@ -684,7 +727,7 @@ the adapter runs. optional routedSubagentPersistence?: RoutedSubagentPersistence; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:687 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:717](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L717) Present when this middleware stores subagent runs. The router calls it. An app does not set it. @@ -701,7 +744,7 @@ The router calls it. An app does not set it. optional sandbox?: ChatSandboxHooks; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:918 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:966](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L966) Sandbox file-event hooks. Fire when a sandbox provided by `withSandbox` is active during the run and a file is created/changed/deleted. Server-side. @@ -718,7 +761,7 @@ active during the run and a file is created/changed/deleted. Server-side. optional setup?: (ctx) => void | Promise; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:736 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:766](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L766) Provisioning hook. Runs FIRST — before `onConfig` (init) — across all middleware in array order. Use it to call `provide` accessors so later diff --git a/docs/reference/interfaces/DocumentPart.md b/docs/reference/interfaces/DocumentPart.md index 4dc6701254..19842d80c3 100644 --- a/docs/reference/interfaces/DocumentPart.md +++ b/docs/reference/interfaces/DocumentPart.md @@ -3,7 +3,7 @@ id: DocumentPart title: DocumentPart --- -Defined in: packages/ai/src/types.ts:315 +Defined in: [packages/ai/src/types.ts:318](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L318) Document content part for multimodal messages (e.g., PDFs). AG-UI `DocumentPart` with typed metadata. @@ -27,7 +27,7 @@ Provider-specific metadata type (e.g., Anthropic's media_type) optional metadata?: TMetadata; ``` -Defined in: packages/ai/src/types.ts:317 +Defined in: [packages/ai/src/types.ts:320](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L320) Provider-specific metadata (e.g., media_type for PDFs) diff --git a/docs/reference/interfaces/Embedding.md b/docs/reference/interfaces/Embedding.md index 0b67c18d57..0a571641b7 100644 --- a/docs/reference/interfaces/Embedding.md +++ b/docs/reference/interfaces/Embedding.md @@ -3,7 +3,7 @@ id: Embedding title: Embedding --- -Defined in: packages/ai/src/types.ts:3315 +Defined in: [packages/ai/src/types.ts:3363](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3363) A single embedding vector. @@ -15,7 +15,7 @@ A single embedding vector. index: number; ``` -Defined in: packages/ai/src/types.ts:3319 +Defined in: [packages/ai/src/types.ts:3367](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3367) Position of the source item in the (normalized) input array @@ -27,6 +27,6 @@ Position of the source item in the (normalized) input array vector: number[]; ``` -Defined in: packages/ai/src/types.ts:3317 +Defined in: [packages/ai/src/types.ts:3365](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3365) The embedding vector diff --git a/docs/reference/interfaces/EmbeddingAdapter.md b/docs/reference/interfaces/EmbeddingAdapter.md index 5fcc4af6bc..6a9080c4d2 100644 --- a/docs/reference/interfaces/EmbeddingAdapter.md +++ b/docs/reference/interfaces/EmbeddingAdapter.md @@ -3,7 +3,7 @@ id: EmbeddingAdapter title: EmbeddingAdapter --- -Defined in: packages/ai/src/activities/embed/adapter.ts:31 +Defined in: [packages/ai/src/activities/embed/adapter.ts:31](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/embed/adapter.ts#L31) Embedding adapter interface with pre-resolved generics. @@ -43,7 +43,7 @@ Generic parameters: ~types: object; ``` -Defined in: packages/ai/src/activities/embed/adapter.ts:54 +Defined in: [packages/ai/src/activities/embed/adapter.ts:54](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/embed/adapter.ts#L54) **`Internal`** @@ -75,7 +75,7 @@ providerOptions: TProviderOptions; createEmbeddings: (options) => Promise; ``` -Defined in: packages/ai/src/activities/embed/adapter.ts:63 +Defined in: [packages/ai/src/activities/embed/adapter.ts:63](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/embed/adapter.ts#L63) Generate embeddings for the input items (one vector per item) @@ -97,7 +97,7 @@ Generate embeddings for the input items (one vector per item) readonly kind: "embedding"; ``` -Defined in: packages/ai/src/activities/embed/adapter.ts:39 +Defined in: [packages/ai/src/activities/embed/adapter.ts:39](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/embed/adapter.ts#L39) Discriminator for adapter kind @@ -109,7 +109,7 @@ Discriminator for adapter kind readonly model: TModel; ``` -Defined in: packages/ai/src/activities/embed/adapter.ts:49 +Defined in: [packages/ai/src/activities/embed/adapter.ts:49](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/embed/adapter.ts#L49) The model this adapter is configured for @@ -121,7 +121,7 @@ The model this adapter is configured for readonly name: string; ``` -Defined in: packages/ai/src/activities/embed/adapter.ts:41 +Defined in: [packages/ai/src/activities/embed/adapter.ts:41](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/embed/adapter.ts#L41) Adapter name identifier @@ -133,7 +133,7 @@ Adapter name identifier readonly optional supportsFileSources?: boolean; ``` -Defined in: packages/ai/src/activities/embed/adapter.ts:47 +Defined in: [packages/ai/src/activities/embed/adapter.ts:47](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/embed/adapter.ts#L47) Declares that this adapter can consume `{ type: 'file' }` content sources (provider Files API references). `embed()` rejects file sources diff --git a/docs/reference/interfaces/EmbeddingOptions.md b/docs/reference/interfaces/EmbeddingOptions.md index a5f248cd68..f8cd4b4b04 100644 --- a/docs/reference/interfaces/EmbeddingOptions.md +++ b/docs/reference/interfaces/EmbeddingOptions.md @@ -3,7 +3,7 @@ id: EmbeddingOptions title: EmbeddingOptions --- -Defined in: packages/ai/src/types.ts:3292 +Defined in: [packages/ai/src/types.ts:3340](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3340) Options for embedding generation, as received by adapters. The `embed()` entry point normalizes a single input item to an array before calling the @@ -23,7 +23,7 @@ adapter, so `input` is always an array here. optional dimensions?: number; ``` -Defined in: packages/ai/src/types.ts:3301 +Defined in: [packages/ai/src/types.ts:3349](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3349) Requested output dimensionality. Adapters for models with fixed dimensions throw a clear runtime error when this is set. @@ -36,7 +36,7 @@ dimensions throw a clear runtime error when this is set. input: EmbeddingInputItem[]; ``` -Defined in: packages/ai/src/types.ts:3296 +Defined in: [packages/ai/src/types.ts:3344](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3344) The items to embed — one vector per item @@ -48,7 +48,7 @@ The items to embed — one vector per item logger: InternalLogger; ``` -Defined in: packages/ai/src/types.ts:3309 +Defined in: [packages/ai/src/types.ts:3357](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3357) Internal logger threaded from the embed() entry point. Adapters must call logger.request() before the SDK call and logger.errors() in catch @@ -62,7 +62,7 @@ blocks. model: string; ``` -Defined in: packages/ai/src/types.ts:3294 +Defined in: [packages/ai/src/types.ts:3342](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3342) The model to use for embedding generation @@ -74,6 +74,6 @@ The model to use for embedding generation optional modelOptions?: TProviderOptions; ``` -Defined in: packages/ai/src/types.ts:3303 +Defined in: [packages/ai/src/types.ts:3351](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3351) Model-specific options for embedding generation diff --git a/docs/reference/interfaces/EmbeddingResult.md b/docs/reference/interfaces/EmbeddingResult.md index 8ccd045347..0d6a305b98 100644 --- a/docs/reference/interfaces/EmbeddingResult.md +++ b/docs/reference/interfaces/EmbeddingResult.md @@ -3,7 +3,7 @@ id: EmbeddingResult title: EmbeddingResult --- -Defined in: packages/ai/src/types.ts:3325 +Defined in: [packages/ai/src/types.ts:3373](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3373) Result of embedding generation. @@ -15,7 +15,7 @@ Result of embedding generation. embeddings: Embedding[]; ``` -Defined in: packages/ai/src/types.ts:3331 +Defined in: [packages/ai/src/types.ts:3379](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3379) One embedding per input item, in input order @@ -27,7 +27,7 @@ One embedding per input item, in input order id: string; ``` -Defined in: packages/ai/src/types.ts:3327 +Defined in: [packages/ai/src/types.ts:3375](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3375) Unique identifier for the generation @@ -39,7 +39,7 @@ Unique identifier for the generation model: string; ``` -Defined in: packages/ai/src/types.ts:3329 +Defined in: [packages/ai/src/types.ts:3377](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3377) Model used for generation @@ -51,6 +51,6 @@ Model used for generation optional usage?: TokenUsage; ``` -Defined in: packages/ai/src/types.ts:3333 +Defined in: [packages/ai/src/types.ts:3381](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3381) Token usage information (if provided by the adapter) diff --git a/docs/reference/interfaces/EmitCustomEventOptions.md b/docs/reference/interfaces/EmitCustomEventOptions.md index daed353bf5..bf847d7b55 100644 --- a/docs/reference/interfaces/EmitCustomEventOptions.md +++ b/docs/reference/interfaces/EmitCustomEventOptions.md @@ -3,7 +3,7 @@ id: EmitCustomEventOptions title: EmitCustomEventOptions --- -Defined in: packages/ai/src/types.ts:847 +Defined in: [packages/ai/src/types.ts:865](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L865) Options for a single `emitCustomEvent` call, on both the tool-execution and middleware contexts. @@ -16,7 +16,7 @@ middleware contexts. optional batch?: boolean; ``` -Defined in: packages/ai/src/types.ts:856 +Defined in: [packages/ai/src/types.ts:874](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L874) Keep this event in the durability batch with later chunks. CUSTOM events flush as soon as they are emitted, so a progress diff --git a/docs/reference/interfaces/ErrorInfo.md b/docs/reference/interfaces/ErrorInfo.md index 37dc3e2fbf..84c5d996c2 100644 --- a/docs/reference/interfaces/ErrorInfo.md +++ b/docs/reference/interfaces/ErrorInfo.md @@ -3,7 +3,7 @@ id: ErrorInfo title: ErrorInfo --- -Defined in: packages/ai/src/activities/chat/middleware/types.ts:602 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:632](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L632) Information passed to onError. @@ -15,7 +15,7 @@ Information passed to onError. duration: number; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:606 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:636](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L636) Duration until error in milliseconds @@ -27,6 +27,6 @@ Duration until error in milliseconds error: unknown; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:604 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:634](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L634) The error that caused the failure diff --git a/docs/reference/interfaces/EvaluateAdapter.md b/docs/reference/interfaces/EvaluateAdapter.md index dc4043c1a6..7c67b44ee3 100644 --- a/docs/reference/interfaces/EvaluateAdapter.md +++ b/docs/reference/interfaces/EvaluateAdapter.md @@ -3,7 +3,7 @@ id: EvaluateAdapter title: EvaluateAdapter --- -Defined in: packages/ai/src/activities/evaluate/adapter.ts:150 +Defined in: [packages/ai/src/activities/evaluate/adapter.ts:226](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/evaluate/adapter.ts#L226) Evaluate adapter interface with pre-resolved generics. @@ -32,7 +32,7 @@ Generic parameters: ~types: object; ``` -Defined in: packages/ai/src/activities/evaluate/adapter.ts:164 +Defined in: [packages/ai/src/activities/evaluate/adapter.ts:240](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/evaluate/adapter.ts#L240) **`Internal`** @@ -52,7 +52,7 @@ providerOptions: TProviderOptions; evaluate: (options) => Promise; ``` -Defined in: packages/ai/src/activities/evaluate/adapter.ts:172 +Defined in: [packages/ai/src/activities/evaluate/adapter.ts:248](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/evaluate/adapter.ts#L248) Evaluate typed questions against `state`. Return the provider payload. Do not invent unified `.value` fields. The activity maps wire answers. @@ -75,7 +75,7 @@ Do not invent unified `.value` fields. The activity maps wire answers. readonly kind: "evaluate"; ``` -Defined in: packages/ai/src/activities/evaluate/adapter.ts:155 +Defined in: [packages/ai/src/activities/evaluate/adapter.ts:231](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/evaluate/adapter.ts#L231) Discriminator for adapter kind @@ -87,7 +87,7 @@ Discriminator for adapter kind readonly model: TModel; ``` -Defined in: packages/ai/src/activities/evaluate/adapter.ts:159 +Defined in: [packages/ai/src/activities/evaluate/adapter.ts:235](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/evaluate/adapter.ts#L235) The model this adapter is configured for @@ -99,6 +99,6 @@ The model this adapter is configured for readonly name: string; ``` -Defined in: packages/ai/src/activities/evaluate/adapter.ts:157 +Defined in: [packages/ai/src/activities/evaluate/adapter.ts:233](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/evaluate/adapter.ts#L233) Adapter name identifier diff --git a/docs/reference/interfaces/EvaluateErrorInit.md b/docs/reference/interfaces/EvaluateErrorInit.md new file mode 100644 index 0000000000..fe29e9c853 --- /dev/null +++ b/docs/reference/interfaces/EvaluateErrorInit.md @@ -0,0 +1,70 @@ +--- +id: EvaluateErrorInit +title: EvaluateErrorInit +--- + +Defined in: [packages/ai/src/activities/evaluate/adapter.ts:144](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/evaluate/adapter.ts#L144) + +Fields for [EvaluateError](../classes/EvaluateError.md). + +## Properties + +### answers? + +```ts +optional answers?: Record; +``` + +Defined in: [packages/ai/src/activities/evaluate/adapter.ts:158](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/evaluate/adapter.ts#L158) + +Wire answers the provider did return, before `decide()` maps them. A +`choice()` answer has `choice`, and a `boolean()` answer is +`{ type: 'noul', noul }`. A refused question has no key. + +*** + +### code + +```ts +code: string; +``` + +Defined in: [packages/ai/src/activities/evaluate/adapter.ts:148](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/evaluate/adapter.ts#L148) + +Stable code to branch on, for example `EVALUATE_REFUSAL_CODE`. + +*** + +### message + +```ts +message: string; +``` + +Defined in: [packages/ai/src/activities/evaluate/adapter.ts:146](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/evaluate/adapter.ts#L146) + +Human-readable error text. + +*** + +### model? + +```ts +optional model?: string; +``` + +Defined in: [packages/ai/src/activities/evaluate/adapter.ts:152](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/evaluate/adapter.ts#L152) + +Resolved model id from the provider. + +*** + +### usage? + +```ts +optional usage?: TokenUsage; +``` + +Defined in: [packages/ai/src/activities/evaluate/adapter.ts:150](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/evaluate/adapter.ts#L150) + +Tokens the provider reported for this call. diff --git a/docs/reference/interfaces/ExtendedModelDef.md b/docs/reference/interfaces/ExtendedModelDef.md index de61a475e1..f7b343623d 100644 --- a/docs/reference/interfaces/ExtendedModelDef.md +++ b/docs/reference/interfaces/ExtendedModelDef.md @@ -3,7 +3,7 @@ id: ExtendedModelDef title: ExtendedModelDef --- -Defined in: packages/ai/src/extend-adapter.ts:21 +Defined in: [packages/ai/src/extend-adapter.ts:21](https://github.com/TanStack/ai/blob/main/packages/ai/src/extend-adapter.ts#L21) Definition for a custom model to add to an adapter. @@ -51,7 +51,7 @@ Provider options type for this model optional features?: TFeatures; ``` -Defined in: packages/ai/src/extend-adapter.ts:35 +Defined in: [packages/ai/src/extend-adapter.ts:35](https://github.com/TanStack/ai/blob/main/packages/ai/src/extend-adapter.ts#L35) Optional declared features (e.g. 'reasoning', 'structured_outputs') @@ -63,7 +63,7 @@ Optional declared features (e.g. 'reasoning', 'structured_outputs') input: TInput; ``` -Defined in: packages/ai/src/extend-adapter.ts:31 +Defined in: [packages/ai/src/extend-adapter.ts:31](https://github.com/TanStack/ai/blob/main/packages/ai/src/extend-adapter.ts#L31) Supported input modalities for this model @@ -75,7 +75,7 @@ Supported input modalities for this model modelOptions: TOptions; ``` -Defined in: packages/ai/src/extend-adapter.ts:33 +Defined in: [packages/ai/src/extend-adapter.ts:33](https://github.com/TanStack/ai/blob/main/packages/ai/src/extend-adapter.ts#L33) Type brand for provider options - use `{} as YourOptionsType` @@ -87,7 +87,7 @@ Type brand for provider options - use `{} as YourOptionsType` name: TName; ``` -Defined in: packages/ai/src/extend-adapter.ts:29 +Defined in: [packages/ai/src/extend-adapter.ts:29](https://github.com/TanStack/ai/blob/main/packages/ai/src/extend-adapter.ts#L29) The model name identifier @@ -99,6 +99,6 @@ The model name identifier optional tools?: TTools; ``` -Defined in: packages/ai/src/extend-adapter.ts:37 +Defined in: [packages/ai/src/extend-adapter.ts:37](https://github.com/TanStack/ai/blob/main/packages/ai/src/extend-adapter.ts#L37) Optional declared provider tools (e.g. 'web_search') diff --git a/docs/reference/interfaces/FileChangedEvent.md b/docs/reference/interfaces/FileChangedEvent.md index 413acbf36c..b797a5724a 100644 --- a/docs/reference/interfaces/FileChangedEvent.md +++ b/docs/reference/interfaces/FileChangedEvent.md @@ -3,7 +3,7 @@ id: FileChangedEvent title: FileChangedEvent --- -Defined in: packages/ai/src/types.ts:1825 +Defined in: [packages/ai/src/types.ts:1883](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1883) Custom event for extensibility. @@ -21,7 +21,7 @@ Custom event for extensibility. optional metadata?: Record; ``` -Defined in: packages/ai/src/types.ts:1756 +Defined in: [packages/ai/src/types.ts:1814](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1814) Extra information attached to this event. @@ -37,7 +37,7 @@ Extra information attached to this event. name: "file.changed"; ``` -Defined in: packages/ai/src/types.ts:1826 +Defined in: [packages/ai/src/types.ts:1884](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1884) What this custom event is. Required: without it a consumer cannot route the value. @@ -56,7 +56,7 @@ CustomEvent.name type: "CUSTOM"; ``` -Defined in: packages/ai/src/types.ts:1755 +Defined in: [packages/ai/src/types.ts:1813](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1813) #### Inherited from @@ -70,7 +70,7 @@ Defined in: packages/ai/src/types.ts:1755 value: object; ``` -Defined in: packages/ai/src/types.ts:1827 +Defined in: [packages/ai/src/types.ts:1885](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1885) The payload. Any JSON value, and required. diff --git a/docs/reference/interfaces/FileChangedPayload.md b/docs/reference/interfaces/FileChangedPayload.md index 82cd53fb32..d9ce5433ec 100644 --- a/docs/reference/interfaces/FileChangedPayload.md +++ b/docs/reference/interfaces/FileChangedPayload.md @@ -3,7 +3,7 @@ id: FileChangedPayload title: FileChangedPayload --- -Defined in: packages/ai/src/custom-events.ts:35 +Defined in: [packages/ai/src/custom-events.ts:35](https://github.com/TanStack/ai/blob/main/packages/ai/src/custom-events.ts#L35) ## Properties @@ -13,7 +13,7 @@ Defined in: packages/ai/src/custom-events.ts:35 optional diff?: string; ``` -Defined in: packages/ai/src/custom-events.ts:40 +Defined in: [packages/ai/src/custom-events.ts:40](https://github.com/TanStack/ai/blob/main/packages/ai/src/custom-events.ts#L40) Unified diff, when the harness can produce one. @@ -25,7 +25,7 @@ Unified diff, when the harness can produce one. path: string; ``` -Defined in: packages/ai/src/custom-events.ts:38 +Defined in: [packages/ai/src/custom-events.ts:38](https://github.com/TanStack/ai/blob/main/packages/ai/src/custom-events.ts#L38) Absolute path inside the sandbox (under the workspace root). @@ -37,7 +37,7 @@ Absolute path inside the sandbox (under the workspace root). timestamp: number; ``` -Defined in: packages/ai/src/custom-events.ts:41 +Defined in: [packages/ai/src/custom-events.ts:41](https://github.com/TanStack/ai/blob/main/packages/ai/src/custom-events.ts#L41) *** @@ -47,4 +47,4 @@ Defined in: packages/ai/src/custom-events.ts:41 type: "create" | "change" | "delete"; ``` -Defined in: packages/ai/src/custom-events.ts:36 +Defined in: [packages/ai/src/custom-events.ts:36](https://github.com/TanStack/ai/blob/main/packages/ai/src/custom-events.ts#L36) diff --git a/docs/reference/interfaces/FileHandle.md b/docs/reference/interfaces/FileHandle.md index 8bff339582..4bc4a414d8 100644 --- a/docs/reference/interfaces/FileHandle.md +++ b/docs/reference/interfaces/FileHandle.md @@ -3,7 +3,7 @@ id: FileHandle title: FileHandle --- -Defined in: packages/ai/src/activities/files/adapter.ts:41 +Defined in: [packages/ai/src/activities/files/adapter.ts:41](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/files/adapter.ts#L41) A provider-issued file handle returned by [FilesAdapter.upload](FilesAdapter.md#upload) / [FilesAdapter.get](FilesAdapter.md#get). Reference it in a message via a `{ type: 'file' }` @@ -28,7 +28,7 @@ compile time. It defaults to `string` so wire-deserialized handles still fit. optional expiresAt?: number; ``` -Defined in: packages/ai/src/activities/files/adapter.ts:62 +Defined in: [packages/ai/src/activities/files/adapter.ts:62](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/files/adapter.ts#L62) Expiry as epoch milliseconds when the handle is scheduled to expire. @@ -40,7 +40,7 @@ Expiry as epoch milliseconds when the handle is scheduled to expire. optional filename?: string; ``` -Defined in: packages/ai/src/activities/files/adapter.ts:64 +Defined in: [packages/ai/src/activities/files/adapter.ts:64](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/files/adapter.ts#L64) Original filename when the provider reports it. @@ -52,7 +52,7 @@ Original filename when the provider reports it. id: string; ``` -Defined in: packages/ai/src/activities/files/adapter.ts:48 +Defined in: [packages/ai/src/activities/files/adapter.ts:48](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/files/adapter.ts#L48) Provider handle used for lifecycle operations (`get`/`delete`): the OpenAI/Anthropic `file_id`, the Gemini file resource name (`files/...`), or @@ -67,7 +67,7 @@ the wire reference). optional mimeType?: string; ``` -Defined in: packages/ai/src/activities/files/adapter.ts:58 +Defined in: [packages/ai/src/activities/files/adapter.ts:58](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/files/adapter.ts#L58) MIME type reported by the provider (or echoed from the upload input). @@ -79,7 +79,7 @@ MIME type reported by the provider (or echoed from the upload input). provider: TProvider; ``` -Defined in: packages/ai/src/activities/files/adapter.ts:50 +Defined in: [packages/ai/src/activities/files/adapter.ts:50](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/files/adapter.ts#L50) The provider that issued the handle (`'openai'`, `'gemini'`, ...). @@ -91,7 +91,7 @@ The provider that issued the handle (`'openai'`, `'gemini'`, ...). optional sizeBytes?: number; ``` -Defined in: packages/ai/src/activities/files/adapter.ts:60 +Defined in: [packages/ai/src/activities/files/adapter.ts:60](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/files/adapter.ts#L60) File size in bytes when the provider reports it. @@ -103,7 +103,7 @@ File size in bytes when the provider reports it. optional uri?: string; ``` -Defined in: packages/ai/src/activities/files/adapter.ts:56 +Defined in: [packages/ai/src/activities/files/adapter.ts:56](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/files/adapter.ts#L56) The handle's URL form when the provider exposes one (Gemini file URI, fal storage URL). For providers whose handle is an opaque id (OpenAI, diff --git a/docs/reference/interfaces/FileSourceCapable.md b/docs/reference/interfaces/FileSourceCapable.md index 46b89bb557..8064cfc6dc 100644 --- a/docs/reference/interfaces/FileSourceCapable.md +++ b/docs/reference/interfaces/FileSourceCapable.md @@ -3,7 +3,7 @@ id: FileSourceCapable title: FileSourceCapable --- -Defined in: packages/ai/src/utilities/content-source.ts:74 +Defined in: [packages/ai/src/utilities/content-source.ts:74](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/content-source.ts#L74) The slice of an adapter the file-source preflight reads. Adapters that can consume `{ type: 'file' }` sources declare `supportsFileSources: true`; @@ -19,7 +19,7 @@ URL/data branch and silently mis-mapping the reference. name: string; ``` -Defined in: packages/ai/src/utilities/content-source.ts:75 +Defined in: [packages/ai/src/utilities/content-source.ts:75](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/content-source.ts#L75) *** @@ -29,4 +29,4 @@ Defined in: packages/ai/src/utilities/content-source.ts:75 optional supportsFileSources?: boolean; ``` -Defined in: packages/ai/src/utilities/content-source.ts:76 +Defined in: [packages/ai/src/utilities/content-source.ts:76](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/content-source.ts#L76) diff --git a/docs/reference/interfaces/FilesAdapter.md b/docs/reference/interfaces/FilesAdapter.md index ea84157a10..ab61630314 100644 --- a/docs/reference/interfaces/FilesAdapter.md +++ b/docs/reference/interfaces/FilesAdapter.md @@ -3,7 +3,7 @@ id: FilesAdapter title: FilesAdapter --- -Defined in: packages/ai/src/activities/files/adapter.ts:75 +Defined in: [packages/ai/src/activities/files/adapter.ts:75](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/files/adapter.ts#L75) The `files` adapter contract. `upload` is required; `get`/`delete` are optional and present only when the provider has a lifecycle API. @@ -26,7 +26,7 @@ type system. optional delete?: (id) => Promise; ``` -Defined in: packages/ai/src/activities/files/adapter.ts:80 +Defined in: [packages/ai/src/activities/files/adapter.ts:80](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/files/adapter.ts#L80) #### Parameters @@ -46,7 +46,7 @@ Defined in: packages/ai/src/activities/files/adapter.ts:80 optional get?: (id) => Promise>; ``` -Defined in: packages/ai/src/activities/files/adapter.ts:79 +Defined in: [packages/ai/src/activities/files/adapter.ts:79](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/files/adapter.ts#L79) #### Parameters @@ -66,7 +66,7 @@ Defined in: packages/ai/src/activities/files/adapter.ts:79 readonly kind: "files"; ``` -Defined in: packages/ai/src/activities/files/adapter.ts:76 +Defined in: [packages/ai/src/activities/files/adapter.ts:76](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/files/adapter.ts#L76) *** @@ -76,7 +76,7 @@ Defined in: packages/ai/src/activities/files/adapter.ts:76 readonly name: TName; ``` -Defined in: packages/ai/src/activities/files/adapter.ts:77 +Defined in: [packages/ai/src/activities/files/adapter.ts:77](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/files/adapter.ts#L77) *** @@ -86,7 +86,7 @@ Defined in: packages/ai/src/activities/files/adapter.ts:77 upload: (input) => Promise>; ``` -Defined in: packages/ai/src/activities/files/adapter.ts:78 +Defined in: [packages/ai/src/activities/files/adapter.ts:78](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/files/adapter.ts#L78) #### Parameters diff --git a/docs/reference/interfaces/FinishInfo.md b/docs/reference/interfaces/FinishInfo.md index 3954b259a3..e50d8ca0c9 100644 --- a/docs/reference/interfaces/FinishInfo.md +++ b/docs/reference/interfaces/FinishInfo.md @@ -3,7 +3,7 @@ id: FinishInfo title: FinishInfo --- -Defined in: packages/ai/src/activities/chat/middleware/types.ts:562 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:592](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L592) Information passed to onFinish. @@ -15,7 +15,7 @@ Information passed to onFinish. content: string; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:568 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:598](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L598) Final accumulated text content @@ -27,7 +27,7 @@ Final accumulated text content duration: number; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:566 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:596](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L596) Total duration of the chat run in milliseconds @@ -39,7 +39,7 @@ Total duration of the chat run in milliseconds finishReason: string | null; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:564 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:594](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L594) The finish reason from the last model response @@ -51,6 +51,6 @@ The finish reason from the last model response optional usage?: TokenUsage; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:570 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:600](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L600) Final usage totals, if available (optionally including provider-reported cost) diff --git a/docs/reference/interfaces/GeneratedVoice.md b/docs/reference/interfaces/GeneratedVoice.md index 4f537b96af..277bb223de 100644 --- a/docs/reference/interfaces/GeneratedVoice.md +++ b/docs/reference/interfaces/GeneratedVoice.md @@ -3,7 +3,7 @@ id: GeneratedVoice title: GeneratedVoice --- -Defined in: packages/ai/src/types.ts:3063 +Defined in: [packages/ai/src/types.ts:3111](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3111) A single voice produced by [VoiceGenerationOptions](VoiceGenerationOptions.md). @@ -15,7 +15,7 @@ A single voice produced by [VoiceGenerationOptions](VoiceGenerationOptions.md). optional audio?: string; ``` -Defined in: packages/ai/src/types.ts:3070 +Defined in: [packages/ai/src/types.ts:3118](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3118) Base64-encoded preview audio, when the provider returns one @@ -27,7 +27,7 @@ Base64-encoded preview audio, when the provider returns one optional contentType?: string; ``` -Defined in: packages/ai/src/types.ts:3074 +Defined in: [packages/ai/src/types.ts:3122](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3122) Content type of the preview (e.g. 'audio/mpeg') @@ -39,7 +39,7 @@ Content type of the preview (e.g. 'audio/mpeg') optional duration?: number; ``` -Defined in: packages/ai/src/types.ts:3076 +Defined in: [packages/ai/src/types.ts:3124](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3124) Duration of the preview in seconds, if available @@ -51,7 +51,7 @@ Duration of the preview in seconds, if available optional format?: string; ``` -Defined in: packages/ai/src/types.ts:3072 +Defined in: [packages/ai/src/types.ts:3120](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3120) Audio format of the preview (e.g. 'mp3') @@ -63,7 +63,7 @@ Audio format of the preview (e.g. 'mp3') optional language?: string; ``` -Defined in: packages/ai/src/types.ts:3078 +Defined in: [packages/ai/src/types.ts:3126](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3126) Language of the preview, if reported @@ -75,7 +75,7 @@ Language of the preview, if reported saved: boolean; ``` -Defined in: packages/ai/src/types.ts:3083 +Defined in: [packages/ai/src/types.ts:3131](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3131) Whether the voice is persisted in the provider's voice library. Unsaved voices are previews and generally expire. @@ -88,7 +88,7 @@ voices are previews and generally expire. status: VoiceTrainingStatus; ``` -Defined in: packages/ai/src/types.ts:3088 +Defined in: [packages/ai/src/types.ts:3136](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3136) Whether the voice can be used in `generateSpeech()` yet. Required so a caller never has to guess: every adapter states it outright. @@ -101,7 +101,7 @@ caller never has to guess: every adapter states it outright. voiceId: string; ``` -Defined in: packages/ai/src/types.ts:3068 +Defined in: [packages/ai/src/types.ts:3116](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3116) The provider's voice identifier. Pass it straight back as the `voice` option on `generateSpeech()`. diff --git a/docs/reference/interfaces/GenerationAbortInfo.md b/docs/reference/interfaces/GenerationAbortInfo.md index 2cff04cc6f..dd1d653ec6 100644 --- a/docs/reference/interfaces/GenerationAbortInfo.md +++ b/docs/reference/interfaces/GenerationAbortInfo.md @@ -3,7 +3,7 @@ id: GenerationAbortInfo title: GenerationAbortInfo --- -Defined in: packages/ai/src/activities/middleware/types.ts:147 +Defined in: [packages/ai/src/activities/middleware/types.ts:147](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/middleware/types.ts#L147) Information passed to [GenerationMiddleware.onAbort](GenerationMiddleware.md#onabort). @@ -15,7 +15,7 @@ Information passed to [GenerationMiddleware.onAbort](GenerationMiddleware.md#ona duration: number; ``` -Defined in: packages/ai/src/activities/middleware/types.ts:151 +Defined in: [packages/ai/src/activities/middleware/types.ts:151](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/middleware/types.ts#L151) Wall-clock duration until the abort, in milliseconds. @@ -27,6 +27,6 @@ Wall-clock duration until the abort, in milliseconds. optional reason?: string; ``` -Defined in: packages/ai/src/activities/middleware/types.ts:149 +Defined in: [packages/ai/src/activities/middleware/types.ts:149](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/middleware/types.ts#L149) The reason for the abort, if provided. diff --git a/docs/reference/interfaces/GenerationErrorInfo.md b/docs/reference/interfaces/GenerationErrorInfo.md index 51eacfe5c6..2bf84a4d1c 100644 --- a/docs/reference/interfaces/GenerationErrorInfo.md +++ b/docs/reference/interfaces/GenerationErrorInfo.md @@ -3,7 +3,7 @@ id: GenerationErrorInfo title: GenerationErrorInfo --- -Defined in: packages/ai/src/activities/middleware/types.ts:155 +Defined in: [packages/ai/src/activities/middleware/types.ts:155](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/middleware/types.ts#L155) Information passed to [GenerationMiddleware.onError](GenerationMiddleware.md#onerror). @@ -15,7 +15,7 @@ Information passed to [GenerationMiddleware.onError](GenerationMiddleware.md#one duration: number; ``` -Defined in: packages/ai/src/activities/middleware/types.ts:159 +Defined in: [packages/ai/src/activities/middleware/types.ts:159](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/middleware/types.ts#L159) Wall-clock duration until the failure, in milliseconds. @@ -27,6 +27,6 @@ Wall-clock duration until the failure, in milliseconds. error: unknown; ``` -Defined in: packages/ai/src/activities/middleware/types.ts:157 +Defined in: [packages/ai/src/activities/middleware/types.ts:157](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/middleware/types.ts#L157) The thrown value (typically an `Error`). diff --git a/docs/reference/interfaces/GenerationFinishInfo.md b/docs/reference/interfaces/GenerationFinishInfo.md index 682211eddc..c408b4c598 100644 --- a/docs/reference/interfaces/GenerationFinishInfo.md +++ b/docs/reference/interfaces/GenerationFinishInfo.md @@ -3,7 +3,7 @@ id: GenerationFinishInfo title: GenerationFinishInfo --- -Defined in: packages/ai/src/activities/middleware/types.ts:139 +Defined in: [packages/ai/src/activities/middleware/types.ts:139](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/middleware/types.ts#L139) Information passed to [GenerationMiddleware.onFinish](GenerationMiddleware.md#onfinish). @@ -15,7 +15,7 @@ Information passed to [GenerationMiddleware.onFinish](GenerationMiddleware.md#on duration: number; ``` -Defined in: packages/ai/src/activities/middleware/types.ts:141 +Defined in: [packages/ai/src/activities/middleware/types.ts:141](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/middleware/types.ts#L141) Wall-clock duration of the activity call, in milliseconds. @@ -27,6 +27,6 @@ Wall-clock duration of the activity call, in milliseconds. optional usage?: TokenUsage; ``` -Defined in: packages/ai/src/activities/middleware/types.ts:143 +Defined in: [packages/ai/src/activities/middleware/types.ts:143](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/middleware/types.ts#L143) Unified usage, when the provider reported it. diff --git a/docs/reference/interfaces/GenerationMiddleware.md b/docs/reference/interfaces/GenerationMiddleware.md index df4bd4d582..27dd69a6b5 100644 --- a/docs/reference/interfaces/GenerationMiddleware.md +++ b/docs/reference/interfaces/GenerationMiddleware.md @@ -3,7 +3,7 @@ id: GenerationMiddleware title: GenerationMiddleware --- -Defined in: packages/ai/src/activities/middleware/types.ts:195 +Defined in: [packages/ai/src/activities/middleware/types.ts:195](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/middleware/types.ts#L195) Activity-agnostic, observe-only middleware. @@ -48,7 +48,7 @@ await generateImage({ optional name?: string; ``` -Defined in: packages/ai/src/activities/middleware/types.ts:197 +Defined in: [packages/ai/src/activities/middleware/types.ts:197](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/middleware/types.ts#L197) Optional name, surfaced in diagnostics. @@ -60,7 +60,7 @@ Optional name, surfaced in diagnostics. optional onAbort?: (ctx, info) => void | Promise; ``` -Defined in: packages/ai/src/activities/middleware/types.ts:211 +Defined in: [packages/ai/src/activities/middleware/types.ts:211](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/middleware/types.ts#L211) Called when the activity is aborted (e.g. an abandoned stream). @@ -86,7 +86,7 @@ Called when the activity is aborted (e.g. an abandoned stream). optional onError?: (ctx, info) => void | Promise; ``` -Defined in: packages/ai/src/activities/middleware/types.ts:216 +Defined in: [packages/ai/src/activities/middleware/types.ts:216](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/middleware/types.ts#L216) Called when the activity throws before completing. @@ -112,7 +112,7 @@ Called when the activity throws before completing. optional onFinish?: (ctx, info) => void | Promise; ``` -Defined in: packages/ai/src/activities/middleware/types.ts:206 +Defined in: [packages/ai/src/activities/middleware/types.ts:206](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/middleware/types.ts#L206) Called after the activity completes successfully. @@ -138,7 +138,7 @@ Called after the activity completes successfully. optional onStart?: (ctx) => void | Promise; ``` -Defined in: packages/ai/src/activities/middleware/types.ts:199 +Defined in: [packages/ai/src/activities/middleware/types.ts:199](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/middleware/types.ts#L199) Called before the adapter request begins. @@ -160,7 +160,7 @@ Called before the adapter request begins. optional onUsage?: (ctx, usage) => void | Promise; ``` -Defined in: packages/ai/src/activities/middleware/types.ts:201 +Defined in: [packages/ai/src/activities/middleware/types.ts:201](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/middleware/types.ts#L201) Called when the provider reports usage, before `onFinish`. diff --git a/docs/reference/interfaces/GenerationMiddlewareContext.md b/docs/reference/interfaces/GenerationMiddlewareContext.md index 46e287aed8..fea90d114a 100644 --- a/docs/reference/interfaces/GenerationMiddlewareContext.md +++ b/docs/reference/interfaces/GenerationMiddlewareContext.md @@ -3,7 +3,7 @@ id: GenerationMiddlewareContext title: GenerationMiddlewareContext --- -Defined in: packages/ai/src/activities/middleware/types.ts:61 +Defined in: [packages/ai/src/activities/middleware/types.ts:61](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/middleware/types.ts#L61) Stable context passed to every [GenerationMiddleware](GenerationMiddleware.md) hook. Created once per activity call and shared across the hooks of that call. @@ -27,7 +27,7 @@ extra fields is not assignable to `GenerationMiddleware`. activity: GenerationActivity; ``` -Defined in: packages/ai/src/activities/middleware/types.ts:68 +Defined in: [packages/ai/src/activities/middleware/types.ts:68](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/middleware/types.ts#L68) Which activity this call is. Discriminates media from chat. @@ -39,7 +39,7 @@ Which activity this call is. Discriminates media from chat. optional artifactInputs?: unknown; ``` -Defined in: packages/ai/src/activities/middleware/types.ts:108 +Defined in: [packages/ai/src/activities/middleware/types.ts:108](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/middleware/types.ts#L108) Activity inputs captured for middleware that needs to transform or persist the result together with reconstructable request metadata. @@ -52,7 +52,7 @@ the result together with reconstructable request metadata. context: TContext; ``` -Defined in: packages/ai/src/activities/middleware/types.ts:88 +Defined in: [packages/ai/src/activities/middleware/types.ts:88](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/middleware/types.ts#L88) Runtime context provided by the activity options, if any. @@ -64,7 +64,7 @@ Runtime context provided by the activity options, if any. createId: (prefix) => string; ``` -Defined in: packages/ai/src/activities/middleware/types.ts:86 +Defined in: [packages/ai/src/activities/middleware/types.ts:86](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/middleware/types.ts#L86) Generate a unique id with the given prefix. @@ -86,7 +86,7 @@ Generate a unique id with the given prefix. model: string; ``` -Defined in: packages/ai/src/activities/middleware/types.ts:72 +Defined in: [packages/ai/src/activities/middleware/types.ts:72](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/middleware/types.ts#L72) Model id. Emitted as `gen_ai.request.model`. @@ -98,7 +98,7 @@ Model id. Emitted as `gen_ai.request.model`. optional modelOptions?: unknown; ``` -Defined in: packages/ai/src/activities/middleware/types.ts:82 +Defined in: [packages/ai/src/activities/middleware/types.ts:82](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/middleware/types.ts#L82) Provider-specific options passed to the activity, if any. Typed `unknown` because each activity's options are strongly typed per model; a supertype @@ -112,7 +112,7 @@ of `ChatMiddlewareContext`'s `modelOptions`. provider: string; ``` -Defined in: packages/ai/src/activities/middleware/types.ts:70 +Defined in: [packages/ai/src/activities/middleware/types.ts:70](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/middleware/types.ts#L70) Provider/adapter name (e.g. `"openai"`). Emitted as `gen_ai.system`. @@ -124,7 +124,7 @@ Provider/adapter name (e.g. `"openai"`). Emitted as `gen_ai.system`. requestId: string; ``` -Defined in: packages/ai/src/activities/middleware/types.ts:66 +Defined in: [packages/ai/src/activities/middleware/types.ts:66](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/middleware/types.ts#L66) Stable id correlating the `onStart` / `onFinish` / `onError` / `onAbort` hooks of a single activity call. @@ -137,7 +137,7 @@ hooks of a single activity call. resultTransforms: GenerationResultTransform[]; ``` -Defined in: packages/ai/src/activities/middleware/types.ts:103 +Defined in: [packages/ai/src/activities/middleware/types.ts:103](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/middleware/types.ts#L103) Result transforms registered by middleware during this activity call. Transforms run after the raw adapter result exists and before the final @@ -160,7 +160,7 @@ data. Every context the library builds comes from optional runId?: string; ``` -Defined in: packages/ai/src/activities/middleware/types.ts:76 +Defined in: [packages/ai/src/activities/middleware/types.ts:76](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/middleware/types.ts#L76) Stable run id, when supplied by the caller. @@ -172,7 +172,7 @@ Stable run id, when supplied by the caller. source: "server" | "client"; ``` -Defined in: packages/ai/src/activities/middleware/types.ts:84 +Defined in: [packages/ai/src/activities/middleware/types.ts:84](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/middleware/types.ts#L84) Where the call originates. Always `'server'` for media activities. @@ -184,6 +184,6 @@ Where the call originates. Always `'server'` for media activities. optional threadId?: string; ``` -Defined in: packages/ai/src/activities/middleware/types.ts:74 +Defined in: [packages/ai/src/activities/middleware/types.ts:74](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/middleware/types.ts#L74) Stable conversation/thread id. Always set, except for `getVideoJobStatus` polls. diff --git a/docs/reference/interfaces/GenerationResultTransformContext.md b/docs/reference/interfaces/GenerationResultTransformContext.md index 5ef376cc41..778b469884 100644 --- a/docs/reference/interfaces/GenerationResultTransformContext.md +++ b/docs/reference/interfaces/GenerationResultTransformContext.md @@ -3,7 +3,7 @@ id: GenerationResultTransformContext title: GenerationResultTransformContext --- -Defined in: packages/ai/src/activities/middleware/types.ts:112 +Defined in: [packages/ai/src/activities/middleware/types.ts:112](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/middleware/types.ts#L112) Stable context handed to each [GenerationResultTransform](../type-aliases/GenerationResultTransform.md). @@ -21,6 +21,6 @@ Stable context handed to each [GenerationResultTransform](../type-aliases/Genera middleware: GenerationMiddlewareContext; ``` -Defined in: packages/ai/src/activities/middleware/types.ts:114 +Defined in: [packages/ai/src/activities/middleware/types.ts:114](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/middleware/types.ts#L114) The activity call being transformed. diff --git a/docs/reference/interfaces/GenerationUsageInfo.md b/docs/reference/interfaces/GenerationUsageInfo.md index a253831372..8de5cba834 100644 --- a/docs/reference/interfaces/GenerationUsageInfo.md +++ b/docs/reference/interfaces/GenerationUsageInfo.md @@ -3,7 +3,7 @@ id: GenerationUsageInfo title: GenerationUsageInfo --- -Defined in: packages/ai/src/activities/middleware/types.ts:136 +Defined in: [packages/ai/src/activities/middleware/types.ts:136](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/middleware/types.ts#L136) Token usage passed to [GenerationMiddleware.onUsage](GenerationMiddleware.md#onusage). Kept as an interface extending `TokenUsage` to preserve declaration merging for this diff --git a/docs/reference/interfaces/GenericInterruptContinuation.md b/docs/reference/interfaces/GenericInterruptContinuation.md index 3ea9c919a6..963cf06442 100644 --- a/docs/reference/interfaces/GenericInterruptContinuation.md +++ b/docs/reference/interfaces/GenericInterruptContinuation.md @@ -3,7 +3,7 @@ id: GenericInterruptContinuation title: GenericInterruptContinuation --- -Defined in: packages/ai/src/generic-interrupt-continuation.ts:16 +Defined in: [packages/ai/src/generic-interrupt-continuation.ts:16](https://github.com/TanStack/ai/blob/main/packages/ai/src/generic-interrupt-continuation.ts#L16) ## Properties @@ -13,7 +13,7 @@ Defined in: packages/ai/src/generic-interrupt-continuation.ts:16 batchIndex: number; ``` -Defined in: packages/ai/src/generic-interrupt-continuation.ts:20 +Defined in: [packages/ai/src/generic-interrupt-continuation.ts:20](https://github.com/TanStack/ai/blob/main/packages/ai/src/generic-interrupt-continuation.ts#L20) *** @@ -23,7 +23,7 @@ Defined in: packages/ai/src/generic-interrupt-continuation.ts:20 definitionId: string; ``` -Defined in: packages/ai/src/generic-interrupt-continuation.ts:18 +Defined in: [packages/ai/src/generic-interrupt-continuation.ts:18](https://github.com/TanStack/ai/blob/main/packages/ai/src/generic-interrupt-continuation.ts#L18) *** @@ -33,7 +33,7 @@ Defined in: packages/ai/src/generic-interrupt-continuation.ts:18 optional expiresAt?: string; ``` -Defined in: packages/ai/src/generic-interrupt-continuation.ts:23 +Defined in: [packages/ai/src/generic-interrupt-continuation.ts:23](https://github.com/TanStack/ai/blob/main/packages/ai/src/generic-interrupt-continuation.ts#L23) *** @@ -43,7 +43,7 @@ Defined in: packages/ai/src/generic-interrupt-continuation.ts:23 key: string; ``` -Defined in: packages/ai/src/generic-interrupt-continuation.ts:19 +Defined in: [packages/ai/src/generic-interrupt-continuation.ts:19](https://github.com/TanStack/ai/blob/main/packages/ai/src/generic-interrupt-continuation.ts#L19) *** @@ -53,7 +53,7 @@ Defined in: packages/ai/src/generic-interrupt-continuation.ts:19 message: string; ``` -Defined in: packages/ai/src/generic-interrupt-continuation.ts:22 +Defined in: [packages/ai/src/generic-interrupt-continuation.ts:22](https://github.com/TanStack/ai/blob/main/packages/ai/src/generic-interrupt-continuation.ts#L22) *** @@ -63,7 +63,7 @@ Defined in: packages/ai/src/generic-interrupt-continuation.ts:22 optional payload?: unknown; ``` -Defined in: packages/ai/src/generic-interrupt-continuation.ts:26 +Defined in: [packages/ai/src/generic-interrupt-continuation.ts:26](https://github.com/TanStack/ai/blob/main/packages/ai/src/generic-interrupt-continuation.ts#L26) *** @@ -73,7 +73,7 @@ Defined in: packages/ai/src/generic-interrupt-continuation.ts:26 optional payloadSchemaHash?: string; ``` -Defined in: packages/ai/src/generic-interrupt-continuation.ts:25 +Defined in: [packages/ai/src/generic-interrupt-continuation.ts:25](https://github.com/TanStack/ai/blob/main/packages/ai/src/generic-interrupt-continuation.ts#L25) *** @@ -83,7 +83,7 @@ Defined in: packages/ai/src/generic-interrupt-continuation.ts:25 reason: string; ``` -Defined in: packages/ai/src/generic-interrupt-continuation.ts:21 +Defined in: [packages/ai/src/generic-interrupt-continuation.ts:21](https://github.com/TanStack/ai/blob/main/packages/ai/src/generic-interrupt-continuation.ts#L21) *** @@ -93,7 +93,7 @@ Defined in: packages/ai/src/generic-interrupt-continuation.ts:21 optional responseSchemaHash?: string; ``` -Defined in: packages/ai/src/generic-interrupt-continuation.ts:24 +Defined in: [packages/ai/src/generic-interrupt-continuation.ts:24](https://github.com/TanStack/ai/blob/main/packages/ai/src/generic-interrupt-continuation.ts#L24) *** @@ -103,4 +103,4 @@ Defined in: packages/ai/src/generic-interrupt-continuation.ts:24 v: 1; ``` -Defined in: packages/ai/src/generic-interrupt-continuation.ts:17 +Defined in: [packages/ai/src/generic-interrupt-continuation.ts:17](https://github.com/TanStack/ai/blob/main/packages/ai/src/generic-interrupt-continuation.ts#L17) diff --git a/docs/reference/interfaces/ImageAdapter.md b/docs/reference/interfaces/ImageAdapter.md index 7470e7ef5b..90304fc49b 100644 --- a/docs/reference/interfaces/ImageAdapter.md +++ b/docs/reference/interfaces/ImageAdapter.md @@ -3,7 +3,7 @@ id: ImageAdapter title: ImageAdapter --- -Defined in: packages/ai/src/activities/generateImage/adapter.ts:39 +Defined in: [packages/ai/src/activities/generateImage/adapter.ts:39](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateImage/adapter.ts#L39) Image adapter interface with pre-resolved generics. @@ -48,7 +48,7 @@ Generic parameters: ~types: object; ``` -Defined in: packages/ai/src/activities/generateImage/adapter.ts:67 +Defined in: [packages/ai/src/activities/generateImage/adapter.ts:67](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateImage/adapter.ts#L67) **`Internal`** @@ -86,7 +86,7 @@ providerOptions: TProviderOptions; generateImages: (options) => Promise; ``` -Defined in: packages/ai/src/activities/generateImage/adapter.ts:77 +Defined in: [packages/ai/src/activities/generateImage/adapter.ts:77](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateImage/adapter.ts#L77) Generate images from a prompt @@ -108,7 +108,7 @@ Generate images from a prompt readonly kind: "image"; ``` -Defined in: packages/ai/src/activities/generateImage/adapter.ts:51 +Defined in: [packages/ai/src/activities/generateImage/adapter.ts:51](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateImage/adapter.ts#L51) Discriminator for adapter kind - used by generate() to determine API shape @@ -120,7 +120,7 @@ Discriminator for adapter kind - used by generate() to determine API shape readonly model: TModel; ``` -Defined in: packages/ai/src/activities/generateImage/adapter.ts:62 +Defined in: [packages/ai/src/activities/generateImage/adapter.ts:62](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateImage/adapter.ts#L62) The model this adapter is configured for @@ -132,7 +132,7 @@ The model this adapter is configured for readonly name: string; ``` -Defined in: packages/ai/src/activities/generateImage/adapter.ts:53 +Defined in: [packages/ai/src/activities/generateImage/adapter.ts:53](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateImage/adapter.ts#L53) Adapter name identifier @@ -144,7 +144,7 @@ Adapter name identifier readonly optional supportsFileSources?: boolean; ``` -Defined in: packages/ai/src/activities/generateImage/adapter.ts:60 +Defined in: [packages/ai/src/activities/generateImage/adapter.ts:60](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateImage/adapter.ts#L60) Declares that this adapter can consume `{ type: 'file' }` content sources (provider Files API references). The activity dispatcher rejects diff --git a/docs/reference/interfaces/ImageGenerationOptions.md b/docs/reference/interfaces/ImageGenerationOptions.md index 57d2d7950f..a0776b5243 100644 --- a/docs/reference/interfaces/ImageGenerationOptions.md +++ b/docs/reference/interfaces/ImageGenerationOptions.md @@ -3,7 +3,7 @@ id: ImageGenerationOptions title: ImageGenerationOptions --- -Defined in: packages/ai/src/types.ts:2344 +Defined in: [packages/ai/src/types.ts:2402](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2402) Options for image generation. These are the common options supported across providers. @@ -26,7 +26,7 @@ These are the common options supported across providers. optional abortSignal?: AbortSignal; ``` -Defined in: packages/ai/src/types.ts:2376 +Defined in: [packages/ai/src/types.ts:2434](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2434) Effective abort signal composed by the activity from caller `abortSignal` and/or `timeout`. Adapters should forward this to the provider SDK when @@ -40,7 +40,7 @@ supported. Request-specific — never store on a global client config. logger: InternalLogger; ``` -Defined in: packages/ai/src/types.ts:2370 +Defined in: [packages/ai/src/types.ts:2428](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2428) Internal logger threaded from the generateImage() entry point. Adapters must call logger.request() before the SDK call and logger.errors() in catch blocks. @@ -53,7 +53,7 @@ call logger.request() before the SDK call and logger.errors() in catch blocks. model: string; ``` -Defined in: packages/ai/src/types.ts:2349 +Defined in: [packages/ai/src/types.ts:2407](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2407) The model to use for image generation @@ -65,7 +65,7 @@ The model to use for image generation optional modelOptions?: TProviderOptions; ``` -Defined in: packages/ai/src/types.ts:2365 +Defined in: [packages/ai/src/types.ts:2423](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2423) Model-specific options for image generation @@ -77,7 +77,7 @@ Model-specific options for image generation optional numberOfImages?: number; ``` -Defined in: packages/ai/src/types.ts:2361 +Defined in: [packages/ai/src/types.ts:2419](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2419) Number of images to generate (default: 1) @@ -89,7 +89,7 @@ Number of images to generate (default: 1) prompt: MediaPrompt; ``` -Defined in: packages/ai/src/types.ts:2359 +Defined in: [packages/ai/src/types.ts:2417](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2417) Description of the desired image(s): a plain string, or an ordered array of content parts for image-conditioned generation (image-to-image, @@ -107,6 +107,6 @@ multimodal `contents`, OpenAI `images.edit()`, fal `image_url` / optional size?: TSize; ``` -Defined in: packages/ai/src/types.ts:2363 +Defined in: [packages/ai/src/types.ts:2421](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2421) Image size in WIDTHxHEIGHT format (e.g., "1024x1024") diff --git a/docs/reference/interfaces/ImageGenerationResult.md b/docs/reference/interfaces/ImageGenerationResult.md index 6715f00696..a44a1b0164 100644 --- a/docs/reference/interfaces/ImageGenerationResult.md +++ b/docs/reference/interfaces/ImageGenerationResult.md @@ -3,7 +3,7 @@ id: ImageGenerationResult title: ImageGenerationResult --- -Defined in: packages/ai/src/types.ts:2452 +Defined in: [packages/ai/src/types.ts:2510](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2510) Result of image generation @@ -15,7 +15,7 @@ Result of image generation optional artifacts?: PersistedArtifactRef[]; ``` -Defined in: packages/ai/src/types.ts:2462 +Defined in: [packages/ai/src/types.ts:2520](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2520) Persisted artifact references for generated assets, when available @@ -27,7 +27,7 @@ Persisted artifact references for generated assets, when available id: string; ``` -Defined in: packages/ai/src/types.ts:2454 +Defined in: [packages/ai/src/types.ts:2512](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2512) Unique identifier for the generation @@ -39,7 +39,7 @@ Unique identifier for the generation images: GeneratedImage[]; ``` -Defined in: packages/ai/src/types.ts:2458 +Defined in: [packages/ai/src/types.ts:2516](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2516) Array of generated images @@ -51,7 +51,7 @@ Array of generated images model: string; ``` -Defined in: packages/ai/src/types.ts:2456 +Defined in: [packages/ai/src/types.ts:2514](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2514) Model used for generation @@ -63,6 +63,6 @@ Model used for generation optional usage?: TokenUsage; ``` -Defined in: packages/ai/src/types.ts:2460 +Defined in: [packages/ai/src/types.ts:2518](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2518) Token usage information (if available) diff --git a/docs/reference/interfaces/ImagePart.md b/docs/reference/interfaces/ImagePart.md index 954b83e9b1..c34afb1090 100644 --- a/docs/reference/interfaces/ImagePart.md +++ b/docs/reference/interfaces/ImagePart.md @@ -3,7 +3,7 @@ id: ImagePart title: ImagePart --- -Defined in: packages/ai/src/types.ts:288 +Defined in: [packages/ai/src/types.ts:291](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L291) Image content part for multimodal messages. AG-UI `ImagePart` with typed metadata. @@ -27,7 +27,7 @@ Provider-specific metadata type (e.g., OpenAI's detail level) optional metadata?: TMetadata; ``` -Defined in: packages/ai/src/types.ts:290 +Defined in: [packages/ai/src/types.ts:293](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L293) Provider-specific metadata (e.g., OpenAI's detail: 'auto' | 'low' | 'high') diff --git a/docs/reference/interfaces/InternalToolCallState.md b/docs/reference/interfaces/InternalToolCallState.md index d10e999551..96cf8be2ac 100644 --- a/docs/reference/interfaces/InternalToolCallState.md +++ b/docs/reference/interfaces/InternalToolCallState.md @@ -3,7 +3,7 @@ id: InternalToolCallState title: InternalToolCallState --- -Defined in: packages/ai/src/activities/chat/stream/types.ts:21 +Defined in: [packages/ai/src/activities/chat/stream/types.ts:21](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/types.ts#L21) Internal state for a tool call being tracked @@ -15,7 +15,7 @@ Internal state for a tool call being tracked arguments: string; ``` -Defined in: packages/ai/src/activities/chat/stream/types.ts:24 +Defined in: [packages/ai/src/activities/chat/stream/types.ts:24](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/types.ts#L24) *** @@ -25,7 +25,7 @@ Defined in: packages/ai/src/activities/chat/stream/types.ts:24 id: string; ``` -Defined in: packages/ai/src/activities/chat/stream/types.ts:22 +Defined in: [packages/ai/src/activities/chat/stream/types.ts:22](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/types.ts#L22) *** @@ -35,7 +35,7 @@ Defined in: packages/ai/src/activities/chat/stream/types.ts:22 index: number; ``` -Defined in: packages/ai/src/activities/chat/stream/types.ts:27 +Defined in: [packages/ai/src/activities/chat/stream/types.ts:27](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/types.ts#L27) *** @@ -45,7 +45,7 @@ Defined in: packages/ai/src/activities/chat/stream/types.ts:27 optional metadata?: Record; ``` -Defined in: packages/ai/src/activities/chat/stream/types.ts:32 +Defined in: [packages/ai/src/activities/chat/stream/types.ts:32](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/types.ts#L32) Provider-specific metadata that round-trips with the tool call (e.g. Gemini's `thoughtSignature`). Untyped at this layer because @@ -60,7 +60,7 @@ via their `TToolCallMetadata` generic. name: string; ``` -Defined in: packages/ai/src/activities/chat/stream/types.ts:23 +Defined in: [packages/ai/src/activities/chat/stream/types.ts:23](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/types.ts#L23) *** @@ -70,7 +70,7 @@ Defined in: packages/ai/src/activities/chat/stream/types.ts:23 optional parsedArguments?: any; ``` -Defined in: packages/ai/src/activities/chat/stream/types.ts:26 +Defined in: [packages/ai/src/activities/chat/stream/types.ts:26](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/types.ts#L26) *** @@ -80,4 +80,4 @@ Defined in: packages/ai/src/activities/chat/stream/types.ts:26 state: ToolCallState; ``` -Defined in: packages/ai/src/activities/chat/stream/types.ts:25 +Defined in: [packages/ai/src/activities/chat/stream/types.ts:25](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/types.ts#L25) diff --git a/docs/reference/interfaces/InterruptBindingDescriptor.md b/docs/reference/interfaces/InterruptBindingDescriptor.md index 64794c6b35..4d1c773343 100644 --- a/docs/reference/interfaces/InterruptBindingDescriptor.md +++ b/docs/reference/interfaces/InterruptBindingDescriptor.md @@ -3,7 +3,7 @@ id: InterruptBindingDescriptor title: InterruptBindingDescriptor --- -Defined in: packages/ai/src/interrupt-definition.ts:54 +Defined in: [packages/ai/src/interrupt-definition.ts:54](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupt-definition.ts#L54) ## Properties @@ -13,7 +13,7 @@ Defined in: packages/ai/src/interrupt-definition.ts:54 optional batchIndex?: number; ``` -Defined in: packages/ai/src/interrupt-definition.ts:62 +Defined in: [packages/ai/src/interrupt-definition.ts:62](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupt-definition.ts#L62) *** @@ -23,7 +23,7 @@ Defined in: packages/ai/src/interrupt-definition.ts:62 definitionId: string; ``` -Defined in: packages/ai/src/interrupt-definition.ts:57 +Defined in: [packages/ai/src/interrupt-definition.ts:57](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupt-definition.ts#L57) *** @@ -33,7 +33,7 @@ Defined in: packages/ai/src/interrupt-definition.ts:57 optional generation?: number; ``` -Defined in: packages/ai/src/interrupt-definition.ts:61 +Defined in: [packages/ai/src/interrupt-definition.ts:61](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupt-definition.ts#L61) *** @@ -43,7 +43,7 @@ Defined in: packages/ai/src/interrupt-definition.ts:61 optional interruptedRunId?: string; ``` -Defined in: packages/ai/src/interrupt-definition.ts:60 +Defined in: [packages/ai/src/interrupt-definition.ts:60](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupt-definition.ts#L60) *** @@ -53,7 +53,7 @@ Defined in: packages/ai/src/interrupt-definition.ts:60 key: string; ``` -Defined in: packages/ai/src/interrupt-definition.ts:58 +Defined in: [packages/ai/src/interrupt-definition.ts:58](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupt-definition.ts#L58) *** @@ -63,7 +63,7 @@ Defined in: packages/ai/src/interrupt-definition.ts:58 kind: "generic"; ``` -Defined in: packages/ai/src/interrupt-definition.ts:56 +Defined in: [packages/ai/src/interrupt-definition.ts:56](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupt-definition.ts#L56) *** @@ -73,7 +73,7 @@ Defined in: packages/ai/src/interrupt-definition.ts:56 optional payloadSchemaCanonicalJson?: string; ``` -Defined in: packages/ai/src/interrupt-definition.ts:64 +Defined in: [packages/ai/src/interrupt-definition.ts:64](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupt-definition.ts#L64) *** @@ -83,7 +83,7 @@ Defined in: packages/ai/src/interrupt-definition.ts:64 optional payloadSchemaHash?: string; ``` -Defined in: packages/ai/src/interrupt-definition.ts:65 +Defined in: [packages/ai/src/interrupt-definition.ts:65](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupt-definition.ts#L65) *** @@ -93,7 +93,7 @@ Defined in: packages/ai/src/interrupt-definition.ts:65 optional responseSchemaCanonicalJson?: string; ``` -Defined in: packages/ai/src/interrupt-definition.ts:63 +Defined in: [packages/ai/src/interrupt-definition.ts:63](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupt-definition.ts#L63) *** @@ -103,7 +103,7 @@ Defined in: packages/ai/src/interrupt-definition.ts:63 optional responseSchemaHash?: string; ``` -Defined in: packages/ai/src/interrupt-definition.ts:66 +Defined in: [packages/ai/src/interrupt-definition.ts:66](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupt-definition.ts#L66) *** @@ -113,7 +113,7 @@ Defined in: packages/ai/src/interrupt-definition.ts:66 optional threadId?: string; ``` -Defined in: packages/ai/src/interrupt-definition.ts:59 +Defined in: [packages/ai/src/interrupt-definition.ts:59](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupt-definition.ts#L59) *** @@ -123,4 +123,4 @@ Defined in: packages/ai/src/interrupt-definition.ts:59 v: 1; ``` -Defined in: packages/ai/src/interrupt-definition.ts:55 +Defined in: [packages/ai/src/interrupt-definition.ts:55](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupt-definition.ts#L55) diff --git a/docs/reference/interfaces/InterruptCorrelation.md b/docs/reference/interfaces/InterruptCorrelation.md index bfa224da7f..f06ba9da46 100644 --- a/docs/reference/interfaces/InterruptCorrelation.md +++ b/docs/reference/interfaces/InterruptCorrelation.md @@ -3,7 +3,7 @@ id: InterruptCorrelation title: InterruptCorrelation --- -Defined in: packages/ai/src/interrupts.ts:8 +Defined in: [packages/ai/src/interrupts.ts:8](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupts.ts#L8) ## Extended by @@ -18,7 +18,7 @@ Defined in: packages/ai/src/interrupts.ts:8 optional continuationRunId?: string; ``` -Defined in: packages/ai/src/interrupts.ts:13 +Defined in: [packages/ai/src/interrupts.ts:13](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupts.ts#L13) *** @@ -28,7 +28,7 @@ Defined in: packages/ai/src/interrupts.ts:13 generation: number; ``` -Defined in: packages/ai/src/interrupts.ts:11 +Defined in: [packages/ai/src/interrupts.ts:11](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupts.ts#L11) *** @@ -38,7 +38,7 @@ Defined in: packages/ai/src/interrupts.ts:11 interruptedRunId: string; ``` -Defined in: packages/ai/src/interrupts.ts:10 +Defined in: [packages/ai/src/interrupts.ts:10](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupts.ts#L10) *** @@ -48,7 +48,7 @@ Defined in: packages/ai/src/interrupts.ts:10 optional submissionId?: string; ``` -Defined in: packages/ai/src/interrupts.ts:12 +Defined in: [packages/ai/src/interrupts.ts:12](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupts.ts#L12) *** @@ -58,4 +58,4 @@ Defined in: packages/ai/src/interrupts.ts:12 threadId: string; ``` -Defined in: packages/ai/src/interrupts.ts:9 +Defined in: [packages/ai/src/interrupts.ts:9](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupts.ts#L9) diff --git a/docs/reference/interfaces/InterruptDefinition.md b/docs/reference/interfaces/InterruptDefinition.md index 45f0e2c8b5..0440863f54 100644 --- a/docs/reference/interfaces/InterruptDefinition.md +++ b/docs/reference/interfaces/InterruptDefinition.md @@ -3,7 +3,7 @@ id: InterruptDefinition title: InterruptDefinition --- -Defined in: packages/ai/src/interrupt-definition.ts:202 +Defined in: [packages/ai/src/interrupt-definition.ts:202](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupt-definition.ts#L202) ## Type Parameters @@ -35,7 +35,7 @@ Defined in: packages/ai/src/interrupt-definition.ts:202 readonly id: TId; ``` -Defined in: packages/ai/src/interrupt-definition.ts:209 +Defined in: [packages/ai/src/interrupt-definition.ts:209](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupt-definition.ts#L209) *** @@ -45,7 +45,7 @@ Defined in: packages/ai/src/interrupt-definition.ts:209 interrupt: (input) => GenericInterruptRequestFor, TPayloadSchema, TPayload>; ``` -Defined in: packages/ai/src/interrupt-definition.ts:212 +Defined in: [packages/ai/src/interrupt-definition.ts:212](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupt-definition.ts#L212) #### Type Parameters @@ -71,7 +71,7 @@ Defined in: packages/ai/src/interrupt-definition.ts:212 readonly payloadSchema: TPayloadSchema; ``` -Defined in: packages/ai/src/interrupt-definition.ts:210 +Defined in: [packages/ai/src/interrupt-definition.ts:210](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupt-definition.ts#L210) *** @@ -81,4 +81,4 @@ Defined in: packages/ai/src/interrupt-definition.ts:210 readonly responseSchema: TResponseSchema; ``` -Defined in: packages/ai/src/interrupt-definition.ts:211 +Defined in: [packages/ai/src/interrupt-definition.ts:211](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupt-definition.ts#L211) diff --git a/docs/reference/interfaces/InterruptDefinitionOptions.md b/docs/reference/interfaces/InterruptDefinitionOptions.md index 701f61aaa7..45038569f3 100644 --- a/docs/reference/interfaces/InterruptDefinitionOptions.md +++ b/docs/reference/interfaces/InterruptDefinitionOptions.md @@ -3,7 +3,7 @@ id: InterruptDefinitionOptions title: InterruptDefinitionOptions --- -Defined in: packages/ai/src/interrupt-definition.ts:44 +Defined in: [packages/ai/src/interrupt-definition.ts:44](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupt-definition.ts#L44) ## Type Parameters @@ -27,7 +27,7 @@ Defined in: packages/ai/src/interrupt-definition.ts:44 id: TId; ``` -Defined in: packages/ai/src/interrupt-definition.ts:49 +Defined in: [packages/ai/src/interrupt-definition.ts:49](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupt-definition.ts#L49) *** @@ -37,7 +37,7 @@ Defined in: packages/ai/src/interrupt-definition.ts:49 optional payloadSchema?: TPayloadSchema; ``` -Defined in: packages/ai/src/interrupt-definition.ts:50 +Defined in: [packages/ai/src/interrupt-definition.ts:50](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupt-definition.ts#L50) *** @@ -47,4 +47,4 @@ Defined in: packages/ai/src/interrupt-definition.ts:50 optional responseSchema?: TResponseSchema; ``` -Defined in: packages/ai/src/interrupt-definition.ts:51 +Defined in: [packages/ai/src/interrupt-definition.ts:51](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupt-definition.ts#L51) diff --git a/docs/reference/interfaces/InterruptResolutionCollection.md b/docs/reference/interfaces/InterruptResolutionCollection.md index 041ab441ca..6a3cad156d 100644 --- a/docs/reference/interfaces/InterruptResolutionCollection.md +++ b/docs/reference/interfaces/InterruptResolutionCollection.md @@ -3,7 +3,7 @@ id: InterruptResolutionCollection title: InterruptResolutionCollection --- -Defined in: packages/ai/src/activities/chat/middleware/types.ts:144 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:145](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L145) ## Type Parameters @@ -22,7 +22,7 @@ all: { }; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:154 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:155](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L155) #### Call Signature @@ -64,7 +64,7 @@ readonly [`GenericInterruptResolution`](../type-aliases/GenericInterruptResoluti for: (definition) => readonly GenericInterruptResolution[]; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:147 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:148](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L148) #### Type Parameters diff --git a/docs/reference/interfaces/ItemInterruptError.md b/docs/reference/interfaces/ItemInterruptError.md index 95abc7be85..90ede92ccb 100644 --- a/docs/reference/interfaces/ItemInterruptError.md +++ b/docs/reference/interfaces/ItemInterruptError.md @@ -3,7 +3,7 @@ id: ItemInterruptError title: ItemInterruptError --- -Defined in: packages/ai/src/interrupts.ts:41 +Defined in: [packages/ai/src/interrupts.ts:41](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupts.ts#L41) ## Extends @@ -17,7 +17,7 @@ Defined in: packages/ai/src/interrupts.ts:41 code: ItemInterruptErrorCode; ``` -Defined in: packages/ai/src/interrupts.ts:44 +Defined in: [packages/ai/src/interrupts.ts:44](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupts.ts#L44) *** @@ -27,7 +27,7 @@ Defined in: packages/ai/src/interrupts.ts:44 optional continuationRunId?: string; ``` -Defined in: packages/ai/src/interrupts.ts:13 +Defined in: [packages/ai/src/interrupts.ts:13](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupts.ts#L13) #### Inherited from @@ -41,7 +41,7 @@ Defined in: packages/ai/src/interrupts.ts:13 generation: number; ``` -Defined in: packages/ai/src/interrupts.ts:11 +Defined in: [packages/ai/src/interrupts.ts:11](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupts.ts#L11) #### Inherited from @@ -55,7 +55,7 @@ Defined in: packages/ai/src/interrupts.ts:11 interruptedRunId: string; ``` -Defined in: packages/ai/src/interrupts.ts:10 +Defined in: [packages/ai/src/interrupts.ts:10](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupts.ts#L10) #### Inherited from @@ -69,7 +69,7 @@ Defined in: packages/ai/src/interrupts.ts:10 interruptId: string; ``` -Defined in: packages/ai/src/interrupts.ts:43 +Defined in: [packages/ai/src/interrupts.ts:43](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupts.ts#L43) *** @@ -79,7 +79,7 @@ Defined in: packages/ai/src/interrupts.ts:43 message: string; ``` -Defined in: packages/ai/src/interrupts.ts:45 +Defined in: [packages/ai/src/interrupts.ts:45](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupts.ts#L45) *** @@ -89,7 +89,7 @@ Defined in: packages/ai/src/interrupts.ts:45 optional path?: readonly (string | number)[]; ``` -Defined in: packages/ai/src/interrupts.ts:46 +Defined in: [packages/ai/src/interrupts.ts:46](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupts.ts#L46) *** @@ -99,7 +99,7 @@ Defined in: packages/ai/src/interrupts.ts:46 retryable: boolean; ``` -Defined in: packages/ai/src/interrupts.ts:48 +Defined in: [packages/ai/src/interrupts.ts:48](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupts.ts#L48) *** @@ -109,7 +109,7 @@ Defined in: packages/ai/src/interrupts.ts:48 scope: "item"; ``` -Defined in: packages/ai/src/interrupts.ts:42 +Defined in: [packages/ai/src/interrupts.ts:42](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupts.ts#L42) *** @@ -119,7 +119,7 @@ Defined in: packages/ai/src/interrupts.ts:42 source: "server" | "client"; ``` -Defined in: packages/ai/src/interrupts.ts:47 +Defined in: [packages/ai/src/interrupts.ts:47](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupts.ts#L47) *** @@ -129,7 +129,7 @@ Defined in: packages/ai/src/interrupts.ts:47 optional submissionId?: string; ``` -Defined in: packages/ai/src/interrupts.ts:12 +Defined in: [packages/ai/src/interrupts.ts:12](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupts.ts#L12) #### Inherited from @@ -143,7 +143,7 @@ Defined in: packages/ai/src/interrupts.ts:12 threadId: string; ``` -Defined in: packages/ai/src/interrupts.ts:9 +Defined in: [packages/ai/src/interrupts.ts:9](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupts.ts#L9) #### Inherited from diff --git a/docs/reference/interfaces/IterationInfo.md b/docs/reference/interfaces/IterationInfo.md index 77a0710a1f..7bcaccbbf7 100644 --- a/docs/reference/interfaces/IterationInfo.md +++ b/docs/reference/interfaces/IterationInfo.md @@ -3,7 +3,7 @@ id: IterationInfo title: IterationInfo --- -Defined in: packages/ai/src/activities/chat/middleware/types.ts:501 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:531](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L531) Information passed to onIteration at the start of each agent loop iteration. @@ -15,7 +15,7 @@ Information passed to onIteration at the start of each agent loop iteration. iteration: number; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:503 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:533](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L533) 0-based iteration index @@ -27,6 +27,6 @@ Defined in: packages/ai/src/activities/chat/middleware/types.ts:503 messageId: string; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:505 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:535](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L535) The assistant message ID created for this iteration diff --git a/docs/reference/interfaces/JSONParser.md b/docs/reference/interfaces/JSONParser.md index 4093600040..6354dd48ae 100644 --- a/docs/reference/interfaces/JSONParser.md +++ b/docs/reference/interfaces/JSONParser.md @@ -3,7 +3,7 @@ id: JSONParser title: JSONParser --- -Defined in: packages/ai/src/activities/chat/stream/json-parser.ts:12 +Defined in: [packages/ai/src/activities/chat/stream/json-parser.ts:12](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/json-parser.ts#L12) JSON Parser interface - allows for custom parser implementations @@ -15,7 +15,7 @@ JSON Parser interface - allows for custom parser implementations parse: (jsonString) => any; ``` -Defined in: packages/ai/src/activities/chat/stream/json-parser.ts:18 +Defined in: [packages/ai/src/activities/chat/stream/json-parser.ts:18](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/json-parser.ts#L18) Parse a JSON string (may be incomplete/partial) diff --git a/docs/reference/interfaces/JSONSchema.md b/docs/reference/interfaces/JSONSchema.md index 650c694d62..f2f875a8a0 100644 --- a/docs/reference/interfaces/JSONSchema.md +++ b/docs/reference/interfaces/JSONSchema.md @@ -3,7 +3,7 @@ id: JSONSchema title: JSONSchema --- -Defined in: packages/ai/src/types.ts:114 +Defined in: [packages/ai/src/types.ts:117](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L117) JSON Schema type for defining tool input/output schemas as raw JSON Schema objects. This allows tools to be defined without schema libraries when you have JSON Schema definitions available. @@ -22,7 +22,7 @@ This allows tools to be defined without schema libraries when you have JSON Sche optional $defs?: Record; ``` -Defined in: packages/ai/src/types.ts:124 +Defined in: [packages/ai/src/types.ts:127](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L127) *** @@ -32,7 +32,7 @@ Defined in: packages/ai/src/types.ts:124 optional $ref?: string; ``` -Defined in: packages/ai/src/types.ts:123 +Defined in: [packages/ai/src/types.ts:126](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L126) *** @@ -42,7 +42,7 @@ Defined in: packages/ai/src/types.ts:123 optional additionalItems?: boolean | JSONSchema; ``` -Defined in: packages/ai/src/types.ts:145 +Defined in: [packages/ai/src/types.ts:148](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L148) *** @@ -52,7 +52,7 @@ Defined in: packages/ai/src/types.ts:145 optional additionalProperties?: boolean | JSONSchema; ``` -Defined in: packages/ai/src/types.ts:144 +Defined in: [packages/ai/src/types.ts:147](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L147) *** @@ -62,7 +62,7 @@ Defined in: packages/ai/src/types.ts:144 optional allOf?: JSONSchema[]; ``` -Defined in: packages/ai/src/types.ts:126 +Defined in: [packages/ai/src/types.ts:129](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L129) *** @@ -72,7 +72,7 @@ Defined in: packages/ai/src/types.ts:126 optional anyOf?: JSONSchema[]; ``` -Defined in: packages/ai/src/types.ts:127 +Defined in: [packages/ai/src/types.ts:130](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L130) *** @@ -82,7 +82,7 @@ Defined in: packages/ai/src/types.ts:127 optional const?: unknown; ``` -Defined in: packages/ai/src/types.ts:120 +Defined in: [packages/ai/src/types.ts:123](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L123) *** @@ -92,7 +92,7 @@ Defined in: packages/ai/src/types.ts:120 optional default?: unknown; ``` -Defined in: packages/ai/src/types.ts:122 +Defined in: [packages/ai/src/types.ts:125](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L125) *** @@ -102,7 +102,7 @@ Defined in: packages/ai/src/types.ts:122 optional definitions?: Record; ``` -Defined in: packages/ai/src/types.ts:125 +Defined in: [packages/ai/src/types.ts:128](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L128) *** @@ -112,7 +112,7 @@ Defined in: packages/ai/src/types.ts:125 optional description?: string; ``` -Defined in: packages/ai/src/types.ts:121 +Defined in: [packages/ai/src/types.ts:124](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L124) *** @@ -122,7 +122,7 @@ Defined in: packages/ai/src/types.ts:121 optional else?: JSONSchema; ``` -Defined in: packages/ai/src/types.ts:132 +Defined in: [packages/ai/src/types.ts:135](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L135) *** @@ -132,7 +132,7 @@ Defined in: packages/ai/src/types.ts:132 optional enum?: unknown[]; ``` -Defined in: packages/ai/src/types.ts:119 +Defined in: [packages/ai/src/types.ts:122](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L122) *** @@ -142,7 +142,7 @@ Defined in: packages/ai/src/types.ts:119 optional examples?: unknown[]; ``` -Defined in: packages/ai/src/types.ts:151 +Defined in: [packages/ai/src/types.ts:154](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L154) *** @@ -152,7 +152,7 @@ Defined in: packages/ai/src/types.ts:151 optional exclusiveMaximum?: number; ``` -Defined in: packages/ai/src/types.ts:136 +Defined in: [packages/ai/src/types.ts:139](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L139) *** @@ -162,7 +162,7 @@ Defined in: packages/ai/src/types.ts:136 optional exclusiveMinimum?: number; ``` -Defined in: packages/ai/src/types.ts:135 +Defined in: [packages/ai/src/types.ts:138](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L138) *** @@ -172,7 +172,7 @@ Defined in: packages/ai/src/types.ts:135 optional format?: string; ``` -Defined in: packages/ai/src/types.ts:140 +Defined in: [packages/ai/src/types.ts:143](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L143) *** @@ -182,7 +182,7 @@ Defined in: packages/ai/src/types.ts:140 optional if?: JSONSchema; ``` -Defined in: packages/ai/src/types.ts:130 +Defined in: [packages/ai/src/types.ts:133](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L133) *** @@ -192,7 +192,7 @@ Defined in: packages/ai/src/types.ts:130 optional items?: JSONSchema | JSONSchema[]; ``` -Defined in: packages/ai/src/types.ts:117 +Defined in: [packages/ai/src/types.ts:120](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L120) *** @@ -202,7 +202,7 @@ Defined in: packages/ai/src/types.ts:117 optional maximum?: number; ``` -Defined in: packages/ai/src/types.ts:134 +Defined in: [packages/ai/src/types.ts:137](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L137) *** @@ -212,7 +212,7 @@ Defined in: packages/ai/src/types.ts:134 optional maxItems?: number; ``` -Defined in: packages/ai/src/types.ts:142 +Defined in: [packages/ai/src/types.ts:145](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L145) *** @@ -222,7 +222,7 @@ Defined in: packages/ai/src/types.ts:142 optional maxLength?: number; ``` -Defined in: packages/ai/src/types.ts:138 +Defined in: [packages/ai/src/types.ts:141](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L141) *** @@ -232,7 +232,7 @@ Defined in: packages/ai/src/types.ts:138 optional maxProperties?: number; ``` -Defined in: packages/ai/src/types.ts:149 +Defined in: [packages/ai/src/types.ts:152](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L152) *** @@ -242,7 +242,7 @@ Defined in: packages/ai/src/types.ts:149 optional minimum?: number; ``` -Defined in: packages/ai/src/types.ts:133 +Defined in: [packages/ai/src/types.ts:136](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L136) *** @@ -252,7 +252,7 @@ Defined in: packages/ai/src/types.ts:133 optional minItems?: number; ``` -Defined in: packages/ai/src/types.ts:141 +Defined in: [packages/ai/src/types.ts:144](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L144) *** @@ -262,7 +262,7 @@ Defined in: packages/ai/src/types.ts:141 optional minLength?: number; ``` -Defined in: packages/ai/src/types.ts:137 +Defined in: [packages/ai/src/types.ts:140](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L140) *** @@ -272,7 +272,7 @@ Defined in: packages/ai/src/types.ts:137 optional minProperties?: number; ``` -Defined in: packages/ai/src/types.ts:148 +Defined in: [packages/ai/src/types.ts:151](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L151) *** @@ -282,7 +282,7 @@ Defined in: packages/ai/src/types.ts:148 optional not?: JSONSchema; ``` -Defined in: packages/ai/src/types.ts:129 +Defined in: [packages/ai/src/types.ts:132](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L132) *** @@ -292,7 +292,7 @@ Defined in: packages/ai/src/types.ts:129 optional oneOf?: JSONSchema[]; ``` -Defined in: packages/ai/src/types.ts:128 +Defined in: [packages/ai/src/types.ts:131](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L131) *** @@ -302,7 +302,7 @@ Defined in: packages/ai/src/types.ts:128 optional pattern?: string; ``` -Defined in: packages/ai/src/types.ts:139 +Defined in: [packages/ai/src/types.ts:142](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L142) *** @@ -312,7 +312,7 @@ Defined in: packages/ai/src/types.ts:139 optional patternProperties?: Record; ``` -Defined in: packages/ai/src/types.ts:146 +Defined in: [packages/ai/src/types.ts:149](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L149) *** @@ -322,7 +322,7 @@ Defined in: packages/ai/src/types.ts:146 optional properties?: Record; ``` -Defined in: packages/ai/src/types.ts:116 +Defined in: [packages/ai/src/types.ts:119](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L119) *** @@ -332,7 +332,7 @@ Defined in: packages/ai/src/types.ts:116 optional propertyNames?: JSONSchema; ``` -Defined in: packages/ai/src/types.ts:147 +Defined in: [packages/ai/src/types.ts:150](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L150) *** @@ -342,7 +342,7 @@ Defined in: packages/ai/src/types.ts:147 optional required?: string[]; ``` -Defined in: packages/ai/src/types.ts:118 +Defined in: [packages/ai/src/types.ts:121](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L121) *** @@ -352,7 +352,7 @@ Defined in: packages/ai/src/types.ts:118 optional then?: JSONSchema; ``` -Defined in: packages/ai/src/types.ts:131 +Defined in: [packages/ai/src/types.ts:134](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L134) *** @@ -362,7 +362,7 @@ Defined in: packages/ai/src/types.ts:131 optional title?: string; ``` -Defined in: packages/ai/src/types.ts:150 +Defined in: [packages/ai/src/types.ts:153](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L153) *** @@ -372,7 +372,7 @@ Defined in: packages/ai/src/types.ts:150 optional type?: string | string[]; ``` -Defined in: packages/ai/src/types.ts:115 +Defined in: [packages/ai/src/types.ts:118](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L118) *** @@ -382,4 +382,4 @@ Defined in: packages/ai/src/types.ts:115 optional uniqueItems?: boolean; ``` -Defined in: packages/ai/src/types.ts:143 +Defined in: [packages/ai/src/types.ts:146](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L146) diff --git a/docs/reference/interfaces/KeyedAdapter.md b/docs/reference/interfaces/KeyedAdapter.md index bfa8686e87..8506c95ca9 100644 --- a/docs/reference/interfaces/KeyedAdapter.md +++ b/docs/reference/interfaces/KeyedAdapter.md @@ -3,7 +3,7 @@ id: KeyedAdapter title: KeyedAdapter --- -Defined in: packages/ai/src/byok/keyed.ts:12 +Defined in: [packages/ai/src/byok/keyed.ts:12](https://github.com/TanStack/ai/blob/main/packages/ai/src/byok/keyed.ts#L12) An adapter that needs a provider key before it exists. Make one with [keyedAdapter](../functions/keyedAdapter.md). A host finds the key and calls `create` just before a @@ -23,7 +23,7 @@ call. readonly [KEYED_ADAPTER]: true; ``` -Defined in: packages/ai/src/byok/keyed.ts:13 +Defined in: [packages/ai/src/byok/keyed.ts:13](https://github.com/TanStack/ai/blob/main/packages/ai/src/byok/keyed.ts#L13) *** @@ -33,7 +33,7 @@ Defined in: packages/ai/src/byok/keyed.ts:13 readonly create: (key) => TAdapter; ``` -Defined in: packages/ai/src/byok/keyed.ts:17 +Defined in: [packages/ai/src/byok/keyed.ts:17](https://github.com/TanStack/ai/blob/main/packages/ai/src/byok/keyed.ts#L17) Builds the adapter from the key. @@ -55,6 +55,6 @@ Builds the adapter from the key. readonly provider: string | ByokProvider; ``` -Defined in: packages/ai/src/byok/keyed.ts:15 +Defined in: [packages/ai/src/byok/keyed.ts:15](https://github.com/TanStack/ai/blob/main/packages/ai/src/byok/keyed.ts#L15) The provider whose key `create` needs. diff --git a/docs/reference/interfaces/LazyToolsConfig.md b/docs/reference/interfaces/LazyToolsConfig.md index aea9329eae..243d1d9b66 100644 --- a/docs/reference/interfaces/LazyToolsConfig.md +++ b/docs/reference/interfaces/LazyToolsConfig.md @@ -3,7 +3,7 @@ id: LazyToolsConfig title: LazyToolsConfig --- -Defined in: packages/ai/src/types.ts:1096 +Defined in: [packages/ai/src/types.ts:1136](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1136) Configuration for the lazy-tool discovery catalog, shared by chat() and Code Mode. Optional in both — lazy behavior is triggered purely by tools @@ -19,7 +19,7 @@ always returns the full description + schema. optional includeDescription?: "full" | "first-sentence" | "none"; ``` -Defined in: packages/ai/src/types.ts:1102 +Defined in: [packages/ai/src/types.ts:1142](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1142) How much of each lazy tool's description appears in the pre-discovery catalog (the names list shown before the model discovers the tool). diff --git a/docs/reference/interfaces/ListVoicesOptions.md b/docs/reference/interfaces/ListVoicesOptions.md index a406575756..64c520bd91 100644 --- a/docs/reference/interfaces/ListVoicesOptions.md +++ b/docs/reference/interfaces/ListVoicesOptions.md @@ -3,7 +3,7 @@ id: ListVoicesOptions title: ListVoicesOptions --- -Defined in: packages/ai/src/types.ts:2987 +Defined in: [packages/ai/src/types.ts:3035](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3035) Options for listing a provider's voices. @@ -15,7 +15,7 @@ Options for listing a provider's voices. optional abortSignal?: AbortSignal; ``` -Defined in: packages/ai/src/types.ts:2997 +Defined in: [packages/ai/src/types.ts:3045](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3045) Effective abort signal. Adapters forward this to the provider SDK when supported. @@ -28,7 +28,7 @@ supported. optional origins?: VoiceOrigin[]; ``` -Defined in: packages/ai/src/types.ts:2992 +Defined in: [packages/ai/src/types.ts:3040](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3040) Restrict the result to voices of these origins. Adapters filter server side when the provider supports it, and in memory otherwise. diff --git a/docs/reference/interfaces/ListVoicesResult.md b/docs/reference/interfaces/ListVoicesResult.md index 7052f0b7d4..4e4caf567e 100644 --- a/docs/reference/interfaces/ListVoicesResult.md +++ b/docs/reference/interfaces/ListVoicesResult.md @@ -3,7 +3,7 @@ id: ListVoicesResult title: ListVoicesResult --- -Defined in: packages/ai/src/types.ts:3001 +Defined in: [packages/ai/src/types.ts:3049](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3049) Result of listing a provider's voices. @@ -15,6 +15,6 @@ Result of listing a provider's voices. voices: CatalogVoice[]; ``` -Defined in: packages/ai/src/types.ts:3003 +Defined in: [packages/ai/src/types.ts:3051](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3051) The voices available to this account diff --git a/docs/reference/interfaces/LiveVideoAdapter.md b/docs/reference/interfaces/LiveVideoAdapter.md index 41301dad18..c118fab703 100644 --- a/docs/reference/interfaces/LiveVideoAdapter.md +++ b/docs/reference/interfaces/LiveVideoAdapter.md @@ -3,7 +3,7 @@ id: LiveVideoAdapter title: LiveVideoAdapter --- -Defined in: packages/ai/src/activities/generateLiveVideo/adapter.ts:31 +Defined in: [packages/ai/src/activities/generateLiveVideo/adapter.ts:31](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateLiveVideo/adapter.ts#L31) **`Experimental`** @@ -36,7 +36,7 @@ Generic parameters: ~types: object; ``` -Defined in: packages/ai/src/activities/generateLiveVideo/adapter.ts:45 +Defined in: [packages/ai/src/activities/generateLiveVideo/adapter.ts:45](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateLiveVideo/adapter.ts#L45) **`Internal`** @@ -56,7 +56,7 @@ providerOptions: TProviderOptions; createLiveVideo: (options) => Promise; ``` -Defined in: packages/ai/src/activities/generateLiveVideo/adapter.ts:55 +Defined in: [packages/ai/src/activities/generateLiveVideo/adapter.ts:55](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateLiveVideo/adapter.ts#L55) **`Experimental`** @@ -83,7 +83,7 @@ prompt so a browser can connect, set the prompt, and start streaming. readonly kind: "liveVideo"; ``` -Defined in: packages/ai/src/activities/generateLiveVideo/adapter.ts:36 +Defined in: [packages/ai/src/activities/generateLiveVideo/adapter.ts:36](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateLiveVideo/adapter.ts#L36) **`Experimental`** @@ -97,7 +97,7 @@ Discriminator for adapter kind - used to determine API shape readonly model: TModel; ``` -Defined in: packages/ai/src/activities/generateLiveVideo/adapter.ts:40 +Defined in: [packages/ai/src/activities/generateLiveVideo/adapter.ts:40](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateLiveVideo/adapter.ts#L40) **`Experimental`** @@ -111,7 +111,7 @@ The model this adapter is configured for readonly name: string; ``` -Defined in: packages/ai/src/activities/generateLiveVideo/adapter.ts:38 +Defined in: [packages/ai/src/activities/generateLiveVideo/adapter.ts:38](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateLiveVideo/adapter.ts#L38) **`Experimental`** diff --git a/docs/reference/interfaces/LiveVideoGenerationOptions.md b/docs/reference/interfaces/LiveVideoGenerationOptions.md index 782e836764..935e63b897 100644 --- a/docs/reference/interfaces/LiveVideoGenerationOptions.md +++ b/docs/reference/interfaces/LiveVideoGenerationOptions.md @@ -3,7 +3,7 @@ id: LiveVideoGenerationOptions title: LiveVideoGenerationOptions --- -Defined in: packages/ai/src/types.ts:2766 +Defined in: [packages/ai/src/types.ts:2814](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2814) **`Experimental`** @@ -25,7 +25,7 @@ Options for live generation (prompt-steerable video sessions). optional abortSignal?: AbortSignal; ``` -Defined in: packages/ai/src/types.ts:2789 +Defined in: [packages/ai/src/types.ts:2837](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2837) **`Experimental`** @@ -41,7 +41,7 @@ supported. Request-specific — never store on a global client config. logger: InternalLogger; ``` -Defined in: packages/ai/src/types.ts:2783 +Defined in: [packages/ai/src/types.ts:2831](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2831) **`Experimental`** @@ -57,7 +57,7 @@ catch blocks. model: string; ``` -Defined in: packages/ai/src/types.ts:2770 +Defined in: [packages/ai/src/types.ts:2818](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2818) **`Experimental`** @@ -71,7 +71,7 @@ The model to use for live generation optional modelOptions?: TProviderOptions; ``` -Defined in: packages/ai/src/types.ts:2777 +Defined in: [packages/ai/src/types.ts:2825](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2825) **`Experimental`** @@ -86,7 +86,7 @@ resolution/seed/audio are browser `sendCommand` fields. prompt: string; ``` -Defined in: packages/ai/src/types.ts:2772 +Defined in: [packages/ai/src/types.ts:2820](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2820) **`Experimental`** diff --git a/docs/reference/interfaces/LiveVideoGenerationResult.md b/docs/reference/interfaces/LiveVideoGenerationResult.md index 1787499d01..d0783779ab 100644 --- a/docs/reference/interfaces/LiveVideoGenerationResult.md +++ b/docs/reference/interfaces/LiveVideoGenerationResult.md @@ -3,7 +3,7 @@ id: LiveVideoGenerationResult title: LiveVideoGenerationResult --- -Defined in: packages/ai/src/types.ts:2802 +Defined in: [packages/ai/src/types.ts:2850](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2850) **`Experimental`** @@ -24,7 +24,7 @@ that attaches `FAL_KEY`. Do not send `token` as Key credentials. expiresAt: number; ``` -Defined in: packages/ai/src/types.ts:2813 +Defined in: [packages/ai/src/types.ts:2861](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2861) **`Experimental`** @@ -38,7 +38,7 @@ Token expiry as milliseconds since epoch id: string; ``` -Defined in: packages/ai/src/types.ts:2804 +Defined in: [packages/ai/src/types.ts:2852](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2852) **`Experimental`** @@ -52,7 +52,7 @@ Unique identifier for this generation model: string; ``` -Defined in: packages/ai/src/types.ts:2809 +Defined in: [packages/ai/src/types.ts:2857](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2857) **`Experimental`** @@ -67,7 +67,7 @@ fal: WMA app id `fal-ai/minimax-h3-max-director`. prompt: string; ``` -Defined in: packages/ai/src/types.ts:2815 +Defined in: [packages/ai/src/types.ts:2863](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2863) **`Experimental`** @@ -81,7 +81,7 @@ Prompt the client should send when it starts the session optional sessionId?: string; ``` -Defined in: packages/ai/src/types.ts:2819 +Defined in: [packages/ai/src/types.ts:2867](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2867) **`Experimental`** @@ -95,7 +95,7 @@ Provider session id, when the adapter created one status: "ready" | "waiting"; ``` -Defined in: packages/ai/src/types.ts:2817 +Defined in: [packages/ai/src/types.ts:2865](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2865) **`Experimental`** @@ -109,7 +109,7 @@ Session status after the server half finishes token: string; ``` -Defined in: packages/ai/src/types.ts:2811 +Defined in: [packages/ai/src/types.ts:2859](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2859) **`Experimental`** @@ -123,7 +123,7 @@ Short-lived session token. Reactor uses this to connect. fal does not. optional usage?: TokenUsage; ``` -Defined in: packages/ai/src/types.ts:2821 +Defined in: [packages/ai/src/types.ts:2869](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2869) **`Experimental`** diff --git a/docs/reference/interfaces/LogRecord.md b/docs/reference/interfaces/LogRecord.md index d0898163a4..474d864fd1 100644 --- a/docs/reference/interfaces/LogRecord.md +++ b/docs/reference/interfaces/LogRecord.md @@ -3,7 +3,7 @@ id: LogRecord title: LogRecord --- -Defined in: packages/ai/src/activities/chat/middleware/log-records.ts:7 +Defined in: [packages/ai/src/activities/chat/middleware/log-records.ts:7](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/log-records.ts#L7) One record of a session log. `type` names the kind of record. The other fields are JSON. @@ -22,4 +22,4 @@ fields are JSON. type: string; ``` -Defined in: packages/ai/src/activities/chat/middleware/log-records.ts:8 +Defined in: [packages/ai/src/activities/chat/middleware/log-records.ts:8](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/log-records.ts#L8) diff --git a/docs/reference/interfaces/LogRecordsWriter.md b/docs/reference/interfaces/LogRecordsWriter.md index d76bc25c96..293f98cffc 100644 --- a/docs/reference/interfaces/LogRecordsWriter.md +++ b/docs/reference/interfaces/LogRecordsWriter.md @@ -3,7 +3,7 @@ id: LogRecordsWriter title: LogRecordsWriter --- -Defined in: packages/ai/src/activities/chat/middleware/log-records.ts:16 +Defined in: [packages/ai/src/activities/chat/middleware/log-records.ts:16](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/log-records.ts#L16) Appends records to the session log that a host keeps. A host is a middleware that provides this capability. `chat()` does not provide it. @@ -16,7 +16,7 @@ middleware that provides this capability. `chat()` does not provide it. append: (records) => Promise; ``` -Defined in: packages/ai/src/activities/chat/middleware/log-records.ts:22 +Defined in: [packages/ai/src/activities/chat/middleware/log-records.ts:22](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/log-records.ts#L22) Resolves when the host has written all the records. Rejects when the host refuses a record or the write fails. Then the host writes none of diff --git a/docs/reference/interfaces/Logger.md b/docs/reference/interfaces/Logger.md index 90581b9f13..dedbb6a711 100644 --- a/docs/reference/interfaces/Logger.md +++ b/docs/reference/interfaces/Logger.md @@ -3,7 +3,7 @@ id: Logger title: Logger --- -Defined in: packages/ai/src/logger/types.ts:4 +Defined in: [packages/ai/src/logger/types.ts:4](https://github.com/TanStack/ai/blob/main/packages/ai/src/logger/types.ts#L4) Pluggable logger interface consumed by every `@tanstack/ai` activity when `debug` is enabled. Supply a custom implementation via `debug: { logger }` on `chat()`, `summarize()`, `generateImage()`, etc. The four methods correspond to log levels: use `debug` for chunk-level diagnostic output, `info`/`warn` for notable events, `error` for caught exceptions. @@ -15,7 +15,7 @@ Pluggable logger interface consumed by every `@tanstack/ai` activity when `debug debug: (message, meta?) => void; ``` -Defined in: packages/ai/src/logger/types.ts:9 +Defined in: [packages/ai/src/logger/types.ts:9](https://github.com/TanStack/ai/blob/main/packages/ai/src/logger/types.ts#L9) Called for chunk-level diagnostic output (raw provider chunks, per-chunk output, agent-loop iteration markers). @@ -43,7 +43,7 @@ Structured data forwarded to the underlying logger. Loggers like pino will prese error: (message, meta?) => void; ``` -Defined in: packages/ai/src/logger/types.ts:24 +Defined in: [packages/ai/src/logger/types.ts:24](https://github.com/TanStack/ai/blob/main/packages/ai/src/logger/types.ts#L24) Called for caught exceptions throughout the pipeline. @@ -71,7 +71,7 @@ Structured data forwarded to the underlying logger. Loggers like pino will prese info: (message, meta?) => void; ``` -Defined in: packages/ai/src/logger/types.ts:14 +Defined in: [packages/ai/src/logger/types.ts:14](https://github.com/TanStack/ai/blob/main/packages/ai/src/logger/types.ts#L14) Called for notable informational events (outgoing requests, tool invocations, middleware transitions). @@ -99,7 +99,7 @@ Structured data forwarded to the underlying logger. Loggers like pino will prese warn: (message, meta?) => void; ``` -Defined in: packages/ai/src/logger/types.ts:19 +Defined in: [packages/ai/src/logger/types.ts:19](https://github.com/TanStack/ai/blob/main/packages/ai/src/logger/types.ts#L19) Called for notable warnings that don't halt execution (deprecations, recoverable anomalies). diff --git a/docs/reference/interfaces/MCPToolSource.md b/docs/reference/interfaces/MCPToolSource.md index cb89d35e0d..22167b71dd 100644 --- a/docs/reference/interfaces/MCPToolSource.md +++ b/docs/reference/interfaces/MCPToolSource.md @@ -3,7 +3,7 @@ id: MCPToolSource title: MCPToolSource --- -Defined in: packages/ai/src/activities/chat/mcp/types.ts:25 +Defined in: [packages/ai/src/activities/chat/mcp/types.ts:25](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/mcp/types.ts#L25) Minimal structural shape that `chat({ mcp })` needs from an MCP client. @@ -19,7 +19,7 @@ shape — the core `@tanstack/ai` package does NOT import `@tanstack/ai-mcp` close: () => Promise; ``` -Defined in: packages/ai/src/activities/chat/mcp/types.ts:30 +Defined in: [packages/ai/src/activities/chat/mcp/types.ts:30](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/mcp/types.ts#L30) #### Returns @@ -33,7 +33,7 @@ Defined in: packages/ai/src/activities/chat/mcp/types.ts:30 optional readResource?: (uri) => Promise; ``` -Defined in: packages/ai/src/activities/chat/mcp/types.ts:38 +Defined in: [packages/ai/src/activities/chat/mcp/types.ts:38](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/mcp/types.ts#L38) Reads an MCP resource by URI. Used by the chat manager to eagerly fetch `ui://` resource widgets (MCP Apps) after a tool result resolves. @@ -59,7 +59,7 @@ this method. `ai-mcp`'s `MCPClient` satisfies this structurally. tools: (options?) => Promise; ``` -Defined in: packages/ai/src/activities/chat/mcp/types.ts:29 +Defined in: [packages/ai/src/activities/chat/mcp/types.ts:29](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/mcp/types.ts#L29) #### Parameters diff --git a/docs/reference/interfaces/MediaInputMetadata.md b/docs/reference/interfaces/MediaInputMetadata.md index 0329c83d3e..5c627a2afa 100644 --- a/docs/reference/interfaces/MediaInputMetadata.md +++ b/docs/reference/interfaces/MediaInputMetadata.md @@ -3,7 +3,7 @@ id: MediaInputMetadata title: MediaInputMetadata --- -Defined in: packages/ai/src/types.ts:2267 +Defined in: [packages/ai/src/types.ts:2325](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2325) Metadata convention for image / video / audio inputs to media generation. Carried on `ImagePart.metadata` / `VideoPart.metadata` / `AudioPart.metadata` @@ -17,7 +17,7 @@ when used as conditioning inputs to `generateImage()` or `generateVideo()`. optional role?: MediaInputRole; ``` -Defined in: packages/ai/src/types.ts:2269 +Defined in: [packages/ai/src/types.ts:2327](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2327) Optional role hint disambiguating the part's intent for the adapter @@ -29,7 +29,7 @@ Optional role hint disambiguating the part's intent for the adapter optional tag?: string; ``` -Defined in: packages/ai/src/types.ts:2278 +Defined in: [packages/ai/src/types.ts:2336](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2336) Optional user-defined label for this input (e.g. `'woman-in-red-dress'`). **Informational only** — adapters never read it and the SDK never diff --git a/docs/reference/interfaces/MemoryStreamInit.md b/docs/reference/interfaces/MemoryStreamInit.md index c7bd3a9e37..adf4704785 100644 --- a/docs/reference/interfaces/MemoryStreamInit.md +++ b/docs/reference/interfaces/MemoryStreamInit.md @@ -3,7 +3,7 @@ id: MemoryStreamInit title: MemoryStreamInit --- -Defined in: packages/ai/src/stream-durability.ts:308 +Defined in: [packages/ai/src/stream-durability.ts:308](https://github.com/TanStack/ai/blob/main/packages/ai/src/stream-durability.ts#L308) Explicit construction for [memoryStream](../functions/memoryStream.md), for callers that don't have the incoming `Request` — e.g. a TanStack Start server function implementing @@ -22,7 +22,7 @@ for await (const chunk of replayRunStream(durability)) yield chunk optional offset?: string | null; ``` -Defined in: packages/ai/src/stream-durability.ts:315 +Defined in: [packages/ai/src/stream-durability.ts:315](https://github.com/TanStack/ai/blob/main/packages/ai/src/stream-durability.ts#L315) Resume offset captured by the consumer (`resumeFrom()` returns it). Defaults to `null` (a producer / from-start reader). @@ -35,6 +35,6 @@ Defaults to `null` (a producer / from-start reader). runId: string; ``` -Defined in: packages/ai/src/stream-durability.ts:310 +Defined in: [packages/ai/src/stream-durability.ts:310](https://github.com/TanStack/ai/blob/main/packages/ai/src/stream-durability.ts#L310) The run this durability adapter attaches to. diff --git a/docs/reference/interfaces/MemoryStreamOptions.md b/docs/reference/interfaces/MemoryStreamOptions.md index 60fbc28425..d5da5beca6 100644 --- a/docs/reference/interfaces/MemoryStreamOptions.md +++ b/docs/reference/interfaces/MemoryStreamOptions.md @@ -3,7 +3,7 @@ id: MemoryStreamOptions title: MemoryStreamOptions --- -Defined in: packages/ai/src/stream-durability.ts:242 +Defined in: [packages/ai/src/stream-durability.ts:242](https://github.com/TanStack/ai/blob/main/packages/ai/src/stream-durability.ts#L242) Options for the in-process delivery-durability backend. @@ -15,7 +15,7 @@ Options for the in-process delivery-durability backend. optional firstChunkDeadlineMs?: number; ``` -Defined in: packages/ai/src/stream-durability.ts:248 +Defined in: [packages/ai/src/stream-durability.ts:248](https://github.com/TanStack/ai/blob/main/packages/ai/src/stream-durability.ts#L248) Milliseconds a from-start join waits for the run's first chunk before throwing. Defaults to DEFAULT\_FIRST\_CHUNK\_DEADLINE\_MS (100ms) — diff --git a/docs/reference/interfaces/MessageSource.md b/docs/reference/interfaces/MessageSource.md index 5b98cf3238..6b233e323a 100644 --- a/docs/reference/interfaces/MessageSource.md +++ b/docs/reference/interfaces/MessageSource.md @@ -3,7 +3,7 @@ id: MessageSource title: MessageSource --- -Defined in: packages/ai/src/types.ts:689 +Defined in: [packages/ai/src/types.ts:692](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L692) Provider, wire API, and requested model of an assistant message. @@ -15,7 +15,7 @@ Provider, wire API, and requested model of an assistant message. api: string; ``` -Defined in: packages/ai/src/types.ts:691 +Defined in: [packages/ai/src/types.ts:694](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L694) *** @@ -25,7 +25,7 @@ Defined in: packages/ai/src/types.ts:691 model: string; ``` -Defined in: packages/ai/src/types.ts:692 +Defined in: [packages/ai/src/types.ts:695](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L695) *** @@ -35,4 +35,4 @@ Defined in: packages/ai/src/types.ts:692 provider: string; ``` -Defined in: packages/ai/src/types.ts:690 +Defined in: [packages/ai/src/types.ts:693](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L693) diff --git a/docs/reference/interfaces/MessagesSnapshotEvent.md b/docs/reference/interfaces/MessagesSnapshotEvent.md index b52b40f57c..5f4f7b95d7 100644 --- a/docs/reference/interfaces/MessagesSnapshotEvent.md +++ b/docs/reference/interfaces/MessagesSnapshotEvent.md @@ -3,7 +3,7 @@ id: MessagesSnapshotEvent title: MessagesSnapshotEvent --- -Defined in: packages/ai/src/types.ts:1733 +Defined in: [packages/ai/src/types.ts:1791](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1791) Emitted to provide a snapshot of all messages in a conversation. diff --git a/docs/reference/interfaces/MetadataStore.md b/docs/reference/interfaces/MetadataStore.md index 31edc5c59f..42d8bdf412 100644 --- a/docs/reference/interfaces/MetadataStore.md +++ b/docs/reference/interfaces/MetadataStore.md @@ -3,7 +3,7 @@ id: MetadataStore title: MetadataStore --- -Defined in: packages/ai/src/activities/chat/middleware/metadata.ts:9 +Defined in: [packages/ai/src/activities/chat/middleware/metadata.ts:9](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/metadata.ts#L9) Namespaced key/value store for app and middleware metadata. @@ -18,7 +18,7 @@ joining them with a delimiter can create collisions. delete: (namespace, key) => Promise; ``` -Defined in: packages/ai/src/activities/chat/middleware/metadata.ts:15 +Defined in: [packages/ai/src/activities/chat/middleware/metadata.ts:15](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/metadata.ts#L15) Delete `(namespace, key)`. Do nothing when it is absent. @@ -44,7 +44,7 @@ Delete `(namespace, key)`. Do nothing when it is absent. get: (namespace, key) => Promise; ``` -Defined in: packages/ai/src/activities/chat/middleware/metadata.ts:11 +Defined in: [packages/ai/src/activities/chat/middleware/metadata.ts:11](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/metadata.ts#L11) Return the value for `(namespace, key)`, or `null` when it is absent. @@ -75,7 +75,7 @@ optional getVersioned?: (namespace, key) => Promise< | null>; ``` -Defined in: packages/ai/src/activities/chat/middleware/metadata.ts:22 +Defined in: [packages/ai/src/activities/chat/middleware/metadata.ts:22](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/metadata.ts#L22) Optional. The value with a revision, or `null` when it is absent. Pair it with `setIf` for compare-and-set writes: implement both or neither. @@ -109,7 +109,7 @@ revision does not come back after a `delete`. set: (namespace, key, value) => Promise; ``` -Defined in: packages/ai/src/activities/chat/middleware/metadata.ts:13 +Defined in: [packages/ai/src/activities/chat/middleware/metadata.ts:13](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/metadata.ts#L13) Insert or replace the value for `(namespace, key)`. @@ -147,7 +147,7 @@ optional setIf?: (namespace, key, value, expectedRevision) => Promise< }>; ``` -Defined in: packages/ai/src/activities/chat/middleware/metadata.ts:31 +Defined in: [packages/ai/src/activities/chat/middleware/metadata.ts:31](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/metadata.ts#L31) Optional. Write only when the current revision is `expectedRevision` (`null` means the key is absent). Success is `{ ok: true, revision }`. diff --git a/docs/reference/interfaces/MidConversationChange.md b/docs/reference/interfaces/MidConversationChange.md index 8f3787bd6b..4617f52692 100644 --- a/docs/reference/interfaces/MidConversationChange.md +++ b/docs/reference/interfaces/MidConversationChange.md @@ -3,7 +3,7 @@ id: MidConversationChange title: MidConversationChange --- -Defined in: packages/ai/src/types.ts:380 +Defined in: [packages/ai/src/types.ts:383](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L383) The mid-conversation record that `chat()` saves on the first assistant message of a model call. It holds tool names and prompt hashes only, so it @@ -17,7 +17,7 @@ does not depend on a provider. optional systemPrompts?: string[]; ``` -Defined in: packages/ai/src/types.ts:386 +Defined in: [packages/ai/src/types.ts:389](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L389) Short prompt hashes: every prompt on a start point, the added prompts otherwise. @@ -29,7 +29,7 @@ Short prompt hashes: every prompt on a start point, the added prompts otherwise. optional tools?: string[]; ``` -Defined in: packages/ai/src/types.ts:382 +Defined in: [packages/ai/src/types.ts:385](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L385) A start point: the names of every tool. @@ -41,6 +41,6 @@ A start point: the names of every tool. optional toolsAdded?: string[]; ``` -Defined in: packages/ai/src/types.ts:384 +Defined in: [packages/ai/src/types.ts:387](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L387) Tool names added since the last record. diff --git a/docs/reference/interfaces/MidConversationChanges.md b/docs/reference/interfaces/MidConversationChanges.md index 938ad31281..984776b62c 100644 --- a/docs/reference/interfaces/MidConversationChanges.md +++ b/docs/reference/interfaces/MidConversationChanges.md @@ -3,7 +3,7 @@ id: MidConversationChanges title: MidConversationChanges --- -Defined in: packages/ai/src/types.ts:393 +Defined in: [packages/ai/src/types.ts:396](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L396) What changed in the tools and system prompts between model calls. `chat()` passes it in `TextOptions.midConversationChanges`. @@ -16,7 +16,7 @@ What changed in the tools and system prompts between model calls. changes: object[]; ``` -Defined in: packages/ai/src/types.ts:404 +Defined in: [packages/ai/src/types.ts:407](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L407) Each change goes directly before `messages[before]`, or at the end when `before === messages.length`. `tools` are the added names. @@ -48,7 +48,7 @@ optional tools?: string[]; start: object; ``` -Defined in: packages/ai/src/types.ts:398 +Defined in: [packages/ai/src/types.ts:401](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L401) The tool names of the start point, in start order, and how many entries at the front of `systemPrompts` belong to it. diff --git a/docs/reference/interfaces/MidConversationChannels.md b/docs/reference/interfaces/MidConversationChannels.md index 3bb9deef6e..1d643765d4 100644 --- a/docs/reference/interfaces/MidConversationChannels.md +++ b/docs/reference/interfaces/MidConversationChannels.md @@ -3,7 +3,7 @@ id: MidConversationChannels title: MidConversationChannels --- -Defined in: packages/ai/src/types.ts:412 +Defined in: [packages/ai/src/types.ts:415](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L415) The mid-conversation channels of a model. @@ -15,7 +15,7 @@ The mid-conversation channels of a model. systemPrompts: boolean; ``` -Defined in: packages/ai/src/types.ts:416 +Defined in: [packages/ai/src/types.ts:419](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L419) Added system prompts can go out as a message at their place. @@ -27,6 +27,6 @@ Added system prompts can go out as a message at their place. tools: boolean; ``` -Defined in: packages/ai/src/types.ts:414 +Defined in: [packages/ai/src/types.ts:417](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L417) Added tools can go out without a change to the tools of the start point. diff --git a/docs/reference/interfaces/MidConversationRequest.md b/docs/reference/interfaces/MidConversationRequest.md index fe1836036e..37a1a27c7a 100644 --- a/docs/reference/interfaces/MidConversationRequest.md +++ b/docs/reference/interfaces/MidConversationRequest.md @@ -3,7 +3,7 @@ id: MidConversationRequest title: MidConversationRequest --- -Defined in: packages/ai/src/utilities/mid-conversation.ts:114 +Defined in: [packages/ai/src/utilities/mid-conversation.ts:114](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/mid-conversation.ts#L114) ## Type Parameters @@ -23,7 +23,7 @@ Defined in: packages/ai/src/utilities/mid-conversation.ts:114 addedTools: TTool[]; ``` -Defined in: packages/ai/src/utilities/mid-conversation.ts:118 +Defined in: [packages/ai/src/utilities/mid-conversation.ts:118](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/mid-conversation.ts#L118) Every added tool, in change order. @@ -38,7 +38,7 @@ at: Map; ``` -Defined in: packages/ai/src/utilities/mid-conversation.ts:120 +Defined in: [packages/ai/src/utilities/mid-conversation.ts:120](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/mid-conversation.ts#L120) The changes by message index (`before`). @@ -50,7 +50,7 @@ The changes by message index (`before`). startSystemPrompts: TPrompt[]; ``` -Defined in: packages/ai/src/utilities/mid-conversation.ts:116 +Defined in: [packages/ai/src/utilities/mid-conversation.ts:116](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/mid-conversation.ts#L116) *** @@ -60,4 +60,4 @@ Defined in: packages/ai/src/utilities/mid-conversation.ts:116 startTools: TTool[]; ``` -Defined in: packages/ai/src/utilities/mid-conversation.ts:115 +Defined in: [packages/ai/src/utilities/mid-conversation.ts:115](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/mid-conversation.ts#L115) diff --git a/docs/reference/interfaces/ModelCapabilities.md b/docs/reference/interfaces/ModelCapabilities.md index 7d8169a233..354a430c38 100644 --- a/docs/reference/interfaces/ModelCapabilities.md +++ b/docs/reference/interfaces/ModelCapabilities.md @@ -3,7 +3,7 @@ id: ModelCapabilities title: ModelCapabilities --- -Defined in: packages/ai/src/extend-adapter.ts:41 +Defined in: [packages/ai/src/extend-adapter.ts:41](https://github.com/TanStack/ai/blob/main/packages/ai/src/extend-adapter.ts#L41) Capability bag accepted by the object form of `createModel`. @@ -33,7 +33,7 @@ Capability bag accepted by the object form of `createModel`. optional features?: TFeatures; ``` -Defined in: packages/ai/src/extend-adapter.ts:48 +Defined in: [packages/ai/src/extend-adapter.ts:48](https://github.com/TanStack/ai/blob/main/packages/ai/src/extend-adapter.ts#L48) *** @@ -43,7 +43,7 @@ Defined in: packages/ai/src/extend-adapter.ts:48 optional input?: TInput; ``` -Defined in: packages/ai/src/extend-adapter.ts:47 +Defined in: [packages/ai/src/extend-adapter.ts:47](https://github.com/TanStack/ai/blob/main/packages/ai/src/extend-adapter.ts#L47) *** @@ -53,7 +53,7 @@ Defined in: packages/ai/src/extend-adapter.ts:47 optional modelOptions?: TOptions; ``` -Defined in: packages/ai/src/extend-adapter.ts:50 +Defined in: [packages/ai/src/extend-adapter.ts:50](https://github.com/TanStack/ai/blob/main/packages/ai/src/extend-adapter.ts#L50) *** @@ -63,4 +63,4 @@ Defined in: packages/ai/src/extend-adapter.ts:50 optional tools?: TTools; ``` -Defined in: packages/ai/src/extend-adapter.ts:49 +Defined in: [packages/ai/src/extend-adapter.ts:49](https://github.com/TanStack/ai/blob/main/packages/ai/src/extend-adapter.ts#L49) diff --git a/docs/reference/interfaces/ModelMessage.md b/docs/reference/interfaces/ModelMessage.md index 76a0510005..3aaa672100 100644 --- a/docs/reference/interfaces/ModelMessage.md +++ b/docs/reference/interfaces/ModelMessage.md @@ -3,7 +3,7 @@ id: ModelMessage title: ModelMessage --- -Defined in: packages/ai/src/types.ts:428 +Defined in: [packages/ai/src/types.ts:431](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L431) ## Type Parameters @@ -19,7 +19,7 @@ Defined in: packages/ai/src/types.ts:428 optional blockOrder?: ModelMessageBlock[]; ``` -Defined in: packages/ai/src/types.ts:452 +Defined in: [packages/ai/src/types.ts:455](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L455) The order of the blocks of an assistant message, when it is not the default order (all thinking, then the text, then the tool calls). Each @@ -35,7 +35,7 @@ that finds a map that does not match the message uses the default order. content: TContent; ``` -Defined in: packages/ai/src/types.ts:435 +Defined in: [packages/ai/src/types.ts:438](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L438) *** @@ -45,7 +45,7 @@ Defined in: packages/ai/src/types.ts:435 optional createdAt?: Date; ``` -Defined in: packages/ai/src/types.ts:482 +Defined in: [packages/ai/src/types.ts:485](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L485) Optional message creation timestamp. When present, message converters preserve it across persist → hydrate round-trips. @@ -58,7 +58,7 @@ preserve it across persist → hydrate round-trips. optional error?: string; ``` -Defined in: packages/ai/src/types.ts:454 +Defined in: [packages/ai/src/types.ts:457](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L457) Error reported by an AG-UI tool message. @@ -70,7 +70,7 @@ Error reported by an AG-UI tool message. optional id?: string; ``` -Defined in: packages/ai/src/types.ts:477 +Defined in: [packages/ai/src/types.ts:480](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L480) Optional stable message id. Providers ignore it; it exists so a persisted transcript can retain the streaming `messageId` and survive the @@ -87,7 +87,7 @@ resume the SAME message bubble in place (see `@tanstack/ai-persistence`). optional metadata?: Record; ``` -Defined in: packages/ai/src/types.ts:462 +Defined in: [packages/ai/src/types.ts:465](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L465) Optional AG-UI message metadata. TanStack-owned fields live under `tanstack`. @@ -99,7 +99,7 @@ Optional AG-UI message metadata. TanStack-owned fields live under `tanstack`. optional midConversationChange?: MidConversationChange; ``` -Defined in: packages/ai/src/types.ts:460 +Defined in: [packages/ai/src/types.ts:463](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L463) The tools and system prompts that changed before this assistant message. `chat()` writes it when the adapter has a mid-conversation channel. @@ -113,7 +113,7 @@ Providers ignore it: adapters read `TextOptions.midConversationChanges`. optional name?: string; ``` -Defined in: packages/ai/src/types.ts:436 +Defined in: [packages/ai/src/types.ts:439](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L439) *** @@ -123,7 +123,7 @@ Defined in: packages/ai/src/types.ts:436 role: "assistant" | "user" | "tool"; ``` -Defined in: packages/ai/src/types.ts:434 +Defined in: [packages/ai/src/types.ts:437](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L437) *** @@ -133,7 +133,7 @@ Defined in: packages/ai/src/types.ts:434 optional structuredOutput?: StructuredOutputPart; ``` -Defined in: packages/ai/src/types.ts:468 +Defined in: [packages/ai/src/types.ts:471](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L471) Completed structured output represented by this assistant message. `content` remains the provider-facing JSON text; this field preserves the @@ -147,7 +147,7 @@ typed UI part across persistence and message conversion. optional thinking?: object[]; ``` -Defined in: packages/ai/src/types.ts:444 +Defined in: [packages/ai/src/types.ts:447](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L447) Signed thinking to send back to the provider. `redacted: true` marks a block the provider encrypted: `content` is empty and `signature` holds its @@ -179,7 +179,7 @@ optional signature?: string; optional toolCallId?: string; ``` -Defined in: packages/ai/src/types.ts:438 +Defined in: [packages/ai/src/types.ts:441](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L441) *** @@ -189,4 +189,4 @@ Defined in: packages/ai/src/types.ts:438 optional toolCalls?: ToolCall[]; ``` -Defined in: packages/ai/src/types.ts:437 +Defined in: [packages/ai/src/types.ts:440](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L440) diff --git a/docs/reference/interfaces/NormalizedApprovalSchema.md b/docs/reference/interfaces/NormalizedApprovalSchema.md index cbd8440a68..91766e100c 100644 --- a/docs/reference/interfaces/NormalizedApprovalSchema.md +++ b/docs/reference/interfaces/NormalizedApprovalSchema.md @@ -3,7 +3,7 @@ id: NormalizedApprovalSchema title: NormalizedApprovalSchema --- -Defined in: packages/ai/src/activities/chat/tools/approval-schema.ts:16 +Defined in: [packages/ai/src/activities/chat/tools/approval-schema.ts:16](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/approval-schema.ts#L16) ## Properties @@ -13,7 +13,7 @@ Defined in: packages/ai/src/activities/chat/tools/approval-schema.ts:16 approvalSchemaHash: string; ``` -Defined in: packages/ai/src/activities/chat/tools/approval-schema.ts:23 +Defined in: [packages/ai/src/activities/chat/tools/approval-schema.ts:23](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/approval-schema.ts#L23) *** @@ -23,7 +23,7 @@ Defined in: packages/ai/src/activities/chat/tools/approval-schema.ts:23 branches: object; ``` -Defined in: packages/ai/src/activities/chat/tools/approval-schema.ts:17 +Defined in: [packages/ai/src/activities/chat/tools/approval-schema.ts:17](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/approval-schema.ts#L17) #### approve @@ -45,7 +45,7 @@ reject: NormalizedSchemaInput | null; responseSchema: JSONSchema; ``` -Defined in: packages/ai/src/activities/chat/tools/approval-schema.ts:21 +Defined in: [packages/ai/src/activities/chat/tools/approval-schema.ts:21](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/approval-schema.ts#L21) *** @@ -55,4 +55,4 @@ Defined in: packages/ai/src/activities/chat/tools/approval-schema.ts:21 responseSchemaHash: string; ``` -Defined in: packages/ai/src/activities/chat/tools/approval-schema.ts:22 +Defined in: [packages/ai/src/activities/chat/tools/approval-schema.ts:22](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/approval-schema.ts#L22) diff --git a/docs/reference/interfaces/NormalizedSchemaInput.md b/docs/reference/interfaces/NormalizedSchemaInput.md index 81829356ba..b52ee17320 100644 --- a/docs/reference/interfaces/NormalizedSchemaInput.md +++ b/docs/reference/interfaces/NormalizedSchemaInput.md @@ -3,7 +3,7 @@ id: NormalizedSchemaInput title: NormalizedSchemaInput --- -Defined in: packages/ai/src/activities/chat/tools/approval-schema.ts:10 +Defined in: [packages/ai/src/activities/chat/tools/approval-schema.ts:10](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/approval-schema.ts#L10) ## Properties @@ -13,7 +13,7 @@ Defined in: packages/ai/src/activities/chat/tools/approval-schema.ts:10 optional jsonSchema?: JSONSchema; ``` -Defined in: packages/ai/src/activities/chat/tools/approval-schema.ts:13 +Defined in: [packages/ai/src/activities/chat/tools/approval-schema.ts:13](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/approval-schema.ts#L13) *** @@ -23,7 +23,7 @@ Defined in: packages/ai/src/activities/chat/tools/approval-schema.ts:13 source: SchemaInput; ``` -Defined in: packages/ai/src/activities/chat/tools/approval-schema.ts:11 +Defined in: [packages/ai/src/activities/chat/tools/approval-schema.ts:11](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/approval-schema.ts#L11) *** @@ -33,4 +33,4 @@ Defined in: packages/ai/src/activities/chat/tools/approval-schema.ts:11 optional validator?: StandardSchemaV1; ``` -Defined in: packages/ai/src/activities/chat/tools/approval-schema.ts:12 +Defined in: [packages/ai/src/activities/chat/tools/approval-schema.ts:12](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/approval-schema.ts#L12) diff --git a/docs/reference/interfaces/NormalizedSystemPrompt.md b/docs/reference/interfaces/NormalizedSystemPrompt.md index 67a32a0942..ee963318b6 100644 --- a/docs/reference/interfaces/NormalizedSystemPrompt.md +++ b/docs/reference/interfaces/NormalizedSystemPrompt.md @@ -3,7 +3,7 @@ id: NormalizedSystemPrompt title: NormalizedSystemPrompt --- -Defined in: packages/ai/src/system-prompts.ts:52 +Defined in: [packages/ai/src/system-prompts.ts:52](https://github.com/TanStack/ai/blob/main/packages/ai/src/system-prompts.ts#L52) Normalised shape adapters see after the chat layer turns string entries into `{ content }` objects. Adapters call `normalizeSystemPrompts` once at @@ -24,7 +24,7 @@ to handle one shape. content: string; ``` -Defined in: packages/ai/src/system-prompts.ts:53 +Defined in: [packages/ai/src/system-prompts.ts:53](https://github.com/TanStack/ai/blob/main/packages/ai/src/system-prompts.ts#L53) *** @@ -34,4 +34,4 @@ Defined in: packages/ai/src/system-prompts.ts:53 optional metadata?: TMetadata; ``` -Defined in: packages/ai/src/system-prompts.ts:54 +Defined in: [packages/ai/src/system-prompts.ts:54](https://github.com/TanStack/ai/blob/main/packages/ai/src/system-prompts.ts#L54) diff --git a/docs/reference/interfaces/PendingInterruptResumeRecord.md b/docs/reference/interfaces/PendingInterruptResumeRecord.md index 72a6773a03..2117f80088 100644 --- a/docs/reference/interfaces/PendingInterruptResumeRecord.md +++ b/docs/reference/interfaces/PendingInterruptResumeRecord.md @@ -3,7 +3,7 @@ id: PendingInterruptResumeRecord title: PendingInterruptResumeRecord --- -Defined in: packages/ai/src/interrupt-resume.ts:50 +Defined in: [packages/ai/src/interrupt-resume.ts:50](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupt-resume.ts#L50) The persistence-neutral shape required to validate an interrupt resume. @@ -15,7 +15,7 @@ The persistence-neutral shape required to validate an interrupt resume. binding: InterruptBinding; ``` -Defined in: packages/ai/src/interrupt-resume.ts:53 +Defined in: [packages/ai/src/interrupt-resume.ts:53](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupt-resume.ts#L53) *** @@ -25,7 +25,7 @@ Defined in: packages/ai/src/interrupt-resume.ts:53 optional genericRequest?: GenericInterruptRequestBase>; ``` -Defined in: packages/ai/src/interrupt-resume.ts:55 +Defined in: [packages/ai/src/interrupt-resume.ts:55](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupt-resume.ts#L55) Present for a first-party generic interrupt. @@ -37,7 +37,7 @@ Present for a first-party generic interrupt. interruptId: string; ``` -Defined in: packages/ai/src/interrupt-resume.ts:51 +Defined in: [packages/ai/src/interrupt-resume.ts:51](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupt-resume.ts#L51) *** @@ -47,4 +47,4 @@ Defined in: packages/ai/src/interrupt-resume.ts:51 payload: unknown; ``` -Defined in: packages/ai/src/interrupt-resume.ts:52 +Defined in: [packages/ai/src/interrupt-resume.ts:52](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupt-resume.ts#L52) diff --git a/docs/reference/interfaces/PersistedArtifactRef.md b/docs/reference/interfaces/PersistedArtifactRef.md index 63cb1a6f55..269cd454a6 100644 --- a/docs/reference/interfaces/PersistedArtifactRef.md +++ b/docs/reference/interfaces/PersistedArtifactRef.md @@ -3,7 +3,7 @@ id: PersistedArtifactRef title: PersistedArtifactRef --- -Defined in: packages/ai/src/types.ts:2406 +Defined in: [packages/ai/src/types.ts:2464](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2464) ## Properties @@ -13,7 +13,7 @@ Defined in: packages/ai/src/types.ts:2406 artifactId: string; ``` -Defined in: packages/ai/src/types.ts:2408 +Defined in: [packages/ai/src/types.ts:2466](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2466) *** @@ -23,7 +23,7 @@ Defined in: packages/ai/src/types.ts:2408 createdAt: string; ``` -Defined in: packages/ai/src/types.ts:2414 +Defined in: [packages/ai/src/types.ts:2472](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2472) *** @@ -33,7 +33,7 @@ Defined in: packages/ai/src/types.ts:2414 mimeType: string; ``` -Defined in: packages/ai/src/types.ts:2412 +Defined in: [packages/ai/src/types.ts:2470](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2470) *** @@ -43,7 +43,7 @@ Defined in: packages/ai/src/types.ts:2412 name: string; ``` -Defined in: packages/ai/src/types.ts:2411 +Defined in: [packages/ai/src/types.ts:2469](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2469) *** @@ -53,7 +53,7 @@ Defined in: packages/ai/src/types.ts:2411 role: PersistedArtifactRole; ``` -Defined in: packages/ai/src/types.ts:2407 +Defined in: [packages/ai/src/types.ts:2465](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2465) *** @@ -63,7 +63,7 @@ Defined in: packages/ai/src/types.ts:2407 runId: string; ``` -Defined in: packages/ai/src/types.ts:2410 +Defined in: [packages/ai/src/types.ts:2468](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2468) *** @@ -73,7 +73,7 @@ Defined in: packages/ai/src/types.ts:2410 size: number; ``` -Defined in: packages/ai/src/types.ts:2413 +Defined in: [packages/ai/src/types.ts:2471](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2471) *** @@ -83,7 +83,7 @@ Defined in: packages/ai/src/types.ts:2413 source: object; ``` -Defined in: packages/ai/src/types.ts:2430 +Defined in: [packages/ai/src/types.ts:2488](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2488) #### activity @@ -135,7 +135,7 @@ provider: string; optional sourceUrl?: string; ``` -Defined in: packages/ai/src/types.ts:2421 +Defined in: [packages/ai/src/types.ts:2479](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2479) Where these bytes were fetched FROM — the provider's original result URL, or a caller-supplied prompt URL when `allowInputUrl` opted that in. Usually @@ -150,7 +150,7 @@ instead. threadId: string; ``` -Defined in: packages/ai/src/types.ts:2409 +Defined in: [packages/ai/src/types.ts:2467](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2467) *** @@ -160,7 +160,7 @@ Defined in: packages/ai/src/types.ts:2409 optional url?: string; ``` -Defined in: packages/ai/src/types.ts:2429 +Defined in: [packages/ai/src/types.ts:2487](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2487) Durable app-origin URL that serves this artifact's persisted bytes (your `GET` route around `retrieveArtifact` / `retrieveBlob`). Stamped by diff --git a/docs/reference/interfaces/PortOpenedPayload.md b/docs/reference/interfaces/PortOpenedPayload.md index cccf1dbbab..1cbec13cff 100644 --- a/docs/reference/interfaces/PortOpenedPayload.md +++ b/docs/reference/interfaces/PortOpenedPayload.md @@ -3,7 +3,7 @@ id: PortOpenedPayload title: PortOpenedPayload --- -Defined in: packages/ai/src/custom-events.ts:51 +Defined in: [packages/ai/src/custom-events.ts:51](https://github.com/TanStack/ai/blob/main/packages/ai/src/custom-events.ts#L51) ## Properties @@ -13,7 +13,7 @@ Defined in: packages/ai/src/custom-events.ts:51 port: number; ``` -Defined in: packages/ai/src/custom-events.ts:52 +Defined in: [packages/ai/src/custom-events.ts:52](https://github.com/TanStack/ai/blob/main/packages/ai/src/custom-events.ts#L52) *** @@ -23,6 +23,6 @@ Defined in: packages/ai/src/custom-events.ts:52 optional url?: string; ``` -Defined in: packages/ai/src/custom-events.ts:54 +Defined in: [packages/ai/src/custom-events.ts:54](https://github.com/TanStack/ai/blob/main/packages/ai/src/custom-events.ts#L54) Externally reachable URL, when the provider exposes one. diff --git a/docs/reference/interfaces/ProcessOutputPayload.md b/docs/reference/interfaces/ProcessOutputPayload.md index 2590d9112c..f21f58ccfc 100644 --- a/docs/reference/interfaces/ProcessOutputPayload.md +++ b/docs/reference/interfaces/ProcessOutputPayload.md @@ -3,7 +3,7 @@ id: ProcessOutputPayload title: ProcessOutputPayload --- -Defined in: packages/ai/src/custom-events.ts:44 +Defined in: [packages/ai/src/custom-events.ts:44](https://github.com/TanStack/ai/blob/main/packages/ai/src/custom-events.ts#L44) ## Properties @@ -13,7 +13,7 @@ Defined in: packages/ai/src/custom-events.ts:44 chunk: string; ``` -Defined in: packages/ai/src/custom-events.ts:48 +Defined in: [packages/ai/src/custom-events.ts:48](https://github.com/TanStack/ai/blob/main/packages/ai/src/custom-events.ts#L48) A chunk of stdout/stderr text. @@ -25,6 +25,6 @@ A chunk of stdout/stderr text. processId: string; ``` -Defined in: packages/ai/src/custom-events.ts:46 +Defined in: [packages/ai/src/custom-events.ts:46](https://github.com/TanStack/ai/blob/main/packages/ai/src/custom-events.ts#L46) Stable id for the spawned process whose output this is. diff --git a/docs/reference/interfaces/ProcessorResult.md b/docs/reference/interfaces/ProcessorResult.md index fd02905d98..defcb7cfd6 100644 --- a/docs/reference/interfaces/ProcessorResult.md +++ b/docs/reference/interfaces/ProcessorResult.md @@ -3,7 +3,7 @@ id: ProcessorResult title: ProcessorResult --- -Defined in: packages/ai/src/activities/chat/stream/types.ts:77 +Defined in: [packages/ai/src/activities/chat/stream/types.ts:77](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/types.ts#L77) Result from processing a stream @@ -15,7 +15,7 @@ Result from processing a stream content: string; ``` -Defined in: packages/ai/src/activities/chat/stream/types.ts:78 +Defined in: [packages/ai/src/activities/chat/stream/types.ts:78](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/types.ts#L78) *** @@ -25,7 +25,7 @@ Defined in: packages/ai/src/activities/chat/stream/types.ts:78 optional finishReason?: string | null; ``` -Defined in: packages/ai/src/activities/chat/stream/types.ts:81 +Defined in: [packages/ai/src/activities/chat/stream/types.ts:81](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/types.ts#L81) *** @@ -35,7 +35,7 @@ Defined in: packages/ai/src/activities/chat/stream/types.ts:81 optional thinking?: string; ``` -Defined in: packages/ai/src/activities/chat/stream/types.ts:79 +Defined in: [packages/ai/src/activities/chat/stream/types.ts:79](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/types.ts#L79) *** @@ -45,4 +45,4 @@ Defined in: packages/ai/src/activities/chat/stream/types.ts:79 optional toolCalls?: ToolCall[]; ``` -Defined in: packages/ai/src/activities/chat/stream/types.ts:80 +Defined in: [packages/ai/src/activities/chat/stream/types.ts:80](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/types.ts#L80) diff --git a/docs/reference/interfaces/ProcessorState.md b/docs/reference/interfaces/ProcessorState.md index ca66e34948..ab0f31953f 100644 --- a/docs/reference/interfaces/ProcessorState.md +++ b/docs/reference/interfaces/ProcessorState.md @@ -3,7 +3,7 @@ id: ProcessorState title: ProcessorState --- -Defined in: packages/ai/src/activities/chat/stream/types.ts:87 +Defined in: [packages/ai/src/activities/chat/stream/types.ts:87](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/types.ts#L87) Current state of the processor @@ -15,7 +15,7 @@ Current state of the processor content: string; ``` -Defined in: packages/ai/src/activities/chat/stream/types.ts:88 +Defined in: [packages/ai/src/activities/chat/stream/types.ts:88](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/types.ts#L88) *** @@ -25,7 +25,7 @@ Defined in: packages/ai/src/activities/chat/stream/types.ts:88 done: boolean; ``` -Defined in: packages/ai/src/activities/chat/stream/types.ts:93 +Defined in: [packages/ai/src/activities/chat/stream/types.ts:93](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/types.ts#L93) *** @@ -35,7 +35,7 @@ Defined in: packages/ai/src/activities/chat/stream/types.ts:93 finishReason: string | null; ``` -Defined in: packages/ai/src/activities/chat/stream/types.ts:92 +Defined in: [packages/ai/src/activities/chat/stream/types.ts:92](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/types.ts#L92) *** @@ -45,7 +45,7 @@ Defined in: packages/ai/src/activities/chat/stream/types.ts:92 thinking: string; ``` -Defined in: packages/ai/src/activities/chat/stream/types.ts:89 +Defined in: [packages/ai/src/activities/chat/stream/types.ts:89](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/types.ts#L89) *** @@ -55,7 +55,7 @@ Defined in: packages/ai/src/activities/chat/stream/types.ts:89 toolCallOrder: string[]; ``` -Defined in: packages/ai/src/activities/chat/stream/types.ts:91 +Defined in: [packages/ai/src/activities/chat/stream/types.ts:91](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/types.ts#L91) *** @@ -65,4 +65,4 @@ Defined in: packages/ai/src/activities/chat/stream/types.ts:91 toolCalls: Map; ``` -Defined in: packages/ai/src/activities/chat/stream/types.ts:90 +Defined in: [packages/ai/src/activities/chat/stream/types.ts:90](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/types.ts#L90) diff --git a/docs/reference/interfaces/ProviderExecutedToolMetadata.md b/docs/reference/interfaces/ProviderExecutedToolMetadata.md index b6bdccf8a3..e16c15e8c7 100644 --- a/docs/reference/interfaces/ProviderExecutedToolMetadata.md +++ b/docs/reference/interfaces/ProviderExecutedToolMetadata.md @@ -3,7 +3,7 @@ id: ProviderExecutedToolMetadata title: ProviderExecutedToolMetadata --- -Defined in: packages/ai/src/types.ts:227 +Defined in: [packages/ai/src/types.ts:230](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L230) Convention for tool-call `metadata` that marks a call as **provider-executed** — run by the provider's own infrastructure (e.g. Anthropic `web_search` / @@ -34,7 +34,7 @@ links a web search used, shared across providers. optional providerExecuted?: boolean; ``` -Defined in: packages/ai/src/types.ts:228 +Defined in: [packages/ai/src/types.ts:231](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L231) *** @@ -44,4 +44,4 @@ Defined in: packages/ai/src/types.ts:228 optional sources?: ProviderExecutedToolSource[]; ``` -Defined in: packages/ai/src/types.ts:229 +Defined in: [packages/ai/src/types.ts:232](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L232) diff --git a/docs/reference/interfaces/ProviderExecutedToolSource.md b/docs/reference/interfaces/ProviderExecutedToolSource.md index 15cefc2a6a..5acc1414aa 100644 --- a/docs/reference/interfaces/ProviderExecutedToolSource.md +++ b/docs/reference/interfaces/ProviderExecutedToolSource.md @@ -3,7 +3,7 @@ id: ProviderExecutedToolSource title: ProviderExecutedToolSource --- -Defined in: packages/ai/src/types.ts:205 +Defined in: [packages/ai/src/types.ts:208](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L208) One source link from a provider-executed web search. @@ -15,7 +15,7 @@ One source link from a provider-executed web search. optional pageAge?: string; ``` -Defined in: packages/ai/src/types.ts:208 +Defined in: [packages/ai/src/types.ts:211](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L211) *** @@ -25,7 +25,7 @@ Defined in: packages/ai/src/types.ts:208 optional title?: string; ``` -Defined in: packages/ai/src/types.ts:207 +Defined in: [packages/ai/src/types.ts:210](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L210) *** @@ -35,4 +35,4 @@ Defined in: packages/ai/src/types.ts:207 url: string; ``` -Defined in: packages/ai/src/types.ts:206 +Defined in: [packages/ai/src/types.ts:209](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L209) diff --git a/docs/reference/interfaces/ProviderKeys.md b/docs/reference/interfaces/ProviderKeys.md index a869fb3af8..074ff6a28b 100644 --- a/docs/reference/interfaces/ProviderKeys.md +++ b/docs/reference/interfaces/ProviderKeys.md @@ -3,7 +3,7 @@ id: ProviderKeys title: ProviderKeys --- -Defined in: packages/ai/src/byok/keyed.ts:25 +Defined in: [packages/ai/src/byok/keyed.ts:25](https://github.com/TanStack/ai/blob/main/packages/ai/src/byok/keyed.ts#L25) Finds provider keys for a run. An agent reads it as `ctx.keys`. A host sets it on the binding and reads each user's own keys. Without a host, @@ -17,7 +17,7 @@ it on the binding and reads each user's own keys. Without a host, adapter: (adapter) => Promise; ``` -Defined in: packages/ai/src/byok/keyed.ts:34 +Defined in: [packages/ai/src/byok/keyed.ts:34](https://github.com/TanStack/ai/blob/main/packages/ai/src/byok/keyed.ts#L34) The adapter to call. A plain adapter comes back unchanged. A [KeyedAdapter](KeyedAdapter.md) is built with the key from `require`. @@ -46,7 +46,7 @@ The adapter to call. A plain adapter comes back unchanged. A get: (provider) => Promise; ``` -Defined in: packages/ai/src/byok/keyed.ts:27 +Defined in: [packages/ai/src/byok/keyed.ts:27](https://github.com/TanStack/ai/blob/main/packages/ai/src/byok/keyed.ts#L27) The key for `provider`, or `null` when there is none. @@ -68,7 +68,7 @@ The key for `provider`, or `null` when there is none. require: (provider) => Promise; ``` -Defined in: packages/ai/src/byok/keyed.ts:29 +Defined in: [packages/ai/src/byok/keyed.ts:29](https://github.com/TanStack/ai/blob/main/packages/ai/src/byok/keyed.ts#L29) The key for `provider`. Throws when there is none. diff --git a/docs/reference/interfaces/ProviderTool.md b/docs/reference/interfaces/ProviderTool.md index 7863d2b7ed..d1ead35173 100644 --- a/docs/reference/interfaces/ProviderTool.md +++ b/docs/reference/interfaces/ProviderTool.md @@ -3,7 +3,7 @@ id: ProviderTool title: ProviderTool --- -Defined in: packages/ai/src/tools/provider-tool.ts:19 +Defined in: [packages/ai/src/tools/provider-tool.ts:19](https://github.com/TanStack/ai/blob/main/packages/ai/src/tools/provider-tool.ts#L19) A provider-specific tool produced by an adapter-package factory (e.g. `webSearchTool` from `@tanstack/ai-anthropic/tools`). @@ -43,7 +43,7 @@ Canonical tool-kind string matching the provider's readonly ~provider: TProvider; ``` -Defined in: packages/ai/src/tools/provider-tool.ts:23 +Defined in: [packages/ai/src/tools/provider-tool.ts:23](https://github.com/TanStack/ai/blob/main/packages/ai/src/tools/provider-tool.ts#L23) *** @@ -53,7 +53,7 @@ Defined in: packages/ai/src/tools/provider-tool.ts:23 readonly ~toolKind: TKind; ``` -Defined in: packages/ai/src/tools/provider-tool.ts:24 +Defined in: [packages/ai/src/tools/provider-tool.ts:24](https://github.com/TanStack/ai/blob/main/packages/ai/src/tools/provider-tool.ts#L24) *** @@ -63,7 +63,7 @@ Defined in: packages/ai/src/tools/provider-tool.ts:24 description: string; ``` -Defined in: packages/ai/src/types.ts:989 +Defined in: [packages/ai/src/types.ts:1029](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1029) Clear description of what the tool does. @@ -88,7 +88,7 @@ Be specific about what the tool does, what parameters it needs, and what it retu optional execute?: (args, context?) => any; ``` -Defined in: packages/ai/src/types.ts:1069 +Defined in: [packages/ai/src/types.ts:1109](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1109) Optional function to execute when the model calls this tool. @@ -136,7 +136,7 @@ execute: async (args) => { optional inputSchema?: SchemaInput; ``` -Defined in: packages/ai/src/types.ts:1029 +Defined in: [packages/ai/src/types.ts:1069](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1069) Schema describing the tool's input parameters. @@ -194,7 +194,7 @@ type({ optional lazy?: boolean; ``` -Defined in: packages/ai/src/types.ts:1075 +Defined in: [packages/ai/src/types.ts:1115](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1115) If true, this tool is lazy and will only be sent to the LLM after being discovered via the lazy tool discovery mechanism. Works with both chat() (the synthetic discovery tool) and Code Mode (kept out of the system prompt and revealed via discover_tools). @@ -210,7 +210,7 @@ If true, this tool is lazy and will only be sent to the LLM after being discover optional metadata?: Record; ``` -Defined in: packages/ai/src/types.ts:1086 +Defined in: [packages/ai/src/types.ts:1126](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1126) Additional metadata for adapters or custom extensions @@ -226,7 +226,7 @@ Additional metadata for adapters or custom extensions name: string; ``` -Defined in: packages/ai/src/types.ts:979 +Defined in: [packages/ai/src/types.ts:1019](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1019) Unique name of the tool (used by the model to call it). @@ -251,7 +251,7 @@ Must be unique within the tools array. optional needsApproval?: boolean; ``` -Defined in: packages/ai/src/types.ts:1072 +Defined in: [packages/ai/src/types.ts:1112](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1112) If true, tool execution requires user approval before running. Works with both server and client tools. @@ -267,7 +267,7 @@ If true, tool execution requires user approval before running. Works with both s optional outputSchema?: SchemaInput; ``` -Defined in: packages/ai/src/types.ts:1050 +Defined in: [packages/ai/src/types.ts:1090](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1090) Optional schema for validating tool output. @@ -302,7 +302,7 @@ z.object({ optional replay?: "safe" | "never"; ``` -Defined in: packages/ai/src/types.ts:1083 +Defined in: [packages/ai/src/types.ts:1123](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1123) Whether a host may run this tool again after a crash cut the run between the call and its result. `'safe'` runs it again. Omit the diff --git a/docs/reference/interfaces/RawEvent.md b/docs/reference/interfaces/RawEvent.md index 58b8299d8c..b3830c7ec8 100644 --- a/docs/reference/interfaces/RawEvent.md +++ b/docs/reference/interfaces/RawEvent.md @@ -3,7 +3,7 @@ id: RawEvent title: RawEvent --- -Defined in: packages/ai/src/types.ts:2020 +Defined in: [packages/ai/src/types.ts:2078](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2078) AG-UI 1.0 RawEvent shape. diff --git a/docs/reference/interfaces/RealtimeAdapter.md b/docs/reference/interfaces/RealtimeAdapter.md index 2f1c33d44f..23e0243e3c 100644 --- a/docs/reference/interfaces/RealtimeAdapter.md +++ b/docs/reference/interfaces/RealtimeAdapter.md @@ -3,7 +3,7 @@ id: RealtimeAdapter title: RealtimeAdapter --- -Defined in: packages/ai/src/realtime/types.ts:319 +Defined in: [packages/ai/src/realtime/types.ts:319](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L319) Adapter interface for connecting to realtime providers. Each provider (OpenAI, ElevenLabs, etc.) implements this interface. @@ -22,7 +22,7 @@ re-exports this type for backwards compatibility. connect: (token, clientTools?) => Promise; ``` -Defined in: packages/ai/src/realtime/types.ts:329 +Defined in: [packages/ai/src/realtime/types.ts:329](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L329) Create a connection using the provided token @@ -54,6 +54,6 @@ A connection instance provider: string; ``` -Defined in: packages/ai/src/realtime/types.ts:321 +Defined in: [packages/ai/src/realtime/types.ts:321](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L321) Provider identifier diff --git a/docs/reference/interfaces/RealtimeAudioPart.md b/docs/reference/interfaces/RealtimeAudioPart.md index fea786b9ec..535e3873e3 100644 --- a/docs/reference/interfaces/RealtimeAudioPart.md +++ b/docs/reference/interfaces/RealtimeAudioPart.md @@ -3,7 +3,7 @@ id: RealtimeAudioPart title: RealtimeAudioPart --- -Defined in: packages/ai/src/realtime/types.ts:107 +Defined in: [packages/ai/src/realtime/types.ts:107](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L107) Audio content part in a realtime message @@ -15,7 +15,7 @@ Audio content part in a realtime message optional audioData?: ArrayBuffer; ``` -Defined in: packages/ai/src/realtime/types.ts:112 +Defined in: [packages/ai/src/realtime/types.ts:112](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L112) Raw audio data (optional, if stored) @@ -27,7 +27,7 @@ Raw audio data (optional, if stored) optional durationMs?: number; ``` -Defined in: packages/ai/src/realtime/types.ts:114 +Defined in: [packages/ai/src/realtime/types.ts:114](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L114) Duration of the audio in milliseconds @@ -39,7 +39,7 @@ Duration of the audio in milliseconds transcript: string; ``` -Defined in: packages/ai/src/realtime/types.ts:110 +Defined in: [packages/ai/src/realtime/types.ts:110](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L110) Transcription of the audio @@ -51,4 +51,4 @@ Transcription of the audio type: "audio"; ``` -Defined in: packages/ai/src/realtime/types.ts:108 +Defined in: [packages/ai/src/realtime/types.ts:108](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L108) diff --git a/docs/reference/interfaces/RealtimeConnection.md b/docs/reference/interfaces/RealtimeConnection.md index ad5e70100c..db732945f4 100644 --- a/docs/reference/interfaces/RealtimeConnection.md +++ b/docs/reference/interfaces/RealtimeConnection.md @@ -3,7 +3,7 @@ id: RealtimeConnection title: RealtimeConnection --- -Defined in: packages/ai/src/realtime/types.ts:339 +Defined in: [packages/ai/src/realtime/types.ts:339](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L339) Connection interface representing an active realtime session. Handles audio I/O, events, and session management. @@ -16,7 +16,7 @@ Handles audio I/O, events, and session management. disconnect: () => Promise; ``` -Defined in: packages/ai/src/realtime/types.ts:342 +Defined in: [packages/ai/src/realtime/types.ts:342](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L342) Disconnect from the realtime session @@ -32,7 +32,7 @@ Disconnect from the realtime session getAudioVisualization: () => AudioVisualization; ``` -Defined in: packages/ai/src/realtime/types.ts:379 +Defined in: [packages/ai/src/realtime/types.ts:379](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L379) Get audio visualization data @@ -48,7 +48,7 @@ Get audio visualization data interrupt: () => void; ``` -Defined in: packages/ai/src/realtime/types.ts:368 +Defined in: [packages/ai/src/realtime/types.ts:368](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L368) Interrupt the current response @@ -64,7 +64,7 @@ Interrupt the current response on: (event, handler) => () => void; ``` -Defined in: packages/ai/src/realtime/types.ts:372 +Defined in: [packages/ai/src/realtime/types.ts:372](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L372) Subscribe to connection events @@ -96,7 +96,7 @@ Subscribe to connection events sendImage: (imageData, mimeType) => void; ``` -Defined in: packages/ai/src/realtime/types.ts:356 +Defined in: [packages/ai/src/realtime/types.ts:356](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L356) Send an image to the conversation @@ -122,7 +122,7 @@ Send an image to the conversation sendText: (text) => void; ``` -Defined in: packages/ai/src/realtime/types.ts:352 +Defined in: [packages/ai/src/realtime/types.ts:352](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L352) Send a text message (fallback for when voice isn't available) @@ -144,7 +144,7 @@ Send a text message (fallback for when voice isn't available) sendToolResult: (callId, result) => void; ``` -Defined in: packages/ai/src/realtime/types.ts:360 +Defined in: [packages/ai/src/realtime/types.ts:360](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L360) Send a tool execution result back to the provider @@ -170,7 +170,7 @@ Send a tool execution result back to the provider startAudioCapture: () => Promise; ``` -Defined in: packages/ai/src/realtime/types.ts:346 +Defined in: [packages/ai/src/realtime/types.ts:346](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L346) Start capturing audio from the microphone @@ -186,7 +186,7 @@ Start capturing audio from the microphone stopAudioCapture: () => void; ``` -Defined in: packages/ai/src/realtime/types.ts:348 +Defined in: [packages/ai/src/realtime/types.ts:348](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L348) Stop capturing audio @@ -202,7 +202,7 @@ Stop capturing audio updateSession: (config) => void; ``` -Defined in: packages/ai/src/realtime/types.ts:364 +Defined in: [packages/ai/src/realtime/types.ts:364](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L364) Update session configuration @@ -224,7 +224,7 @@ Update session configuration optional updateToken?: (token) => void; ``` -Defined in: packages/ai/src/realtime/types.ts:366 +Defined in: [packages/ai/src/realtime/types.ts:366](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L366) Update the ephemeral token (e.g. on refresh); provider may reconnect diff --git a/docs/reference/interfaces/RealtimeError.md b/docs/reference/interfaces/RealtimeError.md index 64dc6d2c55..43497795d9 100644 --- a/docs/reference/interfaces/RealtimeError.md +++ b/docs/reference/interfaces/RealtimeError.md @@ -3,7 +3,7 @@ id: RealtimeError title: RealtimeError --- -Defined in: packages/ai/src/realtime/types.ts:299 +Defined in: [packages/ai/src/realtime/types.ts:299](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L299) Extended error with realtime-specific information @@ -19,7 +19,7 @@ Extended error with realtime-specific information code: RealtimeErrorCode; ``` -Defined in: packages/ai/src/realtime/types.ts:300 +Defined in: [packages/ai/src/realtime/types.ts:300](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L300) *** @@ -29,7 +29,7 @@ Defined in: packages/ai/src/realtime/types.ts:300 optional details?: unknown; ``` -Defined in: packages/ai/src/realtime/types.ts:302 +Defined in: [packages/ai/src/realtime/types.ts:302](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L302) *** @@ -39,4 +39,4 @@ Defined in: packages/ai/src/realtime/types.ts:302 optional provider?: string; ``` -Defined in: packages/ai/src/realtime/types.ts:301 +Defined in: [packages/ai/src/realtime/types.ts:301](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L301) diff --git a/docs/reference/interfaces/RealtimeEventPayloads.md b/docs/reference/interfaces/RealtimeEventPayloads.md index f94ced8e42..68a80865e3 100644 --- a/docs/reference/interfaces/RealtimeEventPayloads.md +++ b/docs/reference/interfaces/RealtimeEventPayloads.md @@ -3,7 +3,7 @@ id: RealtimeEventPayloads title: RealtimeEventPayloads --- -Defined in: packages/ai/src/realtime/types.ts:258 +Defined in: [packages/ai/src/realtime/types.ts:258](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L258) Event payloads for realtime events @@ -15,7 +15,7 @@ Event payloads for realtime events audio_chunk: object; ``` -Defined in: packages/ai/src/realtime/types.ts:266 +Defined in: [packages/ai/src/realtime/types.ts:266](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L266) #### data @@ -37,7 +37,7 @@ sampleRate: number; error: object; ``` -Defined in: packages/ai/src/realtime/types.ts:270 +Defined in: [packages/ai/src/realtime/types.ts:270](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L270) #### error @@ -53,7 +53,7 @@ error: Error; go_away: object; ``` -Defined in: packages/ai/src/realtime/types.ts:271 +Defined in: [packages/ai/src/realtime/types.ts:271](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L271) #### timeLeft? @@ -69,7 +69,7 @@ optional timeLeft?: string; interrupted: object; ``` -Defined in: packages/ai/src/realtime/types.ts:269 +Defined in: [packages/ai/src/realtime/types.ts:269](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L269) #### messageId? @@ -85,7 +85,7 @@ optional messageId?: string; message_complete: object; ``` -Defined in: packages/ai/src/realtime/types.ts:268 +Defined in: [packages/ai/src/realtime/types.ts:268](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L268) #### message @@ -101,7 +101,7 @@ message: RealtimeMessage; mode_change: object; ``` -Defined in: packages/ai/src/realtime/types.ts:260 +Defined in: [packages/ai/src/realtime/types.ts:260](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L260) #### mode @@ -117,7 +117,7 @@ mode: RealtimeMode; status_change: object; ``` -Defined in: packages/ai/src/realtime/types.ts:259 +Defined in: [packages/ai/src/realtime/types.ts:259](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L259) #### status @@ -133,7 +133,7 @@ status: RealtimeStatus; tool_call: object; ``` -Defined in: packages/ai/src/realtime/types.ts:267 +Defined in: [packages/ai/src/realtime/types.ts:267](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L267) #### input @@ -161,7 +161,7 @@ toolName: string; transcript: object; ``` -Defined in: packages/ai/src/realtime/types.ts:261 +Defined in: [packages/ai/src/realtime/types.ts:261](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L261) #### isFinal @@ -189,4 +189,4 @@ transcript: string; usage: UsageInfo; ``` -Defined in: packages/ai/src/realtime/types.ts:272 +Defined in: [packages/ai/src/realtime/types.ts:272](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L272) diff --git a/docs/reference/interfaces/RealtimeImagePart.md b/docs/reference/interfaces/RealtimeImagePart.md index 8ca8a172a6..df0e8096c5 100644 --- a/docs/reference/interfaces/RealtimeImagePart.md +++ b/docs/reference/interfaces/RealtimeImagePart.md @@ -3,7 +3,7 @@ id: RealtimeImagePart title: RealtimeImagePart --- -Defined in: packages/ai/src/realtime/types.ts:141 +Defined in: [packages/ai/src/realtime/types.ts:141](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L141) Image content part in a realtime message @@ -15,7 +15,7 @@ Image content part in a realtime message data: string; ``` -Defined in: packages/ai/src/realtime/types.ts:144 +Defined in: [packages/ai/src/realtime/types.ts:144](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L144) Base64-encoded image data or a URL @@ -27,7 +27,7 @@ Base64-encoded image data or a URL mimeType: string; ``` -Defined in: packages/ai/src/realtime/types.ts:146 +Defined in: [packages/ai/src/realtime/types.ts:146](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L146) MIME type of the image (e.g., 'image/png', 'image/jpeg') @@ -39,4 +39,4 @@ MIME type of the image (e.g., 'image/png', 'image/jpeg') type: "image"; ``` -Defined in: packages/ai/src/realtime/types.ts:142 +Defined in: [packages/ai/src/realtime/types.ts:142](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L142) diff --git a/docs/reference/interfaces/RealtimeMessage.md b/docs/reference/interfaces/RealtimeMessage.md index 83d54306a8..bbf99e84e8 100644 --- a/docs/reference/interfaces/RealtimeMessage.md +++ b/docs/reference/interfaces/RealtimeMessage.md @@ -3,7 +3,7 @@ id: RealtimeMessage title: RealtimeMessage --- -Defined in: packages/ai/src/realtime/types.ts:162 +Defined in: [packages/ai/src/realtime/types.ts:162](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L162) A message in a realtime conversation @@ -15,7 +15,7 @@ A message in a realtime conversation optional audioId?: string; ``` -Defined in: packages/ai/src/realtime/types.ts:174 +Defined in: [packages/ai/src/realtime/types.ts:174](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L174) Reference to audio buffer if stored @@ -27,7 +27,7 @@ Reference to audio buffer if stored optional durationMs?: number; ``` -Defined in: packages/ai/src/realtime/types.ts:176 +Defined in: [packages/ai/src/realtime/types.ts:176](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L176) Duration of the audio in milliseconds @@ -39,7 +39,7 @@ Duration of the audio in milliseconds id: string; ``` -Defined in: packages/ai/src/realtime/types.ts:164 +Defined in: [packages/ai/src/realtime/types.ts:164](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L164) Unique message identifier @@ -51,7 +51,7 @@ Unique message identifier optional interrupted?: boolean; ``` -Defined in: packages/ai/src/realtime/types.ts:172 +Defined in: [packages/ai/src/realtime/types.ts:172](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L172) Whether this message was interrupted @@ -63,7 +63,7 @@ Whether this message was interrupted parts: RealtimeMessagePart[]; ``` -Defined in: packages/ai/src/realtime/types.ts:170 +Defined in: [packages/ai/src/realtime/types.ts:170](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L170) Content parts of the message @@ -75,7 +75,7 @@ Content parts of the message role: "assistant" | "user"; ``` -Defined in: packages/ai/src/realtime/types.ts:166 +Defined in: [packages/ai/src/realtime/types.ts:166](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L166) Message role @@ -87,6 +87,6 @@ Message role timestamp: number; ``` -Defined in: packages/ai/src/realtime/types.ts:168 +Defined in: [packages/ai/src/realtime/types.ts:168](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L168) Timestamp when the message was created diff --git a/docs/reference/interfaces/RealtimeSessionConfig.md b/docs/reference/interfaces/RealtimeSessionConfig.md index c0cbd4bd08..487a391d0b 100644 --- a/docs/reference/interfaces/RealtimeSessionConfig.md +++ b/docs/reference/interfaces/RealtimeSessionConfig.md @@ -3,7 +3,7 @@ id: RealtimeSessionConfig title: RealtimeSessionConfig --- -Defined in: packages/ai/src/realtime/types.ts:35 +Defined in: [packages/ai/src/realtime/types.ts:35](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L35) Configuration for a realtime session @@ -15,7 +15,7 @@ Configuration for a realtime session optional instructions?: string; ``` -Defined in: packages/ai/src/realtime/types.ts:41 +Defined in: [packages/ai/src/realtime/types.ts:41](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L41) System instructions for the assistant @@ -27,7 +27,7 @@ System instructions for the assistant optional maxOutputTokens?: number | "inf"; ``` -Defined in: packages/ai/src/realtime/types.ts:53 +Defined in: [packages/ai/src/realtime/types.ts:53](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L53) Maximum number of tokens in a response @@ -39,7 +39,7 @@ Maximum number of tokens in a response optional model?: string; ``` -Defined in: packages/ai/src/realtime/types.ts:37 +Defined in: [packages/ai/src/realtime/types.ts:37](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L37) Model to use for the session @@ -51,7 +51,7 @@ Model to use for the session optional outputModalities?: ("text" | "audio")[]; ``` -Defined in: packages/ai/src/realtime/types.ts:49 +Defined in: [packages/ai/src/realtime/types.ts:49](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L49) Output modalities for responses (e.g., ['audio', 'text'], ['text']) @@ -63,7 +63,7 @@ Output modalities for responses (e.g., ['audio', 'text'], ['text']) optional providerOptions?: Record; ``` -Defined in: packages/ai/src/realtime/types.ts:57 +Defined in: [packages/ai/src/realtime/types.ts:57](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L57) Provider-specific options @@ -75,7 +75,7 @@ Provider-specific options optional semanticEagerness?: "low" | "medium" | "high"; ``` -Defined in: packages/ai/src/realtime/types.ts:55 +Defined in: [packages/ai/src/realtime/types.ts:55](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L55) Eagerness level for semantic VAD ('low', 'medium', 'high') @@ -87,7 +87,7 @@ Eagerness level for semantic VAD ('low', 'medium', 'high') optional temperature?: number; ``` -Defined in: packages/ai/src/realtime/types.ts:51 +Defined in: [packages/ai/src/realtime/types.ts:51](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L51) Temperature for generation (provider-specific range, e.g., 0.6-1.2 for OpenAI) @@ -99,7 +99,7 @@ Temperature for generation (provider-specific range, e.g., 0.6-1.2 for OpenAI) optional tools?: RealtimeToolConfig[]; ``` -Defined in: packages/ai/src/realtime/types.ts:43 +Defined in: [packages/ai/src/realtime/types.ts:43](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L43) Tools available in the session @@ -111,7 +111,7 @@ Tools available in the session optional vadConfig?: VADConfig; ``` -Defined in: packages/ai/src/realtime/types.ts:47 +Defined in: [packages/ai/src/realtime/types.ts:47](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L47) VAD configuration @@ -123,7 +123,7 @@ VAD configuration optional vadMode?: "server" | "manual" | "semantic"; ``` -Defined in: packages/ai/src/realtime/types.ts:45 +Defined in: [packages/ai/src/realtime/types.ts:45](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L45) VAD mode @@ -135,6 +135,6 @@ VAD mode optional voice?: string; ``` -Defined in: packages/ai/src/realtime/types.ts:39 +Defined in: [packages/ai/src/realtime/types.ts:39](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L39) Voice to use for audio output diff --git a/docs/reference/interfaces/RealtimeTextPart.md b/docs/reference/interfaces/RealtimeTextPart.md index 3464c02f58..0f8d46f6b8 100644 --- a/docs/reference/interfaces/RealtimeTextPart.md +++ b/docs/reference/interfaces/RealtimeTextPart.md @@ -3,7 +3,7 @@ id: RealtimeTextPart title: RealtimeTextPart --- -Defined in: packages/ai/src/realtime/types.ts:99 +Defined in: [packages/ai/src/realtime/types.ts:99](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L99) Text content part in a realtime message @@ -15,7 +15,7 @@ Text content part in a realtime message content: string; ``` -Defined in: packages/ai/src/realtime/types.ts:101 +Defined in: [packages/ai/src/realtime/types.ts:101](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L101) *** @@ -25,4 +25,4 @@ Defined in: packages/ai/src/realtime/types.ts:101 type: "text"; ``` -Defined in: packages/ai/src/realtime/types.ts:100 +Defined in: [packages/ai/src/realtime/types.ts:100](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L100) diff --git a/docs/reference/interfaces/RealtimeToken.md b/docs/reference/interfaces/RealtimeToken.md index f3c8b1ba3f..754f4212ee 100644 --- a/docs/reference/interfaces/RealtimeToken.md +++ b/docs/reference/interfaces/RealtimeToken.md @@ -3,7 +3,7 @@ id: RealtimeToken title: RealtimeToken --- -Defined in: packages/ai/src/realtime/types.ts:63 +Defined in: [packages/ai/src/realtime/types.ts:63](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L63) Token returned by the server for client authentication @@ -15,7 +15,7 @@ Token returned by the server for client authentication config: RealtimeSessionConfig; ``` -Defined in: packages/ai/src/realtime/types.ts:71 +Defined in: [packages/ai/src/realtime/types.ts:71](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L71) Session configuration embedded in the token @@ -27,7 +27,7 @@ Session configuration embedded in the token expiresAt: number; ``` -Defined in: packages/ai/src/realtime/types.ts:69 +Defined in: [packages/ai/src/realtime/types.ts:69](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L69) Token expiration timestamp (ms since epoch) @@ -39,7 +39,7 @@ Token expiration timestamp (ms since epoch) provider: string; ``` -Defined in: packages/ai/src/realtime/types.ts:65 +Defined in: [packages/ai/src/realtime/types.ts:65](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L65) Provider identifier @@ -51,6 +51,6 @@ Provider identifier token: string; ``` -Defined in: packages/ai/src/realtime/types.ts:67 +Defined in: [packages/ai/src/realtime/types.ts:67](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L67) The ephemeral token value diff --git a/docs/reference/interfaces/RealtimeTokenAdapter.md b/docs/reference/interfaces/RealtimeTokenAdapter.md index 083a7774ce..4b858040c4 100644 --- a/docs/reference/interfaces/RealtimeTokenAdapter.md +++ b/docs/reference/interfaces/RealtimeTokenAdapter.md @@ -3,7 +3,7 @@ id: RealtimeTokenAdapter title: RealtimeTokenAdapter --- -Defined in: packages/ai/src/realtime/types.ts:77 +Defined in: [packages/ai/src/realtime/types.ts:77](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L77) Adapter interface for generating provider-specific tokens @@ -15,7 +15,7 @@ Adapter interface for generating provider-specific tokens generateToken: () => Promise; ``` -Defined in: packages/ai/src/realtime/types.ts:81 +Defined in: [packages/ai/src/realtime/types.ts:81](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L81) Generate an ephemeral token for client use @@ -31,6 +31,6 @@ Generate an ephemeral token for client use provider: string; ``` -Defined in: packages/ai/src/realtime/types.ts:79 +Defined in: [packages/ai/src/realtime/types.ts:79](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L79) Provider identifier diff --git a/docs/reference/interfaces/RealtimeTokenOptions.md b/docs/reference/interfaces/RealtimeTokenOptions.md index 317977c859..d543b9a23c 100644 --- a/docs/reference/interfaces/RealtimeTokenOptions.md +++ b/docs/reference/interfaces/RealtimeTokenOptions.md @@ -3,7 +3,7 @@ id: RealtimeTokenOptions title: RealtimeTokenOptions --- -Defined in: packages/ai/src/realtime/types.ts:87 +Defined in: [packages/ai/src/realtime/types.ts:87](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L87) Options for the realtimeToken function @@ -15,6 +15,6 @@ Options for the realtimeToken function adapter: RealtimeTokenAdapter; ``` -Defined in: packages/ai/src/realtime/types.ts:89 +Defined in: [packages/ai/src/realtime/types.ts:89](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L89) The token adapter to use diff --git a/docs/reference/interfaces/RealtimeToolCallPart.md b/docs/reference/interfaces/RealtimeToolCallPart.md index 306fe5ed0e..e443276df3 100644 --- a/docs/reference/interfaces/RealtimeToolCallPart.md +++ b/docs/reference/interfaces/RealtimeToolCallPart.md @@ -3,7 +3,7 @@ id: RealtimeToolCallPart title: RealtimeToolCallPart --- -Defined in: packages/ai/src/realtime/types.ts:120 +Defined in: [packages/ai/src/realtime/types.ts:120](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L120) Tool call part in a realtime message @@ -15,7 +15,7 @@ Tool call part in a realtime message arguments: string; ``` -Defined in: packages/ai/src/realtime/types.ts:124 +Defined in: [packages/ai/src/realtime/types.ts:124](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L124) *** @@ -25,7 +25,7 @@ Defined in: packages/ai/src/realtime/types.ts:124 id: string; ``` -Defined in: packages/ai/src/realtime/types.ts:122 +Defined in: [packages/ai/src/realtime/types.ts:122](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L122) *** @@ -35,7 +35,7 @@ Defined in: packages/ai/src/realtime/types.ts:122 optional input?: unknown; ``` -Defined in: packages/ai/src/realtime/types.ts:125 +Defined in: [packages/ai/src/realtime/types.ts:125](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L125) *** @@ -45,7 +45,7 @@ Defined in: packages/ai/src/realtime/types.ts:125 name: string; ``` -Defined in: packages/ai/src/realtime/types.ts:123 +Defined in: [packages/ai/src/realtime/types.ts:123](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L123) *** @@ -55,7 +55,7 @@ Defined in: packages/ai/src/realtime/types.ts:123 optional output?: unknown; ``` -Defined in: packages/ai/src/realtime/types.ts:126 +Defined in: [packages/ai/src/realtime/types.ts:126](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L126) *** @@ -65,4 +65,4 @@ Defined in: packages/ai/src/realtime/types.ts:126 type: "tool-call"; ``` -Defined in: packages/ai/src/realtime/types.ts:121 +Defined in: [packages/ai/src/realtime/types.ts:121](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L121) diff --git a/docs/reference/interfaces/RealtimeToolConfig.md b/docs/reference/interfaces/RealtimeToolConfig.md index a720443d8d..d9abefaa0e 100644 --- a/docs/reference/interfaces/RealtimeToolConfig.md +++ b/docs/reference/interfaces/RealtimeToolConfig.md @@ -3,7 +3,7 @@ id: RealtimeToolConfig title: RealtimeToolConfig --- -Defined in: packages/ai/src/realtime/types.ts:25 +Defined in: [packages/ai/src/realtime/types.ts:25](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L25) Serializable tool descriptor for realtime session configuration. Contains only the metadata needed by providers, not Zod schemas or execute functions. @@ -16,7 +16,7 @@ Contains only the metadata needed by providers, not Zod schemas or execute funct description: string; ``` -Defined in: packages/ai/src/realtime/types.ts:27 +Defined in: [packages/ai/src/realtime/types.ts:27](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L27) *** @@ -26,7 +26,7 @@ Defined in: packages/ai/src/realtime/types.ts:27 optional inputSchema?: Record; ``` -Defined in: packages/ai/src/realtime/types.ts:28 +Defined in: [packages/ai/src/realtime/types.ts:28](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L28) *** @@ -36,7 +36,7 @@ Defined in: packages/ai/src/realtime/types.ts:28 name: string; ``` -Defined in: packages/ai/src/realtime/types.ts:26 +Defined in: [packages/ai/src/realtime/types.ts:26](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L26) *** @@ -46,4 +46,4 @@ Defined in: packages/ai/src/realtime/types.ts:26 optional outputSchema?: Record; ``` -Defined in: packages/ai/src/realtime/types.ts:29 +Defined in: [packages/ai/src/realtime/types.ts:29](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L29) diff --git a/docs/reference/interfaces/RealtimeToolResultPart.md b/docs/reference/interfaces/RealtimeToolResultPart.md index 558534b55d..15fa2e2556 100644 --- a/docs/reference/interfaces/RealtimeToolResultPart.md +++ b/docs/reference/interfaces/RealtimeToolResultPart.md @@ -3,7 +3,7 @@ id: RealtimeToolResultPart title: RealtimeToolResultPart --- -Defined in: packages/ai/src/realtime/types.ts:132 +Defined in: [packages/ai/src/realtime/types.ts:132](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L132) Tool result part in a realtime message @@ -15,7 +15,7 @@ Tool result part in a realtime message content: string; ``` -Defined in: packages/ai/src/realtime/types.ts:135 +Defined in: [packages/ai/src/realtime/types.ts:135](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L135) *** @@ -25,7 +25,7 @@ Defined in: packages/ai/src/realtime/types.ts:135 toolCallId: string; ``` -Defined in: packages/ai/src/realtime/types.ts:134 +Defined in: [packages/ai/src/realtime/types.ts:134](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L134) *** @@ -35,4 +35,4 @@ Defined in: packages/ai/src/realtime/types.ts:134 type: "tool-result"; ``` -Defined in: packages/ai/src/realtime/types.ts:133 +Defined in: [packages/ai/src/realtime/types.ts:133](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L133) diff --git a/docs/reference/interfaces/ReasoningCapability.md b/docs/reference/interfaces/ReasoningCapability.md index f9598b9fc9..815ffdb253 100644 --- a/docs/reference/interfaces/ReasoningCapability.md +++ b/docs/reference/interfaces/ReasoningCapability.md @@ -3,7 +3,7 @@ id: ReasoningCapability title: ReasoningCapability --- -Defined in: packages/ai/src/reasoning.ts:36 +Defined in: [packages/ai/src/reasoning.ts:36](https://github.com/TanStack/ai/blob/main/packages/ai/src/reasoning.ts#L36) What a model supports, at the type level. Adapters declare it per model in `'~types'.reasoning`. `levels` is a union of the model's levels. `budget` @@ -17,7 +17,7 @@ says whether the model takes a thinking token budget. budget: boolean; ``` -Defined in: packages/ai/src/reasoning.ts:38 +Defined in: [packages/ai/src/reasoning.ts:38](https://github.com/TanStack/ai/blob/main/packages/ai/src/reasoning.ts#L38) *** @@ -27,4 +27,4 @@ Defined in: packages/ai/src/reasoning.ts:38 levels: ReasoningLevel; ``` -Defined in: packages/ai/src/reasoning.ts:37 +Defined in: [packages/ai/src/reasoning.ts:37](https://github.com/TanStack/ai/blob/main/packages/ai/src/reasoning.ts#L37) diff --git a/docs/reference/interfaces/ReasoningEncryptedValueEvent.md b/docs/reference/interfaces/ReasoningEncryptedValueEvent.md index 29c4a5046b..a33b014ec4 100644 --- a/docs/reference/interfaces/ReasoningEncryptedValueEvent.md +++ b/docs/reference/interfaces/ReasoningEncryptedValueEvent.md @@ -3,7 +3,7 @@ id: ReasoningEncryptedValueEvent title: ReasoningEncryptedValueEvent --- -Defined in: packages/ai/src/types.ts:1991 +Defined in: [packages/ai/src/types.ts:2049](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2049) Emitted for encrypted reasoning values. diff --git a/docs/reference/interfaces/ReasoningEndEvent.md b/docs/reference/interfaces/ReasoningEndEvent.md index 85354c2589..32708e1894 100644 --- a/docs/reference/interfaces/ReasoningEndEvent.md +++ b/docs/reference/interfaces/ReasoningEndEvent.md @@ -3,7 +3,7 @@ id: ReasoningEndEvent title: ReasoningEndEvent --- -Defined in: packages/ai/src/types.ts:1984 +Defined in: [packages/ai/src/types.ts:2042](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2042) Emitted when reasoning ends for a message. diff --git a/docs/reference/interfaces/ReasoningMessageChunkEvent.md b/docs/reference/interfaces/ReasoningMessageChunkEvent.md index 61c7801eb8..188dae2737 100644 --- a/docs/reference/interfaces/ReasoningMessageChunkEvent.md +++ b/docs/reference/interfaces/ReasoningMessageChunkEvent.md @@ -3,7 +3,7 @@ id: ReasoningMessageChunkEvent title: ReasoningMessageChunkEvent --- -Defined in: packages/ai/src/types.ts:2029 +Defined in: [packages/ai/src/types.ts:2087](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2087) AG-UI 1.0 ReasoningMessageChunkEvent shape. diff --git a/docs/reference/interfaces/ReasoningMessageContentEvent.md b/docs/reference/interfaces/ReasoningMessageContentEvent.md index 9326a86b00..f539f49150 100644 --- a/docs/reference/interfaces/ReasoningMessageContentEvent.md +++ b/docs/reference/interfaces/ReasoningMessageContentEvent.md @@ -3,7 +3,7 @@ id: ReasoningMessageContentEvent title: ReasoningMessageContentEvent --- -Defined in: packages/ai/src/types.ts:1970 +Defined in: [packages/ai/src/types.ts:2028](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2028) Emitted when reasoning message content is generated. diff --git a/docs/reference/interfaces/ReasoningMessageEndEvent.md b/docs/reference/interfaces/ReasoningMessageEndEvent.md index 900b2b2f1d..c9b20f146f 100644 --- a/docs/reference/interfaces/ReasoningMessageEndEvent.md +++ b/docs/reference/interfaces/ReasoningMessageEndEvent.md @@ -3,7 +3,7 @@ id: ReasoningMessageEndEvent title: ReasoningMessageEndEvent --- -Defined in: packages/ai/src/types.ts:1977 +Defined in: [packages/ai/src/types.ts:2035](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2035) Emitted when a reasoning message ends. diff --git a/docs/reference/interfaces/ReasoningMessageStartEvent.md b/docs/reference/interfaces/ReasoningMessageStartEvent.md index ce1062a49a..df29de6ba7 100644 --- a/docs/reference/interfaces/ReasoningMessageStartEvent.md +++ b/docs/reference/interfaces/ReasoningMessageStartEvent.md @@ -3,7 +3,7 @@ id: ReasoningMessageStartEvent title: ReasoningMessageStartEvent --- -Defined in: packages/ai/src/types.ts:1963 +Defined in: [packages/ai/src/types.ts:2021](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2021) Emitted when a reasoning message starts. diff --git a/docs/reference/interfaces/ReasoningRequest.md b/docs/reference/interfaces/ReasoningRequest.md index f7350230e7..6d0c13869e 100644 --- a/docs/reference/interfaces/ReasoningRequest.md +++ b/docs/reference/interfaces/ReasoningRequest.md @@ -3,7 +3,7 @@ id: ReasoningRequest title: ReasoningRequest --- -Defined in: packages/ai/src/reasoning.ts:72 +Defined in: [packages/ai/src/reasoning.ts:72](https://github.com/TanStack/ai/blob/main/packages/ai/src/reasoning.ts#L72) The `reasoning` an adapter gets in `TextOptions`, after `chat()` normalized it. @@ -15,7 +15,7 @@ The `reasoning` an adapter gets in `TextOptions`, after `chat()` normalized it. optional budgetTokens?: number; ``` -Defined in: packages/ai/src/reasoning.ts:75 +Defined in: [packages/ai/src/reasoning.ts:75](https://github.com/TanStack/ai/blob/main/packages/ai/src/reasoning.ts#L75) *** @@ -25,7 +25,7 @@ Defined in: packages/ai/src/reasoning.ts:75 level: ReasoningLevel; ``` -Defined in: packages/ai/src/reasoning.ts:73 +Defined in: [packages/ai/src/reasoning.ts:73](https://github.com/TanStack/ai/blob/main/packages/ai/src/reasoning.ts#L73) *** @@ -35,4 +35,4 @@ Defined in: packages/ai/src/reasoning.ts:73 summary: boolean; ``` -Defined in: packages/ai/src/reasoning.ts:74 +Defined in: [packages/ai/src/reasoning.ts:74](https://github.com/TanStack/ai/blob/main/packages/ai/src/reasoning.ts#L74) diff --git a/docs/reference/interfaces/ReasoningStartEvent.md b/docs/reference/interfaces/ReasoningStartEvent.md index c33ec1f9f9..931b272ebf 100644 --- a/docs/reference/interfaces/ReasoningStartEvent.md +++ b/docs/reference/interfaces/ReasoningStartEvent.md @@ -3,7 +3,7 @@ id: ReasoningStartEvent title: ReasoningStartEvent --- -Defined in: packages/ai/src/types.ts:1956 +Defined in: [packages/ai/src/types.ts:2014](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2014) Emitted when reasoning starts for a message. diff --git a/docs/reference/interfaces/RerankAdapter.md b/docs/reference/interfaces/RerankAdapter.md index 16d130af84..059d9ce905 100644 --- a/docs/reference/interfaces/RerankAdapter.md +++ b/docs/reference/interfaces/RerankAdapter.md @@ -3,7 +3,7 @@ id: RerankAdapter title: RerankAdapter --- -Defined in: packages/ai/src/activities/rerank/adapter.ts:23 +Defined in: [packages/ai/src/activities/rerank/adapter.ts:23](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/rerank/adapter.ts#L23) Rerank adapter interface with pre-resolved generics. @@ -32,7 +32,7 @@ Generic parameters: ~types: object; ``` -Defined in: packages/ai/src/activities/rerank/adapter.ts:37 +Defined in: [packages/ai/src/activities/rerank/adapter.ts:37](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/rerank/adapter.ts#L37) **`Internal`** @@ -52,7 +52,7 @@ providerOptions: TProviderOptions; readonly kind: "rerank"; ``` -Defined in: packages/ai/src/activities/rerank/adapter.ts:28 +Defined in: [packages/ai/src/activities/rerank/adapter.ts:28](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/rerank/adapter.ts#L28) Discriminator for adapter kind @@ -64,7 +64,7 @@ Discriminator for adapter kind readonly model: TModel; ``` -Defined in: packages/ai/src/activities/rerank/adapter.ts:32 +Defined in: [packages/ai/src/activities/rerank/adapter.ts:32](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/rerank/adapter.ts#L32) The model this adapter is configured for @@ -76,7 +76,7 @@ The model this adapter is configured for readonly name: string; ``` -Defined in: packages/ai/src/activities/rerank/adapter.ts:30 +Defined in: [packages/ai/src/activities/rerank/adapter.ts:30](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/rerank/adapter.ts#L30) Adapter name identifier @@ -88,7 +88,7 @@ Adapter name identifier rerank: (options) => Promise; ``` -Defined in: packages/ai/src/activities/rerank/adapter.ts:46 +Defined in: [packages/ai/src/activities/rerank/adapter.ts:46](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/rerank/adapter.ts#L46) Rerank the given (pre-serialized) documents against the query, returning scored indices into `options.documents`. The activity layer maps these diff --git a/docs/reference/interfaces/RerankAdapterResult.md b/docs/reference/interfaces/RerankAdapterResult.md index 41310de394..6355a1b6b4 100644 --- a/docs/reference/interfaces/RerankAdapterResult.md +++ b/docs/reference/interfaces/RerankAdapterResult.md @@ -3,7 +3,7 @@ id: RerankAdapterResult title: RerankAdapterResult --- -Defined in: packages/ai/src/types.ts:2215 +Defined in: [packages/ai/src/types.ts:2273](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2273) Provider-level rerank result. Adapters return scored indices into the (serialized) `documents` array plus usage — never the documents themselves. @@ -17,7 +17,7 @@ The activity attaches the original documents. id: string; ``` -Defined in: packages/ai/src/types.ts:2216 +Defined in: [packages/ai/src/types.ts:2274](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2274) *** @@ -27,7 +27,7 @@ Defined in: packages/ai/src/types.ts:2216 ranking: object[]; ``` -Defined in: packages/ai/src/types.ts:2218 +Defined in: [packages/ai/src/types.ts:2276](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2276) Scored results, highest relevance first, as indices into `documents`. @@ -51,4 +51,4 @@ score: number; usage: TokenUsage; ``` -Defined in: packages/ai/src/types.ts:2219 +Defined in: [packages/ai/src/types.ts:2277](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2277) diff --git a/docs/reference/interfaces/RerankOptions.md b/docs/reference/interfaces/RerankOptions.md index 75df2dc7af..f3e49da072 100644 --- a/docs/reference/interfaces/RerankOptions.md +++ b/docs/reference/interfaces/RerankOptions.md @@ -3,7 +3,7 @@ id: RerankOptions title: RerankOptions --- -Defined in: packages/ai/src/types.ts:2188 +Defined in: [packages/ai/src/types.ts:2246](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2246) Options passed to a [RerankAdapter](RerankAdapter.md). Documents reach the adapter already serialized to strings — the `rerank()` activity stringifies object @@ -24,7 +24,7 @@ deal with the caller's document type. optional abortSignal?: AbortSignal; ``` -Defined in: packages/ai/src/types.ts:2201 +Defined in: [packages/ai/src/types.ts:2259](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2259) Forwarded to the provider request for cancellation. @@ -36,7 +36,7 @@ Forwarded to the provider request for cancellation. documents: string[]; ``` -Defined in: packages/ai/src/types.ts:2195 +Defined in: [packages/ai/src/types.ts:2253](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2253) Documents to rerank, pre-serialized to strings by the activity. @@ -48,7 +48,7 @@ Documents to rerank, pre-serialized to strings by the activity. logger: InternalLogger; ``` -Defined in: packages/ai/src/types.ts:2207 +Defined in: [packages/ai/src/types.ts:2265](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2265) Internal logger threaded from the rerank() entry point. Adapters must call logger.request() before the provider call and logger.errors() in catch @@ -62,7 +62,7 @@ blocks. model: string; ``` -Defined in: packages/ai/src/types.ts:2191 +Defined in: [packages/ai/src/types.ts:2249](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2249) *** @@ -72,7 +72,7 @@ Defined in: packages/ai/src/types.ts:2191 optional modelOptions?: TProviderOptions; ``` -Defined in: packages/ai/src/types.ts:2199 +Defined in: [packages/ai/src/types.ts:2257](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2257) Provider-specific options forwarded by the rerank() activity. @@ -84,7 +84,7 @@ Provider-specific options forwarded by the rerank() activity. query: string; ``` -Defined in: packages/ai/src/types.ts:2193 +Defined in: [packages/ai/src/types.ts:2251](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2251) The search query documents are scored against. @@ -96,6 +96,6 @@ The search query documents are scored against. optional topN?: number; ``` -Defined in: packages/ai/src/types.ts:2197 +Defined in: [packages/ai/src/types.ts:2255](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2255) Return only the top N results. Passed through to the provider. diff --git a/docs/reference/interfaces/RerankResult.md b/docs/reference/interfaces/RerankResult.md index 74cabbed26..3ccab96933 100644 --- a/docs/reference/interfaces/RerankResult.md +++ b/docs/reference/interfaces/RerankResult.md @@ -3,7 +3,7 @@ id: RerankResult title: RerankResult --- -Defined in: packages/ai/src/types.ts:2227 +Defined in: [packages/ai/src/types.ts:2285](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2285) Public result of the `rerank()` activity, generic over the caller's document element type so `document` / `rerankedDocuments` carry the original values @@ -23,7 +23,7 @@ element type so `document` / `rerankedDocuments` carry the original values id: string; ``` -Defined in: packages/ai/src/types.ts:2228 +Defined in: [packages/ai/src/types.ts:2286](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2286) *** @@ -33,7 +33,7 @@ Defined in: packages/ai/src/types.ts:2228 model: string; ``` -Defined in: packages/ai/src/types.ts:2229 +Defined in: [packages/ai/src/types.ts:2287](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2287) *** @@ -43,7 +43,7 @@ Defined in: packages/ai/src/types.ts:2229 ranking: object[]; ``` -Defined in: packages/ai/src/types.ts:2231 +Defined in: [packages/ai/src/types.ts:2289](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2289) Scored results, highest relevance first. @@ -73,7 +73,7 @@ score: number; rerankedDocuments: TDocument[]; ``` -Defined in: packages/ai/src/types.ts:2233 +Defined in: [packages/ai/src/types.ts:2291](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2291) The documents reordered by relevance — `ranking.map(r => r.document)`. @@ -85,7 +85,7 @@ The documents reordered by relevance — `ranking.map(r => r.document)`. usage: TokenUsage; ``` -Defined in: packages/ai/src/types.ts:2240 +Defined in: [packages/ai/src/types.ts:2298](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2298) Usage for the request. Rerank typically bills in provider-defined "search units" (`usage.billed = { quantity, unit: 'units' }`) rather than tokens. diff --git a/docs/reference/interfaces/ResolvedEmbeddingItem.md b/docs/reference/interfaces/ResolvedEmbeddingItem.md index e24b24fc67..33d3b82091 100644 --- a/docs/reference/interfaces/ResolvedEmbeddingItem.md +++ b/docs/reference/interfaces/ResolvedEmbeddingItem.md @@ -3,7 +3,7 @@ id: ResolvedEmbeddingItem title: ResolvedEmbeddingItem --- -Defined in: packages/ai/src/utilities/embedding-input.ts:8 +Defined in: [packages/ai/src/utilities/embedding-input.ts:8](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/embedding-input.ts#L8) One embedding input item resolved into its text and image constituents. Produced by [resolveEmbeddingInput](../functions/resolveEmbeddingInput.md); adapters map each entry onto @@ -17,7 +17,7 @@ one provider-native input (one vector per entry). images: ImagePart[]; ``` -Defined in: packages/ai/src/utilities/embedding-input.ts:12 +Defined in: [packages/ai/src/utilities/embedding-input.ts:12](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/embedding-input.ts#L12) Image parts of the item, in order (empty for text-only items) @@ -29,6 +29,6 @@ Image parts of the item, in order (empty for text-only items) texts: string[]; ``` -Defined in: packages/ai/src/utilities/embedding-input.ts:10 +Defined in: [packages/ai/src/utilities/embedding-input.ts:10](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/embedding-input.ts#L10) Text contents of the item, in order (empty for image-only items) diff --git a/docs/reference/interfaces/ResolvedMediaPrompt.md b/docs/reference/interfaces/ResolvedMediaPrompt.md index d6bf2b2eea..59d7ae2ca2 100644 --- a/docs/reference/interfaces/ResolvedMediaPrompt.md +++ b/docs/reference/interfaces/ResolvedMediaPrompt.md @@ -3,7 +3,7 @@ id: ResolvedMediaPrompt title: ResolvedMediaPrompt --- -Defined in: packages/ai/src/utilities/media-prompt.ts:23 +Defined in: [packages/ai/src/utilities/media-prompt.ts:23](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/media-prompt.ts#L23) A [MediaPrompt](../type-aliases/MediaPrompt.md) decomposed into the views adapters consume. @@ -24,7 +24,7 @@ themselves — the SDK does not inject or substitute markers. audios: AudioPart[]; ``` -Defined in: packages/ai/src/utilities/media-prompt.ts:36 +Defined in: [packages/ai/src/utilities/media-prompt.ts:36](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/media-prompt.ts#L36) Audio parts in prompt order. @@ -36,7 +36,7 @@ Audio parts in prompt order. images: ImagePart[]; ``` -Defined in: packages/ai/src/utilities/media-prompt.ts:32 +Defined in: [packages/ai/src/utilities/media-prompt.ts:32](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/media-prompt.ts#L32) Image parts in prompt order. @@ -48,7 +48,7 @@ Image parts in prompt order. parts: MediaPromptPart[]; ``` -Defined in: packages/ai/src/utilities/media-prompt.ts:30 +Defined in: [packages/ai/src/utilities/media-prompt.ts:30](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/media-prompt.ts#L30) The prompt as ordered parts; a string prompt becomes one text part. @@ -60,7 +60,7 @@ The prompt as ordered parts; a string prompt becomes one text part. text: string; ``` -Defined in: packages/ai/src/utilities/media-prompt.ts:28 +Defined in: [packages/ai/src/utilities/media-prompt.ts:28](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/media-prompt.ts#L28) Text parts concatenated verbatim (paragraph-separated). Empty string for media-only prompts. @@ -73,6 +73,6 @@ for media-only prompts. videos: VideoPart[]; ``` -Defined in: packages/ai/src/utilities/media-prompt.ts:34 +Defined in: [packages/ai/src/utilities/media-prompt.ts:34](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/media-prompt.ts#L34) Video parts in prompt order. diff --git a/docs/reference/interfaces/ResolvedPromptCache.md b/docs/reference/interfaces/ResolvedPromptCache.md index 039c35309f..66141f41fc 100644 --- a/docs/reference/interfaces/ResolvedPromptCache.md +++ b/docs/reference/interfaces/ResolvedPromptCache.md @@ -3,7 +3,7 @@ id: ResolvedPromptCache title: ResolvedPromptCache --- -Defined in: packages/ai/src/types.ts:1277 +Defined in: [packages/ai/src/types.ts:1317](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1317) What chat() gives the adapter. @@ -15,7 +15,7 @@ What chat() gives the adapter. optional key?: string; ``` -Defined in: packages/ai/src/types.ts:1279 +Defined in: [packages/ai/src/types.ts:1319](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1319) *** @@ -25,4 +25,4 @@ Defined in: packages/ai/src/types.ts:1279 retention: PromptCacheRetention; ``` -Defined in: packages/ai/src/types.ts:1278 +Defined in: [packages/ai/src/types.ts:1318](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1318) diff --git a/docs/reference/interfaces/ResponseFormat.md b/docs/reference/interfaces/ResponseFormat.md index b6f9143839..b4db476599 100644 --- a/docs/reference/interfaces/ResponseFormat.md +++ b/docs/reference/interfaces/ResponseFormat.md @@ -3,7 +3,7 @@ id: ResponseFormat title: ResponseFormat --- -Defined in: packages/ai/src/types.ts:1124 +Defined in: [packages/ai/src/types.ts:1164](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1164) Structured output format specification. @@ -31,7 +31,7 @@ TypeScript type of the expected data structure (for type safety) optional __data?: TData; ``` -Defined in: packages/ai/src/types.ts:1202 +Defined in: [packages/ai/src/types.ts:1242](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1242) **`Internal`** @@ -48,7 +48,7 @@ Allows the SDK to know what type to expect when parsing the response. optional json_schema?: object; ``` -Defined in: packages/ai/src/types.ts:1141 +Defined in: [packages/ai/src/types.ts:1181](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1181) JSON schema specification (required when type is "json_schema"). @@ -137,7 +137,7 @@ https://platform.openai.com/docs/guides/structured-outputs#strict-mode type: "json_object" | "json_schema"; ``` -Defined in: packages/ai/src/types.ts:1133 +Defined in: [packages/ai/src/types.ts:1173](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1173) Type of structured output. diff --git a/docs/reference/interfaces/RunArtifactRef.md b/docs/reference/interfaces/RunArtifactRef.md index c0a566754e..fc9f6904ee 100644 --- a/docs/reference/interfaces/RunArtifactRef.md +++ b/docs/reference/interfaces/RunArtifactRef.md @@ -3,7 +3,7 @@ id: RunArtifactRef title: RunArtifactRef --- -Defined in: packages/ai/src/activities/chat/middleware/run-store.ts:210 +Defined in: [packages/ai/src/activities/chat/middleware/run-store.ts:210](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/run-store.ts#L210) A durable artifact a run produced. @@ -15,7 +15,7 @@ A durable artifact a run produced. artifactId: string; ``` -Defined in: packages/ai/src/activities/chat/middleware/run-store.ts:211 +Defined in: [packages/ai/src/activities/chat/middleware/run-store.ts:211](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/run-store.ts#L211) *** @@ -25,7 +25,7 @@ Defined in: packages/ai/src/activities/chat/middleware/run-store.ts:211 optional mimeType?: string; ``` -Defined in: packages/ai/src/activities/chat/middleware/run-store.ts:213 +Defined in: [packages/ai/src/activities/chat/middleware/run-store.ts:213](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/run-store.ts#L213) *** @@ -35,7 +35,7 @@ Defined in: packages/ai/src/activities/chat/middleware/run-store.ts:213 optional name?: string; ``` -Defined in: packages/ai/src/activities/chat/middleware/run-store.ts:212 +Defined in: [packages/ai/src/activities/chat/middleware/run-store.ts:212](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/run-store.ts#L212) *** @@ -45,4 +45,4 @@ Defined in: packages/ai/src/activities/chat/middleware/run-store.ts:212 optional url?: string; ``` -Defined in: packages/ai/src/activities/chat/middleware/run-store.ts:214 +Defined in: [packages/ai/src/activities/chat/middleware/run-store.ts:214](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/run-store.ts#L214) diff --git a/docs/reference/interfaces/RunCheckpoint.md b/docs/reference/interfaces/RunCheckpoint.md index 05f6be8ae0..2cfded5012 100644 --- a/docs/reference/interfaces/RunCheckpoint.md +++ b/docs/reference/interfaces/RunCheckpoint.md @@ -3,7 +3,7 @@ id: RunCheckpoint title: RunCheckpoint --- -Defined in: packages/ai/src/activities/chat/middleware/run-store.ts:218 +Defined in: [packages/ai/src/activities/chat/middleware/run-store.ts:218](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/run-store.ts#L218) What a run saved at its last model or tool boundary. @@ -15,7 +15,7 @@ What a run saved at its last model or tool boundary. at: number; ``` -Defined in: packages/ai/src/activities/chat/middleware/run-store.ts:220 +Defined in: [packages/ai/src/activities/chat/middleware/run-store.ts:220](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/run-store.ts#L220) Epoch ms of the checkpoint. @@ -27,7 +27,7 @@ Epoch ms of the checkpoint. optional pendingTools?: object[]; ``` -Defined in: packages/ai/src/activities/chat/middleware/run-store.ts:222 +Defined in: [packages/ai/src/activities/chat/middleware/run-store.ts:222](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/run-store.ts#L222) Tools that started but had no result yet at the checkpoint. diff --git a/docs/reference/interfaces/RunDriverOptions.md b/docs/reference/interfaces/RunDriverOptions.md index bb2c782bc7..0d0afce129 100644 --- a/docs/reference/interfaces/RunDriverOptions.md +++ b/docs/reference/interfaces/RunDriverOptions.md @@ -3,7 +3,7 @@ id: RunDriverOptions title: RunDriverOptions --- -Defined in: packages/ai/src/stream-to-response.ts:1166 +Defined in: [packages/ai/src/stream-to-response.ts:1166](https://github.com/TanStack/ai/blob/main/packages/ai/src/stream-to-response.ts#L1166) Everything the resume helpers need to take a run over as a side effect of serving its log. @@ -26,7 +26,7 @@ background-worker-driven run supply its own pair. claim: (input, fn) => Promise; ``` -Defined in: packages/ai/src/stream-to-response.ts:1178 +Defined in: [packages/ai/src/stream-to-response.ts:1178](https://github.com/TanStack/ai/blob/main/packages/ai/src/stream-to-response.ts#L1178) Run `fn` under exclusive ownership of the run, or reject if refused. @@ -68,7 +68,7 @@ Run `fn` under exclusive ownership of the run, or reject if refused. drive: (input) => AsyncIterable; ``` -Defined in: packages/ai/src/stream-to-response.ts:1172 +Defined in: [packages/ai/src/stream-to-response.ts:1172](https://github.com/TanStack/ai/blob/main/packages/ai/src/stream-to-response.ts#L1172) Produce the run's remaining events. Called only once the claim is held. @@ -100,7 +100,7 @@ Produce the run's remaining events. Called only once the claim is held. locks: LockStore; ``` -Defined in: packages/ai/src/stream-to-response.ts:1170 +Defined in: [packages/ai/src/stream-to-response.ts:1170](https://github.com/TanStack/ai/blob/main/packages/ai/src/stream-to-response.ts#L1170) *** @@ -110,7 +110,7 @@ Defined in: packages/ai/src/stream-to-response.ts:1170 optional logger?: InternalLogger; ``` -Defined in: packages/ai/src/stream-to-response.ts:1193 +Defined in: [packages/ai/src/stream-to-response.ts:1193](https://github.com/TanStack/ai/blob/main/packages/ai/src/stream-to-response.ts#L1193) *** @@ -120,7 +120,7 @@ Defined in: packages/ai/src/stream-to-response.ts:1193 pipe: (stream, input) => Promise; ``` -Defined in: packages/ai/src/stream-to-response.ts:1187 +Defined in: [packages/ai/src/stream-to-response.ts:1187](https://github.com/TanStack/ai/blob/main/packages/ai/src/stream-to-response.ts#L1187) Persist the driven stream to the run's producer-side durability log. @@ -156,7 +156,7 @@ Persist the driven stream to the run's producer-side durability log. request: Request; ``` -Defined in: packages/ai/src/stream-to-response.ts:1168 +Defined in: [packages/ai/src/stream-to-response.ts:1168](https://github.com/TanStack/ai/blob/main/packages/ai/src/stream-to-response.ts#L1168) The attach request; its run id is read with [resolveResumeRunId](../functions/resolveResumeRunId.md). @@ -168,7 +168,7 @@ The attach request; its run id is read with [resolveResumeRunId](../functions/re runs: RunStore; ``` -Defined in: packages/ai/src/stream-to-response.ts:1169 +Defined in: [packages/ai/src/stream-to-response.ts:1169](https://github.com/TanStack/ai/blob/main/packages/ai/src/stream-to-response.ts#L1169) *** @@ -178,7 +178,7 @@ Defined in: packages/ai/src/stream-to-response.ts:1169 optional waitUntil?: (promise) => void; ``` -Defined in: packages/ai/src/stream-to-response.ts:1192 +Defined in: [packages/ai/src/stream-to-response.ts:1192](https://github.com/TanStack/ai/blob/main/packages/ai/src/stream-to-response.ts#L1192) Platform keep-alive (e.g. `ctx.waitUntil`) for the background drive. diff --git a/docs/reference/interfaces/RunError.md b/docs/reference/interfaces/RunError.md index 61d456ddeb..b0f272915d 100644 --- a/docs/reference/interfaces/RunError.md +++ b/docs/reference/interfaces/RunError.md @@ -3,7 +3,7 @@ id: RunError title: RunError --- -Defined in: packages/ai/src/activities/chat/middleware/run-store.ts:99 +Defined in: [packages/ai/src/activities/chat/middleware/run-store.ts:99](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/run-store.ts#L99) Why a run failed. @@ -19,7 +19,7 @@ to decide whether to retry, escalate, or surface a specific UI. optional code?: string; ``` -Defined in: packages/ai/src/activities/chat/middleware/run-store.ts:102 +Defined in: [packages/ai/src/activities/chat/middleware/run-store.ts:102](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/run-store.ts#L102) Stable, machine-branchable classification, when the provider supplies one. @@ -31,4 +31,4 @@ Stable, machine-branchable classification, when the provider supplies one. message: string; ``` -Defined in: packages/ai/src/activities/chat/middleware/run-store.ts:100 +Defined in: [packages/ai/src/activities/chat/middleware/run-store.ts:100](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/run-store.ts#L100) diff --git a/docs/reference/interfaces/RunErrorEvent.md b/docs/reference/interfaces/RunErrorEvent.md index 2c9937b4b0..97c5615687 100644 --- a/docs/reference/interfaces/RunErrorEvent.md +++ b/docs/reference/interfaces/RunErrorEvent.md @@ -3,7 +3,7 @@ id: RunErrorEvent title: RunErrorEvent --- -Defined in: packages/ai/src/types.ts:1623 +Defined in: [packages/ai/src/types.ts:1663](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1663) Emitted when an error occurs during a run. @@ -23,7 +23,7 @@ Spec `usage[]` is provider/model token counts. Interrupt errors live in optional error?: object; ``` -Defined in: packages/ai/src/types.ts:1636 +Defined in: [packages/ai/src/types.ts:1676](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1676) Nested payload kept for in-process / durability consumers. @@ -41,13 +41,27 @@ message: string; *** +### errorType? + +```ts +optional errorType?: string; +``` + +Defined in: [packages/ai/src/types.ts:1694](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1694) + +The provider's error type, for example `overloaded_error` or +`rate_limit_exceeded`. `code` stays the HTTP status. A string of at most +128 characters. `chat()` moves it to `metadata.tanstack.errorType`. + +*** + ### metadata? ```ts optional metadata?: object & Record; ``` -Defined in: packages/ai/src/types.ts:1643 +Defined in: [packages/ai/src/types.ts:1701](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1701) #### Type Declaration @@ -65,19 +79,47 @@ optional tanstack?: TanStackRunMetadata; optional model?: string; ``` -Defined in: packages/ai/src/types.ts:1634 +Defined in: [packages/ai/src/types.ts:1674](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1674) Restored on the client from `metadata.tanstack`. *** +### rawText? + +```ts +optional rawText?: string; +``` + +Defined in: [packages/ai/src/types.ts:1682](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1682) + +The model text of a failed structured output: JSON that did not parse, +or a value that failed the `outputSchema` check. `chat()` moves it to +`metadata.tanstack.rawText`. + +*** + +### requestId? + +```ts +optional requestId?: string; +``` + +Defined in: [packages/ai/src/types.ts:1700](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1700) + +The provider's request id, from the SDK error or the `request-id` / +`x-request-id` header. Give it to the provider's support. +`chat()` moves it to `metadata.tanstack.requestId`. + +*** + ### retryAfterMs? ```ts optional retryAfterMs?: number; ``` -Defined in: packages/ai/src/types.ts:1642 +Defined in: [packages/ai/src/types.ts:1688](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1688) How long the provider asks you to wait before a retry, in milliseconds. Adapters read it from the `retry-after-ms` or `retry-after` header. @@ -91,7 +133,7 @@ Adapters read it from the `retry-after-ms` or `retry-after` header. optional runId?: string; ``` -Defined in: packages/ai/src/types.ts:1632 +Defined in: [packages/ai/src/types.ts:1672](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1672) Restored on the client from `metadata.tanstack`. @@ -103,7 +145,7 @@ Restored on the client from `metadata.tanstack`. optional threadId?: string; ``` -Defined in: packages/ai/src/types.ts:1630 +Defined in: [packages/ai/src/types.ts:1670](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1670) Restored on the client from `metadata.tanstack`. @@ -115,7 +157,7 @@ Restored on the client from `metadata.tanstack`. type: RUN_ERROR; ``` -Defined in: packages/ai/src/types.ts:1627 +Defined in: [packages/ai/src/types.ts:1667](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1667) *** @@ -125,4 +167,4 @@ Defined in: packages/ai/src/types.ts:1627 optional usage?: TokenUsage | TokenUsage[]; ``` -Defined in: packages/ai/src/types.ts:1628 +Defined in: [packages/ai/src/types.ts:1668](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1668) diff --git a/docs/reference/interfaces/RunFinishedEvent.md b/docs/reference/interfaces/RunFinishedEvent.md index 5009ef21b5..205c4e8fd5 100644 --- a/docs/reference/interfaces/RunFinishedEvent.md +++ b/docs/reference/interfaces/RunFinishedEvent.md @@ -3,7 +3,7 @@ id: RunFinishedEvent title: RunFinishedEvent --- -Defined in: packages/ai/src/types.ts:1601 +Defined in: [packages/ai/src/types.ts:1641](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1641) Emitted when a run completes successfully. @@ -23,7 +23,7 @@ Spec `usage[]` is provider/model token counts. TanStack leftovers live in optional finishReason?: "length" | "stop" | "content_filter" | "tool_calls" | null; ``` -Defined in: packages/ai/src/types.ts:1612 +Defined in: [packages/ai/src/types.ts:1652](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1652) Restored on the client from `metadata.tanstack`. @@ -35,7 +35,7 @@ Restored on the client from `metadata.tanstack`. optional metadata?: object & Record; ``` -Defined in: packages/ai/src/types.ts:1613 +Defined in: [packages/ai/src/types.ts:1653](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1653) #### Type Declaration @@ -53,7 +53,7 @@ optional tanstack?: TanStackRunMetadata; optional model?: string; ``` -Defined in: packages/ai/src/types.ts:1608 +Defined in: [packages/ai/src/types.ts:1648](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1648) Restored on the client from `metadata.tanstack`. @@ -65,7 +65,7 @@ Restored on the client from `metadata.tanstack`. optional responseId?: string; ``` -Defined in: packages/ai/src/types.ts:1610 +Defined in: [packages/ai/src/types.ts:1650](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1650) Provider generation ID. Restored from `metadata.tanstack`. @@ -77,7 +77,7 @@ Provider generation ID. Restored from `metadata.tanstack`. type: RUN_FINISHED; ``` -Defined in: packages/ai/src/types.ts:1605 +Defined in: [packages/ai/src/types.ts:1645](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1645) *** @@ -87,4 +87,4 @@ Defined in: packages/ai/src/types.ts:1605 optional usage?: TokenUsage | TokenUsage[]; ``` -Defined in: packages/ai/src/types.ts:1606 +Defined in: [packages/ai/src/types.ts:1646](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1646) diff --git a/docs/reference/interfaces/RunRecord.md b/docs/reference/interfaces/RunRecord.md index ac5e029625..410bb8f190 100644 --- a/docs/reference/interfaces/RunRecord.md +++ b/docs/reference/interfaces/RunRecord.md @@ -3,7 +3,7 @@ id: RunRecord title: RunRecord --- -Defined in: packages/ai/src/activities/chat/middleware/run-store.ts:106 +Defined in: [packages/ai/src/activities/chat/middleware/run-store.ts:106](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/run-store.ts#L106) Durable bookkeeping for a single run. @@ -15,7 +15,7 @@ Durable bookkeeping for a single run. optional activity?: string; ``` -Defined in: packages/ai/src/activities/chat/middleware/run-store.ts:186 +Defined in: [packages/ai/src/activities/chat/middleware/run-store.ts:186](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/run-store.ts#L186) The activity of a `kind: 'activity'` run (`'image'`, `'chat'`, ...). @@ -27,7 +27,7 @@ The activity of a `kind: 'activity'` run (`'image'`, `'chat'`, ...). optional agent?: string; ``` -Defined in: packages/ai/src/activities/chat/middleware/run-store.ts:188 +Defined in: [packages/ai/src/activities/chat/middleware/run-store.ts:188](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/run-store.ts#L188) The agent name of a `kind: 'agent'` run. @@ -39,7 +39,7 @@ The agent name of a `kind: 'agent'` run. optional artifacts?: RunArtifactRef[]; ``` -Defined in: packages/ai/src/activities/chat/middleware/run-store.ts:192 +Defined in: [packages/ai/src/activities/chat/middleware/run-store.ts:192](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/run-store.ts#L192) Durable artifact references produced by this run. @@ -51,7 +51,7 @@ Durable artifact references produced by this run. optional cancelRequested?: boolean; ``` -Defined in: packages/ai/src/activities/chat/middleware/run-store.ts:168 +Defined in: [packages/ai/src/activities/chat/middleware/run-store.ts:168](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/run-store.ts#L168) Set by an explicit out-of-band cancel, to be distinguished from a mere client disconnect (the two produce an identical TCP close, so intent is not @@ -69,7 +69,7 @@ the run having stopped, and only the driver knows when it has. optional checkpoint?: RunCheckpoint; ``` -Defined in: packages/ai/src/activities/chat/middleware/run-store.ts:203 +Defined in: [packages/ai/src/activities/chat/middleware/run-store.ts:203](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/run-store.ts#L203) Crash-resume data saved at the last model or tool boundary. @@ -81,7 +81,7 @@ Crash-resume data saved at the last model or tool boundary. optional detachedSince?: number; ``` -Defined in: packages/ai/src/activities/chat/middleware/run-store.ts:158 +Defined in: [packages/ai/src/activities/chat/middleware/run-store.ts:158](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/run-store.ts#L158) Epoch ms when the last viewer detached; absent while someone is attached. Written by `withSandbox`'s detach path (`onAbort` in `@tanstack/ai-sandbox`'s @@ -99,7 +99,7 @@ surfaces (see that method's doc comment). optional driverEpoch?: number; ``` -Defined in: packages/ai/src/activities/chat/middleware/run-store.ts:178 +Defined in: [packages/ai/src/activities/chat/middleware/run-store.ts:178](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/run-store.ts#L178) Monotonic fencing token for the run's driver. Bumped by each host that successfully claims the run (see `withRunClaim` in `@tanstack/ai-sandbox`), @@ -117,7 +117,7 @@ loser nothing to read. Absent on a run that was never claimed. optional error?: RunError; ``` -Defined in: packages/ai/src/activities/chat/middleware/run-store.ts:137 +Defined in: [packages/ai/src/activities/chat/middleware/run-store.ts:137](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/run-store.ts#L137) *** @@ -127,7 +127,7 @@ Defined in: packages/ai/src/activities/chat/middleware/run-store.ts:137 optional finishedAt?: number; ``` -Defined in: packages/ai/src/activities/chat/middleware/run-store.ts:136 +Defined in: [packages/ai/src/activities/chat/middleware/run-store.ts:136](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/run-store.ts#L136) *** @@ -137,7 +137,7 @@ Defined in: packages/ai/src/activities/chat/middleware/run-store.ts:136 optional kind?: RunKind; ``` -Defined in: packages/ai/src/activities/chat/middleware/run-store.ts:184 +Defined in: [packages/ai/src/activities/chat/middleware/run-store.ts:184](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/run-store.ts#L184) What kind of work this run is, when a host session recorded it: a chat turn, an agent run, one activity call inside an agent, a user @@ -151,7 +151,7 @@ command, or a compaction. Absent on runs recorded by plain `chat()`. optional leaseExpiresAt?: number; ``` -Defined in: packages/ai/src/activities/chat/middleware/run-store.ts:201 +Defined in: [packages/ai/src/activities/chat/middleware/run-store.ts:201](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/run-store.ts#L201) *** @@ -161,7 +161,7 @@ Defined in: packages/ai/src/activities/chat/middleware/run-store.ts:201 optional leaseOwner?: string; ``` -Defined in: packages/ai/src/activities/chat/middleware/run-store.ts:200 +Defined in: [packages/ai/src/activities/chat/middleware/run-store.ts:200](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/run-store.ts#L200) The host that currently drives this run, and when its claim expires. The driver renews `leaseExpiresAt`. Another host may resume the run after it @@ -175,7 +175,7 @@ passes. Pairs with `driverEpoch` for fencing. optional name?: string; ``` -Defined in: packages/ai/src/activities/chat/middleware/run-store.ts:133 +Defined in: [packages/ai/src/activities/chat/middleware/run-store.ts:133](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/run-store.ts#L133) Agent name (`researcher`, `writer`) when this record is a subagent. @@ -187,7 +187,7 @@ Agent name (`researcher`, `writer`) when this record is a subagent. optional parentRunId?: string; ``` -Defined in: packages/ai/src/activities/chat/middleware/run-store.ts:125 +Defined in: [packages/ai/src/activities/chat/middleware/run-store.ts:125](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/run-store.ts#L125) Parent chat run that started this child, when this record is a subagent. Absent on the parent run itself. @@ -200,7 +200,7 @@ Absent on the parent run itself. optional principal?: object; ``` -Defined in: packages/ai/src/activities/chat/middleware/run-store.ts:194 +Defined in: [packages/ai/src/activities/chat/middleware/run-store.ts:194](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/run-store.ts#L194) Who started this run, from the host's `authorize`. @@ -218,7 +218,7 @@ id: string; optional result?: unknown; ``` -Defined in: packages/ai/src/activities/chat/middleware/run-store.ts:190 +Defined in: [packages/ai/src/activities/chat/middleware/run-store.ts:190](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/run-store.ts#L190) Terminal result metadata (ids, urls, text). Never media bytes. @@ -230,7 +230,7 @@ Terminal result metadata (ids, urls, text). Never media bytes. runId: string; ``` -Defined in: packages/ai/src/activities/chat/middleware/run-store.ts:107 +Defined in: [packages/ai/src/activities/chat/middleware/run-store.ts:107](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/run-store.ts#L107) *** @@ -240,7 +240,7 @@ Defined in: packages/ai/src/activities/chat/middleware/run-store.ts:107 optional sandboxKey?: string; ``` -Defined in: packages/ai/src/activities/chat/middleware/run-store.ts:148 +Defined in: [packages/ai/src/activities/chat/middleware/run-store.ts:148](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/run-store.ts#L148) Compound sandbox key this run was bound to, when it ran in a sandbox. Recorded so a future reclaimer can identify the sandbox to tear down @@ -258,7 +258,7 @@ destroying the sandbox. A backend must round-trip this field — see startedAt: number; ``` -Defined in: packages/ai/src/activities/chat/middleware/run-store.ts:135 +Defined in: [packages/ai/src/activities/chat/middleware/run-store.ts:135](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/run-store.ts#L135) *** @@ -268,7 +268,7 @@ Defined in: packages/ai/src/activities/chat/middleware/run-store.ts:135 status: RunStatus; ``` -Defined in: packages/ai/src/activities/chat/middleware/run-store.ts:134 +Defined in: [packages/ai/src/activities/chat/middleware/run-store.ts:134](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/run-store.ts#L134) *** @@ -278,7 +278,7 @@ Defined in: packages/ai/src/activities/chat/middleware/run-store.ts:134 optional subagentRunId?: string; ``` -Defined in: packages/ai/src/activities/chat/middleware/run-store.ts:131 +Defined in: [packages/ai/src/activities/chat/middleware/run-store.ts:131](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/run-store.ts#L131) The child's AG-UI subagentRunId, the id on its `SUBAGENT_*` chunks and on every chunk it streams. On a child record this equals `runId`. Absent on @@ -292,7 +292,7 @@ the parent run. threadId: string; ``` -Defined in: packages/ai/src/activities/chat/middleware/run-store.ts:120 +Defined in: [packages/ai/src/activities/chat/middleware/run-store.ts:120](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/run-store.ts#L120) Conversation this run belongs to — the `Scope.threadId`. @@ -313,4 +313,4 @@ conversation never return children. Use `listByParentRun`. optional usage?: TokenUsage; ``` -Defined in: packages/ai/src/activities/chat/middleware/run-store.ts:138 +Defined in: [packages/ai/src/activities/chat/middleware/run-store.ts:138](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/run-store.ts#L138) diff --git a/docs/reference/interfaces/RunStartedEvent.md b/docs/reference/interfaces/RunStartedEvent.md index db157fd86f..fe05438b94 100644 --- a/docs/reference/interfaces/RunStartedEvent.md +++ b/docs/reference/interfaces/RunStartedEvent.md @@ -3,7 +3,7 @@ id: RunStartedEvent title: RunStartedEvent --- -Defined in: packages/ai/src/types.ts:1571 +Defined in: [packages/ai/src/types.ts:1611](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1611) Emitted when a run starts. This is the first event in any streaming response. diff --git a/docs/reference/interfaces/RunStore.md b/docs/reference/interfaces/RunStore.md index 651c9df6ef..33ae8ff2cd 100644 --- a/docs/reference/interfaces/RunStore.md +++ b/docs/reference/interfaces/RunStore.md @@ -3,7 +3,7 @@ id: RunStore title: RunStore --- -Defined in: packages/ai/src/activities/chat/middleware/run-store.ts:245 +Defined in: [packages/ai/src/activities/chat/middleware/run-store.ts:245](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/run-store.ts#L245) Durable store for run lifecycle records. @@ -28,7 +28,7 @@ them. createOrResume: (input) => Promise; ``` -Defined in: packages/ai/src/activities/chat/middleware/run-store.ts:256 +Defined in: [packages/ai/src/activities/chat/middleware/run-store.ts:256](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/run-store.ts#L256) Create a run record, or return the existing one unchanged if `runId` is already present. @@ -57,7 +57,7 @@ link fields are copied only on the first insert. findActiveRun: (threadId) => Promise; ``` -Defined in: packages/ai/src/activities/chat/middleware/run-store.ts:340 +Defined in: [packages/ai/src/activities/chat/middleware/run-store.ts:340](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/run-store.ts#L340) The most recent `'running'` run for `threadId`, or `null` if none is active. @@ -90,7 +90,7 @@ tiers belong at the store level, not the method level. get: (runId) => Promise; ``` -Defined in: packages/ai/src/activities/chat/middleware/run-store.ts:292 +Defined in: [packages/ai/src/activities/chat/middleware/run-store.ts:292](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/run-store.ts#L292) Current record, or null when unknown. @@ -112,7 +112,7 @@ Current record, or null when unknown. optional listByParentRun?: (parentRunId) => Promise; ``` -Defined in: packages/ai/src/activities/chat/middleware/run-store.ts:306 +Defined in: [packages/ai/src/activities/chat/middleware/run-store.ts:306](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/run-store.ts#L306) Child runs started by `parentRunId`, ascending by `startedAt`. OPTIONAL. `reconstructChat` uses this to put subagent cards back @@ -137,7 +137,7 @@ text and not the cards. optional listByThread?: (threadId) => Promise; ``` -Defined in: packages/ai/src/activities/chat/middleware/run-store.ts:299 +Defined in: [packages/ai/src/activities/chat/middleware/run-store.ts:299](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/run-store.ts#L299) Every run in a conversation, ascending by `startedAt`. OPTIONAL. `reconstructChat` calls it to find the parent runs of children that a @@ -162,7 +162,7 @@ Consumers feature-detect. optional listReclaimable?: (opts) => Promise; ``` -Defined in: packages/ai/src/activities/chat/middleware/run-store.ts:322 +Defined in: [packages/ai/src/activities/chat/middleware/run-store.ts:322](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/run-store.ts#L322) Runs that may be reclaimed: ALL THREE of `status === 'running'`, `detachedSince` is set, and `detachedSince <= now - ttlMs`. The cutoff is @@ -202,7 +202,7 @@ method cannot be reaped at all. update: (runId, patch) => Promise; ``` -Defined in: packages/ai/src/activities/chat/middleware/run-store.ts:270 +Defined in: [packages/ai/src/activities/chat/middleware/run-store.ts:270](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/run-store.ts#L270) Patch a record's mutable fields. diff --git a/docs/reference/interfaces/SandboxFileCustomEvent.md b/docs/reference/interfaces/SandboxFileCustomEvent.md index bcb7993c59..4635353730 100644 --- a/docs/reference/interfaces/SandboxFileCustomEvent.md +++ b/docs/reference/interfaces/SandboxFileCustomEvent.md @@ -3,7 +3,7 @@ id: SandboxFileCustomEvent title: SandboxFileCustomEvent --- -Defined in: packages/ai/src/types.ts:1811 +Defined in: [packages/ai/src/types.ts:1869](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1869) Custom event for extensibility. @@ -21,7 +21,7 @@ Custom event for extensibility. optional metadata?: Record; ``` -Defined in: packages/ai/src/types.ts:1756 +Defined in: [packages/ai/src/types.ts:1814](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1814) Extra information attached to this event. @@ -37,7 +37,7 @@ Extra information attached to this event. name: "sandbox.file"; ``` -Defined in: packages/ai/src/types.ts:1812 +Defined in: [packages/ai/src/types.ts:1870](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1870) What this custom event is. Required: without it a consumer cannot route the value. @@ -56,7 +56,7 @@ CustomEvent.name type: "CUSTOM"; ``` -Defined in: packages/ai/src/types.ts:1755 +Defined in: [packages/ai/src/types.ts:1813](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1813) #### Inherited from @@ -70,7 +70,7 @@ Defined in: packages/ai/src/types.ts:1755 value: object; ``` -Defined in: packages/ai/src/types.ts:1813 +Defined in: [packages/ai/src/types.ts:1871](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1871) The payload. Any JSON value, and required. diff --git a/docs/reference/interfaces/SandboxFileDiffEvent.md b/docs/reference/interfaces/SandboxFileDiffEvent.md index 57149953b9..7bfd28477f 100644 --- a/docs/reference/interfaces/SandboxFileDiffEvent.md +++ b/docs/reference/interfaces/SandboxFileDiffEvent.md @@ -3,7 +3,7 @@ id: SandboxFileDiffEvent title: SandboxFileDiffEvent --- -Defined in: packages/ai/src/types.ts:1819 +Defined in: [packages/ai/src/types.ts:1877](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1877) Custom event for extensibility. @@ -21,7 +21,7 @@ Custom event for extensibility. optional metadata?: Record; ``` -Defined in: packages/ai/src/types.ts:1756 +Defined in: [packages/ai/src/types.ts:1814](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1814) Extra information attached to this event. @@ -37,7 +37,7 @@ Extra information attached to this event. name: "sandbox.file.diff"; ``` -Defined in: packages/ai/src/types.ts:1820 +Defined in: [packages/ai/src/types.ts:1878](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1878) What this custom event is. Required: without it a consumer cannot route the value. @@ -56,7 +56,7 @@ CustomEvent.name type: "CUSTOM"; ``` -Defined in: packages/ai/src/types.ts:1755 +Defined in: [packages/ai/src/types.ts:1813](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1813) #### Inherited from @@ -70,7 +70,7 @@ Defined in: packages/ai/src/types.ts:1755 value: object; ``` -Defined in: packages/ai/src/types.ts:1821 +Defined in: [packages/ai/src/types.ts:1879](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1879) The payload. Any JSON value, and required. diff --git a/docs/reference/interfaces/SandboxFileEvent.md b/docs/reference/interfaces/SandboxFileEvent.md index 9a32d76b07..8d9de15a0f 100644 --- a/docs/reference/interfaces/SandboxFileEvent.md +++ b/docs/reference/interfaces/SandboxFileEvent.md @@ -3,7 +3,7 @@ id: SandboxFileEvent title: SandboxFileEvent --- -Defined in: packages/ai/src/activities/chat/middleware/types.ts:37 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:38](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L38) A file change observed inside a sandbox during a chat run. @@ -19,7 +19,7 @@ A file change observed inside a sandbox during a chat run. path: string; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:40 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:41](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L41) Absolute path inside the sandbox (under the workspace root). @@ -31,7 +31,7 @@ Absolute path inside the sandbox (under the workspace root). timestamp: number; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:41 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:42](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L42) *** @@ -41,4 +41,4 @@ Defined in: packages/ai/src/activities/chat/middleware/types.ts:41 type: "create" | "change" | "delete"; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:38 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:39](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L39) diff --git a/docs/reference/interfaces/SandboxFileHookEvent.md b/docs/reference/interfaces/SandboxFileHookEvent.md index 2849ce55ca..a45106fc07 100644 --- a/docs/reference/interfaces/SandboxFileHookEvent.md +++ b/docs/reference/interfaces/SandboxFileHookEvent.md @@ -3,7 +3,7 @@ id: SandboxFileHookEvent title: SandboxFileHookEvent --- -Defined in: packages/ai/src/activities/chat/middleware/types.ts:48 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:49](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L49) The file event a sandbox hook receives: the serializable [SandboxFileEvent](SandboxFileEvent.md) plus lazy, git-backed content accessors. Accessors compute on call, so a hook @@ -22,7 +22,7 @@ The file event a sandbox hook receives: the serializable [SandboxFileEvent](Sand after: () => Promise; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:52 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:53](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L53) Current content (`''` when the event is a delete). @@ -38,7 +38,7 @@ Current content (`''` when the event is a delete). before: () => Promise; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:50 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:51](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L51) Content at the session baseline (`''` for a new file or non-git workspace). @@ -54,7 +54,7 @@ Content at the session baseline (`''` for a new file or non-git workspace). diff: () => Promise; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:54 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:55](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L55) Unified patch vs the session baseline (synthesized add-patch when non-git). @@ -70,7 +70,7 @@ Unified patch vs the session baseline (synthesized add-patch when non-git). path: string; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:40 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:41](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L41) Absolute path inside the sandbox (under the workspace root). @@ -86,7 +86,7 @@ Absolute path inside the sandbox (under the workspace root). timestamp: number; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:41 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:42](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L42) #### Inherited from @@ -100,7 +100,7 @@ Defined in: packages/ai/src/activities/chat/middleware/types.ts:41 type: "create" | "change" | "delete"; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:38 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:39](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L39) #### Inherited from diff --git a/docs/reference/interfaces/SandboxLifecyclePayload.md b/docs/reference/interfaces/SandboxLifecyclePayload.md index f7c45a0d2f..9a7deb5ec4 100644 --- a/docs/reference/interfaces/SandboxLifecyclePayload.md +++ b/docs/reference/interfaces/SandboxLifecyclePayload.md @@ -3,7 +3,7 @@ id: SandboxLifecyclePayload title: SandboxLifecyclePayload --- -Defined in: packages/ai/src/custom-events.ts:76 +Defined in: [packages/ai/src/custom-events.ts:76](https://github.com/TanStack/ai/blob/main/packages/ai/src/custom-events.ts#L76) ## Properties @@ -13,7 +13,7 @@ Defined in: packages/ai/src/custom-events.ts:76 provider: string; ``` -Defined in: packages/ai/src/custom-events.ts:78 +Defined in: [packages/ai/src/custom-events.ts:78](https://github.com/TanStack/ai/blob/main/packages/ai/src/custom-events.ts#L78) *** @@ -23,4 +23,4 @@ Defined in: packages/ai/src/custom-events.ts:78 sandboxId: string; ``` -Defined in: packages/ai/src/custom-events.ts:77 +Defined in: [packages/ai/src/custom-events.ts:77](https://github.com/TanStack/ai/blob/main/packages/ai/src/custom-events.ts#L77) diff --git a/docs/reference/interfaces/Scope.md b/docs/reference/interfaces/Scope.md index 35c691d9f0..d7da626e7e 100644 --- a/docs/reference/interfaces/Scope.md +++ b/docs/reference/interfaces/Scope.md @@ -3,7 +3,7 @@ id: Scope title: Scope --- -Defined in: packages/ai/src/scope.ts:22 +Defined in: [packages/ai/src/scope.ts:22](https://github.com/TanStack/ai/blob/main/packages/ai/src/scope.ts#L22) Shared identity/isolation scope for the TanStack AI subsystems that persist or recall per-conversation data — `@tanstack/ai-persistence` (keyed CRUD over @@ -33,7 +33,7 @@ their own they let one caller read another's data. optional namespace?: string; ``` -Defined in: packages/ai/src/scope.ts:45 +Defined in: [packages/ai/src/scope.ts:45](https://github.com/TanStack/ai/blob/main/packages/ai/src/scope.ts#L45) Logical partition within a tenant/user (e.g. separating distinct memory banks or persistence namespaces). Reserved — no subsystem keys on it yet; @@ -47,7 +47,7 @@ adapters that don't understand it must ignore it rather than error. optional tenantId?: string; ``` -Defined in: packages/ai/src/scope.ts:39 +Defined in: [packages/ai/src/scope.ts:39](https://github.com/TanStack/ai/blob/main/packages/ai/src/scope.ts#L39) Tenant/organization boundary for multi-tenant deployments. When present, every read and write must be confined to it. @@ -60,7 +60,7 @@ every read and write must be confined to it. threadId: string; ``` -Defined in: packages/ai/src/scope.ts:28 +Defined in: [packages/ai/src/scope.ts:28](https://github.com/TanStack/ai/blob/main/packages/ai/src/scope.ts#L28) The conversation this data belongs to. Required — the minimal isolation key both subsystems already center on. Same concept as @@ -74,7 +74,7 @@ key both subsystems already center on. Same concept as optional userId?: string; ``` -Defined in: packages/ai/src/scope.ts:34 +Defined in: [packages/ai/src/scope.ts:34](https://github.com/TanStack/ai/blob/main/packages/ai/src/scope.ts#L34) Durable end-user identity, for cross-thread recall and per-user isolation. Optional, but required in practice for any multi-user deployment — a diff --git a/docs/reference/interfaces/ScoreAnswer.md b/docs/reference/interfaces/ScoreAnswer.md index 858de7a6ae..15016604bf 100644 --- a/docs/reference/interfaces/ScoreAnswer.md +++ b/docs/reference/interfaces/ScoreAnswer.md @@ -3,7 +3,7 @@ id: ScoreAnswer title: ScoreAnswer --- -Defined in: packages/ai/src/activities/evaluate/index.ts:77 +Defined in: [packages/ai/src/activities/evaluate/index.ts:78](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/evaluate/index.ts#L78) Public score answer. `.value` is the nearest level label. `.score` is the raw TypeSafe fraction. @@ -22,7 +22,7 @@ Public score answer. `.value` is the nearest level label. confidence: number; ``` -Defined in: packages/ai/src/activities/evaluate/index.ts:82 +Defined in: [packages/ai/src/activities/evaluate/index.ts:83](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/evaluate/index.ts#L83) *** @@ -32,7 +32,7 @@ Defined in: packages/ai/src/activities/evaluate/index.ts:82 legend: Record; ``` -Defined in: packages/ai/src/activities/evaluate/index.ts:84 +Defined in: [packages/ai/src/activities/evaluate/index.ts:85](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/evaluate/index.ts#L85) *** @@ -42,7 +42,7 @@ Defined in: packages/ai/src/activities/evaluate/index.ts:84 probabilities: Record; ``` -Defined in: packages/ai/src/activities/evaluate/index.ts:85 +Defined in: [packages/ai/src/activities/evaluate/index.ts:86](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/evaluate/index.ts#L86) *** @@ -52,7 +52,7 @@ Defined in: packages/ai/src/activities/evaluate/index.ts:85 probability: number; ``` -Defined in: packages/ai/src/activities/evaluate/index.ts:81 +Defined in: [packages/ai/src/activities/evaluate/index.ts:82](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/evaluate/index.ts#L82) P(nearest level). @@ -64,7 +64,7 @@ P(nearest level). score: number; ``` -Defined in: packages/ai/src/activities/evaluate/index.ts:83 +Defined in: [packages/ai/src/activities/evaluate/index.ts:84](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/evaluate/index.ts#L84) *** @@ -74,7 +74,7 @@ Defined in: packages/ai/src/activities/evaluate/index.ts:83 type: "score"; ``` -Defined in: packages/ai/src/activities/evaluate/index.ts:78 +Defined in: [packages/ai/src/activities/evaluate/index.ts:79](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/evaluate/index.ts#L79) *** @@ -84,4 +84,4 @@ Defined in: packages/ai/src/activities/evaluate/index.ts:78 value: TLevel; ``` -Defined in: packages/ai/src/activities/evaluate/index.ts:79 +Defined in: [packages/ai/src/activities/evaluate/index.ts:80](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/evaluate/index.ts#L80) diff --git a/docs/reference/interfaces/ServerTool.md b/docs/reference/interfaces/ServerTool.md index 5ee38b709f..67f32d5fac 100644 --- a/docs/reference/interfaces/ServerTool.md +++ b/docs/reference/interfaces/ServerTool.md @@ -3,7 +3,7 @@ id: ServerTool title: ServerTool --- -Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:86 +Defined in: [packages/ai/src/activities/chat/tools/tool-definition.ts:86](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-definition.ts#L86) Marker type for server-side tools @@ -47,7 +47,7 @@ Marker type for server-side tools __toolSide: "server"; ``` -Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:97 +Defined in: [packages/ai/src/activities/chat/tools/tool-definition.ts:97](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-definition.ts#L97) *** @@ -57,7 +57,7 @@ Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:97 readonly optional [toolApprovalCapability]?: object; ``` -Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:26 +Defined in: [packages/ai/src/activities/chat/tools/tool-definition.ts:26](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-definition.ts#L26) #### approvalSchema @@ -85,7 +85,7 @@ ToolApprovalCapabilityMarker.[toolApprovalCapability] optional approvalSchema?: TApprovalSchema; ``` -Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:101 +Defined in: [packages/ai/src/activities/chat/tools/tool-definition.ts:101](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-definition.ts#L101) *** @@ -95,7 +95,7 @@ Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:101 description: string; ``` -Defined in: packages/ai/src/types.ts:989 +Defined in: [packages/ai/src/types.ts:1029](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1029) Clear description of what the tool does. @@ -120,7 +120,7 @@ Be specific about what the tool does, what parameters it needs, and what it retu optional execute?: ToolExecuteFunction; ``` -Defined in: packages/ai/src/types.ts:1069 +Defined in: [packages/ai/src/types.ts:1109](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1109) Optional function to execute when the model calls this tool. @@ -160,7 +160,7 @@ execute: async (args) => { optional execution?: "task"; ``` -Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:102 +Defined in: [packages/ai/src/activities/chat/tools/tool-definition.ts:102](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-definition.ts#L102) *** @@ -170,7 +170,7 @@ Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:102 optional inputSchema?: TInput; ``` -Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:98 +Defined in: [packages/ai/src/activities/chat/tools/tool-definition.ts:98](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-definition.ts#L98) Schema describing the tool's input parameters. @@ -228,7 +228,7 @@ type({ optional lazy?: boolean; ``` -Defined in: packages/ai/src/types.ts:1075 +Defined in: [packages/ai/src/types.ts:1115](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1115) If true, this tool is lazy and will only be sent to the LLM after being discovered via the lazy tool discovery mechanism. Works with both chat() (the synthetic discovery tool) and Code Mode (kept out of the system prompt and revealed via discover_tools). @@ -244,7 +244,7 @@ If true, this tool is lazy and will only be sent to the LLM after being discover optional metadata?: Record; ``` -Defined in: packages/ai/src/types.ts:1086 +Defined in: [packages/ai/src/types.ts:1126](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1126) Additional metadata for adapters or custom extensions @@ -260,7 +260,7 @@ Additional metadata for adapters or custom extensions name: TName; ``` -Defined in: packages/ai/src/types.ts:979 +Defined in: [packages/ai/src/types.ts:1019](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1019) Unique name of the tool (used by the model to call it). @@ -285,7 +285,7 @@ Must be unique within the tools array. optional needsApproval?: TNeedsApproval; ``` -Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:100 +Defined in: [packages/ai/src/activities/chat/tools/tool-definition.ts:100](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-definition.ts#L100) If true, tool execution requires user approval before running. Works with both server and client tools. @@ -301,7 +301,7 @@ If true, tool execution requires user approval before running. Works with both s optional outputSchema?: TOutput; ``` -Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:99 +Defined in: [packages/ai/src/activities/chat/tools/tool-definition.ts:99](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-definition.ts#L99) Optional schema for validating tool output. @@ -336,7 +336,7 @@ z.object({ optional replay?: "safe" | "never"; ``` -Defined in: packages/ai/src/types.ts:1083 +Defined in: [packages/ai/src/types.ts:1123](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1123) Whether a host may run this tool again after a crash cut the run between the call and its result. `'safe'` runs it again. Omit the diff --git a/docs/reference/interfaces/SessionIdEvent.md b/docs/reference/interfaces/SessionIdEvent.md index c873250b11..0ae896612f 100644 --- a/docs/reference/interfaces/SessionIdEvent.md +++ b/docs/reference/interfaces/SessionIdEvent.md @@ -3,7 +3,7 @@ id: SessionIdEvent title: SessionIdEvent --- -Defined in: packages/ai/src/types.ts:1829 +Defined in: [packages/ai/src/types.ts:1887](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1887) Custom event for extensibility. @@ -21,7 +21,7 @@ Custom event for extensibility. optional metadata?: Record; ``` -Defined in: packages/ai/src/types.ts:1756 +Defined in: [packages/ai/src/types.ts:1814](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1814) Extra information attached to this event. @@ -37,7 +37,7 @@ Extra information attached to this event. name: `${string}.session-id`; ``` -Defined in: packages/ai/src/types.ts:1830 +Defined in: [packages/ai/src/types.ts:1888](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1888) What this custom event is. Required: without it a consumer cannot route the value. @@ -56,7 +56,7 @@ CustomEvent.name type: "CUSTOM"; ``` -Defined in: packages/ai/src/types.ts:1755 +Defined in: [packages/ai/src/types.ts:1813](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1813) #### Inherited from @@ -70,7 +70,7 @@ Defined in: packages/ai/src/types.ts:1755 value: object; ``` -Defined in: packages/ai/src/types.ts:1831 +Defined in: [packages/ai/src/types.ts:1889](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1889) The payload. Any JSON value, and required. diff --git a/docs/reference/interfaces/SkillLimitErrorInit.md b/docs/reference/interfaces/SkillLimitErrorInit.md index dafbcb949d..2144ca6b8d 100644 --- a/docs/reference/interfaces/SkillLimitErrorInit.md +++ b/docs/reference/interfaces/SkillLimitErrorInit.md @@ -3,7 +3,7 @@ id: SkillLimitErrorInit title: SkillLimitErrorInit --- -Defined in: packages/ai/src/utilities/errors.ts:13 +Defined in: [packages/ai/src/utilities/errors.ts:13](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/errors.ts#L13) Thrown when a skills request exceeds a provider limit. Lives in core (rather than `@tanstack/ai-skills`) so the native tool factories in `ai-anthropic` @@ -22,7 +22,7 @@ cap that only applies to hosted skills. actual: number; ``` -Defined in: packages/ai/src/utilities/errors.ts:18 +Defined in: [packages/ai/src/utilities/errors.ts:18](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/errors.ts#L18) *** @@ -32,7 +32,7 @@ Defined in: packages/ai/src/utilities/errors.ts:18 allowed: number; ``` -Defined in: packages/ai/src/utilities/errors.ts:17 +Defined in: [packages/ai/src/utilities/errors.ts:17](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/errors.ts#L17) *** @@ -42,7 +42,7 @@ Defined in: packages/ai/src/utilities/errors.ts:17 limit: string; ``` -Defined in: packages/ai/src/utilities/errors.ts:16 +Defined in: [packages/ai/src/utilities/errors.ts:16](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/errors.ts#L16) *** @@ -52,7 +52,7 @@ Defined in: packages/ai/src/utilities/errors.ts:16 offending: string[]; ``` -Defined in: packages/ai/src/utilities/errors.ts:19 +Defined in: [packages/ai/src/utilities/errors.ts:19](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/errors.ts#L19) *** @@ -62,7 +62,7 @@ Defined in: packages/ai/src/utilities/errors.ts:19 path: "native" | "portable"; ``` -Defined in: packages/ai/src/utilities/errors.ts:15 +Defined in: [packages/ai/src/utilities/errors.ts:15](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/errors.ts#L15) *** @@ -72,4 +72,4 @@ Defined in: packages/ai/src/utilities/errors.ts:15 provider: "anthropic" | "openai" | "gemini" | "other"; ``` -Defined in: packages/ai/src/utilities/errors.ts:14 +Defined in: [packages/ai/src/utilities/errors.ts:14](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/errors.ts#L14) diff --git a/docs/reference/interfaces/SnippetRegisteredEvent.md b/docs/reference/interfaces/SnippetRegisteredEvent.md index b4b67e48d3..0f1b162f58 100644 --- a/docs/reference/interfaces/SnippetRegisteredEvent.md +++ b/docs/reference/interfaces/SnippetRegisteredEvent.md @@ -3,7 +3,7 @@ id: SnippetRegisteredEvent title: SnippetRegisteredEvent --- -Defined in: packages/ai/src/types.ts:1876 +Defined in: [packages/ai/src/types.ts:1934](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1934) Custom event for extensibility. @@ -21,7 +21,7 @@ Custom event for extensibility. optional metadata?: Record; ``` -Defined in: packages/ai/src/types.ts:1756 +Defined in: [packages/ai/src/types.ts:1814](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1814) Extra information attached to this event. @@ -37,7 +37,7 @@ Extra information attached to this event. name: "snippet:registered"; ``` -Defined in: packages/ai/src/types.ts:1877 +Defined in: [packages/ai/src/types.ts:1935](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1935) What this custom event is. Required: without it a consumer cannot route the value. @@ -56,7 +56,7 @@ CustomEvent.name type: "CUSTOM"; ``` -Defined in: packages/ai/src/types.ts:1755 +Defined in: [packages/ai/src/types.ts:1813](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1813) #### Inherited from @@ -70,7 +70,7 @@ Defined in: packages/ai/src/types.ts:1755 value: object; ``` -Defined in: packages/ai/src/types.ts:1878 +Defined in: [packages/ai/src/types.ts:1936](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1936) The payload. Any JSON value, and required. diff --git a/docs/reference/interfaces/StateDeltaEvent.md b/docs/reference/interfaces/StateDeltaEvent.md index def7b77a98..cd7e5c6d4b 100644 --- a/docs/reference/interfaces/StateDeltaEvent.md +++ b/docs/reference/interfaces/StateDeltaEvent.md @@ -3,7 +3,7 @@ id: StateDeltaEvent title: StateDeltaEvent --- -Defined in: packages/ai/src/types.ts:1747 +Defined in: [packages/ai/src/types.ts:1805](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1805) Emitted to provide an incremental state update. diff --git a/docs/reference/interfaces/StateSnapshotEvent.md b/docs/reference/interfaces/StateSnapshotEvent.md index cd7a776d55..6dd24c50e8 100644 --- a/docs/reference/interfaces/StateSnapshotEvent.md +++ b/docs/reference/interfaces/StateSnapshotEvent.md @@ -3,7 +3,7 @@ id: StateSnapshotEvent title: StateSnapshotEvent --- -Defined in: packages/ai/src/types.ts:1740 +Defined in: [packages/ai/src/types.ts:1798](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1798) Emitted to provide a full state snapshot. diff --git a/docs/reference/interfaces/StepFinishedEvent.md b/docs/reference/interfaces/StepFinishedEvent.md index 581fee3a50..5e9da065d0 100644 --- a/docs/reference/interfaces/StepFinishedEvent.md +++ b/docs/reference/interfaces/StepFinishedEvent.md @@ -3,7 +3,7 @@ id: StepFinishedEvent title: StepFinishedEvent --- -Defined in: packages/ai/src/types.ts:1720 +Defined in: [packages/ai/src/types.ts:1778](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1778) Emitted when a thinking/reasoning step finishes. diff --git a/docs/reference/interfaces/StepStartedEvent.md b/docs/reference/interfaces/StepStartedEvent.md index 9c5171940a..afc5dc4563 100644 --- a/docs/reference/interfaces/StepStartedEvent.md +++ b/docs/reference/interfaces/StepStartedEvent.md @@ -3,7 +3,7 @@ id: StepStartedEvent title: StepStartedEvent --- -Defined in: packages/ai/src/types.ts:1713 +Defined in: [packages/ai/src/types.ts:1771](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1771) Emitted when a thinking/reasoning step starts. diff --git a/docs/reference/interfaces/StreamDurability.md b/docs/reference/interfaces/StreamDurability.md index ee854d0aaa..5193153e1b 100644 --- a/docs/reference/interfaces/StreamDurability.md +++ b/docs/reference/interfaces/StreamDurability.md @@ -3,7 +3,7 @@ id: StreamDurability title: StreamDurability --- -Defined in: packages/ai/src/stream-durability.ts:10 +Defined in: [packages/ai/src/stream-durability.ts:10](https://github.com/TanStack/ai/blob/main/packages/ai/src/stream-durability.ts#L10) A pluggable delivery-durability backend. @@ -29,7 +29,7 @@ and resume without requiring core to understand its cursor format. append: (chunks) => Promise; ``` -Defined in: packages/ai/src/stream-durability.ts:17 +Defined in: [packages/ai/src/stream-durability.ts:17](https://github.com/TanStack/ai/blob/main/packages/ai/src/stream-durability.ts#L17) Persist a batch before it is delivered and return exactly one resumable offset for each chunk, in the same order. @@ -52,7 +52,7 @@ offset for each chunk, in the same order. close: () => Promise; ``` -Defined in: packages/ai/src/stream-durability.ts:27 +Defined in: [packages/ai/src/stream-durability.ts:27](https://github.com/TanStack/ai/blob/main/packages/ai/src/stream-durability.ts#L27) Terminalize the producer log and unblock live readers. Core awaits this for every producer exit, including completion, cancellation, and failure. @@ -72,7 +72,7 @@ read: (offset, signal?) => AsyncIterable<{ }>; ``` -Defined in: packages/ai/src/stream-durability.ts:19 +Defined in: [packages/ai/src/stream-durability.ts:19](https://github.com/TanStack/ai/blob/main/packages/ai/src/stream-durability.ts#L19) Replay chunks strictly after the supplied adapter-owned offset. @@ -101,7 +101,7 @@ Replay chunks strictly after the supplied adapter-owned offset. resumeFrom: () => TOffset | null; ``` -Defined in: packages/ai/src/stream-durability.ts:12 +Defined in: [packages/ai/src/stream-durability.ts:12](https://github.com/TanStack/ai/blob/main/packages/ai/src/stream-durability.ts#L12) Return the adapter offset captured from the request, or null for a producer. @@ -117,7 +117,7 @@ Return the adapter offset captured from the request, or null for a producer. snapshot: () => Promise; ``` -Defined in: packages/ai/src/stream-durability.ts:57 +Defined in: [packages/ai/src/stream-durability.ts:57](https://github.com/TanStack/ai/blob/main/packages/ai/src/stream-durability.ts#L57) Everything stored for this run **at the moment of the call**, in append order, then resolve. diff --git a/docs/reference/interfaces/StreamProcessorEvents.md b/docs/reference/interfaces/StreamProcessorEvents.md index 7ad5bc889d..16257e100a 100644 --- a/docs/reference/interfaces/StreamProcessorEvents.md +++ b/docs/reference/interfaces/StreamProcessorEvents.md @@ -3,7 +3,7 @@ id: StreamProcessorEvents title: StreamProcessorEvents --- -Defined in: packages/ai/src/activities/chat/stream/processor.ts:101 +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:101](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L101) Events emitted by the StreamProcessor @@ -15,7 +15,7 @@ Events emitted by the StreamProcessor optional onApprovalRequest?: (args) => void; ``` -Defined in: packages/ai/src/activities/chat/stream/processor.ts:116 +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:116](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L116) #### Parameters @@ -49,7 +49,7 @@ Defined in: packages/ai/src/activities/chat/stream/processor.ts:116 optional onCustomEvent?: (eventType, data, context) => void; ``` -Defined in: packages/ai/src/activities/chat/stream/processor.ts:124 +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:124](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L124) #### Parameters @@ -79,7 +79,7 @@ Defined in: packages/ai/src/activities/chat/stream/processor.ts:124 optional onError?: (error) => void; ``` -Defined in: packages/ai/src/activities/chat/stream/processor.ts:108 +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:108](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L108) #### Parameters @@ -99,7 +99,7 @@ Defined in: packages/ai/src/activities/chat/stream/processor.ts:108 optional onMessagesChange?: (messages) => void; ``` -Defined in: packages/ai/src/activities/chat/stream/processor.ts:103 +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:103](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L103) #### Parameters @@ -119,7 +119,7 @@ Defined in: packages/ai/src/activities/chat/stream/processor.ts:103 optional onStreamEnd?: (message) => void; ``` -Defined in: packages/ai/src/activities/chat/stream/processor.ts:107 +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:107](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L107) #### Parameters @@ -139,7 +139,7 @@ Defined in: packages/ai/src/activities/chat/stream/processor.ts:107 optional onStreamStart?: () => void; ``` -Defined in: packages/ai/src/activities/chat/stream/processor.ts:106 +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:106](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L106) #### Returns @@ -153,7 +153,7 @@ Defined in: packages/ai/src/activities/chat/stream/processor.ts:106 optional onStructuredOutputChange?: (args) => void; ``` -Defined in: packages/ai/src/activities/chat/stream/processor.ts:143 +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:143](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L143) #### Parameters @@ -207,7 +207,7 @@ Defined in: packages/ai/src/activities/chat/stream/processor.ts:143 optional onTextUpdate?: (messageId, content) => void; ``` -Defined in: packages/ai/src/activities/chat/stream/processor.ts:131 +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:131](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L131) #### Parameters @@ -231,7 +231,7 @@ Defined in: packages/ai/src/activities/chat/stream/processor.ts:131 optional onThinkingUpdate?: (messageId, stepId, content) => void; ``` -Defined in: packages/ai/src/activities/chat/stream/processor.ts:138 +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:138](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L138) #### Parameters @@ -259,7 +259,7 @@ Defined in: packages/ai/src/activities/chat/stream/processor.ts:138 optional onToolCall?: (args) => void; ``` -Defined in: packages/ai/src/activities/chat/stream/processor.ts:111 +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:111](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L111) #### Parameters @@ -289,7 +289,7 @@ Defined in: packages/ai/src/activities/chat/stream/processor.ts:111 optional onToolCallStateChange?: (messageId, toolCallId, state, args) => void; ``` -Defined in: packages/ai/src/activities/chat/stream/processor.ts:132 +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:132](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L132) #### Parameters diff --git a/docs/reference/interfaces/StreamProcessorOptions.md b/docs/reference/interfaces/StreamProcessorOptions.md index da943667e7..812225a65b 100644 --- a/docs/reference/interfaces/StreamProcessorOptions.md +++ b/docs/reference/interfaces/StreamProcessorOptions.md @@ -3,7 +3,7 @@ id: StreamProcessorOptions title: StreamProcessorOptions --- -Defined in: packages/ai/src/activities/chat/stream/processor.ts:159 +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:159](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L159) Options for StreamProcessor @@ -15,7 +15,7 @@ Options for StreamProcessor optional chunkStrategy?: ChunkStrategy; ``` -Defined in: packages/ai/src/activities/chat/stream/processor.ts:160 +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:160](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L160) *** @@ -25,7 +25,7 @@ Defined in: packages/ai/src/activities/chat/stream/processor.ts:160 optional events?: StreamProcessorEvents; ``` -Defined in: packages/ai/src/activities/chat/stream/processor.ts:162 +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:162](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L162) Event-driven handlers @@ -37,7 +37,7 @@ Event-driven handlers optional initialMessages?: UIMessage[]; ``` -Defined in: packages/ai/src/activities/chat/stream/processor.ts:169 +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:169](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L169) Initial messages to populate the processor @@ -49,7 +49,7 @@ Initial messages to populate the processor optional jsonParser?: object; ``` -Defined in: packages/ai/src/activities/chat/stream/processor.ts:163 +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:163](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L163) #### parse @@ -75,7 +75,7 @@ parse: (jsonString) => any; optional recording?: boolean; ``` -Defined in: packages/ai/src/activities/chat/stream/processor.ts:167 +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:167](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L167) Enable recording for replay testing @@ -87,7 +87,7 @@ Enable recording for replay testing optional subagentRunId?: string; ``` -Defined in: packages/ai/src/activities/chat/stream/processor.ts:174 +Defined in: [packages/ai/src/activities/chat/stream/processor.ts:174](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/processor.ts#L174) Set on the processor of a subagent card. Chunks tagged with this id are the card's own; chunks for an id no card holds are dropped. diff --git a/docs/reference/interfaces/StructuredOutputCompleteEvent.md b/docs/reference/interfaces/StructuredOutputCompleteEvent.md index 61d3b8035f..49a2f55a62 100644 --- a/docs/reference/interfaces/StructuredOutputCompleteEvent.md +++ b/docs/reference/interfaces/StructuredOutputCompleteEvent.md @@ -3,7 +3,7 @@ id: StructuredOutputCompleteEvent title: StructuredOutputCompleteEvent --- -Defined in: packages/ai/src/types.ts:1777 +Defined in: [packages/ai/src/types.ts:1835](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1835) Final event of a streaming structured-output run. Carries the validated `object` (typed as `T` after the orchestrator runs Standard Schema parsing), @@ -40,7 +40,7 @@ if (chunk.type === 'CUSTOM' && chunk.name === 'structured-output.complete') { optional metadata?: Record; ``` -Defined in: packages/ai/src/types.ts:1756 +Defined in: [packages/ai/src/types.ts:1814](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1814) Extra information attached to this event. @@ -56,7 +56,7 @@ Extra information attached to this event. name: "structured-output.complete"; ``` -Defined in: packages/ai/src/types.ts:1780 +Defined in: [packages/ai/src/types.ts:1838](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1838) What this custom event is. Required: without it a consumer cannot route the value. @@ -75,7 +75,7 @@ CustomEvent.name type: "CUSTOM"; ``` -Defined in: packages/ai/src/types.ts:1755 +Defined in: [packages/ai/src/types.ts:1813](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1813) #### Inherited from @@ -89,7 +89,7 @@ Defined in: packages/ai/src/types.ts:1755 value: object; ``` -Defined in: packages/ai/src/types.ts:1781 +Defined in: [packages/ai/src/types.ts:1839](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1839) The payload. Any JSON value, and required. diff --git a/docs/reference/interfaces/StructuredOutputMiddlewareConfig.md b/docs/reference/interfaces/StructuredOutputMiddlewareConfig.md index 6efa387c81..77b4a45b26 100644 --- a/docs/reference/interfaces/StructuredOutputMiddlewareConfig.md +++ b/docs/reference/interfaces/StructuredOutputMiddlewareConfig.md @@ -3,7 +3,7 @@ id: StructuredOutputMiddlewareConfig title: StructuredOutputMiddlewareConfig --- -Defined in: packages/ai/src/activities/chat/middleware/types.ts:415 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:429](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L429) Config passed to onStructuredOutputConfig. @@ -27,7 +27,7 @@ vendor-incompatible keywords) by returning a partial that includes optional activities?: ActivityRecord[]; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:347 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:361](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L361) Frontend-only AG-UI activity sidecar. Persistence loads and saves this when an ActivityStore is configured. Never model input. @@ -47,7 +47,7 @@ messages: ModelMessage< | null>[]; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:342 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:356](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L356) Canonical conversation history. Middleware and persistence read this. @@ -63,7 +63,7 @@ Canonical conversation history. Middleware and persistence read this. optional metadata?: Record; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:354 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:368](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L368) #### Inherited from @@ -77,7 +77,7 @@ Defined in: packages/ai/src/activities/chat/middleware/types.ts:354 optional modelOptions?: Record; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:355 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:369](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L369) #### Inherited from @@ -91,7 +91,7 @@ Defined in: packages/ai/src/activities/chat/middleware/types.ts:355 outputSchema: JSONSchema; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:420 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:434](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L434) JSON Schema being sent to the provider for structured output. @@ -103,7 +103,7 @@ JSON Schema being sent to the provider for structured output. optional promptCache?: ResolvedPromptCache; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:368 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:382](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L382) The prompt cache of the next model call. A returned value stays until a middleware changes it. @@ -123,7 +123,7 @@ optional providerMessages?: ModelMessage< | null>[]; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:349 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:363](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L363) Provider-only context. Defaults to `messages` when it is not set. @@ -139,7 +139,7 @@ Provider-only context. Defaults to `messages` when it is not set. optional reasoning?: ReasoningRequest; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:357 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:371](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L371) How hard the model thinks at this call. A middleware can set or change it. @@ -155,7 +155,7 @@ How hard the model thinks at this call. A middleware can set or change it. optional resume?: RunAgentResumeItem[]; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:352 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:366](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L366) #### Inherited from @@ -169,7 +169,7 @@ Defined in: packages/ai/src/activities/chat/middleware/types.ts:352 optional resumeToolState?: ChatResumeToolState; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:353 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:367](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L367) #### Inherited from @@ -183,7 +183,7 @@ Defined in: packages/ai/src/activities/chat/middleware/types.ts:353 systemPrompts: SystemPrompt[]; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:350 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:364](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L364) #### Inherited from @@ -197,7 +197,7 @@ Defined in: packages/ai/src/activities/chat/middleware/types.ts:350 optional wrapFetch?: FetchWrapper; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:374 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:388](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L388) Wraps the fetch of the next model call. A returned wrapper chains inside the wrappers before it, so it does not replace them. It applies to that diff --git a/docs/reference/interfaces/StructuredOutputStartEvent.md b/docs/reference/interfaces/StructuredOutputStartEvent.md index 3a9a60deac..fd231c12e3 100644 --- a/docs/reference/interfaces/StructuredOutputStartEvent.md +++ b/docs/reference/interfaces/StructuredOutputStartEvent.md @@ -3,7 +3,7 @@ id: StructuredOutputStartEvent title: StructuredOutputStartEvent --- -Defined in: packages/ai/src/types.ts:1792 +Defined in: [packages/ai/src/types.ts:1850](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1850) Emitted at the start of a streaming structured-output run, before the JSON deltas. Tells consumers that the upcoming `TEXT_MESSAGE_CONTENT` deltas @@ -24,7 +24,7 @@ made per-message rather than globally. optional metadata?: Record; ``` -Defined in: packages/ai/src/types.ts:1756 +Defined in: [packages/ai/src/types.ts:1814](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1814) Extra information attached to this event. @@ -40,7 +40,7 @@ Extra information attached to this event. name: "structured-output.start"; ``` -Defined in: packages/ai/src/types.ts:1793 +Defined in: [packages/ai/src/types.ts:1851](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1851) What this custom event is. Required: without it a consumer cannot route the value. @@ -59,7 +59,7 @@ CustomEvent.name type: "CUSTOM"; ``` -Defined in: packages/ai/src/types.ts:1755 +Defined in: [packages/ai/src/types.ts:1813](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1813) #### Inherited from @@ -73,7 +73,7 @@ Defined in: packages/ai/src/types.ts:1755 value: object; ``` -Defined in: packages/ai/src/types.ts:1794 +Defined in: [packages/ai/src/types.ts:1852](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1852) The payload. Any JSON value, and required. diff --git a/docs/reference/interfaces/SubagentBinding.md b/docs/reference/interfaces/SubagentBinding.md index d1a1d9a0e0..16a3311507 100644 --- a/docs/reference/interfaces/SubagentBinding.md +++ b/docs/reference/interfaces/SubagentBinding.md @@ -3,11 +3,15 @@ id: SubagentBinding title: SubagentBinding --- -Defined in: packages/ai/src/activities/chat/agents/bound.ts:108 +Defined in: [packages/ai/src/activities/chat/agents/bound.ts:117](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/bound.ts#L117) + +**`Internal`** What a host adds to every activity call an agent makes through `ctx`. Apps using plain `chat({ subagents })` do not set it. + For hosts that run agents, such as `@tanstack/ai-harness`. + ## Properties ### budget? @@ -16,7 +20,7 @@ using plain `chat({ subagents })` do not set it. optional budget?: SubagentBudget; ``` -Defined in: packages/ai/src/activities/chat/agents/bound.ts:123 +Defined in: [packages/ai/src/activities/chat/agents/bound.ts:148](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/bound.ts#L148) The subagent tree budget. A child's `ctx.chat({ subagents })` passes it down, so limits hold across the whole tree. @@ -29,33 +33,87 @@ down, so limits hold across the whole tree. optional chatMiddleware?: readonly AnyChatMiddleware[]; ``` -Defined in: packages/ai/src/activities/chat/agents/bound.ts:113 +Defined in: [packages/ai/src/activities/chat/agents/bound.ts:122](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/bound.ts#L122) Added before the call's own middleware on every `ctx.chat` call. A child's `ctx.chat({ subagents })` passes it down to its own children. *** +### debug? + +```ts +optional debug?: DebugOption; +``` + +Defined in: [packages/ai/src/activities/chat/agents/bound.ts:165](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/bound.ts#L165) + +The `debug` option for the model calls of a child agent that set no +`debug` of their own. A child's `ctx.chat({ subagents })` passes it down +to its own children. + +*** + +### extend? + +```ts +optional extend?: (ctx) => Partial; +``` + +Defined in: [packages/ai/src/activities/chat/agents/bound.ts:170](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/bound.ts#L170) + +Adds fields to the `ctx` of every run. A host declares their types by +augmenting `SubagentContextExtension`. It passes down to nested children. + +#### Parameters + +##### ctx + +[`SubagentRunContext`](../type-aliases/SubagentRunContext.md) + +#### Returns + +`Partial`\<[`SubagentContextExtension`](SubagentContextExtension.md)\> + +*** + ### generationMiddleware? ```ts optional generationMiddleware?: readonly GenerationMiddleware[]; ``` -Defined in: packages/ai/src/activities/chat/agents/bound.ts:118 +Defined in: [packages/ai/src/activities/chat/agents/bound.ts:134](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/bound.ts#L134) Added before the call's own middleware on every generation call. A child's `ctx.chat({ subagents })` passes it down to its own children. *** +### interrupts? + +```ts +optional interrupts?: readonly InterruptDefinition[]; +``` + +Defined in: [packages/ai/src/activities/chat/agents/bound.ts:143](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/bound.ts#L143) + +Interrupt definitions added to every `ctx.chat` call, so the host +middleware in `chatMiddleware` can stop the child with them. The call's +own `interrupts` (for example, the agent's own definitions) win: a host +definition with the same id is not added. A child's +`ctx.chat({ subagents })` passes them down to its own children. A plain +`chat()` call does not get them. + +*** + ### keys? ```ts optional keys?: ProviderKeys; ``` -Defined in: packages/ai/src/activities/chat/agents/bound.ts:129 +Defined in: [packages/ai/src/activities/chat/agents/bound.ts:154](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/bound.ts#L154) The provider keys an agent reads as `ctx.keys`. `subagents.keys` sets them. A child's `ctx.chat({ subagents })` passes them down to its own @@ -63,13 +121,28 @@ children. Without them, `ctx.keys` reads each provider's `env` names. *** +### lastChatMiddleware? + +```ts +optional lastChatMiddleware?: readonly AnyChatMiddleware[]; +``` + +Defined in: [packages/ai/src/activities/chat/agents/bound.ts:129](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/bound.ts#L129) + +Added after the call's own middleware on every `ctx.chat` call, so it +sees the final config and tool results (for example a host middleware +that scrubs secrets or logs results). A child's `ctx.chat({ subagents })` +passes it down to its own children, after their own. + +*** + ### promptCache? ```ts optional promptCache?: PromptCacheRetention; ``` -Defined in: packages/ai/src/activities/chat/agents/bound.ts:134 +Defined in: [packages/ai/src/activities/chat/agents/bound.ts:159](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/bound.ts#L159) The prompt cache retention of the parent call. A child's `ctx.chat()` uses it when the call gives no `promptCache`. @@ -85,7 +158,7 @@ optional start?: (call, options) => Promise<{ }>; ``` -Defined in: packages/ai/src/activities/chat/agents/bound.ts:141 +Defined in: [packages/ai/src/activities/chat/agents/bound.ts:177](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/bound.ts#L177) Starts a child without waiting for it and returns its id at once. The agent tools call it for `background: true`. With diff --git a/docs/reference/interfaces/SubagentContextExtension.md b/docs/reference/interfaces/SubagentContextExtension.md new file mode 100644 index 0000000000..31c05bd175 --- /dev/null +++ b/docs/reference/interfaces/SubagentContextExtension.md @@ -0,0 +1,11 @@ +--- +id: SubagentContextExtension +title: SubagentContextExtension +--- + +Defined in: [packages/ai/src/activities/chat/agents/define-agent.ts:78](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/define-agent.ts#L78) + +What a host adds to `ctx` through `SubagentBinding.extend`. Empty here: a +host package augments it, so its fields type-check on `ctx` in every `run`. +Make each field optional: a run that a plain `chat()` starts has no host, +so it has none of them. diff --git a/docs/reference/interfaces/SubagentErrorEvent.md b/docs/reference/interfaces/SubagentErrorEvent.md index 3f5e75a107..002272fe7b 100644 --- a/docs/reference/interfaces/SubagentErrorEvent.md +++ b/docs/reference/interfaces/SubagentErrorEvent.md @@ -3,7 +3,7 @@ id: SubagentErrorEvent title: SubagentErrorEvent --- -Defined in: packages/ai/src/types.ts:2092 +Defined in: [packages/ai/src/types.ts:2150](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2150) A child agent failed. The parent run can continue. diff --git a/docs/reference/interfaces/SubagentFinishedEvent.md b/docs/reference/interfaces/SubagentFinishedEvent.md index d9fda814fc..ad3b435a94 100644 --- a/docs/reference/interfaces/SubagentFinishedEvent.md +++ b/docs/reference/interfaces/SubagentFinishedEvent.md @@ -3,7 +3,7 @@ id: SubagentFinishedEvent title: SubagentFinishedEvent --- -Defined in: packages/ai/src/types.ts:2085 +Defined in: [packages/ai/src/types.ts:2143](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2143) A child agent's segment of this run ended. diff --git a/docs/reference/interfaces/SubagentForward.md b/docs/reference/interfaces/SubagentForward.md index f5405d0d91..a65b549fe9 100644 --- a/docs/reference/interfaces/SubagentForward.md +++ b/docs/reference/interfaces/SubagentForward.md @@ -3,7 +3,7 @@ id: SubagentForward title: SubagentForward --- -Defined in: packages/ai/src/activities/chat/agents/bound.ts:88 +Defined in: [packages/ai/src/activities/chat/agents/bound.ts:95](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/bound.ts#L95) The fields a child `chat()` needs, in one spread: `chat({ adapter, messages, ...ctx.forward })`. @@ -16,7 +16,7 @@ The fields a child `chat()` needs, in one spread: abortController: AbortController; ``` -Defined in: packages/ai/src/activities/chat/agents/bound.ts:99 +Defined in: [packages/ai/src/activities/chat/agents/bound.ts:106](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/bound.ts#L106) Aborts when the parent run or the subagent group stops. @@ -28,7 +28,7 @@ Aborts when the parent run or the subagent group stops. parentRunId: string; ``` -Defined in: packages/ai/src/activities/chat/agents/bound.ts:91 +Defined in: [packages/ai/src/activities/chat/agents/bound.ts:98](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/bound.ts#L98) *** @@ -38,7 +38,7 @@ Defined in: packages/ai/src/activities/chat/agents/bound.ts:91 optional parentSubagentRunId?: string; ``` -Defined in: packages/ai/src/activities/chat/agents/bound.ts:96 +Defined in: [packages/ai/src/activities/chat/agents/bound.ts:103](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/bound.ts#L103) The subagentRunId of the child that started this one, for a nested child. @@ -50,7 +50,7 @@ The subagentRunId of the child that started this one, for a nested child. optional promptCache?: PromptCacheRetention; ``` -Defined in: packages/ai/src/activities/chat/agents/bound.ts:101 +Defined in: [packages/ai/src/activities/chat/agents/bound.ts:108](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/bound.ts#L108) The prompt cache retention of the parent call, when it has one. @@ -62,7 +62,7 @@ The prompt cache retention of the parent call, when it has one. optional resume?: RunAgentResumeItem[]; ``` -Defined in: packages/ai/src/activities/chat/agents/bound.ts:97 +Defined in: [packages/ai/src/activities/chat/agents/bound.ts:104](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/bound.ts#L104) *** @@ -72,7 +72,7 @@ Defined in: packages/ai/src/activities/chat/agents/bound.ts:97 runId: string; ``` -Defined in: packages/ai/src/activities/chat/agents/bound.ts:90 +Defined in: [packages/ai/src/activities/chat/agents/bound.ts:97](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/bound.ts#L97) *** @@ -82,7 +82,7 @@ Defined in: packages/ai/src/activities/chat/agents/bound.ts:90 subagentName: string; ``` -Defined in: packages/ai/src/activities/chat/agents/bound.ts:94 +Defined in: [packages/ai/src/activities/chat/agents/bound.ts:101](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/bound.ts#L101) The agent name. Middleware reads it as `ctx.subagentName`. @@ -94,7 +94,7 @@ The agent name. Middleware reads it as `ctx.subagentName`. subagentRunId: string; ``` -Defined in: packages/ai/src/activities/chat/agents/bound.ts:92 +Defined in: [packages/ai/src/activities/chat/agents/bound.ts:99](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/bound.ts#L99) *** @@ -104,4 +104,4 @@ Defined in: packages/ai/src/activities/chat/agents/bound.ts:92 threadId: string; ``` -Defined in: packages/ai/src/activities/chat/agents/bound.ts:89 +Defined in: [packages/ai/src/activities/chat/agents/bound.ts:96](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/bound.ts#L96) diff --git a/docs/reference/interfaces/SubagentHandleData.md b/docs/reference/interfaces/SubagentHandleData.md index bd54d74de3..aaf0aeec18 100644 --- a/docs/reference/interfaces/SubagentHandleData.md +++ b/docs/reference/interfaces/SubagentHandleData.md @@ -3,7 +3,7 @@ id: SubagentHandleData title: SubagentHandleData --- -Defined in: packages/ai/src/types.ts:635 +Defined in: [packages/ai/src/types.ts:638](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L638) One child invocation as the client sees it. AG-UI `SubagentInfo` names the child; the other AG-UI fields come from its `SUBAGENT_STARTED`, @@ -23,7 +23,7 @@ spec does not model. optional error?: Pick; ``` -Defined in: packages/ai/src/types.ts:649 +Defined in: [packages/ai/src/types.ts:652](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L652) *** @@ -33,7 +33,7 @@ Defined in: packages/ai/src/types.ts:649 id: string; ``` -Defined in: packages/ai/src/types.ts:642 +Defined in: [packages/ai/src/types.ts:645](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L645) *** @@ -43,7 +43,7 @@ Defined in: packages/ai/src/types.ts:642 optional interruptIds?: string[]; ``` -Defined in: packages/ai/src/types.ts:647 +Defined in: [packages/ai/src/types.ts:650](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L650) Interrupts this child raised, while `status` is `'suspended'`. @@ -55,7 +55,7 @@ Interrupts this child raised, while `status` is `'suspended'`. messages: UIMessage[]; ``` -Defined in: packages/ai/src/types.ts:648 +Defined in: [packages/ai/src/types.ts:651](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L651) *** @@ -65,7 +65,7 @@ Defined in: packages/ai/src/types.ts:648 optional parentRunId?: string; ``` -Defined in: packages/ai/src/types.ts:645 +Defined in: [packages/ai/src/types.ts:648](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L648) The parent chat run that started this child. @@ -77,4 +77,4 @@ The parent chat run that started this child. status: SubagentStatus; ``` -Defined in: packages/ai/src/types.ts:643 +Defined in: [packages/ai/src/types.ts:646](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L646) diff --git a/docs/reference/interfaces/SubagentLimits.md b/docs/reference/interfaces/SubagentLimits.md index e80c3c01f0..05fb654017 100644 --- a/docs/reference/interfaces/SubagentLimits.md +++ b/docs/reference/interfaces/SubagentLimits.md @@ -3,7 +3,7 @@ id: SubagentLimits title: SubagentLimits --- -Defined in: packages/ai/src/activities/chat/agents/limits.ts:5 +Defined in: [packages/ai/src/activities/chat/agents/limits.ts:5](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/limits.ts#L5) Limits for a whole subagent tree. The root run makes one budget, and every child shares it, so a child cannot reset it. @@ -16,7 +16,7 @@ child shares it, so a child cannot reset it. optional maxCalls?: number; ``` -Defined in: packages/ai/src/activities/chat/agents/limits.ts:11 +Defined in: [packages/ai/src/activities/chat/agents/limits.ts:11](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/limits.ts#L11) How many children the whole tree may start. @@ -28,7 +28,7 @@ How many children the whole tree may start. optional maxConcurrent?: number; ``` -Defined in: packages/ai/src/activities/chat/agents/limits.ts:9 +Defined in: [packages/ai/src/activities/chat/agents/limits.ts:9](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/limits.ts#L9) How many children one run may have running at once. @@ -40,7 +40,7 @@ How many children one run may have running at once. optional maxDepth?: number; ``` -Defined in: packages/ai/src/activities/chat/agents/limits.ts:7 +Defined in: [packages/ai/src/activities/chat/agents/limits.ts:7](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/limits.ts#L7) How deep the tree may grow. The root run is depth 0. @@ -52,6 +52,6 @@ How deep the tree may grow. The root run is depth 0. optional timeoutMs?: number; ``` -Defined in: packages/ai/src/activities/chat/agents/limits.ts:13 +Defined in: [packages/ai/src/activities/chat/agents/limits.ts:13](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/limits.ts#L13) How long one child may run. Never later than its parent's own deadline. diff --git a/docs/reference/interfaces/SubagentPart.md b/docs/reference/interfaces/SubagentPart.md index 545a16779b..b476667c9f 100644 --- a/docs/reference/interfaces/SubagentPart.md +++ b/docs/reference/interfaces/SubagentPart.md @@ -3,7 +3,7 @@ id: SubagentPart title: SubagentPart --- -Defined in: packages/ai/src/types.ts:652 +Defined in: [packages/ai/src/types.ts:655](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L655) ## Properties @@ -13,7 +13,7 @@ Defined in: packages/ai/src/types.ts:652 subagent: SubagentHandleData; ``` -Defined in: packages/ai/src/types.ts:654 +Defined in: [packages/ai/src/types.ts:657](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L657) *** @@ -23,4 +23,4 @@ Defined in: packages/ai/src/types.ts:654 type: "subagent"; ``` -Defined in: packages/ai/src/types.ts:653 +Defined in: [packages/ai/src/types.ts:656](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L656) diff --git a/docs/reference/interfaces/SubagentRouteOptions.md b/docs/reference/interfaces/SubagentRouteOptions.md index ddcf675f19..fddb6aaf16 100644 --- a/docs/reference/interfaces/SubagentRouteOptions.md +++ b/docs/reference/interfaces/SubagentRouteOptions.md @@ -3,7 +3,7 @@ id: SubagentRouteOptions title: SubagentRouteOptions --- -Defined in: packages/ai/src/activities/chat/agents/route.ts:8 +Defined in: [packages/ai/src/activities/chat/agents/route.ts:8](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/route.ts#L8) ## Type Parameters @@ -19,7 +19,7 @@ Defined in: packages/ai/src/activities/chat/agents/route.ts:8 optional then?: readonly TAgents[number]["name"][]; ``` -Defined in: packages/ai/src/activities/chat/agents/route.ts:22 +Defined in: [packages/ai/src/activities/chat/agents/route.ts:22](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/route.ts#L22) Agents that run after the other selected agents. The lead group starts together. The `then` agents then run one after another in list order, and @@ -34,7 +34,7 @@ agent from each group. Otherwise `pick` returns `{ names, order }`. optional when?: { [K in string]: string }; ``` -Defined in: packages/ai/src/activities/chat/agents/route.ts:15 +Defined in: [packages/ai/src/activities/chat/agents/route.ts:15](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/route.ts#L15) Question text for every agent. The key is the agent name. Omit this and each question uses that agent's description. diff --git a/docs/reference/interfaces/SubagentRouterPlan.md b/docs/reference/interfaces/SubagentRouterPlan.md index 457fad09d7..65e29b57cf 100644 --- a/docs/reference/interfaces/SubagentRouterPlan.md +++ b/docs/reference/interfaces/SubagentRouterPlan.md @@ -3,7 +3,7 @@ id: SubagentRouterPlan title: SubagentRouterPlan --- -Defined in: packages/ai/src/activities/chat/agents/spawn.ts:71 +Defined in: [packages/ai/src/activities/chat/agents/spawn.ts:87](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/spawn.ts#L87) ## Properties @@ -13,7 +13,7 @@ Defined in: packages/ai/src/activities/chat/agents/spawn.ts:71 names: readonly SubagentPick[]; ``` -Defined in: packages/ai/src/activities/chat/agents/spawn.ts:72 +Defined in: [packages/ai/src/activities/chat/agents/spawn.ts:88](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/spawn.ts#L88) *** @@ -23,6 +23,6 @@ Defined in: packages/ai/src/activities/chat/agents/spawn.ts:72 optional order?: SubagentOrder; ``` -Defined in: packages/ai/src/activities/chat/agents/spawn.ts:74 +Defined in: [packages/ai/src/activities/chat/agents/spawn.ts:90](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/spawn.ts#L90) Overrides `subagents.order` for this turn. diff --git a/docs/reference/interfaces/SubagentRunInput.md b/docs/reference/interfaces/SubagentRunInput.md index 837ecd5fa2..9164f5320c 100644 --- a/docs/reference/interfaces/SubagentRunInput.md +++ b/docs/reference/interfaces/SubagentRunInput.md @@ -3,7 +3,7 @@ id: SubagentRunInput title: SubagentRunInput --- -Defined in: packages/ai/src/activities/chat/agents/define-agent.ts:20 +Defined in: [packages/ai/src/activities/chat/agents/define-agent.ts:20](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/define-agent.ts#L20) What the library knows about a child run before `run` starts. `TInput` is the agent's `inputSchema`. @@ -22,7 +22,7 @@ What the library knows about a child run before `run` starts. optional abortSignal?: AbortSignal; ``` -Defined in: packages/ai/src/activities/chat/agents/define-agent.ts:29 +Defined in: [packages/ai/src/activities/chat/agents/define-agent.ts:29](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/define-agent.ts#L29) *** @@ -32,7 +32,7 @@ Defined in: packages/ai/src/activities/chat/agents/define-agent.ts:29 input: TInput extends SchemaInput ? InferSchemaType : undefined; ``` -Defined in: packages/ai/src/activities/chat/agents/define-agent.ts:27 +Defined in: [packages/ai/src/activities/chat/agents/define-agent.ts:27](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/define-agent.ts#L27) The input the parent model or the router gave this child, checked against `inputSchema`. `undefined` when the agent has no `inputSchema`. @@ -50,7 +50,7 @@ messages: ( | null>)[]; ``` -Defined in: packages/ai/src/activities/chat/agents/define-agent.ts:28 +Defined in: [packages/ai/src/activities/chat/agents/define-agent.ts:28](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/define-agent.ts#L28) *** @@ -60,7 +60,7 @@ Defined in: packages/ai/src/activities/chat/agents/define-agent.ts:28 parentRunId: string; ``` -Defined in: packages/ai/src/activities/chat/agents/define-agent.ts:38 +Defined in: [packages/ai/src/activities/chat/agents/define-agent.ts:38](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/define-agent.ts#L38) The run this child run continues. It is the parent chat run on the first run, and the interrupted parent run on a resume. Pass it to the child @@ -74,7 +74,7 @@ run, and the interrupted parent run on a resume. Pass it to the child optional parentSubagentRunId?: string; ``` -Defined in: packages/ai/src/activities/chat/agents/define-agent.ts:48 +Defined in: [packages/ai/src/activities/chat/agents/define-agent.ts:48](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/define-agent.ts#L48) The subagentRunId of the child that started this one, for a nested child. @@ -86,7 +86,7 @@ The subagentRunId of the child that started this one, for a nested child. optional resume?: RunAgentResumeItem[]; ``` -Defined in: packages/ai/src/activities/chat/agents/define-agent.ts:40 +Defined in: [packages/ai/src/activities/chat/agents/define-agent.ts:40](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/define-agent.ts#L40) Answers to this child's interrupts. Pass it to the child `chat()`. @@ -98,7 +98,7 @@ Answers to this child's interrupts. Pass it to the child `chat()`. runId: string; ``` -Defined in: packages/ai/src/activities/chat/agents/define-agent.ts:32 +Defined in: [packages/ai/src/activities/chat/agents/define-agent.ts:32](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/define-agent.ts#L32) Run id for the child `chat()`. @@ -110,7 +110,7 @@ Run id for the child `chat()`. subagentRunId: string; ``` -Defined in: packages/ai/src/activities/chat/agents/define-agent.ts:46 +Defined in: [packages/ai/src/activities/chat/agents/define-agent.ts:46](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/define-agent.ts#L46) The child's AG-UI run id. Stays the same when an interrupted child continues. Pass it to the child `chat()` so its middleware sees @@ -124,4 +124,4 @@ continues. Pass it to the child `chat()` so its middleware sees threadId: string; ``` -Defined in: packages/ai/src/activities/chat/agents/define-agent.ts:30 +Defined in: [packages/ai/src/activities/chat/agents/define-agent.ts:30](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/define-agent.ts#L30) diff --git a/docs/reference/interfaces/SubagentSink.md b/docs/reference/interfaces/SubagentSink.md index 1e6d2573e7..007f6533fa 100644 --- a/docs/reference/interfaces/SubagentSink.md +++ b/docs/reference/interfaces/SubagentSink.md @@ -3,7 +3,7 @@ id: SubagentSink title: SubagentSink --- -Defined in: packages/ai/src/activities/chat/agents/spawn.ts:205 +Defined in: [packages/ai/src/activities/chat/agents/spawn.ts:223](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/spawn.ts#L223) What the children of one parent run left behind for the parent terminal. @@ -15,7 +15,7 @@ What the children of one parent run left behind for the parent terminal. interrupts: Interrupt[]; ``` -Defined in: packages/ai/src/activities/chat/agents/spawn.ts:206 +Defined in: [packages/ai/src/activities/chat/agents/spawn.ts:224](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/spawn.ts#L224) *** @@ -25,7 +25,7 @@ Defined in: packages/ai/src/activities/chat/agents/spawn.ts:206 optional total?: TokenUsage; ``` -Defined in: packages/ai/src/activities/chat/agents/spawn.ts:210 +Defined in: [packages/ai/src/activities/chat/agents/spawn.ts:228](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/spawn.ts#L228) Summed full usage of the children, including cost. @@ -37,6 +37,6 @@ Summed full usage of the children, including cost. usage: TokenUsage[]; ``` -Defined in: packages/ai/src/activities/chat/agents/spawn.ts:208 +Defined in: [packages/ai/src/activities/chat/agents/spawn.ts:226](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/spawn.ts#L226) One AG-UI entry per child model call. diff --git a/docs/reference/interfaces/SubagentStartedEvent.md b/docs/reference/interfaces/SubagentStartedEvent.md index c1b0ce5aa2..d035d175e1 100644 --- a/docs/reference/interfaces/SubagentStartedEvent.md +++ b/docs/reference/interfaces/SubagentStartedEvent.md @@ -3,7 +3,7 @@ id: SubagentStartedEvent title: SubagentStartedEvent --- -Defined in: packages/ai/src/types.ts:2078 +Defined in: [packages/ai/src/types.ts:2136](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2136) A child agent started. The later chunks for that child carry the same `subagentRunId`. diff --git a/docs/reference/interfaces/SubagentStep.md b/docs/reference/interfaces/SubagentStep.md index 23b53f916d..3cca7a31d1 100644 --- a/docs/reference/interfaces/SubagentStep.md +++ b/docs/reference/interfaces/SubagentStep.md @@ -3,7 +3,7 @@ id: SubagentStep title: SubagentStep --- -Defined in: packages/ai/src/activities/chat/agents/spawn.ts:77 +Defined in: [packages/ai/src/activities/chat/agents/spawn.ts:93](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/spawn.ts#L93) ## Properties @@ -13,7 +13,7 @@ Defined in: packages/ai/src/activities/chat/agents/spawn.ts:77 names: readonly SubagentPick[]; ``` -Defined in: packages/ai/src/activities/chat/agents/spawn.ts:78 +Defined in: [packages/ai/src/activities/chat/agents/spawn.ts:94](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/spawn.ts#L94) *** @@ -23,6 +23,6 @@ Defined in: packages/ai/src/activities/chat/agents/spawn.ts:78 optional order?: SubagentOrder; ``` -Defined in: packages/ai/src/activities/chat/agents/spawn.ts:80 +Defined in: [packages/ai/src/activities/chat/agents/spawn.ts:96](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/spawn.ts#L96) Overrides `subagents.order` for this step. diff --git a/docs/reference/interfaces/SubagentStepsPlan.md b/docs/reference/interfaces/SubagentStepsPlan.md index cad8f112f3..b3cabadaee 100644 --- a/docs/reference/interfaces/SubagentStepsPlan.md +++ b/docs/reference/interfaces/SubagentStepsPlan.md @@ -3,7 +3,7 @@ id: SubagentStepsPlan title: SubagentStepsPlan --- -Defined in: packages/ai/src/activities/chat/agents/spawn.ts:83 +Defined in: [packages/ai/src/activities/chat/agents/spawn.ts:99](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/spawn.ts#L99) ## Properties @@ -13,4 +13,4 @@ Defined in: packages/ai/src/activities/chat/agents/spawn.ts:83 steps: readonly SubagentStep[]; ``` -Defined in: packages/ai/src/activities/chat/agents/spawn.ts:84 +Defined in: [packages/ai/src/activities/chat/agents/spawn.ts:100](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/spawn.ts#L100) diff --git a/docs/reference/interfaces/SubagentWireInfo.md b/docs/reference/interfaces/SubagentWireInfo.md index 1484098d9c..1e375fa280 100644 --- a/docs/reference/interfaces/SubagentWireInfo.md +++ b/docs/reference/interfaces/SubagentWireInfo.md @@ -3,7 +3,7 @@ id: SubagentWireInfo title: SubagentWireInfo --- -Defined in: packages/ai/src/utilities/subagent-wire.ts:8 +Defined in: [packages/ai/src/utilities/subagent-wire.ts:8](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/subagent-wire.ts#L8) Card data that travels on each child wire message, in `metadata.tanstack.subagent`. The messages carry the AG-UI `subagentRunId`. @@ -26,7 +26,7 @@ Card data that travels on each child wire message, in optional error?: Pick; ``` -Defined in: packages/ai/src/types.ts:649 +Defined in: [packages/ai/src/types.ts:652](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L652) #### Inherited from @@ -42,7 +42,7 @@ Pick.error optional interruptIds?: string[]; ``` -Defined in: packages/ai/src/types.ts:647 +Defined in: [packages/ai/src/types.ts:650](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L650) Interrupts this child raised, while `status` is `'suspended'`. @@ -60,7 +60,7 @@ Pick.interruptIds optional placeholder?: true; ``` -Defined in: packages/ai/src/utilities/subagent-wire.ts:21 +Defined in: [packages/ai/src/utilities/subagent-wire.ts:21](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/subagent-wire.ts#L21) The child has no messages yet. This wire message only holds the card. @@ -72,7 +72,7 @@ The child has no messages yet. This wire message only holds the card. status: SubagentStatus; ``` -Defined in: packages/ai/src/types.ts:643 +Defined in: [packages/ai/src/types.ts:646](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L646) #### Inherited from diff --git a/docs/reference/interfaces/SubagentsBag.md b/docs/reference/interfaces/SubagentsBag.md index 5024e524a4..8ad6bc7c18 100644 --- a/docs/reference/interfaces/SubagentsBag.md +++ b/docs/reference/interfaces/SubagentsBag.md @@ -3,7 +3,7 @@ id: SubagentsBag title: SubagentsBag --- -Defined in: packages/ai/src/activities/chat/agents/spawn.ts:108 +Defined in: [packages/ai/src/activities/chat/agents/spawn.ts:124](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/spawn.ts#L124) ## Type Parameters @@ -19,7 +19,7 @@ Defined in: packages/ai/src/activities/chat/agents/spawn.ts:108 agents: TAgents; ``` -Defined in: packages/ai/src/activities/chat/agents/spawn.ts:111 +Defined in: [packages/ai/src/activities/chat/agents/spawn.ts:127](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/spawn.ts#L127) *** @@ -29,11 +29,15 @@ Defined in: packages/ai/src/activities/chat/agents/spawn.ts:111 optional binding?: SubagentBinding; ``` -Defined in: packages/ai/src/activities/chat/agents/spawn.ts:129 +Defined in: [packages/ai/src/activities/chat/agents/spawn.ts:147](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/spawn.ts#L147) + +**`Internal`** What a host adds to every activity call a child makes through `ctx` (`ctx.chat`, `ctx.generateImage`, and the rest). Apps do not set it. + For hosts that run agents, such as `@tanstack/ai-harness`. + *** ### keys? @@ -42,7 +46,7 @@ What a host adds to every activity call a child makes through `ctx` optional keys?: ProviderKeySource; ``` -Defined in: packages/ai/src/activities/chat/agents/spawn.ts:145 +Defined in: [packages/ai/src/activities/chat/agents/spawn.ts:163](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/spawn.ts#L163) Provider keys that agents read as `ctx.keys`: an object by provider id, for example `{ openai: userKey }`, or a function that returns the key of @@ -59,7 +63,7 @@ them on. The keys it sets itself win for those providers. optional limits?: SubagentLimits; ``` -Defined in: packages/ai/src/activities/chat/agents/spawn.ts:136 +Defined in: [packages/ai/src/activities/chat/agents/spawn.ts:154](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/spawn.ts#L154) Limits for the whole tree of children the model starts through tools: depth, total calls, children at once, and time per child. A refused @@ -74,7 +78,7 @@ apply: a nested chat in a child uses the root's budget. optional order?: "parallel" | "sequence"; ``` -Defined in: packages/ai/src/activities/chat/agents/spawn.ts:123 +Defined in: [packages/ai/src/activities/chat/agents/spawn.ts:139](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/spawn.ts#L139) How a router list runs. `parallel` starts every name together. `sequence` runs each name after the previous one finishes, and passes @@ -90,7 +94,7 @@ optional router?: (ctx) => | Promise; ``` -Defined in: packages/ai/src/activities/chat/agents/spawn.ts:112 +Defined in: [packages/ai/src/activities/chat/agents/spawn.ts:128](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/spawn.ts#L128) #### Parameters @@ -126,7 +130,7 @@ Defined in: packages/ai/src/activities/chat/agents/spawn.ts:112 optional sandbox?: "own" | "inherit"; ``` -Defined in: packages/ai/src/activities/chat/agents/spawn.ts:124 +Defined in: [packages/ai/src/activities/chat/agents/spawn.ts:140](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/spawn.ts#L140) *** @@ -136,4 +140,4 @@ Defined in: packages/ai/src/activities/chat/agents/spawn.ts:124 optional strategy?: "exclusive" | "handoff"; ``` -Defined in: packages/ai/src/activities/chat/agents/spawn.ts:117 +Defined in: [packages/ai/src/activities/chat/agents/spawn.ts:133](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/spawn.ts#L133) diff --git a/docs/reference/interfaces/SummarizationOptions.md b/docs/reference/interfaces/SummarizationOptions.md index 07f6dea86d..4e5b77c835 100644 --- a/docs/reference/interfaces/SummarizationOptions.md +++ b/docs/reference/interfaces/SummarizationOptions.md @@ -3,7 +3,7 @@ id: SummarizationOptions title: SummarizationOptions --- -Defined in: packages/ai/src/types.ts:2138 +Defined in: [packages/ai/src/types.ts:2196](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2196) ## Type Parameters @@ -19,7 +19,7 @@ Defined in: packages/ai/src/types.ts:2138 optional abortSignal?: AbortSignal; ``` -Defined in: packages/ai/src/types.ts:2168 +Defined in: [packages/ai/src/types.ts:2226](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2226) Effective abort signal composed by the activity from caller `abortSignal` and/or `timeout`. Adapters should forward this to the provider SDK when @@ -33,7 +33,7 @@ supported. Request-specific — never store on a global client config. optional focus?: string[]; ``` -Defined in: packages/ai/src/types.ts:2145 +Defined in: [packages/ai/src/types.ts:2203](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2203) *** @@ -43,7 +43,7 @@ Defined in: packages/ai/src/types.ts:2145 logger: InternalLogger; ``` -Defined in: packages/ai/src/types.ts:2162 +Defined in: [packages/ai/src/types.ts:2220](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2220) Internal logger threaded from the summarize() entry point. Adapters must call logger.request() before the SDK call and logger.errors() in catch blocks. @@ -56,7 +56,7 @@ call logger.request() before the SDK call and logger.errors() in catch blocks. optional maxLength?: number; ``` -Defined in: packages/ai/src/types.ts:2143 +Defined in: [packages/ai/src/types.ts:2201](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2201) *** @@ -66,7 +66,7 @@ Defined in: packages/ai/src/types.ts:2143 model: string; ``` -Defined in: packages/ai/src/types.ts:2141 +Defined in: [packages/ai/src/types.ts:2199](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2199) *** @@ -76,7 +76,7 @@ Defined in: packages/ai/src/types.ts:2141 optional modelOptions?: TProviderOptions; ``` -Defined in: packages/ai/src/types.ts:2147 +Defined in: [packages/ai/src/types.ts:2205](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2205) Provider-specific options forwarded by the summarize() activity. @@ -88,7 +88,7 @@ Provider-specific options forwarded by the summarize() activity. optional runId?: string; ``` -Defined in: packages/ai/src/types.ts:2156 +Defined in: [packages/ai/src/types.ts:2214](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2214) Run identity forwarded from the summarize() activity. When set, the streaming adapter stamps it onto the emitted `RUN_STARTED` (via the wrapped @@ -105,7 +105,7 @@ their own. optional style?: "bullet-points" | "paragraph" | "concise"; ``` -Defined in: packages/ai/src/types.ts:2144 +Defined in: [packages/ai/src/types.ts:2202](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2202) *** @@ -115,7 +115,7 @@ Defined in: packages/ai/src/types.ts:2144 text: string; ``` -Defined in: packages/ai/src/types.ts:2142 +Defined in: [packages/ai/src/types.ts:2200](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2200) *** @@ -125,4 +125,4 @@ Defined in: packages/ai/src/types.ts:2142 threadId: string; ``` -Defined in: packages/ai/src/types.ts:2157 +Defined in: [packages/ai/src/types.ts:2215](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2215) diff --git a/docs/reference/interfaces/SummarizationResult.md b/docs/reference/interfaces/SummarizationResult.md index 0e7369d6f6..b456357660 100644 --- a/docs/reference/interfaces/SummarizationResult.md +++ b/docs/reference/interfaces/SummarizationResult.md @@ -3,7 +3,7 @@ id: SummarizationResult title: SummarizationResult --- -Defined in: packages/ai/src/types.ts:2171 +Defined in: [packages/ai/src/types.ts:2229](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2229) ## Properties @@ -13,7 +13,7 @@ Defined in: packages/ai/src/types.ts:2171 id: string; ``` -Defined in: packages/ai/src/types.ts:2172 +Defined in: [packages/ai/src/types.ts:2230](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2230) *** @@ -23,7 +23,7 @@ Defined in: packages/ai/src/types.ts:2172 model: string; ``` -Defined in: packages/ai/src/types.ts:2173 +Defined in: [packages/ai/src/types.ts:2231](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2231) *** @@ -33,7 +33,7 @@ Defined in: packages/ai/src/types.ts:2173 summary: string; ``` -Defined in: packages/ai/src/types.ts:2174 +Defined in: [packages/ai/src/types.ts:2232](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2232) *** @@ -43,4 +43,4 @@ Defined in: packages/ai/src/types.ts:2174 usage: TokenUsage; ``` -Defined in: packages/ai/src/types.ts:2175 +Defined in: [packages/ai/src/types.ts:2233](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2233) diff --git a/docs/reference/interfaces/SummarizeAdapter.md b/docs/reference/interfaces/SummarizeAdapter.md index 07ab65bc42..c64a169e22 100644 --- a/docs/reference/interfaces/SummarizeAdapter.md +++ b/docs/reference/interfaces/SummarizeAdapter.md @@ -3,7 +3,7 @@ id: SummarizeAdapter title: SummarizeAdapter --- -Defined in: packages/ai/src/activities/summarize/adapter.ts:28 +Defined in: [packages/ai/src/activities/summarize/adapter.ts:28](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/summarize/adapter.ts#L28) Summarize adapter interface with pre-resolved generics. @@ -32,7 +32,7 @@ Generic parameters: ~types: object; ``` -Defined in: packages/ai/src/activities/summarize/adapter.ts:42 +Defined in: [packages/ai/src/activities/summarize/adapter.ts:42](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/summarize/adapter.ts#L42) **`Internal`** @@ -52,7 +52,7 @@ providerOptions: TProviderOptions; readonly kind: "summarize"; ``` -Defined in: packages/ai/src/activities/summarize/adapter.ts:33 +Defined in: [packages/ai/src/activities/summarize/adapter.ts:33](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/summarize/adapter.ts#L33) Discriminator for adapter kind - used by generate() to determine API shape @@ -64,7 +64,7 @@ Discriminator for adapter kind - used by generate() to determine API shape readonly model: TModel; ``` -Defined in: packages/ai/src/activities/summarize/adapter.ts:37 +Defined in: [packages/ai/src/activities/summarize/adapter.ts:37](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/summarize/adapter.ts#L37) The model this adapter is configured for @@ -76,7 +76,7 @@ The model this adapter is configured for readonly name: string; ``` -Defined in: packages/ai/src/activities/summarize/adapter.ts:35 +Defined in: [packages/ai/src/activities/summarize/adapter.ts:35](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/summarize/adapter.ts#L35) Adapter name identifier @@ -88,7 +88,7 @@ Adapter name identifier summarize: (options) => Promise; ``` -Defined in: packages/ai/src/activities/summarize/adapter.ts:49 +Defined in: [packages/ai/src/activities/summarize/adapter.ts:49](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/summarize/adapter.ts#L49) Summarize the given text @@ -110,7 +110,7 @@ Summarize the given text optional summarizeStream?: (options) => AsyncIterable; ``` -Defined in: packages/ai/src/activities/summarize/adapter.ts:58 +Defined in: [packages/ai/src/activities/summarize/adapter.ts:58](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/summarize/adapter.ts#L58) Stream summarization of the given text. Optional - if not implemented, the activity layer will fall back to diff --git a/docs/reference/interfaces/TTSAdapter.md b/docs/reference/interfaces/TTSAdapter.md index 90399c6db1..beea88812f 100644 --- a/docs/reference/interfaces/TTSAdapter.md +++ b/docs/reference/interfaces/TTSAdapter.md @@ -3,7 +3,7 @@ id: TTSAdapter title: TTSAdapter --- -Defined in: packages/ai/src/activities/generateSpeech/adapter.ts:46 +Defined in: [packages/ai/src/activities/generateSpeech/adapter.ts:46](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateSpeech/adapter.ts#L46) TTS adapter interface with pre-resolved generics. @@ -32,7 +32,7 @@ Generic parameters: ~types: object; ``` -Defined in: packages/ai/src/activities/generateSpeech/adapter.ts:65 +Defined in: [packages/ai/src/activities/generateSpeech/adapter.ts:65](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateSpeech/adapter.ts#L65) **`Internal`** @@ -52,7 +52,7 @@ providerOptions: TProviderOptions; readonly optional capabilities?: TTSCapabilities; ``` -Defined in: packages/ai/src/activities/generateSpeech/adapter.ts:60 +Defined in: [packages/ai/src/activities/generateSpeech/adapter.ts:60](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateSpeech/adapter.ts#L60) Optional static capability declaration. Absent means "single voice, no timestamps" — the contract every adapter had before dialogue existed. @@ -65,7 +65,7 @@ timestamps" — the contract every adapter had before dialogue existed. generateSpeech: (options) => Promise; ``` -Defined in: packages/ai/src/activities/generateSpeech/adapter.ts:72 +Defined in: [packages/ai/src/activities/generateSpeech/adapter.ts:72](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateSpeech/adapter.ts#L72) Generate speech from text @@ -87,7 +87,7 @@ Generate speech from text readonly kind: "tts"; ``` -Defined in: packages/ai/src/activities/generateSpeech/adapter.ts:51 +Defined in: [packages/ai/src/activities/generateSpeech/adapter.ts:51](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateSpeech/adapter.ts#L51) Discriminator for adapter kind - used to determine API shape @@ -99,7 +99,7 @@ Discriminator for adapter kind - used to determine API shape optional listVoices?: (options?) => Promise; ``` -Defined in: packages/ai/src/activities/generateSpeech/adapter.ts:84 +Defined in: [packages/ai/src/activities/generateSpeech/adapter.ts:84](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateSpeech/adapter.ts#L84) List the voices this account can use. @@ -128,7 +128,7 @@ which is the case wherever `generateVoice()` can add to it. readonly model: TModel; ``` -Defined in: packages/ai/src/activities/generateSpeech/adapter.ts:55 +Defined in: [packages/ai/src/activities/generateSpeech/adapter.ts:55](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateSpeech/adapter.ts#L55) The model this adapter is configured for @@ -140,6 +140,6 @@ The model this adapter is configured for readonly name: string; ``` -Defined in: packages/ai/src/activities/generateSpeech/adapter.ts:53 +Defined in: [packages/ai/src/activities/generateSpeech/adapter.ts:53](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateSpeech/adapter.ts#L53) Adapter name identifier diff --git a/docs/reference/interfaces/TTSAlignment.md b/docs/reference/interfaces/TTSAlignment.md index fb54948a68..015bbed3fa 100644 --- a/docs/reference/interfaces/TTSAlignment.md +++ b/docs/reference/interfaces/TTSAlignment.md @@ -3,7 +3,7 @@ id: TTSAlignment title: TTSAlignment --- -Defined in: packages/ai/src/types.ts:2850 +Defined in: [packages/ai/src/types.ts:2898](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2898) Timings for the generated audio, returned when `timestamps: true` was requested and the adapter declares `capabilities.timestamps`. @@ -20,7 +20,7 @@ All times are **seconds**; adapters convert. endSeconds: number[]; ``` -Defined in: packages/ai/src/types.ts:2858 +Defined in: [packages/ai/src/types.ts:2906](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2906) End of each entry in seconds. Same length as `texts`. @@ -32,7 +32,7 @@ End of each entry in seconds. Same length as `texts`. startSeconds: number[]; ``` -Defined in: packages/ai/src/types.ts:2856 +Defined in: [packages/ai/src/types.ts:2904](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2904) Start of each entry in seconds. Same length as `texts`. @@ -44,7 +44,7 @@ Start of each entry in seconds. Same length as `texts`. texts: string[]; ``` -Defined in: packages/ai/src/types.ts:2854 +Defined in: [packages/ai/src/types.ts:2902](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2902) Entry text, in audio order. @@ -56,6 +56,6 @@ Entry text, in audio order. unit: "character" | "word"; ``` -Defined in: packages/ai/src/types.ts:2852 +Defined in: [packages/ai/src/types.ts:2900](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2900) Granularity of each entry. diff --git a/docs/reference/interfaces/TTSCapabilities.md b/docs/reference/interfaces/TTSCapabilities.md index 0a2e9f5eff..091b24c6de 100644 --- a/docs/reference/interfaces/TTSCapabilities.md +++ b/docs/reference/interfaces/TTSCapabilities.md @@ -3,7 +3,7 @@ id: TTSCapabilities title: TTSCapabilities --- -Defined in: packages/ai/src/activities/generateSpeech/adapter.ts:14 +Defined in: [packages/ai/src/activities/generateSpeech/adapter.ts:14](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateSpeech/adapter.ts#L14) What a TTS adapter can do beyond a single voice reading a single string. @@ -18,7 +18,7 @@ before it reaches the provider, instead of surfacing a provider 422. optional maxSpeakers?: number; ``` -Defined in: packages/ai/src/activities/generateSpeech/adapter.ts:20 +Defined in: [packages/ai/src/activities/generateSpeech/adapter.ts:20](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateSpeech/adapter.ts#L20) Maximum number of distinct voices accepted across `turns` (ElevenLabs 10, Gemini 2). Omit it when the adapter has no dialogue @@ -32,6 +32,6 @@ endpoint — then `turns` is rejected outright. optional timestamps?: boolean; ``` -Defined in: packages/ai/src/activities/generateSpeech/adapter.ts:22 +Defined in: [packages/ai/src/activities/generateSpeech/adapter.ts:22](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateSpeech/adapter.ts#L22) Set when the adapter can honour `timestamps: true`. diff --git a/docs/reference/interfaces/TTSOptions.md b/docs/reference/interfaces/TTSOptions.md index 7ae56047e1..b0fbdc5a89 100644 --- a/docs/reference/interfaces/TTSOptions.md +++ b/docs/reference/interfaces/TTSOptions.md @@ -3,7 +3,7 @@ id: TTSOptions title: TTSOptions --- -Defined in: packages/ai/src/types.ts:2882 +Defined in: [packages/ai/src/types.ts:2930](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2930) Options for text-to-speech generation. These are the common options supported across providers. @@ -22,7 +22,7 @@ These are the common options supported across providers. optional abortSignal?: AbortSignal; ``` -Defined in: packages/ai/src/types.ts:2922 +Defined in: [packages/ai/src/types.ts:2970](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2970) Effective abort signal composed by the activity from caller `abortSignal` and/or `timeout`. Adapters should forward this to the provider SDK when @@ -36,7 +36,7 @@ supported. Request-specific — never store on a global client config. optional format?: "mp3" | "opus" | "aac" | "flac" | "wav" | "pcm"; ``` -Defined in: packages/ai/src/types.ts:2906 +Defined in: [packages/ai/src/types.ts:2954](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2954) The output audio format @@ -48,7 +48,7 @@ The output audio format logger: InternalLogger; ``` -Defined in: packages/ai/src/types.ts:2916 +Defined in: [packages/ai/src/types.ts:2964](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2964) Internal logger threaded from the generateSpeech() entry point. Adapters must call logger.request() before the SDK call and logger.errors() in @@ -62,7 +62,7 @@ catch blocks. model: string; ``` -Defined in: packages/ai/src/types.ts:2884 +Defined in: [packages/ai/src/types.ts:2932](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2932) The model to use for TTS generation @@ -74,7 +74,7 @@ The model to use for TTS generation optional modelOptions?: TProviderOptions; ``` -Defined in: packages/ai/src/types.ts:2910 +Defined in: [packages/ai/src/types.ts:2958](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2958) Model-specific options for TTS generation @@ -86,7 +86,7 @@ Model-specific options for TTS generation optional speed?: number; ``` -Defined in: packages/ai/src/types.ts:2908 +Defined in: [packages/ai/src/types.ts:2956](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2956) The speed of the generated audio (0.25 to 4.0) @@ -98,7 +98,7 @@ The speed of the generated audio (0.25 to 4.0) text: string; ``` -Defined in: packages/ai/src/types.ts:2890 +Defined in: [packages/ai/src/types.ts:2938](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2938) The text to convert to speech. When the caller passed `turns`, the activity fills this with the turn texts joined by newlines so adapters @@ -112,7 +112,7 @@ that only read `text` still receive the full script. optional timestamps?: boolean; ``` -Defined in: packages/ai/src/types.ts:2902 +Defined in: [packages/ai/src/types.ts:2950](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2950) Ask for `alignment` / `segments` on the result. Rejected by the activity unless the adapter declares `capabilities.timestamps`, because on some @@ -126,7 +126,7 @@ providers this is a different endpoint rather than free metadata. optional turns?: TTSTurn[]; ``` -Defined in: packages/ai/src/types.ts:2896 +Defined in: [packages/ai/src/types.ts:2944](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2944) Multi-voice dialogue turns, when the caller asked for dialogue. Only adapters that declare `capabilities.maxSpeakers` ever see this — the @@ -140,6 +140,6 @@ activity rejects `turns` for the rest. optional voice?: string; ``` -Defined in: packages/ai/src/types.ts:2904 +Defined in: [packages/ai/src/types.ts:2952](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2952) The voice to use for generation diff --git a/docs/reference/interfaces/TTSResult.md b/docs/reference/interfaces/TTSResult.md index 97cedffbeb..048f23f214 100644 --- a/docs/reference/interfaces/TTSResult.md +++ b/docs/reference/interfaces/TTSResult.md @@ -3,7 +3,7 @@ id: TTSResult title: TTSResult --- -Defined in: packages/ai/src/types.ts:2928 +Defined in: [packages/ai/src/types.ts:2976](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2976) Result of text-to-speech generation. @@ -15,7 +15,7 @@ Result of text-to-speech generation. optional alignment?: TTSAlignment; ``` -Defined in: packages/ai/src/types.ts:2943 +Defined in: [packages/ai/src/types.ts:2991](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2991) Character- or word-level timings, present when `timestamps: true` was requested. Use this rather than `duration` to find where *speech* ends. @@ -28,7 +28,7 @@ requested. Use this rather than `duration` to find where *speech* ends. optional artifacts?: PersistedArtifactRef[]; ``` -Defined in: packages/ai/src/types.ts:2954 +Defined in: [packages/ai/src/types.ts:3002](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3002) Persisted artifact references for generated assets, when available @@ -40,7 +40,7 @@ Persisted artifact references for generated assets, when available audio: string; ``` -Defined in: packages/ai/src/types.ts:2934 +Defined in: [packages/ai/src/types.ts:2982](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2982) Base64-encoded audio data @@ -52,7 +52,7 @@ Base64-encoded audio data optional contentType?: string; ``` -Defined in: packages/ai/src/types.ts:2950 +Defined in: [packages/ai/src/types.ts:2998](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2998) Content type of the audio (e.g., 'audio/mp3') @@ -64,7 +64,7 @@ Content type of the audio (e.g., 'audio/mp3') optional duration?: number; ``` -Defined in: packages/ai/src/types.ts:2938 +Defined in: [packages/ai/src/types.ts:2986](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2986) Duration of the audio file in seconds, if available @@ -76,7 +76,7 @@ Duration of the audio file in seconds, if available format: string; ``` -Defined in: packages/ai/src/types.ts:2936 +Defined in: [packages/ai/src/types.ts:2984](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2984) Audio format of the generated audio @@ -88,7 +88,7 @@ Audio format of the generated audio id: string; ``` -Defined in: packages/ai/src/types.ts:2930 +Defined in: [packages/ai/src/types.ts:2978](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2978) Unique identifier for the generation @@ -100,7 +100,7 @@ Unique identifier for the generation model: string; ``` -Defined in: packages/ai/src/types.ts:2932 +Defined in: [packages/ai/src/types.ts:2980](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2980) Model used for generation @@ -112,7 +112,7 @@ Model used for generation optional segments?: TTSSegment[]; ``` -Defined in: packages/ai/src/types.ts:2948 +Defined in: [packages/ai/src/types.ts:2996](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2996) Per-turn (or per-utterance) spans of the audio, present when `timestamps: true` was requested and the provider reports segmentation. @@ -125,6 +125,6 @@ Per-turn (or per-utterance) spans of the audio, present when optional usage?: TokenUsage; ``` -Defined in: packages/ai/src/types.ts:2952 +Defined in: [packages/ai/src/types.ts:3000](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3000) Token usage information (if provided by the adapter) diff --git a/docs/reference/interfaces/TTSSegment.md b/docs/reference/interfaces/TTSSegment.md index fe8ccca429..c1e08eba55 100644 --- a/docs/reference/interfaces/TTSSegment.md +++ b/docs/reference/interfaces/TTSSegment.md @@ -3,7 +3,7 @@ id: TTSSegment title: TTSSegment --- -Defined in: packages/ai/src/types.ts:2865 +Defined in: [packages/ai/src/types.ts:2913](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2913) A stretch of audio attributable to one turn (multi-voice) or one utterance (single voice). This is what tells a consumer which turn is where. @@ -16,7 +16,7 @@ A stretch of audio attributable to one turn (multi-voice) or one utterance endSeconds: number; ``` -Defined in: packages/ai/src/types.ts:2869 +Defined in: [packages/ai/src/types.ts:2917](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2917) End of the segment in seconds. @@ -28,7 +28,7 @@ End of the segment in seconds. startSeconds: number; ``` -Defined in: packages/ai/src/types.ts:2867 +Defined in: [packages/ai/src/types.ts:2915](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2915) Start of the segment in seconds. @@ -40,7 +40,7 @@ Start of the segment in seconds. optional text?: string; ``` -Defined in: packages/ai/src/types.ts:2875 +Defined in: [packages/ai/src/types.ts:2923](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2923) Text spoken in this segment, when the provider reports it. @@ -52,7 +52,7 @@ Text spoken in this segment, when the provider reports it. optional turnIndex?: number; ``` -Defined in: packages/ai/src/types.ts:2871 +Defined in: [packages/ai/src/types.ts:2919](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2919) Index into the request's `turns`, when the provider reports it. @@ -64,6 +64,6 @@ Index into the request's `turns`, when the provider reports it. optional voice?: string; ``` -Defined in: packages/ai/src/types.ts:2873 +Defined in: [packages/ai/src/types.ts:2921](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2921) Voice heard in this segment, when the provider reports it. diff --git a/docs/reference/interfaces/TTSTurn.md b/docs/reference/interfaces/TTSTurn.md index 541536f9d8..5aeacfddca 100644 --- a/docs/reference/interfaces/TTSTurn.md +++ b/docs/reference/interfaces/TTSTurn.md @@ -3,7 +3,7 @@ id: TTSTurn title: TTSTurn --- -Defined in: packages/ai/src/types.ts:2835 +Defined in: [packages/ai/src/types.ts:2883](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2883) One turn of a multi-voice dialogue request. @@ -19,7 +19,7 @@ single `text` + `voice` pair. text: string; ``` -Defined in: packages/ai/src/types.ts:2837 +Defined in: [packages/ai/src/types.ts:2885](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2885) The text this voice speaks. @@ -31,6 +31,6 @@ The text this voice speaks. voice: string; ``` -Defined in: packages/ai/src/types.ts:2839 +Defined in: [packages/ai/src/types.ts:2887](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2887) Provider voice id (ElevenLabs) or voice name (Gemini) for this turn. diff --git a/docs/reference/interfaces/TanStackMessageMetadata.md b/docs/reference/interfaces/TanStackMessageMetadata.md index dc12be8842..0feba5256f 100644 --- a/docs/reference/interfaces/TanStackMessageMetadata.md +++ b/docs/reference/interfaces/TanStackMessageMetadata.md @@ -3,7 +3,7 @@ id: TanStackMessageMetadata title: TanStackMessageMetadata --- -Defined in: packages/ai/src/types.ts:699 +Defined in: [packages/ai/src/types.ts:702](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L702) Shape of `metadata.tanstack` on a message. `createdAt` is an ISO-8601 string. @@ -16,7 +16,7 @@ Shape of `metadata.tanstack` on a message. optional continues?: string; ``` -Defined in: packages/ai/src/types.ts:751 +Defined in: [packages/ai/src/types.ts:761](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L761) On an assistant wire row that exists only to keep the block order: the id of the assistant row before it. Our server joins the two rows into @@ -30,7 +30,7 @@ one message with a `blockOrder` map. See `uiMessagesToWire`. optional createdAt?: string; ``` -Defined in: packages/ai/src/types.ts:700 +Defined in: [packages/ai/src/types.ts:703](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L703) *** @@ -40,7 +40,7 @@ Defined in: packages/ai/src/types.ts:700 optional finishReason?: "length" | "stop" | "content_filter" | "tool_calls" | null; ``` -Defined in: packages/ai/src/types.ts:709 +Defined in: [packages/ai/src/types.ts:712](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L712) Why the model call of this assistant message ended. A `'length'` message stopped at the output limit, so its tool calls are not complete. @@ -53,7 +53,22 @@ stopped at the output limit, so its tool calls are not complete. optional model?: string; ``` -Defined in: packages/ai/src/types.ts:701 +Defined in: [packages/ai/src/types.ts:704](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L704) + +*** + +### reasoningItem? + +```ts +optional reasoningItem?: boolean; +``` + +Defined in: [packages/ai/src/types.ts:725](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L725) + +The model call of this assistant message sent a reasoning item. The +OpenAI Responses adapter sets it. A replay that lost that reasoning item +sends the message without its item ids, because the API refuses a +`msg_`/`fc_` item without the reasoning item that made it. *** @@ -63,7 +78,7 @@ Defined in: packages/ai/src/types.ts:701 optional responseId?: string; ``` -Defined in: packages/ai/src/types.ts:704 +Defined in: [packages/ai/src/types.ts:707](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L707) *** @@ -73,7 +88,7 @@ Defined in: packages/ai/src/types.ts:704 optional responseItems?: object[]; ``` -Defined in: packages/ai/src/types.ts:715 +Defined in: [packages/ai/src/types.ts:718](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L718) The provider's answer items of this assistant message, in order, for a same-model replay. The OpenAI Responses adapter keeps each output @@ -99,7 +114,7 @@ optional phase?: string; optional run?: object; ``` -Defined in: packages/ai/src/types.ts:723 +Defined in: [packages/ai/src/types.ts:733](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L733) The chat run that produced this assistant message. `withPersistence` sets `id`. `reconstructChat` with `includeRuns: true` adds the finished run's @@ -131,7 +146,7 @@ optional startedAt?: number; optional runId?: string; ``` -Defined in: packages/ai/src/types.ts:717 +Defined in: [packages/ai/src/types.ts:727](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L727) Parent chat run that produced this assistant message. @@ -143,7 +158,7 @@ Parent chat run that produced this assistant message. optional signature?: string; ``` -Defined in: packages/ai/src/types.ts:727 +Defined in: [packages/ai/src/types.ts:737](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L737) Thinking signature for a `role: 'reasoning'` fan-out message. @@ -155,7 +170,7 @@ Thinking signature for a `role: 'reasoning'` fan-out message. optional source?: MessageSource; ``` -Defined in: packages/ai/src/types.ts:702 +Defined in: [packages/ai/src/types.ts:705](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L705) *** @@ -165,7 +180,7 @@ Defined in: packages/ai/src/types.ts:702 optional stopReason?: "error" | "aborted"; ``` -Defined in: packages/ai/src/types.ts:703 +Defined in: [packages/ai/src/types.ts:706](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L706) *** @@ -175,7 +190,7 @@ Defined in: packages/ai/src/types.ts:703 optional structuredOutput?: object; ``` -Defined in: packages/ai/src/types.ts:737 +Defined in: [packages/ai/src/types.ts:747](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L747) #### data? @@ -221,7 +236,7 @@ optional status?: "error" | "complete" | "streaming"; optional subagent?: SubagentWireInfo; ``` -Defined in: packages/ai/src/types.ts:725 +Defined in: [packages/ai/src/types.ts:735](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L735) Card data on a child wire message. See `uiMessagesToWire`. @@ -233,7 +248,7 @@ Card data on a child wire message. See `uiMessagesToWire`. optional toolCallMetadata?: Record; ``` -Defined in: packages/ai/src/types.ts:729 +Defined in: [packages/ai/src/types.ts:739](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L739) Per-tool-call provider metadata keyed by tool call id (e.g. Gemini thoughtSignature). @@ -245,7 +260,7 @@ Per-tool-call provider metadata keyed by tool call id (e.g. Gemini thoughtSignat optional toolResult?: object; ``` -Defined in: packages/ai/src/types.ts:730 +Defined in: [packages/ai/src/types.ts:740](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L740) #### content? @@ -273,7 +288,7 @@ optional id?: string; optional toolResultOutcome?: ToolResultOutcome; ``` -Defined in: packages/ai/src/types.ts:736 +Defined in: [packages/ai/src/types.ts:746](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L746) Outcome of a cancelled or denied tool result; when present, the UI state is `error`. @@ -285,4 +300,4 @@ Outcome of a cancelled or denied tool result; when present, the UI state is `err optional uiResources?: UIResourcePart[]; ``` -Defined in: packages/ai/src/types.ts:745 +Defined in: [packages/ai/src/types.ts:755](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L755) diff --git a/docs/reference/interfaces/TanStackRunMetadata.md b/docs/reference/interfaces/TanStackRunMetadata.md index 889dc6d1ab..89f966d4b8 100644 --- a/docs/reference/interfaces/TanStackRunMetadata.md +++ b/docs/reference/interfaces/TanStackRunMetadata.md @@ -3,7 +3,7 @@ id: TanStackRunMetadata title: TanStackRunMetadata --- -Defined in: packages/ai/src/types.ts:757 +Defined in: [packages/ai/src/types.ts:767](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L767) Shape of `metadata.tanstack` on run events. @@ -15,19 +15,31 @@ Shape of `metadata.tanstack` on run events. optional args?: string; ``` -Defined in: packages/ai/src/types.ts:777 +Defined in: [packages/ai/src/types.ts:795](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L795) The raw tool argument string on `TOOL_CALL_END`, as the provider sent it. *** +### errorType? + +```ts +optional errorType?: string; +``` + +Defined in: [packages/ai/src/types.ts:788](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L788) + +On a `RUN_ERROR`. See `RunErrorEvent.errorType`. + +*** + ### finishReason? ```ts optional finishReason?: "length" | "stop" | "content_filter" | "tool_calls" | null; ``` -Defined in: packages/ai/src/types.ts:763 +Defined in: [packages/ai/src/types.ts:775](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L775) *** @@ -37,7 +49,7 @@ Defined in: packages/ai/src/types.ts:763 optional index?: number; ``` -Defined in: packages/ai/src/types.ts:770 +Defined in: [packages/ai/src/types.ts:782](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L782) *** @@ -47,7 +59,7 @@ Defined in: packages/ai/src/types.ts:770 optional input?: unknown; ``` -Defined in: packages/ai/src/types.ts:775 +Defined in: [packages/ai/src/types.ts:793](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L793) Parsed `TOOL_CALL_END` input. Spec `TOOL_CALL_END` has no top-level `input`. @@ -59,7 +71,7 @@ Parsed `TOOL_CALL_END` input. Spec `TOOL_CALL_END` has no top-level `input`. optional interruptErrors?: readonly InterruptSubmissionError[]; ``` -Defined in: packages/ai/src/types.ts:766 +Defined in: [packages/ai/src/types.ts:778](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L778) *** @@ -69,7 +81,43 @@ Defined in: packages/ai/src/types.ts:766 optional model?: string; ``` -Defined in: packages/ai/src/types.ts:759 +Defined in: [packages/ai/src/types.ts:769](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L769) + +*** + +### rawText? + +```ts +optional rawText?: string; +``` + +Defined in: [packages/ai/src/types.ts:786](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L786) + +On a `RUN_ERROR`. See `RunErrorEvent.rawText`. + +*** + +### reasoningItem? + +```ts +optional reasoningItem?: boolean; +``` + +Defined in: [packages/ai/src/types.ts:774](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L774) + +See `TanStackMessageMetadata.reasoningItem`. + +*** + +### requestId? + +```ts +optional requestId?: string; +``` + +Defined in: [packages/ai/src/types.ts:790](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L790) + +On a `RUN_ERROR`. See `RunErrorEvent.requestId`. *** @@ -79,7 +127,7 @@ Defined in: packages/ai/src/types.ts:759 optional responseId?: string; ``` -Defined in: packages/ai/src/types.ts:760 +Defined in: [packages/ai/src/types.ts:770](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L770) *** @@ -89,7 +137,7 @@ Defined in: packages/ai/src/types.ts:760 optional responseItems?: object[]; ``` -Defined in: packages/ai/src/types.ts:762 +Defined in: [packages/ai/src/types.ts:772](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L772) The answer items of this model call. See `TanStackMessageMetadata.responseItems`. @@ -113,7 +161,7 @@ optional phase?: string; optional retryAfterMs?: number; ``` -Defined in: packages/ai/src/types.ts:772 +Defined in: [packages/ai/src/types.ts:784](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L784) On a `RUN_ERROR`. See `RunErrorEvent.retryAfterMs`. @@ -125,7 +173,7 @@ On a `RUN_ERROR`. See `RunErrorEvent.retryAfterMs`. optional runId?: string; ``` -Defined in: packages/ai/src/types.ts:768 +Defined in: [packages/ai/src/types.ts:780](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L780) *** @@ -135,7 +183,7 @@ Defined in: packages/ai/src/types.ts:768 optional sessionId?: string; ``` -Defined in: packages/ai/src/types.ts:769 +Defined in: [packages/ai/src/types.ts:781](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L781) *** @@ -145,7 +193,7 @@ Defined in: packages/ai/src/types.ts:769 optional source?: MessageSource; ``` -Defined in: packages/ai/src/types.ts:758 +Defined in: [packages/ai/src/types.ts:768](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L768) *** @@ -155,7 +203,7 @@ Defined in: packages/ai/src/types.ts:758 optional state?: ToolOutputState; ``` -Defined in: packages/ai/src/types.ts:773 +Defined in: [packages/ai/src/types.ts:791](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L791) *** @@ -165,7 +213,7 @@ Defined in: packages/ai/src/types.ts:773 optional threadId?: string; ``` -Defined in: packages/ai/src/types.ts:767 +Defined in: [packages/ai/src/types.ts:779](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L779) *** @@ -175,6 +223,6 @@ Defined in: packages/ai/src/types.ts:767 optional usage?: TokenUsageLeftover; ``` -Defined in: packages/ai/src/types.ts:765 +Defined in: [packages/ai/src/types.ts:777](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L777) TokenUsage fields that have no AG-UI `usage[]` equivalent. diff --git a/docs/reference/interfaces/TextAdapter.md b/docs/reference/interfaces/TextAdapter.md index 58d66d7d0a..d4c429c887 100644 --- a/docs/reference/interfaces/TextAdapter.md +++ b/docs/reference/interfaces/TextAdapter.md @@ -3,7 +3,7 @@ id: TextAdapter title: TextAdapter --- -Defined in: packages/ai/src/activities/chat/adapter.ts:75 +Defined in: [packages/ai/src/activities/chat/adapter.ts:75](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/adapter.ts#L75) Text adapter interface with pre-resolved generics. @@ -64,7 +64,7 @@ Generic parameters: ~types: object; ``` -Defined in: packages/ai/src/activities/chat/adapter.ts:133 +Defined in: [packages/ai/src/activities/chat/adapter.ts:134](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/adapter.ts#L134) **`Internal`** @@ -125,7 +125,7 @@ toolCapabilities: TToolCapabilities; readonly optional api?: string; ``` -Defined in: packages/ai/src/activities/chat/adapter.ts:90 +Defined in: [packages/ai/src/activities/chat/adapter.ts:90](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/adapter.ts#L90) Wire API identity. Defaults to the adapter kind when omitted. @@ -137,7 +137,7 @@ Wire API identity. Defaults to the adapter kind when omitted. chatStream: (options) => AsyncIterable; ``` -Defined in: packages/ai/src/activities/chat/adapter.ts:152 +Defined in: [packages/ai/src/activities/chat/adapter.ts:153](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/adapter.ts#L153) Stream text completions from the model @@ -159,7 +159,7 @@ Stream text completions from the model optional combinedStructuredOutputSource?: (modelOptions?) => "text" | "event"; ``` -Defined in: packages/ai/src/activities/chat/adapter.ts:227 +Defined in: [packages/ai/src/activities/chat/adapter.ts:228](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/adapter.ts#L228) Where native-combined structured output is taken from. @@ -191,7 +191,7 @@ optional compact?: (options) => Promise[]>; ``` -Defined in: packages/ai/src/activities/chat/adapter.ts:192 +Defined in: [packages/ai/src/activities/chat/adapter.ts:193](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/adapter.ts#L193) Compact the history with the provider's own compaction endpoint. Resolves to the history to send from the next call on. It can hold @@ -219,7 +219,7 @@ without native compaction omit it. readonly optional inputModalities?: readonly ("text" | "image" | "audio" | "video" | "document")[]; ``` -Defined in: packages/ai/src/activities/chat/adapter.ts:120 +Defined in: [packages/ai/src/activities/chat/adapter.ts:120](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/adapter.ts#L120) The input kinds the model reads, at runtime, from the provider's model metadata. `undefined` means not known. This mirrors the type-level @@ -234,7 +234,7 @@ keeps model lookups assignable under `exactOptionalPropertyTypes`. readonly kind: "text"; ``` -Defined in: packages/ai/src/activities/chat/adapter.ts:86 +Defined in: [packages/ai/src/activities/chat/adapter.ts:86](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/adapter.ts#L86) Discriminator for adapter kind @@ -246,12 +246,13 @@ Discriminator for adapter kind readonly optional midConversationChannels?: MidConversationChannels; ``` -Defined in: packages/ai/src/activities/chat/adapter.ts:128 +Defined in: [packages/ai/src/activities/chat/adapter.ts:129](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/adapter.ts#L129) The mid-conversation channels of the model: tools and system prompts added between model calls can go out with no change to the cached prompt prefix. `chat()` passes `TextOptions.midConversationChanges` only when a -channel is on. `undefined` means no channels. +channel is on. `undefined` means no channels. `| undefined` keeps the +base class assignable under `exactOptionalPropertyTypes`. *** @@ -261,7 +262,7 @@ channel is on. `undefined` means no channels. readonly model: TModel; ``` -Defined in: packages/ai/src/activities/chat/adapter.ts:94 +Defined in: [packages/ai/src/activities/chat/adapter.ts:94](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/adapter.ts#L94) The model this adapter is configured for @@ -273,7 +274,7 @@ The model this adapter is configured for readonly name: string; ``` -Defined in: packages/ai/src/activities/chat/adapter.ts:88 +Defined in: [packages/ai/src/activities/chat/adapter.ts:88](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/adapter.ts#L88) Provider name identifier (e.g., 'openai', 'anthropic') @@ -285,7 +286,7 @@ Provider name identifier (e.g., 'openai', 'anthropic') readonly optional provider?: string; ``` -Defined in: packages/ai/src/activities/chat/adapter.ts:92 +Defined in: [packages/ai/src/activities/chat/adapter.ts:92](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/adapter.ts#L92) Provider identity. Defaults to `name` when omitted. @@ -297,7 +298,7 @@ Provider identity. Defaults to `name` when omitted. readonly optional requires?: readonly CapabilityHandle[]; ``` -Defined in: packages/ai/src/activities/chat/adapter.ts:103 +Defined in: [packages/ai/src/activities/chat/adapter.ts:103](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/adapter.ts#L103) Capabilities this adapter requires at runtime. `chat()` validates that the configured middleware provides each one. Model adapters omit this; harness @@ -313,7 +314,7 @@ this is the declaration/validation surface only. structuredOutput: (options) => Promise>; ``` -Defined in: packages/ai/src/activities/chat/adapter.ts:164 +Defined in: [packages/ai/src/activities/chat/adapter.ts:165](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/adapter.ts#L165) Generate structured output using the provider's native structured output API. This method uses stream: false and sends the JSON schema to the provider @@ -341,7 +342,7 @@ Promise with the raw data (validation is done in the chat function) optional structuredOutputStream?: (options) => AsyncIterable; ``` -Defined in: packages/ai/src/activities/chat/adapter.ts:182 +Defined in: [packages/ai/src/activities/chat/adapter.ts:183](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/adapter.ts#L183) Stream structured output using the provider's native streaming structured output API (stream + response_format json_schema in a single request). @@ -374,7 +375,7 @@ their timestamps follow stream order. optional supportsCombinedToolsAndSchema?: (modelOptions?) => boolean; ``` -Defined in: packages/ai/src/activities/chat/adapter.ts:213 +Defined in: [packages/ai/src/activities/chat/adapter.ts:214](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/adapter.ts#L214) Declares whether the adapter supports combining `tools` and a schema-constrained final answer in a single streaming request. @@ -412,7 +413,7 @@ answer per-request. Most adapters can return a constant. readonly optional supportsFileSources?: boolean; ``` -Defined in: packages/ai/src/activities/chat/adapter.ts:112 +Defined in: [packages/ai/src/activities/chat/adapter.ts:112](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/adapter.ts#L112) Declares that this adapter can consume `{ type: 'file' }` content sources (provider Files API references). `chat()` rejects file sources in preflight diff --git a/docs/reference/interfaces/TextCompactOptions.md b/docs/reference/interfaces/TextCompactOptions.md index 85acbd2058..f9ba2d9f94 100644 --- a/docs/reference/interfaces/TextCompactOptions.md +++ b/docs/reference/interfaces/TextCompactOptions.md @@ -3,7 +3,7 @@ id: TextCompactOptions title: TextCompactOptions --- -Defined in: packages/ai/src/types.ts:1530 +Defined in: [packages/ai/src/types.ts:1570](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1570) What `TextAdapter.compact` receives. @@ -18,7 +18,7 @@ messages: ModelMessage< | null>[]; ``` -Defined in: packages/ai/src/types.ts:1532 +Defined in: [packages/ai/src/types.ts:1572](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1572) The history to compact. @@ -30,7 +30,7 @@ The history to compact. model: string; ``` -Defined in: packages/ai/src/types.ts:1533 +Defined in: [packages/ai/src/types.ts:1573](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1573) *** @@ -40,7 +40,7 @@ Defined in: packages/ai/src/types.ts:1533 optional signal?: AbortSignal; ``` -Defined in: packages/ai/src/types.ts:1534 +Defined in: [packages/ai/src/types.ts:1574](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1574) *** @@ -50,7 +50,7 @@ Defined in: packages/ai/src/types.ts:1534 optional systemPrompts?: SystemPrompt[]; ``` -Defined in: packages/ai/src/types.ts:1538 +Defined in: [packages/ai/src/types.ts:1578](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1578) The system prompts of the chat call. @@ -62,6 +62,6 @@ The system prompts of the chat call. optional wrapFetch?: FetchWrapper; ``` -Defined in: packages/ai/src/types.ts:1536 +Defined in: [packages/ai/src/types.ts:1576](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1576) Wraps the fetch of the compaction request. diff --git a/docs/reference/interfaces/TextCompletionChunk.md b/docs/reference/interfaces/TextCompletionChunk.md index 2ac523c96e..6307f20020 100644 --- a/docs/reference/interfaces/TextCompletionChunk.md +++ b/docs/reference/interfaces/TextCompletionChunk.md @@ -3,7 +3,7 @@ id: TextCompletionChunk title: TextCompletionChunk --- -Defined in: packages/ai/src/types.ts:2129 +Defined in: [packages/ai/src/types.ts:2187](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2187) ## Properties @@ -13,7 +13,7 @@ Defined in: packages/ai/src/types.ts:2129 content: string; ``` -Defined in: packages/ai/src/types.ts:2132 +Defined in: [packages/ai/src/types.ts:2190](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2190) *** @@ -23,7 +23,7 @@ Defined in: packages/ai/src/types.ts:2132 optional finishReason?: "length" | "stop" | "content_filter" | null; ``` -Defined in: packages/ai/src/types.ts:2134 +Defined in: [packages/ai/src/types.ts:2192](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2192) *** @@ -33,7 +33,7 @@ Defined in: packages/ai/src/types.ts:2134 id: string; ``` -Defined in: packages/ai/src/types.ts:2130 +Defined in: [packages/ai/src/types.ts:2188](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2188) *** @@ -43,7 +43,7 @@ Defined in: packages/ai/src/types.ts:2130 model: string; ``` -Defined in: packages/ai/src/types.ts:2131 +Defined in: [packages/ai/src/types.ts:2189](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2189) *** @@ -53,7 +53,7 @@ Defined in: packages/ai/src/types.ts:2131 optional role?: "assistant"; ``` -Defined in: packages/ai/src/types.ts:2133 +Defined in: [packages/ai/src/types.ts:2191](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2191) *** @@ -63,4 +63,4 @@ Defined in: packages/ai/src/types.ts:2133 optional usage?: TokenUsage; ``` -Defined in: packages/ai/src/types.ts:2135 +Defined in: [packages/ai/src/types.ts:2193](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2193) diff --git a/docs/reference/interfaces/TextMessageChunkEvent.md b/docs/reference/interfaces/TextMessageChunkEvent.md index e76eef2e82..59dd5d3e22 100644 --- a/docs/reference/interfaces/TextMessageChunkEvent.md +++ b/docs/reference/interfaces/TextMessageChunkEvent.md @@ -3,7 +3,7 @@ id: TextMessageChunkEvent title: TextMessageChunkEvent --- -Defined in: packages/ai/src/types.ts:2023 +Defined in: [packages/ai/src/types.ts:2081](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2081) AG-UI 1.0 TextMessageChunkEvent shape. diff --git a/docs/reference/interfaces/TextMessageContentEvent.md b/docs/reference/interfaces/TextMessageContentEvent.md index c5c3407700..4699294b67 100644 --- a/docs/reference/interfaces/TextMessageContentEvent.md +++ b/docs/reference/interfaces/TextMessageContentEvent.md @@ -3,7 +3,7 @@ id: TextMessageContentEvent title: TextMessageContentEvent --- -Defined in: packages/ai/src/types.ts:1658 +Defined in: [packages/ai/src/types.ts:1716](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1716) Emitted when text content is generated (streaming tokens). diff --git a/docs/reference/interfaces/TextMessageEndEvent.md b/docs/reference/interfaces/TextMessageEndEvent.md index dcbf009b2b..1fb7497633 100644 --- a/docs/reference/interfaces/TextMessageEndEvent.md +++ b/docs/reference/interfaces/TextMessageEndEvent.md @@ -3,7 +3,7 @@ id: TextMessageEndEvent title: TextMessageEndEvent --- -Defined in: packages/ai/src/types.ts:1665 +Defined in: [packages/ai/src/types.ts:1723](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1723) Emitted when a text message completes. diff --git a/docs/reference/interfaces/TextMessageStartEvent.md b/docs/reference/interfaces/TextMessageStartEvent.md index 0221cc91ee..1e278e38b3 100644 --- a/docs/reference/interfaces/TextMessageStartEvent.md +++ b/docs/reference/interfaces/TextMessageStartEvent.md @@ -3,7 +3,7 @@ id: TextMessageStartEvent title: TextMessageStartEvent --- -Defined in: packages/ai/src/types.ts:1651 +Defined in: [packages/ai/src/types.ts:1709](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1709) Emitted when a text message starts. diff --git a/docs/reference/interfaces/TextOptions.md b/docs/reference/interfaces/TextOptions.md index acf7b46046..5efb79c920 100644 --- a/docs/reference/interfaces/TextOptions.md +++ b/docs/reference/interfaces/TextOptions.md @@ -3,7 +3,7 @@ id: TextOptions title: TextOptions --- -Defined in: packages/ai/src/types.ts:1306 +Defined in: [packages/ai/src/types.ts:1346](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1346) Options passed into the SDK and further piped to the AI provider. @@ -29,7 +29,7 @@ Options passed into the SDK and further piped to the AI provider. optional abortController?: AbortController; ``` -Defined in: packages/ai/src/types.ts:1434 +Defined in: [packages/ai/src/types.ts:1474](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1474) AbortController for request cancellation. @@ -56,7 +56,7 @@ https://developer.mozilla.org/en-US/docs/Web/API/AbortController optional agentLoopStrategy?: AgentLoopStrategy; ``` -Defined in: packages/ai/src/types.ts:1334 +Defined in: [packages/ai/src/types.ts:1374](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1374) *** @@ -66,7 +66,7 @@ Defined in: packages/ai/src/types.ts:1334 optional approvals?: ReadonlyMap; ``` -Defined in: packages/ai/src/types.ts:1526 +Defined in: [packages/ai/src/types.ts:1566](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1566) Client approval decisions for this run, keyed by approval id. The engine populates this from approvals carried on the incoming messages. Harness @@ -82,7 +82,7 @@ here). Undefined for direct adapter usage outside the chat engine. optional capabilities?: CapabilityContext; ``` -Defined in: packages/ai/src/types.ts:1517 +Defined in: [packages/ai/src/types.ts:1557](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1557) Middleware capability context for this run. The engine populates it with the live middleware context so harness adapters that declare @@ -99,7 +99,7 @@ direct adapter usage outside the chat engine. optional context?: TContext; ``` -Defined in: packages/ai/src/types.ts:1318 +Defined in: [packages/ai/src/types.ts:1358](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1358) Runtime context provided by the caller and passed to middleware and server-side tool implementations. @@ -112,7 +112,7 @@ server-side tool implementations. optional lazyToolsConfig?: LazyToolsConfig; ``` -Defined in: packages/ai/src/types.ts:1372 +Defined in: [packages/ai/src/types.ts:1412](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1412) Optional configuration for lazy-tool discovery (tools marked `lazy: true`). Tunes how much of each lazy tool's description appears in the discovery @@ -126,7 +126,7 @@ catalog. Optional — defaults to `{ includeDescription: 'none' }`. logger: InternalLogger; ``` -Defined in: packages/ai/src/types.ts:1441 +Defined in: [packages/ai/src/types.ts:1481](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1481) Internal logger threaded from the chat entry point. Adapter implementations must call `logger.request()` before SDK calls, `logger.provider()` for each @@ -143,7 +143,7 @@ messages: ModelMessage< | null>[]; ``` -Defined in: packages/ai/src/types.ts:1312 +Defined in: [packages/ai/src/types.ts:1352](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1352) *** @@ -153,7 +153,7 @@ Defined in: packages/ai/src/types.ts:1312 optional metadata?: Record; ``` -Defined in: packages/ai/src/types.ts:1383 +Defined in: [packages/ai/src/types.ts:1423](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1423) Observability metadata attached to this call. Surfaced to middleware, devtools, and the event client; values may be arbitrarily structured @@ -172,7 +172,7 @@ OpenAI's and OpenRouter's `metadata` are both Record). optional midConversationChanges?: MidConversationChanges; ``` -Defined in: packages/ai/src/types.ts:1482 +Defined in: [packages/ai/src/types.ts:1522](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1522) The tools and system prompts that changed between model calls. The engine sets it only when `adapter.midConversationChannels` has a channel @@ -188,7 +188,7 @@ Adapters resolve it with `splitMidConversationChanges`. model: string; ``` -Defined in: packages/ai/src/types.ts:1311 +Defined in: [packages/ai/src/types.ts:1351](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1351) *** @@ -198,7 +198,7 @@ Defined in: packages/ai/src/types.ts:1311 optional modelOptions?: TProviderOptionsForModel; ``` -Defined in: packages/ai/src/types.ts:1384 +Defined in: [packages/ai/src/types.ts:1424](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1424) *** @@ -208,7 +208,7 @@ Defined in: packages/ai/src/types.ts:1384 optional outputSchema?: SchemaInput; ``` -Defined in: packages/ai/src/types.ts:1420 +Defined in: [packages/ai/src/types.ts:1460](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1460) Schema for structured output. @@ -243,7 +243,7 @@ Schema for structured output. optional parentRunId?: string; ``` -Defined in: packages/ai/src/types.ts:1463 +Defined in: [packages/ai/src/types.ts:1503](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1503) Parent run ID for AG-UI protocol nested run correlation. Surfaced for observability/middleware; not consumed by the LLM call. @@ -256,7 +256,7 @@ Surfaced for observability/middleware; not consumed by the LLM call. optional parentSubagentRunId?: string; ``` -Defined in: packages/ai/src/types.ts:1498 +Defined in: [packages/ai/src/types.ts:1538](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1538) The subagentRunId of the child that started this one, for a nested child. Middleware reads it as `ctx.parentSubagentRunId`. @@ -269,7 +269,7 @@ Middleware reads it as `ctx.parentSubagentRunId`. optional promptCache?: ResolvedPromptCache; ``` -Defined in: packages/ai/src/types.ts:1452 +Defined in: [packages/ai/src/types.ts:1492](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1492) Automatic prompt caching for this request. `chat()` sets it. When it is absent, the adapter adds no automatic cache fields. @@ -282,7 +282,7 @@ absent, the adapter adds no automatic cache fields. optional reasoning?: ReasoningRequest; ``` -Defined in: packages/ai/src/types.ts:1391 +Defined in: [packages/ai/src/types.ts:1431](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1431) How hard the model thinks, normalized by `chat()`. `undefined`: the user did not ask, so the adapter sends nothing and the provider default applies. @@ -297,7 +297,7 @@ wire field. optional repairToolInput?: false | ((context) => unknown); ``` -Defined in: packages/ai/src/types.ts:1347 +Defined in: [packages/ai/src/types.ts:1387](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1387) How a tool input that fails the final check is repaired. By default, common model mistakes such as `"5"` for a number are repaired against the @@ -313,7 +313,7 @@ validation error to the model. optional request?: Request | RequestInit; ``` -Defined in: packages/ai/src/types.ts:1392 +Defined in: [packages/ai/src/types.ts:1432](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1432) *** @@ -323,7 +323,7 @@ Defined in: packages/ai/src/types.ts:1392 optional resume?: RunAgentResumeItem[]; ``` -Defined in: packages/ai/src/types.ts:1507 +Defined in: [packages/ai/src/types.ts:1547](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1547) AG-UI interrupt resume responses supplied by the client on a follow-up run. A first-party generic item carries the original request in `metadata`. @@ -336,7 +336,7 @@ A first-party generic item carries the original request in `metadata`. optional retry?: object; ``` -Defined in: packages/ai/src/types.ts:1357 +Defined in: [packages/ai/src/types.ts:1397](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1397) Retry a model call when the provider error has a wait time (usually a 429). `chat()` waits for the `retryAfterMs` time of the `RUN_ERROR`, then @@ -370,7 +370,7 @@ Longest wait time to accept, in milliseconds. Default 60 000. optional runId?: string; ``` -Defined in: packages/ai/src/types.ts:1458 +Defined in: [packages/ai/src/types.ts:1498](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1498) Run ID for AG-UI protocol run correlation. When provided, this will be used in RunStartedEvent and RunFinishedEvent. @@ -384,7 +384,7 @@ If not provided, a unique ID will be generated. optional state?: unknown; ``` -Defined in: packages/ai/src/types.ts:1501 +Defined in: [packages/ai/src/types.ts:1541](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1541) Application state mirrored in a STATE_SNAPSHOT before an interrupt terminal. @@ -396,7 +396,7 @@ Application state mirrored in a STATE_SNAPSHOT before an interrupt terminal. optional subagentName?: string; ``` -Defined in: packages/ai/src/types.ts:1493 +Defined in: [packages/ai/src/types.ts:1533](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1533) The agent name when this chat runs as a subagent. Middleware reads it as `ctx.subagentName`. @@ -409,7 +409,7 @@ The agent name when this chat runs as a subagent. Middleware reads it as optional subagentRunId?: string; ``` -Defined in: packages/ai/src/types.ts:1488 +Defined in: [packages/ai/src/types.ts:1528](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1528) AG-UI subagent run id when this chat runs as a child of another run. A child `chat()` passes `ctx.subagentRunId`. Middleware reads it as @@ -423,7 +423,7 @@ A child `chat()` passes `ctx.subagentRunId`. Middleware reads it as optional systemPrompts?: SystemPrompt[]; ``` -Defined in: packages/ai/src/types.ts:1333 +Defined in: [packages/ai/src/types.ts:1373](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1373) System prompts to include with the request. @@ -448,7 +448,7 @@ SystemPrompt threadId: string; ``` -Defined in: packages/ai/src/types.ts:1447 +Defined in: [packages/ai/src/types.ts:1487](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1487) Thread ID for AG-UI protocol run correlation. Required. It is used in RunStartedEvent and RunFinishedEvent. @@ -461,7 +461,7 @@ RunStartedEvent and RunFinishedEvent. optional toolChoice?: ToolChoice; ``` -Defined in: packages/ai/src/types.ts:1468 +Defined in: [packages/ai/src/types.ts:1508](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1508) How the model uses the tools of this request. `chat()` sets it only when the request has tools. A provider value in `modelOptions` wins over it. @@ -474,7 +474,7 @@ the request has tools. A provider value in `modelOptions` wins over it. optional toolExecution?: "parallel" | "sequential"; ``` -Defined in: packages/ai/src/types.ts:1339 +Defined in: [packages/ai/src/types.ts:1379](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1379) How the server tools of one model turn run. `'parallel'` (the default) starts them together, and `'sequential'` runs them one at a time. @@ -487,7 +487,7 @@ starts them together, and `'sequential'` runs them one at a time. optional tools?: AnyTool[]; ``` -Defined in: packages/ai/src/types.ts:1313 +Defined in: [packages/ai/src/types.ts:1353](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1353) *** @@ -497,7 +497,7 @@ Defined in: packages/ai/src/types.ts:1313 optional wrapFetch?: FetchWrapper; ``` -Defined in: packages/ai/src/types.ts:1474 +Defined in: [packages/ai/src/types.ts:1514](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1514) Wraps the fetch of this request. The engine composes the `chat()` option and the middleware wrappers into one function. An adapter that supports diff --git a/docs/reference/interfaces/TextPart.md b/docs/reference/interfaces/TextPart.md index 36c94a7e07..89694d7a3e 100644 --- a/docs/reference/interfaces/TextPart.md +++ b/docs/reference/interfaces/TextPart.md @@ -3,7 +3,7 @@ id: TextPart title: TextPart --- -Defined in: packages/ai/src/types.ts:488 +Defined in: [packages/ai/src/types.ts:491](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L491) Message parts - building blocks of UIMessage @@ -21,7 +21,7 @@ Message parts - building blocks of UIMessage content: string; ``` -Defined in: packages/ai/src/types.ts:490 +Defined in: [packages/ai/src/types.ts:493](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L493) *** @@ -31,7 +31,7 @@ Defined in: packages/ai/src/types.ts:490 optional metadata?: TMetadata; ``` -Defined in: packages/ai/src/types.ts:491 +Defined in: [packages/ai/src/types.ts:494](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L494) *** @@ -41,4 +41,4 @@ Defined in: packages/ai/src/types.ts:491 type: "text"; ``` -Defined in: packages/ai/src/types.ts:489 +Defined in: [packages/ai/src/types.ts:492](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L492) diff --git a/docs/reference/interfaces/ThinkingPart.md b/docs/reference/interfaces/ThinkingPart.md index c3c39f0e9b..155951e43c 100644 --- a/docs/reference/interfaces/ThinkingPart.md +++ b/docs/reference/interfaces/ThinkingPart.md @@ -3,7 +3,7 @@ id: ThinkingPart title: ThinkingPart --- -Defined in: packages/ai/src/types.ts:538 +Defined in: [packages/ai/src/types.ts:541](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L541) ## Properties @@ -13,7 +13,7 @@ Defined in: packages/ai/src/types.ts:538 content: string; ``` -Defined in: packages/ai/src/types.ts:540 +Defined in: [packages/ai/src/types.ts:543](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L543) *** @@ -23,7 +23,7 @@ Defined in: packages/ai/src/types.ts:540 optional redacted?: boolean; ``` -Defined in: packages/ai/src/types.ts:555 +Defined in: [packages/ai/src/types.ts:558](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L558) The provider encrypted this thinking block (Anthropic `redacted_thinking`). `content` is empty, and `signature` holds the opaque data that goes back @@ -38,7 +38,7 @@ starts with `redacted_thinking-` instead. optional signature?: string; ``` -Defined in: packages/ai/src/types.ts:548 +Defined in: [packages/ai/src/types.ts:551](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L551) The provider's opaque reasoning artefact, sent back unchanged: an Anthropic signature, Anthropic redacted data, or OpenAI encrypted content. @@ -53,7 +53,7 @@ Renaming breaks stored messages, so it needs a read shim for `signature`. optional stepId?: string; ``` -Defined in: packages/ai/src/types.ts:541 +Defined in: [packages/ai/src/types.ts:544](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L544) *** @@ -63,4 +63,4 @@ Defined in: packages/ai/src/types.ts:541 type: "thinking"; ``` -Defined in: packages/ai/src/types.ts:539 +Defined in: [packages/ai/src/types.ts:542](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L542) diff --git a/docs/reference/interfaces/Tool.md b/docs/reference/interfaces/Tool.md index a96cfa9ea6..4599ea4ff5 100644 --- a/docs/reference/interfaces/Tool.md +++ b/docs/reference/interfaces/Tool.md @@ -3,7 +3,7 @@ id: Tool title: Tool --- -Defined in: packages/ai/src/types.ts:965 +Defined in: [packages/ai/src/types.ts:1005](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1005) Tool/Function definition for function calling. @@ -51,7 +51,7 @@ or plain JSON Schema objects for runtime validation and type safety. description: string; ``` -Defined in: packages/ai/src/types.ts:989 +Defined in: [packages/ai/src/types.ts:1029](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1029) Clear description of what the tool does. @@ -72,7 +72,7 @@ Be specific about what the tool does, what parameters it needs, and what it retu optional execute?: ToolExecuteFunction; ``` -Defined in: packages/ai/src/types.ts:1069 +Defined in: [packages/ai/src/types.ts:1109](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1109) Optional function to execute when the model calls this tool. @@ -108,7 +108,7 @@ execute: async (args) => { optional inputSchema?: TInput; ``` -Defined in: packages/ai/src/types.ts:1029 +Defined in: [packages/ai/src/types.ts:1069](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1069) Schema describing the tool's input parameters. @@ -162,7 +162,7 @@ type({ optional lazy?: boolean; ``` -Defined in: packages/ai/src/types.ts:1075 +Defined in: [packages/ai/src/types.ts:1115](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1115) If true, this tool is lazy and will only be sent to the LLM after being discovered via the lazy tool discovery mechanism. Works with both chat() (the synthetic discovery tool) and Code Mode (kept out of the system prompt and revealed via discover_tools). @@ -174,7 +174,7 @@ If true, this tool is lazy and will only be sent to the LLM after being discover optional metadata?: Record; ``` -Defined in: packages/ai/src/types.ts:1086 +Defined in: [packages/ai/src/types.ts:1126](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1126) Additional metadata for adapters or custom extensions @@ -186,7 +186,7 @@ Additional metadata for adapters or custom extensions name: TName; ``` -Defined in: packages/ai/src/types.ts:979 +Defined in: [packages/ai/src/types.ts:1019](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1019) Unique name of the tool (used by the model to call it). @@ -207,7 +207,7 @@ Must be unique within the tools array. optional needsApproval?: boolean; ``` -Defined in: packages/ai/src/types.ts:1072 +Defined in: [packages/ai/src/types.ts:1112](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1112) If true, tool execution requires user approval before running. Works with both server and client tools. @@ -219,7 +219,7 @@ If true, tool execution requires user approval before running. Works with both s optional outputSchema?: TOutput; ``` -Defined in: packages/ai/src/types.ts:1050 +Defined in: [packages/ai/src/types.ts:1090](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1090) Optional schema for validating tool output. @@ -250,7 +250,7 @@ z.object({ optional replay?: "safe" | "never"; ``` -Defined in: packages/ai/src/types.ts:1083 +Defined in: [packages/ai/src/types.ts:1123](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1123) Whether a host may run this tool again after a crash cut the run between the call and its result. `'safe'` runs it again. Omit the diff --git a/docs/reference/interfaces/ToolCall.md b/docs/reference/interfaces/ToolCall.md index e5dce6fd16..288903993c 100644 --- a/docs/reference/interfaces/ToolCall.md +++ b/docs/reference/interfaces/ToolCall.md @@ -3,7 +3,7 @@ id: ToolCall title: ToolCall --- -Defined in: packages/ai/src/types.ts:194 +Defined in: [packages/ai/src/types.ts:197](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L197) AG-UI `ToolCall` with typed metadata. `function.arguments` is a JSON string. @@ -25,7 +25,7 @@ AG-UI `ToolCall` with typed metadata. `function.arguments` is a JSON string. optional metadata?: TMetadata; ``` -Defined in: packages/ai/src/types.ts:201 +Defined in: [packages/ai/src/types.ts:204](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L204) Provider-specific metadata to carry through the tool call lifecycle. Typed per-adapter via `TToolCallMetadata`. For example, diff --git a/docs/reference/interfaces/ToolCallArgsEvent.md b/docs/reference/interfaces/ToolCallArgsEvent.md index c928a2899a..3f2191375f 100644 --- a/docs/reference/interfaces/ToolCallArgsEvent.md +++ b/docs/reference/interfaces/ToolCallArgsEvent.md @@ -3,7 +3,7 @@ id: ToolCallArgsEvent title: ToolCallArgsEvent --- -Defined in: packages/ai/src/types.ts:1687 +Defined in: [packages/ai/src/types.ts:1745](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1745) Emitted when tool call arguments are streaming. diff --git a/docs/reference/interfaces/ToolCallChunkEvent.md b/docs/reference/interfaces/ToolCallChunkEvent.md index 7cde7a1c40..3cad8abb84 100644 --- a/docs/reference/interfaces/ToolCallChunkEvent.md +++ b/docs/reference/interfaces/ToolCallChunkEvent.md @@ -3,7 +3,7 @@ id: ToolCallChunkEvent title: ToolCallChunkEvent --- -Defined in: packages/ai/src/types.ts:2026 +Defined in: [packages/ai/src/types.ts:2084](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2084) AG-UI 1.0 ToolCallChunkEvent shape. diff --git a/docs/reference/interfaces/ToolCallEndEvent.md b/docs/reference/interfaces/ToolCallEndEvent.md index 41f2dc2a5e..d13835a295 100644 --- a/docs/reference/interfaces/ToolCallEndEvent.md +++ b/docs/reference/interfaces/ToolCallEndEvent.md @@ -3,7 +3,7 @@ id: ToolCallEndEvent title: ToolCallEndEvent --- -Defined in: packages/ai/src/types.ts:1694 +Defined in: [packages/ai/src/types.ts:1752](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1752) Emitted when a tool call completes. @@ -21,7 +21,7 @@ Emitted when a tool call completes. optional input?: unknown; ``` -Defined in: packages/ai/src/types.ts:1697 +Defined in: [packages/ai/src/types.ts:1755](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1755) Parsed tool arguments when the adapter already parsed them. @@ -33,7 +33,7 @@ Parsed tool arguments when the adapter already parsed them. optional metadata?: Record; ``` -Defined in: packages/ai/src/types.ts:1698 +Defined in: [packages/ai/src/types.ts:1756](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1756) Extra information attached to this event. @@ -51,4 +51,4 @@ Omit.metadata type: "TOOL_CALL_END"; ``` -Defined in: packages/ai/src/types.ts:1695 +Defined in: [packages/ai/src/types.ts:1753](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1753) diff --git a/docs/reference/interfaces/ToolCallHookContext.md b/docs/reference/interfaces/ToolCallHookContext.md index 73e4d348e3..31124169a4 100644 --- a/docs/reference/interfaces/ToolCallHookContext.md +++ b/docs/reference/interfaces/ToolCallHookContext.md @@ -3,9 +3,10 @@ id: ToolCallHookContext title: ToolCallHookContext --- -Defined in: packages/ai/src/activities/chat/middleware/types.ts:430 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:445](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L445) -Context provided to tool call hooks (onBeforeToolCall / onAfterToolCall). +Context provided to tool call hooks (onBeforeToolCall / onGuardToolCall / +onAfterToolCall). ## Properties @@ -15,10 +16,11 @@ Context provided to tool call hooks (onBeforeToolCall / onAfterToolCall). args: unknown; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:439 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:455](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L455) Parsed arguments for the tool call, before the `inputSchema` check: no -schema defaults or transforms yet, and possibly invalid. +schema defaults or transforms yet, and possibly invalid. In +`onGuardToolCall`, these are the final checked arguments. *** @@ -30,7 +32,7 @@ tool: | undefined; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:434 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:449](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L449) The resolved tool definition, if found @@ -42,7 +44,7 @@ The resolved tool definition, if found toolCall: ToolCall; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:432 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:447](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L447) The tool call being executed @@ -54,7 +56,7 @@ The tool call being executed toolCallId: string; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:443 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:459](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L459) ID of the tool call @@ -66,6 +68,6 @@ ID of the tool call toolName: string; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:441 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:457](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L457) Name of the tool diff --git a/docs/reference/interfaces/ToolCallPart.md b/docs/reference/interfaces/ToolCallPart.md index 360362921f..e1d135359e 100644 --- a/docs/reference/interfaces/ToolCallPart.md +++ b/docs/reference/interfaces/ToolCallPart.md @@ -3,7 +3,7 @@ id: ToolCallPart title: ToolCallPart --- -Defined in: packages/ai/src/types.ts:494 +Defined in: [packages/ai/src/types.ts:497](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L497) ## Type Parameters @@ -19,7 +19,7 @@ Defined in: packages/ai/src/types.ts:494 optional approval?: object; ``` -Defined in: packages/ai/src/types.ts:510 +Defined in: [packages/ai/src/types.ts:513](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L513) Approval metadata if tool requires user approval @@ -49,7 +49,7 @@ needsApproval: boolean; arguments: string; ``` -Defined in: packages/ai/src/types.ts:498 +Defined in: [packages/ai/src/types.ts:501](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L501) *** @@ -59,7 +59,7 @@ Defined in: packages/ai/src/types.ts:498 id: string; ``` -Defined in: packages/ai/src/types.ts:496 +Defined in: [packages/ai/src/types.ts:499](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L499) *** @@ -69,7 +69,7 @@ Defined in: packages/ai/src/types.ts:496 optional input?: unknown; ``` -Defined in: packages/ai/src/types.ts:507 +Defined in: [packages/ai/src/types.ts:510](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L510) Parsed tool input. Set from the parsed arguments once they are complete (`state: 'input-complete'` and later). `undefined` while the raw @@ -86,7 +86,7 @@ available as a fallback. Typed per-tool on the client `ToolCallPart` (see optional metadata?: TMetadata; ``` -Defined in: packages/ai/src/types.ts:521 +Defined in: [packages/ai/src/types.ts:524](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L524) Provider-specific metadata that round-trips with the tool call. Typed per-adapter via `TToolCallMetadata`. May follow the @@ -101,7 +101,7 @@ server tools (e.g. Anthropic `web_search`). name: string; ``` -Defined in: packages/ai/src/types.ts:497 +Defined in: [packages/ai/src/types.ts:500](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L500) *** @@ -111,7 +111,7 @@ Defined in: packages/ai/src/types.ts:497 optional output?: any; ``` -Defined in: packages/ai/src/types.ts:516 +Defined in: [packages/ai/src/types.ts:519](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L519) Tool execution output (for client tools or after approval) @@ -123,7 +123,7 @@ Tool execution output (for client tools or after approval) state: ToolCallState; ``` -Defined in: packages/ai/src/types.ts:508 +Defined in: [packages/ai/src/types.ts:511](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L511) *** @@ -133,4 +133,4 @@ Defined in: packages/ai/src/types.ts:508 type: "tool-call"; ``` -Defined in: packages/ai/src/types.ts:495 +Defined in: [packages/ai/src/types.ts:498](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L498) diff --git a/docs/reference/interfaces/ToolCallResultEvent.md b/docs/reference/interfaces/ToolCallResultEvent.md index 25d162140e..ff2bcbcdf3 100644 --- a/docs/reference/interfaces/ToolCallResultEvent.md +++ b/docs/reference/interfaces/ToolCallResultEvent.md @@ -3,7 +3,7 @@ id: ToolCallResultEvent title: ToolCallResultEvent --- -Defined in: packages/ai/src/types.ts:1706 +Defined in: [packages/ai/src/types.ts:1764](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1764) Emitted when a tool call result is available. diff --git a/docs/reference/interfaces/ToolCallStartEvent.md b/docs/reference/interfaces/ToolCallStartEvent.md index 74968320f5..9767ddfa1e 100644 --- a/docs/reference/interfaces/ToolCallStartEvent.md +++ b/docs/reference/interfaces/ToolCallStartEvent.md @@ -3,7 +3,7 @@ id: ToolCallStartEvent title: ToolCallStartEvent --- -Defined in: packages/ai/src/types.ts:1673 +Defined in: [packages/ai/src/types.ts:1731](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1731) Emitted when a tool call starts. @@ -22,7 +22,7 @@ Emitted when a tool call starts. optional metadata?: Record; ``` -Defined in: packages/ai/src/types.ts:1679 +Defined in: [packages/ai/src/types.ts:1737](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1737) Provider-specific metadata to carry into the ToolCall. @@ -40,4 +40,4 @@ Omit.metadata type: "TOOL_CALL_START"; ``` -Defined in: packages/ai/src/types.ts:1677 +Defined in: [packages/ai/src/types.ts:1735](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1735) diff --git a/docs/reference/interfaces/ToolConfig.md b/docs/reference/interfaces/ToolConfig.md index 66148db223..22117e2bc6 100644 --- a/docs/reference/interfaces/ToolConfig.md +++ b/docs/reference/interfaces/ToolConfig.md @@ -3,7 +3,7 @@ id: ToolConfig title: ToolConfig --- -Defined in: packages/ai/src/types.ts:1109 +Defined in: [packages/ai/src/types.ts:1149](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1149) ## Indexable diff --git a/docs/reference/interfaces/ToolDefinition.md b/docs/reference/interfaces/ToolDefinition.md index 0432c1a8f9..65856b6957 100644 --- a/docs/reference/interfaces/ToolDefinition.md +++ b/docs/reference/interfaces/ToolDefinition.md @@ -3,7 +3,7 @@ id: ToolDefinition title: ToolDefinition --- -Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:241 +Defined in: [packages/ai/src/activities/chat/tools/tool-definition.ts:241](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-definition.ts#L241) Tool definition builder that allows creating server or client tools from a shared definition @@ -43,7 +43,7 @@ Tool definition builder that allows creating server or client tools from a share __toolSide: "definition"; ``` -Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:157 +Defined in: [packages/ai/src/activities/chat/tools/tool-definition.ts:157](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-definition.ts#L157) #### Inherited from @@ -57,7 +57,7 @@ Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:157 readonly optional [toolApprovalCapability]?: object; ``` -Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:165 +Defined in: [packages/ai/src/activities/chat/tools/tool-definition.ts:165](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-definition.ts#L165) #### approvalSchema @@ -83,7 +83,7 @@ needsApproval: TNeedsApproval; approvalSchema: TApprovalSchema; ``` -Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:163 +Defined in: [packages/ai/src/activities/chat/tools/tool-definition.ts:163](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-definition.ts#L163) #### Inherited from @@ -97,7 +97,7 @@ Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:163 client: (execute?) => ClientTool & BuiltToolSchemaFields; ``` -Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:275 +Defined in: [packages/ai/src/activities/chat/tools/tool-definition.ts:275](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-definition.ts#L275) Create a client-side tool with optional execute function. Carries the definition's `needsApproval` literal through to the client @@ -127,7 +127,7 @@ tool so the tool-call part's `approval` field stays gated on it. description: string; ``` -Defined in: packages/ai/src/types.ts:989 +Defined in: [packages/ai/src/types.ts:1029](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1029) Clear description of what the tool does. @@ -154,7 +154,7 @@ optional execute?: (args, context?) => | Promise>; ``` -Defined in: packages/ai/src/types.ts:1069 +Defined in: [packages/ai/src/types.ts:1109](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1109) Optional function to execute when the model calls this tool. @@ -203,7 +203,7 @@ execute: async (args) => { optional execution?: "task"; ``` -Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:164 +Defined in: [packages/ai/src/activities/chat/tools/tool-definition.ts:164](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-definition.ts#L164) #### Inherited from @@ -217,7 +217,7 @@ Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:164 inputSchema: TInput; ``` -Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:160 +Defined in: [packages/ai/src/activities/chat/tools/tool-definition.ts:160](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-definition.ts#L160) Schema describing the tool's input parameters. @@ -275,7 +275,7 @@ type({ optional lazy?: boolean; ``` -Defined in: packages/ai/src/types.ts:1075 +Defined in: [packages/ai/src/types.ts:1115](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1115) If true, this tool is lazy and will only be sent to the LLM after being discovered via the lazy tool discovery mechanism. Works with both chat() (the synthetic discovery tool) and Code Mode (kept out of the system prompt and revealed via discover_tools). @@ -291,7 +291,7 @@ If true, this tool is lazy and will only be sent to the LLM after being discover optional metadata?: Record; ``` -Defined in: packages/ai/src/types.ts:1086 +Defined in: [packages/ai/src/types.ts:1126](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1126) Additional metadata for adapters or custom extensions @@ -307,7 +307,7 @@ Additional metadata for adapters or custom extensions name: TName; ``` -Defined in: packages/ai/src/types.ts:979 +Defined in: [packages/ai/src/types.ts:1019](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1019) Unique name of the tool (used by the model to call it). @@ -332,7 +332,7 @@ Must be unique within the tools array. optional needsApproval?: TNeedsApproval; ``` -Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:162 +Defined in: [packages/ai/src/activities/chat/tools/tool-definition.ts:162](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-definition.ts#L162) If true, tool execution requires user approval before running. Works with both server and client tools. @@ -348,7 +348,7 @@ If true, tool execution requires user approval before running. Works with both s outputSchema: TOutput; ``` -Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:161 +Defined in: [packages/ai/src/activities/chat/tools/tool-definition.ts:161](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-definition.ts#L161) Optional schema for validating tool output. @@ -383,7 +383,7 @@ z.object({ optional replay?: "safe" | "never"; ``` -Defined in: packages/ai/src/types.ts:1083 +Defined in: [packages/ai/src/types.ts:1123](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1123) Whether a host may run this tool again after a crash cut the run between the call and its result. `'safe'` runs it again. Omit the @@ -402,7 +402,7 @@ writes the model note. `chat()` does not read this field. server: (execute) => ServerTool & BuiltToolSchemaFields; ``` -Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:258 +Defined in: [packages/ai/src/activities/chat/tools/tool-definition.ts:258](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-definition.ts#L258) Create a server-side tool with execute function diff --git a/docs/reference/interfaces/ToolDefinitionInstance.md b/docs/reference/interfaces/ToolDefinitionInstance.md index 062b942e73..63cb2c254b 100644 --- a/docs/reference/interfaces/ToolDefinitionInstance.md +++ b/docs/reference/interfaces/ToolDefinitionInstance.md @@ -3,7 +3,7 @@ id: ToolDefinitionInstance title: ToolDefinitionInstance --- -Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:149 +Defined in: [packages/ai/src/activities/chat/tools/tool-definition.ts:149](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-definition.ts#L149) Tool definition that can be used directly or instantiated for server/client @@ -51,7 +51,7 @@ Tool definition that can be used directly or instantiated for server/client __toolSide: "definition"; ``` -Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:157 +Defined in: [packages/ai/src/activities/chat/tools/tool-definition.ts:157](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-definition.ts#L157) *** @@ -61,7 +61,7 @@ Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:157 readonly optional [toolApprovalCapability]?: object; ``` -Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:165 +Defined in: [packages/ai/src/activities/chat/tools/tool-definition.ts:165](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-definition.ts#L165) #### approvalSchema @@ -83,7 +83,7 @@ needsApproval: TNeedsApproval; approvalSchema: TApprovalSchema; ``` -Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:163 +Defined in: [packages/ai/src/activities/chat/tools/tool-definition.ts:163](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-definition.ts#L163) *** @@ -93,7 +93,7 @@ Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:163 description: string; ``` -Defined in: packages/ai/src/types.ts:989 +Defined in: [packages/ai/src/types.ts:1029](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1029) Clear description of what the tool does. @@ -118,7 +118,7 @@ Be specific about what the tool does, what parameters it needs, and what it retu optional execute?: ToolExecuteFunction; ``` -Defined in: packages/ai/src/types.ts:1069 +Defined in: [packages/ai/src/types.ts:1109](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1109) Optional function to execute when the model calls this tool. @@ -158,7 +158,7 @@ execute: async (args) => { optional execution?: "task"; ``` -Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:164 +Defined in: [packages/ai/src/activities/chat/tools/tool-definition.ts:164](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-definition.ts#L164) *** @@ -168,7 +168,7 @@ Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:164 inputSchema: TInput; ``` -Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:160 +Defined in: [packages/ai/src/activities/chat/tools/tool-definition.ts:160](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-definition.ts#L160) Schema describing the tool's input parameters. @@ -226,7 +226,7 @@ type({ optional lazy?: boolean; ``` -Defined in: packages/ai/src/types.ts:1075 +Defined in: [packages/ai/src/types.ts:1115](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1115) If true, this tool is lazy and will only be sent to the LLM after being discovered via the lazy tool discovery mechanism. Works with both chat() (the synthetic discovery tool) and Code Mode (kept out of the system prompt and revealed via discover_tools). @@ -242,7 +242,7 @@ If true, this tool is lazy and will only be sent to the LLM after being discover optional metadata?: Record; ``` -Defined in: packages/ai/src/types.ts:1086 +Defined in: [packages/ai/src/types.ts:1126](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1126) Additional metadata for adapters or custom extensions @@ -258,7 +258,7 @@ Additional metadata for adapters or custom extensions name: TName; ``` -Defined in: packages/ai/src/types.ts:979 +Defined in: [packages/ai/src/types.ts:1019](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1019) Unique name of the tool (used by the model to call it). @@ -283,7 +283,7 @@ Must be unique within the tools array. optional needsApproval?: TNeedsApproval; ``` -Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:162 +Defined in: [packages/ai/src/activities/chat/tools/tool-definition.ts:162](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-definition.ts#L162) If true, tool execution requires user approval before running. Works with both server and client tools. @@ -299,7 +299,7 @@ If true, tool execution requires user approval before running. Works with both s outputSchema: TOutput; ``` -Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:161 +Defined in: [packages/ai/src/activities/chat/tools/tool-definition.ts:161](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-definition.ts#L161) Optional schema for validating tool output. @@ -334,7 +334,7 @@ z.object({ optional replay?: "safe" | "never"; ``` -Defined in: packages/ai/src/types.ts:1083 +Defined in: [packages/ai/src/types.ts:1123](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1123) Whether a host may run this tool again after a crash cut the run between the call and its result. `'safe'` runs it again. Omit the diff --git a/docs/reference/interfaces/ToolInputRepairContext.md b/docs/reference/interfaces/ToolInputRepairContext.md index 79f37dd92a..d2abd45536 100644 --- a/docs/reference/interfaces/ToolInputRepairContext.md +++ b/docs/reference/interfaces/ToolInputRepairContext.md @@ -3,7 +3,7 @@ id: ToolInputRepairContext title: ToolInputRepairContext --- -Defined in: packages/ai/src/types.ts:1292 +Defined in: [packages/ai/src/types.ts:1332](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1332) What a `repairToolInput` function gets: a tool input that failed the check. @@ -15,7 +15,7 @@ What a `repairToolInput` function gets: a tool input that failed the check. error: Error; ``` -Defined in: packages/ai/src/types.ts:1300 +Defined in: [packages/ai/src/types.ts:1340](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1340) The validation error. A Standard Schema error also has `issues`. @@ -27,7 +27,7 @@ The validation error. A Standard Schema error also has `issues`. input: unknown; ``` -Defined in: packages/ai/src/types.ts:1298 +Defined in: [packages/ai/src/types.ts:1338](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1338) The input that failed, after approval edits and middleware. @@ -39,7 +39,7 @@ The input that failed, after approval edits and middleware. tool: AnyTool; ``` -Defined in: packages/ai/src/types.ts:1294 +Defined in: [packages/ai/src/types.ts:1334](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1334) The tool the model called. @@ -51,6 +51,6 @@ The tool the model called. toolCall: ToolCall; ``` -Defined in: packages/ai/src/types.ts:1296 +Defined in: [packages/ai/src/types.ts:1336](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1336) The call, with its id and the raw arguments text. diff --git a/docs/reference/interfaces/ToolPhaseCompleteInfo.md b/docs/reference/interfaces/ToolPhaseCompleteInfo.md index 4f6ae80ec0..0e4518b9bf 100644 --- a/docs/reference/interfaces/ToolPhaseCompleteInfo.md +++ b/docs/reference/interfaces/ToolPhaseCompleteInfo.md @@ -3,7 +3,7 @@ id: ToolPhaseCompleteInfo title: ToolPhaseCompleteInfo --- -Defined in: packages/ai/src/activities/chat/middleware/types.ts:516 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:546](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L546) Aggregate information passed to onToolPhaseComplete after all tool calls in an iteration have been processed. @@ -16,7 +16,7 @@ in an iteration have been processed. needsApproval: object[]; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:527 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:557](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L557) Tools that need user approval @@ -52,7 +52,7 @@ toolName: string; needsClientExecution: object[]; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:534 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:564](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L564) Tools that need client-side execution @@ -82,7 +82,7 @@ toolName: string; results: object[]; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:520 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:550](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L550) Completed tool results @@ -118,6 +118,6 @@ toolName: string; toolCalls: ToolCall[]; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:518 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:548](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L548) Tool calls that were assigned to the assistant message diff --git a/docs/reference/interfaces/ToolRegistry.md b/docs/reference/interfaces/ToolRegistry.md index 873f3d48a3..5db3c26613 100644 --- a/docs/reference/interfaces/ToolRegistry.md +++ b/docs/reference/interfaces/ToolRegistry.md @@ -3,7 +3,7 @@ id: ToolRegistry title: ToolRegistry --- -Defined in: packages/ai/src/tool-registry.ts:9 +Defined in: [packages/ai/src/tool-registry.ts:9](https://github.com/TanStack/ai/blob/main/packages/ai/src/tool-registry.ts#L9) A registry that holds tools and allows dynamic tool management. @@ -24,7 +24,7 @@ or frozen (a static tool list, made from the normal `tools` array). add: (tool) => void; ``` -Defined in: packages/ai/src/tool-registry.ts:22 +Defined in: [packages/ai/src/tool-registry.ts:22](https://github.com/TanStack/ai/blob/main/packages/ai/src/tool-registry.ts#L22) Add a tool to the registry dynamically. For frozen registries, this is a no-op. @@ -49,7 +49,7 @@ The tool to add get: (name) => TTool | undefined; ``` -Defined in: packages/ai/src/tool-registry.ts:46 +Defined in: [packages/ai/src/tool-registry.ts:46](https://github.com/TanStack/ai/blob/main/packages/ai/src/tool-registry.ts#L46) Get a tool by name. @@ -75,7 +75,7 @@ The tool if found, undefined otherwise getTools: () => TTool[]; ``` -Defined in: packages/ai/src/tool-registry.ts:14 +Defined in: [packages/ai/src/tool-registry.ts:14](https://github.com/TanStack/ai/blob/main/packages/ai/src/tool-registry.ts#L14) Get all current tools in the registry. Called each agent loop iteration to get the latest tool list. @@ -92,7 +92,7 @@ Called each agent loop iteration to get the latest tool list. has: (name) => boolean; ``` -Defined in: packages/ai/src/tool-registry.ts:38 +Defined in: [packages/ai/src/tool-registry.ts:38](https://github.com/TanStack/ai/blob/main/packages/ai/src/tool-registry.ts#L38) Check if a tool exists in the registry. @@ -116,7 +116,7 @@ The name of the tool to check readonly isFrozen: boolean; ``` -Defined in: packages/ai/src/tool-registry.ts:52 +Defined in: [packages/ai/src/tool-registry.ts:52](https://github.com/TanStack/ai/blob/main/packages/ai/src/tool-registry.ts#L52) Whether this registry is frozen (immutable). Frozen registries don't allow add/remove operations. @@ -129,7 +129,7 @@ Frozen registries don't allow add/remove operations. remove: (name) => boolean; ``` -Defined in: packages/ai/src/tool-registry.ts:31 +Defined in: [packages/ai/src/tool-registry.ts:31](https://github.com/TanStack/ai/blob/main/packages/ai/src/tool-registry.ts#L31) Remove a tool from the registry by name. For frozen registries, this always returns false. diff --git a/docs/reference/interfaces/ToolResultPart.md b/docs/reference/interfaces/ToolResultPart.md index 6bb48bf2ee..443a475cd0 100644 --- a/docs/reference/interfaces/ToolResultPart.md +++ b/docs/reference/interfaces/ToolResultPart.md @@ -3,7 +3,7 @@ id: ToolResultPart title: ToolResultPart --- -Defined in: packages/ai/src/types.ts:524 +Defined in: [packages/ai/src/types.ts:527](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L527) ## Properties @@ -15,7 +15,7 @@ content: | ContentPart[]; ``` -Defined in: packages/ai/src/types.ts:529 +Defined in: [packages/ai/src/types.ts:532](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L532) *** @@ -25,7 +25,7 @@ Defined in: packages/ai/src/types.ts:529 optional createdAt?: Date; ``` -Defined in: packages/ai/src/types.ts:535 +Defined in: [packages/ai/src/types.ts:538](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L538) *** @@ -35,7 +35,7 @@ Defined in: packages/ai/src/types.ts:535 optional error?: string; ``` -Defined in: packages/ai/src/types.ts:533 +Defined in: [packages/ai/src/types.ts:536](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L536) *** @@ -45,7 +45,7 @@ Defined in: packages/ai/src/types.ts:533 optional id?: string; ``` -Defined in: packages/ai/src/types.ts:526 +Defined in: [packages/ai/src/types.ts:529](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L529) *** @@ -55,7 +55,7 @@ Defined in: packages/ai/src/types.ts:526 optional metadata?: Record; ``` -Defined in: packages/ai/src/types.ts:534 +Defined in: [packages/ai/src/types.ts:537](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L537) *** @@ -65,7 +65,7 @@ Defined in: packages/ai/src/types.ts:534 optional name?: string; ``` -Defined in: packages/ai/src/types.ts:527 +Defined in: [packages/ai/src/types.ts:530](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L530) *** @@ -75,7 +75,7 @@ Defined in: packages/ai/src/types.ts:527 optional outcome?: ToolResultOutcome; ``` -Defined in: packages/ai/src/types.ts:532 +Defined in: [packages/ai/src/types.ts:535](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L535) Set when the user or middleware cancelled or denied the tool call; state remains `error`. @@ -87,7 +87,7 @@ Set when the user or middleware cancelled or denied the tool call; state remains state: ToolResultState; ``` -Defined in: packages/ai/src/types.ts:530 +Defined in: [packages/ai/src/types.ts:533](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L533) *** @@ -97,7 +97,7 @@ Defined in: packages/ai/src/types.ts:530 toolCallId: string; ``` -Defined in: packages/ai/src/types.ts:528 +Defined in: [packages/ai/src/types.ts:531](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L531) *** @@ -107,4 +107,4 @@ Defined in: packages/ai/src/types.ts:528 type: "tool-result"; ``` -Defined in: packages/ai/src/types.ts:525 +Defined in: [packages/ai/src/types.ts:528](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L528) diff --git a/docs/reference/interfaces/TranscriptionAdapter.md b/docs/reference/interfaces/TranscriptionAdapter.md index 96591052b3..bfad5e9d44 100644 --- a/docs/reference/interfaces/TranscriptionAdapter.md +++ b/docs/reference/interfaces/TranscriptionAdapter.md @@ -3,7 +3,7 @@ id: TranscriptionAdapter title: TranscriptionAdapter --- -Defined in: packages/ai/src/activities/generateTranscription/adapter.ts:24 +Defined in: [packages/ai/src/activities/generateTranscription/adapter.ts:24](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateTranscription/adapter.ts#L24) Transcription adapter interface with pre-resolved generics. @@ -32,7 +32,7 @@ Generic parameters: ~types: object; ``` -Defined in: packages/ai/src/activities/generateTranscription/adapter.ts:38 +Defined in: [packages/ai/src/activities/generateTranscription/adapter.ts:38](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateTranscription/adapter.ts#L38) **`Internal`** @@ -52,7 +52,7 @@ providerOptions: TProviderOptions; readonly kind: "transcription"; ``` -Defined in: packages/ai/src/activities/generateTranscription/adapter.ts:29 +Defined in: [packages/ai/src/activities/generateTranscription/adapter.ts:29](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateTranscription/adapter.ts#L29) Discriminator for adapter kind - used to determine API shape @@ -64,7 +64,7 @@ Discriminator for adapter kind - used to determine API shape readonly model: TModel; ``` -Defined in: packages/ai/src/activities/generateTranscription/adapter.ts:33 +Defined in: [packages/ai/src/activities/generateTranscription/adapter.ts:33](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateTranscription/adapter.ts#L33) The model this adapter is configured for @@ -76,7 +76,7 @@ The model this adapter is configured for readonly name: string; ``` -Defined in: packages/ai/src/activities/generateTranscription/adapter.ts:31 +Defined in: [packages/ai/src/activities/generateTranscription/adapter.ts:31](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateTranscription/adapter.ts#L31) Adapter name identifier @@ -88,7 +88,7 @@ Adapter name identifier transcribe: (options) => Promise; ``` -Defined in: packages/ai/src/activities/generateTranscription/adapter.ts:45 +Defined in: [packages/ai/src/activities/generateTranscription/adapter.ts:45](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateTranscription/adapter.ts#L45) Transcribe audio to text diff --git a/docs/reference/interfaces/TranscriptionOptions.md b/docs/reference/interfaces/TranscriptionOptions.md index f05ceca1f3..835a217473 100644 --- a/docs/reference/interfaces/TranscriptionOptions.md +++ b/docs/reference/interfaces/TranscriptionOptions.md @@ -3,7 +3,7 @@ id: TranscriptionOptions title: TranscriptionOptions --- -Defined in: packages/ai/src/types.ts:3140 +Defined in: [packages/ai/src/types.ts:3188](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3188) ## Type Parameters @@ -19,7 +19,7 @@ Defined in: packages/ai/src/types.ts:3140 optional abortSignal?: AbortSignal; ``` -Defined in: packages/ai/src/types.ts:3166 +Defined in: [packages/ai/src/types.ts:3214](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3214) Effective abort signal composed by the activity from caller `abortSignal` and/or `timeout`. Adapters should forward this to the provider SDK when @@ -33,7 +33,7 @@ supported. Request-specific — never store on a global client config. audio: string | ArrayBuffer | File | Blob; ``` -Defined in: packages/ai/src/types.ts:3146 +Defined in: [packages/ai/src/types.ts:3194](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3194) The audio data to transcribe - can be base64 string, File, Blob, or Buffer @@ -45,7 +45,7 @@ The audio data to transcribe - can be base64 string, File, Blob, or Buffer optional language?: string; ``` -Defined in: packages/ai/src/types.ts:3148 +Defined in: [packages/ai/src/types.ts:3196](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3196) The language of the audio in ISO-639-1 format (e.g., 'en') @@ -57,7 +57,7 @@ The language of the audio in ISO-639-1 format (e.g., 'en') logger: InternalLogger; ``` -Defined in: packages/ai/src/types.ts:3160 +Defined in: [packages/ai/src/types.ts:3208](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3208) Internal logger threaded from the generateTranscription() entry point. Adapters must call logger.request() before the SDK call and logger.errors() @@ -71,7 +71,7 @@ in catch blocks. model: string; ``` -Defined in: packages/ai/src/types.ts:3144 +Defined in: [packages/ai/src/types.ts:3192](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3192) The model to use for transcription @@ -83,7 +83,7 @@ The model to use for transcription optional modelOptions?: TProviderOptions; ``` -Defined in: packages/ai/src/types.ts:3154 +Defined in: [packages/ai/src/types.ts:3202](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3202) Model-specific options for transcription @@ -95,7 +95,7 @@ Model-specific options for transcription optional prompt?: string; ``` -Defined in: packages/ai/src/types.ts:3150 +Defined in: [packages/ai/src/types.ts:3198](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3198) An optional prompt to guide the transcription @@ -107,6 +107,6 @@ An optional prompt to guide the transcription optional responseFormat?: TranscriptionResponseFormat; ``` -Defined in: packages/ai/src/types.ts:3152 +Defined in: [packages/ai/src/types.ts:3200](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3200) The format of the transcription output diff --git a/docs/reference/interfaces/TranscriptionResult.md b/docs/reference/interfaces/TranscriptionResult.md index aeae1dca44..4b488bfd93 100644 --- a/docs/reference/interfaces/TranscriptionResult.md +++ b/docs/reference/interfaces/TranscriptionResult.md @@ -3,7 +3,7 @@ id: TranscriptionResult title: TranscriptionResult --- -Defined in: packages/ai/src/types.ts:3202 +Defined in: [packages/ai/src/types.ts:3250](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3250) Result of audio transcription. @@ -15,7 +15,7 @@ Result of audio transcription. optional artifacts?: PersistedArtifactRef[]; ``` -Defined in: packages/ai/src/types.ts:3220 +Defined in: [packages/ai/src/types.ts:3268](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3268) Persisted artifact references for generated assets, when available @@ -27,7 +27,7 @@ Persisted artifact references for generated assets, when available optional duration?: number; ``` -Defined in: packages/ai/src/types.ts:3212 +Defined in: [packages/ai/src/types.ts:3260](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3260) Duration of the audio in seconds @@ -39,7 +39,7 @@ Duration of the audio in seconds id: string; ``` -Defined in: packages/ai/src/types.ts:3204 +Defined in: [packages/ai/src/types.ts:3252](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3252) Unique identifier for the transcription @@ -51,7 +51,7 @@ Unique identifier for the transcription optional language?: string; ``` -Defined in: packages/ai/src/types.ts:3210 +Defined in: [packages/ai/src/types.ts:3258](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3258) Language detected or specified @@ -63,7 +63,7 @@ Language detected or specified model: string; ``` -Defined in: packages/ai/src/types.ts:3206 +Defined in: [packages/ai/src/types.ts:3254](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3254) Model used for transcription @@ -75,7 +75,7 @@ Model used for transcription optional segments?: TranscriptionSegment[]; ``` -Defined in: packages/ai/src/types.ts:3214 +Defined in: [packages/ai/src/types.ts:3262](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3262) Detailed segments with timing, if available @@ -87,7 +87,7 @@ Detailed segments with timing, if available text: string; ``` -Defined in: packages/ai/src/types.ts:3208 +Defined in: [packages/ai/src/types.ts:3256](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3256) The full transcribed text @@ -99,7 +99,7 @@ The full transcribed text optional usage?: TokenUsage; ``` -Defined in: packages/ai/src/types.ts:3218 +Defined in: [packages/ai/src/types.ts:3266](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3266) Token usage information (if provided by the adapter) @@ -111,6 +111,6 @@ Token usage information (if provided by the adapter) optional words?: TranscriptionWord[]; ``` -Defined in: packages/ai/src/types.ts:3216 +Defined in: [packages/ai/src/types.ts:3264](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3264) Word-level timestamps, if available diff --git a/docs/reference/interfaces/TranscriptionSegment.md b/docs/reference/interfaces/TranscriptionSegment.md index dca121e9ba..307a1a5b1c 100644 --- a/docs/reference/interfaces/TranscriptionSegment.md +++ b/docs/reference/interfaces/TranscriptionSegment.md @@ -3,7 +3,7 @@ id: TranscriptionSegment title: TranscriptionSegment --- -Defined in: packages/ai/src/types.ts:3172 +Defined in: [packages/ai/src/types.ts:3220](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3220) A single segment of transcribed audio with timing information. @@ -15,7 +15,7 @@ A single segment of transcribed audio with timing information. optional confidence?: number; ``` -Defined in: packages/ai/src/types.ts:3182 +Defined in: [packages/ai/src/types.ts:3230](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3230) Confidence score (0-1), if available @@ -27,7 +27,7 @@ Confidence score (0-1), if available end: number; ``` -Defined in: packages/ai/src/types.ts:3178 +Defined in: [packages/ai/src/types.ts:3226](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3226) End time of the segment in seconds @@ -39,7 +39,7 @@ End time of the segment in seconds id: number; ``` -Defined in: packages/ai/src/types.ts:3174 +Defined in: [packages/ai/src/types.ts:3222](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3222) Unique identifier for the segment @@ -51,7 +51,7 @@ Unique identifier for the segment optional speaker?: string; ``` -Defined in: packages/ai/src/types.ts:3184 +Defined in: [packages/ai/src/types.ts:3232](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3232) Speaker identifier, if diarization is enabled @@ -63,7 +63,7 @@ Speaker identifier, if diarization is enabled start: number; ``` -Defined in: packages/ai/src/types.ts:3176 +Defined in: [packages/ai/src/types.ts:3224](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3224) Start time of the segment in seconds @@ -75,6 +75,6 @@ Start time of the segment in seconds text: string; ``` -Defined in: packages/ai/src/types.ts:3180 +Defined in: [packages/ai/src/types.ts:3228](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3228) Transcribed text for this segment diff --git a/docs/reference/interfaces/TranscriptionWord.md b/docs/reference/interfaces/TranscriptionWord.md index 3d57e1f810..4f06e4ad7a 100644 --- a/docs/reference/interfaces/TranscriptionWord.md +++ b/docs/reference/interfaces/TranscriptionWord.md @@ -3,7 +3,7 @@ id: TranscriptionWord title: TranscriptionWord --- -Defined in: packages/ai/src/types.ts:3190 +Defined in: [packages/ai/src/types.ts:3238](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3238) A single word with timing information. @@ -15,7 +15,7 @@ A single word with timing information. end: number; ``` -Defined in: packages/ai/src/types.ts:3196 +Defined in: [packages/ai/src/types.ts:3244](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3244) End time in seconds @@ -27,7 +27,7 @@ End time in seconds start: number; ``` -Defined in: packages/ai/src/types.ts:3194 +Defined in: [packages/ai/src/types.ts:3242](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3242) Start time in seconds @@ -39,6 +39,6 @@ Start time in seconds word: string; ``` -Defined in: packages/ai/src/types.ts:3192 +Defined in: [packages/ai/src/types.ts:3240](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3240) The transcribed word diff --git a/docs/reference/interfaces/UIMessage.md b/docs/reference/interfaces/UIMessage.md index 5ba2951608..025c72c4b0 100644 --- a/docs/reference/interfaces/UIMessage.md +++ b/docs/reference/interfaces/UIMessage.md @@ -3,7 +3,7 @@ id: UIMessage title: UIMessage --- -Defined in: packages/ai/src/types.ts:787 +Defined in: [packages/ai/src/types.ts:805](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L805) UIMessage - Domain-specific message format optimized for building chat UIs Contains parts that can be text, tool calls, or tool results. Generic over @@ -25,7 +25,7 @@ consumer side without manual casts. optional createdAt?: Date; ``` -Defined in: packages/ai/src/types.ts:791 +Defined in: [packages/ai/src/types.ts:809](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L809) *** @@ -35,7 +35,7 @@ Defined in: packages/ai/src/types.ts:791 id: string; ``` -Defined in: packages/ai/src/types.ts:788 +Defined in: [packages/ai/src/types.ts:806](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L806) *** @@ -45,7 +45,7 @@ Defined in: packages/ai/src/types.ts:788 optional metadata?: Record; ``` -Defined in: packages/ai/src/types.ts:798 +Defined in: [packages/ai/src/types.ts:816](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L816) Optional AG-UI metadata bag. TanStack writes the `tanstack` key. User keys stay at the top. @@ -58,7 +58,7 @@ User keys stay at the top. optional name?: string; ``` -Defined in: packages/ai/src/types.ts:793 +Defined in: [packages/ai/src/types.ts:811](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L811) Optional AG-UI sender name. Converters preserve it across wire and persist. @@ -70,7 +70,7 @@ Optional AG-UI sender name. Converters preserve it across wire and persist. parts: MessagePart[]; ``` -Defined in: packages/ai/src/types.ts:790 +Defined in: [packages/ai/src/types.ts:808](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L808) *** @@ -80,4 +80,4 @@ Defined in: packages/ai/src/types.ts:790 role: "assistant" | "user" | "activity" | "system"; ``` -Defined in: packages/ai/src/types.ts:789 +Defined in: [packages/ai/src/types.ts:807](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L807) diff --git a/docs/reference/interfaces/UIResourceEvent.md b/docs/reference/interfaces/UIResourceEvent.md index 79507d276b..baff55a6f9 100644 --- a/docs/reference/interfaces/UIResourceEvent.md +++ b/docs/reference/interfaces/UIResourceEvent.md @@ -3,7 +3,7 @@ id: UIResourceEvent title: UIResourceEvent --- -Defined in: packages/ai/src/types.ts:1799 +Defined in: [packages/ai/src/types.ts:1857](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1857) Emitted when an MCP tool returns a ui:// resource (MCP Apps). Reconciled into a UIResourcePart on the assistant UIMessage. Never enters model input. @@ -20,7 +20,7 @@ Emitted when an MCP tool returns a ui:// resource (MCP Apps). Reconciled into optional metadata?: Record; ``` -Defined in: packages/ai/src/types.ts:1756 +Defined in: [packages/ai/src/types.ts:1814](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1814) Extra information attached to this event. @@ -36,7 +36,7 @@ Extra information attached to this event. name: "ui-resource"; ``` -Defined in: packages/ai/src/types.ts:1800 +Defined in: [packages/ai/src/types.ts:1858](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1858) What this custom event is. Required: without it a consumer cannot route the value. @@ -55,7 +55,7 @@ CustomEvent.name type: "CUSTOM"; ``` -Defined in: packages/ai/src/types.ts:1755 +Defined in: [packages/ai/src/types.ts:1813](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1813) #### Inherited from @@ -69,7 +69,7 @@ Defined in: packages/ai/src/types.ts:1755 value: object; ``` -Defined in: packages/ai/src/types.ts:1801 +Defined in: [packages/ai/src/types.ts:1859](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1859) The payload. Any JSON value, and required. diff --git a/docs/reference/interfaces/UIResourcePart.md b/docs/reference/interfaces/UIResourcePart.md index 1a4ebc4560..93ff1f8a69 100644 --- a/docs/reference/interfaces/UIResourcePart.md +++ b/docs/reference/interfaces/UIResourcePart.md @@ -3,7 +3,7 @@ id: UIResourcePart title: UIResourcePart --- -Defined in: packages/ai/src/types.ts:657 +Defined in: [packages/ai/src/types.ts:660](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L660) ## Properties @@ -13,7 +13,7 @@ Defined in: packages/ai/src/types.ts:657 optional meta?: Record; ``` -Defined in: packages/ai/src/types.ts:671 +Defined in: [packages/ai/src/types.ts:674](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L674) Reserved for future passthrough of the resource/tool `_meta.ui` (e.g. frame-size hints). Currently always `undefined` — nothing populates this field yet. @@ -26,7 +26,7 @@ Reserved for future passthrough of the resource/tool `_meta.ui` (e.g. frame-size resource: object; ``` -Defined in: packages/ai/src/types.ts:660 +Defined in: [packages/ai/src/types.ts:663](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L663) The ui:// resource object in MCP-native shape — fed straight to the renderer. @@ -62,7 +62,7 @@ uri: string; optional serverId?: string; ``` -Defined in: packages/ai/src/types.ts:662 +Defined in: [packages/ai/src/types.ts:665](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L665) Pool prefix / config key — routes interactive calls to the right MCP server. @@ -74,7 +74,7 @@ Pool prefix / config key — routes interactive calls to the right MCP server. toolCallId: string; ``` -Defined in: packages/ai/src/types.ts:665 +Defined in: [packages/ai/src/types.ts:668](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L668) Links the widget to the originating tool call — correlates it with the sibling ToolCallPart/ToolResultPart in the same message. @@ -87,7 +87,7 @@ Links the widget to the originating tool call — correlates it with the toolName: string; ``` -Defined in: packages/ai/src/types.ts:668 +Defined in: [packages/ai/src/types.ts:671](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L671) Server-native (unprefixed) MCP tool name whose UI this resource renders. Required by the renderer (`@mcp-ui/client`'s `AppRenderer` `toolName` prop). @@ -100,4 +100,4 @@ Server-native (unprefixed) MCP tool name whose UI this resource renders. type: "ui-resource"; ``` -Defined in: packages/ai/src/types.ts:658 +Defined in: [packages/ai/src/types.ts:661](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L661) diff --git a/docs/reference/interfaces/UpsertableStreamDurability.md b/docs/reference/interfaces/UpsertableStreamDurability.md index aea4bf7ffa..a8ab624f1c 100644 --- a/docs/reference/interfaces/UpsertableStreamDurability.md +++ b/docs/reference/interfaces/UpsertableStreamDurability.md @@ -3,7 +3,7 @@ id: UpsertableStreamDurability title: UpsertableStreamDurability --- -Defined in: packages/ai/src/stream-durability.ts:83 +Defined in: [packages/ai/src/stream-durability.ts:83](https://github.com/TanStack/ai/blob/main/packages/ai/src/stream-durability.ts#L83) A [StreamDurability](StreamDurability.md) that can re-persist an already-stored range idempotently. @@ -45,7 +45,7 @@ reject a hole in the entries array. append: (chunks) => Promise; ``` -Defined in: packages/ai/src/stream-durability.ts:17 +Defined in: [packages/ai/src/stream-durability.ts:17](https://github.com/TanStack/ai/blob/main/packages/ai/src/stream-durability.ts#L17) Persist a batch before it is delivered and return exactly one resumable offset for each chunk, in the same order. @@ -72,7 +72,7 @@ offset for each chunk, in the same order. close: () => Promise; ``` -Defined in: packages/ai/src/stream-durability.ts:27 +Defined in: [packages/ai/src/stream-durability.ts:27](https://github.com/TanStack/ai/blob/main/packages/ai/src/stream-durability.ts#L27) Terminalize the producer log and unblock live readers. Core awaits this for every producer exit, including completion, cancellation, and failure. @@ -96,7 +96,7 @@ read: (offset, signal?) => AsyncIterable<{ }>; ``` -Defined in: packages/ai/src/stream-durability.ts:19 +Defined in: [packages/ai/src/stream-durability.ts:19](https://github.com/TanStack/ai/blob/main/packages/ai/src/stream-durability.ts#L19) Replay chunks strictly after the supplied adapter-owned offset. @@ -129,7 +129,7 @@ Replay chunks strictly after the supplied adapter-owned offset. resumeFrom: () => TOffset | null; ``` -Defined in: packages/ai/src/stream-durability.ts:12 +Defined in: [packages/ai/src/stream-durability.ts:12](https://github.com/TanStack/ai/blob/main/packages/ai/src/stream-durability.ts#L12) Return the adapter offset captured from the request, or null for a producer. @@ -149,7 +149,7 @@ Return the adapter offset captured from the request, or null for a producer. snapshot: () => Promise; ``` -Defined in: packages/ai/src/stream-durability.ts:57 +Defined in: [packages/ai/src/stream-durability.ts:57](https://github.com/TanStack/ai/blob/main/packages/ai/src/stream-durability.ts#L57) Everything stored for this run **at the moment of the call**, in append order, then resolve. @@ -195,7 +195,7 @@ must not treat the last returned offset as the permanent tail. upsert: (entries) => Promise; ``` -Defined in: packages/ai/src/stream-durability.ts:90 +Defined in: [packages/ai/src/stream-durability.ts:90](https://github.com/TanStack/ai/blob/main/packages/ai/src/stream-durability.ts#L90) Persist a batch at caller-supplied offsets, replacing any entry already stored at the same offset. Returns the offsets in the order supplied. diff --git a/docs/reference/interfaces/UsageInfo.md b/docs/reference/interfaces/UsageInfo.md index dbab974e14..c54fdedc03 100644 --- a/docs/reference/interfaces/UsageInfo.md +++ b/docs/reference/interfaces/UsageInfo.md @@ -3,7 +3,7 @@ id: UsageInfo title: UsageInfo --- -Defined in: packages/ai/src/activities/chat/middleware/types.ts:553 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:583](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L583) Token usage statistics passed to the onUsage hook. Extracted from the RUN_FINISHED chunk when usage data is present. diff --git a/docs/reference/interfaces/VADConfig.md b/docs/reference/interfaces/VADConfig.md index 9d039adb00..3e6174d7c2 100644 --- a/docs/reference/interfaces/VADConfig.md +++ b/docs/reference/interfaces/VADConfig.md @@ -3,7 +3,7 @@ id: VADConfig title: VADConfig --- -Defined in: packages/ai/src/realtime/types.ts:12 +Defined in: [packages/ai/src/realtime/types.ts:12](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L12) Voice activity detection configuration @@ -15,7 +15,7 @@ Voice activity detection configuration optional prefixPaddingMs?: number; ``` -Defined in: packages/ai/src/realtime/types.ts:16 +Defined in: [packages/ai/src/realtime/types.ts:16](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L16) Audio to include before speech detection (ms) @@ -27,7 +27,7 @@ Audio to include before speech detection (ms) optional silenceDurationMs?: number; ``` -Defined in: packages/ai/src/realtime/types.ts:18 +Defined in: [packages/ai/src/realtime/types.ts:18](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L18) Silence duration to end turn (ms) @@ -39,6 +39,6 @@ Silence duration to end turn (ms) optional threshold?: number; ``` -Defined in: packages/ai/src/realtime/types.ts:14 +Defined in: [packages/ai/src/realtime/types.ts:14](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L14) Sensitivity threshold (0.0-1.0) diff --git a/docs/reference/interfaces/ValidateInterruptResumeBatchInput.md b/docs/reference/interfaces/ValidateInterruptResumeBatchInput.md index ff8bc29655..eea98b5f5d 100644 --- a/docs/reference/interfaces/ValidateInterruptResumeBatchInput.md +++ b/docs/reference/interfaces/ValidateInterruptResumeBatchInput.md @@ -3,7 +3,7 @@ id: ValidateInterruptResumeBatchInput title: ValidateInterruptResumeBatchInput --- -Defined in: packages/ai/src/interrupt-resume.ts:60 +Defined in: [packages/ai/src/interrupt-resume.ts:60](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupt-resume.ts#L60) ## Properties @@ -13,7 +13,7 @@ Defined in: packages/ai/src/interrupt-resume.ts:60 generation: number; ``` -Defined in: packages/ai/src/interrupt-resume.ts:63 +Defined in: [packages/ai/src/interrupt-resume.ts:63](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupt-resume.ts#L63) *** @@ -23,7 +23,7 @@ Defined in: packages/ai/src/interrupt-resume.ts:63 interruptedRunId: string; ``` -Defined in: packages/ai/src/interrupt-resume.ts:62 +Defined in: [packages/ai/src/interrupt-resume.ts:62](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupt-resume.ts#L62) *** @@ -33,7 +33,7 @@ Defined in: packages/ai/src/interrupt-resume.ts:62 optional now?: number; ``` -Defined in: packages/ai/src/interrupt-resume.ts:67 +Defined in: [packages/ai/src/interrupt-resume.ts:67](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupt-resume.ts#L67) *** @@ -43,7 +43,7 @@ Defined in: packages/ai/src/interrupt-resume.ts:67 pending: readonly PendingInterruptResumeRecord[]; ``` -Defined in: packages/ai/src/interrupt-resume.ts:64 +Defined in: [packages/ai/src/interrupt-resume.ts:64](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupt-resume.ts#L64) *** @@ -53,7 +53,7 @@ Defined in: packages/ai/src/interrupt-resume.ts:64 optional resume?: readonly RunAgentResumeItem[]; ``` -Defined in: packages/ai/src/interrupt-resume.ts:65 +Defined in: [packages/ai/src/interrupt-resume.ts:65](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupt-resume.ts#L65) *** @@ -63,7 +63,7 @@ Defined in: packages/ai/src/interrupt-resume.ts:65 threadId: string; ``` -Defined in: packages/ai/src/interrupt-resume.ts:61 +Defined in: [packages/ai/src/interrupt-resume.ts:61](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupt-resume.ts#L61) *** @@ -73,4 +73,4 @@ Defined in: packages/ai/src/interrupt-resume.ts:61 tools: Tool[]; ``` -Defined in: packages/ai/src/interrupt-resume.ts:66 +Defined in: [packages/ai/src/interrupt-resume.ts:66](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupt-resume.ts#L66) diff --git a/docs/reference/interfaces/ValidatedInterruptResumeBatch.md b/docs/reference/interfaces/ValidatedInterruptResumeBatch.md index 14b42ea4e5..4a0c01eb0d 100644 --- a/docs/reference/interfaces/ValidatedInterruptResumeBatch.md +++ b/docs/reference/interfaces/ValidatedInterruptResumeBatch.md @@ -3,7 +3,7 @@ id: ValidatedInterruptResumeBatch title: ValidatedInterruptResumeBatch --- -Defined in: packages/ai/src/interrupt-resume.ts:70 +Defined in: [packages/ai/src/interrupt-resume.ts:70](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupt-resume.ts#L70) ## Properties @@ -13,7 +13,7 @@ Defined in: packages/ai/src/interrupt-resume.ts:70 optional canonicalResolutions?: string; ``` -Defined in: packages/ai/src/interrupt-resume.ts:73 +Defined in: [packages/ai/src/interrupt-resume.ts:73](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupt-resume.ts#L73) *** @@ -23,7 +23,7 @@ Defined in: packages/ai/src/interrupt-resume.ts:73 errors: readonly InterruptSubmissionError[]; ``` -Defined in: packages/ai/src/interrupt-resume.ts:71 +Defined in: [packages/ai/src/interrupt-resume.ts:71](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupt-resume.ts#L71) *** @@ -33,7 +33,7 @@ Defined in: packages/ai/src/interrupt-resume.ts:71 optional fingerprint?: string; ``` -Defined in: packages/ai/src/interrupt-resume.ts:74 +Defined in: [packages/ai/src/interrupt-resume.ts:74](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupt-resume.ts#L74) *** @@ -43,7 +43,7 @@ Defined in: packages/ai/src/interrupt-resume.ts:74 optional resolutions?: readonly RunAgentResumeItem[]; ``` -Defined in: packages/ai/src/interrupt-resume.ts:72 +Defined in: [packages/ai/src/interrupt-resume.ts:72](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupt-resume.ts#L72) *** @@ -53,4 +53,4 @@ Defined in: packages/ai/src/interrupt-resume.ts:72 optional resumeToolState?: ChatResumeToolState; ``` -Defined in: packages/ai/src/interrupt-resume.ts:75 +Defined in: [packages/ai/src/interrupt-resume.ts:75](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupt-resume.ts#L75) diff --git a/docs/reference/interfaces/VideoAdapter.md b/docs/reference/interfaces/VideoAdapter.md index e8d4cb3dec..6a4bf14e73 100644 --- a/docs/reference/interfaces/VideoAdapter.md +++ b/docs/reference/interfaces/VideoAdapter.md @@ -3,7 +3,7 @@ id: VideoAdapter title: VideoAdapter --- -Defined in: packages/ai/src/activities/generateVideo/adapter.ts:64 +Defined in: [packages/ai/src/activities/generateVideo/adapter.ts:64](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateVideo/adapter.ts#L64) Video adapter interface with pre-resolved generics. @@ -55,7 +55,7 @@ Generic parameters: ~types: object; ``` -Defined in: packages/ai/src/activities/generateVideo/adapter.ts:94 +Defined in: [packages/ai/src/activities/generateVideo/adapter.ts:94](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateVideo/adapter.ts#L94) **`Internal`** @@ -99,7 +99,7 @@ providerOptions: TProviderOptions; availableDurations: () => DurationOptions; ``` -Defined in: packages/ai/src/activities/generateVideo/adapter.ts:131 +Defined in: [packages/ai/src/activities/generateVideo/adapter.ts:131](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateVideo/adapter.ts#L131) Describe the durations this adapter's model accepts. Returns a tagged union so consumers can render UI / coerce input without provider-specific @@ -117,7 +117,7 @@ knowledge. createVideoJob: (options) => Promise; ``` -Defined in: packages/ai/src/activities/generateVideo/adapter.ts:106 +Defined in: [packages/ai/src/activities/generateVideo/adapter.ts:106](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateVideo/adapter.ts#L106) Create a new video generation job. Returns a job ID that can be used to poll for status and retrieve the video. @@ -142,7 +142,7 @@ getVideo: (jobId) => Promise< | VideoStreamResult>; ``` -Defined in: packages/ai/src/activities/generateVideo/adapter.ts:124 +Defined in: [packages/ai/src/activities/generateVideo/adapter.ts:124](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateVideo/adapter.ts#L124) Get the finished video: a public URL when the provider has one, or the download stream for generation middleware to host. Call only after @@ -168,7 +168,7 @@ status is 'completed'. getVideoStatus: (jobId) => Promise; ``` -Defined in: packages/ai/src/activities/generateVideo/adapter.ts:117 +Defined in: [packages/ai/src/activities/generateVideo/adapter.ts:117](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateVideo/adapter.ts#L117) Get the current status of a video generation job. @@ -190,7 +190,7 @@ Get the current status of a video generation job. readonly kind: "video"; ``` -Defined in: packages/ai/src/activities/generateVideo/adapter.ts:78 +Defined in: [packages/ai/src/activities/generateVideo/adapter.ts:78](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateVideo/adapter.ts#L78) Discriminator for adapter kind - used to determine API shape @@ -202,7 +202,7 @@ Discriminator for adapter kind - used to determine API shape readonly model: TModel; ``` -Defined in: packages/ai/src/activities/generateVideo/adapter.ts:89 +Defined in: [packages/ai/src/activities/generateVideo/adapter.ts:89](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateVideo/adapter.ts#L89) The model this adapter is configured for @@ -214,7 +214,7 @@ The model this adapter is configured for readonly name: string; ``` -Defined in: packages/ai/src/activities/generateVideo/adapter.ts:80 +Defined in: [packages/ai/src/activities/generateVideo/adapter.ts:80](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateVideo/adapter.ts#L80) Adapter name identifier @@ -226,7 +226,7 @@ Adapter name identifier snapDuration: (input) => TModelDurationByName[TModel] | undefined; ``` -Defined in: packages/ai/src/activities/generateVideo/adapter.ts:140 +Defined in: [packages/ai/src/activities/generateVideo/adapter.ts:140](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateVideo/adapter.ts#L140) Coerce `input` to the closest duration this model accepts. `input` may be seconds (`7`), a numeric string (`"7"`), a template @@ -252,7 +252,7 @@ Returns `undefined` when the model has no duration field, or when readonly optional supportsFileSources?: boolean; ``` -Defined in: packages/ai/src/activities/generateVideo/adapter.ts:87 +Defined in: [packages/ai/src/activities/generateVideo/adapter.ts:87](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateVideo/adapter.ts#L87) Declares that this adapter can consume `{ type: 'file' }` content sources (provider Files API references). The activity dispatcher rejects diff --git a/docs/reference/interfaces/VideoGenerationOptions.md b/docs/reference/interfaces/VideoGenerationOptions.md index b0016a51de..68fb3f3ed7 100644 --- a/docs/reference/interfaces/VideoGenerationOptions.md +++ b/docs/reference/interfaces/VideoGenerationOptions.md @@ -3,7 +3,7 @@ id: VideoGenerationOptions title: VideoGenerationOptions --- -Defined in: packages/ai/src/types.ts:2590 +Defined in: [packages/ai/src/types.ts:2590](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2590) Options for video generation. These are the common options supported across providers. @@ -30,7 +30,7 @@ These are the common options supported across providers. optional abortSignal?: AbortSignal; ``` -Defined in: packages/ai/src/types.ts:2627 +Defined in: [packages/ai/src/types.ts:2627](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2627) Effective abort signal composed by the activity from caller `abortSignal` and/or `timeout`. Adapters should forward this to the provider SDK when @@ -44,7 +44,7 @@ supported. Request-specific — never store on a global client config. optional duration?: TDuration; ``` -Defined in: packages/ai/src/types.ts:2614 +Defined in: [packages/ai/src/types.ts:2614](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2614) Video duration. Adapters that declare a per-model duration map narrow this to that model's union (a number, `"8"`, or `"8s"`). Use @@ -59,7 +59,7 @@ seconds, a `"6s"` template, or `"auto"` when the model lists it. logger: InternalLogger; ``` -Defined in: packages/ai/src/types.ts:2621 +Defined in: [packages/ai/src/types.ts:2621](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2621) Internal logger threaded from the generateVideo() entry point. Adapters must call logger.request() before the SDK call and logger.errors() in catch blocks. @@ -72,7 +72,7 @@ call logger.request() before the SDK call and logger.errors() in catch blocks. model: string; ``` -Defined in: packages/ai/src/types.ts:2596 +Defined in: [packages/ai/src/types.ts:2596](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2596) The model to use for video generation @@ -84,7 +84,7 @@ The model to use for video generation optional modelOptions?: TProviderOptions; ``` -Defined in: packages/ai/src/types.ts:2616 +Defined in: [packages/ai/src/types.ts:2616](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2616) Model-specific options for video generation @@ -96,7 +96,7 @@ Model-specific options for video generation prompt: MediaPrompt; ``` -Defined in: packages/ai/src/types.ts:2605 +Defined in: [packages/ai/src/types.ts:2605](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2605) Description of the desired video: a plain string, or an ordered array of content parts for image-conditioned generation. Image parts may carry @@ -113,6 +113,6 @@ provider-native request (e.g. OpenAI Sora `input_reference`, fal optional size?: TSize; ``` -Defined in: packages/ai/src/types.ts:2607 +Defined in: [packages/ai/src/types.ts:2607](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2607) Video size — format depends on the provider (e.g., "16:9", "1280x720") diff --git a/docs/reference/interfaces/VideoJobResult.md b/docs/reference/interfaces/VideoJobResult.md index 755700e0dc..3387bb3028 100644 --- a/docs/reference/interfaces/VideoJobResult.md +++ b/docs/reference/interfaces/VideoJobResult.md @@ -3,7 +3,7 @@ id: VideoJobResult title: VideoJobResult --- -Defined in: packages/ai/src/types.ts:2633 +Defined in: [packages/ai/src/types.ts:2633](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2633) Result of creating a video generation job. @@ -15,7 +15,7 @@ Result of creating a video generation job. optional artifacts?: PersistedArtifactRef[]; ``` -Defined in: packages/ai/src/types.ts:2643 +Defined in: [packages/ai/src/types.ts:2643](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2643) Durable artifact references, when generation persistence with an artifact + blob store is wired. A submission has no video yet, so this only carries @@ -29,7 +29,7 @@ refs for persisted prompt INPUTS (e.g. a start frame). jobId: string; ``` -Defined in: packages/ai/src/types.ts:2635 +Defined in: [packages/ai/src/types.ts:2635](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2635) Unique job identifier for polling status @@ -41,6 +41,6 @@ Unique job identifier for polling status model: string; ``` -Defined in: packages/ai/src/types.ts:2637 +Defined in: [packages/ai/src/types.ts:2637](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2637) Model used for generation diff --git a/docs/reference/interfaces/VideoPart.md b/docs/reference/interfaces/VideoPart.md index bcf2a148b8..fe39c964d4 100644 --- a/docs/reference/interfaces/VideoPart.md +++ b/docs/reference/interfaces/VideoPart.md @@ -3,7 +3,7 @@ id: VideoPart title: VideoPart --- -Defined in: packages/ai/src/types.ts:306 +Defined in: [packages/ai/src/types.ts:309](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L309) Video content part for multimodal messages. AG-UI `VideoPart` with typed metadata. @@ -27,7 +27,7 @@ Provider-specific metadata type optional metadata?: TMetadata; ``` -Defined in: packages/ai/src/types.ts:308 +Defined in: [packages/ai/src/types.ts:311](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L311) Provider-specific metadata (e.g., duration, resolution) diff --git a/docs/reference/interfaces/VideoStatusResult.md b/docs/reference/interfaces/VideoStatusResult.md index 3fc1359a09..25c66dcae0 100644 --- a/docs/reference/interfaces/VideoStatusResult.md +++ b/docs/reference/interfaces/VideoStatusResult.md @@ -3,7 +3,7 @@ id: VideoStatusResult title: VideoStatusResult --- -Defined in: packages/ai/src/types.ts:2649 +Defined in: [packages/ai/src/types.ts:2649](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2649) Status of a video generation job. @@ -15,7 +15,7 @@ Status of a video generation job. optional error?: string; ``` -Defined in: packages/ai/src/types.ts:2657 +Defined in: [packages/ai/src/types.ts:2657](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2657) Error message if status is 'failed' @@ -27,7 +27,7 @@ Error message if status is 'failed' jobId: string; ``` -Defined in: packages/ai/src/types.ts:2651 +Defined in: [packages/ai/src/types.ts:2651](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2651) Job identifier @@ -39,7 +39,7 @@ Job identifier optional progress?: number; ``` -Defined in: packages/ai/src/types.ts:2655 +Defined in: [packages/ai/src/types.ts:2655](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2655) Progress percentage (0-100), if available @@ -51,6 +51,6 @@ Progress percentage (0-100), if available status: "pending" | "processing" | "completed" | "failed"; ``` -Defined in: packages/ai/src/types.ts:2653 +Defined in: [packages/ai/src/types.ts:2653](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2653) Current status of the job diff --git a/docs/reference/interfaces/VideoStreamResult.md b/docs/reference/interfaces/VideoStreamResult.md index d95a3b94a6..c28e852071 100644 --- a/docs/reference/interfaces/VideoStreamResult.md +++ b/docs/reference/interfaces/VideoStreamResult.md @@ -3,7 +3,7 @@ id: VideoStreamResult title: VideoStreamResult --- -Defined in: packages/ai/src/types.ts:2686 +Defined in: [packages/ai/src/types.ts:2686](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2686) Video bytes from a provider that has no public URL for the finished video. Core passes `body` to generation middleware, which streams it into storage @@ -17,7 +17,7 @@ and sets `url`. Use `withGenerationPersistence` with `artifactUrl`. body: ReadableStream>; ``` -Defined in: packages/ai/src/types.ts:2690 +Defined in: [packages/ai/src/types.ts:2690](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2690) The video bytes. Read once, with backpressure. Never buffer it whole. @@ -29,7 +29,7 @@ The video bytes. Read once, with backpressure. Never buffer it whole. contentType: string; ``` -Defined in: packages/ai/src/types.ts:2692 +Defined in: [packages/ai/src/types.ts:2692](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2692) MIME type of `body`, e.g. `video/mp4`. @@ -41,7 +41,7 @@ MIME type of `body`, e.g. `video/mp4`. jobId: string; ``` -Defined in: packages/ai/src/types.ts:2688 +Defined in: [packages/ai/src/types.ts:2688](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2688) Job identifier @@ -53,7 +53,7 @@ Job identifier optional url?: undefined; ``` -Defined in: packages/ai/src/types.ts:2694 +Defined in: [packages/ai/src/types.ts:2694](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2694) *** @@ -63,4 +63,4 @@ Defined in: packages/ai/src/types.ts:2694 optional usage?: TokenUsage; ``` -Defined in: packages/ai/src/types.ts:2693 +Defined in: [packages/ai/src/types.ts:2693](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2693) diff --git a/docs/reference/interfaces/VideoUrlResult.md b/docs/reference/interfaces/VideoUrlResult.md index 689e62ea47..19ac6cb22e 100644 --- a/docs/reference/interfaces/VideoUrlResult.md +++ b/docs/reference/interfaces/VideoUrlResult.md @@ -3,7 +3,7 @@ id: VideoUrlResult title: VideoUrlResult --- -Defined in: packages/ai/src/types.ts:2663 +Defined in: [packages/ai/src/types.ts:2663](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2663) Result containing the URL to a generated video. @@ -15,7 +15,7 @@ Result containing the URL to a generated video. optional artifacts?: PersistedArtifactRef[]; ``` -Defined in: packages/ai/src/types.ts:2677 +Defined in: [packages/ai/src/types.ts:2677](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2677) Persisted artifact references for generated assets, when available @@ -27,7 +27,7 @@ Persisted artifact references for generated assets, when available optional body?: undefined; ``` -Defined in: packages/ai/src/types.ts:2678 +Defined in: [packages/ai/src/types.ts:2678](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2678) *** @@ -37,7 +37,7 @@ Defined in: packages/ai/src/types.ts:2678 optional expiresAt?: Date; ``` -Defined in: packages/ai/src/types.ts:2669 +Defined in: [packages/ai/src/types.ts:2669](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2669) When the URL expires, if applicable @@ -49,7 +49,7 @@ When the URL expires, if applicable jobId: string; ``` -Defined in: packages/ai/src/types.ts:2665 +Defined in: [packages/ai/src/types.ts:2665](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2665) Job identifier @@ -61,7 +61,7 @@ Job identifier url: string; ``` -Defined in: packages/ai/src/types.ts:2667 +Defined in: [packages/ai/src/types.ts:2667](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2667) URL to the generated video @@ -73,7 +73,7 @@ URL to the generated video optional usage?: TokenUsage; ``` -Defined in: packages/ai/src/types.ts:2675 +Defined in: [packages/ai/src/types.ts:2675](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2675) Usage information for the completed generation, when the adapter can report it. For usage-based providers (e.g. fal) this carries `billed` — the real diff --git a/docs/reference/interfaces/VoiceAdapter.md b/docs/reference/interfaces/VoiceAdapter.md index 38b5eeb645..3880a78337 100644 --- a/docs/reference/interfaces/VoiceAdapter.md +++ b/docs/reference/interfaces/VoiceAdapter.md @@ -3,7 +3,7 @@ id: VoiceAdapter title: VoiceAdapter --- -Defined in: packages/ai/src/activities/generateVoice/adapter.ts:24 +Defined in: [packages/ai/src/activities/generateVoice/adapter.ts:24](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateVoice/adapter.ts#L24) Voice adapter interface with pre-resolved generics. @@ -32,7 +32,7 @@ Generic parameters: ~types: object; ``` -Defined in: packages/ai/src/activities/generateVoice/adapter.ts:38 +Defined in: [packages/ai/src/activities/generateVoice/adapter.ts:38](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateVoice/adapter.ts#L38) **`Internal`** @@ -52,7 +52,7 @@ providerOptions: TProviderOptions; generateVoice: (options) => Promise; ``` -Defined in: packages/ai/src/activities/generateVoice/adapter.ts:45 +Defined in: [packages/ai/src/activities/generateVoice/adapter.ts:45](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateVoice/adapter.ts#L45) Create a voice from a text description and/or reference audio @@ -74,7 +74,7 @@ Create a voice from a text description and/or reference audio readonly kind: "voice"; ``` -Defined in: packages/ai/src/activities/generateVoice/adapter.ts:29 +Defined in: [packages/ai/src/activities/generateVoice/adapter.ts:29](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateVoice/adapter.ts#L29) Discriminator for adapter kind - used to determine API shape @@ -86,7 +86,7 @@ Discriminator for adapter kind - used to determine API shape readonly model: TModel; ``` -Defined in: packages/ai/src/activities/generateVoice/adapter.ts:33 +Defined in: [packages/ai/src/activities/generateVoice/adapter.ts:33](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateVoice/adapter.ts#L33) The model this adapter is configured for @@ -98,6 +98,6 @@ The model this adapter is configured for readonly name: string; ``` -Defined in: packages/ai/src/activities/generateVoice/adapter.ts:31 +Defined in: [packages/ai/src/activities/generateVoice/adapter.ts:31](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateVoice/adapter.ts#L31) Adapter name identifier diff --git a/docs/reference/interfaces/VoiceGenerationOptions.md b/docs/reference/interfaces/VoiceGenerationOptions.md index c934770f8a..893b2639a4 100644 --- a/docs/reference/interfaces/VoiceGenerationOptions.md +++ b/docs/reference/interfaces/VoiceGenerationOptions.md @@ -3,7 +3,7 @@ id: VoiceGenerationOptions title: VoiceGenerationOptions --- -Defined in: packages/ai/src/types.ts:3022 +Defined in: [packages/ai/src/types.ts:3070](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3070) Options for creating a voice. @@ -30,7 +30,7 @@ takes `referenceAudio` as an additional design reference. optional abortSignal?: AbortSignal; ``` -Defined in: packages/ai/src/types.ts:3057 +Defined in: [packages/ai/src/types.ts:3105](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3105) Effective abort signal composed by the activity from caller `abortSignal` and/or `timeout`. Adapters should forward this to the provider SDK when @@ -44,7 +44,7 @@ supported. Request-specific - never store on a global client config. optional description?: string; ``` -Defined in: packages/ai/src/types.ts:3043 +Defined in: [packages/ai/src/types.ts:3091](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3091) Human-readable description stored alongside the voice @@ -56,7 +56,7 @@ Human-readable description stored alongside the voice logger: InternalLogger; ``` -Defined in: packages/ai/src/types.ts:3051 +Defined in: [packages/ai/src/types.ts:3099](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3099) Internal logger threaded from the generateVoice() entry point. Adapters must call logger.request() before the SDK call and logger.errors() in @@ -70,7 +70,7 @@ catch blocks. model: string; ``` -Defined in: packages/ai/src/types.ts:3026 +Defined in: [packages/ai/src/types.ts:3074](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3074) The model to use for voice creation @@ -82,7 +82,7 @@ The model to use for voice creation optional modelOptions?: TProviderOptions; ``` -Defined in: packages/ai/src/types.ts:3045 +Defined in: [packages/ai/src/types.ts:3093](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3093) Model-specific options for voice creation @@ -94,7 +94,7 @@ Model-specific options for voice creation optional name?: string; ``` -Defined in: packages/ai/src/types.ts:3041 +Defined in: [packages/ai/src/types.ts:3089](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3089) Name to store the voice under in the provider's voice library. Providers differ on what this implies — ElevenLabs only persists a designed voice @@ -109,7 +109,7 @@ actually happened. optional prompt?: string; ``` -Defined in: packages/ai/src/types.ts:3028 +Defined in: [packages/ai/src/types.ts:3076](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3076) Text description of the voice to create, for design-capable models @@ -121,7 +121,7 @@ Text description of the voice to create, for design-capable models optional referenceAudio?: string | ArrayBuffer | File | Blob; ``` -Defined in: packages/ai/src/types.ts:3034 +Defined in: [packages/ai/src/types.ts:3082](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3082) Reference audio of the speaker to clone - base64 string, base64 data URL, File, Blob, or ArrayBuffer. For clone-capable models. Remote URLs are not diff --git a/docs/reference/interfaces/VoiceResult.md b/docs/reference/interfaces/VoiceResult.md index e971213bb4..4b52ca424c 100644 --- a/docs/reference/interfaces/VoiceResult.md +++ b/docs/reference/interfaces/VoiceResult.md @@ -3,7 +3,7 @@ id: VoiceResult title: VoiceResult --- -Defined in: packages/ai/src/types.ts:3110 +Defined in: [packages/ai/src/types.ts:3158](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3158) Result of voice creation. @@ -18,7 +18,7 @@ models return exactly one. optional artifacts?: PersistedArtifactRef[]; ``` -Defined in: packages/ai/src/types.ts:3122 +Defined in: [packages/ai/src/types.ts:3170](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3170) Persisted artifact references for generated assets, when available @@ -30,7 +30,7 @@ Persisted artifact references for generated assets, when available id: string; ``` -Defined in: packages/ai/src/types.ts:3112 +Defined in: [packages/ai/src/types.ts:3160](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3160) Unique identifier for the generation @@ -42,7 +42,7 @@ Unique identifier for the generation model: string; ``` -Defined in: packages/ai/src/types.ts:3114 +Defined in: [packages/ai/src/types.ts:3162](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3162) Model used for generation @@ -54,7 +54,7 @@ Model used for generation optional previewText?: string; ``` -Defined in: packages/ai/src/types.ts:3118 +Defined in: [packages/ai/src/types.ts:3166](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3166) The line spoken in the previews, when the provider generated one @@ -66,7 +66,7 @@ The line spoken in the previews, when the provider generated one optional usage?: TokenUsage; ``` -Defined in: packages/ai/src/types.ts:3120 +Defined in: [packages/ai/src/types.ts:3168](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3168) Token usage information (if provided by the adapter) @@ -78,6 +78,6 @@ Token usage information (if provided by the adapter) voices: GeneratedVoice[]; ``` -Defined in: packages/ai/src/types.ts:3116 +Defined in: [packages/ai/src/types.ts:3164](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3164) The voices produced, best-first when the provider ranks them diff --git a/docs/reference/interfaces/WebSocketLike.md b/docs/reference/interfaces/WebSocketLike.md index 4aead5cb1c..b05d5545e3 100644 --- a/docs/reference/interfaces/WebSocketLike.md +++ b/docs/reference/interfaces/WebSocketLike.md @@ -3,7 +3,7 @@ id: WebSocketLike title: WebSocketLike --- -Defined in: packages/ai/src/stream-to-websocket.ts:15 +Defined in: [packages/ai/src/stream-to-websocket.ts:15](https://github.com/TanStack/ai/blob/main/packages/ai/src/stream-to-websocket.ts#L15) The minimal WHATWG WebSocket surface the core needs. Cloudflare `WebSocketPair` server sockets, Deno's upgraded sockets, and `ws` (Node) @@ -21,7 +21,7 @@ addEventListener: { }; ``` -Defined in: packages/ai/src/stream-to-websocket.ts:18 +Defined in: [packages/ai/src/stream-to-websocket.ts:24](https://github.com/TanStack/ai/blob/main/packages/ai/src/stream-to-websocket.ts#L24) #### Call Signature @@ -65,13 +65,27 @@ Defined in: packages/ai/src/stream-to-websocket.ts:18 *** +### bufferedAmount? + +```ts +readonly optional bufferedAmount?: number; +``` + +Defined in: [packages/ai/src/stream-to-websocket.ts:23](https://github.com/TanStack/ai/blob/main/packages/ai/src/stream-to-websocket.ts#L23) + +Bytes that `send` queued and the socket did not write yet. A server can +read it to stop sending to a slow client. A socket without it gets no +backpressure. + +*** + ### close ```ts close: (code?, reason?) => void; ``` -Defined in: packages/ai/src/stream-to-websocket.ts:17 +Defined in: [packages/ai/src/stream-to-websocket.ts:17](https://github.com/TanStack/ai/blob/main/packages/ai/src/stream-to-websocket.ts#L17) #### Parameters @@ -95,7 +109,7 @@ Defined in: packages/ai/src/stream-to-websocket.ts:17 send: (data) => void; ``` -Defined in: packages/ai/src/stream-to-websocket.ts:16 +Defined in: [packages/ai/src/stream-to-websocket.ts:16](https://github.com/TanStack/ai/blob/main/packages/ai/src/stream-to-websocket.ts#L16) #### Parameters diff --git a/docs/reference/interfaces/WebSocketStreamInit.md b/docs/reference/interfaces/WebSocketStreamInit.md index d030cac2e8..bbaef9b78e 100644 --- a/docs/reference/interfaces/WebSocketStreamInit.md +++ b/docs/reference/interfaces/WebSocketStreamInit.md @@ -3,7 +3,7 @@ id: WebSocketStreamInit title: WebSocketStreamInit --- -Defined in: packages/ai/src/stream-to-websocket.ts:90 +Defined in: [packages/ai/src/stream-to-websocket.ts:96](https://github.com/TanStack/ai/blob/main/packages/ai/src/stream-to-websocket.ts#L96) ## Type Parameters @@ -19,7 +19,7 @@ Defined in: packages/ai/src/stream-to-websocket.ts:90 optional batch?: number; ``` -Defined in: packages/ai/src/stream-to-websocket.ts:96 +Defined in: [packages/ai/src/stream-to-websocket.ts:102](https://github.com/TanStack/ai/blob/main/packages/ai/src/stream-to-websocket.ts#L102) Chunks buffered per durability append (default 32). @@ -31,7 +31,7 @@ Chunks buffered per durability append (default 32). optional batchWaitMs?: number; ``` -Defined in: packages/ai/src/stream-to-websocket.ts:101 +Defined in: [packages/ai/src/stream-to-websocket.ts:107](https://github.com/TanStack/ai/blob/main/packages/ai/src/stream-to-websocket.ts#L107) Most ms a chunk waits in the batch for the next one before the batch is appended and sent anyway (default 50). `0` appends every chunk on its own. @@ -44,7 +44,7 @@ appended and sent anyway (default 50). `0` appends every chunk on its own. optional debug?: DebugOption; ``` -Defined in: packages/ai/src/stream-to-websocket.ts:110 +Defined in: [packages/ai/src/stream-to-websocket.ts:116](https://github.com/TanStack/ai/blob/main/packages/ai/src/stream-to-websocket.ts#L116) *** @@ -54,7 +54,7 @@ Defined in: packages/ai/src/stream-to-websocket.ts:110 optional durability?: (ctx) => StreamDurability; ``` -Defined in: packages/ai/src/stream-to-websocket.ts:94 +Defined in: [packages/ai/src/stream-to-websocket.ts:100](https://github.com/TanStack/ai/blob/main/packages/ai/src/stream-to-websocket.ts#L100) Per-TURN durability factory, keyed by the frame's runId via ctx.request. @@ -76,7 +76,7 @@ Per-TURN durability factory, keyed by the frame's runId via ctx.request. optional heartbeatMs?: number; ``` -Defined in: packages/ai/src/stream-to-websocket.ts:103 +Defined in: [packages/ai/src/stream-to-websocket.ts:109](https://github.com/TanStack/ai/blob/main/packages/ai/src/stream-to-websocket.ts#L109) Heartbeat ping interval in ms (default 30_000). @@ -88,7 +88,7 @@ Heartbeat ping interval in ms (default 30_000). optional idleTimeoutMs?: number; ``` -Defined in: packages/ai/src/stream-to-websocket.ts:109 +Defined in: [packages/ai/src/stream-to-websocket.ts:115](https://github.com/TanStack/ai/blob/main/packages/ai/src/stream-to-websocket.ts#L115) Close after this many ms without any inbound frame (default 300_000). Never fires while a turn is still streaming, so a long single generation @@ -102,7 +102,7 @@ Never fires while a turn is still streaming, so a long single generation onRun: (ctx) => AsyncIterable; ``` -Defined in: packages/ai/src/stream-to-websocket.ts:92 +Defined in: [packages/ai/src/stream-to-websocket.ts:98](https://github.com/TanStack/ai/blob/main/packages/ai/src/stream-to-websocket.ts#L98) Build a fresh chat() stream for each inbound RunAgentInput frame. diff --git a/docs/reference/interfaces/WorldAdapter.md b/docs/reference/interfaces/WorldAdapter.md index 693c678085..630229fa30 100644 --- a/docs/reference/interfaces/WorldAdapter.md +++ b/docs/reference/interfaces/WorldAdapter.md @@ -3,7 +3,7 @@ id: WorldAdapter title: WorldAdapter --- -Defined in: packages/ai/src/activities/generateWorld/adapter.ts:28 +Defined in: [packages/ai/src/activities/generateWorld/adapter.ts:28](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateWorld/adapter.ts#L28) **`Experimental`** @@ -36,7 +36,7 @@ Generic parameters: ~types: object; ``` -Defined in: packages/ai/src/activities/generateWorld/adapter.ts:42 +Defined in: [packages/ai/src/activities/generateWorld/adapter.ts:42](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateWorld/adapter.ts#L42) **`Internal`** @@ -56,7 +56,7 @@ providerOptions: TProviderOptions; createWorld: (options) => Promise; ``` -Defined in: packages/ai/src/activities/generateWorld/adapter.ts:54 +Defined in: [packages/ai/src/activities/generateWorld/adapter.ts:54](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateWorld/adapter.ts#L54) **`Experimental`** @@ -85,7 +85,7 @@ id while the job is still running). readonly kind: "world"; ``` -Defined in: packages/ai/src/activities/generateWorld/adapter.ts:33 +Defined in: [packages/ai/src/activities/generateWorld/adapter.ts:33](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateWorld/adapter.ts#L33) **`Experimental`** @@ -99,7 +99,7 @@ Discriminator for adapter kind - used to determine API shape readonly model: TModel; ``` -Defined in: packages/ai/src/activities/generateWorld/adapter.ts:37 +Defined in: [packages/ai/src/activities/generateWorld/adapter.ts:37](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateWorld/adapter.ts#L37) **`Experimental`** @@ -113,7 +113,7 @@ The model this adapter is configured for readonly name: string; ``` -Defined in: packages/ai/src/activities/generateWorld/adapter.ts:35 +Defined in: [packages/ai/src/activities/generateWorld/adapter.ts:35](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateWorld/adapter.ts#L35) **`Experimental`** diff --git a/docs/reference/interfaces/WorldGenerationAssets.md b/docs/reference/interfaces/WorldGenerationAssets.md index f72ddfdae1..cc19f46a67 100644 --- a/docs/reference/interfaces/WorldGenerationAssets.md +++ b/docs/reference/interfaces/WorldGenerationAssets.md @@ -3,7 +3,7 @@ id: WorldGenerationAssets title: WorldGenerationAssets --- -Defined in: packages/ai/src/types.ts:2693 +Defined in: [packages/ai/src/types.ts:2741](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2741) **`Experimental`** @@ -21,7 +21,7 @@ to fetch from a browser. optional caption?: string; ``` -Defined in: packages/ai/src/types.ts:2695 +Defined in: [packages/ai/src/types.ts:2743](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2743) **`Experimental`** @@ -35,7 +35,7 @@ Auto-generated scene description optional imagery?: object; ``` -Defined in: packages/ai/src/types.ts:2709 +Defined in: [packages/ai/src/types.ts:2757](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2757) **`Experimental`** @@ -53,7 +53,7 @@ optional panoUrl?: string; optional mesh?: object; ``` -Defined in: packages/ai/src/types.ts:2704 +Defined in: [packages/ai/src/types.ts:2752](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2752) **`Experimental`** @@ -83,7 +83,7 @@ optional hqMeshUrl?: string; optional splats?: object; ``` -Defined in: packages/ai/src/types.ts:2698 +Defined in: [packages/ai/src/types.ts:2746](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2746) **`Experimental`** @@ -115,7 +115,7 @@ Quality-key map of splat URLs (`100k`, `500k`, `full_res`, …) optional thumbnailUrl?: string; ``` -Defined in: packages/ai/src/types.ts:2697 +Defined in: [packages/ai/src/types.ts:2745](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2745) **`Experimental`** diff --git a/docs/reference/interfaces/WorldGenerationOptions.md b/docs/reference/interfaces/WorldGenerationOptions.md index 9241277431..690cf71cd3 100644 --- a/docs/reference/interfaces/WorldGenerationOptions.md +++ b/docs/reference/interfaces/WorldGenerationOptions.md @@ -3,7 +3,7 @@ id: WorldGenerationOptions title: WorldGenerationOptions --- -Defined in: packages/ai/src/types.ts:2658 +Defined in: [packages/ai/src/types.ts:2706](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2706) **`Experimental`** @@ -25,7 +25,7 @@ Options for world generation (live session or finished job). optional abortSignal?: AbortSignal; ``` -Defined in: packages/ai/src/types.ts:2683 +Defined in: [packages/ai/src/types.ts:2731](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2731) **`Experimental`** @@ -41,7 +41,7 @@ supported. Request-specific — never store on a global client config. logger: InternalLogger; ``` -Defined in: packages/ai/src/types.ts:2677 +Defined in: [packages/ai/src/types.ts:2725](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2725) **`Experimental`** @@ -57,7 +57,7 @@ catch blocks. model: string; ``` -Defined in: packages/ai/src/types.ts:2662 +Defined in: [packages/ai/src/types.ts:2710](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2710) **`Experimental`** @@ -71,7 +71,7 @@ The model to use for world generation optional modelOptions?: TProviderOptions; ``` -Defined in: packages/ai/src/types.ts:2671 +Defined in: [packages/ai/src/types.ts:2719](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2719) **`Experimental`** @@ -88,7 +88,7 @@ token-mint fields. prompt: string; ``` -Defined in: packages/ai/src/types.ts:2664 +Defined in: [packages/ai/src/types.ts:2712](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2712) **`Experimental`** diff --git a/docs/reference/interfaces/WorldGenerationResult.md b/docs/reference/interfaces/WorldGenerationResult.md index e89e68ba4e..cee6e14338 100644 --- a/docs/reference/interfaces/WorldGenerationResult.md +++ b/docs/reference/interfaces/WorldGenerationResult.md @@ -3,7 +3,7 @@ id: WorldGenerationResult title: WorldGenerationResult --- -Defined in: packages/ai/src/types.ts:2727 +Defined in: [packages/ai/src/types.ts:2775](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2775) **`Experimental`** @@ -27,7 +27,7 @@ Job adapters (World Labs): `status: 'ready'` with viewer `url` and optional assets?: WorldGenerationAssets; ``` -Defined in: packages/ai/src/types.ts:2752 +Defined in: [packages/ai/src/types.ts:2800](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2800) **`Experimental`** @@ -41,7 +41,7 @@ Assets when a world job has finished and the provider returned them optional expiresAt?: number; ``` -Defined in: packages/ai/src/types.ts:2738 +Defined in: [packages/ai/src/types.ts:2786](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2786) **`Experimental`** @@ -56,7 +56,7 @@ Job adapters: operation expiry when the provider sends it. id: string; ``` -Defined in: packages/ai/src/types.ts:2729 +Defined in: [packages/ai/src/types.ts:2777](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2777) **`Experimental`** @@ -70,7 +70,7 @@ Unique identifier for this generation model: string; ``` -Defined in: packages/ai/src/types.ts:2731 +Defined in: [packages/ai/src/types.ts:2779](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2779) **`Experimental`** @@ -84,7 +84,7 @@ Model used for generation (provider connect slug or model id) optional operationId?: string; ``` -Defined in: packages/ai/src/types.ts:2750 +Defined in: [packages/ai/src/types.ts:2798](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2798) **`Experimental`** @@ -98,7 +98,7 @@ Provider operation id for a long-running world job prompt: string; ``` -Defined in: packages/ai/src/types.ts:2740 +Defined in: [packages/ai/src/types.ts:2788](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2788) **`Experimental`** @@ -112,7 +112,7 @@ Prompt used to generate the world, or the prompt the client should send optional sessionId?: string; ``` -Defined in: packages/ai/src/types.ts:2744 +Defined in: [packages/ai/src/types.ts:2792](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2792) **`Experimental`** @@ -126,7 +126,7 @@ Provider session id, when the adapter created one status: "ready" | "waiting"; ``` -Defined in: packages/ai/src/types.ts:2742 +Defined in: [packages/ai/src/types.ts:2790](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2790) **`Experimental`** @@ -140,7 +140,7 @@ Status after the server half finishes optional token?: string; ``` -Defined in: packages/ai/src/types.ts:2733 +Defined in: [packages/ai/src/types.ts:2781](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2781) **`Experimental`** @@ -154,7 +154,7 @@ Short-lived session token for a live client connection optional url?: string; ``` -Defined in: packages/ai/src/types.ts:2746 +Defined in: [packages/ai/src/types.ts:2794](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2794) **`Experimental`** @@ -168,7 +168,7 @@ Viewer URL for a finished world job (not an asset download URL) optional usage?: TokenUsage; ``` -Defined in: packages/ai/src/types.ts:2754 +Defined in: [packages/ai/src/types.ts:2802](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2802) **`Experimental`** @@ -182,7 +182,7 @@ Token usage / billing, when the adapter can report it optional worldId?: string; ``` -Defined in: packages/ai/src/types.ts:2748 +Defined in: [packages/ai/src/types.ts:2796](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2796) **`Experimental`** diff --git a/docs/reference/interfaces/WsRunContext.md b/docs/reference/interfaces/WsRunContext.md index e9157b7924..82892c681f 100644 --- a/docs/reference/interfaces/WsRunContext.md +++ b/docs/reference/interfaces/WsRunContext.md @@ -3,7 +3,7 @@ id: WsRunContext title: WsRunContext --- -Defined in: packages/ai/src/stream-to-websocket.ts:62 +Defined in: [packages/ai/src/stream-to-websocket.ts:68](https://github.com/TanStack/ai/blob/main/packages/ai/src/stream-to-websocket.ts#L68) Per-turn context for one inbound `run` frame on a conversation-scoped socket. @@ -15,7 +15,7 @@ Per-turn context for one inbound `run` frame on a conversation-scoped socket. optional forwardedProps?: Record; ``` -Defined in: packages/ai/src/stream-to-websocket.ts:66 +Defined in: [packages/ai/src/stream-to-websocket.ts:72](https://github.com/TanStack/ai/blob/main/packages/ai/src/stream-to-websocket.ts#L72) *** @@ -30,7 +30,7 @@ messages: ( | null>)[]; ``` -Defined in: packages/ai/src/stream-to-websocket.ts:63 +Defined in: [packages/ai/src/stream-to-websocket.ts:69](https://github.com/TanStack/ai/blob/main/packages/ai/src/stream-to-websocket.ts#L69) *** @@ -40,7 +40,7 @@ Defined in: packages/ai/src/stream-to-websocket.ts:63 request: Request; ``` -Defined in: packages/ai/src/stream-to-websocket.ts:68 +Defined in: [packages/ai/src/stream-to-websocket.ts:74](https://github.com/TanStack/ai/blob/main/packages/ai/src/stream-to-websocket.ts#L74) Synthetic per-turn request carrying `?runId=` so durability keys correctly. @@ -52,7 +52,7 @@ Synthetic per-turn request carrying `?runId=` so durability keys correctly. runId: string; ``` -Defined in: packages/ai/src/stream-to-websocket.ts:65 +Defined in: [packages/ai/src/stream-to-websocket.ts:71](https://github.com/TanStack/ai/blob/main/packages/ai/src/stream-to-websocket.ts#L71) *** @@ -62,7 +62,7 @@ Defined in: packages/ai/src/stream-to-websocket.ts:65 signal: AbortSignal; ``` -Defined in: packages/ai/src/stream-to-websocket.ts:70 +Defined in: [packages/ai/src/stream-to-websocket.ts:76](https://github.com/TanStack/ai/blob/main/packages/ai/src/stream-to-websocket.ts#L76) Aborts on socket close or an `abort` control frame for this run. @@ -74,4 +74,4 @@ Aborts on socket close or an `abort` control frame for this run. threadId: string; ``` -Defined in: packages/ai/src/stream-to-websocket.ts:64 +Defined in: [packages/ai/src/stream-to-websocket.ts:70](https://github.com/TanStack/ai/blob/main/packages/ai/src/stream-to-websocket.ts#L70) diff --git a/docs/reference/type-aliases/AGUIEvent.md b/docs/reference/type-aliases/AGUIEvent.md index b951982bf1..0144a5d263 100644 --- a/docs/reference/type-aliases/AGUIEvent.md +++ b/docs/reference/type-aliases/AGUIEvent.md @@ -38,6 +38,6 @@ type AGUIEvent = | SubagentErrorEvent; ``` -Defined in: packages/ai/src/types.ts:2038 +Defined in: [packages/ai/src/types.ts:2096](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2096) Union of all AG-UI events. diff --git a/docs/reference/type-aliases/AIAdapter.md b/docs/reference/type-aliases/AIAdapter.md index 631127f259..fb26b52da0 100644 --- a/docs/reference/type-aliases/AIAdapter.md +++ b/docs/reference/type-aliases/AIAdapter.md @@ -21,6 +21,6 @@ type AIAdapter = | AnyFilesAdapter; ``` -Defined in: packages/ai/src/activities/index.ts:370 +Defined in: [packages/ai/src/activities/index.ts:374](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/index.ts#L374) Union of all adapter types across every activity kind diff --git a/docs/reference/type-aliases/AdapterReasoning.md b/docs/reference/type-aliases/AdapterReasoning.md index 9a52f0173e..c9aec1d28d 100644 --- a/docs/reference/type-aliases/AdapterReasoning.md +++ b/docs/reference/type-aliases/AdapterReasoning.md @@ -7,7 +7,7 @@ title: AdapterReasoning type AdapterReasoning = TAdapter extends object ? TCapability : never; ``` -Defined in: packages/ai/src/reasoning.ts:58 +Defined in: [packages/ai/src/reasoning.ts:58](https://github.com/TanStack/ai/blob/main/packages/ai/src/reasoning.ts#L58) The reasoning capability an adapter declares in `'~types'`, or `never`. diff --git a/docs/reference/type-aliases/AdapterYieldChunk.md b/docs/reference/type-aliases/AdapterYieldChunk.md index 52f7215a9a..b682fa0c83 100644 --- a/docs/reference/type-aliases/AdapterYieldChunk.md +++ b/docs/reference/type-aliases/AdapterYieldChunk.md @@ -7,4 +7,4 @@ title: AdapterYieldChunk type AdapterYieldChunk = WithAdapterExtras; ``` -Defined in: packages/ai/src/utilities/adapter-yield-chunk.ts:36 +Defined in: [packages/ai/src/utilities/adapter-yield-chunk.ts:36](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/adapter-yield-chunk.ts#L36) diff --git a/docs/reference/type-aliases/AfterToolCallDecision.md b/docs/reference/type-aliases/AfterToolCallDecision.md index 97fd17b3a3..c1e8c82aa1 100644 --- a/docs/reference/type-aliases/AfterToolCallDecision.md +++ b/docs/reference/type-aliases/AfterToolCallDecision.md @@ -12,7 +12,7 @@ type AfterToolCallDecision = }; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:489 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:519](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L519) Decision returned from onAfterToolCall. - undefined/void: keep the current result diff --git a/docs/reference/type-aliases/AgentLoopStrategy.md b/docs/reference/type-aliases/AgentLoopStrategy.md index fb3d58b416..2c91c14895 100644 --- a/docs/reference/type-aliases/AgentLoopStrategy.md +++ b/docs/reference/type-aliases/AgentLoopStrategy.md @@ -7,7 +7,7 @@ title: AgentLoopStrategy type AgentLoopStrategy = (state) => boolean; ``` -Defined in: packages/ai/src/types.ts:1243 +Defined in: [packages/ai/src/types.ts:1283](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1283) Strategy function that determines whether the agent loop should continue diff --git a/docs/reference/type-aliases/AgentProduces.md b/docs/reference/type-aliases/AgentProduces.md index 86d3769143..730d7448fa 100644 --- a/docs/reference/type-aliases/AgentProduces.md +++ b/docs/reference/type-aliases/AgentProduces.md @@ -18,7 +18,7 @@ type AgentProduces = | string & object; ``` -Defined in: packages/ai/src/activities/chat/agents/define-agent.ts:75 +Defined in: [packages/ai/src/activities/chat/agents/define-agent.ts:84](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/define-agent.ts#L84) What an agent makes. Informative: a host can use it to find an agent by the kind of output it produces. diff --git a/docs/reference/type-aliases/AnyAudioAdapter.md b/docs/reference/type-aliases/AnyAudioAdapter.md index 43fa5c4c69..46011183e9 100644 --- a/docs/reference/type-aliases/AnyAudioAdapter.md +++ b/docs/reference/type-aliases/AnyAudioAdapter.md @@ -7,7 +7,7 @@ title: AnyAudioAdapter type AnyAudioAdapter = AudioAdapter; ``` -Defined in: packages/ai/src/activities/generateAudio/adapter.ts:54 +Defined in: [packages/ai/src/activities/generateAudio/adapter.ts:54](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateAudio/adapter.ts#L54) An AudioAdapter with any/unknown type parameters. Useful as a constraint in generic functions and interfaces. diff --git a/docs/reference/type-aliases/AnyChatMiddleware.md b/docs/reference/type-aliases/AnyChatMiddleware.md index 0e87c27d6e..77825f1e8a 100644 --- a/docs/reference/type-aliases/AnyChatMiddleware.md +++ b/docs/reference/type-aliases/AnyChatMiddleware.md @@ -7,6 +7,6 @@ title: AnyChatMiddleware type AnyChatMiddleware = ChatMiddleware; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:923 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:971](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L971) A permissive middleware constraint that retains the definition parameter. diff --git a/docs/reference/type-aliases/AnyClientTool.md b/docs/reference/type-aliases/AnyClientTool.md index 797cca81cd..47ea354f4e 100644 --- a/docs/reference/type-aliases/AnyClientTool.md +++ b/docs/reference/type-aliases/AnyClientTool.md @@ -9,6 +9,6 @@ type AnyClientTool = | Omit, "execute"> & object; ``` -Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:174 +Defined in: [packages/ai/src/activities/chat/tools/tool-definition.ts:174](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-definition.ts#L174) Union type for any kind of client-side tool (client tool or definition) diff --git a/docs/reference/type-aliases/AnyEmbeddingAdapter.md b/docs/reference/type-aliases/AnyEmbeddingAdapter.md index 3ccb4a85e4..702a61198d 100644 --- a/docs/reference/type-aliases/AnyEmbeddingAdapter.md +++ b/docs/reference/type-aliases/AnyEmbeddingAdapter.md @@ -7,7 +7,7 @@ title: AnyEmbeddingAdapter type AnyEmbeddingAdapter = EmbeddingAdapter; ``` -Defined in: packages/ai/src/activities/embed/adapter.ts:72 +Defined in: [packages/ai/src/activities/embed/adapter.ts:72](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/embed/adapter.ts#L72) An EmbeddingAdapter with any/unknown type parameters. Useful as a constraint in generic functions and interfaces. diff --git a/docs/reference/type-aliases/AnyEvaluateAdapter.md b/docs/reference/type-aliases/AnyEvaluateAdapter.md index 6a5f2a6b1a..0af5aec935 100644 --- a/docs/reference/type-aliases/AnyEvaluateAdapter.md +++ b/docs/reference/type-aliases/AnyEvaluateAdapter.md @@ -7,7 +7,7 @@ title: AnyEvaluateAdapter type AnyEvaluateAdapter = EvaluateAdapter; ``` -Defined in: packages/ai/src/activities/evaluate/adapter.ts:181 +Defined in: [packages/ai/src/activities/evaluate/adapter.ts:257](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/evaluate/adapter.ts#L257) An EvaluateAdapter with any/unknown type parameters. Useful as a constraint in generic functions and interfaces. diff --git a/docs/reference/type-aliases/AnyFilesAdapter.md b/docs/reference/type-aliases/AnyFilesAdapter.md index f93f3a13f2..c09b5cbab6 100644 --- a/docs/reference/type-aliases/AnyFilesAdapter.md +++ b/docs/reference/type-aliases/AnyFilesAdapter.md @@ -7,4 +7,4 @@ title: AnyFilesAdapter type AnyFilesAdapter = FilesAdapter; ``` -Defined in: packages/ai/src/activities/files/adapter.ts:83 +Defined in: [packages/ai/src/activities/files/adapter.ts:83](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/files/adapter.ts#L83) diff --git a/docs/reference/type-aliases/AnyGenerationMiddleware.md b/docs/reference/type-aliases/AnyGenerationMiddleware.md index 27ab0836cd..29c5e4316a 100644 --- a/docs/reference/type-aliases/AnyGenerationMiddleware.md +++ b/docs/reference/type-aliases/AnyGenerationMiddleware.md @@ -7,6 +7,6 @@ title: AnyGenerationMiddleware type AnyGenerationMiddleware = GenerationMiddleware; ``` -Defined in: packages/ai/src/activities/middleware/types.ts:223 +Defined in: [packages/ai/src/activities/middleware/types.ts:223](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/middleware/types.ts#L223) A `GenerationMiddleware` with a permissive context — for use as a constraint. diff --git a/docs/reference/type-aliases/AnyImageAdapter.md b/docs/reference/type-aliases/AnyImageAdapter.md index 75ab6824ae..9ec328b3bf 100644 --- a/docs/reference/type-aliases/AnyImageAdapter.md +++ b/docs/reference/type-aliases/AnyImageAdapter.md @@ -7,7 +7,7 @@ title: AnyImageAdapter type AnyImageAdapter = ImageAdapter; ``` -Defined in: packages/ai/src/activities/generateImage/adapter.ts:86 +Defined in: [packages/ai/src/activities/generateImage/adapter.ts:86](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateImage/adapter.ts#L86) An ImageAdapter with any/unknown type parameters. Useful as a constraint in generic functions and interfaces. diff --git a/docs/reference/type-aliases/AnyLiveVideoAdapter.md b/docs/reference/type-aliases/AnyLiveVideoAdapter.md index 37ccf5178b..6c33974927 100644 --- a/docs/reference/type-aliases/AnyLiveVideoAdapter.md +++ b/docs/reference/type-aliases/AnyLiveVideoAdapter.md @@ -7,7 +7,7 @@ title: AnyLiveVideoAdapter type AnyLiveVideoAdapter = LiveVideoAdapter; ``` -Defined in: packages/ai/src/activities/generateLiveVideo/adapter.ts:64 +Defined in: [packages/ai/src/activities/generateLiveVideo/adapter.ts:64](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateLiveVideo/adapter.ts#L64) A LiveVideoAdapter with any/unknown type parameters. Useful as a constraint in generic functions and interfaces. diff --git a/docs/reference/type-aliases/AnyRerankAdapter.md b/docs/reference/type-aliases/AnyRerankAdapter.md index 6ed5d8c760..32f5e034d2 100644 --- a/docs/reference/type-aliases/AnyRerankAdapter.md +++ b/docs/reference/type-aliases/AnyRerankAdapter.md @@ -7,7 +7,7 @@ title: AnyRerankAdapter type AnyRerankAdapter = RerankAdapter; ``` -Defined in: packages/ai/src/activities/rerank/adapter.ts:55 +Defined in: [packages/ai/src/activities/rerank/adapter.ts:55](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/rerank/adapter.ts#L55) A RerankAdapter with any/unknown type parameters. Useful as a constraint in generic functions and interfaces. diff --git a/docs/reference/type-aliases/AnyServerTool.md b/docs/reference/type-aliases/AnyServerTool.md index 23d16120f5..57759d5364 100644 --- a/docs/reference/type-aliases/AnyServerTool.md +++ b/docs/reference/type-aliases/AnyServerTool.md @@ -7,7 +7,7 @@ title: AnyServerTool type AnyServerTool = Omit, "execute"> & object; ``` -Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:139 +Defined in: [packages/ai/src/activities/chat/tools/tool-definition.ts:139](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-definition.ts#L139) Broad server-tool shape for heterogeneous internal collections. diff --git a/docs/reference/type-aliases/AnySummarizeAdapter.md b/docs/reference/type-aliases/AnySummarizeAdapter.md index 19e38a4f83..448af6aaf6 100644 --- a/docs/reference/type-aliases/AnySummarizeAdapter.md +++ b/docs/reference/type-aliases/AnySummarizeAdapter.md @@ -7,7 +7,7 @@ title: AnySummarizeAdapter type AnySummarizeAdapter = SummarizeAdapter; ``` -Defined in: packages/ai/src/activities/summarize/adapter.ts:67 +Defined in: [packages/ai/src/activities/summarize/adapter.ts:67](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/summarize/adapter.ts#L67) A SummarizeAdapter with any/unknown type parameters. Useful as a constraint in generic functions and interfaces. diff --git a/docs/reference/type-aliases/AnyTTSAdapter.md b/docs/reference/type-aliases/AnyTTSAdapter.md index 97ad6cdf8b..0432ccacb8 100644 --- a/docs/reference/type-aliases/AnyTTSAdapter.md +++ b/docs/reference/type-aliases/AnyTTSAdapter.md @@ -7,7 +7,7 @@ title: AnyTTSAdapter type AnyTTSAdapter = TTSAdapter; ``` -Defined in: packages/ai/src/activities/generateSpeech/adapter.ts:91 +Defined in: [packages/ai/src/activities/generateSpeech/adapter.ts:91](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateSpeech/adapter.ts#L91) A TTSAdapter with any/unknown type parameters. Useful as a constraint in generic functions and interfaces. diff --git a/docs/reference/type-aliases/AnyTextAdapter.md b/docs/reference/type-aliases/AnyTextAdapter.md index 3d5bb48384..96bba909e6 100644 --- a/docs/reference/type-aliases/AnyTextAdapter.md +++ b/docs/reference/type-aliases/AnyTextAdapter.md @@ -7,7 +7,7 @@ title: AnyTextAdapter type AnyTextAdapter = TextAdapter; ``` -Defined in: packages/ai/src/activities/chat/adapter.ts:236 +Defined in: [packages/ai/src/activities/chat/adapter.ts:237](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/adapter.ts#L237) A TextAdapter with any/unknown type parameters. Useful as a constraint in generic functions and interfaces. diff --git a/docs/reference/type-aliases/AnyTool.md b/docs/reference/type-aliases/AnyTool.md index 38e99be0ce..1f62f9335a 100644 --- a/docs/reference/type-aliases/AnyTool.md +++ b/docs/reference/type-aliases/AnyTool.md @@ -7,7 +7,7 @@ title: AnyTool type AnyTool = Omit, "execute"> & object; ``` -Defined in: packages/ai/src/types.ts:1105 +Defined in: [packages/ai/src/types.ts:1145](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1145) ## Type Declaration diff --git a/docs/reference/type-aliases/AnyTranscriptionAdapter.md b/docs/reference/type-aliases/AnyTranscriptionAdapter.md index 98692211ae..e886c62e28 100644 --- a/docs/reference/type-aliases/AnyTranscriptionAdapter.md +++ b/docs/reference/type-aliases/AnyTranscriptionAdapter.md @@ -7,7 +7,7 @@ title: AnyTranscriptionAdapter type AnyTranscriptionAdapter = TranscriptionAdapter; ``` -Defined in: packages/ai/src/activities/generateTranscription/adapter.ts:54 +Defined in: [packages/ai/src/activities/generateTranscription/adapter.ts:54](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateTranscription/adapter.ts#L54) A TranscriptionAdapter with any/unknown type parameters. Useful as a constraint in generic functions and interfaces. diff --git a/docs/reference/type-aliases/AnyVideoAdapter.md b/docs/reference/type-aliases/AnyVideoAdapter.md index 22658b9743..2c291ec7d1 100644 --- a/docs/reference/type-aliases/AnyVideoAdapter.md +++ b/docs/reference/type-aliases/AnyVideoAdapter.md @@ -7,7 +7,7 @@ title: AnyVideoAdapter type AnyVideoAdapter = VideoAdapter; ``` -Defined in: packages/ai/src/activities/generateVideo/adapter.ts:184 +Defined in: [packages/ai/src/activities/generateVideo/adapter.ts:179](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateVideo/adapter.ts#L179) A VideoAdapter with any/unknown type parameters. Useful as a constraint in generic functions and interfaces. diff --git a/docs/reference/type-aliases/AnyVoiceAdapter.md b/docs/reference/type-aliases/AnyVoiceAdapter.md index 303f3827bb..9a0bb17019 100644 --- a/docs/reference/type-aliases/AnyVoiceAdapter.md +++ b/docs/reference/type-aliases/AnyVoiceAdapter.md @@ -7,7 +7,7 @@ title: AnyVoiceAdapter type AnyVoiceAdapter = VoiceAdapter; ``` -Defined in: packages/ai/src/activities/generateVoice/adapter.ts:54 +Defined in: [packages/ai/src/activities/generateVoice/adapter.ts:54](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateVoice/adapter.ts#L54) A VoiceAdapter with any/unknown type parameters. Useful as a constraint in generic functions and interfaces. diff --git a/docs/reference/type-aliases/AnyWorldAdapter.md b/docs/reference/type-aliases/AnyWorldAdapter.md index be0362471d..7b70193c4d 100644 --- a/docs/reference/type-aliases/AnyWorldAdapter.md +++ b/docs/reference/type-aliases/AnyWorldAdapter.md @@ -7,7 +7,7 @@ title: AnyWorldAdapter type AnyWorldAdapter = WorldAdapter; ``` -Defined in: packages/ai/src/activities/generateWorld/adapter.ts:63 +Defined in: [packages/ai/src/activities/generateWorld/adapter.ts:63](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/generateWorld/adapter.ts#L63) A WorldAdapter with any/unknown type parameters. Useful as a constraint in generic functions and interfaces. diff --git a/docs/reference/type-aliases/ApprovalCapabilityOf.md b/docs/reference/type-aliases/ApprovalCapabilityOf.md index a77a19771e..6e6c751092 100644 --- a/docs/reference/type-aliases/ApprovalCapabilityOf.md +++ b/docs/reference/type-aliases/ApprovalCapabilityOf.md @@ -7,7 +7,7 @@ title: ApprovalCapabilityOf type ApprovalCapabilityOf = TTool extends ToolApprovalCapabilityMarker ? TNeeds : false; ``` -Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:44 +Defined in: [packages/ai/src/activities/chat/tools/tool-definition.ts:44](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-definition.ts#L44) ## Type Parameters diff --git a/docs/reference/type-aliases/ApprovalSchemaConfig.md b/docs/reference/type-aliases/ApprovalSchemaConfig.md index 3b9ddcd24a..16e4f6b3a2 100644 --- a/docs/reference/type-aliases/ApprovalSchemaConfig.md +++ b/docs/reference/type-aliases/ApprovalSchemaConfig.md @@ -16,4 +16,4 @@ type ApprovalSchemaConfig = }; ``` -Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:32 +Defined in: [packages/ai/src/activities/chat/tools/tool-definition.ts:32](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-definition.ts#L32) diff --git a/docs/reference/type-aliases/ApprovalSchemaOf.md b/docs/reference/type-aliases/ApprovalSchemaOf.md index ddcc6e6d21..4253cfd171 100644 --- a/docs/reference/type-aliases/ApprovalSchemaOf.md +++ b/docs/reference/type-aliases/ApprovalSchemaOf.md @@ -7,7 +7,7 @@ title: ApprovalSchemaOf type ApprovalSchemaOf = TTool extends ToolApprovalCapabilityMarker ? TSchema : undefined; ``` -Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:49 +Defined in: [packages/ai/src/activities/chat/tools/tool-definition.ts:49](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-definition.ts#L49) ## Type Parameters diff --git a/docs/reference/type-aliases/BatchInterruptErrorCode.md b/docs/reference/type-aliases/BatchInterruptErrorCode.md index c589e98305..afaa44e7d2 100644 --- a/docs/reference/type-aliases/BatchInterruptErrorCode.md +++ b/docs/reference/type-aliases/BatchInterruptErrorCode.md @@ -20,4 +20,4 @@ type BatchInterruptErrorCode = | "conflict"; ``` -Defined in: packages/ai/src/interrupts.ts:26 +Defined in: [packages/ai/src/interrupts.ts:26](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupts.ts#L26) diff --git a/docs/reference/type-aliases/BeforeToolCallDecision.md b/docs/reference/type-aliases/BeforeToolCallDecision.md index 226d391e53..c01277622f 100644 --- a/docs/reference/type-aliases/BeforeToolCallDecision.md +++ b/docs/reference/type-aliases/BeforeToolCallDecision.md @@ -22,7 +22,7 @@ type BeforeToolCallDecision = }; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:453 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:469](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L469) Decision returned from onBeforeToolCall. - undefined/void: continue with normal execution diff --git a/docs/reference/type-aliases/Capability.md b/docs/reference/type-aliases/Capability.md index b1a63a3e72..1d67af7951 100644 --- a/docs/reference/type-aliases/Capability.md +++ b/docs/reference/type-aliases/Capability.md @@ -7,7 +7,7 @@ title: Capability type Capability = readonly [CapabilityGetter, CapabilityProvider] & object; ``` -Defined in: packages/ai/src/activities/chat/middleware/capabilities.ts:36 +Defined in: [packages/ai/src/activities/chat/middleware/capabilities.ts:36](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/capabilities.ts#L36) A capability handle. It is BOTH a `[get, provide]` tuple (array-destructurable) AND the identity used in middleware `requires`/`provides` declarations. diff --git a/docs/reference/type-aliases/CapabilityHandle.md b/docs/reference/type-aliases/CapabilityHandle.md index 535259e3bb..ca99f8e4aa 100644 --- a/docs/reference/type-aliases/CapabilityHandle.md +++ b/docs/reference/type-aliases/CapabilityHandle.md @@ -7,7 +7,7 @@ title: CapabilityHandle type CapabilityHandle = Capability; ``` -Defined in: packages/ai/src/activities/chat/middleware/capabilities.ts:54 +Defined in: [packages/ai/src/activities/chat/middleware/capabilities.ts:54](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/capabilities.ts#L54) A capability handle with permissive value/name — for use as a constraint in `requires`/`provides` arrays. Concentrates `any` in one named alias (same diff --git a/docs/reference/type-aliases/CapabilityProvider.md b/docs/reference/type-aliases/CapabilityProvider.md index 97e959e485..19fbc10ed2 100644 --- a/docs/reference/type-aliases/CapabilityProvider.md +++ b/docs/reference/type-aliases/CapabilityProvider.md @@ -7,7 +7,7 @@ title: CapabilityProvider type CapabilityProvider = (ctx, value) => void; ``` -Defined in: packages/ai/src/activities/chat/middleware/capabilities.ts:23 +Defined in: [packages/ai/src/activities/chat/middleware/capabilities.ts:23](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/capabilities.ts#L23) Writes a capability value onto a context. diff --git a/docs/reference/type-aliases/ChatMiddlewarePhase.md b/docs/reference/type-aliases/ChatMiddlewarePhase.md index 9a3a2aafe7..968d001052 100644 --- a/docs/reference/type-aliases/ChatMiddlewarePhase.md +++ b/docs/reference/type-aliases/ChatMiddlewarePhase.md @@ -14,7 +14,7 @@ type ChatMiddlewarePhase = | "structuredOutput"; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:95 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:96](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L96) Phase of the chat middleware lifecycle. - 'init': Initial config transform before the chat engine starts diff --git a/docs/reference/type-aliases/ChatResumeGenericResolution.md b/docs/reference/type-aliases/ChatResumeGenericResolution.md index 0bc1721f5f..f732f95a3e 100644 --- a/docs/reference/type-aliases/ChatResumeGenericResolution.md +++ b/docs/reference/type-aliases/ChatResumeGenericResolution.md @@ -17,4 +17,4 @@ type ChatResumeGenericResolution = }; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:400 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:414](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L414) diff --git a/docs/reference/type-aliases/ChatStream.md b/docs/reference/type-aliases/ChatStream.md index a9ed40e5de..9627d75ae2 100644 --- a/docs/reference/type-aliases/ChatStream.md +++ b/docs/reference/type-aliases/ChatStream.md @@ -9,7 +9,7 @@ type ChatStream = AsyncIterable< | KnownCustomEvent>; ``` -Defined in: packages/ai/src/types.ts:1908 +Defined in: [packages/ai/src/types.ts:1966](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1966) The default chat streaming result: standard chunks plus every typed framework CUSTOM event, with the `value: any` catch-all excluded so diff --git a/docs/reference/type-aliases/ClientToolDeclaration.md b/docs/reference/type-aliases/ClientToolDeclaration.md index 2107f8763c..86bf598e44 100644 --- a/docs/reference/type-aliases/ClientToolDeclaration.md +++ b/docs/reference/type-aliases/ClientToolDeclaration.md @@ -7,7 +7,7 @@ title: ClientToolDeclaration type ClientToolDeclaration = object; ``` -Defined in: packages/ai/src/utilities/chat-params.ts:313 +Defined in: [packages/ai/src/utilities/chat-params.ts:313](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/chat-params.ts#L313) Client-declared tool stub (no execute). `name` is `string`, so arrays that include these stubs intentionally widen tool-name discrimination — @@ -21,7 +21,7 @@ pass server tools alone when you need a closed name union. description: string; ``` -Defined in: packages/ai/src/utilities/chat-params.ts:315 +Defined in: [packages/ai/src/utilities/chat-params.ts:315](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/chat-params.ts#L315) *** @@ -31,7 +31,7 @@ Defined in: packages/ai/src/utilities/chat-params.ts:315 inputSchema: JSONSchema; ``` -Defined in: packages/ai/src/utilities/chat-params.ts:316 +Defined in: [packages/ai/src/utilities/chat-params.ts:316](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/chat-params.ts#L316) *** @@ -41,4 +41,4 @@ Defined in: packages/ai/src/utilities/chat-params.ts:316 name: string; ``` -Defined in: packages/ai/src/utilities/chat-params.ts:314 +Defined in: [packages/ai/src/utilities/chat-params.ts:314](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/chat-params.ts#L314) diff --git a/docs/reference/type-aliases/ConstrainedContent.md b/docs/reference/type-aliases/ConstrainedContent.md index be002265f1..731ff1e670 100644 --- a/docs/reference/type-aliases/ConstrainedContent.md +++ b/docs/reference/type-aliases/ConstrainedContent.md @@ -10,7 +10,7 @@ type ConstrainedContent = | ContentPartForInputModalitiesTypes[]; ``` -Defined in: packages/ai/src/types.ts:368 +Defined in: [packages/ai/src/types.ts:371](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L371) Type for message content constrained by supported modalities. When modalities is ['text', 'image'], only TextPart and ImagePart are allowed in the array. diff --git a/docs/reference/type-aliases/ConstrainedModelMessage.md b/docs/reference/type-aliases/ConstrainedModelMessage.md index cbf9132870..4c284c356d 100644 --- a/docs/reference/type-aliases/ConstrainedModelMessage.md +++ b/docs/reference/type-aliases/ConstrainedModelMessage.md @@ -7,7 +7,7 @@ title: ConstrainedModelMessage type ConstrainedModelMessage = Omit & object; ``` -Defined in: packages/ai/src/types.ts:810 +Defined in: [packages/ai/src/types.ts:828](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L828) A ModelMessage with content constrained to only allow content parts matching the specified input modalities. diff --git a/docs/reference/type-aliases/ContentPart.md b/docs/reference/type-aliases/ContentPart.md index 1e876ff952..60f84b7140 100644 --- a/docs/reference/type-aliases/ContentPart.md +++ b/docs/reference/type-aliases/ContentPart.md @@ -12,7 +12,7 @@ type ContentPart = | DocumentPart; ``` -Defined in: packages/ai/src/types.ts:327 +Defined in: [packages/ai/src/types.ts:330](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L330) Union type for all multimodal content parts. diff --git a/docs/reference/type-aliases/ContentPartForInputModalitiesTypes.md b/docs/reference/type-aliases/ContentPartForInputModalitiesTypes.md index 2cd647b069..9a2be881fc 100644 --- a/docs/reference/type-aliases/ContentPartForInputModalitiesTypes.md +++ b/docs/reference/type-aliases/ContentPartForInputModalitiesTypes.md @@ -9,7 +9,7 @@ type ContentPartForInputModalitiesTypes = Extract; ``` -Defined in: packages/ai/src/types.ts:344 +Defined in: [packages/ai/src/types.ts:347](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L347) Helper type to filter ContentPart union to only include specific modalities. Used to constrain message content based on model capabilities. diff --git a/docs/reference/type-aliases/ContentPartSource.md b/docs/reference/type-aliases/ContentPartSource.md index 4f1ff088b0..6713fe39e9 100644 --- a/docs/reference/type-aliases/ContentPartSource.md +++ b/docs/reference/type-aliases/ContentPartSource.md @@ -10,7 +10,7 @@ type ContentPartSource = | ContentPartFileSource; ``` -Defined in: packages/ai/src/types.ts:279 +Defined in: [packages/ai/src/types.ts:282](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L282) Where a media part's bytes come from: inline data, a URL, or a provider file handle. Same members as AG-UI `PartSource`. diff --git a/docs/reference/type-aliases/DebugOption.md b/docs/reference/type-aliases/DebugOption.md index 115cbb9236..f36992ca3c 100644 --- a/docs/reference/type-aliases/DebugOption.md +++ b/docs/reference/type-aliases/DebugOption.md @@ -7,6 +7,6 @@ title: DebugOption type DebugOption = boolean | DebugConfig; ``` -Defined in: packages/ai/src/logger/types.ts:83 +Defined in: [packages/ai/src/logger/types.ts:83](https://github.com/TanStack/ai/blob/main/packages/ai/src/logger/types.ts#L83) The shape accepted by the `debug` option on every `@tanstack/ai` activity. Pass `true` to enable all categories with the default console logger; `false` to silence everything including errors; an object for granular control. diff --git a/docs/reference/type-aliases/DeepPartial.md b/docs/reference/type-aliases/DeepPartial.md index 0a968269ba..137254d9f0 100644 --- a/docs/reference/type-aliases/DeepPartial.md +++ b/docs/reference/type-aliases/DeepPartial.md @@ -7,7 +7,7 @@ title: DeepPartial type DeepPartial = T extends ReadonlyArray ? DeepPartial[] : T extends object ? { [K in keyof T]?: DeepPartial } : T; ``` -Defined in: packages/ai/src/types.ts:585 +Defined in: [packages/ai/src/types.ts:588](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L588) Recursive `Partial` — every nested field becomes optional. Used as the `partial` type on a streaming structured-output part since the progressive diff --git a/docs/reference/type-aliases/EmbeddingContentParts.md b/docs/reference/type-aliases/EmbeddingContentParts.md index 2e4f59e05b..74fb203765 100644 --- a/docs/reference/type-aliases/EmbeddingContentParts.md +++ b/docs/reference/type-aliases/EmbeddingContentParts.md @@ -9,7 +9,7 @@ type EmbeddingContentParts = ( | ImagePart)[]; ``` -Defined in: packages/ai/src/types.ts:3254 +Defined in: [packages/ai/src/types.ts:3302](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3302) A fused multi-part embedding item: all parts are embedded together into a single vector (e.g. a product photo plus its caption). Written as a nested diff --git a/docs/reference/type-aliases/EmbeddingInputItem.md b/docs/reference/type-aliases/EmbeddingInputItem.md index c094a678ee..86d28e6427 100644 --- a/docs/reference/type-aliases/EmbeddingInputItem.md +++ b/docs/reference/type-aliases/EmbeddingInputItem.md @@ -11,7 +11,7 @@ type EmbeddingInputItem = | EmbeddingContentParts; ``` -Defined in: packages/ai/src/types.ts:3263 +Defined in: [packages/ai/src/types.ts:3311](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3311) One embeddable item, producing exactly one vector. A bare string is shorthand for a text part; a nested [EmbeddingContentParts](EmbeddingContentParts.md) array diff --git a/docs/reference/type-aliases/EmbeddingInputItemFor.md b/docs/reference/type-aliases/EmbeddingInputItemFor.md index d74f53ce53..02d03ec2c3 100644 --- a/docs/reference/type-aliases/EmbeddingInputItemFor.md +++ b/docs/reference/type-aliases/EmbeddingInputItemFor.md @@ -10,7 +10,7 @@ type EmbeddingInputItemFor = | EmbeddingItemByModality[TModalities]; ``` -Defined in: packages/ai/src/types.ts:3283 +Defined in: [packages/ai/src/types.ts:3331](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3331) Embedding item type narrowed to the modalities a specific model supports. `EmbeddingInputItemFor<'text'>` (a text-only model) is `string | TextPart`; diff --git a/docs/reference/type-aliases/EmbeddingModality.md b/docs/reference/type-aliases/EmbeddingModality.md index 75d3b01a34..49879dc370 100644 --- a/docs/reference/type-aliases/EmbeddingModality.md +++ b/docs/reference/type-aliases/EmbeddingModality.md @@ -7,7 +7,7 @@ title: EmbeddingModality type EmbeddingModality = "text" | "image"; ``` -Defined in: packages/ai/src/types.ts:3233 +Defined in: [packages/ai/src/types.ts:3281](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3281) Input modalities an embedding model can accept. Unlike [MediaPromptModality](MediaPromptModality.md), `'text'` is listed explicitly because diff --git a/docs/reference/type-aliases/EmbeddingModelInputModalitiesByName.md b/docs/reference/type-aliases/EmbeddingModelInputModalitiesByName.md index 41cdc1dfc3..7abb200094 100644 --- a/docs/reference/type-aliases/EmbeddingModelInputModalitiesByName.md +++ b/docs/reference/type-aliases/EmbeddingModelInputModalitiesByName.md @@ -7,7 +7,7 @@ title: EmbeddingModelInputModalitiesByName type EmbeddingModelInputModalitiesByName = Record>; ``` -Defined in: packages/ai/src/types.ts:3240 +Defined in: [packages/ai/src/types.ts:3288](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3288) Per-model map from model name to the input modalities it accepts, used as an adapter type parameter (`TModelInputModalitiesByName`). Models absent diff --git a/docs/reference/type-aliases/EvaluateResult.md b/docs/reference/type-aliases/EvaluateResult.md index 5bbb5dc811..2124b2cf28 100644 --- a/docs/reference/type-aliases/EvaluateResult.md +++ b/docs/reference/type-aliases/EvaluateResult.md @@ -7,7 +7,7 @@ title: EvaluateResult type EvaluateResult = { [K in keyof TQuestions as K extends typeof RESERVED_QUESTION_KEY ? never : K]: InferEvaluateAnswer } & object; ``` -Defined in: packages/ai/src/activities/evaluate/index.ts:131 +Defined in: [packages/ai/src/activities/evaluate/index.ts:132](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/evaluate/index.ts#L132) Result of `decide()`. Each question key is a top-level answer. `meta` holds the resolved model id and usage. diff --git a/docs/reference/type-aliases/FetchWrapper.md b/docs/reference/type-aliases/FetchWrapper.md index 203faf97d6..80f5d50856 100644 --- a/docs/reference/type-aliases/FetchWrapper.md +++ b/docs/reference/type-aliases/FetchWrapper.md @@ -7,7 +7,7 @@ title: FetchWrapper type FetchWrapper = (next) => typeof fetch; ``` -Defined in: packages/ai/src/types.ts:1287 +Defined in: [packages/ai/src/types.ts:1327](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1327) Wraps the fetch of a model call. It gets the next fetch and gives back a new fetch. A wrapper can change the URL, the headers, the request, or the diff --git a/docs/reference/type-aliases/FileUploadInput.md b/docs/reference/type-aliases/FileUploadInput.md index ce04168db4..f6e8970f2e 100644 --- a/docs/reference/type-aliases/FileUploadInput.md +++ b/docs/reference/type-aliases/FileUploadInput.md @@ -13,7 +13,7 @@ type FileUploadInput = }; ``` -Defined in: packages/ai/src/activities/files/adapter.ts:20 +Defined in: [packages/ai/src/activities/files/adapter.ts:20](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/files/adapter.ts#L20) Input to [FilesAdapter.upload](../interfaces/FilesAdapter.md#upload). Either a `Blob` (memory-efficient, preferred for large assets) or base64 `data` plus its `mimeType`. diff --git a/docs/reference/type-aliases/GeneratedAudio.md b/docs/reference/type-aliases/GeneratedAudio.md index d95b686dd4..413ea0c2c9 100644 --- a/docs/reference/type-aliases/GeneratedAudio.md +++ b/docs/reference/type-aliases/GeneratedAudio.md @@ -7,7 +7,7 @@ title: GeneratedAudio type GeneratedAudio = GeneratedMediaSource & object; ``` -Defined in: packages/ai/src/types.ts:2501 +Defined in: [packages/ai/src/types.ts:2559](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2559) A single generated audio output diff --git a/docs/reference/type-aliases/GeneratedImage.md b/docs/reference/type-aliases/GeneratedImage.md index d2249ad9f4..25614c467a 100644 --- a/docs/reference/type-aliases/GeneratedImage.md +++ b/docs/reference/type-aliases/GeneratedImage.md @@ -7,7 +7,7 @@ title: GeneratedImage type GeneratedImage = GeneratedMediaSource & object; ``` -Defined in: packages/ai/src/types.ts:2444 +Defined in: [packages/ai/src/types.ts:2502](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2502) A single generated image diff --git a/docs/reference/type-aliases/GeneratedMediaSource.md b/docs/reference/type-aliases/GeneratedMediaSource.md index 14c45ebd16..08751c3d47 100644 --- a/docs/reference/type-aliases/GeneratedMediaSource.md +++ b/docs/reference/type-aliases/GeneratedMediaSource.md @@ -15,7 +15,7 @@ type GeneratedMediaSource = }; ``` -Defined in: packages/ai/src/types.ts:2385 +Defined in: [packages/ai/src/types.ts:2443](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2443) Source of a generated media asset. Exactly one of `url` or `b64Json` is present; the other is absent. Modeled as a mutually-exclusive union so the diff --git a/docs/reference/type-aliases/GenerationActivity.md b/docs/reference/type-aliases/GenerationActivity.md index 2d3f2c1116..7b33df018f 100644 --- a/docs/reference/type-aliases/GenerationActivity.md +++ b/docs/reference/type-aliases/GenerationActivity.md @@ -20,7 +20,7 @@ type GenerationActivity = | "liveVideo"; ``` -Defined in: packages/ai/src/activities/middleware/types.ts:37 +Defined in: [packages/ai/src/activities/middleware/types.ts:37](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/middleware/types.ts#L37) The activity an observability event describes. diff --git a/docs/reference/type-aliases/GenerationResultTransform.md b/docs/reference/type-aliases/GenerationResultTransform.md index 524de2f979..58fd1188e0 100644 --- a/docs/reference/type-aliases/GenerationResultTransform.md +++ b/docs/reference/type-aliases/GenerationResultTransform.md @@ -7,7 +7,7 @@ title: GenerationResultTransform type GenerationResultTransform = (result, ctx) => TResult | undefined | Promise; ``` -Defined in: packages/ai/src/activities/middleware/types.ts:122 +Defined in: [packages/ai/src/activities/middleware/types.ts:122](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/middleware/types.ts#L122) A transform middleware registers on `ctx.resultTransforms` to rewrite the raw adapter result before it is returned or streamed. Return a new result to diff --git a/docs/reference/type-aliases/GenericInterruptContinuationReadResult.md b/docs/reference/type-aliases/GenericInterruptContinuationReadResult.md index 1c338cc374..f96cd2a29d 100644 --- a/docs/reference/type-aliases/GenericInterruptContinuationReadResult.md +++ b/docs/reference/type-aliases/GenericInterruptContinuationReadResult.md @@ -18,4 +18,4 @@ type GenericInterruptContinuationReadResult = }; ``` -Defined in: packages/ai/src/generic-interrupt-continuation.ts:29 +Defined in: [packages/ai/src/generic-interrupt-continuation.ts:29](https://github.com/TanStack/ai/blob/main/packages/ai/src/generic-interrupt-continuation.ts#L29) diff --git a/docs/reference/type-aliases/GenericInterruptRequest.md b/docs/reference/type-aliases/GenericInterruptRequest.md index ed9f00829f..ff25f8e08c 100644 --- a/docs/reference/type-aliases/GenericInterruptRequest.md +++ b/docs/reference/type-aliases/GenericInterruptRequest.md @@ -7,7 +7,7 @@ title: GenericInterruptRequest type GenericInterruptRequest = [TDefinition] extends [never] ? never : TDefinition extends InterruptDefinition ? GenericInterruptRequestFor : GenericInterruptRequestBase; ``` -Defined in: packages/ai/src/interrupt-definition.ts:103 +Defined in: [packages/ai/src/interrupt-definition.ts:103](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupt-definition.ts#L103) ## Type Parameters diff --git a/docs/reference/type-aliases/GenericInterruptResolution.md b/docs/reference/type-aliases/GenericInterruptResolution.md index 73c0475f9c..c2e4282f2d 100644 --- a/docs/reference/type-aliases/GenericInterruptResolution.md +++ b/docs/reference/type-aliases/GenericInterruptResolution.md @@ -17,7 +17,7 @@ type GenericInterruptResolution = TDefinition extends AnyInterruptD } : never; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:128 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:129](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L129) ## Type Parameters diff --git a/docs/reference/type-aliases/GuardToolCallDecision.md b/docs/reference/type-aliases/GuardToolCallDecision.md new file mode 100644 index 0000000000..d7185c0676 --- /dev/null +++ b/docs/reference/type-aliases/GuardToolCallDecision.md @@ -0,0 +1,27 @@ +--- +id: GuardToolCallDecision +title: GuardToolCallDecision +--- + +```ts +type GuardToolCallDecision = + | void + | undefined + | null + | { + result: unknown; + type: "skip"; +} + | { + reason?: string; + type: "abort"; +}; +``` + +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:484](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L484) + +Decision returned from onGuardToolCall. A guard cannot change the args. +- undefined/void: allow the call. The next guard runs. +- { type: 'skip', result }: deny the call. The tool does not run, and the + model gets `result`, as for an `onBeforeToolCall` skip. +- { type: 'abort', reason }: abort the entire chat run diff --git a/docs/reference/type-aliases/InboundFrame.md b/docs/reference/type-aliases/InboundFrame.md index 228f098679..8016747c04 100644 --- a/docs/reference/type-aliases/InboundFrame.md +++ b/docs/reference/type-aliases/InboundFrame.md @@ -15,6 +15,6 @@ type InboundFrame = }; ``` -Defined in: packages/ai/src/stream-to-websocket.ts:25 +Defined in: [packages/ai/src/stream-to-websocket.ts:31](https://github.com/TanStack/ai/blob/main/packages/ai/src/stream-to-websocket.ts#L31) One inbound WS text frame, after JSON parse + shape discrimination. diff --git a/docs/reference/type-aliases/InferSchemaType.md b/docs/reference/type-aliases/InferSchemaType.md index a96ccad03a..c56ebee0f9 100644 --- a/docs/reference/type-aliases/InferSchemaType.md +++ b/docs/reference/type-aliases/InferSchemaType.md @@ -7,7 +7,7 @@ title: InferSchemaType type InferSchemaType = T extends StandardJSONSchemaV1 ? TInput : T extends StandardSchemaV1 ? TInput : unknown; ``` -Defined in: packages/ai/src/types.ts:186 +Defined in: [packages/ai/src/types.ts:189](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L189) Infer the TypeScript type from a schema. For Standard JSON Schema compliant schemas, extracts the input type. diff --git a/docs/reference/type-aliases/InferToolInput.md b/docs/reference/type-aliases/InferToolInput.md index 974fef3e20..66a72f9d62 100644 --- a/docs/reference/type-aliases/InferToolInput.md +++ b/docs/reference/type-aliases/InferToolInput.md @@ -7,7 +7,7 @@ title: InferToolInput type InferToolInput = T extends object ? TInput extends JSONSchema ? unknown : InferSchemaType : unknown; ``` -Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:193 +Defined in: [packages/ai/src/activities/chat/tools/tool-definition.ts:193](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-definition.ts#L193) Extract the input type from a tool (inferred from Standard JSON Schema, or `unknown` for plain JSONSchema) diff --git a/docs/reference/type-aliases/InferToolName.md b/docs/reference/type-aliases/InferToolName.md index 673df3ebb7..9d0fff259a 100644 --- a/docs/reference/type-aliases/InferToolName.md +++ b/docs/reference/type-aliases/InferToolName.md @@ -7,7 +7,7 @@ title: InferToolName type InferToolName = T extends object ? N : never; ``` -Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:188 +Defined in: [packages/ai/src/activities/chat/tools/tool-definition.ts:188](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-definition.ts#L188) Extract the tool name as a literal type diff --git a/docs/reference/type-aliases/InferToolOutput.md b/docs/reference/type-aliases/InferToolOutput.md index c6121a5b36..3408bf3f07 100644 --- a/docs/reference/type-aliases/InferToolOutput.md +++ b/docs/reference/type-aliases/InferToolOutput.md @@ -7,7 +7,7 @@ title: InferToolOutput type InferToolOutput = T extends object ? TOutput extends StandardJSONSchemaV1 ? InferSchemaType : TOutput extends StandardSchemaV1 ? InferSchemaType : TOutput extends JSONSchema ? unknown : InferSchemaType : unknown; ``` -Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:202 +Defined in: [packages/ai/src/activities/chat/tools/tool-definition.ts:202](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-definition.ts#L202) Extract the output type from a tool (inferred from Standard JSON Schema, or `unknown` for plain JSONSchema) diff --git a/docs/reference/type-aliases/InputModalitiesTypes.md b/docs/reference/type-aliases/InputModalitiesTypes.md index f775a6978f..286cb0815e 100644 --- a/docs/reference/type-aliases/InputModalitiesTypes.md +++ b/docs/reference/type-aliases/InputModalitiesTypes.md @@ -7,7 +7,7 @@ title: InputModalitiesTypes type InputModalitiesTypes = object; ``` -Defined in: packages/ai/src/types.ts:801 +Defined in: [packages/ai/src/types.ts:819](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L819) ## Properties @@ -17,7 +17,7 @@ Defined in: packages/ai/src/types.ts:801 inputModalities: ReadonlyArray; ``` -Defined in: packages/ai/src/types.ts:802 +Defined in: [packages/ai/src/types.ts:820](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L820) *** @@ -27,4 +27,4 @@ Defined in: packages/ai/src/types.ts:802 messageMetadataByModality: DefaultMessageMetadataByModality; ``` -Defined in: packages/ai/src/types.ts:803 +Defined in: [packages/ai/src/types.ts:821](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L821) diff --git a/docs/reference/type-aliases/InputSchemaOf.md b/docs/reference/type-aliases/InputSchemaOf.md index ae666fd741..cba9f8f95a 100644 --- a/docs/reference/type-aliases/InputSchemaOf.md +++ b/docs/reference/type-aliases/InputSchemaOf.md @@ -7,7 +7,7 @@ title: InputSchemaOf type InputSchemaOf = TTool extends object ? TInput extends undefined ? NoSchema : TInput : NoSchema; ``` -Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:57 +Defined in: [packages/ai/src/activities/chat/tools/tool-definition.ts:57](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-definition.ts#L57) ## Type Parameters diff --git a/docs/reference/type-aliases/Interrupt.md b/docs/reference/type-aliases/Interrupt.md index cceaf25e13..5dffaf3245 100644 --- a/docs/reference/type-aliases/Interrupt.md +++ b/docs/reference/type-aliases/Interrupt.md @@ -7,4 +7,4 @@ title: Interrupt type Interrupt = AGUIInterrupt; ``` -Defined in: packages/ai/src/types.ts:1585 +Defined in: [packages/ai/src/types.ts:1625](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1625) diff --git a/docs/reference/type-aliases/InterruptBinding.md b/docs/reference/type-aliases/InterruptBinding.md index 0f531423f5..b005360c8b 100644 --- a/docs/reference/type-aliases/InterruptBinding.md +++ b/docs/reference/type-aliases/InterruptBinding.md @@ -10,4 +10,4 @@ type InterruptBinding = | InterruptBindingBase & object; ``` -Defined in: packages/ai/src/interrupts.ts:92 +Defined in: [packages/ai/src/interrupts.ts:92](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupts.ts#L92) diff --git a/docs/reference/type-aliases/InterruptBoundaryPhase.md b/docs/reference/type-aliases/InterruptBoundaryPhase.md index 7437409ec5..6b2aa7cd26 100644 --- a/docs/reference/type-aliases/InterruptBoundaryPhase.md +++ b/docs/reference/type-aliases/InterruptBoundaryPhase.md @@ -7,4 +7,4 @@ title: InterruptBoundaryPhase type InterruptBoundaryPhase = typeof INTERRUPT_BOUNDARY_PHASES[number]; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:111 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:112](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L112) diff --git a/docs/reference/type-aliases/InterruptBoundaryResult.md b/docs/reference/type-aliases/InterruptBoundaryResult.md index 8d10cc5715..30d9d18c6c 100644 --- a/docs/reference/type-aliases/InterruptBoundaryResult.md +++ b/docs/reference/type-aliases/InterruptBoundaryResult.md @@ -11,7 +11,7 @@ type InterruptBoundaryResult = }; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:177 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:178](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L178) ## Type Parameters diff --git a/docs/reference/type-aliases/InterruptResolutionResult.md b/docs/reference/type-aliases/InterruptResolutionResult.md index 7f7df19590..df4d1dbd43 100644 --- a/docs/reference/type-aliases/InterruptResolutionResult.md +++ b/docs/reference/type-aliases/InterruptResolutionResult.md @@ -11,4 +11,4 @@ type InterruptResolutionResult = }; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:185 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:186](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L186) diff --git a/docs/reference/type-aliases/InterruptSubmissionError.md b/docs/reference/type-aliases/InterruptSubmissionError.md index 2c71301b5a..d8307e42b9 100644 --- a/docs/reference/type-aliases/InterruptSubmissionError.md +++ b/docs/reference/type-aliases/InterruptSubmissionError.md @@ -9,4 +9,4 @@ type InterruptSubmissionError = | BatchInterruptError; ``` -Defined in: packages/ai/src/interrupts.ts:60 +Defined in: [packages/ai/src/interrupts.ts:60](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupts.ts#L60) diff --git a/docs/reference/type-aliases/InterruptToolResume.md b/docs/reference/type-aliases/InterruptToolResume.md index ab1987b53a..64909c3e47 100644 --- a/docs/reference/type-aliases/InterruptToolResume.md +++ b/docs/reference/type-aliases/InterruptToolResume.md @@ -7,4 +7,4 @@ title: InterruptToolResume type InterruptToolResume = typeof INTERRUPT_TOOL_RESUMES[number]; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:115 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:116](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L116) diff --git a/docs/reference/type-aliases/ItemInterruptErrorCode.md b/docs/reference/type-aliases/ItemInterruptErrorCode.md index ef09d7593c..047dad03ea 100644 --- a/docs/reference/type-aliases/ItemInterruptErrorCode.md +++ b/docs/reference/type-aliases/ItemInterruptErrorCode.md @@ -15,4 +15,4 @@ type ItemInterruptErrorCode = | "conflict"; ``` -Defined in: packages/ai/src/interrupts.ts:16 +Defined in: [packages/ai/src/interrupts.ts:16](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupts.ts#L16) diff --git a/docs/reference/type-aliases/KeyedAdapterResult.md b/docs/reference/type-aliases/KeyedAdapterResult.md index 6d7300bd09..205aa4a893 100644 --- a/docs/reference/type-aliases/KeyedAdapterResult.md +++ b/docs/reference/type-aliases/KeyedAdapterResult.md @@ -7,7 +7,7 @@ title: KeyedAdapterResult type KeyedAdapterResult = T extends KeyedAdapter ? A : never; ``` -Defined in: packages/ai/src/byok/keyed.ts:90 +Defined in: [packages/ai/src/byok/keyed.ts:90](https://github.com/TanStack/ai/blob/main/packages/ai/src/byok/keyed.ts#L90) The adapter type that a [KeyedAdapter](../interfaces/KeyedAdapter.md) builds. diff --git a/docs/reference/type-aliases/KnownCustomEvent.md b/docs/reference/type-aliases/KnownCustomEvent.md index 5268dc8899..f5a30735a6 100644 --- a/docs/reference/type-aliases/KnownCustomEvent.md +++ b/docs/reference/type-aliases/KnownCustomEvent.md @@ -23,7 +23,7 @@ type KnownCustomEvent = | UIResourceEvent; ``` -Defined in: packages/ai/src/types.ts:1886 +Defined in: [packages/ai/src/types.ts:1944](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1944) Every CUSTOM event TanStack AI itself emits, as a discriminated union on `name`. User-emitted custom events (via `emitCustomEvent` with a custom name) diff --git a/docs/reference/type-aliases/LoadChild.md b/docs/reference/type-aliases/LoadChild.md index b425965f1b..b754e4f9da 100644 --- a/docs/reference/type-aliases/LoadChild.md +++ b/docs/reference/type-aliases/LoadChild.md @@ -4,17 +4,22 @@ title: LoadChild --- ```ts -type LoadChild = (subagentRunId) => Promise< +type LoadChild = (subagentRunId, options?) => Promise< | { agent?: string; + interruptIds?: string[]; messages: ( | ModelMessage | UIMessage)[]; + parentToolCallId?: string; + pending?: ( + | ModelMessage + | UIMessage)[]; } | undefined>; ``` -Defined in: packages/ai/src/activities/chat/middleware/load-child.ts:12 +Defined in: [packages/ai/src/activities/chat/middleware/load-child.ts:17](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/load-child.ts#L17) Loads the stored transcript of a finished subagent run by its `subagentRunId`. Returns `undefined` for an unknown id. A persistence @@ -23,19 +28,35 @@ child by `sessionId`. When `agent` is set, only that agent can continue the child. A middleware that provides it must list `LoadChildCapability` in `provides`. Only then do the agent tools take `sessionId`. +With `parentSubagentRunId`, it loads a nested child: a child that the child +`parentSubagentRunId` started. It returns `undefined` when that child did +not start it. A loader that ignores the option fails closed for nested +children. + ## Parameters ### subagentRunId `string` +### options? + +#### parentSubagentRunId? + +`string` + ## Returns `Promise`\< \| \{ `agent?`: `string`; + `interruptIds?`: `string`[]; `messages`: ( \| [`ModelMessage`](../interfaces/ModelMessage.md) \| [`UIMessage`](../interfaces/UIMessage.md))[]; + `parentToolCallId?`: `string`; + `pending?`: ( + \| [`ModelMessage`](../interfaces/ModelMessage.md) + \| [`UIMessage`](../interfaces/UIMessage.md))[]; \} \| `undefined`\> diff --git a/docs/reference/type-aliases/MCPConnectionPolicy.md b/docs/reference/type-aliases/MCPConnectionPolicy.md index dfd80bf7c7..9fc9b276bc 100644 --- a/docs/reference/type-aliases/MCPConnectionPolicy.md +++ b/docs/reference/type-aliases/MCPConnectionPolicy.md @@ -7,7 +7,7 @@ title: MCPConnectionPolicy type MCPConnectionPolicy = "close" | "keep-alive"; ``` -Defined in: packages/ai/src/activities/chat/mcp/types.ts:50 +Defined in: [packages/ai/src/activities/chat/mcp/types.ts:50](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/mcp/types.ts#L50) Controls what happens to MCP connections when the chat run ends. diff --git a/docs/reference/type-aliases/MediaInputRole.md b/docs/reference/type-aliases/MediaInputRole.md index 888d78c8c8..2b1f453b17 100644 --- a/docs/reference/type-aliases/MediaInputRole.md +++ b/docs/reference/type-aliases/MediaInputRole.md @@ -13,7 +13,7 @@ type MediaInputRole = | "character"; ``` -Defined in: packages/ai/src/types.ts:2254 +Defined in: [packages/ai/src/types.ts:2312](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2312) Optional role hint on a media input part (image / video / audio). Adapters read `metadata.role` to route the part to the provider-specific request diff --git a/docs/reference/type-aliases/MediaPrompt.md b/docs/reference/type-aliases/MediaPrompt.md index cf086c89e8..5ca37dd524 100644 --- a/docs/reference/type-aliases/MediaPrompt.md +++ b/docs/reference/type-aliases/MediaPrompt.md @@ -7,7 +7,7 @@ title: MediaPrompt type MediaPrompt = string | MediaPromptPart[]; ``` -Defined in: packages/ai/src/types.ts:2305 +Defined in: [packages/ai/src/types.ts:2363](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2363) Prompt accepted by `generateImage()` / `generateVideo()`: a plain string, or an ordered array of content parts for image-conditioned generation diff --git a/docs/reference/type-aliases/MediaPromptFor.md b/docs/reference/type-aliases/MediaPromptFor.md index 726b22b510..2e5b2522f8 100644 --- a/docs/reference/type-aliases/MediaPromptFor.md +++ b/docs/reference/type-aliases/MediaPromptFor.md @@ -11,7 +11,7 @@ type MediaPromptFor = | MediaPartByModality[TModalities])[]; ``` -Defined in: packages/ai/src/types.ts:2326 +Defined in: [packages/ai/src/types.ts:2384](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2384) Prompt type narrowed to the modalities a specific model supports. `MediaPromptFor` (a text-only model) is `string | Array`; diff --git a/docs/reference/type-aliases/MediaPromptModality.md b/docs/reference/type-aliases/MediaPromptModality.md index 4f7a70f55f..d9b8542d2d 100644 --- a/docs/reference/type-aliases/MediaPromptModality.md +++ b/docs/reference/type-aliases/MediaPromptModality.md @@ -7,6 +7,6 @@ title: MediaPromptModality type MediaPromptModality = "image" | "video" | "audio"; ``` -Defined in: packages/ai/src/types.ts:2310 +Defined in: [packages/ai/src/types.ts:2368](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2368) Non-text modalities a media-generation model can accept in its prompt. diff --git a/docs/reference/type-aliases/MediaPromptPart.md b/docs/reference/type-aliases/MediaPromptPart.md index 54903fc3bc..4d7d3f16dc 100644 --- a/docs/reference/type-aliases/MediaPromptPart.md +++ b/docs/reference/type-aliases/MediaPromptPart.md @@ -11,7 +11,7 @@ type MediaPromptPart = | AudioPart; ``` -Defined in: packages/ai/src/types.ts:2287 +Defined in: [packages/ai/src/types.ts:2345](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2345) A single part of a multimodal media-generation prompt. Reuses the chat content-part shapes: text parts carry the instruction, image / video / diff --git a/docs/reference/type-aliases/MergedAgentTools.md b/docs/reference/type-aliases/MergedAgentTools.md index aec4f289fa..c861f73691 100644 --- a/docs/reference/type-aliases/MergedAgentTools.md +++ b/docs/reference/type-aliases/MergedAgentTools.md @@ -9,7 +9,7 @@ type MergedAgentTools = ReadonlyArray< | ClientToolDeclaration>; ``` -Defined in: packages/ai/src/utilities/chat-params.ts:319 +Defined in: [packages/ai/src/utilities/chat-params.ts:319](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/chat-params.ts#L319) ## Type Parameters diff --git a/docs/reference/type-aliases/MessagePart.md b/docs/reference/type-aliases/MessagePart.md index a1628b9e41..9c2771ff7b 100644 --- a/docs/reference/type-aliases/MessagePart.md +++ b/docs/reference/type-aliases/MessagePart.md @@ -19,7 +19,7 @@ type MessagePart = | SubagentPart; ``` -Defined in: packages/ai/src/types.ts:674 +Defined in: [packages/ai/src/types.ts:677](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L677) ## Type Parameters diff --git a/docs/reference/type-aliases/ModalitiesArrayToUnion.md b/docs/reference/type-aliases/ModalitiesArrayToUnion.md index 4c048fc7fa..c4e49fa64a 100644 --- a/docs/reference/type-aliases/ModalitiesArrayToUnion.md +++ b/docs/reference/type-aliases/ModalitiesArrayToUnion.md @@ -7,7 +7,7 @@ title: ModalitiesArrayToUnion type ModalitiesArrayToUnion = T[number]; ``` -Defined in: packages/ai/src/types.ts:361 +Defined in: [packages/ai/src/types.ts:364](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L364) Helper type to convert a readonly array of modalities to a union type. e.g., readonly ['text', 'image'] -> 'text' | 'image' diff --git a/docs/reference/type-aliases/Modality.md b/docs/reference/type-aliases/Modality.md index ca18add6aa..3a06b0493c 100644 --- a/docs/reference/type-aliases/Modality.md +++ b/docs/reference/type-aliases/Modality.md @@ -7,7 +7,7 @@ title: Modality type Modality = AGUIContentPart["type"]; ``` -Defined in: packages/ai/src/types.ts:241 +Defined in: [packages/ai/src/types.ts:244](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L244) Supported input modality types for multimodal content: the `type` of each AG-UI `ContentPart` (text, image, audio, video, document). diff --git a/docs/reference/type-aliases/ModelInputModalitiesByName.md b/docs/reference/type-aliases/ModelInputModalitiesByName.md index 5fbaa2fe23..3faa1dad31 100644 --- a/docs/reference/type-aliases/ModelInputModalitiesByName.md +++ b/docs/reference/type-aliases/ModelInputModalitiesByName.md @@ -7,7 +7,7 @@ title: ModelInputModalitiesByName type ModelInputModalitiesByName = Record>; ``` -Defined in: packages/ai/src/types.ts:2335 +Defined in: [packages/ai/src/types.ts:2393](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2393) Per-model map from model name to the prompt modalities it accepts, used as an adapter type parameter (`TModelInputModalitiesByName`). Models absent diff --git a/docs/reference/type-aliases/ModelMessageBlock.md b/docs/reference/type-aliases/ModelMessageBlock.md index b88fb9ea9f..af15edde43 100644 --- a/docs/reference/type-aliases/ModelMessageBlock.md +++ b/docs/reference/type-aliases/ModelMessageBlock.md @@ -19,7 +19,7 @@ type ModelMessageBlock = }; ``` -Defined in: packages/ai/src/types.ts:423 +Defined in: [packages/ai/src/types.ts:426](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L426) One block of an assistant `ModelMessage`, in the order the model sent it. Each entry points into a field of the message. See `ModelMessage.blockOrder`. diff --git a/docs/reference/type-aliases/ModelReasoning.md b/docs/reference/type-aliases/ModelReasoning.md index 5a2d097337..e7bbe3de81 100644 --- a/docs/reference/type-aliases/ModelReasoning.md +++ b/docs/reference/type-aliases/ModelReasoning.md @@ -12,7 +12,7 @@ type ModelReasoning = }; ``` -Defined in: packages/ai/src/reasoning.ts:82 +Defined in: [packages/ai/src/reasoning.ts:82](https://github.com/TanStack/ai/blob/main/packages/ai/src/reasoning.ts#L82) A model's reasoning data at runtime. `false`: the model does not reason. Otherwise the levels it has, and whether it takes a token budget. diff --git a/docs/reference/type-aliases/NoSchema.md b/docs/reference/type-aliases/NoSchema.md index a544be0bdd..0456c0d678 100644 --- a/docs/reference/type-aliases/NoSchema.md +++ b/docs/reference/type-aliases/NoSchema.md @@ -7,4 +7,4 @@ title: NoSchema type NoSchema = typeof noSchema; ``` -Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:55 +Defined in: [packages/ai/src/activities/chat/tools/tool-definition.ts:55](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-definition.ts#L55) diff --git a/docs/reference/type-aliases/OrderedAssistantBlock.md b/docs/reference/type-aliases/OrderedAssistantBlock.md index 398cd69f3e..d8f9930f15 100644 --- a/docs/reference/type-aliases/OrderedAssistantBlock.md +++ b/docs/reference/type-aliases/OrderedAssistantBlock.md @@ -19,6 +19,6 @@ type OrderedAssistantBlock = }; ``` -Defined in: packages/ai/src/utilities/block-order.ts:42 +Defined in: [packages/ai/src/utilities/block-order.ts:42](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/block-order.ts#L42) A block of an assistant message, resolved from its order map. diff --git a/docs/reference/type-aliases/OutputSchemaOf.md b/docs/reference/type-aliases/OutputSchemaOf.md index ba90b34b9b..a569684305 100644 --- a/docs/reference/type-aliases/OutputSchemaOf.md +++ b/docs/reference/type-aliases/OutputSchemaOf.md @@ -7,7 +7,7 @@ title: OutputSchemaOf type OutputSchemaOf = TTool extends object ? TOutput extends undefined ? NoSchema : TOutput : NoSchema; ``` -Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:65 +Defined in: [packages/ai/src/activities/chat/tools/tool-definition.ts:65](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-definition.ts#L65) ## Type Parameters diff --git a/docs/reference/type-aliases/PersistedArtifactActivity.md b/docs/reference/type-aliases/PersistedArtifactActivity.md index 86e9e08ebe..5b1bb3370f 100644 --- a/docs/reference/type-aliases/PersistedArtifactActivity.md +++ b/docs/reference/type-aliases/PersistedArtifactActivity.md @@ -7,4 +7,4 @@ title: PersistedArtifactActivity type PersistedArtifactActivity = "image" | "audio" | "tts" | "video" | "transcription"; ``` -Defined in: packages/ai/src/types.ts:2399 +Defined in: [packages/ai/src/types.ts:2457](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2457) diff --git a/docs/reference/type-aliases/PersistedArtifactRole.md b/docs/reference/type-aliases/PersistedArtifactRole.md index 65b3faf546..d1df402622 100644 --- a/docs/reference/type-aliases/PersistedArtifactRole.md +++ b/docs/reference/type-aliases/PersistedArtifactRole.md @@ -7,4 +7,4 @@ title: PersistedArtifactRole type PersistedArtifactRole = "input" | "output"; ``` -Defined in: packages/ai/src/types.ts:2397 +Defined in: [packages/ai/src/types.ts:2455](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2455) diff --git a/docs/reference/type-aliases/PromptCacheOptions.md b/docs/reference/type-aliases/PromptCacheOptions.md index d21a114048..8ffe26b41b 100644 --- a/docs/reference/type-aliases/PromptCacheOptions.md +++ b/docs/reference/type-aliases/PromptCacheOptions.md @@ -12,7 +12,7 @@ type PromptCacheOptions = }; ``` -Defined in: packages/ai/src/types.ts:1272 +Defined in: [packages/ai/src/types.ts:1312](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1312) The `promptCache` option of `chat()`: a retention, or an object with a retention and a cache key. diff --git a/docs/reference/type-aliases/PromptCacheRetention.md b/docs/reference/type-aliases/PromptCacheRetention.md index 403e8715e6..7cf737651c 100644 --- a/docs/reference/type-aliases/PromptCacheRetention.md +++ b/docs/reference/type-aliases/PromptCacheRetention.md @@ -7,7 +7,7 @@ title: PromptCacheRetention type PromptCacheRetention = "none" | "short" | "long"; ``` -Defined in: packages/ai/src/types.ts:1266 +Defined in: [packages/ai/src/types.ts:1306](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1306) How long the provider keeps the cached start of a request. `'none'` turns automatic prompt caching off. diff --git a/docs/reference/type-aliases/ProviderKeySource.md b/docs/reference/type-aliases/ProviderKeySource.md index 9053bc949c..e24a7bbcf8 100644 --- a/docs/reference/type-aliases/ProviderKeySource.md +++ b/docs/reference/type-aliases/ProviderKeySource.md @@ -13,7 +13,7 @@ type ProviderKeySource = | Promise); ``` -Defined in: packages/ai/src/byok/env-keys.ts:20 +Defined in: [packages/ai/src/byok/env-keys.ts:20](https://github.com/TanStack/ai/blob/main/packages/ai/src/byok/env-keys.ts#L20) Where `subagents.keys` finds a key: an object by provider id, or a function that gets the provider (a BYOK descriptor or an id) and returns its key. diff --git a/docs/reference/type-aliases/RealtimeErrorCode.md b/docs/reference/type-aliases/RealtimeErrorCode.md index 435c2e0cc3..d6194736d3 100644 --- a/docs/reference/type-aliases/RealtimeErrorCode.md +++ b/docs/reference/type-aliases/RealtimeErrorCode.md @@ -12,6 +12,6 @@ type RealtimeErrorCode = | "UNKNOWN"; ``` -Defined in: packages/ai/src/realtime/types.ts:289 +Defined in: [packages/ai/src/realtime/types.ts:289](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L289) Error codes for realtime errors diff --git a/docs/reference/type-aliases/RealtimeEvent.md b/docs/reference/type-aliases/RealtimeEvent.md index b19dbac298..64f818488e 100644 --- a/docs/reference/type-aliases/RealtimeEvent.md +++ b/docs/reference/type-aliases/RealtimeEvent.md @@ -17,6 +17,6 @@ type RealtimeEvent = | "usage"; ``` -Defined in: packages/ai/src/realtime/types.ts:243 +Defined in: [packages/ai/src/realtime/types.ts:243](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L243) Events emitted by the realtime connection diff --git a/docs/reference/type-aliases/RealtimeEventHandler.md b/docs/reference/type-aliases/RealtimeEventHandler.md index b2e9d09b0f..01ecef9833 100644 --- a/docs/reference/type-aliases/RealtimeEventHandler.md +++ b/docs/reference/type-aliases/RealtimeEventHandler.md @@ -7,7 +7,7 @@ title: RealtimeEventHandler type RealtimeEventHandler = (payload) => void; ``` -Defined in: packages/ai/src/realtime/types.ts:278 +Defined in: [packages/ai/src/realtime/types.ts:278](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L278) Handler type for realtime events diff --git a/docs/reference/type-aliases/RealtimeMessagePart.md b/docs/reference/type-aliases/RealtimeMessagePart.md index 087d421f6a..7ace4ef4a1 100644 --- a/docs/reference/type-aliases/RealtimeMessagePart.md +++ b/docs/reference/type-aliases/RealtimeMessagePart.md @@ -12,6 +12,6 @@ type RealtimeMessagePart = | RealtimeImagePart; ``` -Defined in: packages/ai/src/realtime/types.ts:152 +Defined in: [packages/ai/src/realtime/types.ts:152](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L152) Union of all realtime message parts diff --git a/docs/reference/type-aliases/RealtimeMode.md b/docs/reference/type-aliases/RealtimeMode.md index e8546d1a51..bb3fbe5b8c 100644 --- a/docs/reference/type-aliases/RealtimeMode.md +++ b/docs/reference/type-aliases/RealtimeMode.md @@ -7,6 +7,6 @@ title: RealtimeMode type RealtimeMode = "idle" | "listening" | "thinking" | "speaking"; ``` -Defined in: packages/ai/src/realtime/types.ts:196 +Defined in: [packages/ai/src/realtime/types.ts:196](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L196) Current mode of the realtime session diff --git a/docs/reference/type-aliases/RealtimeStatus.md b/docs/reference/type-aliases/RealtimeStatus.md index 8b9dbfad32..d8cd349980 100644 --- a/docs/reference/type-aliases/RealtimeStatus.md +++ b/docs/reference/type-aliases/RealtimeStatus.md @@ -7,6 +7,6 @@ title: RealtimeStatus type RealtimeStatus = "idle" | "connecting" | "connected" | "reconnecting" | "error"; ``` -Defined in: packages/ai/src/realtime/types.ts:186 +Defined in: [packages/ai/src/realtime/types.ts:186](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L186) Connection status of the realtime client diff --git a/docs/reference/type-aliases/ReasoningLevel.md b/docs/reference/type-aliases/ReasoningLevel.md index 774e759ea4..5ecff0e9ef 100644 --- a/docs/reference/type-aliases/ReasoningLevel.md +++ b/docs/reference/type-aliases/ReasoningLevel.md @@ -7,7 +7,7 @@ title: ReasoningLevel type ReasoningLevel = "off" | "minimal" | "low" | "medium" | "high" | "xhigh" | "max"; ``` -Defined in: packages/ai/src/reasoning.ts:5 +Defined in: [packages/ai/src/reasoning.ts:5](https://github.com/TanStack/ai/blob/main/packages/ai/src/reasoning.ts#L5) How hard a model thinks. `off` asks for no thinking. The levels are ordered from least to most, and the clamp rule walks this order. diff --git a/docs/reference/type-aliases/ReasoningLevels.md b/docs/reference/type-aliases/ReasoningLevels.md index 3cb0a66e32..1e4f505d52 100644 --- a/docs/reference/type-aliases/ReasoningLevels.md +++ b/docs/reference/type-aliases/ReasoningLevels.md @@ -7,7 +7,7 @@ title: ReasoningLevels type ReasoningLevels = Partial>; ``` -Defined in: packages/ai/src/reasoning.ts:29 +Defined in: [packages/ai/src/reasoning.ts:29](https://github.com/TanStack/ai/blob/main/packages/ai/src/reasoning.ts#L29) A model's levels: the provider value to send for each level the model has. A level with no entry is not supported. diff --git a/docs/reference/type-aliases/ReasoningOption.md b/docs/reference/type-aliases/ReasoningOption.md index 7f6a2a8799..1f21f5391b 100644 --- a/docs/reference/type-aliases/ReasoningOption.md +++ b/docs/reference/type-aliases/ReasoningOption.md @@ -9,7 +9,7 @@ type ReasoningOption = | object & true extends TCapability["budget"] ? object : object; ``` -Defined in: packages/ai/src/reasoning.ts:46 +Defined in: [packages/ai/src/reasoning.ts:46](https://github.com/TanStack/ai/blob/main/packages/ai/src/reasoning.ts#L46) The `reasoning` option of `chat()`: a level, or an object. `summary` asks the provider to stream the thinking text (default `true`). `budgetTokens` diff --git a/docs/reference/type-aliases/ReasoningOptionFor.md b/docs/reference/type-aliases/ReasoningOptionFor.md index d4c50f11da..5f0670ddd8 100644 --- a/docs/reference/type-aliases/ReasoningOptionFor.md +++ b/docs/reference/type-aliases/ReasoningOptionFor.md @@ -7,7 +7,7 @@ title: ReasoningOptionFor type ReasoningOptionFor = [TCapability] extends [never] ? never : TCapability extends ReasoningCapability ? ReasoningOption : never; ``` -Defined in: packages/ai/src/reasoning.ts:65 +Defined in: [packages/ai/src/reasoning.ts:65](https://github.com/TanStack/ai/blob/main/packages/ai/src/reasoning.ts#L65) The `reasoning` option a model's capability allows. `never` for a model that does not reason. diff --git a/docs/reference/type-aliases/RunAgentResumeItem.md b/docs/reference/type-aliases/RunAgentResumeItem.md index 579cb9778f..b5a8ba23ca 100644 --- a/docs/reference/type-aliases/RunAgentResumeItem.md +++ b/docs/reference/type-aliases/RunAgentResumeItem.md @@ -7,7 +7,7 @@ title: RunAgentResumeItem type RunAgentResumeItem = AGUIResumeEntry & object; ``` -Defined in: packages/ai/src/types.ts:1589 +Defined in: [packages/ai/src/types.ts:1629](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1629) ## Type Declaration diff --git a/docs/reference/type-aliases/RunFinishedOutcome.md b/docs/reference/type-aliases/RunFinishedOutcome.md index 67490f5f1e..ccf1b92f51 100644 --- a/docs/reference/type-aliases/RunFinishedOutcome.md +++ b/docs/reference/type-aliases/RunFinishedOutcome.md @@ -7,4 +7,4 @@ title: RunFinishedOutcome type RunFinishedOutcome = AGUIRunFinishedOutcome; ``` -Defined in: packages/ai/src/types.ts:1587 +Defined in: [packages/ai/src/types.ts:1627](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1627) diff --git a/docs/reference/type-aliases/RunKind.md b/docs/reference/type-aliases/RunKind.md index 1afe64feec..ab7613d075 100644 --- a/docs/reference/type-aliases/RunKind.md +++ b/docs/reference/type-aliases/RunKind.md @@ -7,6 +7,6 @@ title: RunKind type RunKind = "chat" | "agent" | "activity" | "command" | "compact"; ``` -Defined in: packages/ai/src/activities/chat/middleware/run-store.ts:207 +Defined in: [packages/ai/src/activities/chat/middleware/run-store.ts:207](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/run-store.ts#L207) Kinds of work a host session records. diff --git a/docs/reference/type-aliases/RunStatus.md b/docs/reference/type-aliases/RunStatus.md index c6a1d0f749..450595949f 100644 --- a/docs/reference/type-aliases/RunStatus.md +++ b/docs/reference/type-aliases/RunStatus.md @@ -7,7 +7,7 @@ title: RunStatus type RunStatus = "running" | "interrupted" | TerminalRunStatus; ``` -Defined in: packages/ai/src/activities/chat/middleware/run-store.ts:37 +Defined in: [packages/ai/src/activities/chat/middleware/run-store.ts:37](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/run-store.ts#L37) Lifecycle status of one run (one agent turn within a conversation). diff --git a/docs/reference/type-aliases/SchemaInput.md b/docs/reference/type-aliases/SchemaInput.md index 96cd1285cf..8b6c9bdb68 100644 --- a/docs/reference/type-aliases/SchemaInput.md +++ b/docs/reference/type-aliases/SchemaInput.md @@ -10,7 +10,7 @@ type SchemaInput = | JSONSchema; ``` -Defined in: packages/ai/src/types.ts:173 +Defined in: [packages/ai/src/types.ts:176](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L176) Union type for schema input - can be any Standard Schema compliant validator, any Standard JSON Schema compliant schema, or a plain JSONSchema object. diff --git a/docs/reference/type-aliases/StreamChunk.md b/docs/reference/type-aliases/StreamChunk.md index eb11d7df30..28d13040b9 100644 --- a/docs/reference/type-aliases/StreamChunk.md +++ b/docs/reference/type-aliases/StreamChunk.md @@ -7,7 +7,7 @@ title: StreamChunk type StreamChunk = AGUIEvent; ``` -Defined in: packages/ai/src/types.ts:2098 +Defined in: [packages/ai/src/types.ts:2156](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2156) Chunk returned by the SDK during streaming chat completions. Uses the AG-UI protocol event format. diff --git a/docs/reference/type-aliases/StructuredOutputPart.md b/docs/reference/type-aliases/StructuredOutputPart.md index af541c211a..1b65c1e25b 100644 --- a/docs/reference/type-aliases/StructuredOutputPart.md +++ b/docs/reference/type-aliases/StructuredOutputPart.md @@ -9,7 +9,7 @@ type StructuredOutputPart = | StructuredOutputPartBase & object; ``` -Defined in: packages/ai/src/types.ts:602 +Defined in: [packages/ai/src/types.ts:605](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L605) StructuredOutputPart — a typed structured response attached to the assistant message that produced it. Generic over the schema-inferred data type so diff --git a/docs/reference/type-aliases/StructuredOutputStream.md b/docs/reference/type-aliases/StructuredOutputStream.md index 96f7f9ea4a..7ff73f3797 100644 --- a/docs/reference/type-aliases/StructuredOutputStream.md +++ b/docs/reference/type-aliases/StructuredOutputStream.md @@ -10,7 +10,7 @@ type StructuredOutputStream = AsyncIterable< | StructuredOutputCompleteEvent>; ``` -Defined in: packages/ai/src/types.ts:1941 +Defined in: [packages/ai/src/types.ts:1999](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1999) Public type for streams returned by `chat({ outputSchema, stream: true })`. diff --git a/docs/reference/type-aliases/SubagentChoiceOptions.md b/docs/reference/type-aliases/SubagentChoiceOptions.md index f4da62581c..b6083f0d21 100644 --- a/docs/reference/type-aliases/SubagentChoiceOptions.md +++ b/docs/reference/type-aliases/SubagentChoiceOptions.md @@ -7,7 +7,7 @@ title: SubagentChoiceOptions type SubagentChoiceOptions = object & { [K in TAgents[number]["name"]]: string }; ``` -Defined in: packages/ai/src/activities/chat/agents/define-agent.ts:143 +Defined in: [packages/ai/src/activities/chat/agents/define-agent.ts:152](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/define-agent.ts#L152) Choice options for a `decide()` router. `main` is required plus every agent name. diff --git a/docs/reference/type-aliases/SubagentOrder.md b/docs/reference/type-aliases/SubagentOrder.md index 9baf2592bf..1d8e9bcf3c 100644 --- a/docs/reference/type-aliases/SubagentOrder.md +++ b/docs/reference/type-aliases/SubagentOrder.md @@ -7,4 +7,4 @@ title: SubagentOrder type SubagentOrder = "parallel" | "sequence"; ``` -Defined in: packages/ai/src/activities/chat/agents/spawn.ts:61 +Defined in: [packages/ai/src/activities/chat/agents/spawn.ts:77](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/spawn.ts#L77) diff --git a/docs/reference/type-aliases/SubagentPick.md b/docs/reference/type-aliases/SubagentPick.md index c1d73afced..d462e105bf 100644 --- a/docs/reference/type-aliases/SubagentPick.md +++ b/docs/reference/type-aliases/SubagentPick.md @@ -12,7 +12,7 @@ type SubagentPick = }; ``` -Defined in: packages/ai/src/activities/chat/agents/spawn.ts:69 +Defined in: [packages/ai/src/activities/chat/agents/spawn.ts:85](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/spawn.ts#L85) One agent in a router pick: its name, or its name and its input. An agent with `inputSchema` needs `{ name, input }`, and no other agent takes an diff --git a/docs/reference/type-aliases/SubagentRouterPick.md b/docs/reference/type-aliases/SubagentRouterPick.md index a8971397aa..6ee59aa9fd 100644 --- a/docs/reference/type-aliases/SubagentRouterPick.md +++ b/docs/reference/type-aliases/SubagentRouterPick.md @@ -12,4 +12,4 @@ type SubagentRouterPick = | SubagentStepsPlan; ``` -Defined in: packages/ai/src/activities/chat/agents/spawn.ts:87 +Defined in: [packages/ai/src/activities/chat/agents/spawn.ts:103](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/spawn.ts#L103) diff --git a/docs/reference/type-aliases/SubagentRunContext.md b/docs/reference/type-aliases/SubagentRunContext.md index 400879f70a..e6146b6347 100644 --- a/docs/reference/type-aliases/SubagentRunContext.md +++ b/docs/reference/type-aliases/SubagentRunContext.md @@ -4,10 +4,10 @@ title: SubagentRunContext --- ```ts -type SubagentRunContext = SubagentRunInput & BoundActivities & object; +type SubagentRunContext = SubagentRunInput & BoundActivities & SubagentContextExtension & object; ``` -Defined in: packages/ai/src/activities/chat/agents/define-agent.ts:64 +Defined in: [packages/ai/src/activities/chat/agents/define-agent.ts:64](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/agents/define-agent.ts#L64) Context the library passes into [defineAgent](../functions/defineAgent.md) `run`. diff --git a/docs/reference/type-aliases/SubagentStatus.md b/docs/reference/type-aliases/SubagentStatus.md index 62d8b85f7d..fea9d8f4fa 100644 --- a/docs/reference/type-aliases/SubagentStatus.md +++ b/docs/reference/type-aliases/SubagentStatus.md @@ -7,4 +7,4 @@ title: SubagentStatus type SubagentStatus = "running" | "finished" | "error" | "suspended"; ``` -Defined in: packages/ai/src/types.ts:626 +Defined in: [packages/ai/src/types.ts:629](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L629) diff --git a/docs/reference/type-aliases/SystemPrompt.md b/docs/reference/type-aliases/SystemPrompt.md index 03e371a270..2707d2beb4 100644 --- a/docs/reference/type-aliases/SystemPrompt.md +++ b/docs/reference/type-aliases/SystemPrompt.md @@ -12,7 +12,7 @@ type SystemPrompt = }; ``` -Defined in: packages/ai/src/system-prompts.ts:39 +Defined in: [packages/ai/src/system-prompts.ts:39](https://github.com/TanStack/ai/blob/main/packages/ai/src/system-prompts.ts#L39) A single entry in `chat({ systemPrompts: [...] })`. diff --git a/docs/reference/type-aliases/TaggedCustomEvent.md b/docs/reference/type-aliases/TaggedCustomEvent.md index b42c92aa59..c920102fed 100644 --- a/docs/reference/type-aliases/TaggedCustomEvent.md +++ b/docs/reference/type-aliases/TaggedCustomEvent.md @@ -9,7 +9,7 @@ type TaggedCustomEvent = | StructuredOutputCompleteEvent; ``` -Defined in: packages/ai/src/types.ts:2123 +Defined in: [packages/ai/src/types.ts:2181](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L2181) Discriminated union of the orchestrator-tagged `CUSTOM` events. Each variant has a literal `name`, so a single narrow on `chunk.name` yields a typed diff --git a/docs/reference/type-aliases/TerminalRunStatus.md b/docs/reference/type-aliases/TerminalRunStatus.md index a5e75a105b..4716ac0f2c 100644 --- a/docs/reference/type-aliases/TerminalRunStatus.md +++ b/docs/reference/type-aliases/TerminalRunStatus.md @@ -7,6 +7,6 @@ title: TerminalRunStatus type TerminalRunStatus = "completed" | "failed" | "aborted"; ``` -Defined in: packages/ai/src/activities/chat/middleware/run-store.ts:15 +Defined in: [packages/ai/src/activities/chat/middleware/run-store.ts:15](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/run-store.ts#L15) A terminal run status: no further events will be appended. diff --git a/docs/reference/type-aliases/ToolApprovalResolution.md b/docs/reference/type-aliases/ToolApprovalResolution.md index 4736ed0d74..e72770b391 100644 --- a/docs/reference/type-aliases/ToolApprovalResolution.md +++ b/docs/reference/type-aliases/ToolApprovalResolution.md @@ -18,4 +18,4 @@ type ToolApprovalResolution = }; ``` -Defined in: packages/ai/src/interrupts.ts:124 +Defined in: [packages/ai/src/interrupts.ts:124](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupts.ts#L124) diff --git a/docs/reference/type-aliases/ToolCallState.md b/docs/reference/type-aliases/ToolCallState.md index 818a6cf91e..2430bd4c7f 100644 --- a/docs/reference/type-aliases/ToolCallState.md +++ b/docs/reference/type-aliases/ToolCallState.md @@ -14,6 +14,6 @@ type ToolCallState = | "error"; ``` -Defined in: packages/ai/src/types.ts:88 +Defined in: [packages/ai/src/types.ts:91](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L91) Tool call states - track the lifecycle of a tool call diff --git a/docs/reference/type-aliases/ToolChoice.md b/docs/reference/type-aliases/ToolChoice.md index ff8d3f3f88..5aff39f4fe 100644 --- a/docs/reference/type-aliases/ToolChoice.md +++ b/docs/reference/type-aliases/ToolChoice.md @@ -14,7 +14,7 @@ type ToolChoice = }; ``` -Defined in: packages/ai/src/types.ts:1255 +Defined in: [packages/ai/src/types.ts:1295](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L1295) How the model uses the tools of a call. - `'auto'`: the model decides. diff --git a/docs/reference/type-aliases/ToolDefinitionConfig.md b/docs/reference/type-aliases/ToolDefinitionConfig.md index 565f5017ba..745bf7aeb8 100644 --- a/docs/reference/type-aliases/ToolDefinitionConfig.md +++ b/docs/reference/type-aliases/ToolDefinitionConfig.md @@ -7,7 +7,7 @@ title: ToolDefinitionConfig type ToolDefinitionConfig = object & ApprovalConfig; ``` -Defined in: packages/ai/src/activities/chat/tools/tool-definition.ts:215 +Defined in: [packages/ai/src/activities/chat/tools/tool-definition.ts:215](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/tool-definition.ts#L215) Tool definition configuration diff --git a/docs/reference/type-aliases/ToolExecuteFunction.md b/docs/reference/type-aliases/ToolExecuteFunction.md index 9a9520e654..53c9ef6f72 100644 --- a/docs/reference/type-aliases/ToolExecuteFunction.md +++ b/docs/reference/type-aliases/ToolExecuteFunction.md @@ -11,7 +11,7 @@ type ToolExecuteFunction = undefined extends TContext | InferSchemaType; ``` -Defined in: packages/ai/src/types.ts:938 +Defined in: [packages/ai/src/types.ts:978](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L978) ## Type Parameters diff --git a/docs/reference/type-aliases/ToolExecutionContext.md b/docs/reference/type-aliases/ToolExecutionContext.md index 2bbec9267f..7b3d3ff8da 100644 --- a/docs/reference/type-aliases/ToolExecutionContext.md +++ b/docs/reference/type-aliases/ToolExecutionContext.md @@ -7,7 +7,7 @@ title: ToolExecutionContext type ToolExecutionContext = RuntimeContextField & object; ``` -Defined in: packages/ai/src/types.ts:872 +Defined in: [packages/ai/src/types.ts:890](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L890) Context passed to tool execute functions, providing capabilities like emitting custom events during execution. @@ -101,6 +101,64 @@ const tool = toolDefinition({ ... }).server(async (args, context) => { }) ``` +### get? + +```ts +optional get?: (capability) => TValue; +``` + +Read a capability that a middleware of the run provided, by its +handle. It works like `ctx.get` in middleware and throws if the +capability was never provided. `chat()` sets it. It is missing when a +tool runs outside a chat. + +#### Type Parameters + +##### TValue + +`TValue` + +#### Parameters + +##### capability + +[`Capability`](Capability.md)\<`TValue`\> + +#### Returns + +`TValue` + +#### Example + +```ts +const sandbox = context?.get?.(SandboxCapability) +``` + +### getOptional? + +```ts +optional getOptional?: (capability) => TValue | undefined; +``` + +Read a capability by its handle. Returns `undefined` if no middleware +provided it. It works like `ctx.getOptional` in middleware. + +#### Type Parameters + +##### TValue + +`TValue` + +#### Parameters + +##### capability + +[`Capability`](Capability.md)\<`TValue`\> + +#### Returns + +`TValue` \| `undefined` + ### inputResponse? ```ts @@ -111,6 +169,15 @@ The answer to the input request that this tool call raised in the previous run. It is set only when the run resumes an `mcp_input` interrupt for this tool call. +### runId? + +```ts +optional runId?: string; +``` + +The run of the call, when a host knows it. `chat()` does not set it: +a host such as the harness wraps the tool's `execute` to add it. + ### threadId? ```ts diff --git a/docs/reference/type-aliases/ToolInputResponse.md b/docs/reference/type-aliases/ToolInputResponse.md index 4def3417d4..7e57260cfd 100644 --- a/docs/reference/type-aliases/ToolInputResponse.md +++ b/docs/reference/type-aliases/ToolInputResponse.md @@ -14,7 +14,7 @@ type ToolInputResponse = }; ``` -Defined in: packages/ai/src/types.ts:864 +Defined in: [packages/ai/src/types.ts:882](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L882) The user's answer to an `mcp_input` interrupt. `resolved` carries the `payload` from `resolveInterrupt`. diff --git a/docs/reference/type-aliases/ToolOutputState.md b/docs/reference/type-aliases/ToolOutputState.md index 1dadc5417e..c67ca92a92 100644 --- a/docs/reference/type-aliases/ToolOutputState.md +++ b/docs/reference/type-aliases/ToolOutputState.md @@ -7,4 +7,4 @@ title: ToolOutputState type ToolOutputState = "output-available" | "output-error"; ``` -Defined in: packages/ai/src/types.ts:108 +Defined in: [packages/ai/src/types.ts:111](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L111) diff --git a/docs/reference/type-aliases/ToolResultOutcome.md b/docs/reference/type-aliases/ToolResultOutcome.md index bf12ec8847..578c8be9cb 100644 --- a/docs/reference/type-aliases/ToolResultOutcome.md +++ b/docs/reference/type-aliases/ToolResultOutcome.md @@ -7,6 +7,6 @@ title: ToolResultOutcome type ToolResultOutcome = "cancelled" | "denied"; ``` -Defined in: packages/ai/src/types.ts:106 +Defined in: [packages/ai/src/types.ts:109](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L109) Why a tool result ended without executing successfully. diff --git a/docs/reference/type-aliases/ToolResultState.md b/docs/reference/type-aliases/ToolResultState.md index 5a94e65db6..198ae48b17 100644 --- a/docs/reference/type-aliases/ToolResultState.md +++ b/docs/reference/type-aliases/ToolResultState.md @@ -7,6 +7,6 @@ title: ToolResultState type ToolResultState = "streaming" | "complete" | "error"; ``` -Defined in: packages/ai/src/types.ts:100 +Defined in: [packages/ai/src/types.ts:103](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L103) Tool result states - track the lifecycle of a tool result diff --git a/docs/reference/type-aliases/TranscriptionResponseFormat.md b/docs/reference/type-aliases/TranscriptionResponseFormat.md index b6db018e4c..dc2f625b19 100644 --- a/docs/reference/type-aliases/TranscriptionResponseFormat.md +++ b/docs/reference/type-aliases/TranscriptionResponseFormat.md @@ -7,7 +7,7 @@ title: TranscriptionResponseFormat type TranscriptionResponseFormat = "json" | "text" | "srt" | "verbose_json" | "vtt"; ``` -Defined in: packages/ai/src/types.ts:3133 +Defined in: [packages/ai/src/types.ts:3181](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3181) Options for audio transcription. These are the common options supported across providers. diff --git a/docs/reference/type-aliases/UnopenedInterruptBinding.md b/docs/reference/type-aliases/UnopenedInterruptBinding.md index 269e56df34..07529e28e2 100644 --- a/docs/reference/type-aliases/UnopenedInterruptBinding.md +++ b/docs/reference/type-aliases/UnopenedInterruptBinding.md @@ -7,4 +7,4 @@ title: UnopenedInterruptBinding type UnopenedInterruptBinding = InterruptBinding extends infer TBinding ? TBinding extends InterruptBinding ? Omit : never : never; ``` -Defined in: packages/ai/src/interrupts.ts:118 +Defined in: [packages/ai/src/interrupts.ts:118](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupts.ts#L118) diff --git a/docs/reference/type-aliases/VoiceOrigin.md b/docs/reference/type-aliases/VoiceOrigin.md index 5143ae0247..4bc8be5ffc 100644 --- a/docs/reference/type-aliases/VoiceOrigin.md +++ b/docs/reference/type-aliases/VoiceOrigin.md @@ -7,7 +7,7 @@ title: VoiceOrigin type VoiceOrigin = "premade" | "generated" | "cloned" | "professional"; ``` -Defined in: packages/ai/src/types.ts:2968 +Defined in: [packages/ai/src/types.ts:3016](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3016) Where a voice in a provider's catalog came from. diff --git a/docs/reference/type-aliases/VoiceTrainingStatus.md b/docs/reference/type-aliases/VoiceTrainingStatus.md index 0000724359..21a2705aee 100644 --- a/docs/reference/type-aliases/VoiceTrainingStatus.md +++ b/docs/reference/type-aliases/VoiceTrainingStatus.md @@ -7,7 +7,7 @@ title: VoiceTrainingStatus type VoiceTrainingStatus = "ready" | "training" | "failed"; ``` -Defined in: packages/ai/src/types.ts:3102 +Defined in: [packages/ai/src/types.ts:3150](https://github.com/TanStack/ai/blob/main/packages/ai/src/types.ts#L3150) Whether a created voice is usable. diff --git a/docs/reference/type-aliases/WellKnownCustomEventName.md b/docs/reference/type-aliases/WellKnownCustomEventName.md index 430f9c869b..48dd31e53b 100644 --- a/docs/reference/type-aliases/WellKnownCustomEventName.md +++ b/docs/reference/type-aliases/WellKnownCustomEventName.md @@ -7,6 +7,6 @@ title: WellKnownCustomEventName type WellKnownCustomEventName = typeof CUSTOM_EVENT[keyof typeof CUSTOM_EVENT]; ``` -Defined in: packages/ai/src/custom-events.ts:30 +Defined in: [packages/ai/src/custom-events.ts:30](https://github.com/TanStack/ai/blob/main/packages/ai/src/custom-events.ts#L30) Union of the well-known CUSTOM event name literals. diff --git a/docs/reference/type-aliases/WireAnswer.md b/docs/reference/type-aliases/WireAnswer.md index 27d0003ee1..9bebbd8296 100644 --- a/docs/reference/type-aliases/WireAnswer.md +++ b/docs/reference/type-aliases/WireAnswer.md @@ -7,6 +7,6 @@ title: WireAnswer type WireAnswer = WireChoiceAnswer | WireScoreAnswer | WireNoulAnswer; ``` -Defined in: packages/ai/src/activities/evaluate/adapter.ts:100 +Defined in: [packages/ai/src/activities/evaluate/adapter.ts:100](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/evaluate/adapter.ts#L100) Provider payload for one question. The activity maps this to a unified answer. diff --git a/docs/reference/type-aliases/WireMessage.md b/docs/reference/type-aliases/WireMessage.md index 367ff9b288..073451cf63 100644 --- a/docs/reference/type-aliases/WireMessage.md +++ b/docs/reference/type-aliases/WireMessage.md @@ -13,4 +13,4 @@ type WireMessage = | WireActivityMessage; ``` -Defined in: packages/ai/src/utilities/ag-ui-wire.ts:79 +Defined in: [packages/ai/src/utilities/ag-ui-wire.ts:79](https://github.com/TanStack/ai/blob/main/packages/ai/src/utilities/ag-ui-wire.ts#L79) diff --git a/docs/reference/type-aliases/WireQuestion.md b/docs/reference/type-aliases/WireQuestion.md index cda8d06e8e..59007c9008 100644 --- a/docs/reference/type-aliases/WireQuestion.md +++ b/docs/reference/type-aliases/WireQuestion.md @@ -7,6 +7,6 @@ title: WireQuestion type WireQuestion = WireChoiceQuestion | WireScoreQuestion | WireNoulQuestion; ``` -Defined in: packages/ai/src/activities/evaluate/adapter.ts:71 +Defined in: [packages/ai/src/activities/evaluate/adapter.ts:71](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/evaluate/adapter.ts#L71) Question payload adapters send to the provider. diff --git a/docs/reference/variables/CONTEXT_OVERFLOW_CODE.md b/docs/reference/variables/CONTEXT_OVERFLOW_CODE.md index 447f76beca..07956d9c2c 100644 --- a/docs/reference/variables/CONTEXT_OVERFLOW_CODE.md +++ b/docs/reference/variables/CONTEXT_OVERFLOW_CODE.md @@ -7,7 +7,7 @@ title: CONTEXT_OVERFLOW_CODE const CONTEXT_OVERFLOW_CODE: "context_overflow" = 'context_overflow'; ``` -Defined in: packages/ai/src/activities/error-payload.ts:41 +Defined in: [packages/ai/src/activities/error-payload.ts:41](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/error-payload.ts#L41) The `RUN_ERROR.code` a text adapter sets when the provider says the input does not fit in the model's context window. Shorten the messages, then call diff --git a/docs/reference/variables/CUSTOM_EVENT.md b/docs/reference/variables/CUSTOM_EVENT.md index aeb8c4f8b1..36ff871fca 100644 --- a/docs/reference/variables/CUSTOM_EVENT.md +++ b/docs/reference/variables/CUSTOM_EVENT.md @@ -7,7 +7,7 @@ title: CUSTOM_EVENT const CUSTOM_EVENT: object; ``` -Defined in: packages/ai/src/custom-events.ts:17 +Defined in: [packages/ai/src/custom-events.ts:17](https://github.com/TanStack/ai/blob/main/packages/ai/src/custom-events.ts#L17) Well-known CUSTOM event names. diff --git a/docs/reference/variables/DISCOVERY_TOOL_NAME.md b/docs/reference/variables/DISCOVERY_TOOL_NAME.md index b50fd2aa33..0952299533 100644 --- a/docs/reference/variables/DISCOVERY_TOOL_NAME.md +++ b/docs/reference/variables/DISCOVERY_TOOL_NAME.md @@ -7,7 +7,7 @@ title: DISCOVERY_TOOL_NAME const DISCOVERY_TOOL_NAME: "__lazy__tool__discovery__" = '__lazy__tool__discovery__'; ``` -Defined in: packages/ai/src/activities/chat/tools/lazy-tool-manager.ts:12 +Defined in: [packages/ai/src/activities/chat/tools/lazy-tool-manager.ts:12](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/lazy-tool-manager.ts#L12) Name of the synthetic tool the LLM calls to discover lazy tools. diff --git a/docs/reference/variables/DetachableRunCapability.md b/docs/reference/variables/DetachableRunCapability.md index a93d74e48c..e7d792d4d9 100644 --- a/docs/reference/variables/DetachableRunCapability.md +++ b/docs/reference/variables/DetachableRunCapability.md @@ -7,7 +7,7 @@ title: DetachableRunCapability const DetachableRunCapability: Capability; ``` -Defined in: packages/ai/src/activities/chat/middleware/run-store.ts:375 +Defined in: [packages/ai/src/activities/chat/middleware/run-store.ts:375](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/run-store.ts#L375) Whether the current run can be DETACHED rather than destroyed when its client disconnects — `true` only when some middleware has both a [RunStore](../interfaces/RunStore.md) and diff --git a/docs/reference/variables/EVALUATE_REFUSAL_CODE.md b/docs/reference/variables/EVALUATE_REFUSAL_CODE.md new file mode 100644 index 0000000000..2e51b0a3b8 --- /dev/null +++ b/docs/reference/variables/EVALUATE_REFUSAL_CODE.md @@ -0,0 +1,12 @@ +--- +id: EVALUATE_REFUSAL_CODE +title: EVALUATE_REFUSAL_CODE +--- + +```ts +const EVALUATE_REFUSAL_CODE: "refusal" = 'refusal'; +``` + +Defined in: [packages/ai/src/activities/evaluate/adapter.ts:141](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/evaluate/adapter.ts#L141) + +`EvaluateError.code` when the provider declined to answer a question. diff --git a/docs/reference/variables/INTERRUPT_BINDING_METADATA_KEY.md b/docs/reference/variables/INTERRUPT_BINDING_METADATA_KEY.md index 5748f6f2e5..9fb7711d5d 100644 --- a/docs/reference/variables/INTERRUPT_BINDING_METADATA_KEY.md +++ b/docs/reference/variables/INTERRUPT_BINDING_METADATA_KEY.md @@ -7,7 +7,7 @@ title: INTERRUPT_BINDING_METADATA_KEY const INTERRUPT_BINDING_METADATA_KEY: "tanstack:interruptBinding" = 'tanstack:interruptBinding'; ``` -Defined in: packages/ai/src/interrupt-resume.ts:45 +Defined in: [packages/ai/src/interrupt-resume.ts:45](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupt-resume.ts#L45) The `Interrupt.metadata` key under which this package's resume binding travels. diff --git a/docs/reference/variables/INTERRUPT_BINDING_VERSION.md b/docs/reference/variables/INTERRUPT_BINDING_VERSION.md index c60221fca5..171d572154 100644 --- a/docs/reference/variables/INTERRUPT_BINDING_VERSION.md +++ b/docs/reference/variables/INTERRUPT_BINDING_VERSION.md @@ -7,7 +7,7 @@ title: INTERRUPT_BINDING_VERSION const INTERRUPT_BINDING_VERSION: 1; ``` -Defined in: packages/ai/src/interrupts.ts:77 +Defined in: [packages/ai/src/interrupts.ts:77](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupts.ts#L77) Wire version of [InterruptBinding](../type-aliases/InterruptBinding.md). diff --git a/docs/reference/variables/INTERRUPT_BOUNDARY_PHASES.md b/docs/reference/variables/INTERRUPT_BOUNDARY_PHASES.md index e2d3647b76..e8c2b103ab 100644 --- a/docs/reference/variables/INTERRUPT_BOUNDARY_PHASES.md +++ b/docs/reference/variables/INTERRUPT_BOUNDARY_PHASES.md @@ -7,4 +7,4 @@ title: INTERRUPT_BOUNDARY_PHASES const INTERRUPT_BOUNDARY_PHASES: readonly ["beforeModel", "afterModel", "beforeTools", "afterTools"]; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:104 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:105](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L105) diff --git a/docs/reference/variables/INTERRUPT_CONTINUATION_METADATA_KEY.md b/docs/reference/variables/INTERRUPT_CONTINUATION_METADATA_KEY.md index e79f501ef2..50043c1dab 100644 --- a/docs/reference/variables/INTERRUPT_CONTINUATION_METADATA_KEY.md +++ b/docs/reference/variables/INTERRUPT_CONTINUATION_METADATA_KEY.md @@ -7,7 +7,7 @@ title: INTERRUPT_CONTINUATION_METADATA_KEY const INTERRUPT_CONTINUATION_METADATA_KEY: "tanstack:interruptContinuation"; ``` -Defined in: packages/ai/src/generic-interrupt-continuation.ts:11 +Defined in: [packages/ai/src/generic-interrupt-continuation.ts:11](https://github.com/TanStack/ai/blob/main/packages/ai/src/generic-interrupt-continuation.ts#L11) `ResumeEntry.metadata` key for a first-party generic request. diff --git a/docs/reference/variables/INTERRUPT_CONTINUATION_VERSION.md b/docs/reference/variables/INTERRUPT_CONTINUATION_VERSION.md index fcfd693fae..c927f8db6d 100644 --- a/docs/reference/variables/INTERRUPT_CONTINUATION_VERSION.md +++ b/docs/reference/variables/INTERRUPT_CONTINUATION_VERSION.md @@ -7,4 +7,4 @@ title: INTERRUPT_CONTINUATION_VERSION const INTERRUPT_CONTINUATION_VERSION: 1; ``` -Defined in: packages/ai/src/generic-interrupt-continuation.ts:14 +Defined in: [packages/ai/src/generic-interrupt-continuation.ts:14](https://github.com/TanStack/ai/blob/main/packages/ai/src/generic-interrupt-continuation.ts#L14) diff --git a/docs/reference/variables/INTERRUPT_PAYLOAD_METADATA_KEY.md b/docs/reference/variables/INTERRUPT_PAYLOAD_METADATA_KEY.md index 64b368b7d0..4037f1cb2e 100644 --- a/docs/reference/variables/INTERRUPT_PAYLOAD_METADATA_KEY.md +++ b/docs/reference/variables/INTERRUPT_PAYLOAD_METADATA_KEY.md @@ -7,4 +7,4 @@ title: INTERRUPT_PAYLOAD_METADATA_KEY const INTERRUPT_PAYLOAD_METADATA_KEY: "tanstack:interruptPayload"; ``` -Defined in: packages/ai/src/interrupt-definition.ts:16 +Defined in: [packages/ai/src/interrupt-definition.ts:16](https://github.com/TanStack/ai/blob/main/packages/ai/src/interrupt-definition.ts#L16) diff --git a/docs/reference/variables/INTERRUPT_TOOL_RESUMES.md b/docs/reference/variables/INTERRUPT_TOOL_RESUMES.md index efc984c16e..0e726eb001 100644 --- a/docs/reference/variables/INTERRUPT_TOOL_RESUMES.md +++ b/docs/reference/variables/INTERRUPT_TOOL_RESUMES.md @@ -7,4 +7,4 @@ title: INTERRUPT_TOOL_RESUMES const INTERRUPT_TOOL_RESUMES: readonly ["continue", "cancel", "stop"]; ``` -Defined in: packages/ai/src/activities/chat/middleware/types.ts:113 +Defined in: [packages/ai/src/activities/chat/middleware/types.ts:114](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L114) diff --git a/docs/reference/variables/LoadChildCapability.md b/docs/reference/variables/LoadChildCapability.md index d8286c325a..5c75ba9f7a 100644 --- a/docs/reference/variables/LoadChildCapability.md +++ b/docs/reference/variables/LoadChildCapability.md @@ -7,4 +7,4 @@ title: LoadChildCapability const LoadChildCapability: Capability; ``` -Defined in: packages/ai/src/activities/chat/middleware/load-child.ts:21 +Defined in: [packages/ai/src/activities/chat/middleware/load-child.ts:40](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/load-child.ts#L40) diff --git a/docs/reference/variables/LogRecordsCapability.md b/docs/reference/variables/LogRecordsCapability.md index ce3db6d5dc..db3c1f2511 100644 --- a/docs/reference/variables/LogRecordsCapability.md +++ b/docs/reference/variables/LogRecordsCapability.md @@ -7,4 +7,4 @@ title: LogRecordsCapability const LogRecordsCapability: Capability; ``` -Defined in: packages/ai/src/activities/chat/middleware/log-records.ts:25 +Defined in: [packages/ai/src/activities/chat/middleware/log-records.ts:25](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/log-records.ts#L25) diff --git a/docs/reference/variables/MetadataCapability.md b/docs/reference/variables/MetadataCapability.md index 2274e4f157..a8ea378329 100644 --- a/docs/reference/variables/MetadataCapability.md +++ b/docs/reference/variables/MetadataCapability.md @@ -7,4 +7,4 @@ title: MetadataCapability const MetadataCapability: Capability; ``` -Defined in: packages/ai/src/activities/chat/middleware/metadata.ts:41 +Defined in: [packages/ai/src/activities/chat/middleware/metadata.ts:41](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/metadata.ts#L41) diff --git a/docs/reference/variables/REASONING_LEVELS.md b/docs/reference/variables/REASONING_LEVELS.md index 6f70ded94a..1eb94165f6 100644 --- a/docs/reference/variables/REASONING_LEVELS.md +++ b/docs/reference/variables/REASONING_LEVELS.md @@ -7,6 +7,6 @@ title: REASONING_LEVELS const REASONING_LEVELS: ReadonlyArray; ``` -Defined in: packages/ai/src/reasoning.ts:15 +Defined in: [packages/ai/src/reasoning.ts:15](https://github.com/TanStack/ai/blob/main/packages/ai/src/reasoning.ts#L15) Every level, from least to most thinking. diff --git a/docs/reference/variables/RUN_ACCEPTED_EVENT.md b/docs/reference/variables/RUN_ACCEPTED_EVENT.md index 104b9d4ba5..fac0f8e406 100644 --- a/docs/reference/variables/RUN_ACCEPTED_EVENT.md +++ b/docs/reference/variables/RUN_ACCEPTED_EVENT.md @@ -7,7 +7,7 @@ title: RUN_ACCEPTED_EVENT const RUN_ACCEPTED_EVENT: "run.accepted" = 'run.accepted'; ``` -Defined in: packages/ai/src/stream-to-response.ts:650 +Defined in: [packages/ai/src/stream-to-response.ts:650](https://github.com/TanStack/ai/blob/main/packages/ai/src/stream-to-response.ts#L650) Name of the synthetic `CUSTOM` chunk a fresh durable producer appends to its log before pulling the first real chunk. diff --git a/docs/reference/variables/RUN_CANCEL_REASON.md b/docs/reference/variables/RUN_CANCEL_REASON.md index 5e3f0ae5e9..a1ee71a296 100644 --- a/docs/reference/variables/RUN_CANCEL_REASON.md +++ b/docs/reference/variables/RUN_CANCEL_REASON.md @@ -7,7 +7,7 @@ title: RUN_CANCEL_REASON const RUN_CANCEL_REASON: "tanstack-ai:cancel-requested" = 'tanstack-ai:cancel-requested'; ``` -Defined in: packages/ai/src/activities/chat/cancel.ts:30 +Defined in: [packages/ai/src/activities/chat/cancel.ts:30](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/cancel.ts#L30) Abort reason that marks an abort as an explicit cancellation. diff --git a/docs/reference/variables/RunDetachedCapability.md b/docs/reference/variables/RunDetachedCapability.md index 1e7e248e81..f85dd67e91 100644 --- a/docs/reference/variables/RunDetachedCapability.md +++ b/docs/reference/variables/RunDetachedCapability.md @@ -7,7 +7,7 @@ title: RunDetachedCapability const RunDetachedCapability: Capability; ``` -Defined in: packages/ai/src/activities/chat/middleware/run-store.ts:414 +Defined in: [packages/ai/src/activities/chat/middleware/run-store.ts:414](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/run-store.ts#L414) Whether this run's teardown DID detach — the disconnect was survived, the agent is still working, and a later attach can take the run over. diff --git a/docs/reference/variables/defaultJSONParser.md b/docs/reference/variables/defaultJSONParser.md index 840b4d9192..14e2f541a3 100644 --- a/docs/reference/variables/defaultJSONParser.md +++ b/docs/reference/variables/defaultJSONParser.md @@ -7,6 +7,6 @@ title: defaultJSONParser const defaultJSONParser: PartialJSONParser; ``` -Defined in: packages/ai/src/activities/chat/stream/json-parser.ts:49 +Defined in: [packages/ai/src/activities/chat/stream/json-parser.ts:49](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/stream/json-parser.ts#L49) Default parser instance diff --git a/docs/reference/variables/getDetachableRun.md b/docs/reference/variables/getDetachableRun.md index 578b2bea24..7ff92c5fd1 100644 --- a/docs/reference/variables/getDetachableRun.md +++ b/docs/reference/variables/getDetachableRun.md @@ -7,4 +7,4 @@ title: getDetachableRun getDetachableRun: CapabilityGetter; ``` -Defined in: packages/ai/src/activities/chat/middleware/run-store.ts:382 +Defined in: [packages/ai/src/activities/chat/middleware/run-store.ts:382](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/run-store.ts#L382) diff --git a/docs/reference/variables/getLoadChild.md b/docs/reference/variables/getLoadChild.md index c5ccf37c18..82a34829c2 100644 --- a/docs/reference/variables/getLoadChild.md +++ b/docs/reference/variables/getLoadChild.md @@ -7,4 +7,4 @@ title: getLoadChild getLoadChild: CapabilityGetter; ``` -Defined in: packages/ai/src/activities/chat/middleware/load-child.ts:23 +Defined in: [packages/ai/src/activities/chat/middleware/load-child.ts:42](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/load-child.ts#L42) diff --git a/docs/reference/variables/getLogRecords.md b/docs/reference/variables/getLogRecords.md index 13b9bfcbda..130a3d3ac3 100644 --- a/docs/reference/variables/getLogRecords.md +++ b/docs/reference/variables/getLogRecords.md @@ -7,4 +7,4 @@ title: getLogRecords getLogRecords: CapabilityGetter; ``` -Defined in: packages/ai/src/activities/chat/middleware/log-records.ts:28 +Defined in: [packages/ai/src/activities/chat/middleware/log-records.ts:28](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/log-records.ts#L28) diff --git a/docs/reference/variables/getMetadata.md b/docs/reference/variables/getMetadata.md index aaa2930240..781b60ac3b 100644 --- a/docs/reference/variables/getMetadata.md +++ b/docs/reference/variables/getMetadata.md @@ -7,4 +7,4 @@ title: getMetadata getMetadata: CapabilityGetter; ``` -Defined in: packages/ai/src/activities/chat/middleware/metadata.ts:43 +Defined in: [packages/ai/src/activities/chat/middleware/metadata.ts:43](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/metadata.ts#L43) diff --git a/docs/reference/variables/getRunDetached.md b/docs/reference/variables/getRunDetached.md index c918934db1..77ad7be37c 100644 --- a/docs/reference/variables/getRunDetached.md +++ b/docs/reference/variables/getRunDetached.md @@ -7,4 +7,4 @@ title: getRunDetached getRunDetached: CapabilityGetter; ``` -Defined in: packages/ai/src/activities/chat/middleware/run-store.ts:420 +Defined in: [packages/ai/src/activities/chat/middleware/run-store.ts:420](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/run-store.ts#L420) diff --git a/docs/reference/variables/provideDetachableRun.md b/docs/reference/variables/provideDetachableRun.md index 37108447ed..b980d771d4 100644 --- a/docs/reference/variables/provideDetachableRun.md +++ b/docs/reference/variables/provideDetachableRun.md @@ -7,4 +7,4 @@ title: provideDetachableRun provideDetachableRun: CapabilityProvider; ``` -Defined in: packages/ai/src/activities/chat/middleware/run-store.ts:382 +Defined in: [packages/ai/src/activities/chat/middleware/run-store.ts:382](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/run-store.ts#L382) diff --git a/docs/reference/variables/provideLoadChild.md b/docs/reference/variables/provideLoadChild.md index 2ce3b4901f..ed6a9920cf 100644 --- a/docs/reference/variables/provideLoadChild.md +++ b/docs/reference/variables/provideLoadChild.md @@ -7,4 +7,4 @@ title: provideLoadChild provideLoadChild: CapabilityProvider; ``` -Defined in: packages/ai/src/activities/chat/middleware/load-child.ts:23 +Defined in: [packages/ai/src/activities/chat/middleware/load-child.ts:42](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/load-child.ts#L42) diff --git a/docs/reference/variables/provideLogRecords.md b/docs/reference/variables/provideLogRecords.md index 344f05088b..39b3a8e79b 100644 --- a/docs/reference/variables/provideLogRecords.md +++ b/docs/reference/variables/provideLogRecords.md @@ -7,4 +7,4 @@ title: provideLogRecords provideLogRecords: CapabilityProvider; ``` -Defined in: packages/ai/src/activities/chat/middleware/log-records.ts:28 +Defined in: [packages/ai/src/activities/chat/middleware/log-records.ts:28](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/log-records.ts#L28) diff --git a/docs/reference/variables/provideMetadata.md b/docs/reference/variables/provideMetadata.md index c79ee44b3f..aaf38f6208 100644 --- a/docs/reference/variables/provideMetadata.md +++ b/docs/reference/variables/provideMetadata.md @@ -7,4 +7,4 @@ title: provideMetadata provideMetadata: CapabilityProvider; ``` -Defined in: packages/ai/src/activities/chat/middleware/metadata.ts:43 +Defined in: [packages/ai/src/activities/chat/middleware/metadata.ts:43](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/metadata.ts#L43) diff --git a/docs/reference/variables/provideRunDetached.md b/docs/reference/variables/provideRunDetached.md index 0b41d34741..4c455ad321 100644 --- a/docs/reference/variables/provideRunDetached.md +++ b/docs/reference/variables/provideRunDetached.md @@ -7,4 +7,4 @@ title: provideRunDetached provideRunDetached: CapabilityProvider; ``` -Defined in: packages/ai/src/activities/chat/middleware/run-store.ts:420 +Defined in: [packages/ai/src/activities/chat/middleware/run-store.ts:420](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/run-store.ts#L420) diff --git a/packages/ai-client/README.md b/packages/ai-client/README.md index 1519015a88..17ca7028e0 100644 --- a/packages/ai-client/README.md +++ b/packages/ai-client/README.md @@ -19,17 +19,17 @@
- - NPM downloads + + NPM downloads GitHub stars - - npm version + + npm version - - Bundle size + + Bundle size Follow @TanStack @@ -298,9 +298,9 @@ on. - - - CodeRabbit + + + CodeRabbit @@ -309,7 +309,7 @@ on. - Cloudflare + Cloudflare diff --git a/packages/ai-devtools/README.md b/packages/ai-devtools/README.md index ad371b89a4..17ca7028e0 100644 --- a/packages/ai-devtools/README.md +++ b/packages/ai-devtools/README.md @@ -19,17 +19,17 @@
- - NPM downloads + + NPM downloads GitHub stars - - npm version + + npm version - - Bundle size + + Bundle size Follow @TanStack @@ -298,9 +298,9 @@ on. - - - CodeRabbit + + + CodeRabbit @@ -309,7 +309,7 @@ on. - Cloudflare + Cloudflare diff --git a/packages/ai-gemini/README.md b/packages/ai-gemini/README.md index 2b86d10594..17ca7028e0 100644 --- a/packages/ai-gemini/README.md +++ b/packages/ai-gemini/README.md @@ -19,17 +19,17 @@
- - NPM downloads + + NPM downloads GitHub stars - - npm version + + npm version - - Bundle size + + Bundle size Follow @TanStack @@ -298,9 +298,9 @@ on. - - - CodeRabbit + + + CodeRabbit @@ -309,7 +309,7 @@ on. - Cloudflare + Cloudflare diff --git a/packages/ai-ollama/README.md b/packages/ai-ollama/README.md index 3c784e83e2..17ca7028e0 100644 --- a/packages/ai-ollama/README.md +++ b/packages/ai-ollama/README.md @@ -19,17 +19,17 @@
- - NPM downloads + + NPM downloads GitHub stars - - npm version + + npm version - - Bundle size + + Bundle size Follow @TanStack @@ -298,9 +298,9 @@ on. - - - CodeRabbit + + + CodeRabbit @@ -309,7 +309,7 @@ on. - Cloudflare + Cloudflare diff --git a/packages/ai-openai/README.md b/packages/ai-openai/README.md index 750744e0d4..17ca7028e0 100644 --- a/packages/ai-openai/README.md +++ b/packages/ai-openai/README.md @@ -19,17 +19,17 @@
- - NPM downloads + + NPM downloads GitHub stars - - npm version + + npm version - - Bundle size + + Bundle size Follow @TanStack @@ -298,9 +298,9 @@ on. - - - CodeRabbit + + + CodeRabbit @@ -309,7 +309,7 @@ on. - Cloudflare + Cloudflare diff --git a/packages/ai-openrouter/README.md b/packages/ai-openrouter/README.md index 78ffdd0831..17ca7028e0 100644 --- a/packages/ai-openrouter/README.md +++ b/packages/ai-openrouter/README.md @@ -19,17 +19,17 @@
- - NPM downloads + + NPM downloads GitHub stars - - npm version + + npm version - - Bundle size + + Bundle size Follow @TanStack @@ -298,9 +298,9 @@ on. - - - CodeRabbit + + + CodeRabbit @@ -309,7 +309,7 @@ on. - Cloudflare + Cloudflare diff --git a/packages/ai-preact/README.md b/packages/ai-preact/README.md index e0c2336bcb..17ca7028e0 100644 --- a/packages/ai-preact/README.md +++ b/packages/ai-preact/README.md @@ -19,17 +19,17 @@
- - NPM downloads + + NPM downloads GitHub stars - - npm version + + npm version - - Bundle size + + Bundle size Follow @TanStack @@ -298,9 +298,9 @@ on. - - - CodeRabbit + + + CodeRabbit @@ -309,7 +309,7 @@ on. - Cloudflare + Cloudflare diff --git a/packages/ai-react/README.md b/packages/ai-react/README.md index 078478a7c5..17ca7028e0 100644 --- a/packages/ai-react/README.md +++ b/packages/ai-react/README.md @@ -19,17 +19,17 @@
- - NPM downloads + + NPM downloads GitHub stars - - npm version + + npm version - - Bundle size + + Bundle size Follow @TanStack @@ -298,9 +298,9 @@ on. - - - CodeRabbit + + + CodeRabbit @@ -309,7 +309,7 @@ on. - Cloudflare + Cloudflare diff --git a/packages/ai-vue/README.md b/packages/ai-vue/README.md index 111e8f50df..17ca7028e0 100644 --- a/packages/ai-vue/README.md +++ b/packages/ai-vue/README.md @@ -19,17 +19,17 @@
- - NPM downloads + + NPM downloads GitHub stars - - npm version + + npm version - - Bundle size + + Bundle size Follow @TanStack @@ -298,9 +298,9 @@ on. - - - CodeRabbit + + + CodeRabbit @@ -309,7 +309,7 @@ on. - Cloudflare + Cloudflare diff --git a/packages/ai/README.md b/packages/ai/README.md index 59a4d6f500..17ca7028e0 100644 --- a/packages/ai/README.md +++ b/packages/ai/README.md @@ -298,9 +298,9 @@ on. - - - CodeRabbit + + + CodeRabbit @@ -309,7 +309,7 @@ on. - Cloudflare + Cloudflare diff --git a/packages/preact-ai-devtools/README.md b/packages/preact-ai-devtools/README.md index de01f09004..17ca7028e0 100644 --- a/packages/preact-ai-devtools/README.md +++ b/packages/preact-ai-devtools/README.md @@ -19,17 +19,17 @@
- - NPM downloads + + NPM downloads GitHub stars - - npm version + + npm version - - Bundle size + + Bundle size Follow @TanStack @@ -298,9 +298,9 @@ on. - - - CodeRabbit + + + CodeRabbit @@ -309,7 +309,7 @@ on. - Cloudflare + Cloudflare diff --git a/packages/react-ai-devtools/README.md b/packages/react-ai-devtools/README.md index a4547e0444..17ca7028e0 100644 --- a/packages/react-ai-devtools/README.md +++ b/packages/react-ai-devtools/README.md @@ -19,17 +19,17 @@
- - NPM downloads + + NPM downloads GitHub stars - - npm version + + npm version - - Bundle size + + Bundle size Follow @TanStack @@ -298,9 +298,9 @@ on. - - - CodeRabbit + + + CodeRabbit @@ -309,7 +309,7 @@ on. - Cloudflare + Cloudflare diff --git a/packages/solid-ai-devtools/README.md b/packages/solid-ai-devtools/README.md index d2cdcee5d7..17ca7028e0 100644 --- a/packages/solid-ai-devtools/README.md +++ b/packages/solid-ai-devtools/README.md @@ -19,17 +19,17 @@
- - NPM downloads + + NPM downloads GitHub stars - - npm version + + npm version - - Bundle size + + Bundle size Follow @TanStack @@ -298,9 +298,9 @@ on. - - - CodeRabbit + + + CodeRabbit @@ -309,7 +309,7 @@ on. - Cloudflare + Cloudflare diff --git a/packages/svelte-ai-devtools/README.md b/packages/svelte-ai-devtools/README.md index 14abb6669b..17ca7028e0 100644 --- a/packages/svelte-ai-devtools/README.md +++ b/packages/svelte-ai-devtools/README.md @@ -19,17 +19,17 @@