UIP Docsai

Sintaxis y opciones para `uip docsai`, que consulta la documentación de UiPath a través del lenguaje natural y devuelve respuestas generadas por IA con las URL de origen.

uip docsai hace preguntas en lenguaje natural sobre la documentación de UiPath, devolviendo una respuesta generada por IA con las URL de origen y preguntas de seguimiento sugeridas. Internamente, la herramienta se comunica con un servidor MCP alojado (herramienta SearchDocumentation ) en lugar de con un punto final REST; esta es la razón por la que la forma de salida tiene un campo query_id .

Consulta Herramientas (complementos) para ver cómo se integra esta herramienta con la CLI.

Sinopsis

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

Todos los subcomandos respetan las opciones globales y los códigos de salida.

uip docsai preguntar

Buscar en la documentación de UiPath. Devuelve una respuesta sintetizada y las fuentes que la respaldaron.

Argumentos

• <query> requerido) — La pregunta, como una cadena de lenguaje natural. Ajustar entre comillas si contiene espacios.

Opciones

• -t, --tenant <name> — Tenant; el valor predeterminado es el tenant seleccionado por uip login.
• --source <source> — Base de conocimientos para buscar. Uno de docs (predeterminado) o technical_solution_articles. Los valores no válidos fallan en el momento del análisis.

Ejemplos

# 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

Formato de salida

uip docsai ask adapta su salida al modo --output global de la CLI:

• --output table (predeterminado) e --output plain imprimen una respuesta legible y fácil de usar: el texto de respuesta, luego una lista Sources: y luego (si está presente) Follow-up questions:.
• --output json emite la respuesta analizada en el sobre estándar.

Forma de datos (--json de salida)

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

• query_id — ID único para esta consulta.
• text — Respuesta generada por IA.
• sources : URL absolutas para las páginas de documentación citadas en la respuesta.
• disclaimers — cualquier advertencia que el servidor quiera que el cliente muestre junto con la respuesta (a menudo vacía).
• followups : siguientes preguntas sugeridas, clasificadas.

Si el servidor devuelve una respuesta que la CLI no puede analizar como la forma estructurada anterior, Data recurre a la matriz de contenido sin procesar de la llamada de la herramienta MCP para que no se pierda nada.

Comportamiento de error

• Fallo al crear el cliente MCP (normalmente un problema de autenticación o conectividad): Failure: "Error querying DocsAI" con el error subyacente en Instructions, salida 1.
• Errores de llamada de herramienta de MCP: mismo sobre Failure: "Error querying DocsAI" ; la CLI cierra el cliente limpiamente antes de salir.
• Error del lado del servidor (por ejemplo, límite de tasa): Failure: "DocsAI returned an error" con la carga útil de contenido sin procesar en Instructions.

Relacionado

• Herramientas (complementos) : instala, actualiza y desinstala el paquete docsai-tool .
• uip mcp : permite a un host MCP de cliente invocar la CLI; docsai va en la otra dirección y llama a un servidor MCP remoto .
• uip login : sesión utilizada para autenticar las llamadas de DocsAI.