Einbetten von IFrame und Apps

Überblick

Integrieren Sie Ihren Konversations-Agent mithilfe von iFrame in Webanwendungen. Mit diesem Ansatz können Sie Konversations-Agents zu Drittanbieter-Anwendungen oder zu UiPath Apps mithilfe der iFrame-Komponente hinzufügen.

Vorgesehene Benutzer: Entwickler und Administratoren, die Konversations-Agents in benutzerdefinierte Webanwendungen oder UiPath Apps einbetten möchten.

Funktionsverfügbarkeit

Funktionen	Verfügbar
Neuen Chat starten	✅
Chatverlauf	✅
Löschen Sie die Chatsitzung	✅
Einstellungen	✅
Eingabeaufforderungen beim Starten	✅
Dateiuploads	✅
Zitate	❌
HTML-Vorschau	✅
Antwort kopieren	✅
Feedback (Miniaturen)	✅
Debug-Dump	❌

Voraussetzungen

Um einen Konversations-Agent einzubetten, führen Sie die folgenden Einrichtungsschritte aus:

Administrator- oder Entwicklereinrichtung

1. Veröffentlichen Sie den Konversations-Agent im gewünschten Orchestrator-Ordner.
2. Release-ID des Agents aus der Instanzverwaltung abrufen.
3. Erstellen Sie für UiPath Apps ein Apps-Projekt in UiPath Studio.
4. Stellen Sie bei Drittanbieter-Apps sicher, dass die Webanwendung die iFrame-Einbettung unterstützt.

Suchen der Agent-ID

1. Gehen Sie in der Instanzverwaltung zu Agents > Bereitgestellte Agents.
2. Wählen Sie Chat für den gewünschten Agenten.
3. Kopieren Sie die Mitarbeiter-ID aus der URL. In der URL https://cloud.uipath.com/conversationalagents/agents_/deployed/chat/342061 ist die Agent-ID beispielsweise 342061.

Benutzeranforderungen:

• Authentifizierte Benutzer müssen über ein UiPath-Konto mit Berechtigung für den Zugriff auf den Agent verfügen.
• Einanonymer Benutzer muss Zugriff auf die Anwendung oder Oberfläche haben, in die der Agent eingebettet ist.

Einbetten des Agents

URL-Konstruktion

Legen Sie die iFrame-Quelle auf eine URL mit dem folgenden Format fest:

https://cloud.uipath.com/<organization>/<tenant>/autopilotforeveryone_/conversational-agents/?agentId=<agent_id>&mode=<mode>

Hinweis:

Beim Namen der Organisation und des Mandanten wird die Groß-/Kleinschreibung beachtet.

URL-Parameter

Parameter	Erforderlich	Beschreibung
agentId	Ja	Die Release-ID des veröffentlichten Agents
mode	Nein	embedded für die rechte Leiste, fullscreen für Vollbild (Standard: fullscreen)
title	Nein	Im Chat-Header angezeigter Titel (Standard: Name des Agents)
welcomeTitle	Nein	Titel für den Begrüßungsbildschirm bei der ersten Ausführung
welcomeDescription	Nein	Beschreibung für den Begrüßungsbildschirm bei der ersten Ausführung
suggestions	Nein	Array der vorgeschlagenen Prompts für die erste Ausführung
showHistory	Nein	Chatverlaufsbereich anzeigen/ausblenden (Standard: true)

Beispiel-URLs

Standard eingebetteter Modus:

https://cloud.uipath.com/myorg/mytenant/autopilotforeveryone_/conversational-agents/?agentId=12345&mode=embedded

Mit Begrüßungsnachricht und Vorschlägen:

https://cloud.uipath.com/myorg/mytenant/autopilotforeveryone_/conversational-agents/?agentId=12345&mode=embedded&title=HR Assistant&welcomeTitle=Welcome!&welcomeDescription=I can help you with HR questions&suggestions=["What is the PTO policy?","How do I submit expenses?"]

Einbetten in UiPath Apps

Um einen Konversations-Agent in UiPath Apps einzubetten, verwenden Sie die iFrame-Komponente.

1. Öffnen Sie Ihre App in UiPath Apps Studio.

2. Fügen Sie Ihrer Seite eine iFrame- Komponente hinzu.

