User Manual

awaBerry | Agentic API Projektübersicht

Verwalten Sie Ihre awaBerry Agentic API-Projekte — zeigen Sie alle API-fähigen Automatisierungen an, erstellen Sie neue Projekte und greifen Sie auf...

Übersicht des Agentic API-Projekts

Zusammenfassung

Die Seite "Übersicht des Agentic API-Projekts" ist Ihr zentraler Knotenpunkt für die Verwaltung all Ihrer Agentic API-Projekte. Diese Seite zeigt eine dynamische Liste von Projekten an, die es Ihnen ermöglicht, einfach neue Projekte hinzuzufügen, deren Details anzuzeigen und Bearbeitungs- oder Löschvorgänge einzuleiten. Agentic-Projekte ermöglichen den programmatischen Zugriff auf Ihre Geräte und bieten 'Gerätezugriff als Dienstleistung' über eine API. Sie ermöglichen auch den direkten Benutzerzugriff über die Funktion 'Gerät teilen'. Die Agentic API unterstützt Orchestrierungsaufrufe über mehrere Geräte hinweg und kann mit dem awaBerry Smart Automization Framework oder Ihrer bevorzugten Entwicklungsumgebung integriert werden.

Seiten-Zugriff

Sie können auf diese Seite zugreifen, indem Sie zu folgendem navigieren: /agentic

Seiten-Funktionalitäten

Diese Seite bietet eine umfassende Übersicht und eine Verwaltungsoberfläche für Ihre Agentic API-Projekte. Zu den wichtigsten Funktionalitäten gehören:

  • Informationsbanner: Am oberen Rand der Seite bietet ein Informationsbanner mit dem Titel "Die awaBerry Agentic API - Gerätezugriff als Dienstleistung" wichtigen Kontext zu den Fähigkeiten der Agentic API. Sie können dieses Banner durch Klicken auf die Schaltfläche 'Schließen' in der oberen rechten Ecke ausblenden. Es bleibt bei zukünftigen Besuchen verborgen.
  • Anzeige der Projektanzahl: Eine klare Anzeige zeigt "Verfügbare Projekte: X" an und gibt die Gesamtzahl der von Ihnen konfigurierten API-Projekte an.
  • Beschreibung der Projektverwaltung: Ein beschreibender Text erklärt den Zweck der Seite: "Alle Ihre konfigurierten Projekte sind unten aufgelistet. Klicken Sie auf 'Neues Projekt hinzufügen', um ein neues Projekt zu erstellen und dessen Anmeldedaten, Zielgeräte und Zugriffsberechtigungen zu definieren."
  • Neues Projekt hinzufügen: Eine spezielle Schaltfläche "Neues Projekt hinzufügen" ermöglicht es Ihnen, die Erstellung eines neuen Agentic API-Projekts zu initiieren. Ein Klick darauf führt Sie durch den Prozess der Einrichtung neuer Projektanmeldedaten, Zielgeräte und Zugriffsrechte.
  • Projektliste: Unter der Schaltfläche "Neues Projekt hinzufügen" zeigt eine scrollbare Liste alle Ihre bestehenden Agentic API-Projekte an. Jedes Projekt wird durch eine Kachel dargestellt, die eine Zusammenfassung und schnellen Zugriff auf weitere Aktionen bietet.
  • Einzelne Projektaktionen: Für jedes Projekt in der Liste können Sie:
    • Details anzeigen: Greifen Sie auf eine detaillierte Ansicht der Projektkonfiguration und zugehöriger Informationen zu.
    • Projekt bearbeiten: Ändern Sie die bestehenden Details eines Projekts, wie z. B. Anmeldedaten, Gerätezuweisungen oder Berechtigungen.
    • Projekt löschen: Entfernen Sie ein Projekt dauerhaft aus Ihrer Liste. Ein Bestätigungsschritt ist in der Regel erforderlich, um versehentliches Löschen zu verhindern.

Szenario-Ausführungen

Hier sind einige gängige Szenarien, die zeigen, wie Sie die Seite "Übersicht des Agentic API-Projekts" zur effektiven Verwaltung Ihrer Projekte nutzen können.

Mögliche Nutzungsschritte auf dieser Seite:

Szenario 1: Hinzufügen eines neuen Agentic API-Projekts

  1. Suchen Sie auf der Seite "Übersicht des Agentic API-Projekts" die Schaltfläche "Neues Projekt hinzufügen" und klicken Sie darauf.
  2. Sie werden zu einer neuen Seite oder einem Dialog weitergeleitet, auf dem Sie die Details für Ihr neues Projekt eingeben können, wie z. B. Name, Beschreibung und anfängliche Konfigurationen.
  3. Folgen Sie den Anweisungen auf dem Bildschirm, um Anmeldedaten zu definieren, Zielgeräte zuzuweisen und Zugriffsberechtigungen festzulegen.
  4. Sobald alle erforderlichen Informationen eingegeben sind, klicken Sie auf die Schaltfläche "Speichern" oder "Projekt erstellen", um die Erstellung abzuschließen.
  5. Das neue Projekt wird nun in Ihrer Liste der verfügbaren Projekte auf der Übersichtsseite angezeigt.

