すべてのプロダクト
Search

このプロダクト

    Tablestore:Agent Storage CLI

    ドキュメントセンター

    Tablestore:Agent Storage CLI

    最終更新日:Jul 04, 2026

    tablestore-agent-cli は、ナレッジベースおよびメモリ (メモリストア) のリソースを管理するためのコマンドラインツールです。

    インストール

    npm レジストリから CLI をグローバルにインストールします。

    前提条件： Node.js 18 以降。

    npm install -g @tablestore/tablestore-agent-cli --registry=https://registry.npmjs.org/
tablestore-agent-cli version

    npm パッケージ： https://www.npmjs.com/package/@tablestore/tablestore-agent-cli。

    設定

    configure set コマンドを使用して、アクセス認証情報とリソース設定を保存します。CLI はダッシュボードからも設定できます。詳細については、ダッシュボードのセクションをご参照ください。

    必須：AccessKey

    Alibaba Cloud アカウントの AccessKey ID と AccessKey Secret を設定します。AccessKey を取得するには、「AccessKey の作成」をご参照ください。

    tablestore-agent-cli configure set access_key_id 'LTAI5t...'
tablestore-agent-cli configure set access_key_secret 'xxx'

    オプション設定

    必要に応じて、以下のリソースを設定します。

    Tablestore インスタンス

    tablestore-agent-cli configure set ots_endpoint 'https://xxx.cn-beijing.ots.aliyuncs.com'
tablestore-agent-cli configure set ots_instance_name 'xxx'

    Tablestore インスタンスが設定されていない場合、CLI は自動的にマネージドインスタンスを作成して再利用します。詳細については、「マネージドインスタンスの自動作成」をご参照ください。

    リージョンを指定するには、 region を設定します。

    tablestore-agent-cli configure set region 'cn-beijing'

    OSS バケット

    ナレッジベースのドキュメントアップロード機能のみが、OSS バケットを必要とします。

    説明

    ナレッジベースには、OSS バケットの読み取りおよび書き込み権限が必要です。権限を付与するには、 Tablestore に OSS へのアクセスを認可 をクリックします。

    tablestore-agent-cli configure set oss_endpoint 'https://oss-cn-hangzhou.aliyuncs.com'
tablestore-agent-cli configure set oss_bucket_name 'my-bucket'

    メモリのデフォルトのスコープ

    メモリのデフォルトのスコープを設定すると、メモリコマンドで対応するパラメータを省略できます。

    tablestore-agent-cli configure set memory_store_name 'agent_memory'
tablestore-agent-cli configure set memory_app_id 'app-001'
tablestore-agent-cli configure set memory_tenant_id 'tenant-001'
tablestore-agent-cli configure set memory_agent_id 'agent-001'
tablestore-agent-cli configure set memory_run_id 'run-001'

    接続性の検証

    doctor コマンドを実行して、設定と接続性を確認します。

    tablestore-agent-cli doctor          # 完全な診断
tablestore-agent-cli doctor kb       # ナレッジベースのみ
tablestore-agent-cli doctor memory   # メモリのみ

    各チェックは pass、warn、fail、または skip を返します。すべてのチェックが pass の場合、終了コードは 0 になり、いずれかのチェックが fail の場合は 1 になります。

    必要な Tablestore インスタンスまたは OSS バケットが設定されていない場合、doctor は自動的にマネージドの Tablestore インスタンスまたは OSS バケットを作成して再利用します。詳細については、「マネージドインスタンスの自動作成」をご参照ください。

    例

    CLI をインストールして設定した後、次のコマンドを実行してナレッジベースとメモリの主要な機能をお試しください。

    ナレッジベースの例：ナレッジベースの作成とドキュメントのアップロード

    # ナレッジベースの作成
tablestore-agent-cli kb create --name my_kb --description "製品ドキュメントのナレッジベース"

# ローカルドキュメントの追加
tablestore-agent-cli kb doc-add --kb my_kb --file ./report.pdf

# セマンティック検索
tablestore-agent-cli kb retrieve --kb my_kb --query "システムアーキテクチャ設計"

    メモリの例：メモリの書き込みと取得

    # メモリストアの作成
