Botpress は、OpenAIを活用した次世代チャットボットとアシスタントを構築するための究極のプラットフォームです。プロジェクトやビジネス向けの優れたアシスタントを高速で構築し始めることができます。
始めましょう • Cloud • ドキュメント • 統合 • プラグイン
このリポジトリは以下を含んでいます：
- 統合 – Botpress Hub 上のすべてのパブリック統合（Botpressで管理）
- 開発ツール – すべてのBotpress Cloud開発ツール（CLI、SDK、APIクライアント）
- ボット - SDKとCLIのみを使用して作成されたボット「コード化」の例
- プラグイン – Botpress Studio 上のすべてのプラグイン （近日公開予定）
コミュニティからの貢献を歓迎しています！
このリポジトリに含まれるコードに関連するプルリクエストと問題を歓迎します。詳細は「このリポジトリについて」セクションを参照してください。
Botpress Cloudに関するバグまたは機能については、このリポジトリで問題を作成できますが、代わりにDiscordで私たちと話す方がより迅速な対応が得られることにご注意ください！
オンプレミスBotpress v12に関する問題については、Botpress v12リポジトリを参照してください。
/integrations フォルダには、公開されておりオープンソースの統合がすべて含まれています。コミュニティが統合に貢献することや、Botpress Hub に独自の統合を公開することをお招きします。
統合を開発するには、まず Botpress CLI をインストールすることから始めます。
npm install -g @botpress/cli # for npm
yarn global add @botpress/cli # for yarn
pnpm install -g @botpress/cli # for pnpmその後、選択したディレクトリで新しい統合を作成します。
bp initこのコマンドは、提案されたテンプレートの 1 つから統合を生成します。
このステップは、選択した任意のディレクトリと git リポジトリで実行できます。統合を作成するためにこのリポジトリをフォークする必要はありません。
integration.definition.ts および src/index.ts ファイルにそれぞれ置かれている、統合の定義と実装の両方を変更できます。
統合を開発する方法の詳細については、ドキュメント を参照してください。
統合を試すには、Botpress CLI を使用して、その現在のバージョンをワークスペースにデプロイできます。
bp deployこれにより、統合の現在のバージョンがワークスペースにデプロイされ、すべてのボットで利用可能になります。このバージョンが既にデプロイされている場合は、更新されます。それ以外の場合は、新しいバージョンが作成されます。
デフォルトでは、すべての統合はデプロイされたワークスペースに対してプライベートです。バージョンをコミュニティと共有する準備ができたら、以下を実行してパブリックにできます。
bp deploy --visibility publicこれにより、統合は Botpress Hub 上のすべての Botpress ユーザーが利用できるようになります。統合のバージョンが公開されたら、再度更新することはできません。
/bots フォルダには、クライアント、SDK、および CLI のみを使用して作成されたボット "as code" の例が含まれています。
これはボットを構築する推奨される方法ではなく、Botpress Studio の代わりにはなりません。
ただし、より プログラム的な方法でボットを構築したい経験豊富な開発者にとって有用な場合があります。
Studio と SDK の両方が同じ基本的なプリミティブを使用しているため、Botpress チームによって内部的にも使用されています。
近日公開予定です。
| パッケージ | 説明 | ドキュメント | コード |
|---|---|---|---|
@botpress/cli |
ボット、統合、プラグインの構築、デプロイ、管理 | ドキュメント | コード |
@botpress/client |
Botpress API を使用するためのタイプセーフなクライアント | ドキュメント | コード |
@botpress/sdk |
統合を構築するために使用される SDK | ドキュメント | コード |
開発環境には、以下のツールをインストールする必要があります。
git: Git は、無料でオープンソースの分散バージョン管理システムです。node: Node.js® は、Chrome の V8 JavaScript エンジンの上に構築された JavaScript ランタイムです。pnpm: pnpm は、高速でディスク容量効率的なパッケージマネージャーです。
# リポジトリのクローン
git clone https://github.com/botpress/botpress.git
cd botpress
# 依存関係をインストール
pnpm install
# すべてのパッケージをビルド
pnpm run build
# チェックの実行
pnpm run checkこのリポジトリ内のすべてのパッケージはオープンソースソフトウェアであり、MIT ライセンスの下でライセンスされています。このリポジトリに貢献することで、あなたはあなたのコードをこのライセンスの下で公開することに同意します。
チャットボット開発の未来を一緒に構築しましょう。🤖🚀
