Merge pull request #90 from watson-developer-cloud/gh-13-abstractSpeechToText

Gh 13 abstract speech to text

Author: mediumTaj

IBM.WatsonDeveloperCloud.sln

@@ -234,7 +234,7 @@ Global
 	EndGlobalSection
 	GlobalSection(NestedProjects) = preSolution
 		{1A587AA2-5F1B-4A6C-B084-57DC46019668} = {FF4673C9-CB33-4D4F-9116-776A792A2189}
-		{4A6D2C37-7500-4E47-A4DA-849B25E5F24D} = {28E61676-E9FF-4DA9-99CC-5E0D16F02380}
+		{4A6D2C37-7500-4E47-A4DA-849B25E5F24D} = {BE946662-3884-45E9-A3B1-B28F3081AD1B}
 		{423DC6CA-8FF9-48D3-9B9D-B2D3B9DCFFD4} = {4A6D2C37-7500-4E47-A4DA-849B25E5F24D}
 		{254924C9-64CD-4902-97C4-5F9E48DCDF7F} = {28E61676-E9FF-4DA9-99CC-5E0D16F02380}
 		{B8A228E3-E05B-451B-8504-7BB9ED05E1B3} = {254924C9-64CD-4902-97C4-5F9E48DCDF7F}

examples/IBM.WatsonDeveloperCloud.SpeechToText.Example/SpeechToTextServiceExample.cs

@@ -17,6 +17,7 @@
 
 using IBM.WatsonDeveloperCloud.SpeechToText.v1;
 using IBM.WatsonDeveloperCloud.SpeechToText.v1.Model;
+using IBM.WatsonDeveloperCloud.SpeechToText.v1.Util;
 using System;
 using System.IO;
 
