Botkonfigurationsoberfläche

Artikel
06/26/2024

Mit der Botkonfiguration können Benutzer die Einstellungen ihrer Bots direkt innerhalb des Kanals oder Gruppenchats nach der Installation einrichten und neu konfigurieren, wodurch die betriebsbezogene Effizienz von Anfang an erhöht wird. Diese Funktionalität entfällt die Notwendigkeit wiederholter Benutzereingriffe, die zuvor die rechtzeitige Realisierung von Vorteilen durch Apps verhinderten. Benutzer können den Bot jetzt während der Installation an ihre spezifischen Workflows und Präferenzen anpassen und einstellungen bei Bedarf neu konfigurieren, um sich ändernde Anforderungen anzupassen, um die fortlaufende Relevanz und den Wert des Bots sicherzustellen.

Betrachten Sie beispielsweise einen Bot, der Nachrichtenthemen nachverfolgt und teilt oder GitHub-Repositorys überwacht. Diese Bots, die ursprünglich so konfiguriert wurden, dass sie an Benutzerworkflows ausgerichtet sind, können problemlos neu konfiguriert werden, um direkt aus dem Gruppenchat auf neue Themen oder Repositorys zu reagieren, die Inhaltsverwaltung und die Interaktion zu optimieren, ohne die Teams-Umgebung zu verlassen. Diese flexible Konfigurationserfahrung verbessert die Benutzerfreundlichkeit und Produktivität erheblich, indem Bots nahtlos in den täglichen Betrieb integriert werden.

Hier ist ein Beispiel, in dem ein Benutzer den Bot zu einem Gruppenchat hinzufügt und dann so konfiguriert, dass er seinen spezifischen Anforderungen entspricht. Der Benutzer konfiguriert dann den Bot neu, um den Status zu ändern.

Konfigurieren

Die Grafik zeigt den Prozess der Konfiguration eines Bots in einem Teams-Kanal.

Rekonfigurieren

Screenshot: Konfigurationsoption für den Bot im Bereich zum Verfassen von Nachrichten

Erstellen einer Botkonfigurationsumgebung

Hinweis

Die Benutzeroberfläche für die Botkonfiguration wird nur im Kanal- oder Gruppenchat unterstützt.

Beim Erstellen der Botkonfiguration müssen Sie sicherstellen, dass der Benutzer in der Lage sein muss, einen Bot bei der ersten Installation zu konfigurieren und ihn jederzeit neu zu konfigurieren.

Führen Sie die folgenden Schritte aus, um die Botkonfiguration zu erstellen:

Aktualisieren des App-Manifests
Konfigurieren Ihres Bots

Aktualisieren des App-Manifests

Aktualisieren Sie in der App-Manifestdatei (früher Teams-App-Manifest genannt) die fetchTask -Eigenschaft unter dem bots.configuration -Objekt wie folgt:

"bots": [
    {
      "botId": "${{AAD_APP_CLIENT_ID}}",
     "needsChannelSelector": false,
      "scopes": [
        "personal",
        "team",
        "groupChat"
      ],
      "configuration":{
        "groupChat":{
          "fetchTask": true
        },
        "team":{
          "fetchTask": true
        }
      },
      "isNotificationOnly": false
    }
  ],

Weitere Informationen finden Sie unter App-Manifestschema.

Konfigurieren Ihres Bots

Wenn ein Benutzer den Bot im Kanal- oder Gruppenchat installiert, initiiert die fetchTask Eigenschaft in der App-Manifestdatei entweder config/fetch oder config/submit wie in der teamsBot.js Datei definiert.

Wenn Sie die fetchTask -Eigenschaft im App-Manifest auf Folgendes festlegen:

false: Der Bot ruft keinen Dialog oder eine adaptive Karte ab. Stattdessen muss der Bot einen statischen Dialog oder eine statische Karte bereitstellen, die beim Aufrufen des Bots verwendet wird. Weitere Informationen finden Sie unter Dialoge.
true: Der Bot initiiert entweder config/fetch oder config/submit wie definiert. Wenn der Bot aufgerufen wird, können Sie eine adaptive Karte oder einen Dialog zurückgeben, abhängig vom Kontext, der in channelData und userdata bereitgestellt wird.

