@lobehub/chat-plugins-gateway

LobeChat Plugins Gateway

Plugin Gateway Service for Lobe Chat and Lobe Web

English · 简体中文 · Changelog · Report Bug · Request Feature

Table of contents

TOC

• 👋 Intro
• 🤯 Usage
  • Base URLs
  • POST Plugin Gateway
• 🛳 Self Hosting
  • Deploy to Vercel
• 📦 Plugin Ecosystem
• ⌨️ Local Development
• 🤝 Contributing
• 🔗 Links

👋 Intro

LobeChat Plugins Gateway is a backend service that provides a gateway for LobeChat plugins. We use vercel to deploy this service. The main API POST /api/v1/runner is deployed as an Edge Function.

The gateway service fetches lobe plugins index from the LobeChat Plugins, if you want to add your plugin to the index, please submit a PR to the LobeChat Plugins repository.

🤯 Usage

Base URLs

Environment	URL
PROD	https://chat-plugins-gateway.lobehub.com
DEV	https://chat-plugins-gateway-dev.lobehub.com

POST Plugin Gateway

Note
POST /api/v1/runner
Interface to communicate with the LobeChat plugin. This interface describes how to use the LobeChat plugin gateway API to send requests and get responses

Body Request Parameters

{
  "arguments": "{\n  \"city\": \"杭州\"\n}",
  "name": "realtimeWeather"
}

Response

[
  {
    "city": "杭州市",
    "adcode": "330100",
    "province": "浙江",
    "reporttime": "2023-08-17 23:32:22",
    "casts": [
      {
        "date": "2023-08-17",
        "week": "4",
        "dayweather": "小雨",
        "nightweather": "小雨",
        "daytemp": "33",
        "nighttemp": "24",
        "daywind": "东",
        "nightwind": "东",
        "daypower": "≤3",
        "nightpower": "≤3",
        "daytemp_float": "33.0",
        "nighttemp_float": "24.0"
      },
      {
        "date": "2023-08-18",
        "week": "5",
        "dayweather": "小雨",
        "nightweather": "小雨",
        "daytemp": "32",
        "nighttemp": "23",
        "daywind": "东北",
        "nightwind": "东北",
        "daypower": "4",
        "nightpower": "4",
        "daytemp_float": "32.0",
        "nighttemp_float": "23.0"
      },
      {
        "date": "2023-08-19",
        "week": "6",
        "dayweather": "小雨",
        "nightweather": "雷阵雨",
        "daytemp": "32",
        "nighttemp": "24",
        "daywind": "东",
        "nightwind": "东",
        "daypower": "4",
        "nightpower": "4",
        "daytemp_float": "32.0",
        "nighttemp_float": "24.0"
      },
      {
        "date": "2023-08-20",
        "week": "7",
        "dayweather": "雷阵雨",
        "nightweather": "多云",
        "daytemp": "33",
        "nighttemp": "25",
        "daywind": "东",
        "nightwind": "东",
        "daypower": "≤3",
        "nightpower": "≤3",
        "daytemp_float": "33.0",
        "nighttemp_float": "25.0"
      }
    ]
  }
]

See API Document for more information.

🛳 Self Hosting

If you want to deploy this service by yourself, you can follow the steps below.

Deploy to Vercel

Click button below to deploy your private plugins' gateway.

If you want to make some customization, you can add environment variable:

• PLUGINS_INDEX_URL: You can change the default plugins index url as your need.

📦 Plugin Ecosystem

Plugins provide a means to extend the Function Calling capabilities of LobeChat. They can be used to introduce new function calls and even new ways to render message results. If you are interested in plugin development, please refer to our 📘 Plugin Development Guide in the Wiki.

• lobe-chat-plugins: This is the plugin index for LobeChat. It accesses index.json from this repository to display a list of available plugins for LobeChat to the user.
• chat-plugin-template: This is the plugin template for LobeChat plugin development.
• @lobehub/chat-plugin-sdk: The LobeChat Plugin SDK assists you in creating exceptional chat plugins for Lobe Chat.
• @lobehub/chat-plugins-gateway: The LobeChat Plugins Gateway is a backend service that provides a gateway for LobeChat plugins. We deploy this service using Vercel. The primary API POST /api/v1/runner is deployed as an Edge Function.

⌨️ Local Development

You can use Github Codespaces for online development:

Or clone it for local development:

$ git clone https://github.com/lobehub/chat-plugins-gateway.git
$ cd chat-plugins-gateway
$ bun install
$ bun dev

🤝 Contributing

Contributions of all types are more than welcome, if you are interested in contributing code, feel free to check out our GitHub Issues to get stuck in to show us what you’re made of.

🔗 Links

• 🤖 Lobe Chat - An open-source, extensible (Function Calling), high-performance chatbot framework. It supports one-click free deployment of your private ChatGPT/LLM web application.
• 🧩 / 🏪 Plugin Index - This is the plugin index for LobeChat. It accesses index.json from this repository to display a list of available plugins for Function Calling to the user.

📝 License

Copyright © 2023 LobeHub.
This project is MIT licensed.

Changelog

Version 1.9.0

^{Released on 2023-12-26}

✨ Features

• misc: Support defaultPluginSettings options on Gateway.

<br/> <details> <summary><kbd>Improvements and Fixes</kbd></summary>

What's improved

• misc: Support defaultPluginSettings options on Gateway (fea957e)

</details> <div align="right">

</div>