Try our Chrome extension
Easily add the current web-page from your browser directly into your changedetection.io tool, more great features coming soon!
Chrome Webstore
Changedetection.io needs your support!
You can help us by supporting changedetection.io on these platforms;
- Rate us at AlternativeTo.net
- Star us on GitHub
- Follow us at Twitter/X
- G2 Software reviews
- Check us out on LinkedIn
- And tell your friends and colleagues :)
The more popular changedetection.io is, the more time we can dedicate to adding amazing features!
Many thanks :)
changedetection.io team
Not yet seconds ago
False
Not yet seconds ago
3 hours ago
Pro-tip: Highlight text to add to ignore filters
OpenSearch
Menu
* About
+ Releases
+ Roadmap
+ FAQ
* Platform
+ Search
+ Observability
+ Security Analytics
+ Vector Database
+ Playground Demo
+ Performance Benchmarks
* Community
+ Forum
+ Slack
+ Events
+ Solutions Providers
+ Projects
+ Members
* Documentation
+ OpenSearch and Dashboards
+ Data Prepper
+ Clients
+ Benchmark
+ Migration Assistant
* Blog
* Download
*
Documentation
OpenSearch and OpenSearch Dashboards ← Back to docs home
* About OpenSearch
+ Version history
+ Breaking changes
* Getting started
+ Intro to OpenSearch
+ Installation quickstart
+ Communicate with OpenSearch
+ Ingest data
+ Search your data
+ Concepts
* Tutorials
+ Vector search
o Getting started with semantic and hybrid search
o Vector operations
- Generating embeddings
- Semantic search using byte vectors
- Optimizing vector search using Cohere compressed embeddings
o Semantic search
- Semantic search using OpenAI
- Semantic search using Cohere Embed
- Semantic search using Cohere Embed on Amazon Bedrock
- Semantic search using Amazon Bedrock Titan
- Semantic search using Amazon Bedrock Titan in another account
- Semantic search in Amazon SageMaker
- Semantic search using AWS CloudFormation and Amazon SageMaker
- Semantic search using AWS CloudFormation and Amazon Bedrock
- Semantic search using an asymmetric embedding model
- Semantic search using text chunking
o Using semantic highlighting
+ Reranking search results
o Reranking using Cohere Rerank
o Reranking search results using Cohere Rerank on Amazon Bedrock
o Reranking search results using Amazon Bedrock models
o Reranking search results using a cross-encoder in Amazon SageMaker
o Reranking search results using a reranker in Amazon SageMaker
o Reranking search results by a field
+ Generative AI
o RAG
- RAG using the DeepSeek Chat API
- RAG using DeepSeek-R1 on Amazon Bedrock
- RAG using DeepSeek-R1 in Amazon SageMaker
- Conversational search using Cohere Command
- Conversational search using Anthropic Claude on Amazon Bedrock
- Conversational search using OpenAI
o Agentic AI
- Building a plan-execute-reflect agent
o Chatbots
- RAG chatbot
- RAG chatbot with a conversational flow agent
- Build your own chatbot
o AI search workflows
o Model guardrails
- Amazon Bedrock model guardrails
+ Faceted search
* Install and configure
+ Installing OpenSearch
o Docker
o Helm
o Tarball
o RPM
o Debian
o OpenSearch Kubernetes Operator
o Ansible playbook
o Windows
+ Installing OpenSearch Dashboards
o Docker
o Tarball
o RPM
o Debian
o Helm
o Windows
o Configure TLS
+ Configuring OpenSearch
o Configuration and system settings
o Network settings
o Discovery and gateway settings
o Security settings
o Cluster settings
o Index settings
o Search settings
o Availability and recovery settings
o Thread pool settings
o Circuit breaker settings
o Plugin settings
o Experimental feature flags
o Logs
+ Compatible operating systems
+ Configuring OpenSearch Dashboards
+ Installing plugins
o Additional plugins
o Ingest-attachment plugin
o Mapper-size plugin
+ Managing OpenSearch Dashboards plugins
* Migrate or upgrade
+ Snapshot and restore
+ Rolling upgrade
+ Migration Assistant
* Creating and tuning your cluster
+ Cluster manager task throttling
+ Cross-cluster replication
o Getting started
o Auto-follow
o Replication security
o Replication settings
o API
+ Availability and recovery
o Snapshots
- Take and restore snapshots
- Snapshot management
- Snapshot management API
- Searchable snapshots
o Remote-backed storage
- Migrating to remote-backed storage
- Remote cluster state
- Remote segment backpressure
- Shallow snapshots
- Remote Store Stats API
o Search backpressure
o Shard indexing backpressure
- Stats API
- Settings
o Segment replication
- Segment replication backpressure
o Rule-based auto-tagging
- Rules API
o Workload management
- Workload groups
- Workload group rules
- Managing workloads in OpenSearch Dashboards
+ Tuning for indexing speed
+ Separate index and search workloads
* Managing Indexes
+ Index templates
+ Index aliases
+ Data streams
+ Append-only index
+ Index context
+ Index sorting
+ Reindex data
+ Refresh search analyzer
+ Similarity
+ Index State Management
o Policies
o Managed indexes
o Settings
o ISM API
+ Index transforms
o Transforms APIs
+ Index rollups
o Index rollups API
o Settings
+ ISM Error Prevention
o ISM Error Prevention resolutions
o ISM Error Prevention API
+ Notification settings
+ Index management security
* Ingest Pipelines
+ Create or update pipeline
+ Simulate pipeline
+ Get pipeline
+ Delete pipeline
+ Access data in a pipeline
+ Handling pipeline failures
+ Conditional execution
o Complex conditionals
o Conditionals with the pipeline processor
o Regex conditionals
+ Ingest processors
o Append
o Bytes
o Convert
o Copy
o CSV
o Date
o Community ID
o Date index name
o Dissect
o Dot expander
o Drop
o Fail
o Fingerprint
o Foreach
o gsub
o IP2Geo
o Grok
o HTML strip
o Join
o JSON
o KV
o Lowercase
o ML inference
o Pipeline
o Remove
o Remove by pattern
o Rename
o Script
o Set
o Sparse encoding
o Sort
o Text chunking
o Text embedding
o Split
o Text/image embedding
o Trim
o Uppercase
o URL decode
o User agent
* OpenSearch Dashboards
+ OpenSearch Dashboards quickstart guide
+ OpenSearch Assistant for OpenSearch Dashboards
o Alert insights
o Data summary
o Anomaly detector suggestions
o Text to visualization
+ Analyzing data with Discover
+ Creating dashboards
+ Building data visualizations
o Area charts
o Coordinate and region maps
- Using maps
- Maps Stats API
- Configuring a Web Map Service (WMS)
- Using self-hosted map servers
o TSVB
o Vega
o VisBuilder
+ Index Management
o Indexes
o Data streams
o Force merge
o Rollover
o Component templates
o Notification settings
+ Snapshot Management
+ Dashboards Management
o Index patterns
o Advanced settings
o Access control lists for saved objects
+ Data sources
o Configuring and using multiple data sources
o Connecting Amazon S3 to OpenSearch
- Query and visualize Amazon S3 data
o Optimizing query performance using OpenSearch indexing
o Scheduled Query Acceleration
o Connecting Prometheus to OpenSearch
+ Dev Tools
+ Workspace for OpenSearch Dashboards
o Getting started with workspaces
o Create a workspace
o Manage workspaces
o Workspace access control lists
o Workspaces APIs
+ Dashboards Query Language (DQL)
+ Query Workbench
+ Custom branding
+ Integrations in OpenSearch Dashboards
+ Configuring CSP rules for frame ancestors
+ Search telemetry
* Security
+ Getting started with OpenSearch security
+ Configuration
o Best practices
o Setting up a demo configuration
o System indexes
o Configuring the Security backend
o Modifying the YAML files
o Configuring TLS certificates
o Generating self-signed certificates
o Applying changes to configuration files
o Security configuration versioning
o API rate limiting
o Configuring sign-in options
o Disabling and enabling the Security plugin
o OpenSearch keystore
+ Authentication backends
o HTTP basic authentication
o JSON Web Token
o OpenID Connect
o SAML
o Active Directory and LDAP
o Proxy-based authentication
o Client certificate authentication
o Kerberos
+ Access control
o REST layer authorization
o Document-level security
o Defining users and roles
o Field-level security
o Field masking
o User impersonation
o Permissions
o Default action groups
o API
o Authorization tokens
o Anonymous authentication
+ Audit logs
o Audit log field reference
o Audit log storage types
+ OpenSearch Dashboards multi-tenancy
o Multi-tenancy configuration
o Dynamic configuration in OpenSearch Dashboards
o Multi-tenancy aggregate view for saved objects
* Security analytics
+ OpenSearch Security for Security Analytics
+ Setting up Security Analytics
o Working with log types
o Creating detectors
o Creating correlation rules
+ Supported log types
o AD LDAP
o Amazon S3
o Apache Access
o AWS CloudTrail
o Azure
o DNS
o GitHub
o Google Workspace
o Linux
o Microsoft 365
o NetFlow
o Network
o Okta
o VPC Flow
o WAF
o Windows
o Other log type mappings
+ Using Security Analytics
o The Overview page
o Working with detectors
o Working with findings
o Working with detection rules
o Working with the correlation graph
o Working with alerts
+ API tools
o Detector APIs
o Rule APIs
o Mappings APIs
o Alerts and findings APIs
o Correlation engine APIs
o Log type APIs
+ Threat intelligence
o Getting started
o Threat intelligence APIs
- Monitor API
- Alerts and Findings API
- Source API
+ Security Analytics settings
* Mappings
+ Supported field types
o Alias
o Boolean
o Binary
o String field types
- Text
- Keyword
- Match-only text
- Wildcard
- Token count
- Constant keyword
o Numeric field types
- Unsigned long
o Date field types
- Date
- Date nanoseconds
o IP address
o Geographic field types
- Geopoint
- Geoshape
o Cartesian field types
- xy point
- xy shape
o Range field types
o Object field types
- Object
- Nested
- Flat object
- Join
o Version
o Autocomplete field types
- Completion
- Search as you type
o k-NN vector
- Spaces
- Methods and engines
- Memory-optimized vectors
o Sparse vector
o Specialized search field types
- Semantic
- Rank field types
- Percolator
- Star-tree
- Derived
+ Metadata fields
o Field names
o ID
o Ignored
o Index
o Meta
o Routing
o Source
+ Mapping parameters
o Analyzer
o Boost
o Coerce
o Copy to
o Doc values
o Dynamic
o Eager global ordinals
o Enabled
o Fields
o Format
o Ignore above
o Ignore malformed
o Index options
o Index
o Index phrases
o Index prefixes
o Meta
o Normalizer
o Norms
o Null value
o Position increment gap
o Properties
o Search analyzer
o Similarity
o Store
o Term vector
+ Mapping explosion
* Text analysis
+ Analyzers
o Index analyzers
o Search analyzers
o Creating a custom analyzer
o Standard analyzer
o Fingerprint analyzer
o Keyword analyzer
o Pattern analyzer
o Simple analyzer
o Stop analyzer
o Whitespace analyzer
o DL model analyzers
o Language analyzers
- Arabic
- Armenian
- Basque
- Bengali
- Brazilian
- Bulgarian
- Catalan
- CJK
- Czech
- Danish
- Dutch
- English
- Estonian
- Finnish
- French
- Galician
- German
- Greek
- Hindi
- Hungarian
- Indonesian
- Irish
- Italian
- Latvian
- Lithuanian
- Norwegian
- Persian
- Polish
- Portuguese
- Romanian
- Russian
- Sorani
- Spanish
- Swedish
- Thai
- Turkish
- Ukrainian
o Phone number analyzers
+ Tokenizers
o Character group
o Classic
o Edge n-gram
o Keyword
o Letter
o Lowercase
o N-gram
o Path hierarchy
o Pattern
o Simple pattern
o Simple pattern split
o Standard
o Thai
o UAX URL email
o Whitespace
+ Token filters
o Apostrophe
o ASCII folding
o CJK bigram
o CJK width
o Classic
o Common grams
o Condition
o Decimal digit
o Delimited payload
o Delimited term frequency
o Dictionary decompounder
o Edge n-gram
o Elision
o Fingerprint
o Flatten graph
o Hunspell
o Hyphenation decompounder
o Keep types
o Keep words
o Keyword marker
o Keyword repeat
o KStem
o Kuromoji completion
o Length
o Limit
o Lowercase
o Min hash
o Multiplexer
o N-gram
o Normalization
o Pattern capture
o Pattern replace
o Phonetic
o Porter stem
o Predicate token filter
o Remove duplicates
o Reverse
o Shingle
o Snowball
o Stemmer
o Stemmer override
o Stop
o Synonym
o Synonym graph
o Trim
o Truncate
o Unique
o Uppercase
o Word delimiter
o Word delimiter graph
+ Character filters
o HTML strip
o Mapping
o Pattern replace
+ Normalizers
+ Stemming
+ Token graphs
* Query DSL
+ Query and filter context
+ Term-level and full-text queries compared
+ Term-level queries
o Term
o Terms
o Terms set
o IDs
o Range
o Prefix
o Exists
o Fuzzy
o Wildcard
o Regexp
+ Full-text queries
o Match
o Match Boolean prefix
o Match phrase
o Match phrase prefix
o Multi-match
o Query string
o Simple query string
o Intervals
+ Compound queries
o Boolean
o Boosting
o Constant score
o Disjunction max
o Function score
o Hybrid
+ Geographic and xy queries
o Geo-bounding box
o Geodistance
o Geopolygon
o Geoshape
o xy
+ Joining queries
o Has child
o Has parent
o Nested
o Parent ID
+ Span queries
o Span containing
o Span field masking
o Span first
o Span multi-term
o Span near
o Span not
o Span or
o Span term
o Span within
+ Match all queries
+ Specialized queries
o Agentic
o Distance feature
o k-NN
- k-NN query explain
o More like this
o Neural
o Neural sparse
o Percolate
o Script query
o Script score
o Template
o Rank feature
o Wrapper
+ Minimum should match
+ Rewrite
+ Rescore
+ Regular expression syntax
* Aggregations
+ Metric aggregations
o Average
o Cardinality
o Extended stats
o Geobounds
o Geocentroid
o Matrix stats
o Maximum
o Median absolute deviation
o Minimum
o Percentile ranks
o Percentile
o Scripted metric
o Stats
o Sum
o Top hits
o Value count
o Weighted average
+ Bucket aggregations
o Adjacency matrix
o Auto-interval date histogram
o Children
o Composite
o Date histogram
o Date range
o Diversified sampler
o Filter
o Filters
o Geodistance
o Geohash grid
o Geohex grid
o Geotile grid
o Global
o Histogram
o IP range
o Missing
o Multi-terms
o Nested
o Parent
o Range
o Rare terms
o Reverse nested
o Sampler
o Significant terms
o Significant text
o Terms
+ Pipeline aggregations
o Average bucket
o Bucket script
o Bucket selector
o Bucket sort
o Cumulative sum
o Derivative
o Extended stats bucket
o Maximum bucket
o Minimum bucket
o Moving average
o Moving function
o Percentiles bucket
o Serial differencing
o Stats bucket
o Sum bucket
* Search features
+ Search options
o Paginate results
o Point in Time
o Sort results
o Filter results
o Collapse search results
o Highlight query matches
o Autocomplete
o Did-you-mean
o Retrieve inner hits
o Retrieve specific fields
o Search shard routing
+ Keyword search
+ Learning to Rank
o ML ranking core concepts
o Scope of the plugin
o Working with features
o Feature engineering
o Logging feature scores
o Uploading trained models
o Optimizing search with LTR
o Advanced functionality
o Common issues
+ Cross-cluster search
+ Search relevance
o Search Relevance Workbench
- Query sets
- Search configurations
- Judgments
- Comparing single queries
- Comparing search results
- Comparing query sets
- Evaluating search quality
- Optimizing hybrid search
- Exploring search evaluation results
o Reranking search results
- Reranking using a cross-encoder model
- Reranking by a field
- Reranking by a field using a cross-encoder
- Reranking by a field using a late interaction model
o Query rewriting
- Template queries
- Querqy
+ User Behavior Insights
o UBI index schemas
o UBI JavaScript Collector
o Example UBI query DSL queries
o Sample UBI SQL queries
o UBI dashboard tutorial
o Using UBI in Amazon OpenSearch Service
+ Search pipelines
o Creating a search pipeline
o Using a search pipeline
o Debugging a search pipeline
o Retrieving search pipelines
o Deleting search pipelines
o User-defined search processors
- Collapse
- Hybrid score explanation
- Filter query
- ML inference (request)
- ML inference (response)
- Neural query enricher
- Neural sparse query two-phase
- Normalization
- Oversample
- Personalize search ranking
- Rename field
- Rerank
- Retrieval-augmented generation
- Score ranker
- Script
- Sort
- Split
- Truncate hits
o System-generated search processors
o Search pipeline metrics
+ Improving search performance
o Asynchronous search
- Asynchronous search security
- Settings
o Concurrent segment search
o Star-tree index
o Caching
- Index request cache
- Tiered cache
- Field data cache
+ SQL and PPL
o SQL and PPL API
o Response formats
o SQL and PPL CLI
o SQL
- Basic Queries
- Complex Queries
- Functions
- JSON Support
- Metadata Queries
- Aggregate Functions
- Delete
- JDBC Driver
- ODBC Driver
o PPL
- Syntax
- Commands
- Subsearch
o Identifiers
o Data types
o Functions
o Full-Text Search
o Settings
o Troubleshooting
o Monitoring
o Limitations
* Vector search
+ Getting started
o Vector search basics
o Preparing vectors
o Generating embeddings automatically
o Concepts
+ Vector search techniques
o Approximate k-NN search
o Exact k-NN search with a scoring script
- Painless extensions
+ Creating a vector index
+ Ingesting data
o Text chunking
+ Searching data
+ AI search
o Semantic search
o Hybrid search
- Using sorting with a hybrid query
- Paginating hybrid query results
- Hybrid search with search_after
- Collapsing hybrid query results
- Hybrid search with post-filtering
- Combining hybrid search and aggregations
- Using inner hits in hybrid queries
- Hybrid search explain
o Multimodal search
o Neural sparse search
- Generating sparse vector embeddings automatically
- Using custom configurations for neural sparse search
- Neural sparse search using raw vectors
- Neural sparse ANN search
o Conversational search with RAG
o Agentic search
- Configuring agents
- Using flow agents
- Using conversational agents
- Configuring agents for semantic search
- Adding search templates
- Using external MCP servers
o Building AI search workflows in OpenSearch Dashboards
- Configuring AI search types
- Configuring agentic search
+ Filtering data
o Efficient k-NN filtering
o Post-filtering
o Scoring script filter
o Filtering in neural sparse ANN search
+ Specialized vector search
o Nested field search
o Radial search
o Vector search with MMR reranking
+ Optimizing vector storage
o Vector quantization
- Lucene scalar quantization
- Faiss 16-bit scalar quantization
- Faiss product quantization
- Binary quantization
o Disk-based vector search
o Memory-optimized search
+ Performance tuning
o Indexing performance tuning
o Search performance tuning
+ Remote index build
+ LLM framework integration
+ Vector search API
o k-NN API
o Neural Search API
+ Settings
* Machine learning
+ Integrating ML models
o Model access control
o Using ML models within OpenSearch
- Custom models
- Pretrained models
- GPU acceleration
o Connecting to externally hosted models
- Connectors
- Supported connectors
- Connector blueprints
- Guardrails
- Batch ingestion
- Asynchronous batch ingestion
o Managing ML models in OpenSearch Dashboards
+ Agents and tools
o Agents and tools tutorial
o Agents
- Flow agents
- Conversational flow agents
- Conversational agents
- Plan-execute-reflect agents
o Tools
- Agent tool
- Connector tool
- Create Anomaly Detector tool
- Data Distribution tool
- Index Mapping tool
- List Index tool
- Log Pattern tool
- Log Pattern Analysis tool
- ML Model tool
- Neural Sparse Search tool
- Query Planning tool
- PPL tool
- Scratchpad tools
- RAG tool
- Search Alerts tool
- Search Anomaly Detectors tool
- Search Anomaly Results tool
- Search Index tool
- Search Monitors tool
- Vector DB tool
- Visualization tool
- Web Search tool
o Using MCP tools
- Connecting to an external MCP server
+ Processor chains
+ Agentic memory
+ OpenSearch Assistant Toolkit
+ Supported algorithms
+ ML Commons APIs
o Model APIs
- Register model
- Deploy model
- Get model
- Search model
- Update model
- Undeploy model
- Delete model
- Train
- Predict
- Predict stream
- Batch predict
- Train and predict
o Model group APIs
- Register model group
- Update model group
- Get model group
- Search model group
- Delete model group
o Connector APIs
- Create connector
- Get connector
- Search connector
- Update connector
- Delete connector
o Agent APIs
- Register agent
- Update agent
- Execute agent
- Execute stream agent
- Get agent
- Search agent
- Delete agent
o Agentic memory APIs
- Create memory container
- Update memory container
- Get memory container
- Search memory containers
- Delete memory container
- Create session
- Add agentic memory
- Get memory
- Update memory
- Delete memory
- Search memory
o MCP server APIs
- Register MCP tools
- Update MCP tools
- List MCP tools
- Remove MCP tools
- MCP Streamable HTTP Server
o Memory APIs
- Create or update memory
- Get memory
- Search memory
- Delete memory
- Create or update message
- Get message
- Search message
- Get message traces
o Controller APIs
- Create controller
- Get controller
- Delete controller
o Tasks APIs
- Get task
- Search task
- Delete task
o Asynchronous batch ingestion
o Execute algorithm
o Execute tool
o Profile
o Stats
+ ML Commons cluster settings
* Automating configurations
+ Workflow steps
+ Workflow tutorial
+ Workflow templates
+ Workflow settings
+ Workflow APIs
o Create or update a workflow
o Get a workflow
o Provision a workflow
o Get a workflow status
o Get workflow steps
o Search for a workflow
o Search for a workflow state
o Deprovision a workflow
o Delete a workflow
+ Workflow template security
* Monitoring your cluster
+ Job Scheduler
o Jobs API
o Locks API
+ Metrics framework
+ Performance Analyzer
o API
o Create PerfTop Dashboards
o Metrics Reference
o Root Cause Analysis
- API
- RCA Reference
- Hot shard identification
* Observability
+ Observability security
+ Application analytics
+ Event analytics
+ Log ingestion
+ Metric analytics
+ Query insights
o Top N queries
o Grouping top N queries
o Live queries
o Query metrics
o Query Insights plugin health
o Query insights dashboards
+ Trace Analytics
o Getting Started
o Trace Analytics plugin for OpenSearch Dashboards
o Analyzing Jaeger trace data
o Distributed tracing
+ Notebooks
+ Operational panels
+ Alerting
o Monitors
- Per query and per bucket monitors
- Per cluster metrics monitors
- Per document monitors
- Composite monitors
- Triggers
- Actions
o Management
o Alerting security
o API
o Cron
o Adding comments
o Alerting dashboards and visualizations
+ Anomaly detection
o Anomaly detection API
o Settings
o Anomaly result mapping
o Anomaly detection security
o Anomaly detection visualizations and dashboards
o Configuring anomaly alerting
+ Forecasting
o Getting started with forecasting
o Managing forecasters
o Forecasting security
o Forecasting API
+ Notifications
o API
+ Simple Schema for Observability
+ Cross-cluster search
* Reporting
+ Reporting using OpenSearch Dashboards
+ Reporting using the CLI
o Download and install the Reporting CLI tool
o Create and request visualization reports
o Schedule reports with the cron utility
o Schedule reports with AWS Lambda
o Reporting CLI options
o Use environment variables with the Reporting CLI
* Tools
+ OpenSearch CLI
+ Logstash
o Logstash execution model
o Common filter plugins
o Read from OpenSearch
o Ship events to OpenSearch
o Advanced configurations
+ Terraform
+ Grafana
+ Sycamore
* API reference
+ Analyze API
+ CAT APIs
o CAT aliases
o CAT allocation
o CAT count
o CAT field data
o CAT health
o CAT indices
o CAT cluster manager
o CAT nodeattrs
o CAT nodes
o CAT pending tasks
o CAT PIT segments
o CAT plugins
o CAT recovery
o CAT repositories
o CAT segment replication
o CAT segments
o CAT shards
o CAT snapshots
o CAT tasks
o CAT templates
o CAT thread pool
+ Cluster APIs
o Cluster allocation explain
o Cluster decommission
o Cluster health
o Cluster pending tasks
o Cluster reroute
o Cluster routing and awareness
o Cluster settings
o Cluster state
o Cluster stats
o Cluster information
o Remote cluster information
o Voting configuration exclusions
+ Document APIs
o Index document
o Get document
o Update document
o Delete document
o Bulk
o Streaming bulk
o Multi-get documents
o Update by query
o Delete by query
o Reindex documents
o Term vectors
o Multi term vectors
o Pull-based ingestion
- Pull-based ingestion management
+ gRPC APIs
o Bulk (gRPC)
o Search (gRPC)
o k-NN (gRPC)
+ Index APIs
o Core index APIs
- Create index
- Delete index
- Get index
- Index exists
- Open index
- Close index
- Resolve index
o Index operations
- Clear cache
- Clone index
- Flush
- Force merge
- Index recovery
- Refresh index
- Roll over index
- Scale
- Index segments
- Index shard stores
- Shrink index
- Split index
- Index stats
o Index settings and mappings
- Get settings
- Update settings
- Create or update mappings
o Alias APIs
- Create or update alias
- Get alias
- Delete alias
- Alias exists
- Manage aliases
o Index templates
- Create or update index template
- Delete index template
- Get index template
- Index template exists
- Simulate index templates
- Component template APIs
- Post template (deprecated)
- Put template (deprecated)
- Get template (deprecated)
- Template exists (deprecated)
- Delete template (deprecated)
o Index blocks and allocation
- Blocks
- Shard allocation
o Data stream stats
o Dangling indexes
+ Ingest APIs
+ List APIs
o List shards
o List indices
+ Nodes APIs
o Nodes info
o Nodes stats
o Nodes hot threads
o Nodes usage
o Nodes reload secure settings
+ Script APIs
o Execute inline script
o Create or update stored script
o Execute stored script
o Get stored script
o Delete stored script
o Get script languages
o Get script contexts
+ Search APIs
o Search
o Multi-search
o Point in Time
o Scroll
o Count
o Explain
o Field capabilities
o Profile
o Ranking evaluation
o Search shards
o Validate query
o Search templates
- Render template
- Multi-search template
+ Security APIs
o Authentication APIs
- Authentication Information API
- Change Password API
o Configuration APIs
- Upgrade Check API
- Upgrade Perform API
- Update Security Configuration API
- Get Configuration API
- Patch Configuration API
+ Snapshot APIs
o Register snapshot repository
o Get snapshot repository
o Delete snapshot repository
o Verify snaphot repository
o Create Snapshot
o Get snapshot
o Delete snapshot
o Get snapshot status
o Restore Snapshot
o Clone snapshot
o Cleanup snapshot repository
+ Tasks APIs
o List tasks
o Get task
o Cancel tasks
o Rethrottle
+ Supported units
+ Common REST parameters
+ Popular APIs
* Troubleshooting
+ Troubleshoot securityadmin.sh
+ Troubleshoot TLS
+ Troubleshoot SAML
+ Troubleshoot OpenID Connect
* Developer documentation
+ Plugin as a service
+ Extensions
1. About OpenSearch
2. Version history
Version history
OpenSearch version Release highlights Release date
3.3.2 Includes maintenance changes and bug fixes for the OpenSearch core engine and ML Commons, Neural Search, Skills, k-NN and Security plugins. For a full list of release highlights, see the Release Notes. 30 October 2025
3.3.1 Fixes backward compatibility handling of date fields while maintaining performance optimizations. The skip_list parameter is now automatically set to true for new @timestamp fields created since 3.3.0, while preserving skip_list=false for existing indexes with @timestamp or index sort date fields. This approach ensures date histogram aggregation performance benefits for new indexes while maintaining compatibility with existing workloads. For a full list of release highlights, see the Release Notes. 22 October 2025
3.3.0 Introduces redesigned Discover interface with log analytics and distributed tracing capabilities, and Apache Calcite as default PPL query engine with expanded functions. Makes agentic search and agentic memory APIs generally available for AI applications. Implements Seismic algorithm for neural sparse search performance improvements and processor chains for data transformation pipelines. Expands gRPC support for additional query types and adds experimental streaming with Apache Arrow Flight. Includes workload management enhancements with rule-based auto-tagging and query monitoring capabilities. For a full list of release highlights, see the Release Notes. 14 October 2025
3.2.0 Updates Search Relevance Workbench. Makes gRPC APIs generally available. Introduces derived source, updates workload management, semantic field, and star tree functionality. Adds experimental Agentic Memory APIs and Job Scheduler APIs. For a full list of release highlights, see the Release Notes. 19 August 2025
3.1.0 Makes GPU acceleration for vector index builds generally available. Introduces memory-optimized search for Faiss indexes using Lucene HNSW, semantic field type for streamlined semantic search, and Search Relevance Workbench for search quality optimization. Makes star-tree indexes generally available with support for comprehensive query types. Enhances observability with ML Commons metrics integration, custom index support for OpenTelemetry data, and new PPL commands for JSON manipulation. Improves agent management with Update Agent API and persistent MCP tools. Includes security enhancements with immutable user objects and new resource sharing framework. For a full list of release highlights, see the Release Notes. 24 June 2025
3.0.0 Upgrades to Lucene 10 for improved indexing and vector search. Adds experimental gRPC support and pull-based ingestion from Kafka and Kinesis. Introduces GPU acceleration for vector operations and semantic sentence highlighting. Improves range query performance and hybrid search with z-score normalization. Adds plan-execute-reflect agents and native MCP protocol support for agentic workflows. Enhances security with a new Java agent replacing the Security Manager. Includes PPL query improvements with lookup, join, and subsearch commands. For a full list of release highlights, see the Release Notes. 06 May 2025
2.19.3 Improves Flow Framework with enhanced memory handling and workflow step processing. Fixes several Query Insights and Query Insights Dashboards issues. Implements security updates across multiple components. Updates infrastructure components and documentation across multiple plugins. For a full list of release highlights, see the Release Notes. 22 July 2025
2.19.2 Improves query insights with better index handling, a new verbose API parameter, and a default index template. Fixes bugs across Query Insights, Observability, Flow Framework, and Dashboards. Includes multiple CVE fixes, test enhancements, and a new PGP key for artifact verification. For a full list of release highlights, see the Release Notes. 29 April 2025
2.19.1 Adds execution hint for cardinality aggregator. Includes bug fixes for ML Commons, Query Insights Dashboards, and Remote Metadata SDK. Contains maintenance updates for several components. For a full list of release highlights, see the Release Notes. 27 February 2025
2.19.0 Adds workload management, additional query insights, and template queries. Introduces a query insights page to OpenSearch Dashboards. Includes improvements and bug fixes to snapshots, search statistics, star-tree search, and index management. For a full list of release highlights, see the Release Notes. 11 February 2025
2.18.0 Adds a redesigned home page, updated Discover interface, and collaborative workspaces to OpenSearch Dashboards. Includes improvements to ML inference processor and query grouping. Introduces reranking by field and paginated CAT APIs. Includes experimental OpenSearch Dashboards Assistant capabilities. For a full list of release highlights, see the Release Notes. 05 November 2024
2.17.1 Includes bug fixes for ML Commons, anomaly detection, k-NN, and security analytics. Adds various infrastructure and maintenance updates. For a full list of release highlights, see the Release Notes. 1 October 2024
2.17.0 Includes disk-optimized vector search, binary quantization, and byte vector encoding in k-NN. Adds asynchronous batch ingestion for ML tasks. Provides search and query performance enhancements and a new custom trace source in trace analytics. Includes application-based configuration templates. For a full list of release highlights, see the Release Notes. 17 September 2024
2.16.0 Includes built-in byte vector quantization and binary vector support in k-NN. Adds new sort, split, and ML inference search processors for search pipelines. Provides application-based configuration templates and additional plugins to integrate multiple data sources in OpenSearch Dashboards. Includes an experimental Batch Predict ML Commons API. For a full list of release highlights, see the Release Notes. 06 August 2024
2.15.0 Includes parallel ingestion processing, SIMD support for exact search, and the ability to disable doc values for the k-NN field. Adds wildcard and derived field types. Improves performance for single-cardinality aggregations, rolling upgrades to remote-backed clusters, and more metrics for top N queries. For a full list of release highlights, see the Release Notes. 25 June 2024
2.14.0 Includes performance improvements to hybrid search and date histogram queries with multi-range traversal, ML model integration within the Ingest API, semantic cache for LangChain applications, low-level vector query interface for neural sparse queries, and improved k-NN search filtering. Provides an experimental tiered cache feature. For a full list of release highlights, see the Release Notes. 14 May 2024
2.13.0 Makes agents and tools and the OpenSearch Assistant Toolkit generally available. Introduces vector quantization within OpenSearch. Adds LLM guardrails and hybrid search with aggregations. Adds the Bloom filter skipping index for Apache Spark data sources, I/O-based admission control, and the ability to add an alerting cluster that manages all alerting tasks. For a full list of release highlights, see the Release Notes. 2 April 2024
2.12.0 Makes concurrent segment search and conversational search generally available. Provides an experimental OpenSearch Assistant Toolkit, including agents and tools, workflow automation, and OpenSearch Assistant for OpenSearch Dashboards UI. Adds a new match-only text field, query insights to monitor top N queries, and k-NN search on nested fields. For a full list of release highlights, see the Release Notes. 20 February 2024
2.11.1 Includes maintenance changes and bug fixes for cross-cluster replication, alerting, observability, OpenSearch Dashboards, index management, machine learning, security, and security analytics. For a full list of release highlights, see the Release Notes. 30 November 2023
2.11.0 Adds multimodal and sparse neural search capability and the ability to take shallow snapshots that refer to data stored in remote-backed storage. Makes the search comparison tool generally available. Includes a simplified workflow to create threat detectors in Security Analytics and improved security in OpenSearch Dashboards. Experimental features include a new framework and toolset for distributed tracing and updates to conversational search. For a full list of release highlights, see the Release Notes. 16 October 2023
2.10.0 Makes remote-backed storage generally available. Adds hybrid search capability, custom log types for Security Analytics, IP2Geo ingest processor, and delimited term frequency token filter. Includes a new look and feel for OpenSearch Dashboards and updates the Discover tool. Adds Microsoft Teams webhook support for notifications. Experimental features include concurrent segment search and conversational search. For a full list of release highlights, see the Release Notes. 25 September 2023
2.9.0 Makes search pipelines and the Neural Search plugin generally available. Adds ML model access control and integration with external ML tools. Implements k-NN byte vectors and efficient filtering with the Faiss engine. Integrates alerting and anomaly detection with OpenSearch Dashboards and adds composite monitors. Adds two new index codec algorithm options. Includes a new ingestion schema for Security Analytics, geoshape aggregations, and extensions—a new mechanism for extending OpenSearch functionality. For a full list of release highlights, see the Release Notes. 24 July 2023
2.8.0 Adds cross-cluster query with PPL, search pipelines, an option to turn on segment replication as the default replication type, improved searchable snapshot performance, and Amazon OpenSearch Serverless support with SigV4 authentication for multiple data sources. Includes the UI for the flush, refresh, and clear cache operations in OpenSearch Dashboards. For a full list of release highlights, see the Release Notes. 06 June 2023
2.7.0 Includes searchable snapshots and segment replication, which are now generally available. Adds multiple data sources, observability features, dynamic tenant management, component templates, and shape-based map filters in OpenSearch Dashboards. Includes the flat object field type, hot shard identification, and a new automatic reloading mechanism for ML models. For a full list of release highlights, see the Release Notes. 02 May 2023
2.6.0 Includes simple schema for observability, index management UI enhancements, Security Analytics enhancements, search backpressure at the coordinator node level, and the ability to add maps to dashboards. Experimental features include a new ML model health dashboard, new text embedding models in ML, and SigV4 authentication in Dashboards. For a full list of release highlights, see the Release Notes. 28 February 2023
2.5.0 Includes index management UI enhancements, multi-layer maps, Jaeger support for observability, Debian distributions, returning cluster health by awareness attribute, cluster manager task throttling, weighted zonal search request routing policy, and query string support in index rollups. Experimental features include request-level durability in remote-backed storage and GPU acceleration for ML nodes. For a full list of release highlights, see the Release Notes. 24 January 2023
2.4.1 Includes maintenance changes and bug fixes for gradle check and indexing pressure tests. Adds support for skipping changelog. For a full list of release highlights, see the Release Notes. 13 December 2022
2.4.0 Includes Windows support, Point-in-time search, custom k-NN filtering, xy_point and xy_shape field types for Cartesian coordinates, GeoHex grid aggregation, and resilience enhancements, including search backpressure. In OpenSearch Dashboards, this release adds snapshot restore functionality, multiple authentication, and aggregate view of saved objects. This release includes the following experimental features: searchable snapshots, Compare Search Results, multiple data sources in OpenSearch Dashboards, a new Model Serving Framework in ML Commons, a new Neural Search plugin that supports semantic search, and a new Security Analytics plugin to analyze security logs. For a full list of release highlights, see the Release Notes. 15 November 2022
2.3.0 This release includes the following experimental features: segment replication, remote-backed storage, and drag and drop for OpenSearch Dashboards. Experimental features allow you to test new functionality in OpenSearch. Because these features are still being developed, your testing and feedback can help shape the development of the feature before it’s official released. We do not recommend use of experimental features in production. Additionally, this release adds maketime and makedate datetime functions for the SQL plugin. Creates a new OpenSearch Playground demo site for OpenSearch Dashboards. For a full list of release highlights, see the Release Notes. 14 September 2022
2.2.1 Includes gradle updates and bug fixes for gradle check. For a full list of release highlights, see the Release Notes. 01 September 2022
2.2.0 Includes support for Logistic Regression and RCF Summarize machine learning algorithms in ML Commons, Lucene or C-based Nmslib and Faiss libraries for approximate k-NN search, search by relevance using SQL and PPL queries, custom region maps for visualizations, and rollup enhancements. For a full list of release highlights, see the Release Notes. 11 August 2022
2.1.0 Includes support for dedicated ML node in the ML Commons plugin, relevance search and other features in SQL, multi-terms aggregation, and Snapshot Management. For a full list of release highlights, see the Release Notes. 07 July 2022
2.0.1 Includes bug fixes and maintenance updates for Alerting and Anomaly Detection. For a full list of release highlights, see the Release Notes. 16 June 2022
2.0.0 Includes document-level monitors for alerting, OpenSearch Notifications plugins, and Geo Map Tiles in OpenSearch Dashboards. Also adds support for Lucene 9 and bug fixes for all OpenSearch plugins. For a full list of release highlights, see the Release Notes. 26 May 2022
2.0.0-rc1 The Release Candidate for 2.0.0. This version allows you to preview the upcoming 2.0.0 release before the GA release. The preview release adds document-level alerting, support for Lucene 9, and the ability to use term lookup queries in document level security. For a full list of release highlights, see the Release Notes. 03 May 2022
1.3.20 Includes enhancements to Anomaly Detection Dashboards, bug fixes for Alerting and Dashboards Reports, and maintenance updates for several OpenSearch components. For a full list of release highlights, see the Release Notes. 11 December 2024
1.3.19 Includes bug fixes and maintenance updates for OpenSearch security, OpenSearch security Dashboards, and anomaly detection. For a full list of release highlights, see the Release Notes. 27 August 2024
1.3.18 Includes maintenance updates for OpenSearch security. For a full list of release highlights, see the Release Notes. 16 July 2024
1.3.17 Includes maintenance updates for OpenSearch security and OpenSearch Dashboards security. For a full list of release highlights, see the Release Notes. 06 June 2024
1.3.16 Includes bug fixes and maintenance updates for OpenSearch security, index management, performance analyzer, and reporting. For a full list of release highlights, see the Release Notes. 23 April 2024
1.3.15 Includes bug fixes and maintenance updates for cross-cluster replication, SQL, OpenSearch Dashboards reporting, and alerting. For a full list of release highlights, see the Release Notes. 05 March 2024
1.3.14 Includes bug fixes and maintenance updates for OpenSearch security and OpenSearch Dashboards security. For a full list of release highlights, see the Release Notes. 12 December 2023
1.3.13 Includes bug fixes for Anomaly Detection, adds maintenance updates and infrastructure enhancements. For a full list of release highlights, see the Release Notes. 21 September 2023
1.3.12 Adds maintenance updates for OpenSearch security and OpenSearch Dashboards observability. Includes bug fixes for observability, OpenSearch Dashboards visualizations, and OpenSearch security. For a full list of release highlights, see the Release Notes. 10 August 2023
1.3.11 Adds maintenance updates for OpenSearch security, OpenSearch Dashboards security, and ML Commons. For a full list of release highlights, see the Release Notes. 29 June 2023
1.3.10 Adds infrastructure enhancements and maintenance updates for anomaly detection, observability, and security. Includes bug fixes for index management and OpenSearch security. For a full list of release highlights, see the Release Notes. 18 May 2023
1.3.9 Adds Debian support. Includes upgrades, enhancements, and maintenance updates for OpenSearch core, k-NN, and OpenSearch security. For a full list of release highlights, see the Release Notes. 16 March 2023
1.3.8 Adds OpenSearch security enhancements. Updates tool scripts to run on Windows. Includes maintenance updates and bug fixes for Anomaly Detection and OpenSearch security. For a full list of release highlights, see the Release Notes. 02 February 2023
1.3.7 Adds Windows support. Includes maintenance updates and bug fixes for error handling. For a full list of release highlights, see the Release Notes. 13 December 2022
1.3.6 Includes maintenance updates and bug fixes for tenancy in the OpenSearch Security Dashboards plugin. For a full list of release highlights, see the Release Notes. 06 October 2022
1.3.5 Includes maintenance updates and bug fixes for gradle check and OpenSearch security. For a full list of release highlights, see the Release Notes. 01 September 2022
1.3.4 Includes maintenance updates and bug fixes for OpenSearch and OpenSearch Dashboards. For a full list of release highlights, see the Release Notes. 14 July 2022
1.3.3 Adds enhancements to Anomaly Detection and ML Commons. Bug fixes for Anomaly Detection, Observability, and k-NN. For a full list of release highlights, see the Release Notes. 09 June 2022
1.3.2 Bug fixes for Anomaly Detection and the Security Dashboards Plugin, adds the option to install OpenSearch using RPM, as well as enhancements to the ML Commons execute task, and the removal of the job-scheduler zip in Anomaly Detection. For a full list of release highlights, see the Release Notes. 05 May 2022
1.3.1 Bug fixes when using document-level security, and adjusted ML Commons to use the latest RCF jar and protostuff to RCF model serialization. For a full list of release highlights, see the Release Notes. 30 March 2022
1.3.0 Adds Model Type Validation to Validate Detector API, continuous transforms, custom actions, applied policy parameter to Explain API, default action retries, and new rollover and transition conditions to Index Management, new ML Commons plugin, parse command to SQL, Application Analytics, Live Tail, Correlation, and Events Flyout to Observability, and auto backport and support for OPENSEARCH_JAVA_HOME to Performance Analyzer. Bug fixes. For a full list of release highlights, see the Release Notes. 17 March 2022
1.2.4 Updates Performance Analyzer, SQL, and Security plugins to Log4j 2.17.1, Alerting and Job Scheduler to cron-utils 9.1.6, and gson in Anomaly Detection and SQL. For a full list of release highlights, see the Release Notes. 18 January 2022
1.2.3 Updates the version of Log4j used in OpenSearch to Log4j 2.17.0 as recommended by the advisory in CVE-2021-45105. For a full list of release highlights, see the Release Notes. 22 December 2021
1.2.0 Adds observability, new validation API for Anomaly Detection, shard-level indexing back-pressure, new “match” query type for SQL and PPL, support for Faiss libraries in k-NN, and custom Dashboards branding. For a full list of release highlights, see the Release Notes. 23 November 2021
1.1.0 Adds cross-cluster replication, security for Index Management, bucket-level alerting, a CLI to help with upgrading from Elasticsearch OSS to OpenSearch, and enhancements to high cardinality data in the anomaly detection plugin. For a full list of release highlights, see the Release Notes. 05 October 2021
1.0.1 Bug fixes. For a full list of release highlights, see the Release Notes. 01 September 2021
1.0.0 General availability release. Adds compatibility setting for clients that require a version check before connecting. For a full list of release highlights, see the Release Notes. 12 July 2021
1.0.0-rc1 First release candidate. For a full list of release highlights, see the Release Notes. 07 June 2021
1.0.0-beta1 Initial beta release. Refactors plugins to work with OpenSearch. For a full list of release highlights, see the Release Notes. 13 May 2021
WAS THIS PAGE HELPFUL?
✔ Yes ✖ No
Tell us why
350 characters left
Send
Thank you for your feedback!
Have a question? Ask us on the OpenSearch forum.
Want to contribute? Edit this page or create an issue.
OpenSearch Links
Get Involved
* Code of Conduct
* Forum
* GitHub
* Slack
Resources
* About
* Release Schedule
* Maintenance Policy
* FAQ
* Testimonials
* Trademark and Brand Policy
* Privacy
Contact Us
* Connect
* Twitter
* LinkedIn
* YouTube
* Meetup
* Facebook
Copyright © OpenSearch Project a Series of LF Projects, LLC
For web site terms of use, trademark policy and other project policies please see https://lfprojects.org.
|
For now, Differences are performed on text, not graphically, only the latest screenshot is available.
Screenshot requires Playwright/WebDriver enabled