Merge pull request #304 from watson-developer-cloud/master

Pull release changes from Master

Author: mediumTaj

CHANGELOG.md

@@ -1,5 +1,24 @@
 Change Log
 ==========
+## Version 2.0.0
+_2017-11-20_ MAJOR RELEASE, BREAKING CHANGES
+* New: Implemented error callbacks in each call
+* New: Implemented generic type success callbacks
+* New: Implemented `Dictionary<string, object>` to hold custom data for each call
+* New: Support for `Hololens`
+* New: Abstracted custom acoustic models for `SpeechToText`
+* New: Addition of streaming example where the sample is split up to improve latency
+* New: Transition to dll for `WebSocketSharp`
+* New: Added support for decoding unicode characters in `TextToSpeech`
+* Fixed: Transition `Delete` methods to `UnityWebRequest`
+* Fixed: Improvements to `SpeechToText` streaming
+* Fixed: `SpeechToText` streaming parameters
+* Fixed: Improvements to `ExampleStreaming`
+* Fixed: `SpeechToText` custom corpus
+* Fixed: Allow empty string to be sent when invoking `Message` from the `Conversation` service
+* Fixed: Standardized `Debug.Log` output throughout SDK
+* Fixed: Fix all integration tests
+
 ## Version 1.0.0
 _2017-08-31_ MAJOR RELEASE, BREAKING CHANGES
 

Docs/UnitySDK.shfbproj

@@ -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         = 1.0.0
+PROJECT_NUMBER         = 2.0.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

Docs/UnitySDK.shfbproj.meta

@@ -24,20 +24,26 @@
 using System.Collections.Generic;
 using UnityEngine.UI;
 
+/// <summary>
+/// This class is an example of how to stream audio from the device microphone to the Speech to Text service in Unity.
+/// </summary>
 public class ExampleStreamingSplitSamples : MonoBehaviour
 {
     private string _username = null;
     private string _password = null;
     private string _url = null;
 
+    /// <summary>
+    /// Text field to display the results of streaming.
+    /// </summary>
     public Text ResultsField;
 
     private int _recordingRoutine = 0;
     private string _microphoneID = null;
     private AudioClip _recording = null;
     private int _recordingBufferSize = 1;
     private int _recordingHZ = 22050;
-	private int _sampleSegments = 50;
+    private int _sampleSegments = 50;
 
     private SpeechToText _speechToText;
 
@@ -54,6 +60,9 @@ void Start()
         StartRecording();
     }
 
