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
• Semantic Caching for LLMs
  • Initializing SemanticCache
  • Basic Cache Usage
  • Customize the Distance Threshhold
  • Utilize TTL
  • Simple Performance Testing
  • Cache Access Controls, Tags & Filters
• 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
• 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:
• Cleanup
• 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
• Threshold Optimization
• CacheThresholdOptimizer
  • Define test_data and optimize
• RouterThresholdOptimizer
  • Define the routes
  • Initialize the SemanticRouter
  • Provide test_data
  • Optimize
  • Test it out
  • Cleanup
• Release Guides
  • 0.5.1 Feature Overview
  • HybridQuery class
  • TextQueries
  • Threshold optimization
  • Schema validation
  • Timestamp filters
  • Batch search
  • Vector normalization
  • Hybrid policy on knn with filters