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: src/Endpoints/Esql.php
+9-3Lines changed: 9 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -43,7 +43,7 @@ class Esql extends AbstractEndpoint
43
43
* error_trace?: bool, // Include the stack trace of returned errors. (DEFAULT: false)
44
44
* source?: string, // The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
45
45
* filter_path?: string|array<string>, // A comma-separated list of filters used to reduce the response.
46
-
* body: string|array<mixed>, // (REQUIRED) Use the `query` element to start a query. Use `columnar` to format the answer.. If body is a string must be a valid JSON.
46
+
* body: string|array<mixed>, // (REQUIRED) Use the `query` element to start a query. Use `columnar` to format the answer. Use the `settings` object to supply per-query settings (e.g. `time_zone`) — the request-body equivalent of in-query `SET`.. If body is a string must be a valid JSON.
47
47
* } $params
48
48
*
49
49
* @throws NoNodeAvailableException if all the hosts are offline
@@ -193,6 +193,7 @@ public function asyncQueryStop(?array $params = null)
193
193
* Delete one or more ES|QL data sources. Fails with 409 if any dataset references them.
* @internal This API is EXPERIMENTAL and may be changed or removed completely in a future release
565
571
*
566
572
* @param array{
@@ -570,7 +576,7 @@ public function putDataSource(?array $params = null)
570
576
* error_trace?: bool, // Include the stack trace of returned errors. (DEFAULT: false)
571
577
* source?: string, // The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
572
578
* filter_path?: string|array<string>, // A comma-separated list of filters used to reduce the response.
573
-
* body: string|array<mixed>, // (REQUIRED) Dataset definition: parent data_source name, resource path, optional description, and type-specific settings.. If body is a string must be a valid JSON.
579
+
* body: string|array<mixed>, // (REQUIRED) Dataset definition: parent data_source name, resource path, optional description, type-specific settings, and an optional mappings block (column types, path renames, format, _id).. If body is a string must be a valid JSON.
574
580
* } $params
575
581
*
576
582
* @throws MissingParameterException if a required parameter is missing
@@ -656,7 +662,7 @@ public function putView(?array $params = null)
656
662
* error_trace?: bool, // Include the stack trace of returned errors. (DEFAULT: false)
657
663
* source?: string, // The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
658
664
* filter_path?: string|array<string>, // A comma-separated list of filters used to reduce the response.
659
-
* body: string|array<mixed>, // (REQUIRED) Use the `query` element to start a query. Use `columnar` to format the answer.. If body is a string must be a valid JSON.
665
+
* body: string|array<mixed>, // (REQUIRED) Use the `query` element to start a query. Use `columnar` to format the answer. Use the `settings` object to supply per-query settings (e.g. `time_zone`) — the request-body equivalent of in-query `SET`.. If body is a string must be a valid JSON.
660
666
* } $params
661
667
*
662
668
* @throws NoNodeAvailableException if all the hosts are offline
Copy file name to clipboardExpand all lines: src/Endpoints/Indices.php
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -2067,7 +2067,7 @@ public function putAlias(?array $params = null)
2067
2067
* error_trace?: bool, // Include the stack trace of returned errors. (DEFAULT: false)
2068
2068
* source?: string, // The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
2069
2069
* filter_path?: string|array<string>, // A comma-separated list of filters used to reduce the response.
2070
-
* body: string|array<mixed>, // (REQUIRED) The data stream lifecycle configuration that consist of the data retention. If body is a string must be a valid JSON.
2070
+
* body: string|array<mixed>, // (REQUIRED) The data stream lifecycle configuration, supporting fields: 'enabled', 'data_retention', 'downsampling', and 'frozen_after'. If body is a string must be a valid JSON.
2071
2071
* } $params
2072
2072
*
2073
2073
* @throws MissingParameterException if a required parameter is missing
@@ -302,7 +374,7 @@ public function inference(?array $params = null)
302
374
* @param array{
303
375
* inference_id: string, // (REQUIRED) The inference Id
304
376
* task_type?: string, // The task type
305
-
* timeout?: int|string, // Specifies the amount of time to wait for the inference endpoint to be created. (DEFAULT: 30s)
377
+
* timeout?: int|string, // Specifies the amount of time to wait for the inference endpoint to be created. The default depends on the task type: 120s for `completion` and `chat_completion`, and 30s for all other task types. (DEFAULT: 30s)
306
378
* pretty?: bool, // Pretty format the returned JSON response. (DEFAULT: false)
307
379
* human?: bool, // Return human readable values for statistics. (DEFAULT: true)
308
380
* error_trace?: bool, // Include the stack trace of returned errors. (DEFAULT: false)
@@ -1371,6 +1443,46 @@ public function putOpenshiftAi(?array $params = null)
* force?: bool, // If `true`, the region policy is applied even if it would deny access to inference endpoints that are currently in use by ingest pipeline or indices.
1454
+
* pretty?: bool, // Pretty format the returned JSON response. (DEFAULT: false)
1455
+
* human?: bool, // Return human readable values for statistics. (DEFAULT: true)
1456
+
* error_trace?: bool, // Include the stack trace of returned errors. (DEFAULT: false)
1457
+
* source?: string, // The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests.
1458
+
* filter_path?: string|array<string>, // A comma-separated list of filters used to reduce the response.
1459
+
* body: string|array<mixed>, // (REQUIRED) The region policy configuration. If body is a string must be a valid JSON.
1460
+
* } $params
1461
+
*
1462
+
* @throws NoNodeAvailableException if all the hosts are offline
1463
+
* @throws ClientResponseException if the status code of response is 4xx
1464
+
* @throws ServerResponseException if the status code of response is 5xx
@@ -1634,6 +1746,7 @@ public function textEmbedding(?array $params = null)
1634
1746
* @param array{
1635
1747
* inference_id: string, // (REQUIRED) The inference Id
1636
1748
* task_type?: string, // The task type
1749
+
* timeout?: int|string, // Specifies the amount of time to wait for the inference endpoint to be updated. The default depends on the task type: 120s for `completion` and `chat_completion`, and 30s for all other task types.
1637
1750
* pretty?: bool, // Pretty format the returned JSON response. (DEFAULT: false)
1638
1751
* human?: bool, // Return human readable values for statistics. (DEFAULT: true)
1639
1752
* error_trace?: bool, // Include the stack trace of returned errors. (DEFAULT: false)
@@ -1660,7 +1773,7 @@ public function update(?array $params = null)
Copy file name to clipboardExpand all lines: src/Endpoints/Synonyms.php
+5-4Lines changed: 5 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -117,9 +117,9 @@ public function deleteSynonymRule(?array $params = null)
117
117
*
118
118
* @param array{
119
119
* id: string, // (REQUIRED) The name of the synonyms set to be retrieved
120
-
* from?: int, // The starting offset for query rules to retrieve.
121
-
* size?: int, // The max number of query rules to retrieve. (DEFAULT: 10)
122
-
* search_after?: string, // The rule ID of the last result from the previous page, for cursor-based pagination
120
+
* from?: int, // The starting offset for synonym rules to retrieve.
121
+
* size?: int, // The max number of synonym rules to retrieve. (DEFAULT: 10)
122
+
* search_after?: string, // The synonym rule ID to use as a cursor for pagination. The next page of results will start after this rule ID. This parameter cannot be used with `from`.
123
123
* pretty?: bool, // Pretty format the returned JSON response. (DEFAULT: false)
124
124
* human?: bool, // Return human readable values for statistics. (DEFAULT: true)
125
125
* error_trace?: bool, // Include the stack trace of returned errors. (DEFAULT: false)
@@ -239,6 +239,7 @@ public function getSynonymsSets(?array $params = null)
239
239
* @param array{
240
240
* id: string, // (REQUIRED) The id of the synonyms set to be created or updated
241
241
* refresh?: bool, // If `true`, the request will refresh the analyzers with the new synonyms set and wait for the new synonyms to be available before returning. If `false`, analyzers will not be reloaded with the new synonym set (DEFAULT: 1)
242
+
* append?: bool, // If `true`, the provided synonym rules are appended to the existing set, with matching IDs overwriting existing rules. If `false`, the entire synonyms set is replaced with the new synonym rules definitions.
242
243
* pretty?: bool, // Pretty format the returned JSON response. (DEFAULT: false)
243
244
* human?: bool, // Return human readable values for statistics. (DEFAULT: true)
244
245
* error_trace?: bool, // Include the stack trace of returned errors. (DEFAULT: false)
@@ -261,7 +262,7 @@ public function putSynonym(?array $params = null)
Copy file name to clipboardExpand all lines: src/Endpoints/Transform.php
+3-2Lines changed: 3 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -159,10 +159,11 @@ public function getTransform(?array $params = null)
159
159
*
160
160
* @param array{
161
161
* transform_id: string|array<string>, // (REQUIRED) Comma-separated list of transform identifiers or wildcard expressions. You can get information for all transforms by using `_all`, by specifying `*` as the `<transform_id>`, or by omitting the `<transform_id>`.
162
+
* allow_no_match?: bool, // Specifies what to do when the request: 1. Contains wildcard expressions and there are no transforms that match. 2. Contains the _all string or no identifiers and there are no matches. 3. Contains wildcard expressions and there are only partial matches. If this parameter is false, the request returns a 404 status code when there are no matches or only partial matches. (DEFAULT: 1)
163
+
* basic?: bool, // If true, the response includes `id`, `state`, `node`, `stats`, `health`, and basic `checkpointing` information (the last and next checkpoint numbers, and the next checkpoint's `position` and `progress`). Skips statistics that require heavy computations to calculate: `operations_behind`, `changes_last_detected_at`, `last_search_time`, and the checkpoint timestamps.
162
164
* from?: int, // Skips the specified number of transforms.
163
165
* size?: int, // Specifies the maximum number of transforms to obtain. (DEFAULT: 100)
164
166
* timeout?: int|string, // Controls the time to wait for the stats (DEFAULT: 30s)
165
-
* allow_no_match?: bool, // Specifies what to do when the request: 1. Contains wildcard expressions and there are no transforms that match. 2. Contains the _all string or no identifiers and there are no matches. 3. Contains wildcard expressions and there are only partial matches. If this parameter is false, the request returns a 404 status code when there are no matches or only partial matches. (DEFAULT: 1)
166
167
* pretty?: bool, // Pretty format the returned JSON response. (DEFAULT: false)
167
168
* human?: bool, // Return human readable values for statistics. (DEFAULT: true)
168
169
* error_trace?: bool, // Include the stack trace of returned errors. (DEFAULT: false)
@@ -184,7 +185,7 @@ public function getTransformStats(?array $params = null)
0 commit comments