Smart agent

API này cho phép người dùng tìm kiếm dữ liệu của đối tác theo hội thoại.

Smart agent

POST https://hostname/smart-agent/v2/data/discovery

Headers

Name
Type
Description

accesstoken

string

mỗi partner sẽ được cấp 1 access token

partnerid

string

partner ID

content-type

string

application/json

Request Body

Name
Type
Description

userAction

object

payload:"level_vn", payloadText:"cầu kỳ"

botId

string

bot ID

userId

string

user ID

message

string

từ khóa hoặc câu hỏi

{
  "responseMessage": "Bạn yêu cầu, MyBee đáp ứng. Tớ tìm được 3 kết quả cho bạn.",
  "quickReplyMessage": "Để tìm được kết quả như ý muốn :) bạn có thể lựa chọn những từ khoá dưới đây:",
  "quickReplies": [
    {
      "content_type": "text",
      "title": "dưới 30 phút",
      "payload": "totalTimeString"
    },
    {
      "content_type": "text",
      "title": "trung bình",
      "payload": "level_vn"
    },
    {
      "content_type": "text",
      "title": "đơn giản",
      "payload": "level_vn"
    },
    {
      "content_type": "text",
      "title": "ăn trưa",
      "payload": "events_vn"
    },
    {
      "content_type": "text",
      "title": "ăn tối",
      "payload": "events_vn"
    },
    {
      "content_type": "text",
      "title": "tiệc",
      "payload": "events_vn"
    },
    {
      "content_type": "text",
      "title": "ăn sáng",
      "payload": "events_vn"
    },
    {
      "content_type": "text",
      "title": "ăn vặt",
      "payload": "events_vn"
    }
  ],
  "conceptObjectResult": {
    "conceptObjectId": "dataInfoConceptObject",
    "numFound": 31,
    "results": [
      {
        "docId": "prc-5d09fb8ab4f46b407b1307dd",
        "score": 0,
        "language": "vn",
        "author": "Thu Trang tổng hợp",
        "basicInfo": {
          "name": "Cơm ngon hơn với thịt vịt xào măng trúc",
          "image": {
            "id": {
              "externalId": "ydt3bgpodqfbkhuklmtl"
            },
            "title": "Cơm ngon hơn với thịt vịt xào măng trúc",
            "description": "Có rất nhiều món ngon khi nhắc đến nguyên liệu là Vịt trong ẩm thực Việt Nam. Nhưng có lẽ nhiều người sẽ còn lạ lẫm về cái tên vịt xào măng trúc.",
            "width": 240,
            "height": 160,
            "bytes": 25643,
            "photoUrls": {
              "originPhotoUrl": "https://res.cloudinary.com/ddnbfszye/image/upload/v1560935305/ydt3bgpodqfbkhuklmtl.jpg"
            }
          },
          "intro": "Có rất nhiều món ngon khi nhắc đến nguyên liệu là Vịt trong ẩm thực Việt Nam. Nhưng có lẽ nhiều người sẽ còn lạ lẫm về cái tên vịt xào măng trúc.",
          "hasVideo": false,
          "categories": [
            "đời sống",
            "ẩm thực"
          ]
        },
        "partnerRedirectUrl": "https://vietnamnet.vn/vn/doi-song/am-thuc/com-ngon-hon-voi-thit-vit-xao-mang-truc-433873.html"
      },
      {
        "docId": "prc-5d0b34c7b4f46b407b3ff36d",
        "score": 0,
        "language": "vn",
        "author": "Thu Trang tổng hợp",
        "basicInfo": {
          "name": "Cơm ngon hơn với thịt vịt xào măng trúc",
          "image": {
            "id": {
              "externalId": "uozbiqfxithx0seegds9"
            },
            "externalUri": "https://vnn-imgs-f.vgcloud.vn/2018/03/05/11/com-ngon-hon-voi-thit-vit-xao-mang-truc.jpg",
            "title": "Cơm ngon hơn với thịt vịt xào măng trúc",
            "description": "Có rất nhiều món ngon khi nhắc đến nguyên liệu là Vịt trong ẩm thực Việt Nam. Nhưng có lẽ nhiều người sẽ còn lạ lẫm về cái tên vịt xào măng trúc.",
            "width": 480,
            "height": 270,
            "bytes": 42229,
            "photoUrls": {
              "originPhotoUrl": "https://res.cloudinary.com/dqdeath3s/image/upload/v1561015494/uozbiqfxithx0seegds9.jpg"
            }
          },
          "intro": "Có rất nhiều món ngon khi nhắc đến nguyên liệu là Vịt trong ẩm thực Việt Nam. Nhưng có lẽ nhiều người sẽ còn lạ lẫm về cái tên vịt xào măng trúc.",
          "hasVideo": false,
          "categories": [
            "đời sống",
            "ẩm thực"
          ]
        },
        "partnerRedirectUrl": "https://vietnamnet.vn/vn/doi-song/am-thuc/com-ngon-hon-voi-thit-vit-xao-mang-truc-433873.html"
      },
      {
        "docId": "prc-5d0b023eb4f46b407b3fef40",
        "score": 0,
        "language": "vn",
        "author": "Thu Trang tổng hợp",
        "basicInfo": {
          "name": "Cơm ngon hơn với thịt vịt xào măng trúc",
          "image": {
            "id": {
              "externalId": "bf8dhctqkbrydjucxqxx"
            },
            "externalUri": "https://vnn-imgs-f.vgcloud.vn/2018/03/05/11/com-ngon-hon-voi-thit-vit-xao-mang-truc.jpg",
            "title": "Cơm ngon hơn với thịt vịt xào măng trúc",
            "description": "Có rất nhiều món ngon khi nhắc đến nguyên liệu là Vịt trong ẩm thực Việt Nam. Nhưng có lẽ nhiều người sẽ còn lạ lẫm về cái tên vịt xào măng trúc.",
            "width": 480,
            "height": 270,
            "bytes": 42229,
            "photoUrls": {
              "originPhotoUrl": "https://res.cloudinary.com/dqdeath3s/image/upload/v1561002557/bf8dhctqkbrydjucxqxx.jpg"
            }
          },
          "intro": "Có rất nhiều món ngon khi nhắc đến nguyên liệu là Vịt trong ẩm thực Việt Nam. Nhưng có lẽ nhiều người sẽ còn lạ lẫm về cái tên vịt xào măng trúc.",
          "hasVideo": false,
          "categories": [
            "đời sống",
            "ẩm thực"
          ]
        },
        "partnerRedirectUrl": "https://vietnamnet.vn/vn/doi-song/am-thuc/com-ngon-hon-voi-thit-vit-xao-mang-truc-433873.html"
      }
    ],
    "inputLanguage": "vn"
  },
  "imageDetectionFlag": false,
  "moreResult": false,
  "goBack": true,
  "recommendFlag": false,
  "templateEntity": {
    "responseTemplate": "resultTemplate.tpl"
  }
}

