From 81593c690b0f0a633fb42f2096a85e59144d61b0 Mon Sep 17 00:00:00 2001 From: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Date: Tue, 11 Feb 2025 16:04:44 -0600 Subject: [PATCH 1/6] Add version 2.19. (#9174) Signed-off-by: Archer --- _config.yml | 6 +++--- _data/versions.json | 5 +++-- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/_config.yml b/_config.yml index 54b267ea03..f4ce58fc70 100644 --- a/_config.yml +++ b/_config.yml @@ -5,9 +5,9 @@ baseurl: "/docs/latest" # the subpath of your site, e.g. /blog url: "https://opensearch.org" # the base hostname & protocol for your site, e.g. http://example.com permalink: /:path/ -opensearch_version: '2.18.0' -opensearch_dashboards_version: '2.18.0' -opensearch_major_minor_version: '2.18' +opensearch_version: '2.19.0' +opensearch_dashboards_version: '2.19.0' +opensearch_major_minor_version: '2.19' lucene_version: '9_12_0' # Build settings diff --git a/_data/versions.json b/_data/versions.json index 6fe1c59e6b..51d0fa3b12 100644 --- a/_data/versions.json +++ b/_data/versions.json @@ -1,10 +1,11 @@ { - "current": "2.18", + "current": "2.19", "all": [ - "2.18", + "2.19", "1.3" ], "archived": [ + "2.18", "2.17", "2.16", "2.15", From cfaac10b9959e1518c469e8d427c3d85ad3444fc Mon Sep 17 00:00:00 2001 From: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Date: Tue, 11 Feb 2025 16:05:41 -0600 Subject: [PATCH 2/6] Add 2.19 documentation release notes (#9175) * Add 2.19 documentation release notes Signed-off-by: Archer * make PR titles consistent Signed-off-by: Archer --------- Signed-off-by: Archer --- ...arch-documentation-release-notes-2.19.0.md | 36 +++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 release-notes/opensearch-documentation-release-notes-2.19.0.md diff --git a/release-notes/opensearch-documentation-release-notes-2.19.0.md b/release-notes/opensearch-documentation-release-notes-2.19.0.md new file mode 100644 index 0000000000..f71087df84 --- /dev/null +++ b/release-notes/opensearch-documentation-release-notes-2.19.0.md @@ -0,0 +1,36 @@ +# OpenSearch Documentation Website 2.19.0 Release Notes + +The OpenSearch 2.19.0 documentation includes the following additions and updates. + +## New documentation for 2.19.0 + +- Adds star-tree search changes related to new aggregations supported [#9163](https://github.com/opensearch-project/documentation-website/pull/9163) +- Adds QueryInsightsDashboard [#9157](https://github.com/opensearch-project/documentation-website/pull/9157) +- Add Convert Index to remote documentation [#9156](https://github.com/opensearch-project/documentation-website/pull/9156) +- Adds details for using index_thread_qty for Lucene library [#9152](https://github.com/opensearch-project/documentation-website/pull/9152) +- Update threshold for 2.19 [#9151](https://github.com/opensearch-project/documentation-website/pull/9151) +- Add avx512_spr documentation [#9148](https://github.com/opensearch-project/documentation-website/pull/9148) +- Add documentation for plugin as a service [#9144](https://github.com/opensearch-project/documentation-website/pull/9144) +- Add AD flatten result index feature [#9140](https://github.com/opensearch-project/documentation-website/pull/9140) +- Add documentation for `wait_for_completion_timeout` Parameter [#9138](https://github.com/opensearch-project/documentation-website/pull/9138) +- Add feature direction to AD docs [#9137](https://github.com/opensearch-project/documentation-website/pull/9137) +- Add verbose_pipeline section in using-search-pipeline [#9130](https://github.com/opensearch-project/documentation-website/pull/9130) +- Query Insights 2.19 documentation [#9120](https://github.com/opensearch-project/documentation-website/pull/9120) +- Add template query [#9119](https://github.com/opensearch-project/documentation-website/pull/9119) +- Add RRF documentation for hybrid search [#9117](https://github.com/opensearch-project/documentation-website/pull/9117) +- Add Pagination in hybrid query [#9109](https://github.com/opensearch-project/documentation-website/pull/9109) +- Mark nmslib references for vector search as deprecated [#9107](https://github.com/opensearch-project/documentation-website/pull/9107) +- Add in-place SSL certs hot reload documentation [#9103](https://github.com/opensearch-project/documentation-website/pull/9103) +- Add binary Lucene vector updates for 2.19 [#9102](https://github.com/opensearch-project/documentation-website/pull/9102) +- Add OpenSearch Flow OSD plugin [#9101](https://github.com/opensearch-project/documentation-website/pull/9101) +- Update hot reload documentation to show how DN validation can be skipped [#9079](https://github.com/opensearch-project/documentation-website/pull/9079) +- Update k-NN Cosine formula [#9078](https://github.com/opensearch-project/documentation-website/pull/9078) += Update Ada Grad as the default optimiser. [#9061](https://github.com/opensearch-project/documentation-website/pull/9061) +- Add documentation about explain in hybrid query and hybrid_score_explanation processor [#9053](https://github.com/opensearch-project/documentation-website/pull/9053) +- Add Query Insights local index delete after documentation [#9052](https://github.com/opensearch-project/documentation-website/pull/9052) +- Add support for Bedrock Rerank API #9027 [#9029](https://github.com/opensearch-project/documentation-website/pull/9029) +- Add validation requirement for message fields [#9000](https://github.com/opensearch-project/documentation-website/pull/9000) +- Add documentation for workspace privacy [#8994](https://github.com/opensearch-project/documentation-website/pull/8994) +- Add documentation for pruning neural sparse vectors [#8984](https://github.com/opensearch-project/documentation-website/pull/8984) +- Add document the usage of update document API with ingest pipeline [#8874](https://github.com/opensearch-project/documentation-website/pull/8874) +- Update innerHits of nested k-NN fields [#8822](https://github.com/opensearch-project/documentation-website/pull/8822) From 59214e6935be70ced347c15cdc00994d83a40481 Mon Sep 17 00:00:00 2001 From: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Date: Tue, 11 Feb 2025 16:06:12 -0600 Subject: [PATCH 3/6] Add 2.19 to version history. (#9173) Signed-off-by: Archer --- _about/version-history.md | 1 + 1 file changed, 1 insertion(+) diff --git a/_about/version-history.md b/_about/version-history.md index d1cf98c178..fbc008ecd8 100644 --- a/_about/version-history.md +++ b/_about/version-history.md @@ -9,6 +9,7 @@ permalink: /version-history/ OpenSearch version | Release highlights | Release date :--- | :--- | :--- +[2.19.0](https://github.com/opensearch-project/opensearch-build/blob/main/release-notes/opensearch-release-notes-2.19.0.md) | 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](https://github.com/opensearch-project/opensearch-build/blob/main/release-notes/opensearch-release-notes-2.18.0.md) | 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](https://github.com/opensearch-project/opensearch-build/blob/main/release-notes/opensearch-release-notes-2.17.1.md) | 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](https://github.com/opensearch-project/opensearch-build/blob/main/release-notes/opensearch-release-notes-2.17.0.md) | 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 From 6fa541276dc4a78f74d8fd4aeecd143ae02b0bc2 Mon Sep 17 00:00:00 2001 From: 10000-ki <10000ki6472@gmail.com> Date: Thu, 13 Feb 2025 04:02:16 +0900 Subject: [PATCH 4/6] Fix query insights image link error (#9200) * Fix query insights image link error Signed-off-by: 10000-ki <10000ki6472@gmail.com> * Apply suggestions from code review Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update _observing-your-data/query-insights/query-insights-dashboard.md Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> --------- Signed-off-by: 10000-ki <10000ki6472@gmail.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> --- .../query-insights-dashboard.md | 20 +++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/_observing-your-data/query-insights/query-insights-dashboard.md b/_observing-your-data/query-insights/query-insights-dashboard.md index aa417f9236..66a01bb2a2 100644 --- a/_observing-your-data/query-insights/query-insights-dashboard.md +++ b/_observing-your-data/query-insights/query-insights-dashboard.md @@ -11,7 +11,7 @@ You can interact with the query insights feature using the Query Insights Dashbo ## Prerequisites -The Query Insights Dashboards plugin requires [OpenSearch 2.19 or later]({{site.url}}{{site.baseurl}}/install-and-configure/). +The Query Insights Dashboards plugin requires [OpenSearch 2.19 or later]({{site.url}}{{site.baseurl}}/install-and-configure/). ## Installing the plugin @@ -19,7 +19,7 @@ To install the Query Insights Dashboards plugin, see [Managing OpenSearch Dashbo ## Navigation -After logging in to OpenSearch Dashboards, you can find the **Query insights** page by navigating to **OpenSearch Plugins** > **Query insights**. +After logging in to OpenSearch Dashboards, you can find the **Query insights** page by navigating to **OpenSearch Plugins** > **Query insights**. If you have [multiple data sources]({{site.url}}{{site.baseurl}}/dashboards/management/multi-data-sources/) enabled, the **Query insights** page can be found by navigating to **Data administration** > **Performance** > **Query insights**. {: .note} @@ -37,7 +37,7 @@ The **Top N queries** page provides a detailed overview of the queries that have The following image of the **Top N queries** page contains letter labels for each component. -![Top N Queries Interface](../../images/Query-Insights/QueryInsights.png) +![Top N Queries Interface]({{site.url}}{{site.baseurl}}/images/Query-Insights/QueryInsights.png) Each label corresponds to the following components: @@ -99,13 +99,13 @@ The metrics table displays the following metrics for each query. The **Query details** page provides insights into query behavior, performance, and structure. You can access the query details page by selecting the query ID, as shown in the following image: -![Query Insights List](../../images/Query-Insights/Querieslist.png) +![Query Insights List]({{site.url}}{{site.baseurl}}/images/Query-Insights/Querieslist.png) ### Viewing individual query details You can access detailed information about a single query by selecting the query ID, such as `51c68a1a-7507-4b3e-aea1-32ddd74dbac4`. The query details page will appear, as shown in the following image. -![Individual Query Details](../../images/Query-Insights/IndividualQueryDetails.png) +![Individual Query Details]({{site.url}}{{site.baseurl}}/images/Query-Insights/IndividualQueryDetails.png) In the query details view, you can view information such as **Timestamp**, **CPU Time**, **Memory Usage**, **Indexes**, **Search Type**, **Coordinator Node ID**, and **Total Shards**. @@ -115,18 +115,18 @@ The query group details view provides insights into aggregated metrics for a gro To view query group details, select a query ID marked as a "group" in the **Top N queries** list. The query group details view provides the following information: -![Query Group Details](../../images/Query-Insights/GroupQueryDetails.png) +![Query Group Details]({{site.url}}{{site.baseurl}}/images/Query-Insights/GroupQueryDetails.png) - The **Aggregate summary for queries** section provides a view of key query metrics for the entire group, including **Average latency**, **Average CPU time**, **Average memory usage**, and **Group by** criteria. - The **Sample query details** section provides information about a single representative query, including its **Timestamp**, **Indexes**, **Search Type**, **Coordinator Node ID**, and **Total Shards**. -- The **Query** section displays the JSON structure of the query. +- The **Query** section displays the JSON structure of the query. - The **Latency** section presents a graphical representation of the run phases for the query. ## Configuration The **Query insights - Configuration** page is designed to gives you control over how the query insights feature collects, monitors, groups, and retains data. The following image shows the configuration page. -![Configuration](../../images/Query-Insights/Configuration.png) +![Configuration]({{site.url}}{{site.baseurl}}/images/Query-Insights/Configuration.png) On the configuration page, you can configure the settings described in the following sections. @@ -139,12 +139,12 @@ Perform the following to configure the top N queries settings: 1. From the **Query insights** page, navigate to the **Configuration** tab. 2. Select the metric type: **Latency**, **CPU Usage**, or **Memory**. 3. Toggle the **Enabled** setting to turn the top N queries feature on or off for the selected metric. -4. Specify the monitoring **Window size**, which determines the duration of the time queries collected for analysis. +4. Specify the monitoring **Window size**, which determines the duration of the time queries collected for analysis. 5. Enter the value of **N**, which defines the number of top queries to track in each window. 6. Select **Save**. 7. Check the **Statuses for configuration metrics** panel to see the enabled metrics. -### Top N queries grouping +### Top N queries grouping The **Top n queries group configuration settings** set the grouping settings for queries. From 849a3ad1359287327b0c251ed64a0cea8f61202a Mon Sep 17 00:00:00 2001 From: Xinyuan Lu Date: Fri, 14 Feb 2025 23:23:31 +0800 Subject: [PATCH 5/6] Add description for safely deleting model (#9206) * Update delete-model.md Signed-off-by: Xinyuan Lu * Doc review Signed-off-by: Fanit Kolchina * Apply suggestions from code review Co-authored-by: Nathan Bower Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> --------- Signed-off-by: Xinyuan Lu Signed-off-by: Fanit Kolchina Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Fanit Kolchina Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Co-authored-by: Nathan Bower --- .../api/model-apis/delete-model.md | 13 ++- _ml-commons-plugin/cluster-settings.md | 84 +++++++++++-------- 2 files changed, 63 insertions(+), 34 deletions(-) diff --git a/_ml-commons-plugin/api/model-apis/delete-model.md b/_ml-commons-plugin/api/model-apis/delete-model.md index 009e4d9436..bc152c1228 100644 --- a/_ml-commons-plugin/api/model-apis/delete-model.md +++ b/_ml-commons-plugin/api/model-apis/delete-model.md @@ -44,4 +44,15 @@ DELETE /_plugins/_ml/models/MzcIJX8BA7mbufL6DOwl "_seq_no" : 27, "_primary_term" : 18 } -``` \ No newline at end of file +``` + +## Safely deleting a model +Introduced 2.19 +{: .label .label-purple } + +To prevent accidental deletion of models in active use by agents, search pipelines, ingest pipelines, or other components, you can enable a safety check. If the safety check is enabled and you attempt to delete a model that is in current use, OpenSearch returns an error message. To proceed with deletion: + +- Identify any components using the model and either delete them or update them so that they use other models. +- Once all dependencies are cleared, delete the model. + +For information about enabling this feature, see [Safely delete models]({{site.url}}{{site.baseurl}}/ml-commons-plugin/cluster-settings/#safely-delete-models). \ No newline at end of file diff --git a/_ml-commons-plugin/cluster-settings.md b/_ml-commons-plugin/cluster-settings.md index efb13dd73a..c2939b3f2b 100644 --- a/_ml-commons-plugin/cluster-settings.md +++ b/_ml-commons-plugin/cluster-settings.md @@ -36,7 +36,7 @@ We recommend setting `plugins.ml_commons.only_run_on_ml_node` to `true` on produ ### Setting -``` +```yaml plugins.ml_commons.only_run_on_ml_node: true ``` @@ -52,7 +52,7 @@ plugins.ml_commons.only_run_on_ml_node: true ### Setting -``` +```yaml plugins.ml_commons.task_dispatch_policy: round_robin ``` @@ -68,7 +68,7 @@ Sets the number of ML tasks that can run on each ML node. When set to `0`, no ML ### Setting -``` +```yaml plugins.ml_commons.max_ml_task_per_node: 10 ``` @@ -83,7 +83,7 @@ Sets the number of ML models that can be deployed to each ML node. When set to ` ### Setting -``` +```yaml plugins.ml_commons.max_model_on_node: 10 ``` @@ -99,7 +99,7 @@ When returning runtime information with the [Profile API]({{site.url}}{{site.bas ### Setting -``` +```yaml plugins.ml_commons.sync_up_job_interval_in_seconds: 3 ``` @@ -114,7 +114,7 @@ Controls how many predict requests are monitored on one node. If set to `0`, Ope ### Setting -``` +```yaml plugins.ml_commons.monitoring_request_count: 100 ``` @@ -129,7 +129,7 @@ Controls how many register model tasks can run in parallel on one node. If set t ### Setting -``` +```yaml plugins.ml_commons.max_register_model_tasks_per_node: 10 ``` @@ -146,7 +146,7 @@ Controls how many deploy model tasks can run in parallel on one node. If set to ### Setting -``` +```yaml plugins.ml_commons.max_deploy_model_tasks_per_node: 10 ``` @@ -157,11 +157,11 @@ plugins.ml_commons.max_deploy_model_tasks_per_node: 10 ## Register models using URLs -This setting gives you the ability to register models using a URL. By default, ML Commons only allows registration of [pretrained]({{site.url}}{{site.baseurl}}//ml-commons-plugin/pretrained-models/) models from the OpenSearch model repository. +This setting gives you the ability to register models using a URL. By default, ML Commons only allows registration of [pretrained]({{site.url}}{{site.baseurl}}/ml-commons-plugin/pretrained-models/) models from the OpenSearch model repository. ### Setting -``` +```yaml plugins.ml_commons.allow_registering_model_via_url: false ``` @@ -172,11 +172,11 @@ plugins.ml_commons.allow_registering_model_via_url: false ## Register models using local files -This setting gives you the ability to register a model using a local file. By default, ML Commons only allows registration of [pretrained]({{site.url}}{{site.baseurl}}//ml-commons-plugin/pretrained-models/) models from the OpenSearch model repository. +This setting gives you the ability to register a model using a local file. By default, ML Commons only allows registration of [pretrained]({{site.url}}{{site.baseurl}}/ml-commons-plugin/pretrained-models/) models from the OpenSearch model repository. ### Setting -``` +```yaml plugins.ml_commons.allow_registering_model_via_local_file: false ``` @@ -196,7 +196,7 @@ The default URL value for this trusted URL setting is not secure. For security, {: .warning } -``` +```yaml plugins.ml_commons.trusted_url_regex: ``` @@ -211,7 +211,7 @@ Assigns how long in seconds an ML task will live. After the timeout, the task wi ### Setting -``` +```yaml plugins.ml_commons.ml_task_timeout_in_seconds: 600 ``` @@ -230,7 +230,7 @@ Starting with OpenSearch 2.5, ML Commons runs a native memory circuit breaker to ### Setting -``` +```yaml plugins.ml_commons.native_memory_threshold: 90 ``` @@ -247,7 +247,7 @@ Values are based on the percentage of JVM heap memory available. When set to `0` ### Setting -``` +```yaml plugins.ml_commons.jvm_heap_memory_threshold: 85 ``` @@ -264,7 +264,7 @@ Valid values are in byte units. To disable the circuit breaker, set this value t ### Setting -``` +```yaml plugins.ml_commons.disk_free_space_threshold: 5G ``` @@ -279,7 +279,7 @@ Use this setting to specify the names of nodes on which you don't want to run ML ### Setting -``` +```yaml plugins.ml_commons.exclude_nodes._name: node1, node2 ``` @@ -289,7 +289,7 @@ When enabled, this setting grants users the ability to deploy models to specific ### Setting -``` +```yaml plugins.ml_commons.allow_custom_deployment_plan: false ``` @@ -304,7 +304,7 @@ This setting is applicable when you send a prediction request for an externally ### Setting -``` +```yaml plugins.ml_commons.model_auto_deploy.enable: false ``` @@ -319,7 +319,7 @@ This setting automatically redeploys deployed or partially deployed models upon ### Setting -``` +```yaml plugins.ml_commons.model_auto_redeploy.enable: true ``` @@ -334,7 +334,7 @@ This setting sets the limit for the number of times a deployed or partially depl ### Setting -``` +```yaml plugins.ml_commons.model_auto_redeploy.lifetime_retry_times: 3 ``` @@ -349,7 +349,7 @@ This setting sets the ratio of success for the auto-redeployment of a model base ### Setting -``` +```yaml plugins.ml_commons.model_auto_redeploy_success_ratio: 0.8 ``` @@ -364,22 +364,40 @@ When set to `true`, this setting enables the ability to run Python-based models ### Setting -``` +```yaml plugins.ml_commons.enable_inhouse_python_model: false ``` ### Values -- Default value: false +- Default value: `false` +- Valid values: `false`, `true` + +## Safely delete models +Introduced 2.19 +{: .label .label-purple } + +When set to `true`, this setting enables a safety feature that checks for downstream dependencies before deleting a model. This helps prevent accidental deletion of models in active use by agents, search pipelines, ingest pipelines, and other downstream tasks. If this setting is enabled and you attempt to delete a model that has active downstream dependencies, you'll receive an error message and the model will not be deleted. + +### Setting + +```yaml +plugins.ml_commons.safe_delete_model: true +``` + +### Values + +- Default value: `false` - Valid values: `false`, `true` + ## Enable access control for connectors When set to `true`, the setting allows admins to control access and permissions to the connector API using `backend_roles`. ### Setting -``` +```yaml plugins.ml_commons.connector_access_control_enabled: true ``` @@ -394,7 +412,7 @@ This setting allows a cluster admin to enable running local models on the cluste ### Setting -``` +```yaml plugins.ml_commons.local_model.enabled: true ``` @@ -409,7 +427,7 @@ This setting allows a cluster admin to control the types of nodes on which exter ### Setting -``` +```yaml plugins.ml_commons.task_dispatcher.eligible_node_role.remote_model: ["ml"] ``` @@ -424,7 +442,7 @@ This setting allows a cluster admin to control the types of nodes on which local ### Setting -``` +```yaml plugins.ml_commons.task_dispatcher.eligible_node_role.remote_model: ["ml"] ``` @@ -438,7 +456,7 @@ This setting allows a cluster admin to enable remote inference on the cluster. I ### Setting -``` +```yaml plugins.ml_commons.remote_inference.enabled: true ``` @@ -453,7 +471,7 @@ When set to `true`, this setting enables the agent framework (including agents a ### Setting -``` +```yaml plugins.ml_commons.agent_framework_enabled: true ``` @@ -468,7 +486,7 @@ When set to `true`, this setting enables conversational memory, which stores all ### Setting -``` +```yaml plugins.ml_commons.memory_feature_enabled: true ``` @@ -484,7 +502,7 @@ When set to `true`, this setting enables the search processors for retrieval-aug ### Setting -``` +```yaml plugins.ml_commons.rag_pipeline_feature_enabled: true ``` From ac2b3a59dee7f38ca4db98f9bc115be6be2965da Mon Sep 17 00:00:00 2001 From: Robin Schneider <97551096+ypid-work@users.noreply.github.com> Date: Fri, 14 Feb 2025 16:31:25 +0100 Subject: [PATCH 6/6] =?UTF-8?q?float=20and=20double=20field=20type=20don?= =?UTF-8?q?=E2=80=99t=20accept=20special=20values=20like=20NaN=20nor=20Inf?= =?UTF-8?q?inity=20(#9205)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit According to [IEEE 754 floating point numbers support special values like NaN nor Infinity](https://en.wikipedia.org/wiki/Floating-point_arithmetic#IEEE_754:_floating_point_in_modern_computers). OpenSearch does not support them. This change adds this restriction to the documentation for the supported datatypes. Note that this restriction should also apply to half_float but this is not explicitly documented. https://github.com/elastic/elasticsearch/issues/27653 This change was still done under [Apache-2.0](https://github.com/cbuescher/elasticsearch/blob/2d7f0089ee3a924156905aaeedde5c50bc50ec2d/LICENSE.txt) so copy-paste should be no issue. Signed-off-by: Robin Schneider Co-authored-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> --- _field-types/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/_field-types/index.md b/_field-types/index.md index e9250f409d..7bac4e114e 100644 --- a/_field-types/index.md +++ b/_field-types/index.md @@ -28,8 +28,8 @@ Type | Description :--- | :--- `null` | A `null` field can't be indexed or searched. When a field is set to null, OpenSearch behaves as if the field has no value. `boolean` | OpenSearch accepts `true` and `false` as Boolean values. An empty string is equal to `false.` -`float` | A single-precision, 32-bit floating-point number. -`double` | A double-precision, 64-bit floating-point number. +`float` | A single-precision, 32-bit IEEE 754 floating-point number, restricted to finite values. +`double` | A double-precision, 64-bit IEEE 754 floating-point number, restricted to finite values. `integer` | A signed 32-bit number. `object` | Objects are standard JSON objects, which can have fields and mappings of their own. For example, a `movies` object can have additional properties such as `title`, `year`, and `director`. `array` | OpenSearch does not have a specific array data type. Arrays are represented as a set of values of the same data type (for example, integers or strings) associated with a field. When indexing, you can pass multiple values for a field, and OpenSearch will treat it as an array. Empty arrays are valid and recognized as array fields with zero elements---not as fields with no values. OpenSearch supports querying and filtering arrays, including checking for values, range queries, and array operations like concatenation and intersection. Nested arrays, which may contain complex objects or other arrays, can also be used for advanced data modeling.