跳到主要內容

使用DirectLine API 實作Client應用程式來串接Chat Bot



基本上MS的Bot framework 本來就提供了許多Channel 讓我們的bot 可以自由地選擇想要串接的平台
像是 Skype, Facebook messager, Slake 等等

但若是想自己開發一個client端的應用程式去串接Bot
那實際上我們可以透過DirectLine chenel 來達成


目前DirectLine 已經提供完整的REST API 讓我們呼叫

所以要實作一個能夠與Bot對話的client 應用程式其實不難

首先:
需要一組Secret key 用來當作每個conversation的鑰匙




(注意:底下的說明使用Python語言)

第一步: 開啟對話


使用底下的url
    
 API_ENDPOINT = "https://directline.botframework.com/v3/directline/conversations"
並且在 Header 裡面加入你的secret key

 headers = {'Authorization': 'Bearer '+API_KEY}
然後再POST

     # sending post request and saving response as response object
     responds = requests.post(url=API_ENDPOINT, headers=headers)

 
如果有成功開啟一個 conversation的話
就會得到一個 consersation id(當我們收送訊息時都會用到他)

第二步: 送訊息給Bot


使用底下的 url
     # defining the api-endpoint
     send_api_endpoint = "https://directline.botframework.com/v3/directline/conversations/"+ conversation_id + "/activities"

Header 裡面加入你的secret key,
headers = {'Authorization': 'Bearer '+API_KEY, 'Content-Type': 'application/json'}
    
以及在body 裡面填入你要送的訊息 
    data = {
        "type": "message",
        "from": {
            "id": "user1"
        },
        "text": message
    }

最後再POST出去

     # sending post request and saving response as response object
     responds = requests.post(url=send_api_endpoint, data=json.dumps(data), headers=headers)
     print "The status code is:%s"%responds.status_code

成功的話你會得到JSON的結果如下
{
    "id": "4onHfZ1hPGnI0Yk1YjmSdY|0000001"
}


第三步:接受訊息


使用底下的 url並指定conversation id
     # defining the api-endpoint
    receive_api_endpoint = "https://directline.botframework.com/v3/directline/conversations/"
                 + conversation_id + "/activities


Header 裡面加入你的secret key,
    headers = {'Authorization':'Bearer '+API_KEY}


然後再使用GET

     # sending get request and saving response as response object
     responds = requests.get(url=receive_api_endpoint, headers=headers)
     print "The status code is:%s"%responds.status_code


這邊需要注意的是如果url 沒有特別指定watermark的話
get下來的結果會是全部的對話紀錄,

由於每次Bot回傳的結果都會帶一個watermark
{
    "activities": [
        {
            "type": "message",
            "channelId": "directline",
            "conversation": {
                "id": "abc123"
            },
            "id": "abc123|0000",
            "from": {
                "id": "user1"
            },
            "text": "hello"
        },
        {
            "type": "message",
            "channelId": "directline",
            "conversation": {
                "id": "abc123"
            },
            "id": "abc123|0001",
            "from": {
                "id": "bot1"
            },
            "text": "Nice to see you, user1!"
        }
    ],
    "watermark": "2"
}
而這個watermark簡單來就是一個訊息編號, 會不斷地被更新
所以若我要取得訊息編號2之後的對話紀錄
我們可以在原本url後面加入watermark=2的query string

     # defining the api-endpoint
     receive_api_endpoint = "https://directline.botframework.com/v3/directline/conversations/"
                 + conversation_id + "/activities?watermark="+"2"


最後再解析JSON 結果的時候
可以使用BotId 過濾訊息

     ACTIVITIES = JSON_MESSAGE["activities"]
     BOT_MESSAGES = list()
     for active in ACTIVITIES:
         if active["from"]["id"] == BOT_ID:
             BOT_MESSAGES.append(active)
     for bot_message in BOT_MESSAGES:
         print bot_message["text"]


完整 sample code:


實際run起來的結果

標籤：

留言

張貼留言

這個網誌中的熱門文章

[解決方法] docker: permission denied