tablestore-agent-cli memory create --store agent_memory --description "長期記憶のためのメモリストア"

# メモリの追加
tablestore-agent-cli memory add --store agent_memory --app-id app-001 --text "ユーザーは麻婆豆腐が好きです"

# メモリの取得
tablestore-agent-cli memory search --store agent_memory --app-id app-001 --tenant-id tenant-001 --query "ユーザーが好きな食べ物は？" --top-k 5

    ダッシュボード

    CLI には Web ダッシュボードが含まれており、CLI の設定、ナレッジベースとメモリリソースの管理、取得処理のデバッグに使用できます。

    ダッシュボードの起動

    tablestore-agent-cli dashboard start                     # デフォルトで 127.0.0.1:3000 をリッスン
tablestore-agent-cli dashboard start -p 9999             # カスタムポート
tablestore-agent-cli dashboard start --host 0.0.0.0      # カスタムバインドアドレス

    ダッシュボードが起動したら、ターミナルに表示されたアドレスをブラウザで開きます。

    メモリスコープの選択ルール

    ダッシュボードでメモリストアを開くと、デフォルトのスコープは */*/*/* です。このスコープでは、すべての長期記憶を一覧表示すると監査をリクエストするの 2 つの操作のみが可能です。

    メモリを取得するには、AppId と TenantId を指定します。AgentId と RunId には、特定の値またはワイルドカード * を指定できます。

    メモリを追加するには、AppId、TenantId、AgentId、RunId のそれぞれに値を指定します。

    高度な設定

    設定ファイルの場所

    設定ファイルは ~/.config/tablestore-agent-cli/config.toml に保存されます。

    環境変数

    環境変数は設定ファイルよりも優先されます。

    環境変数

    設定キー

    TABLESTORE_ACCESS_KEY_ID

    access_key_id

    TABLESTORE_ACCESS_KEY_SECRET

    access_key_secret

    TABLESTORE_ENDPOINT

    ots_endpoint

    TABLESTORE_INSTANCE_NAME

    ots_instance_name

    TABLESTORE_OSS_ENDPOINT

    oss_endpoint

    TABLESTORE_OSS_BUCKET_NAME

    oss_bucket_name

    TABLESTORE_REGION

    region

    TABLESTORE_MEMORY_STORE_NAME

    memory_store_name

    TABLESTORE_MEMORY_APP_ID

    memory_app_id

    TABLESTORE_MEMORY_TENANT_ID

    memory_tenant_id

    TABLESTORE_MEMORY_AGENT_ID

    memory_agent_id

    TABLESTORE_MEMORY_RUN_ID

    memory_run_id

    マネージドインスタンスの自動作成

    ots_endpoint と ots_instance_name が設定されていない場合、CLI は北京リージョンにマネージド Tablestore インスタンスを自動的に作成して再利用します。このインスタンスは、初めて doctor を実行するか、インスタンスを必要とするコマンドを呼び出すときに作成されます。マネージドインスタンスはパブリックエンドポイントを使用し、非同期に作成されます。CLI は、後続のコマンドが同じインスタンスを再利用できるように、結果を設定ファイルの [managed_ots] セクションにキャッシュします。明示的なターゲットを設定すると、マネージドキャッシュは自動的にクリアされます。

    OSS バケットも同様に、doctor kb や kb doc-add などのアップロードフロー中にオンデマンドで作成され、設定ファイルの [managed_oss] セクションにキャッシュされます。

    複数インスタンスの管理

    単一の設定ファイルに複数の名前付きインスタンスを保存し、CLI またはダッシュボード上部のスイッチャーで切り替えることができます。

    # 特定のインスタンスの AccessKey を設定
tablestore-agent-cli configure set --instance prod access_key_id 'LTAI...'

# アクティブなインスタンスを切り替え
tablestore-agent-cli configure use prod

# 現在の設定を表示
tablestore-agent-cli configure show

    名前付きインスタンスを使用して、本番、ステージング、テストなどの環境を切り替えます。