Intelligentes Schreiben

Das Feature „Smart Compose“ unterstützt einen menschlichen Kundenservicemitarbeiter bei einem Textchat mit einem Endnutzer. Es schlägt Wortgruppen vor, um die von Kundenservicemitarbeitern begonnenen Sätze zu vervollständigen. Mit dieser Funktion können Sie eine benutzerdefinierte Vorschlagsfunktion für die Chat-Oberfläche Ihres Agenten implementieren.

Ein Kundenservicemitarbeiter erhält einen Textvorschlag, während er in einer Chatoberfläche tippt. In dieser Anleitung wird beschrieben, wie Sie das Feature „Intelligentes Schreiben“ implementieren, indem Sie die API direkt aufrufen. Wenn Sie möchten, können Sie ein Modell mit der Agent Assist Console trainieren und seine Leistung mit dem Simulator testen. Eine Anleitung finden Sie im Tutorial zum Smart Compose-Simulator.

In der Dokumentation zu Best Practices für die Funktion „Intelligentes Schreiben“ finden Sie Richtlinien zur Integration der Funktion „Intelligentes Schreiben“ in Ihr eigenes System und zur Verbesserung der Qualität Ihrer Vorschläge.

Hinweis

Führen Sie die folgenden Schritte aus, bevor Sie diese Anleitung lesen:

  1. Aktivieren Sie die Dialogflow API für Ihr Projekt.

Personenidentifizierbare Informationen und Daten von Kindern

Wenn Sie Daten an diese API senden, versucht die API, alle personenidentifizierbaren Informationen (PII) zu entfernen. Wenn Sie sicherstellen müssen, dass das Modell keine personenidentifizierbaren Informationen enthält, sollten Sie Ihre Daten bereinigen, bevor Sie sie an die API senden. Ersetzen Sie die geschwärzten Wörter durch Platzhalter wie `REDACTED_NUMBER` oder `REDACTED_NAME`, anstatt sie einfach zu entfernen.

Wenn Ihre Daten Informationen enthalten, die von Kindern erhoben wurden, sollten Sie die Daten der Kinder entfernen, bevor Sie sie an die API senden.

Modell trainieren und bereitstellen

Agent Assist-Modelle für intelligente Antworten werden mit Unterhaltungs-Datasets trainiert. Ein Unterhaltungs-Dataset enthält Ihre eigenen hochgeladenen Transkriptdaten. In diesem Abschnitt wird beschrieben, wie Sie ein Unterhaltungs-Dataset erstellen, Ihre Unterhaltungsdaten hochladen und ein Modell trainieren und bereitstellen. Sie können diese Aktionen auch über die Agent Assist Console ausführen, wenn Sie die API nicht direkt aufrufen möchten.

Unterhaltungs-Dataset erstellen

Bevor Sie mit dem Hochladen von Unterhaltungstranskripten beginnen können, müssen Sie zuerst ein Unterhaltung-Dataset erstellen, in dem sie gespeichert werden. Rufen Sie die Methode create für die Ressource ConversationDataset auf, um ein Unterhaltung-Dataset zu erstellen.

Die Antwort enthält eine ID für das Unterhaltungs-Dataset.

Unterhaltungstranskripte in Ihr Unterhaltungs-Dataset importieren

Laden Sie Ihre Chat-Unterhaltungsdaten in Ihr Unterhaltung-Dataset hoch, damit sie von Agent Assist verarbeitet werden können. Achten Sie darauf, dass ein Transkript jeder Unterhaltung im JSON-Format vorliegt und in einem Cloud Storage-Bucket gespeichert ist. Ein Unterhaltungs-Dataset muss mindestens 30.000 Unterhaltungen enthalten, andernfalls schlägt das Modelltraining fehl. Als allgemeine Regel gilt: Je mehr Unterhaltungen, desto besser ist die Modellqualität. Wir empfehlen, Unterhaltungen aus einem Zeitraum von mindestens drei Monaten hochzuladen, damit möglichst viele Anwendungsfälle abgedeckt sind. Die maximale Anzahl an Nachrichten in einem Unterhaltungs-Dataset beträgt 1.000.000.

Rufen Sie die Methode importConversationData für die Ressource ConversationDataset auf, um Ihre Unterhaltungen zu importieren.

Pflichtfelder:

  • Die ID des Unterhaltungs-Datasets, das Sie zuvor erstellt haben.
  • Der Pfad inputConfig führt zu Ihren Daten zum Unterhaltungstranskript in einem Cloud Storage-Bucket.

Die Antwort ist ein Vorgang mit langer Ausführungszeit, bei dem Sie prüfen können, ob er abgeschlossen wurde.

Unterhaltungsmodell erstellen

Rufen Sie die Methode create für die Ressource ConversationModel auf, um ein Unterhaltungsmodell zu erstellen. Bei dieser Aktion wird auch die Zulassungsliste des Modells erstellt.

