Auto-generated API code

elastic · Dec 2, 2024 · 0023d03 · 0023d03
1 parent 7d4ae5e
commit 0023d03
Show file tree

Hide file tree

Showing 60 changed files with 1,007 additions and 106 deletions.
diff --git a/docs/doc_examples/015e6e6132b6d6d44bddb06bc3b316ed.asciidoc b/docs/doc_examples/015e6e6132b6d6d44bddb06bc3b316ed.asciidoc
@@ -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);
+----
diff --git a/docs/doc_examples/0165d22da5f2fc7678392b31d8eb5566.asciidoc b/docs/doc_examples/0165d22da5f2fc7678392b31d8eb5566.asciidoc
@@ -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);
+----
diff --git a/docs/doc_examples/0bc6155e0c88062a4d8490da49db3aa8.asciidoc b/docs/doc_examples/0bc6155e0c88062a4d8490da49db3aa8.asciidoc
@@ -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);
+----
diff --git a/docs/doc_examples/0bee07a581c5776e068f6f4efad5a399.asciidoc b/docs/doc_examples/0bee07a581c5776e068f6f4efad5a399.asciidoc
@@ -3,8 +3,12 @@
 
 [source, js]
 ----
-const response = await client.esql.asyncQuery({
-  format: "json",
+const response = await client.transport.request({
+  method: "POST",
+  path: "/_query/async",
+  querystring: {
+    format: "json",
+  },
   body: {
     query:
       "\n    FROM my-index-000001,cluster_one:my-index-000001,cluster_two:my-index*\n    | STATS COUNT(http.response.status_code) BY user.id\n    | LIMIT 2\n  ",

diff --git a/docs/doc_examples/0d689ac6e78be5d438f9b5d441be2b44.asciidoc b/docs/doc_examples/0d689ac6e78be5d438f9b5d441be2b44.asciidoc
@@ -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);
+----
diff --git a/docs/doc_examples/0dfde6a9d953822fd4b3aa0121ddd8fb.asciidoc b/docs/doc_examples/0dfde6a9d953822fd4b3aa0121ddd8fb.asciidoc
@@ -3,8 +3,9 @@
 
 [source, js]
 ----
-const response = await client.searchApplication.renderQuery({
-  name: "my-app",
+const response = await client.transport.request({
+  method: "POST",
+  path: "/_application/search_application/my-app/_render_query",
   body: {
     params: {
       query_string: "my first query",

diff --git a/docs/doc_examples/16634cfa7916cf4e8048a1d70e6240f2.asciidoc b/docs/doc_examples/16634cfa7916cf4e8048a1d70e6240f2.asciidoc
@@ -11,7 +11,7 @@ const response = await client.searchApplication.put({
       script: {
         lang: "mustache",
         source:
-          '\n        {\n          "query": {\n            "bool": {\n              "must": [\n              {{#query}}\n                \n              {{/query}}\n            ],\n            "filter": {{#toJson}}_es_filters{{/toJson}}\n            }\n          },\n          "_source": {\n            "includes": ["title", "plot"]\n            },\n            "highlight": {\n              "fields": {\n                "title": { "fragment_size": 0 },\n                "plot": { "fragment_size": 200 }\n                }\n                },\n                "aggs": {{#toJson}}_es_aggs{{/toJson}},\n                "from": {{from}},\n                "size": {{size}},\n                "sort": {{#toJson}}_es_sort_fields{{/toJson}}\n                }\n                ',
+          '\n        {\n          "query": {\n            "bool": {\n              "must": [\n              {{#query}}\n              {{/query}}\n            ],\n            "filter": {{#toJson}}_es_filters{{/toJson}}\n            }\n          },\n          "_source": {\n            "includes": ["title", "plot"]\n            },\n            "highlight": {\n              "fields": {\n                "title": { "fragment_size": 0 },\n                "plot": { "fragment_size": 200 }\n                }\n                },\n                "aggs": {{#toJson}}_es_aggs{{/toJson}},\n                "from": {{from}},\n                "size": {{size}},\n                "sort": {{#toJson}}_es_sort_fields{{/toJson}}\n                }\n                ',
         params: {
           query: "",
           _es_filters: {},

diff --git a/...c02c2916b97b6fa7db82dbc7f0378310.asciidoc → ...17b1647c8509543f2388c886f2584a20.asciidoc b/...c02c2916b97b6fa7db82dbc7f0378310.asciidoc → ...17b1647c8509543f2388c886f2584a20.asciidoc
@@ -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,

diff --git a/docs/doc_examples/19c00c6b29bc7dbc5e92b3668da2da93.asciidoc b/docs/doc_examples/19c00c6b29bc7dbc5e92b3668da2da93.asciidoc
@@ -3,7 +3,9 @@
 
 [source, js]
 ----
-const response = await client.simulate.ingest({
+const response = await client.transport.request({
+  method: "POST",
+  path: "/_ingest/_simulate",
   body: {
     docs: [
       {

diff --git a/...4dab4c5168047ba596af1beb0e55b845.asciidoc → ...22b176a184517cf1b5801f5eb4f17f97.asciidoc b/...4dab4c5168047ba596af1beb0e55b845.asciidoc → ...22b176a184517cf1b5801f5eb4f17f97.asciidoc
@@ -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);
 ----
diff --git a/docs/doc_examples/2577acb462b95bd4394523cf2f8a661f.asciidoc b/docs/doc_examples/2577acb462b95bd4394523cf2f8a661f.asciidoc
diff --git a/docs/doc_examples/2a1eece9a59ac1773edcf0a932c26de0.asciidoc b/docs/doc_examples/2a1eece9a59ac1773edcf0a932c26de0.asciidoc
@@ -3,7 +3,9 @@
 
 [source, js]
 ----
-const response = await client.security.oidcLogout({
+const response = await client.transport.request({
+  method: "POST",
+  path: "/_security/oidc/logout",
   body: {
     token:
       "dGhpcyBpcyBub3QgYSByZWFsIHRva2VuIGJ1dCBpdCBpcyBvbmx5IHRlc3QgZGF0YS4gZG8gbm90IHRyeSB0byByZWFkIHRva2VuIQ==",

diff --git a/docs/doc_examples/2afdf0d83724953aa2875b5fb37d60cc.asciidoc b/docs/doc_examples/2afdf0d83724953aa2875b5fb37d60cc.asciidoc
@@ -3,10 +3,12 @@
 
 [source, js]
 ----
-const response = await client.esql.asyncQueryGet({
-  id: "FmNJRUZ1YWZCU3dHY1BIOUhaenVSRkEaaXFlZ3h4c1RTWFNocDdnY2FSaERnUTozNDE=",
-  wait_for_completion_timeout: "30s",
-  body: null,
+const response = await client.transport.request({
+  method: "GET",
+  path: "/_query/async/FmNJRUZ1YWZCU3dHY1BIOUhaenVSRkEaaXFlZ3h4c1RTWFNocDdnY2FSaERnUTozNDE&#x3D;",
+  querystring: {
+    wait_for_completion_timeout: "30s",
+  },
 });
 console.log(response);
 ----
diff --git a/docs/doc_examples/2bb41b0b4876ce98cd0cd8fb6d337f18.asciidoc b/docs/doc_examples/2bb41b0b4876ce98cd0cd8fb6d337f18.asciidoc
diff --git a/docs/doc_examples/30d051f534aeb884176eedb2c11dac85.asciidoc b/docs/doc_examples/30d051f534aeb884176eedb2c11dac85.asciidoc
@@ -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);
+----
diff --git a/docs/doc_examples/3f1fe5f5f99b98d0891f38003e10b636.asciidoc b/docs/doc_examples/3f1fe5f5f99b98d0891f38003e10b636.asciidoc
@@ -3,7 +3,9 @@
 
 [source, js]
 ----
-const response = await client.esql.asyncQuery({
+const response = await client.transport.request({
+  method: "POST",
+  path: "/_query/async",
   body: {
     query:
       "\n    FROM library\n    | EVAL year = DATE_TRUNC(1 YEARS, release_date)\n    | STATS MAX(page_count) BY year\n    | SORT year\n    | LIMIT 5\n  ",

diff --git a/docs/doc_examples/405511f7c1f12cc0a227b4563fe7b2e2.asciidoc b/docs/doc_examples/405511f7c1f12cc0a227b4563fe7b2e2.asciidoc
@@ -3,9 +3,9 @@
 
 [source, js]
 ----
-const response = await client.esql.asyncQueryGet({
-  id: "FkpMRkJGS1gzVDRlM3g4ZzMyRGlLbkEaTXlJZHdNT09TU2VTZVBoNDM3cFZMUToxMDM=",
-  body: null,
+const response = await client.transport.request({
+  method: "GET",
+  path: "/_query/async/FkpMRkJGS1gzVDRlM3g4ZzMyRGlLbkEaTXlJZHdNT09TU2VTZVBoNDM3cFZMUToxMDM&#x3D;",
 });
 console.log(response);
 ----
diff --git a/docs/doc_examples/4b91ad7c9b44e07db4a4e81390f19ad3.asciidoc b/docs/doc_examples/4b91ad7c9b44e07db4a4e81390f19ad3.asciidoc
@@ -3,9 +3,9 @@
 
 [source, js]
 ----
-const response = await client.inference.streamInference({
-  task_type: "completion",
-  inference_id: "openai-completion",
+const response = await client.transport.request({
+  method: "POST",
+  path: "/_inference/completion/openai-completion/_stream",
   body: {
     input: "What is Elastic?",
   },

diff --git a/...191074b2eebd5f74e628c2ada4b6d2e4.asciidoc → ...4edfb5934d14ad7655bd7e19a112b5c0.asciidoc b/...191074b2eebd5f74e628c2ada4b6d2e4.asciidoc → ...4edfb5934d14ad7655bd7e19a112b5c0.asciidoc
@@ -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",