Skip to content

Commit 4fd0170

Browse files
Auto-generated API code (#3049)
1 parent e0353e7 commit 4fd0170

File tree

3 files changed

+303
-49
lines changed

3 files changed

+303
-49
lines changed

docs/reference/api-reference.md

Lines changed: 23 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1514,7 +1514,7 @@ client.search({ ... })
15141514
- **`track_total_hits` (Optional, boolean \| number)**: Number of hits matching the query to count accurately. If `true`, the exact number of hits is returned at the cost of some performance. If `false`, the response does not include the total number of hits matching the query.
15151515
- **`indices_boost` (Optional, Record<string, number>[])**: Boost the `_score` of documents from specified indices. The boost value is the factor by which scores are multiplied. A boost value greater than `1.0` increases the score. A boost value between `0` and `1.0` decreases the score.
15161516
- **`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.
1517-
- **`knn` (Optional, { field, query_vector, query_vector_builder, k, num_candidates, boost, filter, similarity, inner_hits, rescore_vector } \| { field, query_vector, query_vector_builder, k, num_candidates, boost, filter, similarity, inner_hits, rescore_vector }[])**: The approximate kNN search to run.
1517+
- **`knn` (Optional, { field, query_vector, query_vector_builder, k, num_candidates, visit_percentage, boost, filter, similarity, inner_hits, rescore_vector } \| { field, query_vector, query_vector_builder, k, num_candidates, visit_percentage, boost, filter, similarity, inner_hits, rescore_vector }[])**: The approximate kNN search to run.
15181518
- **`rank` (Optional, { rrf })**: The Reciprocal Rank Fusion (RRF) to use.
15191519
- **`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.
15201520
- **`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.
@@ -2160,7 +2160,7 @@ Defaults to 10,000 hits.
21602160
- **`indices_boost` (Optional, Record<string, number>[])**: Boosts the _score of documents from specified indices.
21612161
- **`docvalue_fields` (Optional, { field, format, include_unmapped }[])**: Array of wildcard (*) patterns. The request returns doc values for field
21622162
names matching these patterns in the hits.fields property of the response.
2163-
- **`knn` (Optional, { field, query_vector, query_vector_builder, k, num_candidates, boost, filter, similarity, inner_hits, rescore_vector } \| { field, query_vector, query_vector_builder, k, num_candidates, boost, filter, similarity, inner_hits, rescore_vector }[])**: Defines the approximate kNN search to run.
2163+
- **`knn` (Optional, { field, query_vector, query_vector_builder, k, num_candidates, visit_percentage, boost, filter, similarity, inner_hits, rescore_vector } \| { field, query_vector, query_vector_builder, k, num_candidates, visit_percentage, boost, filter, similarity, inner_hits, rescore_vector }[])**: Defines the approximate kNN search to run.
21642164
- **`min_score` (Optional, number)**: Minimum _score for matching documents. Documents with a lower _score are
21652165
not included in search results and results collected by aggregations.
21662166
- **`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 })**
@@ -5634,6 +5634,16 @@ client.indices.deleteIndexTemplate({ name })
56345634
- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.
56355635
- **`timeout` (Optional, string \| -1 \| 0)**: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.
56365636

5637+
## client.indices.deleteSampleConfiguration [_indices.delete_sample_configuration]
5638+
Delete sampling configuration for an index or data stream
5639+
5640+
[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-delete-sample-configuration)
5641+
5642+
```ts
5643+
client.indices.deleteSampleConfiguration()
5644+
```
5645+
5646+
56375647
## client.indices.deleteTemplate [_indices.delete_template]
56385648
Delete a legacy index template.
56395649
IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.
@@ -6219,23 +6229,13 @@ client.indices.getMigrateReindexStatus({ index })
62196229
#### Request (object) [_request_indices.get_migrate_reindex_status]
62206230
- **`index` (string \| string[])**: The index or data stream name.
62216231

6222-
## client.indices.getSample [_indices.get_sample]
6223-
Get random sample of ingested data
6232+
## client.indices.getSampleConfiguration [_indices.get_sample_configuration]
6233+
Get sampling configuration for an index or data stream
62246234

6225-
[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-sample)
6235+
[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-sample-configuration)
62266236

62276237
```ts
6228-
client.indices.getSample()
6229-
```
6230-
6231-
6232-
## client.indices.getSampleStats [_indices.get_sample_stats]
6233-
Get stats about a random sample of ingested data
6234-
6235-
[Endpoint documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-get-sample)
6236-
6237-
```ts
6238-
client.indices.getSampleStats()
6238+
client.indices.getSampleConfiguration()
62396239
```
62406240

62416241

