Guides

Get started

Quickstart

Quickstart: With Cloud resourcesQuickstart: Locally hosted with Docker

Connect to Weaviate

Connect to WeaviateWeaviate CloudLocal instancesCustom connectionsEmbedded WeaviateConnect with Query Agent

Starter guides

Starter guidesWeaviate configurationsQuickstart: Bring your own vectorsRetrieval augmented generation (RAG)Collection definitions (schemas)Scaling limits with collectionsManaging resources (Hot, Warm, Cold)CompressionIndexingTenant states

Best practices

AI-assisted (vibe) coding

AI-assisted Weaviate code generationWeaviate MCP serverWeaviate Docs MCP Server

Model provider integrations

Search

SearchVector SearchKeyword Search (BM25)Hybrid search

Concepts

ConceptsData structureData importModulesStorageCompression (Vector Quantization)FilteringRerankingHorizontal ScalingInterfaceResource Planning

Replication Architecture

Replication ArchitectureUse Cases (Motivation)PhilosophyCluster ArchitectureConsistencyMulti-Data center

Indexing

IndexingVector IndexingInverted indexes

GuidesHow-to manuals and Guides

How-to: Configure Weaviate

How to configure WeaviateAuthentication and authorizationCompressionRotational Quantization (RQ)Product Quantization (PQ)Binary Quantization (BQ)Scalar Quantization (SQ)Uncompressed vector embeddingsMulti-vector encodingsModules

How-to: Manage collections

Manage collectionsBasic collection operationsVectorizer and vector index configGenerative and reranker modelsInverted indexMulti-tenancy operationsManage tenant states & temperatureCollection aliasesTime to live (TTL)Multi-node setupMigrate dataCross-references

How-to: Manage objects

Manage objectsCreate objectsBatch importRead objectsRead all objectsUpdate objectsDelete objects

How-to: Query & Search

Query and searchSearch patterns and basicsQuery Agent searchVector similarity searchKeyword searchHybrid searchImage searchMultimedia searchMultiple target vectorsRetrieval Augmented Generation (RAG)RerankingBoostAggregate dataFiltersQuery profiling

Guides: Tutorials

TutorialsQuick tour of WeaviateSwitching vectorizersBatch data importMulti-vector embeddings (ColBERT, ColPali, etc.)Select & configure vector indexesConfigure tokenization for keyword searchSetting up RBAC in WeaviateSecuring Weaviate with SSL/TLSZero-downtime collection migration with aliasesManage relationships with cross-referencesLoad data into Weaviate with Spark

Reference: Configuration

ConfigurationCollection definitionVector indexInverted indexProperty data typesDistance metrics

Client libraries

Client Libraries / SDKsPythonAsync APINotes and best practicesJavaScript and TypeScriptNotes and best practicesJavaC#Go Community clients

APIs

APIsSearch (GraphQL | gRPC)Object-level queries (Get)AggregateSearch operatorsConditional filtersAdditional operatorsAdditional properties (metadata)ExploregRPC

Releases

Release NotesKnown issues

Benchmarks

BenchmarksANN Benchmark

Modules

Reference - ModulesContextionary VectorizerRef2Vec Centroid VectorizerQuestion Answering - transformersQuestion Answering - OpenAINamed Entity RecognitionSpell CheckSummarizationCustom modulesUsage Module

Others

OthersFAQGlossaryExample datasets

Recipes

Weaviate Recipes (code examples)Generate new content with NVIDIA models and RAGGenerative search (RAG) with AWS BedrockHow to Use Weaviate Embedding ServiceHybrid Search with MistralMulti-vector RAG: Using Weaviate to search a collection of PDF documentsSimilarity Search with Cohere

Installation

Deploying WeaviateWeaviate CloudDockerKubernetesEmbedded Weaviate

Deploy: AWS

Deploy: AWSMarketplace - Weaviate Shared CloudSelf-Managed EKS

GCP

GCPGCP Marketplace - Weaviate Shared Cloud