+    /// <summary>
+    /// Gets or sets the Active state.
+    /// </summary>
     public bool Active
     {
         get { return _speechToText.IsListening; }
@@ -105,12 +114,12 @@ private void OnError(string error)
     {
         Active = false;
 
-		Log.Debug("ExampleStreamingSplitSamples.OnError()", "Error! {0}", error);
+        Log.Debug("ExampleStreamingSplitSamples.OnError()", "Error! {0}", error);
     }
 
     private IEnumerator RecordingHandler()
     {
-		Log.Debug("ExampleStreamingSplitSamples.RecordingHandler()", "devices: {0}", Microphone.devices);
+        Log.Debug("ExampleStreamingSplitSamples.RecordingHandler()", "devices: {0}", Microphone.devices);
         //  Start recording
         _recording = Microphone.Start(_microphoneID, true, _recordingBufferSize, _recordingHZ);
         yield return null;
@@ -127,82 +136,82 @@ private IEnumerator RecordingHandler()
 #endif
 
         //  Current sample segment number
-		int sampleSegmentNum = 0;
+        int sampleSegmentNum = 0;
 
         //  Size of the sample segment in samples
-		int sampleSegmentSize = _recording.samples / _sampleSegments;
+        int sampleSegmentSize = _recording.samples / _sampleSegments;
 
         //  Init samples
         float[] samples = null;
 
-		while (_recordingRoutine != 0 && _recording != null)
-		{
-			//  Get the mic position
-			int microphonePosition = Microphone.GetPosition(_microphoneID);
-			if (microphonePosition > _recording.samples || !Microphone.IsRecording(_microphoneID))
-			{
-				Log.Error("ExampleStreamingSplitSamples.RecordingHandler()", "Microphone disconnected.");
-
-				StopRecording();
-				yield break;
-			}
-
-			int sampleStart = sampleSegmentSize * sampleSegmentNum;
-			int sampleEnd = sampleSegmentSize * (sampleSegmentNum + 1);
-
-			#if ENABLE_DEBUGGING
-			Log.Debug("ExampleStreamingSplitSamples.RecordinHandler", "microphonePosition: {0} | sampleStart: {1} | sampleEnd: {2} | sampleSegmentNum: {3}",
-			microphonePosition.ToString(),
-			sampleStart.ToString(),
-			sampleEnd.ToString(),
-			sampleSegmentNum.ToString());
-			#endif
-			//If the write position is past the end of the sample segment or if write position is before the start of the sample segment
-			while (microphonePosition > sampleEnd || microphonePosition < sampleStart)
-			{
-				//  Init samples
-				samples = new float[sampleSegmentSize];
-				//  Write data from recording into samples starting from the sampleSegmentStart
-				_recording.GetData(samples, sampleStart);
-
-				//  Create AudioData and use the samples we just created
-				AudioData record = new AudioData();
-				record.MaxLevel = Mathf.Max(Mathf.Abs(Mathf.Min(samples)), Mathf.Max(samples));
-				record.Clip = AudioClip.Create("Recording", sampleSegmentSize, _recording.channels, _recordingHZ, false);
-				record.Clip.SetData(samples, 0);
-
-				//  Send the newly created AudioData to the service
-				_speechToText.OnListen(record);
-
-				//  Iterate or reset sampleSegmentNum
-				if (sampleSegmentNum < _sampleSegments - 1)
-				{
-					sampleSegmentNum++;
-					#if ENABLE_DEBUGGING
-					Log.Debug("ExampleStreamingSplitSamples.RecordingHandler()", "Iterating sampleSegmentNum: {0}", sampleSegmentNum);
-					#endif
-				}
-				else
-				{
-					sampleSegmentNum = 0;
-					#if ENABLE_DEBUGGING
-					Log.Debug("ExampleStreamingSplitSamples.RecordingHandler()", "Resetting sampleSegmentNum: {0}", sampleSegmentNum);
-					#endif
-				}
-
-				#if ENABLE_TIME_LOGGING
-				Log.Debug("ExampleStreamingSplitSamples.RecordingHandler", "Sending data - time since last transmission: {0} ms", Mathf.Floor((float)(DateTime.Now - now).TotalMilliseconds));
-				now = DateTime.Now;
-				#endif
-				sampleStart = sampleSegmentSize * sampleSegmentNum;
-				sampleEnd = sampleSegmentSize * (sampleSegmentNum + 1);
-			}
-
-			yield return 0;
-		}
-
-		yield break;
-	}
+        while (_recordingRoutine != 0 && _recording != null)
+        {
+            //  Get the mic position
+            int microphonePosition = Microphone.GetPosition(_microphoneID);
+            if (microphonePosition > _recording.samples || !Microphone.IsRecording(_microphoneID))
+            {
+                Log.Error("ExampleStreamingSplitSamples.RecordingHandler()", "Microphone disconnected.");
+
+                StopRecording();
+                yield break;
+            }
+
+            int sampleStart = sampleSegmentSize * sampleSegmentNum;
+            int sampleEnd = sampleSegmentSize * (sampleSegmentNum + 1);
+
+#if ENABLE_DEBUGGING
+            Log.Debug("ExampleStreamingSplitSamples.RecordinHandler", "microphonePosition: {0} | sampleStart: {1} | sampleEnd: {2} | sampleSegmentNum: {3}",
+            microphonePosition.ToString(),
+            sampleStart.ToString(),
+            sampleEnd.ToString(),
+            sampleSegmentNum.ToString());
+#endif
+            //If the write position is past the end of the sample segment or if write position is before the start of the sample segment
+            while (microphonePosition > sampleEnd || microphonePosition < sampleStart)
+            {
+                //  Init samples
+                samples = new float[sampleSegmentSize];
+                //  Write data from recording into samples starting from the sampleSegmentStart
+                _recording.GetData(samples, sampleStart);
+
+                //  Create AudioData and use the samples we just created
+                AudioData record = new AudioData();
+                record.MaxLevel = Mathf.Max(Mathf.Abs(Mathf.Min(samples)), Mathf.Max(samples));
+                record.Clip = AudioClip.Create("Recording", sampleSegmentSize, _recording.channels, _recordingHZ, false);
+                record.Clip.SetData(samples, 0);
+
+                //  Send the newly created AudioData to the service
+                _speechToText.OnListen(record);
+
+                //  Iterate or reset sampleSegmentNum
+                if (sampleSegmentNum < _sampleSegments - 1)
+                {
+                    sampleSegmentNum++;
+#if ENABLE_DEBUGGING
+                    Log.Debug("ExampleStreamingSplitSamples.RecordingHandler()", "Iterating sampleSegmentNum: {0}", sampleSegmentNum);
+#endif
+                }
+                else
+                {
+                    sampleSegmentNum = 0;
+#if ENABLE_DEBUGGING
+                    Log.Debug("ExampleStreamingSplitSamples.RecordingHandler()", "Resetting sampleSegmentNum: {0}", sampleSegmentNum);
+#endif
+                }
+
+#if ENABLE_TIME_LOGGING
+                Log.Debug("ExampleStreamingSplitSamples.RecordingHandler", "Sending data - time since last transmission: {0} ms", Mathf.Floor((float)(DateTime.Now - now).TotalMilliseconds));
+                now = DateTime.Now;
+#endif
+                sampleStart = sampleSegmentSize * sampleSegmentNum;
+                sampleEnd = sampleSegmentSize * (sampleSegmentNum + 1);
+            }
+
+            yield return 0;
+        }
+
+        yield break;
+    }
 
     private void OnRecognize(SpeechRecognitionEvent result)
     {
@@ -213,25 +222,25 @@ private void OnRecognize(SpeechRecognitionEvent result)
                 foreach (var alt in res.alternatives)
                 {
                     string text = string.Format("{0} ({1}, {2:0.00})\n", alt.transcript, res.final ? "Final" : "Interim", alt.confidence);
-					Log.Debug("ExampleStreamingSplitSamples.OnRecognize()", text);
+                    Log.Debug("ExampleStreamingSplitSamples.OnRecognize()", text);
                     ResultsField.text = text;
                 }
 
                 if (res.keywords_result != null && res.keywords_result.keyword != null)
                 {
                     foreach (var keyword in res.keywords_result.keyword)
                     {
-						Log.Debug("ExampleStreamingSplitSamples.OnRecognize", "keyword: {0}, confidence: {1}, start time: {2}, end time: {3}", keyword.normalized_text, keyword.confidence, keyword.start_time, keyword.end_time);
+                        Log.Debug("ExampleStreamingSplitSamples.OnRecognize", "keyword: {0}, confidence: {1}, start time: {2}, end time: {3}", keyword.normalized_text, keyword.confidence, keyword.start_time, keyword.end_time);
                     }
                 }
 
                 if (res.word_alternatives != null)
                 {
                     foreach (var wordAlternative in res.word_alternatives)
                     {
-						Log.Debug("ExampleStreamingSplitSamples.OnRecognize()", "Word alternatives found. Start time: {0} | EndTime: {1}", wordAlternative.start_time, wordAlternative.end_time);
+                        Log.Debug("ExampleStreamingSplitSamples.OnRecognize()", "Word alternatives found. Start time: {0} | EndTime: {1}", wordAlternative.start_time, wordAlternative.end_time);
                         foreach (var alternative in wordAlternative.alternatives)
-							Log.Debug("ExampleStreamingSplitSamples.OnRecognie()", "\t word: {0} | confidence: {1}", alternative.word, alternative.confidence);
+                            Log.Debug("ExampleStreamingSplitSamples.OnRecognie()", "\t word: {0} | confidence: {1}", alternative.word, alternative.confidence);
                     }
                 }
             }
