Skip to content

Latest commit

 

History

History
119 lines (84 loc) · 4.68 KB

README.md

File metadata and controls

119 lines (84 loc) · 4.68 KB

Stream Chat AI Integration Examples

Integrating Stream Chat with AI

Quick Links 🔗

Prerequisites ✅

Before you begin, you'll need:

Overview 😎

This repository showcases official Stream sample projects demonstrating Generative AI integration with Chat API and UI Kits.

Samples:

Frontend SDKs:

Backend Examples:

You can use our pre-built OpenAI/Anthropic integrations or extend the Agent class to work with any external LLM provider.

Architecture Overview 🏗️

The repository implements a modular architecture that connects Stream's Chat functionality with various LLM providers:

Stream Chat AI Integration Architecture

Key features:

  • Pre-built integrations with OpenAI and Anthropic
  • Extensible Agent class for custom LLM provider integration
  • Built-in UI components that handle:
    • Loading states
    • Code block rendering
    • Markdown formatting
    • Table displays
    • Image rendering

Getting Started 🚀

  1. Clone the repo
  2. Configure environment variables:
cp .env.example .env
  1. Add the following credentials to your .env:

Setup ⚙️

Backend

Frontend Integration

Select your preferred SDK to get started.

AI Guides 📚

These guides explore more of how AI can be used across our SDKs and products.

Contributing 🤔

We welcome contributions that improve functionality or fix issues:

  1. Fork the repository
  2. Create a feature branch
  3. Implement your changes
  4. Add tests if applicable
  5. Submit a PR with a clear description/changes

Sample App Submissions

We encourage you to try the tutorials and submit new sample apps 🥳

  • How can I submit a sample app?
    • Open a pr with a proper description and we'll review it as soon as possible.

Bug Reports 🕷

  • Open an issue with:
    • Clear steps to reproduce
    • Add screenshots/videos if possible
    • Expected behavior
    • Actual behavior
    • Platform/environment details