3. Legen Sie die Eigenschaft iFrame -Quelle auf die erstellte URL fest.

4. Veröffentlichen Sie die App.

   

Wenn Sie einen Konversations-Agent in UiPath Apps einbetten, umgehen Sie das Vorschlag-Array, indem Sie doppelte Anführungszeichen verwenden, wie im folgenden Beispiel gezeigt:

suggestions=[""What is the PTO policy?"",""How do I submit expenses?""]

Dies ist erforderlich, da UiPath Apps den Wert als Zeichenfolge überprüft.

Einbetten in Anwendungen von Drittanbietern

Sie können einen Konversations-Agent in jede Webanwendung einbetten, die die Einbettung von iFrame unterstützt.

HTML-Beispiel:

<iframe
  src="https://cloud.uipath.com/myorg/mytenant/autopilotforeveryone_/conversational-agents/?agentId=12345&mode=embedded"
  width="400"
  height="600"
  frameborder="0"
  allow="clipboard-write"
></iframe>

Überlegungen

• Quellenübergreifende Richtlinien: Stellen Sie sicher, dass die Inhaltssicherheitsrichtlinie Ihrer Anwendung das Einbetten von uipath.com zulässt.
• Reaktionsfähiges Design: Konfigurieren Sie geeignete Werte für Breite und Höhe, um eine korrekte Darstellung über alle Bildschirmgrößen hinweg sicherzustellen.
• Zugriff auf Zwischenablage: Fügen Sie allow="clipboard-write" ein, um die Antwortfunktion kopieren zu aktivieren.

Chatfunktionen

Der eingebettete Chat verwendet die Chat-UI für die Instanzverwaltung und bietet die gleiche Chat-Funktionalität, mit den folgenden Ausnahmen und Einschränkungen.

Einschränkungen

Die folgenden Funktionen sind im eingebetteten Modus nicht verfügbar:

Funktionen	Hinweise
Zitate	Zitatvorschau ist nicht verfügbar
Debug-Dump	Nicht verfügbar. Verwenden Sie die Instanzverwaltung für das Debuggen.

Authentifizierungsoptionen

Authentifizierte Benutzer

Für interne Benutzer mit UiPath-Konten:

• Benutzer authentifizieren sich mithilfe der standardmäßigen UiPath-Authentifizierung.
• Der Agent hat Zugriff auf die Identitätsinformationen des Benutzers, wie z. B. Name und E-Mail-Adresse.
• Der Verbrauch wird anhand der Benutzerlizenz nachverfolgt.

Anonyme Benutzer

Für externe oder nicht authentifizierte Szenarien:

• Eine vertrauliche externe Anwendung muss im Administratorportal konfiguriert werden.
• Ein von Ihrer Organisation gehosteter Tokenendpunkt ist erforderlich.
• Es ist keine individuelle Benutzerlizenz erforderlich.
• Der Verbrauch wird vom Einheitenpool des Mandanten abgezogen.

Anweisungen zur Einrichtung finden Sie unter Einrichtung von anonymem Zugriff.

Weitere Einzelheiten zur Lizenzierung finden Sie unter Lizenzierung.

Warnung:

Anonymer Zugriff ermöglicht Benutzern ohne UiPath-Konten die Interaktion mit Ihrem Agent. Es wird dringend empfohlen, anonyme Agents hinter Ihrem eigenen Portal oder Ihrer Anmeldung zu platzieren, um Missbrauch zu vermeiden.

Fehlersuche und ‑behebung

iFrame wird nicht geladen

• Überprüfen Sie, ob die URL korrekt erstellt wurde.
• Überprüfen Sie, ob die Agent-ID gültig ist.
• Stellen Sie sicher, dass der Agent veröffentlicht wurde und ausgeführt wird.
• Überprüfen Sie die Browserkonsole auf Fehler bei der Inhaltssicherheitsrichtlinie.

Kopieren funktioniert nicht

• Stellen Sie sicher, dass der iFrame das Attribut allow="clipboard-write" enthält.
• Überprüfen Sie die Browserberechtigungen für den Zugriff auf die Zwischenablage.

Nächste Schritte

• Einrichtung von anonymem Zugriff: Aktivieren Sie den Zugriff für Benutzer ohne UiPath-Konten
• Instanzverwaltung: Vollständige Funktionsreferenz und Debugging