Support named entities in the JSON response

SmRtAPI/SmRtAPI/Messages/WordSubMessage.cs

@@ -1,3 +1,5 @@
+using Newtonsoft.Json;
+
 namespace Speechmatics.Realtime.Client.Messages
 {
     /// <summary>
@@ -6,7 +8,7 @@ namespace Speechmatics.Realtime.Client.Messages
     public class WordSubMessage : BaseMessage
     {
         /// <summary>
-        /// Type for this token, one of "word", "punctuation" or "speaker_change"
+        /// Type for this token, one of "word", "punctuation" or "entity"
         /// </summary>
         public string type;
         /// <summary>
@@ -17,20 +19,56 @@ public class WordSubMessage : BaseMessage
         /// End time
         /// </summary>
         public double end_time;
-
         /// <summary>
         /// Whether the element represents an end of sentence marker (e.g. full stop, question mark, exclamation mark)
         /// </summary>
         public bool is_eos;
-
         /// <summary>
         /// Whether this punctuation mark attaches to previous or next token.
         /// </summary>
         public string? attaches_to;
         /// <summary>
-        /// Audio length (seconds)
+        /// Alternative options for the words (currently of length 1)
+        /// </summary>
+        public Alternative[] alternatives;
+        /// <summary>
+        /// If the word is a named entity, the class of the entity (money, date, etc), otherwise omitted
+        /// </summary>
+        [JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
+        public string? entity_class;
+        /// <summary>
+        /// For an entity, the recognized spoken words, otherwise omitted
+        /// </summary>
+        [JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
+        public EntitySpokenOrWrittenForm[]? spoken_form;
+        /// <summary>
+        /// For an entity, the written form of the recognised words, otherwise omitted
+        /// </summary>
+        [JsonProperty(NullValueHandling = NullValueHandling.Ignore)]
+        public EntitySpokenOrWrittenForm[]? written_form;
+    }
+
+    /// <summary>
+    /// Represents the spoken or written form of an entity (money, date, etc)
+    /// </summary>
+    public class EntitySpokenOrWrittenForm
+    {
+        /// <summary>
+        /// Alternative options for the words (currently of length 1)
         /// </summary>
         public Alternative[] alternatives;
+        /// <summary>
+        /// Type for this token (usually 'word' when dealing with entity sub-components)
+        /// </summary>
+        public string type;
+        /// <summary>
+        /// Start time (offset from audio start) of the whole entity
+        /// </summary>
+        public double start_time;
+        /// <summary>
+        /// End time of the whole entity
+        /// </summary>
+        public double end_time;
     }
 
     /// <summary>

SmRtAPI/Speechmatics.nuspec

@@ -2,7 +2,7 @@
 <package xmlns="http://schemas.microsoft.com/packaging/2012/06/nuspec.xsd">
 	<metadata>
 		<id>Speechmatics</id>
-		<version>1.1.1</version>
+		<version>1.1.3</version>
 		<authors>Speechmatics</authors>
 		<owners>Speechmatics</owners>
 		<readme>docs/README.md</readme>