Skip to content

docs: regenerate API documentation #1265

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AlemTuzlak merged 1 commit into from
Aug 31, 2026
Merged

docs: regenerate API documentation #1265

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/reference/classes/StandardSchemaValidationError.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: StandardSchemaValidationError

# Class: StandardSchemaValidationError

Defined in: [packages/ai/src/activities/chat/tools/schema-converter.ts:418](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/schema-converter.ts#L418)
Defined in: [packages/ai/src/activities/chat/tools/schema-converter.ts:431](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/schema-converter.ts#L431)

Error thrown when Standard Schema validation fails. Carries the original
`issues` array so consumers (middleware `onError`, callers catching from
Expand All @@ -23,7 +23,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:422](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/schema-converter.ts#L422)
Defined in: [packages/ai/src/activities/chat/tools/schema-converter.ts:435](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/schema-converter.ts#L435)

#### Parameters

Expand All @@ -49,7 +49,7 @@ Error.constructor
readonly issues: readonly Issue[];
```

Defined in: [packages/ai/src/activities/chat/tools/schema-converter.ts:420](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/schema-converter.ts#L420)
Defined in: [packages/ai/src/activities/chat/tools/schema-converter.ts:433](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/schema-converter.ts#L433)

***

Expand All @@ -59,7 +59,7 @@ Defined in: [packages/ai/src/activities/chat/tools/schema-converter.ts:420](http
readonly name: "StandardSchemaValidationError" = 'StandardSchemaValidationError';
```

Defined in: [packages/ai/src/activities/chat/tools/schema-converter.ts:419](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/schema-converter.ts#L419)
Defined in: [packages/ai/src/activities/chat/tools/schema-converter.ts:432](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/schema-converter.ts#L432)

#### Overrides

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/functions/chat.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: chat
function chat<TAdapter, TSchema, TStream, TTools, TInterrupts, TContext, TMiddleware>(options): TextActivityResult<TSchema, TStream, TTools>;
```

Defined in: [packages/ai/src/activities/chat/index.ts:4548](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/index.ts#L4548)
Defined in: [packages/ai/src/activities/chat/index.ts:4643](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/index.ts#L4643)

Text activity - handles agentic text generation, one-shot text generation, and agentic structured output.

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/functions/convertSchemaToJsonSchema.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: convertSchemaToJsonSchema
function convertSchemaToJsonSchema(schema, options?): JSONSchema | undefined;
```

Defined in: [packages/ai/src/activities/chat/tools/schema-converter.ts:324](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/schema-converter.ts#L324)
Defined in: [packages/ai/src/activities/chat/tools/schema-converter.ts:337](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/schema-converter.ts#L337)

Converts a Standard JSON Schema compliant schema or plain JSONSchema to JSON Schema format
compatible with LLM providers.
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/functions/parseWithStandardSchema.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: parseWithStandardSchema
function parseWithStandardSchema<T>(schema, data): T;
```

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)
Defined in: [packages/ai/src/activities/chat/tools/schema-converter.ts:456](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/schema-converter.ts#L456)

Synchronously validates data against a Standard Schema compliant schema.
Note: Some Standard Schema implementations may only support async validation.
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/functions/validateWithStandardSchema.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ function validateWithStandardSchema<T>(schema, data): Promise<
}>;
```

Defined in: [packages/ai/src/activities/chat/tools/schema-converter.ts:383](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/schema-converter.ts#L383)
Defined in: [packages/ai/src/activities/chat/tools/schema-converter.ts:396](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/tools/schema-converter.ts#L396)

Validates data against a Standard Schema compliant schema.

Expand Down
4 changes: 4 additions & 0 deletions docs/reference/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,7 @@ title: "@tanstack/ai"
- [MemoryStreamInit](interfaces/MemoryStreamInit.md)
- [MemoryStreamOptions](interfaces/MemoryStreamOptions.md)
- [MessagesSnapshotEvent](interfaces/MessagesSnapshotEvent.md)
- [MetadataStore](interfaces/MetadataStore.md)
- [ModelCapabilities](interfaces/ModelCapabilities.md)
- [ModelMessage](interfaces/ModelMessage.md)
- [NormalizedApprovalSchema](interfaces/NormalizedApprovalSchema.md)
Expand Down Expand Up @@ -350,6 +351,7 @@ title: "@tanstack/ai"
- [DetachableRunCapability](variables/DetachableRunCapability.md)
- [DISCOVERY\_TOOL\_NAME](variables/DISCOVERY_TOOL_NAME.md)
- [getDetachableRun](variables/getDetachableRun.md)
- [getMetadata](variables/getMetadata.md)
- [getRunDetached](variables/getRunDetached.md)
- [INTERRUPT\_BINDING\_METADATA\_KEY](variables/INTERRUPT_BINDING_METADATA_KEY.md)
- [INTERRUPT\_BINDING\_VERSION](variables/INTERRUPT_BINDING_VERSION.md)
Expand All @@ -358,7 +360,9 @@ title: "@tanstack/ai"
- [INTERRUPT\_CONTINUATION\_VERSION](variables/INTERRUPT_CONTINUATION_VERSION.md)
- [INTERRUPT\_PAYLOAD\_METADATA\_KEY](variables/INTERRUPT_PAYLOAD_METADATA_KEY.md)
- [INTERRUPT\_TOOL\_RESUMES](variables/INTERRUPT_TOOL_RESUMES.md)
- [MetadataCapability](variables/MetadataCapability.md)
- [provideDetachableRun](variables/provideDetachableRun.md)
- [provideMetadata](variables/provideMetadata.md)
- [provideRunDetached](variables/provideRunDetached.md)
- [RUN\_ACCEPTED\_EVENT](variables/RUN_ACCEPTED_EVENT.md)
- [RUN\_CANCEL\_REASON](variables/RUN_CANCEL_REASON.md)
Expand Down
8 changes: 4 additions & 4 deletions docs/reference/interfaces/AbortInfo.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: AbortInfo

# Interface: AbortInfo

Defined in: [packages/ai/src/activities/chat/middleware/types.ts:499](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L499)
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)

Information passed to onAbort.

Expand All @@ -17,7 +17,7 @@ Information passed to onAbort.
optional cancelRequested?: boolean;
```

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)
Defined in: [packages/ai/src/activities/chat/middleware/types.ts:528](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L528)

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
Expand All @@ -41,7 +41,7 @@ host reads `RunRecord.cancelRequested` in addition to this flag.
duration: number;
```

Defined in: [packages/ai/src/activities/chat/middleware/types.ts:503](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L503)
Defined in: [packages/ai/src/activities/chat/middleware/types.ts:512](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L512)

Duration until abort in milliseconds

Expand All @@ -53,6 +53,6 @@ Duration until abort in milliseconds
optional reason?: string;
```

Defined in: [packages/ai/src/activities/chat/middleware/types.ts:501](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L501)
Defined in: [packages/ai/src/activities/chat/middleware/types.ts:510](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L510)

The reason for the abort, if provided
18 changes: 9 additions & 9 deletions docs/reference/interfaces/AfterToolCallInfo.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: AfterToolCallInfo

# Interface: AfterToolCallInfo

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)
Defined in: [packages/ai/src/activities/chat/middleware/types.ts:408](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L408)

Outcome information provided to onAfterToolCall.

Expand All @@ -17,7 +17,7 @@ Outcome information provided to onAfterToolCall.
duration: number;
```

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)
Defined in: [packages/ai/src/activities/chat/middleware/types.ts:420](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L420)

Duration of tool execution in milliseconds

Expand All @@ -29,7 +29,7 @@ Duration of tool execution in milliseconds
optional error?: unknown;
```

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)
Defined in: [packages/ai/src/activities/chat/middleware/types.ts:423](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L423)

***

Expand All @@ -39,7 +39,7 @@ Defined in: [packages/ai/src/activities/chat/middleware/types.ts:414](https://gi
ok: boolean;
```

Defined in: [packages/ai/src/activities/chat/middleware/types.ts:409](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L409)
Defined in: [packages/ai/src/activities/chat/middleware/types.ts:418](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L418)

Whether the execution succeeded

Expand All @@ -51,7 +51,7 @@ Whether the execution succeeded
optional result?: unknown;
```

Defined in: [packages/ai/src/activities/chat/middleware/types.ts:413](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L413)
Defined in: [packages/ai/src/activities/chat/middleware/types.ts:422](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L422)

The result (if ok) or error (if not ok)

Expand All @@ -65,7 +65,7 @@ tool:
| undefined;
```

Defined in: [packages/ai/src/activities/chat/middleware/types.ts:403](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L403)
Defined in: [packages/ai/src/activities/chat/middleware/types.ts:412](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L412)

The resolved tool definition

Expand All @@ -77,7 +77,7 @@ The resolved tool definition
toolCall: ToolCall;
```

Defined in: [packages/ai/src/activities/chat/middleware/types.ts:401](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L401)
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)

The tool call that was executed

Expand All @@ -89,7 +89,7 @@ The tool call that was executed
toolCallId: string;
```

Defined in: [packages/ai/src/activities/chat/middleware/types.ts:407](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L407)
Defined in: [packages/ai/src/activities/chat/middleware/types.ts:416](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L416)

ID of the tool call

Expand All @@ -101,6 +101,6 @@ ID of the tool call
toolName: string;
```

Defined in: [packages/ai/src/activities/chat/middleware/types.ts:405](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/types.ts#L405)
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)

Name of the tool
Loading