Ví dụ về body request:

# Gửi yêu cần tìm kiếm món ăn
{
  "botId":"387610014903427",
  "userId": "1161399530641264",
  "message": "thịt vịt"
}

# Nếu kết quả quá 8 công thức, để xem công thức tiếp theo gửi payload: SEE_MORE_RECIPE
{
  "botId":"387610014903427",
  "userId": "1161399530641264",
  "userAction": {
    "payload": "SEE_MORE_RECIPE"
  }
}

# Để quay lại trang kết quả vừa rồi dùng payload có giá trị SEE_BACK_RECIPE
{
  "botId":"387610014903427",
  "userId": "1161399530641264",
  "userAction": {
    "payload": "SEE_BACK_RECIPE"
  }
}

# Nếu kết quả hiện ra "quickReplies", kiểu như:
{
"content_type": "text",
"title": "dưới 30 phút",
"payload": "totalTimeString"
}

để thu hẹp kết quả tìm kiếm "dưới 30 phút" gửi request sau:
{
  "botId":"387610014903427",
  "userId": "1161399530641264",
  "userAction": {
    "payload": "totalTimeString",
	"payloadText":"dưới 30 phút"
  }
}

Nếu người dùng chưa login thì để userId là sessionId, và gửi đúng sessionId đó cho toàn bộ phiên chat của người dùng.

Last updated

Was this helpful?