2.14.0.0

Version 2.14.0.0 Release Notes

Compatible with OpenSearch 2.14.0.0

Features

• Initiate MLInferencelngestProcessor (#2205)
• Add TTL to un-deploy model automatically (#2365)
• ML Model Interface (#2357)

Enhancements

• Change httpclient to async (#1958)
• Migrate RAG pipeline to async processing. (#2345)
• Filtering hidden model info from model profiling for users other than superadmin (#2332)
• check model auto deploy (#2288)
• restrict stash context only for stop words system index (#2283)
• Add a flag to control auto-deploy behavior (#2276)

Bug Fixes

• fix stopwords npe (#2311)
• guardrails npe (#2304)
• not sending failure message when model index isn't present (#2351)
• fix guardrails mapping (#2279)
• fix no model group index issue in connector helper notebook (#2336)
• Fixes #2317 predict api not working with asymmetric models (#2318)
• fixing isHidden null issue (#2337)
• fix remote register model / circuit breaker 500(#2264)
• guardrails bug fixes and IT for creating guardrails (#2269)
• Added missing result filter to inference (#2367)
• making Boolean type for isHidden (#2341
• Clear planningWorkerNodes when model auto-deploys again after undeploy (#2396)
• Avoid race condition in syncup model state refresh (#2405)
• Add a flag to distinguish remote model auto deploy and transport deploy (#2410)
• Add deploySetting in registering local models (#2415)

Refactoring

• feat: Add search index tool (#2356)
• Move visualization tool to ml-commons (#2363)

Documentation

• Add connector blueprint for VertexAI Embedding endpoint (#2268)

Infrastructure

• remove checkstyle (#2312)
• Increase rounding delta from 0.005% to 0.5% on RestMLInferenceIngestProcessorIT (#2372)
• add agent framework security it tests by (#2266)
• Add IT for interface (#2394)
• Fix local build failure for RestMLInferenceIngestProcessorIT (#2402)

Maintenance

• fix CVE for org.eclipse.core.runtime (#2378)

2.13.0.0

Version 2.13.0.0 Release Notes

Compatible with OpenSearch 2.13.0

Features

• hidden agent (#2204)
• auto deployment for remote models (#2206)
• support question answering model (#2208)
• Guardrails for remote model input and output (#2209)

Enhancements

• Adding connector http timeout in the connector level (#1835)
• enable auto redeploy for hidden model (#2102)
• Add verification to rate limiter number field (#2113)
• asymmetric embeddings (#2123)
• Set the number of ml system index primary shards to 1 (#2137)
• prevent exposing internal ip when an agent gets an internal OpenSearch exception (#2154)
• Change the index update settings to make it only contain dynamic settings (#2156)
• add remote predict thread pool (#2207)
• add local inference enabling/disabling setting (#2232)
• Add request level parameters for system_prompt and user_instructions (#2236)
• Add support for Cohere and other chat model input/outputs in the RAG pipeline (#2238)

Infrastructure

• Add integration tests for the RAG pipeline covering OpenAI and Bedrock (#2213)

Bug Fixes

• fix error code when executing agent (#2120)
• fix npe when executing agent with empty parameter (#2145)
• fix delete model cache on macOS causing model deploy fail with model (#2180)
• adding BWC for connector config field (#2184)
• Fix onnx dep (#2198)
• update the response code to 404 when deleting a memory (#2212)
• Fix model enable flag not loading (#2221)
• updating ml_connector schema version (#2228)
• fix json error (#2234)
• update remote model auto deploy tests in predict runner (#2237)

Documentation

• Add Cohere Chat blueprint with RAG (#1991)
• add tutorial for semantic search with byte quantized vector and Cohere embedding model (#2127)
• add tutorial for rerank pipeline with Cohere rerank model (#2134)
• add tutorial for chatbot with rag (#2141)
• add tutorial for building your own chatbot (#2144)
• add tutorial for CFN template integration (#2161)
• fix cohere chat blueprint (#2167)
• add demo notebook for creating connector (#2192)
• enhance connector helper notebook to support 2.9 (#2202)

Maintenance

• Updates sample cert and admin keystore (#2143)
• Bump common-compress package to fix CVE (#2186)
• Suppress removal AccessController in java.security has been deprecated and marked for removal (#2195)

Refactoring

• refactor memory logs (#2121)
• parse tool input to map (#2131)

2.12.0.0

Version 2.12.0.0 Release Notes

Compatible with OpenSearch 2.12.0

Maintenance

• Add Austin and Henry as maintainer (#1579)
• Updated version of awssdk (#1607)
• Update Gradle to 8.4 (#1697)
• Address CVE-2023-42503 (#1727)
• Fix CVE-2023-2976 and upgrade guava to be consistent (#2013)
• Fix CVE-2023-42503 due to djl models (#2016)
• Add maintainer (#1952)
• Updating maintainers list (#1938)
• Bump Mockito dependencies (#1868)
• Updated OpenSearch Lucene snapshot location (#1834)
• Add kotlin stblib dependency for SearchAlertTool (#1861)
• Update dependency com.jayway.jsonpath:json-path to v2.9.0 (#1956)
• Update http package import for 2.x (#1957)
• Update the lucene snapshot url (#2082)
• removing skills first (#2089)

Infrastructure

• Onboarding Jenkins prod docker images to github ci check (#1566)
• Add code coverage report for commons and memory modules (#1585)
• Adding UT coverage for in-cache update and fine-tuning throttling feature (#1913)
• Add tests for MLAgent Get and Delete (#1794)
• Fix race confition in index initialization and RestUpdateConnector UT (#1857)
• Fix failing flaky tests due to pytorch library not available for dependency plugins (#1886)
• Adding tests for all the agent runners (#1792)
• Update deprecated openAI mode in integration test and fix flaky tests (#1858)

Documentation

• Updated developer guide to include links for getting started with git (#1409)
• Add triaging doc (#1250)
• Add bedrock blueprint doc (#1501)
• Add bedrock titan embedding model blueprint (#1527)
• Fix bedrock embedding model blueprint (#1563)
• Add openai embedding model blueprint (#1602)
• Added Connector Blueprint for AI21 Labs Jurassic-2 Mid (#1617)
• Update default model_access_mode for model group (#1677)
• Add cohere version 3 embedding model (#1721)
• Blueprint for multi-model titan model (#1729)
• AI connector blueprint for the Aleph Alpha Luminous-Base Embedding Model (#2003)
• Add tutorial doc for semantic search on amazon opensearch (#1928)
• Add tutorial doc for semantic search with OpenAI embedding model (#1936)
• Add connector blueprint for Azure OpenAI Embedding and Chat model (#2062)
• Add updated Cohere Embedding blueprint (#2063)
• add tutorial for conversational search (#2075)
• Add Cohere Chat blueprint with RAG (#1991)

Bug Fixes

• Fix missing lombok version compilation failure issue (#1278)
• Fix update connector API (#1484)
• Fixes bugs in the Cohere Blueprint (#1505)
• Fix register client API (#1561)
• Fixing MachineLearningNodeClient create connector, deploy model, register model group actions (#1584)
• Fix model/connector update API to address security concern (#1595)
• Fixing class casting exception for MachineLearningNodeClient GetMLTask API (#1618)
• Fix for controller error stack trace and tokenbucket (#1985)
• Fix internal connector (#1992)
• Fix argument pass (#1993)
• Fix error code when failed to delete model (#2037)
• Fix edge case for validate json method (#2045)
• Fix long pending issue when deleting model (#2046)
• Add escape method for process function (#2055)
• Fix bug in delete empty memory (#1966)
• Fix dup last trace (#1975)
• Add a version filter to enable bwc in 2.12 (#1944)
• Fix error message (#1976)
• Fix string.format wrong parameter position (#1960)
• Fix null taskId causing model undeploy issue (#1945)
• Fix updating plugins.ml_commons.jvm_heap_memory_threshold takes no effect (#1946)
• Fix compilation when backport (#1798)
• Fix duplicate node if node has both data and ml role (#1830)
• Fix partially response issue in profile API result (#1775)
• Fix: RestStatus 500 returned ml validation (#1811)
• Fix the hardcode password in IT (#1856)
• Fix model not deploy issue under intensive prediction tasks (#1930)
• Fix bug - not found agent index (#1867)
• Issue #1787: Fixing connector endpoint returns index not found (#1885)
• Issue #1878/#1879/#1880: Fixing index not found for model group/model/tasks (#1895)
• Change searchResponse method to fix breaking change in managed service (#1917)
• Adjust ListTool response format (#1912)
• Issue #844: Add accessUserInformation to the plugin security policy (#1959)
• Escape input data (#1974)
• flow agent suggestions missing (#2064)
• bug fix - tool parameters missing (#2065)
• fix empty tool parameter issue (#2067)
• tool uses original input (#2068)
• update Unthrotized error code to 401 (#2076)
• handle null value exceptions when arguments are missing or Null in caling RAG pipeline (#2079)
• changing error message and error code (#2073) (#2086)
• Fix bwc issue in remote prediction (#2085)

Experimental Feature

• Update Model API (#1350)
• Hidden model implementation (#1755)
• Model & user level throttling (#1814)
• Search agent api (#1826)
• Add GetTool API and ListTools API (#1850)
• Enable in-place update model (#1796)
• Memory Manager and Update Memory Actions/APIs (#1776)
• Add CatIndexTool (#1770)
• Add search and singular APIs to conversation memory (#1720)
• Memory interface in spi (#1771)
• Tool interface (#1772)
• Add get config api to retrieve root agent id (#1995)
• Register agent rest and transport actions (#1801)
• IndicesHandler and conversationIndexMemory (#1777)
• Adding mlmodeltool and agent tool with tests (#1778)
• Get and delete agent APIs (#1779)
• Add register action request/response (#1780)
• Add execute agent api; add load extension (#1810)
• Add IndexMapping Tool (#1934)
• Agent meta classes in common (#1759)
• Agent framework disable/enable flag (#1994)
• Do not allow non super admin users to undeploy hidden models (#1981)
• System error handling (#2051)
• Handling tool errors (#1881)
• Changes to hidden model code to use OPENDISTRO_SECURITY_USER instad of ssl principal (#1897) (#1900)
• Support regenerate for chatbot (#1823)
• Update IndexMappingTool Description (#1998)
• Add more user based permission check in Memory (#1935)
• Update memory index name and add updated_time (#1793)
• fine tune prompt;refactor conversational agent code (#2094)

Feature

• Add cross encoder support (#1739)
• Enable conversation memory feature flags (#2095)

Enhancements

• Add register and deploy api in client (#1502)
• Added create connector API for MLClient (#1506)
• Added register model group API for MLClient (#1519)
• Expose execute api for MLClient (#1541)
• Add prefix to show the error is from remote service (#1515)
• Fine tune predict API: read model from index directly (#1559)
• Removed empty host check, inherently within httpHost object generation (#1599)
• Cluster restart model auto redeploy (#1627)
• Add new data fields in the memory layer and update tests (#1753)
• Check if model id is null when undeploy (#2015)
• Adds inputs validation for create memory (#2040)
• Make response_field customizable in MLModelTool (#2043)
• Add memory id and interation id for non-verbose (#2005)
• Issue #1965: Remove logging of sensitive chat history (#2012)
• Update memory if tool output needs to be included in response (#2018)
• Disable dynamic mapping for config index (#2027)
• Move allow model setting from rest to transport (#1977)
• Fine tune connector process function (#1963)
• Change model auto redeploy enabled to true (#1809)
• Add auto expand replica settings to memories (#1824)
• Add interaction id into execute response (#1825)
• Add more methods to client (#1782)
• Support charset input params and change default charset as utf8 (#1828)
• Fine tune log message based on error type (#1842)
• Stash thread context before running forward action (#1906)
• Refine the error message on cluster status not ready scenario (#1931)
• Add Request-Source header (#1892)
• Add process function for bedrock (#1554)
• send agent execution response after saving memory (#2066)
• add conversational flow agent (#2069)

REFACTOR

• Rename memory field names in responses (#2020)
• Refactor memory layer APIs (#1890)

2.11.1.0

Version 2.11.1.0 Release Notes

Compatible with OpenSearch 2.11.1

Bug Fixes

• fix multiple docs support (#1516)
• support step size for embedding model which outputs less embeddings (#1586)
• validate step size (#1587)

CVE Fixes

• Bump json version to address CVE-2023-5072 (#1551)

2.11.0.0

Version 2.11.0.0 Release Notes

Compatible with OpenSearch 2.11.0

Experimental Features

• Update Connector API (#1227)

Enhancements

• Add neural search default processor for non OpenAI/Cohere scenario (#1274)
• Add tokenizer and sparse encoding (#1301)
• allow input null for text docs input (#1402)
• Add support for context_size and include 'interaction_id' in SearchRequest (#1385)
• adding model level metric in node level (#1330)
• add status code to model tensor (#1443)
• add bedrockURL to trusted connector regex list (#1461)
• Performance enhacement for predict action by caching model info (#1472)

Infrastructure

Bug Fixes

• fix parameter name in preprocess function (#1362)
• fix spelling in Readme.md (#1363)
• Fix error message in TransportDeplpoyModelAction class (#1368)
• fix null exception in text docs data set (#1403)
• fix text docs input unescaped error; enable deploy remote model (#1407)
• restore thread context before running action listener (#1418)
• fix more places where thread context not restored (#1421)
• Fix BWC test suite (#1426)
• support bwc for process function (#1427)
• fix model group auto-deletion when last version is deleted (#1444)
• fixing metrics correlation algorithm (#1448)
• throw exception if remote model doesn't return 2xx status code; fix predict runner (#1477)
• fix no worker node exception for remote embedding model (#1482)
• fix for delete model group API throwing incorrect error when model index not created (#1485)
• fix no worker node error on multi-node cluster (#1487)
• Fix prompt passing for Bedrock by passing a single string prompt for Bedrock models. (#1490)

Documentation

Maintenance

• Ignoring Redeploy test on MacOS due to known failures (#1414)
• throw exception when model group not found during update request (#1447)
• Add a setting to control the update connector API (#1274)

Refactoring

• register new versions to a model group based on the name provided (#1452)
• if model version fails to register, update model group accordingly (#1463)

2.10.0.0

Version 2.10.0.0 Release Notes

Compatible with OpenSearch 2.10.0

Experimental Features

• Conversations and Generative AI in OpenSearch (#1150)

Enhancements

• Add feature flags for remote inference (#1223)
• Add eligible node role settings (#1197)
• Add more stats: connector count, connector/config index status (#1180)

Infrastructure

• Updates demo certs used in integ tests (#1291)
• Add Auto Release Workflow (#1306)

Bug Fixes

• Fixing metrics (#1194)
• Fix null pointer exception when input parameter is null. (#1192)
• Fix admin with no backend role on AOS unable to create restricted model group (#1188)
• Fix parameter parsing bug for create connector input (#1185)
• Handle escaping string parameters explicitly (#1174)
• Fix model count bug (#1180)
• Fix core package name to address compilation errors (#1157)

Documentation

• Updating cohere blueprint doc (#1213)
• Fixing docs (#1193)
• Add model auto redeploy tutorial (#1175)
• Add remote inference tutorial (#1158)
• Adding blueprint examples for remote inference (#1155)
• Updating developer guide for CCI contributors (#1049)

Maintenance

• Bump checkstyle version for CVE fix (#1216)
• Correct imports for new location with regard to core refactoring (#1206)
• Fix breaking change caused by opensearch core (#1187)
• Bump OpenSearch snapshot version to 2.10 (#1157)
• Bump aws-encryption-sdk-java to fix CVE-2023-33201 (#1309)

Refactoring

• Renaming metrics (#1224)
• Changing messaging for IllegalArgumentException on duplicate model groups (#1294)
• Fixing some error message handeling (#1222)

2.9.0.0

Version 2.9.0.0 Release Notes

Compatible with OpenSearch 2.9.0

Features

• remote inference: add connector; fine tune ML model and tensor class (#1051)
• remote inference: add connector executor (#1052)
• connector transport actions, requests and responses (#1053)
• refactor predictable: add method to check if model is ready (#1057)
• Add basic connector access control classes (#1055)
• connector transport actions and disable native memory CB (#1056)
• restful connector actions and UT (#1065)
• Change connector access control creation allow empty list (#1069)

Enhancements

• create model group automatically with first model version (#1063)
• init master key automatically (#1075))

Infrastructure

• Adding an integration test for redeploying a model (#1016)
• add unit test for connector class in commons (#1058)
• remote inference: add unit test for model and register model input (#1059)
• remote inference: add unit test for StringUtils and remote inference input (#1061)
• more UT for rest and trasport actions (#1066)
• remote inference: add unit test for create connector request/response (#1067)
• Add more UT for remote inference classes (#1077)
• IT Security Tests for model access control (#1095)
• Add integration tests for the remote inference feature (#1073)
• Temporarily ignore OpenAI Tests (#1118)
• Increase sleep time on remote inference integration tests (#1124)
• fix remote inference it: update job interval (#1129)
• Add null key check for remote inference integration tests (#1113)
• Reenable OpenAI Remote Inference Tests (#1127)

Bug Fixes

• Add missing codes from pen test fix (#1060)
• fix cannot specify model access control parameters error (#1068)
• fix memory circuit breaker (#1072)
• PenTest fixes: error codes and update model group fix (#1074)
• Fix rare private ip address bypass SSRF issue (#1070)
• leftover in the 404 Not Found return error (#1079)
• modify error message when model group not unique is provided (#1078)
• stash context before accessing ml config index (#1092)
• fix init master key bug (#1094)
• delete connector successfully if model index is missing (#1106)
• fix encoding US-ASCII error (#1126)

Documentation

• model access control documentation (#966)
• updating docs for model group id (#980)

Maintenance

• Increment version to 2.9.0-SNAPSHOT (#955)
• Manual CVE backport (#1008)
• Fix build. (#1018)
• Fix the refactor change brought by core backport (#1047)
• change to compileOnly to avoid jarhell (#1062)
• Update ml CI workflow checkout ref to be PR commit (#1114)
• Add shell bash settings for windows github actions to export credentials (#1116)

2.8.0.0

Version 2.8.0.0 Release Notes

Compatible with OpenSearch 2.8.0

Experimental Features

• Model access control. (#928)

Enhancements

• Add a setting to enable/disable model url in register API (#871)
• Add a setting to enable/disable local upload while registering model (#873)
• Check hash value for the pretrained models (#878)
• Add pre-trained model list (#883)
• Add content hash value for the correlation model. (#885)
• Set default access_control_enabled setting to false (#935)
• Enable model access control in secure reset IT (#940)
• Add model group rest ITs (#942)

Bug Fixes

• Fix class not found exception when deserialize model (#899)
• Fix publish shadow publication dependency issue (#919)
• Fix model group index not existing model version query issue and SecureMLRestIT failure ITs (#933)
• Fix model access mode upper case bug (#937)

Documentation

Maintenance

• Increment version to 2.8.0-SNAPSHOT (#896)

Refactoring

• Change mem_size_estimation to memory_size_estimation (#868)

2.7.0.0

Version 2.7.0.0 Release Notes

Compatible with OpenSearch 2.7.0

Experimental Features

• Add metrics correlation algorithm. (#845)

Enhancements

• Add model auto deploy feature (#852)
• Add memory consumption estimation for models in profile API (#853)
• Add text docs ML input (#830)
• Add allow custom deployment plan setting; add deploy to all nodes field in model index (#818)
• Add exclude nodes setting. (#813)
• set model state as partially loaded if unload model from partial nodes (#806)

Bug Fixes

• change to old method to fix missing method createParentDirectories (#759)
• fix delete model API (#861)
• fix breaking changes of Xcontent namespace change (#838)
• Change the ziputil dependency to fix a potential security concern (#824)
• fix checkstyle version (#792)
• Typo fix and minor improvement in maven-publish GHA workflow (#757)

Documentation

• add docker-compose file for starting cluster with dedicated ML node (#799)

Maintenance

• Increment version to 2.7.0-SNAPSHOT (#742)
• Publish snapshots to maven via GHA (#754)

Refactoring

• rename API/function/variable names (#822)
• rename model meta/chunk API (#827)

2.6.0.0

Compatible with OpenSearch 2.6.0.

Experimental Features

• enable prebuilt model. (#729)

Enhancements

• tune error message for no ML node case (#699)
• [experimental] Enhance profile API to add model centric result controlled by view parameter (#714)
• [experimental] tune model config: change pooling mode to optional (#724)
• check state before deleting model or task (#725)

Bug Fixes

• fixing gradle issue (#735)
• fix delete model API (#748)

Documentation

• Update gpu doc with docker test (#702)
• add text embedding API example doc (#710)
• fix profile API in example doc (#712)
• change model url to public repo in text embedding model example doc (#713)
• json listing of all the pretrianed models (#730)

Maintenance

• Increment version to 2.6.0-SNAPSHOT (#671)

Refactoring

• add DL model class (#722)