PHPackages                             orchestratexr/botman-chat-sdk - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. orchestratexr/botman-chat-sdk

ActiveLibrary[Utility & Helpers](/categories/utility)

orchestratexr/botman-chat-sdk
=============================

0.0.20(9mo ago)07MITPHPPHP ^8.2CI failing

Since Aug 5Pushed 8mo agoCompare

[ Source](https://github.com/AccessVR/BotManChatSDK)[ Packagist](https://packagist.org/packages/orchestratexr/botman-chat-sdk)[ Docs](https://github.com/AccessVR/BotManChatSDK)[ RSS](/packages/orchestratexr-botman-chat-sdk/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependencies (11)Versions (10)Used By (0)

An SDK for building AI-backed chatbots with BotMan and Laravel
==============================================================

[](#an-sdk-for-building-ai-backed-chatbots-with-botman-and-laravel)

[![Latest Version on Packagist](https://camo.githubusercontent.com/881f99796dcc381c75b41431df47405609c88003521481e94212a627da6dc631/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f6f7263686573747261746578722f626f746d616e2d636861742d73646b2e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/orchestratexr/botman-chat-sdk)[![Total Downloads](https://camo.githubusercontent.com/4865a801069f301b1b29d5f7f64d662de73305a049756eacffbfd2b6214198cb/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f6f7263686573747261746578722f626f746d616e2d636861742d73646b2e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/orchestratexr/botman-chat-sdk)[![License](https://camo.githubusercontent.com/06735e43d315b9ef37cbee45e402e8ea48d859a0b9ae3601216bc2161a3724a8/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6963656e73652f41636365737356522f426f744d616e4368617453444b)](https://github.com/AccessVR/BotManChatSDK/blob/main/LICENSE)[![GitHub Actions](https://github.com/AccessVR/BotManChatSDK/actions/workflows/build-assets.yml/badge.svg)](https://github.com/AccessVR/BotManChatSDK/actions/workflows/build-assets.yml/badge.svg)

BotManChatSDK is a Laravel package designed for supporting the creation of LLM-backed Chat Bots using [BotMan](https://github.com/botman/botman), [LLPhant](https://github.com/LLPhant/LLPhant), and LLM providers like OpenAI, Anthropic, and Ollama.

About OrchestrateXR
-------------------

[](#about-orchestratexr)

[OrchestrateXR](https://orchestratexr.com) is the easiest way to create and deploy XR content. Use your web browser to create for mobile, tablets, PCs and XR devices.

Roadmap
-------

[](#roadmap)

- Full compatability with existing [BotMan Drivers](https://botman.io/2.0/installation), and drop-in replacement for [BotMan Web Widget](https://botman.io/2.0/web-widget)
- Add the Web Widget into any Laravel application, including Laravel Nova, using `@botman` blade directive
- Base class `ChatConversation` for building LLM-backed [Conversations](https://botman.io/2.0/conversations)
- Extend Conversations to emulate Agents with [Tools](https://github.com/LLPhant/LLPhant?tab=readme-ov-file#tools) that execute PHP functions
- Built-in Tool for crawling URLs which you can bootstrap into any `ChatConversation` with `$conversation->withCrawler()`
- Custom [Cache](https://botman.io/2.0/cache-drivers) driver for persisting Conversations between user sessions
- Enhanced Web Driver to provide for real-time message streaming using Laravel event system
- Discord Driver, to enable chat interactions in [Discord](https://discord.com/developers/docs/intro)
- Chat Completion Driver, to enable chat requests and responses to take the form of [OpenAI Chat Completions](https://platform.openai.com/docs/api-reference/chat/create)
- Examples of `ChatConversation` implementations, to help you start your journey
- Example `BotManChatServerController` for setting up the server-side of `ChatConversation` instances
- Laravel Livewire Starter Kit bootstrapped with BotManChatSDK, perfect for deploying to [Laravel Cloud](https://cloud.laravel.com/)

Quickstart
----------

[](#quickstart)

To be written:

- Clone the starter kit repo
- Add an environment variable
- Run it locally using `php artisan serve`

Installation
------------

[](#installation)

Install this Laravel package via composer into an existing Laravel project:

```
composer require orchestratexr/botman-chat-sdk
```

Publish front-end assets and configuration

```
php artisan vendor:publish --provider="OrchestrateXR\BotManChatSDK\BotManChatServiceProvider"
```

Inject the chat client into your front-end using the `@botman` blade directive. For most Laravel applications, this means adding `@botman` to your blade layout.

```

    @slot

    {{!-- somewhere near the bottom --}}
    @blade

```

In Laravel Nova applications, you can safely add `@botman` to your `meta.php` file.

Create a web route for BotMan chat requests:

```