BYO 会話AI側 エンドポイント仕様書

リクエスト仕様

サンプル

{
  "sid": "SESSION-ID",
  "customData": {
    "locale": "en-US",
    "location": "38.9124, -77.0917",
    "myCustomField": "Value of myCustomField"
  },
  "userInput": "What is generative AI?",
  "conversationPayload": "",
  "type": "QUESTION",
  "uneeqSessionId": "18220511-b8bb-4164-9d43-dcf4e33e07b1",
  "userLocale": "en-US",
  "userLocation": "38.9124, -77.0917"
}

1. sid: "SESSION-ID"という値が設定されています。これはHosted Experienceを使用していることを示しています。

2. customData: カスタムデータを含むオブジェクトです。
• locale: en-US（アメリカ英語）が設定されています。日本語の場合はja-JPです。
• location: "38.9124, -77.0917"（緯度と経度）が設定されています。
• myCustomField: カスタムフィールドの例で、"Value of myCustomField"という値が設定されています。

3. userInput: ユーザーの質問で、"What is generative AI?"（生成AIとは何ですか？）という内容です。

4. conversationPayload: 空の文字列になっています。これは会話の状態を保持するために使用できますが、この例では使用されていません。

5. type: "QUESTION"となっており、これが通常の質問であることを示しています（最初の挨拶ではない）。

6. uneeqSessionId: "18220511-b8bb-4164-9d43-dcf4e33e07b1"というユニークな識別子が設定されています。これは特定の会話セッションを識別するために使用されます。

7. userLocale: "en-US"で、customDataのlocaleフィールドと同じ値です。

8. userLocation: "38.9124, -77.0917"で、customDataのlocationフィールドと同じ値です。

レスポンス仕様

レスポンスタイプ

ボディ

サンプル

{
  "answer": "Hello! I'm a digital human. How can I help you?",
  "instructions": {
    "displayHtml": {
      "html": "an html string"
    }
  },
  "conversationPayload": ""
}

1. answer: 値: "Hello! I'm a digital human. How can I help you?"（日本語訳: "こんにちは！私はデジタルヒューマンです。どのようにお手伝いできますか？"）

これはデジタルヒューマンが話す実際のテキストです。

2. instructions: このオブジェクトには、デジタルヒューマンの動作や表示に関する追加の指示が含まれます。

displayHtml: このサブオブジェクトは、ユーザーインターフェースに表示するHTMLを指定します。

• html: "an html string"（HTMLの文字列） 実際の使用では、ここに有効なHTML文字列が入ります。これにより、テキスト、画像、リンクなどの追加情報をユーザーに表示できます。

3. conversationPayload: 値: "" （空の文字列）

この例では使用されていませんが、必要に応じてここに会話の状態や文脈に関する情報を含めることができます。