UIP 会話型

「uip 会話型」の構文とオプション。デプロイ済みの UiPath 会話型エージェントとチャットし、結果として生成される会話 (チャット、エージェント、会話) を管理します。

uip conversational は、デプロイ済みの 会話型エージェント (Orchestrator にデプロイされたプロセスです。チャット インターフェイスとして公開され、UiPath Conversational-Agent ランタイム上に構築されています) と対話します。このページでは、エージェントのリリースの検出 (agents)、エージェントとの会話の開始/管理 (conversations)、リアルタイムのチャット (chat) について説明します。会話履歴、フィードバック、音声チャネル ルーティング、およびプロファイル設定については、「 会話型: やり取り、メッセージ、トランク、ユーザー設定」を参照してください。

概念

• エージェントのリリース — 会話機能が有効化されている、デプロイ済みの Orchestrator プロセス リリースです。リリース ID とそれが存在するフォルダーで識別されます。agents listでリリースを検出する
• 会話 — UUID で識別される conversations createで作成された、1 つのエージェント リリースに対する永続セッションです。すべてのチャット アクティビティは会話内で行われます。
• チャットと会話 — conversations create/list/get 会話レコード自体 (メタデータ、ラベル、エージェントの入力) を管理します。 chat は、 既存の 会話とリアルタイムで対話することです。まず会話を作成してから、会話に chat します。
• conversations create/updateの--agent-inputは、会話用のエージェントの初期入力をシードまたは更新する JSON 文字列です。送信前に { inline: <parsed JSON> } としてラップされます。

概要

uip conversational chat <conversation-id> [-m, --message <text>]
uip conversational agents list [--folder-id <id>]
uip conversational agents get --release-id <id> --folder-id <id>
uip conversational conversations create --release-id <id> --folder-id <id> [--label <label>] [--autogenerate-label | --no-autogenerate-label] [--agent-input <json>]
uip conversational conversations list [--limit <n>] [--sort-order <order>] [--cursor <token>] [--agent-id <id>] [--agent-key <guid>] [--label <substring>]
uip conversational conversations get <conversation-id>
uip conversational conversations update <conversation-id> [--label <label>] [--autogenerate-label | --no-autogenerate-label] [--agent-input <json>]
uip conversational conversations delete <conversation-id> -y
uip conversational conversations attachments upload <conversation-id> --file <path>
uip conversational conversations attachments get-uri <conversation-id> --file-name <name>

UIP 会話型チャット

