User Guides

User guides provide helpful resources for using RedisVL and its different components.

• Getting Started with RedisVL
  • Define an IndexSchema
  • Sample Dataset Preparation
  • Create a SearchIndex
  • Inspect with the rvl CLI
  • Load Data to SearchIndex
  • Creating VectorQuery Objects
  • Using an Asynchronous Redis Client
  • Updating a schema
  • Check Index Stats
  • Cleanup
• Querying with RedisVL
  • Hybrid Queries
  • Combining Filters
  • Non-vector Queries
  • Count Queries
  • Range Queries
  • Advanced Query Modifiers
• LLM Caching
  • Initializing SemanticCache
  • Basic Cache Usage
  • Customize the Distance Threshold
  • Utilize TTL
  • Simple Performance Testing
  • Cache Access Controls, Tags & Filters
• Vectorizers
  • Creating Text Embeddings
  • Search with Provider Embeddings
  • Selecting your float data type
• Hash vs JSON Storage
  • Hash or JSON – how to choose?
  • Cleanup
• Working with nested data in JSON
  • Full JSON Path support
  • As an example:
• Rerankers
  • Simple Reranking
• LLM Message History
  • Managing multiple users and conversations
  • Semantic message history
  • Conversation control
• Semantic Routing
  • Define the Routes
  • Initialize the SemanticRouter
  • Simple routing
  • Update the routing config
  • Router serialization
  • Add route references
  • Get route references
  • Delete route references
  • Clean up the router
• SVS-VAMANA Vector Search
  • Prerequisites
  • Quick Start with CompressionAdvisor
  • Creating an SVS-VAMANA Index
  • Loading Sample Data
  • Performing Vector Searches
  • Runtime Parameters for Performance Tuning
  • Understanding Compression Types
  • Compression Types Explained
  • Hybrid Queries with SVS-VAMANA
  • Performance Monitoring
  • Manual Configuration (Advanced)
  • Best Practices and Tips
  • Cleanup
• Caching Embeddings
  • Setup
  • Initializing the EmbeddingsCache
  • Basic Usage
  • Advanced Usage
  • Async Support
  • Real-World Example
  • Performance Benchmark
  • Common Use Cases for Embedding Caching
  • Cleanup
  • Summary
• Advanced Query Types
  • Setup and Data Preparation
  • Define the Schema
  • Create Index and Load Data
  • 1. TextQuery: Full Text Search
  • 2. AggregateHybridQuery: Combining Text and Vector Search
  • 3. MultiVectorQuery: Multi-Vector Search
  • Comparing Query Types
  • Best Practices