API Reference

The complete Go API reference for RedisVL is published on pkg.go.dev, generated directly from the source code documentation. Unlike the Java library’s bundled Javadoc, Go reference docs live alongside the module on the central package index.

Reference documentation

Core module on pkg.go.dev — github.com/redis/redis-vl-golang
hf module on pkg.go.dev — local embeddings and cross-encoders via ONNX Runtime (a separate Go module because it uses cgo)

Packages

Package Description

Package	Description
redisvl	Root package: `SearchIndex`, index lifecycle (`Create`, `Load`, `Fetch`, `Query`, `Delete`), batching, and sentinel errors like `ErrIndexNotFound`.
schema	Index schema definitions: `IndexSchema`, field constructors (text, tag, numeric, geo, vector), YAML loading, and SVS-VAMANA compression advisors.
query	Query builders: `VectorQuery`, `VectorRangeQuery`, `FilterQuery`, `TextQuery`, `HybridQuery`, `AggregateHybridQuery`, `MultiVectorQuery`, and `CountQuery`.
filter	Fluent filter expression DSL for tags, numerics, text, geo, and timestamps, combinable with `And`/`Or`.
vectors	Vector encoding utilities: `ToBuffer`/`FromBuffer` and the supported datatypes (`float32`, `float64`, `float16`, `bfloat16`, …).
extensions/vectorize	Embedding providers: OpenAI, Azure OpenAI, Cohere, Mistral, VoyageAI, Ollama, and the `Func` adapter for custom embedding functions.
extensions/vectorize/hf	Local, in-process sentence-transformer embeddings and cross-encoder reranking via ONNX Runtime (separate module).
extensions/cache	`SemanticCache`, `EmbeddingsCache`, `CachedVectorizer`, and the managed `LangCache` client. See Semantic Caching.
extensions/history	`MessageHistory` and `SemanticMessageHistory` for LLM conversation memory. See Message History.
extensions/router	`SemanticRouter` for classifying statements against routes. See Semantic Router.
extensions/rerank	Hosted rerankers (Cohere, VoyageAI) for improving search result relevancy. See Rerankers.
mcpserver	The MCP server implementation behind `rvl mcp`. See MCP Server.

redisvl

Root package: SearchIndex, index lifecycle (Create, Load, Fetch, Query, Delete), batching, and sentinel errors like ErrIndexNotFound.

schema

Index schema definitions: IndexSchema, field constructors (text, tag, numeric, geo, vector), YAML loading, and SVS-VAMANA compression advisors.

query

Query builders: VectorQuery, VectorRangeQuery, FilterQuery, TextQuery, HybridQuery, AggregateHybridQuery, MultiVectorQuery, and CountQuery.

filter

Fluent filter expression DSL for tags, numerics, text, geo, and timestamps, combinable with And/Or.

vectors

Vector encoding utilities: ToBuffer/FromBuffer and the supported datatypes (float32, float64, float16, bfloat16, …).

extensions/vectorize

Embedding providers: OpenAI, Azure OpenAI, Cohere, Mistral, VoyageAI, Ollama, and the Func adapter for custom embedding functions.

extensions/vectorize/hf

Local, in-process sentence-transformer embeddings and cross-encoder reranking via ONNX Runtime (separate module).

extensions/cache

SemanticCache, EmbeddingsCache, CachedVectorizer, and the managed LangCache client. See Semantic Caching.

extensions/history

MessageHistory and SemanticMessageHistory for LLM conversation memory. See Message History.

extensions/router

SemanticRouter for classifying statements against routes. See Semantic Router.

extensions/rerank

Hosted rerankers (Cohere, VoyageAI) for improving search result relevancy. See Rerankers.

mcpserver

The MCP server implementation behind rvl mcp. See MCP Server.

Versioning

RedisVL for Golang follows Go module conventions: releases are git tags (v0.2.0, …) on the repository, and pkg.go.dev renders the docs for every tagged version. Pin a specific version in your go.mod:

go get github.com/redis/redis-vl-golang@v0.2.0

The hf module is tagged and versioned alongside the core module but must be required separately.

Go doc conventions

Reference content comes straight from the source doc comments, so it is always in sync with the code:

Hovering over any RedisVL symbol in a Go-aware IDE (gopls) shows the same documentation.
go doc works offline from your module cache, for example go doc github.com/redis/redis-vl-golang/extensions/cache.SemanticCache.
Runnable examples on pkg.go.dev come from Example* functions in the test files.

On pkg.go.dev, use the version switcher at the top of the page to match the documentation to the module version in your go.mod.