Skip to content
Nappai Documentation

Redis

This component helps Nappai quickly find similar pieces of information within your data. It uses a special type of database (Redis) to store and search this information very efficiently. Think of it as a highly organized filing cabinet that lets you find exactly what you need, very quickly.

Relationship with Redis

This component uses the Redis database to store and search your data. Redis is known for its speed and efficiency, making searches very fast, even with large amounts of information.

Inputs

  • Redis Index: The name you give to the location where your data will be stored within Redis. Think of it as the folder name in your filing cabinet.
  • Schema: Defines the structure of your data within Redis. This helps Nappai understand how your information is organized. (Usually pre-configured and you won’t need to change this.)
  • Search Query: The words or phrases you type to search for information. This is what you’ll use to find what you need.
  • Ingest Data: The information you want to add to the Redis database. This could be text documents, descriptions, or any data that can be converted into a searchable format.
  • Number of Results: How many search results you want to see (default is 4).
  • Embedding: (Usually pre-configured and you won’t need to change this.) This is a technical setting that helps Nappai understand the meaning of your data and find similar items.
  • Credential: Your login information to access the Redis database. (Usually pre-configured and you won’t need to change this.)

Outputs

The component returns a list of the most similar pieces of information found based on your search query. These results can then be used by other parts of Nappai to complete your task, such as displaying them on the dashboard or using them in further analysis.

Usage Example

Let’s say you have a collection of customer reviews and want to find reviews similar to a specific one. You would:

  1. Provide the name for your Redis storage location (Redis Index).
  2. Enter your search query (e.g., “excellent customer service”).
  3. Nappai will then search the Redis database and return a list of the most similar customer reviews.

Templates

[List of templates where the component is used - This section will be populated based on the actual templates used.]

  • VectorStoreInfo: Provides information about the vector store used by this component.
  • Self Query Retriever: Uses this component to search for information and generate queries.
  • [Other Components]: [List and brief descriptions of other connected components, using the provided list. Keep descriptions concise and user-friendly.] For example: Google Drive File Manager: Lets you upload files to be indexed by this component.

Tips and Best Practices

  • Make sure your Redis Index name is descriptive and easy to remember.
  • Use clear and concise search queries for better results.
  • Experiment with the “Number of Results” input to adjust the number of results displayed.

Security Considerations

  • Ensure your Redis credentials are securely stored and protected. Nappai will handle this securely, but it’s important to be aware of the security implications of storing sensitive data.