UiPath Docsai

Syntaxe et options pour `uip docsai`, qui interroge la documentation UiPath en langage naturel et renvoie des réponses générées par l'IA avec des URL sources.

uip docsai pose des questions en langage naturel par rapport à la documentation d’UiPath, renvoyant une réponse générée par l’IA avec des URL sources et des suggestions de questions de suivi. En interne, l’outil communique avec un serveur MCP hébergé (outil SearchDocumentation ) plutôt qu’un point de terminaison REST; c’est pourquoi la forme de sortie comporte un champ query_id .

Voir Outils pour découvrir comment cet outil s'intègre à la CLI.

Synthèse

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

Toutes les sous-commandes respectent les options globales et les codes de sortie.

Demander uip docsai

Rechercher la documentation UiPath. Renvoie une réponse synthétisée et les sources qui la soutiennent.

Arguments

• <query> (requis) : la question, sous la forme d'une chaîne en langage naturel. Enveloppez de guillemets si elle contient des espaces.

Options

• --source <source> — Base de connaissances à rechercher. L’un de docs (par défaut) ou technical_solution_articles. Les valeurs non valides échouent au moment de l’analyse.

Exemples

# 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

Formatage de sortie

uip docsai ask adapte sa sortie au mode --output global de la CLI:

• --output table (par défaut) et --output plain impriment une réponse lisible et conviviale: le texte de la réponse, puis une liste Sources: , puis (si présent) Follow-up questions:.
• --output json génère la réponse analysée dans l'enveloppe standard.

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

• query_id — ID unique pour cette requête.
• text — Réponse générée par l'IA.
• sources — URL absolues pour les pages de documentation citées dans la réponse.
• disclaimers — les avertissements que le serveur souhaite que le client fasse apparaître à côté de la réponse (souvent vides).
• followups — questions suivantes suggérées, classées.

Si le serveur renvoie une réponse que la CLI ne peut pas analyser comme la forme structurée ci-dessus, Data revient au tableau de contenu brut de l'appel d'outil MCP afin que rien ne soit perdu.

Comportement des erreurs

• Échec de la création du client MCP (généralement un problème d'authentification ou de connectivité): Failure: "Error querying DocsAI" avec l'erreur sous-jacente dans Instructions, sortie 1.
• Erreurs d’appel d’outil MCP: même enveloppe Failure: "Error querying DocsAI" ; la CLI ferme le client proprement avant de quitter.
• Erreur côté serveur (par exemple, limite de débit): Failure: "DocsAI returned an error" avec la charge utile de contenu brut dans Instructions.

Associé

• Outils (extensions) : installez, mettez à jour, désinstallez le package docsai-tool .
• uip mcp — permet à un hôte MCP client d'invoquer la CLI; docsai va dans l’autre sens et appelle un serveur MCP distant .
• uip login — session utilisée pour authentifier les appels DocsAI.