From b805a7b8a15e2e8c9cddb8266abe8a2076bffd2e Mon Sep 17 00:00:00 2001 From: Nanwarin Chantarutai Date: Wed, 8 Sep 2021 13:26:27 -0700 Subject: [PATCH 01/26] feat(assistant-v1): alt_text property added to Image response type --- .../Model/DialogNodeOutputGeneric.cs | 9 +++++++-- ...utputGenericDialogNodeOutputResponseTypeImage.cs | 13 +++++++++++-- .../Model/RuntimeResponseGeneric.cs | 9 +++++++-- ...untimeResponseGenericRuntimeResponseTypeImage.cs | 13 +++++++++++-- 4 files changed, 36 insertions(+), 8 deletions(-) diff --git a/src/IBM.Watson.Assistant.v1/Model/DialogNodeOutputGeneric.cs b/src/IBM.Watson.Assistant.v1/Model/DialogNodeOutputGeneric.cs index 295d5ed412..290ced8115 100644 --- a/src/IBM.Watson.Assistant.v1/Model/DialogNodeOutputGeneric.cs +++ b/src/IBM.Watson.Assistant.v1/Model/DialogNodeOutputGeneric.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2018, 2021. +* (C) Copyright IBM Corp. 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -161,7 +161,7 @@ public class QueryTypeEnumValue [JsonProperty("typing", NullValueHandling = NullValueHandling.Ignore)] public bool? Typing { get; protected set; } /// - /// The URL of the image. + /// The `https:` URL of the image. /// [JsonProperty("source", NullValueHandling = NullValueHandling.Ignore)] public string Source { get; protected set; } @@ -176,6 +176,11 @@ public class QueryTypeEnumValue [JsonProperty("description", NullValueHandling = NullValueHandling.Ignore)] public string Description { get; protected set; } /// + /// Descriptive text that can be used for screen readers or other situations where the image cannot be seen. + /// + [JsonProperty("alt_text", NullValueHandling = NullValueHandling.Ignore)] + public string AltText { get; protected set; } + /// /// An array of objects describing the options from which the user can choose. You can include up to 20 options. /// [JsonProperty("options", NullValueHandling = NullValueHandling.Ignore)] diff --git a/src/IBM.Watson.Assistant.v1/Model/DialogNodeOutputGenericDialogNodeOutputResponseTypeImage.cs b/src/IBM.Watson.Assistant.v1/Model/DialogNodeOutputGenericDialogNodeOutputResponseTypeImage.cs index f51576b95d..aa9aefb558 100644 --- a/src/IBM.Watson.Assistant.v1/Model/DialogNodeOutputGenericDialogNodeOutputResponseTypeImage.cs +++ b/src/IBM.Watson.Assistant.v1/Model/DialogNodeOutputGenericDialogNodeOutputResponseTypeImage.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2020, 2021. +* (C) Copyright IBM Corp. 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -36,7 +36,7 @@ public class DialogNodeOutputGenericDialogNodeOutputResponseTypeImage : DialogNo set { base.ResponseType = value; } } /// - /// The URL of the image. + /// The `https:` URL of the image. /// [JsonProperty("source", NullValueHandling = NullValueHandling.Ignore)] public new string Source @@ -71,6 +71,15 @@ public class DialogNodeOutputGenericDialogNodeOutputResponseTypeImage : DialogNo get { return base.Channels; } set { base.Channels = value; } } + /// + /// Descriptive text that can be used for screen readers or other situations where the image cannot be seen. + /// + [JsonProperty("alt_text", NullValueHandling = NullValueHandling.Ignore)] + public new string AltText + { + get { return base.AltText; } + set { base.AltText = value; } + } } } diff --git a/src/IBM.Watson.Assistant.v1/Model/RuntimeResponseGeneric.cs b/src/IBM.Watson.Assistant.v1/Model/RuntimeResponseGeneric.cs index bbf76012d6..94b8297bc9 100644 --- a/src/IBM.Watson.Assistant.v1/Model/RuntimeResponseGeneric.cs +++ b/src/IBM.Watson.Assistant.v1/Model/RuntimeResponseGeneric.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2019, 2021. +* (C) Copyright IBM Corp. 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -108,7 +108,7 @@ public class PreferenceEnumValue [JsonProperty("typing", NullValueHandling = NullValueHandling.Ignore)] public bool? Typing { get; protected set; } /// - /// The URL of the image. + /// The `https:` URL of the image. /// [JsonProperty("source", NullValueHandling = NullValueHandling.Ignore)] public string Source { get; protected set; } @@ -123,6 +123,11 @@ public class PreferenceEnumValue [JsonProperty("description", NullValueHandling = NullValueHandling.Ignore)] public string Description { get; protected set; } /// + /// Descriptive text that can be used for screen readers or other situations where the image cannot be seen. + /// + [JsonProperty("alt_text", NullValueHandling = NullValueHandling.Ignore)] + public string AltText { get; protected set; } + /// /// An array of objects describing the options from which the user can choose. /// [JsonProperty("options", NullValueHandling = NullValueHandling.Ignore)] diff --git a/src/IBM.Watson.Assistant.v1/Model/RuntimeResponseGenericRuntimeResponseTypeImage.cs b/src/IBM.Watson.Assistant.v1/Model/RuntimeResponseGenericRuntimeResponseTypeImage.cs index 3d2d8b3975..e2e783e0d3 100644 --- a/src/IBM.Watson.Assistant.v1/Model/RuntimeResponseGenericRuntimeResponseTypeImage.cs +++ b/src/IBM.Watson.Assistant.v1/Model/RuntimeResponseGenericRuntimeResponseTypeImage.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2020, 2021. +* (C) Copyright IBM Corp. 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -36,7 +36,7 @@ public class RuntimeResponseGenericRuntimeResponseTypeImage : RuntimeResponseGen set { base.ResponseType = value; } } /// - /// The URL of the image. + /// The `https:` URL of the image. /// [JsonProperty("source", NullValueHandling = NullValueHandling.Ignore)] public new string Source @@ -72,6 +72,15 @@ public class RuntimeResponseGenericRuntimeResponseTypeImage : RuntimeResponseGen get { return base.Channels; } set { base.Channels = value; } } + /// + /// Descriptive text that can be used for screen readers or other situations where the image cannot be seen. + /// + [JsonProperty("alt_text", NullValueHandling = NullValueHandling.Ignore)] + public new string AltText + { + get { return base.AltText; } + set { base.AltText = value; } + } } } From fcecbd29878d29ed6768cdce3f9546412492748c Mon Sep 17 00:00:00 2001 From: Nanwarin Chantarutai Date: Wed, 8 Sep 2021 13:28:35 -0700 Subject: [PATCH 02/26] feat(assistant-v2): session_start_time and state properties added to MessageContextGlobalSystem --- .../Model/MessageContextGlobalSystem.cs | 25 ++++++++++++++++--- .../Model/MessageInput.cs | 20 ++++++++++++--- .../Model/MessageInputStateless.cs | 20 ++++++++++++--- 3 files changed, 56 insertions(+), 9 deletions(-) diff --git a/src/IBM.Watson.Assistant.v2/Model/MessageContextGlobalSystem.cs b/src/IBM.Watson.Assistant.v2/Model/MessageContextGlobalSystem.cs index e4a9dcabd8..94cd7cf46f 100644 --- a/src/IBM.Watson.Assistant.v2/Model/MessageContextGlobalSystem.cs +++ b/src/IBM.Watson.Assistant.v2/Model/MessageContextGlobalSystem.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2018, 2021. +* (C) Copyright IBM Corp. 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -136,13 +136,32 @@ public class LocaleEnumValue /// `tomorrow`. This can be useful for simulating past or future times for testing purposes, or when analyzing /// documents such as news articles. /// - /// This value must be a UTC time value formatted according to ISO 8601 (for example, `2019-06-26T12:00:00Z` for - /// noon on 26 June 2019. + /// This value must be a UTC time value formatted according to ISO 8601 (for example, `2021-06-26T12:00:00Z` for + /// noon UTC on 26 June 2021). /// /// This property is included only if the new system entities are enabled for the skill. /// [JsonProperty("reference_time", NullValueHandling = NullValueHandling.Ignore)] public string ReferenceTime { get; set; } + /// + /// The time at which the session started. With the stateful `message` method, the start time is always present, + /// and is set by the service based on the time the session was created. With the stateless `message` method, + /// the start time is set by the service in the response to the first message, and should be returned as part of + /// the context with each subsequent message in the session. + /// + /// This value is a UTC time value formatted according to ISO 8601 (for example, `2021-06-26T12:00:00Z` for noon + /// UTC on 26 June 2021). + /// + [JsonProperty("session_start_time", NullValueHandling = NullValueHandling.Ignore)] + public string SessionStartTime { get; set; } + /// + /// An encoded string that represents the configuration state of the assistant at the beginning of the + /// conversation. If you are using the stateless `message` method, save this value and then send it in the + /// context of the subsequent message request to avoid disruptions if there are configuration changes during the + /// conversation (such as a change to a skill the assistant uses). + /// + [JsonProperty("state", NullValueHandling = NullValueHandling.Ignore)] + public string State { get; set; } } } diff --git a/src/IBM.Watson.Assistant.v2/Model/MessageInput.cs b/src/IBM.Watson.Assistant.v2/Model/MessageInput.cs index f6a7c07e5a..4acd70a4c9 100644 --- a/src/IBM.Watson.Assistant.v2/Model/MessageInput.cs +++ b/src/IBM.Watson.Assistant.v2/Model/MessageInput.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2018, 2020. +* (C) Copyright IBM Corp. 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -26,7 +26,12 @@ namespace IBM.Watson.Assistant.v2.Model public class MessageInput { /// - /// The type of user input. Currently, only text input is supported. + /// The type of the message: + /// + /// - `text`: The user input is processed normally by the assistant. + /// - `search`: Only search results are returned. (Any dialog or actions skill is bypassed.) + /// + /// **Note:** A `search` message results in an error if no search skill is configured for the assistant. /// public class MessageTypeEnumValue { @@ -34,11 +39,20 @@ public class MessageTypeEnumValue /// Constant TEXT for text /// public const string TEXT = "text"; + /// + /// Constant SEARCH for search + /// + public const string SEARCH = "search"; } /// - /// The type of user input. Currently, only text input is supported. + /// The type of the message: + /// + /// - `text`: The user input is processed normally by the assistant. + /// - `search`: Only search results are returned. (Any dialog or actions skill is bypassed.) + /// + /// **Note:** A `search` message results in an error if no search skill is configured for the assistant. /// Constants for possible values can be found using MessageInput.MessageTypeEnumValue /// [JsonProperty("message_type", NullValueHandling = NullValueHandling.Ignore)] diff --git a/src/IBM.Watson.Assistant.v2/Model/MessageInputStateless.cs b/src/IBM.Watson.Assistant.v2/Model/MessageInputStateless.cs index ded305e50b..fdd0d1ac3a 100644 --- a/src/IBM.Watson.Assistant.v2/Model/MessageInputStateless.cs +++ b/src/IBM.Watson.Assistant.v2/Model/MessageInputStateless.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2018, 2020. +* (C) Copyright IBM Corp. 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -26,7 +26,12 @@ namespace IBM.Watson.Assistant.v2.Model public class MessageInputStateless { /// - /// The type of user input. Currently, only text input is supported. + /// The type of the message: + /// + /// - `text`: The user input is processed normally by the assistant. + /// - `search`: Only search results are returned. (Any dialog or actions skill is bypassed.) + /// + /// **Note:** A `search` message results in an error if no search skill is configured for the assistant. /// public class MessageTypeEnumValue { @@ -34,11 +39,20 @@ public class MessageTypeEnumValue /// Constant TEXT for text /// public const string TEXT = "text"; + /// + /// Constant SEARCH for search + /// + public const string SEARCH = "search"; } /// - /// The type of user input. Currently, only text input is supported. + /// The type of the message: + /// + /// - `text`: The user input is processed normally by the assistant. + /// - `search`: Only search results are returned. (Any dialog or actions skill is bypassed.) + /// + /// **Note:** A `search` message results in an error if no search skill is configured for the assistant. /// Constants for possible values can be found using MessageInputStateless.MessageTypeEnumValue /// [JsonProperty("message_type", NullValueHandling = NullValueHandling.Ignore)] From 98448daaf5bc8035a92ed090a07d699e38fdacc4 Mon Sep 17 00:00:00 2001 From: Nanwarin Chantarutai Date: Wed, 8 Sep 2021 13:29:48 -0700 Subject: [PATCH 03/26] feat(assistant-v2): alt_text property added to Image response type --- .../Model/RuntimeResponseGeneric.cs | 9 +++++++-- ...untimeResponseGenericRuntimeResponseTypeImage.cs | 13 +++++++++++-- 2 files changed, 18 insertions(+), 4 deletions(-) diff --git a/src/IBM.Watson.Assistant.v2/Model/RuntimeResponseGeneric.cs b/src/IBM.Watson.Assistant.v2/Model/RuntimeResponseGeneric.cs index 949052780c..b09dda5b1b 100644 --- a/src/IBM.Watson.Assistant.v2/Model/RuntimeResponseGeneric.cs +++ b/src/IBM.Watson.Assistant.v2/Model/RuntimeResponseGeneric.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2018, 2021. +* (C) Copyright IBM Corp. 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -111,7 +111,7 @@ public class PreferenceEnumValue [JsonProperty("typing", NullValueHandling = NullValueHandling.Ignore)] public bool? Typing { get; protected set; } /// - /// The URL of the image. + /// The `https:` URL of the image. /// [JsonProperty("source", NullValueHandling = NullValueHandling.Ignore)] public string Source { get; protected set; } @@ -126,6 +126,11 @@ public class PreferenceEnumValue [JsonProperty("description", NullValueHandling = NullValueHandling.Ignore)] public string Description { get; protected set; } /// + /// Descriptive text that can be used for screen readers or other situations where the image cannot be seen. + /// + [JsonProperty("alt_text", NullValueHandling = NullValueHandling.Ignore)] + public string AltText { get; protected set; } + /// /// An array of objects describing the options from which the user can choose. /// [JsonProperty("options", NullValueHandling = NullValueHandling.Ignore)] diff --git a/src/IBM.Watson.Assistant.v2/Model/RuntimeResponseGenericRuntimeResponseTypeImage.cs b/src/IBM.Watson.Assistant.v2/Model/RuntimeResponseGenericRuntimeResponseTypeImage.cs index cf945dfe25..865740d002 100644 --- a/src/IBM.Watson.Assistant.v2/Model/RuntimeResponseGenericRuntimeResponseTypeImage.cs +++ b/src/IBM.Watson.Assistant.v2/Model/RuntimeResponseGenericRuntimeResponseTypeImage.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2020, 2021. +* (C) Copyright IBM Corp. 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -36,7 +36,7 @@ public class RuntimeResponseGenericRuntimeResponseTypeImage : RuntimeResponseGen set { base.ResponseType = value; } } /// - /// The URL of the image. + /// The `https:` URL of the image. /// [JsonProperty("source", NullValueHandling = NullValueHandling.Ignore)] public new string Source @@ -72,6 +72,15 @@ public class RuntimeResponseGenericRuntimeResponseTypeImage : RuntimeResponseGen get { return base.Channels; } set { base.Channels = value; } } + /// + /// Descriptive text that can be used for screen readers or other situations where the image cannot be seen. + /// + [JsonProperty("alt_text", NullValueHandling = NullValueHandling.Ignore)] + public new string AltText + { + get { return base.AltText; } + set { base.AltText = value; } + } } } From 7ed8976747c165176899b7cd7183e6dbfcc2356d Mon Sep 17 00:00:00 2001 From: Nanwarin Chantarutai Date: Wed, 8 Sep 2021 13:49:06 -0700 Subject: [PATCH 04/26] feat(tts): new voice models added --- .../TextToSpeechService.cs | 165 ++++++++++-------- 1 file changed, 96 insertions(+), 69 deletions(-) diff --git a/src/IBM.Watson.TextToSpeech.v1/TextToSpeechService.cs b/src/IBM.Watson.TextToSpeech.v1/TextToSpeechService.cs index f438ba228d..9b988f9f5c 100644 --- a/src/IBM.Watson.TextToSpeech.v1/TextToSpeechService.cs +++ b/src/IBM.Watson.TextToSpeech.v1/TextToSpeechService.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2016, 2021. +* (C) Copyright IBM Corp. 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -16,7 +16,7 @@ */ /** -* IBM OpenAPI SDK Code Generator Version: 99-SNAPSHOT-902c9336-20210513-140138 +* IBM OpenAPI SDK Code Generator Version: 3.38.0-07189efd-20210827-205025 */ using System.Collections.Generic; @@ -58,8 +58,8 @@ public TextToSpeechService(string serviceName, IAuthenticator authenticator) : b /// /// Lists all voices available for use with the service. The information includes the name, language, gender, /// and other details about the voice. The ordering of the list of voices can change from call to call; do not - /// rely on an alphabetized or static list of voices. To see information about a specific voice, use the **Get a - /// voice** method. + /// rely on an alphabetized or static list of voices. To see information about a specific voice, use the [Get a + /// voice](#getvoice). /// /// **See also:** [Listing all available /// voices](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-voices#listVoices). @@ -101,13 +101,13 @@ public DetailedResponse ListVoices() /// /// Gets information about the specified voice. The information includes the name, language, gender, and other /// details about the voice. Specify a customization ID to obtain information for a custom model that is defined - /// for the language of the specified voice. To list information about all available voices, use the **List - /// voices** method. + /// for the language of the specified voice. To list information about all available voices, use the [List + /// voices](#listvoices) method. /// /// **See also:** [Listing a specific /// voice](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-voices#listVoice). /// - /// ### Important voice updates + /// ### Important voice updates for IBM Cloud /// /// The service's voices underwent significant change on 2 December 2020. /// * The Arabic, Chinese, Dutch, Australian English, and Korean voices are now neural instead of concatenative. @@ -124,10 +124,13 @@ public DetailedResponse ListVoices() /// future date. You are encouraged to migrate to the equivalent neural voices at your earliest convenience. For /// more information about all voice updates, see the [2 December 2020 service /// update](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-release-notes#December2020) in the - /// release notes. + /// release notes for IBM Cloud. /// /// The voice for which information is to be returned. For more information about specifying - /// a voice, see **Important voice updates** in the method description. + /// a voice, see **Important voice updates for IBM Cloud** in the method description. + /// + /// **IBM Cloud:** The Arabic, Chinese, Dutch, Australian English, and Korean languages and voices are supported + /// only for IBM Cloud. /// The customization ID (GUID) of a custom model for which information is to be /// returned. You must make the request with credentials for the instance of the service that owns the custom /// model. Omit the parameter to see information about the specified voice with no customization. @@ -183,7 +186,10 @@ public class GetVoiceEnums { /// /// The voice for which information is to be returned. For more information about specifying a voice, see - /// **Important voice updates** in the method description. + /// **Important voice updates for IBM Cloud** in the method description. + /// + /// **IBM Cloud:** The Arabic, Chinese, Dutch, Australian English, and Korean languages and voices are + /// supported only for IBM Cloud. /// public class VoiceValue { @@ -360,6 +366,10 @@ public class VoiceValue /// public const string KO_KR_YUNAVOICE = "ko-KR_YunaVoice"; /// + /// Constant NL_BE_ADELEVOICE for nl-BE_AdeleVoice + /// + public const string NL_BE_ADELEVOICE = "nl-BE_AdeleVoice"; + /// /// Constant NL_NL_EMMAVOICE for nl-NL_EmmaVoice /// public const string NL_NL_EMMAVOICE = "nl-NL_EmmaVoice"; @@ -438,10 +448,10 @@ public class VoiceValue /// is 22,050 Hz. /// /// For more information about specifying an audio format, including additional details about some of the - /// formats, see [Audio - /// formats](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-audioFormats#audioFormats). + /// formats, see [Using audio + /// formats](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-audio-formats). /// - /// ### Important voice updates + /// ### Important voice updates for IBM Cloud /// /// The service's voices underwent significant change on 2 December 2020. /// * The Arabic, Chinese, Dutch, Australian English, and Korean voices are now neural instead of concatenative. @@ -458,7 +468,7 @@ public class VoiceValue /// future date. You are encouraged to migrate to the equivalent neural voices at your earliest convenience. For /// more information about all voice updates, see the [2 December 2020 service /// update](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-release-notes#December2020) in the - /// release notes. + /// release notes for IBM Cloud. /// /// ### Warning messages /// @@ -474,7 +484,14 @@ public class VoiceValue /// **Audio formats (accept types)** in the method description. (optional, default to /// audio/ogg;codecs=opus) /// The voice to use for synthesis. For more information about specifying a voice, see - /// **Important voice updates** in the method description. (optional, default to en-US_MichaelV3Voice) + /// **Important voice updates for IBM Cloud** in the method description. + /// + /// **IBM Cloud:** The Arabic, Chinese, Dutch, Australian English, and Korean languages and voices are supported + /// only for IBM Cloud. + /// + /// **See also:** See also [Using languages and + /// voices](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-voices). (optional, default to + /// en-US_MichaelV3Voice) /// The customization ID (GUID) of a custom model to use for the synthesis. If a /// custom model is specified, it works only if it matches the language of the indicated voice. You must make /// the request with credentials for the instance of the service that owns the custom model. Omit the parameter @@ -601,7 +618,13 @@ public class AcceptValue } /// /// The voice to use for synthesis. For more information about specifying a voice, see **Important voice - /// updates** in the method description. + /// updates for IBM Cloud** in the method description. + /// + /// **IBM Cloud:** The Arabic, Chinese, Dutch, Australian English, and Korean languages and voices are + /// supported only for IBM Cloud. + /// + /// **See also:** See also [Using languages and + /// voices](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-voices). /// public class VoiceValue { @@ -778,6 +801,10 @@ public class VoiceValue /// public const string KO_KR_YUNAVOICE = "ko-KR_YunaVoice"; /// + /// Constant NL_BE_ADELEVOICE for nl-BE_AdeleVoice + /// + public const string NL_BE_ADELEVOICE = "nl-BE_AdeleVoice"; + /// /// Constant NL_NL_EMMAVOICE for nl-NL_EmmaVoice /// public const string NL_NL_EMMAVOICE = "nl-NL_EmmaVoice"; @@ -818,7 +845,7 @@ public class VoiceValue /// **See also:** [Querying a word from a /// language](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customWords#cuWordsQueryLanguage). /// - /// ### Important voice updates + /// ### Important voice updates for IBM Cloud /// /// The service's voices underwent significant change on 2 December 2020. /// * The Arabic, Chinese, Dutch, Australian English, and Korean voices are now neural instead of concatenative. @@ -835,13 +862,15 @@ public class VoiceValue /// future date. You are encouraged to migrate to the equivalent neural voices at your earliest convenience. For /// more information about all voice updates, see the [2 December 2020 service /// update](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-release-notes#December2020) in the - /// release notes. + /// release notes for IBM Cloud. /// /// The word for which the pronunciation is requested. /// A voice that specifies the language in which the pronunciation is to be returned. All /// voices for the same language (for example, `en-US`) return the same translation. For more information about - /// specifying a voice, see **Important voice updates** in the method description. (optional, default to - /// en-US_MichaelV3Voice) + /// specifying a voice, see **Important voice updates for IBM Cloud** in the method description. + /// + /// **IBM Cloud:** The Arabic, Chinese, Dutch, Australian English, and Korean languages and voices are supported + /// only for IBM Cloud. (optional, default to en-US_MichaelV3Voice) /// The phoneme format in which to return the pronunciation. The Arabic, Chinese, Dutch, /// Australian English, and Korean languages support only IPA. Omit the parameter to obtain the pronunciation in /// the default format. (optional, default to ipa) @@ -911,7 +940,10 @@ public class GetPronunciationEnums /// /// A voice that specifies the language in which the pronunciation is to be returned. All voices for the /// same language (for example, `en-US`) return the same translation. For more information about specifying - /// a voice, see **Important voice updates** in the method description. + /// a voice, see **Important voice updates for IBM Cloud** in the method description. + /// + /// **IBM Cloud:** The Arabic, Chinese, Dutch, Australian English, and Korean languages and voices are + /// supported only for IBM Cloud. /// public class VoiceValue { @@ -1088,6 +1120,10 @@ public class VoiceValue /// public const string KO_KR_YUNAVOICE = "ko-KR_YunaVoice"; /// + /// Constant NL_BE_ADELEVOICE for nl-BE_AdeleVoice + /// + public const string NL_BE_ADELEVOICE = "nl-BE_AdeleVoice"; + /// /// Constant NL_NL_EMMAVOICE for nl-NL_EmmaVoice /// public const string NL_NL_EMMAVOICE = "nl-NL_EmmaVoice"; @@ -1145,7 +1181,7 @@ public class FormatValue /// **See also:** [Creating a custom /// model](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customModels#cuModelsCreate). /// - /// ### Important voice updates + /// ### Important voice updates for IBM Cloud /// /// The service's voices underwent significant change on 2 December 2020. /// * The Arabic, Chinese, Dutch, Australian English, and Korean voices are now neural instead of concatenative. @@ -1162,14 +1198,16 @@ public class FormatValue /// future date. You are encouraged to migrate to the equivalent neural voices at your earliest convenience. For /// more information about all voice updates, see the [2 December 2020 service /// update](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-release-notes#December2020) in the - /// release notes. + /// release notes for IBM Cloud. /// /// The name of the new custom model. /// The language of the new custom model. You create a custom model for a specific /// language, not for a specific voice. A custom model can be used with any voice for its specified language. /// Omit the parameter to use the the default language, `en-US`. **Note:** The `ar-AR` language identifier - /// cannot be used to create a custom model. Use the `ar-MS` identifier instead. (optional, default to - /// en-US) + /// cannot be used to create a custom model. Use the `ar-MS` identifier instead. + /// + /// **IBM Cloud:** The Arabic, Chinese, Dutch, Australian English, and Korean languages and voices are supported + /// only for IBM Cloud. (optional, default to en-US) /// A description of the new custom model. Specifying a description is recommended. /// (optional) /// CustomModel @@ -1230,8 +1268,9 @@ public DetailedResponse CreateCustomModel(string name, string langu /// /// Lists metadata such as the name and description for all custom models that are owned by an instance of the /// service. Specify a language to list the custom models for that language only. To see the words and prompts - /// in addition to the metadata for a specific custom model, use the **Get a custom model** method. You must use - /// credentials for the instance of the service that owns a model to list information about it. + /// in addition to the metadata for a specific custom model, use the [Get a custom model](#getcustommodel) + /// method. You must use credentials for the instance of the service that owns a model to list information about + /// it. /// /// **See also:** [Querying all custom /// models](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customModels#cuModelsQueryAll). @@ -1339,6 +1378,10 @@ public class LanguageValue /// public const string KO_KR = "ko-KR"; /// + /// Constant NL_BE for nl-BE + /// + public const string NL_BE = "nl-BE"; + /// /// Constant NL_NL for nl-NL /// public const string NL_NL = "nl-NL"; @@ -1452,7 +1495,7 @@ public DetailedResponse UpdateCustomModel(string customizationId, string /// Gets all information about a specified custom model. In addition to metadata such as the name and /// description of the custom model, the output includes the words and their translations that are defined for /// the model, as well as any prompts that are defined for the model. To see just the metadata for a model, use - /// the **List custom models** method. + /// the [List custom models](#listcustommodels) method. /// /// **See also:** [Querying a custom /// model](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-customModels#cuModelsQuery). @@ -1577,12 +1620,12 @@ public DetailedResponse DeleteCustomModel(string customizationId) /// /// The customization ID (GUID) of the custom model. You must make the request /// with credentials for the instance of the service that owns the custom model. - /// The **Add custom words** method accepts an array of `Word` objects. Each object provides - /// a word that is to be added or updated for the custom model and the word's translation. + /// The [Add custom words](#addwords) method accepts an array of `Word` objects. Each object + /// provides a word that is to be added or updated for the custom model and the word's translation. /// - /// The **List custom words** method returns an array of `Word` objects. Each object shows a word and its - /// translation from the custom model. The words are listed in alphabetical order, with uppercase letters listed - /// before lowercase letters. The array is empty if the custom model contains no words. + /// The [List custom words](#listwords) method returns an array of `Word` objects. Each object shows a word and + /// its translation from the custom model. The words are listed in alphabetical order, with uppercase letters + /// listed before lowercase letters. The array is empty if the custom model contains no words. /// object public DetailedResponse AddWords(string customizationId, List words) { @@ -1916,11 +1959,9 @@ public DetailedResponse DeleteWord(string customizationId, string word) /// Lists information about all custom prompts that are defined for a custom model. The information includes the /// prompt ID, prompt text, status, and optional speaker ID for each prompt of the custom model. You must use /// credentials for the instance of the service that owns the custom model. The same information about all of - /// the prompts for a custom model is also provided by the **Get a custom model** method. That method provides - /// complete details about a specified custom model, including its language, owner, custom words, and more. - /// - /// **Beta:** Custom prompts are beta functionality that is supported only for use with US English custom models - /// and voices. + /// the prompts for a custom model is also provided by the [Get a custom model](#getcustommodel) method. That + /// method provides complete details about a specified custom model, including its language, owner, custom + /// words, and more. Custom prompts are supported only for use with US English custom models and voices. /// /// **See also:** [Listing custom /// prompts](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-tbe-custom-prompts#tbe-custom-prompts-list). @@ -1994,10 +2035,10 @@ public DetailedResponse ListCustomPrompts(string customizationId) /// audio (for example, it takes 20 seconds to process a 20-second prompt). /// /// For shorter prompts, you can wait for a reasonable amount of time and then check the status of the prompt - /// with the **Get a custom prompt** method. For longer prompts, consider using that method to poll the service - /// every few seconds to determine when the prompt becomes available. No prompt can be used for speech synthesis - /// if it is in the `processing` or `failed` state. Only prompts that are in the `available` state can be used - /// for speech synthesis. + /// with the [Get a custom prompt](#getcustomprompt) method. For longer prompts, consider using that method to + /// poll the service every few seconds to determine when the prompt becomes available. No prompt can be used for + /// speech synthesis if it is in the `processing` or `failed` state. Only prompts that are in the `available` + /// state can be used for speech synthesis. /// /// When it processes a request, the service attempts to align the text and the audio that are provided for the /// prompt. The text that is passed with a prompt must match the spoken audio as closely as possible. Optimally, @@ -2028,10 +2069,8 @@ public DetailedResponse ListCustomPrompts(string customizationId) /// If a prompt that is created without a speaker ID does not adequately reflect the intended prosody, enrolling /// the speaker and providing a speaker ID for the prompt is one recommended means of potentially improving the /// quality of the prompt. This is especially important for shorter prompts such as "good-bye" or "thank you," - /// where less audio data makes it more difficult to match the prosody of the speaker. - /// - /// **Beta:** Custom prompts are beta functionality that is supported only for use with US English custom models - /// and voices. + /// where less audio data makes it more difficult to match the prosody of the speaker. Custom prompts are + /// supported only for use with US English custom models and voices. /// /// **See also:** /// * [Add a custom @@ -2141,10 +2180,8 @@ public DetailedResponse AddCustomPrompt(string customizationId, string p /// /// Gets information about a specified custom prompt for a specified custom model. The information includes the /// prompt ID, prompt text, status, and optional speaker ID for each prompt of the custom model. You must use - /// credentials for the instance of the service that owns the custom model. - /// - /// **Beta:** Custom prompts are beta functionality that is supported only for use with US English custom models - /// and voices. + /// credentials for the instance of the service that owns the custom model. Custom prompts are supported only + /// for use with US English custom models and voices. /// /// **See also:** [Listing custom /// prompts](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-tbe-custom-prompts#tbe-custom-prompts-list). @@ -2209,9 +2246,7 @@ public DetailedResponse GetCustomPrompt(string customizationId, string p /// /// **Caution:** Deleting a custom prompt elicits a 400 response code from synthesis requests that attempt to /// use the prompt. Make sure that you do not attempt to use a deleted prompt in a production application. - /// - /// **Beta:** Custom prompts are beta functionality that is supported only for use with US English custom models - /// and voices. + /// Custom prompts are supported only for use with US English custom models and voices. /// /// **See also:** [Deleting a custom /// prompt](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-tbe-custom-prompts#tbe-custom-prompts-delete). @@ -2270,10 +2305,8 @@ public DetailedResponse DeleteCustomPrompt(string customizationId, strin /// /// Lists information about all speaker models that are defined for a service instance. The information includes /// the speaker ID and speaker name of each defined speaker. You must use credentials for the instance of a - /// service to list its speakers. - /// - /// **Beta:** Speaker models and the custom prompts with which they are used are beta functionality that is - /// supported only for use with US English custom models and voices. + /// service to list its speakers. Speaker models and the custom prompts with which they are used are supported + /// only for use with US English custom models and voices. /// /// **See also:** [Listing speaker /// models](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-tbe-speaker-models#tbe-speaker-models-list). @@ -2343,10 +2376,8 @@ public DetailedResponse ListSpeakerModels() /// the call returns, the audio is fully processed and the speaker enrollment is complete. /// /// The service returns a speaker ID with the request. A speaker ID is globally unique identifier (GUID) that - /// you use to identify the speaker in subsequent requests to the service. - /// - /// **Beta:** Speaker models and the custom prompts with which they are used are beta functionality that is - /// supported only for use with US English custom models and voices. + /// you use to identify the speaker in subsequent requests to the service. Speaker models and the custom prompts + /// with which they are used are supported only for use with US English custom models and voices. /// /// **See also:** /// * [Create a speaker @@ -2420,10 +2451,8 @@ public DetailedResponse CreateSpeakerModel(string speakerName, Sys /// owned by a service instance. The information is grouped by the customization IDs of the custom models. For /// each custom model, the information lists information about each prompt that is defined for that custom model /// by the speaker. You must use credentials for the instance of the service that owns a speaker model to list - /// its prompts. - /// - /// **Beta:** Speaker models and the custom prompts with which they are used are beta functionality that is - /// supported only for use with US English custom models and voices. + /// its prompts. Speaker models and the custom prompts with which they are used are supported only for use with + /// US English custom models and voices. /// /// **See also:** [Listing the custom prompts for a speaker /// model](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-tbe-speaker-models#tbe-speaker-models-list-prompts). @@ -2480,10 +2509,8 @@ public DetailedResponse GetSpeakerModel(string speakerId) /// Any prompts that are associated with the deleted speaker are not affected by the speaker's deletion. The /// prosodic data that defines the quality of a prompt is established when the prompt is created. A prompt is /// static and remains unaffected by deletion of its associated speaker. However, the prompt cannot be - /// resubmitted or updated with its original speaker once that speaker is deleted. - /// - /// **Beta:** Speaker models and the custom prompts with which they are used are beta functionality that is - /// supported only for use with US English custom models and voices. + /// resubmitted or updated with its original speaker once that speaker is deleted. Speaker models and the custom + /// prompts with which they are used are supported only for use with US English custom models and voices. /// /// **See also:** [Deleting a speaker /// model](https://cloud.ibm.com/docs/text-to-speech?topic=text-to-speech-tbe-speaker-models#tbe-speaker-models-delete). From 603bd99ae8bd9a733298c85f64776575a6596370 Mon Sep 17 00:00:00 2001 From: Nanwarin Chantarutai Date: Wed, 8 Sep 2021 13:52:42 -0700 Subject: [PATCH 05/26] feat(stt): more languages supported for next generation models --- .../SpeechToTextService.cs | 749 +++++++++++------- 1 file changed, 479 insertions(+), 270 deletions(-) diff --git a/src/IBM.Watson.SpeechToText.v1/SpeechToTextService.cs b/src/IBM.Watson.SpeechToText.v1/SpeechToTextService.cs index 0be6e301dc..a5d191a33e 100644 --- a/src/IBM.Watson.SpeechToText.v1/SpeechToTextService.cs +++ b/src/IBM.Watson.SpeechToText.v1/SpeechToTextService.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2016, 2021. +* (C) Copyright IBM Corp. 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -16,7 +16,7 @@ */ /** -* IBM OpenAPI SDK Code Generator Version: 99-SNAPSHOT-902c9336-20210513-140138 +* IBM OpenAPI SDK Code Generator Version: 3.38.0-07189efd-20210827-205025 */ using System.Collections.Generic; @@ -102,9 +102,9 @@ public DetailedResponse ListModels() /// /// **See also:** [Listing models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-models-list). /// - /// The identifier of the model in the form of its name from the output of the **Get a - /// model** method. (**Note:** The model `ar-AR_BroadbandModel` is deprecated; use `ar-MS_BroadbandModel` - /// instead.). + /// The identifier of the model in the form of its name from the output of the [List + /// models](#listmodels) method. (**Note:** The model `ar-AR_BroadbandModel` is deprecated; use + /// `ar-MS_BroadbandModel` instead.). /// SpeechModel public DetailedResponse GetModel(string modelId) { @@ -151,8 +151,8 @@ public DetailedResponse GetModel(string modelId) public class GetModelEnums { /// - /// The identifier of the model in the form of its name from the output of the **Get a model** method. - /// (**Note:** The model `ar-AR_BroadbandModel` is deprecated; use `ar-MS_BroadbandModel` instead.). + /// The identifier of the model in the form of its name from the output of the [List models](#listmodels) + /// method. (**Note:** The model `ar-AR_BroadbandModel` is deprecated; use `ar-MS_BroadbandModel` instead.). /// public class ModelIdValue { @@ -205,6 +205,10 @@ public class ModelIdValue /// public const string EN_GB_TELEPHONY = "en-GB_Telephony"; /// + /// Constant EN_IN_TELEPHONY for en-IN_Telephony + /// + public const string EN_IN_TELEPHONY = "en-IN_Telephony"; + /// /// Constant EN_US_BROADBANDMODEL for en-US_BroadbandModel /// public const string EN_US_BROADBANDMODEL = "en-US_BroadbandModel"; @@ -293,6 +297,10 @@ public class ModelIdValue /// public const string FR_FR_BROADBANDMODEL = "fr-FR_BroadbandModel"; /// + /// Constant FR_FR_MULTIMEDIA for fr-FR_Multimedia + /// + public const string FR_FR_MULTIMEDIA = "fr-FR_Multimedia"; + /// /// Constant FR_FR_NARROWBANDMODEL for fr-FR_NarrowbandModel /// public const string FR_FR_NARROWBANDMODEL = "fr-FR_NarrowbandModel"; @@ -301,6 +309,10 @@ public class ModelIdValue /// public const string FR_FR_TELEPHONY = "fr-FR_Telephony"; /// + /// Constant HI_IN_TELEPHONY for hi-IN_Telephony + /// + public const string HI_IN_TELEPHONY = "hi-IN_Telephony"; + /// /// Constant IT_IT_BROADBANDMODEL for it-IT_BroadbandModel /// public const string IT_IT_BROADBANDMODEL = "it-IT_BroadbandModel"; @@ -317,6 +329,10 @@ public class ModelIdValue /// public const string JA_JP_BROADBANDMODEL = "ja-JP_BroadbandModel"; /// + /// Constant JA_JP_MULTIMEDIA for ja-JP_Multimedia + /// + public const string JA_JP_MULTIMEDIA = "ja-JP_Multimedia"; + /// /// Constant JA_JP_NARROWBANDMODEL for ja-JP_NarrowbandModel /// public const string JA_JP_NARROWBANDMODEL = "ja-JP_NarrowbandModel"; @@ -325,10 +341,22 @@ public class ModelIdValue /// public const string KO_KR_BROADBANDMODEL = "ko-KR_BroadbandModel"; /// + /// Constant KO_KR_MULTIMEDIA for ko-KR_Multimedia + /// + public const string KO_KR_MULTIMEDIA = "ko-KR_Multimedia"; + /// /// Constant KO_KR_NARROWBANDMODEL for ko-KR_NarrowbandModel /// public const string KO_KR_NARROWBANDMODEL = "ko-KR_NarrowbandModel"; /// + /// Constant KO_KR_TELEPHONY for ko-KR_Telephony + /// + public const string KO_KR_TELEPHONY = "ko-KR_Telephony"; + /// + /// Constant NL_BE_TELEPHONY for nl-BE_Telephony + /// + public const string NL_BE_TELEPHONY = "nl-BE_Telephony"; + /// /// Constant NL_NL_BROADBANDMODEL for nl-NL_BroadbandModel /// public const string NL_NL_BROADBANDMODEL = "nl-NL_BroadbandModel"; @@ -421,30 +449,20 @@ public class ModelIdValue /// /// ### Next-generation models /// - /// **Note:** The next-generation language models are beta functionality. They support a limited number of - /// languages and features at this time. The supported languages, models, and features will increase with future - /// releases. - /// - /// The service supports next-generation `Multimedia` (16 kHz) and `Telephony` (8 kHz) models for many + /// The service supports next-generation `Multimedia` (16 kHz) and `Telephony` (8 kHz) models for many /// languages. Next-generation models have higher throughput than the service's previous generation of /// `Broadband` and `Narrowband` models. When you use next-generation models, the service can return /// transcriptions more quickly and also provide noticeably better transcription accuracy. /// /// You specify a next-generation model by using the `model` query parameter, as you do a previous-generation - /// model. Next-generation models support the same request headers as previous-generation models, but they - /// support only the following additional query parameters: - /// * `background_audio_suppression` - /// * `inactivity_timeout` - /// * `profanity_filter` - /// * `redaction` - /// * `smart_formatting` - /// * `speaker_labels` - /// * `speech_detector_sensitivity` - /// * `timestamps` - /// - /// Many next-generation models also support the beta `low_latency` parameter, which is not available with + /// model. Many next-generation models also support the `low_latency` parameter, which is not available with /// previous-generation models. /// + /// But next-generation models do not support all of the parameters that are available for use with + /// previous-generation models. For more information about all parameters that are supported for use with + /// next-generation models, see [Supported features for next-generation + /// models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-models-ng#models-ng-features). + /// /// **See also:** [Next-generation languages and /// models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-models-ng). /// @@ -468,7 +486,8 @@ public class ModelIdValue /// The format (MIME type) of the audio. For more information about specifying an /// audio format, see **Audio formats (content types)** in the method description. (optional) /// The identifier of the model that is to be used for the recognition request. (**Note:** - /// The model `ar-AR_BroadbandModel` is deprecated; use `ar-MS_BroadbandModel` instead.) See [Languages and + /// The model `ar-AR_BroadbandModel` is deprecated; use `ar-MS_BroadbandModel` instead.) See + /// [Previous-generation languages and /// models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-models) and [Next-generation /// languages and models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-models-ng). (optional, /// default to en-US_BroadbandModel) @@ -561,7 +580,8 @@ public class ModelIdValue /// the final transcript of a recognition request. For US English, the service also converts certain keyword /// strings to punctuation symbols. By default, the service performs no smart formatting. /// - /// **Note:** Applies to US English, Japanese, and Spanish transcription only. + /// **Beta:** The parameter is beta functionality. Applies to US English, Japanese, and Spanish transcription + /// only. /// /// See [Smart /// formatting](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-formatting#smart-formatting). @@ -570,10 +590,13 @@ public class ModelIdValue /// which participants in a multi-person exchange. By default, the service returns no speaker labels. Setting /// `speaker_labels` to `true` forces the `timestamps` parameter to be `true`, regardless of whether you specify /// `false` for the parameter. - /// * For previous-generation models, can be used for US English, Australian English, German, Japanese, Korean, - /// and Spanish (both broadband and narrowband models) and UK English (narrowband model) transcription only. - /// * For next-generation models, can be used for English (Australian, UK, and US), German, and Spanish + /// + /// **Beta:** The parameter is beta functionality. + /// * For previous-generation models, the parameter can be used for Australian English, US English, German, + /// Japanese, Korean, and Spanish (both broadband and narrowband models) and UK English (narrowband model) /// transcription only. + /// * For next-generation models, the parameter can be used for English (Australian, Indian, UK, and US), + /// German, Japanese, Korean, and Spanish transcription only. /// /// Restrictions and limitations apply to the use of speaker labels for both types of models. See [Speaker /// labels](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-speaker-labels). (optional, default @@ -585,7 +608,11 @@ public class ModelIdValue /// specify a grammar, you must also use the `language_customization_id` parameter to specify the name of the /// custom language model for which the grammar is defined. The service recognizes only strings that are /// recognized by the specified grammar; it does not recognize other custom words from the model's words - /// resource. See [Using a grammar for speech + /// resource. + /// + /// **Beta:** The parameter is beta functionality. + /// + /// See [Using a grammar for speech /// recognition](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-grammarUse). (optional) /// If `true`, the service redacts, or masks, numeric data from final transcripts. The /// feature redacts any number that has three or more consecutive digits by replacing each digit with an `X` @@ -597,7 +624,8 @@ public class ModelIdValue /// (ignores the `keywords` and `keywords_threshold` parameters) and returns only a single final transcript /// (forces the `max_alternatives` parameter to be `1`). /// - /// **Note:** Applies to US English, Japanese, and Korean transcription only. + /// **Beta:** The parameter is beta functionality. Applies to US English, Japanese, and Korean transcription + /// only. /// /// See [Numeric /// redaction](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-formatting#numeric-redaction). @@ -663,12 +691,10 @@ public class ModelIdValue /// causes the models to produce results even more quickly, though the results might be less accurate when the /// parameter is used. /// - /// **Note:** The parameter is beta functionality. It is not available for previous-generation `Broadband` and - /// `Narrowband` models. It is available only for some next-generation models. - /// - /// * For a list of next-generation models that support low latency, see [Supported language - /// models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-models-ng#models-ng-supported) for - /// next-generation models. + /// The parameter is not available for previous-generation `Broadband` and `Narrowband` models. It is available + /// only for some next-generation models. For a list of next-generation models that support low latency, see + /// [Supported next-generation language + /// models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-models-ng#models-ng-supported). /// * For more information about the `low_latency` parameter, see [Low /// latency](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-interim#low-latency). (optional, /// default to false) @@ -893,9 +919,10 @@ public class ContentTypeValue } /// /// The identifier of the model that is to be used for the recognition request. (**Note:** The model - /// `ar-AR_BroadbandModel` is deprecated; use `ar-MS_BroadbandModel` instead.) See [Languages and - /// models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-models) and [Next-generation - /// languages and models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-models-ng). + /// `ar-AR_BroadbandModel` is deprecated; use `ar-MS_BroadbandModel` instead.) See [Previous-generation + /// languages and models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-models) and + /// [Next-generation languages and + /// models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-models-ng). /// public class ModelValue { @@ -936,6 +963,10 @@ public class ModelValue /// public const string EN_AU_TELEPHONY = "en-AU_Telephony"; /// + /// Constant EN_IN_TELEPHONY for en-IN_Telephony + /// + public const string EN_IN_TELEPHONY = "en-IN_Telephony"; + /// /// Constant EN_GB_BROADBANDMODEL for en-GB_BroadbandModel /// public const string EN_GB_BROADBANDMODEL = "en-GB_BroadbandModel"; @@ -1036,6 +1067,10 @@ public class ModelValue /// public const string FR_FR_BROADBANDMODEL = "fr-FR_BroadbandModel"; /// + /// Constant FR_FR_MULTIMEDIA for fr-FR_Multimedia + /// + public const string FR_FR_MULTIMEDIA = "fr-FR_Multimedia"; + /// /// Constant FR_FR_NARROWBANDMODEL for fr-FR_NarrowbandModel /// public const string FR_FR_NARROWBANDMODEL = "fr-FR_NarrowbandModel"; @@ -1044,6 +1079,10 @@ public class ModelValue /// public const string FR_FR_TELEPHONY = "fr-FR_Telephony"; /// + /// Constant HI_IN_TELEPHONY for hi-IN_Telephony + /// + public const string HI_IN_TELEPHONY = "hi-IN_Telephony"; + /// /// Constant IT_IT_BROADBANDMODEL for it-IT_BroadbandModel /// public const string IT_IT_BROADBANDMODEL = "it-IT_BroadbandModel"; @@ -1060,6 +1099,10 @@ public class ModelValue /// public const string JA_JP_BROADBANDMODEL = "ja-JP_BroadbandModel"; /// + /// Constant JA_JP_MULTIMEDIA for ja-JP_Multimedia + /// + public const string JA_JP_MULTIMEDIA = "ja-JP_Multimedia"; + /// /// Constant JA_JP_NARROWBANDMODEL for ja-JP_NarrowbandModel /// public const string JA_JP_NARROWBANDMODEL = "ja-JP_NarrowbandModel"; @@ -1068,10 +1111,22 @@ public class ModelValue /// public const string KO_KR_BROADBANDMODEL = "ko-KR_BroadbandModel"; /// + /// Constant KO_KR_MULTIMEDIA for ko-KR_Multimedia + /// + public const string KO_KR_MULTIMEDIA = "ko-KR_Multimedia"; + /// /// Constant KO_KR_NARROWBANDMODEL for ko-KR_NarrowbandModel /// public const string KO_KR_NARROWBANDMODEL = "ko-KR_NarrowbandModel"; /// + /// Constant KO_KR_TELEPHONY for ko-KR_Telephony + /// + public const string KO_KR_TELEPHONY = "ko-KR_Telephony"; + /// + /// Constant NL_BE_TELEPHONY for nl-BE_Telephony + /// + public const string NL_BE_TELEPHONY = "nl-BE_Telephony"; + /// /// Constant NL_NL_BROADBANDMODEL for nl-NL_BroadbandModel /// public const string NL_NL_BROADBANDMODEL = "nl-NL_BroadbandModel"; @@ -1118,8 +1173,8 @@ public class ModelValue /// /// The service sends only a single `GET` request to the callback URL. If the service does not receive a reply /// with a response code of 200 and a body that echoes the challenge string sent by the service within five - /// seconds, it does not allowlist the URL; it instead sends status code 400 in response to the **Register a - /// callback** request. If the requested callback URL is already allowlisted, the service responds to the + /// seconds, it does not allowlist the URL; it instead sends status code 400 in response to the request to + /// register a callback. If the requested callback URL is already allowlisted, the service responds to the /// initial registration request with response code 200. /// /// If you specify a user secret with the request, the service uses it as a key to calculate an HMAC-SHA1 @@ -1189,9 +1244,9 @@ public DetailedResponse RegisterCallback(string callbackUrl, str /// /// Unregister a callback. /// - /// Unregisters a callback URL that was previously allowlisted with a **Register a callback** request for use - /// with the asynchronous interface. Once unregistered, the URL can no longer be used with asynchronous - /// recognition requests. + /// Unregisters a callback URL that was previously allowlisted with a [Register a callback](#registercallback) + /// request for use with the asynchronous interface. Once unregistered, the URL can no longer be used with + /// asynchronous recognition requests. /// /// **See also:** [Unregistering a callback /// URL](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-async#unregister). @@ -1247,15 +1302,15 @@ public DetailedResponse UnregisterCallback(string callbackUrl) /// `events` and `user_token` parameters to subscribe to specific events and to specify a string that is to be /// included with each notification for the job. /// * By polling the service: Omit the `callback_url`, `events`, and `user_token` parameters. You must then use - /// the **Check jobs** or **Check a job** methods to check the status of the job, using the latter to retrieve - /// the results when the job is complete. + /// the [Check jobs](#checkjobs) or [Check a job](#checkjob) methods to check the status of the job, using the + /// latter to retrieve the results when the job is complete. /// /// The two approaches are not mutually exclusive. You can poll the service for job status or obtain results /// from the service manually even if you include a callback URL. In both cases, you can include the /// `results_ttl` parameter to specify how long the results are to remain available after the job is complete. - /// Using the HTTPS **Check a job** method to retrieve results is more secure than receiving them via callback - /// notification over HTTP because it provides confidentiality in addition to authentication and data integrity. - /// + /// Using the HTTPS [Check a job](#checkjob) method to retrieve results is more secure than receiving them via + /// callback notification over HTTP because it provides confidentiality in addition to authentication and data + /// integrity. /// /// The method supports the same basic parameters as other HTTP and WebSocket recognition requests. It also /// supports the following parameters specific to the asynchronous interface: @@ -1323,30 +1378,20 @@ public DetailedResponse UnregisterCallback(string callbackUrl) /// /// ### Next-generation models /// - /// **Note:** The next-generation language models are beta functionality. They support a limited number of - /// languages and features at this time. The supported languages, models, and features will increase with future - /// releases. - /// - /// The service supports next-generation `Multimedia` (16 kHz) and `Telephony` (8 kHz) models for many + /// The service supports next-generation `Multimedia` (16 kHz) and `Telephony` (8 kHz) models for many /// languages. Next-generation models have higher throughput than the service's previous generation of /// `Broadband` and `Narrowband` models. When you use next-generation models, the service can return /// transcriptions more quickly and also provide noticeably better transcription accuracy. /// /// You specify a next-generation model by using the `model` query parameter, as you do a previous-generation - /// model. Next-generation models support the same request headers as previous-generation models, but they - /// support only the following additional query parameters: - /// * `background_audio_suppression` - /// * `inactivity_timeout` - /// * `profanity_filter` - /// * `redaction` - /// * `smart_formatting` - /// * `speaker_labels` - /// * `speech_detector_sensitivity` - /// * `timestamps` - /// - /// Many next-generation models also support the beta `low_latency` parameter, which is not available with + /// model. Many next-generation models also support the `low_latency` parameter, which is not available with /// previous-generation models. /// + /// But next-generation models do not support all of the parameters that are available for use with + /// previous-generation models. For more information about all parameters that are supported for use with + /// next-generation models, see [Supported features for next-generation + /// models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-models-ng#models-ng-features). + /// /// **See also:** [Next-generation languages and /// models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-models-ng). /// @@ -1354,14 +1399,15 @@ public DetailedResponse UnregisterCallback(string callbackUrl) /// The format (MIME type) of the audio. For more information about specifying an /// audio format, see **Audio formats (content types)** in the method description. (optional) /// The identifier of the model that is to be used for the recognition request. (**Note:** - /// The model `ar-AR_BroadbandModel` is deprecated; use `ar-MS_BroadbandModel` instead.) See [Languages and + /// The model `ar-AR_BroadbandModel` is deprecated; use `ar-MS_BroadbandModel` instead.) See + /// [Previous-generation languages and /// models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-models) and [Next-generation /// languages and models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-models-ng). (optional, /// default to en-US_BroadbandModel) /// A URL to which callback notifications are to be sent. The URL must already be - /// successfully allowlisted by using the **Register a callback** method. You can include the same callback URL - /// with any number of job creation requests. Omit the parameter to poll the service for job completion and - /// results. + /// successfully allowlisted by using the [Register a callback](#registercallback) method. You can include the + /// same callback URL with any number of job creation requests. Omit the parameter to poll the service for job + /// completion and results. /// /// Use the `user_token` parameter to specify a unique user-specified string with each job to differentiate the /// callback notifications for the jobs. (optional) @@ -1369,7 +1415,7 @@ public DetailedResponse UnregisterCallback(string callbackUrl) /// which to subscribe. Valid events are /// * `recognitions.started` generates a callback notification when the service begins to process the job. /// * `recognitions.completed` generates a callback notification when the job is complete. You must use the - /// **Check a job** method to retrieve the results before they time out or are deleted. + /// [Check a job](#checkjob) method to retrieve the results before they time out or are deleted. /// * `recognitions.completed_with_results` generates a callback notification when the job is complete. The /// notification includes the results of the request. /// * `recognitions.failed` generates a callback notification if the service experiences an error while @@ -1478,7 +1524,8 @@ public DetailedResponse UnregisterCallback(string callbackUrl) /// the final transcript of a recognition request. For US English, the service also converts certain keyword /// strings to punctuation symbols. By default, the service performs no smart formatting. /// - /// **Note:** Applies to US English, Japanese, and Spanish transcription only. + /// **Beta:** The parameter is beta functionality. Applies to US English, Japanese, and Spanish transcription + /// only. /// /// See [Smart /// formatting](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-formatting#smart-formatting). @@ -1487,10 +1534,13 @@ public DetailedResponse UnregisterCallback(string callbackUrl) /// which participants in a multi-person exchange. By default, the service returns no speaker labels. Setting /// `speaker_labels` to `true` forces the `timestamps` parameter to be `true`, regardless of whether you specify /// `false` for the parameter. - /// * For previous-generation models, can be used for US English, Australian English, German, Japanese, Korean, - /// and Spanish (both broadband and narrowband models) and UK English (narrowband model) transcription only. - /// * For next-generation models, can be used for English (Australian, UK, and US), German, and Spanish + /// + /// **Beta:** The parameter is beta functionality. + /// * For previous-generation models, the parameter can be used for Australian English, US English, German, + /// Japanese, Korean, and Spanish (both broadband and narrowband models) and UK English (narrowband model) /// transcription only. + /// * For next-generation models, the parameter can be used for English (Australian, Indian, UK, and US), + /// German, Japanese, Korean, and Spanish transcription only. /// /// Restrictions and limitations apply to the use of speaker labels for both types of models. See [Speaker /// labels](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-speaker-labels). (optional, default @@ -1502,7 +1552,11 @@ public DetailedResponse UnregisterCallback(string callbackUrl) /// specify a grammar, you must also use the `language_customization_id` parameter to specify the name of the /// custom language model for which the grammar is defined. The service recognizes only strings that are /// recognized by the specified grammar; it does not recognize other custom words from the model's words - /// resource. See [Using a grammar for speech + /// resource. + /// + /// **Beta:** The parameter is beta functionality. + /// + /// See [Using a grammar for speech /// recognition](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-grammarUse). (optional) /// If `true`, the service redacts, or masks, numeric data from final transcripts. The /// feature redacts any number that has three or more consecutive digits by replacing each digit with an `X` @@ -1514,7 +1568,8 @@ public DetailedResponse UnregisterCallback(string callbackUrl) /// (ignores the `keywords` and `keywords_threshold` parameters) and returns only a single final transcript /// (forces the `max_alternatives` parameter to be `1`). /// - /// **Note:** Applies to US English, Japanese, and Korean transcription only. + /// **Beta:** The parameter is beta functionality. Applies to US English, Japanese, and Korean transcription + /// only. /// /// See [Numeric /// redaction](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-formatting#numeric-redaction). @@ -1603,12 +1658,10 @@ public DetailedResponse UnregisterCallback(string callbackUrl) /// causes the models to produce results even more quickly, though the results might be less accurate when the /// parameter is used. /// - /// **Note:** The parameter is beta functionality. It is not available for previous-generation `Broadband` and - /// `Narrowband` models. It is available only for some next-generation models. - /// - /// * For a list of next-generation models that support low latency, see [Supported language - /// models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-models-ng#models-ng-supported) for - /// next-generation models. + /// The parameter is not available for previous-generation `Broadband` and `Narrowband` models. It is available + /// only for some next-generation models. For a list of next-generation models that support low latency, see + /// [Supported next-generation language + /// models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-models-ng#models-ng-supported). /// * For more information about the `low_latency` parameter, see [Low /// latency](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-interim#low-latency). (optional, /// default to false) @@ -1857,9 +1910,10 @@ public class ContentTypeValue } /// /// The identifier of the model that is to be used for the recognition request. (**Note:** The model - /// `ar-AR_BroadbandModel` is deprecated; use `ar-MS_BroadbandModel` instead.) See [Languages and - /// models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-models) and [Next-generation - /// languages and models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-models-ng). + /// `ar-AR_BroadbandModel` is deprecated; use `ar-MS_BroadbandModel` instead.) See [Previous-generation + /// languages and models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-models) and + /// [Next-generation languages and + /// models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-models-ng). /// public class ModelValue { @@ -1900,6 +1954,10 @@ public class ModelValue /// public const string EN_AU_TELEPHONY = "en-AU_Telephony"; /// + /// Constant EN_IN_TELEPHONY for en-IN_Telephony + /// + public const string EN_IN_TELEPHONY = "en-IN_Telephony"; + /// /// Constant EN_GB_BROADBANDMODEL for en-GB_BroadbandModel /// public const string EN_GB_BROADBANDMODEL = "en-GB_BroadbandModel"; @@ -2000,6 +2058,10 @@ public class ModelValue /// public const string FR_FR_BROADBANDMODEL = "fr-FR_BroadbandModel"; /// + /// Constant FR_FR_MULTIMEDIA for fr-FR_Multimedia + /// + public const string FR_FR_MULTIMEDIA = "fr-FR_Multimedia"; + /// /// Constant FR_FR_NARROWBANDMODEL for fr-FR_NarrowbandModel /// public const string FR_FR_NARROWBANDMODEL = "fr-FR_NarrowbandModel"; @@ -2008,6 +2070,10 @@ public class ModelValue /// public const string FR_FR_TELEPHONY = "fr-FR_Telephony"; /// + /// Constant HI_IN_TELEPHONY for hi-IN_Telephony + /// + public const string HI_IN_TELEPHONY = "hi-IN_Telephony"; + /// /// Constant IT_IT_BROADBANDMODEL for it-IT_BroadbandModel /// public const string IT_IT_BROADBANDMODEL = "it-IT_BroadbandModel"; @@ -2024,6 +2090,10 @@ public class ModelValue /// public const string JA_JP_BROADBANDMODEL = "ja-JP_BroadbandModel"; /// + /// Constant JA_JP_MULTIMEDIA for ja-JP_Multimedia + /// + public const string JA_JP_MULTIMEDIA = "ja-JP_Multimedia"; + /// /// Constant JA_JP_NARROWBANDMODEL for ja-JP_NarrowbandModel /// public const string JA_JP_NARROWBANDMODEL = "ja-JP_NarrowbandModel"; @@ -2032,10 +2102,22 @@ public class ModelValue /// public const string KO_KR_BROADBANDMODEL = "ko-KR_BroadbandModel"; /// + /// Constant KO_KR_MULTIMEDIA for ko-KR_Multimedia + /// + public const string KO_KR_MULTIMEDIA = "ko-KR_Multimedia"; + /// /// Constant KO_KR_NARROWBANDMODEL for ko-KR_NarrowbandModel /// public const string KO_KR_NARROWBANDMODEL = "ko-KR_NarrowbandModel"; /// + /// Constant KO_KR_TELEPHONY for ko-KR_Telephony + /// + public const string KO_KR_TELEPHONY = "ko-KR_Telephony"; + /// + /// Constant NL_BE_TELEPHONY for nl-BE_Telephony + /// + public const string NL_BE_TELEPHONY = "nl-BE_Telephony"; + /// /// Constant NL_NL_BROADBANDMODEL for nl-NL_BroadbandModel /// public const string NL_NL_BROADBANDMODEL = "nl-NL_BroadbandModel"; @@ -2070,7 +2152,7 @@ public class ModelValue /// Valid events are /// * `recognitions.started` generates a callback notification when the service begins to process the job. /// * `recognitions.completed` generates a callback notification when the job is complete. You must use the - /// **Check a job** method to retrieve the results before they time out or are deleted. + /// [Check a job](#checkjob) method to retrieve the results before they time out or are deleted. /// * `recognitions.completed_with_results` generates a callback notification when the job is complete. The /// notification includes the results of the request. /// * `recognitions.failed` generates a callback notification if the service experiences an error while @@ -2111,9 +2193,9 @@ public class EventsValue /// Returns the ID and status of the latest 100 outstanding jobs associated with the credentials with which it /// is called. The method also returns the creation and update times of each job, and, if a job was created with /// a callback URL and a user token, the user token for the job. To obtain the results for a job whose status is - /// `completed` or not one of the latest 100 outstanding jobs, use the **Check a job** method. A job and its - /// results remain available until you delete them with the **Delete a job** method or until the job's time to - /// live expires, whichever comes first. + /// `completed` or not one of the latest 100 outstanding jobs, use the [Check a job[(#checkjob) method. A job + /// and its results remain available until you delete them with the [Delete a job](#deletejob) method or until + /// the job's time to live expires, whichever comes first. /// /// **See also:** [Checking the status of the latest /// jobs](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-async#jobs). @@ -2160,8 +2242,8 @@ public DetailedResponse CheckJobs() /// /// You can use the method to retrieve the results of any job, regardless of whether it was submitted with a /// callback URL and the `recognitions.completed_with_results` event, and you can retrieve the results multiple - /// times for as long as they remain available. Use the **Check jobs** method to request information about the - /// most recent jobs associated with the calling credentials. + /// times for as long as they remain available. Use the [Check jobs](#checkjobs) method to request information + /// about the most recent jobs associated with the calling credentials. /// /// **See also:** [Checking the status and retrieving the results of a /// job](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-async#job). @@ -2280,27 +2362,24 @@ public DetailedResponse DeleteJob(string id) /// The name of the base language model that is to be customized by the new custom /// language model. The new custom model can be used only with the base model that it customizes. /// - /// To determine whether a base model supports language model customization, use the **Get a model** method and - /// check that the attribute `custom_language_model` is set to `true`. You can also refer to [Language support - /// for - /// customization](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-customization#languageSupport). + /// To determine whether a base model supports language model customization, use the [Get a model](#getmodel) + /// method and check that the attribute `custom_language_model` is set to `true`. You can also refer to + /// [Language support for + /// customization](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-custom-support#custom-language-support). /// The dialect of the specified language that is to be used with the custom language /// model. For most languages, the dialect matches the language of the base model by default. For example, - /// `en-US` is used for either of the US English language models. + /// `en-US` is used for the US English language models. All dialect values are case-insensitive. /// - /// For a Spanish language, the service creates a custom language model that is suited for speech in one of the - /// following dialects: + /// The parameter is meaningful only for Spanish language models, for which you can always safely omit the + /// parameter to have the service create the correct mapping. For Spanish, the service creates a custom language + /// model that is suited for speech in one of the following dialects: /// * `es-ES` for Castilian Spanish (`es-ES` models) /// * `es-LA` for Latin American Spanish (`es-AR`, `es-CL`, `es-CO`, and `es-PE` models) /// * `es-US` for Mexican (North American) Spanish (`es-MX` models) /// - /// The parameter is meaningful only for Spanish models, for which you can always safely omit the parameter to - /// have the service create the correct mapping. - /// - /// If you specify the `dialect` parameter for non-Spanish language models, its value must match the language of - /// the base model. If you specify the `dialect` for Spanish language models, its value must match one of the - /// defined mappings as indicated (`es-ES`, `es-LA`, or `es-MX`). All dialect values are case-insensitive. - /// (optional) + /// If you specify the `dialect` parameter for a non-Spanish language model, its value must match the language + /// of the base model. If you specify the `dialect` for a Spanish language model, its value must match one of + /// the defined mappings (`es-ES`, `es-LA`, or `es-MX`). (optional) /// A description of the new custom language model. Use a localized description that /// matches the language of the custom model. (optional) /// LanguageModel @@ -2380,7 +2459,7 @@ public DetailedResponse CreateLanguageModel(string name, string b /// by the requesting credentials. (**Note:** The identifier `ar-AR` is deprecated; use `ar-MS` instead.) /// /// To determine the languages for which customization is available, see [Language support for - /// customization](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-customization#languageSupport). + /// customization](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-custom-support#custom-language-support). /// (optional) /// LanguageModels public DetailedResponse ListLanguageModels(string language = null) @@ -2429,7 +2508,7 @@ public class ListLanguageModelsEnums /// credentials. (**Note:** The identifier `ar-AR` is deprecated; use `ar-MS` instead.) /// /// To determine the languages for which customization is available, see [Language support for - /// customization](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-customization#languageSupport). + /// customization](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-custom-support#custom-language-support). /// public class LanguageValue { @@ -2454,6 +2533,10 @@ public class LanguageValue /// public const string EN_GB = "en-GB"; /// + /// Constant EN_IN for en-IN + /// + public const string EN_IN = "en-IN"; + /// /// Constant EN_US for en-US /// public const string EN_US = "en-US"; @@ -2490,6 +2573,10 @@ public class LanguageValue /// public const string FR_FR = "fr-FR"; /// + /// Constant HI_IN for hi-IN + /// + public const string HI_IN = "hi-IN"; + /// /// Constant IT_IT for it-IT /// public const string IT_IT = "it-IT"; @@ -2502,6 +2589,10 @@ public class LanguageValue /// public const string KO_KR = "ko-KR"; /// + /// Constant NL_BE for nl-BE + /// + public const string NL_BE = "nl-BE"; + /// /// Constant NL_NL for nl-NL /// public const string NL_NL = "nl-NL"; @@ -2635,11 +2726,11 @@ public DetailedResponse DeleteLanguageModel(string customizationId) /// of data on which the service is being trained and the current load on the service. The method returns an /// HTTP 200 response code to indicate that the training process has begun. /// - /// You can monitor the status of the training by using the **Get a custom language model** method to poll the - /// model's status. Use a loop to check the status every 10 seconds. The method returns a `LanguageModel` object - /// that includes `status` and `progress` fields. A status of `available` means that the custom model is trained - /// and ready to use. The service cannot accept subsequent training requests or requests to add new resources - /// until the existing request completes. + /// You can monitor the status of the training by using the [Get a custom language model](#getlanguagemodel) + /// method to poll the model's status. Use a loop to check the status every 10 seconds. The method returns a + /// `LanguageModel` object that includes `status` and `progress` fields. A status of `available` means that the + /// custom model is trained and ready to use. The service cannot accept subsequent training requests or requests + /// to add new resources until the existing request completes. /// /// **See also:** [Train the custom language /// model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-languageCreate#trainModel-language). @@ -2658,12 +2749,16 @@ public DetailedResponse DeleteLanguageModel(string customizationId) /// The customization ID (GUID) of the custom language model that is to be used /// for the request. You must make the request with credentials for the instance of the service that owns the /// custom model. - /// The type of words from the custom language model's words resource on which to - /// train the model: + /// _For custom models that are based on previous-generation models_, the type of + /// words from the custom language model's words resource on which to train the model: /// * `all` (the default) trains the model on all new words, regardless of whether they were extracted from /// corpora or grammars or were added or modified by the user. - /// * `user` trains the model only on new words that were added or modified by the user directly. The model is - /// not trained on new words extracted from corpora or grammars. (optional, default to all) + /// * `user` trains the model only on custom words that were added or modified by the user directly. The model + /// is not trained on new words extracted from corpora or grammars. + /// + /// _For custom models that are based on next-generation models_, the service ignores the parameter. The words + /// resource contains only custom words that the user adds or modifies directly, so the parameter is + /// unnecessary. (optional, default to all) /// Specifies a customization weight for the custom language model. The /// customization weight tells the service how much weight to give to words from the custom language model /// compared to those from the base model for speech recognition. Specify a value between 0.0 and 1.0; the @@ -2734,11 +2829,16 @@ public DetailedResponse TrainLanguageModel(string customizatio public class TrainLanguageModelEnums { /// - /// The type of words from the custom language model's words resource on which to train the model: + /// _For custom models that are based on previous-generation models_, the type of words from the custom + /// language model's words resource on which to train the model: /// * `all` (the default) trains the model on all new words, regardless of whether they were extracted from /// corpora or grammars or were added or modified by the user. - /// * `user` trains the model only on new words that were added or modified by the user directly. The model - /// is not trained on new words extracted from corpora or grammars. + /// * `user` trains the model only on custom words that were added or modified by the user directly. The + /// model is not trained on new words extracted from corpora or grammars. + /// + /// _For custom models that are based on next-generation models_, the service ignores the parameter. The + /// words resource contains only custom words that the user adds or modifies directly, so the parameter is + /// unnecessary. /// public class WordTypeToAddValue { @@ -2818,11 +2918,14 @@ public DetailedResponse ResetLanguageModel(string customizationId) /// to upgrade it. /// /// The method returns an HTTP 200 response code to indicate that the upgrade process has begun successfully. - /// You can monitor the status of the upgrade by using the **Get a custom language model** method to poll the - /// model's status. The method returns a `LanguageModel` object that includes `status` and `progress` fields. - /// Use a loop to check the status every 10 seconds. While it is being upgraded, the custom model has the status - /// `upgrading`. When the upgrade is complete, the model resumes the status that it had prior to upgrade. The - /// service cannot accept subsequent requests for the model until the upgrade completes. + /// You can monitor the status of the upgrade by using the [Get a custom language model](#getlanguagemodel) + /// method to poll the model's status. The method returns a `LanguageModel` object that includes `status` and + /// `progress` fields. Use a loop to check the status every 10 seconds. While it is being upgraded, the custom + /// model has the status `upgrading`. When the upgrade is complete, the model resumes the status that it had + /// prior to upgrade. The service cannot accept subsequent requests for the model until the upgrade completes. + /// + /// **Note:** Upgrading is necessary only for custom language models that are based on previous-generation + /// models. Only a single version of a custom model that is based on a next-generation model is ever available. /// /// **See also:** [Upgrading a custom language /// model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-custom-upgrade#custom-upgrade-language). @@ -2872,8 +2975,9 @@ public DetailedResponse UpgradeLanguageModel(string customizationId) /// /// List corpora. /// - /// Lists information about all corpora from a custom language model. The information includes the total number - /// of words and out-of-vocabulary (OOV) words, name, and status of each corpus. You must use credentials for + /// Lists information about all corpora from a custom language model. The information includes the name, status, + /// and total number of words for each corpus. _For custom models that are based on previous-generation models_, + /// it also includes the number of out-of-vocabulary (OOV) words from the corpus. You must use credentials for /// the instance of the service that owns a model to list its corpora. /// /// **See also:** [Listing corpora for a custom language @@ -2928,43 +3032,50 @@ public DetailedResponse ListCorpora(string customizationId) /// Adds a single corpus text file of new training data to a custom language model. Use multiple requests to /// submit multiple corpus text files. You must use credentials for the instance of the service that owns a /// model to add a corpus to it. Adding a corpus does not affect the custom language model until you train the - /// model for the new data by using the **Train a custom language model** method. + /// model for the new data by using the [Train a custom language model](#trainlanguagemodel) method. /// /// Submit a plain text file that contains sample sentences from the domain of interest to enable the service to - /// extract words in context. The more sentences you add that represent the context in which speakers use words - /// from the domain, the better the service's recognition accuracy. + /// parse the words in context. The more sentences you add that represent the context in which speakers use + /// words from the domain, the better the service's recognition accuracy. /// /// The call returns an HTTP 201 response code if the corpus is valid. The service then asynchronously processes - /// the contents of the corpus and automatically extracts new words that it finds. This operation can take on - /// the order of minutes to complete depending on the total number of words and the number of new words in the - /// corpus, as well as the current load on the service. You cannot submit requests to add additional resources - /// to the custom model or to train the model until the service's analysis of the corpus for the current request - /// completes. Use the **List a corpus** method to check the status of the analysis. - /// - /// The service auto-populates the model's words resource with words from the corpus that are not found in its - /// base vocabulary. These words are referred to as out-of-vocabulary (OOV) words. After adding a corpus, you - /// must validate the words resource to ensure that each OOV word's definition is complete and valid. You can - /// use the **List custom words** method to examine the words resource. You can use other words method to - /// eliminate typos and modify how words are pronounced as needed. + /// and automatically extracts data from the contents of the corpus. This operation can take on the order of + /// minutes to complete depending on the current load on the service, the total number of words in the corpus, + /// and, _for custom models that are based on previous-generation models_, the number of new (out-of-vocabulary) + /// words in the corpus. You cannot submit requests to add additional resources to the custom model or to train + /// the model until the service's analysis of the corpus for the current request completes. Use the [Get a + /// corpus](#getcorpus) method to check the status of the analysis. + /// + /// _For custom models that are based on previous-generation models_, the service auto-populates the model's + /// words resource with words from the corpus that are not found in its base vocabulary. These words are + /// referred to as out-of-vocabulary (OOV) words. After adding a corpus, you must validate the words resource to + /// ensure that each OOV word's definition is complete and valid. You can use the [List custom + /// words](#listwords) method to examine the words resource. You can use other words method to eliminate typos + /// and modify how words are pronounced as needed. /// /// To add a corpus file that has the same name as an existing corpus, set the `allow_overwrite` parameter to /// `true`; otherwise, the request fails. Overwriting an existing corpus causes the service to process the - /// corpus text file and extract OOV words anew. Before doing so, it removes any OOV words associated with the - /// existing corpus from the model's words resource unless they were also added by another corpus or grammar, or - /// they have been modified in some way with the **Add custom words** or **Add a custom word** method. + /// corpus text file and extract its data anew. _For a custom model that is based on a previous-generation + /// model_, the service first removes any OOV words that are associated with the existing corpus from the + /// model's words resource unless they were also added by another corpus or grammar, or they have been modified + /// in some way with the [Add custom words](#addwords) or [Add a custom word](#addword) method. /// /// The service limits the overall amount of data that you can add to a custom model to a maximum of 10 million - /// total words from all sources combined. Also, you can add no more than 90 thousand custom (OOV) words to a - /// model. This includes words that the service extracts from corpora and grammars, and words that you add - /// directly. + /// total words from all sources combined. _For a custom model that is based on a previous-generation model_, + /// you can add no more than 90 thousand custom (OOV) words to a model. This includes words that the service + /// extracts from corpora and grammars, and words that you add directly. /// /// **See also:** /// * [Add a corpus to the custom language /// model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-languageCreate#addCorpus) - /// * [Working with - /// corpora](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-corporaWords#workingCorpora) - /// * [Validating a words - /// resource](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-corporaWords#validateModel). + /// * [Working with corpora for previous-generation + /// models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-corporaWords#workingCorpora) + /// * [Working with corpora for next-generation + /// models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-corporaWords-ng#workingCorpora-ng) + /// * [Validating a words resource for previous-generation + /// models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-corporaWords#validateModel) + /// * [Validating a words resource for next-generation + /// models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-corporaWords-ng#validateModel-ng). /// /// The customization ID (GUID) of the custom language model that is to be used /// for the request. You must make the request with credentials for the instance of the service that owns the @@ -2985,9 +3096,9 @@ public DetailedResponse ListCorpora(string customizationId) /// in UTF-8 if it contains non-ASCII characters; the service assumes UTF-8 encoding if it encounters non-ASCII /// characters. /// - /// Make sure that you know the character encoding of the file. You must use that encoding when working with the - /// words in the custom language model. For more information, see [Character - /// encoding](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-corporaWords#charEncoding). + /// Make sure that you know the character encoding of the file. You must use that same encoding when working + /// with the words in the custom language model. For more information, see [Character encoding for custom + /// words](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageWords#charEncoding). /// /// With the `curl` command, use the `--data-binary` option to upload the file for the request. /// If `true`, the specified corpus overwrites an existing corpus with the same @@ -3064,8 +3175,9 @@ public DetailedResponse AddCorpus(string customizationId, string corpusN /// /// Get a corpus. /// - /// Gets information about a corpus from a custom language model. The information includes the total number of - /// words and out-of-vocabulary (OOV) words, name, and status of the corpus. You must use credentials for the + /// Gets information about a corpus from a custom language model. The information includes the name, status, and + /// total number of words for the corpus. _For custom models that are based on previous-generation models_, it + /// also includes the number of out-of-vocabulary (OOV) words from the corpus. You must use credentials for the /// instance of the service that owns a model to list its corpora. /// /// **See also:** [Listing corpora for a custom language @@ -3126,12 +3238,16 @@ public DetailedResponse GetCorpus(string customizationId, string corpusN /// /// Delete a corpus. /// - /// Deletes an existing corpus from a custom language model. The service removes any out-of-vocabulary (OOV) - /// words that are associated with the corpus from the custom model's words resource unless they were also added - /// by another corpus or grammar, or they were modified in some way with the **Add custom words** or **Add a - /// custom word** method. Removing a corpus does not affect the custom model until you train the model with the - /// **Train a custom language model** method. You must use credentials for the instance of the service that owns - /// a model to delete its corpora. + /// Deletes an existing corpus from a custom language model. Removing a corpus does not affect the custom model + /// until you train the model with the [Train a custom language model](#trainlanguagemodel) method. You must use + /// credentials for the instance of the service that owns a model to delete its corpora. + /// + /// _For custom models that are based on previous-generation models_, the service removes any out-of-vocabulary + /// (OOV) words that are associated with the corpus from the custom model's words resource unless they were also + /// added by another corpus or grammar, or they were modified in some way with the [Add custom words](#addwords) + /// or [Add a custom word](#addword) method. + /// + /// /// /// **See also:** [Deleting a corpus from a custom language /// model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageCorpora#deleteCorpus). @@ -3191,11 +3307,11 @@ public DetailedResponse DeleteCorpus(string customizationId, string corp /// List custom words. /// /// Lists information about custom words from a custom language model. You can list all words from the custom - /// model's words resource, only custom words that were added or modified by the user, or only out-of-vocabulary - /// (OOV) words that were extracted from corpora or are recognized by grammars. You can also indicate the order - /// in which the service is to return words; by default, the service lists words in ascending alphabetical - /// order. You must use credentials for the instance of the service that owns a model to list information about - /// its words. + /// model's words resource, only custom words that were added or modified by the user, or, _for a custom model + /// that is based on a previous-generation model_, only out-of-vocabulary (OOV) words that were extracted from + /// corpora or are recognized by grammars. You can also indicate the order in which the service is to return + /// words; by default, the service lists words in ascending alphabetical order. You must use credentials for the + /// instance of the service that owns a model to list information about its words. /// /// **See also:** [Listing words from a custom language /// model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageWords#listWords). @@ -3207,7 +3323,11 @@ public DetailedResponse DeleteCorpus(string customizationId, string corp /// * `all` (the default) shows all words. /// * `user` shows only custom words that were added or modified by the user directly. /// * `corpora` shows only OOV that were extracted from corpora. - /// * `grammars` shows only OOV words that are recognized by grammars. (optional, default to all) + /// * `grammars` shows only OOV words that are recognized by grammars. + /// + /// _For a custom model that is based on a next-generation model_, only `all` and `user` apply. Both options + /// return the same results. Words from other sources are not added to custom models that are based on + /// next-generation models. (optional, default to all) /// Indicates the order in which the words are to be listed, `alphabetical` or by `count`. /// You can prepend an optional `+` or `-` to an argument to indicate whether the results are to be sorted in /// ascending or descending order. By default, words are sorted in ascending alphabetical order. For @@ -3273,6 +3393,10 @@ public class ListWordsEnums /// * `user` shows only custom words that were added or modified by the user directly. /// * `corpora` shows only OOV that were extracted from corpora. /// * `grammars` shows only OOV words that are recognized by grammars. + /// + /// _For a custom model that is based on a next-generation model_, only `all` and `user` apply. Both options + /// return the same results. Words from other sources are not added to custom models that are based on + /// next-generation models. /// public class WordTypeValue { @@ -3319,29 +3443,34 @@ public class SortValue /// /// Add custom words. /// - /// Adds one or more custom words to a custom language model. The service populates the words resource for a - /// custom model with out-of-vocabulary (OOV) words from each corpus or grammar that is added to the model. You - /// can use this method to add additional words or to modify existing words in the words resource. The words - /// resource for a model can contain a maximum of 90 thousand custom (OOV) words. This includes words that the - /// service extracts from corpora and grammars and words that you add directly. + /// Adds one or more custom words to a custom language model. You can use this method to add words or to modify + /// existing words in a custom model's words resource. _For custom models that are based on previous-generation + /// models_, the service populates the words resource for a custom model with out-of-vocabulary (OOV) words from + /// each corpus or grammar that is added to the model. You can use this method to modify OOV words in the + /// model's words resource. + /// + /// _For a custom model that is based on a previous-generation model_, the words resource for a model can + /// contain a maximum of 90 thousand custom (OOV) words. This includes words that the service extracts from + /// corpora and grammars and words that you add directly. /// /// You must use credentials for the instance of the service that owns a model to add or modify custom words for /// the model. Adding or modifying custom words does not affect the custom model until you train the model for - /// the new data by using the **Train a custom language model** method. + /// the new data by using the [Train a custom language model](#trainlanguagemodel) method. /// /// You add custom words by providing a `CustomWords` object, which is an array of `CustomWord` objects, one per - /// word. You must use the object's `word` parameter to identify the word that is to be added. You can also - /// provide one or both of the optional `sounds_like` and `display_as` fields for each word. - /// * The `sounds_like` field provides an array of one or more pronunciations for the word. Use the parameter to - /// specify how the word can be pronounced by users. Use the parameter for words that are difficult to + /// word. Use the object's `word` parameter to identify the word that is to be added. You can also provide one + /// or both of the optional `display_as` or `sounds_like` fields for each word. + /// * The `display_as` field provides a different way of spelling the word in a transcript. Use the parameter + /// when you want the word to appear different from its usual representation or from its spelling in training + /// data. For example, you might indicate that the word `IBM` is to be displayed as `IBM™`. + /// * The `sounds_like` field, _which can be used only with a custom model that is based on a + /// previous-generation model_, provides an array of one or more pronunciations for the word. Use the parameter + /// to specify how the word can be pronounced by users. Use the parameter for words that are difficult to /// pronounce, foreign words, acronyms, and so on. For example, you might specify that the word `IEEE` can sound /// like `i triple e`. You can specify a maximum of five sounds-like pronunciations for a word. If you omit the /// `sounds_like` field, the service attempts to set the field to its pronunciation of the word. It cannot /// generate a pronunciation for all words, so you must review the word's definition to ensure that it is /// complete and valid. - /// * The `display_as` field provides a different way of spelling the word in a transcript. Use the parameter - /// when you want the word to appear different from its usual representation or from its spelling in training - /// data. For example, you might indicate that the word `IBM(trademark)` is to be displayed as `IBM™`. /// /// If you add a custom word that already exists in the words resource for the custom model, the new definition /// overwrites the existing data for the word. If the service encounters an error with the input data, it @@ -3351,24 +3480,28 @@ public class SortValue /// words to add them to the model's words resource. The time that it takes for the analysis to complete depends /// on the number of new words that you add but is generally faster than adding a corpus or grammar. /// - /// You can monitor the status of the request by using the **List a custom language model** method to poll the - /// model's status. Use a loop to check the status every 10 seconds. The method returns a `Customization` object - /// that includes a `status` field. A status of `ready` means that the words have been added to the custom - /// model. The service cannot accept requests to add new data or to train the model until the existing request - /// completes. + /// You can monitor the status of the request by using the [Get a custom language model](#getlanguagemodel) + /// method to poll the model's status. Use a loop to check the status every 10 seconds. The method returns a + /// `Customization` object that includes a `status` field. A status of `ready` means that the words have been + /// added to the custom model. The service cannot accept requests to add new data or to train the model until + /// the existing request completes. /// - /// You can use the **List custom words** or **List a custom word** method to review the words that you add. - /// Words with an invalid `sounds_like` field include an `error` field that describes the problem. You can use - /// other words-related methods to correct errors, eliminate typos, and modify how words are pronounced as - /// needed. + /// You can use the [List custom words](#listwords) or [Get a custom word](#getword) method to review the words + /// that you add. Words with an invalid `sounds_like` field include an `error` field that describes the problem. + /// You can use other words-related methods to correct errors, eliminate typos, and modify how words are + /// pronounced as needed. /// /// **See also:** /// * [Add words to the custom language /// model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-languageCreate#addWords) - /// * [Working with custom - /// words](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-corporaWords#workingWords) - /// * [Validating a words - /// resource](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-corporaWords#validateModel). + /// * [Working with custom words for previous-generation + /// models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-corporaWords#workingWords) + /// * [Working with custom words for next-generation + /// models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-corporaWords-ng#workingWords-ng) + /// * [Validating a words resource for previous-generation + /// models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-corporaWords#validateModel) + /// * [Validating a words resource for next-generation + /// models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-corporaWords-ng#validateModel-ng). /// /// The customization ID (GUID) of the custom language model that is to be used /// for the request. You must make the request with credentials for the instance of the service that owns the @@ -3431,41 +3564,50 @@ public DetailedResponse AddWords(string customizationId, List /// Add a custom word. /// - /// Adds a custom word to a custom language model. The service populates the words resource for a custom model - /// with out-of-vocabulary (OOV) words from each corpus or grammar that is added to the model. You can use this - /// method to add a word or to modify an existing word in the words resource. The words resource for a model can + /// Adds a custom word to a custom language model. You can use this method to add a word or to modify an + /// existing word in the words resource. _For custom models that are based on previous-generation models_, the + /// service populates the words resource for a custom model with out-of-vocabulary (OOV) words from each corpus + /// or grammar that is added to the model. You can use this method to modify OOV words in the model's words + /// resource. + /// + /// _For a custom model that is based on a previous-generation models_, the words resource for a model can /// contain a maximum of 90 thousand custom (OOV) words. This includes words that the service extracts from /// corpora and grammars and words that you add directly. /// /// You must use credentials for the instance of the service that owns a model to add or modify a custom word /// for the model. Adding or modifying a custom word does not affect the custom model until you train the model - /// for the new data by using the **Train a custom language model** method. + /// for the new data by using the [Train a custom language model](#trainlanguagemodel) method. /// /// Use the `word_name` parameter to specify the custom word that is to be added or modified. Use the - /// `CustomWord` object to provide one or both of the optional `sounds_like` and `display_as` fields for the + /// `CustomWord` object to provide one or both of the optional `display_as` or `sounds_like` fields for the /// word. - /// * The `sounds_like` field provides an array of one or more pronunciations for the word. Use the parameter to - /// specify how the word can be pronounced by users. Use the parameter for words that are difficult to + /// * The `display_as` field provides a different way of spelling the word in a transcript. Use the parameter + /// when you want the word to appear different from its usual representation or from its spelling in training + /// data. For example, you might indicate that the word `IBM` is to be displayed as `IBM™`. + /// * The `sounds_like` field, _which can be used only with a custom model that is based on a + /// previous-generation model_, provides an array of one or more pronunciations for the word. Use the parameter + /// to specify how the word can be pronounced by users. Use the parameter for words that are difficult to /// pronounce, foreign words, acronyms, and so on. For example, you might specify that the word `IEEE` can sound /// like `i triple e`. You can specify a maximum of five sounds-like pronunciations for a word. If you omit the /// `sounds_like` field, the service attempts to set the field to its pronunciation of the word. It cannot /// generate a pronunciation for all words, so you must review the word's definition to ensure that it is /// complete and valid. - /// * The `display_as` field provides a different way of spelling the word in a transcript. Use the parameter - /// when you want the word to appear different from its usual representation or from its spelling in training - /// data. For example, you might indicate that the word `IBM(trademark)` is to be displayed as `IBM™`. /// /// If you add a custom word that already exists in the words resource for the custom model, the new definition /// overwrites the existing data for the word. If the service encounters an error, it does not add the word to - /// the words resource. Use the **List a custom word** method to review the word that you add. + /// the words resource. Use the [Get a custom word](#getword) method to review the word that you add. /// /// **See also:** /// * [Add words to the custom language /// model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-languageCreate#addWords) - /// * [Working with custom - /// words](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-corporaWords#workingWords) - /// * [Validating a words - /// resource](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-corporaWords#validateModel). + /// * [Working with custom words for previous-generation + /// models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-corporaWords#workingWords) + /// * [Working with custom words for next-generation + /// models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-corporaWords-ng#workingWords-ng) + /// * [Validating a words resource for previous-generation + /// models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-corporaWords#validateModel) + /// * [Validating a words resource for next-generation + /// models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-corporaWords-ng#validateModel-ng). /// /// The customization ID (GUID) of the custom language model that is to be used /// for the request. You must make the request with credentials for the instance of the service that owns the @@ -3474,13 +3616,14 @@ public DetailedResponse AddWords(string customizationId, List - /// For the **Add custom words** method, you must specify the custom word that is to be added - /// to or updated in the custom model. Do not include spaces in the word. Use a `-` (dash) or `_` (underscore) - /// to connect the tokens of compound words. - /// - /// Omit this parameter for the **Add a custom word** method. (optional) - /// An array of sounds-like pronunciations for the custom word. Specify how words that - /// are difficult to pronounce, foreign words, acronyms, and so on can be pronounced by users. + /// For the [Add custom words](#addwords) method, you must specify the custom word that is to + /// be added to or updated in the custom model. Do not include spaces in the word. Use a `-` (dash) or `_` + /// (underscore) to connect the tokens of compound words. + /// + /// Omit this parameter for the [Add a custom word](#addword) method. (optional) + /// _For a custom model that is based on a previous-generation model_, an array of + /// sounds-like pronunciations for the custom word. Specify how words that are difficult to pronounce, foreign + /// words, acronyms, and so on can be pronounced by users. /// * For a word that is not in the service's base vocabulary, omit the parameter to have the service /// automatically generate a sounds-like pronunciation for the word. /// * For a word that is in the service's base vocabulary, use the parameter to specify additional @@ -3488,7 +3631,11 @@ public DetailedResponse AddWords(string customizationId, List + /// not including spaces. + /// + /// _For a custom model that is based on a next-generation model_, omit this field. Custom models based on + /// next-generation models do not support the `sounds_like` field. The service ignores the field. + /// (optional) /// An alternative spelling for the custom word when it appears in a transcript. Use the /// parameter when you want the word to have a spelling that is different from its usual representation or from /// its spelling in corpora training data. (optional) @@ -3625,10 +3772,10 @@ public DetailedResponse GetWord(string customizationId, string wordName) /// /// Deletes a custom word from a custom language model. You can remove any word that you added to the custom /// model's words resource via any means. However, if the word also exists in the service's base vocabulary, the - /// service removes only the custom pronunciation for the word; the word remains in the base vocabulary. - /// Removing a custom word does not affect the custom model until you train the model with the **Train a custom - /// language model** method. You must use credentials for the instance of the service that owns a model to - /// delete its words. + /// service removes the word only from the words resource; the word remains in the base vocabulary. Removing a + /// custom word does not affect the custom model until you train the model with the [Train a custom language + /// model](#trainlanguagemodel) method. You must use credentials for the instance of the service that owns a + /// model to delete its words. /// /// **See also:** [Deleting a word from a custom language /// model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageWords#deleteWord). @@ -3691,7 +3838,11 @@ public DetailedResponse DeleteWord(string customizationId, string wordNa /// /// Lists information about all grammars from a custom language model. The information includes the total number /// of out-of-vocabulary (OOV) words, name, and status of each grammar. You must use credentials for the - /// instance of the service that owns a model to list its grammars. + /// instance of the service that owns a model to list its grammars. Grammars are available for all languages and + /// models that support language customization. + /// + /// **Note:** Grammars are supported only for use with previous-generation models. They are not supported for + /// next-generation models. /// /// **See also:** [Listing grammars from a custom language /// model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageGrammars#listGrammars). @@ -3745,30 +3896,35 @@ public DetailedResponse ListGrammars(string customizationId) /// Adds a single grammar file to a custom language model. Submit a plain text file in UTF-8 format that defines /// the grammar. Use multiple requests to submit multiple grammar files. You must use credentials for the /// instance of the service that owns a model to add a grammar to it. Adding a grammar does not affect the - /// custom language model until you train the model for the new data by using the **Train a custom language - /// model** method. + /// custom language model until you train the model for the new data by using the [Train a custom language + /// model](#trainlanguagemodel) method. /// /// The call returns an HTTP 201 response code if the grammar is valid. The service then asynchronously /// processes the contents of the grammar and automatically extracts new words that it finds. This operation can /// take a few seconds or minutes to complete depending on the size and complexity of the grammar, as well as /// the current load on the service. You cannot submit requests to add additional resources to the custom model /// or to train the model until the service's analysis of the grammar for the current request completes. Use the - /// **Get a grammar** method to check the status of the analysis. + /// [Get a grammar](#getgrammar) method to check the status of the analysis. /// /// The service populates the model's words resource with any word that is recognized by the grammar that is not /// found in the model's base vocabulary. These are referred to as out-of-vocabulary (OOV) words. You can use - /// the **List custom words** method to examine the words resource and use other words-related methods to - /// eliminate typos and modify how words are pronounced as needed. + /// the [List custom words](#listwords) method to examine the words resource and use other words-related methods + /// to eliminate typos and modify how words are pronounced as needed. /// /// To add a grammar that has the same name as an existing grammar, set the `allow_overwrite` parameter to /// `true`; otherwise, the request fails. Overwriting an existing grammar causes the service to process the /// grammar file and extract OOV words anew. Before doing so, it removes any OOV words associated with the /// existing grammar from the model's words resource unless they were also added by another resource or they - /// have been modified in some way with the **Add custom words** or **Add a custom word** method. + /// have been modified in some way with the [Add custom words](#addwords) or [Add a custom word](#addword) + /// method. /// /// The service limits the overall amount of data that you can add to a custom model to a maximum of 10 million /// total words from all sources combined. Also, you can add no more than 90 thousand OOV words to a model. This - /// includes words that the service extracts from corpora and grammars and words that you add directly. + /// includes words that the service extracts from corpora and grammars and words that you add directly. Grammars + /// are available for all languages and models that support language customization. + /// + /// **Note:** Grammars are supported only for use with previous-generation models. They are not supported for + /// next-generation models. /// /// **See also:** /// * [Understanding @@ -3904,7 +4060,11 @@ public class ContentTypeValue /// /// Gets information about a grammar from a custom language model. The information includes the total number of /// out-of-vocabulary (OOV) words, name, and status of the grammar. You must use credentials for the instance of - /// the service that owns a model to list its grammars. + /// the service that owns a model to list its grammars. Grammars are available for all languages and models that + /// support language customization. + /// + /// **Note:** Grammars are supported only for use with previous-generation models. They are not supported for + /// next-generation models. /// /// **See also:** [Listing grammars from a custom language /// model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageGrammars#listGrammars). @@ -3966,10 +4126,14 @@ public DetailedResponse GetGrammar(string customizationId, string gramm /// /// Deletes an existing grammar from a custom language model. The service removes any out-of-vocabulary (OOV) /// words associated with the grammar from the custom model's words resource unless they were also added by - /// another resource or they were modified in some way with the **Add custom words** or **Add a custom word** - /// method. Removing a grammar does not affect the custom model until you train the model with the **Train a - /// custom language model** method. You must use credentials for the instance of the service that owns a model - /// to delete its grammar. + /// another resource or they were modified in some way with the [Add custom words](#addwords) or [Add a custom + /// word](#addword) method. Removing a grammar does not affect the custom model until you train the model with + /// the [Train a custom language model](#trainlanguagemodel) method. You must use credentials for the instance + /// of the service that owns a model to delete its grammar. Grammars are available for all languages and models + /// that support language customization. + /// + /// **Note:** Grammars are supported only for use with previous-generation models. They are not supported for + /// next-generation models. /// /// **See also:** [Deleting a grammar from a custom language /// model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageGrammars#deleteGrammar). @@ -4036,6 +4200,9 @@ public DetailedResponse DeleteGrammar(string customizationId, string gra /// if you attempt to create more than 1024 models. You do not lose any models, but you cannot create any more /// until your model count is below the limit. /// + /// **Note:** Acoustic model customization is supported only for use with previous-generation models. It is not + /// supported for next-generation models. + /// /// **See also:** [Create a custom acoustic /// model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-acoustic#createModel-acoustic). /// @@ -4048,7 +4215,7 @@ public DetailedResponse DeleteGrammar(string customizationId, string gra /// model `ar-AR_BroadbandModel` is deprecated; use `ar-MS_BroadbandModel` instead.) /// /// To determine whether a base model supports acoustic model customization, refer to [Language support for - /// customization](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-customization#languageSupport). + /// customization](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-custom-support#custom-language-support). /// A description of the new custom acoustic model. Use a localized description that /// matches the language of the custom model. (optional) /// AcousticModel @@ -4116,6 +4283,9 @@ public DetailedResponse CreateAcousticModel(string name, string b /// all custom acoustic models for all languages. You must use credentials for the instance of the service that /// owns a model to list information about it. /// + /// **Note:** Acoustic model customization is supported only for use with previous-generation models. It is not + /// supported for next-generation models. + /// /// **See also:** [Listing custom acoustic /// models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageAcousticModels#listModels-acoustic). /// @@ -4124,7 +4294,7 @@ public DetailedResponse CreateAcousticModel(string name, string b /// by the requesting credentials. (**Note:** The identifier `ar-AR` is deprecated; use `ar-MS` instead.) /// /// To determine the languages for which customization is available, see [Language support for - /// customization](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-customization#languageSupport). + /// customization](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-custom-support#custom-language-support). /// (optional) /// AcousticModels public DetailedResponse ListAcousticModels(string language = null) @@ -4173,7 +4343,7 @@ public class ListAcousticModelsEnums /// credentials. (**Note:** The identifier `ar-AR` is deprecated; use `ar-MS` instead.) /// /// To determine the languages for which customization is available, see [Language support for - /// customization](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-customization#languageSupport). + /// customization](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-custom-support#custom-language-support). /// public class LanguageValue { @@ -4198,6 +4368,10 @@ public class LanguageValue /// public const string EN_GB = "en-GB"; /// + /// Constant EN_IN for en-IN + /// + public const string EN_IN = "en-IN"; + /// /// Constant EN_US for en-US /// public const string EN_US = "en-US"; @@ -4234,6 +4408,10 @@ public class LanguageValue /// public const string FR_FR = "fr-FR"; /// + /// Constant HI_IN for hi-IN + /// + public const string HI_IN = "hi-IN"; + /// /// Constant IT_IT for it-IT /// public const string IT_IT = "it-IT"; @@ -4246,6 +4424,10 @@ public class LanguageValue /// public const string KO_KR = "ko-KR"; /// + /// Constant NL_BE for nl-BE + /// + public const string NL_BE = "nl-BE"; + /// /// Constant NL_NL for nl-NL /// public const string NL_NL = "nl-NL"; @@ -4267,6 +4449,9 @@ public class LanguageValue /// Gets information about a specified custom acoustic model. You must use credentials for the instance of the /// service that owns a model to list information about it. /// + /// **Note:** Acoustic model customization is supported only for use with previous-generation models. It is not + /// supported for next-generation models. + /// /// **See also:** [Listing custom acoustic /// models](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageAcousticModels#listModels-acoustic). /// @@ -4320,6 +4505,9 @@ public DetailedResponse GetAcousticModel(string customizationId) /// adding an audio resource to the model, is currently being processed. You must use credentials for the /// instance of the service that owns a model to delete it. /// + /// **Note:** Acoustic model customization is supported only for use with previous-generation models. It is not + /// supported for next-generation models. + /// /// **See also:** [Deleting a custom acoustic /// model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageAcousticModels#deleteModel-acoustic). /// @@ -4381,12 +4569,12 @@ public DetailedResponse DeleteAcousticModel(string customizationId) /// hours to train a model that contains a total of 2 hours of audio. The method returns an HTTP 200 response /// code to indicate that the training process has begun. /// - /// You can monitor the status of the training by using the **Get a custom acoustic model** method to poll the - /// model's status. Use a loop to check the status once a minute. The method returns an `AcousticModel` object - /// that includes `status` and `progress` fields. A status of `available` indicates that the custom model is - /// trained and ready to use. The service cannot train a model while it is handling another request for the - /// model. The service cannot accept subsequent training requests, or requests to add new audio resources, until - /// the existing training request completes. + /// You can monitor the status of the training by using the [Get a custom acoustic model](#getacousticmodel) + /// method to poll the model's status. Use a loop to check the status once a minute. The method returns an + /// `AcousticModel` object that includes `status` and `progress` fields. A status of `available` indicates that + /// the custom model is trained and ready to use. The service cannot train a model while it is handling another + /// request for the model. The service cannot accept subsequent training requests, or requests to add new audio + /// resources, until the existing training request completes. /// /// You can use the optional `custom_language_model_id` parameter to specify the GUID of a separately created /// custom language model that is to be used during training. Train with a custom language model if you have @@ -4395,6 +4583,9 @@ public DetailedResponse DeleteAcousticModel(string customizationId) /// to succeed, both of the custom models must be based on the same version of the same base model, and the /// custom language model must be fully trained and available. /// + /// **Note:** Acoustic model customization is supported only for use with previous-generation models. It is not + /// supported for next-generation models. + /// /// **See also:** /// * [Train the custom acoustic /// model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-acoustic#trainModel-acoustic) @@ -4479,6 +4670,9 @@ public DetailedResponse TrainAcousticModel(string customizatio /// subsequent requests for the model until the existing reset request completes. You must use credentials for /// the instance of the service that owns a model to reset it. /// + /// **Note:** Acoustic model customization is supported only for use with previous-generation models. It is not + /// supported for next-generation models. + /// /// **See also:** [Resetting a custom acoustic /// model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageAcousticModels#resetModel-acoustic). /// @@ -4536,18 +4730,21 @@ public DetailedResponse ResetAcousticModel(string customizationId) /// that owns a model to upgrade it. /// /// The method returns an HTTP 200 response code to indicate that the upgrade process has begun successfully. - /// You can monitor the status of the upgrade by using the **Get a custom acoustic model** method to poll the - /// model's status. The method returns an `AcousticModel` object that includes `status` and `progress` fields. - /// Use a loop to check the status once a minute. While it is being upgraded, the custom model has the status - /// `upgrading`. When the upgrade is complete, the model resumes the status that it had prior to upgrade. The - /// service cannot upgrade a model while it is handling another request for the model. The service cannot accept - /// subsequent requests for the model until the existing upgrade request completes. + /// You can monitor the status of the upgrade by using the [Get a custom acoustic model](#getacousticmodel) + /// method to poll the model's status. The method returns an `AcousticModel` object that includes `status` and + /// `progress` fields. Use a loop to check the status once a minute. While it is being upgraded, the custom + /// model has the status `upgrading`. When the upgrade is complete, the model resumes the status that it had + /// prior to upgrade. The service cannot upgrade a model while it is handling another request for the model. The + /// service cannot accept subsequent requests for the model until the existing upgrade request completes. /// /// If the custom acoustic model was trained with a separately created custom language model, you must use the /// `custom_language_model_id` parameter to specify the GUID of that custom language model. The custom language /// model must be upgraded before the custom acoustic model can be upgraded. Omit the parameter if the custom /// acoustic model was not trained with a custom language model. /// + /// **Note:** Acoustic model customization is supported only for use with previous-generation models. It is not + /// supported for next-generation models. + /// /// **See also:** [Upgrading a custom acoustic /// model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-custom-upgrade#custom-upgrade-acoustic). /// @@ -4620,6 +4817,9 @@ public DetailedResponse UpgradeAcousticModel(string customizationId, str /// request to add it to the custom acoustic model. You must use credentials for the instance of the service /// that owns a model to list its audio resources. /// + /// **Note:** Acoustic model customization is supported only for use with previous-generation models. It is not + /// supported for next-generation models. + /// /// **See also:** [Listing audio resources for a custom acoustic /// model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageAudio#listAudio). /// @@ -4672,8 +4872,8 @@ public DetailedResponse ListAudio(string customizationId) /// Adds an audio resource to a custom acoustic model. Add audio content that reflects the acoustic /// characteristics of the audio that you plan to transcribe. You must use credentials for the instance of the /// service that owns a model to add an audio resource to it. Adding audio data does not affect the custom - /// acoustic model until you train the model for the new data by using the **Train a custom acoustic model** - /// method. + /// acoustic model until you train the model for the new data by using the [Train a custom acoustic + /// model](#trainacousticmodel) method. /// /// You can add individual audio files or an archive file that contains multiple audio files. Adding multiple /// audio files via a single archive file is significantly more efficient than adding each file individually. @@ -4693,10 +4893,13 @@ public DetailedResponse ListAudio(string customizationId) /// encoding. You cannot submit requests to train or upgrade the model until the service's analysis of all audio /// resources for current requests completes. /// - /// To determine the status of the service's analysis of the audio, use the **Get an audio resource** method to - /// poll the status of the audio. The method accepts the customization ID of the custom model and the name of - /// the audio resource, and it returns the status of the resource. Use a loop to check the status of the audio - /// every few seconds until it becomes `ok`. + /// To determine the status of the service's analysis of the audio, use the [Get an audio resource](#getaudio) + /// method to poll the status of the audio. The method accepts the customization ID of the custom model and the + /// name of the audio resource, and it returns the status of the resource. Use a loop to check the status of the + /// audio every few seconds until it becomes `ok`. + /// + /// **Note:** Acoustic model customization is supported only for use with previous-generation models. It is not + /// supported for next-generation models. /// /// **See also:** [Add audio to the custom acoustic /// model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-acoustic#addAudio). @@ -4777,7 +4980,7 @@ public DetailedResponse ListAudio(string customizationId) /// /// For an archive-type resource, the media type of the archive file. For more information, see **Content types /// for archive-type resources** in the method description. (optional) - /// **For an archive-type resource,** specify the format of the audio files + /// _For an archive-type resource_, specify the format of the audio files /// that are contained in the archive file if they are of type `audio/alaw`, `audio/basic`, `audio/l16`, or /// `audio/mulaw`. Include the `rate`, `channels`, and `endianness` parameters where necessary. In this case, /// all audio files that are contained in the archive file must be of the indicated type. @@ -4788,7 +4991,7 @@ public DetailedResponse ListAudio(string customizationId) /// The parameter accepts all of the audio formats that are supported for use with speech recognition. For more /// information, see **Content types for audio-type resources** in the method description. /// - /// **For an audio-type resource,** omit the header. (optional) + /// _For an audio-type resource_, omit the header. (optional) /// If `true`, the specified audio resource overwrites an existing audio resource /// with the same name. If `false`, the request fails if an audio resource with the same name already exists. /// The parameter has no effect if an audio resource with the same name does not already exist. (optional, @@ -4949,9 +5152,9 @@ public class ContentTypeValue } /// - /// **For an archive-type resource,** specify the format of the audio files that are contained in the - /// archive file if they are of type `audio/alaw`, `audio/basic`, `audio/l16`, or `audio/mulaw`. Include the - /// `rate`, `channels`, and `endianness` parameters where necessary. In this case, all audio files that are + /// _For an archive-type resource_, specify the format of the audio files that are contained in the archive + /// file if they are of type `audio/alaw`, `audio/basic`, `audio/l16`, or `audio/mulaw`. Include the `rate`, + /// `channels`, and `endianness` parameters where necessary. In this case, all audio files that are /// contained in the archive file must be of the indicated type. /// /// For all other audio formats, you can omit the header. In this case, the audio files can be of multiple @@ -4960,7 +5163,7 @@ public class ContentTypeValue /// The parameter accepts all of the audio formats that are supported for use with speech recognition. For /// more information, see **Content types for audio-type resources** in the method description. /// - /// **For an audio-type resource,** omit the header. + /// _For an audio-type resource_, omit the header. /// public class ContainedContentTypeValue { @@ -5034,20 +5237,23 @@ public class ContainedContentTypeValue /// Gets information about an audio resource from a custom acoustic model. The method returns an `AudioListing` /// object whose fields depend on the type of audio resource that you specify with the method's `audio_name` /// parameter: - /// * **For an audio-type resource,** the object's fields match those of an `AudioResource` object: `duration`, + /// * _For an audio-type resource_, the object's fields match those of an `AudioResource` object: `duration`, /// `name`, `details`, and `status`. - /// * **For an archive-type resource,** the object includes a `container` field whose fields match those of an + /// * _For an archive-type resource_, the object includes a `container` field whose fields match those of an /// `AudioResource` object. It also includes an `audio` field, which contains an array of `AudioResource` /// objects that provides information about the audio files that are contained in the archive. /// /// The information includes the status of the specified audio resource. The status is important for checking /// the service's analysis of a resource that you add to the custom model. - /// * For an audio-type resource, the `status` field is located in the `AudioListing` object. - /// * For an archive-type resource, the `status` field is located in the `AudioResource` object that is returned - /// in the `container` field. + /// * _For an audio-type resource_, the `status` field is located in the `AudioListing` object. + /// * _For an archive-type resource_, the `status` field is located in the `AudioResource` object that is + /// returned in the `container` field. /// /// You must use credentials for the instance of the service that owns a model to list its audio resources. /// + /// **Note:** Acoustic model customization is supported only for use with previous-generation models. It is not + /// supported for next-generation models. + /// /// **See also:** [Listing audio resources for a custom acoustic /// model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageAudio#listAudio). /// @@ -5111,9 +5317,12 @@ public DetailedResponse GetAudio(string customizationId, string au /// resource. /// /// Removing an audio resource does not affect the custom model until you train the model on its updated data by - /// using the **Train a custom acoustic model** method. You can delete an existing audio resource from a model - /// while a different resource is being added to the model. You must use credentials for the instance of the - /// service that owns a model to delete its audio resources. + /// using the [Train a custom acoustic model](#trainacousticmodel) method. You can delete an existing audio + /// resource from a model while a different resource is being added to the model. You must use credentials for + /// the instance of the service that owns a model to delete its audio resources. + /// + /// **Note:** Acoustic model customization is supported only for use with previous-generation models. It is not + /// supported for next-generation models. /// /// **See also:** [Deleting an audio resource from a custom acoustic /// model](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-manageAudio#deleteAudio). From c488dac28259fc696718f6c4f4eeb5cbcb1e603c Mon Sep 17 00:00:00 2001 From: Nanwarin Chantarutai Date: Wed, 8 Sep 2021 13:57:09 -0700 Subject: [PATCH 06/26] fix(nlu): fix listClassificationsModels through return type change and removal of unnecessary model --- .../INaturalLanguageUnderstandingService.cs | 4 ++-- .../NaturalLanguageUnderstandingService.cs | 16 ++++++++-------- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/src/IBM.Watson.NaturalLanguageUnderstanding.v1/INaturalLanguageUnderstandingService.cs b/src/IBM.Watson.NaturalLanguageUnderstanding.v1/INaturalLanguageUnderstandingService.cs index f6bd5ad956..539784ab69 100644 --- a/src/IBM.Watson.NaturalLanguageUnderstanding.v1/INaturalLanguageUnderstandingService.cs +++ b/src/IBM.Watson.NaturalLanguageUnderstanding.v1/INaturalLanguageUnderstandingService.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2019, 2021. +* (C) Copyright IBM Corp. 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -36,7 +36,7 @@ public partial interface INaturalLanguageUnderstandingService DetailedResponse UpdateCategoriesModel(string modelId, string language, System.IO.MemoryStream trainingData, string trainingDataContentType = null, string name = null, string description = null, string modelVersion = null, string workspaceId = null, string versionDescription = null); DetailedResponse DeleteCategoriesModel(string modelId); DetailedResponse CreateClassificationsModel(string language, System.IO.MemoryStream trainingData, string trainingDataContentType = null, string name = null, string description = null, string modelVersion = null, string workspaceId = null, string versionDescription = null); - DetailedResponse ListClassificationsModels(); + DetailedResponse ListClassificationsModels(); DetailedResponse GetClassificationsModel(string modelId); DetailedResponse UpdateClassificationsModel(string modelId, string language, System.IO.MemoryStream trainingData, string trainingDataContentType = null, string name = null, string description = null, string modelVersion = null, string workspaceId = null, string versionDescription = null); DetailedResponse DeleteClassificationsModel(string modelId); diff --git a/src/IBM.Watson.NaturalLanguageUnderstanding.v1/NaturalLanguageUnderstandingService.cs b/src/IBM.Watson.NaturalLanguageUnderstanding.v1/NaturalLanguageUnderstandingService.cs index 8de3fb66a8..0eb41eeee9 100644 --- a/src/IBM.Watson.NaturalLanguageUnderstanding.v1/NaturalLanguageUnderstandingService.cs +++ b/src/IBM.Watson.NaturalLanguageUnderstanding.v1/NaturalLanguageUnderstandingService.cs @@ -16,7 +16,7 @@ */ /** -* IBM OpenAPI SDK Code Generator Version: 99-SNAPSHOT-902c9336-20210513-140138 +* IBM OpenAPI SDK Code Generator Version: 3.38.0-07189efd-20210827-205025 */ using System.Collections.Generic; @@ -1277,16 +1277,16 @@ public class TrainingDataContentTypeValue /// /// List classifications models. /// - /// (Beta) Returns all custom classifications models associated with this service instance. + /// Returns all custom classifications models associated with this service instance. /// - /// ListClassificationsModelsResponse - public DetailedResponse ListClassificationsModels() + /// ClassificationsModelList + public DetailedResponse ListClassificationsModels() { if (string.IsNullOrEmpty(Version)) { throw new ArgumentNullException("`Version` is required"); } - DetailedResponse result = null; + DetailedResponse result = null; try { @@ -1305,10 +1305,10 @@ public DetailedResponse ListClassificationsMo restRequest.WithHeaders(customRequestHeaders); ClearCustomRequestHeaders(); - result = restRequest.As().Result; + result = restRequest.As().Result; if (result == null) { - result = new DetailedResponse(); + result = new DetailedResponse(); } } catch (AggregateException ae) @@ -1322,7 +1322,7 @@ public DetailedResponse ListClassificationsMo /// /// Get classifications model details. /// - /// (Beta) Returns the status of the classifications model with the given model ID. + /// Returns the status of the classifications model with the given model ID. /// /// ID of the model. /// ClassificationsModel From b16b1651dc25b390fefa280d36d97bb5f2683c62 Mon Sep 17 00:00:00 2001 From: Nanwarin Chantarutai Date: Wed, 8 Sep 2021 14:15:35 -0700 Subject: [PATCH 07/26] feat(discovery-2): enum update for CreateProjectConstants --- .../DiscoveryService.cs | 10 +++++-- .../Model/ProjectDetails.cs | 26 +++++++++++++++---- .../Model/ProjectListDetails.cs | 26 +++++++++++++++---- 3 files changed, 50 insertions(+), 12 deletions(-) diff --git a/src/IBM.Watson.Discovery.v2/DiscoveryService.cs b/src/IBM.Watson.Discovery.v2/DiscoveryService.cs index c737238353..3992a18e88 100644 --- a/src/IBM.Watson.Discovery.v2/DiscoveryService.cs +++ b/src/IBM.Watson.Discovery.v2/DiscoveryService.cs @@ -1825,7 +1825,7 @@ public DetailedResponse AnalyzeDocument(string projectId, stri if (file != null) { - var fileContent = new StreamContent(file); + var fileContent = new ByteArrayContent(file.ToArray()); System.Net.Http.Headers.MediaTypeHeaderValue contentType; System.Net.Http.Headers.MediaTypeHeaderValue.TryParse(fileContentType, out contentType); fileContent.Headers.ContentType = contentType; @@ -2303,7 +2303,13 @@ public DetailedResponse ListProjects() /// Create a new project for this instance. /// /// The human readable name of this project. - /// The project type of this project. + /// The type of project. + /// + /// The `content_intelligence` type is a *Document Retrieval for Contracts* project and the `other` type is a + /// *Custom* project. + /// + /// The `content_mining` and `content_intelligence` types are available with Premium plan managed deployments + /// and installed deployments only. /// Default query parameters for this project. (optional) /// ProjectDetails public DetailedResponse CreateProject(string name, string type, DefaultQueryParams defaultQueryParameters = null) diff --git a/src/IBM.Watson.Discovery.v2/Model/ProjectDetails.cs b/src/IBM.Watson.Discovery.v2/Model/ProjectDetails.cs index be9099c7cf..a167a9030f 100644 --- a/src/IBM.Watson.Discovery.v2/Model/ProjectDetails.cs +++ b/src/IBM.Watson.Discovery.v2/Model/ProjectDetails.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2018, 2020. +* (C) Copyright IBM Corp. 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -25,7 +25,13 @@ namespace IBM.Watson.Discovery.v2.Model public class ProjectDetails { /// - /// The project type of this project. + /// The type of project. + /// + /// The `content_intelligence` type is a *Document Retrieval for Contracts* project and the `other` type is a + /// *Custom* project. + /// + /// The `content_mining` and `content_intelligence` types are available with Premium plan managed deployments + /// and installed deployments only. /// public class TypeEnumValue { @@ -34,14 +40,18 @@ public class TypeEnumValue /// public const string DOCUMENT_RETRIEVAL = "document_retrieval"; /// - /// Constant ANSWER_RETRIEVAL for answer_retrieval + /// Constant CONVERSATIONAL_SEARCH for conversational_search /// - public const string ANSWER_RETRIEVAL = "answer_retrieval"; + public const string CONVERSATIONAL_SEARCH = "conversational_search"; /// /// Constant CONTENT_MINING for content_mining /// public const string CONTENT_MINING = "content_mining"; /// + /// Constant CONTENT_INTELLIGENCE for content_intelligence + /// + public const string CONTENT_INTELLIGENCE = "content_intelligence"; + /// /// Constant OTHER for other /// public const string OTHER = "other"; @@ -49,7 +59,13 @@ public class TypeEnumValue } /// - /// The project type of this project. + /// The type of project. + /// + /// The `content_intelligence` type is a *Document Retrieval for Contracts* project and the `other` type is a + /// *Custom* project. + /// + /// The `content_mining` and `content_intelligence` types are available with Premium plan managed deployments + /// and installed deployments only. /// Constants for possible values can be found using ProjectDetails.TypeEnumValue /// [JsonProperty("type", NullValueHandling = NullValueHandling.Ignore)] diff --git a/src/IBM.Watson.Discovery.v2/Model/ProjectListDetails.cs b/src/IBM.Watson.Discovery.v2/Model/ProjectListDetails.cs index 640ba15983..582c3d8380 100644 --- a/src/IBM.Watson.Discovery.v2/Model/ProjectListDetails.cs +++ b/src/IBM.Watson.Discovery.v2/Model/ProjectListDetails.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2018, 2020. +* (C) Copyright IBM Corp. 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -25,7 +25,13 @@ namespace IBM.Watson.Discovery.v2.Model public class ProjectListDetails { /// - /// The project type of this project. + /// The type of project. + /// + /// The `content_intelligence` type is a *Document Retrieval for Contracts* project and the `other` type is a + /// *Custom* project. + /// + /// The `content_mining` and `content_intelligence` types are available with Premium plan managed deployments + /// and installed deployments only. /// public class TypeEnumValue { @@ -34,14 +40,18 @@ public class TypeEnumValue /// public const string DOCUMENT_RETRIEVAL = "document_retrieval"; /// - /// Constant ANSWER_RETRIEVAL for answer_retrieval + /// Constant CONVERSATIONAL_SEARCH for conversational_search /// - public const string ANSWER_RETRIEVAL = "answer_retrieval"; + public const string CONVERSATIONAL_SEARCH = "conversational_search"; /// /// Constant CONTENT_MINING for content_mining /// public const string CONTENT_MINING = "content_mining"; /// + /// Constant CONTENT_INTELLIGENCE for content_intelligence + /// + public const string CONTENT_INTELLIGENCE = "content_intelligence"; + /// /// Constant OTHER for other /// public const string OTHER = "other"; @@ -49,7 +59,13 @@ public class TypeEnumValue } /// - /// The project type of this project. + /// The type of project. + /// + /// The `content_intelligence` type is a *Document Retrieval for Contracts* project and the `other` type is a + /// *Custom* project. + /// + /// The `content_mining` and `content_intelligence` types are available with Premium plan managed deployments + /// and installed deployments only. /// Constants for possible values can be found using ProjectListDetails.TypeEnumValue /// [JsonProperty("type", NullValueHandling = NullValueHandling.Ignore)] From 05c7a6786b06009104f4ce6af716158e8dccf56c Mon Sep 17 00:00:00 2001 From: Nanwarin Chantarutai Date: Wed, 8 Sep 2021 14:22:13 -0700 Subject: [PATCH 08/26] fix(formatting): update comments and fomatting changes --- .../AssistantService.cs | 8 +- .../Model/RuntimeEntity.cs | 7 +- .../Model/RuntimeEntity.cs | 7 +- .../DiscoveryService.cs | 8 +- .../Model/Enrichment.cs | 8 +- .../Model/EnrichmentOptions.cs | 4 +- src/IBM.Watson.Discovery.v1/Model/Notice.cs | 8 +- .../DiscoveryService.cs | 178 +++++++++--------- .../Model/CollectionEnrichment.cs | 5 +- .../Model/CreateEnrichment.cs | 5 +- .../Model/DefaultQueryParams.cs | 4 +- .../DefaultQueryParamsSuggestedRefinements.cs | 6 +- .../Model/Enrichment.cs | 5 +- .../Model/EnrichmentOptions.cs | 20 +- .../Model/QueryFilterAggregation.cs | 10 +- .../Model/QueryGroupByAggregationResult.cs | 4 +- .../Model/QueryHistogramAggregation.cs | 4 +- .../Model/QueryHistogramAggregationResult.cs | 4 +- .../Model/QueryLargePassages.cs | 31 +-- .../Model/QueryLargeSuggestedRefinements.cs | 4 +- .../Model/QueryNestedAggregation.cs | 10 +- .../Model/QueryResponse.cs | 7 +- .../Model/QueryResponsePassage.cs | 4 +- .../Model/QueryResult.cs | 4 +- .../Model/QueryResultPassage.cs | 4 +- .../Model/QueryTermAggregationResult.cs | 4 +- .../Model/QueryTimesliceAggregationResult.cs | 4 +- .../Model/RetrievalDetails.cs | 10 +- .../LanguageTranslatorService.cs | 4 +- .../Model/CategoriesOptions.cs | 4 +- .../Model/CategoriesResult.cs | 6 +- .../Model/ClassificationsOptions.cs | 2 +- .../Model/Features.cs | 6 +- .../NaturalLanguageUnderstandingService.cs | 14 +- .../Model/AcousticModel.cs | 7 +- .../Model/AudioDetails.cs | 11 +- .../Model/AudioListing.cs | 17 +- .../Model/AudioResource.cs | 8 +- .../Model/Corpus.cs | 8 +- .../Model/CustomWord.cs | 18 +- .../Model/LanguageModel.cs | 18 +- .../Model/ProcessingMetrics.cs | 4 +- .../Model/RecognitionJob.cs | 15 +- .../Model/SpeechRecognitionAlternative.cs | 8 +- .../Model/SpeechRecognitionResults.cs | 4 +- .../Model/SupportedFeatures.cs | 14 +- src/IBM.Watson.SpeechToText.v1/Model/Word.cs | 35 ++-- .../Model/CustomModel.cs | 11 +- src/IBM.Watson.TextToSpeech.v1/Model/Voice.cs | 6 +- src/IBM.Watson.TextToSpeech.v1/Model/Words.cs | 18 +- 50 files changed, 335 insertions(+), 280 deletions(-) diff --git a/src/IBM.Watson.Assistant.v1/AssistantService.cs b/src/IBM.Watson.Assistant.v1/AssistantService.cs index 3f947d2c66..088fab589a 100644 --- a/src/IBM.Watson.Assistant.v1/AssistantService.cs +++ b/src/IBM.Watson.Assistant.v1/AssistantService.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2018, 2021. +* (C) Copyright IBM Corp. 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -16,7 +16,7 @@ */ /** -* IBM OpenAPI SDK Code Generator Version: 99-SNAPSHOT-902c9336-20210513-140138 +* IBM OpenAPI SDK Code Generator Version: 3.38.0-07189efd-20210827-205025 */ using System.Collections.Generic; @@ -4319,8 +4319,8 @@ public DetailedResponse ListLogs(string workspaceId, string sort /// /// A cacheable parameter that limits the results to those matching the specified filter. /// You must specify a filter query that includes a value for `language`, as well as a value for - /// `request.context.system.assistant_id`, `workspace_id`, or `request.context.metadata.deployment`. For more - /// information, see the + /// `request.context.system.assistant_id`, `workspace_id`, or `request.context.metadata.deployment`. These + /// required filters must be specified using the exact match (`::`) operator. For more information, see the /// [documentation](https://cloud.ibm.com/docs/assistant?topic=assistant-filter-reference#filter-reference). /// How to sort the returned log events. You can sort by **request_timestamp**. To reverse /// the sort order, prefix the parameter value with a minus sign (`-`). (optional) diff --git a/src/IBM.Watson.Assistant.v1/Model/RuntimeEntity.cs b/src/IBM.Watson.Assistant.v1/Model/RuntimeEntity.cs index 078c759c23..11fda29aa9 100644 --- a/src/IBM.Watson.Assistant.v1/Model/RuntimeEntity.cs +++ b/src/IBM.Watson.Assistant.v1/Model/RuntimeEntity.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2018, 2020. +* (C) Copyright IBM Corp. 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -47,7 +47,10 @@ public class RuntimeEntity [JsonProperty("confidence", NullValueHandling = NullValueHandling.Ignore)] public float? Confidence { get; set; } /// - /// Any metadata for the entity. + /// **Deprecated.** Any metadata for the entity. + /// + /// Beginning with the `2021-06-14` API version, the `metadata` property is no longer returned. For information + /// about system entities recognized in the user input, see the `interpretation` property. /// [JsonProperty("metadata", NullValueHandling = NullValueHandling.Ignore)] public Dictionary Metadata { get; set; } diff --git a/src/IBM.Watson.Assistant.v2/Model/RuntimeEntity.cs b/src/IBM.Watson.Assistant.v2/Model/RuntimeEntity.cs index aaefe81b45..7eafe8bc43 100644 --- a/src/IBM.Watson.Assistant.v2/Model/RuntimeEntity.cs +++ b/src/IBM.Watson.Assistant.v2/Model/RuntimeEntity.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2018, 2020. +* (C) Copyright IBM Corp. 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -47,7 +47,10 @@ public class RuntimeEntity [JsonProperty("confidence", NullValueHandling = NullValueHandling.Ignore)] public float? Confidence { get; set; } /// - /// Any metadata for the entity. + /// **Deprecated.** Any metadata for the entity. + /// + /// Beginning with the `2021-06-14` API version, the `metadata` property is no longer returned. For information + /// about system entities recognized in the user input, see the `interpretation` property. /// [JsonProperty("metadata", NullValueHandling = NullValueHandling.Ignore)] public Dictionary Metadata { get; set; } diff --git a/src/IBM.Watson.Discovery.v1/DiscoveryService.cs b/src/IBM.Watson.Discovery.v1/DiscoveryService.cs index 47e95f4b5f..96bfce92b0 100644 --- a/src/IBM.Watson.Discovery.v1/DiscoveryService.cs +++ b/src/IBM.Watson.Discovery.v1/DiscoveryService.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2017, 2020. +* (C) Copyright IBM Corp. 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -16,7 +16,7 @@ */ /** -* IBM OpenAPI SDK Code Generator Version: 99-SNAPSHOT-be3b4618-20201201-123423 +* IBM OpenAPI SDK Code Generator Version: 3.38.0-07189efd-20210827-205025 */ using System.Collections.Generic; @@ -2364,7 +2364,7 @@ public DetailedResponse DeleteDocument(string environmen /// are biased towards higher field values. This parameter cannot be used in the same query as the **sort** /// parameter. (optional) /// When `true` and the **natural_language_query** parameter is used, the - /// **natural_languge_query** parameter is spell checked. The most likely correction is retunred in the + /// **natural_languge_query** parameter is spell checked. The most likely correction is returned in the /// **suggested_query** field of the response (if one exists). /// /// **Important:** this parameter is only valid when using the Cloud Pak version of Discovery. (optional, @@ -3061,7 +3061,7 @@ public DetailedResponse FederatedQueryNotices(string envir /// The ID of the environment. /// The ID of the collection. /// The prefix to use for autocompletion. For example, the prefix `Ho` could autocomplete - /// to `Hot`, `Housing`, or `How do I upgrade`. Possible completions are. + /// to `hot`, `housing`, or `how`. /// The field in the result documents that autocompletion suggestions are identified from. /// (optional) /// The number of autocompletion suggestions to return. (optional) diff --git a/src/IBM.Watson.Discovery.v1/Model/Enrichment.cs b/src/IBM.Watson.Discovery.v1/Model/Enrichment.cs index e9d591d0a4..ca0c800511 100644 --- a/src/IBM.Watson.Discovery.v1/Model/Enrichment.cs +++ b/src/IBM.Watson.Discovery.v1/Model/Enrichment.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2017, 2020. +* (C) Copyright IBM Corp. 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -56,9 +56,9 @@ public class Enrichment /// When using `natual_language_understanding`, the **options** object must contain Natural Language /// Understanding options. /// - /// When using `elements` the **options** object must contain Element Classification options. Additionally, - /// when using the `elements` enrichment the configuration specified and files ingested must meet all the - /// criteria specified in [the + /// When using `elements` the **options** object must contain Element Classification options. Additionally, when + /// using the `elements` enrichment the configuration specified and files ingested must meet all the criteria + /// specified in [the /// documentation](https://cloud.ibm.com/docs/discovery?topic=discovery-element-classification#element-classification). /// [JsonProperty("enrichment", NullValueHandling = NullValueHandling.Ignore)] diff --git a/src/IBM.Watson.Discovery.v1/Model/EnrichmentOptions.cs b/src/IBM.Watson.Discovery.v1/Model/EnrichmentOptions.cs index de8049fac9..8ceea3e293 100644 --- a/src/IBM.Watson.Discovery.v1/Model/EnrichmentOptions.cs +++ b/src/IBM.Watson.Discovery.v1/Model/EnrichmentOptions.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2017, 2019. +* (C) Copyright IBM Corp. 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -86,7 +86,7 @@ public class LanguageEnumValue [JsonProperty("features", NullValueHandling = NullValueHandling.Ignore)] public NluEnrichmentFeatures Features { get; set; } /// - /// *For use with `elements` enrichments only.* The element extraction model to use. Models available are: + /// For use with `elements` enrichments only. The element extraction model to use. The only model available is /// `contract`. /// [JsonProperty("model", NullValueHandling = NullValueHandling.Ignore)] diff --git a/src/IBM.Watson.Discovery.v1/Model/Notice.cs b/src/IBM.Watson.Discovery.v1/Model/Notice.cs index 2e6415ca73..d94d9e71f9 100644 --- a/src/IBM.Watson.Discovery.v1/Model/Notice.cs +++ b/src/IBM.Watson.Discovery.v1/Model/Notice.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2017, 2019. +* (C) Copyright IBM Corp. 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -55,7 +55,7 @@ public class SeverityEnumValue /// `missing_model`, `unsupported_model`, `smart_document_understanding_failed_incompatible_field`, /// `smart_document_understanding_failed_internal_error`, `smart_document_understanding_failed_internal_error`, /// `smart_document_understanding_failed_warning`, `smart_document_understanding_page_error`, - /// `smart_document_understanding_page_warning`. **Note:** This is not a complete list, other values might be + /// `smart_document_understanding_page_warning`. **Note:** This is not a complete list; other values might be /// returned. /// [JsonProperty("notice_id", NullValueHandling = NullValueHandling.Ignore)] @@ -76,8 +76,8 @@ public class SeverityEnumValue [JsonProperty("query_id", NullValueHandling = NullValueHandling.Ignore)] public virtual string QueryId { get; private set; } /// - /// Ingestion or training step in which the notice occurred. Typical step values include: `classify_elements`, - /// `smartDocumentUnderstanding`, `ingestion`, `indexing`, `convert`. **Note:** This is not a complete list, + /// Ingestion or training step in which the notice occurred. Typical step values include: + /// `smartDocumentUnderstanding`, `ingestion`, `indexing`, `convert`. **Note:** This is not a complete list; /// other values might be returned. /// [JsonProperty("step", NullValueHandling = NullValueHandling.Ignore)] diff --git a/src/IBM.Watson.Discovery.v2/DiscoveryService.cs b/src/IBM.Watson.Discovery.v2/DiscoveryService.cs index 3992a18e88..36febfe53d 100644 --- a/src/IBM.Watson.Discovery.v2/DiscoveryService.cs +++ b/src/IBM.Watson.Discovery.v2/DiscoveryService.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2019, 2021. +* (C) Copyright IBM Corp. 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -16,7 +16,7 @@ */ /** -* IBM OpenAPI SDK Code Generator Version: 99-SNAPSHOT-902c9336-20210513-140138 +* IBM OpenAPI SDK Code Generator Version: 3.38.0-07189efd-20210827-205025 */ using System.Collections.Generic; @@ -65,8 +65,8 @@ public DiscoveryService(string version, string serviceName, IAuthenticator authe /// /// Lists existing collections for the specified project. /// - /// The ID of the project. This information can be found from the deploy page of the - /// Discovery administrative tooling. + /// The ID of the project. This information can be found from the *Integrate and Deploy* + /// page in Discovery. /// ListCollectionsResponse public DetailedResponse ListCollections(string projectId) { @@ -120,8 +120,8 @@ public DetailedResponse ListCollections(string projectI /// /// Create a new collection in the specified project. /// - /// The ID of the project. This information can be found from the deploy page of the - /// Discovery administrative tooling. + /// The ID of the project. This information can be found from the *Integrate and Deploy* + /// page in Discovery. /// The name of the collection. /// A description of the collection. (optional) /// The language of the collection. (optional, default to en) @@ -204,8 +204,8 @@ public DetailedResponse CreateCollection(string projectId, st /// /// Get details about the specified collection. /// - /// The ID of the project. This information can be found from the deploy page of the - /// Discovery administrative tooling. + /// The ID of the project. This information can be found from the *Integrate and Deploy* + /// page in Discovery. /// The ID of the collection. /// CollectionDetails public DetailedResponse GetCollection(string projectId, string collectionId) @@ -268,8 +268,8 @@ public DetailedResponse GetCollection(string projectId, strin /// /// Updates the specified collection's name, description, and enrichments. /// - /// The ID of the project. This information can be found from the deploy page of the - /// Discovery administrative tooling. + /// The ID of the project. This information can be found from the *Integrate and Deploy* + /// page in Discovery. /// The ID of the collection. /// The name of the collection. (optional) /// A description of the collection. (optional) @@ -353,8 +353,8 @@ public DetailedResponse UpdateCollection(string projectId, st /// Deletes the specified collection from the project. All documents stored in the specified collection and not /// shared is also deleted. /// - /// The ID of the project. This information can be found from the deploy page of the - /// Discovery administrative tooling. + /// The ID of the project. This information can be found from the *Integrate and Deploy* + /// page in Discovery. /// The ID of the collection. /// object public DetailedResponse DeleteCollection(string projectId, string collectionId) @@ -420,8 +420,8 @@ public DetailedResponse DeleteCollection(string projectId, string collec /// overview of the standard default settings, and see [the Projects API documentation](#create-project) for /// details about how to set custom default query settings. /// - /// The ID of the project. This information can be found from the deploy page of the - /// Discovery administrative tooling. + /// The ID of the project. This information can be found from the *Integrate and Deploy* + /// page in Discovery. /// A comma-separated list of collection IDs to be queried against. /// (optional) /// A cacheable query that excludes documents that don't mention the query content. Filter @@ -449,7 +449,8 @@ public DetailedResponse DeleteCollection(string projectId, string collec /// **natural_language_query** parameter is spell checked. The most likely correction is returned in the /// **suggested_query** field of the response (if one exists). (optional) /// Configuration for table retrieval. (optional) - /// Configuration for suggested refinements. (optional) + /// Configuration for suggested refinements. Available with Premium plans + /// only. (optional) /// Configuration for passage retrieval. (optional) /// QueryResponse public DetailedResponse Query(string projectId, List collectionIds = null, string filter = null, string query = null, string naturalLanguageQuery = null, string aggregation = null, long? count = null, List _return = null, long? offset = null, string sort = null, bool? highlight = null, bool? spellingSuggestions = null, QueryLargeTableResults tableResults = null, QueryLargeSuggestedRefinements suggestedRefinements = null, QueryLargePassages passages = null) @@ -565,10 +566,10 @@ public DetailedResponse Query(string projectId, List coll /// /// Returns completion query suggestions for the specified prefix. /// - /// The ID of the project. This information can be found from the deploy page of the - /// Discovery administrative tooling. + /// The ID of the project. This information can be found from the *Integrate and Deploy* + /// page in Discovery. /// The prefix to use for autocompletion. For example, the prefix `Ho` could autocomplete - /// to `Hot`, `Housing`, or `How do I upgrade`. Possible completions are. + /// to `hot`, `housing`, or `how`. /// Comma separated list of the collection IDs. If this parameter is not specified, /// all collections in the project are used. (optional) /// The field in the result documents that autocompletion suggestions are identified from. @@ -647,8 +648,8 @@ public DetailedResponse GetAutocompletion(string projectId, string /// /// Finds collection-level notices (errors and warnings) that are generated when documents are ingested. /// - /// The ID of the project. This information can be found from the deploy page of the - /// Discovery administrative tooling. + /// The ID of the project. This information can be found from the *Integrate and Deploy* + /// page in Discovery. /// The ID of the collection. /// A cacheable query that excludes documents that don't mention the query content. Filter /// searches are better for metadata-type searches and for assessing the concepts in the data set. @@ -744,8 +745,8 @@ public DetailedResponse QueryCollectionNotices(string proj /// Finds project-level notices (errors and warnings). Currently, project-level notices are generated by /// relevancy training. /// - /// The ID of the project. This information can be found from the deploy page of the - /// Discovery administrative tooling. + /// The ID of the project. This information can be found from the *Integrate and Deploy* + /// page in Discovery. /// A cacheable query that excludes documents that don't mention the query content. Filter /// searches are better for metadata-type searches and for assessing the concepts in the data set. /// (optional) @@ -831,8 +832,8 @@ public DetailedResponse QueryNotices(string projectId, str /// /// Gets a list of the unique fields (and their types) stored in the the specified collections. /// - /// The ID of the project. This information can be found from the deploy page of the - /// Discovery administrative tooling. + /// The ID of the project. This information can be found from the *Integrate and Deploy* + /// page in Discovery. /// Comma separated list of the collection IDs. If this parameter is not specified, /// all collections in the project are used. (optional) /// ListFieldsResponse @@ -891,8 +892,8 @@ public DetailedResponse ListFields(string projectId, List - /// The ID of the project. This information can be found from the deploy page of the - /// Discovery administrative tooling. + /// The ID of the project. This information can be found from the *Integrate and Deploy* + /// page in Discovery. /// ComponentSettingsResponse public DetailedResponse GetComponentSettings(string projectId) { @@ -945,16 +946,16 @@ public DetailedResponse GetComponentSettings(string p /// /// Add a document to a collection with optional metadata. /// - /// Returns immediately after the system has accepted the document for processing. + /// Returns immediately after the system has accepted the document for processing. /// /// * The user must provide document content, metadata, or both. If the request is missing both document /// content and metadata, it is rejected. /// - /// * The user can set the **Content-Type** parameter on the **file** part to indicate the media type of the + /// * You can set the **Content-Type** parameter on the **file** part to indicate the media type of the /// document. If the **Content-Type** parameter is missing or is one of the generic media types (for example, /// `application/octet-stream`), then the service attempts to automatically detect the document's media type. /// - /// * The following field names are reserved and will be filtered out if present after normalization: `id`, + /// * The following field names are reserved and are filtered out if present after normalization: `id`, /// `score`, `highlight`, and any field with the prefix of: `_`, `+`, or `-` /// /// * Fields with empty name values after normalization are filtered out before indexing. @@ -962,21 +963,22 @@ public DetailedResponse GetComponentSettings(string p /// * Fields that contain the following characters after normalization are filtered out before indexing: `#` /// and `,` /// - /// If the document is uploaded to a collection that has it's data shared with another collection, the + /// If the document is uploaded to a collection that shares its data with another collection, the /// **X-Watson-Discovery-Force** header must be set to `true`. /// - /// **Note:** Documents can be added with a specific **document_id** by using the - /// **_/v2/projects/{project_id}/collections/{collection_id}/documents** method. + /// **Note:** You can assign an ID to a document that you add by appending the ID to the endpoint + /// (`/v2/projects/{project_id}/collections/{collection_id}/documents/{document_id}`). If a document already + /// exists with the specified ID, it is replaced. /// - /// **Note:** This operation only works on collections created to accept direct file uploads. It cannot be used - /// to modify a collection that connects to an external source such as Microsoft SharePoint. + /// **Note:** This operation works with a file upload collection. It cannot be used to modify a collection that + /// crawls an external data source. /// - /// The ID of the project. This information can be found from the deploy page of the - /// Discovery administrative tooling. + /// The ID of the project. This information can be found from the *Integrate and Deploy* + /// page in Discovery. /// The ID of the collection. - /// The content of the document to ingest. The maximum supported file size when adding a file - /// to a collection is 32 MB. The maximum supported file size when testing a configuration is 1 MB. Files larger - /// than the supported size are rejected. (optional) + /// The content of the document to ingest. For maximum supported file size limits, see [the + /// documentation](https://cloud.ibm.com/docs/discovery-data?topic=discovery-data-collections#collections-doc-limits). + /// (optional) /// The filename for file. (optional) /// The content type of file. (optional) /// The maximum supported metadata file size is 1 MB. Metadata parts larger than 1 MB are @@ -1113,7 +1115,7 @@ public class FileContentTypeValue /// Replace an existing document or add a document with a specified **document_id**. Starts ingesting a document /// with optional metadata. /// - /// If the document is uploaded to a collection that has it's data shared with another collection, the + /// If the document is uploaded to a collection that shares its data with another collection, the /// **X-Watson-Discovery-Force** header must be set to `true`. /// /// **Note:** When uploading a new document with this method it automatically replaces any document stored with @@ -1122,16 +1124,16 @@ public class FileContentTypeValue /// **Note:** This operation only works on collections created to accept direct file uploads. It cannot be used /// to modify a collection that connects to an external source such as Microsoft SharePoint. /// - /// **Note:** If an uploaded document is segmented, all segments will be overwritten, even if the updated - /// version of the document has fewer segments. + /// **Note:** If an uploaded document is segmented, all segments are overwritten, even if the updated version of + /// the document has fewer segments. /// - /// The ID of the project. This information can be found from the deploy page of the - /// Discovery administrative tooling. + /// The ID of the project. This information can be found from the *Integrate and Deploy* + /// page in Discovery. /// The ID of the collection. /// The ID of the document. - /// The content of the document to ingest. The maximum supported file size when adding a file - /// to a collection is 32 MB. The maximum supported file size when testing a configuration is 1 MB. Files larger - /// than the supported size are rejected. (optional) + /// The content of the document to ingest. For maximum supported file size limits, see [the + /// documentation](https://cloud.ibm.com/docs/discovery-data?topic=discovery-data-collections#collections-doc-limits). + /// (optional) /// The filename for file. (optional) /// The content type of file. (optional) /// The maximum supported metadata file size is 1 MB. Metadata parts larger than 1 MB are @@ -1282,8 +1284,8 @@ public class FileContentTypeValue /// **Note:** Segments of an uploaded document cannot be deleted individually. Delete all segments by deleting /// using the `parent_document_id` of a segment result. /// - /// The ID of the project. This information can be found from the deploy page of the - /// Discovery administrative tooling. + /// The ID of the project. This information can be found from the *Integrate and Deploy* + /// page in Discovery. /// The ID of the collection. /// The ID of the document. /// When `true`, the uploaded document is added to the collection even if @@ -1361,8 +1363,8 @@ public DetailedResponse DeleteDocument(string projectId, /// /// List the training queries for the specified project. /// - /// The ID of the project. This information can be found from the deploy page of the - /// Discovery administrative tooling. + /// The ID of the project. This information can be found from the *Integrate and Deploy* + /// page in Discovery. /// TrainingQuerySet public DetailedResponse ListTrainingQueries(string projectId) { @@ -1416,8 +1418,8 @@ public DetailedResponse ListTrainingQueries(string projectId) /// /// Removes all training queries for the specified project. /// - /// The ID of the project. This information can be found from the deploy page of the - /// Discovery administrative tooling. + /// The ID of the project. This information can be found from the *Integrate and Deploy* + /// page in Discovery. /// object public DetailedResponse DeleteTrainingQueries(string projectId) { @@ -1471,8 +1473,8 @@ public DetailedResponse DeleteTrainingQueries(string projectId) /// Add a query to the training data for this project. The query can contain a filter and natural language /// query. /// - /// The ID of the project. This information can be found from the deploy page of the - /// Discovery administrative tooling. + /// The ID of the project. This information can be found from the *Integrate and Deploy* + /// page in Discovery. /// The natural text query for the training query. /// Array of training examples. /// The filter used on the collection before the **natural_language_query** is applied. @@ -1555,8 +1557,8 @@ public DetailedResponse CreateTrainingQuery(string projectId, str /// /// Get details for a specific training data query, including the query string and all examples. /// - /// The ID of the project. This information can be found from the deploy page of the - /// Discovery administrative tooling. + /// The ID of the project. This information can be found from the *Integrate and Deploy* + /// page in Discovery. /// The ID of the query used for training. /// TrainingQuery public DetailedResponse GetTrainingQuery(string projectId, string queryId) @@ -1619,8 +1621,8 @@ public DetailedResponse GetTrainingQuery(string projectId, string /// /// Updates an existing training query and it's examples. /// - /// The ID of the project. This information can be found from the deploy page of the - /// Discovery administrative tooling. + /// The ID of the project. This information can be found from the *Integrate and Deploy* + /// page in Discovery. /// The ID of the query used for training. /// The natural text query for the training query. /// Array of training examples. @@ -1712,8 +1714,8 @@ public DetailedResponse UpdateTrainingQuery(string projectId, str /// /// Removes details from a training data query, including the query string and all examples. /// - /// The ID of the project. This information can be found from the deploy page of the - /// Discovery administrative tooling. + /// The ID of the project. This information can be found from the *Integrate and Deploy* + /// page in Discovery. /// The ID of the query used for training. /// object public DetailedResponse DeleteTrainingQuery(string projectId, string queryId) @@ -1772,18 +1774,19 @@ public DetailedResponse DeleteTrainingQuery(string projectId, string que /// /// Analyze a Document. /// - /// Process a document using the specified collection's settings and return it for realtime use. + /// Process a document and return it for realtime use. Supports JSON files only. /// - /// **Note:** Documents processed using this method are not added to the specified collection. + /// The document is processed according to the collection's configuration settings but is not stored in the + /// collection. /// - /// **Note:** This method is only supported on IBM Cloud Pak for Data instances of Discovery. + /// **Note:** This method is supported on installed instances of Discovery only. /// - /// The ID of the project. This information can be found from the deploy page of the - /// Discovery administrative tooling. + /// The ID of the project. This information can be found from the *Integrate and Deploy* + /// page in Discovery. /// The ID of the collection. - /// The content of the document to ingest. The maximum supported file size when adding a file - /// to a collection is 32 MB. The maximum supported file size when testing a configuration is 1 MB. Files larger - /// than the supported size are rejected. (optional) + /// The content of the document to ingest. For maximum supported file size limits, see [the + /// documentation](https://cloud.ibm.com/docs/discovery-data?topic=discovery-data-collections#collections-doc-limits). + /// (optional) /// The filename for file. (optional) /// The content type of file. (optional) /// The maximum supported metadata file size is 1 MB. Metadata parts larger than 1 MB are @@ -1909,10 +1912,11 @@ public class FileContentTypeValue /// /// List Enrichments. /// - /// List the enrichments available to this project. + /// Lists the enrichments available to this project. The *Part of Speech* and *Sentiment of Phrases* enrichments + /// might be listed, but are reserved for internal use only. /// - /// The ID of the project. This information can be found from the deploy page of the - /// Discovery administrative tooling. + /// The ID of the project. This information can be found from the *Integrate and Deploy* + /// page in Discovery. /// Enrichments public DetailedResponse ListEnrichments(string projectId) { @@ -1964,10 +1968,10 @@ public DetailedResponse ListEnrichments(string projectId) /// /// Create an enrichment. /// - /// Create an enrichment for use with the specified project/. + /// Create an enrichment for use with the specified project. /// - /// The ID of the project. This information can be found from the deploy page of the - /// Discovery administrative tooling. + /// The ID of the project. This information can be found from the *Integrate and Deploy* + /// page in Discovery. /// Information about a specific enrichment. /// The enrichment file to upload. (optional) /// Enrichment @@ -2046,8 +2050,8 @@ public DetailedResponse CreateEnrichment(string projectId, CreateEnr /// /// Get details about a specific enrichment. /// - /// The ID of the project. This information can be found from the deploy page of the - /// Discovery administrative tooling. + /// The ID of the project. This information can be found from the *Integrate and Deploy* + /// page in Discovery. /// The ID of the enrichment. /// Enrichment public DetailedResponse GetEnrichment(string projectId, string enrichmentId) @@ -2110,8 +2114,8 @@ public DetailedResponse GetEnrichment(string projectId, string enric /// /// Updates an existing enrichment's name and description. /// - /// The ID of the project. This information can be found from the deploy page of the - /// Discovery administrative tooling. + /// The ID of the project. This information can be found from the *Integrate and Deploy* + /// page in Discovery. /// The ID of the enrichment. /// A new name for the enrichment. /// A new description for the enrichment. (optional) @@ -2195,8 +2199,8 @@ public DetailedResponse UpdateEnrichment(string projectId, string en /// /// **Note:** Only enrichments that have been manually created can be deleted. /// - /// The ID of the project. This information can be found from the deploy page of the - /// Discovery administrative tooling. + /// The ID of the project. This information can be found from the *Integrate and Deploy* + /// page in Discovery. /// The ID of the enrichment. /// object public DetailedResponse DeleteEnrichment(string projectId, string enrichmentId) @@ -2381,8 +2385,8 @@ public DetailedResponse CreateProject(string name, string type, /// /// Get details on the specified project. /// - /// The ID of the project. This information can be found from the deploy page of the - /// Discovery administrative tooling. + /// The ID of the project. This information can be found from the *Integrate and Deploy* + /// page in Discovery. /// ProjectDetails public DetailedResponse GetProject(string projectId) { @@ -2436,8 +2440,8 @@ public DetailedResponse GetProject(string projectId) /// /// Update the specified project's name. /// - /// The ID of the project. This information can be found from the deploy page of the - /// Discovery administrative tooling. + /// The ID of the project. This information can be found from the *Integrate and Deploy* + /// page in Discovery. /// The new name to give this project. (optional) /// ProjectDetails public DetailedResponse UpdateProject(string projectId, string name = null) @@ -2504,8 +2508,8 @@ public DetailedResponse UpdateProject(string projectId, string n /// **Important:** Deleting a project deletes everything that is part of the specified project, including all /// collections. /// - /// The ID of the project. This information can be found from the deploy page of the - /// Discovery administrative tooling. + /// The ID of the project. This information can be found from the *Integrate and Deploy* + /// page in Discovery. /// object public DetailedResponse DeleteProject(string projectId) { diff --git a/src/IBM.Watson.Discovery.v2/Model/CollectionEnrichment.cs b/src/IBM.Watson.Discovery.v2/Model/CollectionEnrichment.cs index c3a4a82fc5..5c8e33fea3 100644 --- a/src/IBM.Watson.Discovery.v2/Model/CollectionEnrichment.cs +++ b/src/IBM.Watson.Discovery.v2/Model/CollectionEnrichment.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2018, 2020. +* (C) Copyright IBM Corp. 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -32,6 +32,9 @@ public class CollectionEnrichment public string EnrichmentId { get; set; } /// /// An array of field names that the enrichment is applied to. + /// + /// If you apply an enrichment to a field from a JSON file, the data is converted to an array automatically, + /// even if the field contains a single value. /// [JsonProperty("fields", NullValueHandling = NullValueHandling.Ignore)] public List Fields { get; set; } diff --git a/src/IBM.Watson.Discovery.v2/Model/CreateEnrichment.cs b/src/IBM.Watson.Discovery.v2/Model/CreateEnrichment.cs index fce530792b..49c138b9c2 100644 --- a/src/IBM.Watson.Discovery.v2/Model/CreateEnrichment.cs +++ b/src/IBM.Watson.Discovery.v2/Model/CreateEnrichment.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2020, 2021. +* (C) Copyright IBM Corp. 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -69,7 +69,8 @@ public class TypeEnumValue [JsonProperty("description", NullValueHandling = NullValueHandling.Ignore)] public string Description { get; set; } /// - /// A object that contains options for the current enrichment. + /// An object that contains options for the current enrichment. Starting with version `2020-08-30`, the + /// enrichment options are not included in responses from the List Enrichments method. /// [JsonProperty("options", NullValueHandling = NullValueHandling.Ignore)] public EnrichmentOptions Options { get; set; } diff --git a/src/IBM.Watson.Discovery.v2/Model/DefaultQueryParams.cs b/src/IBM.Watson.Discovery.v2/Model/DefaultQueryParams.cs index cedfebb14d..e54b6534b1 100644 --- a/src/IBM.Watson.Discovery.v2/Model/DefaultQueryParams.cs +++ b/src/IBM.Watson.Discovery.v2/Model/DefaultQueryParams.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2020, 2021. +* (C) Copyright IBM Corp. 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -46,7 +46,7 @@ public class DefaultQueryParams [JsonProperty("aggregation", NullValueHandling = NullValueHandling.Ignore)] public string Aggregation { get; set; } /// - /// Object that contains suggested refinement settings. + /// Object that contains suggested refinement settings. Available with Premium plans only. /// [JsonProperty("suggested_refinements", NullValueHandling = NullValueHandling.Ignore)] public DefaultQueryParamsSuggestedRefinements SuggestedRefinements { get; set; } diff --git a/src/IBM.Watson.Discovery.v2/Model/DefaultQueryParamsSuggestedRefinements.cs b/src/IBM.Watson.Discovery.v2/Model/DefaultQueryParamsSuggestedRefinements.cs index 54e24df987..3f30393a72 100644 --- a/src/IBM.Watson.Discovery.v2/Model/DefaultQueryParamsSuggestedRefinements.cs +++ b/src/IBM.Watson.Discovery.v2/Model/DefaultQueryParamsSuggestedRefinements.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2020, 2021. +* (C) Copyright IBM Corp. 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -20,12 +20,12 @@ namespace IBM.Watson.Discovery.v2.Model { /// - /// Object that contains suggested refinement settings. + /// Object that contains suggested refinement settings. Available with Premium plans only. /// public class DefaultQueryParamsSuggestedRefinements { /// - /// When `true`, a suggested refinements for the query are returned by default. + /// When `true`, suggested refinements for the query are returned by default. /// [JsonProperty("enabled", NullValueHandling = NullValueHandling.Ignore)] public bool? Enabled { get; set; } diff --git a/src/IBM.Watson.Discovery.v2/Model/Enrichment.cs b/src/IBM.Watson.Discovery.v2/Model/Enrichment.cs index d4e04c0bc0..4973928586 100644 --- a/src/IBM.Watson.Discovery.v2/Model/Enrichment.cs +++ b/src/IBM.Watson.Discovery.v2/Model/Enrichment.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2020, 2021. +* (C) Copyright IBM Corp. 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -86,7 +86,8 @@ public class TypeEnumValue [JsonProperty("description", NullValueHandling = NullValueHandling.Ignore)] public string Description { get; set; } /// - /// A object that contains options for the current enrichment. + /// An object that contains options for the current enrichment. Starting with version `2020-08-30`, the + /// enrichment options are not included in responses from the List Enrichments method. /// [JsonProperty("options", NullValueHandling = NullValueHandling.Ignore)] public EnrichmentOptions Options { get; set; } diff --git a/src/IBM.Watson.Discovery.v2/Model/EnrichmentOptions.cs b/src/IBM.Watson.Discovery.v2/Model/EnrichmentOptions.cs index 754eaa3e3d..a3a38f5a4c 100644 --- a/src/IBM.Watson.Discovery.v2/Model/EnrichmentOptions.cs +++ b/src/IBM.Watson.Discovery.v2/Model/EnrichmentOptions.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2020, 2021. +* (C) Copyright IBM Corp. 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -21,30 +21,32 @@ namespace IBM.Watson.Discovery.v2.Model { /// - /// A object that contains options for the current enrichment. + /// An object that contains options for the current enrichment. Starting with version `2020-08-30`, the enrichment + /// options are not included in responses from the List Enrichments method. /// public class EnrichmentOptions { /// - /// An array of supported languages for this enrichment. + /// An array of supported languages for this enrichment. Required when `type` is `dictionary`. Optional when + /// `type` is `rule_based`. Not valid when creating any other type of enrichment. /// [JsonProperty("languages", NullValueHandling = NullValueHandling.Ignore)] public List Languages { get; set; } /// - /// The type of entity. Required when creating `dictionary` and `regular_expression` **type** enrichment. Not - /// valid when creating any other type of enrichment. + /// The name of the entity type. This value is used as the field name in the index. Required when `type` is + /// `dictionary` or `regular_expression`. Not valid when creating any other type of enrichment. /// [JsonProperty("entity_type", NullValueHandling = NullValueHandling.Ignore)] public string EntityType { get; set; } /// - /// The regular expression to apply for this enrichment. Required only when the **type** of enrichment being - /// created is a `regular_expression`. Not valid when creating any other type of enrichment. + /// The regular expression to apply for this enrichment. Required when `type` is `regular_expression`. Not valid + /// when creating any other type of enrichment. /// [JsonProperty("regular_expression", NullValueHandling = NullValueHandling.Ignore)] public string RegularExpression { get; set; } /// - /// The name of the result document field that this enrichment creates. Required only when the enrichment - /// **type** is `rule_based`. Not valid when creating any other type of enrichment. + /// The name of the result document field that this enrichment creates. Required when `type` is `rule_based`. + /// Not valid when creating any other type of enrichment. /// [JsonProperty("result_field", NullValueHandling = NullValueHandling.Ignore)] public string ResultField { get; set; } diff --git a/src/IBM.Watson.Discovery.v2/Model/QueryFilterAggregation.cs b/src/IBM.Watson.Discovery.v2/Model/QueryFilterAggregation.cs index 5d8295e17e..e2640c5ef2 100644 --- a/src/IBM.Watson.Discovery.v2/Model/QueryFilterAggregation.cs +++ b/src/IBM.Watson.Discovery.v2/Model/QueryFilterAggregation.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2019, 2021. +* (C) Copyright IBM Corp. 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -21,13 +21,13 @@ namespace IBM.Watson.Discovery.v2.Model { /// - /// A modifier that will narrow down the document set of the sub aggregations it precedes. + /// A modifier that narrows the document set of the sub-aggregations it precedes. /// public class QueryFilterAggregation : QueryAggregation { /// - /// The filter written in Discovery Query Language syntax applied to the documents before sub aggregations are - /// run. + /// The filter that is written in Discovery Query Language syntax and is applied to the documents before + /// sub-aggregations are run. /// [JsonProperty("match", NullValueHandling = NullValueHandling.Ignore)] public string Match { get; set; } @@ -37,7 +37,7 @@ public class QueryFilterAggregation : QueryAggregation [JsonProperty("matching_results", NullValueHandling = NullValueHandling.Ignore)] public long? MatchingResults { get; set; } /// - /// An array of sub aggregations. + /// An array of sub-aggregations. /// [JsonProperty("aggregations", NullValueHandling = NullValueHandling.Ignore)] public List Aggregations { get; set; } diff --git a/src/IBM.Watson.Discovery.v2/Model/QueryGroupByAggregationResult.cs b/src/IBM.Watson.Discovery.v2/Model/QueryGroupByAggregationResult.cs index c20cc3f66e..2626ca2c96 100644 --- a/src/IBM.Watson.Discovery.v2/Model/QueryGroupByAggregationResult.cs +++ b/src/IBM.Watson.Discovery.v2/Model/QueryGroupByAggregationResult.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2020, 2021. +* (C) Copyright IBM Corp. 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -53,7 +53,7 @@ public class QueryGroupByAggregationResult [JsonProperty("estimated_matching_documents", NullValueHandling = NullValueHandling.Ignore)] public long? EstimatedMatchingDocuments { get; set; } /// - /// An array of sub aggregations. + /// An array of sub-aggregations. /// [JsonProperty("aggregations", NullValueHandling = NullValueHandling.Ignore)] public List Aggregations { get; set; } diff --git a/src/IBM.Watson.Discovery.v2/Model/QueryHistogramAggregation.cs b/src/IBM.Watson.Discovery.v2/Model/QueryHistogramAggregation.cs index 564c94abaa..6178c0e55d 100644 --- a/src/IBM.Watson.Discovery.v2/Model/QueryHistogramAggregation.cs +++ b/src/IBM.Watson.Discovery.v2/Model/QueryHistogramAggregation.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2018, 2020. +* (C) Copyright IBM Corp. 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -32,7 +32,7 @@ public class QueryHistogramAggregation : QueryAggregation [JsonProperty("field", NullValueHandling = NullValueHandling.Ignore)] public string Field { get; set; } /// - /// The size of the sections the results are split into. + /// The size of the sections that the results are split into. /// [JsonProperty("interval", NullValueHandling = NullValueHandling.Ignore)] public long? Interval { get; set; } diff --git a/src/IBM.Watson.Discovery.v2/Model/QueryHistogramAggregationResult.cs b/src/IBM.Watson.Discovery.v2/Model/QueryHistogramAggregationResult.cs index 133ece0639..711a15c86c 100644 --- a/src/IBM.Watson.Discovery.v2/Model/QueryHistogramAggregationResult.cs +++ b/src/IBM.Watson.Discovery.v2/Model/QueryHistogramAggregationResult.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2018, 2019. +* (C) Copyright IBM Corp. 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -36,7 +36,7 @@ public class QueryHistogramAggregationResult [JsonProperty("matching_results", NullValueHandling = NullValueHandling.Ignore)] public long? MatchingResults { get; set; } /// - /// An array of sub aggregations. + /// An array of sub-aggregations. /// [JsonProperty("aggregations", NullValueHandling = NullValueHandling.Ignore)] public List Aggregations { get; set; } diff --git a/src/IBM.Watson.Discovery.v2/Model/QueryLargePassages.cs b/src/IBM.Watson.Discovery.v2/Model/QueryLargePassages.cs index c4c5af5548..ab56508bc3 100644 --- a/src/IBM.Watson.Discovery.v2/Model/QueryLargePassages.cs +++ b/src/IBM.Watson.Discovery.v2/Model/QueryLargePassages.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2019, 2021. +* (C) Copyright IBM Corp. 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -31,7 +31,11 @@ public class QueryLargePassages [JsonProperty("enabled", NullValueHandling = NullValueHandling.Ignore)] public bool? Enabled { get; set; } /// - /// Indicates whether to group passages with the document that they are extracted from in the query result. + /// If `true`, ranks the documents by document quality, and then returns the highest-ranked passages per + /// document in a `document_passages` field for each document entry in the results list of the response. + /// + /// If `false`, ranks the passages from all of the documents by passage quality regardless of the document + /// quality and returns them in a separate `passages` field in the response. /// [JsonProperty("per_document", NullValueHandling = NullValueHandling.Ignore)] public bool? PerDocument { get; set; } @@ -61,16 +65,19 @@ public class QueryLargePassages /// When true, `answer` objects are returned as part of each passage in the query results. The primary /// difference between an `answer` and a `passage` is that the length of a passage is defined by the query, /// where the length of an `answer` is calculated by Discovery based on how much text is needed to answer the - /// question./n/nThis parameter is ignored if passages are not enabled for the query, or no - /// **natural_language_query** is specified./n/nIf the **find_answers** parameter is set to `true` and - /// **per_document** parameter is also set to `true`, then the document search results and the passage search - /// results within each document are reordered using the answer confidences. The goal of this reordering is to - /// do as much as possible to make sure that the first answer of the first passage of the first document is the - /// best answer. Similarly, if the **find_answers** parameter is set to `true` and **per_document** parameter is - /// set to `false`, then the passage search results are reordered in decreasing order of the highest confidence - /// answer for each document and passage./n/nThe **find_answers** parameter is **beta** functionality available - /// only on managed instances and should not be used in a production environment. This parameter is not - /// available on installed instances of Discovery. + /// question. + /// + /// This parameter is ignored if passages are not enabled for the query, or no **natural_language_query** is + /// specified. + /// + /// If the **find_answers** parameter is set to `true` and **per_document** parameter is also set to `true`, + /// then the document search results and the passage search results within each document are reordered using the + /// answer confidences. The goal of this reordering is to place the best answer as the first answer of the first + /// passage of the first document. Similarly, if the **find_answers** parameter is set to `true` and + /// **per_document** parameter is set to `false`, then the passage search results are reordered in decreasing + /// order of the highest confidence answer for each document and passage. + /// + /// The **find_answers** parameter is available only on managed instances of Discovery. /// [JsonProperty("find_answers", NullValueHandling = NullValueHandling.Ignore)] public bool? FindAnswers { get; set; } diff --git a/src/IBM.Watson.Discovery.v2/Model/QueryLargeSuggestedRefinements.cs b/src/IBM.Watson.Discovery.v2/Model/QueryLargeSuggestedRefinements.cs index 5c0befbfdb..37e9edc032 100644 --- a/src/IBM.Watson.Discovery.v2/Model/QueryLargeSuggestedRefinements.cs +++ b/src/IBM.Watson.Discovery.v2/Model/QueryLargeSuggestedRefinements.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2018, 2020. +* (C) Copyright IBM Corp. 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -20,7 +20,7 @@ namespace IBM.Watson.Discovery.v2.Model { /// - /// Configuration for suggested refinements. + /// Configuration for suggested refinements. Available with Premium plans only. /// public class QueryLargeSuggestedRefinements { diff --git a/src/IBM.Watson.Discovery.v2/Model/QueryNestedAggregation.cs b/src/IBM.Watson.Discovery.v2/Model/QueryNestedAggregation.cs index 491fb24798..b8b453253b 100644 --- a/src/IBM.Watson.Discovery.v2/Model/QueryNestedAggregation.cs +++ b/src/IBM.Watson.Discovery.v2/Model/QueryNestedAggregation.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2018, 2019. +* (C) Copyright IBM Corp. 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -21,13 +21,13 @@ namespace IBM.Watson.Discovery.v2.Model { /// - /// A restriction that alter the document set used for sub aggregations it precedes to nested documents found in the - /// field specified. + /// A restriction that alters the document set that is used for sub-aggregations it precedes to nested documents + /// found in the field specified. /// public class QueryNestedAggregation : QueryAggregation { /// - /// The path to the document field to scope sub aggregations to. + /// The path to the document field to scope sub-aggregations to. /// [JsonProperty("path", NullValueHandling = NullValueHandling.Ignore)] public string Path { get; set; } @@ -37,7 +37,7 @@ public class QueryNestedAggregation : QueryAggregation [JsonProperty("matching_results", NullValueHandling = NullValueHandling.Ignore)] public long? MatchingResults { get; set; } /// - /// An array of sub aggregations. + /// An array of sub-aggregations. /// [JsonProperty("aggregations", NullValueHandling = NullValueHandling.Ignore)] public List Aggregations { get; set; } diff --git a/src/IBM.Watson.Discovery.v2/Model/QueryResponse.cs b/src/IBM.Watson.Discovery.v2/Model/QueryResponse.cs index 4086d752a5..d547cd4a54 100644 --- a/src/IBM.Watson.Discovery.v2/Model/QueryResponse.cs +++ b/src/IBM.Watson.Discovery.v2/Model/QueryResponse.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2019, 2021. +* (C) Copyright IBM Corp. 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -26,7 +26,8 @@ namespace IBM.Watson.Discovery.v2.Model public class QueryResponse { /// - /// The number of matching results for the query. + /// The number of matching results for the query. Results that match due to a curation only are not counted in + /// the total. /// [JsonProperty("matching_results", NullValueHandling = NullValueHandling.Ignore)] public long? MatchingResults { get; set; } @@ -61,7 +62,7 @@ public class QueryResponse [JsonProperty("table_results", NullValueHandling = NullValueHandling.Ignore)] public List TableResults { get; set; } /// - /// Passages returned by Discovery. + /// Passages that best match the query from across all of the collections in the project. /// [JsonProperty("passages", NullValueHandling = NullValueHandling.Ignore)] public List Passages { get; set; } diff --git a/src/IBM.Watson.Discovery.v2/Model/QueryResponsePassage.cs b/src/IBM.Watson.Discovery.v2/Model/QueryResponsePassage.cs index 32d93a6496..ebc8479713 100644 --- a/src/IBM.Watson.Discovery.v2/Model/QueryResponsePassage.cs +++ b/src/IBM.Watson.Discovery.v2/Model/QueryResponsePassage.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2020, 2021. +* (C) Copyright IBM Corp. 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -51,7 +51,7 @@ public class QueryResponsePassage [JsonProperty("start_offset", NullValueHandling = NullValueHandling.Ignore)] public long? StartOffset { get; set; } /// - /// The position of the last character of the extracted passage in the originating field. + /// The position after the last character of the extracted passage in the originating field. /// [JsonProperty("end_offset", NullValueHandling = NullValueHandling.Ignore)] public long? EndOffset { get; set; } diff --git a/src/IBM.Watson.Discovery.v2/Model/QueryResult.cs b/src/IBM.Watson.Discovery.v2/Model/QueryResult.cs index 4d7ce497be..49af44da29 100644 --- a/src/IBM.Watson.Discovery.v2/Model/QueryResult.cs +++ b/src/IBM.Watson.Discovery.v2/Model/QueryResult.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2018, 2019. +* (C) Copyright IBM Corp. 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -42,7 +42,7 @@ public class QueryResult : DynamicModel [JsonProperty("result_metadata", NullValueHandling = NullValueHandling.Ignore)] public QueryResultMetadata ResultMetadata { get; set; } /// - /// Passages returned by Discovery. + /// Passages from the document that best matches the query. /// [JsonProperty("document_passages", NullValueHandling = NullValueHandling.Ignore)] public List DocumentPassages { get; set; } diff --git a/src/IBM.Watson.Discovery.v2/Model/QueryResultPassage.cs b/src/IBM.Watson.Discovery.v2/Model/QueryResultPassage.cs index e29c160bd9..8013b64bb1 100644 --- a/src/IBM.Watson.Discovery.v2/Model/QueryResultPassage.cs +++ b/src/IBM.Watson.Discovery.v2/Model/QueryResultPassage.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2019, 2021. +* (C) Copyright IBM Corp. 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -36,7 +36,7 @@ public class QueryResultPassage [JsonProperty("start_offset", NullValueHandling = NullValueHandling.Ignore)] public long? StartOffset { get; set; } /// - /// The position of the last character of the extracted passage in the originating field. + /// The position after the last character of the extracted passage in the originating field. /// [JsonProperty("end_offset", NullValueHandling = NullValueHandling.Ignore)] public long? EndOffset { get; set; } diff --git a/src/IBM.Watson.Discovery.v2/Model/QueryTermAggregationResult.cs b/src/IBM.Watson.Discovery.v2/Model/QueryTermAggregationResult.cs index a820ff1b1a..ab4abf2c6c 100644 --- a/src/IBM.Watson.Discovery.v2/Model/QueryTermAggregationResult.cs +++ b/src/IBM.Watson.Discovery.v2/Model/QueryTermAggregationResult.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2019, 2021. +* (C) Copyright IBM Corp. 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -53,7 +53,7 @@ public class QueryTermAggregationResult [JsonProperty("estimated_matching_documents", NullValueHandling = NullValueHandling.Ignore)] public long? EstimatedMatchingDocuments { get; set; } /// - /// An array of sub aggregations. + /// An array of sub-aggregations. /// [JsonProperty("aggregations", NullValueHandling = NullValueHandling.Ignore)] public List Aggregations { get; set; } diff --git a/src/IBM.Watson.Discovery.v2/Model/QueryTimesliceAggregationResult.cs b/src/IBM.Watson.Discovery.v2/Model/QueryTimesliceAggregationResult.cs index 7d1a9db5a2..4f38555562 100644 --- a/src/IBM.Watson.Discovery.v2/Model/QueryTimesliceAggregationResult.cs +++ b/src/IBM.Watson.Discovery.v2/Model/QueryTimesliceAggregationResult.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2018, 2020. +* (C) Copyright IBM Corp. 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -41,7 +41,7 @@ public class QueryTimesliceAggregationResult [JsonProperty("matching_results", NullValueHandling = NullValueHandling.Ignore)] public long? MatchingResults { get; set; } /// - /// An array of sub aggregations. + /// An array of sub-aggregations. /// [JsonProperty("aggregations", NullValueHandling = NullValueHandling.Ignore)] public List Aggregations { get; set; } diff --git a/src/IBM.Watson.Discovery.v2/Model/RetrievalDetails.cs b/src/IBM.Watson.Discovery.v2/Model/RetrievalDetails.cs index 7e39531a07..4110e68789 100644 --- a/src/IBM.Watson.Discovery.v2/Model/RetrievalDetails.cs +++ b/src/IBM.Watson.Discovery.v2/Model/RetrievalDetails.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2018, 2020. +* (C) Copyright IBM Corp. 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -28,8 +28,8 @@ public class RetrievalDetails /// Identifies the document retrieval strategy used for this query. `relevancy_training` indicates that the /// results were returned using a relevancy trained model. /// - /// **Note**: In the event of trained collections being queried, but the trained model is not used to return - /// results, the **document_retrieval_strategy** will be listed as `untrained`. + /// **Note**: In the event of trained collections being queried, but the trained model is not used to return + /// results, the **document_retrieval_strategy** is listed as `untrained`. /// public class DocumentRetrievalStrategyEnumValue { @@ -48,8 +48,8 @@ public class DocumentRetrievalStrategyEnumValue /// Identifies the document retrieval strategy used for this query. `relevancy_training` indicates that the /// results were returned using a relevancy trained model. /// - /// **Note**: In the event of trained collections being queried, but the trained model is not used to return - /// results, the **document_retrieval_strategy** will be listed as `untrained`. + /// **Note**: In the event of trained collections being queried, but the trained model is not used to return + /// results, the **document_retrieval_strategy** is listed as `untrained`. /// Constants for possible values can be found using RetrievalDetails.DocumentRetrievalStrategyEnumValue /// [JsonProperty("document_retrieval_strategy", NullValueHandling = NullValueHandling.Ignore)] diff --git a/src/IBM.Watson.LanguageTranslator.v3/LanguageTranslatorService.cs b/src/IBM.Watson.LanguageTranslator.v3/LanguageTranslatorService.cs index a47d1297c2..7e87915844 100644 --- a/src/IBM.Watson.LanguageTranslator.v3/LanguageTranslatorService.cs +++ b/src/IBM.Watson.LanguageTranslator.v3/LanguageTranslatorService.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2018, 2020. +* (C) Copyright IBM Corp. 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -16,7 +16,7 @@ */ /** -* IBM OpenAPI SDK Code Generator Version: 99-SNAPSHOT-be3b4618-20201201-123423 +* IBM OpenAPI SDK Code Generator Version: 3.38.0-07189efd-20210827-205025 */ using System.Collections.Generic; diff --git a/src/IBM.Watson.NaturalLanguageUnderstanding.v1/Model/CategoriesOptions.cs b/src/IBM.Watson.NaturalLanguageUnderstanding.v1/Model/CategoriesOptions.cs index e24e9f0d6f..a6c0f2ff9f 100644 --- a/src/IBM.Watson.NaturalLanguageUnderstanding.v1/Model/CategoriesOptions.cs +++ b/src/IBM.Watson.NaturalLanguageUnderstanding.v1/Model/CategoriesOptions.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2019, 2021. +* (C) Copyright IBM Corp. 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -20,7 +20,7 @@ namespace IBM.Watson.NaturalLanguageUnderstanding.v1.Model { /// - /// Returns a five-level taxonomy of the content. The top three categories are returned. + /// Returns a hierarchical taxonomy of the content. The top three categories are returned by default. /// /// Supported languages: Arabic, English, French, German, Italian, Japanese, Korean, Portuguese, Spanish. /// diff --git a/src/IBM.Watson.NaturalLanguageUnderstanding.v1/Model/CategoriesResult.cs b/src/IBM.Watson.NaturalLanguageUnderstanding.v1/Model/CategoriesResult.cs index 4a83f98ce8..718fefdd12 100644 --- a/src/IBM.Watson.NaturalLanguageUnderstanding.v1/Model/CategoriesResult.cs +++ b/src/IBM.Watson.NaturalLanguageUnderstanding.v1/Model/CategoriesResult.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2017, 2020. +* (C) Copyright IBM Corp. 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -25,8 +25,8 @@ namespace IBM.Watson.NaturalLanguageUnderstanding.v1.Model public class CategoriesResult { /// - /// The path to the category through the 5-level taxonomy hierarchy. For more information about the categories, - /// see [Categories + /// The path to the category through the multi-level taxonomy hierarchy. For more information about the + /// categories, see [Categories /// hierarchy](https://cloud.ibm.com/docs/natural-language-understanding?topic=natural-language-understanding-categories#categories-hierarchy). /// [JsonProperty("label", NullValueHandling = NullValueHandling.Ignore)] diff --git a/src/IBM.Watson.NaturalLanguageUnderstanding.v1/Model/ClassificationsOptions.cs b/src/IBM.Watson.NaturalLanguageUnderstanding.v1/Model/ClassificationsOptions.cs index 2241c65f92..ccf6ee74ce 100644 --- a/src/IBM.Watson.NaturalLanguageUnderstanding.v1/Model/ClassificationsOptions.cs +++ b/src/IBM.Watson.NaturalLanguageUnderstanding.v1/Model/ClassificationsOptions.cs @@ -27,7 +27,7 @@ namespace IBM.Watson.NaturalLanguageUnderstanding.v1.Model public class ClassificationsOptions { /// - /// (Beta) Enter a [custom + /// Enter a [custom /// model](https://cloud.ibm.com/docs/natural-language-understanding?topic=natural-language-understanding-customizing) /// ID of the classification model to be used. /// diff --git a/src/IBM.Watson.NaturalLanguageUnderstanding.v1/Model/Features.cs b/src/IBM.Watson.NaturalLanguageUnderstanding.v1/Model/Features.cs index 44ca161311..039cd58f41 100644 --- a/src/IBM.Watson.NaturalLanguageUnderstanding.v1/Model/Features.cs +++ b/src/IBM.Watson.NaturalLanguageUnderstanding.v1/Model/Features.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2017, 2021. +* (C) Copyright IBM Corp. 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -71,7 +71,7 @@ public class Features /// and publication date. Supports URL and HTML input types only. /// [JsonProperty("metadata", NullValueHandling = NullValueHandling.Ignore)] - public object Metadata { get; set; } + public MetadataOptions Metadata { get; set; } /// /// Recognizes when two entities are related and identifies the type of relation. For example, an `awardedTo` /// relation might connect the entities "Nobel Prize" and "Albert Einstein". For more information, see [Relation @@ -107,7 +107,7 @@ public class Features [JsonProperty("summarization", NullValueHandling = NullValueHandling.Ignore)] public SummarizationOptions Summarization { get; set; } /// - /// Returns a five-level taxonomy of the content. The top three categories are returned. + /// Returns a hierarchical taxonomy of the content. The top three categories are returned by default. /// /// Supported languages: Arabic, English, French, German, Italian, Japanese, Korean, Portuguese, Spanish. /// diff --git a/src/IBM.Watson.NaturalLanguageUnderstanding.v1/NaturalLanguageUnderstandingService.cs b/src/IBM.Watson.NaturalLanguageUnderstanding.v1/NaturalLanguageUnderstandingService.cs index 0eb41eeee9..b9e107cae5 100644 --- a/src/IBM.Watson.NaturalLanguageUnderstanding.v1/NaturalLanguageUnderstandingService.cs +++ b/src/IBM.Watson.NaturalLanguageUnderstanding.v1/NaturalLanguageUnderstandingService.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2017, 2021. +* (C) Copyright IBM Corp. 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -1136,8 +1136,8 @@ public DetailedResponse DeleteCategoriesModel(string modelId /// /// Create classifications model. /// - /// (Beta) Creates a custom classifications model by uploading training data and associated metadata. The model - /// begins the training and deploying process and is ready to use when the `status` is `available`. + /// Creates a custom classifications model by uploading training data and associated metadata. The model begins + /// the training and deploying process and is ready to use when the `status` is `available`. /// /// The 2-letter language code of this model. /// Training data in JSON format. For more information, see [Classifications training @@ -1376,8 +1376,8 @@ public DetailedResponse GetClassificationsModel(string mod /// /// Update classifications model. /// - /// (Beta) Overwrites the training data associated with this custom classifications model and retrains the - /// model. The new model replaces the current deployment. + /// Overwrites the training data associated with this custom classifications model and retrains the model. The + /// new model replaces the current deployment. /// /// ID of the model. /// The 2-letter language code of this model. @@ -1526,8 +1526,8 @@ public class TrainingDataContentTypeValue /// /// Delete classifications model. /// - /// (Beta) Un-deploys the custom classifications model with the given model ID and deletes all associated - /// customer data, including any training data or binary artifacts. + /// Un-deploys the custom classifications model with the given model ID and deletes all associated customer + /// data, including any training data or binary artifacts. /// /// ID of the model. /// DeleteModelResults diff --git a/src/IBM.Watson.SpeechToText.v1/Model/AcousticModel.cs b/src/IBM.Watson.SpeechToText.v1/Model/AcousticModel.cs index ed8ae88b9b..49480ebc04 100644 --- a/src/IBM.Watson.SpeechToText.v1/Model/AcousticModel.cs +++ b/src/IBM.Watson.SpeechToText.v1/Model/AcousticModel.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2018, 2019. +* (C) Copyright IBM Corp. 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -80,8 +80,9 @@ public class StatusEnumValue [JsonProperty("status", NullValueHandling = NullValueHandling.Ignore)] public string Status { get; set; } /// - /// The customization ID (GUID) of the custom acoustic model. The **Create a custom acoustic model** method - /// returns only this field of the object; it does not return the other fields. + /// The customization ID (GUID) of the custom acoustic model. The [Create a custom acoustic + /// model](#createacousticmodel) method returns only this field of the object; it does not return the other + /// fields. /// [JsonProperty("customization_id", NullValueHandling = NullValueHandling.Ignore)] public string CustomizationId { get; set; } diff --git a/src/IBM.Watson.SpeechToText.v1/Model/AudioDetails.cs b/src/IBM.Watson.SpeechToText.v1/Model/AudioDetails.cs index f94fed9a29..7206371ccc 100644 --- a/src/IBM.Watson.SpeechToText.v1/Model/AudioDetails.cs +++ b/src/IBM.Watson.SpeechToText.v1/Model/AudioDetails.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2018, 2019. +* (C) Copyright IBM Corp. 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -49,7 +49,7 @@ public class TypeEnumValue } /// - /// **For an archive-type resource,** the format of the compressed archive: + /// _For an archive-type resource_, the format of the compressed archive: /// * `zip` for a **.zip** file /// * `gzip` for a **.tar.gz** file /// @@ -79,7 +79,7 @@ public class CompressionEnumValue [JsonProperty("type", NullValueHandling = NullValueHandling.Ignore)] public string Type { get; set; } /// - /// **For an archive-type resource,** the format of the compressed archive: + /// _For an archive-type resource_, the format of the compressed archive: /// * `zip` for a **.zip** file /// * `gzip` for a **.tar.gz** file /// @@ -89,13 +89,12 @@ public class CompressionEnumValue [JsonProperty("compression", NullValueHandling = NullValueHandling.Ignore)] public string Compression { get; set; } /// - /// **For an audio-type resource,** the codec in which the audio is encoded. Omitted for an archive-type - /// resource. + /// _For an audio-type resource_, the codec in which the audio is encoded. Omitted for an archive-type resource. /// [JsonProperty("codec", NullValueHandling = NullValueHandling.Ignore)] public string Codec { get; set; } /// - /// **For an audio-type resource,** the sampling rate of the audio in Hertz (samples per second). Omitted for an + /// _For an audio-type resource_, the sampling rate of the audio in Hertz (samples per second). Omitted for an /// archive-type resource. /// [JsonProperty("frequency", NullValueHandling = NullValueHandling.Ignore)] diff --git a/src/IBM.Watson.SpeechToText.v1/Model/AudioListing.cs b/src/IBM.Watson.SpeechToText.v1/Model/AudioListing.cs index 35d52054c2..5ac1dd323c 100644 --- a/src/IBM.Watson.SpeechToText.v1/Model/AudioListing.cs +++ b/src/IBM.Watson.SpeechToText.v1/Model/AudioListing.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2018, 2019. +* (C) Copyright IBM Corp. 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -26,7 +26,7 @@ namespace IBM.Watson.SpeechToText.v1.Model public class AudioListing { /// - /// **For an audio-type resource,** the status of the resource: + /// _For an audio-type resource_, the status of the resource: /// * `ok`: The service successfully analyzed the audio data. The data can be used to train the custom model. /// * `being_processed`: The service is still analyzing the audio data. The service cannot accept requests to /// add new audio resources or to train the custom model until its analysis is complete. @@ -53,7 +53,7 @@ public class StatusEnumValue } /// - /// **For an audio-type resource,** the status of the resource: + /// _For an audio-type resource_, the status of the resource: /// * `ok`: The service successfully analyzed the audio data. The data can be used to train the custom model. /// * `being_processed`: The service is still analyzing the audio data. The service cannot accept requests to /// add new audio resources or to train the custom model until its analysis is complete. @@ -66,32 +66,31 @@ public class StatusEnumValue [JsonProperty("status", NullValueHandling = NullValueHandling.Ignore)] public string Status { get; set; } /// - /// **For an audio-type resource,** the total seconds of audio in the resource. Omitted for an archive-type + /// _For an audio-type resource_, the total seconds of audio in the resource. Omitted for an archive-type /// resource. /// [JsonProperty("duration", NullValueHandling = NullValueHandling.Ignore)] public long? Duration { get; set; } /// - /// **For an audio-type resource,** the user-specified name of the resource. Omitted for an archive-type - /// resource. + /// _For an audio-type resource_, the user-specified name of the resource. Omitted for an archive-type resource. /// [JsonProperty("name", NullValueHandling = NullValueHandling.Ignore)] public string Name { get; set; } /// - /// **For an audio-type resource,** an `AudioDetails` object that provides detailed information about the + /// _For an audio-type resource_, an `AudioDetails` object that provides detailed information about the /// resource. The object is empty until the service finishes processing the audio. Omitted for an archive-type /// resource. /// [JsonProperty("details", NullValueHandling = NullValueHandling.Ignore)] public AudioDetails Details { get; set; } /// - /// **For an archive-type resource,** an object of type `AudioResource` that provides information about the + /// _For an archive-type resource_, an object of type `AudioResource` that provides information about the /// resource. Omitted for an audio-type resource. /// [JsonProperty("container", NullValueHandling = NullValueHandling.Ignore)] public AudioResource Container { get; set; } /// - /// **For an archive-type resource,** an array of `AudioResource` objects that provides information about the + /// _For an archive-type resource_, an array of `AudioResource` objects that provides information about the /// audio-type resources that are contained in the resource. Omitted for an audio-type resource. /// [JsonProperty("audio", NullValueHandling = NullValueHandling.Ignore)] diff --git a/src/IBM.Watson.SpeechToText.v1/Model/AudioResource.cs b/src/IBM.Watson.SpeechToText.v1/Model/AudioResource.cs index ab880dff03..078b54e8cf 100644 --- a/src/IBM.Watson.SpeechToText.v1/Model/AudioResource.cs +++ b/src/IBM.Watson.SpeechToText.v1/Model/AudioResource.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2018, 2019. +* (C) Copyright IBM Corp. 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -68,10 +68,10 @@ public class StatusEnumValue [JsonProperty("duration", NullValueHandling = NullValueHandling.Ignore)] public long? Duration { get; set; } /// - /// **For an archive-type resource,** the user-specified name of the resource. + /// _For an archive-type resource_, the user-specified name of the resource. /// - /// **For an audio-type resource,** the user-specified name of the resource or the name of the audio file that - /// the user added for the resource. The value depends on the method that is called. + /// _For an audio-type resource_, the user-specified name of the resource or the name of the audio file that the + /// user added for the resource. The value depends on the method that is called. /// [JsonProperty("name", NullValueHandling = NullValueHandling.Ignore)] public string Name { get; set; } diff --git a/src/IBM.Watson.SpeechToText.v1/Model/Corpus.cs b/src/IBM.Watson.SpeechToText.v1/Model/Corpus.cs index a0d783ef24..0111e5be88 100644 --- a/src/IBM.Watson.SpeechToText.v1/Model/Corpus.cs +++ b/src/IBM.Watson.SpeechToText.v1/Model/Corpus.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2017, 2019. +* (C) Copyright IBM Corp. 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -73,7 +73,11 @@ public class StatusEnumValue [JsonProperty("total_words", NullValueHandling = NullValueHandling.Ignore)] public long? TotalWords { get; set; } /// - /// The number of OOV words in the corpus. The value is `0` while the corpus is being processed. + /// _For custom models that are based on previous-generation models_, the number of OOV words extracted from the + /// corpus. The value is `0` while the corpus is being processed. + /// + /// _For custom models that are based on next-generation models_, no OOV words are extracted from corpora, so + /// the value is always `0`. /// [JsonProperty("out_of_vocabulary_words", NullValueHandling = NullValueHandling.Ignore)] public long? OutOfVocabularyWords { get; set; } diff --git a/src/IBM.Watson.SpeechToText.v1/Model/CustomWord.cs b/src/IBM.Watson.SpeechToText.v1/Model/CustomWord.cs index f0751ab9d4..383c01f396 100644 --- a/src/IBM.Watson.SpeechToText.v1/Model/CustomWord.cs +++ b/src/IBM.Watson.SpeechToText.v1/Model/CustomWord.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2018, 2019. +* (C) Copyright IBM Corp. 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -26,17 +26,18 @@ namespace IBM.Watson.SpeechToText.v1.Model public class CustomWord { /// - /// For the **Add custom words** method, you must specify the custom word that is to be added to or updated in - /// the custom model. Do not include spaces in the word. Use a `-` (dash) or `_` (underscore) to connect the - /// tokens of compound words. + /// For the [Add custom words](#addwords) method, you must specify the custom word that is to be added to or + /// updated in the custom model. Do not include spaces in the word. Use a `-` (dash) or `_` (underscore) to + /// connect the tokens of compound words. /// - /// Omit this parameter for the **Add a custom word** method. + /// Omit this parameter for the [Add a custom word](#addword) method. /// [JsonProperty("word", NullValueHandling = NullValueHandling.Ignore)] public string Word { get; set; } /// - /// An array of sounds-like pronunciations for the custom word. Specify how words that are difficult to - /// pronounce, foreign words, acronyms, and so on can be pronounced by users. + /// _For a custom model that is based on a previous-generation model_, an array of sounds-like pronunciations + /// for the custom word. Specify how words that are difficult to pronounce, foreign words, acronyms, and so on + /// can be pronounced by users. /// * For a word that is not in the service's base vocabulary, omit the parameter to have the service /// automatically generate a sounds-like pronunciation for the word. /// * For a word that is in the service's base vocabulary, use the parameter to specify additional @@ -45,6 +46,9 @@ public class CustomWord /// /// A word can have at most five sounds-like pronunciations. A pronunciation can include at most 40 characters /// not including spaces. + /// + /// _For a custom model that is based on a next-generation model_, omit this field. Custom models based on + /// next-generation models do not support the `sounds_like` field. The service ignores the field. /// [JsonProperty("sounds_like", NullValueHandling = NullValueHandling.Ignore)] public List SoundsLike { get; set; } diff --git a/src/IBM.Watson.SpeechToText.v1/Model/LanguageModel.cs b/src/IBM.Watson.SpeechToText.v1/Model/LanguageModel.cs index f054dc0c99..f9888cba3b 100644 --- a/src/IBM.Watson.SpeechToText.v1/Model/LanguageModel.cs +++ b/src/IBM.Watson.SpeechToText.v1/Model/LanguageModel.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2018, 2019. +* (C) Copyright IBM Corp. 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -80,8 +80,9 @@ public class StatusEnumValue [JsonProperty("status", NullValueHandling = NullValueHandling.Ignore)] public string Status { get; set; } /// - /// The customization ID (GUID) of the custom language model. The **Create a custom language model** method - /// returns only this field of the object; it does not return the other fields. + /// The customization ID (GUID) of the custom language model. The [Create a custom language + /// model](#createlanguagemodel) method returns only this field of the object; it does not return the other + /// fields. /// [JsonProperty("customization_id", NullValueHandling = NullValueHandling.Ignore)] public string CustomizationId { get; set; } @@ -116,9 +117,14 @@ public class StatusEnumValue [JsonProperty("dialect", NullValueHandling = NullValueHandling.Ignore)] public string Dialect { get; set; } /// - /// A list of the available versions of the custom language model. Each element of the array indicates a version - /// of the base model with which the custom model can be used. Multiple versions exist only if the custom model - /// has been upgraded; otherwise, only a single version is shown. + /// _For custom models that are based on previous-generation models_, a list of the available versions of the + /// custom language model. Each element of the array indicates a version of the base model with which the custom + /// model can be used. Multiple versions exist only if the custom model has been upgraded; otherwise, only a + /// single version is shown. + /// + /// _For custom models that are based on next-generation models_, a single version of the custom model. Only one + /// version of a custom model that is based on a next-generation model is ever available, and upgrading does not + /// apply. /// [JsonProperty("versions", NullValueHandling = NullValueHandling.Ignore)] public List Versions { get; set; } diff --git a/src/IBM.Watson.SpeechToText.v1/Model/ProcessingMetrics.cs b/src/IBM.Watson.SpeechToText.v1/Model/ProcessingMetrics.cs index f8c5389baf..da857d2f61 100644 --- a/src/IBM.Watson.SpeechToText.v1/Model/ProcessingMetrics.cs +++ b/src/IBM.Watson.SpeechToText.v1/Model/ProcessingMetrics.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2018, 2019. +* (C) Copyright IBM Corp. 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -21,7 +21,7 @@ namespace IBM.Watson.SpeechToText.v1.Model { /// /// If processing metrics are requested, information about the service's processing of the input audio. Processing - /// metrics are not available with the synchronous **Recognize audio** method. + /// metrics are not available with the synchronous [Recognize audio](#recognize) method. /// public class ProcessingMetrics { diff --git a/src/IBM.Watson.SpeechToText.v1/Model/RecognitionJob.cs b/src/IBM.Watson.SpeechToText.v1/Model/RecognitionJob.cs index 3338b47fbc..e2e2c362de 100644 --- a/src/IBM.Watson.SpeechToText.v1/Model/RecognitionJob.cs +++ b/src/IBM.Watson.SpeechToText.v1/Model/RecognitionJob.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2018, 2019. +* (C) Copyright IBM Corp. 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -85,25 +85,26 @@ public class StatusEnumValue /// /// The date and time in Coordinated Universal Time (UTC) at which the job was last updated by the service. The /// value is provided in full ISO 8601 format (`YYYY-MM-DDThh:mm:ss.sTZD`). This field is returned only by the - /// **Check jobs** and **Check a job** methods. + /// [Check jobs](#checkjobs) and [Check a job[(#checkjob) methods. /// [JsonProperty("updated", NullValueHandling = NullValueHandling.Ignore)] public string Updated { get; set; } /// - /// The URL to use to request information about the job with the **Check a job** method. This field is returned - /// only by the **Create a job** method. + /// The URL to use to request information about the job with the [Check a job](#checkjob) method. This field is + /// returned only by the [Create a job](#createjob) method. /// [JsonProperty("url", NullValueHandling = NullValueHandling.Ignore)] public string Url { get; set; } /// /// The user token associated with a job that was created with a callback URL and a user token. This field can - /// be returned only by the **Check jobs** method. + /// be returned only by the [Check jobs](#checkjobs) method. /// [JsonProperty("user_token", NullValueHandling = NullValueHandling.Ignore)] public string UserToken { get; set; } /// /// If the status is `completed`, the results of the recognition request as an array that includes a single - /// instance of a `SpeechRecognitionResults` object. This field is returned only by the **Check a job** method. + /// instance of a `SpeechRecognitionResults` object. This field is returned only by the [Check a job](#checkjob) + /// method. /// [JsonProperty("results", NullValueHandling = NullValueHandling.Ignore)] public List Results { get; set; } @@ -111,7 +112,7 @@ public class StatusEnumValue /// An array of warning messages about invalid parameters included with the request. Each warning includes a /// descriptive message and a list of invalid argument strings, for example, `"unexpected query parameter /// 'user_token', query parameter 'callback_url' was not specified"`. The request succeeds despite the warnings. - /// This field can be returned only by the **Create a job** method. + /// This field can be returned only by the [Create a job](#createjob) method. /// [JsonProperty("warnings", NullValueHandling = NullValueHandling.Ignore)] public List Warnings { get; set; } diff --git a/src/IBM.Watson.SpeechToText.v1/Model/SpeechRecognitionAlternative.cs b/src/IBM.Watson.SpeechToText.v1/Model/SpeechRecognitionAlternative.cs index 86eee9593d..1e6f2bf971 100644 --- a/src/IBM.Watson.SpeechToText.v1/Model/SpeechRecognitionAlternative.cs +++ b/src/IBM.Watson.SpeechToText.v1/Model/SpeechRecognitionAlternative.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2017, 2021. +* (C) Copyright IBM Corp. 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -31,10 +31,8 @@ public class SpeechRecognitionAlternative [JsonProperty("transcript", NullValueHandling = NullValueHandling.Ignore)] public string Transcript { get; set; } /// - /// A score that indicates the service's confidence in the transcript in the range of 0.0 to 1.0. For speech - /// recognition with previous-generation models, a confidence score is returned only for the best alternative - /// and only with results marked as final. For speech recognition with next-generation models, a confidence - /// score is never returned. + /// A score that indicates the service's confidence in the transcript in the range of 0.0 to 1.0. The service + /// returns a confidence score only for the best alternative and only with results marked as final. /// [JsonProperty("confidence", NullValueHandling = NullValueHandling.Ignore)] public double? Confidence { get; set; } diff --git a/src/IBM.Watson.SpeechToText.v1/Model/SpeechRecognitionResults.cs b/src/IBM.Watson.SpeechToText.v1/Model/SpeechRecognitionResults.cs index 11ed90e101..ca4494164e 100644 --- a/src/IBM.Watson.SpeechToText.v1/Model/SpeechRecognitionResults.cs +++ b/src/IBM.Watson.SpeechToText.v1/Model/SpeechRecognitionResults.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2018, 2019. +* (C) Copyright IBM Corp. 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -50,7 +50,7 @@ public class SpeechRecognitionResults public List SpeakerLabels { get; set; } /// /// If processing metrics are requested, information about the service's processing of the input audio. - /// Processing metrics are not available with the synchronous **Recognize audio** method. + /// Processing metrics are not available with the synchronous [Recognize audio](#recognize) method. /// [JsonProperty("processing_metrics", NullValueHandling = NullValueHandling.Ignore)] public ProcessingMetrics ProcessingMetrics { get; set; } diff --git a/src/IBM.Watson.SpeechToText.v1/Model/SupportedFeatures.cs b/src/IBM.Watson.SpeechToText.v1/Model/SupportedFeatures.cs index ae44c75f84..dc87a31b67 100644 --- a/src/IBM.Watson.SpeechToText.v1/Model/SupportedFeatures.cs +++ b/src/IBM.Watson.SpeechToText.v1/Model/SupportedFeatures.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2017, 2021. +* (C) Copyright IBM Corp. 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -33,9 +33,15 @@ public class SupportedFeatures /// /// Indicates whether the `speaker_labels` parameter can be used with the language model. /// - /// **Note:** The field returns `true` for all models. However, speaker labels are supported only for US - /// English, Australian English, German, Japanese, Korean, and Spanish (both broadband and narrowband models) - /// and UK English (narrowband model only). Speaker labels are not supported for any other models. + /// **Note:** The field returns `true` for all models. However, speaker labels are supported as beta + /// functionality only for the following languages and models: + /// * For previous-generation models, the parameter can be used for Australian English, US English, German, + /// Japanese, Korean, and Spanish (both broadband and narrowband models) and UK English (narrowband model) + /// transcription only. + /// * For next-generation models, the parameter can be used for English (Australian, Indian, UK, and US), + /// German, Japanese, Korean, and Spanish transcription only. + /// + /// Speaker labels are not supported for any other models. /// [JsonProperty("speaker_labels", NullValueHandling = NullValueHandling.Ignore)] public bool? SpeakerLabels { get; set; } diff --git a/src/IBM.Watson.SpeechToText.v1/Model/Word.cs b/src/IBM.Watson.SpeechToText.v1/Model/Word.cs index ae4ab7fd68..efc7d83561 100644 --- a/src/IBM.Watson.SpeechToText.v1/Model/Word.cs +++ b/src/IBM.Watson.SpeechToText.v1/Model/Word.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2017, 2019. +* (C) Copyright IBM Corp. 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -31,9 +31,13 @@ public class Word [JsonProperty("word", NullValueHandling = NullValueHandling.Ignore)] public string _Word { get; set; } /// - /// An array of pronunciations for the word. The array can include the sounds-like pronunciation automatically - /// generated by the service if none is provided for the word; the service adds this pronunciation when it - /// finishes processing the word. + /// _For a custom model that is based on a previous-generation model_, an array of as many as five + /// pronunciations for the word. The array can include the sounds-like pronunciation that is automatically + /// generated by the service if none is provided when the word is added to the custom model; the service adds + /// this pronunciation when it finishes processing the word. + /// + /// _For a custom model that is based on a next-generation model_, this field does not apply. Custom models + /// based on next-generation models do not support the `sounds_like` field, which is ignored. /// [JsonProperty("sounds_like", NullValueHandling = NullValueHandling.Ignore)] public List SoundsLike { get; set; } @@ -45,18 +49,25 @@ public class Word [JsonProperty("display_as", NullValueHandling = NullValueHandling.Ignore)] public string DisplayAs { get; set; } /// - /// A sum of the number of times the word is found across all corpora. For example, if the word occurs five - /// times in one corpus and seven times in another, its count is `12`. If you add a custom word to a model - /// before it is added by any corpora, the count begins at `1`; if the word is added from a corpus first and - /// later modified, the count reflects only the number of times it is found in corpora. + /// _For a custom model that is based on a previous-generation model_, a sum of the number of times the word is + /// found across all corpora and grammars. For example, if the word occurs five times in one corpus and seven + /// times in another, its count is `12`. If you add a custom word to a model before it is added by any corpora + /// or grammars, the count begins at `1`; if the word is added from a corpus or grammar first and later + /// modified, the count reflects only the number of times it is found in corpora and grammars. + /// + /// _For a custom model that is based on a next-generation model_, the `count` field for any word is always `1`. /// [JsonProperty("count", NullValueHandling = NullValueHandling.Ignore)] public long? Count { get; set; } /// - /// An array of sources that describes how the word was added to the custom model's words resource. For OOV - /// words added from a corpus, includes the name of the corpus; if the word was added by multiple corpora, the - /// names of all corpora are listed. If the word was modified or added by the user directly, the field includes - /// the string `user`. + /// An array of sources that describes how the word was added to the custom model's words resource. + /// * _For a custom model that is based on previous-generation model,_ the field includes the name of each + /// corpus and grammar from which the service extracted the word. For OOV that are added by multiple corpora or + /// grammars, the names of all corpora and grammars are listed. If you modified or added the word directly, the + /// field includes the string `user`. + /// * _For a custom model that is based on a next-generation model,_ this field shows only `user` for custom + /// words that were added directly to the custom model. Words from corpora and grammars are not added to the + /// words resource for custom models that are based on next-generation models. /// [JsonProperty("source", NullValueHandling = NullValueHandling.Ignore)] public List Source { get; set; } diff --git a/src/IBM.Watson.TextToSpeech.v1/Model/CustomModel.cs b/src/IBM.Watson.TextToSpeech.v1/Model/CustomModel.cs index daac00f442..4b019e1a72 100644 --- a/src/IBM.Watson.TextToSpeech.v1/Model/CustomModel.cs +++ b/src/IBM.Watson.TextToSpeech.v1/Model/CustomModel.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2020, 2021. +* (C) Copyright IBM Corp. 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -26,8 +26,8 @@ namespace IBM.Watson.TextToSpeech.v1.Model public class CustomModel { /// - /// The customization ID (GUID) of the custom model. The **Create a custom model** method returns only this - /// field. It does not not return the other fields of this object. + /// The customization ID (GUID) of the custom model. The [Create a custom model](#createcustommodel) method + /// returns only this field. It does not not return the other fields of this object. /// [JsonProperty("customization_id", NullValueHandling = NullValueHandling.Ignore)] public string CustomizationId { get; set; } @@ -67,14 +67,15 @@ public class CustomModel /// /// An array of `Word` objects that lists the words and their translations from the custom model. The words are /// listed in alphabetical order, with uppercase letters listed before lowercase letters. The array is empty if - /// no words are defined for the custom model. This field is returned only by the **Get a custom model** method. + /// no words are defined for the custom model. This field is returned only by the [Get a custom + /// model](#getcustommodel) method. /// [JsonProperty("words", NullValueHandling = NullValueHandling.Ignore)] public List Words { get; set; } /// /// An array of `Prompt` objects that provides information about the prompts that are defined for the specified /// custom model. The array is empty if no prompts are defined for the custom model. This field is returned only - /// by the **Get a custom model** method. + /// by the [Get a custom model](#getcustommodel) method. /// [JsonProperty("prompts", NullValueHandling = NullValueHandling.Ignore)] public List Prompts { get; set; } diff --git a/src/IBM.Watson.TextToSpeech.v1/Model/Voice.cs b/src/IBM.Watson.TextToSpeech.v1/Model/Voice.cs index 2d15306a69..de870b009f 100644 --- a/src/IBM.Watson.TextToSpeech.v1/Model/Voice.cs +++ b/src/IBM.Watson.TextToSpeech.v1/Model/Voice.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2018, 2020. +* (C) Copyright IBM Corp. 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -61,8 +61,8 @@ public class Voice [JsonProperty("supported_features", NullValueHandling = NullValueHandling.Ignore)] public SupportedFeatures SupportedFeatures { get; set; } /// - /// Returns information about a specified custom model. This field is returned only by the **Get a voice** - /// method and only when you specify the customization ID of a custom model. + /// Returns information about a specified custom model. This field is returned only by the [Get a + /// voice](#getvoice) method and only when you specify the customization ID of a custom model. /// [JsonProperty("customization", NullValueHandling = NullValueHandling.Ignore)] public CustomModel Customization { get; set; } diff --git a/src/IBM.Watson.TextToSpeech.v1/Model/Words.cs b/src/IBM.Watson.TextToSpeech.v1/Model/Words.cs index 715a16f705..10ac2535ac 100644 --- a/src/IBM.Watson.TextToSpeech.v1/Model/Words.cs +++ b/src/IBM.Watson.TextToSpeech.v1/Model/Words.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2018, 2020. +* (C) Copyright IBM Corp. 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -21,20 +21,20 @@ namespace IBM.Watson.TextToSpeech.v1.Model { /// - /// For the **Add custom words** method, one or more words that are to be added or updated for the custom model and - /// the translation for each specified word. + /// For the [Add custom words](#addwords) method, one or more words that are to be added or updated for the custom + /// model and the translation for each specified word. /// - /// For the **List custom words** method, the words and their translations from the custom model. + /// For the [List custom words](#listwords) method, the words and their translations from the custom model. /// public class Words { /// - /// The **Add custom words** method accepts an array of `Word` objects. Each object provides a word that is to - /// be added or updated for the custom model and the word's translation. + /// The [Add custom words](#addwords) method accepts an array of `Word` objects. Each object provides a word + /// that is to be added or updated for the custom model and the word's translation. /// - /// The **List custom words** method returns an array of `Word` objects. Each object shows a word and its - /// translation from the custom model. The words are listed in alphabetical order, with uppercase letters listed - /// before lowercase letters. The array is empty if the custom model contains no words. + /// The [List custom words](#listwords) method returns an array of `Word` objects. Each object shows a word and + /// its translation from the custom model. The words are listed in alphabetical order, with uppercase letters + /// listed before lowercase letters. The array is empty if the custom model contains no words. /// [JsonProperty("words", NullValueHandling = NullValueHandling.Ignore)] public List _Words { get; set; } From c5062191f026e710a64c6db2cd37b93751527981 Mon Sep 17 00:00:00 2001 From: Nanwarin Chantarutai Date: Wed, 8 Sep 2021 14:23:39 -0700 Subject: [PATCH 09/26] fix(formatting): update comments and formatting changes --- .../Model/WorkspaceSystemSettingsDisambiguation.cs | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/src/IBM.Watson.Assistant.v1/Model/WorkspaceSystemSettingsDisambiguation.cs b/src/IBM.Watson.Assistant.v1/Model/WorkspaceSystemSettingsDisambiguation.cs index de1952933c..53fc265c36 100644 --- a/src/IBM.Watson.Assistant.v1/Model/WorkspaceSystemSettingsDisambiguation.cs +++ b/src/IBM.Watson.Assistant.v1/Model/WorkspaceSystemSettingsDisambiguation.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2018, 2020. +* (C) Copyright IBM Corp. 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -25,8 +25,8 @@ namespace IBM.Watson.Assistant.v1.Model public class WorkspaceSystemSettingsDisambiguation { /// - /// The sensitivity of the disambiguation feature to intent detection conflicts. Set to **high** if you want the - /// disambiguation feature to be triggered more often. This can be useful for testing or demonstration purposes. + /// The sensitivity of the disambiguation feature to intent detection uncertainty. Higher sensitivity means that + /// the disambiguation feature is triggered more often and includes more choices. /// public class SensitivityEnumValue { @@ -42,8 +42,8 @@ public class SensitivityEnumValue } /// - /// The sensitivity of the disambiguation feature to intent detection conflicts. Set to **high** if you want the - /// disambiguation feature to be triggered more often. This can be useful for testing or demonstration purposes. + /// The sensitivity of the disambiguation feature to intent detection uncertainty. Higher sensitivity means that + /// the disambiguation feature is triggered more often and includes more choices. /// Constants for possible values can be found using WorkspaceSystemSettingsDisambiguation.SensitivityEnumValue /// [JsonProperty("sensitivity", NullValueHandling = NullValueHandling.Ignore)] From 35080676f062a578de277c72b492a467c4c98ae5 Mon Sep 17 00:00:00 2001 From: Nanwarin Chantarutai Date: Wed, 8 Sep 2021 14:32:02 -0700 Subject: [PATCH 10/26] feat(assistant-v1): add more enums for Disambiguation settings --- .../WorkspaceSystemSettingsDisambiguation.cs | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/src/IBM.Watson.Assistant.v1/Model/WorkspaceSystemSettingsDisambiguation.cs b/src/IBM.Watson.Assistant.v1/Model/WorkspaceSystemSettingsDisambiguation.cs index 53fc265c36..43456da850 100644 --- a/src/IBM.Watson.Assistant.v1/Model/WorkspaceSystemSettingsDisambiguation.cs +++ b/src/IBM.Watson.Assistant.v1/Model/WorkspaceSystemSettingsDisambiguation.cs @@ -38,6 +38,22 @@ public class SensitivityEnumValue /// Constant HIGH for high /// public const string HIGH = "high"; + /// + /// Constant MEDIUM_HIGH for medium_high + /// + public const string MEDIUM_HIGH = "medium_high"; + /// + /// Constant MEDIUM for medium + /// + public const string MEDIUM = "medium"; + /// + /// Constant MEDIUM_LOW for medium_low + /// + public const string MEDIUM_LOW = "medium_low"; + /// + /// Constant LOW for low + /// + public const string LOW = "low"; } From a72c99b002008c7a3cd905ca2db66edd5fd5ba8a Mon Sep 17 00:00:00 2001 From: Nanwarin Chantarutai Date: Wed, 8 Sep 2021 14:52:52 -0700 Subject: [PATCH 11/26] fix(integration-test): update return type from response.Result.Models in TestListClassificationModel --- ...NaturalLanguageUnderstandingIntegrationTests.cs | 14 +++++--------- 1 file changed, 5 insertions(+), 9 deletions(-) diff --git a/src/IBM.Watson.NaturalLanguageUnderstanding.v1/Test/Integration/NaturalLanguageUnderstandingIntegrationTests.cs b/src/IBM.Watson.NaturalLanguageUnderstanding.v1/Test/Integration/NaturalLanguageUnderstandingIntegrationTests.cs index 1e8a4a4f99..be3d7e55d9 100644 --- a/src/IBM.Watson.NaturalLanguageUnderstanding.v1/Test/Integration/NaturalLanguageUnderstandingIntegrationTests.cs +++ b/src/IBM.Watson.NaturalLanguageUnderstanding.v1/Test/Integration/NaturalLanguageUnderstandingIntegrationTests.cs @@ -784,18 +784,14 @@ public void TestListClassificationModel() Assert.IsNotNull(response.Result.Models); - foreach (ClassificationsModelList classificationsModelList in response.Result.Models) + foreach (ClassificationsModel classificationsModel in response.Result.Models) { - foreach (ClassificationsModel classificationsModel in classificationsModelList.Models) + if (classificationsModel.Name.StartsWith("testString")) { - if (classificationsModel.Name.StartsWith("testString")) - { - service.DeleteClassificationsModel( - modelId: classificationsModel.ModelId - ); - } + service.DeleteClassificationsModel( + modelId: classificationsModel.ModelId + ); } - } } From 2bcedc1f18eefe5c2debd96429d54d3dfbf482f4 Mon Sep 17 00:00:00 2001 From: Nanwarin Chantarutai Date: Wed, 8 Sep 2021 15:03:22 -0700 Subject: [PATCH 12/26] chore(lint-copyrights): ran lint-copyrights --- src/IBM.Watson.Assistant.v1/AssistantService.cs | 2 +- src/IBM.Watson.Assistant.v1/Model/DialogNodeOutputGeneric.cs | 2 +- .../DialogNodeOutputGenericDialogNodeOutputResponseTypeImage.cs | 2 +- src/IBM.Watson.Assistant.v1/Model/RuntimeEntity.cs | 2 +- src/IBM.Watson.Assistant.v1/Model/RuntimeResponseGeneric.cs | 2 +- .../Model/RuntimeResponseGenericRuntimeResponseTypeImage.cs | 2 +- .../Model/WorkspaceSystemSettingsDisambiguation.cs | 2 +- .../Test/Integration/AssistantServiceIntegrationTests.cs | 2 +- src/IBM.Watson.Assistant.v2/Model/MessageContextGlobalSystem.cs | 2 +- src/IBM.Watson.Assistant.v2/Model/MessageInput.cs | 2 +- src/IBM.Watson.Assistant.v2/Model/MessageInputStateless.cs | 2 +- src/IBM.Watson.Assistant.v2/Model/RuntimeEntity.cs | 2 +- src/IBM.Watson.Assistant.v2/Model/RuntimeResponseGeneric.cs | 2 +- .../Model/RuntimeResponseGenericRuntimeResponseTypeImage.cs | 2 +- .../Test/Integration/AssistantServiceIntegrationTests.cs | 2 +- src/IBM.Watson.Assistant.v2/Test/Unit/AssistantV2UnitTests.cs | 2 +- src/IBM.Watson.CompareComply.v1/CompareComplyService.cs | 2 +- src/IBM.Watson.Discovery.v1/DiscoveryService.cs | 2 +- src/IBM.Watson.Discovery.v1/Model/Enrichment.cs | 2 +- src/IBM.Watson.Discovery.v1/Model/EnrichmentOptions.cs | 2 +- src/IBM.Watson.Discovery.v1/Model/Notice.cs | 2 +- src/IBM.Watson.Discovery.v2/DiscoveryService.cs | 2 +- src/IBM.Watson.Discovery.v2/Model/CollectionEnrichment.cs | 2 +- src/IBM.Watson.Discovery.v2/Model/CreateEnrichment.cs | 2 +- src/IBM.Watson.Discovery.v2/Model/DefaultQueryParams.cs | 2 +- .../Model/DefaultQueryParamsSuggestedRefinements.cs | 2 +- src/IBM.Watson.Discovery.v2/Model/Enrichment.cs | 2 +- src/IBM.Watson.Discovery.v2/Model/EnrichmentOptions.cs | 2 +- src/IBM.Watson.Discovery.v2/Model/ProjectDetails.cs | 2 +- src/IBM.Watson.Discovery.v2/Model/ProjectListDetails.cs | 2 +- src/IBM.Watson.Discovery.v2/Model/QueryFilterAggregation.cs | 2 +- .../Model/QueryGroupByAggregationResult.cs | 2 +- src/IBM.Watson.Discovery.v2/Model/QueryHistogramAggregation.cs | 2 +- .../Model/QueryHistogramAggregationResult.cs | 2 +- src/IBM.Watson.Discovery.v2/Model/QueryLargePassages.cs | 2 +- .../Model/QueryLargeSuggestedRefinements.cs | 2 +- src/IBM.Watson.Discovery.v2/Model/QueryNestedAggregation.cs | 2 +- src/IBM.Watson.Discovery.v2/Model/QueryResponse.cs | 2 +- src/IBM.Watson.Discovery.v2/Model/QueryResponsePassage.cs | 2 +- src/IBM.Watson.Discovery.v2/Model/QueryResult.cs | 2 +- src/IBM.Watson.Discovery.v2/Model/QueryResultPassage.cs | 2 +- src/IBM.Watson.Discovery.v2/Model/QueryTermAggregationResult.cs | 2 +- .../Model/QueryTimesliceAggregationResult.cs | 2 +- src/IBM.Watson.Discovery.v2/Model/RetrievalDetails.cs | 2 +- .../Test/Integration/DiscoveryIntegrationTests.cs | 2 +- .../Test/Unit/DiscoveryServiceGeneratedUnitTests.cs | 2 +- .../LanguageTranslatorService.cs | 2 +- .../NaturalLanguageClassifierService.cs | 2 +- .../INaturalLanguageUnderstandingService.cs | 2 +- .../Model/CategoriesOptions.cs | 2 +- .../Model/CategoriesResult.cs | 2 +- .../Model/Features.cs | 2 +- .../NaturalLanguageUnderstandingService.cs | 2 +- .../Integration/NaturalLanguageUnderstandingIntegrationTests.cs | 2 +- src/IBM.Watson.SpeechToText.v1/Model/AcousticModel.cs | 2 +- src/IBM.Watson.SpeechToText.v1/Model/AudioDetails.cs | 2 +- src/IBM.Watson.SpeechToText.v1/Model/AudioListing.cs | 2 +- src/IBM.Watson.SpeechToText.v1/Model/AudioResource.cs | 2 +- src/IBM.Watson.SpeechToText.v1/Model/Corpus.cs | 2 +- src/IBM.Watson.SpeechToText.v1/Model/CustomWord.cs | 2 +- src/IBM.Watson.SpeechToText.v1/Model/LanguageModel.cs | 2 +- src/IBM.Watson.SpeechToText.v1/Model/ProcessingMetrics.cs | 2 +- src/IBM.Watson.SpeechToText.v1/Model/RecognitionJob.cs | 2 +- .../Model/SpeechRecognitionAlternative.cs | 2 +- .../Model/SpeechRecognitionResults.cs | 2 +- src/IBM.Watson.SpeechToText.v1/Model/SupportedFeatures.cs | 2 +- src/IBM.Watson.SpeechToText.v1/Model/Word.cs | 2 +- src/IBM.Watson.SpeechToText.v1/SpeechToTextService.cs | 2 +- src/IBM.Watson.TextToSpeech.v1/Model/CustomModel.cs | 2 +- src/IBM.Watson.TextToSpeech.v1/Model/Voice.cs | 2 +- src/IBM.Watson.TextToSpeech.v1/Model/Words.cs | 2 +- .../Test/Integration/TextToSpeechServiceIntegrationTests.cs | 2 +- src/IBM.Watson.TextToSpeech.v1/TextToSpeechService.cs | 2 +- 73 files changed, 73 insertions(+), 73 deletions(-) diff --git a/src/IBM.Watson.Assistant.v1/AssistantService.cs b/src/IBM.Watson.Assistant.v1/AssistantService.cs index 088fab589a..4edc0b1586 100644 --- a/src/IBM.Watson.Assistant.v1/AssistantService.cs +++ b/src/IBM.Watson.Assistant.v1/AssistantService.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2021. +* (C) Copyright IBM Corp. 2018, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/IBM.Watson.Assistant.v1/Model/DialogNodeOutputGeneric.cs b/src/IBM.Watson.Assistant.v1/Model/DialogNodeOutputGeneric.cs index 290ced8115..39ad9b956d 100644 --- a/src/IBM.Watson.Assistant.v1/Model/DialogNodeOutputGeneric.cs +++ b/src/IBM.Watson.Assistant.v1/Model/DialogNodeOutputGeneric.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2021. +* (C) Copyright IBM Corp. 2018, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/IBM.Watson.Assistant.v1/Model/DialogNodeOutputGenericDialogNodeOutputResponseTypeImage.cs b/src/IBM.Watson.Assistant.v1/Model/DialogNodeOutputGenericDialogNodeOutputResponseTypeImage.cs index aa9aefb558..321ea322f8 100644 --- a/src/IBM.Watson.Assistant.v1/Model/DialogNodeOutputGenericDialogNodeOutputResponseTypeImage.cs +++ b/src/IBM.Watson.Assistant.v1/Model/DialogNodeOutputGenericDialogNodeOutputResponseTypeImage.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2021. +* (C) Copyright IBM Corp. 2020, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/IBM.Watson.Assistant.v1/Model/RuntimeEntity.cs b/src/IBM.Watson.Assistant.v1/Model/RuntimeEntity.cs index 11fda29aa9..6673872c3e 100644 --- a/src/IBM.Watson.Assistant.v1/Model/RuntimeEntity.cs +++ b/src/IBM.Watson.Assistant.v1/Model/RuntimeEntity.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2021. +* (C) Copyright IBM Corp. 2018, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/IBM.Watson.Assistant.v1/Model/RuntimeResponseGeneric.cs b/src/IBM.Watson.Assistant.v1/Model/RuntimeResponseGeneric.cs index 94b8297bc9..2708d9f695 100644 --- a/src/IBM.Watson.Assistant.v1/Model/RuntimeResponseGeneric.cs +++ b/src/IBM.Watson.Assistant.v1/Model/RuntimeResponseGeneric.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2021. +* (C) Copyright IBM Corp. 2019, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/IBM.Watson.Assistant.v1/Model/RuntimeResponseGenericRuntimeResponseTypeImage.cs b/src/IBM.Watson.Assistant.v1/Model/RuntimeResponseGenericRuntimeResponseTypeImage.cs index e2e783e0d3..5e813b7cd3 100644 --- a/src/IBM.Watson.Assistant.v1/Model/RuntimeResponseGenericRuntimeResponseTypeImage.cs +++ b/src/IBM.Watson.Assistant.v1/Model/RuntimeResponseGenericRuntimeResponseTypeImage.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2021. +* (C) Copyright IBM Corp. 2020, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/IBM.Watson.Assistant.v1/Model/WorkspaceSystemSettingsDisambiguation.cs b/src/IBM.Watson.Assistant.v1/Model/WorkspaceSystemSettingsDisambiguation.cs index 43456da850..36e4501468 100644 --- a/src/IBM.Watson.Assistant.v1/Model/WorkspaceSystemSettingsDisambiguation.cs +++ b/src/IBM.Watson.Assistant.v1/Model/WorkspaceSystemSettingsDisambiguation.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2021. +* (C) Copyright IBM Corp. 2018, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/IBM.Watson.Assistant.v1/Test/Integration/AssistantServiceIntegrationTests.cs b/src/IBM.Watson.Assistant.v1/Test/Integration/AssistantServiceIntegrationTests.cs index f168ad3227..30d7d6693d 100644 --- a/src/IBM.Watson.Assistant.v1/Test/Integration/AssistantServiceIntegrationTests.cs +++ b/src/IBM.Watson.Assistant.v1/Test/Integration/AssistantServiceIntegrationTests.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2018, 2020. +* (C) Copyright IBM Corp. 2018, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/IBM.Watson.Assistant.v2/Model/MessageContextGlobalSystem.cs b/src/IBM.Watson.Assistant.v2/Model/MessageContextGlobalSystem.cs index 94cd7cf46f..6a716c3ad7 100644 --- a/src/IBM.Watson.Assistant.v2/Model/MessageContextGlobalSystem.cs +++ b/src/IBM.Watson.Assistant.v2/Model/MessageContextGlobalSystem.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2021. +* (C) Copyright IBM Corp. 2018, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/IBM.Watson.Assistant.v2/Model/MessageInput.cs b/src/IBM.Watson.Assistant.v2/Model/MessageInput.cs index 4acd70a4c9..739bcc1beb 100644 --- a/src/IBM.Watson.Assistant.v2/Model/MessageInput.cs +++ b/src/IBM.Watson.Assistant.v2/Model/MessageInput.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2021. +* (C) Copyright IBM Corp. 2018, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/IBM.Watson.Assistant.v2/Model/MessageInputStateless.cs b/src/IBM.Watson.Assistant.v2/Model/MessageInputStateless.cs index fdd0d1ac3a..69d07db384 100644 --- a/src/IBM.Watson.Assistant.v2/Model/MessageInputStateless.cs +++ b/src/IBM.Watson.Assistant.v2/Model/MessageInputStateless.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2021. +* (C) Copyright IBM Corp. 2020, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/IBM.Watson.Assistant.v2/Model/RuntimeEntity.cs b/src/IBM.Watson.Assistant.v2/Model/RuntimeEntity.cs index 7eafe8bc43..d8158b778e 100644 --- a/src/IBM.Watson.Assistant.v2/Model/RuntimeEntity.cs +++ b/src/IBM.Watson.Assistant.v2/Model/RuntimeEntity.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2021. +* (C) Copyright IBM Corp. 2018, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/IBM.Watson.Assistant.v2/Model/RuntimeResponseGeneric.cs b/src/IBM.Watson.Assistant.v2/Model/RuntimeResponseGeneric.cs index b09dda5b1b..38fdff5fec 100644 --- a/src/IBM.Watson.Assistant.v2/Model/RuntimeResponseGeneric.cs +++ b/src/IBM.Watson.Assistant.v2/Model/RuntimeResponseGeneric.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2021. +* (C) Copyright IBM Corp. 2018, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/IBM.Watson.Assistant.v2/Model/RuntimeResponseGenericRuntimeResponseTypeImage.cs b/src/IBM.Watson.Assistant.v2/Model/RuntimeResponseGenericRuntimeResponseTypeImage.cs index 865740d002..a19031f8ac 100644 --- a/src/IBM.Watson.Assistant.v2/Model/RuntimeResponseGenericRuntimeResponseTypeImage.cs +++ b/src/IBM.Watson.Assistant.v2/Model/RuntimeResponseGenericRuntimeResponseTypeImage.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2021. +* (C) Copyright IBM Corp. 2020, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/IBM.Watson.Assistant.v2/Test/Integration/AssistantServiceIntegrationTests.cs b/src/IBM.Watson.Assistant.v2/Test/Integration/AssistantServiceIntegrationTests.cs index 4e8d80ce45..5d61dbc976 100644 --- a/src/IBM.Watson.Assistant.v2/Test/Integration/AssistantServiceIntegrationTests.cs +++ b/src/IBM.Watson.Assistant.v2/Test/Integration/AssistantServiceIntegrationTests.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2017, 2020. +* (C) Copyright IBM Corp. 2017, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/IBM.Watson.Assistant.v2/Test/Unit/AssistantV2UnitTests.cs b/src/IBM.Watson.Assistant.v2/Test/Unit/AssistantV2UnitTests.cs index 1f777f7c26..f17ad15d3d 100644 --- a/src/IBM.Watson.Assistant.v2/Test/Unit/AssistantV2UnitTests.cs +++ b/src/IBM.Watson.Assistant.v2/Test/Unit/AssistantV2UnitTests.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2017, 2020. +* (C) Copyright IBM Corp. 2017, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/IBM.Watson.CompareComply.v1/CompareComplyService.cs b/src/IBM.Watson.CompareComply.v1/CompareComplyService.cs index 8b34c03915..634c9aaa25 100644 --- a/src/IBM.Watson.CompareComply.v1/CompareComplyService.cs +++ b/src/IBM.Watson.CompareComply.v1/CompareComplyService.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2018, 2020. +* (C) Copyright IBM Corp. 2018, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/IBM.Watson.Discovery.v1/DiscoveryService.cs b/src/IBM.Watson.Discovery.v1/DiscoveryService.cs index 96bfce92b0..f8ddbdd895 100644 --- a/src/IBM.Watson.Discovery.v1/DiscoveryService.cs +++ b/src/IBM.Watson.Discovery.v1/DiscoveryService.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2021. +* (C) Copyright IBM Corp. 2017, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/IBM.Watson.Discovery.v1/Model/Enrichment.cs b/src/IBM.Watson.Discovery.v1/Model/Enrichment.cs index ca0c800511..8b1bc0fb56 100644 --- a/src/IBM.Watson.Discovery.v1/Model/Enrichment.cs +++ b/src/IBM.Watson.Discovery.v1/Model/Enrichment.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2021. +* (C) Copyright IBM Corp. 2017, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/IBM.Watson.Discovery.v1/Model/EnrichmentOptions.cs b/src/IBM.Watson.Discovery.v1/Model/EnrichmentOptions.cs index 8ceea3e293..0430da67e5 100644 --- a/src/IBM.Watson.Discovery.v1/Model/EnrichmentOptions.cs +++ b/src/IBM.Watson.Discovery.v1/Model/EnrichmentOptions.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2021. +* (C) Copyright IBM Corp. 2017, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/IBM.Watson.Discovery.v1/Model/Notice.cs b/src/IBM.Watson.Discovery.v1/Model/Notice.cs index d94d9e71f9..fa9378c69a 100644 --- a/src/IBM.Watson.Discovery.v1/Model/Notice.cs +++ b/src/IBM.Watson.Discovery.v1/Model/Notice.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2021. +* (C) Copyright IBM Corp. 2017, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/IBM.Watson.Discovery.v2/DiscoveryService.cs b/src/IBM.Watson.Discovery.v2/DiscoveryService.cs index 36febfe53d..f5300ec6aa 100644 --- a/src/IBM.Watson.Discovery.v2/DiscoveryService.cs +++ b/src/IBM.Watson.Discovery.v2/DiscoveryService.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2021. +* (C) Copyright IBM Corp. 2019, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/IBM.Watson.Discovery.v2/Model/CollectionEnrichment.cs b/src/IBM.Watson.Discovery.v2/Model/CollectionEnrichment.cs index 5c8e33fea3..df3f2a3cdf 100644 --- a/src/IBM.Watson.Discovery.v2/Model/CollectionEnrichment.cs +++ b/src/IBM.Watson.Discovery.v2/Model/CollectionEnrichment.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2021. +* (C) Copyright IBM Corp. 2020, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/IBM.Watson.Discovery.v2/Model/CreateEnrichment.cs b/src/IBM.Watson.Discovery.v2/Model/CreateEnrichment.cs index 49c138b9c2..70f9391060 100644 --- a/src/IBM.Watson.Discovery.v2/Model/CreateEnrichment.cs +++ b/src/IBM.Watson.Discovery.v2/Model/CreateEnrichment.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2021. +* (C) Copyright IBM Corp. 2020, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/IBM.Watson.Discovery.v2/Model/DefaultQueryParams.cs b/src/IBM.Watson.Discovery.v2/Model/DefaultQueryParams.cs index e54b6534b1..a3a88df688 100644 --- a/src/IBM.Watson.Discovery.v2/Model/DefaultQueryParams.cs +++ b/src/IBM.Watson.Discovery.v2/Model/DefaultQueryParams.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2021. +* (C) Copyright IBM Corp. 2020, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/IBM.Watson.Discovery.v2/Model/DefaultQueryParamsSuggestedRefinements.cs b/src/IBM.Watson.Discovery.v2/Model/DefaultQueryParamsSuggestedRefinements.cs index 3f30393a72..83af7d03a2 100644 --- a/src/IBM.Watson.Discovery.v2/Model/DefaultQueryParamsSuggestedRefinements.cs +++ b/src/IBM.Watson.Discovery.v2/Model/DefaultQueryParamsSuggestedRefinements.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2021. +* (C) Copyright IBM Corp. 2020, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/IBM.Watson.Discovery.v2/Model/Enrichment.cs b/src/IBM.Watson.Discovery.v2/Model/Enrichment.cs index 4973928586..a7c7c510bc 100644 --- a/src/IBM.Watson.Discovery.v2/Model/Enrichment.cs +++ b/src/IBM.Watson.Discovery.v2/Model/Enrichment.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2021. +* (C) Copyright IBM Corp. 2020, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/IBM.Watson.Discovery.v2/Model/EnrichmentOptions.cs b/src/IBM.Watson.Discovery.v2/Model/EnrichmentOptions.cs index a3a38f5a4c..c8d14a1854 100644 --- a/src/IBM.Watson.Discovery.v2/Model/EnrichmentOptions.cs +++ b/src/IBM.Watson.Discovery.v2/Model/EnrichmentOptions.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2021. +* (C) Copyright IBM Corp. 2020, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/IBM.Watson.Discovery.v2/Model/ProjectDetails.cs b/src/IBM.Watson.Discovery.v2/Model/ProjectDetails.cs index a167a9030f..2def8b1d99 100644 --- a/src/IBM.Watson.Discovery.v2/Model/ProjectDetails.cs +++ b/src/IBM.Watson.Discovery.v2/Model/ProjectDetails.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2021. +* (C) Copyright IBM Corp. 2020, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/IBM.Watson.Discovery.v2/Model/ProjectListDetails.cs b/src/IBM.Watson.Discovery.v2/Model/ProjectListDetails.cs index 582c3d8380..c904af9eac 100644 --- a/src/IBM.Watson.Discovery.v2/Model/ProjectListDetails.cs +++ b/src/IBM.Watson.Discovery.v2/Model/ProjectListDetails.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2021. +* (C) Copyright IBM Corp. 2020, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/IBM.Watson.Discovery.v2/Model/QueryFilterAggregation.cs b/src/IBM.Watson.Discovery.v2/Model/QueryFilterAggregation.cs index e2640c5ef2..018ad5daf7 100644 --- a/src/IBM.Watson.Discovery.v2/Model/QueryFilterAggregation.cs +++ b/src/IBM.Watson.Discovery.v2/Model/QueryFilterAggregation.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2021. +* (C) Copyright IBM Corp. 2019, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/IBM.Watson.Discovery.v2/Model/QueryGroupByAggregationResult.cs b/src/IBM.Watson.Discovery.v2/Model/QueryGroupByAggregationResult.cs index 2626ca2c96..6e7eb2a3f6 100644 --- a/src/IBM.Watson.Discovery.v2/Model/QueryGroupByAggregationResult.cs +++ b/src/IBM.Watson.Discovery.v2/Model/QueryGroupByAggregationResult.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2021. +* (C) Copyright IBM Corp. 2020, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/IBM.Watson.Discovery.v2/Model/QueryHistogramAggregation.cs b/src/IBM.Watson.Discovery.v2/Model/QueryHistogramAggregation.cs index 6178c0e55d..fa9277a707 100644 --- a/src/IBM.Watson.Discovery.v2/Model/QueryHistogramAggregation.cs +++ b/src/IBM.Watson.Discovery.v2/Model/QueryHistogramAggregation.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2021. +* (C) Copyright IBM Corp. 2019, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/IBM.Watson.Discovery.v2/Model/QueryHistogramAggregationResult.cs b/src/IBM.Watson.Discovery.v2/Model/QueryHistogramAggregationResult.cs index 711a15c86c..bb85b88a10 100644 --- a/src/IBM.Watson.Discovery.v2/Model/QueryHistogramAggregationResult.cs +++ b/src/IBM.Watson.Discovery.v2/Model/QueryHistogramAggregationResult.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2021. +* (C) Copyright IBM Corp. 2019, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/IBM.Watson.Discovery.v2/Model/QueryLargePassages.cs b/src/IBM.Watson.Discovery.v2/Model/QueryLargePassages.cs index ab56508bc3..233d0fcf49 100644 --- a/src/IBM.Watson.Discovery.v2/Model/QueryLargePassages.cs +++ b/src/IBM.Watson.Discovery.v2/Model/QueryLargePassages.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2021. +* (C) Copyright IBM Corp. 2019, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/IBM.Watson.Discovery.v2/Model/QueryLargeSuggestedRefinements.cs b/src/IBM.Watson.Discovery.v2/Model/QueryLargeSuggestedRefinements.cs index 37e9edc032..b172fa7119 100644 --- a/src/IBM.Watson.Discovery.v2/Model/QueryLargeSuggestedRefinements.cs +++ b/src/IBM.Watson.Discovery.v2/Model/QueryLargeSuggestedRefinements.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2021. +* (C) Copyright IBM Corp. 2019, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/IBM.Watson.Discovery.v2/Model/QueryNestedAggregation.cs b/src/IBM.Watson.Discovery.v2/Model/QueryNestedAggregation.cs index b8b453253b..83115a3016 100644 --- a/src/IBM.Watson.Discovery.v2/Model/QueryNestedAggregation.cs +++ b/src/IBM.Watson.Discovery.v2/Model/QueryNestedAggregation.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2021. +* (C) Copyright IBM Corp. 2019, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/IBM.Watson.Discovery.v2/Model/QueryResponse.cs b/src/IBM.Watson.Discovery.v2/Model/QueryResponse.cs index d547cd4a54..6d898b7b5d 100644 --- a/src/IBM.Watson.Discovery.v2/Model/QueryResponse.cs +++ b/src/IBM.Watson.Discovery.v2/Model/QueryResponse.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2021. +* (C) Copyright IBM Corp. 2019, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/IBM.Watson.Discovery.v2/Model/QueryResponsePassage.cs b/src/IBM.Watson.Discovery.v2/Model/QueryResponsePassage.cs index ebc8479713..4a7954ca42 100644 --- a/src/IBM.Watson.Discovery.v2/Model/QueryResponsePassage.cs +++ b/src/IBM.Watson.Discovery.v2/Model/QueryResponsePassage.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2021. +* (C) Copyright IBM Corp. 2020, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/IBM.Watson.Discovery.v2/Model/QueryResult.cs b/src/IBM.Watson.Discovery.v2/Model/QueryResult.cs index 49af44da29..76937b8f10 100644 --- a/src/IBM.Watson.Discovery.v2/Model/QueryResult.cs +++ b/src/IBM.Watson.Discovery.v2/Model/QueryResult.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2021. +* (C) Copyright IBM Corp. 2019, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/IBM.Watson.Discovery.v2/Model/QueryResultPassage.cs b/src/IBM.Watson.Discovery.v2/Model/QueryResultPassage.cs index 8013b64bb1..3e93292bf1 100644 --- a/src/IBM.Watson.Discovery.v2/Model/QueryResultPassage.cs +++ b/src/IBM.Watson.Discovery.v2/Model/QueryResultPassage.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2021. +* (C) Copyright IBM Corp. 2019, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/IBM.Watson.Discovery.v2/Model/QueryTermAggregationResult.cs b/src/IBM.Watson.Discovery.v2/Model/QueryTermAggregationResult.cs index ab4abf2c6c..2bae6dbf70 100644 --- a/src/IBM.Watson.Discovery.v2/Model/QueryTermAggregationResult.cs +++ b/src/IBM.Watson.Discovery.v2/Model/QueryTermAggregationResult.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2021. +* (C) Copyright IBM Corp. 2019, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/IBM.Watson.Discovery.v2/Model/QueryTimesliceAggregationResult.cs b/src/IBM.Watson.Discovery.v2/Model/QueryTimesliceAggregationResult.cs index 4f38555562..48791cb91d 100644 --- a/src/IBM.Watson.Discovery.v2/Model/QueryTimesliceAggregationResult.cs +++ b/src/IBM.Watson.Discovery.v2/Model/QueryTimesliceAggregationResult.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2021. +* (C) Copyright IBM Corp. 2019, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/IBM.Watson.Discovery.v2/Model/RetrievalDetails.cs b/src/IBM.Watson.Discovery.v2/Model/RetrievalDetails.cs index 4110e68789..8f43136d1e 100644 --- a/src/IBM.Watson.Discovery.v2/Model/RetrievalDetails.cs +++ b/src/IBM.Watson.Discovery.v2/Model/RetrievalDetails.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2021. +* (C) Copyright IBM Corp. 2019, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/IBM.Watson.Discovery.v2/Test/Integration/DiscoveryIntegrationTests.cs b/src/IBM.Watson.Discovery.v2/Test/Integration/DiscoveryIntegrationTests.cs index 6709c880df..052738389d 100644 --- a/src/IBM.Watson.Discovery.v2/Test/Integration/DiscoveryIntegrationTests.cs +++ b/src/IBM.Watson.Discovery.v2/Test/Integration/DiscoveryIntegrationTests.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2019, 2020. +* (C) Copyright IBM Corp. 2019, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/IBM.Watson.Discovery.v2/Test/Unit/DiscoveryServiceGeneratedUnitTests.cs b/src/IBM.Watson.Discovery.v2/Test/Unit/DiscoveryServiceGeneratedUnitTests.cs index a2dd761f3e..4681a7f2d5 100644 --- a/src/IBM.Watson.Discovery.v2/Test/Unit/DiscoveryServiceGeneratedUnitTests.cs +++ b/src/IBM.Watson.Discovery.v2/Test/Unit/DiscoveryServiceGeneratedUnitTests.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2018, 2020. +* (C) Copyright IBM Corp. 2018, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/IBM.Watson.LanguageTranslator.v3/LanguageTranslatorService.cs b/src/IBM.Watson.LanguageTranslator.v3/LanguageTranslatorService.cs index 7e87915844..d78b63f1a7 100644 --- a/src/IBM.Watson.LanguageTranslator.v3/LanguageTranslatorService.cs +++ b/src/IBM.Watson.LanguageTranslator.v3/LanguageTranslatorService.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2021. +* (C) Copyright IBM Corp. 2018, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/IBM.Watson.NaturalLanguageClassifier.v1/NaturalLanguageClassifierService.cs b/src/IBM.Watson.NaturalLanguageClassifier.v1/NaturalLanguageClassifierService.cs index 1364ebe826..56efc59633 100644 --- a/src/IBM.Watson.NaturalLanguageClassifier.v1/NaturalLanguageClassifierService.cs +++ b/src/IBM.Watson.NaturalLanguageClassifier.v1/NaturalLanguageClassifierService.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2018, 2020. +* (C) Copyright IBM Corp. 2018, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/IBM.Watson.NaturalLanguageUnderstanding.v1/INaturalLanguageUnderstandingService.cs b/src/IBM.Watson.NaturalLanguageUnderstanding.v1/INaturalLanguageUnderstandingService.cs index 539784ab69..5b8f048ae4 100644 --- a/src/IBM.Watson.NaturalLanguageUnderstanding.v1/INaturalLanguageUnderstandingService.cs +++ b/src/IBM.Watson.NaturalLanguageUnderstanding.v1/INaturalLanguageUnderstandingService.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2021. +* (C) Copyright IBM Corp. 2019, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/IBM.Watson.NaturalLanguageUnderstanding.v1/Model/CategoriesOptions.cs b/src/IBM.Watson.NaturalLanguageUnderstanding.v1/Model/CategoriesOptions.cs index a6c0f2ff9f..7c5b9cf271 100644 --- a/src/IBM.Watson.NaturalLanguageUnderstanding.v1/Model/CategoriesOptions.cs +++ b/src/IBM.Watson.NaturalLanguageUnderstanding.v1/Model/CategoriesOptions.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2021. +* (C) Copyright IBM Corp. 2019, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/IBM.Watson.NaturalLanguageUnderstanding.v1/Model/CategoriesResult.cs b/src/IBM.Watson.NaturalLanguageUnderstanding.v1/Model/CategoriesResult.cs index 718fefdd12..d07556d79a 100644 --- a/src/IBM.Watson.NaturalLanguageUnderstanding.v1/Model/CategoriesResult.cs +++ b/src/IBM.Watson.NaturalLanguageUnderstanding.v1/Model/CategoriesResult.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2021. +* (C) Copyright IBM Corp. 2017, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/IBM.Watson.NaturalLanguageUnderstanding.v1/Model/Features.cs b/src/IBM.Watson.NaturalLanguageUnderstanding.v1/Model/Features.cs index 039cd58f41..03444a4c3a 100644 --- a/src/IBM.Watson.NaturalLanguageUnderstanding.v1/Model/Features.cs +++ b/src/IBM.Watson.NaturalLanguageUnderstanding.v1/Model/Features.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2021. +* (C) Copyright IBM Corp. 2017, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/IBM.Watson.NaturalLanguageUnderstanding.v1/NaturalLanguageUnderstandingService.cs b/src/IBM.Watson.NaturalLanguageUnderstanding.v1/NaturalLanguageUnderstandingService.cs index b9e107cae5..70b4ee0f7e 100644 --- a/src/IBM.Watson.NaturalLanguageUnderstanding.v1/NaturalLanguageUnderstandingService.cs +++ b/src/IBM.Watson.NaturalLanguageUnderstanding.v1/NaturalLanguageUnderstandingService.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2021. +* (C) Copyright IBM Corp. 2017, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/IBM.Watson.NaturalLanguageUnderstanding.v1/Test/Integration/NaturalLanguageUnderstandingIntegrationTests.cs b/src/IBM.Watson.NaturalLanguageUnderstanding.v1/Test/Integration/NaturalLanguageUnderstandingIntegrationTests.cs index be3d7e55d9..01142dca85 100644 --- a/src/IBM.Watson.NaturalLanguageUnderstanding.v1/Test/Integration/NaturalLanguageUnderstandingIntegrationTests.cs +++ b/src/IBM.Watson.NaturalLanguageUnderstanding.v1/Test/Integration/NaturalLanguageUnderstandingIntegrationTests.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2017, 2020. +* (C) Copyright IBM Corp. 2017, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/IBM.Watson.SpeechToText.v1/Model/AcousticModel.cs b/src/IBM.Watson.SpeechToText.v1/Model/AcousticModel.cs index 49480ebc04..7fc6b1c1d6 100644 --- a/src/IBM.Watson.SpeechToText.v1/Model/AcousticModel.cs +++ b/src/IBM.Watson.SpeechToText.v1/Model/AcousticModel.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2021. +* (C) Copyright IBM Corp. 2018, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/IBM.Watson.SpeechToText.v1/Model/AudioDetails.cs b/src/IBM.Watson.SpeechToText.v1/Model/AudioDetails.cs index 7206371ccc..778956e0c7 100644 --- a/src/IBM.Watson.SpeechToText.v1/Model/AudioDetails.cs +++ b/src/IBM.Watson.SpeechToText.v1/Model/AudioDetails.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2021. +* (C) Copyright IBM Corp. 2018, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/IBM.Watson.SpeechToText.v1/Model/AudioListing.cs b/src/IBM.Watson.SpeechToText.v1/Model/AudioListing.cs index 5ac1dd323c..6ab2091730 100644 --- a/src/IBM.Watson.SpeechToText.v1/Model/AudioListing.cs +++ b/src/IBM.Watson.SpeechToText.v1/Model/AudioListing.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2021. +* (C) Copyright IBM Corp. 2018, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/IBM.Watson.SpeechToText.v1/Model/AudioResource.cs b/src/IBM.Watson.SpeechToText.v1/Model/AudioResource.cs index 078b54e8cf..73e37372da 100644 --- a/src/IBM.Watson.SpeechToText.v1/Model/AudioResource.cs +++ b/src/IBM.Watson.SpeechToText.v1/Model/AudioResource.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2021. +* (C) Copyright IBM Corp. 2018, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/IBM.Watson.SpeechToText.v1/Model/Corpus.cs b/src/IBM.Watson.SpeechToText.v1/Model/Corpus.cs index 0111e5be88..53f1e2100a 100644 --- a/src/IBM.Watson.SpeechToText.v1/Model/Corpus.cs +++ b/src/IBM.Watson.SpeechToText.v1/Model/Corpus.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2021. +* (C) Copyright IBM Corp. 2017, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/IBM.Watson.SpeechToText.v1/Model/CustomWord.cs b/src/IBM.Watson.SpeechToText.v1/Model/CustomWord.cs index 383c01f396..81e856e721 100644 --- a/src/IBM.Watson.SpeechToText.v1/Model/CustomWord.cs +++ b/src/IBM.Watson.SpeechToText.v1/Model/CustomWord.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2021. +* (C) Copyright IBM Corp. 2018, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/IBM.Watson.SpeechToText.v1/Model/LanguageModel.cs b/src/IBM.Watson.SpeechToText.v1/Model/LanguageModel.cs index f9888cba3b..45c8e7507c 100644 --- a/src/IBM.Watson.SpeechToText.v1/Model/LanguageModel.cs +++ b/src/IBM.Watson.SpeechToText.v1/Model/LanguageModel.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2021. +* (C) Copyright IBM Corp. 2018, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/IBM.Watson.SpeechToText.v1/Model/ProcessingMetrics.cs b/src/IBM.Watson.SpeechToText.v1/Model/ProcessingMetrics.cs index da857d2f61..5f6e5b4dee 100644 --- a/src/IBM.Watson.SpeechToText.v1/Model/ProcessingMetrics.cs +++ b/src/IBM.Watson.SpeechToText.v1/Model/ProcessingMetrics.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2021. +* (C) Copyright IBM Corp. 2019, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/IBM.Watson.SpeechToText.v1/Model/RecognitionJob.cs b/src/IBM.Watson.SpeechToText.v1/Model/RecognitionJob.cs index e2e2c362de..d107a2d818 100644 --- a/src/IBM.Watson.SpeechToText.v1/Model/RecognitionJob.cs +++ b/src/IBM.Watson.SpeechToText.v1/Model/RecognitionJob.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2021. +* (C) Copyright IBM Corp. 2018, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/IBM.Watson.SpeechToText.v1/Model/SpeechRecognitionAlternative.cs b/src/IBM.Watson.SpeechToText.v1/Model/SpeechRecognitionAlternative.cs index 1e6f2bf971..18cab66d9e 100644 --- a/src/IBM.Watson.SpeechToText.v1/Model/SpeechRecognitionAlternative.cs +++ b/src/IBM.Watson.SpeechToText.v1/Model/SpeechRecognitionAlternative.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2021. +* (C) Copyright IBM Corp. 2017, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/IBM.Watson.SpeechToText.v1/Model/SpeechRecognitionResults.cs b/src/IBM.Watson.SpeechToText.v1/Model/SpeechRecognitionResults.cs index ca4494164e..fc22f57360 100644 --- a/src/IBM.Watson.SpeechToText.v1/Model/SpeechRecognitionResults.cs +++ b/src/IBM.Watson.SpeechToText.v1/Model/SpeechRecognitionResults.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2021. +* (C) Copyright IBM Corp. 2018, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/IBM.Watson.SpeechToText.v1/Model/SupportedFeatures.cs b/src/IBM.Watson.SpeechToText.v1/Model/SupportedFeatures.cs index dc87a31b67..21b8618a70 100644 --- a/src/IBM.Watson.SpeechToText.v1/Model/SupportedFeatures.cs +++ b/src/IBM.Watson.SpeechToText.v1/Model/SupportedFeatures.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2021. +* (C) Copyright IBM Corp. 2017, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/IBM.Watson.SpeechToText.v1/Model/Word.cs b/src/IBM.Watson.SpeechToText.v1/Model/Word.cs index efc7d83561..8f3a947f00 100644 --- a/src/IBM.Watson.SpeechToText.v1/Model/Word.cs +++ b/src/IBM.Watson.SpeechToText.v1/Model/Word.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2021. +* (C) Copyright IBM Corp. 2017, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/IBM.Watson.SpeechToText.v1/SpeechToTextService.cs b/src/IBM.Watson.SpeechToText.v1/SpeechToTextService.cs index a5d191a33e..8da553576f 100644 --- a/src/IBM.Watson.SpeechToText.v1/SpeechToTextService.cs +++ b/src/IBM.Watson.SpeechToText.v1/SpeechToTextService.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2021. +* (C) Copyright IBM Corp. 2016, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/IBM.Watson.TextToSpeech.v1/Model/CustomModel.cs b/src/IBM.Watson.TextToSpeech.v1/Model/CustomModel.cs index 4b019e1a72..661879704c 100644 --- a/src/IBM.Watson.TextToSpeech.v1/Model/CustomModel.cs +++ b/src/IBM.Watson.TextToSpeech.v1/Model/CustomModel.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2021. +* (C) Copyright IBM Corp. 2020, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/IBM.Watson.TextToSpeech.v1/Model/Voice.cs b/src/IBM.Watson.TextToSpeech.v1/Model/Voice.cs index de870b009f..4d27190bda 100644 --- a/src/IBM.Watson.TextToSpeech.v1/Model/Voice.cs +++ b/src/IBM.Watson.TextToSpeech.v1/Model/Voice.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2021. +* (C) Copyright IBM Corp. 2018, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/IBM.Watson.TextToSpeech.v1/Model/Words.cs b/src/IBM.Watson.TextToSpeech.v1/Model/Words.cs index 10ac2535ac..bc0142768a 100644 --- a/src/IBM.Watson.TextToSpeech.v1/Model/Words.cs +++ b/src/IBM.Watson.TextToSpeech.v1/Model/Words.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2021. +* (C) Copyright IBM Corp. 2018, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/IBM.Watson.TextToSpeech.v1/Test/Integration/TextToSpeechServiceIntegrationTests.cs b/src/IBM.Watson.TextToSpeech.v1/Test/Integration/TextToSpeechServiceIntegrationTests.cs index 8d0e5bd53e..6a21bb6d61 100644 --- a/src/IBM.Watson.TextToSpeech.v1/Test/Integration/TextToSpeechServiceIntegrationTests.cs +++ b/src/IBM.Watson.TextToSpeech.v1/Test/Integration/TextToSpeechServiceIntegrationTests.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2018, 2020. +* (C) Copyright IBM Corp. 2018, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/IBM.Watson.TextToSpeech.v1/TextToSpeechService.cs b/src/IBM.Watson.TextToSpeech.v1/TextToSpeechService.cs index 9b988f9f5c..bd0c22ead8 100644 --- a/src/IBM.Watson.TextToSpeech.v1/TextToSpeechService.cs +++ b/src/IBM.Watson.TextToSpeech.v1/TextToSpeechService.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2021. +* (C) Copyright IBM Corp. 2016, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. From b5459426755cfb3d26d0c8fbc1f6602a3a037a9a Mon Sep 17 00:00:00 2001 From: Nanwarin Chantarutai Date: Wed, 8 Sep 2021 17:23:47 -0700 Subject: [PATCH 13/26] fix(nlu): manual change: convert MetadataOptions back to Object on Model/Features --- .../Model/Features.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/IBM.Watson.NaturalLanguageUnderstanding.v1/Model/Features.cs b/src/IBM.Watson.NaturalLanguageUnderstanding.v1/Model/Features.cs index 03444a4c3a..fe1ff461e7 100644 --- a/src/IBM.Watson.NaturalLanguageUnderstanding.v1/Model/Features.cs +++ b/src/IBM.Watson.NaturalLanguageUnderstanding.v1/Model/Features.cs @@ -71,7 +71,7 @@ public class Features /// and publication date. Supports URL and HTML input types only. /// [JsonProperty("metadata", NullValueHandling = NullValueHandling.Ignore)] - public MetadataOptions Metadata { get; set; } + public object Metadata { get; set; } /// /// Recognizes when two entities are related and identifies the type of relation. For example, an `awardedTo` /// relation might connect the entities "Nobel Prize" and "Albert Einstein". For more information, see [Relation From b047d7f67010d0b8659429675a6449878e97e49b Mon Sep 17 00:00:00 2001 From: Nanwarin Chantarutai Date: Thu, 9 Sep 2021 12:57:59 -0700 Subject: [PATCH 14/26] fix(discovery-v2): manual revert fileContent method under AnalyzeDocument to the original code --- src/IBM.Watson.Discovery.v2/DiscoveryService.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/IBM.Watson.Discovery.v2/DiscoveryService.cs b/src/IBM.Watson.Discovery.v2/DiscoveryService.cs index f5300ec6aa..b42823e94b 100644 --- a/src/IBM.Watson.Discovery.v2/DiscoveryService.cs +++ b/src/IBM.Watson.Discovery.v2/DiscoveryService.cs @@ -1828,7 +1828,7 @@ public DetailedResponse AnalyzeDocument(string projectId, stri if (file != null) { - var fileContent = new ByteArrayContent(file.ToArray()); + var fileContent = new StreamContent(file); System.Net.Http.Headers.MediaTypeHeaderValue contentType; System.Net.Http.Headers.MediaTypeHeaderValue.TryParse(fileContentType, out contentType); fileContent.Headers.ContentType = contentType; From 12ef23393ca0a90f417f3d96c327577c95483027 Mon Sep 17 00:00:00 2001 From: Nanwarin Chantarutai Date: Thu, 9 Sep 2021 14:29:40 -0700 Subject: [PATCH 15/26] chore(common): update common package --- src/IBM.Watson.Common/Common.cs | 2 +- src/IBM.Watson.Common/IBM.Watson.Common.csproj | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/IBM.Watson.Common/Common.cs b/src/IBM.Watson.Common/Common.cs index 055de79728..67f952437c 100644 --- a/src/IBM.Watson.Common/Common.cs +++ b/src/IBM.Watson.Common/Common.cs @@ -27,7 +27,7 @@ public partial class Common /// /// The SDK version. /// - public const string Version = "watson-apis-dotnet-standard-sdk-5.2.1"; + public const string Version = "watson-apis-dotnet-standard-sdk-5.3.0"; private static string os; private static string osVersion; private static string frameworkDescription; diff --git a/src/IBM.Watson.Common/IBM.Watson.Common.csproj b/src/IBM.Watson.Common/IBM.Watson.Common.csproj index defd8aff22..6bc6bb5604 100644 --- a/src/IBM.Watson.Common/IBM.Watson.Common.csproj +++ b/src/IBM.Watson.Common/IBM.Watson.Common.csproj @@ -10,7 +10,7 @@ watson;cognitive;speech;vision;machine-learning;ml;ai;artificial-intelligence;.NET;.NET-Standard https://watson-developer-cloud.github.io/dotnet-standard-sdk/img/Watson_Avatar_Pos_RGB.png https://github.com/watson-developer-cloud/dotnet-standard-sdk - 5.2.1 + 5.3.0 From c39d890d819a9d08bb511249ae00541d5621d52d Mon Sep 17 00:00:00 2001 From: Nanwarin Chantarutai Date: Sun, 12 Sep 2021 23:56:18 -0700 Subject: [PATCH 16/26] fix(discovery-v1): update status from string to StatusDetails --- .../DiscoveryService.cs | 28 ++++++------- .../IDiscoveryService.cs | 6 +-- .../Model/Credentials.cs | 33 +++------------- .../Model/StatusDetails.cs | 39 +++++++++++++++++++ 4 files changed, 60 insertions(+), 46 deletions(-) create mode 100644 src/IBM.Watson.Discovery.v1/Model/StatusDetails.cs diff --git a/src/IBM.Watson.Discovery.v1/DiscoveryService.cs b/src/IBM.Watson.Discovery.v1/DiscoveryService.cs index f8ddbdd895..8e801ba78d 100644 --- a/src/IBM.Watson.Discovery.v1/DiscoveryService.cs +++ b/src/IBM.Watson.Discovery.v1/DiscoveryService.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2017, 2021. +* (C) Copyright IBM Corp. 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -16,7 +16,7 @@ */ /** -* IBM OpenAPI SDK Code Generator Version: 3.38.0-07189efd-20210827-205025 +* IBM OpenAPI SDK Code Generator Version: 99-SNAPSHOT-07189efd-20210907-091205 */ using System.Collections.Generic; @@ -4566,12 +4566,10 @@ public DetailedResponse ListCredentials(string environmentId) /// Object containing details of the stored credentials. /// /// Obtain credentials for your source from the administrator of the source. (optional) - /// The current status of this set of credentials. `connected` indicates that the - /// credentials are available to use with the source configuration of a collection. `invalid` refers to the - /// credentials (for example, the password provided has expired) and must be corrected before they can be used - /// with a collection. (optional) + /// Object that contains details about the status of the authentication process. + /// (optional) /// Credentials - public DetailedResponse CreateCredentials(string environmentId, string sourceType = null, CredentialDetails credentialDetails = null, string status = null) + public DetailedResponse CreateCredentials(string environmentId, string sourceType = null, CredentialDetails credentialDetails = null, StatusDetails status = null) { if (string.IsNullOrEmpty(Version)) { @@ -4610,9 +4608,9 @@ public DetailedResponse CreateCredentials(string environmentId, str { bodyObject["credential_details"] = JToken.FromObject(credentialDetails); } - if (!string.IsNullOrEmpty(status)) + if (status != null) { - bodyObject["status"] = status; + bodyObject["status"] = JToken.FromObject(status); } var httpContent = new StringContent(JsonConvert.SerializeObject(bodyObject), Encoding.UTF8, HttpMediaType.APPLICATION_JSON); restRequest.WithBodyContent(httpContent); @@ -4720,12 +4718,10 @@ public DetailedResponse GetCredentials(string environmentId, string /// Object containing details of the stored credentials. /// /// Obtain credentials for your source from the administrator of the source. (optional) - /// The current status of this set of credentials. `connected` indicates that the - /// credentials are available to use with the source configuration of a collection. `invalid` refers to the - /// credentials (for example, the password provided has expired) and must be corrected before they can be used - /// with a collection. (optional) + /// Object that contains details about the status of the authentication process. + /// (optional) /// Credentials - public DetailedResponse UpdateCredentials(string environmentId, string credentialId, string sourceType = null, CredentialDetails credentialDetails = null, string status = null) + public DetailedResponse UpdateCredentials(string environmentId, string credentialId, string sourceType = null, CredentialDetails credentialDetails = null, StatusDetails status = null) { if (string.IsNullOrEmpty(Version)) { @@ -4772,9 +4768,9 @@ public DetailedResponse UpdateCredentials(string environmentId, str { bodyObject["credential_details"] = JToken.FromObject(credentialDetails); } - if (!string.IsNullOrEmpty(status)) + if (status != null) { - bodyObject["status"] = status; + bodyObject["status"] = JToken.FromObject(status); } var httpContent = new StringContent(JsonConvert.SerializeObject(bodyObject), Encoding.UTF8, HttpMediaType.APPLICATION_JSON); restRequest.WithBodyContent(httpContent); diff --git a/src/IBM.Watson.Discovery.v1/IDiscoveryService.cs b/src/IBM.Watson.Discovery.v1/IDiscoveryService.cs index 9e4ac3229f..2059e17aa3 100644 --- a/src/IBM.Watson.Discovery.v1/IDiscoveryService.cs +++ b/src/IBM.Watson.Discovery.v1/IDiscoveryService.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2017, 2019. +* (C) Copyright IBM Corp. 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -79,9 +79,9 @@ public partial interface IDiscoveryService DetailedResponse GetMetricsEventRate(DateTime? startTime = null, DateTime? endTime = null, string resultType = null); DetailedResponse GetMetricsQueryTokenEvent(long? count = null); DetailedResponse ListCredentials(string environmentId); - DetailedResponse CreateCredentials(string environmentId, string sourceType = null, CredentialDetails credentialDetails = null, string status = null); + DetailedResponse CreateCredentials(string environmentId, string sourceType = null, CredentialDetails credentialDetails = null, StatusDetails status = null); DetailedResponse GetCredentials(string environmentId, string credentialId); - DetailedResponse UpdateCredentials(string environmentId, string credentialId, string sourceType = null, CredentialDetails credentialDetails = null, string status = null); + DetailedResponse UpdateCredentials(string environmentId, string credentialId, string sourceType = null, CredentialDetails credentialDetails = null, StatusDetails status = null); DetailedResponse DeleteCredentials(string environmentId, string credentialId); DetailedResponse ListGateways(string environmentId); DetailedResponse CreateGateway(string environmentId, string name = null); diff --git a/src/IBM.Watson.Discovery.v1/Model/Credentials.cs b/src/IBM.Watson.Discovery.v1/Model/Credentials.cs index 5bc947b658..133c95a0c8 100644 --- a/src/IBM.Watson.Discovery.v1/Model/Credentials.cs +++ b/src/IBM.Watson.Discovery.v1/Model/Credentials.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2018, 2019. +* (C) Copyright IBM Corp. 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -57,24 +57,6 @@ public class SourceTypeEnumValue } - /// - /// The current status of this set of credentials. `connected` indicates that the credentials are available to - /// use with the source configuration of a collection. `invalid` refers to the credentials (for example, the - /// password provided has expired) and must be corrected before they can be used with a collection. - /// - public class StatusEnumValue - { - /// - /// Constant CONNECTED for connected - /// - public const string CONNECTED = "connected"; - /// - /// Constant INVALID for invalid - /// - public const string INVALID = "invalid"; - - } - /// /// The source that this credentials object connects to. /// - `box` indicates the credentials are used to connect an instance of Enterprise Box. @@ -87,14 +69,6 @@ public class StatusEnumValue [JsonProperty("source_type", NullValueHandling = NullValueHandling.Ignore)] public string SourceType { get; set; } /// - /// The current status of this set of credentials. `connected` indicates that the credentials are available to - /// use with the source configuration of a collection. `invalid` refers to the credentials (for example, the - /// password provided has expired) and must be corrected before they can be used with a collection. - /// Constants for possible values can be found using Credentials.StatusEnumValue - /// - [JsonProperty("status", NullValueHandling = NullValueHandling.Ignore)] - public string Status { get; set; } - /// /// Unique identifier for this set of credentials. /// [JsonProperty("credential_id", NullValueHandling = NullValueHandling.Ignore)] @@ -106,6 +80,11 @@ public class StatusEnumValue /// [JsonProperty("credential_details", NullValueHandling = NullValueHandling.Ignore)] public CredentialDetails CredentialDetails { get; set; } + /// + /// Object that contains details about the status of the authentication process. + /// + [JsonProperty("status", NullValueHandling = NullValueHandling.Ignore)] + public StatusDetails Status { get; set; } } } diff --git a/src/IBM.Watson.Discovery.v1/Model/StatusDetails.cs b/src/IBM.Watson.Discovery.v1/Model/StatusDetails.cs new file mode 100644 index 0000000000..5822ccde43 --- /dev/null +++ b/src/IBM.Watson.Discovery.v1/Model/StatusDetails.cs @@ -0,0 +1,39 @@ +/** +* (C) Copyright IBM Corp. 2021. +* +* 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.Watson.Discovery.v1.Model +{ + /// + /// Object that contains details about the status of the authentication process. + /// + public class StatusDetails + { + /// + /// Indicates whether the credential is accepted by the target data source. + /// + [JsonProperty("authentication", NullValueHandling = NullValueHandling.Ignore)] + public bool? Authentication { get; set; } + /// + /// If `authentication` is `false`, a message describes why the authentication was unsuccessful. + /// + [JsonProperty("error_message", NullValueHandling = NullValueHandling.Ignore)] + public string ErrorMessage { get; set; } + } + +} From 08d2889beeb19eeaba1e8406c88f0c79d0bf4b26 Mon Sep 17 00:00:00 2001 From: Nanwarin Chantarutai Date: Mon, 13 Sep 2021 00:05:27 -0700 Subject: [PATCH 17/26] chore(lint-copyrights): ran lint-copyrights --- src/IBM.Watson.Discovery.v1/DiscoveryService.cs | 2 +- src/IBM.Watson.Discovery.v1/IDiscoveryService.cs | 2 +- src/IBM.Watson.Discovery.v1/Model/Credentials.cs | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/src/IBM.Watson.Discovery.v1/DiscoveryService.cs b/src/IBM.Watson.Discovery.v1/DiscoveryService.cs index 8e801ba78d..3484de4144 100644 --- a/src/IBM.Watson.Discovery.v1/DiscoveryService.cs +++ b/src/IBM.Watson.Discovery.v1/DiscoveryService.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2021. +* (C) Copyright IBM Corp. 2017, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/IBM.Watson.Discovery.v1/IDiscoveryService.cs b/src/IBM.Watson.Discovery.v1/IDiscoveryService.cs index 2059e17aa3..a2724894c2 100644 --- a/src/IBM.Watson.Discovery.v1/IDiscoveryService.cs +++ b/src/IBM.Watson.Discovery.v1/IDiscoveryService.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2021. +* (C) Copyright IBM Corp. 2017, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/IBM.Watson.Discovery.v1/Model/Credentials.cs b/src/IBM.Watson.Discovery.v1/Model/Credentials.cs index 133c95a0c8..a93186c883 100644 --- a/src/IBM.Watson.Discovery.v1/Model/Credentials.cs +++ b/src/IBM.Watson.Discovery.v1/Model/Credentials.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2021. +* (C) Copyright IBM Corp. 2018, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. From 06438ccc94995139c1123e260bacdd4f2cdfd5d7 Mon Sep 17 00:00:00 2001 From: Nanwarin Chantarutai Date: Mon, 13 Sep 2021 00:22:42 -0700 Subject: [PATCH 18/26] fix(unit-test): update unit test for discovery v1 for converting status from string to StatusDetails --- .../Test/Unit/DiscoveryServiceGeneratedUnitTests.cs | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/src/IBM.Watson.Discovery.v1/Test/Unit/DiscoveryServiceGeneratedUnitTests.cs b/src/IBM.Watson.Discovery.v1/Test/Unit/DiscoveryServiceGeneratedUnitTests.cs index 2f62a6df5a..7eaf282140 100644 --- a/src/IBM.Watson.Discovery.v1/Test/Unit/DiscoveryServiceGeneratedUnitTests.cs +++ b/src/IBM.Watson.Discovery.v1/Test/Unit/DiscoveryServiceGeneratedUnitTests.cs @@ -1630,7 +1630,7 @@ public void CreateCredentials_Success() var environmentId = "environmentId"; var sourceType = "sourceType"; var credentialDetails = new CredentialDetails(); - var status = "status"; + var status = new StatusDetails(); var result = service.CreateCredentials(environmentId: environmentId, sourceType: sourceType, credentialDetails: credentialDetails, status: status); @@ -1643,9 +1643,9 @@ public void CreateCredentials_Success() { bodyObject["credential_details"] = JToken.FromObject(credentialDetails); } - if (!string.IsNullOrEmpty(status)) + if (status != null) { - bodyObject["status"] = JToken.FromObject(status); + bodyObject["authentication"] = JToken.FromObject(status); } var json = JsonConvert.SerializeObject(bodyObject); request.Received().WithArgument("version", versionDate); @@ -1688,7 +1688,7 @@ public void UpdateCredentials_Success() var credentialId = "credentialId"; var sourceType = "sourceType"; var credentialDetails = new CredentialDetails(); - var status = "status"; + var status = new StatusDetails(); var result = service.UpdateCredentials(environmentId: environmentId, credentialId: credentialId, sourceType: sourceType, credentialDetails: credentialDetails, status: status); @@ -1701,9 +1701,9 @@ public void UpdateCredentials_Success() { bodyObject["credential_details"] = JToken.FromObject(credentialDetails); } - if (!string.IsNullOrEmpty(status)) + if (status != null) { - bodyObject["status"] = JToken.FromObject(status); + bodyObject["authentication"] = JToken.FromObject(status); } var json = JsonConvert.SerializeObject(bodyObject); request.Received().WithArgument("version", versionDate); From 3dddd1e02f5223450bcfce5bf55c7d5f4eaa9085 Mon Sep 17 00:00:00 2001 From: Nanwarin Chantarutai Date: Mon, 13 Sep 2021 00:42:13 -0700 Subject: [PATCH 19/26] fix(unit-test): fix unit test for diccovery-v1 --- .../Test/Unit/DiscoveryServiceGeneratedUnitTests.cs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/IBM.Watson.Discovery.v1/Test/Unit/DiscoveryServiceGeneratedUnitTests.cs b/src/IBM.Watson.Discovery.v1/Test/Unit/DiscoveryServiceGeneratedUnitTests.cs index 7eaf282140..4a8cb5f300 100644 --- a/src/IBM.Watson.Discovery.v1/Test/Unit/DiscoveryServiceGeneratedUnitTests.cs +++ b/src/IBM.Watson.Discovery.v1/Test/Unit/DiscoveryServiceGeneratedUnitTests.cs @@ -1645,7 +1645,7 @@ public void CreateCredentials_Success() } if (status != null) { - bodyObject["authentication"] = JToken.FromObject(status); + bodyObject["status"] = JToken.FromObject(status); } var json = JsonConvert.SerializeObject(bodyObject); request.Received().WithArgument("version", versionDate); @@ -1703,7 +1703,7 @@ public void UpdateCredentials_Success() } if (status != null) { - bodyObject["authentication"] = JToken.FromObject(status); + bodyObject["status"] = JToken.FromObject(status); } var json = JsonConvert.SerializeObject(bodyObject); request.Received().WithArgument("version", versionDate); From 8d25195001d59bb07ffbdb385a20beaea46666a0 Mon Sep 17 00:00:00 2001 From: Nanwarin Chantarutai Date: Tue, 14 Sep 2021 08:04:56 -0700 Subject: [PATCH 20/26] fix(assistant-v2): add transferInfo property for assistant v2 --- .../Model/RuntimeResponseGeneric.cs | 7 ++++++- ...meResponseGenericRuntimeResponseTypeChannelTransfer.cs | 6 +++++- ...imeResponseGenericRuntimeResponseTypeConnectToAgent.cs | 8 ++++++-- 3 files changed, 17 insertions(+), 4 deletions(-) diff --git a/src/IBM.Watson.Assistant.v2/Model/RuntimeResponseGeneric.cs b/src/IBM.Watson.Assistant.v2/Model/RuntimeResponseGeneric.cs index 38fdff5fec..13d7be6e36 100644 --- a/src/IBM.Watson.Assistant.v2/Model/RuntimeResponseGeneric.cs +++ b/src/IBM.Watson.Assistant.v2/Model/RuntimeResponseGeneric.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2018, 2021. +* (C) Copyright IBM Corp. 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -153,6 +153,11 @@ public class PreferenceEnumValue [JsonProperty("agent_unavailable", NullValueHandling = NullValueHandling.Ignore)] public AgentAvailabilityMessage AgentUnavailable { get; protected set; } /// + /// Routing or other contextual information to be used by target service desk systems. + /// + [JsonProperty("transfer_info", NullValueHandling = NullValueHandling.Ignore)] + public DialogNodeOutputConnectToAgentTransferInfo TransferInfo { get; protected set; } + /// /// A label identifying the topic of the conversation, derived from the **title** property of the relevant node /// or the **topic** property of the dialog node response. /// diff --git a/src/IBM.Watson.Assistant.v2/Model/RuntimeResponseGenericRuntimeResponseTypeChannelTransfer.cs b/src/IBM.Watson.Assistant.v2/Model/RuntimeResponseGenericRuntimeResponseTypeChannelTransfer.cs index 52343ecded..56291a19db 100644 --- a/src/IBM.Watson.Assistant.v2/Model/RuntimeResponseGenericRuntimeResponseTypeChannelTransfer.cs +++ b/src/IBM.Watson.Assistant.v2/Model/RuntimeResponseGenericRuntimeResponseTypeChannelTransfer.cs @@ -48,7 +48,11 @@ public class RuntimeResponseGenericRuntimeResponseTypeChannelTransfer : RuntimeR /// Information used by an integration to transfer the conversation to a different channel. /// [JsonProperty("transfer_info", NullValueHandling = NullValueHandling.Ignore)] - public new ChannelTransferInfo TransferInfo { get; protected set; } + public new ChannelTransferInfo TransferInfo + { + get { return base.TransferInfo; } + set { base.TransferInfo = value; } + } /// /// An array of objects specifying channels for which the response is intended. If **channels** is present, the /// response is intended for a built-in integration and should not be handled by an API client. diff --git a/src/IBM.Watson.Assistant.v2/Model/RuntimeResponseGenericRuntimeResponseTypeConnectToAgent.cs b/src/IBM.Watson.Assistant.v2/Model/RuntimeResponseGenericRuntimeResponseTypeConnectToAgent.cs index 444286b52a..97f1e2dfea 100644 --- a/src/IBM.Watson.Assistant.v2/Model/RuntimeResponseGenericRuntimeResponseTypeConnectToAgent.cs +++ b/src/IBM.Watson.Assistant.v2/Model/RuntimeResponseGenericRuntimeResponseTypeConnectToAgent.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2020, 2021. +* (C) Copyright IBM Corp. 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -68,7 +68,11 @@ public class RuntimeResponseGenericRuntimeResponseTypeConnectToAgent : RuntimeRe /// Routing or other contextual information to be used by target service desk systems. /// [JsonProperty("transfer_info", NullValueHandling = NullValueHandling.Ignore)] - public new DialogNodeOutputConnectToAgentTransferInfo TransferInfo { get; protected set; } + public new DialogNodeOutputConnectToAgentTransferInfo TransferInfo + { + get { return base.TransferInfo; } + set { base.TransferInfo = value; } + } /// /// A label identifying the topic of the conversation, derived from the **title** property of the relevant node /// or the **topic** property of the dialog node response. From 9dc83ea2f6f6e3eca73ac496ed9f50fe1f510383 Mon Sep 17 00:00:00 2001 From: Nanwarin Chantarutai Date: Tue, 14 Sep 2021 08:18:33 -0700 Subject: [PATCH 21/26] fix(manual-changes): fix runtime error --- ...timeResponseGenericRuntimeResponseTypeChannelTransfer.cs | 6 +----- ...ntimeResponseGenericRuntimeResponseTypeConnectToAgent.cs | 6 +----- 2 files changed, 2 insertions(+), 10 deletions(-) diff --git a/src/IBM.Watson.Assistant.v2/Model/RuntimeResponseGenericRuntimeResponseTypeChannelTransfer.cs b/src/IBM.Watson.Assistant.v2/Model/RuntimeResponseGenericRuntimeResponseTypeChannelTransfer.cs index 56291a19db..52343ecded 100644 --- a/src/IBM.Watson.Assistant.v2/Model/RuntimeResponseGenericRuntimeResponseTypeChannelTransfer.cs +++ b/src/IBM.Watson.Assistant.v2/Model/RuntimeResponseGenericRuntimeResponseTypeChannelTransfer.cs @@ -48,11 +48,7 @@ public class RuntimeResponseGenericRuntimeResponseTypeChannelTransfer : RuntimeR /// Information used by an integration to transfer the conversation to a different channel. /// [JsonProperty("transfer_info", NullValueHandling = NullValueHandling.Ignore)] - public new ChannelTransferInfo TransferInfo - { - get { return base.TransferInfo; } - set { base.TransferInfo = value; } - } + public new ChannelTransferInfo TransferInfo { get; protected set; } /// /// An array of objects specifying channels for which the response is intended. If **channels** is present, the /// response is intended for a built-in integration and should not be handled by an API client. diff --git a/src/IBM.Watson.Assistant.v2/Model/RuntimeResponseGenericRuntimeResponseTypeConnectToAgent.cs b/src/IBM.Watson.Assistant.v2/Model/RuntimeResponseGenericRuntimeResponseTypeConnectToAgent.cs index 97f1e2dfea..3833935f57 100644 --- a/src/IBM.Watson.Assistant.v2/Model/RuntimeResponseGenericRuntimeResponseTypeConnectToAgent.cs +++ b/src/IBM.Watson.Assistant.v2/Model/RuntimeResponseGenericRuntimeResponseTypeConnectToAgent.cs @@ -68,11 +68,7 @@ public class RuntimeResponseGenericRuntimeResponseTypeConnectToAgent : RuntimeRe /// Routing or other contextual information to be used by target service desk systems. /// [JsonProperty("transfer_info", NullValueHandling = NullValueHandling.Ignore)] - public new DialogNodeOutputConnectToAgentTransferInfo TransferInfo - { - get { return base.TransferInfo; } - set { base.TransferInfo = value; } - } + public new DialogNodeOutputConnectToAgentTransferInfo TransferInfo { get; protected set; } /// /// A label identifying the topic of the conversation, derived from the **title** property of the relevant node /// or the **topic** property of the dialog node response. From 4011057a72f6ec5c63485d24f082c9d97cb4923c Mon Sep 17 00:00:00 2001 From: Nanwarin Chantarutai Date: Tue, 14 Sep 2021 08:29:46 -0700 Subject: [PATCH 22/26] chore(lint-copyrights): ran lint-copyrights fix --- src/IBM.Watson.Assistant.v2/Model/RuntimeResponseGeneric.cs | 2 +- .../RuntimeResponseGenericRuntimeResponseTypeConnectToAgent.cs | 2 +- .../Test/Unit/DiscoveryServiceGeneratedUnitTests.cs | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/src/IBM.Watson.Assistant.v2/Model/RuntimeResponseGeneric.cs b/src/IBM.Watson.Assistant.v2/Model/RuntimeResponseGeneric.cs index 13d7be6e36..f6fdd4956c 100644 --- a/src/IBM.Watson.Assistant.v2/Model/RuntimeResponseGeneric.cs +++ b/src/IBM.Watson.Assistant.v2/Model/RuntimeResponseGeneric.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2021. +* (C) Copyright IBM Corp. 2018, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/IBM.Watson.Assistant.v2/Model/RuntimeResponseGenericRuntimeResponseTypeConnectToAgent.cs b/src/IBM.Watson.Assistant.v2/Model/RuntimeResponseGenericRuntimeResponseTypeConnectToAgent.cs index 3833935f57..444286b52a 100644 --- a/src/IBM.Watson.Assistant.v2/Model/RuntimeResponseGenericRuntimeResponseTypeConnectToAgent.cs +++ b/src/IBM.Watson.Assistant.v2/Model/RuntimeResponseGenericRuntimeResponseTypeConnectToAgent.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2021. +* (C) Copyright IBM Corp. 2020, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/src/IBM.Watson.Discovery.v1/Test/Unit/DiscoveryServiceGeneratedUnitTests.cs b/src/IBM.Watson.Discovery.v1/Test/Unit/DiscoveryServiceGeneratedUnitTests.cs index 4a8cb5f300..0c0c2a234a 100644 --- a/src/IBM.Watson.Discovery.v1/Test/Unit/DiscoveryServiceGeneratedUnitTests.cs +++ b/src/IBM.Watson.Discovery.v1/Test/Unit/DiscoveryServiceGeneratedUnitTests.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2018, 2020. +* (C) Copyright IBM Corp. 2018, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. From 856ffd8d5edffdfd6cccc2bdb60d3825ccbd0faa Mon Sep 17 00:00:00 2001 From: Nanwarin Chantarutai Date: Tue, 14 Sep 2021 08:52:16 -0700 Subject: [PATCH 23/26] fix(assistant-v2): update assistant v2 add new Model, SearchResultAnswer --- .../Model/SearchResult.cs | 12 +++++- .../Model/SearchResultAnswer.cs | 39 +++++++++++++++++++ 2 files changed, 50 insertions(+), 1 deletion(-) create mode 100644 src/IBM.Watson.Assistant.v2/Model/SearchResultAnswer.cs diff --git a/src/IBM.Watson.Assistant.v2/Model/SearchResult.cs b/src/IBM.Watson.Assistant.v2/Model/SearchResult.cs index ea784a97f3..47ffcf7d6a 100644 --- a/src/IBM.Watson.Assistant.v2/Model/SearchResult.cs +++ b/src/IBM.Watson.Assistant.v2/Model/SearchResult.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2019, 2021. +* (C) Copyright IBM Corp. 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -15,6 +15,7 @@ * */ +using System.Collections.Generic; using Newtonsoft.Json; namespace IBM.Watson.Assistant.v2.Model @@ -60,6 +61,15 @@ public class SearchResult /// [JsonProperty("highlight", NullValueHandling = NullValueHandling.Ignore)] public SearchResultHighlight Highlight { get; set; } + /// + /// An array specifying segments of text within the result that were identified as direct answers to the search + /// query. Currently, only the single answer with the highest confidence (if any) is returned. + /// + /// **Note:** This property uses the answer finding beta feature, and is available only if the search skill is + /// connected to a Discovery v2 service instance. + /// + [JsonProperty("answers", NullValueHandling = NullValueHandling.Ignore)] + public List Answers { get; set; } } } diff --git a/src/IBM.Watson.Assistant.v2/Model/SearchResultAnswer.cs b/src/IBM.Watson.Assistant.v2/Model/SearchResultAnswer.cs new file mode 100644 index 0000000000..01ce04f468 --- /dev/null +++ b/src/IBM.Watson.Assistant.v2/Model/SearchResultAnswer.cs @@ -0,0 +1,39 @@ +/** +* (C) Copyright IBM Corp. 2021. +* +* 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.Watson.Assistant.v2.Model +{ + /// + /// An object specifing a segment of text that was identified as a direct answer to the search query. + /// + public class SearchResultAnswer + { + /// + /// The text of the answer. + /// + [JsonProperty("text", NullValueHandling = NullValueHandling.Ignore)] + public string Text { get; set; } + /// + /// The confidence score for the answer, as returned by the Discovery service. + /// + [JsonProperty("confidence", NullValueHandling = NullValueHandling.Ignore)] + public double? Confidence { get; set; } + } + +} From 7b9769a41efaaedd5dd7f65c8af46e2a1defdaaf Mon Sep 17 00:00:00 2001 From: Nanwarin Chantarutai Date: Tue, 14 Sep 2021 08:52:58 -0700 Subject: [PATCH 24/26] fix(discovery-v1): fix Status Details property change from authentication to authenticated --- src/IBM.Watson.Discovery.v1/Model/StatusDetails.cs | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/IBM.Watson.Discovery.v1/Model/StatusDetails.cs b/src/IBM.Watson.Discovery.v1/Model/StatusDetails.cs index 5822ccde43..c6fbe17b0a 100644 --- a/src/IBM.Watson.Discovery.v1/Model/StatusDetails.cs +++ b/src/IBM.Watson.Discovery.v1/Model/StatusDetails.cs @@ -27,10 +27,10 @@ public class StatusDetails /// /// Indicates whether the credential is accepted by the target data source. /// - [JsonProperty("authentication", NullValueHandling = NullValueHandling.Ignore)] - public bool? Authentication { get; set; } + [JsonProperty("authenticated", NullValueHandling = NullValueHandling.Ignore)] + public bool? Authenticated { get; set; } /// - /// If `authentication` is `false`, a message describes why the authentication was unsuccessful. + /// If `authenticated` is `false`, a message describes why the authentication was unsuccessful. /// [JsonProperty("error_message", NullValueHandling = NullValueHandling.Ignore)] public string ErrorMessage { get; set; } From 8f999398eebc7266412f1d013e8d660140d88a93 Mon Sep 17 00:00:00 2001 From: Nanwarin Chantarutai Date: Tue, 14 Sep 2021 08:58:45 -0700 Subject: [PATCH 25/26] chore(lint-copyrights): ran lint-copyrights --- src/IBM.Watson.Assistant.v2/Model/SearchResult.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/IBM.Watson.Assistant.v2/Model/SearchResult.cs b/src/IBM.Watson.Assistant.v2/Model/SearchResult.cs index 47ffcf7d6a..145bddb45d 100644 --- a/src/IBM.Watson.Assistant.v2/Model/SearchResult.cs +++ b/src/IBM.Watson.Assistant.v2/Model/SearchResult.cs @@ -1,5 +1,5 @@ /** -* (C) Copyright IBM Corp. 2021. +* (C) Copyright IBM Corp. 2019, 2021. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. From 295ce72da051338b05c441c88dca747b5980cbba Mon Sep 17 00:00:00 2001 From: Nanwarin Chantarutai Date: Tue, 14 Sep 2021 10:07:00 -0700 Subject: [PATCH 26/26] fix(manual-changes): remote transfer_infor out from runtimeResponseGeneric for assistant-v2 --- src/IBM.Watson.Assistant.v2/Model/RuntimeResponseGeneric.cs | 5 ----- 1 file changed, 5 deletions(-) diff --git a/src/IBM.Watson.Assistant.v2/Model/RuntimeResponseGeneric.cs b/src/IBM.Watson.Assistant.v2/Model/RuntimeResponseGeneric.cs index f6fdd4956c..38fdff5fec 100644 --- a/src/IBM.Watson.Assistant.v2/Model/RuntimeResponseGeneric.cs +++ b/src/IBM.Watson.Assistant.v2/Model/RuntimeResponseGeneric.cs @@ -153,11 +153,6 @@ public class PreferenceEnumValue [JsonProperty("agent_unavailable", NullValueHandling = NullValueHandling.Ignore)] public AgentAvailabilityMessage AgentUnavailable { get; protected set; } /// - /// Routing or other contextual information to be used by target service desk systems. - /// - [JsonProperty("transfer_info", NullValueHandling = NullValueHandling.Ignore)] - public DialogNodeOutputConnectToAgentTransferInfo TransferInfo { get; protected set; } - /// /// A label identifying the topic of the conversation, derived from the **title** property of the relevant node /// or the **topic** property of the dialog node response. ///