Pflichtfelder:

  • Geben Sie in datasets ein einzelnes Dataset mit der zuvor erstellten ID des Unterhaltungs-Datasets an.
  • Setzen Sie smartReplyModelMetadata auf ein leeres Objekt oder füllen Sie das Feld aus, um die Standardeinstellung zu überschreiben.

Die Antwort ist ein Vorgang mit langer Ausführungszeit, bei dem Sie prüfen können, ob er abgeschlossen wurde. Anschließend sind die Modell-ID und die Zulassungslisten-ID in den Metadaten für den Vorgang enthalten.

  • Modell-ID: name
  • ID der Zulassungsliste: smart_reply_model_metadata.associated_allowlist_info.document

Unterhaltungsmodell bereitstellen

Rufen Sie die Methode deploy für die Ressource ConversationModel auf, um das Unterhaltungsmodell bereitzustellen.

Pflichtfeld:

  • conversationModels verwenden: Geben Sie die ID des Konversationsmodells ein, das Sie zuvor erstellt haben.

Zulassungsliste verwalten

Jedes Modell hat eine zugehörige Zulassungsliste, die automatisch erstellt wird, wenn Sie ein Konversationsmodell erstellen. Die Zulassungsliste enthält alle Antworten, die aus Ihren Konversationsdatensätzen generiert wurden und die einem Kundenservicemitarbeiter zur Laufzeit angezeigt werden können. In diesem Abschnitt wird beschrieben, wie Sie Zulassungslisten erstellen und verwalten. Sie können diese Aktionen auch über die Agent Assist Console ausführen, wenn Sie die API nicht direkt aufrufen möchten.

Inhalte der Zulassungsliste in eine CSV-Datei exportieren

Beim Erstellen eines Modells wird automatisch eine Zulassungsliste erstellt, die dem neuen Modell zugeordnet ist. Die Zulassungsliste ist eine Dokumentressource mit einer eindeutigen ID. Die ID wird in smart_reply_model_metadata.associated_allowlist_info.document zurückgegeben, wenn ein Modell erstellt wird. Wenn Sie Nachrichten auf der Zulassungsliste überprüfen und ändern möchten, müssen Sie sie in einen Cloud Storage-Bucket exportieren.

Rufen Sie die Methode export für die Ressource Document auf, um das Dokument in eine CSV-Datei in einem Cloud Storage-Bucket zu exportieren. Das Feld smart_messaging_partial_update ist optional, wirkt sich aber darauf aus, wie Sie diese Zulassungsliste in Zukunft aktualisieren können. Wenn true festgelegt ist, enthält die exportierte CSV-Datei eine Spalte mit einer eindeutigen ID für jede Nachricht. Mit der Nachrichten-ID können Sie nur bestimmte Nachrichten anstelle des gesamten Dokuments aktualisieren. Wenn smart_messaging_partial_update auf false gesetzt oder nicht festgelegt ist, wird die zusätzliche Spalte nicht in der Datei angezeigt und alle Aktualisierungen der Zulassungsliste erfordern eine Aktualisierung des gesamten Dokuments.

Pflichtfeld:

  • Der Pfad gcsDestination führt zu Ihrem Cloud Storage-Bucket.

Die Antwort ist ein Vorgang mit langer Ausführungszeit, bei dem Sie prüfen können, ob er abgeschlossen wurde. Anschließend wird die CSV-Datei, die Sie in der Anfrage angegeben haben, mit Antwortvorschlägen gefüllt.

Zulassungsliste prüfen

Die generierte Zulassungsliste enthält Antworten, die von Smart Reply anhand Ihrer Unterhaltungsdaten automatisch generiert wurden. Sie können diese Antworten jetzt prüfen und bei Bedarf aktualisieren. Laden Sie die Datei CSV aus Ihrem Cloud Storage-Bucket herunter, bearbeiten Sie sie nach Bedarf und laden Sie die Datei wieder in den Cloud Storage-Bucket hoch. Nur Antworten auf der Zulassungsliste können an menschliche Kundenservicemitarbeiter weitergeleitet werden.

Wenn Sie Antworten bearbeiten, empfehlen wir, nur Rechtschreib- und Grammatikfehler zu korrigieren und die Bedeutung der Nachricht nicht zu ändern. Je stärker der bearbeitete Text von der Bedeutung im Modell abweicht, desto unwahrscheinlicher ist es, dass die Nachricht angezeigt wird.

Bei Bedarf können Sie auch neue Mitteilungen erstellen. Ähnlich wie bearbeitete Nachrichten werden erstellte Nachrichten mit geringerer Wahrscheinlichkeit während der Laufzeit eingeblendet.

Zulassungsliste aktualisieren

Nachdem Sie die Datei CSV aktualisiert haben, können Sie sie verwenden, um die Ressource Document zu aktualisieren. Sie können die gesamte Zulassungsliste oder nur bestimmte Nachrichten aktualisieren. Wenn Sie nur bestimmte Nachrichten aktualisieren möchten, muss smart_messaging_partial_update beim Exportieren der Zulassungsliste auf true festgelegt worden sein. Wenn Sie das bereits getan haben, verwenden Sie die automatisch generierte Spalte in der exportierten CSV-Datei, um die zu aktualisierenden Mitteilungen anzugeben.