Szenario 2: Anzeigen von Details eines bestehenden Projekts

  1. Navigieren Sie zur Seite "Übersicht des Agentic API-Projekts".
  2. Suchen Sie in der Liste der verfügbaren Projekte das spezifische Projekt, das Sie untersuchen möchten.
  3. Klicken Sie auf die Kachel des Projekts, um dessen Detailansicht zu öffnen.
  4. Auf der Detailseite können Sie alle konfigurierten Aspekte des Projekts überprüfen, einschließlich der zugewiesenen Geräte, Anmeldedaten und Berechtigungen.

Szenario 3: Bearbeiten eines bestehenden Projekts

  1. Gehen Sie zur Seite "Übersicht des Agentic API-Projekts".
  2. Finden Sie das Projekt, das Sie ändern möchten, in der Liste.
  3. Klicken Sie auf das Symbol oder die Schaltfläche "Bearbeiten", die mit der Kachel dieses Projekts verbunden ist.
  4. Sie gelangen zu einer Bearbeitungsoberfläche, auf der Sie die Einstellungen des Projekts anpassen können.
  5. Nehmen Sie die erforderlichen Änderungen vor und klicken Sie dann auf "Speichern" oder "Projekt aktualisieren", um sie anzuwenden.
  6. Die aktualisierten Projektdetails werden auf der Übersichtsseite angezeigt.

Szenario 4: Löschen eines Agentic API-Projekts

  1. Identifizieren Sie auf der Seite "Übersicht des Agentic API-Projekts" das Projekt, das Sie löschen möchten.
  2. Klicken Sie auf das Symbol oder die Schaltfläche "Löschen" auf der Kachel des Projekts.
  3. Ein Bestätigungsdialog wird angezeigt und fordert Sie auf, das Löschen zu bestätigen. Dies ist ein wichtiger Schritt, um versehentlichen Datenverlust zu verhindern.
  4. Bestätigen Sie Ihre Aktion. Das Projekt wird dauerhaft aus Ihrer Liste entfernt und der zugehörige Gerätezugriff wird widerrufen.

Szenario 5: Ausblenden des Informationsbanners

  1. Wenn Sie die Seite "Übersicht des Agentic API-Projekts" zum ersten Mal aufrufen, sehen Sie möglicherweise ein Informationsbanner oben, das Kontext liefert.
  2. Wenn Sie dieses Banner ausblenden möchten, klicken Sie auf das Symbol "Schließen" (X) in der oberen rechten Ecke des Banners.
  3. Das Banner verschwindet und bleibt bei nachfolgenden Besuchen der Seite ausgeblendet, wobei Ihre Präferenz gespeichert wird.

Mögliche Fehler, die auf dieser Seite auftreten können:

Fehler: Projekt erscheint nach Erstellung/Bearbeitung nicht

Warum es passiert: Dies kann vorkommen, wenn es während des Speichervorgangs ein Netzwerkproblem gab oder wenn das System eine vorübergehende Verzögerung bei der Aktualisierung der Projektliste aufweist. Obwohl der Seiten-Code eine Aktualisierungslogik enthält, können externe Faktoren stören.

Was zu tun ist: Versuchen Sie, die gesamte Seite zu aktualisieren. Wenn das Problem weiterhin besteht, überprüfen Sie Ihre Internetverbindung. Wenn das Problem weiterhin besteht, wenden Sie sich mit Details zu Ihren Aktionen an den Support.

Fehler: Projekt kann nicht gelöscht werden

Warum es passiert: Dies kann auf Netzwerkverbindungsprobleme zurückzuführen sein, die verhindern, dass die Löschanforderung den Server erreicht, oder wenn das Projekt Abhängigkeiten hat, die seine Entfernung verhindern (z. B. aktiv geteilte Geräte, was normalerweise vom System angezeigt würde). Manchmal können auch unzureichende Benutzerberechtigungen dies verursachen.

Was zu tun ist: Überprüfen Sie Ihre Internetverbindung. Stellen Sie sicher, dass Sie über die erforderlichen Berechtigungen verfügen. Wenn Meldungen auf Abhängigkeiten hinweisen, müssen Sie diese möglicherweise zuerst beheben. Wenn keine dieser Optionen zutrifft, aktualisieren Sie die Seite und versuchen Sie es erneut. Kontaktieren Sie den Support, wenn das Problem weiterhin besteht.