前言 當我們執行docker 指令時若出現以下錯誤訊息 docker: Got permission denied while trying to connect to the Docker daemon socket at unix:///var/run/docker.sock: Post http://%2Fvar%2Frun%2Fdocker.sock/v1.26/containers/create: dial unix /var/run/docker.sock: connect: permission denied. See 'docker run --help'. 表示目前的使用者身分沒有權限去存取docker engine, 因為docker的服務基本上都是以root的身分在執行的, 所以在指令前加sudo就能成功執行指令 但每次實行docker指令(就連docker ps)都還要加sudo實在有點麻煩, 正確的解法是 我們可以把目前使用者加到docker群組裡面, 當docker service 起來時, 會以這個群組的成員來初始化相關服務 sudo groupadd docker sudo usermod -aG docker $USER 需要退出重新登錄後才會生效 Workaround 因為問題是出在權限不足, 如果以上方法都不管用的話, 可以手動修改權限來解決這個問題 sudo chmod 777 /var/run/docker.sock https://docs.docker.com/install/linux/linux-postinstall/
張貼留言
閱讀完整內容

[C#] Visual Studio, 如何在10分鐘內快速更改命名專案名稱

前言: 由於工作需要, 而且懶得再重寫類似的專案, 所以常常將之前寫的專案複製一份加料後, 再重新命名編譯 假設今天我有一個專案HolyUWP, 我想把它重新命名成 BestUWP 時該怎麼做? 以下是幾個簡單的的步驟 使用Visual Studio 2017 備份原來專案 更改Solution名稱 更改Assembly name, Default namespce 更改每支程式碼的Namespace 更改專案資料夾名稱 備份原來專案 由於怕改壞掉, 所以在改之前先備份 更改Solution名稱 更改sln的名稱, 這邊我改成BestUWP.sln 使用Visual Studio打開你的.sln, 右鍵點擊Solution後選擇Rename, 這邊我把它重新命名成BestUWP(跟檔案名稱一致) 必要的話可以順便修改Porject名稱 更改Assembly name, Default namespce 進入 Project > OOXX Properties    修改Assembly Name, Default namesapce 更改每支程式碼的Namespace 基本上隨便挑一支有用到預設Namesapce(HolyUWP)的程式碼來改就好了 重新命名後點擊Apply,  這個動作做完後所有用到舊Namespace的程式碼都會被改成新的 更改專案資料夾名稱 以上動作做完後, 基本上就可以把專案編譯出來測看看了~
2 則留言
閱讀完整內容

[解決方法] mac 作業系統上無法使用 docker

  錯誤訊息 Cannot connect to the Docker daemon at unix:///var/run/docker.sock. Is the docker daemon running? 原因 因為 docker 的設計是走 client-server 的架構,  如果少裝了 server 的部分就會出現以上的錯誤訊息 解決方法 因為 docker daemon 需要使用 linux kernel 上的某些功能, 所以若想要在 mac 的 OS X 上使用 docker 必須額外起一台 linux VM 給 docker daemon 用  Step 1. 安裝 virtual box $ brew install virtualbox --cask   Step 2. 安裝 docker machine $ brew install docker-machine --cask   Step 3. 設定 使用 docker-machine 建立 VM 跑容器 $docker-machine create --driver virtualbox default $docker-machine restart   輸出環境變數 $docker-machine env default 如果執行以上的指令出現錯誤訊息 Error checking TLS connection: ...  可以執行以下指令重新產生憑證 $docker-machine regenerate-certs 最後套用環境變數, 讓 docker 知道要怎麼去跟這台 VM 溝通  $eval $(docker-machine env default)   測試 若做完以上的步驟沒噴錯誤訊息的話, 可以跑個 hello-world 看看 docker daemon 有沒有起來 $docker run hello-world Unable to find image 'hello-world:latest' locally latest: Pulling from library/hello-world 0e03bdcc26d7: Pull complete Digest: sha256:95ddb6c31407e84e91a986b004aee40975cb0
張貼留言
閱讀完整內容