Virtual Agent API -Funktionen, die in Store Release 3.0.x verfügbar sind

  • Freigeben Version: Washingtondc
  • Aktualisiert 1. Februar 2024
  • 6 Minuten Lesedauer
  • Virtual Agent API Version 3.0.x bietet Zugriff auf weitere Funktionen, die in Virtual Agent und Mitarbeiterchatverfügbar sind, einschließlich der Möglichkeit, Dateien von einer privaten URL hochzuladen, und Verbesserungen des synchronen Handshake.

    Abgebrochene Virtual Agent Konversationen werden beendet

    Wenn eine Konversation aufgrund eines Fehlers unvollständig ist, kann Virtual Agent den primären Bot bitten, die Kontrolle zu übernehmen. Wenn die Kennzeichnung truetakeControl auf [] gesetzt ist, schließt Virtual Agent (als sekundärer Bot) die Konversation automatisch. Wenn der primäre Bot eine Konversation starten möchte, kann er die folgende Aktionsnachricht senden: „hi“/START_CONVERSATION.

    Sie können den primären Bot bitten, in den folgenden Situationen die Kontrolle zu übernehmen:
    • Leerlauf-Zeitüberschreitung: Interaktionsstatus ist „ Geschlossen – verworfen“. Statusgrund ist „Keine Aktivität“.
    • Technische Probleme: Interaktionsstatus ist „Geschlossen – verworfen“. Statusgrund ist Bot-Probleme.
    • Ungültige Anwendereingabe: Interaktionsstatus ist „Geschlossen – verworfen“. Statusgrund ist „Ungültige Anwendereingabe“.

    Um anzufordern, dass der primäre Bot die Kontrolle übernimmt, senden Sie die Kennzeichnung takeControl im Textkörper der Nutzlast mit dem Wert truean den primären Bot.

    Beispiel für Nachrichtennutzlast:
    {​ 
       "requestId": "xxxx-xxxx-xxxx-xxxx",
       "clientSessionId": "xxx-xxx-xxx-xxx",
       "message": {
           "text":"invalid3",
           "typed":true
           }
       "body":[{
           "uiType":"OutputText",
           "group":"DefaultText",
           "value":"Sorry, I didn't get that. Could you help me by answering this?"
           },
           {
           "uiType":"Boolean",
           "group":"DefaultPicker",
           "required":true,
           "nluTextEnabled": false,
           "label":"Choose a value",
           "options":[
              {"label":"Yes"},
              {"label":"No"}
              ]
           }],
        "takeControl":true,
        "score":0
    } 

    Verbesserte Antwortzeit von Virtual Agent API .

    Virtual Agent API Antworten enthalten Parameter wie „Kontrolle übernehmen“ und „NLU-Punktzahl“. Diese Parameter werden beim Vorbereiten der Antwort verarbeitet.

    Ab Version 3.9.0 können Sie die Parameter „Steuerung übernehmen“ und/oder „NLU-Punktzahl“ aus der Antwort von Virtual Agent API ausschließen, um die Antwortzeit zu verbessern.

    Führen Sie die folgenden Schritte aus, um die Parameter „Steuerung übernehmen“ und „NLU-Punktzahl“ aus der Antwort Virtual Agent API auszuschließen:
    1. Navigieren zu Alle > sys_cs_custom_adapter_property.list.
    2. Suchen Sie nach den Eigenschaften enable_take_control und send_nlu_score.
    3. Legen Sie den Wert der Eigenschaft enable_take_control auf „falsch“ fest, um die Einstellung „Steuerung übernehmen“ auszuschließen, und die Eigenschaft send_nlu_score auf „falsch“, um die NLU-Punktzahlberechnung während der Verarbeitung der Antwort auszuschließen. Diese Eigenschaften sind standardmäßig auf „true“ festgelegt.

    Verbesserte Fehler beim Themenwechsel und Fehlerbehebung

    Der Themenwechsel kann aus einem der folgenden Gründe fehlschlagen:
    • Die Anforderung enthält sowohl den Themennamen als auch die Themen-ID (Stichwort „Themenerkennung“) oder den Absichtsnamen des Themas und die Absichts-ID des Themas (NLU-Themenerkennung). Geben Sie einen oder den anderen an.
    • Die Anforderung enthält einen ungültigen Themen- oder Absichtsnamen oder eine ungültige ID.
    • Der Name oder die ID des Themas/der Absicht ist gültig, aber Virtual Agent kann ihn/sie nicht ausführen, da er inaktiv oder kein Thema ist. Zum Beispiel, wenn Name oder ID auf einen Themenblock oder ein benutzerdefiniertes Steuerungsobjekt verweisen.
    • Das angeforderte Thema wird bereits ausgeführt.
    • Das angeforderte Thema ist gültig, aber eine Sicherheitsbedingung verhindert den Zugriff. Beispielsweise darf das Thema möglicherweise nicht im Kanal ausgeführt werden, oder es kann eine andere Zugriffssteuerungsbedingung gelten.
    Wenn der Themenwechsel fehlschlägt, reagiert Virtual Agent API wie folgt, unabhängig davon, ob Sie sie synchron oder asynchron verwenden:
    • Wenn der Themenwechsel fehlschlägt, wird die Konversation mit der Meldung geschlossen, dass die Konversation nicht fortgesetzt werden kann. Die Konversation bleibt nicht mehr im offenen Status.
    • Die vorherige Anforderung wird als verarbeitet markiert, sodass eine neue Anforderung gestellt werden kann, ohne auf eine Zeitüberschreitung zu warten.
    • Der Grund für den Fehler wird in der Systemprotokolltabelle () protokolliert.Automated Test Framework > Systemprotokolle > Fehler) an.

    Verbesserungen des synchronen Handshake

    Ab Version 3.0.x kann Virtual Agent API synchron an einen Servicemitarbeiter übertragen. Wenn ein Benutzer oder Service Desk-Mitarbeiter eine Konversation beendet, erfolgt die Rückübertragung an Virtual Agent ebenfalls synchron. Einige Systemnachrichten und Wartezeitnachrichten werden auch synchron gesendet.

    Um die synchrone Übertragung an einen Servicemitarbeiter zu verwenden, beachten Sie die folgenden Richtlinien:
    • Konfigurieren Sie den Antwortendpunkt Virtual Agent. Mitarbeiterchat Nachrichten werden an den von Ihnen angegebenen Endpunkt übermittelt.
    • Sie müssen Benachrichtigungen für die Instanz manuell deaktivieren.
    • Wenn Sie die synchrone Übertragung an einen Servicemitarbeiter verwenden, sendet Virtual Agent API den Typisierungsindikator, wenn er aktiviert ist:
      {
        "uiType": "ActionMsg",
        "actionType": "StartTypingIndicator",
      }
      
    • Themen, die die folgenden Funktionen verwenden, werden im synchronen Modus nicht unterstützt: Datei-Upload, Aktionsdienstprogrammund Themenblock Pause.
    Führen Sie die folgenden Schritte aus, um diese Funktionen zu deaktivieren und die synchrone Unterstützung zu aktivieren:
    1. Navigieren zu Alle > sys_cs_channel.list.
    2. Wählen Sie den Bot-zu-Bot-Datensatz aus.
    3. Deaktivieren Sie das Kontrollkästchen Benachrichtigungen aktivieren, um sie zu deaktivieren.
    4. Wenn Sie im synchronen Modus nicht an einen Servicemitarbeiter übertragen, deaktivieren Sie das Kontrollkästchen Support-Typisierungsindikator, um ihn zu deaktivieren.
    5. Aktivieren Sie das Kontrollkästchen Synchron.
      Abbildung : 1. Bot-zu-Bot-Kanal mit aktivierter synchroner Unterstützung
      Die Bot-zu-Bot-Kanalkonfiguration für den synchronen Modus zeigt die Indikatorfelder Benachrichtigungen aktivieren und Typisierung unterstützen als deaktiviert an. Das Kontrollkästchen Synchron ist aktiviert.
    6. Klicken Sie auf Aktualisieren.

    Unterstützung für Aktionsnachrichten

    Zusätzlich zur Weiterleitung von Nachrichten an einen sekundären Bot von ServiceNow® Virtual Agent kann der primäre Bot oder Chat-Client Nachrichten über Mitarbeiterchatan einen Service Desk-Mitarbeiter weiterleiten. Verwenden Sie den im Anforderungstext übergebenen Parameter action, um anzugeben, wie der Inhalt behandelt werden soll.

    Virtual Agent API unterstützt die folgenden Aktionsnachrichtentypen:
    Tabelle : 1. Unterstützte Aktionsnachrichtentypen
    actionType-Wert Beschreibung
    ChatSubHeader Ausgehende Nachricht, die angibt, dass einer der folgenden Fälle aufgetreten ist:
    • Dynamische Übersetzung fehlgeschlagen.
    • Der Autopilot für Servicemitarbeiter wurde initiiert und abgeschlossen.
    StartSpinner Ausgehende Nachricht, die einen Spinner startet, wenn sich eine Nachricht aufgrund asynchroner Prozesse wie KI-Suche oder des Obszönitätsfilters im Status „Ausstehend“ befindet.
    EndSpinner Ausgehende Nachricht, die den zuvor gesendeten Spinner anhält.
    StartTypingIndicatorActionMsg Ausgehende Nachricht, die angibt, dass ein Benutzer oder Service Desk-Mitarbeiter mit der Eingabe begonnen hat (nachdem ein Service Desk-Mitarbeiter den Chat akzeptiert hat).
    EndTypingIndicatorActionMsg Ausgehende Nachricht, die angibt, dass ein Benutzer oder Service Desk-Mitarbeiter die Eingabe beendet hat.
    SubscribeToSupportQueue Gibt an, dass die Konversation auf die Support-Warteschlange festgelegt ist.
    SubscribeToChatPresence Ausgehende Nachricht, die angibt, dass eine Servicemitarbeiter-Konversation begonnen hat.
    SwitchToLiveAgent Ausgehende Nachricht, die angibt, dass ein Servicemitarbeiter die Konversation angenommen hat.
    SwitchToVirtualAgent Ausgehende Nachricht, die angibt, dass die Servicemitarbeiter-Sitzung beendet wurde und die Konversation an Virtual Agentzurückgegeben wird.
    SwitchConversation Ausgehende Nachricht, die angibt, dass eine Benachrichtigung gesendet wurde. Dadurch wird eine neue Konversation erstellt, sodass Virtual Agent zur neuen Konversation wechselt.
    System Ausgehende Nachricht mit einer der folgenden Angaben:
    • Ein Servicemitarbeiter hat die Kategorie betreten.
    • Entweder der Servicemitarbeiter oder der Benutzer hat den Chat geschlossen.
    • Bei der Konversation mit einem Servicemitarbeiter ist eine Zeitüberschreitung aufgetreten.

    Unterstützung für die Kennzeichnung „stummMessage“.

    Eine stille Nachricht ist eine Nachricht, die keine Antwort erfordert. Wenn Virtual Agent eine Anforderung mit silentMessage=true] erhält, werden alle nachfolgenden Bot-Nachrichten unterdrückt, bis Virtual Agent eine Anforderung zum Deaktivieren des unbeaufsichtigten Modus (silentMessage=false) erhält.

    Beispiel für Nachrichtennutzlast des primären Bots:
    { 
       "token": "BOT_TOKEN",
       "botToBot": true,
       "clientSessionId": "884502214730301027f83ee4070f589a",
       "clientVariables": {},
       "requestId": "48450221d23030107300b7756770bc9b",
       "silentMessage": "true",
       "timestamp": 1623916324820,
       "timezone": "GMT",
       "userId": "abel.tuter",
       "emailId": "abel.tuter@example.com" 
    }
    Hinweis:
    Bei silentMessage=truewerden Benachrichtigungen nicht zugestellt.

    Sichere Dateiuploads von einer privaten URL

    Virtual Agent API unterstützt das Hochladen von Dateien mit einer Größe von bis zu 1 GB von einer privaten URL. Der primäre Bot muss die Benutzer-ID, die optionale ID der Anbieteranwendung und den Namen der Datei übergeben. Beachten Sie die folgenden Richtlinien:
    • Anbieteranwendungs-ID ist optional.
    • Die Benutzer-ID und die Provider-Anwendungs-ID müssen vor dem Dateinamen in der Nutzlast gesendet werden.
    • Der Endbenutzer muss eine Rolle haben, die in der Eigenschaft glide.attachment.role angegeben ist. Weitere Informationen finden Sie unter Rolle zum Anhängen von Dateien anfordern.
    • Standard- oder OAuth-Authentifizierung wird unterstützt, Nachrichtenauthentifizierung jedoch nicht.
    Beispiel für Nachrichtennutzlast des primären Bots:
    curl -X POST \
      https://instance.service-now.com/api/now/v1/cccif/media/upload \
      -H 'authorization: Basic YWRtaW46YWRtaW4=' \
      -H 'content-type: multipart/form-data; \
      -F user_id=xxxxxx \
      -F provider_application_id=optionalId \
      -F 'file=@SomeFile.png'
    Virtual Agent API sendet das folgende JSON-Beispiel:
    {
      "result": {
        "mediaUrl": "http://123.456.7.8:8080//api/now/v1/cs/media/string",
        "name":"imagefile.png",
        "state":"pending",
        "attachmentId":"abcdefghijklmno12345"
      }
    }

    Unterstützung für die Transformation von Virtual Agent API Anforderung und Antwort

    Virtual Agent API unterstützt die Transformation von Anforderungs- und Antwortnutzlasten in und aus Virtual Agent API. Dies ist in Fällen hilfreich, in denen der primäre Bot eine gemeinsame Antwortvorlage für alle sekundären Bots hat. Weitere Informationen finden Sie unter Transformieren Sie die Anforderung und Antwort der Virtual Agent-API.

    Unterstützung für die Konfiguration mehrerer Anbieteranwendungen

    Virtual Agent API ermöglicht die Konfiguration mehrerer Anbieteranwendungen, um Anwendungsfälle zu unterstützen, in denen Virtual Agent API von mehreren primären Bots verwendet wird, zwischen denen unterschieden werden muss. Weitere Informationen finden Sie unter Konfigurieren Sie mehrere Provider-Anwendungen.

    Unterstützung für Experience Now Assist .

    Now Assist Experience in Virtual Agent API bietet generative KI-Kompetenzen über mehrere Anbieterkanäle hinweg. Weitere Informationen finden Sie unter Aktivieren Sie die Now Assist-Experience in der Virtual Agent-API.