Contextualização da uip

Sintaxe e opções para "uip context-grounding", uma ponte para o Python UiPath CLI para operações de contextualização.

uip context-grounding é uma ponte fino para as operações de contextualização do SDK da UiPath baseada em Python. Ela detecta um interpretador de Python adequado, confirma que o pacote Python uipath está instalado e encaminha todo o resto para o CLI do Python como uipath context-grounding <args> — essa ferramenta não define nenhum subcomando nativo além de setup.

Ao contrário de uip codedagent, que encaminha apenas uma lista de permissões fixa de nomes de subcomando, context-grounding-tool encaminha qualquer comando não reconhecido — não há lista de permissões para consultar antes que um novo verbo do lado do Python funcione aqui.

Consulte Ferramentas ( Não

Resumo

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

e qualquer comando encaminhado respeita --output opções globais ( setup , --output-filter, --log-level, --log-file). Os códigos de saída seguem o contrato padrão.

configuração de contextualização do uip

Detecte Python e verifique uipath o pacote está instalado. Os resultados são armazenados em cache em um arquivo por usuário para que os comandos context-grounding subsequentes possam resolver o binário do Python instantaneamente.

Argumentos

Nenhum.

Opções

• --force Execute novamente a detecção mesmo se um resultado em cache estiver presente.

Exemplos

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

Formato dos dados (--output json)

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

Verificações de ambiente

• As versões permitidas do Python são configuradas por meio da variável de ambiente PYTHON_TOOL_PYTHON_VERSIONS. Uma lista vazia gera Failure no momento da configuração.
• Se um diretório .venv existir no diretório de trabalho atual, mas nenhum ambiente virtual for ativado, a configuração se recusa a ser executada e sugere ativá-lo primeiro (.venv\Scripts\activate no Windows, source .venv/bin/activate em outro lugar).

Comandos encaminhados

Qualquer subcomando que não seja setup ou help é encaminhado para a CLI uipath do Python como uipath context-grounding <args> — não há lista de permissões fixa para verificar; um verbo novíssimo que o pacote Python adiciona amanhã funciona aqui hoje, com uma exceção:

Observação:

auth está bloqueado. A chamada de uip context-grounding auth ... falha imediatamente com Result: ValidationError (código de saída 3) e a mensagem "Use 'uip login' para autenticação." — a menos que você passe --force, que ignora esse filtro e permite que a chamada auth passe para o Python. Isso é o oposto do efeito de --force em uip codedagent, onde --force é sempre removido silenciosamente e nunca chega a Python — aqui é uma entrada de escape real, porém estreita.

Exemplos

# 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

Observação:

Como os comandos encaminhados são definidos pelo pacote Python uipath, seus sinalizadores e formato de saída são o que esse pacote emite — não o envelope padrão Code/Data da CLI. Trate a CLI aqui como um transporte. Para a superfície do argumento, execute uip context-grounding <command> --help.

Relay no formato de saída: quando o --output global é json, a CLI anexa --format json ao comando encaminhado automaticamente (ignorado para chamadas --help ou quando os argumentos encaminhados já contêm --format) — o CLI do Python deve suportar --format json para que tenha efeito; nenhum outro formato de saída é transmitido dessa forma.

Invocação bruta e help ambos para a frente — ao contrário de uip codedagent (em que help apenas mostra a ajuda do próprio Comando), uip context-grounding sem argumentos encaminha para exec --help e uip context-grounding help encaminha explicitamente para a mesma chamada exec --help . Ambos exibem o texto de ajuda do próprio pacote Python, não o desta ferramenta.

Relay de autenticação: antes de encaminhar, a CLI lê a sessão criada por uip login e a injeta no ambiente do subprocesso Python, o mesmo mecanismo que uip codedagent utiliza. Se você não estiver conectado, o encaminhamento ainda funcionará; a CLI do Python é executada sem essas variáveis.

Códigos de saída

Os códigos de saída padrão se aplicam, mais 3 especificamente para o comando bloqueado auth descrito acima. Caso contrário, o código de saída do subprocesso encaminhado é relaydo diretamente para o shell pai.

Relacionado

• Ferramentas ( plugins ) — modelo de ferramenta de envolvimento fino.
• uip codedagent — o mesmo padrão de ponte do Python, com uma lista de permissões de encaminhamento fixa em vez de encaminhar tudo.
• uip login — cria a sessão que é reenviada para o runtime do Python.
• uip tools — instalar, atualizar e desinstalar o próprio pacote context-grounding-tool .