このプロジェクトについて

このリポジトリは、Octavus AIエージェントを使ったアプリケーションを構築するための公式JavaScript/TypeScript SDKを提供します。統合サーフェスの異なる部分をそれぞれ対象とする複数のnpmパッケージを含むモノレポとして構成されています。 パッケージには、クライアント/サーバー通信で使用される共有型とユーティリティを提供する@octavus/core、バックエンド統合用の@octavus/server-sdk、フレームワーク非依存のクライアントである@octavus/client-sdk、Reactフックとバインディングの@octavus/react、エージェント管理用の@octavus/cli、ドキュメントコンテンツ用の@octavus/docsが含まれます。 サーバーSDKでは、APIキーを使ってOctavusClientを作成し、初期変数を持つエージェントセッションを作成し、カスタムツールハンドラーでそのセッションにアタッチし、テキストデルタなどのレスポンスイベントをストリーミングしながら名前付きトリガーを起動する例が示されています。Reactパッケージでは、useOctavusChatフックとHTTPトランスポートを組み合わせ、トリガーリクエストをバックエンドエンドポイントへ転送し、メッセージ、ステータス、送信関数をUIに公開する例が示されています。 ドキュメントリンクは、はじめに、サーバーSDK、クライアントSDK、プロトコルリファレンス、APIリファレンスをカバーしています。開発にはNode.js 20+とpnpm 10+が必要で、インストール、ビルド、lint、型チェック、フォーマット用のスクリプトが用意されています。このプロジェクトはMITライセンスで、コントリビューションガイドを通じて貢献を受け付けています。