Azure Bot-Clientbibliothek für JavaScript– Version 4.0.0
Dieses Paket enthält ein isomorphes SDK (wird sowohl in Node.js als auch in Browsern ausgeführt) für den Azure Bot-Client.
Azure Bot Service ist eine Plattform zum Erstellen intelligenter Konversations-Agents.
Quellcode | Paket (NPM) | API-Referenzdokumentation | Proben
Erste Schritte
Die derzeitig unterstützten Umgebungen
- LTS-Versionen von Node.js
- Neueste Versionen von Safari, Chrome, Edge und Firefox.
Ausführlichere Informationen finden Sie in der Supportrichtlinie.
Voraussetzungen
- Ein Azure-Abonnement.
Installieren Sie das Paket @azure/arm-botservice
.
Installieren Sie die Azure Bot-Clientbibliothek für JavaScript mit npm
:
npm install @azure/arm-botservice
Erstellen und Authentifizieren eines AzureBotService
Um ein Clientobjekt für den Zugriff auf die Azure Bot-API zu erstellen, benötigen Sie die endpoint
ihrer Azure Bot-Ressource und eine credential
. Der Azure Bot-Client kann Azure Active Directory-Anmeldeinformationen für die Authentifizierung verwenden.
Den Endpunkt für Ihre Azure Bot-Ressource finden Sie im Azure-Portal.
Sie können sich mit Azure Active Directory mithilfe von Anmeldeinformationen aus der @azure-/Identitätsbibliothek oder einem vorhandenen AAD-Token authentifizieren.
Um den unten gezeigten DefaultAzureCredential-Anbieter oder andere Anmeldeinformationsanbieter zu verwenden, die mit dem Azure SDK bereitgestellt werden, installieren Sie das @azure/identity
Paket:
npm install @azure/identity
Sie müssen auch eine neue AAD-Anwendung registrieren und Zugriff auf Azure Bot gewähren, indem Sie Ihrem Dienstprinzipal die geeignete Rolle zuweisen (Hinweis: Rollen wie "Owner"
erteilen nicht die erforderlichen Berechtigungen).
Legen Sie die Werte der Client-ID, der Mandanten-ID und des geheimen Clientschlüssels der AAD-Anwendung als Umgebungsvariablen fest: AZURE_CLIENT_ID
, AZURE_TENANT_ID
, AZURE_CLIENT_SECRET
.
Weitere Informationen zum Erstellen einer Azure AD-Anwendung finden Sie in diesem Leitfaden.
const { AzureBotService } = require("@azure/arm-botservice");
const { DefaultAzureCredential } = require("@azure/identity");
// For client-side applications running in the browser, use InteractiveBrowserCredential instead of DefaultAzureCredential. See https://aka.ms/azsdk/js/identity/examples for more details.
const subscriptionId = "00000000-0000-0000-0000-000000000000";
const client = new AzureBotService(new DefaultAzureCredential(), subscriptionId);
// For client-side applications running in the browser, use this code instead:
// const credential = new InteractiveBrowserCredential({
// tenantId: "<YOUR_TENANT_ID>",
// clientId: "<YOUR_CLIENT_ID>"
// });
// const client = new AzureBotService(credential, subscriptionId);
JavaScript-Paket
Um diese Clientbibliothek im Browser verwenden zu können, müssen Sie zunächst einen Bundler verwenden. Ausführliche Informationen dazu finden Sie in unserer Bündelungsdokumentation.
Wichtige Begriffe
AzureBotService
AzureBotService
ist die primäre Schnittstelle für Entwickler, die die Azure Bot-Clientbibliothek verwenden. Erkunden Sie die Methoden für dieses Clientobjekt, um die verschiedenen Features des Azure Bot-Diensts zu verstehen, auf die Sie zugreifen können.
Problembehandlung
Protokollierung
Die Aktivierung der Protokollierung kann hilfreiche Informationen über Fehler aufdecken. Um ein Protokoll von HTTP-Anforderungen und -Antworten anzuzeigen, legen Sie die Umgebungsvariable AZURE_LOG_LEVEL
auf info
fest. Alternativ kann die Protokollierung zur Laufzeit aktiviert werden, indem Sie setLogLevel
in @azure/logger
aufrufen:
const { setLogLevel } = require("@azure/logger");
setLogLevel("info");
Ausführlichere Anweisungen zum Aktivieren von Protokollen finden Sie in der Paketdokumentation zu @azure/logger.
Nächste Schritte
Ausführliche Beispiele zur Verwendung dieser Bibliothek finden Sie im Beispielverzeichnis .
Mitwirken
Wenn Sie an dieser Bibliothek mitwirken möchten, lesen Sie die Anleitung für Mitwirkende, um mehr darüber zu erfahren, wie Sie den Code erstellen und testen können.
Verwandte Projekte
Azure SDK for JavaScript