volcengine/SearchCLI

SearchCLI – Volcengine AI Search 用のコマンドラインインターフェース

何であるか – SearchCLI は Volcengine の AI Search サービスをラップした CLI です。開発者や AI エージェントシステムが、データセットやアプリケーションを管理し、ターミナルから検索、推薦、チャット形式のリトリーバル操作を実行できます。

対象ユーザー –

• ビジネスバックエンドに AI ベースの検索や推薦機能を統合したいエンジニア。
• データのインポート、検索アプリの設定、結果の検証を繰り返し可能でレビュー可能な方法で行う自律型エージェントを開発しているチーム。
• 本番環境への変更を適用する前に安全に「ドライラン」ワークフローを実行したいオペレーター。

主要機能

分野	CLI コマンド（プレフィックス vs）	機能
認証とヘルスチェック	vs auth, vs doctor	Volcengine 認証情報の読み込み、接続状態の確認
LLM 統合	vs llm	関連性判断やクエリ生成に使用する OpenAI 互換 LLM の登録
データセット操作	vs dataset, vs data	ファイルのインポート、スキーマの推論、レコードの書き込み
アプリケーション管理	vs app	検索アプリの作成、データセットの接続
検索 / 推薦 / チャット	vs search run, vs recommend run, vs chat run	実行中のクエリを実行、順位付けされた結果を取得、会話型リトリーバルを実行
パラメータチューニング	`vs search tune query-generate	plan
拡張性	Viking skills（npx skills add … でインストール）	エージェントがプログラム的に呼び出せる再利用可能なコマンドセットのバンドル

通常の人間のワークフロー

1. リポジトリをクローンし、bash ./scripts/install.sh を実行（Node 20+ と git が必要）。
2. Volcengine の Access Key/Secret Key で認証する（vs auth login または環境変数からインポート）。
3. （オプション）関連性判断用に LLM を登録する（vs llm login）。
4. JSONL データファイルをインポートし、サービスがスキーマを推論し、データを書き込み、アプリを作成し、データセットを接続する。vs dataset … と vs app … コマンド数個で完了。
5. vs search run、vs recommend run、または vs chat run を実行してサービスの動作を確認する、またはチューニングコマンドを使って関連性を向上させる。

エージェント指向のワークフロー

• CLI を一度だけインストール。
• 事前にパッケージ化された Viking skills を追加（npx skills add …）。これらは外部 AI エージェントが呼び出せる関数として同じコマンドグループを公開する。
• エージェントは認証を行い、スキルバンドルの検証を行い、その後 vs search tune … や vs chat run … を自動化パイプライン内で呼び出すことができる。安全のため、組み込みのドライランと確認ステップが備わっている。

インストールと前提条件

• Node.js 20+ と git。
• AI Search 権限を持つ AK/SK を持つ Volcengine アカウント。
• （オプション）関連性判断用に OpenAI 互換 LLM エンドポイントへのアクセス。

ドキュメントとコミュニティ

• 多言語対応の README リンク（英語、中国語、日本語など）。
• 詳細なエージェントクイックスタートガイド（docs/agent-quick-start.md）。
• 実時間サポート用の WeChat ユーザーグループ（リポジトリに QR コード付き）。
• 標準的なオープンソース貢献ファイル（CLA、コードオブコンダクト、セキュリティポリシー）。

ライセンス – Apache‑2.0。

---

結論 – SearchCLI はプロダクションレベルの CLI 最優先ツールであり、Volcengine の AI Search プラットフォームと人間オペレーター、自律型エージェントの橋渡しを果たし、検索可能、推薦可能、会話型リトリーバルを統合した安全でスクリプト可能なワークフローを提供します。