Rufen Sie die Methode reload für die Ressource Document auf, um die Zulassungsliste zu aktualisieren. Wenn Sie nur bestimmte Nachrichten aktualisieren möchten, legen Sie smart_messaging_partial_update im ReloadDocumentRequest auf true fest. Wenn Sie die gesamte Zulassungsliste aktualisieren möchten, lassen Sie smart_messaging_partial_update nicht festgelegt oder legen Sie sie auf false fest.

Pflichtfelder:

Beispielanfrage:

{
  "name":"projects/project-id/knowledgeBases/knowledge-base-id/documents/allowlist-id",
  "gcsSource" {
      "uri": "gs://revised_smart_reply_allowlist_path"
   }
}

Leistung eines trainierten Modells bewerten

Sie können die Leistung eines Modells testen, nachdem Sie das Modell bereitgestellt und eine Zulassungsliste dafür erstellt haben. Sie müssen auch ein Test-Dataset bereitstellen. Die vom trainierten Modell für intelligente Antworten generierten Antworten und die zugehörige Zulassungsliste werden mit den tatsächlichen Kundenservicemitarbeiter-Nachrichten im Test-Dataset verglichen. Der Testdatensatz sollte aus realen Unterhaltungsdaten bestehen, darf aber keine Daten aus dem Unterhaltungsdatensatz enthalten, mit dem Sie das Modell trainiert haben. Wenn Sie beispielsweise Unterhaltungs-Traffic für einen Monat haben, können Sie 3 Wochen lang Unterhaltungsdaten verwenden, um ein Unterhaltungs-Dataset zu erstellen, und die Daten der verbleibenden Woche, um das Test-Dataset zu erstellen. Ein Test-Dataset sollte mindestens 1.000 Unterhaltungen enthalten. In der Regel sind die Bewertungsstatistiken jedoch zuverlässiger, wenn das Test-Dataset mehr Unterhaltungen enthält. Das Format des Test-Datasets entspricht dem Format des Unterhaltungs-Datasets.

Wenn Sie eine neue Modellbewertung erstellen möchten, rufen Sie die Methode CreateConversationModelEvaluation für eine ConversationModel-Ressource auf. Diese Methode gibt einen Vorgang mit langer Ausführungszeit zurück. Sie können den Vorgang abfragen, um seinen Status zu prüfen. Dabei wird einer der folgenden Werte zurückgegeben: INITIALIZING, RUNNING, SUCCEEDED, CANCELLED, FAILED.

Pflichtfelder:

  • InputDataset: Das Test-Dataset, das zum Testen der Leistung des Modells verwendet wird.
  • allowlist_document: Die Zulassungsliste, die dem zu testenden Smart Reply-Modell zugeordnet ist.

Eine ConversationModelEvaluation-Ressource wird zurückgegeben, wenn der Vorgang mit langer Ausführungszeit abgeschlossen ist. Es sind zwei Messwerte enthalten:

  • allowlist_coverage: Der Prozentsatz der Agent-Nachrichten im Test-Dataset, die auf der Zulassungsliste stehen.
  • recall: Der Prozentsatz der Agent-Nachrichten im Test-Dataset, die auf der Zulassungsliste stehen und in den drei besten Vorschlägen des Smart Reply-Modells enthalten sind.

Unterhaltungsprofil konfigurieren

Ein Unterhaltungsprofil konfiguriert eine Reihe von Parametern, die die Vorschläge steuern, die einem Kundenservicemitarbeiter während einer Unterhaltung gegeben werden. In den folgenden Schritten wird ein ConversationProfile-Objekt mit einem HumanAgentAssistantConfig-Objekt erstellt. Sie können diese Aktionen auch über die Agent Assist Console ausführen, wenn Sie die API nicht direkt aufrufen möchten.

Unterhaltungsprofil erstellen

Zum Erstellen eines Unterhaltungsprofils rufen Sie die Methode create für die Ressource ConversationProfile auf. Geben Sie die ID der Wissensdatenbank, die Dokument-ID, die Projekt-ID und die Modell-ID an.

Hier ein JSON-Beispiel: 
{
  "displayName": "smart_compose_assist",
  "humanAgentAssistantConfig": {
    "humanAgentSuggestionConfig": {
      "featureConfigs": [
        {
          "suggestionFeature": {
            "type": "SMART_COMPOSE"
          },
          "queryConfig": {
            "documentQuerySource": {
              "documents": "projects/PROJECT_ID/knowledgeBases/KNOWLEDGE_BASE_ID/documents/DOCUMENT_ID"
            },
           "maxResults": "1"
          },
         "conversationModelConfig": {
           "model": "projects/PROJECT_ID/conversationModels/MODEL_ID"
         }
        }
      ]
    }
  }
}

Die Antwort enthält Ihre neue Unterhaltungsprofil-ID.