@@ -7966,7 +7966,7 @@ client.inference.putCustom({ task_type, custom_inference_id, service, service_se
79667966
- **`task_type` (Enum("text_embedding" \| "sparse_embedding" \| "rerank" \| "completion"))**: The type of the inference task that the model will perform.
79677967
- **`custom_inference_id` (string)**: The unique identifier of the inference endpoint.
79687968
- **`service` (Enum("custom"))**: The type of service supported for the specified task type. In this case, `custom`.
7969-
- **`service_settings` ({ headers, input_type, query_parameters, request, response, secret_parameters, url })**: Settings used to install the inference model.
7969+
- **`service_settings` ({ batch_size, headers, input_type, query_parameters, request, response, secret_parameters, url })**: Settings used to install the inference model.
79707970
These settings are specific to the `custom` service.
79717971
- **`chunking_settings` (Optional, { max_chunk_size, overlap, sentence_overlap, separator_group, separators, strategy })**: The chunking configuration object.
79727972
- **`task_settings` (Optional, { parameters })**: Settings to configure the inference task.
@@ -8025,8 +8025,10 @@ client.inference.putElasticsearch({ task_type, elasticsearch_inference_id, servi
80258025
- **`elasticsearch_inference_id` (string)**: The unique identifier of the inference endpoint.
80268026
The must not match the `model_id`.
80278027
- **`service` (Enum("elasticsearch"))**: The type of service supported for the specified task type. In this case, `elasticsearch`.
8028-
- **`service_settings` ({ adaptive_allocations, deployment_id, model_id, num_allocations, num_threads })**: Settings used to install the inference model. These settings are specific to the `elasticsearch` service.
8028+
- **`service_settings` ({ adaptive_allocations, deployment_id, model_id, num_allocations, num_threads, long_document_strategy, max_chunks_per_doc })**: Settings used to install the inference model. These settings are specific to the `elasticsearch` service.
80298029
- **`chunking_settings` (Optional, { max_chunk_size, overlap, sentence_overlap, separator_group, separators, strategy })**: The chunking configuration object.
8030+
Applies only to the `sparse_embedding` and `text_embedding` task types.
8031+
Not applicable to the `rerank`, `completion`, or `chat_completion` task types.
80308032
- **`task_settings` (Optional, { return_documents })**: Settings to configure the inference task.
80318033
These settings are specific to the task type you specified.
80328034
- **`timeout` (Optional, string \| -1 \| 0)**: Specifies the amount of time to wait for the inference endpoint to be created.
@@ -8105,9 +8107,9 @@ client.inference.putGooglevertexai({ task_type, googlevertexai_inference_id, ser
81058107
- **`task_type` (Enum("rerank" \| "text_embedding" \| "completion" \| "chat_completion"))**: The type of the inference task that the model will perform.
81068108
- **`googlevertexai_inference_id` (string)**: The unique identifier of the inference endpoint.
81078109
- **`service` (Enum("googlevertexai"))**: The type of service supported for the specified task type. In this case, `googlevertexai`.
8108-
- **`service_settings` ({ location, model_id, project_id, rate_limit, service_account_json, dimensions })**: Settings used to install the inference model. These settings are specific to the `googlevertexai` service.
8110+
- **`service_settings` ({ provider, url, streaming_url, location, model_id, project_id, rate_limit, service_account_json, dimensions })**: Settings used to install the inference model. These settings are specific to the `googlevertexai` service.
81098111
- **`chunking_settings` (Optional, { max_chunk_size, overlap, sentence_overlap, separator_group, separators, strategy })**: The chunking configuration object.
8110-
- **`task_settings` (Optional, { auto_truncate, top_n, thinking_config })**: Settings to configure the inference task.
8112+
- **`task_settings` (Optional, { auto_truncate, top_n, thinking_config, max_tokens })**: Settings to configure the inference task.
81118113
These settings are specific to the task type you specified.
81128114
- **`timeout` (Optional, string \| -1 \| 0)**: Specifies the amount of time to wait for the inference endpoint to be created.
81138115

@@ -8257,7 +8259,7 @@ NOTE: The `chat_completion` task type only supports streaming and only through t
82578259
- **`service` (Enum("openai"))**: The type of service supported for the specified task type. In this case, `openai`.
82588260
- **`service_settings` ({ api_key, dimensions, model_id, organization_id, rate_limit, url })**: Settings used to install the inference model. These settings are specific to the `openai` service.
82598261
- **`chunking_settings` (Optional, { max_chunk_size, overlap, sentence_overlap, separator_group, separators, strategy })**: The chunking configuration object.
8260-
- **`task_settings` (Optional, { user })**: Settings to configure the inference task.
8262+
- **`task_settings` (Optional, { user, headers })**: Settings to configure the inference task.
82618263
These settings are specific to the task type you specified.
82628264
- **`timeout` (Optional, string \| -1 \| 0)**: Specifies the amount of time to wait for the inference endpoint to be created.
82638265

0 commit comments

Comments
 (0)