既存の会話をリアルタイムに対話します (単発メッセージ (--message) または対話型 REPL ( --messageを省略)。

引数

名前	Required	目的
<conversation-id>	○	会話の UUID ( conversations create/listから)。

オプション

長押し	値 (Value)	説明
-m, --message <text>	string	1 つのメッセージを送信し、やり取りが完了したら終了します (非対話型)。代わりに、対話型 REPL を開始する場合は省略します。

--messageを使用しない場合、chat にはプロンプト対応のターミナルが必要です。非対話型環境 (CI、パイプ出力) ではすぐに失敗し、代わりに --message を使用するよう指示が表示されます。REPL に「 /exit 」または「 /quit 」と入力してセッションを終了するか、Ctrl+C キーを押します。Assistant の応答は stdout にトークンごとにストリーミングされます。インライン引用マーカー ([1]、 [2]、 など) が応答ストリームとして表示され、各やり取りの完了後にタイトル/URL を含む --- Citations --- 脚注ブロックが出力され、セッション全体で重複が排除されます。

例

# Single-shot message
uip conversational chat b2c3d4e5-0000-0000-0000-000000000001 --message "What's the status of order 4471?"

# Interactive REPL
uip conversational chat b2c3d4e5-0000-0000-0000-000000000001

このコマンドは、CLIの通常の --output json エンベロープを出力するのではなく、人間が判読できるテキストをstdoutにストリーミングします — スクリプト作成ではなく、対話型の使用のために設計されています。起動エラーまたはセッション途中のエラーは、プロセスがゼロ以外を終了する前に、標準の OutputFormatter.error エンベロープを介して報告されます。

UIP 会話型エージェント

会話型エージェントのリリースを検査します。

UIP 会話型エージェントのリスト

オプション

長押し	値 (Value)	説明
--folder-id <id>	正の整数	会話型エージェントをフォルダーごとにフィルター処理します。

例

uip conversational agents list --folder-id 123456

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

{
  "Result": "Success",
  "Code": "ConversationalAgentList",
  "Data": [
    {
      "id": 42,
      "releaseKey": "b2c3d4e5-0000-0000-0000-000000000001",
      "name": "Support Assistant",
      "description": "Handles tier-1 support conversations",
      "processVersion": "1.0.0",
      "processKey": "SupportAssistant",
      "folderId": 123456,
      "feedId": "c3d4e5f6-0000-0000-0000-000000000001",
      "createdTime": "2026-08-01T10:00:00Z"
    }
  ]
}

キーは、パスカル大文字と小文字ではなくネイティブのキャメルケース (preserveDataKeys: true) で保持されます。

UIP 会話型エージェントは を取得します。

オプション

長押し	値 (Value)	Required	説明
--release-id <id>	正の整数	○	エージェント リリース ID。
--folder-id <id>	正の整数	○	エージェントを含むフォルダー ID です。

例

uip conversational agents get --release-id 42 --folder-id 123456

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

{
  "Result": "Success",
  "Code": "ConversationalAgent",
  "Data": {
    "id": 42,
    "releaseKey": "b2c3d4e5-0000-0000-0000-000000000001",
    "name": "Support Assistant",
    "description": "Handles tier-1 support conversations",
    "processVersion": "1.0.0",
    "processKey": "SupportAssistant",
    "folderId": 123456,
    "feedId": "c3d4e5f6-0000-0000-0000-000000000001",
    "createdTime": "2026-08-01T10:00:00Z",
    "appearance": { "...": "agent chat-widget appearance config" }
  }
}

appearance は、すでに表示されている値を超える get 返されるフィールド list 1 つです。

UIP の会話

会話を作成、一覧表示、検査、更新、削除し、添付ファイルを管理します。

UIP 会話による作成

オプション

長押し	値 (Value)	Required	説明
--release-id <id>	正の整数	○	会話が有効なリリースの ID です。
--folder-id <id>	正の整数	○	リリースを含むフォルダー ID です。
--label <label>	string	×	会話のラベル。
--autogenerate-label	フラグ	×	やり取りが発生した後のラベルの自動生成を有効化します。
--no-autogenerate-label	フラグ	×	ラベルの自動生成を無効化します。
--agent-input <json>	JSON 文字列	×	エージェントの初期入力 — { inline: <value> }として解析およびラップされます。無効な JSON で高速で失敗する

例

uip conversational conversations create --release-id 42 --folder-id 123456 --label "Order 4471"

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

{
  "Result": "Success",
  "Code": "ConversationCreated",
  "Data": {
    "id": "b2c3d4e5-0000-0000-0000-000000000001",
    "label": "Order 4471",
    "autogenerateLabel": false,
    "agentId": 42,
    "folderId": 123456,
    "agentInput": { "inline": {} },
    "traceId": "d4e5f6a7-0000-0000-0000-000000000001",
    "spanId": "e5f6a7b8",
    "createdTime": "2026-08-01T10:00:00Z",
    "lastActivityTime": "2026-08-01T10:00:00Z"
  }
}

UIP 会話のリスト

オプション

長押し	値 (Value)	説明
--limit <number>	正の整数	ページあたりの会話数
--sort-order <order>	ascending|descending	並べ替え順序。
--cursor <token>	string	次のページのページネーション カーソルです。
--agent-id <id>	正の整数	エージェント リリース ID でフィルター処理します。
--agent-key <guid>	string	エージェントのリリース キーでフィルター処理します。
--label <substring>	string	ラベル部分文字列でフィルター処理し、大文字と小文字を区別せず、1 文字から 100 文字でフィルター処理します。

例

uip conversational conversations list --agent-id 42 --limit 20

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

{
  "Result": "Success",
  "Code": "ConversationList",
  "Data": {
    "items": [{ "id": "b2c3d4e5-0000-0000-0000-000000000001", "label": "Order 4471" }],
    "nextCursor": null
  }
}

UIP 会話は を取得します。

引数

名前	Required	目的
<conversation-id>	○	会話の UUID。

例

uip conversational conversations get b2c3d4e5-0000-0000-0000-000000000001

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

createの回答と同じ形Code: "Conversation"。

UIP の会話の更新

少なくとも 1 つのオプションが必要です。4 つすべてを省略すると、ネットワーク呼び出しの前にクライアント側で失敗します。

引数

名前	Required	目的
<conversation-id>	○	会話の UUID。

オプション

長押し	値 (Value)	説明
--label <label>	string	新しい会話ラベル。
--autogenerate-label	フラグ	ラベルの自動生成を有効化します。
--no-autogenerate-label	フラグ	ラベルの自動生成を無効化します。
--agent-input <json>	JSON 文字列	エージェント入力の更新 — 値全体を置換します。 { inline: <value> }としてラップされます。

例

uip conversational conversations update b2c3d4e5-0000-0000-0000-000000000001 --label "Order 4471 (resolved)"

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

createの回答と同じ形Code: "ConversationUpdated"。

UIP 会話 削除

破壊的 — -y/--yesが必要です。CLI はプロンプトを表示しません。

引数

名前	Required	目的
<conversation-id>	○	会話の UUID。

オプション

長押し	説明
-y, --yes	この元に戻せない操作を確認します。必須 — 省略すると、ネットワーク呼び出しの前に失敗します。

例

uip conversational conversations delete b2c3d4e5-0000-0000-0000-000000000001 -y

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

createの応答と同じ形状 Code: "ConversationDeleted" — 削除された会話の最後の既知のステートです。

UIP 会話の添付ファイルのアップロード

ローカル ファイルを会話の添付ファイルとしてアップロードします。

引数

名前	Required	目的
<conversation-id>	○	会話の UUID。

オプション

長押し	値 (Value)	Required	説明
--file <path>	パス	○	アップロードするローカル ファイルへのパスです。

例

uip conversational conversations attachments upload b2c3d4e5-0000-0000-0000-000000000001 --file ./invoice.pdf

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

{ "Result": "Success", "Code": "AttachmentUploaded", "Data": { "...": "raw upload result from the conversational-agent SDK" } }

UIP 会話 添付ファイル GET-URI

ローカル ファイルをアップロードせずに、添付ファイルの署名済みアップロード URI を取得します (帯域外アップロードの場合)。

引数

名前	Required	目的
<conversation-id>	○	会話の UUID。

オプション

長押し	値 (Value)	Required	説明
--file-name <name>	string	○	URI で受け入れるファイルの名前です。

例

uip conversational conversations attachments get-uri b2c3d4e5-0000-0000-0000-000000000001 --file-name invoice.pdf

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

{ "Result": "Success", "Code": "AttachmentUri", "Data": { "...": "pre-signed URI payload" } }

関連

• 会話型: やり取り、メッセージ、トランク、ユーザー設定 — 会話履歴、フィードバック、音声チャネル ルーティング、プロファイル設定。

参照

• グローバル オプション
• 終了コード