uip ancrage dans le contexte

Syntaxe et options pour `uip context-grounding`, un pont vers la UiPath CLI pour les opérations d'ancrage dans le contexte.

uip context-grounding est un pont léger vers les opérations d’ancrage dans le contexte du SDK UiPath basé sur Python. Il détecte un interprète Python approprié, confirme que le package Python uipath est installé et transmet tout le reste à la CLI Python en tant que uipath context-grounding <args> — cet outil ne définit aucune sous-commande native au-delà de setup.

Contrairement à uip codedagent, qui ne transmet qu'une liste blanche fixe de noms de sous-commandes, context-grounding-tool transmet toute commande non reconnue - il n'y a pas de liste d'autorisation à consulter avant qu'un nouveau verbe côté Python ne fonctionne ici.

Voir Outils pour la façon dont les encapsuleurs légers diffèrent des outils complets.

Synthèse

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

setup et toute commande transférée respectent les options globales (--output, --output-filter, --log-level, --log-file). Les codes de sortie suivent le contrat standard.

configuration de l’ancrage dans le contexte de l’interface utilisateur

Détectez Python et vérifiez que le package uipath est installé. Les résultats sont mis en cache dans un fichier par utilisateur afin que les commandes context-grounding ultérieures puissent résoudre le binaire Python instantanément.

Arguments

Aucun

Options

• --force — Réexécuter la détection même si un résultat mis en cache est présent.

Exemples

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

Format des données (--output json)

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

Vérifications de l'environnement

• Les versions Python autorisées sont configurées via la variable d’environnement PYTHON_TOOL_PYTHON_VERSIONS. Une liste vide génère Failure au moment de la configuration.
• Si un répertoire .venv existe dans le répertoire de travail actuel mais qu'aucun environnement virtuel n'est activé, la configuration refuse de l'exécuter et suggère de l'activer d'abord (.venv\Scripts\activate sous Windows, source .venv/bin/activate ailleurs).

Commandes transférées

Toute sous-commande qui n'est pas setup ou help est transmise à la CLI Python uipath en tant que uipath context-grounding <args> — il n'y a pas de liste blanche fixe à vérifier; un verbe complètement nouveau ajouté par le paquet Python demain fonctionne ici aujourd’hui, avec une exception:

Remarque :

auth est bloqué. L’appel de uip context-grounding auth ... échoue immédiatement avec Result: ValidationError (code de sortie 3) et le message « Utiliser ’uip pull’ pour l’authentification.» — à moins que vous ne passiez --force, qui contourne ce filtre et permet à l' auth d'appeler via Python. C'est l'inverse de l'effet de --force sur uip codedagent, où --force est toujours supprimé silencieusement et n'atteint jamais Python — il s'agit ici d'une passerelle d'échappement réelle, bien que étroite.

Exemples

# 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

Remarque :

Étant donné que les commandes transférées sont définies par le package Python uipath, leurs indicateurs et leur forme de sortie représentent ce qui est émis par le package, et non l'enveloppe Code/Data standard de la CLI. Traitez la CLI ici comme un transport. Pour la surface de l’argument, exécutez uip context-grounding <command> --help.

Relay au format de sortie: lorsque le --output global est json, la CLI ajoute automatiquement --format json à la commande transférée (ignoré pour les appels --help , ou lorsque les arguments transférés contiennent déjà --format) — la CLI Python doit prendre en charge --format json pour que cela ait un effet; aucun autre format de sortie n'est Relayé de cette manière.

Invocation à barres et help transfert tous les deux , contrairement à uip codedagent (où la barre help affiche l'aide du Commandant), uip context-grounding sans argument vers exec --help et uip context-grounding help redirige explicitement vers le même appel exec --help . Les deux font apparaître le propre texte d'aide du paquet Python, et non celui de cet outil.

Relay d’authentification: avant de transférer, la CLI lit la session créée par uip login et l’injecte dans l’environnement du sous-processus Python, le même mécanisme utilisé par uip codedagent . Si vous n’êtes pas connecté, le transfert fonctionne toujours; la CLI Python s'exécute sans ces variables.

Codes de sortie

Les codes de sortie standard s'appliquent, plus 3 spécifiquement pour la commande auth bloquée décrite ci-dessus. Le code de sortie du sous-processus transféré est sinon transmis directement au shell parent.

Associé

• Outils (extensions) — modèle d'outil encapsuleur fin.
• uip codedagent — le même modèle de pont Python, avec une liste blanche de transfert fixe au lieu de tout transférer.
• uip login — crée la session qui est transmise au runtime Python.
• uip tools — installez, mettez à jour, désinstallez le package context-grounding-tool lui-même.