Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/elastic/site-search-node
Elastic Site Search Official Node.js Client
https://github.com/elastic/site-search-node
api-client elastic elastic-site-search javascript node search swiftype
Last synced: 3 months ago
JSON representation
Elastic Site Search Official Node.js Client
- Host: GitHub
- URL: https://github.com/elastic/site-search-node
- Owner: elastic
- License: apache-2.0
- Created: 2019-07-31T15:25:48.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-06-24T15:57:01.000Z (over 1 year ago)
- Last Synced: 2024-04-14T10:15:46.018Z (8 months ago)
- Topics: api-client, elastic, elastic-site-search, javascript, node, search, swiftype
- Language: JavaScript
- Homepage: https://www.elastic.co/products/site-search
- Size: 124 KB
- Stars: 9
- Watchers: 20
- Forks: 9
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
> A first-party Node client for the [Elastic Site Search API](https://swiftype.com/documentation/site-search/overview).
## Contents
- [Getting started](#getting-started-)
- [Usage](#usage)
- [Running tests](#running-tests)
- [FAQ](#faq-)
- [Contribute](#contribute-)
- [License](#license-)
---
## Getting started 🐣
With npm:
```shell
npm install @elastic/site-search-node
```
or clone locally:
```shell
$ git clone [email protected]:elastic/site-search-node.git
$ cd site-search-node
$ npm install
```
## Usage
Create a new instance of the client with your api key:
```javascript
var SiteSearchClient = require("@elastic/site-search-node");
var client = new SiteSearchClient({
apiKey: "yourApiKey"
});
```
### Searching
Search for `cats` on the engine `my-engine` with filters and facets:
```javascript
client.search(
{
engine: "my-engine",
q: "cats",
filters: {
page: {
enumField: "theFilter"
}
},
facets: {
page: ["enumField", "anotherField"]
}
},
function(err, res) {
console.log(res);
}
);
```
### Autocomplete
Autocomplete suggestion for `cat` on the engine `my-engine` with filters:
```javascript
client.suggest(
{
engine: "my-engine",
q: "cat",
filters: {
page: {
enumField: "theFilter"
}
}
},
function(err, res) {
console.log(res);
}
);
```
### Click
Log clickthrough for `cat` on the engine `my-engine` for the documentType `page`:
```javascript
client.click(
{
engine: "my-engine",
q: "cat",
id: "the-document-id",
documentType: "page"
},
function(err, res) {
console.log(res);
}
);
```
### Documents
Create a new document:
```javascript
client.documents.create(
{
engine: "my-engine",
documentType: "books",
document: {
external_id: "1",
fields: [
{ name: "title", value: "The Great Gatsby", type: "string" },
{ name: "author", value: "F. Scott Fitzgerald", type: "string" },
{ name: "genre", value: "fiction", type: "enum" }
]
}
},
function(err, res) {
console.log(res);
}
);
```
### Engines
Fetch all of your engines:
```javascript
client.engines.list(function(err, res) {
console.log(res);
});
```
Fetch a single engine:
```javascript
client.engines.get(
{
engine: "my-engine"
},
function(err, res) {
console.log(res);
}
);
```
### Document Types
Fetch all of the document types in the engine `my-engine`
```javascript
client.documentTypes.list(
{
engine: "my-engine"
},
function(err, res) {
console.log(res);
}
);
```
Fetch the document type `books` in the engine `my-engine`
```javascript
client.documentTypes.get(
{
engine: "my-engine",
documentType: "books"
},
function(err, res) {
console.log(res);
}
);
```
Create the document type `books` in the engine `my-engine`
```javascript
client.documentTypes.create(
{
engine: "my-engine",
document_type: { name: "books" }
},
function(err, res) {
console.log(res);
}
);
```
Check out the tests for more examples!
## Running tests
```shell
$ npm test
```
The tests use stubbed HTTP interactions that are recorded with the [node-replay](https://github.com/assaf/node-replay) module. By default, HTTP interactions are not allowed when running the tests.
The tests can also use environment variables so that you can create new replays against your own account. Don't forget to change the "authorization" header in the replay files to not give away your api key.
- SITE_SEARCH_TEST_MY_ENGINE = the slug for your 'my-engine' in the tests
- SITE_SEARCH_TEST_BOOKSTORE_ENGINE = the slug for your 'bookstore' in the tests
- SITE_SEARCH_TEST_TEMPORARY_ENGINE = the slug for your 'temporary' in the tests
- SITE_SEARCH_TEST_API_KEY = your api key in the tests
- REPLAY = 'record' to record new replay files
## FAQ 🔮
### Where do I report issues with the client?
If something is not working as expected, please open an [issue](https://github.com/elastic/site-search-node/issues/new).
### Where can I learn more about Site Search?
Your best bet is to read the [documentation](https://swiftype.com/documentation/site-search).
### Where else can I go to get help?
You can checkout the [Elastic Site Search community discuss forums](https://discuss.elastic.co/c/site-search).
## Contribute 🚀
We welcome contributors to the project. Before you begin, a couple notes...
- Before opening a pull request, please create an issue to [discuss the scope of your proposal](https://github.com/elastic/site-search-node/issues).
- Please write simple code and concise documentation, when appropriate.
## License 📗
[Apache 2.0](https://github.com/elastic/site-search-node/blob/master/LICENSE.txt) © [Elastic](https://github.com/elastic)
Thank you to all the [contributors](https://github.com/elastic/site-search-node/graphs/contributors)!