Table of contents

Vespa basics

• Deploy an application
• Vespa applications
• Schemas
• Writing
• Querying
• Ranking
• Operations
• What's more

Learn more

• Vespa overview
• Features
• Tutorials and use cases
• Frequently Asked Questions
• Tenants, Apps and Instances
• Glossary

Clients

• Command line client (Vespa CLI)
• Python client (pyVespa)
• Java feed client

Schemas and documents

• Documents
• Inheritance in schemas
• Concrete document types
• Parent/Child
• Structs
• Exposing schema information

Reading and writing

• Reads and writes
• /document/v1
• Indexing
• Visiting
• Document API
• Partial Updates
• Batch delete
• Feed block

Querying

• The query api
• Vespa Query Language
• Grouping Information in Results
• Federation
• Query Profiles
• Nearest Neighbor Search
• Approximate Nearest Neighbor Search
• Nearest Neighbor Search Guide
• Text matching
• Geo Search
• Predicate Fields
• Document Summaries
• Result Renderers
• Result Diversity
• Page Templates

Ranking and ML models

• Getting Started with Ranking
• Ranking expressions and features
• Embedding
• Multivalue Query Operators
• Tensor User Guide
• Tensor Examples
• Phased Ranking
• Searcher Re-Ranking
• Cross-Encoder Transformer Ranking
• Ranking With TensorFlow Models
• Ranking With ONNX Models
• Ranking With XGBoost Models
• Ranking With LightGBM Models
• Stateless Model Evaluation
• Ranking With BM25
• Significance Model
• Ranking With nativeRank
• Accelerated OR search using the WAND algorithm
• Model Hub

Linguistics and text processing

• Linguistics
• Query Rewriting
• Troubleshooting character encoding
• Lucene Linguistics

Applications and components

• Developer guide
• Unit Testing
• Testing
• Testing Reference
• Testing Reference Java
• Deployment
• The config system
• Java Serving Container
• Container Components
• Request-Response Processing
• Searcher Development
• Document Processor Development
• Developing Web Service Applications
• Component Injection
• Chained Components
• Configuring Java components
• Bundles
• Using ZooKeeper
• Developing request handlers
• Building an HTTP API using request handlers and processors
• Configuring Http Servers and Filters
• Using Libraries for Pluggable Frameworks
• Developing server providers
• Server Tutorial

GenAI and RAG

• LLMs in Vespa
• Working with chunks
• Local LLMs in Vespa
• External LLMs in Vespa
• RAG in Vespa
• Document enrichment with LLMs

Content and elasticity

• Elasticity
• Proton
• Content Nodes and States
• Consistency Model
• Distribution Algorithm
• Buckets

Performance and tuning

• Performance overview
• Practical performance guide
• Serving Sizing Guide
• Feed Sizing Guide
• Sizing Examples
• Streaming Search
• Binarizing Vectors
• Document Attributes
• Benchmarking
• Benchmarking with Vespa Cloud
• Memory Visualizer
• Profiling
• Container Tuning
• Rate-Limiting Search Requests
• Graceful Query Coverage Degradation
• Caches
• HTTP Performance Testing
• HTTP Best Practices
• HTTP/2
• Feature Tuning
• Valgrind

Operations - Vespa Cloud

• Automated deployments
• Node resources
• Autoscaling
• Topology and resizing
• Production deployment
• Migrating to Vespa Cloud
• Migrating from ElasticSearch to Vespa
• Data management and backup
• Cloning applications and data
• Index bootstrap
• Monitoring
• Notifications
• Deleting applications
• Environments
• Zones
• Private endpoints
• Deployment patterns
• Routing
• Reindexing

Operations - Self-managed

• Admin procedures
• Metrics
• Logs
• Access Logging
• Multinode Systems
• Files, Processes, Ports, Environment
• Node Setup
• Content node recovery
• Using Kubernetes with Vespa
• Securing a Vespa installation
• mTLS
• Configuration Servers
• Live Vespa upgrade procedure
• Config Sentinel
• Config Proxy
• Docker Containers
• Vespa Command-line Tools
• Docker Containers GPU setup
• CPU Support
• Service Location Broker
• Change from attribute to index procedure
• Container
• Monitoring
• Routing

Security

• Security overview
• Security Guide
• Secret Store
• Cloudflare Workers
• Security Whitepaper

Reference

• Application packages
• Schemas
• deployment.xml
• Deployment variants
• hosts.xml
• validation-overrides.xml
• APIs and Interfaces
• Indexing language
• Chunking
• Embedding
• Components
• Custom configuration files
• Configuration file format
• mTLS
• Tools
• Health checks

Getting help from LLMs

• Guide to using LLMs
• llms.txt

Contributing

• Contributing
• Build and install Vespa
• Documentation Conventions