Unterhaltungen während der Laufzeit verarbeiten

Wenn ein Dialog zwischen einem Endnutzer und einem menschlichen Kundenservicemitarbeiter beginnt, erstellen Sie eine Unterhaltung. Um Vorschläge zu erhalten, müssen Sie einen Endnutzer und einen menschlichen Kundenservicemitarbeiter erstellen und der Unterhaltung als Teilnehmer hinzufügen. Dieser Prozess wird in den folgenden Abschnitten beschrieben.

Unterhaltung erstellen

Rufen Sie zum Erstellen einer Unterhaltung die Methode create für die Ressource Conversation auf.

REST

Ersetzen Sie diese Werte in den folgenden Anfragedaten:

  • PROJECT_ID: Ihre Cloud-Projekt-ID
  • LOCATION_ID: Ihre Standort-ID
  • CONVERSATION_PROFILE_ID: Die ID, die Sie beim Erstellen des Unterhaltungsprofils erhalten haben.

HTTP-Methode und URL:

POST https://dialogflow.googleapis.com/v2/projects/PROJECT_ID/locations/LOCATION_ID/conversations

JSON-Text anfordern:

{
  "conversationProfile": "projects/PROJECT_ID/locations/LOCATION_ID/conversationProfiles/CONVERSATION_PROFILE_ID",
}

Wenn Sie die Anfrage senden möchten, maximieren Sie eine der folgenden Optionen:

Sie sollten eine JSON-Antwort ähnlich wie diese erhalten:

{
  "name": "projects/PROJECT_ID/locations/LOCATION_ID/conversations/CONVERSATION_ID",
  "lifecycleState": "IN_PROGRESS",
  "conversationProfile": "projects/PROJECT_ID/locations/LOCATION_ID/conversationProfiles/CONVERSATION_PROFILE_ID",
  "startTime": "2018-11-05T21:05:45.622Z"
}

Das Pfadsegment nach conversations enthält Ihre neue Unterhaltungs-ID.

Python

Richten Sie zur Authentifizierung bei Agent Assist Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten. 

def create_conversation(project_id, conversation_profile_id):
    """Creates a conversation with given values

    Args:
        project_id:  The GCP project linked with the conversation.
        conversation_profile_id: The conversation profile id used to create
        conversation."""

    client = dialogflow.ConversationsClient()
    conversation_profile_client = dialogflow.ConversationProfilesClient()
    project_path = client.common_project_path(project_id)
    conversation_profile_path = conversation_profile_client.conversation_profile_path(
        project_id, conversation_profile_id
    )
    conversation = {"conversation_profile": conversation_profile_path}
    response = client.create_conversation(
        parent=project_path, conversation=conversation
    )

    print("Life Cycle State: {}".format(response.lifecycle_state))
    print("Conversation Profile Name: {}".format(response.conversation_profile))
    print("Name: {}".format(response.name))
    return response

Endnutzer als Teilnehmer erstellen

Sie müssen der Unterhaltung sowohl Endnutzer als auch menschliche Kundenservicemitarbeiter hinzufügen, damit Vorschläge angezeigt werden. Rufen Sie zum Erstellen eines Endnutzers als Teilnehmer die Methode create für die Ressource Participant auf. Geben Sie für das Feld role Ihre Unterhaltungs-ID und END_USER ein.

REST

Ersetzen Sie diese Werte in den folgenden Anfragedaten:

  • PROJECT_ID: Ihre Cloud-Projekt-ID
  • LOCATION_ID: Ihre Standort-ID
  • CONVERSATION_ID: Die Unterhaltungs-ID

HTTP-Methode und URL:

POST https://dialogflow.googleapis.com/v2/projects/PROJECT_ID/locations/LOCATION_ID/conversations/CONVERSATION_ID/participants

JSON-Text anfordern:

{
  "role": "END_USER",
}

Wenn Sie die Anfrage senden möchten, maximieren Sie eine der folgenden Optionen:

Sie sollten eine JSON-Antwort ähnlich wie diese erhalten:

{
  "name": "projects/PROJECT_ID/locations/LOCATION_ID/conversations/CONVERSATION_ID/participants/PARTICIPANT_ID",
  "role": "END_USER"
}

Das Pfadsegment nach participants enthält die neue Teilnehmer-ID für den Endnutzer.

Python

Richten Sie zur Authentifizierung bei Agent Assist Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten. 

def create_participant(project_id: str, conversation_id: str, role: str):
    from google.cloud import dialogflow_v2beta1 as dialogflow

    """Creates a participant in a given conversation.

    Args:
        project_id: The GCP project linked with the conversation profile.
        conversation_id: Id of the conversation.
        participant: participant to be created."""

    client = dialogflow.ParticipantsClient()
    conversation_path = dialogflow.ConversationsClient.conversation_path(
        project_id, conversation_id
    )
    if role in ROLES:
        response = client.create_participant(
            parent=conversation_path, participant={"role": role}, timeout=600
        )
        print("Participant Created.")
        print(f"Role: {response.role}")
        print(f"Name: {response.name}")

        return response

