Table of contents

Getting started

• Vespa Overview
• Features
• Vespa CLI
• Getting Started with Ranking
• Vespa API and Interfaces
• Use case: Shopping
• Frequently Asked Questions - FAQ
• Tenants, Apps and Instances
• Glossary

Tutorials and quick starts

• News Tutorials
• Models Hot Swap
• Text Search
• Hybrid Text Search
• Text Search ML
• Quick Start
• Quick Start Java

Schemas and documents

• Documents
• Parent/Child
• Annotations API
• Concrete document types
• Exposing schema information
• Reindexing

Reading and writing

• /document/v1
• Visiting
• Vespa Feed Client
• Indexing
• Document API
• Partial Updates
• Batch delete
• Feed block

Querying

• 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
• Streaming Search
• Document Summaries
• Result Renderers
• Page Templates
• Result Diversity

Ranking and ML models

• Rank Features and Expressions
• 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

Linguistics and text processing

• Query Rewriting
• Troubleshooting character encoding
• Lucene Linguistics

Applications and components

• Developer Guide
• Unit Testing
• Testing
• Testing Reference
• Testing Reference Java
• 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
• LLMs in Vespa
• RAG in Vespa

Content and elasticity

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

Performance and tuning

• Practical performance guide
• Serving Sizing Guide
• Feed Sizing Guide
• Sizing Examples
• 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

• Archive
• Autoscaling
• Data management and backup
• Cloning applications and data
• Migrating to Vespa Cloud
• Migrating from ElasticSearch to Vespa
• Index bootstrap
• Monitoring
• Notifications
• Deleting applications
• Enclave - bring your own cloud
• Private endpoints
• Production deployment
• Topology and resizing

Operations - Vespa OSS

• 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
• Service Location Broker
• Change from attribute to index procedure
• Container
• Monitoring
• Routing

Configuration reference

• Schema Reference
• services.xml
• services.xml - admin
• services.xml - container
• services.xml - content
• services.xml - docproc
• services.xml - http
• services.xml - processing
• services.xml - search
• hosts.xml
• validation-overrides.xml
• Indexing Language Reference
• Custom Configuration File Reference
• mTLS Reference
• Internal Configuration File Reference
• Healthchecks Reference
• /state/v1 API Reference
• Deploy API
• HTTP Config API
• /application/v2/tenant API Reference
• /cluster/v2 API Reference
• /metrics/v1 API Reference
• /metrics/v2 API Reference
• /prometheus/v1 API Reference

Ranking and ML models reference

• Tensor Evaluation Reference
• nativeRank Reference
• Rank Feature Reference
• String Segment Match
• Rank Feature Configuration
• Rank Types
• Stateless Model Reference
• Embedding Model Reference

Queries and results reference

• Query Language Reference
• Simple Query Language Reference
• Select Reference
• Grouping Reference
• Sorting Reference
• Query Profile Reference
• Semantic Rule Language Reference
• Default JSON Result Format
• Page Templates Syntax
• Page Result Format
• Inspecting Structured Data in a Searcher
• Low-level request handler APIs

Document API reference

• Document JSON Format
• Document Field Path Syntax
• Document Selector Language

Component reference

Metrics reference

• Default Metric Set Reference
• Container Metrics Reference
• Distributor Metrics Reference
• Searchnode Metrics Reference
• Storage Metrics Reference
• Configserver Metrics Reference
• Logd Metrics Reference
• Node Admin Metrics Reference
• Slobrok Metrics Reference
• Clustercontroller Metrics Reference
• Sentinel Metrics Reference
• Metric Units Reference

Utilities and libraries

• Predicate Search Java Library
• pyvespa: Getting Started

Contributing

• Build and install Vespa
• Documentation Conventions
• Config API
• Developing Config Model Plugins
• Developing with the Java Cloud Config API
• Using the C++ Cloud config API