watson_assistant 0.0.3

  • README.md
  • CHANGELOG.md
  • Example
  • Installing
  • Versions
  • 70

watson_assistant #

Unofficial implementation of IBM Watson Assistant API for Flutter.

Usage #

To use this plugin, add watson_assistant as a dependency in your pubspec.yaml file.

Example #

import 'package:watson_assistant/watson_assistant.dart';
/* add async in your function */

WatsonAssistantCredential credential = WatsonAssistantCredential(username: [USERNAME], password: [PASSWORD], workspaceId: [WORKSPACEID]);

WatsonAssistantApiV1 watsonAssistant = WatsonAssistantApiV1(watsonAssistantCredential: credential);

WatsonAssistantContext watsonAssistantContext =WatsonAssistantContext(context: {});

WatsonAssistantResult watsonAssistantResponse;

/*First interaction*/
watsonAssistantResponse = await watsonAssistant.sendMessage("Hello", watsonAssistantContext);  // context of the conversation initially void

watsonAssistantContext = watsonAssistantResponse.context;        // to store the progress of the conversation
print(watsonAssistantResponse.resultText);                       // -->  "Hi i'm Watson Assistant!"

/*Second interaction*/
watsonAssistantResponse = await watsonAssistant.sendMessage("what's the weather tomorrow?", watsonAssistantContext);

watsonAssistantContext = watsonAssistantResponse.context;        // to store the progress of the conversation
print(watsonAssistantResponse.resultText);                       // -->  "It will be sunny tomorrow"



/*Reset the context*/
watsonAssistantContext.resetContext();

[0.0.3] - march 2019

  • Update README

[0.0.2] - march 2019

  • Add Example Project

[0.0.1] - 26 december 2018

  • Add Watson assistant V1

example/README.md

watson_assistant #

Unofficial implementation of IBM Watson Assistant API for Flutter.

Usage #

To use this plugin, add watson_assistant as a dependency in your pubspec.yaml file.

Example #

import 'package:flutter/material.dart';
import 'package:watson_assistant/watson_assistant.dart';

void main() => runApp(MyApp());

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: MyHomePage(title: 'Watson Assistant Example'),
    );
  }
}

class MyHomePage extends StatefulWidget {
  MyHomePage({Key key, this.title}) : super(key: key);

  final String title;

  @override
  _MyHomePageState createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  String _text;
  WatsonAssistantCredential credential = WatsonAssistantCredential(
      username: "YOUR USERNAME",
      password: "YOUR PASSWORD",
      workspaceId: "YOUR WORKSPACE ID");

  WatsonAssistantApiV1 watsonAssistant;
  WatsonAssistantResult watsonAssistantResponse;
  WatsonAssistantContext watsonAssistantContext =
      WatsonAssistantContext(context: {});

  final myController = TextEditingController();

  void _callWatsonAssistant() async {
    watsonAssistantResponse = await watsonAssistant.sendMessage(
        myController.text, watsonAssistantContext);
    setState(() {
      _text = watsonAssistantResponse.resultText;
    });
    watsonAssistantContext = watsonAssistantResponse.context;
    myController.clear();
  }

  @override
  void initState() {
    super.initState();
    watsonAssistant =
        WatsonAssistantApiV1(watsonAssistantCredential: credential);
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
        actions: <Widget>[
          IconButton(
            icon: Icon(
              Icons.restore,
            ),
            onPressed: () {
              watsonAssistantContext.resetContext();
              setState(() {
                _text = null;
              });
            },
          )
        ],
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            TextField(
              controller: myController,
            ),
            Text(
              _text != null ? '$_text' : 'Watson Response Here',
              style: Theme.of(context).textTheme.display1,
            ),
          ],
        ),
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: _callWatsonAssistant,
        child: Icon(Icons.send),
      ),
    );
  }

  @override
  void dispose() {
    myController.dispose();
    super.dispose();
  }
}

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  watson_assistant: ^0.0.3

2. Install it

You can install packages from the command line:

with Flutter:


$ flutter packages get

Alternatively, your editor might support flutter packages get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:watson_assistant/watson_assistant.dart';
  
Version Uploaded Documentation Archive
0.0.3 Mar 16, 2019 Go to the documentation of watson_assistant 0.0.3 Download watson_assistant 0.0.3 archive
0.0.2 Mar 16, 2019 Go to the documentation of watson_assistant 0.0.2 Download watson_assistant 0.0.2 archive
0.0.1 Dec 26, 2018 Go to the documentation of watson_assistant 0.0.1 Download watson_assistant 0.0.1 archive
Popularity:
Describes how popular the package is relative to other packages. [more]
46
Health:
Code health derived from static analysis. [more]
99
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
90
Overall:
Weighted score of the above. [more]
70
Learn more about scoring.

We analyzed this package on Apr 22, 2019, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.2.0
  • pana: 0.12.14
  • Flutter: 1.4.7

Platforms

Detected platforms: Flutter

References Flutter, and has no conflicting libraries.

Health issues and suggestions

Document public APIs. (-1 points)

29 out of 29 API elements have no dartdoc comment.Providing good documentation for libraries, classes, functions, and other API elements improves code readability and helps developers find and use your API.

Fix lib/watson_assistant.dart. (-0.50 points)

Analysis of lib/watson_assistant.dart reported 1 hint:

line 48 col 3: The class 'Future' was not exported from 'dart:core' until version 2.1, but this code is required to be able to run on earlier versions.

Maintenance suggestions

Package is pre-v0.1 release. (-10 points)

While nothing is inherently wrong with versions of 0.0.*, it might mean that the author is still experimenting with the general direction of the API.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.0.0-dev.68.0 <3.0.0
flutter 0.0.0
http ^0.12.0 0.12.0+2
Transitive dependencies
async 2.2.0
charcode 1.1.2
collection 1.14.11
http_parser 3.1.3
meta 1.1.6 1.1.7
path 1.6.2
pedantic 1.5.0
sky_engine 0.0.99
source_span 1.5.5
string_scanner 1.0.4
term_glyph 1.1.0
typed_data 1.1.6
vector_math 2.0.8
Dev dependencies
flutter_test