Documento da UIP

uip docsai faz perguntas em linguagem natural contra a documentação da UiPath, retornando uma resposta gerada por IA com URLs de origem e perguntas de acompanhamento sugeridas. Internamente, a ferramenta se comunica com um servidor MCP hospedado (ferramenta SearchDocumentation ) em vez de um ponto de extremidade REST — é por isso que o formato de saída tem um campo query_id .

Consulte Ferramentas ( plugins ) para saber como essa ferramenta integra-se à CLI.

Resumo

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

Todos os subcomando honram as opções globais e os códigos de saída.

pergunta do uip docsai

Pesquise a documentação da UiPath. Retorna uma resposta sintetizada e as origens que a apoiaram.

Argumentos

• <query> necessário) — A pergunta, como uma string de idioma natural. Encapsule aspas se contiver espaços.

Opções

• -t, --tenant <name> — Tenant; o padrão é o tenant selecionado por uip login.
• --source <source> — Base de conhecimento a ser pesquisada. Um destes docs (padrão) ou technical_solution_articles. Valores inválidos falham no momento da análise.

Exemplos

# 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

Formatação de saída

uip docsai ask sua saída ao modo global --output da CLI:

• --output table (padrão) e --output plain imprimem uma resposta legível e amigável para humanos: o texto da resposta, depois uma lista Sources: e, depois, (se presente) Follow-up questions:.
• --output json emite a resposta analisada no envelope padrão.

Formato dos dados (--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/pt-BR/orchestrator/standalone/2022.4/user-guide/managing-processes"
    ],
    "disclaimers": [],
    "followups": [
      "What permissions are required to create a process in Orchestrator?"
    ]
  }
}

• query_id ID exclusivo para esta consulta.
• text Resposta gerada por IA.
• sources URLs absolutos para as páginas de documentação mencionadas na resposta.
• — disclaimers avisos que o servidor deseja que o cliente exiba junto com a resposta (muitas vezes vazia).
• followups — próximas perguntas sugeridas, classificadas.

Se o servidor retornar uma resposta que a CLI não puder analisar como a forma estruturada acima, Data retorna para a matriz de conteúdo bruto da chamada de ferramenta MCP para que nada seja perdido.

Comportamento de erro

• Falha ao criar o cliente MCP (normalmente um problema de autenticação ou conectividade): Failure: "Error querying DocsAI" com o erro subjacente em Instructions, saída 1.
• Erros de chamada de ferramenta MCP: mesmo envelope Failure: "Error querying DocsAI" ; a CLI fecha o cliente corretamente antes de sair.
• Erro no lado do servidor (por exemplo, limite de taxa): Failure: "DocsAI returned an error" com a carga de conteúdo bruto em Instructions.

Relacionado

• Ferramentas ( plugins ) — instalam, atualizam e desinstalam o pacote docsai-tool .
• uip mcp — permite que um host cliente MCP invoque a CLI; docsai vai na outra direção e chama um servidor MCP remoto .
• uip login — sessão usada para autenticar chamadas do DocsAI.