{ "id": "search-workspace", "title": "Search workspace", "url": "https://redis.io/docs/latest/develop/tools/insight/search-workspace/", "summary": "Create and manage search indexes, build and save queries, and explore your data in the Redis Insight Search workspace.", "tags": [ "docs", "develop", "stack", "oss", "rs", "rc", "oss", "kubernetes", "clients" ], "last_updated": "2026-06-10T09:02:56+01:00", "page_type": "content", "content_hash": "c50b1bca275b9ba55ed816cd93e0d2f6f08c339c5e82f446d9ca0cfef02d6261", "sections": [ { "id": "overview", "title": "Overview", "role": "overview", "text": "The **Search** workspace in Redis Insight is a dedicated space for working with [Redis Search](https://redis.io/docs/latest/develop/ai/search-and-query). From a single page you can browse the search indexes in your database, create new indexes from sample or existing data, build and run queries with a schema-aware editor, and save queries to a reusable library.\n\nTo open the workspace, select **Search** in the menu at the top of the screen.\n\n![images/ri/ri-search-indexes-list.png](https://redis.io/docs/latest/images/ri/ri-search-indexes-list.png)" }, { "id": "prerequisites", "title": "Prerequisites", "role": "content", "text": "The Search workspace requires Redis Search. When you open the workspace, Redis Insight checks the connected database and shows a message instead of the workspace if it is not available:\n\n- **Redis Search is not available for this database** — the connected database does not include Redis Search. The engine is available in Redis Open Source, Redis Software, and Redis Cloud.\n- **Redis Search 2.0+ required** — the Search workspace requires Redis Search 2.0 or later (included with Redis 6 and later). Older query engine versions are not compatible with the commands used here." }, { "id": "get-started", "title": "Get started", "role": "content", "text": "The first time you open the Search workspace for a database that has no search indexes, Redis Insight shows a welcome screen that introduces full-text, vector, and hybrid search. From here you can get started in one of two ways:\n\n- **Try with sample data** — load a ready-made dataset and its index so you can explore search straight away. See [Create an index from sample data](#from-sample-data).\n- **Use data from my database** — build an index over keys that already exist in your database. See [Create an index from existing data](#from-existing-data).\n\n![images/ri/ri-search-welcome.png](https://redis.io/docs/latest/images/ri/ri-search-welcome.png)\n\nIf your database contains at least one search index, the Search workspace opens to the index list instead." }, { "id": "search-indexes-list", "title": "Search indexes list", "role": "content", "text": "The Search workspace lists the [search indexes](https://redis.io/docs/latest/develop/ai/search-and-query/indexing) defined in the connected database.\n\nThe list shows the following information for each index. Several columns include an info button that explains the column when selected.\n\n| Column | Description |\n|--------|-------------|\n| **Index name** | The name of the index. |\n| **Index prefix** | The key prefix that the index matches. Keys whose names start with this prefix are automatically indexed. |\n| **Index types** | The field types used in the index schema (for example, TEXT, TAG, NUMERIC, and VECTOR). |\n| **Docs** | The number of documents currently indexed. |\n| **Records** | The total number of indexed field-value pairs across all documents. (A document with five fields counts as five records.) |\n| **Terms** | The number of unique words extracted from `TEXT` fields for full-text search. |\n| **Fields** | The total number of fields defined in the index schema. |\n\nThe last column (unlabeled) holds the row actions:\n\n- A **query** button that opens the index in the [query editor](#query-an-index).\n- An ellipsis (**...**) menu with:\n - **View index** — open the query page for the index with its details side panel showing.\n - **Browse dataset** — switch to the Browse workspace to review the keys that the index covers.\n - **Delete** — drop the index." }, { "id": "create-an-index", "title": "Create an index", "role": "content", "text": "Select **+ Create search index** to create a new index. You can create an index from sample data or from data that already exists in your database.\n\n![images/ri/ri-search-create-menu.png](https://redis.io/docs/latest/images/ri/ri-search-create-menu.png)" }, { "id": "from-sample-data", "title": "From sample data", "role": "content", "text": "Choose **Use sample data** to load a ready-made dataset and the index that goes with it. This is the quickest way to explore how Redis Search works without preparing your own data.\n\nSelect one of the bundled datasets:\n\n- **E-commerce Discovery** — product data for exploring discovery use cases that match intent rather than just text.\n- **Content recommendations** — content data for discovering items by theme or plot.\n\n![images/ri/ri-search-sample-data.png](https://redis.io/docs/latest/images/ri/ri-search-sample-data.png)\n\nFrom here you can:\n\n- Select **See index definition** to review the schema that will be created before you commit to it.\n- Select **Start querying** to load the data, create the index, and open the query editor right away." }, { "id": "from-existing-data", "title": "From existing data", "role": "content", "text": "Choose **Use existing data** to build an index over keys that already exist in your database. Indexing is available for hash and JSON data structures.\n\nRedis Insight opens the create-index page with a key browser on the left. Select a key to get started: Redis Insight uses it to generate a suggested indexing schema. The index then covers **all keys that share the same prefix**, not just the key you selected.\n\nAfter you select a key, Redis Insight inspects it and automatically detects its fields, presenting the suggested schema on the right. You can edit the index name (shown as **Define search index: ``**) using the **pencil** icon next to it, and edit the **Index prefix** to control which keys the index matches.\n\nThe schema is shown in a table with the following columns:\n\n- A **selection** checkbox — select or clear a field to include or exclude it from the index.\n- **Field name** — the detected field.\n- **Field sample value** — an example value taken from the key.\n- **Suggested indexing type** — the field type Redis Insight recommends.\n- A **pencil** icon — edit the field's type and options.\n\n![images/ri/ri-search-create-existing.png](https://redis.io/docs/latest/images/ri/ri-search-create-existing.png)\n\n\nThe first time you create an index from existing data, Redis Insight shows a short guided tour of the page. Select **Skip tour** to dismiss it, or **Next** to step through it.\n\n \n\nNested JSON objects and arrays cannot be indexed directly. If Redis Insight detects one, it removes the field and shows a warning that explains why.\n\n\n#### Configure field types\n\nTo add a field, select **+ Add field**; to change a detected field, select its **pencil** icon. In the field dialog, choose the index type and configure its options:\n\n- **Text** — full-text searchable fields, with options for weight and phonetic matching (English, French, Portuguese, or Spanish).\n- **Tag** — exact-match fields for filtering and faceting.\n- **Numeric** — numeric fields for range filtering.\n- **Geo** — geospatial fields for location filtering.\n- **Vector** — vector fields for similarity search, with options for the indexing algorithm (`FLAT` or `HNSW`), vector type (`FLOAT32`, `FLOAT64`, `FLOAT16`, or `BFLOAT16`), distance metric (`L2`, `IP`, or `COSINE`), the number of dimensions, and (for `HNSW`) algorithm-specific tuning parameters.\n\n![images/ri/ri-search-field-type.png](https://redis.io/docs/latest/images/ri/ri-search-field-type.png)\n\n#### Table view and command view\n\nThe create-index page provides two views of your index definition:\n\n- **Table view** — the visual schema editor described above.\n- **Command view** — the equivalent [`FT.CREATE`](https://redis.io/docs/latest/commands/ft.create) command that Redis Insight will run.\n\n![images/ri/ri-search-command-view.png](https://redis.io/docs/latest/images/ri/ri-search-command-view.png)\n\nWhen you are satisfied with the schema, select **Create index**. Redis Insight confirms when the index is created and your data becomes searchable." }, { "id": "query-an-index", "title": "Query an index", "role": "content", "text": "When you open an index, Redis Insight shows the query page. At the top of the page, an index selector (shown as **Indexes / ``**) lets you switch between the indexes in your database, and a **View index** button opens a side panel with the full index definition and statistics.\n\n![images/ri/ri-search-index-info.png](https://redis.io/docs/latest/images/ri/ri-search-index-info.png)\n\nThe rest of the page is split into two resizable panes: the query editor on top and the results below. The editor has two tabs, **Query editor** and **Query library**.\n\n![images/ri/ri-search-run-query.png](https://redis.io/docs/latest/images/ri/ri-search-run-query.png)" }, { "id": "query-editor", "title": "Query editor", "role": "content", "text": "The **Query editor** tab lets you write and run [Redis Query Engine commands](https://redis.io/docs/latest/develop/ai/search-and-query/query) (such as `FT.SEARCH` and `FT.AGGREGATE`) against the selected index, with syntax highlighting and schema-aware autocomplete. Start typing `FT.` to see available search commands, index names, and fields based on your current query.\n\nThe action bar at the bottom of the editor pane provides the following actions:\n\n- **Explain** — show the execution plan for the query (using [`FT.EXPLAIN`](https://redis.io/docs/latest/commands/ft.explain)) so you can understand how it will run. Available for `FT.SEARCH` and `FT.AGGREGATE` queries.\n- **Profile** — profile the query (using [`FT.PROFILE`](https://redis.io/docs/latest/commands/ft.profile)) to see where time is spent and identify bottlenecks. Available for `FT.SEARCH` and `FT.AGGREGATE` queries.\n- **Save** — save the current query to the Query library for reuse.\n- **Run** — run the query and view the results in the lower pane.\n\nFor example, the following query returns the first 10 documents priced under 2000:\n\n[code example]\n\nSelect **Explain** to see how the query runs:\n\n![images/ri/ri-search-explain-query.png](https://redis.io/docs/latest/images/ri/ri-search-explain-query.png)\n\nSelect **Profile** to see where time is spent:\n\n![images/ri/ri-search-profile-query.png](https://redis.io/docs/latest/images/ri/ri-search-profile-query.png)" }, { "id": "results", "title": "Results", "role": "returns", "text": "Each command you run appears in the results pane below the editor. You can switch between a **Text** and a **Table** view of the results, and re-run, profile, or explain a command directly from its result using the actions on the right.\n\n![images/ri/ri-search-results-view-button.png](https://redis.io/docs/latest/images/ri/ri-search-results-view-button.png)\n\n![images/ri/ri-search-results-actions-button.png](https://redis.io/docs/latest/images/ri/ri-search-results-actions-button.png)" }, { "id": "query-library", "title": "Query library", "role": "content", "text": "The **Query library** tab keeps saved and sample queries together so you can reuse them quickly. Use the search field at the top to filter the list. From the library you can load a query into the editor, run it directly, or delete it.\n\nTo save your own query, write it in the **Query editor** tab, select **Save**, and give it a name. It then appears in the library alongside the built-in sample queries.\n\n![images/ri/ri-search-query-library.png](https://redis.io/docs/latest/images/ri/ri-search-query-library.png)" }, { "id": "navigate-between-the-browse-and-search-workspaces", "title": "Navigate between the Browse and Search workspaces", "role": "content", "text": "The [Browse](https://redis.io/docs/latest/develop/tools/insight#browser) and Search workspaces are connected so you can move between your raw data and your indexes." }, { "id": "make-data-searchable-from-the-browse-workspace", "title": "Make data searchable from the Browse workspace", "role": "content", "text": "When you view a hash or JSON key in the Browse workspace that is not yet indexed, select **Make searchable** to create an index for it. A **Make this data searchable** dialog explains that all keys sharing the key's prefix will be included. Select **Continue** to go to the Search workspace, where you can review and adjust the schema before creating the index, as described in [Create an index from existing data](#from-existing-data).\n\n![images/ri/ri-search-make-searchable.png](https://redis.io/docs/latest/images/ri/ri-search-make-searchable.png)" }, { "id": "view-the-index-for-a-key", "title": "View the index for a key", "role": "content", "text": "When you view a key that is already indexed, select **View index** to jump to that index in the Search workspace. If the key belongs to more than one index, choose the index you want from the menu.\n\n![images/ri/ri-search-view-index.png](https://redis.io/docs/latest/images/ri/ri-search-view-index.png)" } ], "examples": [ { "id": "query-editor-ex0", "language": "plaintext", "code": "FT.SEARCH idx:bikes_vss \"@price:[0 2000]\" LIMIT 0 10", "section_id": "query-editor" } ] }