@@ -110,7 +111,8 @@ private void Recognize()
             using (FileStream fs = File.OpenRead(_path))
             {
                 Console.WriteLine("Calling Recognize...");
-                var speechEvent = _speechToText.Recognize(fs);
+                var speechEvent = _speechToText.Recognize(fs.GetMediaTypeFromFile(),
+                                                          fs);
 
                 Console.WriteLine("speechEvent received...");
                 if (speechEvent.Results != null || speechEvent.Results.Count > 0)

src/IBM.WatsonDeveloperCloud.SpeechToText/README.md

@@ -60,12 +60,12 @@ Retrieves information about a single specified model that is available for use w
 var results = _speechToText.GetModel("<model-name>");
 ```
 
-<!-- #### Recognize audio via websockets
+#### Recognize audio via websockets
 Sends audio and returns transcription results for recognition requests over a WebSocket connection. Requests and responses are enabled over a single TCP connection that abstracts much of the complexity of the request to offer efficient implementation, low latency, high throughput, and an asynchronous response. By default, only final results are returned for any request; to enable interim results, set the interim_results parameter to true.
 
 The service imposes a data size limit of 100 MB per connection. It automatically detects the endianness of the incoming audio and, for audio that includes multiple channels, downmixes the audio to one-channel mono during transcoding.
 ```cs
-``` -->
+```
 
 #### Recognize audio via file
 Sends audio and returns transcription results for a sessionless recognition request. Returns only the final results.

src/IBM.WatsonDeveloperCloud.SpeechToText/v1/ISpeechToTextService.cs

@@ -0,0 +1,32 @@
+/**
+* Copyright 2017 IBM Corp. All Rights Reserved.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*      http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*
+*/
+
+using Newtonsoft.Json;
+using System.Collections.Generic;
+
+namespace IBM.WatsonDeveloperCloud.SpeechToText.v1.Model
+{
+    public class Corpora
+    {
+        /// <summary>
+        /// Gets or sets information about corpora of the custom model. The
+        /// array is empty if the custom model has no corpora.
+        /// </summary>
+        [JsonProperty(PropertyName = "corpora")]
+        public IList<Corpus> CorporaProperty { get; set; }
+    }
+}

src/IBM.WatsonDeveloperCloud.SpeechToText/v1/Model/Corpora.cs

@@ -0,0 +1,66 @@
+/**
+* Copyright 2017 IBM Corp. All Rights Reserved.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*      http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*
+*/
+
+using Newtonsoft.Json;
+
+namespace IBM.WatsonDeveloperCloud.SpeechToText.v1.Model
+{
+    public class Corpus
+    {
+        /// <summary>
+        /// Gets or sets the name of the corpus.
+        /// </summary>
+        [JsonProperty(PropertyName = "name")]
+        public string Name { get; set; }
+
+        /// <summary>
+        /// Gets or sets the total number of words in the corpus. The value is
+        /// `0` while the corpus is being processed.
+        /// </summary>
+        [JsonProperty(PropertyName = "total_words")]
+        public int TotalWords { get; set; }
+
+        /// <summary>
+        /// Gets or sets the number of OOV words in the corpus. The value is
+        /// `0` while the corpus is being processed.
+        /// </summary>
+        [JsonProperty(PropertyName = "out_of_vocabulary_words")]
+        public int OutOfVocabularyWords { get; set; }
+
+        /// <summary>
+        /// Gets or sets the status of the corpus: `analyzed` indicates that
+        /// the service has successfully analyzed the corpus; the custom
+        /// model can be trained with data from the corpus. `being_processed`
+        /// indicates that the service is still analyzing the corpus; the
+        /// service cannot accept requests to add new corpora or words, or to
+        /// train the custom model. `undetermined` indicates that the service
+        /// encountered an error while processing the corpus. Possible values
+        /// include: 'analyzed', 'being_processed', 'undetermined'
+        /// </summary>
+        [JsonProperty(PropertyName = "status")]
+        public string Status { get; set; }
+
+        /// <summary>
+        /// Gets or sets if the status of the corpus is `undetermined`, the
+        /// following message: `Analysis of corpus 'name' failed. Please try
+        /// adding the corpus again by setting the 'allow_overwrite' flag to
+        /// 'true'`.
+        /// </summary>
+        [JsonProperty(PropertyName = "error")]
+        public string Error { get; set; }
+    }
+}

src/IBM.WatsonDeveloperCloud.SpeechToText/v1/Model/Corpus.cs

@@ -0,0 +1,53 @@
+/**
+* Copyright 2017 IBM Corp. All Rights Reserved.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*      http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*
+*/
+using System;
+using Newtonsoft.Json;
+
+namespace IBM.WatsonDeveloperCloud.SpeechToText.v1.Model
+{
+    public class CustomModel
+    {
+        /// <summary>
+        /// Gets or sets the name of the new custom model. Use a name that is
+        /// unique among all custom models that are owned by the calling
+        /// user. Use a localized name that matches the language of the
+        /// custom model.
+        /// </summary>
+        [JsonProperty(PropertyName = "name")]
+        public string Name { get; set; }
+
+        /// <summary>
+        /// Gets or sets the name of the language model that is to be
+        /// customized by the new model. You must use the name of one of the
+        /// US English or Japanese models that is returned by the `GET
+        /// /v1/models` method. The new custom model can be used only with
+        /// the base language model that it customizes. Possible values
+        /// include: 'en-US_BroadbandModel', 'en-US_NarrowbandModel',
+        /// 'ja-JP_BroadbandModel', 'ja-JP_NarrowbandModel'
+        /// </summary>
+        [JsonProperty(PropertyName = "base_model_name")]
+        public string BaseModelName { get; set; }
+
+        /// <summary>
+        /// Gets or sets a description of the new custom model. Use a
+        /// localized description that matches the language of the custom
+        /// model.
+        /// </summary>
+        [JsonProperty(PropertyName = "description")]
+        public string Description { get; set; }
+    }
+}

src/IBM.WatsonDeveloperCloud.SpeechToText/v1/Model/CustomModel.cs

@@ -0,0 +1,103 @@
+/**
+* Copyright 2017 IBM Corp. All Rights Reserved.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*      http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*
+*/
+
+namespace IBM.WatsonDeveloperCloud.SpeechToText.v1.Model
+{
+    public class Customization
+    {
+        /// <summary>
+        /// Gets or sets the GUID of the custom language model.
+        /// </summary>
+        [Newtonsoft.Json.JsonProperty(PropertyName = "customization_id")]
+        public string CustomizationId { get; set; }
+
+        /// <summary>
+        /// Gets or sets the date and time in Coordinated Universal Time (UTC)
+        /// at which the custom language model was created. The value is
+        /// provided in full ISO 8601 format (`YYYY-MM-DDThh:mm:ss.sTZD`).
+        /// </summary>
+        [Newtonsoft.Json.JsonProperty(PropertyName = "created")]
+        public string Created { get; set; }
+
+        /// <summary>
+        /// Gets or sets the language of the custom language model, `en-US` or
+        /// `ja-JP`.
+        /// </summary>
+        [Newtonsoft.Json.JsonProperty(PropertyName = "language")]
+        public string Language { get; set; }
+
+        /// <summary>
+        /// Gets or sets the GUID of the service credentials for the owner of
+        /// the custom language model.
+        /// </summary>
+        [Newtonsoft.Json.JsonProperty(PropertyName = "owner")]
+        public string Owner { get; set; }
+
+        /// <summary>
+        /// Gets or sets the name of the custom language model.
+        /// </summary>
+        [Newtonsoft.Json.JsonProperty(PropertyName = "name")]
+        public string Name { get; set; }
+
+        /// <summary>
+        /// Gets or sets the description of the custom language model.
+        /// </summary>
+        [Newtonsoft.Json.JsonProperty(PropertyName = "description")]
+        public string Description { get; set; }
+
+        /// <summary>
+        /// Gets or sets the name of the base language model for which the
+        /// custom language model was created. Possible values include:
+        /// 'en-US_BroadbandModel', 'en-US_NarrowbandModel'
+        /// </summary>
+        [Newtonsoft.Json.JsonProperty(PropertyName = "base_model_name")]
+        public string BaseModelName { get; set; }
+
+        /// <summary>
+        /// Gets or sets the current status of the custom language model:
+        /// `pending` indicates that the model was created but is waiting
+        /// either for training data to be added or for the service to finish
+        /// analyzing added data. `ready` indicates that the model contains
+        /// data and is ready to be trained. `training` indicates that the
+        /// model is currently being trained. `available` indicates that the
+        /// model is trained and ready to use. `failed` indicates that
+        /// training of the model failed. Possible values include: 'pending',
+        /// 'ready', 'training', 'available', 'failed'
+        /// </summary>
+        [Newtonsoft.Json.JsonProperty(PropertyName = "status")]
+        public string Status { get; set; }
+
+        /// <summary>
+        /// Gets or sets a percentage that indicates the progress of the
+        /// model's current training. A value of `100` means that the model
+        /// is fully trained. For this beta release, the `progress` field
+        /// does not reflect the current progress of the training; the field
+        /// changes from `0` to `100` when training is complete.
+        /// </summary>
+        [Newtonsoft.Json.JsonProperty(PropertyName = "progress")]
+        public int Progress { get; set; }
+
+        /// <summary>
+        /// Gets or sets if the request included unknown query parameters, the
+        /// following message: `Unexpected query parameter(s) ['parameters']
+        /// detected`, where `parameters` is a list that includes a quoted
+        /// string for each unknown parameter.
+        /// </summary>
+        [Newtonsoft.Json.JsonProperty(PropertyName = "warnings")]
+        public string Warnings { get; set; }
+    }
+}

src/IBM.WatsonDeveloperCloud.SpeechToText/v1/Model/Customization.cs

@@ -1,36 +1,30 @@
-/**
-* Copyright 2017 IBM Corp. All Rights Reserved.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-*      http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*
-*/
-
-using Newtonsoft.Json;
-
-namespace IBM.WatsonDeveloperCloud.SpeechToText.v1.Model
-{
-    public class JobStatusNew
-    {
-        [JsonProperty("created")]
-        public string Created { get; set; }
-
-        [JsonProperty("id")]
-        public string Id { get; set; }
-
-        [JsonProperty("url")]
-        public string Url { get; set; }
-
-        [JsonProperty("status")]
-        public string Status { get; set; }
-    }
+/**
+* Copyright 2017 IBM Corp. All Rights Reserved.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*      http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*
+*/
+
+using Newtonsoft.Json;
+
+namespace IBM.WatsonDeveloperCloud.SpeechToText.v1.Model
+{
+    public class CustomizationID
+    {
+        /// <summary>
+        /// The GUID of the new custom language model.
+        /// </summary>
+        [JsonProperty("customization_id")]
+        public string CustomizationId { get; set; }
+    }
 }