motuo/call-watson-api

Call Watson API(Assistant and Discovery Service)

1.1 2018-11-16 03:58 UTC

Requires

• php: >=7.0.0
• guzzlehttp/guzzle: ^6.3

MIT

• Yousuke Enomoto

• laravel
• watson

README

motuo/call-watson-api is a laravel package providing easy cooperation to Watson Such as:

• Call Watson Assistant API(Get response to user input)
• Call Watson Discovery Service API

Japanese Document
日本語記事はこちら

Installation

You can install the package via composer:

composer require motuo/call-watson-api

If you are using Laravel 5.5, the service provider will automatically be discovered.

Publish config file

php artisan vendor:publish

and choose

Provider: motuo\CallWatsonAPI\CallWatsonServiceProvider

Add API credentials to .env file like this as you need.

WATSON_ASSISTAN_API_URL="https://gateway-fra.watsonplatform.net/assistant/api"
WATSON_ASSISTANT_VERSION="2018-07-10"
WATSON_ASSISTANT_WORKSPACEID=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
WATSON_ASSISTANT_USER_NAME=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
WATSON_ASSISTANT_PASSWORD=xxxxxxxxxxxx

WATSON_DISCOVERY_API_URL="https://gateway-fra.watsonplatform.net/discovery/api"
WATSON_DISCOVERY_VERSION="2018-10-15"
WATSON_DISCOVERY_ENV_ID=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
WATSON_DISCOVERY_COLLECTION=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
WATSON_DISCOVERY_USER_NAME=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
WATSON_DISCOVERY_PASSWORD=xxxxxxxxxxxx

Usage

Call Watson Assistant

Example

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;
use motuo\CallWatsonAPI\CallAssistant;

class TestContoller extends Controller
{
    public function index(Request $request,CallAssistant $CWA){
        //provide user input message and context
        $response      = $CWA->postMessage('input message',session('context')?session('context'):[]);
        //this method returns json.If necessary,please json decode.
        $responseArray = json_decode($response,true);
        //this step put a context to session for next conversation
        $request->session()->put('context',$responseArray['context']);
        return view('welcome');
    }
}

Call Watson Discovery

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;
use motuo\CallWatsonAPI\CallDiscovery;

class TestContoller extends Controller
{
    public function index(Request $request,CallDiscovery $CWD){
        //Query your collection
        $query  = ['query'=>[
            'version'        => '2018-08-01',
            'deduplicate'    => 'false',
            'highlight'      => 'true',
            'passages'       => 'true',
            'passages.count' => '5'   ,
            'natural_language_query' => 'natural_language_query'
        ]];
        $CWD->queryCollection($query);
        //Management training Querys
        $CWD->listTrainingData();
        $CWD->getQueryIdByNLQ('natural_language_query');
        $CWD->addQueryToTrainingData('document_id','natural_language_query',100);
        $CWD->deleteTrainingDataQuery('query_id');
        //Management Examples
        $CWD->listExamplesTrainingData('query_id');
        $CWD->getExampleId('query_id','document_id');
        $CWD->addExampleToTrainingData('query_id','document_id',100);
        $CWD->deleteExampleForTrainingDataQuery('query_id','document_id');
        return view('welcome');
    }
}

Version history

See the dedicated change log

License

The MIT License (MIT). Please see License File for more information.