Watson Unity SDK v2.3.0

.travis.yml

@@ -17,5 +17,5 @@ before_script:
 script:
 - ./Travis/createProject.sh
 - ./Travis/installSDK.sh
-- ./Travis/runTests.sh
-- ./Travis/build.sh
+# - ./Travis/runTests.sh
+# - ./Travis/build.sh

CHANGELOG.md

@@ -1,5 +1,12 @@
 Change Log
 ==========
+## Version 2.3.0
+_2018-05-31_
+* New: IAM support in Visual Recognition.
+* Fixed: Use non-region specific url for IamUrl.
+* Fixed: Authenticating with apikey sets the service url to `gateway-a`.
+* New: Abstract `DeleteUserData()` for Speech to Text and Text to Speech.
+
 ## Version 2.2.3
 _2018-05-21_
 * New: Abstract `DeleteUserData()` for Assistant, Conversation and Discovery ([#387](https://github.com/watson-developer-cloud/unity-sdk/pull/387)).

Doxyfile

@@ -38,7 +38,7 @@ PROJECT_NAME           = "Watson Developer Cloud Unity SDK"
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = 2.2.3
+PROJECT_NUMBER         = 2.3.0
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a

Examples/ServiceExamples/Scripts/ExampleVisualRecognition.cs

@@ -15,9 +15,9 @@
 *
 */
 //  Uncomment to train a new classifier
-//#define TRAIN_CLASSIFIER
+#define TRAIN_CLASSIFIER
 //  Uncommnent to delete the trained classifier
-//#define DELETE_TRAINED_CLASSIFIER
+#define DELETE_TRAINED_CLASSIFIER
 
 using UnityEngine;
 using System.Collections;
@@ -33,16 +33,22 @@ public class ExampleVisualRecognition : MonoBehaviour
     [SerializeField]
     private string _apikey;
     [SerializeField]
+    private string _iamApikey;
+    [SerializeField]
     private string _url;
     [SerializeField]
+    private string _iamUrl;
+    [SerializeField]
     private string _versionDate;
     #endregion
 
     private VisualRecognition _visualRecognition;
 
     private string _classifierID = "";
     private string _imageURL = "https://upload.wikimedia.org/wikipedia/commons/e/e9/Official_portrait_of_Barack_Obama.jpg";
+#if TRAIN_CLASSIFIER
     private string _coreMLDownloadPath = "";
+#endif
 
 #if DELETE_TRAINED_CLASSIFIER
     private string _classifierToDelete;
@@ -61,14 +67,41 @@ public class ExampleVisualRecognition : MonoBehaviour
     private bool _detectFacesGetTested = false;
     private bool _detectFacesPostTested = false;
     private bool _getCoreMLModelTested = false;
+    private bool _isClassifierReady = false;
 
     void Start()
     {
         LogSystem.InstallDefaultReactors();
 
-        //  Create credential and instantiate service
-        Credentials credentials = new Credentials(_apikey, _url);
 
+        Runnable.Run(CreateService());
+    }
+
+    private IEnumerator CreateService()
+    {
+        Credentials credentials = null;
+        if (!string.IsNullOrEmpty(_apikey))
+        {
+            //  Authenticate using apikey
+            credentials = new Credentials(_apikey, _url);
+        }
+        else if (!string.IsNullOrEmpty(_iamApikey))
+        {
+            //  Authenticate using iamApikey
+            TokenOptions tokenOptions = new TokenOptions()
+            {
+                IamApiKey = _iamApikey,
+                IamUrl = _iamUrl
+            };
+
+            credentials = new Credentials(tokenOptions, _url);
+
+            //  Wait for tokendata
+            while (!credentials.HasIamTokenData())
+                yield return null;
+        }
+
+        //  Create credential and instantiate service
         _visualRecognition = new VisualRecognition(credentials);
         _visualRecognition.VersionDate = _versionDate;
 
@@ -86,25 +119,25 @@ private IEnumerator Examples()
             yield return null;
 
 #if TRAIN_CLASSIFIER
-                //          Train classifier
-                Log.Debug("ExampleVisualRecognition.Examples()", "Attempting to train classifier");
-                string positiveExamplesPath = Application.dataPath + "/Watson/Examples/ServiceExamples/TestData/visual-recognition-classifiers/giraffe_positive_examples.zip";
-                string negativeExamplesPath = Application.dataPath + "/Watson/Examples/ServiceExamples/TestData/visual-recognition-classifiers/negative_examples.zip";
-                Dictionary<string, string> positiveExamples = new Dictionary<string, string>();
-                positiveExamples.Add("giraffe", positiveExamplesPath);
-                if (!_visualRecognition.TrainClassifier(OnTrainClassifier, OnFail, "unity-test-classifier-example", positiveExamples, negativeExamplesPath))
-                    Log.Debug("ExampleVisualRecognition.TrainClassifier()", "Failed to train classifier!");
-
-                while (!_trainClassifierTested)
-                    yield return null;
-
-                //          Find classifier by ID
-                Log.Debug("ExampleVisualRecognition.Examples()", "Attempting to find classifier by ID");
-                if (!_visualRecognition.GetClassifier(OnGetClassifier, OnFail, _classifierID))
-                    Log.Debug("ExampleVisualRecognition.GetClassifier()", "Failed to get classifier!");
-
-                while (!_getClassifierTested)
-                    yield return null;
+        //          Train classifier
+        Log.Debug("ExampleVisualRecognition.Examples()", "Attempting to train classifier");
+        string positiveExamplesPath = Application.dataPath + "/Watson/Examples/ServiceExamples/TestData/visual-recognition-classifiers/giraffe_positive_examples.zip";
+        string negativeExamplesPath = Application.dataPath + "/Watson/Examples/ServiceExamples/TestData/visual-recognition-classifiers/negative_examples.zip";
+        Dictionary<string, string> positiveExamples = new Dictionary<string, string>();
+        positiveExamples.Add("giraffe", positiveExamplesPath);
+        if (!_visualRecognition.TrainClassifier(OnTrainClassifier, OnFail, "unity-test-classifier-example", positiveExamples, negativeExamplesPath))
+            Log.Debug("ExampleVisualRecognition.TrainClassifier()", "Failed to train classifier!");
+
+        while (!_trainClassifierTested)
+            yield return null;
+
+        //          Find classifier by ID
+        Log.Debug("ExampleVisualRecognition.Examples()", "Attempting to find classifier by ID");
+        if (!_visualRecognition.GetClassifier(OnGetClassifier, OnFail, _classifierID))
+            Log.Debug("ExampleVisualRecognition.GetClassifier()", "Failed to get classifier!");
+
+        while (!_getClassifierTested)
+            yield return null;
 #endif
 
         //          Classify get
@@ -144,34 +177,35 @@ private IEnumerator Examples()
             yield return null;
 
 #if DELETE_TRAINED_CLASSIFIER
-        #region Delay
-                Runnable.Run(Delay(_delayTime));
-                while (_isWaitingForDelay)
-                    yield return null;
-        #endregion
-
-                //          Delete classifier by ID
-                Log.Debug("ExampleVisualRecognition.Examples()", "Attempting to delete classifier");
-                if (!_visualRecognition.DeleteClassifier(OnDeleteClassifier, OnFail, _classifierToDelete))
-                    Log.Debug("ExampleVisualRecognition.DeleteClassifier()", "Failed to delete classifier!");
-
-                while (!_deleteClassifierTested)
-                    yield return null;
-#endif
+        Runnable.Run(IsClassifierReady(_classifierToDelete));
+        while (!_isClassifierReady)
+            yield return null;
 
-        _visualRecognition.DownloadCoreMLModel(_classifierID, _coreMLDownloadPath);
+        //  Download Core ML Model
+        Log.Debug("ExampleVisualRecognition.RunTest()", "Attempting to get Core ML Model");
+        if (!_visualRecognition.GetCoreMLModel(OnGetCoreMLModel, OnFail, _classifierID))
+            Log.Debug("TestVisualRecognition.GetCoreMLModel()", "Failed to get core ml model!");
         while (!_getCoreMLModelTested)
             yield return null;
 
+        //          Delete classifier by ID
+        Log.Debug("ExampleVisualRecognition.Examples()", "Attempting to delete classifier");
+        if (!_visualRecognition.DeleteClassifier(OnDeleteClassifier, OnFail, _classifierToDelete))
+            Log.Debug("ExampleVisualRecognition.DeleteClassifier()", "Failed to delete classifier!");
+
+        while (!_deleteClassifierTested)
+            yield return null;
+#endif
+
         Log.Debug("ExampleVisualRecognition.Examples()", "Visual Recogition tests complete");
     }
 
-private void OnGetClassifiers(ClassifiersBrief classifiers, Dictionary<string, object> customData)
-{
-    Log.Debug("ExampleVisualRecognition.OnGetClassifiers()", "VisualRecognition - GetClassifiers Response: {0}", customData["json"].ToString());
+    private void OnGetClassifiers(ClassifiersBrief classifiers, Dictionary<string, object> customData)
+    {
+        Log.Debug("ExampleVisualRecognition.OnGetClassifiers()", "VisualRecognition - GetClassifiers Response: {0}", customData["json"].ToString());
 
-    _getClassifiersTested = true;
-}
+        _getClassifiersTested = true;
+    }
 
 #if DELETE_TRAINED_CLASSIFIER
     private void OnGetClassifier(ClassifierVerbose classifier, Dictionary<string, object> customData)
@@ -202,51 +236,79 @@ private void OnTrainClassifier(ClassifierVerbose classifier, Dictionary<string,
     }
 #endif
 
-private void OnClassifyGet(ClassifiedImages classify, Dictionary<string, object> customData)
-{
-    Log.Debug("ExampleVisualRecognition.OnClassifyGet()", "{0}", customData["json"].ToString());
-    _classifyGetTested = true;
+    private void OnClassifyGet(ClassifiedImages classify, Dictionary<string, object> customData)
+    {
+        Log.Debug("ExampleVisualRecognition.OnClassifyGet()", "{0}", customData["json"].ToString());
+        _classifyGetTested = true;
 
-}
+    }
 
-private void OnClassifyPost(ClassifiedImages classify, Dictionary<string, object> customData)
-{
-    Log.Debug("ExampleVisualRecognition.OnClassifyPost()", "{0}", customData["json"].ToString());
-    _classifyPostTested = true;
-}
+    private void OnClassifyPost(ClassifiedImages classify, Dictionary<string, object> customData)
+    {
+        Log.Debug("ExampleVisualRecognition.OnClassifyPost()", "{0}", customData["json"].ToString());
+        _classifyPostTested = true;
+    }
 
-private void OnDetectFacesGet(DetectedFaces multipleImages, Dictionary<string, object> customData)
-{
-    Log.Debug("ExampleVisualRecognition.OnDetectFacesGet()", "{0}", customData["json"].ToString());
-    _detectFacesGetTested = true;
-}
+    private void OnDetectFacesGet(DetectedFaces multipleImages, Dictionary<string, object> customData)
+    {
+        Log.Debug("ExampleVisualRecognition.OnDetectFacesGet()", "{0}", customData["json"].ToString());
+        _detectFacesGetTested = true;
+    }
 
-private void OnDetectFacesPost(DetectedFaces multipleImages, Dictionary<string, object> customData)
-{
-    Log.Debug("ExampleVisualRecognition.OnDetectFacesPost()", "{0}", customData["json"].ToString());
-    _detectFacesPostTested = true;
-}
+    private void OnDetectFacesPost(DetectedFaces multipleImages, Dictionary<string, object> customData)
+    {
+        Log.Debug("ExampleVisualRecognition.OnDetectFacesPost()", "{0}", customData["json"].ToString());
+        _detectFacesPostTested = true;
+    }
+
+#if DELETE_TRAINED_CLASSIFIER
+    private void OnGetCoreMLModel(byte[] resp, Dictionary<string, object> customData)
+    {
+        Log.Debug("ExampleVisualRecognition.OnGetCoreMLModel()", "SUCCESS!");
+        _getCoreMLModelTested = true;
+    }
+#endif
 
-#region Delay
-//  Introducing a delay because of a known issue with Visual Recognition where newly created classifiers 
-//  will disappear without being deleted if a delete is attempted less than ~10 seconds after creation.
 #if DELETE_TRAINED_CLASSIFIER
-    private float _delayTime = 15f;
-    private bool _isWaitingForDelay = false;
+    #region Is Classifier Ready
+    //  Checking if classifier is ready before deletion due to a known bug in the Visual Recognition service where
+    //  if a classifier is deleted before it is `ready` or `failed` the classifier will still exist in object storage
+    //  but will be inaccessable to the user.
+    private IEnumerator IsClassifierReady(string classifierId)
+    {
+        Log.Debug("TestVisualRecognition.IsClassifierReady()", "Checking if classifier is ready in 15 seconds...");
+
+        yield return new WaitForSeconds(15f);
+
+        Dictionary<string, object> customData = new Dictionary<string, object>();
+        customData.Add("classifierId", classifierId);
+        if (!_visualRecognition.GetClassifier(OnCheckIfClassifierIsReady, OnFailCheckingIfClassifierIsReady, classifierId))
+            IsClassifierReady(classifierId);
+    }
+
+    private void OnCheckIfClassifierIsReady(ClassifierVerbose response, Dictionary<string, object> customData)
+    {
+        Log.Debug("TestVisualRecognition.IsClassifierReady()", "Classifier status is {0}", response.status);
 
+        if (response.status == "ready" || response.status == "failed")
+        {
+            _isClassifierReady = true;
+        }
+        else
+        {
 
-    private IEnumerator Delay(float delayTime)
+            Runnable.Run(IsClassifierReady(response.classifier_id));
+        }
+    }
+    private void OnFailCheckingIfClassifierIsReady(RESTConnector.Error error, Dictionary<string, object> customData)
     {
-        _isWaitingForDelay = true;
-        Log.Debug("ExampleVisualRecognition.Delay()", "Delaying for {0} seconds....", delayTime);
-        yield return new WaitForSeconds(delayTime);
-        _isWaitingForDelay = false;
+        IsClassifierReady(_classifierToDelete);
     }
+    #endregion
 #endif
-#endregion
 
-private void OnFail(RESTConnector.Error error, Dictionary<string, object> customData)
-{
-    Log.Error("ExampleRetrieveAndRank.OnFail()", "Error received: {0}", error.ToString());
-}
+    private void OnFail(RESTConnector.Error error, Dictionary<string, object> customData)
+    {
+        Log.Error("ExampleRetrieveAndRank.OnFail()", "Error received: {0}", error.ToString());
+    }
 }

README.md

@@ -109,7 +109,9 @@ void IEnumerator TokenExample()
     //  Alternatively you can supply an access token.
     TokenOptions iamTokenOptions = new TokenOptions()
     {
-        IamApiKey = "<iam-api-key>"
+        IamApiKey = "<iam-api-key>",
+        IamAccessToken = "<iam-access-token>",
+        IamUrl = "<service-url>"
     };
 
     //  Create credentials using the IAM token options