IBM Cloud Docs
Zusammenfassung der API-Methoden

Zusammenfassung der API-Methoden

In den folgenden Tabellen sind die Methoden aufgeführt, die mit watsonx Assistant verfügbar sind.

Laufzeitmethoden

Methode Beschreibung Version Referenz
Sitzung erstellen Erstellt eine neue Sitzung. Eine Sitzung wird verwendet, um Benutzereingaben an einen Skill zu senden und Antworten zum empfangen. Außerdem wird in einer Sitzung der Status des Dialogs verwaltet. v2 cURL Knoten Java Python
Sitzung löschen Löscht eine Sitzung explizit, bevor das Zeitlimit überschritten wird. v2 cURL Knoten Java Python
Benutzereingabe an Assistenten senden (statusabhängig) Senden Sie Benutzereingaben an einen Assistenten und erhalten Sie eine Antwort, wobei der Gesprächsstatus (einschließlich Kontextdaten) während der Sitzung von watsonx Assistant gespeichert wird. v2 cURL Knoten Java Python
Benutzereingabe an Assistenten senden (statusunabhängig) Sendet Benutzereingaben an einen Assistenten und empfängt eine Antwort, wobei der Dialogstatus (einschließlich Kontextdaten) von Ihrer Anwendung verwaltet wird. v2 cURL Knoten Java Python

Authoring-Methoden

