Easybeam SDK for React

Overview

The Easybeam SDK for React provides a seamless integration with the Easybeam AI platform, allowing developers to easily incorporate AI-powered chat functionality into their React applications. This SDK supports both streaming and non-streaming interactions with Easybeam's portals and workflows.

Features

• Stream responses from Easybeam portals and workflows
• Make non-streaming requests to portals and workflows
• Handle user reviews for chat interactions
• TypeScript support for improved developer experience
• Built-in error handling and event management

Installation

npm install easybeam-react

Usage

Initializing the SDK

import { Easybeam, EasyBeamConfig } from "easybeam-react";

const config: EasyBeamConfig = {
  token: "your-api-token-here",
};

const easybeam = new Easybeam(config);

Streaming a Portal Response

const portalId = "your-portal-id";
const userId = "user-123";
const filledVariables = { key: "value" };
const messages = [
  {
    content: "Hello",
    role: "USER",
    createdAt: new Date().toISOString(),
    id: "1",
  },
];

easybeam.streamPortal(
  portalId,
  userId,
  filledVariables,
  messages,
  (response) => {
    console.log("New message:", response.newMessage);
  },
  () => {
    console.log("Stream closed");
  },
  (error) => {
    console.error("Error:", error);
  }
);

Making a Non-Streaming Portal Request

const response = await easybeam.getPortal(
  portalId,
  userId,
  filledVariables,
  messages
);
console.log("Portal response:", response);

Submitting a Review

await easybeam.review("chat-123", "user-123", 5, "Great experience!");

API Reference

Easybeam Class

The main class for interacting with the Easybeam API.

Methods

• streamPortal: Stream responses from an Easybeam portal
• getPortal: Make a non-streaming request to an Easybeam portal
• streamWorkflow: Stream responses from an Easybeam workflow
• getWorkflow: Make a non-streaming request to an Easybeam workflow
• review: Submit a review for a chat interaction
• cancelCurrentStream: Cancel the current streaming request

Error Handling

The SDK provides built-in error handling for network requests and SSE connections. Errors are passed to the onError callback in streaming methods and thrown as exceptions in non-streaming methods.

TypeScript Support

This SDK is written in TypeScript and provides type definitions for all exported interfaces and classes, ensuring type safety and improved developer experience.

Contributing

We welcome contributions to the Easybeam SDK for React. Please feel free to submit issues, fork the repository and send pull requests!

License

This project is licensed under the MIT License - see the LICENSE file for details.

Support

For any questions or support needs, please contact our support team at [email protected] or visit our documentation.