Menschlichen Kundenservicemitarbeiter als Teilnehmer erstellen

Rufen Sie zum Erstellen eines menschlichen Kundenservicemitarbeiters als Teilnehmer die Methode create für die Ressource Participant auf. Geben Sie für das Feld role Ihre Unterhaltungs-ID und HUMAN_AGENT ein.

REST

Ersetzen Sie diese Werte in den folgenden Anfragedaten:

  • PROJECT_ID: Ihre Cloud-Projekt-ID
  • LOCATION_ID: Ihre Standort-ID
  • CONVERSATION_ID: Die Unterhaltungs-ID

HTTP-Methode und URL:

POST https://dialogflow.googleapis.com/v2/projects/PROJECT_ID/locations/LOCATION_ID/conversations/CONVERSATION_ID/participants

JSON-Text anfordern:

{
  "role": "HUMAN_AGENT",
}

Wenn Sie die Anfrage senden möchten, maximieren Sie eine der folgenden Optionen:

Sie sollten eine JSON-Antwort ähnlich wie diese erhalten:

{
  "name": "projects/PROJECT_ID/locations/LOCATION_ID/conversations/CONVERSATION_ID/participants/PARTICIPANT_ID",
  "role": "HUMAN_AGENT"
}

Das Pfadsegment nach participants enthält die neue Teilnehmer-ID für den menschlichen Kundenservicemitarbeiter.

Python

Richten Sie zur Authentifizierung bei Agent Assist Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten. 

def create_participant(project_id: str, conversation_id: str, role: str):
    from google.cloud import dialogflow_v2beta1 as dialogflow

    """Creates a participant in a given conversation.

    Args:
        project_id: The GCP project linked with the conversation profile.
        conversation_id: Id of the conversation.
        participant: participant to be created."""

    client = dialogflow.ParticipantsClient()
    conversation_path = dialogflow.ConversationsClient.conversation_path(
        project_id, conversation_id
    )
    if role in ROLES:
        response = client.create_participant(
            parent=conversation_path, participant={"role": role}, timeout=600
        )
        print("Participant Created.")
        print(f"Role: {response.role}")
        print(f"Name: {response.name}")

        return response

Nachricht vom menschlichen Kundenservicemitarbeiter hinzufügen und analysieren

Wenn ein Teilnehmer eine Nachricht in die Unterhaltung eingibt, müssen Sie diese Nachricht zur Verarbeitung an die API senden. Agent Assist erteilt Vorschläge basierend auf der Analyse von Nachrichten von menschlichen Kundenservicemitarbeitern und Endnutzern. Wenn Sie die Nachricht eines menschlichen Kundenservicemitarbeiters für die Unterhaltung hinzufügen und analysieren möchten, rufen Sie die Methode analyzeContent für die Ressource Participant auf. Geben Sie die Unterhaltungs-ID und die Teilnehmer-ID des menschlichen Kundenservicemitarbeiters ein.

REST

Ersetzen Sie diese Werte in den folgenden Anfragedaten:

  • PROJECT_ID: Ihre GCP-Projekt-ID
  • CONVERSATION_ID: Die Unterhaltungs-ID
  • PARTICIPANT_ID: Die Teilnehmer-ID für den menschlichen Kundenservicemitarbeiter

HTTP-Methode und URL:

POST https://dialogflow.googleapis.com/v2/projects/PROJECT_ID/conversations/CONVERSATION_ID/participants/PARTICIPANT_ID:analyzeContent

JSON-Text anfordern:

{
  "textInput": {
    "text": "How may I help you?",
    "languageCode": "en-US"
  }
}

Wenn Sie die Anfrage senden möchten, maximieren Sie eine der folgenden Optionen:

Sie sollten eine JSON-Antwort ähnlich wie diese erhalten:

{
  "message": {
    "name": "projects/PROJECT_ID/conversations/CONVERSATION_ID/messages/MESSAGE_ID",
    "content": "How may I help you?",
    "languageCode": "en-US",
    "participant": "PARTICIPANT_ID",
    "participantRole": "HUMAN_AGENT",
    "createTime": "2020-02-13T00:01:30.683Z"
  },
  "humanAgentSuggestionResults": [
    {
      "suggestSmartRepliesResponse": {
      "smartReplyAnswers": [
          {
            "reply": "I am here to help you.",
            "confidence": 0.5,
            "answerRecord": "projects/PROJECT_ID/answerRecords/ANSWER_RECORD_ID_1"
          },
          {
            "reply": "Sorry for the wait, we have a high volume of chats right now.",
            "confidence": 0.3,
            "answerRecord": "projects/PROJECT_ID/answerRecords/ANSWER_RECORD_ID_2"
          },
          {
            "reply": "Thank you for contacting us!",
            "confidence": 0.1,
            "answerRecord": "projects/PROJECT_ID/answerRecords/ANSWER_RECORD_ID_3"
          }
        ]
      }
    }
  ]
}

