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

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 15 additions & 15 deletions docs/reference/classes/BaseAdapter.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ Generic parameters:
new BaseAdapter<TChatModels, TEmbeddingModels, TChatProviderOptions, TEmbeddingProviderOptions, TModelProviderOptionsByName, TModelInputModalitiesByName, TMessageMetadataByModality>(config): BaseAdapter<TChatModels, TEmbeddingModels, TChatProviderOptions, TEmbeddingProviderOptions, TModelProviderOptionsByName, TModelInputModalitiesByName, TMessageMetadataByModality>;
```

Defined in: [base-adapter.ts:70](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/base-adapter.ts#L70)
Defined in: [base-adapter.ts:66](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/base-adapter.ts#L66)

#### Parameters

Expand All @@ -80,7 +80,7 @@ Defined in: [base-adapter.ts:70](https://github.com/TanStack/ai/blob/main/packag
optional _chatProviderOptions: TChatProviderOptions;
```

Defined in: [base-adapter.ts:61](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/base-adapter.ts#L61)
Defined in: [base-adapter.ts:57](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/base-adapter.ts#L57)

#### Implementation of

Expand All @@ -94,7 +94,7 @@ Defined in: [base-adapter.ts:61](https://github.com/TanStack/ai/blob/main/packag
optional _embeddingProviderOptions: TEmbeddingProviderOptions;
```

Defined in: [base-adapter.ts:62](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/base-adapter.ts#L62)
Defined in: [base-adapter.ts:58](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/base-adapter.ts#L58)

#### Implementation of

Expand All @@ -108,7 +108,7 @@ Defined in: [base-adapter.ts:62](https://github.com/TanStack/ai/blob/main/packag
optional _messageMetadataByModality: TMessageMetadataByModality;
```

Defined in: [base-adapter.ts:68](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/base-adapter.ts#L68)
Defined in: [base-adapter.ts:64](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/base-adapter.ts#L64)

Type-only map from modality type to adapter-specific metadata types.
Used to provide type-safe autocomplete for metadata on content parts.
Expand All @@ -125,7 +125,7 @@ Used to provide type-safe autocomplete for metadata on content parts.
optional _modelInputModalitiesByName: TModelInputModalitiesByName;
```

Defined in: [base-adapter.ts:66](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/base-adapter.ts#L66)
Defined in: [base-adapter.ts:62](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/base-adapter.ts#L62)

Type-only map from model name to its supported input modalities.
Used by the core AI types to narrow ContentPart types based on the selected model.
Expand All @@ -143,7 +143,7 @@ Must be provided by all adapters.
_modelProviderOptionsByName: TModelProviderOptionsByName;
```

Defined in: [base-adapter.ts:64](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/base-adapter.ts#L64)
Defined in: [base-adapter.ts:60](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/base-adapter.ts#L60)

Type-only map from model name to its specific provider options.
Used by the core AI types to narrow providerOptions based on the selected model.
Expand All @@ -161,7 +161,7 @@ Must be provided by all adapters.
optional _providerOptions: TChatProviderOptions;
```

Defined in: [base-adapter.ts:60](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/base-adapter.ts#L60)
Defined in: [base-adapter.ts:56](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/base-adapter.ts#L56)

#### Implementation of

Expand All @@ -175,7 +175,7 @@ Defined in: [base-adapter.ts:60](https://github.com/TanStack/ai/blob/main/packag
protected config: AIAdapterConfig;
```

Defined in: [base-adapter.ts:57](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/base-adapter.ts#L57)
Defined in: [base-adapter.ts:53](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/base-adapter.ts#L53)

***

Expand All @@ -185,7 +185,7 @@ Defined in: [base-adapter.ts:57](https://github.com/TanStack/ai/blob/main/packag
optional embeddingModels: TEmbeddingModels;
```

Defined in: [base-adapter.ts:56](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/base-adapter.ts#L56)
Defined in: [base-adapter.ts:52](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/base-adapter.ts#L52)

Models that support embeddings

Expand All @@ -201,7 +201,7 @@ Models that support embeddings
abstract models: TChatModels;
```

Defined in: [base-adapter.ts:55](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/base-adapter.ts#L55)
Defined in: [base-adapter.ts:51](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/base-adapter.ts#L51)

Models that support chat/text completion

Expand All @@ -217,7 +217,7 @@ Models that support chat/text completion
abstract name: string;
```

Defined in: [base-adapter.ts:54](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/base-adapter.ts#L54)
Defined in: [base-adapter.ts:50](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/base-adapter.ts#L50)

#### Implementation of

Expand All @@ -231,7 +231,7 @@ Defined in: [base-adapter.ts:54](https://github.com/TanStack/ai/blob/main/packag
abstract chatStream(options): AsyncIterable<StreamChunk>;
```

Defined in: [base-adapter.ts:74](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/base-adapter.ts#L74)
Defined in: [base-adapter.ts:70](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/base-adapter.ts#L70)

#### Parameters

Expand All @@ -255,7 +255,7 @@ Defined in: [base-adapter.ts:74](https://github.com/TanStack/ai/blob/main/packag
abstract createEmbeddings(options): Promise<EmbeddingResult>;
```

Defined in: [base-adapter.ts:79](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/base-adapter.ts#L79)
Defined in: [base-adapter.ts:75](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/base-adapter.ts#L75)

#### Parameters

Expand All @@ -279,7 +279,7 @@ Defined in: [base-adapter.ts:79](https://github.com/TanStack/ai/blob/main/packag
protected generateId(): string;
```

Defined in: [base-adapter.ts:81](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/base-adapter.ts#L81)
Defined in: [base-adapter.ts:77](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/base-adapter.ts#L77)

#### Returns

Expand All @@ -293,7 +293,7 @@ Defined in: [base-adapter.ts:81](https://github.com/TanStack/ai/blob/main/packag
abstract summarize(options): Promise<SummarizationResult>;
```

Defined in: [base-adapter.ts:76](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/base-adapter.ts#L76)
Defined in: [base-adapter.ts:72](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/base-adapter.ts#L72)

#### Parameters

Expand Down
24 changes: 12 additions & 12 deletions docs/reference/interfaces/AIAdapter.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ Generic parameters:
optional _chatProviderOptions: TChatProviderOptions;
```

Defined in: [types.ts:711](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L711)
Defined in: [types.ts:709](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L709)

***

Expand All @@ -66,7 +66,7 @@ Defined in: [types.ts:711](https://github.com/TanStack/ai/blob/main/packages/typ
optional _embeddingProviderOptions: TEmbeddingProviderOptions;
```

Defined in: [types.ts:712](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L712)
Defined in: [types.ts:710](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L710)

***

Expand All @@ -76,7 +76,7 @@ Defined in: [types.ts:712](https://github.com/TanStack/ai/blob/main/packages/typ
optional _messageMetadataByModality: TMessageMetadataByModality;
```

Defined in: [types.ts:729](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L729)
Defined in: [types.ts:727](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L727)

Type-only map from modality type to adapter-specific metadata types.
Used to provide type-safe autocomplete for metadata on content parts.
Expand All @@ -89,7 +89,7 @@ Used to provide type-safe autocomplete for metadata on content parts.
optional _modelInputModalitiesByName: TModelInputModalitiesByName;
```

Defined in: [types.ts:724](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L724)
Defined in: [types.ts:722](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L722)

Type-only map from model name to its supported input modalities.
Used by the core AI types to narrow ContentPart types based on the selected model.
Expand All @@ -103,7 +103,7 @@ Must be provided by all adapters.
_modelProviderOptionsByName: TModelProviderOptionsByName;
```

Defined in: [types.ts:718](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L718)
Defined in: [types.ts:716](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L716)

Type-only map from model name to its specific provider options.
Used by the core AI types to narrow providerOptions based on the selected model.
Expand All @@ -117,7 +117,7 @@ Must be provided by all adapters.
optional _providerOptions: TChatProviderOptions;
```

Defined in: [types.ts:710](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L710)
Defined in: [types.ts:708](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L708)

***

Expand All @@ -127,7 +127,7 @@ Defined in: [types.ts:710](https://github.com/TanStack/ai/blob/main/packages/typ
chatStream: (options) => AsyncIterable<StreamChunk>;
```

Defined in: [types.ts:732](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L732)
Defined in: [types.ts:730](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L730)

#### Parameters

Expand All @@ -147,7 +147,7 @@ Defined in: [types.ts:732](https://github.com/TanStack/ai/blob/main/packages/typ
createEmbeddings: (options) => Promise<EmbeddingResult>;
```

Defined in: [types.ts:740](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L740)
Defined in: [types.ts:738](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L738)

#### Parameters

Expand All @@ -167,7 +167,7 @@ Defined in: [types.ts:740](https://github.com/TanStack/ai/blob/main/packages/typ
optional embeddingModels: TEmbeddingModels;
```

Defined in: [types.ts:707](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L707)
Defined in: [types.ts:705](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L705)

Models that support embeddings

Expand All @@ -179,7 +179,7 @@ Models that support embeddings
models: TChatModels;
```

Defined in: [types.ts:704](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L704)
Defined in: [types.ts:702](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L702)

Models that support chat/text completion

Expand All @@ -191,7 +191,7 @@ Models that support chat/text completion
name: string;
```

Defined in: [types.ts:702](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L702)
Defined in: [types.ts:700](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L700)

***

Expand All @@ -201,7 +201,7 @@ Defined in: [types.ts:702](https://github.com/TanStack/ai/blob/main/packages/typ
summarize: (options) => Promise<SummarizationResult>;
```

Defined in: [types.ts:737](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L737)
Defined in: [types.ts:735](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L735)

#### Parameters

Expand Down
12 changes: 6 additions & 6 deletions docs/reference/interfaces/AIAdapterConfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: AIAdapterConfig

# Interface: AIAdapterConfig

Defined in: [types.ts:743](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L743)
Defined in: [types.ts:741](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L741)

## Properties

Expand All @@ -15,7 +15,7 @@ Defined in: [types.ts:743](https://github.com/TanStack/ai/blob/main/packages/typ
optional apiKey: string;
```

Defined in: [types.ts:744](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L744)
Defined in: [types.ts:742](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L742)

***

Expand All @@ -25,7 +25,7 @@ Defined in: [types.ts:744](https://github.com/TanStack/ai/blob/main/packages/typ
optional baseUrl: string;
```

Defined in: [types.ts:745](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L745)
Defined in: [types.ts:743](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L743)

***

Expand All @@ -35,7 +35,7 @@ Defined in: [types.ts:745](https://github.com/TanStack/ai/blob/main/packages/typ
optional headers: Record<string, string>;
```

Defined in: [types.ts:748](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L748)
Defined in: [types.ts:746](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L746)

***

Expand All @@ -45,7 +45,7 @@ Defined in: [types.ts:748](https://github.com/TanStack/ai/blob/main/packages/typ
optional maxRetries: number;
```

Defined in: [types.ts:747](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L747)
Defined in: [types.ts:745](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L745)

***

Expand All @@ -55,4 +55,4 @@ Defined in: [types.ts:747](https://github.com/TanStack/ai/blob/main/packages/typ
optional timeout: number;
```

Defined in: [types.ts:746](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L746)
Defined in: [types.ts:744](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L744)
2 changes: 1 addition & 1 deletion docs/reference/type-aliases/ChatStreamOptionsForModel.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: ChatStreamOptionsForModel
type ChatStreamOptionsForModel<TAdapter, TModel> = TAdapter extends AIAdapter<any, any, any, any, infer ModelProviderOptions, infer ModelInputModalities, infer MessageMetadata> ? Omit<ChatOptions, "model" | "providerOptions" | "responseFormat" | "messages"> & object : never;
```

Defined in: [types.ts:811](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L811)
Defined in: [types.ts:809](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L809)

Chat options constrained by a specific model's capabilities.
Unlike ChatStreamOptionsUnion which creates a union over all models,
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/type-aliases/ChatStreamOptionsUnion.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: ChatStreamOptionsUnion
type ChatStreamOptionsUnion<TAdapter> = TAdapter extends AIAdapter<infer Models, any, any, any, infer ModelProviderOptions, infer ModelInputModalities, infer MessageMetadata> ? Models[number] extends infer TModel ? TModel extends string ? Omit<ChatOptions, "model" | "providerOptions" | "responseFormat" | "messages"> & object : never : never : never;
```

Defined in: [types.ts:751](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L751)
Defined in: [types.ts:749](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L749)

## Type Parameters

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/type-aliases/ExtractModalitiesForModel.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: ExtractModalitiesForModel
type ExtractModalitiesForModel<TAdapter, TModel> = TAdapter extends AIAdapter<any, any, any, any, any, infer ModelInputModalities> ? TModel extends keyof ModelInputModalities ? ModelInputModalities[TModel] : ReadonlyArray<Modality> : ReadonlyArray<Modality>;
```

Defined in: [types.ts:870](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L870)
Defined in: [types.ts:868](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L868)

Extract the supported input modalities for a specific model from an adapter.

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/type-aliases/ExtractModelsFromAdapter.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: ExtractModelsFromAdapter
type ExtractModelsFromAdapter<T> = T extends AIAdapter<infer M, any, any, any, any, any> ? M[number] : never;
```

Defined in: [types.ts:864](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L864)
Defined in: [types.ts:862](https://github.com/TanStack/ai/blob/main/packages/typescript/ai/src/types.ts#L862)

## Type Parameters

Expand Down
18 changes: 9 additions & 9 deletions examples/php-slim/composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,18 @@
}
],
"require": {
"php": ">=8.1",
"slim/slim": "^4.12",
"slim/psr7": "^1.6",
"vlucas/phpdotenv": "^5.5",
"monolog/monolog": "^3.0",
"anthropic-ai/sdk": "^0.3.0",
"openai-php/client": "^0.10.0",
"php": ">=8.5.0",
"slim/slim": "^4.15.1",
"slim/psr7": "^1.8.0",
"vlucas/phpdotenv": "^5.6.2",
"monolog/monolog": "^3.9.0",
"anthropic-ai/sdk": "^0.4.0",
"openai-php/client": "^0.18.0",
"tanstack/ai": "@dev",
"symfony/http-client": "^7.3"
"symfony/http-client": "^7.4.1"
},
"require-dev": {
"slim/psr7": "^1.6"
"slim/psr7": "^1.8.0"
},
"autoload": {
"psr-4": {
Expand Down
2 changes: 1 addition & 1 deletion examples/php-slim/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,6 @@
"start-openai": "concurrently -n \"php,ui\" -c \"cyan,magenta\" \"composer start-openai\" \"pnpm --filter vanilla-chat start\""
},
"devDependencies": {
"concurrently": "^9.1.2"
"concurrently": "^9.2.1"
}
}
2 changes: 1 addition & 1 deletion examples/python-fastapi/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,6 @@
"start:openai": "concurrently -n \"python,ui\" -c \"cyan,magenta\" \"venv/bin/python openai-server.py\" \"pnpm --filter vanilla-chat start\""
},
"devDependencies": {
"concurrently": "^9.1.2"
"concurrently": "^9.2.1"
}
}
12 changes: 6 additions & 6 deletions examples/python-fastapi/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
fastapi==0.115.0
uvicorn[standard]==0.32.0
anthropic==0.40.0
openai>=2.6.0
pydantic==2.9.2
python-dotenv==1.0.1
fastapi==0.124.0
uvicorn[standard]==0.38.0
anthropic==0.75.0
openai>=2.9.0
pydantic==2.12.5
python-dotenv==1.2.1
-e ../../packages/python/tanstack-ai

Loading
Loading