Redis
redis-vl-dotnet Documentation redis-vl-dotnet

redis-vl-dotnet

redis-vl-dotnet Documentation

This site is the canonical home for redis-vl-dotnet documentation.

Documentation publishing is automated through GitHub Pages. See Testing for the repository Pages settings and workflow requirements.

redis-vl-dotnet is a .NET-native Redis Vector Library for Redis Search, vector search, semantic caches, reranking flows, and related Redis-backed application workflows.

Use this landing page when you need the fastest path into the repository:

  • Getting Started for SDK prerequisites, local Redis setup, topology options, and the first schema-to-query workflow

  • Core Features for schemas, indexes, document lifecycle operations, query types, and aggregation workflows

  • Extensions for vectorizer and reranker packages plus provider-backed examples

  • Examples for runnable sample coverage across each major feature area

  • CLI for terminal-oriented schema and index management

  • Testing for local validation commands, CI gates, and GitHub Pages publishing details

  • Reference for repository layout and roadmap pointers

Repository highlights

The current workspace is organized around a few primary entry points:

  • src/RedisVL contains the core library surface for schema definitions, index operations, queries, caches, and workflow APIs

  • src/RedisVL.Cli contains the command-line app for index and schema lifecycle commands

  • src/RedisVL.Vectorizers. and src/RedisVL.Rerankers. contain optional provider abstractions and implementations

  • examples/ contains runnable sample projects for JSON, vector, semantic workflow, and provider-backed scenarios

  • docs/parity-roadmap.md tracks cross-language parity scope, intentional .NET differences, and the current roadmap contract

Local docs workflow

Build and validate this site from the repository root:

npm install
npm run docs:validate

The generated static site is written to build/site.

Section index