Python

Richten Sie zur Authentifizierung bei Agent Assist Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten. 

def analyze_content_text(
    project_id: str, conversation_id: str, participant_id: str, text: str
):
    from google.cloud import dialogflow_v2beta1 as dialogflow

    """Analyze text message content from a participant.

    Args:
        project_id: The GCP project linked with the conversation profile.
        conversation_id: Id of the conversation.
        participant_id: Id of the participant.
        text: the text message that participant typed."""

    client = dialogflow.ParticipantsClient()
    participant_path = client.participant_path(
        project_id, conversation_id, participant_id
    )
    text_input = {"text": text, "language_code": "en-US"}
    response = client.analyze_content(
        participant=participant_path, text_input=text_input
    )
    print("AnalyzeContent Response:")
    print(f"Reply Text: {response.reply_text}")

    for suggestion_result in response.human_agent_suggestion_results:
        if suggestion_result.error is not None:
            print(f"Error: {suggestion_result.error.message}")
        if suggestion_result.suggest_articles_response:
            for answer in suggestion_result.suggest_articles_response.article_answers:
                print(f"Article Suggestion Answer: {answer.title}")
                print(f"Answer Record: {answer.answer_record}")
        if suggestion_result.suggest_faq_answers_response:
            for answer in suggestion_result.suggest_faq_answers_response.faq_answers:
                print(f"Faq Answer: {answer.answer}")
                print(f"Answer Record: {answer.answer_record}")
        if suggestion_result.suggest_smart_replies_response:
            for (
                answer
            ) in suggestion_result.suggest_smart_replies_response.smart_reply_answers:
                print(f"Smart Reply: {answer.reply}")
                print(f"Answer Record: {answer.answer_record}")

    for suggestion_result in response.end_user_suggestion_results:
        if suggestion_result.error:
            print(f"Error: {suggestion_result.error.message}")
        if suggestion_result.suggest_articles_response:
            for answer in suggestion_result.suggest_articles_response.article_answers:
                print(f"Article Suggestion Answer: {answer.title}")
                print(f"Answer Record: {answer.answer_record}")
        if suggestion_result.suggest_faq_answers_response:
            for answer in suggestion_result.suggest_faq_answers_response.faq_answers:
                print(f"Faq Answer: {answer.answer}")
                print(f"Answer Record: {answer.answer_record}")
        if suggestion_result.suggest_smart_replies_response:
            for (
                answer
            ) in suggestion_result.suggest_smart_replies_response.smart_reply_answers:
                print(f"Smart Reply: {answer.reply}")
                print(f"Answer Record: {answer.answer_record}")

    return response

Nachricht vom Endnutzer hinzufügen und analysieren

Rufen Sie die Methode analyzeContent für die Resource Participant auf, um eine Endnutzernachricht für die Unterhaltung hinzuzufügen und zu analysieren. Geben Sie die Unterhaltungs-ID und die Teilnehmer-ID des Endnutzers ein.

Die Antwort enthält eine Nachrichten-ID. Im nächsten Schritt werden Vorschläge abgerufen.

REST

Ersetzen Sie diese Werte in den folgenden Anfragedaten:

  • PROJECT_ID: Ihre GCP-Projekt-ID
  • CONVERSATION_ID: Die Unterhaltungs-ID
  • PARTICIPANT_ID: Die Teilnehmer-ID für den Endnutzer

HTTP-Methode und URL:

POST https://dialogflow.googleapis.com/v2/projects/PROJECT_ID/conversations/CONVERSATION_ID/participants/PARTICIPANT_ID:analyzeContent

JSON-Text anfordern:

{
  "textInput": {
    "text": "I want to reserve a room.",
    "languageCode": "en-US"
  }
}

Wenn Sie die Anfrage senden möchten, maximieren Sie eine der folgenden Optionen:

Sie sollten eine JSON-Antwort ähnlich wie diese erhalten:

{
  "message": {
    "name": "projects/PROJECT_ID/conversations/CONVERSATION_ID/messages/MESSAGE_ID",
    "content": "I want to reserve a room.",
    "languageCode": "en-US",
    "participant": "PARTICIPANT_ID",
    "participantRole": "END_USER",
    "createTime": "2020-02-13T00:07:35.925Z"
  },
  "humanAgentSuggestionResults": [
    {
      "suggestSmartRepliesResponse": {
      "smartReplyAnswers": [
          {
            "reply": "Where would you like to reserve a room?",
            "confidence": 0.5,
            "answerRecord": "projects/PROJECT_ID/answerRecords/ANSWER_RECORD_ID_1"
          },
          {
            "reply": "What type of rooms would you like to reserve?",
            "confidence": 0.3,
            "answerRecord": "projects/PROJECT_ID/answerRecords/ANSWER_RECORD_ID_2"
          },
          {
            "reply": "How long do you want to stay?",
            "confidence": 0.1,
            "answerRecord": "projects/PROJECT_ID/answerRecords/ANSWER_RECORD_ID_3"
          }
        ]
      }
    }
  ]
}

