Beispiel

Das folgende Beispiel zeigt eine zustandsbehaftete /message-Anfrage, die sowohl globale als auch fähigkeitsspezifische Kontextvariablen enthält; außerdem wird die options.return_context-Eigenschaft verwendet, um zu verlangen, dass der Kontext mit der Antwort zurückgegeben wird. Diese Option ist nur anwendbar, wenn Sie die zustandsbehaftete message-Methode verwenden, da die zustandslose message-Methode immer den Kontext zurückgibt.

service
  .message({
    assistant_id: '{assistant_id}',
    session_id: '{session_id}',
    input: {
      message_type: 'text',
      text: 'Hello',
      options: {
        'return_context': true
      }
    },
    context: {
      'global': {
        'system': {
          'user_id': 'my_user_id'
        }
      },
      'skills': {
        'main skill': {
          'user_defined': {
            'account_number': '123456'
          }
        }
      }
    }
  })
  .then(res => {
    console.log(JSON.stringify(res, null, 2));
  })
  .catch(err => {
    console.log(err);
  });

response=service.message(
    assistant_id='{assistant_id}',
    session_id='{session_id}',
    input={
        'message_type': 'text',
        'text': 'Hello',
        'options': {
            'return_context': True
        }
    },
    context={
        'global': {
            'system': {
                'user_id': 'my_user_id'
            }
        },
        'skills': {
            'main skill': {
                'user_defined': {
                    'account_number': '123456'
                }
            }
        }
    }
).get_result()

print(json.dumps(response, indent=2))

MessageInputOptions inputOptions = new MessageInputOptions.Builder()
  .returnContext(true)
  .build();

MessageInput input = new MessageInput.Builder()
  .messageType("text")
  .text("Hello")
  .options(inputOptions)
  .build();

// create global context with user ID
MessageContextGlobalSystem system = new MessageContextGlobalSystem.Builder()
  .userId("my_user_id")
  .build();
MessageContextGlobal globalContext = new MessageContextGlobal.Builder()
  .system(system)
  .build();

// build user-defined context variables, put in skill-specific context for main skill
Map<String, Object> userDefinedContext = new HashMap<>();
userDefinedContext.put("account_number","123456");
MessageContextSkill mainSkillContext = new MessageContextSkill.Builder()
  .userDefined(userDefinedContext)
  .build();
Map<String, MessageContextSkill> skillsContext = new HashMap<>();
skillsContext.put("main skill", mainSkillContext);

MessageContext context = new MessageContext.Builder()
  .global(globalContext)
  .skills(skillsContext)
  .build();

MessageOptions options = new MessageOptions.Builder()
  .assistantId("{assistant_id}")
  .sessionId("{session_id}")
  .input(input)
  .context(context)
  .build();

MessageResponse response = service.message(options).execute().getResult();

System.out.println(response);

In dieser Beispielanforderung gibt die Anwendung einen Wert für user_id als Teil des globalen Kontexts an. Außerdem wird eine benutzerdefinierte Kontextvariable (account_number) als Teil des skillbezogenen Kontexts festgelegt. Diese Kontextvariable kann von Dialogmodulknoten als $account_number aufgerufen werden.

Sie können einen beliebigen Variablennamen angeben, den Sie für eine benutzerdefinierte Kontextvariable verwenden möchten. Wenn die angegebene Variable vorhanden ist, wird sie mit dem neuen Wert überschrieben; wenn nicht, wird dem Kontext eine neue Variable hinzugefügt.

Die Ausgabe dieser Anforderung enthält neben den üblichen Ausgabedaten den Kontext und zeigt, dass die angegebenen Werte hinzugefügt wurden. Wenn Sie die statusunabhängige Methode message verwenden, müssen diese Kontextdaten lokal gespeichert und als Teil der nächsten Nachricht an den watsonx Assistant-Service zurückgesendet werden. Wenn Sie die zustandsbehaftete message-Methode verwenden, wird dieser Kontext automatisch gespeichert und bleibt für die Dauer der Sitzung bestehen.

{
  "output": {
    "generic": [
      {
        "response_type": "text",
        "text": "Welcome to the watsonx Assistant example!"
      }
    ],
    "intents": [
      {
        "intent": "hello",
        "confidence": 1
      }
    ],
    "entities": []
  },
  "user_id": "my_user_id",
  "context": {
    "global": {
      "system": {
        "turn_count": 1,
        "user_id": "my_user_id"
      }
    },
    "skills": {
      "main skill": {
        "user_defined": {
          "account_number": "123456"
        }
      }
    }
  }
}

Dialogstatus wiederherstellen

In manchen Situationen ist es hilfreich, wenn ein vorheriger Status des Dialogs wiederhergestellt werden kann.

Sie können die Option export in statusabhängigen Anforderungen message verwenden, um anzugeben, dass das Kontextobjekt in der Antwort die vollständigen Informationen zum Sitzungsstatus enthalten soll. Wenn Sie für diese Option true angeben, enthält der zurückgegebene Skillkontext eine codierte Eigenschaft state, die den aktuellen Dialogstatus darstellt.

Wenn Sie die statusabhängige API message verwenden, speichert der Service die Dialogstatusdaten nur für die Lebensdauer der Sitzung. Wenn Sie jedoch diese Kontextdaten (einschließlich state ) speichern und sie mit einer nachfolgenden Nachrichtenanfrage an den Dienst zurücksenden, können Sie die Konversation im gleichen Zustand wiederherstellen, selbst wenn die ursprüngliche Sitzung abgelaufen ist oder gelöscht wurde.

Wenn Sie die statusunabhängie API message verwenden, ist die Eigenschaft state immer in den Antworten enthalten (zusammen mit dem übrigen Inhalt von context). Obwohl statusunabhängige Sitzungen nicht ablaufen, können Sie mithilfe der Statusdaten dennoch einen früheren Dialogstatus wiederherstellen.