easybeam-react v2.2.0

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 prompts and agents.

Features

• Stream responses from Easybeam prompts and agents
• Make non-streaming requests to prompts and agents
• Handle user reviews for chat interactions
• TypeScript support for improved developer experience
• Built-in error handling and event management
• Secure handling of user secrets for agent interactions
• Support for image URLs in chat messages

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);

Using Prompts

Streaming a Prompt Response

const promptId = "your-prompt-id";
const userId = "user-123";
const filledVariables = { key: "value" };
const messages = [
  {
    content: "Hello",
    role: "USER",
    createdAt: new Date().toISOString(),
    id: "1",
    imageURL: "https://example.com/image.jpg", // Optional image URL for the message, not supported by all models
  },
];

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

Making a Non-Streaming Prompt Request

const response = await easybeam.getPrompt(
  promptId,
  userId,
  filledVariables,
  messages
);
console.log("Prompt response:", response);

Using Agents

Streaming an Agent Response

const agentId = "your-agent-id";
const userId = "user-123";
const filledVariables = { language: "english" };
const userSecrets = { apiKey: "sensitive-api-key" }; // Optional secrets for agent
const messages = [
  {
    content: "Can you help me with data analysis?",
    role: "USER",
    createdAt: new Date().toISOString(),
    id: "1",
    imageURL: "https://example.com/chart.png", // Optional image URL for the message
  },
];

easybeam.streamAgent(
  agentId,
  userId,
  filledVariables,
  messages,
  (response) => {
    console.log("New message:", response.newMessage);
  },
  () => {
    console.log("Stream closed");
  },
  (error) => {
    console.error("Error:", error);
  },
  userSecrets // Optional parameter for secure credentials
);

Making a Non-Streaming Agent Request

const response = await easybeam.getAgent(
  agentId,
  userId,
  filledVariables,
  messages,
  userSecrets // Optional parameter for secure credentials
);
console.log("Agent 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

• streamPrompt: Stream responses from an Easybeam prompt
• getPrompt: Make a non-streaming request to an Easybeam prompt
• streamAgent: Stream responses from an Easybeam agent
• getAgent: Make a non-streaming request to an Easybeam agent
• review: Submit a review for a chat interaction
• cancelCurrentStream: Cancel the current streaming request

Type Interfaces

interface UserSecrets {
  [key: string]: string;
}

interface FilledVariables {
  [key: string]: string;
}

interface ChatMessage {
  content: string;
  role: ChatRole;
  createdAt: string;
  providerId?: string;
  id: string;
  inputTokens?: number;
  outputTokens?: number;
  imageURL?: string; // URL to an image associated with the message
}

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.

Security Considerations

When using agents with sensitive credentials or API keys, always pass them through the userSecrets parameter. This ensures proper handling of sensitive information and prevents exposure in logs or client-side code.

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 support@easybeam.ai or visit our documentation.