UIP のコンテキスト グラウンディング

「uip context-grounding」の構文とオプション。コンテキスト グラウンディング操作のための Python UiPath CLI へのブリッジです。

uip context-grounding は、Python ベースの UiPath SDK のコンテキスト グラウンディング操作への細いブリッジです。適切な Python インタプリタを検出し、 uipath Python パッケージがインストールされていることを確認し、他のすべてを uipath context-grounding <args> として Python CLI に転送します — このツールは、 以外のネイティブのサブコマンドを定義しません setup。

サブコマンド名の固定ホワイトリストのみを転送する uip codedagentとは異なり、認識できないコマンドcontext-grounding-tool転送します — ここでは、新しい Python 側動詞が機能する前に確認する許可リストはありません。

シンラッパーとフルツールの違いについては、 ツール (プラグイン) を参照してください。

概要

uip context-grounding setup [--force]
uip context-grounding <any-command> [args...]
uip context-grounding help
uip context-grounding

setup および転送されるコマンドには、 グローバル オプション (--output、 --output-filter、 --log-level、 --log-fileが適用されます。終了コードは 標準契約に従います。

UIP コンテキスト グラウンディングの設定

Python を検出し、 uipath パッケージがインストールされていることを確認します。結果はユーザーごとのファイルにキャッシュされるため、後続の context-grounding コマンドでPythonバイナリを即座に解決できます。

引数

設定はありません。

オプション

• --force — キャッシュされた結果が存在する場合でも、検出を再実行します。

例

uip context-grounding setup
uip context-grounding setup --force

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

{
  "Code": "ContextGroundingSetup",
  "Data": {
    "PythonPath": "/usr/bin/python3.11",
    "Package": "uipath",
    "PackageInstalled": "Yes",
    "PackageVersion": "1.0.0"
  }
}

環境チェック

• 許可される Python のバージョンは、環境変数 ( PYTHON_TOOL_PYTHON_VERSIONS) を使用して構成されます。リストが空の場合、セットアップ時に Failure が発生します。
• 現在の作業ディレクトリに .venv ディレクトリが存在するが、仮想環境がアクティブになっていない場合、セットアップは実行を拒否し、最初にアクティブにすることを提案します(Windowsでは.venv\Scripts\activate 、他の場所では source .venv/bin/activate )。

転送されるコマンド

setupまたはhelpされていないサブコマンドは、uipath context-grounding <args>として Python uipath CLI に転送されます。Python パッケージが明日追加するまったく新しい動詞は、1 つの例外を除いて、今日はここで機能します。

注:

auth はブロックされます。uip context-grounding auth ... を呼び出すとすぐに失敗し、Result: ValidationError (終了コード 3) と「認証に「uip login' を使用してください」というメッセージが表示されます。— --force渡さない限り、この 1 つのフィルターをバイパスして auth を Python に呼び出すことができます。これは、 --forceが uip codedagentに及ぼす影響とは逆で、 --force は常に静かに剥ぎ取られ、Pythonに到達することはありません。

例

# Hand off to the Python CLI's index command
uip context-grounding index ./my-index

# Search a context grounding index
uip context-grounding search "invoice total" --index my-index

# Blocked without --force
uip context-grounding auth login
# Result: ValidationError — "Use 'uip login' for authentication."

# Bypasses the auth filter
uip context-grounding auth login --force

注:

転送されたコマンドは uipath Python パッケージによって定義されるため、そのフラグと出力形状は、CLI の標準の Code/Data エンベロープではなく、そのパッケージが出力するものです。ここでは、CLI をトランスポートとして扱います。引数サーフェスに対して、 uip context-grounding <command> --helpを実行します。

Output-format relay: グローバル --output が jsonの場合、CLI は転送されたコマンドに --format json を自動的に追加します ( --help 呼び出しの場合、または転送された引数にすでに --formatが含まれている場合はスキップされます) — これが効果を発揮するには、Python CLI が --format json をサポートしている必要があります。この方法で中継される出力形式は他にありません。

ベア呼び出しと help は両方を転送 します — uip codedagent (裸の help は Commander 自身の助けを示します) とは異なり、引数のない uip context-grounding は exec --helpに転送され、 uip context-grounding help は明示的に同じ exec --help 呼び出しに転送されます。どちらも、このツールではなく、Python パッケージ独自のヘルプテキストを表示します。

認証リレー: 転送する前に、CLI は uip login によって作成されたセッションを読み取り、uip codedagent が使用するのと同じメカニズムで Python サブプロセスの環境に挿入します。ログインしていない場合でも、転送は機能します。Python CLI は、これらの変数なしで実行されます。

終了コード

標準の終了コードに加えて、上記のブロックされたauthコマンド専用の3が適用されます。それ以外の場合は、転送されたサブプロセスの終了コードが親シェルに直接中継されます。

関連

• ツール (プラグイン) — シンラッパーツールモデル。
• uip codedagent — 同じ Python ブリッジ パターンで、すべてを転送するのではなく、固定転送ホワイトリストを使用します。
• uip login — Python ランタイムにリレーされるセッションを作成します。
• uip tools — context-grounding-toolパッケージ自体をインストール、更新、アンインストールします。