Python

Richten Sie zur Authentifizierung bei Agent Assist Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten. 

def analyze_content_text(
    project_id: str, conversation_id: str, participant_id: str, text: str
):
    from google.cloud import dialogflow_v2beta1 as dialogflow

    """Analyze text message content from a participant.

    Args:
        project_id: The GCP project linked with the conversation profile.
        conversation_id: Id of the conversation.
        participant_id: Id of the participant.
        text: the text message that participant typed."""

    client = dialogflow.ParticipantsClient()
    participant_path = client.participant_path(
        project_id, conversation_id, participant_id
    )
    text_input = {"text": text, "language_code": "en-US"}
    response = client.analyze_content(
        participant=participant_path, text_input=text_input
    )
    print("AnalyzeContent Response:")
    print(f"Reply Text: {response.reply_text}")

    for suggestion_result in response.human_agent_suggestion_results:
        if suggestion_result.error is not None:
            print(f"Error: {suggestion_result.error.message}")
        if suggestion_result.suggest_articles_response:
            for answer in suggestion_result.suggest_articles_response.article_answers:
                print(f"Article Suggestion Answer: {answer.title}")
                print(f"Answer Record: {answer.answer_record}")
        if suggestion_result.suggest_faq_answers_response:
            for answer in suggestion_result.suggest_faq_answers_response.faq_answers:
                print(f"Faq Answer: {answer.answer}")
                print(f"Answer Record: {answer.answer_record}")
        if suggestion_result.suggest_smart_replies_response:
            for (
                answer
            ) in suggestion_result.suggest_smart_replies_response.smart_reply_answers:
                print(f"Smart Reply: {answer.reply}")
                print(f"Answer Record: {answer.answer_record}")

    for suggestion_result in response.end_user_suggestion_results:
        if suggestion_result.error:
            print(f"Error: {suggestion_result.error.message}")
        if suggestion_result.suggest_articles_response:
            for answer in suggestion_result.suggest_articles_response.article_answers:
                print(f"Article Suggestion Answer: {answer.title}")
                print(f"Answer Record: {answer.answer_record}")
        if suggestion_result.suggest_faq_answers_response:
            for answer in suggestion_result.suggest_faq_answers_response.faq_answers:
                print(f"Faq Answer: {answer.answer}")
                print(f"Answer Record: {answer.answer_record}")
        if suggestion_result.suggest_smart_replies_response:
            for (
                answer
            ) in suggestion_result.suggest_smart_replies_response.smart_reply_answers:
                print(f"Smart Reply: {answer.reply}")
                print(f"Answer Record: {answer.answer_record}")

    return response

Vorschlag erhalten (optional)

Sie können Vorschläge jederzeit deaktivieren. Optional können Sie eine Nachrichten-ID angeben, um Vorschläge basierend auf dieser Nachricht zu erhalten. Wenn dieses Feld nicht festgelegt ist, basieren Vorschläge standardmäßig auf der letzten Nachricht von einem der beiden Teilnehmer. Rufen Sie die Methode suggestSmartReplies für die Ressource Suggestion auf, um Vorschläge zu erhalten. Geben Sie die Unterhaltungs-ID, die Teilnehmer-ID für den menschlichen Kundenservicemitarbeiter und eine Nachrichten-ID von einem der beiden Teilnehmer an (optional).

Die Antwort enthält Vorschläge für intelligente Antworten für den Kundenservicemitarbeiter.

REST

Ersetzen Sie diese Werte in den folgenden Anfragedaten:

  • PROJECT_ID: Ihre GCP-Projekt-ID
  • CONVERSATION_ID: Die Unterhaltungs-ID
  • PARTICIPANT_ID: Die Teilnehmer-ID für den Endnutzer

HTTP-Methode und URL:

POST https://dialogflow.googleapis.com/v2/projects/PROJECT_ID/conversations/CONVERSATION_ID/participants/PARTICIPANT_ID:analyzeContent

JSON-Text anfordern:

{
  "textInput": {
    "text": "I want to reserve a room.",
    "languageCode": "en-US"
  }
}

Wenn Sie die Anfrage senden möchten, maximieren Sie eine der folgenden Optionen:

Sie sollten eine JSON-Antwort ähnlich wie diese erhalten:

{
  "message": {
    "name": "projects/PROJECT_ID/conversations/CONVERSATION_ID/messages/MESSAGE_ID",
    "content": "I want to reserve a room.",
    "languageCode": "en-US",
    "participant": "PARTICIPANT_ID",
    "participantRole": "END_USER",
    "createTime": "2020-02-13T00:07:35.925Z"
  },
  "humanAgentSuggestionResults": [
    {
      "suggestSmartRepliesResponse": {
      "smartReplyAnswers": [
          {
            "reply": "Where would you like to reserve a room?",
            "confidence": 0.5,
            "answerRecord": "projects/PROJECT_ID/answerRecords/ANSWER_RECORD_ID_1"
          },
          {
            "reply": "What type of rooms would you like to reserve?",
            "confidence": 0.3,
            "answerRecord": "projects/PROJECT_ID/answerRecords/ANSWER_RECORD_ID_2"
          },
          {
            "reply": "How long do you want to stay?",
            "confidence": 0.1,
            "answerRecord": "projects/PROJECT_ID/answerRecords/ANSWER_RECORD_ID_3"
          }
        ]
      }
    }
  ]
}

