Skip to content

Commit e4b18e2

Browse files
committed
docs(sessions): deprecate speech to text sessions
1 parent 297a0ff commit e4b18e2

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

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

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -135,6 +135,7 @@ public SpeechRecognitionResults Recognize(string contentType, Metadata metaData,
135135
/// <param name="smartFormatting"></param>
136136
/// <param name="speakerLabels"></param>
137137
/// <returns></returns>
138+
[Obsolete("RecognizeWithSession is deprecated as of August 8, 2018, and will be removed from service on September 7, 2018.")]
138139
public SpeechRecognitionResults RecognizeWithSession(string sessionId, string contentType, Stream audio, string transferEncoding = "", string model = "en-US_BroadbandModel", string customizationId = "", bool? continuous = null, int? inactivityTimeout = null, string[] keywords = null, double? keywordsThreshold = null, int? maxAlternatives = null, double? wordAlternativesThreshold = null, bool? wordConfidence = null, bool? timestamps = null, bool profanityFilter = false, bool? smartFormatting = null, bool? speakerLabels = null)
139140
{
140141
if (string.IsNullOrEmpty(sessionId))
@@ -177,6 +178,7 @@ public SpeechRecognitionResults RecognizeWithSession(string sessionId, string co
177178
/// <param name="metaData"></param>
178179
/// <param name="audio"></param>
179180
/// <returns></returns>
181+
[Obsolete("RecognizeWithSession is deprecated as of August 8, 2018, and will be removed from service on September 7, 2018.")]
180182
public SpeechRecognitionResults RecognizeWithSession(string sessionId, string contentType, Metadata metaData, Stream audio, string transferEncoding = "", string model = "en-US_BroadbandModel", string customizationId = "")
181183
{
182184
if (string.IsNullOrEmpty(sessionId))
@@ -347,6 +349,7 @@ private SpeechRecognitionResults Recognize(string sessionId, string contentType,
347349
/// <param name="sequenceId">The sequence ID of the recognition task whose results you want to observe. Omit the parameter to obtain results either for an ongoing recognition, if any, or for the next recognition task regardless of whether it specifies a sequence ID.</param>
348350
/// <param name="interimResults">Indicates whether the service is to return interim results. If true, interim results are returned as a stream of JSON objects; each object represents a single SpeechRecognitionEvent. If false, the response is a single SpeechRecognitionEvent with final results only.</param>
349351
/// <returns></returns>
352+
[Obsolete("ObserveResult is deprecated as of August 8, 2018, and will be removed from service on September 7, 2018.")]
350353
public List<SpeechRecognitionResults> ObserveResult(string sessionId, int? sequenceId = (int?)null, bool interimResults = false)
351354
{
352355
List<SpeechRecognitionResults> result = null;
@@ -410,6 +413,7 @@ public List<SpeechRecognitionResults> ObserveResult(string sessionId, int? seque
410413
/// <param name="acousticCustomizationId">The GUID of a custom acoustic model that is to be used with the new session. The base model of the specified custom acoustic model must match the model specified with the model parameter. You must make the request with service credentials created for the instance of the service that owns the custom model. By default, no custom acoustic model is used.</param>
411414
/// <param name="baseModelVersion">The version of the specified base model that is to be used with the new session. Multiple versions of a base model can exist when a model is updated for internal improvements. The parameter is intended primarily for use with custom models that have been upgraded for a new base model. The default value depends on whether the parameter is used with or without a custom model. For more information, see Base model version (https://console.bluemix.net/docs/services/speech-to-text/input.html#version).</param>
412415
/// <returns>The created session</returns>
416+
[Obsolete("CreateSession is deprecated as of August 8, 2018, and will be removed from service on September 7, 2018.")]
413417
public SpeechSession CreateSession(string model, string customizationId = null, string acousticCustomizationId = null, string baseModelVersion = null)
414418
{
415419
SpeechSession result = null;
@@ -454,6 +458,7 @@ public SpeechSession CreateSession(string model, string customizationId = null,
454458
/// </summary>
455459
/// <param name="session">The session to get.</param>
456460
/// <returns></returns>
461+
[Obsolete("GetSessionStatus is deprecated as of August 8, 2018, and will be removed from service on September 7, 2018.")]
457462
public SessionStatus GetSessionStatus(SpeechSession session)
458463
{
459464
return this.GetSessionStatus(session.SessionId);
@@ -464,6 +469,7 @@ public SessionStatus GetSessionStatus(SpeechSession session)
464469
/// </summary>
465470
/// <param name="sessionId">The ID of the session for the recognition task.</param>
466471
/// <returns>The session status.</returns>
472+
[Obsolete("GetSessionStatus is deprecated as of August 8, 2018, and will be removed from service on September 7, 2018.")]
467473
public SessionStatus GetSessionStatus(string sessionId)
468474
{
469475
SessionStatus result = null;
@@ -504,6 +510,7 @@ public SessionStatus GetSessionStatus(string sessionId)
504510
/// </summary>
505511
/// <param name="session">The session to be deleted.</param>
506512
/// <returns></returns>
513+
[Obsolete("DeleteSession is deprecated as of August 8, 2018, and will be removed from service on September 7, 2018.")]
507514
public object DeleteSession(SpeechSession session)
508515
{
509516
return this.DeleteSession(session.SessionId);
@@ -514,6 +521,7 @@ public object DeleteSession(SpeechSession session)
514521
/// </summary>
515522
/// <param name="session">The ID of the session to be deleted.</param>
516523
/// <returns></returns>
524+
[Obsolete("DeleteSession is deprecated as of August 8, 2018, and will be removed from service on September 7, 2018.")]
517525
public object DeleteSession(string sessionId)
518526
{
519527
if (string.IsNullOrEmpty(sessionId))
@@ -689,6 +697,7 @@ public class Metadata
689697
public bool? SpeakerLabels { get; set; }
690698
}
691699

700+
[Obsolete("SpeechSession is deprecated as of August 8, 2018, and will be removed from service on September 7, 2018.")]
692701
public class SpeechSession
693702
{
694703
/// <summary>
@@ -734,6 +743,7 @@ public class SpeechSession
734743
public string Model { get; set; }
735744
}
736745

746+
[Obsolete("SessionStatus is deprecated as of August 8, 2018, and will be removed from service on September 7, 2018.")]
737747
public class SessionStatus
738748
{
739749
/// <summary>

0 commit comments

Comments
 (0)