UIP-Dokumentation

uip docsai stellt Fragen in natürlicher Sprache anhand der Dokumentation von UiPath und gibt eine KI-generierte Antwort mit Quell-URLs und vorgeschlagenen Anschlussfragen zurück. Intern kommuniziert das Tool mit einem gehosteten MCP-Server (SearchDocumentation -Tool) und nicht mit einem REST-Endpunkt – deshalb hat die Ausgabeform ein query_id -Feld.

Unter Tools (Plugins) finden Sie weitere Informationen zur Integration dieses Tools in die CLI.

Zusammenfassung

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

Alle Unterbefehle berücksichtigen die globalen Optionen und Exitcodes.

UIP-Docsai fragen

Durchsuchen Sie die UiPath-Dokumentation. Gibt eine synthetisierte Antwort und die Quellen zurück, die sie unterstützt.

Argumente

• <query> (erforderlich) – Die Frage als Zeichenfolge in natürlicher Sprache. Umbrechen Sie sie in Anführungszeichen, wenn sie Leerzeichen enthält.

Optionen

• -t, --tenant <name> – Mandant; standardmäßig der von uip login ausgewählte Mandant.
• --source <source> – Zu durchsuchende Wissensdatenbank. Entweder docs (Standard) oder technical_solution_articles. Ungültige Werte schlagen zum Parsezeitpunkt fehl.

Beispiele

# 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

Ausgabeformatierung

uip docsai ask passt seine Ausgabe an den globalen --output -Modus der CLI an:

• --output table (Standard) und --output plain geben eine lesbare, menschliche Antwort aus: den Antworttext, dann eine Sources: -Liste und dann (falls vorhanden) Follow-up questions:.
• --output json Gibt die geparste Antwort im Standardumschlag aus.

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

• query_id – eindeutige ID für diese Abfrage.
• text – KI-generierte Antwort.
• sources – absolute URLs für die in der Antwort zitierten Dokumentationsseiten.
• disclaimers – alle Warnungen des Servers möchten, dass der Client neben der Antwort erscheint (oft leer).
• followups – vorgeschlagene nächste Fragen, bewertet.

Wenn der Server eine Antwort zurückgibt, die die CLI nicht als die oben strukturierte Form analysieren kann, greift Data auf das Rohinhaltsarray aus dem MCP-Tool-Aufruf zurück, sodass nichts verloren geht.

Fehlerverhalten

• Fehler beim Erstellen des MCP-Clients (normalerweise ein Authentifizierungs- oder Konnektivitätsproblem): Failure: "Error querying DocsAI" mit dem zugrunde liegenden Fehler in Instructions, Exit 1.
• Fehler beim Aufruf des MCP-Tools: der gleiche Failure: "Error querying DocsAI" -Umschlag; Die CLI schließt den Client sauber, bevor er beendet wird.
• Serverseitiger Fehler (z. B. Ratenlimit): Failure: "DocsAI returned an error" mit der Rohinhaltsnutzlast in Instructions.

Zugehörig

• Tools (Plugins) – Installieren, Aktualisieren und Deinstallieren des Pakets docsai-tool .
• uip mcp – ermöglicht es einem Client -MCP-Host, die CLI aufzurufen; docsai geht in die andere Richtung und ruft einen Remote -MCP-Server auf.
• uip login – Sitzung, die zur Authentifizierung von DocsAI-Aufrufen verwendet wird.