In der folgenden Tabelle ist der Antworttyp aufgeführt, der den Aufrufanforderungen zugeordnet ist:

Anforderung aufrufen	Antworttyp
`config/fetch`	`Type: "continue"` oder `Type = "auth"`
`config/submit`	`Type: "continue"` oder `Type: "message"`

type: "continue": type: "continue" wird verwendet, um eine Fortsetzung eines Dialogs oder einer adaptiven Karte innerhalb einer Botkonfiguration zu definieren. Wenn der Typ auf continuefestgelegt ist, gibt dies an, dass der Bot eine weitere Interaktion vom Benutzer erwartet, um mit dem Konfigurationsprozess fortzufahren.

ist adaptiveCardForContinue eine benutzerdefinierte Funktion, die den JSON-Code für eine adaptive Karte zurückgibt, die in verschiedenen Phasen des Workflows eines Bots verwendet werden soll. Diese Funktionen werden verwendet, um adaptive Karten für verschiedene Szenarien zurückzugeben, die auf der Interaktion des Benutzers mit dem Bot basieren.

Wenn der Benutzer die Konfiguration übermittelt, wird der config/submit Aufruf ausgelöst. Es liest die Eingabe des Benutzers und gibt eine andere adaptive Karte zurück. Sie können auch die Botkonfiguration aktualisieren, um einen Dialog zurückzugeben.
- C#
- JavaScript
Beispielcodereferenz
```
protected override Task<ConfigResponseBase>OnTeamsConfigFetchAsync(ITurnContext<IInvokeActivity> turnContext, JObject configData, CancellationToken cancellationToken)
{
    ConfigResponseBase response = adaptiveCardForContinue();
    return Task.FromResult(response);
}
```
Beispielcodereferenz
```
async handleTeamsConfigFetch(_context, _configData) {
    let response = {};
    const adaptiveCard = CardFactory.adaptiveCard(this.adaptiveCardForContinue());
    response = {
       config: {
          value: {
             card: adaptiveCard,
             height: 500,
             width: 600,
             title: 'test card',
          },
          type: 'continue',
       },
    };
    return response;
}
```

type: "auth": Sie können den Benutzer auch auffordern, sich als Antwort auf die Anforderung zu config/fetch authentifizieren. Die type: "auth" Konfiguration fordert den Benutzer auf, sich über eine angegebene URL anzumelden, die mit einer gültigen Authentifizierungsseite verknüpft sein muss, die in einem Browser geöffnet werden kann. Die Authentifizierung ist für Szenarien unerlässlich, in denen der Bot die Authentifizierung des Benutzers erfordert. Es stellt sicher, dass die Identität des Benutzers überprüft wird, und die Sicherheit und personalisierte Erfahrungen innerhalb der Funktionalität des Bots aufrechterhalten werden.

Hinweis

Nur type: "auth" für Drittanbieter wird die Authentifizierung unterstützt. Einmaliges Anmelden (Single Sign-On, SSO) wird nicht unterstützt. Weitere Informationen zur Authentifizierung von Drittanbietern finden Sie unter Hinzufügen der Authentifizierung.

C#
JavaScript

Beispielcodereferenz

