@elastic/enterprise-search
TypeScript icon, indicating that this package has built-in type declarations

8.18.0 • Public • Published

⚠️ App Search and Workplace Search will be discontinued in 9.0

Starting with Elastic version 9.0, the standalone Enterprise Search products, will no longer be included in our offering. They remain supported in their current form in version 8.x and will only receive security upgrades and fixes. Enterprise Search clients will continue to be supported in their current form throughout 8.x versions, according to our EOL policy. We recommend transitioning to our actively developed Elastic Stack tools for your search use cases. However, if you're still using any Enterprise Search products, we recommend using the latest stable release of the clients.

Here are some useful links with more information:

Elastic Enterprise Search

js-standard-style Build Status. Node CI

Official Node.js client for Elastic Enterprise Search, App Search, and Workplace Search.

ℹ️ Read the full documentation for this client at elastic.co.

Install

npm install @elastic/enterprise-search

Quick start

const { Client } = require('@elastic/enterprise-search')
const client = new Client({
  url: 'http://localhost:3002',
  // basic auth
  auth: {
    username: 'elastic',
    password: 'changeme'
  }
  // bearer auth
  auth: {
    token: 'my-token'
  }
})

// Enterprise Search API
const response = await client.enterprise.getHealth()
console.log(response)

// App Search API
const response = await client.app.search({
  engine_name: 'games',
  body: {
    query: 'Pack-Man'
  }
})
console.log(response)

// Workplace Search API
const response = await client.workplace.getDocument({
  content_source_id: 'test',
  document_id: 'id'
})
console.log(response)

License

This software is licensed under the Apache 2 license.

Package Sidebar

Install

npm i @elastic/enterprise-search

Weekly Downloads

3,846

Version

8.18.0

License

Apache-2.0

Unpacked Size

270 kB

Total Files

46

Last publish

Collaborators

  • jen-huang
  • delvedor
  • lukasolson
  • ccowan
  • jbudz
  • thomasneirynck
  • verogo
  • weltenwort
  • pugnascotia
  • zinckiwi
  • brandon.kobel
  • nreese
  • mgreau
  • jonahbull
  • jarpy
  • leathekd
  • lukeelmers
  • ddillinger
  • jasonstoltz
  • bamieh
  • markov00
  • joshmock
  • vignesh.shanmugam
  • watson
  • rhodesjason
  • jmlrt
  • mattkime
  • afoucret
  • nickpeihl
  • axw
  • mistic
  • elasticmachine
  • gtback
  • pickypg
  • trentm
  • andrewvc-elastic
  • jorge.sanz
  • stratoula
  • nkammah
  • streamich
  • nickofthyme
  • phoey1
  • breehall
  • kyrspl
  • johnwcambra
  • colleen.mcginnis
  • legrego
  • banerjeesoham004
  • patryk.kopycinski
  • kibanamachine
  • tkajtoch
  • cindy_c
  • cbishopewc
  • lenegadewoll
  • asnyder-elastic
  • lgestc
  • weronika-olejniczak
  • elena-shostak
  • kc13greiner
  • yan.savitski
  • jeramysoucy
  • miguel-elastic
  • bradtimmerman
  • obltmachine
  • jbwelastic
  • acstll
  • bmorelli25