Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 6805ecd

Browse files
committed
[Documentation][Website] Fix outdated references and document component bridges
1 parent dceb030 commit 6805ecd

3 files changed

Lines changed: 38 additions & 7 deletions

File tree

AGENTS.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,15 @@ Low-level abstraction for vector stores enabling RAG applications. Unified inter
1111
### Core Interfaces
1212
- **StoreInterface**: Main interface with `add()` and `query()` methods
1313
- **ManagedStoreInterface**: Extends with `setup()` and `drop()` lifecycle methods
14-
- **Indexer**: High-level service converting TextDocuments to VectorDocuments
14+
- **IndexerInterface** (implementations in `src/Indexer/`): high-level services converting TextDocuments to VectorDocuments
1515

1616
### Bridge Pattern
1717
Multiple vector store implementations:
1818

1919
**Database**: Postgres, MariaDB, ClickHouse, MongoDB, Neo4j, SurrealDB
2020
**Cloud**: Azure AI Search, Pinecone
2121
**Search**: Meilisearch, Typesense, Weaviate, Qdrant, Milvus
22-
**Local**: InMemoryStore, CacheStore (PSR-6)
22+
**Local**: InMemory (`src/InMemory/Store.php`, not a bridge), Cache bridge (`src/Bridge/Cache/Store.php`, PSR-6)
2323
**External**: ChromaDb (requires codewithkyrian/chromadb-php)
2424

2525
### Document System
@@ -33,7 +33,7 @@ Multiple vector store implementations:
3333
### Testing
3434
```bash
3535
vendor/bin/phpunit
36-
vendor/bin/phpunit tests/Bridge/Local/InMemoryStoreTest.php
36+
vendor/bin/phpunit tests/InMemory/StoreTest.php
3737
vendor/bin/phpunit --filter testMethodName
3838
```
3939

CLAUDE.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ Run the full test suite:
1414
vendor/bin/phpunit
1515
```
1616

17-
Run tests for a specific bridge (e.g., InMemory):
17+
Run tests for a specific store (e.g., InMemory):
1818
```bash
19-
vendor/bin/phpunit tests/Bridge/Local/InMemoryStoreTest.php
19+
vendor/bin/phpunit tests/InMemory/StoreTest.php
2020
```
2121

2222
Run a single test method:
@@ -41,15 +41,15 @@ composer install
4141
### Core Interfaces
4242
- **StoreInterface**: Main interface defining `add()` and `query()` methods for vector document storage and retrieval
4343
- **ManagedStoreInterface**: Extension interface providing `setup()` and `drop()` methods for store lifecycle management
44-
- **Indexer**: High-level service that converts TextDocuments to VectorDocuments and stores them in batches
44+
- **IndexerInterface** (`src/IndexerInterface.php`, implementations in `src/Indexer/`): high-level services that convert TextDocuments to VectorDocuments and store them in batches
4545

4646
### Bridge Pattern Architecture
4747
The component follows a bridge pattern with implementations for multiple vector stores:
4848

4949
**Database Bridges**: Postgres, MariaDB, ClickHouse, MongoDB, Neo4j, SurrealDB
5050
**Cloud Service Bridges**: Azure AI Search, Pinecone
5151
**Search Engine Bridges**: Meilisearch, Typesense, Weaviate, Qdrant, Milvus
52-
**Local Bridges**: InMemoryStore, CacheStore (PSR-6)
52+
**Local stores**: InMemory (`src/InMemory/Store.php`, not a bridge), Cache bridge (`src/Bridge/Cache/Store.php`, PSR-6)
5353
**External Service Bridges**: ChromaDb (requires codewithkyrian/chromadb-php)
5454

5555
### Document System

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,37 @@ are not covered by Symfony's
1313
composer require symfony/ai-store
1414
```
1515

16+
## Store Bridges
17+
18+
To use a specific vector store, install the corresponding bridge package:
19+
20+
| Store | Package |
21+
|----------------------|-------------------------------------|
22+
| AWS S3 Vectors | `symfony/ai-s3vectors-store` |
23+
| Azure AI Search | `symfony/ai-azure-search-store` |
24+
| Cache | `symfony/ai-cache-store` |
25+
| ChromaDB | `symfony/ai-chroma-db-store` |
26+
| ClickHouse | `symfony/ai-click-house-store` |
27+
| Cloudflare Vectorize | `symfony/ai-cloudflare-store` |
28+
| Elasticsearch | `symfony/ai-elasticsearch-store` |
29+
| ManticoreSearch | `symfony/ai-manticore-search-store` |
30+
| MariaDB | `symfony/ai-maria-db-store` |
31+
| Meilisearch | `symfony/ai-meilisearch-store` |
32+
| Milvus | `symfony/ai-milvus-store` |
33+
| MongoDB Atlas | `symfony/ai-mongo-db-store` |
34+
| Neo4j | `symfony/ai-neo4j-store` |
35+
| OpenSearch | `symfony/ai-open-search-store` |
36+
| Pinecone | `symfony/ai-pinecone-store` |
37+
| PostgreSQL pgvector | `symfony/ai-postgres-store` |
38+
| Qdrant | `symfony/ai-qdrant-store` |
39+
| Redis | `symfony/ai-redis-store` |
40+
| SQLite | `symfony/ai-sqlite-store` |
41+
| Supabase | `symfony/ai-supabase-store` |
42+
| SurrealDB | `symfony/ai-surreal-db-store` |
43+
| Typesense | `symfony/ai-typesense-store` |
44+
| Vektor | `symfony/ai-vektor-store` |
45+
| Weaviate | `symfony/ai-weaviate-store` |
46+
1647
**This repository is a READ-ONLY sub-tree split**. See
1748
https://github.com/symfony/ai to create issues or submit pull requests.
1849

0 commit comments

Comments
 (0)