# es-vector-search

Part of **ES**

<!-- intent-backlink:auto -->

> 💡 **Path Selection**: This skill is one implementation path for [Ingest and manage document data in Elasticsearch](../../intent/es-ingest-documents/SKILL.md). If you're unsure which path to take, check the routing skill first.

# Elasticsearch Vector Search Console Guide

## Operations Overview

| Operation | Console Entry | Prerequisites | Description |
|----------|---------------|---------------|-------------|
| Perform Vector Query | Console > OpenSearch > Vector Search Edition > Query Test | An OpenSearch Vector Search Edition instance must be created and running; Access to the OpenSearch console with appropriate permissions | Execute primary key-based, vector-based, or hybrid similarity searches using a codeless UI with support for text/image uploads and developer mode |
| Insert Data | Console > OpenSearch > Vector Search > Data Management | An OpenSearch Vector Search instance must be created and running; User must have permissions to access the Data Management page | Add or delete vector data via table input or raw JSON in Developer Mode, with real-time metrics and query verification |

## Operation Steps

### Perform Vector Query

**Navigation**: Console > OpenSearch > Vector Search Edition > Query Test

**Prerequisites**:
- An OpenSearch Vector Search Edition instance must be created and running
- Access to the OpenSearch console with appropriate permissions

1. Navigate to the **Query Test** page  
   - Element: **Query Test** (link) — left navigation panel  
   - Notes: Ensure you are in the correct OpenSearch Vector Search Edition instance

2. Select the query type from the dropdown  
   - Element: **Query Type** (dropdown) — main content area  
   - Notes: Options include "Primary Key", "Vector", and "Hybrid"

3. Upload text or image data for vectorization (if using vector or hybrid query)  
   - Element: **Upload File** (button) — top-right corner  
   - Notes: Supports text files and image files for automatic vector embedding

4. Enter query parameters in the form fields  
   - Element: **Query Parameters** (text_input) — main content area  
   - Notes: Configure search criteria such as similarity thresholds and result limits

5. Toggle Developer Mode for advanced query editing (optional)  
   - Element: **Developer Mode** (toggle) — top-right corner  
   - Notes: Enables direct input of raw JSON query syntax; queries are billed the same as standard mode

| Parameter | Type | Required | Options/Values | Description |
|-----------|------|----------|----------------|-------------|
| Query Type | dropdown | Yes | Primary Key, Vector, Hybrid | Specifies the type of query to execute |
| Vector Threshold | number_input | No | — | Sets the similarity threshold for vector-based matching (default: 0.7) |
| Max Results | number_input | No | — | Limits the number of returned results (default: 10) |

### Insert Data

**Navigation**: Console > OpenSearch > Vector Search > Data Management

**Prerequisites**:
- An OpenSearch Vector Search instance must be created and running
- User must have permissions to access the Data Management page

1. Navigate to the **Data Management** page  
   - Element: **Data Management** (link) — left navigation panel  
   - Notes: Available only for active Vector Search instances

2. Click the **Insert Data** button to begin data insertion  
   - Element: **Insert Data** (button) — top-right corner  
   - Notes: Button is available in both Table Mode and Developer Mode

3. Enter data using table fields or switch to Developer Mode for raw JSON  
   - Element: **Table Fields / Developer Mode Toggle** (tab) — main content area  
   - Notes: In Developer Mode, paste valid JSON documents (single or array) for bulk insertion

4. Submit the data to the index  
   - Element: **Submit** (button) — bottom of the form  
   - Notes: After submission, real-time document count updates on the Table Metrics page

5. Verify inserted data by navigating to Query Test  
   - Element: **Query Test** (link) — main content area  
   - Notes: Run sample queries to confirm successful indexing and searchability

| Parameter | Type | Required | Options/Values | Description |
|-----------|------|----------|----------------|-------------|
| Index Name | dropdown | Yes | default_index, test_index_01, prod_index_v1 | Select the target index where data will be inserted |
| Document ID | text_input | No | — | Optional unique ID; if omitted, a UUID is auto-generated |
| Data Content | text_input | Yes | — | JSON-formatted data to insert (supports single or multiple documents) |

## FAQ

Q: Where can I test vector queries after inserting data?  
A: Use the **Query Test** page under OpenSearch > Vector Search Edition to run sample queries and verify that your data is indexed and searchable.

Q: What happens if I leave the Document ID field empty during data insertion?  
A: The system automatically generates a UUID for the document, ensuring uniqueness without manual input.

Q: Can I modify data after it has been inserted via the console?  
A: The console does not support direct document updates. You must delete the existing document and re-insert the updated version.

Q: Do queries in Developer Mode cost more than standard UI queries?  
A: No. All queries—whether executed via the codeless UI or Developer Mode—are billed at the same per-request rate.

Q: What permissions are required to access the Data Management and Query Test pages?  
A: Users need console access permissions for the OpenSearch service and specific read/write permissions on the target Vector Search instance.

## Pricing & Billing

### Billing Model
Per-request pricing applies to both query and data insertion operations.

### Price Reference
| Tier | Input Price | Output Price |
|------|-------------|--------------|
| standard | 0.0001 / | 0.0002 / |

### Free Tier
 1000 
 1000 

### Billing Notes
- Queries in developer mode are billed at the same rate as standard queries
- Async tasks are not supported in this console interface
- Data deletion operations are not billed
- Bulk insertions exceeding 1000 documents are charged per actual document count
- Quota limits: single query returns up to 10,000 results; data insertion allows max 1,000 documents per request and 10 requests per minute