​
Installation Guide for Saiku

Setting up Saiku in your project is straightforward. This guide provides you with the necessary steps to install Saiku and prepare your environment for its optimal use.

​
Prerequisites

Before installing Saiku, ensure you meet the following prerequisites:

  • Node.js installed on your system.
  • An OpenAI API key for GPT-4 integration.

​
Installation Steps

​
1. Adding Saiku as a Dependency

To add Saiku as a dependency in your project, run the following command in your project directory:

npm install saiku

​
2. Environment Configuration

Set up the necessary environment variables for Saiku. Start by copying the example environment file:

cp .env.example .env

Then, edit the .env file to include your specific details, such as the OpenAI API key and other required service credentials.

​
3. Verifying Installation

After installing Saiku, it’s important to ensure it’s functioning correctly. This section will guide you through a simple test to verify your installation.

​
Setting Up a Test Script

Create a file named test-saiku.js in your project directory and insert the following code:

import Agent from 'saiku/agents/agent';

async function testSaiku() {
  const agent = new Agent();
  const userQuery = "Hello Saiku";

  const response = await agent.interact(userQuery);
  console.log(response.text);
}

testSaiku();

​
Running the Test Script

To run the test, use the following command in your terminal:

node test-saiku.js

When executed, this script will initialize a Saiku agent and process the query “Hello Saiku”. It will then output Saiku’s response to the console.

You’re now ready to explore Saiku’s capabilities and integrate it into your projects. For more detailed usage instructions, refer to our User Guide.