Methode Beschreibung Version Referenz
Arbeitsbereiche auflisten Listen Sie die Arbeitsbereiche auf, die mit watsonx Assistant verknüpft sind. v1 cURL Knoten Java Python
Arbeitsbereich erstellen Erstellt einen Arbeitsbereich auf der Basis von Komponentenobjekten. Sie müssen Arbeitsbereichskomponenten bereitstellen, die den Inhalt des neuen Arbeitsbereichs definieren. v1 cURL Knoten Java Python
Informationen zu einem Arbeitsbereich abrufen Ruft Informationen zu einem Arbeitsbereich ab (optional einschließlich des gesamten Arbeitsbereichsinhalts). v1 cURL Knoten Java Python
Arbeitsbereich aktualisieren Aktualisiert einen vorhandenen Arbeitsbereich mit neuen oder geänderten Daten. Sie müssen Komponentenobjekte bereitstellen, die den Inhalt des aktualisierten Arbeitsbereichs definieren. v1 cURL Knoten Java Python
Arbeitsbereich löschen Löscht einen Arbeitsbereich in der Serviceinstanz. v1 cURL Knoten Java Python
Absichten auflisten Listet die Absichten für einen Arbeitsbereich auf. v1 cURL Knoten Java Python
Absicht erstellen Erstellt eine neue Absicht. v1 cURL Knoten Java Python
Absicht abrufen Ruft Informationen zu einer Absicht ab (optional mit dem gesamten Inhalt der Absicht). v1 cURL Knoten Java Python
Absicht aktualisieren Aktualisiert eine vorhandene Absicht mit neuen oder geänderten Daten. Sie müssen Komponentenobjekte bereitstellen, die den Inhalt der aktualisierten Absicht definieren. v1 cURL Knoten Java Python
Absicht löschen Löscht eine Absicht in einem Arbeitsbereich. v1 cURL Knoten Java Python
Benutzereingabebeispiele auflisten Listet Benutzereingabebeispiele für eine Absicht auf, optional mit kontextbasierten Entitätserwähnungen. v1 cURL Knoten Java Python
Benutzereingabebeispiel erstellen Fügt ein neues Benutzereingabebeispiel für eine Absicht hinzu. v1 cURL Knoten Java Python
Benutzereingabebeispiel abrufen Ruft Informationen zu einem Benutzereingabebeispiel ab. v1 cURL Knoten Java Python
Benutzereingabebeispiel aktualisieren Aktualisiert den Text eines Benutzereingabebeispiels. v1 cURL Knoten Java Python
Benutzereingabebeispiel löschen Löscht ein Benutzereingabebeispiel in einer Absicht. v1 cURL Knoten Java Python
Gegenbeispiele auflisten Listet die Gegenbeispiele für einen Arbeitsbereich auf. Gegenbeispiele sind Beispiele, die als irrelevante Eingabe markiert sind. v1 cURL Knoten Java Python
Gegenbeispiel erstellen Fügt ein neues Gegenbeispiel in einem Arbeitsbereich hinzu. Gegenbeispiele sind Beispiele, die als irrelevante Eingabe markiert sind. v1 cURL Knoten Java Python
Gegenbeispiel abrufen Ruft Informationen zu einem Gegenbeispiel ab. Gegenbeispiele sind Beispiele, die als irrelevante Eingabe markiert sind. v1 cURL Knoten Java Python
Gegenbeispiel aktualisieren Aktualisiert den Text für ein Gegenbeispiel. Gegenbeispiele sind Beispiele, die als irrelevante Eingabe markiert sind. v1 cURL Knoten Java Python
Gegenbeispiel löschen Löscht ein Gegenbeispiel in einem Arbeitsbereich. Gegenbeispiele sind Beispiele, die als irrelevante Eingabe markiert sind. v1 cURL Knoten Java Python
Entitäten auflisten Listet die Entitäten für einen Arbeitsbereich auf. v1 cURL Knoten Java Python
Entität erstellen Erstellt eine neue Entität oder aktiviert eine Systementität. v1 cURL Knoten Java Python
Entität abrufen Ruft Informationen zu einer Entität ab (optional mit dem gesamten Inhalt der Entität). v1 cURL Knoten Java Python
Entität aktualisieren Aktualisiert eine vorhandene Entität mit neuen oder geänderten Daten. Sie müssen Komponentenobjekte bereitstellen, die den Inhalt der aktualisierten Entität definieren. v1 cURL Knoten Java Python
Entität löschen Löscht eine Entität in einem Arbeitsbereich oder inaktiviert eine Systementität. v1 cURL Knoten Java Python
Entitätserwähnungen auflisten Listet Erwähnungen einer kontextbezogenen Entität auf. Eine Entitätserwähnung ist das Auftreten einer kontextbezogenen Entität im Kontext eines Benutzerbeispiels für eine Absicht. v1 cURL Knoten Java Python
Entitätswerte auflisten Listet die Werte für eine Entität auf. v1 cURL Knoten Java Python
Entitätswert hinzufügen Erstellt einen neuen Wert für eine Entität. v1 cURL Knoten Java Python
Entitätswert abrufen Ruft Informationen zu einem Entitätswert ab. v1 cURL Knoten Java Python
Entitätswert aktualisieren Aktualisiert einen vorhandenen Entitätswert mit neuen oder geänderten Daten. Sie müssen Komponentenobjekte bereitstellen, die den Inhalt des aktualisierten Entitätswerts definieren. v1 cURL Knoten Java Python
Entitätswert löschen Löscht einen Wert aus einer Entität. v1 cURL Knoten Java Python
Synonyme für Entitätswerte auflisten Listet die Synonyme für einen Entitätswert auf. v1 cURL Knoten Java Python
Synonym für Entitätswert hinzufügen Fügt ein neues Synonym für einen Entitätswert hinzu. v1 cURL Knoten Java Python
Synonym für Entitätswert abrufen Ruft Informationen zu einem Synonym für einen Entitätswert ab. v1 cURL Knoten Java Python
Synonym für Entitätswert aktualisieren Aktualisiert ein Synonym für einen Entitätswert mit neuem Text. v1 cURL Knoten Java Python
Synonym für Entitätswert löschen Löscht ein Synonym für einen Entitätswert. v1 cURL Knoten Java Python
Dialogmodulknoten auflisten Listet die Dialogmodulknoten für einen Arbeitsbereich auf. v1 cURL Knoten Java Python
Dialogmodulknoten erstellen Erstellt einen neuen Dialogmodulknoten. v1 cURL Knoten Java Python
Dialogmodulknoten abrufen Ruft Informationen zu einem Dialogmodulknoten ab. v1 cURL Knoten Java Python
Dialogmodulknoten aktualisieren Aktualisiert einen vorhandenen Dialogmodulknoten mit neuen oder geänderten Daten. v1 cURL Knoten Java Python
Dialogmodulknoten löschen Löscht einen Dialogmodulknoten in einem Arbeitsbereich. v1 cURL Knoten Java Python
Protokollereignisse in einem Arbeitsbereich auflisten Listet Ereignisse aus dem Protokoll für einen bestimmten Arbeitsbereich auf. v1 cURL Knoten Java Python
Protokollereignisse in allen Arbeitsbereichen auflisten Listet die Ereignisse aus den Protokollen aller Arbeitsbereiche der Serviceinstanz auf. v1 cURL Knoten Java Python
Zugehörige Daten löschen Löscht alle Daten, die mit einer bestimmten Kunden-ID verknüpft sind. Falls der Kunden-ID keine Daten zugeordnet sind, ist die Methode wirkungslos. v1 cURL Knoten Java Python