Welcome to vd’s documentation!

Contents:

• vd
  • Quick start
  • Embedding is external
  • AbstractClient
  • AbstractCollection
  • AsyncClient
  • AsyncClientWrapper
  • AsyncCollection
  • AsyncCollectionWrapper
  • BM25Index
  • BackendNotInstalledError
  • Client
  • Collection
  • Document
  • EmbeddingRequiredError
  • StaticIndexError
  • SupportsBatch
  • SupportsHybrid
  • SupportsNativeAsync
  • TimeIndexedCollection
  • UnsupportedCapabilityError
  • UnsupportedFilterError
  • VdError
  • WindowSlice
  • benchmark_insert()
  • benchmark_search()
  • bm25_lexical_search()
  • check_requirements()
  • chunk_documents()
  • chunk_text()
  • clean_text()
  • collection_stats()
  • compare_backends()
  • connect()
  • connect_async()
  • connect_from_config()
  • copy_collection()
  • cosine_similarity()
  • count_docs()
  • create_example_config()
  • deduplicate_results()
  • euclidean_distance()
  • export_collection()
  • export_to_directory()
  • export_to_json()
  • export_to_jsonl()
  • extract_metadata()
  • find_duplicates()
  • find_outliers()
  • get_backend_characteristics()
  • get_backend_info()
  • get_install_instructions()
  • health_check_backend()
  • health_check_collection()
  • hybrid_search()
  • hybrid_search_async()
  • id_and_score()
  • id_only()
  • id_text_score()
  • import_collection()
  • import_from_directory()
  • import_from_json()
  • import_from_jsonl()
  • install_backend()
  • install_command()
  • list_all_backends()
  • list_available_backends()
  • list_backends()
  • load_config()
  • matches_filter()
  • mean_vector()
  • metadata_distribution()
  • migrate_client()
  • migrate_collection()
  • multi_query_search()
  • normalize_document_input()
  • normalize_whitespace()
  • parse_window()
  • print_backends_table()
  • print_comparison()
  • print_recommendation()
  • provider()
  • providers()
  • reciprocal_rank_fusion()
  • recommend_backend()
  • register_backend()
  • sample_collection()
  • save_config()
  • search_similar_to_document()
  • setup_guide()
  • skills_dir()
  • text_only()
  • to_datetime()
  • to_iso()
  • truncate_text()
  • validate_collection()
  • validate_filter()
• vd.analytics
  • collection_stats()
  • find_duplicates()
  • find_outliers()
  • metadata_distribution()
  • sample_collection()
  • validate_collection()
• vd.asynchronous
  • AsyncClientWrapper
  • AsyncCollectionWrapper
  • SupportsHybrid
  • connect_async()
  • hybrid_search_async()
• vd.backends
• vd.backends._helpers
  • OVERFETCH_FACTOR
  • apply_client_filter()
  • coerce_metadata()
  • overfetch_limit()
  • score_from_distance()
• vd.backends.chroma
• vd.backends.duckdb
• vd.backends.elasticsearch
• vd.backends.faiss
• vd.backends.lancedb
• vd.backends.memory
  • MemoryClient
  • MemoryCollection
• vd.backends.milvus
• vd.backends.mongodb
• vd.backends.pgvector
• vd.backends.pinecone
• vd.backends.qdrant
• vd.backends.redis
• vd.backends.sqlite_vec
• vd.backends.turbopuffer
• vd.backends.weaviate
• vd.base
  • AbstractClient
  • AbstractCollection
  • AsyncClient
  • AsyncCollection
  • BackendNotInstalledError
  • Client
  • Collection
  • Document
  • DocumentInput
  • EmbeddingRequiredError
  • METRICS
  • StaticIndexError
  • SupportsBatch
  • SupportsHybrid
  • SupportsNativeAsync
  • UnsupportedCapabilityError
  • UnsupportedFilterError
  • VdError
• vd.cli
  • cmd_backends()
  • cmd_benchmark()
  • cmd_export()
  • cmd_health_check()
  • cmd_import()
  • cmd_install_info()
  • cmd_migrate()
  • cmd_stats()
  • cmd_validate()
  • main()
• vd.config
  • apply_env_overrides()
  • connect_from_config()
  • create_example_config()
  • get_profile()
  • load_config()
  • load_toml_config()
  • load_yaml_config()
  • save_config()
• vd.filters
  • Filter syntax
  • FIELD_OPERATORS
  • LOGICAL_OPERATORS
  • SUPPORTED_FILTER_OPERATORS
  • matches_filter()
  • validate_filter()
• vd.health
  • benchmark_insert()
  • benchmark_search()
  • health_check_backend()
  • health_check_collection()
• vd.io
  • export_collection()
  • export_to_directory()
  • export_to_json()
  • export_to_jsonl()
  • import_collection()
  • import_from_directory()
  • import_from_json()
  • import_from_jsonl()
• vd.migration
  • copy_collection()
  • migrate_client()
  • migrate_collection()
• vd.providers
  • compare_backends()
  • get_backend_characteristics()
  • get_backend_info()
  • get_install_instructions()
  • has_adapter()
  • install_command()
  • is_installed()
  • list_all_backends()
  • list_available_backends()
  • print_backends_table()
  • print_comparison()
  • print_recommendation()
  • provider()
  • provider_names()
  • providers()
  • recommend_backend()
  • registry_as_of()
• vd.requirements
  • check_requirements()
  • install_backend()
  • setup_guide()
• vd.search
  • BM25Index
  • bm25_lexical_search()
  • deduplicate_results()
  • hybrid_search()
  • multi_query_search()
  • reciprocal_rank_fusion()
  • search_similar_to_document()
  • search_with_feedback()
• vd.text
  • chunk_documents()
  • chunk_text()
  • clean_text()
  • extract_metadata()
  • normalize_whitespace()
  • truncate_text()
• vd.time_indexed
  • TimeIndexedCollection
  • WindowSlice
  • count_docs()
  • mean_vector()
  • parse_window()
  • to_datetime()
  • to_iso()
• vd.util
  • connect()
  • cosine_similarity()
  • euclidean_distance()
  • get_backend()
  • id_and_score()
  • id_only()
  • id_text_score()
  • list_backends()
  • mean_vector()
  • normalize_document_input()
  • register_backend()
  • text_only()

Indices and tables

• Index

• Module Index

• Search Page

Release: 0.2.10

Last change: Jun 21, 2026