Dropstone SDK
Dropstoneエージェント向けの型付きTypeScriptおよびJavaScriptクライアント。2つのエントリポイントを備え、1つはCIやサーバーレス関数からのヘッドレスAPI呼び出し用、もう1つはCLIやChatと同じアカウントメモリを持つエージェントをローカルで実行するためのものです。
Dropstone SDKは、Dropstoneエージェントランタイム向けの型付きTypeScriptおよびJavaScriptクライアントです。Dropstone ChatやCLIで動作するのと同じエージェントに、コードからプログラムでアクセスできます。セッション、ツール、ストリーミング応答、構造化出力などが利用可能です。
npm install @blankline/dropstone-sdk
メソッドリファレンスはdocs.dropstone.io/cli/sdkにあります。このページは概要で、インストールして最初のセッションを実行するがチュートリアルです。
2つのエントリポイント
SDKには2つのクライアントが含まれており、どちらを使用するかはコードの実行場所によって決まります。
| ヘッドレスAPIクライアント | ローカルエージェントクライアント | |
|---|---|---|
| インポート | createDropstoneApi | createDropstone |
| 通信先 | api.dropstone.io/api/v1 | 自動的に起動されるdropstone serveプロセス |
| 認証方法 | APIキー | 同じマシン上のCLIのサインイン |
| 課金 | クレジット残高からの従量課金 | CLIと同様の週次アローワンス |
| メモリ | なし。ステートレスな完了エンドポイントです | あり。ChatとCLIが使用するアカウントメモリ |
| 使用用途 | CI、ジョブ、サーバーレス、CLIのないホスト | Nodeアプリへのインタラクティブエージェントの組み込み |
さらに2つのエントリポイントが付属しています。createDropstoneClientは、既に実行中のサーバーに同じ型付きクライアントを接続し、createDropstoneTuiはNodeプロセスからインタラクティブなターミナルUIを起動します。
どこでも同じメモリ
ローカルセッションはアカウントとして実行されるため、Dropstoneが他のサーフェスで学習したすべての情報から始まります。Chatで設定したルールはSDKを介して実行されるコードにも適用され、セッションが記録した内容は次にCLIを開いたときにそこにあります。すべてのサーフェスで同じメモリを参照してください。
ヘッドレスクライアントは意図的にその逆です。メモリが接続されていないステートレスなOpenAI互換の完了エンドポイントであり、パイプラインは予測可能な入力と出力を得られます。プランでのAPIの使用を参照してください。
エンドツーエンドの型付け
リクエスト、レスポンス、ストリーミングイベント、ツール呼び出しはサーバーのOpenAPI仕様から生成されるため、エディタが補完し、コンパイラがチェックします。1つのパッケージに2つのサーフェスが含まれています。安定版のv1クライアントと、ファイルとワークスペース向けのよりリッチなリソースモデルを持つ@blankline/dropstone-sdk/v2のv2クライアントです。新しいエンドポイントはv2に追加されます。
要件
- Node.js
- ローカルエージェントクライアントの場合、同じマシンにDropstone CLIがインストールされ、
dropstone loginでサインインしていること - ヘッドレスクライアントの場合、APIキーと資金が入ったクレジット残高
サポート
CLIリファレンスは、メソッドレベルの質問の最初の窓口です。アカウント、請求、アクセスの問題については、サポートを受ける方法を参照してください。
Related articles
- Install and run your first sessionInstall the Dropstone SDK, make a headless API call with an API key, and run a local agent session that carries your account memory. Includes streaming, structured output, and using the OpenAI SDK against Dropstone.
- Using the API with your planCall Dropstone over HTTP with an API key. The endpoint is OpenAI-compatible, billed pay-per-use from your credit balance, and works from any language. Keys, errors, rate limits, and what the API does not carry.
- One memory across every surfaceThe account memory that follows you across Dropstone Chat, the CLI, and the SDK, what shares it and what does not, and how to keep an integration's learning out of your own memory.
- Install the CLIInstall the Dropstone CLI on macOS, Linux, or Windows with one command, sign in, and check it works. Upgrading and uninstalling.
- Memory across chat, CLI, and SDKDropstone memory belongs to your account, not to one app. A rule you set in the CLI applies in chat, and something learned in chat is available to the SDK. One memory, every surface.