[Backport 8.14] adding index module code examples (#2559)

* adding index module code examples (#2554) * adding index module code examples * adding trailing comma (cherry picked from commit 3a1cd62) * Run examples generation again --------- Co-authored-by: Annie Hansen <annie.gale@elastic.co> Co-authored-by: Quentin Pradet <quentin.pradet@elastic.co>
elastic · Jun 6, 2024 · 0ecc91b · 0ecc91b
1 parent 728c616
commit 0ecc91b
Show file tree

Hide file tree

Showing 80 changed files with 599 additions and 173 deletions.
diff --git a/docs/examples/00fea15cbca83be9d5f1a024ff2ec708.asciidoc b/docs/examples/00fea15cbca83be9d5f1a024ff2ec708.asciidoc
@@ -1,4 +1,4 @@
-// inference/put-inference.asciidoc:275
+// inference/put-inference.asciidoc:452
 
 [source, python]
 ----

diff --git a/docs/examples/0e5db64154a722a5cbdb84b588ce2ce8.asciidoc b/docs/examples/0e5db64154a722a5cbdb84b588ce2ce8.asciidoc
@@ -1,4 +1,4 @@
-// mapping/types/numeric.asciidoc:275
+// mapping/types/numeric.asciidoc:287
 
 [source, python]
 ----

diff --git a/docs/examples/10c3fe2265bb34964bd1005f9da66773.asciidoc b/docs/examples/10c3fe2265bb34964bd1005f9da66773.asciidoc
@@ -1,4 +1,4 @@
-// inference/put-inference.asciidoc:369
+// inference/put-inference.asciidoc:559
 
 [source, python]
 ----

diff --git a/docs/examples/13ecdf99114098c76b050397d9c3d4e6.asciidoc b/docs/examples/13ecdf99114098c76b050397d9c3d4e6.asciidoc
@@ -1,4 +1,4 @@
-// inference/post-inference.asciidoc:73
+// inference/post-inference.asciidoc:197
 
 [source, python]
 ----

diff --git a/docs/examples/156bc64c94f9f3334fbce25165d2286a.asciidoc b/docs/examples/156bc64c94f9f3334fbce25165d2286a.asciidoc
@@ -0,0 +1,15 @@
+// index-modules/index-sorting.asciidoc:16
+
+[source, python]
+----
+resp = client.indices.create(
+    index="my-index-000001",
+    body={
+        "settings": {
+            "index": {"sort.field": "date", "sort.order": "desc"}
+        },
+        "mappings": {"properties": {"date": {"type": "date"}}},
+    },
+)
+print(resp)
+----
diff --git a/docs/examples/17e6f3fac556f08a78f7a876e71acb89.asciidoc b/docs/examples/17e6f3fac556f08a78f7a876e71acb89.asciidoc
@@ -0,0 +1,12 @@
+// index-modules/allocation/delayed.asciidoc:40
+
+[source, python]
+----
+resp = client.indices.put_settings(
+    index="_all",
+    body={
+        "settings": {"index.unassigned.node_left.delayed_timeout": "5m"}
+    },
+)
+print(resp)
+----
diff --git a/docs/examples/197dc41c8df9629e145b3064c63b2ccc.asciidoc b/docs/examples/197dc41c8df9629e145b3064c63b2ccc.asciidoc
diff --git a/docs/examples/1aa91d3d48140d6367b6cabca8737b8f.asciidoc b/docs/examples/1aa91d3d48140d6367b6cabca8737b8f.asciidoc
@@ -1,4 +1,4 @@
-// docs/bulk.asciidoc:634
+// docs/bulk.asciidoc:632
 
 [source, python]
 ----

diff --git a/docs/examples/1dadb7efe27b6c0c231eb6535e413bd9.asciidoc b/docs/examples/1dadb7efe27b6c0c231eb6535e413bd9.asciidoc
@@ -0,0 +1,19 @@
+// inference/put-inference.asciidoc:671
+
+[source, python]
+----
+resp = client.inference.put_model(
+    task_type="text_embedding",
+    inference_id="azure_ai_studio_embeddings",
+    body={
+        "service": "azureaistudio",
+        "service_settings": {
+            "api_key": "<api_key>",
+            "target": "<target_uri>",
+            "provider": "<model_provider>",
+            "endpoint_type": "<endpoint_type>",
+        },
+    },
+)
+print(resp)
+----
diff --git a/docs/examples/2342a56279106ea643026df657bf7f88.asciidoc b/docs/examples/2342a56279106ea643026df657bf7f88.asciidoc
@@ -0,0 +1,24 @@
+// index-modules/similarity.asciidoc:22
+
+[source, python]
+----
+resp = client.indices.create(
+    index="index",
+    body={
+        "settings": {
+            "index": {
+                "similarity": {
+                    "my_similarity": {
+                        "type": "DFR",
+                        "basic_model": "g",
+                        "after_effect": "l",
+                        "normalization": "h2",
+                        "normalization.h2.c": "3.0",
+                    }
+                }
+            }
+        }
+    },
+)
+print(resp)
+----
diff --git a/docs/examples/23af230e824f48b9cd56a4cf973d788c.asciidoc b/docs/examples/23af230e824f48b9cd56a4cf973d788c.asciidoc
@@ -0,0 +1,19 @@
+// index-modules/slowlog.asciidoc:31
+
+[source, python]
+----
+resp = client.indices.put_settings(
+    index="my-index-000001",
+    body={
+        "index.search.slowlog.threshold.query.warn": "10s",
+        "index.search.slowlog.threshold.query.info": "5s",
+        "index.search.slowlog.threshold.query.debug": "2s",
+        "index.search.slowlog.threshold.query.trace": "500ms",
+        "index.search.slowlog.threshold.fetch.warn": "1s",
+        "index.search.slowlog.threshold.fetch.info": "800ms",
+        "index.search.slowlog.threshold.fetch.debug": "500ms",
+        "index.search.slowlog.threshold.fetch.trace": "200ms",
+    },
+)
+print(resp)
+----
diff --git a/docs/examples/25d40d3049e57e2bb70c2c5b88bd7b87.asciidoc b/docs/examples/25d40d3049e57e2bb70c2c5b88bd7b87.asciidoc
@@ -0,0 +1,10 @@
+// index-modules/allocation/delayed.asciidoc:95
+
+[source, python]
+----
+resp = client.indices.put_settings(
+    index="_all",
+    body={"settings": {"index.unassigned.node_left.delayed_timeout": "0"}},
+)
+print(resp)
+----
diff --git a/docs/examples/28ac880057135e46b3b00c7f3976538c.asciidoc b/docs/examples/28ac880057135e46b3b00c7f3976538c.asciidoc
@@ -0,0 +1,10 @@
+// index-modules/allocation/filtering.asciidoc:122
+
+[source, python]
+----
+resp = client.indices.put_settings(
+    index="test",
+    body={"index.routing.allocation.include._ip": "192.168.2.*"},
+)
+print(resp)
+----
diff --git a/docs/examples/2f07b81fd47ec3b074242a760f0c4e9e.asciidoc b/docs/examples/2f07b81fd47ec3b074242a760f0c4e9e.asciidoc
@@ -0,0 +1,10 @@
+// index-modules/slowlog.asciidoc:149
+
+[source, python]
+----
+resp = client.indices.put_settings(
+    index="my-index-000001",
+    body={"index.indexing.slowlog.include.user": True},
+)
+print(resp)
+----
diff --git a/docs/examples/316cd43feb3b86396483903af1a048b1.asciidoc b/docs/examples/316cd43feb3b86396483903af1a048b1.asciidoc
@@ -1,4 +1,4 @@
-// aggregations/bucket/datehistogram-aggregation.asciidoc:781
+// aggregations/bucket/datehistogram-aggregation.asciidoc:782
 
 [source, python]
 ----

diff --git a/docs/examples/34cdeefb09bbbe5206957a8bc1bd513d.asciidoc b/docs/examples/34cdeefb09bbbe5206957a8bc1bd513d.asciidoc
@@ -0,0 +1,10 @@
+// index-modules/slowlog.asciidoc:66
+
+[source, python]
+----
+resp = client.indices.put_settings(
+    index="my-index-000001",
+    body={"index.search.slowlog.include.user": True},
+)
+print(resp)
+----
diff --git a/docs/examples/3541d4a85e27b2c3896a7a7ee98b4b37.asciidoc b/docs/examples/3541d4a85e27b2c3896a7a7ee98b4b37.asciidoc
@@ -1,4 +1,4 @@
-// health/health.asciidoc:478
+// health/health.asciidoc:481
 
 [source, python]
 ----

diff --git a/docs/examples/36063ff9a318dba7bb0be3a230655dc8.asciidoc b/docs/examples/36063ff9a318dba7bb0be3a230655dc8.asciidoc
@@ -1,4 +1,4 @@
-// mapping/types/numeric.asciidoc:247
+// mapping/types/numeric.asciidoc:259
 
 [source, python]
 ----

diff --git a/docs/examples/36b86b97feedcf5632824eefc251d6ed.asciidoc b/docs/examples/36b86b97feedcf5632824eefc251d6ed.asciidoc
diff --git a/docs/examples/3d1ff6097e2359f927c88c2ccdb36252.asciidoc b/docs/examples/3d1ff6097e2359f927c88c2ccdb36252.asciidoc
diff --git a/docs/examples/3f3b3e207f79303ce6f86e03e928e062.asciidoc b/docs/examples/3f3b3e207f79303ce6f86e03e928e062.asciidoc
diff --git a/docs/examples/48de51de87a8ad9fd8b8db1ca25b85c1.asciidoc b/docs/examples/48de51de87a8ad9fd8b8db1ca25b85c1.asciidoc
@@ -0,0 +1,20 @@
+// index-modules/similarity.asciidoc:540
+
+[source, python]
+----
+resp = client.indices.close(
+    index="index",
+)
+print(resp)
+
+resp = client.indices.put_settings(
+    index="index",
+    body={"index": {"similarity": {"default": {"type": "boolean"}}}},
+)
+print(resp)
+
+resp = client.indices.open(
+    index="index",
+)
+print(resp)
+----
diff --git a/docs/examples/4ca15672fc5ab1d80a127d086b6d2837.asciidoc b/docs/examples/4ca15672fc5ab1d80a127d086b6d2837.asciidoc
@@ -1,4 +1,4 @@
-// cluster/allocation-explain.asciidoc:342
+// cluster/allocation-explain.asciidoc:344
 
 [source, python]
 ----

diff --git a/docs/examples/4e3414fc712b16311f9e433dd366f49d.asciidoc b/docs/examples/4e3414fc712b16311f9e433dd366f49d.asciidoc
@@ -1,4 +1,4 @@
-// inference/delete-inference.asciidoc:53
+// inference/delete-inference.asciidoc:55
 
 [source, python]
 ----

diff --git a/docs/examples/51b40610ae05730b4c6afd25647d7ae0.asciidoc b/docs/examples/51b40610ae05730b4c6afd25647d7ae0.asciidoc
@@ -1,4 +1,4 @@
-// aggregations/bucket/datehistogram-aggregation.asciidoc:488
+// aggregations/bucket/datehistogram-aggregation.asciidoc:489
 
 [source, python]
 ----

diff --git a/docs/examples/5203560189ccab7122c03500147701ef.asciidoc b/docs/examples/5203560189ccab7122c03500147701ef.asciidoc
@@ -1,4 +1,4 @@
-// aggregations/bucket/datehistogram-aggregation.asciidoc:568
+// aggregations/bucket/datehistogram-aggregation.asciidoc:569
 
 [source, python]
 ----

diff --git a/docs/examples/528e5f1c345c3769248cc6889e8cf552.asciidoc b/docs/examples/528e5f1c345c3769248cc6889e8cf552.asciidoc
@@ -0,0 +1,14 @@
+// index-modules/similarity.asciidoc:45
+
+[source, python]
+----
+resp = client.indices.put_mapping(
+    index="index",
+    body={
+        "properties": {
+            "title": {"type": "text", "similarity": "my_similarity"}
+        }
+    },
+)
+print(resp)
+----
diff --git a/docs/examples/553d79817bb1333970e99507c37a159a.asciidoc b/docs/examples/553d79817bb1333970e99507c37a159a.asciidoc
@@ -0,0 +1,14 @@
+// index-modules/similarity.asciidoc:520
+
+[source, python]
+----
+resp = client.indices.create(
+    index="index",
+    body={
+        "settings": {
+            "index": {"similarity": {"default": {"type": "boolean"}}}
+        }
+    },
+)
+print(resp)
+----
diff --git a/docs/examples/5553cf7a02c22f616cd994747f2dd5a5.asciidoc b/docs/examples/5553cf7a02c22f616cd994747f2dd5a5.asciidoc
@@ -1,4 +1,4 @@
-// mapping/types/nested.asciidoc:58
+// mapping/types/nested.asciidoc:60
 
 [source, python]
 ----

diff --git a/docs/examples/59d736a4d064ed2013c7ead8e32e0998.asciidoc b/docs/examples/59d736a4d064ed2013c7ead8e32e0998.asciidoc
@@ -0,0 +1,17 @@
+// inference/put-inference.asciidoc:600
+
+[source, python]
+----
+resp = client.inference.put_model(
+    task_type="completion",
+    inference_id="openai-completion",
+    body={
+        "service": "openai",
+        "service_settings": {
+            "api_key": "<api_key>",
+            "model_id": "gpt-3.5-turbo",
+        },
+    },
+)
+print(resp)
+----
diff --git a/docs/examples/5f8fb5513d4f725434db2f517ad4298f.asciidoc b/docs/examples/5f8fb5513d4f725434db2f517ad4298f.asciidoc
@@ -0,0 +1,30 @@
+// index-modules/similarity.asciidoc:357
+
+[source, python]
+----
+resp = client.indices.create(
+    index="index",
+    body={
+        "settings": {
+            "number_of_shards": 1,
+            "similarity": {
+                "scripted_tfidf": {
+                    "type": "scripted",
+                    "weight_script": {
+                        "source": "double idf = Math.log((field.docCount+1.0)/(term.docFreq+1.0)) + 1.0; return query.boost * idf;"
+                    },
+                    "script": {
+                        "source": "double tf = Math.sqrt(doc.freq); double norm = 1/Math.sqrt(doc.length); return weight * tf * norm;"
+                    },
+                }
+            },
+        },
+        "mappings": {
+            "properties": {
+                "field": {"type": "text", "similarity": "scripted_tfidf"}
+            }
+        },
+    },
+)
+print(resp)
+----
diff --git a/docs/examples/6cd083045bf06e80b83889a939a18451.asciidoc b/docs/examples/6cd083045bf06e80b83889a939a18451.asciidoc
@@ -1,4 +1,4 @@
-// mapping/types/nested.asciidoc:85
+// mapping/types/nested.asciidoc:87
 
 [source, python]
 ----