Merge branch 'main' into derived

_api-reference/document-apis/bulk-streaming.md

@@ -0,0 +1,81 @@
+---
+layout: default
+title: Streaming bulk
+parent: Document APIs
+nav_order: 25
+redirect_from:
+ - /opensearch/rest-api/document-apis/bulk/streaming/
+---
+
+# Streaming bulk
+**Introduced 2.17.0**
+{: .label .label-purple }
+
+This is an experimental feature and is not recommended for use in a production environment. For updates on the progress of the feature or if you want to leave feedback, see the associated [GitHub issue](https://github.com/opensearch-project/OpenSearch/issues/9065).    
+{: .warning}
+
+The streaming bulk operation lets you add, update, or delete multiple documents by streaming the request and getting the results as a streaming response. In comparison to the traditional [Bulk API]({{site.url}}{{site.baseurl}}/api-reference/document-apis/bulk/), streaming ingestion eliminates the need to estimate the batch size (which is affected by the cluster operational state at any given time) and naturally applies backpressure between many clients and the cluster. The streaming works over HTTP/2 or HTTP/1.1 (using chunked transfer encoding), depending on the capabilities of the clients and the cluster.
+
+The default HTTP transport method does not support streaming. You must install the [`transport-reactor-netty4`]({{site.url}}{{site.baseurl}}/install-and-configure/configuring-opensearch/network-settings/#selecting-the-transport) HTTP transport plugin and use it as the default HTTP transport layer. Both the `transport-reactor-netty4` plugin and the Streaming Bulk API are experimental.
+{: .note}
+
+## Path and HTTP methods
+
+```json
+POST _bulk/stream
+POST <index>/_bulk/stream
+```
+
+If you specify the index in the path, then you don't need to include it in the [request body chunks]({{site.url}}{{site.baseurl}}/api-reference/document-apis/bulk/#request-body).
+
+OpenSearch also accepts PUT requests to the `_bulk/stream` path, but we highly recommend using POST. The accepted usage of PUT---adding or replacing a single resource on a given path---doesn't make sense for streaming bulk requests.
+{: .note }
+
+
+## Query parameters
+
+The following table lists the available query parameters. All query parameters are optional.
+
+Parameter | Data type | Description
+:--- | :--- | :---
+`pipeline` | String | The pipeline ID for preprocessing documents.
+`refresh` | Enum | Whether to refresh the affected shards after performing the indexing operations. Default is `false`. `true` causes the changes show up in search results immediately but degrades cluster performance. `wait_for` waits for a refresh. Requests take longer to return, but cluster performance isn't degraded.
+`require_alias` | Boolean | Set to `true` to require that all actions target an index alias rather than an index. Default is `false`.
+`routing` | String | Routes the request to the specified shard.
+`timeout` | Time | How long to wait for the request to return. Default is `1m`.
+`type` | String | (Deprecated) The default document type for documents that don't specify a type. Default is `_doc`. We highly recommend ignoring this parameter and using the `_doc` type for all indexes.
+`wait_for_active_shards` | String | Specifies the number of active shards that must be available before OpenSearch processes the bulk request. Default is `1` (only the primary shard). Set to `all` or a positive integer. Values greater than 1 require replicas. For example, if you specify a value of 3, the index must have 2 replicas distributed across 2 additional nodes in order for the request to succeed.
+`batch_interval` | Time | Specifies for how long bulk operations should be accumulated into a batch before sending the batch to data nodes.
+`batch_size` | Time | Specifies how many bulk operations should be accumulated into a batch before sending the batch to data nodes. Default is `1`.
+{% comment %}_source | List | asdf
+`_source_excludes` | List | asdf
+`_source_includes` | List | asdf{% endcomment %}
+
+## Request body
+
+The Streaming Bulk API request body is fully compatible with the [Bulk API request body]({{site.url}}{{site.baseurl}}/api-reference/document-apis/bulk/#request-body), where each bulk operation (create/index/update/delete) is sent as a separate chunk.  
+
+## Example request
+
+```json
+curl -X POST "http://localhost:9200/_bulk/stream" -H "Transfer-Encoding: chunked" -H "Content-Type: application/json" -d'
+{ "delete": { "_index": "movies", "_id": "tt2229499" } }
+{ "index": { "_index": "movies", "_id": "tt1979320" } }
+{ "title": "Rush", "year": 2013 }
+{ "create": { "_index": "movies", "_id": "tt1392214" } }
+{ "title": "Prisoners", "year": 2013 }
+{ "update": { "_index": "movies", "_id": "tt0816711" } }
+{ "doc" : { "title": "World War Z" } }
+'
+```
+{% include copy.html %}
+
+## Example response
+
+Depending on the batch settings, each streamed response chunk may report the results of one or many (batch) bulk operations. For example, for the preceding request with no batching (default), the streaming response may appear as follows:
+
+```json
+{"took": 11, "errors": false, "items": [ { "index": {"_index": "movies", "_id": "tt1979320", "_version": 1, "result": "created", "_shards": { "total": 2 "successful": 1, "failed": 0 }, "_seq_no": 1, "_primary_term": 1, "status": 201 } } ] }
+{"took": 2, "errors": true, "items": [ { "create": { "_index": "movies", "_id": "tt1392214", "status": 409, "error": { "type": "version_conflict_engine_exception", "reason": "[tt1392214]: version conflict, document already exists (current version [1])", "index": "movies", "shard": "0", "index_uuid": "yhizhusbSWmP0G7OJnmcLg" } } } ] }
+{"took": 4, "errors": true, "items": [ { "update": { "_index": "movies", "_id": "tt0816711", "status": 404, "error": { "type": "document_missing_exception", "reason": "[_doc][tt0816711]: document missing", "index": "movies", "shard": "0", "index_uuid": "yhizhusbSWmP0G7OJnmcLg" } } } ] }
+```

_api-reference/document-apis/bulk.md

@@ -53,16 +53,16 @@ All bulk URL parameters are optional.
 Parameter | Type | Description
 :--- | :--- | :---
 pipeline | String | The pipeline ID for preprocessing documents.
-refresh | Enum | Whether to refresh the affected shards after performing the indexing operations. Default is `false`. `true` makes the changes show up in search results immediately, but hurts cluster performance. `wait_for` waits for a refresh. Requests take longer to return, but cluster performance doesn't suffer.
+refresh | Enum | Whether to refresh the affected shards after performing the indexing operations. Default is `false`. `true` causes the changes show up in search results immediately but degrades cluster performance. `wait_for` waits for a refresh. Requests take longer to return, but cluster performance isn't degraded.
 require_alias | Boolean | Set to `true` to require that all actions target an index alias rather than an index. Default is `false`.
 routing | String | Routes the request to the specified shard.
-timeout | Time | How long to wait for the request to return. Default `1m`.
-type | String | (Deprecated) The default document type for documents that don't specify a type. Default is `_doc`. We highly recommend ignoring this parameter and using a type of `_doc` for all indexes.
-wait_for_active_shards | String | Specifies the number of active shards that must be available before OpenSearch processes the bulk request. Default is 1 (only the primary shard). Set to `all` or a positive integer. Values greater than 1 require replicas. For example, if you specify a value of 3, the index must have two replicas distributed across two additional nodes for the request to succeed.
+timeout | Time | How long to wait for the request to return. Default is `1m`.
+type | String | (Deprecated) The default document type for documents that don't specify a type. Default is `_doc`. We highly recommend ignoring this parameter and using the `_doc` type for all indexes.
+wait_for_active_shards | String | Specifies the number of active shards that must be available before OpenSearch processes the bulk request. Default is `1` (only the primary shard). Set to `all` or a positive integer. Values greater than 1 require replicas. For example, if you specify a value of 3, the index must have 2 replicas distributed across 2 additional nodes in order for the request to succeed.
 batch_size | Integer | **(Deprecated)** Specifies the number of documents to be batched and sent to an ingest pipeline to be processed together. Default is `2147483647` (documents are ingested by an ingest pipeline all at once). If the bulk request doesn't explicitly specify an ingest pipeline or the index doesn't have a default ingest pipeline, then this parameter is ignored. Only documents with `create`, `index`, or `update` actions can be grouped into batches.
 {% comment %}_source | List | asdf
-_source_excludes | list | asdf
-_source_includes | list | asdf{% endcomment %}
+_source_excludes | List | asdf
+_source_includes | List | asdf{% endcomment %}
 
 
 ## Request body

_field-types/supported-field-types/alias.md

@@ -10,6 +10,8 @@ redirect_from:
 ---
 
 # Alias field type
+**Introduced 1.0**
+{: .label .label-purple }
 
 An alias field type creates another name for an existing field. You can use aliases in the[search](#using-aliases-in-search-api-operations) and [field capabilities](#using-aliases-in-field-capabilities-api-operations) API operations, with some [exceptions](#exceptions). To set up an [alias](#alias-field), you need to specify the [original field](#original-field) name in the `path` parameter.
 

_field-types/supported-field-types/binary.md

@@ -10,6 +10,8 @@ redirect_from:
 ---
 
 # Binary field type
+**Introduced 1.0**
+{: .label .label-purple }
 
 A binary field type contains a binary value in [Base64](https://en.wikipedia.org/wiki/Base64) encoding that is not searchable. 
 

_field-types/supported-field-types/boolean.md

@@ -10,6 +10,8 @@ redirect_from:
 ---
 
 # Boolean field type
+**Introduced 1.0**
+{: .label .label-purple }
 
 A Boolean field type takes `true` or `false` values, or `"true"` or `"false"` strings. You can also pass an empty string (`""`) in place of a `false` value.
 

_field-types/supported-field-types/completion.md

@@ -11,6 +11,8 @@ redirect_from:
 ---
 
 # Completion field type
+**Introduced 1.0**
+{: .label .label-purple }
 
 A completion field type provides autocomplete functionality through a completion suggester. The completion suggester is a prefix suggester, so it matches the beginning of text only. A completion suggester creates an in-memory data structure, which provides faster lookups but leads to increased memory usage. You need to upload a list of all possible completions into the index before using this feature.
 

_field-types/supported-field-types/constant-keyword.md

@@ -8,6 +8,8 @@ grand_parent: Supported field types
 ---
 
 # Constant keyword field type
+**Introduced 2.14**
+{: .label .label-purple }
 
 A constant keyword field uses the same value for all documents in the index. 
 

_field-types/supported-field-types/date-nanos.md

@@ -8,6 +8,8 @@ grand_parent: Supported field types
 ---
 
 # Date nanoseconds field type
+**Introduced 1.0**
+{: .label .label-purple }
 
 The `date_nanos` field type is similar to the [`date`]({{site.url}}{{site.baseurl}}/opensearch/supported-field-types/date/) field type in that it holds a date. However, `date` stores the date in millisecond resolution, while `date_nanos` stores the date in nanosecond resolution. Dates are stored as `long` values that correspond to nanoseconds since the epoch. Therefore, the range of supported dates is approximately 1970--2262.
 

_field-types/supported-field-types/date.md

@@ -11,6 +11,8 @@ redirect_from:
 ---
 
 # Date field type
+**Introduced 1.0**
+{: .label .label-purple }
 
 A date in OpenSearch can be represented as one of the following:
 

_field-types/supported-field-types/flat-object.md

@@ -10,6 +10,8 @@ redirect_from:
 ---
 
 # Flat object field type
+**Introduced 2.7**
+{: .label .label-purple }
 
 In OpenSearch, you don't have to specify a mapping before indexing documents. If you don't specify a mapping, OpenSearch uses [dynamic mapping]({{site.url}}{{site.baseurl}}/field-types/index#dynamic-mapping) to map every field and its subfields in the document automatically. When you ingest documents such as logs, you may not know every field's subfield name and type in advance. In this case, dynamically mapping all new subfields can quickly lead to a "mapping explosion," where the growing number of fields may degrade the performance of your cluster. 
 

_field-types/supported-field-types/geo-point.md

@@ -11,6 +11,8 @@ redirect_from:
 ---
 
 # Geopoint field type
+**Introduced 1.0**
+{: .label .label-purple }
 
 A geopoint field type contains a geographic point specified by latitude and longitude. 
 

_field-types/supported-field-types/geo-shape.md

@@ -11,6 +11,8 @@ redirect_from:
 ---
 
 # Geoshape field type
+**Introduced 1.0**
+{: .label .label-purple }
 
 A geoshape field type contains a geographic shape, such as a polygon or a collection of geographic points. To index a geoshape, OpenSearch tesselates the shape into a triangular mesh and stores each triangle in a BKD tree. This provides a 10<sup>-7</sup>decimal degree of precision, which represents near-perfect spatial resolution. Performance of this process is mostly impacted by the number of vertices in a polygon you are indexing.
 

_field-types/supported-field-types/ip.md

@@ -10,6 +10,8 @@ redirect_from:
 ---
 
 # IP address field type
+**Introduced 1.0**
+{: .label .label-purple }
 
 An ip field type contains an IP address in IPv4 or IPv6 format. 
 

_field-types/supported-field-types/join.md

@@ -11,6 +11,8 @@ redirect_from:
 ---
 
 # Join field type
+**Introduced 1.0**
+{: .label .label-purple }
 
 A join field type establishes a parent/child relationship between documents in the same index. 
 

_field-types/supported-field-types/keyword.md

@@ -11,6 +11,8 @@ redirect_from:
 ---
 
 # Keyword field type
+**Introduced 1.0**
+{: .label .label-purple }
 
 A keyword field type contains a string that is not analyzed. It allows only exact, case-sensitive matches.
 

_field-types/supported-field-types/knn-vector.md

@@ -8,6 +8,8 @@ has_math: true
 ---
 
 # k-NN vector field type
+**Introduced 1.0**
+{: .label .label-purple }
 
 The [k-NN plugin]({{site.url}}{{site.baseurl}}/search-plugins/knn/index/) introduces a custom data type, the `knn_vector`, that allows users to ingest their k-NN vectors into an OpenSearch index and perform different kinds of k-NN search. The `knn_vector` field is highly configurable and can serve many different k-NN workloads. In general, a `knn_vector` field can be built either by providing a method definition or specifying a model id.
 

_field-types/supported-field-types/match-only-text.md

@@ -8,6 +8,8 @@ grand_parent: Supported field types
 ---
 
 # Match-only text field type
+**Introduced 2.12**
+{: .label .label-purple }
 
 A `match_only_text` field is a variant of a `text` field designed for full-text search when scoring and positional information of terms within a document are not critical.
 

_field-types/supported-field-types/nested.md

@@ -11,6 +11,8 @@ redirect_from:
 ---
 
 # Nested field type
+**Introduced 1.0**
+{: .label .label-purple }
 
 A nested field type is a special type of [object field type]({{site.url}}{{site.baseurl}}/opensearch/supported-field-types/object/). 
 

_field-types/supported-field-types/object.md

@@ -11,6 +11,8 @@ redirect_from:
 ---
 
 # Object field type
+**Introduced 1.0**
+{: .label .label-purple }
 
 An object field type contains a JSON object (a set of name/value pairs). A value in a JSON object may be another JSON object. It is not necessary to specify `object` as the type when mapping object fields because `object` is the default type.
 

_field-types/supported-field-types/percolator.md

@@ -10,6 +10,8 @@ redirect_from:
 ---
 
 # Percolator field type
+**Introduced 1.0**
+{: .label .label-purple }
 
 A percolator field type specifies to treat this field as a query. Any JSON object field can be marked as a percolator field. Normally, documents are indexed and searches are run against them. When you use a percolator field, you store a search, and later the percolate query matches documents to that search. 
 

_field-types/supported-field-types/range.md

@@ -10,6 +10,8 @@ redirect_from:
 ---
 
 # Range field types
+**Introduced 1.0**
+{: .label .label-purple }
 
 The following table lists all range field types that OpenSearch supports.
 

_field-types/supported-field-types/rank.md

@@ -10,6 +10,8 @@ redirect_from:
 ---
 
 # Rank field types
+**Introduced 1.0**
+{: .label .label-purple }
 
 The following table lists all rank field types that OpenSearch supports.
 

_field-types/supported-field-types/search-as-you-type.md

@@ -11,6 +11,8 @@ redirect_from:
 ---
 
 # Search-as-you-type field type
+**Introduced 1.0**
+{: .label .label-purple }
 
 A search-as-you-type field type provides search-as-you-type functionality using both prefix and infix completion. 
 

_field-types/supported-field-types/text.md

@@ -11,6 +11,8 @@ redirect_from:
 ---
 
 # Text field type
+**Introduced 1.0**
+{: .label .label-purple }
 
 A `text` field type contains a string that is analyzed. It is used for full-text search because it allows partial matches. Searches for multiple terms can match some but not all of them. Depending on the analyzer, results can be case insensitive, stemmed, have stopwords removed, have synonyms applied, and so on.
 

_field-types/supported-field-types/token-count.md

@@ -11,6 +11,8 @@ redirect_from:
 ---
 
 # Token count field type
+**Introduced 1.0**
+{: .label .label-purple }
 
 A token count field type stores the number of analyzed tokens in a string.
 

_field-types/supported-field-types/unsigned-long.md

@@ -8,6 +8,8 @@ has_children: false
 ---
 
 # Unsigned long field type
+**Introduced 2.8**
+{: .label .label-purple }
 
 The `unsigned_long` field type is a numeric field type that represents an unsigned 64-bit integer with a minimum value of 0 and a maximum value of 2<sup>64</sup> &minus; 1. In the following example, `counter` is mapped as an `unsigned_long` field:
 

_field-types/supported-field-types/wildcard.md

@@ -8,6 +8,8 @@ grand_parent: Supported field types
 ---
 
 # Wildcard field type
+**Introduced 2.15**
+{: .label .label-purple }
 
 A `wildcard` field is a variant of a `keyword` field designed for arbitrary substring and regular expression matching.
 

_field-types/supported-field-types/xy-point.md

@@ -11,6 +11,8 @@ redirect_from:
 ---
 
 # xy point field type
+**Introduced 2.4**
+{: .label .label-purple }
 
 An xy point field type contains a point in a two-dimensional Cartesian coordinate system, specified by x and y coordinates. It is based on the Lucene [XYPoint](https://lucene.apache.org/core/9_3_0/core/org/apache/lucene/geo/XYPoint.html) field type. The xy point field type is similar to the [geopoint]({{site.url}}{{site.baseurl}}/opensearch/supported-field-types/geo-point/) field type, but does not have the range limitations of geopoint. The coordinates of an xy point are single-precision floating-point values. For information about the range and precision of floating-point values, see [Numeric field types]({{site.url}}{{site.baseurl}}/opensearch/supported-field-types/numeric/).
 

_field-types/supported-field-types/xy-shape.md

@@ -11,6 +11,8 @@ redirect_from:
 ---
 
 # xy shape field type
+**Introduced 2.4**
+{: .label .label-purple }
 
 An xy shape field type contains a shape, such as a polygon or a collection of xy points. It is based on the Lucene [XYShape](https://lucene.apache.org/core/9_3_0/core/org/apache/lucene/document/XYShape.html) field type. To index an xy shape, OpenSearch tessellates the shape into a triangular mesh and stores each triangle in a BKD tree (a set of balanced k-dimensional trees). This provides a 10<sup>-7</sup>decimal degree of precision, which represents near-perfect spatial resolution.