Python

Richten Sie zur Authentifizierung bei Agent Assist Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten. 

def analyze_content_text(
    project_id: str, conversation_id: str, participant_id: str, text: str
):
    from google.cloud import dialogflow_v2beta1 as dialogflow

    """Analyze text message content from a participant.

    Args:
        project_id: The GCP project linked with the conversation profile.
        conversation_id: Id of the conversation.
        participant_id: Id of the participant.
        text: the text message that participant typed."""

    client = dialogflow.ParticipantsClient()
    participant_path = client.participant_path(
        project_id, conversation_id, participant_id
    )
    text_input = {"text": text, "language_code": "en-US"}
    response = client.analyze_content(
        participant=participant_path, text_input=text_input
    )
    print("AnalyzeContent Response:")
    print(f"Reply Text: {response.reply_text}")

    for suggestion_result in response.human_agent_suggestion_results:
        if suggestion_result.error is not None:
            print(f"Error: {suggestion_result.error.message}")
        if suggestion_result.suggest_articles_response:
            for answer in suggestion_result.suggest_articles_response.article_answers:
                print(f"Article Suggestion Answer: {answer.title}")
                print(f"Answer Record: {answer.answer_record}")
        if suggestion_result.suggest_faq_answers_response:
            for answer in suggestion_result.suggest_faq_answers_response.faq_answers:
                print(f"Faq Answer: {answer.answer}")
                print(f"Answer Record: {answer.answer_record}")
        if suggestion_result.suggest_smart_replies_response:
            for (
                answer
            ) in suggestion_result.suggest_smart_replies_response.smart_reply_answers:
                print(f"Smart Reply: {answer.reply}")
                print(f"Answer Record: {answer.answer_record}")

    for suggestion_result in response.end_user_suggestion_results:
        if suggestion_result.error:
            print(f"Error: {suggestion_result.error.message}")
        if suggestion_result.suggest_articles_response:
            for answer in suggestion_result.suggest_articles_response.article_answers:
                print(f"Article Suggestion Answer: {answer.title}")
                print(f"Answer Record: {answer.answer_record}")
        if suggestion_result.suggest_faq_answers_response:
            for answer in suggestion_result.suggest_faq_answers_response.faq_answers:
                print(f"Faq Answer: {answer.answer}")
                print(f"Answer Record: {answer.answer_record}")
        if suggestion_result.suggest_smart_replies_response:
            for (
                answer
            ) in suggestion_result.suggest_smart_replies_response.smart_reply_answers:
                print(f"Smart Reply: {answer.reply}")
                print(f"Answer Record: {answer.answer_record}")

    return response

Unterhaltung abschließen

Rufen Sie zum Abschließen der Unterhaltung die Methode complete für die Ressource conversations auf. Geben Sie die Unterhaltungs-ID an.

REST

Ersetzen Sie diese Werte in den folgenden Anfragedaten:

  • PROJECT_ID: Ihre GCP-Projekt-ID
  • CONVERSATION_ID: Die ID, die Sie beim Erstellen der Unterhaltung erhalten haben

HTTP-Methode und URL:

POST https://dialogflow.googleapis.com/v2/projects/PROJECT_ID/conversations/CONVERSATION_ID:complete

Wenn Sie die Anfrage senden möchten, maximieren Sie eine der folgenden Optionen:

Sie sollten eine JSON-Antwort ähnlich wie diese erhalten:

{
  "name": "projects/PROJECT_ID/conversations/CONVERSATION_ID",
  "lifecycleState": "COMPLETED",
  "conversationProfile": "projects/PROJECT_ID/conversationProfiles/CONVERSATION_PROFILE_ID",
  "startTime": "2018-11-05T21:05:45.622Z",
  "endTime": "2018-11-06T03:50:26.930Z"
}

Python

Richten Sie zur Authentifizierung bei Agent Assist Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten. 

def complete_conversation(project_id, conversation_id):
    """Completes the specified conversation. Finished conversations are purged from the database after 30 days.

    Args:
        project_id: The GCP project linked with the conversation.
        conversation_id: Id of the conversation."""

    client = dialogflow.ConversationsClient()
    conversation_path = client.conversation_path(project_id, conversation_id)
    conversation = client.complete_conversation(name=conversation_path)
    print("Completed Conversation.")
    print("Life Cycle State: {}".format(conversation.lifecycle_state))
    print("Conversation Profile Name: {}".format(conversation.conversation_profile))
    print("Name: {}".format(conversation.name))
    return conversation