Skip to content

Commit 3abceba

Browse files
authored
Merge branch 'main' into renovate-tweaks
2 parents e0391bb + 1a969b3 commit 3abceba

File tree

6 files changed

+319
-13
lines changed

6 files changed

+319
-13
lines changed

docs/reference/api-reference.md

Lines changed: 56 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,7 @@ Some of the officially supported clients provide helpers to assist with bulk req
7676
* JavaScript: Check out `client.helpers.*`
7777
* .NET: Check out `BulkAllObservable`
7878
* PHP: Check out bulk indexing.
79+
* Ruby: Check out `Elasticsearch::Helpers::BulkHelper`
7980

8081
**Submitting bulk requests with cURL**
8182

@@ -1825,7 +1826,7 @@ client.termvectors({ index })
18251826
- **`doc` (Optional, object)**: An artificial document (a document not present in the index) for which you want to retrieve term vectors.
18261827
- **`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.
18271828
- **`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.
18291830
- **`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).
18301831
- **`offsets` (Optional, boolean)**: If `true`, the response includes term offsets.
18311832
- **`payloads` (Optional, boolean)**: If `true`, the response includes term payloads.
@@ -3487,7 +3488,12 @@ client.cluster.getSettings({ ... })
34873488

34883489
#### Request (object) [_request_cluster.get_settings]
34893490
- **`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.
34913497
- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node.
34923498
If no response is received before the timeout expires, the request fails and returns an error.
34933499
- **`timeout` (Optional, string \| -1 \| 0)**: Period to wait for a response.
@@ -6706,7 +6712,7 @@ You can use the update mapping API to:
67066712
- Change a field's mapping using reindexing
67076713
- Rename a field using a field alias
67086714

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.
67106716

67116717
[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-mapping)
67126718

@@ -7667,24 +7673,26 @@ For built-in models and models uploaded through Eland, the inference APIs offer
76677673
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.
76687674

76697675
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`)
76707677
* AlibabaCloud AI Search (`completion`, `rerank`, `sparse_embedding`, `text_embedding`)
76717678
* Amazon Bedrock (`completion`, `text_embedding`)
76727679
* Amazon SageMaker (`chat_completion`, `completion`, `rerank`, `sparse_embedding`, `text_embedding`)
76737680
* Anthropic (`completion`)
76747681
* Azure AI Studio (`completion`, 'rerank', `text_embedding`)
76757682
* Azure OpenAI (`completion`, `text_embedding`)
76767683
* Cohere (`completion`, `rerank`, `text_embedding`)
7677-
* DeepSeek (`completion`, `chat_completion`)
7684+
* DeepSeek (`chat_completion`, `completion`)
76787685
* Elasticsearch (`rerank`, `sparse_embedding`, `text_embedding` - this service is for built-in models and models uploaded through Eland)
76797686
* ELSER (`sparse_embedding`)
76807687
* Google AI Studio (`completion`, `text_embedding`)
7681-
* Google Vertex AI (`rerank`, `text_embedding`)
7688+
* Google Vertex AI (`chat_completion`, `completion`, `rerank`, `text_embedding`)
76827689
* Hugging Face (`chat_completion`, `completion`, `rerank`, `text_embedding`)
7690+
* JinaAI (`rerank`, `text_embedding`)
7691+
* Llama (`chat_completion`, `completion`, `text_embedding`)
76837692
* Mistral (`chat_completion`, `completion`, `text_embedding`)
76847693
* OpenAI (`chat_completion`, `completion`, `text_embedding`)
7685-
* VoyageAI (`text_embedding`, `rerank`)
7694+
* VoyageAI (`rerank`, `text_embedding`)
76867695
* Watsonx inference integration (`text_embedding`)
7687-
* JinaAI (`text_embedding`, `rerank`)
76887696

76897697
[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put)
76907698

@@ -7700,6 +7708,26 @@ client.inference.put({ inference_id })
77007708
- **`inference_config` (Optional, { chunking_settings, service, service_settings, task_settings })**
77017709
- **`timeout` (Optional, string \| -1 \| 0)**: Specifies the amount of time to wait for the inference endpoint to be created.
77027710

7711+
## client.inference.putAi21 [_inference.put_ai21]
7712+
Create a AI21 inference endpoint.
7713+
7714+
Create an inference endpoint to perform an inference task with the `ai21` service.
7715+
7716+
[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-ai21)
7717+
7718+
```ts
7719+
client.inference.putAi21({ task_type, ai21_inference_id, service, service_settings })
7720+
```
7721+
7722+
### Arguments [_arguments_inference.put_ai21]
7723+
7724+
#### Request (object) [_request_inference.put_ai21]
7725+
- **`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.
7730+
77037731
## client.inference.putAlibabacloud [_inference.put_alibabacloud]
77047732
Create an AlibabaCloud AI Search inference endpoint.
77057733

@@ -8159,6 +8187,27 @@ client.inference.putJinaai({ task_type, jinaai_inference_id, service, service_se
81598187
These settings are specific to the task type you specified.
81608188
- **`timeout` (Optional, string \| -1 \| 0)**: Specifies the amount of time to wait for the inference endpoint to be created.
81618189

8190+
## client.inference.putLlama [_inference.put_llama]
8191+
Create a Llama inference endpoint.
8192+
8193+
Create an inference endpoint to perform an inference task with the `llama` service.
8194+
8195+
[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-llama)
8196+
8197+
```ts
8198+
client.inference.putLlama({ task_type, llama_inference_id, service, service_settings })
8199+
```
8200+
8201+
### Arguments [_arguments_inference.put_llama]
8202+
8203+
#### Request (object) [_request_inference.put_llama]
8204+
- **`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.
8208+
- **`chunking_settings` (Optional, { max_chunk_size, overlap, sentence_overlap, separator_group, separators, strategy })**: The chunking configuration object.
8209+
- **`timeout` (Optional, string \| -1 \| 0)**: Specifies the amount of time to wait for the inference endpoint to be created.
8210+
81628211
## client.inference.putMistral [_inference.put_mistral]
81638212
Create a Mistral inference endpoint.
81648213

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@
6363
"@sinonjs/fake-timers": "14.0.0",
6464
"@types/debug": "4.1.12",
6565
"@types/ms": "2.1.0",
66-
"@types/node": "22.17.0",
66+
"@types/node": "22.17.1",
6767
"@types/sinonjs__fake-timers": "8.1.5",
6868
"@types/split2": "4.2.3",
6969
"@types/stoppable": "1.1.3",

0 commit comments

Comments
 (0)