Search.io SDK for Node

The official 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
  • Before you begin
  • Install the SDK
  • Use the SDK
• Examples
• Contributing
• License

Quickstart

Before you begin

1. Create a Search.io account
2. Retrieve your account credentials

Install the SDK

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.

// 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 directory.

| Example | Source code | | ---------------------------- | ------------------------------------------------------------------------------------------------------ | | Batch create schema fields | source code | | Batch upsert records | source code | | Create collection | source code | | Create pipeline | source code | | Create schema field | source code | | Delete collection | source code | | Delete record | source code | | Generate pipelines | source code | | Get collection | source code | | Get pipeline | source code | | Get record | source code | | List collections | source code | | List pipelines | source code | | List schema fields | source code | | Upsert record | source code | | Query collection | source code | | Set default pipeline | source code | | Send event | source code | | Get default pipeline | source code | | Set default pipeline version | source code | | Get default pipeline version | source code |

Contributing

Contributions are welcome. See the Contributing guide.

License

MIT

See LICENSE