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.asciidoc
+7-44
Original file line number
Diff line number
Diff line change
@@ -1729,7 +1729,7 @@ client.search({ ... })
1729
1729
** *`docvalue_fields` (Optional, { field, format, include_unmapped }[])*: An array of wildcard (`*`) field patterns. The request returns doc values for field names matching these patterns in the `hits.fields` property of the response.
** *`rank` (Optional, { rrf })*: The Reciprocal Rank Fusion (RRF) to use.
1732
-
** *`min_score` (Optional, number)*: The minimum `_score` for matching documents. Documents with a lower `_score` are not included in the search results.
1732
+
** *`min_score` (Optional, number)*: The minimum `_score` for matching documents. Documents with a lower `_score` are not included in search results and results collected by aggregations.
1733
1733
** *`post_filter` (Optional, { bool, boosting, common, combined_fields, constant_score, dis_max, distance_feature, exists, function_score, fuzzy, geo_bounding_box, geo_distance, geo_grid, geo_polygon, geo_shape, has_child, has_parent, ids, intervals, knn, match, match_all, match_bool_prefix, match_none, match_phrase, match_phrase_prefix, more_like_this, multi_match, nested, parent_id, percolate, pinned, prefix, query_string, range, rank_feature, regexp, rule, script, script_score, semantic, shape, simple_query_string, span_containing, span_field_masking, span_first, span_multi, span_near, span_not, span_or, span_term, span_within, sparse_vector, term, terms, terms_set, text_expansion, weighted_tokens, wildcard, wrapper, type })*: Use the `post_filter` parameter to filter search results. The search hits are filtered after the aggregations are calculated. A post filter has no impact on the aggregation results.
1734
1734
** *`profile` (Optional, boolean)*: Set to `true` to return detailed timing information about the execution of individual components in a search request. NOTE: This is a debugging tool and adds significant overhead to search execution.
** *`task_type` (Enum("chat_completion"))*: The type of the inference task that the model will perform.
8300
-
NOTE: The `chat_completion` task type only supports streaming and only through the _stream API.
8301
-
** *`eis_inference_id` (string)*: The unique identifier of the inference endpoint.
8302
-
** *`service` (Enum("elastic"))*: The type of service supported for the specified task type. In this case, `elastic`.
8303
-
** *`service_settings` ({ model_id, rate_limit })*: Settings used to install the inference model. These settings are specific to the `elastic` service.
8304
-
8305
8265
[discrete]
8306
8266
==== put_elasticsearch
8307
8267
Create an Elasticsearch inference endpoint.
@@ -16420,7 +16380,10 @@ To indicate that the request should never timeout, set it to `-1`.
16420
16380
Update Watcher index settings.
16421
16381
Update settings for the Watcher internal index (`.watches`).
16422
16382
Only a subset of settings can be modified.
16423
-
This includes `index.auto_expand_replicas` and `index.number_of_replicas`.
16383
+
This includes `index.auto_expand_replicas`, `index.number_of_replicas`, `index.routing.allocation.exclude.*`,
16384
+
`index.routing.allocation.include.*` and `index.routing.allocation.require.*`.
16385
+
Modification of `index.routing.allocation.include._tier_preference` is an exception and is not allowed as the
16386
+
Watcher shards must always be in the `data_content` tier.
returnawaitthis.transport.request({ path, method, querystring, body, meta },options)
247
-
}
248
-
249
212
/**
250
213
* Create an inference endpoint. When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running. After creating the endpoint, wait for the model deployment to complete before using it. To verify the deployment status, use the get trained model statistics API. Look for `"state": "fully_allocated"` in the response and ensure that the `"allocation_count"` matches the `"target_allocation_count"`. Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources. IMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Mistral, Azure OpenAI, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. 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.
251
214
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.x/put-inference-api.html | Elasticsearch API documentation}
@@ -561,51 +524,6 @@ export default class Inference {
561
524
returnawaitthis.transport.request({ path, method, querystring, body, meta },options)
562
525
}
563
526
564
-
/**
565
-
* Create an Elastic Inference Service (EIS) inference endpoint. Create an inference endpoint to perform an inference task through the Elastic Inference Service (EIS).
566
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.x/infer-service-elastic.html | Elasticsearch API documentation}
returnawaitthis.transport.request({ path, method, querystring, body, meta },options)
607
-
}
608
-
609
527
/**
610
528
* Create an Elasticsearch inference endpoint. Create an inference endpoint to perform an inference task with the `elasticsearch` service. > info > Your Elasticsearch deployment contains preconfigured ELSER and E5 inference endpoints, you only need to create the enpoints using the API if you want to customize the settings. If you use the ELSER or the E5 model through the `elasticsearch` service, the API request will automatically download and deploy the model if it isn't downloaded yet. > info > You might see a 502 bad gateway error in the response when using the Kibana Console. This error usually just reflects a timeout, while the model downloads in the background. You can check the download progress in the Machine Learning UI. If using the Python client, you can set the timeout parameter to a higher value. After creating the endpoint, wait for the model deployment to complete before using it. To verify the deployment status, use the get trained model statistics API. Look for `"state": "fully_allocated"` in the response and ensure that the `"allocation_count"` matches the `"target_allocation_count"`. Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.
611
529
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.x/infer-service-elasticsearch.html | Elasticsearch API documentation}
Copy file name to clipboardExpand all lines: src/api/api/watcher.ts
+1-1
Original file line number
Diff line number
Diff line change
@@ -481,7 +481,7 @@ export default class Watcher {
481
481
}
482
482
483
483
/**
484
-
* Update Watcher index settings. Update settings for the Watcher internal index (`.watches`). Only a subset of settings can be modified. This includes `index.auto_expand_replicas`and `index.number_of_replicas`.
484
+
* Update Watcher index settings. Update settings for the Watcher internal index (`.watches`). Only a subset of settings can be modified. This includes `index.auto_expand_replicas`, `index.number_of_replicas`, `index.routing.allocation.exclude.*`, `index.routing.allocation.include.*` and `index.routing.allocation.require.*`. Modification of `index.routing.allocation.include._tier_preference` is an exception and is not allowed as the Watcher shards must always be in the `data_content` tier.
485
485
* @see {@link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-watcher-update-settings | Elasticsearch API documentation}
0 commit comments