DigitalOcean

DigitalOceanDigitalOcean Managed Weaviate

Deploy config

Deploy configConfiguration overview

Authorization and authentication

Authorization and authenticationAuthenticationAuthorizationOIDC ConfigurationRBAC OverviewEnable and configure RBACManage rolesManage usersManage groups

Database configuration

Database configurationEnvironment variables referenceRuntime configuration management

Monitoring and logging

Monitoring and loggingMonitoringLoggingCluster status and metadataTelemetry

Replication and scaling

Replication and scalingReplicationAsync ReplicationReplica movementHorizontal Scaling Deployment Strategies

Storage and backups

Storage and backupsBackupsCollection exportPersistenceTenant Offloading

Deploy production

Deploy productionProduction Environments

Kubernetes

KubernetesKubernetes: Getting to productionKubernetes: Production readiness self-assessment

Deploy production: AWS

Deploying Weaviate on AWSAWS: Hardening your EKS deploymentAWS: Network security - Best practices

Deploy faqs

Deploy faqsDeployment Troubleshooting Guide

Deploy migration

Deploy migrationBlockMax WAND migration guide1.25 (For Kubernetes users)Archive

Agents

AgentsIntroductionInstallationQuickstartLimitations & troubleshooting

Modes

ModesAsk ModeSearch ModeSuggest Queries Mode

Agents: Configuration

ConfigurationClass instantiationCustomizing the system promptMulti-turn conversationsAdditional filtersCollection configurationStructured outputs

Clients

Client librariesPython clientJavaScript/TypeScript client

Tutorials and guides

Tutorials and guidesGet started with the Weaviate Query AgentBuild a Query Agent e-commerce assistantBuild a streaming chat UI with StreamlitQuery Agent vs. doing it yourselfUsing the Query Agent as a tool

Contributor guide

Open-source at WeaviateFeature requests and enhancementsReporting bugsGetting Started

Contributor

ContributorWeaviate Clients

Weaviate Database

Weaviate DatabaseCode structure and styleCICD philosophyTestsDevelopment setupParsing objects & resolving referencesRuntime configurations

Weaviate Docs

Weaviate DocumentationSetup and editingStyle guidelinesOptimizing docs for LLMs

Weaviate Modules

Weaviate module systemArchitectureModule creation in a nutshell

Cloud

CloudWeaviate CloudWeaviate Cloud QuickstartFAQs

Manage clusters

Manage clustersConnect to Weaviate CloudCreate a clusterCluster status and metricsAuthenticationAuthorizationDefault cluster settings

Manage collections

Manage collectionsCollections toolEnable compression

Cloud: Agents

Cloud: AgentsQuery Agent

Other tools

Other toolsExplorer tool

Cloud weaviate embeddings

Cloud weaviate embeddingsWeaviate EmbeddingsQuickstartChoose a modelAdministration

Cloud account management

Cloud account managementBillingServer versionManage user accountsMulti-factor authenticationUsers and organizations

Engram

EngramEngramQuickstartInstall & integrateEngram Web Console

Engram: Concepts

ConceptsMemoriesTopicsScopesInput data typesPipelines and runsSearchGroups

Engram: Guides

GuidesStore memoriesSearch memoriesManage memoriesCheck run status

Engram: Tutorials

TutorialsAdd Long-Term Memory to a Chat AppContext Window ManagementPersonalized RAG with Per-User Memory

Support

SupportWeaviate Support

Errors

ErrorsImprove your clusterError and warning messagesCluster resource messagesCollection configuration messagesModel integration messages

Deploy

DeployDeployment FAQsHow to install WeaviateSnowpark Container Services (SPCS)Migration and Upgrades

Query agent

Query agentResearch Mode

Weaviate

WeaviateConceptsResNet Image VectorizerExample use cases and demosMore resourcesIndex types and performanceHow to write great bug reportsModules - an introductionImports - Vector provision optionsWikipedia with custom vectors