diff --git a/docs/source/providers/index.md b/docs/source/providers/index.md index adccc710f..b051ebb4a 100644 --- a/docs/source/providers/index.md +++ b/docs/source/providers/index.md @@ -31,15 +31,16 @@ Importantly, Llama Stack always strives to provide at least one fully "local" pr ## Tool Runtime -## Vector DBs +## Vector IO + +Vector IO refers to operations on vector databases, such as adding documents, searching, and deleting documents. +Vector IO plays a crucial role in [Retreival Augmented Generation (RAG)](../building_applications/rag), where the vector +io and database are used to store and retrieve documents for retrieval. + +The following providers (i.e., databases) are available for Vector IO: ```{toctree} :maxdepth: 1 -vector_db/chromadb -vector_db/sqlite-vec -vector_db/faiss -vector_db/pgvector -vector_db/qdrant -vector_db/weaviate +vector_io/index ``` diff --git a/docs/source/providers/vector_db/chromadb.md b/docs/source/providers/vector_io/chromadb.md similarity index 100% rename from docs/source/providers/vector_db/chromadb.md rename to docs/source/providers/vector_io/chromadb.md diff --git a/docs/source/providers/vector_db/faiss.md b/docs/source/providers/vector_io/faiss.md similarity index 100% rename from docs/source/providers/vector_db/faiss.md rename to docs/source/providers/vector_io/faiss.md diff --git a/docs/source/providers/vector_io/index.md b/docs/source/providers/vector_io/index.md new file mode 100644 index 000000000..ea38e0951 --- /dev/null +++ b/docs/source/providers/vector_io/index.md @@ -0,0 +1,10 @@ +```{toctree} +:maxdepth: 2 + +chromadb +sqlite-vec +faiss +pgvector +qdrant +weaviate +``` diff --git a/docs/source/providers/vector_db/pgvector.md b/docs/source/providers/vector_io/pgvector.md similarity index 100% rename from docs/source/providers/vector_db/pgvector.md rename to docs/source/providers/vector_io/pgvector.md diff --git a/docs/source/providers/vector_db/qdrant.md b/docs/source/providers/vector_io/qdrant.md similarity index 100% rename from docs/source/providers/vector_db/qdrant.md rename to docs/source/providers/vector_io/qdrant.md diff --git a/docs/source/providers/vector_db/sqlite-vec.md b/docs/source/providers/vector_io/sqlite-vec.md similarity index 100% rename from docs/source/providers/vector_db/sqlite-vec.md rename to docs/source/providers/vector_io/sqlite-vec.md diff --git a/docs/source/providers/vector_io/weaviate.md b/docs/source/providers/vector_io/weaviate.md new file mode 100644 index 000000000..5c593ef42 --- /dev/null +++ b/docs/source/providers/vector_io/weaviate.md @@ -0,0 +1,30 @@ +# Weaviate + +[Weaviate](https://weaviate.io/) is a vector database provider for Llama Stack. +It allows you to store and query vectors directly within a Weaviate database. +That means you're not limited to storing vectors in memory or in a separate service. + +## Features +Weaviate supports: +- Store embeddings and their metadata +- Vector search +- Full-text search +- Hybrid search +- Document storage +- Metadata filtering +- Multi-modal retrieval + +## Usage + +To use Weaviate in your Llama Stack project, follow these steps: + +1. Install the necessary dependencies. +2. Configure your Llama Stack project to use chroma. +3. Start storing and querying vectors. + +## Installation + +To install Weaviate see the [Weaviate quickstart documentation](https://weaviate.io/developers/weaviate/quickstart). + +## Documentation +See [Weaviate's documentation](https://weaviate.io/developers/weaviate) for more details about Weaviate in general.