protected override Task<ConfigResponseBase>OnTeamsConfigFetchAsync(ITurnContext<IInvokeActivity> turnContext, JObject configData, CancellationToken cancellationToken)
{
    ConfigResponseBase response = new ConfigResponse<BotConfigAuth> {
       Config = new BotConfigAuth {
          SuggestedActions = new SuggestedActions {
             Actions = new List<CardAction> {
                new CardAction {
                   type: "openUrl",
                   value: "https://example.com/auth",
                   title: "Sign in to this app"
                }
             }
          },
       Type = "auth"
    }
};

Beispielcodereferenz

async handleTeamsConfigFetch(_context, _configData) {
    let response = {};
    response = {
       config: {
          type: "auth",
          suggestedActions: {
             actions: [{
                type: "openUrl",
                value: "https://example.com/auth",
                title: "Sign in to this app"
             }]
          },
      },
    };
    return response;
}

type="message": Wenn der Typ auf message festgelegt ist, gibt dies an, dass der Bot eine einfache Nachricht zurück an den Benutzer sendet, die das Ende der Interaktion angibt oder Informationen bereitstellt, ohne dass weitere Eingaben erforderlich sind.

C#
JavaScript

Beispielcodereferenz

protected override Task<ConfigResponseBase> OnTeamsConfigSubmitAsync(ITurnContext<IInvokeActivity> turnContext, JObject configData, CancellationToken cancellationToken)
{
    ConfigResponseBase response = new ConfigResponse<TaskModuleResponseBase>
    {
       Config = new TaskModuleMessageResponse
       {
          Type = "message",
          Value = "You have chosen to finish setting up bot"
       }
    };
    return Task.FromResult(response);
}

Beispielcodereferenz

async handleTeamsConfigSubmit(context, _configData) {
    let response = {};
    response = {
       config: {
          type: 'message',
          value: 'You have chosen to finish setting up bot',
       },
    }
    return response;
}

Wenn ein Benutzer den Bot neu konfiguriert, wird die fetchTask -Eigenschaft in der App-Manifestdatei in der Botlogik initiiert config/fetch . Der Benutzer kann die Boteinstellungen nach der Installation auf zwei Arten neu konfigurieren:

@mention der Bot im Bereich zum Verfassen von Nachrichten. Wählen Sie die Option Einstellungen aus, die über dem Bereich zum Verfassen von Nachrichten angezeigt wird. Ein Dialogfeld wird angezeigt, aktualisiert oder ändert die Konfigurationseinstellungen des Bots im Dialogfeld.
Zeigen Sie auf den Bot, und die Botprofilkarte wird angezeigt. Um die Konfigurationseinstellungen des Bots zu aktualisieren oder zu ändern, wählen Sie das Einstellungssymbol auf der Botprofilkarte aus.

Bewährte Methoden

Wenn Sie eine individuelle Konfiguration ihres Bots auf Kanalebene wünschen, stellen Sie sicher, dass Sie die Konfiguration gemäß dem Kanal nachverfolgen. Konfigurationsdaten werden nicht gespeichert, und die Aufrufnutzlast enthält die ausreichenden channelData-Daten.
Stellen Sie ein klares und benutzerfreundliches Dialogfeld bereit, in dem der Benutzer aufgefordert wird, die erforderlichen Informationen einzugeben, damit der Bot ordnungsgemäß funktioniert, z. B. eine URL, einen Bereichspfad oder einen Dashboardlink.
Vermeiden Sie das Senden mehrerer Benachrichtigungen oder Konfigurationsanforderungen nach der Installation, da dies die Benutzer verwirren kann.

Codebeispiel

Beispielname	Beschreibung	.NET	Node.js	Manifest
Botkonfigurations-App	In diesem Beispielcode wird die Konfiguration und Neukonfiguration von Bots im Team- und Gruppenchat mit `continue` - und `message` -Antworttypen beschrieben.	View	View	View
Botkonfigurations-App mit Authentifizierung	In diesem Beispielcode wird die Konfiguration und Neukonfiguration von Bots im Team- und Gruppenchat mit `auth` - und `message` -Antworttypen beschrieben.	View	View	View

Schrittweise Anleitung

Befolgen Sie die Schritt-für-Schritt-Anleitung , um Ihren Bot während der Installation oder nach der Installation über den Team- oder Gruppenchat zu konfigurieren, in dem der Bot installiert ist.

Freigeben über

Botkonfigurationsoberfläche

Erstellen einer Botkonfigurationsumgebung

Aktualisieren des App-Manifests

Konfigurieren Ihres Bots

Bewährte Methoden

Codebeispiel

Schrittweise Anleitung

Siehe auch

Zusätzliche Ressourcen