Guide

Query Memory

Overview

Hyperspell's memory query feature allows you to search and retrieve documents from your knowledge base using natural language or structured queries. The Sandbox environment provides a safe, isolated testing space where you can develop and refine queries before running them in production. This workflow walks you through accessing the Query interface in Sandbox mode, composing your search criteria, and executing the query to retrieve matching results. Memory queries are essential for building AI applications that need to intelligently retrieve contextual information, enabling features like semantic search, retrieval-augmented generation (RAG), and document discovery.

Before you begin

  • Active Hyperspell account with access to app.hyperspell.com
  • Data or documents previously uploaded to your Hyperspell memory store
  • Access to the Sandbox environment (typically available to all account tiers)
  • Basic understanding of query syntax or natural language search patterns

Step by step

1
ClickSandbox

Select the Sandbox environment from the available options to ensure your query executes in a safe, isolated testing context rather than production. This protects your live data while you develop and validate your query logic.

Tip. The Sandbox environment is ideal for experimentation. Always test queries here before running them against production memory.
Step 1
2
ClickQuery

Click the Query tab to navigate to the query composition interface. This tab provides the workspace where you can write, configure, and execute memory queries.

Step 2
3
Clickgeneric

Click the generic query type selector to specify that you will use a custom, flexible query format. This allows you to write your own query without being restricted to predefined templates.

Tip. The generic query type is the most flexible option and supports natural language, keyword searches, and structured query syntax.
Step 3
4
TypeQuery

Enter your custom query text in the Query textbox. Compose your search criteria using keywords, natural language, or structured syntax to specify which documents or data you want to retrieve from memory.

Tip. Use specific, descriptive keywords for better results. Natural language queries like 'Find all customer complaints about billing' typically work well in Hyperspell's memory system.
5
ClickQuery

Click the Query button to submit your query for execution. The system will process your request and return matching documents from your memory store.

Step 5

Confirm it worked

  1. 1The Sandbox environment is displayed as the active context in the top navigation or header
  2. 2The Query tab appears selected/highlighted in the interface navigation
  3. 3Your custom query text is visible in the query textbox input field
  4. 4Query results are returned and displayed, showing matching documents or a success confirmation message

Common issues

Keep reading