UiPath CLI ユーザーガイド

uip docsai

uip docsai は、UiPath のドキュメントに対して自然言語による質問をし、AI が生成した回答、ソース URL および推奨されるフォローアップの質問を返します。内部的には、ツールはRESTエンドポイントではなくホストされたMCPサーバー(SearchDocumentation ツール)と通信するため、出力図形には query_id フィールドがあります。

このツールがCLIとどのように連携するかについては、「ツール(プラグイン)」を参照してください。

概要

uip docsai ask <query> [-t <tenant>] [--source <docs|technical_solution_articles>]
uip docsai ask <query> [-t <tenant>] [--source <docs|technical_solution_articles>]

すべてのサブコマンドは、グローバルオプションと終了コードを尊重します。

uip docsai ask

UiPath のドキュメントを検索します。合成された回答と、それを裏付けたソースを返します。

引数

<query> (必須) — 自然言語の文字列としての質問です。スペースがある場合は引用符で囲みます。

オプション

-t, --tenant <name> — テナント既定では、uip loginによって選択されたテナントが使用されます。
--source <source> — 検索するナレッジベースです。docs (既定) または technical_solution_articlesのいずれか。無効な値は解析時に失敗します。

例

# Ask a how-to question against the main docs
uip docsai ask "How do I create a process?"

# Search the technical solution articles instead
uip docsai ask "Selector failed with 404" --source technical_solution_articles
# Ask a how-to question against the main docs
uip docsai ask "How do I create a process?"

# Search the technical solution articles instead
uip docsai ask "Selector failed with 404" --source technical_solution_articles

出力の書式設定

uip docsai ask の出力を CLI のグローバル --output モードに適応させます。

--output table (既定) と --output plain では、読みやすく人間にわかりやすい回答が出力されます。回答テキスト、 Sources: リスト、 Follow-up questions:(存在する場合) です。
--output json 解析された応答を標準エンベロープで出力します。

データシェイプ(--output json)

{
  "Code": "DocsAIAsk",
  "Data": {
    "query_id": "a1b2c3d4-0000-0000-0000-000000000001",
    "text": "To create a process, open UiPath Orchestrator, navigate to Processes, and click Add.",
    "sources": [
      "https://docs.uipath.com/ja/orchestrator/standalone/2022.4/user-guide/managing-processes"
    ],
    "disclaimers": [],
    "followups": [
      "What permissions are required to create a process in Orchestrator?"
    ]
  }
}
{
  "Code": "DocsAIAsk",
  "Data": {
    "query_id": "a1b2c3d4-0000-0000-0000-000000000001",
    "text": "To create a process, open UiPath Orchestrator, navigate to Processes, and click Add.",
    "sources": [
      "https://docs.uipath.com/ja/orchestrator/standalone/2022.4/user-guide/managing-processes"
    ],
    "disclaimers": [],
    "followups": [
      "What permissions are required to create a process in Orchestrator?"
    ]
  }
}

query_id — このクエリの一意の ID。
text — AI が生成した回答。
sources — 回答で引用されたドキュメントページの絶対 URL。
disclaimers — サーバーがクライアントに回答と一緒に表示させたい警告(多くの場合、空)。
followups — 次の質問を提案し、ランク付けしました。

サーバーが応答を返す場合、CLIは上記の構造化された形状として解析できないため、 Data はMCPツール呼び出しからの生コンテンツ配列にフォールバックするため、何も失われません。

エラー動作

MCP クライアントの作成の失敗 (通常は認証または接続の問題): Instructionsの根本的なエラーでFailure: "Error querying DocsAI"し、1 を終了します。
MCP ツールの呼び出しエラー: 同じ Failure: "Error querying DocsAI" エンベロープ。CLI は、終了する前にクライアントを正常に閉じます。
サーバー側のエラー (例: レート制限): Instructionsの生コンテンツのペイロードでFailure: "DocsAI returned an error"。

ツール (プラグイン) — docsai-tool パッケージをインストール、更新、アンインストールします。
uip mcp — クライアント MCP ホストが CLI を呼び出すことができます。docsai反対方向に進み、リモート MCP サーバーを呼び出します。
uip login — DocsAI 呼び出しの認証に使用されるセッション。

概要
uip docsai ask
引数
オプション
例
出力の書式設定
データシェイプ(--output json)
エラー動作
関連

このページは役に立ちましたか?

前へfiles

次へUIP フロー

UiPath CLI ユーザー ガイド

概要​

uip docsai ask​

引数​

オプション​

例​

出力の書式設定​

データシェイプ(--output json)​

エラー動作​

関連​