Skip to main content

​
Overview

FAISS (Facebook AI Similarity Search) is a library for efficient similarity search and clustering of dense vectors. It supports local file-based storage with HNSW, IVF_FLAT, and FLAT index types, plus quantization options. Provider Class: FaissProvider
Config Class: FaissConfig

​
Dependencies

pip install "upsonic[rag]"

​
Examples

from upsonic import Agent, Task, KnowledgeBase
from upsonic.embeddings.openai_provider import OpenAIEmbeddingProvider
from upsonic.vectordb import FaissProvider, FaissConfig, HNSWIndexConfig

# Setup embedding provider
embedding = OpenAIEmbeddingProvider(api_key="your-api-key")

# Create FAISS configuration
config = FaissConfig(
    collection_name="my_collection",
    vector_size=1536,
    db_path="./faiss_db",
    index=HNSWIndexConfig(m=16, ef_construction=200),
    normalize_vectors=True
)
vectordb = FaissProvider(config)

# Create knowledge base
kb = KnowledgeBase(
    sources="document.pdf",
    embedding_provider=embedding,
    vectordb=vectordb
)

# Use with Agent
agent = Agent("openai/gpt-4o")
task = Task(
    description="Search the documents",
    context=[kb]
)
result = agent.do(task)

​
Parameters

​
Base Parameters (from BaseVectorDBConfig)

ParameterTypeDescriptionDefaultRequired
collection_namestrName of the collection"default_collection"No
vector_sizeintDimension of vectors-Yes
distance_metricDistanceMetricSimilarity metric (COSINE, EUCLIDEAN, DOT_PRODUCT)COSINENo
recreate_if_existsboolRecreate collection if it existsFalseNo
default_top_kintDefault number of results10No
default_similarity_thresholdOptional[float]Minimum similarity score (0.0-1.0)NoneNo
dense_search_enabledboolEnable dense vector searchTrueNo
full_text_search_enabledboolEnable full-text searchTrueNo
hybrid_search_enabledboolEnable hybrid searchTrueNo
default_hybrid_alphafloatDefault alpha for hybrid search (0.0-1.0)0.5No
default_fusion_methodLiteral['rrf', 'weighted']Default fusion method for hybrid search'weighted'No
provider_nameOptional[str]Provider nameNoneNo
provider_descriptionOptional[str]Provider descriptionNoneNo
provider_idOptional[str]Provider IDNoneNo
default_metadataOptional[Dict[str, Any]]Default metadata for all recordsNoneNo
auto_generate_content_idboolAuto-generate content IDsTrueNo
indexed_fieldsOptional[List[Union[str, Dict[str, Any]]]]Fields to index for filteringNoneNo

​
FAISS-Specific Parameters

ParameterTypeDescriptionDefaultRequired
db_pathOptional[str]Path for persistent storage (required except in-memory)NoneNo
indexIndexConfigIndex type configuration (HNSWIndexConfig, IVFIndexConfig, FlatIndexConfig)HNSWIndexConfig()No
normalize_vectorsboolAuto-normalize vectors for cosine similarity (must be True for COSINE metric)TrueNo
quantization_typeOptional[Literal['scalar', 'product']]Quantization method for compressionNoneNo
quantization_bitsintBits for quantization8No