Skip to content

Commit 69dc789

Browse files
docs: Add unsupported search mode info about FAISS (llamastack#3089)
1 parent ce72a28 commit 69dc789

File tree

3 files changed

+30
-2
lines changed

3 files changed

+30
-2
lines changed

docs/source/providers/vector_io/inline_faiss.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,18 @@ That means you'll get fast and efficient vector retrieval.
1212
- Lightweight and easy to use
1313
- Fully integrated with Llama Stack
1414
- GPU support
15+
- **Vector search** - FAISS supports pure vector similarity search using embeddings
16+
17+
## Search Modes
18+
19+
**Supported:**
20+
- **Vector Search** (`mode="vector"`): Performs vector similarity search using embeddings
21+
22+
**Not Supported:**
23+
- **Keyword Search** (`mode="keyword"`): Not supported by FAISS
24+
- **Hybrid Search** (`mode="hybrid"`): Not supported by FAISS
25+
26+
> **Note**: FAISS is designed as a pure vector similarity search library. See the [FAISS GitHub repository](https://github.com/facebookresearch/faiss) for more details about FAISS's core functionality.
1527
1628
## Usage
1729

llama_stack/providers/inline/vector_io/faiss/faiss.py

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,9 @@ async def query_keyword(
174174
k: int,
175175
score_threshold: float,
176176
) -> QueryChunksResponse:
177-
raise NotImplementedError("Keyword search is not supported in FAISS")
177+
raise NotImplementedError(
178+
"Keyword search is not supported - underlying DB FAISS does not support this search mode"
179+
)
178180

179181
async def query_hybrid(
180182
self,
@@ -185,7 +187,9 @@ async def query_hybrid(
185187
reranker_type: str,
186188
reranker_params: dict[str, Any] | None = None,
187189
) -> QueryChunksResponse:
188-
raise NotImplementedError("Hybrid search is not supported in FAISS")
190+
raise NotImplementedError(
191+
"Hybrid search is not supported - underlying DB FAISS does not support this search mode"
192+
)
189193

190194

191195
class FaissVectorIOAdapter(OpenAIVectorStoreMixin, VectorIO, VectorDBsProtocolPrivate):

llama_stack/providers/registry/vector_io.py

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,18 @@ def available_providers() -> list[ProviderSpec]:
4545
- Lightweight and easy to use
4646
- Fully integrated with Llama Stack
4747
- GPU support
48+
- **Vector search** - FAISS supports pure vector similarity search using embeddings
49+
50+
## Search Modes
51+
52+
**Supported:**
53+
- **Vector Search** (`mode="vector"`): Performs vector similarity search using embeddings
54+
55+
**Not Supported:**
56+
- **Keyword Search** (`mode="keyword"`): Not supported by FAISS
57+
- **Hybrid Search** (`mode="hybrid"`): Not supported by FAISS
58+
59+
> **Note**: FAISS is designed as a pure vector similarity search library. See the [FAISS GitHub repository](https://github.com/facebookresearch/faiss) for more details about FAISS's core functionality.
4860
4961
## Usage
5062

0 commit comments

Comments
 (0)