Skip to content

Commit

Permalink
Added introduced version labels to field types (#8227)
Browse files Browse the repository at this point in the history
Signed-off-by: Fanit Kolchina <[email protected]>
  • Loading branch information
kolchfa-aws authored Sep 12, 2024
1 parent 76486a4 commit efd0115
Show file tree
Hide file tree
Showing 27 changed files with 54 additions and 0 deletions.
2 changes: 2 additions & 0 deletions _field-types/supported-field-types/alias.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 2 additions & 0 deletions _field-types/supported-field-types/binary.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 2 additions & 0 deletions _field-types/supported-field-types/boolean.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 2 additions & 0 deletions _field-types/supported-field-types/completion.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 2 additions & 0 deletions _field-types/supported-field-types/constant-keyword.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 2 additions & 0 deletions _field-types/supported-field-types/date-nanos.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 2 additions & 0 deletions _field-types/supported-field-types/date.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
2 changes: 2 additions & 0 deletions _field-types/supported-field-types/flat-object.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 2 additions & 0 deletions _field-types/supported-field-types/geo-point.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 2 additions & 0 deletions _field-types/supported-field-types/geo-shape.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 2 additions & 0 deletions _field-types/supported-field-types/ip.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 2 additions & 0 deletions _field-types/supported-field-types/join.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 2 additions & 0 deletions _field-types/supported-field-types/keyword.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 2 additions & 0 deletions _field-types/supported-field-types/knn-vector.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 2 additions & 0 deletions _field-types/supported-field-types/match-only-text.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 2 additions & 0 deletions _field-types/supported-field-types/nested.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/).

Expand Down
2 changes: 2 additions & 0 deletions _field-types/supported-field-types/object.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 2 additions & 0 deletions _field-types/supported-field-types/percolator.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 2 additions & 0 deletions _field-types/supported-field-types/range.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 2 additions & 0 deletions _field-types/supported-field-types/rank.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 2 additions & 0 deletions _field-types/supported-field-types/search-as-you-type.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 2 additions & 0 deletions _field-types/supported-field-types/text.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 2 additions & 0 deletions _field-types/supported-field-types/token-count.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 2 additions & 0 deletions _field-types/supported-field-types/unsigned-long.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
2 changes: 2 additions & 0 deletions _field-types/supported-field-types/wildcard.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 2 additions & 0 deletions _field-types/supported-field-types/xy-point.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/).

Expand Down
2 changes: 2 additions & 0 deletions _field-types/supported-field-types/xy-shape.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down

0 comments on commit efd0115

Please sign in to comment.