Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sajari/sdk-node
Official repository of the Search.io SDK for Node.js
https://github.com/sajari/sdk-node
api nodejs sdk search
Last synced: 7 days ago
JSON representation
Official repository of the Search.io SDK for Node.js
- Host: GitHub
- URL: https://github.com/sajari/sdk-node
- Owner: sajari
- License: mit
- Created: 2018-03-14T23:24:11.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-06T01:38:14.000Z (almost 2 years ago)
- Last Synced: 2024-08-09T16:53:25.939Z (3 months ago)
- Topics: api, nodejs, sdk, search
- Language: TypeScript
- Homepage: https://www.search.io
- Size: 1.3 MB
- Stars: 8
- Watchers: 6
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Search.io SDK for Node
[](https://github.com/sajari/sdk-node/actions)
The official [Search.io](https://www.search.io) Node client library.
Search.io offers a search and discovery service with Neuralsearch®, the world's first instant AI search technology. Businesses of all sizes use Search.io to build site search and discovery solutions that maximize e-commerce revenue, optimize on-site customer experience, and scale their online presence.
## Table of contents
- [Quickstart](#quickstart)
- [Before you begin](#before-you-begin)
- [Install the SDK](#install-the-sdk)
- [Use the SDK](#use-the-sdk)
- [Examples](#examples)
- [Contributing](#contributing)
- [License](#license)
## Quickstart
### Before you begin
1. [Create a Search.io account](http://app.search.io)
1. [Retrieve your account credentials](https://app.search.io/project/credentials)
### Install the SDK
```bash
npm install @sajari/sdk-node
```
### Use the SDK
The following example shows how to create a collection using the SDK.
> ⚠️ The function below cleans up after itself by deleting the collection immediately after creation.
```javascript
// Import the Search.io SDK.
import { CollectionsClient, withKeyCredentials } from "@sajari/sdk-node";
// Create a client for working with collections from account key credentials.
const client = new CollectionsClient(
withKeyCredentials("account-key-id", "account-key-secret")
);
async function createCollection(id, displayName) {
// Create a new collection.
const collection = await client.createCollection({ id, displayName });
console.log(`Collection ${collection.displayName} created.`);
// Clean up. Remove this in your application to keep the collection.
await client.deleteCollection(collection.id);
}
createCollection("collection-id", "Collection display name").catch(
console.error
);
```
## Examples
Examples are in the [examples](https://github.com/sajari/sdk-node/blob/master/examples) directory.
| Example | Source code |
| ---------------------------- | ------------------------------------------------------------------------------------------------------ |
| Batch create schema fields | [source code](https://github.com/sajari/sdk-node/blob/master/examples/batch-create-schema-fields.ts) |
| Batch upsert records | [source code](https://github.com/sajari/sdk-node/blob/master/examples/batch-upsert-records.ts) |
| Create collection | [source code](https://github.com/sajari/sdk-node/blob/master/examples/create-collection.ts) |
| Create pipeline | [source code](https://github.com/sajari/sdk-node/blob/master/examples/create-pipeline.ts) |
| Create schema field | [source code](https://github.com/sajari/sdk-node/blob/master/examples/create-schema-field.ts) |
| Delete collection | [source code](https://github.com/sajari/sdk-node/blob/master/examples/delete-collection.ts) |
| Delete record | [source code](https://github.com/sajari/sdk-node/blob/master/examples/delete-record.ts) |
| Generate pipelines | [source code](https://github.com/sajari/sdk-node/blob/master/examples/generate-pipelines.ts) |
| Get collection | [source code](https://github.com/sajari/sdk-node/blob/master/examples/get-collection.ts) |
| Get pipeline | [source code](https://github.com/sajari/sdk-node/blob/master/examples/get-pipeline.ts) |
| Get record | [source code](https://github.com/sajari/sdk-node/blob/master/examples/get-record.ts) |
| List collections | [source code](https://github.com/sajari/sdk-node/blob/master/examples/list-collections.ts) |
| List pipelines | [source code](https://github.com/sajari/sdk-node/blob/master/examples/list-pipelines.ts) |
| List schema fields | [source code](https://github.com/sajari/sdk-node/blob/master/examples/list-schema-fields.ts) |
| Upsert record | [source code](https://github.com/sajari/sdk-node/blob/master/examples/upsert-record.ts) |
| Query collection | [source code](https://github.com/sajari/sdk-node/blob/master/examples/query-collection.ts) |
| Set default pipeline | [source code](https://github.com/sajari/sdk-node/blob/master/examples/set-default-pipeline.ts) |
| Send event | [source code](https://github.com/sajari/sdk-node/blob/master/examples/send-event.ts) |
| Get default pipeline | [source code](https://github.com/sajari/sdk-node/blob/master/examples/get-default-pipeline.ts) |
| Set default pipeline version | [source code](https://github.com/sajari/sdk-node/blob/master/examples/set-default-pipeline-version.ts) |
| Get default pipeline version | [source code](https://github.com/sajari/sdk-node/blob/master/examples/get-default-pipeline-version.ts) |
## Contributing
Contributions are welcome. See the [Contributing](https://github.com/sajari/sdk-node/blob/master/CONTRIBUTING.md) guide.
## License
MIT
See [LICENSE](https://github.com/sajari/sdk-node/blob/master/LICENSE)