@@ -244,7 +253,7 @@ private void OnRecognizeSpeaker(SpeakerRecognitionEvent result)
         {
             foreach (SpeakerLabelsResult labelResult in result.speaker_labels)
             {
-				Log.Debug("ExampleStreamingSplitSamples.OnRecongizeSpeaker()", string.Format("speaker result: {0} | confidence: {3} | from: {1} | to: {2}", labelResult.speaker, labelResult.from, labelResult.to, labelResult.confidence));
+                Log.Debug("ExampleStreamingSplitSamples.OnRecongizeSpeaker()", string.Format("speaker result: {0} | confidence: {3} | from: {1} | to: {2}", labelResult.speaker, labelResult.from, labelResult.to, labelResult.confidence));
             }
         }
     }

Docs/Watson Unity SDK.odg

@@ -185,7 +185,7 @@ public static string FixupURL(string URL)
         /// <summary>
         /// Create a WSConnector for the given service and function. 
         /// </summary>
-        /// <param name="serviceID">The ID of the service.</param>
+        /// <param name="credentials">The credentials for the service.</param>
         /// <param name="function">The name of the function to connect.</param>
         /// <param name="args">Additional function arguments.</param>
         /// <returns>The WSConnector object or null or error.</returns>

Docs/Watson Unity SDK.odg.meta

@@ -87,6 +87,10 @@ public Credentials Credentials
         #endregion
 
         #region Constructor
