[docs] Migrate docs from AsciiDoc to Markdown (#2635)

* delete asciidoc files * add migrated files * Apply suggestions from review Co-authored-by: Josh Mock <josh@joshmock.com> * Apply suggestions from review Co-authored-by: Josh Mock <josh@joshmock.com> * add the new ci checks (#2634) --------- Co-authored-by: Marci W <333176+marciw@users.noreply.github.com> Co-authored-by: Josh Mock <josh@joshmock.com>
2025-02-27 11:51:14 -06:00
parent ac231c859e
commit 3e5e568c07
142 changed files with 18203 additions and 31131 deletions
--- a/docs/reference/suggest_examples.md
+++ b/docs/reference/suggest_examples.md
@ -0,0 +1,68 @@
+---
+mapped_pages:
+  - https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/suggest_examples.html
+---
+
+# Suggest [suggest_examples]
+
+The suggest feature suggests similar looking terms based on a provided text by using a suggester. *Parts of the suggest feature are still under development.*
+
+The suggest request part is defined alongside the query part in a `search` request. If the query part is left out, only suggestions are returned.
+
+```js
+'use strict'
+
+const { Client } = require('@elastic/elasticsearch')
+const client = new Client({
+  cloud: { id: '<cloud-id>' },
+  auth: { apiKey: 'base64EncodedKey' }
+})
+
+async function run () {
+  const bulkResponse = await client.bulk({
+    refresh: true,
+    operations: [
+      { index: { _index: 'game-of-thrones' } },
+      {
+        character: 'Ned Stark',
+        quote: 'Winter is coming.'
+      },
+
+      { index: { _index: 'game-of-thrones' } },
+      {
+        character: 'Daenerys Targaryen',
+        quote: 'I am the blood of the dragon.'
+      },
+
+      { index: { _index: 'game-of-thrones' } },
+      {
+        character: 'Tyrion Lannister',
+        quote: 'A mind needs books like a sword needs a whetstone.'
+      }
+    ]
+  })
+
+  if (bulkResponse.errors) {
+    console.log(bulkResponse)
+    process.exit(1)
+  }
+
+  const result = await client.search({
+    index: 'game-of-thrones',
+    query: {
+      match: { quote: 'winter' }
+    },
+    suggest: {
+      gotsuggest: {
+        text: 'winter',
+        term: { field: 'quote' }
+      }
+    }
+  })
+
+  console.log(result)
+}
+
+run().catch(console.log)
+```
+