Auto-generated code for 8.x (#2500)
This commit is contained in:
46
docs/doc_examples/015e6e6132b6d6d44bddb06bc3b316ed.asciidoc
Normal file
46
docs/doc_examples/015e6e6132b6d6d44bddb06bc3b316ed.asciidoc
Normal file
@ -0,0 +1,46 @@
|
||||
// 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.search({
|
||||
index: "retrievers_example",
|
||||
retriever: {
|
||||
rrf: {
|
||||
retrievers: [
|
||||
{
|
||||
standard: {
|
||||
query: {
|
||||
range: {
|
||||
year: {
|
||||
gt: 2023,
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
{
|
||||
standard: {
|
||||
query: {
|
||||
term: {
|
||||
topic: "elastic",
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
],
|
||||
rank_window_size: 10,
|
||||
rank_constant: 1,
|
||||
},
|
||||
},
|
||||
_source: false,
|
||||
aggs: {
|
||||
topics: {
|
||||
terms: {
|
||||
field: "topic",
|
||||
},
|
||||
},
|
||||
},
|
||||
});
|
||||
console.log(response);
|
||||
----
|
||||
18
docs/doc_examples/0165d22da5f2fc7678392b31d8eb5566.asciidoc
Normal file
18
docs/doc_examples/0165d22da5f2fc7678392b31d8eb5566.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.inference.put({
|
||||
task_type: "rerank",
|
||||
inference_id: "my-rerank-model",
|
||||
inference_config: {
|
||||
service: "cohere",
|
||||
service_settings: {
|
||||
model_id: "rerank-english-v3.0",
|
||||
api_key: "{{COHERE_API_KEY}}",
|
||||
},
|
||||
},
|
||||
});
|
||||
console.log(response);
|
||||
----
|
||||
49
docs/doc_examples/0bc6155e0c88062a4d8490da49db3aa8.asciidoc
Normal file
49
docs/doc_examples/0bc6155e0c88062a4d8490da49db3aa8.asciidoc
Normal file
@ -0,0 +1,49 @@
|
||||
// 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.search({
|
||||
index: "retrievers_example_nested",
|
||||
retriever: {
|
||||
rrf: {
|
||||
retrievers: [
|
||||
{
|
||||
standard: {
|
||||
query: {
|
||||
nested: {
|
||||
path: "nested_field",
|
||||
inner_hits: {
|
||||
name: "nested_vector",
|
||||
_source: false,
|
||||
fields: ["nested_field.paragraph_id"],
|
||||
},
|
||||
query: {
|
||||
knn: {
|
||||
field: "nested_field.nested_vector",
|
||||
query_vector: [1, 0, 0.5],
|
||||
k: 10,
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
{
|
||||
standard: {
|
||||
query: {
|
||||
term: {
|
||||
topic: "ai",
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
],
|
||||
rank_window_size: 10,
|
||||
rank_constant: 1,
|
||||
},
|
||||
},
|
||||
_source: ["topic"],
|
||||
});
|
||||
console.log(response);
|
||||
----
|
||||
57
docs/doc_examples/0d689ac6e78be5d438f9b5d441be2b44.asciidoc
Normal file
57
docs/doc_examples/0d689ac6e78be5d438f9b5d441be2b44.asciidoc
Normal file
@ -0,0 +1,57 @@
|
||||
// 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.search({
|
||||
index: "retrievers_example",
|
||||
retriever: {
|
||||
rrf: {
|
||||
retrievers: [
|
||||
{
|
||||
standard: {
|
||||
query: {
|
||||
term: {
|
||||
topic: "elastic",
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
{
|
||||
rrf: {
|
||||
retrievers: [
|
||||
{
|
||||
standard: {
|
||||
query: {
|
||||
query_string: {
|
||||
query:
|
||||
"(information retrieval) OR (artificial intelligence)",
|
||||
default_field: "text",
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
{
|
||||
knn: {
|
||||
field: "vector",
|
||||
query_vector: [0.23, 0.67, 0.89],
|
||||
k: 3,
|
||||
num_candidates: 5,
|
||||
},
|
||||
},
|
||||
],
|
||||
rank_window_size: 10,
|
||||
rank_constant: 1,
|
||||
},
|
||||
},
|
||||
],
|
||||
rank_window_size: 10,
|
||||
rank_constant: 1,
|
||||
},
|
||||
},
|
||||
_source: false,
|
||||
size: 1,
|
||||
explain: true,
|
||||
});
|
||||
console.log(response);
|
||||
----
|
||||
@ -16,7 +16,7 @@ const response = await client.search({
|
||||
},
|
||||
},
|
||||
field: "text",
|
||||
inference_id: "my-cohere-rerank-model",
|
||||
inference_id: "elastic-rerank",
|
||||
inference_text: "How often does the moon hide the sun?",
|
||||
rank_window_size: 100,
|
||||
min_score: 0.5,
|
||||
@ -3,8 +3,8 @@
|
||||
|
||||
[source, js]
|
||||
----
|
||||
const response = await client.cluster.getSettings({
|
||||
flat_settings: "true",
|
||||
const response = await client.indices.rollover({
|
||||
alias: "datastream",
|
||||
});
|
||||
console.log(response);
|
||||
----
|
||||
@ -1,28 +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.esql.query({
|
||||
format: "txt",
|
||||
query:
|
||||
"\n FROM library\n | SORT page_count DESC\n | KEEP name, author\n | LOOKUP era ON author\n | LIMIT 5\n ",
|
||||
tables: {
|
||||
era: {
|
||||
author: {
|
||||
keyword: [
|
||||
"Frank Herbert",
|
||||
"Peter F. Hamilton",
|
||||
"Vernor Vinge",
|
||||
"Alastair Reynolds",
|
||||
"James S.A. Corey",
|
||||
],
|
||||
},
|
||||
era: {
|
||||
keyword: ["The New Wave", "Diamond", "Diamond", "Diamond", "Hadron"],
|
||||
},
|
||||
},
|
||||
},
|
||||
});
|
||||
console.log(response);
|
||||
----
|
||||
@ -1,16 +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.cluster.putSettings({
|
||||
persistent: {
|
||||
"cluster.indices.close.enable": false,
|
||||
"indices.recovery.max_bytes_per_sec": "50mb",
|
||||
},
|
||||
transient: {
|
||||
"*": null,
|
||||
},
|
||||
});
|
||||
console.log(response);
|
||||
----
|
||||
23
docs/doc_examples/30d051f534aeb884176eedb2c11dac85.asciidoc
Normal file
23
docs/doc_examples/30d051f534aeb884176eedb2c11dac85.asciidoc
Normal file
@ -0,0 +1,23 @@
|
||||
// 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: "rerank",
|
||||
inference_id: "my-elastic-rerank",
|
||||
inference_config: {
|
||||
service: "elasticsearch",
|
||||
service_settings: {
|
||||
model_id: ".rerank-v1",
|
||||
num_threads: 1,
|
||||
adaptive_allocations: {
|
||||
enabled: true,
|
||||
min_number_of_allocations: 1,
|
||||
max_number_of_allocations: 4,
|
||||
},
|
||||
},
|
||||
},
|
||||
});
|
||||
console.log(response);
|
||||
----
|
||||
@ -8,11 +8,6 @@ const response = await client.search({
|
||||
query: {
|
||||
bool: {
|
||||
must: [
|
||||
{
|
||||
term: {
|
||||
"category.keyword": "Main Course",
|
||||
},
|
||||
},
|
||||
{
|
||||
term: {
|
||||
tags: "vegetarian",
|
||||
@ -27,6 +22,11 @@ const response = await client.search({
|
||||
},
|
||||
],
|
||||
should: [
|
||||
{
|
||||
term: {
|
||||
category: "Main Course",
|
||||
},
|
||||
},
|
||||
{
|
||||
multi_match: {
|
||||
query: "curry spicy",
|
||||
@ -9,7 +9,6 @@ const response = await client.indices.create({
|
||||
properties: {
|
||||
inference_field: {
|
||||
type: "semantic_text",
|
||||
inference_id: "my-elser-endpoint",
|
||||
},
|
||||
},
|
||||
},
|
||||
@ -45,7 +45,7 @@ console.log(response);
|
||||
|
||||
const response1 = await client.indices.putIndexTemplate({
|
||||
name: 2,
|
||||
index_patterns: ["k8s*"],
|
||||
index_patterns: ["k9s*"],
|
||||
composed_of: ["destination_template"],
|
||||
data_stream: {},
|
||||
});
|
||||
44
docs/doc_examples/76e02434835630cb830724beb92df354.asciidoc
Normal file
44
docs/doc_examples/76e02434835630cb830724beb92df354.asciidoc
Normal file
@ -0,0 +1,44 @@
|
||||
// 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.search({
|
||||
index: "retrievers_example",
|
||||
retriever: {
|
||||
rrf: {
|
||||
retrievers: [
|
||||
{
|
||||
knn: {
|
||||
field: "vector",
|
||||
query_vector: [0.23, 0.67, 0.89],
|
||||
k: 3,
|
||||
num_candidates: 5,
|
||||
},
|
||||
},
|
||||
{
|
||||
text_similarity_reranker: {
|
||||
retriever: {
|
||||
standard: {
|
||||
query: {
|
||||
term: {
|
||||
topic: "ai",
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
field: "text",
|
||||
inference_id: "my-rerank-model",
|
||||
inference_text:
|
||||
"Can I use generative AI to identify user intent and improve search relevance?",
|
||||
},
|
||||
},
|
||||
],
|
||||
rank_window_size: 10,
|
||||
rank_constant: 1,
|
||||
},
|
||||
},
|
||||
_source: false,
|
||||
});
|
||||
console.log(response);
|
||||
----
|
||||
46
docs/doc_examples/78043831fd32004a82930c8ac8a1d809.asciidoc
Normal file
46
docs/doc_examples/78043831fd32004a82930c8ac8a1d809.asciidoc
Normal file
@ -0,0 +1,46 @@
|
||||
// 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.search({
|
||||
index: "retrievers_example",
|
||||
retriever: {
|
||||
text_similarity_reranker: {
|
||||
retriever: {
|
||||
rrf: {
|
||||
retrievers: [
|
||||
{
|
||||
standard: {
|
||||
query: {
|
||||
query_string: {
|
||||
query:
|
||||
"(information retrieval) OR (artificial intelligence)",
|
||||
default_field: "text",
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
{
|
||||
knn: {
|
||||
field: "vector",
|
||||
query_vector: [0.23, 0.67, 0.89],
|
||||
k: 3,
|
||||
num_candidates: 5,
|
||||
},
|
||||
},
|
||||
],
|
||||
rank_window_size: 10,
|
||||
rank_constant: 1,
|
||||
},
|
||||
},
|
||||
field: "text",
|
||||
inference_id: "my-rerank-model",
|
||||
inference_text:
|
||||
"What are the state of the art applications of AI in information retrieval?",
|
||||
},
|
||||
},
|
||||
_source: false,
|
||||
});
|
||||
console.log(response);
|
||||
----
|
||||
23
docs/doc_examples/79d206a528be704050a437adce2496dd.asciidoc
Normal file
23
docs/doc_examples/79d206a528be704050a437adce2496dd.asciidoc
Normal file
@ -0,0 +1,23 @@
|
||||
// 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: "rerank",
|
||||
inference_id: "my-elastic-rerank",
|
||||
inference_config: {
|
||||
service: "elasticsearch",
|
||||
service_settings: {
|
||||
model_id: ".rerank-v1",
|
||||
num_threads: 1,
|
||||
adaptive_allocations: {
|
||||
enabled: true,
|
||||
min_number_of_allocations: 1,
|
||||
max_number_of_allocations: 10,
|
||||
},
|
||||
},
|
||||
},
|
||||
});
|
||||
console.log(response);
|
||||
----
|
||||
@ -4,7 +4,7 @@
|
||||
[source, js]
|
||||
----
|
||||
const response = await client.indices.create({
|
||||
index: "my-index-000002",
|
||||
index: "my-index-000003",
|
||||
mappings: {
|
||||
properties: {
|
||||
inference_field: {
|
||||
@ -9,7 +9,6 @@ const response = await client.indices.create({
|
||||
properties: {
|
||||
content: {
|
||||
type: "semantic_text",
|
||||
inference_id: "my-elser-endpoint",
|
||||
},
|
||||
},
|
||||
},
|
||||
13
docs/doc_examples/9313f534e1aa266cde7d4af74665497f.asciidoc
Normal file
13
docs/doc_examples/9313f534e1aa266cde7d4af74665497f.asciidoc
Normal file
@ -0,0 +1,13 @@
|
||||
// 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.connector.put({
|
||||
connector_id: "my-{service-name-stub}-connector",
|
||||
index_name: "my-elasticsearch-index",
|
||||
name: "Content synced from {service-name}",
|
||||
service_type: "{service-name-stub}",
|
||||
});
|
||||
console.log(response);
|
||||
----
|
||||
18
docs/doc_examples/96e88611f99e6834bd64b58dc8a282c1.asciidoc
Normal file
18
docs/doc_examples/96e88611f99e6834bd64b58dc8a282c1.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.indices.create({
|
||||
index: "my-index-000002",
|
||||
mappings: {
|
||||
properties: {
|
||||
inference_field: {
|
||||
type: "semantic_text",
|
||||
inference_id: "my-openai-endpoint",
|
||||
},
|
||||
},
|
||||
},
|
||||
});
|
||||
console.log(response);
|
||||
----
|
||||
37
docs/doc_examples/97c6c07f46f4177f0565a04bc50924a3.asciidoc
Normal file
37
docs/doc_examples/97c6c07f46f4177f0565a04bc50924a3.asciidoc
Normal file
@ -0,0 +1,37 @@
|
||||
// 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.search({
|
||||
index: "retrievers_example",
|
||||
retriever: {
|
||||
rrf: {
|
||||
retrievers: [
|
||||
{
|
||||
standard: {
|
||||
query: {
|
||||
query_string: {
|
||||
query: "(information retrieval) OR (artificial intelligence)",
|
||||
default_field: "text",
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
{
|
||||
knn: {
|
||||
field: "vector",
|
||||
query_vector: [0.23, 0.67, 0.89],
|
||||
k: 3,
|
||||
num_candidates: 5,
|
||||
},
|
||||
},
|
||||
],
|
||||
rank_window_size: 10,
|
||||
rank_constant: 1,
|
||||
},
|
||||
},
|
||||
_source: false,
|
||||
});
|
||||
console.log(response);
|
||||
----
|
||||
27
docs/doc_examples/a9f14efc26fdd3c37a71f06c310163d9.asciidoc
Normal file
27
docs/doc_examples/a9f14efc26fdd3c37a71f06c310163d9.asciidoc
Normal file
@ -0,0 +1,27 @@
|
||||
// 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.search({
|
||||
retriever: {
|
||||
text_similarity_reranker: {
|
||||
retriever: {
|
||||
standard: {
|
||||
query: {
|
||||
match: {
|
||||
text: "How often does the moon hide the sun?",
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
field: "text",
|
||||
inference_id: "my-elastic-rerank",
|
||||
inference_text: "How often does the moon hide the sun?",
|
||||
rank_window_size: 100,
|
||||
min_score: 0.5,
|
||||
},
|
||||
},
|
||||
});
|
||||
console.log(response);
|
||||
----
|
||||
37
docs/doc_examples/ac22cc2b0f4ad659055feed2852a2d59.asciidoc
Normal file
37
docs/doc_examples/ac22cc2b0f4ad659055feed2852a2d59.asciidoc
Normal file
@ -0,0 +1,37 @@
|
||||
// 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.search({
|
||||
index: "retrievers_example",
|
||||
retriever: {
|
||||
text_similarity_reranker: {
|
||||
retriever: {
|
||||
text_similarity_reranker: {
|
||||
retriever: {
|
||||
knn: {
|
||||
field: "vector",
|
||||
query_vector: [0.23, 0.67, 0.89],
|
||||
k: 3,
|
||||
num_candidates: 5,
|
||||
},
|
||||
},
|
||||
rank_window_size: 100,
|
||||
field: "text",
|
||||
inference_id: "my-rerank-model",
|
||||
inference_text:
|
||||
"What are the state of the art applications of AI in information retrieval?",
|
||||
},
|
||||
},
|
||||
rank_window_size: 10,
|
||||
field: "text",
|
||||
inference_id: "my-other-more-expensive-rerank-model",
|
||||
inference_text:
|
||||
"Applications of Large Language Models in technology and their impact on user satisfaction",
|
||||
},
|
||||
},
|
||||
_source: false,
|
||||
});
|
||||
console.log(response);
|
||||
----
|
||||
@ -12,7 +12,7 @@ const response = await client.inference.put({
|
||||
adaptive_allocations: {
|
||||
enabled: true,
|
||||
min_number_of_allocations: 1,
|
||||
max_number_of_allocations: 10,
|
||||
max_number_of_allocations: 4,
|
||||
},
|
||||
num_threads: 1,
|
||||
model_id: ".elser_model_2",
|
||||
14
docs/doc_examples/ae3473adaf1515afcf7773f26c018e5c.asciidoc
Normal file
14
docs/doc_examples/ae3473adaf1515afcf7773f26c018e5c.asciidoc
Normal file
@ -0,0 +1,14 @@
|
||||
// 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.connector.put({
|
||||
connector_id: "my-{service-name-stub}-connector",
|
||||
index_name: "my-elasticsearch-index",
|
||||
name: "Content synced from {service-name}",
|
||||
service_type: "{service-name-stub}",
|
||||
is_native: true,
|
||||
});
|
||||
console.log(response);
|
||||
----
|
||||
45
docs/doc_examples/bb2ba5d1885f87506f90dbb002e518f4.asciidoc
Normal file
45
docs/doc_examples/bb2ba5d1885f87506f90dbb002e518f4.asciidoc
Normal file
@ -0,0 +1,45 @@
|
||||
// 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.search({
|
||||
index: "retrievers_example",
|
||||
retriever: {
|
||||
rrf: {
|
||||
retrievers: [
|
||||
{
|
||||
standard: {
|
||||
query: {
|
||||
query_string: {
|
||||
query: "(information retrieval) OR (artificial intelligence)",
|
||||
default_field: "text",
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
{
|
||||
knn: {
|
||||
field: "vector",
|
||||
query_vector: [0.23, 0.67, 0.89],
|
||||
k: 3,
|
||||
num_candidates: 5,
|
||||
},
|
||||
},
|
||||
],
|
||||
rank_window_size: 10,
|
||||
rank_constant: 1,
|
||||
},
|
||||
},
|
||||
highlight: {
|
||||
fields: {
|
||||
text: {
|
||||
fragment_size: 150,
|
||||
number_of_fragments: 3,
|
||||
},
|
||||
},
|
||||
},
|
||||
_source: false,
|
||||
});
|
||||
console.log(response);
|
||||
----
|
||||
83
docs/doc_examples/bee3fda7bb07086243424b62e5b16ca7.asciidoc
Normal file
83
docs/doc_examples/bee3fda7bb07086243424b62e5b16ca7.asciidoc
Normal file
@ -0,0 +1,83 @@
|
||||
// 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: "retrievers_example_nested",
|
||||
mappings: {
|
||||
properties: {
|
||||
nested_field: {
|
||||
type: "nested",
|
||||
properties: {
|
||||
paragraph_id: {
|
||||
type: "keyword",
|
||||
},
|
||||
nested_vector: {
|
||||
type: "dense_vector",
|
||||
dims: 3,
|
||||
similarity: "l2_norm",
|
||||
index: true,
|
||||
},
|
||||
},
|
||||
},
|
||||
topic: {
|
||||
type: "keyword",
|
||||
},
|
||||
},
|
||||
},
|
||||
});
|
||||
console.log(response);
|
||||
|
||||
const response1 = await client.index({
|
||||
index: "retrievers_example_nested",
|
||||
id: 1,
|
||||
document: {
|
||||
nested_field: [
|
||||
{
|
||||
paragraph_id: "1a",
|
||||
nested_vector: [-1.12, -0.59, 0.78],
|
||||
},
|
||||
{
|
||||
paragraph_id: "1b",
|
||||
nested_vector: [-0.12, 1.56, 0.42],
|
||||
},
|
||||
{
|
||||
paragraph_id: "1c",
|
||||
nested_vector: [1, -1, 0],
|
||||
},
|
||||
],
|
||||
topic: ["ai"],
|
||||
},
|
||||
});
|
||||
console.log(response1);
|
||||
|
||||
const response2 = await client.index({
|
||||
index: "retrievers_example_nested",
|
||||
id: 2,
|
||||
document: {
|
||||
nested_field: [
|
||||
{
|
||||
paragraph_id: "2a",
|
||||
nested_vector: [0.23, 1.24, 0.65],
|
||||
},
|
||||
],
|
||||
topic: ["information_retrieval"],
|
||||
},
|
||||
});
|
||||
console.log(response2);
|
||||
|
||||
const response3 = await client.index({
|
||||
index: "retrievers_example_nested",
|
||||
id: 3,
|
||||
document: {
|
||||
topic: ["ai"],
|
||||
},
|
||||
});
|
||||
console.log(response3);
|
||||
|
||||
const response4 = await client.indices.refresh({
|
||||
index: "retrievers_example_nested",
|
||||
});
|
||||
console.log(response4);
|
||||
----
|
||||
@ -1,11 +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.cluster.getSettings({
|
||||
flat_settings: "true",
|
||||
filter_path: "transient",
|
||||
});
|
||||
console.log(response);
|
||||
----
|
||||
154
docs/doc_examples/d4158d486e7fee2702a14068b69e3b33.asciidoc
Normal file
154
docs/doc_examples/d4158d486e7fee2702a14068b69e3b33.asciidoc
Normal file
@ -0,0 +1,154 @@
|
||||
// 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.putIndexTemplate({
|
||||
name: "datastream_template",
|
||||
index_patterns: ["datastream*"],
|
||||
data_stream: {},
|
||||
template: {
|
||||
lifecycle: {
|
||||
downsampling: [
|
||||
{
|
||||
after: "1m",
|
||||
fixed_interval: "1h",
|
||||
},
|
||||
],
|
||||
},
|
||||
settings: {
|
||||
index: {
|
||||
mode: "time_series",
|
||||
},
|
||||
},
|
||||
mappings: {
|
||||
properties: {
|
||||
"@timestamp": {
|
||||
type: "date",
|
||||
},
|
||||
kubernetes: {
|
||||
properties: {
|
||||
container: {
|
||||
properties: {
|
||||
cpu: {
|
||||
properties: {
|
||||
usage: {
|
||||
properties: {
|
||||
core: {
|
||||
properties: {
|
||||
ns: {
|
||||
type: "long",
|
||||
},
|
||||
},
|
||||
},
|
||||
limit: {
|
||||
properties: {
|
||||
pct: {
|
||||
type: "float",
|
||||
},
|
||||
},
|
||||
},
|
||||
nanocores: {
|
||||
type: "long",
|
||||
time_series_metric: "gauge",
|
||||
},
|
||||
node: {
|
||||
properties: {
|
||||
pct: {
|
||||
type: "float",
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
memory: {
|
||||
properties: {
|
||||
available: {
|
||||
properties: {
|
||||
bytes: {
|
||||
type: "long",
|
||||
time_series_metric: "gauge",
|
||||
},
|
||||
},
|
||||
},
|
||||
majorpagefaults: {
|
||||
type: "long",
|
||||
},
|
||||
pagefaults: {
|
||||
type: "long",
|
||||
time_series_metric: "gauge",
|
||||
},
|
||||
rss: {
|
||||
properties: {
|
||||
bytes: {
|
||||
type: "long",
|
||||
time_series_metric: "gauge",
|
||||
},
|
||||
},
|
||||
},
|
||||
usage: {
|
||||
properties: {
|
||||
bytes: {
|
||||
type: "long",
|
||||
time_series_metric: "gauge",
|
||||
},
|
||||
limit: {
|
||||
properties: {
|
||||
pct: {
|
||||
type: "float",
|
||||
},
|
||||
},
|
||||
},
|
||||
node: {
|
||||
properties: {
|
||||
pct: {
|
||||
type: "float",
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
workingset: {
|
||||
properties: {
|
||||
bytes: {
|
||||
type: "long",
|
||||
time_series_metric: "gauge",
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
name: {
|
||||
type: "keyword",
|
||||
},
|
||||
start_time: {
|
||||
type: "date",
|
||||
},
|
||||
},
|
||||
},
|
||||
host: {
|
||||
type: "keyword",
|
||||
time_series_dimension: true,
|
||||
},
|
||||
namespace: {
|
||||
type: "keyword",
|
||||
time_series_dimension: true,
|
||||
},
|
||||
node: {
|
||||
type: "keyword",
|
||||
time_series_dimension: true,
|
||||
},
|
||||
pod: {
|
||||
type: "keyword",
|
||||
time_series_dimension: true,
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
});
|
||||
console.log(response);
|
||||
----
|
||||
16
docs/doc_examples/e22a1da3c622611be6855e534c0709ae.asciidoc
Normal file
16
docs/doc_examples/e22a1da3c622611be6855e534c0709ae.asciidoc
Normal file
@ -0,0 +1,16 @@
|
||||
// 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.transport.request({
|
||||
method: "POST",
|
||||
path: "/_query_rules/my-ruleset/_test",
|
||||
body: {
|
||||
match_criteria: {
|
||||
query_string: "puggles",
|
||||
},
|
||||
},
|
||||
});
|
||||
console.log(response);
|
||||
----
|
||||
44
docs/doc_examples/e6f6d3aeea7ecea47cfd5c3d727f7004.asciidoc
Normal file
44
docs/doc_examples/e6f6d3aeea7ecea47cfd5c3d727f7004.asciidoc
Normal file
@ -0,0 +1,44 @@
|
||||
// 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.search({
|
||||
index: "retrievers_example",
|
||||
retriever: {
|
||||
rrf: {
|
||||
retrievers: [
|
||||
{
|
||||
standard: {
|
||||
query: {
|
||||
query_string: {
|
||||
query: "(information retrieval) OR (artificial intelligence)",
|
||||
default_field: "text",
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
{
|
||||
knn: {
|
||||
field: "vector",
|
||||
query_vector: [0.23, 0.67, 0.89],
|
||||
k: 3,
|
||||
num_candidates: 5,
|
||||
},
|
||||
},
|
||||
],
|
||||
rank_window_size: 10,
|
||||
rank_constant: 1,
|
||||
},
|
||||
},
|
||||
collapse: {
|
||||
field: "year",
|
||||
inner_hits: {
|
||||
name: "topic related documents",
|
||||
_source: ["year"],
|
||||
},
|
||||
},
|
||||
_source: false,
|
||||
});
|
||||
console.log(response);
|
||||
----
|
||||
94
docs/doc_examples/ee05714a83d75fb6858e3b9fcbeb8f8b.asciidoc
Normal file
94
docs/doc_examples/ee05714a83d75fb6858e3b9fcbeb8f8b.asciidoc
Normal file
@ -0,0 +1,94 @@
|
||||
// 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: "retrievers_example",
|
||||
mappings: {
|
||||
properties: {
|
||||
vector: {
|
||||
type: "dense_vector",
|
||||
dims: 3,
|
||||
similarity: "l2_norm",
|
||||
index: true,
|
||||
},
|
||||
text: {
|
||||
type: "text",
|
||||
},
|
||||
year: {
|
||||
type: "integer",
|
||||
},
|
||||
topic: {
|
||||
type: "keyword",
|
||||
},
|
||||
},
|
||||
},
|
||||
});
|
||||
console.log(response);
|
||||
|
||||
const response1 = await client.index({
|
||||
index: "retrievers_example",
|
||||
id: 1,
|
||||
document: {
|
||||
vector: [0.23, 0.67, 0.89],
|
||||
text: "Large language models are revolutionizing information retrieval by boosting search precision, deepening contextual understanding, and reshaping user experiences in data-rich environments.",
|
||||
year: 2024,
|
||||
topic: ["llm", "ai", "information_retrieval"],
|
||||
},
|
||||
});
|
||||
console.log(response1);
|
||||
|
||||
const response2 = await client.index({
|
||||
index: "retrievers_example",
|
||||
id: 2,
|
||||
document: {
|
||||
vector: [0.12, 0.56, 0.78],
|
||||
text: "Artificial intelligence is transforming medicine, from advancing diagnostics and tailoring treatment plans to empowering predictive patient care for improved health outcomes.",
|
||||
year: 2023,
|
||||
topic: ["ai", "medicine"],
|
||||
},
|
||||
});
|
||||
console.log(response2);
|
||||
|
||||
const response3 = await client.index({
|
||||
index: "retrievers_example",
|
||||
id: 3,
|
||||
document: {
|
||||
vector: [0.45, 0.32, 0.91],
|
||||
text: "AI is redefining security by enabling advanced threat detection, proactive risk analysis, and dynamic defenses against increasingly sophisticated cyber threats.",
|
||||
year: 2024,
|
||||
topic: ["ai", "security"],
|
||||
},
|
||||
});
|
||||
console.log(response3);
|
||||
|
||||
const response4 = await client.index({
|
||||
index: "retrievers_example",
|
||||
id: 4,
|
||||
document: {
|
||||
vector: [0.34, 0.21, 0.98],
|
||||
text: "Elastic introduces Elastic AI Assistant, the open, generative AI sidekick powered by ESRE to democratize cybersecurity and enable users of every skill level.",
|
||||
year: 2023,
|
||||
topic: ["ai", "elastic", "assistant"],
|
||||
},
|
||||
});
|
||||
console.log(response4);
|
||||
|
||||
const response5 = await client.index({
|
||||
index: "retrievers_example",
|
||||
id: 5,
|
||||
document: {
|
||||
vector: [0.11, 0.65, 0.47],
|
||||
text: "Learn how to spin up a deployment of our hosted Elasticsearch Service and use Elastic Observability to gain deeper insight into the behavior of your applications and systems.",
|
||||
year: 2024,
|
||||
topic: ["documentation", "observability", "elastic"],
|
||||
},
|
||||
});
|
||||
console.log(response5);
|
||||
|
||||
const response6 = await client.indices.refresh({
|
||||
index: "retrievers_example",
|
||||
});
|
||||
console.log(response6);
|
||||
----
|
||||
@ -818,6 +818,8 @@ Random by default.
|
||||
** *`expand_wildcards` (Optional, Enum("all" | "open" | "closed" | "hidden" | "none") | Enum("all" | "open" | "closed" | "hidden" | "none")[])*: Type of index that wildcard patterns can match.
|
||||
If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
|
||||
Supports a list of values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`.
|
||||
** *`allow_partial_search_results` (Optional, boolean)*: If `false`, creating a point in time request when a shard is missing or unavailable will throw an exception.
|
||||
If `true`, the point in time will contain all the shards that are available at the time of the request.
|
||||
|
||||
[discrete]
|
||||
=== ping
|
||||
@ -1558,6 +1560,8 @@ client.asyncSearch.status({ id })
|
||||
|
||||
* *Request (object):*
|
||||
** *`id` (string)*: A unique identifier for the async search.
|
||||
** *`keep_alive` (Optional, string | -1 | 0)*: Specifies how long the async search needs to be available.
|
||||
Ongoing async searches and any saved search results are deleted after this period.
|
||||
|
||||
[discrete]
|
||||
==== submit
|
||||
@ -1659,14 +1663,13 @@ A partial reduction is performed every time the coordinating node has received a
|
||||
** *`pre_filter_shard_size` (Optional, number)*: The default value cannot be changed, which enforces the execution of a pre-filter roundtrip to retrieve statistics from each shard so that the ones that surely don’t hold any document matching the query get skipped.
|
||||
** *`request_cache` (Optional, boolean)*: Specify if request cache should be used for this request or not, defaults to true
|
||||
** *`routing` (Optional, string)*: A list of specific routing values
|
||||
** *`scroll` (Optional, string | -1 | 0)*
|
||||
** *`search_type` (Optional, Enum("query_then_fetch" | "dfs_query_then_fetch"))*: Search operation type
|
||||
** *`suggest_field` (Optional, string)*: Specifies which field to use for suggestions.
|
||||
** *`suggest_mode` (Optional, Enum("missing" | "popular" | "always"))*: Specify suggest mode
|
||||
** *`suggest_size` (Optional, number)*: How many suggestions to return in response
|
||||
** *`suggest_text` (Optional, string)*: The source text for which the suggestions should be returned.
|
||||
** *`typed_keys` (Optional, boolean)*: Specify whether aggregation and suggester names should be prefixed by their respective types in the response
|
||||
** *`rest_total_hits_as_int` (Optional, boolean)*
|
||||
** *`rest_total_hits_as_int` (Optional, boolean)*: Indicates whether hits.total should be rendered as an integer or an object in the rest search response
|
||||
** *`_source_excludes` (Optional, string | string[])*: A list of fields to exclude from the returned _source field
|
||||
** *`_source_includes` (Optional, string | string[])*: A list of fields to extract and return from the _source field
|
||||
** *`q` (Optional, string)*: Query in the Lucene query string syntax
|
||||
@ -1690,6 +1693,9 @@ client.autoscaling.deleteAutoscalingPolicy({ name })
|
||||
|
||||
* *Request (object):*
|
||||
** *`name` (string)*: the name of the autoscaling policy
|
||||
** *`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.
|
||||
** *`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.
|
||||
|
||||
[discrete]
|
||||
==== get_autoscaling_capacity
|
||||
@ -1711,9 +1717,15 @@ Do not use this information to make autoscaling decisions.
|
||||
{ref}/autoscaling-get-autoscaling-capacity.html[Endpoint documentation]
|
||||
[source,ts]
|
||||
----
|
||||
client.autoscaling.getAutoscalingCapacity()
|
||||
client.autoscaling.getAutoscalingCapacity({ ... })
|
||||
----
|
||||
|
||||
[discrete]
|
||||
==== Arguments
|
||||
|
||||
* *Request (object):*
|
||||
** *`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.
|
||||
|
||||
[discrete]
|
||||
==== get_autoscaling_policy
|
||||
@ -1732,6 +1744,8 @@ client.autoscaling.getAutoscalingPolicy({ name })
|
||||
|
||||
* *Request (object):*
|
||||
** *`name` (string)*: the name of the autoscaling policy
|
||||
** *`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.
|
||||
|
||||
[discrete]
|
||||
==== put_autoscaling_policy
|
||||
@ -1751,6 +1765,9 @@ client.autoscaling.putAutoscalingPolicy({ name })
|
||||
* *Request (object):*
|
||||
** *`name` (string)*: the name of the autoscaling policy
|
||||
** *`policy` (Optional, { roles, deciders })*
|
||||
** *`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.
|
||||
** *`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.
|
||||
|
||||
[discrete]
|
||||
=== cat
|
||||
@ -9204,7 +9221,7 @@ client.security.bulkPutRole({ roles })
|
||||
==== Arguments
|
||||
|
||||
* *Request (object):*
|
||||
** *`roles` (Record<string, { cluster, indices, remote_indices, remote_cluster, global, applications, metadata, run_as, description, transient_metadata }>)*: A dictionary of role name to RoleDescriptor objects to add or update
|
||||
** *`roles` (Record<string, { cluster, indices, remote_indices, remote_cluster, global, applications, metadata, run_as, description, restriction, transient_metadata }>)*: A dictionary of role name to RoleDescriptor objects to add or update
|
||||
** *`refresh` (Optional, Enum(true | false | "wait_for"))*: If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.
|
||||
|
||||
[discrete]
|
||||
@ -9361,7 +9378,7 @@ client.security.createApiKey({ ... })
|
||||
* *Request (object):*
|
||||
** *`expiration` (Optional, string | -1 | 0)*: Expiration time for the API key. By default, API keys never expire.
|
||||
** *`name` (Optional, string)*: Specifies the name for this API key.
|
||||
** *`role_descriptors` (Optional, Record<string, { cluster, indices, remote_indices, remote_cluster, global, applications, metadata, run_as, description, transient_metadata }>)*: An array of role descriptors for this API key. This parameter is optional. When it is not specified or is an empty array, then the API key will have a point in time snapshot of permissions of the authenticated user. If you supply role descriptors then the resultant permissions would be an intersection of API keys permissions and authenticated user’s permissions thereby limiting the access scope for API keys. The structure of role descriptor is the same as the request for create role API. For more details, see create or update roles API.
|
||||
** *`role_descriptors` (Optional, Record<string, { cluster, indices, remote_indices, remote_cluster, global, applications, metadata, run_as, description, restriction, transient_metadata }>)*: An array of role descriptors for this API key. This parameter is optional. When it is not specified or is an empty array, then the API key will have a point in time snapshot of permissions of the authenticated user. If you supply role descriptors then the resultant permissions would be an intersection of API keys permissions and authenticated user’s permissions thereby limiting the access scope for API keys. The structure of role descriptor is the same as the request for create role API. For more details, see create or update roles API.
|
||||
** *`metadata` (Optional, Record<string, User-defined value>)*: Arbitrary metadata that you want to associate with the API key. It supports nested data structure. Within the metadata object, keys beginning with `_` are reserved for system usage.
|
||||
** *`refresh` (Optional, Enum(true | false | "wait_for"))*: If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.
|
||||
|
||||
@ -10431,7 +10448,7 @@ client.security.updateApiKey({ id })
|
||||
|
||||
* *Request (object):*
|
||||
** *`id` (string)*: The ID of the API key to update.
|
||||
** *`role_descriptors` (Optional, Record<string, { cluster, indices, remote_indices, remote_cluster, global, applications, metadata, run_as, description, transient_metadata }>)*: An array of role descriptors for this API key. This parameter is optional. When it is not specified or is an empty array, then the API key will have a point in time snapshot of permissions of the authenticated user. If you supply role descriptors then the resultant permissions would be an intersection of API keys permissions and authenticated user’s permissions thereby limiting the access scope for API keys. The structure of role descriptor is the same as the request for create role API. For more details, see create or update roles API.
|
||||
** *`role_descriptors` (Optional, Record<string, { cluster, indices, remote_indices, remote_cluster, global, applications, metadata, run_as, description, restriction, transient_metadata }>)*: An array of role descriptors for this API key. This parameter is optional. When it is not specified or is an empty array, then the API key will have a point in time snapshot of permissions of the authenticated user. If you supply role descriptors then the resultant permissions would be an intersection of API keys permissions and authenticated user’s permissions thereby limiting the access scope for API keys. The structure of role descriptor is the same as the request for create role API. For more details, see create or update roles API.
|
||||
** *`metadata` (Optional, Record<string, User-defined value>)*: Arbitrary metadata that you want to associate with the API key. It supports nested data structure. Within the metadata object, keys beginning with _ are reserved for system usage.
|
||||
** *`expiration` (Optional, string | -1 | 0)*: Expiration time for the API key.
|
||||
|
||||
|
||||
@ -498,6 +498,15 @@ export interface HealthReportDiskIndicatorDetails {
|
||||
nodes_with_unknown_disk_status: long
|
||||
}
|
||||
|
||||
export interface HealthReportFileSettingsIndicator extends HealthReportBaseIndicator {
|
||||
details?: HealthReportFileSettingsIndicatorDetails
|
||||
}
|
||||
|
||||
export interface HealthReportFileSettingsIndicatorDetails {
|
||||
failure_streak: long
|
||||
most_recent_failure: string
|
||||
}
|
||||
|
||||
export interface HealthReportIlmIndicator extends HealthReportBaseIndicator {
|
||||
details?: HealthReportIlmIndicatorDetails
|
||||
}
|
||||
@ -533,6 +542,7 @@ export interface HealthReportIndicators {
|
||||
ilm?: HealthReportIlmIndicator
|
||||
slm?: HealthReportSlmIndicator
|
||||
shards_capacity?: HealthReportShardsCapacityIndicator
|
||||
file_settings?: HealthReportFileSettingsIndicator
|
||||
}
|
||||
|
||||
export interface HealthReportMasterIsStableIndicator extends HealthReportBaseIndicator {
|
||||
@ -884,6 +894,7 @@ export interface OpenPointInTimeRequest extends RequestBase {
|
||||
preference?: string
|
||||
routing?: Routing
|
||||
expand_wildcards?: ExpandWildcards
|
||||
allow_partial_search_results?: boolean
|
||||
index_filter?: QueryDslQueryContainer
|
||||
}
|
||||
|
||||
@ -6663,6 +6674,7 @@ export type AsyncSearchGetResponse<TDocument = unknown, TAggregations = Record<A
|
||||
|
||||
export interface AsyncSearchStatusRequest extends RequestBase {
|
||||
id: Id
|
||||
keep_alive?: Duration
|
||||
}
|
||||
|
||||
export type AsyncSearchStatusResponse = AsyncSearchStatusStatusResponseBase
|
||||
@ -6695,7 +6707,6 @@ export interface AsyncSearchSubmitRequest extends RequestBase {
|
||||
pre_filter_shard_size?: long
|
||||
request_cache?: boolean
|
||||
routing?: Routing
|
||||
scroll?: Duration
|
||||
search_type?: SearchType
|
||||
suggest_field?: Field
|
||||
suggest_mode?: SuggestMode
|
||||
@ -6751,6 +6762,8 @@ export interface AutoscalingAutoscalingPolicy {
|
||||
|
||||
export interface AutoscalingDeleteAutoscalingPolicyRequest extends RequestBase {
|
||||
name: Name
|
||||
master_timeout?: Duration
|
||||
timeout?: Duration
|
||||
}
|
||||
|
||||
export type AutoscalingDeleteAutoscalingPolicyResponse = AcknowledgedResponseBase
|
||||
@ -6783,6 +6796,7 @@ export interface AutoscalingGetAutoscalingCapacityAutoscalingResources {
|
||||
}
|
||||
|
||||
export interface AutoscalingGetAutoscalingCapacityRequest extends RequestBase {
|
||||
master_timeout?: Duration
|
||||
}
|
||||
|
||||
export interface AutoscalingGetAutoscalingCapacityResponse {
|
||||
@ -6791,12 +6805,15 @@ export interface AutoscalingGetAutoscalingCapacityResponse {
|
||||
|
||||
export interface AutoscalingGetAutoscalingPolicyRequest extends RequestBase {
|
||||
name: Name
|
||||
master_timeout?: Duration
|
||||
}
|
||||
|
||||
export type AutoscalingGetAutoscalingPolicyResponse = AutoscalingAutoscalingPolicy
|
||||
|
||||
export interface AutoscalingPutAutoscalingPolicyRequest extends RequestBase {
|
||||
name: Name
|
||||
master_timeout?: Duration
|
||||
timeout?: Duration
|
||||
policy?: AutoscalingAutoscalingPolicy
|
||||
}
|
||||
|
||||
@ -16870,6 +16887,7 @@ export interface QueryRulesListRulesetsQueryRulesetListItem {
|
||||
ruleset_id: Id
|
||||
rule_total_count: integer
|
||||
rule_criteria_types_counts: Record<string, integer>
|
||||
rule_type_counts: Record<string, integer>
|
||||
}
|
||||
|
||||
export interface QueryRulesListRulesetsRequest extends RequestBase {
|
||||
@ -17267,21 +17285,26 @@ export interface SecurityAccess {
|
||||
}
|
||||
|
||||
export interface SecurityApiKey {
|
||||
creation?: long
|
||||
expiration?: long
|
||||
id: Id
|
||||
invalidated?: boolean
|
||||
name: Name
|
||||
realm?: string
|
||||
type: SecurityApiKeyType
|
||||
creation: EpochTime<UnitMillis>
|
||||
expiration?: EpochTime<UnitMillis>
|
||||
invalidated: boolean
|
||||
invalidation?: EpochTime<UnitMillis>
|
||||
username: Username
|
||||
realm: string
|
||||
realm_type?: string
|
||||
username?: Username
|
||||
profile_uid?: string
|
||||
metadata?: Metadata
|
||||
metadata: Metadata
|
||||
role_descriptors?: Record<string, SecurityRoleDescriptor>
|
||||
limited_by?: Record<string, SecurityRoleDescriptor>[]
|
||||
access?: SecurityAccess
|
||||
profile_uid?: string
|
||||
_sort?: SortResults
|
||||
}
|
||||
|
||||
export type SecurityApiKeyType = 'rest' | 'cross_cluster'
|
||||
|
||||
export interface SecurityApplicationGlobalUserPrivileges {
|
||||
manage: SecurityManageUserPrivileges
|
||||
}
|
||||
@ -17328,7 +17351,7 @@ export type SecurityIndexPrivilege = 'all' | 'auto_configure' | 'create' | 'crea
|
||||
|
||||
export interface SecurityIndicesPrivileges {
|
||||
field_security?: SecurityFieldSecurity
|
||||
names: IndexName[]
|
||||
names: IndexName | IndexName[]
|
||||
privileges: SecurityIndexPrivilege[]
|
||||
query?: SecurityIndicesPrivilegesQuery
|
||||
allow_restricted_indices?: boolean
|
||||
@ -17355,17 +17378,23 @@ export interface SecurityRemoteClusterPrivileges {
|
||||
export interface SecurityRemoteIndicesPrivileges {
|
||||
clusters: Names
|
||||
field_security?: SecurityFieldSecurity
|
||||
names: IndexName[]
|
||||
names: IndexName | IndexName[]
|
||||
privileges: SecurityIndexPrivilege[]
|
||||
query?: SecurityIndicesPrivilegesQuery
|
||||
allow_restricted_indices?: boolean
|
||||
}
|
||||
|
||||
export interface SecurityReplicationAccess {
|
||||
names: IndexName[]
|
||||
names: IndexName | IndexName[]
|
||||
allow_restricted_indices?: boolean
|
||||
}
|
||||
|
||||
export interface SecurityRestriction {
|
||||
workflows: SecurityRestrictionWorkflow[]
|
||||
}
|
||||
|
||||
export type SecurityRestrictionWorkflow = 'search_application_query' | string
|
||||
|
||||
export interface SecurityRoleDescriptor {
|
||||
cluster?: SecurityClusterPrivilege[]
|
||||
indices?: SecurityIndicesPrivileges[]
|
||||
@ -17377,6 +17406,7 @@ export interface SecurityRoleDescriptor {
|
||||
metadata?: Metadata
|
||||
run_as?: string[]
|
||||
description?: string
|
||||
restriction?: SecurityRestriction
|
||||
transient_metadata?: Record<string, any>
|
||||
}
|
||||
|
||||
@ -17391,6 +17421,7 @@ export interface SecurityRoleDescriptorRead {
|
||||
metadata?: Metadata
|
||||
run_as?: string[]
|
||||
description?: string
|
||||
restriction?: SecurityRestriction
|
||||
transient_metadata?: Record<string, any>
|
||||
}
|
||||
|
||||
@ -17430,7 +17461,7 @@ export interface SecurityRoleTemplateScript {
|
||||
|
||||
export interface SecuritySearchAccess {
|
||||
field_security?: SecurityFieldSecurity
|
||||
names: IndexName[]
|
||||
names: IndexName | IndexName[]
|
||||
query?: SecurityIndicesPrivilegesQuery
|
||||
allow_restricted_indices?: boolean
|
||||
}
|
||||
@ -17449,7 +17480,7 @@ export interface SecurityUser {
|
||||
|
||||
export interface SecurityUserIndicesPrivileges {
|
||||
field_security?: SecurityFieldSecurity[]
|
||||
names: IndexName[]
|
||||
names: IndexName | IndexName[]
|
||||
privileges: SecurityIndexPrivilege[]
|
||||
query?: SecurityIndicesPrivilegesQuery[]
|
||||
allow_restricted_indices: boolean
|
||||
@ -17493,11 +17524,16 @@ export interface SecurityActivateUserProfileRequest extends RequestBase {
|
||||
|
||||
export type SecurityActivateUserProfileResponse = SecurityUserProfileWithMetadata
|
||||
|
||||
export interface SecurityAuthenticateAuthenticateApiKey {
|
||||
id: Id
|
||||
name?: Name
|
||||
}
|
||||
|
||||
export interface SecurityAuthenticateRequest extends RequestBase {
|
||||
}
|
||||
|
||||
export interface SecurityAuthenticateResponse {
|
||||
api_key?: SecurityApiKey
|
||||
api_key?: SecurityAuthenticateAuthenticateApiKey
|
||||
authentication_realm: SecurityRealmInfo
|
||||
email?: string | null
|
||||
full_name?: Name | null
|
||||
@ -19884,6 +19920,7 @@ export interface WatcherReportingEmailAttachment {
|
||||
export type WatcherResponseContentType = 'json' | 'yaml' | 'text'
|
||||
|
||||
export interface WatcherScheduleContainer {
|
||||
timezone?: string
|
||||
cron?: WatcherCronExpression
|
||||
daily?: WatcherDailySchedule
|
||||
hourly?: WatcherHourlySchedule
|
||||
|
||||
@ -519,6 +519,15 @@ export interface HealthReportDiskIndicatorDetails {
|
||||
nodes_with_unknown_disk_status: long
|
||||
}
|
||||
|
||||
export interface HealthReportFileSettingsIndicator extends HealthReportBaseIndicator {
|
||||
details?: HealthReportFileSettingsIndicatorDetails
|
||||
}
|
||||
|
||||
export interface HealthReportFileSettingsIndicatorDetails {
|
||||
failure_streak: long
|
||||
most_recent_failure: string
|
||||
}
|
||||
|
||||
export interface HealthReportIlmIndicator extends HealthReportBaseIndicator {
|
||||
details?: HealthReportIlmIndicatorDetails
|
||||
}
|
||||
@ -554,6 +563,7 @@ export interface HealthReportIndicators {
|
||||
ilm?: HealthReportIlmIndicator
|
||||
slm?: HealthReportSlmIndicator
|
||||
shards_capacity?: HealthReportShardsCapacityIndicator
|
||||
file_settings?: HealthReportFileSettingsIndicator
|
||||
}
|
||||
|
||||
export interface HealthReportMasterIsStableIndicator extends HealthReportBaseIndicator {
|
||||
@ -917,6 +927,7 @@ export interface OpenPointInTimeRequest extends RequestBase {
|
||||
preference?: string
|
||||
routing?: Routing
|
||||
expand_wildcards?: ExpandWildcards
|
||||
allow_partial_search_results?: boolean
|
||||
/** @deprecated The use of the 'body' key has been deprecated, move the nested keys to the top level object. */
|
||||
body?: {
|
||||
index_filter?: QueryDslQueryContainer
|
||||
@ -6739,6 +6750,7 @@ export type AsyncSearchGetResponse<TDocument = unknown, TAggregations = Record<A
|
||||
|
||||
export interface AsyncSearchStatusRequest extends RequestBase {
|
||||
id: Id
|
||||
keep_alive?: Duration
|
||||
}
|
||||
|
||||
export type AsyncSearchStatusResponse = AsyncSearchStatusStatusResponseBase
|
||||
@ -6771,7 +6783,6 @@ export interface AsyncSearchSubmitRequest extends RequestBase {
|
||||
pre_filter_shard_size?: long
|
||||
request_cache?: boolean
|
||||
routing?: Routing
|
||||
scroll?: Duration
|
||||
search_type?: SearchType
|
||||
suggest_field?: Field
|
||||
suggest_mode?: SuggestMode
|
||||
@ -6830,6 +6841,8 @@ export interface AutoscalingAutoscalingPolicy {
|
||||
|
||||
export interface AutoscalingDeleteAutoscalingPolicyRequest extends RequestBase {
|
||||
name: Name
|
||||
master_timeout?: Duration
|
||||
timeout?: Duration
|
||||
}
|
||||
|
||||
export type AutoscalingDeleteAutoscalingPolicyResponse = AcknowledgedResponseBase
|
||||
@ -6862,6 +6875,7 @@ export interface AutoscalingGetAutoscalingCapacityAutoscalingResources {
|
||||
}
|
||||
|
||||
export interface AutoscalingGetAutoscalingCapacityRequest extends RequestBase {
|
||||
master_timeout?: Duration
|
||||
}
|
||||
|
||||
export interface AutoscalingGetAutoscalingCapacityResponse {
|
||||
@ -6870,12 +6884,15 @@ export interface AutoscalingGetAutoscalingCapacityResponse {
|
||||
|
||||
export interface AutoscalingGetAutoscalingPolicyRequest extends RequestBase {
|
||||
name: Name
|
||||
master_timeout?: Duration
|
||||
}
|
||||
|
||||
export type AutoscalingGetAutoscalingPolicyResponse = AutoscalingAutoscalingPolicy
|
||||
|
||||
export interface AutoscalingPutAutoscalingPolicyRequest extends RequestBase {
|
||||
name: Name
|
||||
master_timeout?: Duration
|
||||
timeout?: Duration
|
||||
/** @deprecated The use of the 'body' key has been deprecated, use 'policy' instead. */
|
||||
body?: AutoscalingAutoscalingPolicy
|
||||
}
|
||||
@ -17226,6 +17243,7 @@ export interface QueryRulesListRulesetsQueryRulesetListItem {
|
||||
ruleset_id: Id
|
||||
rule_total_count: integer
|
||||
rule_criteria_types_counts: Record<string, integer>
|
||||
rule_type_counts: Record<string, integer>
|
||||
}
|
||||
|
||||
export interface QueryRulesListRulesetsRequest extends RequestBase {
|
||||
@ -17645,21 +17663,26 @@ export interface SecurityAccess {
|
||||
}
|
||||
|
||||
export interface SecurityApiKey {
|
||||
creation?: long
|
||||
expiration?: long
|
||||
id: Id
|
||||
invalidated?: boolean
|
||||
name: Name
|
||||
realm?: string
|
||||
type: SecurityApiKeyType
|
||||
creation: EpochTime<UnitMillis>
|
||||
expiration?: EpochTime<UnitMillis>
|
||||
invalidated: boolean
|
||||
invalidation?: EpochTime<UnitMillis>
|
||||
username: Username
|
||||
realm: string
|
||||
realm_type?: string
|
||||
username?: Username
|
||||
profile_uid?: string
|
||||
metadata?: Metadata
|
||||
metadata: Metadata
|
||||
role_descriptors?: Record<string, SecurityRoleDescriptor>
|
||||
limited_by?: Record<string, SecurityRoleDescriptor>[]
|
||||
access?: SecurityAccess
|
||||
profile_uid?: string
|
||||
_sort?: SortResults
|
||||
}
|
||||
|
||||
export type SecurityApiKeyType = 'rest' | 'cross_cluster'
|
||||
|
||||
export interface SecurityApplicationGlobalUserPrivileges {
|
||||
manage: SecurityManageUserPrivileges
|
||||
}
|
||||
@ -17706,7 +17729,7 @@ export type SecurityIndexPrivilege = 'all' | 'auto_configure' | 'create' | 'crea
|
||||
|
||||
export interface SecurityIndicesPrivileges {
|
||||
field_security?: SecurityFieldSecurity
|
||||
names: IndexName[]
|
||||
names: IndexName | IndexName[]
|
||||
privileges: SecurityIndexPrivilege[]
|
||||
query?: SecurityIndicesPrivilegesQuery
|
||||
allow_restricted_indices?: boolean
|
||||
@ -17733,17 +17756,23 @@ export interface SecurityRemoteClusterPrivileges {
|
||||
export interface SecurityRemoteIndicesPrivileges {
|
||||
clusters: Names
|
||||
field_security?: SecurityFieldSecurity
|
||||
names: IndexName[]
|
||||
names: IndexName | IndexName[]
|
||||
privileges: SecurityIndexPrivilege[]
|
||||
query?: SecurityIndicesPrivilegesQuery
|
||||
allow_restricted_indices?: boolean
|
||||
}
|
||||
|
||||
export interface SecurityReplicationAccess {
|
||||
names: IndexName[]
|
||||
names: IndexName | IndexName[]
|
||||
allow_restricted_indices?: boolean
|
||||
}
|
||||
|
||||
export interface SecurityRestriction {
|
||||
workflows: SecurityRestrictionWorkflow[]
|
||||
}
|
||||
|
||||
export type SecurityRestrictionWorkflow = 'search_application_query' | string
|
||||
|
||||
export interface SecurityRoleDescriptor {
|
||||
cluster?: SecurityClusterPrivilege[]
|
||||
indices?: SecurityIndicesPrivileges[]
|
||||
@ -17755,6 +17784,7 @@ export interface SecurityRoleDescriptor {
|
||||
metadata?: Metadata
|
||||
run_as?: string[]
|
||||
description?: string
|
||||
restriction?: SecurityRestriction
|
||||
transient_metadata?: Record<string, any>
|
||||
}
|
||||
|
||||
@ -17769,6 +17799,7 @@ export interface SecurityRoleDescriptorRead {
|
||||
metadata?: Metadata
|
||||
run_as?: string[]
|
||||
description?: string
|
||||
restriction?: SecurityRestriction
|
||||
transient_metadata?: Record<string, any>
|
||||
}
|
||||
|
||||
@ -17808,7 +17839,7 @@ export interface SecurityRoleTemplateScript {
|
||||
|
||||
export interface SecuritySearchAccess {
|
||||
field_security?: SecurityFieldSecurity
|
||||
names: IndexName[]
|
||||
names: IndexName | IndexName[]
|
||||
query?: SecurityIndicesPrivilegesQuery
|
||||
allow_restricted_indices?: boolean
|
||||
}
|
||||
@ -17827,7 +17858,7 @@ export interface SecurityUser {
|
||||
|
||||
export interface SecurityUserIndicesPrivileges {
|
||||
field_security?: SecurityFieldSecurity[]
|
||||
names: IndexName[]
|
||||
names: IndexName | IndexName[]
|
||||
privileges: SecurityIndexPrivilege[]
|
||||
query?: SecurityIndicesPrivilegesQuery[]
|
||||
allow_restricted_indices: boolean
|
||||
@ -17874,11 +17905,16 @@ export interface SecurityActivateUserProfileRequest extends RequestBase {
|
||||
|
||||
export type SecurityActivateUserProfileResponse = SecurityUserProfileWithMetadata
|
||||
|
||||
export interface SecurityAuthenticateAuthenticateApiKey {
|
||||
id: Id
|
||||
name?: Name
|
||||
}
|
||||
|
||||
export interface SecurityAuthenticateRequest extends RequestBase {
|
||||
}
|
||||
|
||||
export interface SecurityAuthenticateResponse {
|
||||
api_key?: SecurityApiKey
|
||||
api_key?: SecurityAuthenticateAuthenticateApiKey
|
||||
authentication_realm: SecurityRealmInfo
|
||||
email?: string | null
|
||||
full_name?: Name | null
|
||||
@ -20389,6 +20425,7 @@ export interface WatcherReportingEmailAttachment {
|
||||
export type WatcherResponseContentType = 'json' | 'yaml' | 'text'
|
||||
|
||||
export interface WatcherScheduleContainer {
|
||||
timezone?: string
|
||||
cron?: WatcherCronExpression
|
||||
daily?: WatcherDailySchedule
|
||||
hourly?: WatcherHourlySchedule
|
||||
|
||||
Reference in New Issue
Block a user