Auto-generated code for 8.16 (#2538)
This commit is contained in:
Elastic Machine
@ -10,7 +10,7 @@ const response = await client.ingest.putPipeline({
|
||||
{
|
||||
attachment: {
|
||||
field: "data",
|
||||
remove_binary: false,
|
||||
remove_binary: true,
|
||||
},
|
||||
},
|
||||
],
|
||||
35
docs/doc_examples/2a67608dadbf220a2f040f3a79d3677d.asciidoc
Normal file
35
docs/doc_examples/2a67608dadbf220a2f040f3a79d3677d.asciidoc
Normal file
@ -0,0 +1,35 @@
|
||||
// This file is autogenerated, DO NOT EDIT
|
||||
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
|
||||
|
||||
[source, js]
|
||||
----
|
||||
const response = await client.ingest.putPipeline({
|
||||
id: "attachment",
|
||||
description: "Extract attachment information including original binary",
|
||||
processors: [
|
||||
{
|
||||
attachment: {
|
||||
field: "data",
|
||||
remove_binary: false,
|
||||
},
|
||||
},
|
||||
],
|
||||
});
|
||||
console.log(response);
|
||||
|
||||
const response1 = await client.index({
|
||||
index: "my-index-000001",
|
||||
id: "my_id",
|
||||
pipeline: "attachment",
|
||||
document: {
|
||||
data: "e1xydGYxXGFuc2kNCkxvcmVtIGlwc3VtIGRvbG9yIHNpdCBhbWV0DQpccGFyIH0=",
|
||||
},
|
||||
});
|
||||
console.log(response1);
|
||||
|
||||
const response2 = await client.get({
|
||||
index: "my-index-000001",
|
||||
id: "my_id",
|
||||
});
|
||||
console.log(response2);
|
||||
----
|
||||
@ -10,7 +10,8 @@ const response = await client.inference.put({
|
||||
service: "openai",
|
||||
service_settings: {
|
||||
api_key: "<api_key>",
|
||||
model_id: "text-embedding-ada-002",
|
||||
model_id: "text-embedding-3-small",
|
||||
dimensions: 128,
|
||||
},
|
||||
},
|
||||
});
|
||||
@ -1,17 +0,0 @@
|
||||
// This file is autogenerated, DO NOT EDIT
|
||||
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
|
||||
|
||||
[source, js]
|
||||
----
|
||||
const response = await client.knnSearch({
|
||||
index: "my-index",
|
||||
knn: {
|
||||
field: "image_vector",
|
||||
query_vector: [0.3, 0.1, 1.2],
|
||||
k: 10,
|
||||
num_candidates: 100,
|
||||
},
|
||||
_source: ["name", "file_type"],
|
||||
});
|
||||
console.log(response);
|
||||
----
|
||||
18
docs/doc_examples/53d9d2ec9cb8d211772d764e76fe6890.asciidoc
Normal file
18
docs/doc_examples/53d9d2ec9cb8d211772d764e76fe6890.asciidoc
Normal file
@ -0,0 +1,18 @@
|
||||
// This file is autogenerated, DO NOT EDIT
|
||||
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
|
||||
|
||||
[source, js]
|
||||
----
|
||||
const response = await client.ingest.simulate({
|
||||
id: "query_helper_pipeline",
|
||||
docs: [
|
||||
{
|
||||
_source: {
|
||||
content:
|
||||
"artificial intelligence in medicine articles published in the last 12 months",
|
||||
},
|
||||
},
|
||||
],
|
||||
});
|
||||
console.log(response);
|
||||
----
|
||||
@ -1,22 +0,0 @@
|
||||
// This file is autogenerated, DO NOT EDIT
|
||||
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
|
||||
|
||||
[source, js]
|
||||
----
|
||||
const response = await client.indices.create({
|
||||
index: "semantic-embeddings",
|
||||
mappings: {
|
||||
properties: {
|
||||
semantic_text: {
|
||||
type: "semantic_text",
|
||||
inference_id: "my-elser-endpoint",
|
||||
},
|
||||
content: {
|
||||
type: "text",
|
||||
copy_to: "semantic_text",
|
||||
},
|
||||
},
|
||||
},
|
||||
});
|
||||
console.log(response);
|
||||
----
|
||||
@ -12,7 +12,7 @@ const response = await client.ingest.putPipeline({
|
||||
field: "data",
|
||||
indexed_chars: 11,
|
||||
indexed_chars_field: "max_size",
|
||||
remove_binary: false,
|
||||
remove_binary: true,
|
||||
},
|
||||
},
|
||||
],
|
||||
@ -1,22 +0,0 @@
|
||||
// This file is autogenerated, DO NOT EDIT
|
||||
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
|
||||
|
||||
[source, js]
|
||||
----
|
||||
const response = await client.inference.put({
|
||||
task_type: "sparse_embedding",
|
||||
inference_id: "my-elser-endpoint",
|
||||
inference_config: {
|
||||
service: "elser",
|
||||
service_settings: {
|
||||
adaptive_allocations: {
|
||||
enabled: true,
|
||||
min_number_of_allocations: 3,
|
||||
max_number_of_allocations: 10,
|
||||
},
|
||||
num_threads: 1,
|
||||
},
|
||||
},
|
||||
});
|
||||
console.log(response);
|
||||
----
|
||||
32
docs/doc_examples/931817b168e055ecf738785c721125dd.asciidoc
Normal file
32
docs/doc_examples/931817b168e055ecf738785c721125dd.asciidoc
Normal file
@ -0,0 +1,32 @@
|
||||
// This file is autogenerated, DO NOT EDIT
|
||||
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
|
||||
|
||||
[source, js]
|
||||
----
|
||||
const response = await client.ingest.putPipeline({
|
||||
id: "query_helper_pipeline",
|
||||
processors: [
|
||||
{
|
||||
script: {
|
||||
source:
|
||||
"ctx.prompt = 'Please generate an elasticsearch search query on index `articles_index` for the following natural language query. Dates are in the field `@timestamp`, document types are in the field `type` (options are `news`, `publication`), categories in the field `category` and can be multiple (options are `medicine`, `pharmaceuticals`, `technology`), and document names are in the field `title` which should use a fuzzy match. Ignore fields which cannot be determined from the natural language query context: ' + ctx.content",
|
||||
},
|
||||
},
|
||||
{
|
||||
inference: {
|
||||
model_id: "openai_chat_completions",
|
||||
input_output: {
|
||||
input_field: "prompt",
|
||||
output_field: "query",
|
||||
},
|
||||
},
|
||||
},
|
||||
{
|
||||
remove: {
|
||||
field: "prompt",
|
||||
},
|
||||
},
|
||||
],
|
||||
});
|
||||
console.log(response);
|
||||
----
|
||||
@ -9,7 +9,7 @@ const response = await client.indices.create({
|
||||
properties: {
|
||||
infer_field: {
|
||||
type: "semantic_text",
|
||||
inference_id: "my-elser-endpoint",
|
||||
inference_id: ".elser-2-elasticsearch",
|
||||
},
|
||||
source_field: {
|
||||
type: "text",
|
||||
@ -14,7 +14,7 @@ const response = await client.ingest.putPipeline({
|
||||
attachment: {
|
||||
target_field: "_ingest._value.attachment",
|
||||
field: "_ingest._value.data",
|
||||
remove_binary: false,
|
||||
remove_binary: true,
|
||||
},
|
||||
},
|
||||
},
|
||||
24
docs/doc_examples/d29031409016b2b798148ef173a196ae.asciidoc
Normal file
24
docs/doc_examples/d29031409016b2b798148ef173a196ae.asciidoc
Normal file
@ -0,0 +1,24 @@
|
||||
// This file is autogenerated, DO NOT EDIT
|
||||
// Use `node scripts/generate-docs-examples.js` to generate the docs examples
|
||||
|
||||
[source, js]
|
||||
----
|
||||
const response = await client.indices.create({
|
||||
index: "test-index",
|
||||
query: {
|
||||
semantic: {
|
||||
field: "my_semantic_field",
|
||||
},
|
||||
},
|
||||
highlight: {
|
||||
fields: {
|
||||
my_semantic_field: {
|
||||
type: "semantic",
|
||||
number_of_fragments: 2,
|
||||
order: "score",
|
||||
},
|
||||
},
|
||||
},
|
||||
});
|
||||
console.log(response);
|
||||
----
|
||||
@ -10,7 +10,7 @@ const response = await client.ingest.putPipeline({
|
||||
{
|
||||
attachment: {
|
||||
field: "data",
|
||||
remove_binary: false,
|
||||
remove_binary: true,
|
||||
},
|
||||
},
|
||||
],
|
||||
@ -11,7 +11,7 @@ const response = await client.ingest.putPipeline({
|
||||
attachment: {
|
||||
field: "data",
|
||||
properties: ["content", "title"],
|
||||
remove_binary: false,
|
||||
remove_binary: true,
|
||||
},
|
||||
},
|
||||
],
|
||||
@ -12,7 +12,7 @@ const response = await client.ingest.putPipeline({
|
||||
field: "data",
|
||||
indexed_chars: 11,
|
||||
indexed_chars_field: "max_size",
|
||||
remove_binary: false,
|
||||
remove_binary: true,
|
||||
},
|
||||
},
|
||||
],
|
||||
@ -96,7 +96,8 @@ client.closePointInTime({ id })
|
||||
|
||||
[discrete]
|
||||
=== count
|
||||
Returns number of documents matching a query.
|
||||
Count search results.
|
||||
Get the number of documents matching a query.
|
||||
|
||||
{ref}/search-count.html[Endpoint documentation]
|
||||
[source,ts]
|
||||
@ -3563,7 +3564,8 @@ client.enrich.deletePolicy({ name })
|
||||
|
||||
[discrete]
|
||||
==== execute_policy
|
||||
Creates the enrich index for an existing enrich policy.
|
||||
Run an enrich policy.
|
||||
Create the enrich index for an existing enrich policy.
|
||||
|
||||
{ref}/execute-enrich-policy-api.html[Endpoint documentation]
|
||||
[source,ts]
|
||||
@ -3632,7 +3634,8 @@ client.enrich.stats()
|
||||
=== eql
|
||||
[discrete]
|
||||
==== delete
|
||||
Deletes an async EQL search or a stored synchronous EQL search.
|
||||
Delete an async EQL search.
|
||||
Delete an async EQL search or a stored synchronous EQL search.
|
||||
The API also deletes results for the search.
|
||||
|
||||
{ref}/eql-search-api.html[Endpoint documentation]
|
||||
@ -3651,7 +3654,8 @@ A search ID is also provided if the request’s `keep_on_completion` parameter i
|
||||
|
||||
[discrete]
|
||||
==== get
|
||||
Returns the current status and available results for an async EQL search or a stored synchronous EQL search.
|
||||
Get async EQL search results.
|
||||
Get the current status and available results for an async EQL search or a stored synchronous EQL search.
|
||||
|
||||
{ref}/get-async-eql-search-api.html[Endpoint documentation]
|
||||
[source,ts]
|
||||
@ -3671,7 +3675,8 @@ Defaults to no timeout, meaning the request waits for complete search results.
|
||||
|
||||
[discrete]
|
||||
==== get_status
|
||||
Returns the current status for an async EQL search or a stored synchronous EQL search without returning results.
|
||||
Get the async EQL status.
|
||||
Get the current status for an async EQL search or a stored synchronous EQL search without returning results.
|
||||
|
||||
{ref}/get-async-eql-status-api.html[Endpoint documentation]
|
||||
[source,ts]
|
||||
@ -3687,7 +3692,9 @@ client.eql.getStatus({ id })
|
||||
|
||||
[discrete]
|
||||
==== search
|
||||
Returns results matching a query expressed in Event Query Language (EQL)
|
||||
Get EQL search results.
|
||||
Returns search results for an Event Query Language (EQL) query.
|
||||
EQL assumes each document in a data stream or index corresponds to an event.
|
||||
|
||||
{ref}/eql-search-api.html[Endpoint documentation]
|
||||
[source,ts]
|
||||
@ -3744,7 +3751,8 @@ client.esql.asyncQueryGet()
|
||||
|
||||
[discrete]
|
||||
==== query
|
||||
Executes an ES|QL request
|
||||
Run an ES|QL query.
|
||||
Get search results for an ES|QL (Elasticsearch query language) query.
|
||||
|
||||
{ref}/esql-rest.html[Endpoint documentation]
|
||||
[source,ts]
|
||||
@ -3963,7 +3971,12 @@ which is true by default.
|
||||
=== graph
|
||||
[discrete]
|
||||
==== explore
|
||||
Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index.
|
||||
Explore graph analytics.
|
||||
Extract and summarize information about the documents and terms in an Elasticsearch data stream or index.
|
||||
The easiest way to understand the behavior of this API is to use the Graph UI to explore connections.
|
||||
An initial request to the `_explore` API contains a seed query that identifies the documents of interest and specifies the fields that define the vertices and connections you want to include in the graph.
|
||||
Subsequent requests enable you to spider out from one more vertices of interest.
|
||||
You can exclude vertices that have already been returned.
|
||||
|
||||
{ref}/graph-explore-api.html[Endpoint documentation]
|
||||
[source,ts]
|
||||
@ -4633,7 +4646,8 @@ Valid values are: `all`, `open`, `closed`, `hidden`, `none`.
|
||||
|
||||
[discrete]
|
||||
==== exists_index_template
|
||||
Returns information about whether a particular index template exists.
|
||||
Check index templates.
|
||||
Check whether index templates exist.
|
||||
|
||||
{ref}/index-templates.html[Endpoint documentation]
|
||||
[source,ts]
|
||||
@ -5447,7 +5461,8 @@ Valid values are: `all`, `open`, `closed`, `hidden`, `none`.
|
||||
|
||||
[discrete]
|
||||
==== resolve_index
|
||||
Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams.
|
||||
Resolve indices.
|
||||
Resolve the names and/or index patterns for indices, aliases, and data streams.
|
||||
Multiple patterns and remote clusters are supported.
|
||||
|
||||
{ref}/indices-resolve-index-api.html[Endpoint documentation]
|
||||
@ -5884,7 +5899,8 @@ client.inference.streamInference()
|
||||
=== ingest
|
||||
[discrete]
|
||||
==== delete_geoip_database
|
||||
Deletes a geoip database configuration.
|
||||
Delete GeoIP database configurations.
|
||||
Delete one or more IP geolocation database configurations.
|
||||
|
||||
{ref}/delete-geoip-database-api.html[Endpoint documentation]
|
||||
[source,ts]
|
||||
@ -5914,7 +5930,8 @@ client.ingest.deleteIpLocationDatabase()
|
||||
|
||||
[discrete]
|
||||
==== delete_pipeline
|
||||
Deletes one or more existing ingest pipeline.
|
||||
Delete pipelines.
|
||||
Delete one or more ingest pipelines.
|
||||
|
||||
{ref}/delete-pipeline-api.html[Endpoint documentation]
|
||||
[source,ts]
|
||||
@ -5935,7 +5952,8 @@ If no response is received before the timeout expires, the request fails and ret
|
||||
|
||||
[discrete]
|
||||
==== geo_ip_stats
|
||||
Gets download statistics for GeoIP2 databases used with the geoip processor.
|
||||
Get GeoIP statistics.
|
||||
Get download statistics for GeoIP2 databases that are used with the GeoIP processor.
|
||||
|
||||
{ref}/geoip-processor.html[Endpoint documentation]
|
||||
[source,ts]
|
||||
@ -5946,7 +5964,8 @@ client.ingest.geoIpStats()
|
||||
|
||||
[discrete]
|
||||
==== get_geoip_database
|
||||
Returns information about one or more geoip database configurations.
|
||||
Get GeoIP database configurations.
|
||||
Get information about one or more IP geolocation database configurations.
|
||||
|
||||
{ref}/get-geoip-database-api.html[Endpoint documentation]
|
||||
[source,ts]
|
||||
@ -5977,7 +5996,8 @@ client.ingest.getIpLocationDatabase()
|
||||
|
||||
[discrete]
|
||||
==== get_pipeline
|
||||
Returns information about one or more ingest pipelines.
|
||||
Get pipelines.
|
||||
Get information about one or more ingest pipelines.
|
||||
This API returns a local reference of the pipeline.
|
||||
|
||||
{ref}/get-pipeline-api.html[Endpoint documentation]
|
||||
@ -5999,8 +6019,9 @@ If no response is received before the timeout expires, the request fails and ret
|
||||
|
||||
[discrete]
|
||||
==== processor_grok
|
||||
Extracts structured fields out of a single text field within a document.
|
||||
You choose which field to extract matched fields from, as well as the grok pattern you expect will match.
|
||||
Run a grok processor.
|
||||
Extract structured fields out of a single text field within a document.
|
||||
You must choose which field to extract matched fields from, as well as the grok pattern you expect will match.
|
||||
A grok pattern is like a regular expression that supports aliased expressions that can be reused.
|
||||
|
||||
{ref}/grok-processor.html[Endpoint documentation]
|
||||
@ -6012,7 +6033,8 @@ client.ingest.processorGrok()
|
||||
|
||||
[discrete]
|
||||
==== put_geoip_database
|
||||
Returns information about one or more geoip database configurations.
|
||||
Create or update GeoIP database configurations.
|
||||
Create or update IP geolocation database configurations.
|
||||
|
||||
{ref}/put-geoip-database-api.html[Endpoint documentation]
|
||||
[source,ts]
|
||||
@ -6045,7 +6067,7 @@ client.ingest.putIpLocationDatabase()
|
||||
|
||||
[discrete]
|
||||
==== put_pipeline
|
||||
Creates or updates an ingest pipeline.
|
||||
Create or update a pipeline.
|
||||
Changes made using this API take effect immediately.
|
||||
|
||||
{ref}/ingest.html[Endpoint documentation]
|
||||
@ -6072,7 +6094,9 @@ When a deprecated ingest pipeline is referenced as the default or final pipeline
|
||||
|
||||
[discrete]
|
||||
==== simulate
|
||||
Executes an ingest pipeline against a set of provided documents.
|
||||
Simulate a pipeline.
|
||||
Run an ingest pipeline against a set of provided documents.
|
||||
You can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request.
|
||||
|
||||
{ref}/simulate-pipeline-api.html[Endpoint documentation]
|
||||
[source,ts]
|
||||
@ -8545,7 +8569,8 @@ If no response is received before the timeout expires, the request fails and ret
|
||||
=== query_rules
|
||||
[discrete]
|
||||
==== delete_rule
|
||||
Deletes a query rule within a query ruleset.
|
||||
Delete a query rule.
|
||||
Delete a query rule within a query ruleset.
|
||||
|
||||
{ref}/delete-query-rule.html[Endpoint documentation]
|
||||
[source,ts]
|
||||
@ -8562,7 +8587,7 @@ client.queryRules.deleteRule({ ruleset_id, rule_id })
|
||||
|
||||
[discrete]
|
||||
==== delete_ruleset
|
||||
Deletes a query ruleset.
|
||||
Delete a query ruleset.
|
||||
|
||||
{ref}/delete-query-ruleset.html[Endpoint documentation]
|
||||
[source,ts]
|
||||
@ -8578,7 +8603,8 @@ client.queryRules.deleteRuleset({ ruleset_id })
|
||||
|
||||
[discrete]
|
||||
==== get_rule
|
||||
Returns the details about a query rule within a query ruleset
|
||||
Get a query rule.
|
||||
Get details about a query rule within a query ruleset.
|
||||
|
||||
{ref}/get-query-rule.html[Endpoint documentation]
|
||||
[source,ts]
|
||||
@ -8595,7 +8621,8 @@ client.queryRules.getRule({ ruleset_id, rule_id })
|
||||
|
||||
[discrete]
|
||||
==== get_ruleset
|
||||
Returns the details about a query ruleset
|
||||
Get a query ruleset.
|
||||
Get details about a query ruleset.
|
||||
|
||||
{ref}/get-query-ruleset.html[Endpoint documentation]
|
||||
[source,ts]
|
||||
@ -8611,7 +8638,8 @@ client.queryRules.getRuleset({ ruleset_id })
|
||||
|
||||
[discrete]
|
||||
==== list_rulesets
|
||||
Returns summarized information about existing query rulesets.
|
||||
Get all query rulesets.
|
||||
Get summarized information about the query rulesets.
|
||||
|
||||
{ref}/list-query-rulesets.html[Endpoint documentation]
|
||||
[source,ts]
|
||||
@ -8628,7 +8656,8 @@ client.queryRules.listRulesets({ ... })
|
||||
|
||||
[discrete]
|
||||
==== put_rule
|
||||
Creates or updates a query rule within a query ruleset.
|
||||
Create or update a query rule.
|
||||
Create or update a query rule within a query ruleset.
|
||||
|
||||
{ref}/put-query-rule.html[Endpoint documentation]
|
||||
[source,ts]
|
||||
@ -8649,7 +8678,7 @@ client.queryRules.putRule({ ruleset_id, rule_id, type, criteria, actions })
|
||||
|
||||
[discrete]
|
||||
==== put_ruleset
|
||||
Creates or updates a query ruleset.
|
||||
Create or update a query ruleset.
|
||||
|
||||
{ref}/put-query-ruleset.html[Endpoint documentation]
|
||||
[source,ts]
|
||||
@ -8666,7 +8695,8 @@ client.queryRules.putRuleset({ ruleset_id, rules })
|
||||
|
||||
[discrete]
|
||||
==== test
|
||||
Creates or updates a query ruleset.
|
||||
Test a query ruleset.
|
||||
Evaluate match criteria against a query ruleset to identify the rules that would match that criteria.
|
||||
|
||||
{ref}/test-query-ruleset.html[Endpoint documentation]
|
||||
[source,ts]
|
||||
@ -10931,7 +10961,7 @@ client.snapshot.verifyRepository({ repository })
|
||||
=== sql
|
||||
[discrete]
|
||||
==== clear_cursor
|
||||
Clears the SQL cursor
|
||||
Clear an SQL search cursor.
|
||||
|
||||
{ref}/clear-sql-cursor-api.html[Endpoint documentation]
|
||||
[source,ts]
|
||||
@ -10947,7 +10977,9 @@ client.sql.clearCursor({ cursor })
|
||||
|
||||
[discrete]
|
||||
==== delete_async
|
||||
Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it.
|
||||
Delete an async SQL search.
|
||||
Delete an async SQL search or a stored synchronous SQL search.
|
||||
If the search is still running, the API cancels it.
|
||||
|
||||
{ref}/delete-async-sql-search-api.html[Endpoint documentation]
|
||||
[source,ts]
|
||||
@ -10963,7 +10995,8 @@ client.sql.deleteAsync({ id })
|
||||
|
||||
[discrete]
|
||||
==== get_async
|
||||
Returns the current status and available results for an async SQL search or stored synchronous SQL search
|
||||
Get async SQL search results.
|
||||
Get the current status and available results for an async SQL search or stored synchronous SQL search.
|
||||
|
||||
{ref}/get-async-sql-search-api.html[Endpoint documentation]
|
||||
[source,ts]
|
||||
@ -10986,7 +11019,8 @@ meaning the request waits for complete search results.
|
||||
|
||||
[discrete]
|
||||
==== get_async_status
|
||||
Returns the current status of an async SQL search or a stored synchronous SQL search
|
||||
Get the async SQL search status.
|
||||
Get the current status of an async SQL search or a stored synchronous SQL search.
|
||||
|
||||
{ref}/get-async-sql-search-status-api.html[Endpoint documentation]
|
||||
[source,ts]
|
||||
@ -11002,7 +11036,8 @@ client.sql.getAsyncStatus({ id })
|
||||
|
||||
[discrete]
|
||||
==== query
|
||||
Executes a SQL request
|
||||
Get SQL search results.
|
||||
Run an SQL request.
|
||||
|
||||
{ref}/sql-search-api.html[Endpoint documentation]
|
||||
[source,ts]
|
||||
@ -11037,7 +11072,8 @@ precedence over mapped fields with the same name.
|
||||
|
||||
[discrete]
|
||||
==== translate
|
||||
Translates SQL into Elasticsearch queries
|
||||
Translate SQL into Elasticsearch queries.
|
||||
Translate an SQL search into a search API request containing Query DSL.
|
||||
|
||||
{ref}/sql-translate-api.html[Endpoint documentation]
|
||||
[source,ts]
|
||||
@ -11087,7 +11123,7 @@ client.ssl.certificates()
|
||||
=== synonyms
|
||||
[discrete]
|
||||
==== delete_synonym
|
||||
Deletes a synonym set
|
||||
Delete a synonym set.
|
||||
|
||||
{ref}/delete-synonyms-set.html[Endpoint documentation]
|
||||
[source,ts]
|
||||
@ -11103,7 +11139,8 @@ client.synonyms.deleteSynonym({ id })
|
||||
|
||||
[discrete]
|
||||
==== delete_synonym_rule
|
||||
Deletes a synonym rule in a synonym set
|
||||
Delete a synonym rule.
|
||||
Delete a synonym rule from a synonym set.
|
||||
|
||||
{ref}/delete-synonym-rule.html[Endpoint documentation]
|
||||
[source,ts]
|
||||
@ -11120,7 +11157,7 @@ client.synonyms.deleteSynonymRule({ set_id, rule_id })
|
||||
|
||||
[discrete]
|
||||
==== get_synonym
|
||||
Retrieves a synonym set
|
||||
Get a synonym set.
|
||||
|
||||
{ref}/get-synonyms-set.html[Endpoint documentation]
|
||||
[source,ts]
|
||||
@ -11138,7 +11175,8 @@ client.synonyms.getSynonym({ id })
|
||||
|
||||
[discrete]
|
||||
==== get_synonym_rule
|
||||
Retrieves a synonym rule from a synonym set
|
||||
Get a synonym rule.
|
||||
Get a synonym rule from a synonym set.
|
||||
|
||||
{ref}/get-synonym-rule.html[Endpoint documentation]
|
||||
[source,ts]
|
||||
@ -11155,7 +11193,8 @@ client.synonyms.getSynonymRule({ set_id, rule_id })
|
||||
|
||||
[discrete]
|
||||
==== get_synonyms_sets
|
||||
Retrieves a summary of all defined synonym sets
|
||||
Get all synonym sets.
|
||||
Get a summary of all defined synonym sets.
|
||||
|
||||
{ref}/list-synonyms-sets.html[Endpoint documentation]
|
||||
[source,ts]
|
||||
@ -11172,7 +11211,9 @@ client.synonyms.getSynonymsSets({ ... })
|
||||
|
||||
[discrete]
|
||||
==== put_synonym
|
||||
Creates or updates a synonym set.
|
||||
Create or update a synonym set.
|
||||
Synonyms sets are limited to a maximum of 10,000 synonym rules per set.
|
||||
If you need to manage more synonym rules, you can create multiple synonym sets.
|
||||
|
||||
{ref}/put-synonyms-set.html[Endpoint documentation]
|
||||
[source,ts]
|
||||
@ -11189,7 +11230,8 @@ client.synonyms.putSynonym({ id, synonyms_set })
|
||||
|
||||
[discrete]
|
||||
==== put_synonym_rule
|
||||
Creates or updates a synonym rule in a synonym set
|
||||
Create or update a synonym rule.
|
||||
Create or update a synonym rule in a synonym set.
|
||||
|
||||
{ref}/put-synonym-rule.html[Endpoint documentation]
|
||||
[source,ts]
|
||||
|
||||
@ -39,7 +39,7 @@ import * as TB from '../typesWithBodyKey'
|
||||
interface That { transport: Transport }
|
||||
|
||||
/**
|
||||
* Returns number of documents matching a query.
|
||||
* Count search results. Get the number of documents matching a query.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/search-count.html | Elasticsearch API documentation}
|
||||
*/
|
||||
export default async function CountApi (this: That, params?: T.CountRequest | TB.CountRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.CountResponse>
|
||||
|
||||
@ -77,7 +77,7 @@ export default class Enrich {
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates the enrich index for an existing enrich policy.
|
||||
* Run an enrich policy. Create the enrich index for an existing enrich policy.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/execute-enrich-policy-api.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async executePolicy (this: That, params: T.EnrichExecutePolicyRequest | TB.EnrichExecutePolicyRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.EnrichExecutePolicyResponse>
|
||||
|
||||
@ -45,7 +45,7 @@ export default class Eql {
|
||||
}
|
||||
|
||||
/**
|
||||
* Deletes an async EQL search or a stored synchronous EQL search. The API also deletes results for the search.
|
||||
* Delete an async EQL search. Delete an async EQL search or a stored synchronous EQL search. The API also deletes results for the search.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/eql-search-api.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async delete (this: That, params: T.EqlDeleteRequest | TB.EqlDeleteRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.EqlDeleteResponse>
|
||||
@ -77,7 +77,7 @@ export default class Eql {
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the current status and available results for an async EQL search or a stored synchronous EQL search.
|
||||
* Get async EQL search results. Get the current status and available results for an async EQL search or a stored synchronous EQL search.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-async-eql-search-api.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async get<TEvent = unknown> (this: That, params: T.EqlGetRequest | TB.EqlGetRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.EqlGetResponse<TEvent>>
|
||||
@ -109,7 +109,7 @@ export default class Eql {
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the current status for an async EQL search or a stored synchronous EQL search without returning results.
|
||||
* Get the async EQL status. Get the current status for an async EQL search or a stored synchronous EQL search without returning results.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-async-eql-status-api.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async getStatus (this: That, params: T.EqlGetStatusRequest | TB.EqlGetStatusRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.EqlGetStatusResponse>
|
||||
@ -141,7 +141,7 @@ export default class Eql {
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns results matching a query expressed in Event Query Language (EQL)
|
||||
* Get EQL search results. Returns search results for an Event Query Language (EQL) query. EQL assumes each document in a data stream or index corresponds to an event.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/eql-search-api.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async search<TEvent = unknown> (this: That, params: T.EqlSearchRequest | TB.EqlSearchRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.EqlSearchResponse<TEvent>>
|
||||
|
||||
@ -106,7 +106,7 @@ export default class Esql {
|
||||
}
|
||||
|
||||
/**
|
||||
* Executes an ES|QL request
|
||||
* Run an ES|QL query. Get search results for an ES|QL (Elasticsearch query language) query.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/esql-rest.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async query (this: That, params: T.EsqlQueryRequest | TB.EsqlQueryRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.EsqlQueryResponse>
|
||||
|
||||
@ -45,7 +45,7 @@ export default class Graph {
|
||||
}
|
||||
|
||||
/**
|
||||
* Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index.
|
||||
* Explore graph analytics. Extract and summarize information about the documents and terms in an Elasticsearch data stream or index. The easiest way to understand the behavior of this API is to use the Graph UI to explore connections. An initial request to the `_explore` API contains a seed query that identifies the documents of interest and specifies the fields that define the vertices and connections you want to include in the graph. Subsequent requests enable you to spider out from one more vertices of interest. You can exclude vertices that have already been returned.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/graph-explore-api.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async explore (this: That, params: T.GraphExploreRequest | TB.GraphExploreRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.GraphExploreResponse>
|
||||
|
||||
@ -705,7 +705,7 @@ export default class Indices {
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns information about whether a particular index template exists.
|
||||
* Check index templates. Check whether index templates exist.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/index-templates.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async existsIndexTemplate (this: That, params: T.IndicesExistsIndexTemplateRequest | TB.IndicesExistsIndexTemplateRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IndicesExistsIndexTemplateResponse>
|
||||
@ -1824,7 +1824,7 @@ export default class Indices {
|
||||
}
|
||||
|
||||
/**
|
||||
* Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams. Multiple patterns and remote clusters are supported.
|
||||
* Resolve indices. Resolve the names and/or index patterns for indices, aliases, and data streams. Multiple patterns and remote clusters are supported.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/indices-resolve-index-api.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async resolveIndex (this: That, params: T.IndicesResolveIndexRequest | TB.IndicesResolveIndexRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IndicesResolveIndexResponse>
|
||||
|
||||
@ -45,7 +45,7 @@ export default class Ingest {
|
||||
}
|
||||
|
||||
/**
|
||||
* Deletes a geoip database configuration.
|
||||
* Delete GeoIP database configurations. Delete one or more IP geolocation database configurations.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/delete-geoip-database-api.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async deleteGeoipDatabase (this: That, params: T.IngestDeleteGeoipDatabaseRequest | TB.IngestDeleteGeoipDatabaseRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IngestDeleteGeoipDatabaseResponse>
|
||||
@ -109,7 +109,7 @@ export default class Ingest {
|
||||
}
|
||||
|
||||
/**
|
||||
* Deletes one or more existing ingest pipeline.
|
||||
* Delete pipelines. Delete one or more ingest pipelines.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/delete-pipeline-api.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async deletePipeline (this: That, params: T.IngestDeletePipelineRequest | TB.IngestDeletePipelineRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IngestDeletePipelineResponse>
|
||||
@ -141,7 +141,7 @@ export default class Ingest {
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets download statistics for GeoIP2 databases used with the geoip processor.
|
||||
* Get GeoIP statistics. Get download statistics for GeoIP2 databases that are used with the GeoIP processor.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/geoip-processor.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async geoIpStats (this: That, params?: T.IngestGeoIpStatsRequest | TB.IngestGeoIpStatsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IngestGeoIpStatsResponse>
|
||||
@ -171,7 +171,7 @@ export default class Ingest {
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns information about one or more geoip database configurations.
|
||||
* Get GeoIP database configurations. Get information about one or more IP geolocation database configurations.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-geoip-database-api.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async getGeoipDatabase (this: That, params?: T.IngestGetGeoipDatabaseRequest | TB.IngestGetGeoipDatabaseRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IngestGetGeoipDatabaseResponse>
|
||||
@ -250,7 +250,7 @@ export default class Ingest {
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns information about one or more ingest pipelines. This API returns a local reference of the pipeline.
|
||||
* Get pipelines. Get information about one or more ingest pipelines. This API returns a local reference of the pipeline.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-pipeline-api.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async getPipeline (this: That, params?: T.IngestGetPipelineRequest | TB.IngestGetPipelineRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IngestGetPipelineResponse>
|
||||
@ -290,7 +290,7 @@ export default class Ingest {
|
||||
}
|
||||
|
||||
/**
|
||||
* Extracts structured fields out of a single text field within a document. You choose which field to extract matched fields from, as well as the grok pattern you expect will match. A grok pattern is like a regular expression that supports aliased expressions that can be reused.
|
||||
* Run a grok processor. Extract structured fields out of a single text field within a document. You must choose which field to extract matched fields from, as well as the grok pattern you expect will match. A grok pattern is like a regular expression that supports aliased expressions that can be reused.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/grok-processor.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async processorGrok (this: That, params?: T.IngestProcessorGrokRequest | TB.IngestProcessorGrokRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IngestProcessorGrokResponse>
|
||||
@ -320,7 +320,7 @@ export default class Ingest {
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns information about one or more geoip database configurations.
|
||||
* Create or update GeoIP database configurations. Create or update IP geolocation database configurations.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/put-geoip-database-api.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async putGeoipDatabase (this: That, params: T.IngestPutGeoipDatabaseRequest | TB.IngestPutGeoipDatabaseRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IngestPutGeoipDatabaseResponse>
|
||||
@ -396,7 +396,7 @@ export default class Ingest {
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates or updates an ingest pipeline. Changes made using this API take effect immediately.
|
||||
* Create or update a pipeline. Changes made using this API take effect immediately.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/ingest.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async putPipeline (this: That, params: T.IngestPutPipelineRequest | TB.IngestPutPipelineRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IngestPutPipelineResponse>
|
||||
@ -440,7 +440,7 @@ export default class Ingest {
|
||||
}
|
||||
|
||||
/**
|
||||
* Executes an ingest pipeline against a set of provided documents.
|
||||
* Simulate a pipeline. Run an ingest pipeline against a set of provided documents. You can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/simulate-pipeline-api.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async simulate (this: That, params: T.IngestSimulateRequest | TB.IngestSimulateRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IngestSimulateResponse>
|
||||
|
||||
@ -45,7 +45,7 @@ export default class QueryRules {
|
||||
}
|
||||
|
||||
/**
|
||||
* Deletes a query rule within a query ruleset.
|
||||
* Delete a query rule. Delete a query rule within a query ruleset.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/delete-query-rule.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async deleteRule (this: That, params: T.QueryRulesDeleteRuleRequest | TB.QueryRulesDeleteRuleRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.QueryRulesDeleteRuleResponse>
|
||||
@ -78,7 +78,7 @@ export default class QueryRules {
|
||||
}
|
||||
|
||||
/**
|
||||
* Deletes a query ruleset.
|
||||
* Delete a query ruleset.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/delete-query-ruleset.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async deleteRuleset (this: That, params: T.QueryRulesDeleteRulesetRequest | TB.QueryRulesDeleteRulesetRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.QueryRulesDeleteRulesetResponse>
|
||||
@ -110,7 +110,7 @@ export default class QueryRules {
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the details about a query rule within a query ruleset
|
||||
* Get a query rule. Get details about a query rule within a query ruleset.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-query-rule.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async getRule (this: That, params: T.QueryRulesGetRuleRequest | TB.QueryRulesGetRuleRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.QueryRulesGetRuleResponse>
|
||||
@ -143,7 +143,7 @@ export default class QueryRules {
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the details about a query ruleset
|
||||
* Get a query ruleset. Get details about a query ruleset.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-query-ruleset.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async getRuleset (this: That, params: T.QueryRulesGetRulesetRequest | TB.QueryRulesGetRulesetRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.QueryRulesGetRulesetResponse>
|
||||
@ -175,7 +175,7 @@ export default class QueryRules {
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns summarized information about existing query rulesets.
|
||||
* Get all query rulesets. Get summarized information about the query rulesets.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/list-query-rulesets.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async listRulesets (this: That, params?: T.QueryRulesListRulesetsRequest | TB.QueryRulesListRulesetsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.QueryRulesListRulesetsResponse>
|
||||
@ -205,7 +205,7 @@ export default class QueryRules {
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates or updates a query rule within a query ruleset.
|
||||
* Create or update a query rule. Create or update a query rule within a query ruleset.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/put-query-rule.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async putRule (this: That, params: T.QueryRulesPutRuleRequest | TB.QueryRulesPutRuleRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.QueryRulesPutRuleResponse>
|
||||
@ -250,7 +250,7 @@ export default class QueryRules {
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates or updates a query ruleset.
|
||||
* Create or update a query ruleset.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/put-query-ruleset.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async putRuleset (this: That, params: T.QueryRulesPutRulesetRequest | TB.QueryRulesPutRulesetRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.QueryRulesPutRulesetResponse>
|
||||
@ -294,7 +294,7 @@ export default class QueryRules {
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates or updates a query ruleset.
|
||||
* Test a query ruleset. Evaluate match criteria against a query ruleset to identify the rules that would match that criteria.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/test-query-ruleset.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async test (this: That, params: T.QueryRulesTestRequest | TB.QueryRulesTestRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.QueryRulesTestResponse>
|
||||
|
||||
@ -45,7 +45,7 @@ export default class Sql {
|
||||
}
|
||||
|
||||
/**
|
||||
* Clears the SQL cursor
|
||||
* Clear an SQL search cursor.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/clear-sql-cursor-api.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async clearCursor (this: That, params: T.SqlClearCursorRequest | TB.SqlClearCursorRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SqlClearCursorResponse>
|
||||
@ -86,7 +86,7 @@ export default class Sql {
|
||||
}
|
||||
|
||||
/**
|
||||
* Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it.
|
||||
* Delete an async SQL search. Delete an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/delete-async-sql-search-api.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async deleteAsync (this: That, params: T.SqlDeleteAsyncRequest | TB.SqlDeleteAsyncRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SqlDeleteAsyncResponse>
|
||||
@ -118,7 +118,7 @@ export default class Sql {
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the current status and available results for an async SQL search or stored synchronous SQL search
|
||||
* Get async SQL search results. Get the current status and available results for an async SQL search or stored synchronous SQL search.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-async-sql-search-api.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async getAsync (this: That, params: T.SqlGetAsyncRequest | TB.SqlGetAsyncRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SqlGetAsyncResponse>
|
||||
@ -150,7 +150,7 @@ export default class Sql {
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the current status of an async SQL search or a stored synchronous SQL search
|
||||
* Get the async SQL search status. Get the current status of an async SQL search or a stored synchronous SQL search.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-async-sql-search-status-api.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async getAsyncStatus (this: That, params: T.SqlGetAsyncStatusRequest | TB.SqlGetAsyncStatusRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SqlGetAsyncStatusResponse>
|
||||
@ -182,7 +182,7 @@ export default class Sql {
|
||||
}
|
||||
|
||||
/**
|
||||
* Executes a SQL request
|
||||
* Get SQL search results. Run an SQL request.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/sql-search-api.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async query (this: That, params?: T.SqlQueryRequest | TB.SqlQueryRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SqlQueryResponse>
|
||||
@ -224,7 +224,7 @@ export default class Sql {
|
||||
}
|
||||
|
||||
/**
|
||||
* Translates SQL into Elasticsearch queries
|
||||
* Translate SQL into Elasticsearch queries. Translate an SQL search into a search API request containing Query DSL.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/sql-translate-api.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async translate (this: That, params: T.SqlTranslateRequest | TB.SqlTranslateRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SqlTranslateResponse>
|
||||
|
||||
@ -45,7 +45,7 @@ export default class Synonyms {
|
||||
}
|
||||
|
||||
/**
|
||||
* Deletes a synonym set
|
||||
* Delete a synonym set.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/delete-synonyms-set.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async deleteSynonym (this: That, params: T.SynonymsDeleteSynonymRequest | TB.SynonymsDeleteSynonymRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SynonymsDeleteSynonymResponse>
|
||||
@ -77,7 +77,7 @@ export default class Synonyms {
|
||||
}
|
||||
|
||||
/**
|
||||
* Deletes a synonym rule in a synonym set
|
||||
* Delete a synonym rule. Delete a synonym rule from a synonym set.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/delete-synonym-rule.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async deleteSynonymRule (this: That, params: T.SynonymsDeleteSynonymRuleRequest | TB.SynonymsDeleteSynonymRuleRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SynonymsDeleteSynonymRuleResponse>
|
||||
@ -110,7 +110,7 @@ export default class Synonyms {
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieves a synonym set
|
||||
* Get a synonym set.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-synonyms-set.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async getSynonym (this: That, params: T.SynonymsGetSynonymRequest | TB.SynonymsGetSynonymRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SynonymsGetSynonymResponse>
|
||||
@ -142,7 +142,7 @@ export default class Synonyms {
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieves a synonym rule from a synonym set
|
||||
* Get a synonym rule. Get a synonym rule from a synonym set.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/get-synonym-rule.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async getSynonymRule (this: That, params: T.SynonymsGetSynonymRuleRequest | TB.SynonymsGetSynonymRuleRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SynonymsGetSynonymRuleResponse>
|
||||
@ -175,7 +175,7 @@ export default class Synonyms {
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieves a summary of all defined synonym sets
|
||||
* Get all synonym sets. Get a summary of all defined synonym sets.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/list-synonyms-sets.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async getSynonymsSets (this: That, params?: T.SynonymsGetSynonymsSetsRequest | TB.SynonymsGetSynonymsSetsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SynonymsGetSynonymsSetsResponse>
|
||||
@ -205,7 +205,7 @@ export default class Synonyms {
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates or updates a synonym set.
|
||||
* Create or update a synonym set. Synonyms sets are limited to a maximum of 10,000 synonym rules per set. If you need to manage more synonym rules, you can create multiple synonym sets.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/put-synonyms-set.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async putSynonym (this: That, params: T.SynonymsPutSynonymRequest | TB.SynonymsPutSynonymRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SynonymsPutSynonymResponse>
|
||||
@ -249,7 +249,7 @@ export default class Synonyms {
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates or updates a synonym rule in a synonym set
|
||||
* Create or update a synonym rule. Create or update a synonym rule in a synonym set.
|
||||
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/put-synonym-rule.html | Elasticsearch API documentation}
|
||||
*/
|
||||
async putSynonymRule (this: That, params: T.SynonymsPutSynonymRuleRequest | TB.SynonymsPutSynonymRuleRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SynonymsPutSynonymRuleResponse>
|
||||
|
||||
@ -13334,10 +13334,12 @@ export interface LogstashPutPipelineRequest extends RequestBase {
|
||||
export type LogstashPutPipelineResponse = boolean
|
||||
|
||||
export interface MigrationDeprecationsDeprecation {
|
||||
details: string
|
||||
details?: string
|
||||
level: MigrationDeprecationsDeprecationLevel
|
||||
message: string
|
||||
url: string
|
||||
resolve_during_rolling_upgrade: boolean
|
||||
_meta?: Record<string, any>
|
||||
}
|
||||
|
||||
export type MigrationDeprecationsDeprecationLevel = 'none' | 'info' | 'warning' | 'critical'
|
||||
@ -16500,7 +16502,7 @@ export interface NodesInfoNodeInfoPath {
|
||||
logs?: string
|
||||
home?: string
|
||||
repo?: string[]
|
||||
data?: string[]
|
||||
data?: string | string[]
|
||||
}
|
||||
|
||||
export interface NodesInfoNodeInfoRepositories {
|
||||
|
||||
@ -13575,10 +13575,12 @@ export interface LogstashPutPipelineRequest extends RequestBase {
|
||||
export type LogstashPutPipelineResponse = boolean
|
||||
|
||||
export interface MigrationDeprecationsDeprecation {
|
||||
details: string
|
||||
details?: string
|
||||
level: MigrationDeprecationsDeprecationLevel
|
||||
message: string
|
||||
url: string
|
||||
resolve_during_rolling_upgrade: boolean
|
||||
_meta?: Record<string, any>
|
||||
}
|
||||
|
||||
export type MigrationDeprecationsDeprecationLevel = 'none' | 'info' | 'warning' | 'critical'
|
||||
@ -16855,7 +16857,7 @@ export interface NodesInfoNodeInfoPath {
|
||||
logs?: string
|
||||
home?: string
|
||||
repo?: string[]
|
||||
data?: string[]
|
||||
data?: string | string[]
|
||||
}
|
||||
|
||||
export interface NodesInfoNodeInfoRepositories {
|
||||
|
||||
Reference in New Issue
Block a user