+        /// <summary>
+        /// Conversation constructor
+        /// </summary>
+        /// <param name="credentials">The service credentials</param>
         public Conversation(Credentials credentials)
         {
             if (credentials.HasCredentials() || credentials.HasAuthorizationToken())

Doxyfile

@@ -96,6 +96,10 @@ public Credentials Credentials
         #endregion
 
         #region Constructor
+        /// <summary>
+        /// Discovery constructor.
+        /// </summary>
+        /// <param name="credentials">The service credentials.</param>
         public Discovery(Credentials credentials)
         {
             if (credentials.HasCredentials() || credentials.HasAuthorizationToken())
@@ -1714,7 +1718,7 @@ private void OnGetFieldsResponse(RESTConnector.Request req, RESTConnector.Respon
         /// <param name="environmentID">The environment identifier.</param>
         /// <param name="collectionID">The collection identifier.</param>
         /// <param name="contentData">A byte array of content to be ingested.</param>
-        /// <param name="contentMimeType">The mimeType of the content data to be ingested./param>
+        /// <param name="contentMimeType">The mimeType of the content data to be ingested.</param>
         /// <param name="configurationFilePath">The file path to the configuration to use to process the document.</param>
         /// <param name="metadata">If you're using the Data Crawler to upload your documents, you can test a document against the type 
         /// of metadata that the Data Crawler might send. The maximum supported metadata file size is 1 MB. Metadata parts larger than 
@@ -1766,12 +1770,12 @@ private void OnGetFieldsResponse(RESTConnector.Request req, RESTConnector.Respon
         /// <param name="environmentID">The environment identifier.</param>
         /// <param name="collectionID">The collection identifier.</param>
         /// <param name="contentData">A byte array of content to be ingested.</param>
-        /// <param name="contentMimeType">The mimeType of the content data to be ingested./param>
+        /// <param name="contentMimeType">The mimeType of the content data to be ingested.</param>
         /// <param name="configurationID">The configuration identifier. If this is specified, do not specify a configuration.</param>
         /// <param name="configuration">A json string of the configuration to test. If this is specified, do not specify a configurationID.</param>
-        /// <param name="metadata">If you're using the Data Crawler to upload your documents, you can test a document against the type 
-        /// of metadata that the Data Crawler might send. The maximum supported metadata file size is 1 MB. Metadata parts larger than 
-        /// 1 MB are rejected. Example: { "Creator": "Johnny Appleseed", "Subject": "Apples" }</param>
+        /// <param name="metadata">If you're using the Data Crawler to upload your documents, you can test a document against the type of metadata 
+        /// that the Data Crawler might send. The maximum supported metadata file size is 1 MB. Metadata parts larger than 1 MB are rejected. 
+        /// Example: { "Creator": "Johnny Appleseed", "Subject": "Apples" }</param>
         /// <param name="customData">Optional custom data.</param>
         /// <returns>True if the call succeeds, false if the call is unsuccessful.</returns>
         public bool AddDocument(SuccessCallback<DocumentAccepted> successCallback, FailCallback failCallback, string environmentID, string collectionID, byte[] contentData, string contentMimeType, string configurationID = default(string), string configuration = default(string), string metadata = default(string), Dictionary<string, object> customData = null)
@@ -2136,7 +2140,7 @@ private void OnGetDocumentResponse(RESTConnector.Request req, RESTConnector.Resp
         /// <param name="collectionID">The collection identifier.</param>
         /// <param name="documentID">The document identifier.</param>
         /// <param name="contentData">A byte array of content to be ingested.</param>
-        /// <param name="contentMimeType">The mimeType of the content data to be ingested./param>
+        /// <param name="contentMimeType">The mimeType of the content data to be ingested.</param>
         /// <param name="configurationID">The identifier of the configuration to use to process the document.</param>
         /// <param name="metadata">If you're using the Data Crawler to upload your documents, you can test a document against the type 
         /// of metadata that the Data Crawler might send. The maximum supported metadata file size is 1 MB. Metadata parts larger than 
@@ -2174,7 +2178,7 @@ private void OnGetDocumentResponse(RESTConnector.Request req, RESTConnector.Resp
         /// <param name="collectionID">The collection identifier.</param>
         /// <param name="documentID">The document identifier.</param>
         /// <param name="contentData">A byte array of content to be ingested.</param>
-        /// <param name="contentMimeType">The mimeType of the content data to be ingested./param>
+        /// <param name="contentMimeType">The mimeType of the content data to be ingested.</param>
         /// <param name="configurationFilePath">The file path to the configuration to use to process</param>
         /// <param name="metadata">If you're using the Data Crawler to upload your documents, you can test a document against the type 
         /// of metadata that the Data Crawler might send. The maximum supported metadata file size is 1 MB. Metadata parts larger than 

Examples/ServiceExamples/Scripts/ExampleStreamingSplitSamples.cs

@@ -178,7 +178,7 @@ public class Warning
         public string warning_id { get; set; }
         /// <summary>
         /// The message associated with the `warning_id`. For `WORD_COUNT_MESSAGE`, "There were 
-        /// <number> words in the input. We need a minimum of 600, preferably 1,200 or more, to 
+        /// &gt;number&lt; words in the input. We need a minimum of 600, preferably 1,200 or more, to 
         /// compute statistically significant estimates."; for `JSON_AS_TEXT`, "Request input
         /// was processed as text/plain as indicated, however detected a JSON input. Did you 
         /// mean application/json?"; and for `PARTIAL_TEXT_USED`, "The text provided to compute the