You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/reference/api-reference.md
+56-7Lines changed: 56 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -76,6 +76,7 @@ Some of the officially supported clients provide helpers to assist with bulk req
76
76
* JavaScript: Check out `client.helpers.*`
77
77
* .NET: Check out `BulkAllObservable`
78
78
* PHP: Check out bulk indexing.
79
+
* Ruby: Check out `Elasticsearch::Helpers::BulkHelper`
79
80
80
81
**Submitting bulk requests with cURL**
81
82
@@ -1825,7 +1826,7 @@ client.termvectors({ index })
1825
1826
- **`doc` (Optional, object)**: An artificial document (a document not present in the index) for which you want to retrieve term vectors.
1826
1827
- **`filter` (Optional, { max_doc_freq, max_num_terms, max_term_freq, max_word_length, min_doc_freq, min_term_freq, min_word_length })**: Filter terms based on their tf-idf scores. This could be useful in order find out a good characteristic vector of a document. This feature works in a similar manner to the second phase of the More Like This Query.
1827
1828
- **`per_field_analyzer` (Optional, Record<string, string>)**: Override the default per-field analyzer. This is useful in order to generate term vectors in any fashion, especially when using artificial documents. When providing an analyzer for a field that already stores term vectors, the term vectors will be regenerated.
1828
-
- **`fields` (Optional, string \| string[])**: A list of fields to include in the statistics. It is used as the default list unless a specific field list is provided in the `completion_fields` or `fielddata_fields` parameters.
1829
+
- **`fields` (Optional, string[])**: A list of fields to include in the statistics. It is used as the default list unless a specific field list is provided in the `completion_fields` or `fielddata_fields` parameters.
1829
1830
- **`field_statistics` (Optional, boolean)**: If `true`, the response includes: * The document count (how many documents contain this field). * The sum of document frequencies (the sum of document frequencies for all terms in this field). * The sum of total term frequencies (the sum of total term frequencies of each term in this field).
1830
1831
- **`offsets` (Optional, boolean)**: If `true`, the response includes term offsets.
1831
1832
- **`payloads` (Optional, boolean)**: If `true`, the response includes term payloads.
- **`flat_settings` (Optional, boolean)**: If `true`, returns settings in flat format.
3490
-
- **`include_defaults` (Optional, boolean)**: If `true`, returns default cluster settings from the local node.
3491
+
- **`include_defaults` (Optional, boolean)**: If `true`, also returns default values for all other cluster settings, reflecting the values
3492
+
in the `elasticsearch.yml` file of one of the nodes in the cluster. If the nodes in your
3493
+
cluster do not all have the same values in their `elasticsearch.yml` config files then the
3494
+
values returned by this API may vary from invocation to invocation and may not reflect the
3495
+
values that Elasticsearch uses in all situations. Use the `GET _nodes/settings` API to
3496
+
fetch the settings for each individual node in your cluster.
3491
3497
- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node.
3492
3498
If no response is received before the timeout expires, the request fails and returns an error.
3493
3499
- **`timeout` (Optional, string \| -1 \| 0)**: Period to wait for a response.
@@ -6706,7 +6712,7 @@ You can use the update mapping API to:
6706
6712
- Change a field's mapping using reindexing
6707
6713
- Rename a field using a field alias
6708
6714
6709
-
Learn how to use the update mapping API with practical examples in the [Update mapping API examples](docs-content://manage-data/data-store/mapping/update-mappings-examples.md) guide.
6715
+
Learn how to use the update mapping API with practical examples in the [Update mapping API examples](https://www.elastic.co/docs/manage-data/data-store/mapping/update-mappings-examples) guide.
@@ -7667,24 +7673,26 @@ For built-in models and models uploaded through Eland, the inference APIs offer
7667
7673
However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs.
7668
7674
7669
7675
The following integrations are available through the inference API. You can find the available task types next to the integration name:
7676
+
* AI21 (`chat_completion`, `completion`)
7670
7677
* AlibabaCloud AI Search (`completion`, `rerank`, `sparse_embedding`, `text_embedding`)
- **`task_type` (Enum("completion" \| "chat_completion"))**: The type of the inference task that the model will perform.
7726
+
- **`ai21_inference_id` (string)**: The unique identifier of the inference endpoint.
7727
+
- **`service` (Enum("ai21"))**: The type of service supported for the specified task type. In this case, `ai21`.
7728
+
- **`service_settings` ({ model_id, api_key, rate_limit })**: Settings used to install the inference model. These settings are specific to the `ai21` service.
7729
+
- **`timeout` (Optional, string \| -1 \| 0)**: Specifies the amount of time to wait for the inference endpoint to be created.
- **`task_type` (Enum("text_embedding" \| "completion" \| "chat_completion"))**: The type of the inference task that the model will perform.
8205
+
- **`llama_inference_id` (string)**: The unique identifier of the inference endpoint.
8206
+
- **`service` (Enum("llama"))**: The type of service supported for the specified task type. In this case, `llama`.
8207
+
- **`service_settings` ({ url, model_id, max_input_tokens, similarity, rate_limit })**: Settings used to install the inference model. These settings are specific to the `llama` service.
0 commit comments