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
+12-13Lines changed: 12 additions & 13 deletions
Original file line number
Diff line number
Diff line change
@@ -831,7 +831,6 @@ client.getSource({ id, index })
831
831
- **`_source` (Optional, boolean \| string \| string[])**: Indicates whether to return the `_source` field (`true` or `false`) or lists the fields to return.
832
832
- **`_source_excludes` (Optional, string \| string[])**: A list of source fields to exclude in the response.
833
833
- **`_source_includes` (Optional, string \| string[])**: A list of source fields to include in the response.
834
-
- **`stored_fields` (Optional, string \| string[])**: A list of stored fields to return as part of a hit.
835
834
- **`version` (Optional, number)**: The version number for concurrency control. It must match the current version of the document for the request to succeed.
836
835
- **`version_type` (Optional, Enum("internal" \| "external" \| "external_gte" \| "force"))**: The version type.
837
836
@@ -1014,6 +1013,7 @@ client.index({ index })
1014
1013
- **`version_type` (Optional, Enum("internal" \| "external" \| "external_gte" \| "force"))**: The version type.
1015
1014
- **`wait_for_active_shards` (Optional, number \| Enum("all" \| "index-setting"))**: The number of shard copies that must be active before proceeding with the operation. You can set it to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). The default value of `1` means it waits for each primary shard to be active.
1016
1015
- **`require_alias` (Optional, boolean)**: If `true`, the destination must be an index alias.
1016
+
- **`require_data_stream` (Optional, boolean)**: If `true`, the request's actions must target a data stream (existing or to be created).
- **`name` (Optional, string)**: List of component template names used to limit the request.
3465
3465
Wildcard (`*`) expressions are supported.
3466
3466
- **`flat_settings` (Optional, boolean)**: If `true`, returns settings in flat format.
3467
+
- **`settings_filter` (Optional, string \| string[])**: Filter out results, for example to filter out sensitive information. Supports wildcards or full settings keys
3467
3468
- **`include_defaults` (Optional, boolean)**: Return all default configurations for the component template (default: false)
3468
3469
- **`local` (Optional, boolean)**: If `true`, the request retrieves information from the local node only.
3469
3470
If `false`, information is retrieved from the master node.
@@ -3648,6 +3649,7 @@ To unset `_meta`, replace the template without specifying this information.
3648
3649
- **`deprecated` (Optional, boolean)**: Marks this index template as deprecated. When creating or updating a non-deprecated index template
3649
3650
that uses deprecated components, Elasticsearch will emit a deprecation warning.
3650
3651
- **`create` (Optional, boolean)**: If `true`, this request cannot replace or update existing component templates.
3652
+
- **`cause` (Optional, string)**: User defined reason for create the component template.
3651
3653
- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node.
3652
3654
If no response is received before the timeout expires, the request fails and returns an error.
3653
3655
@@ -7858,7 +7860,7 @@ The only valid task type for the model to perform is `text_embedding`.
7858
7860
- **`service_settings` ({ api_key, api_version, model_id, project_id, rate_limit, url })**: Settings used to install the inference model. These settings are specific to the `watsonxai` service.
- **`application` (Optional, string)**: The name of the application. Application privileges are always associated with exactly one application. If you do not specify this parameter, the API returns information about all privileges for all applications.
12017
-
- **`priviledge` (Optional, string)**: The name of the privilege. If you do not specify this parameter, the API returns information about all privileges for the requested application.
0 commit comments