Skip to content

Commit 30eb7de

Browse files
committed
feat: regenrate services using current API def
1 parent fa97def commit 30eb7de

File tree

4 files changed

+44
-30
lines changed

4 files changed

+44
-30
lines changed

Scripts/Services/LanguageTranslator/V3/LanguageTranslatorService.cs

Lines changed: 22 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* (C) Copyright IBM Corp. 2018, 2020.
2+
* (C) Copyright IBM Corp. 2020.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -91,8 +91,11 @@ public LanguageTranslatorService(string versionDate, Authenticator authenticator
9191
/// <summary>
9292
/// List supported languages.
9393
///
94-
/// Lists all supported languages. The method returns an array of supported languages with information about
95-
/// each language. Languages are listed in alphabetical order by language code (for example, `af`, `ar`).
94+
/// Lists all supported languages for translation. The method returns an array of supported languages with
95+
/// information about each language. Languages are listed in alphabetical order by language code (for example,
96+
/// `af`, `ar`). In addition to basic information about each language, the response indicates whether the
97+
/// language is `supported_as_source` for translation and `supported_as_target` for translation. It also lists
98+
/// whether the language is `identifiable`.
9699
/// </summary>
97100
/// <param name="callback">The callback function that is invoked when the operation completes.</param>
98101
/// <returns><see cref="Languages" />Languages</returns>
@@ -162,10 +165,13 @@ private void OnListLanguagesResponse(RESTConnector.Request req, RESTConnector.Re
162165
/// source language to have the service attempt to detect the language from the input text. If you omit the
163166
/// source language, the request must contain sufficient input text for the service to identify the source
164167
/// language.
168+
///
169+
/// You can translate a maximum of 50 KB (51,200 bytes) of text with a single request. All input text must be
170+
/// encoded in UTF-8 format.
165171
/// </summary>
166172
/// <param name="callback">The callback function that is invoked when the operation completes.</param>
167-
/// <param name="text">Input text in UTF-8 encoding. Multiple entries result in multiple translations in the
168-
/// response.</param>
173+
/// <param name="text">Input text in UTF-8 encoding. Submit a maximum of 50 KB (51,200 bytes) of text with a
174+
/// single request. Multiple elements result in multiple translations in the response.</param>
169175
/// <param name="modelId">The model to use for translation. For example, `en-de` selects the IBM-provided base
170176
/// model for English-to-German translation. A model ID overrides the `source` and `target` parameters and is
171177
/// required if you use a custom model. If no model ID is specified, you must specify at least a target
@@ -501,9 +507,11 @@ private void OnListModelsResponse(RESTConnector.Request req, RESTConnector.Respo
501507
/// * **XLIFF** (`.xliff`) - XML Localization Interchange File Format (XLIFF) is an XML specification for the
502508
/// exchange of translation memories.
503509
/// * **CSV** (`.csv`) - Comma-separated values (CSV) file with two columns for aligned sentences and phrases.
504-
/// The first row contains the language code.
510+
/// The first row must have two language codes. The first column is for the source language code, and the second
511+
/// column is for the target language code.
505512
/// * **TSV** (`.tsv` or `.tab`) - Tab-separated values (TSV) file with two columns for aligned sentences and
506-
/// phrases. The first row contains the language code.
513+
/// phrases. The first row must have two language codes. The first column is for the source language code, and
514+
/// the second column is for the target language code.
507515
/// * **JSON** (`.json`) - Custom JSON format for specifying aligned sentences and phrases.
508516
/// * **Microsoft Excel** (`.xls` or `.xlsx`) - Excel file with the first two columns for aligned sentences and
509517
/// phrases. The first row contains the language code.
@@ -844,15 +852,15 @@ private void OnListDocumentsResponse(RESTConnector.Request req, RESTConnector.Re
844852
/// Translate document.
845853
///
846854
/// Submit a document for translation. You can submit the document contents in the `file` parameter, or you can
847-
/// reference a previously submitted document by document ID.
855+
/// reference a previously submitted document by document ID. The maximum file size for document translation is
856+
/// * 20 MB for service instances on the Standard, Advanced, and Premium plans
857+
/// * 2 MB for service instances on the Lite plan.
848858
/// </summary>
849859
/// <param name="callback">The callback function that is invoked when the operation completes.</param>
850-
/// <param name="file">The contents of the source file to translate.
851-
///
852-
/// [Supported file
853-
/// types](https://cloud.ibm.com/docs/language-translator?topic=language-translator-document-translator-tutorial#supported-file-formats)
854-
///
855-
/// Maximum file size: **20 MB**.</param>
860+
/// <param name="file">The contents of the source file to translate. The maximum file size for document
861+
/// translation is 20 MB for service instances on the Standard, Advanced, and Premium plans, and 2 MB for
862+
/// service instances on the Lite plan. For more information, see [Supported file formats
863+
/// (Beta)](https://cloud.ibm.com/docs/language-translator?topic=language-translator-document-translator-tutorial#supported-file-formats).</param>
856864
/// <param name="filename">The filename for file.</param>
857865
/// <param name="fileContentType">The content type of file. (optional)</param>
858866
/// <param name="modelId">The model to use for translation. For example, `en-de` selects the IBM-provided base

Scripts/Services/NaturalLanguageUnderstanding/V1/Model/Model.cs

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* (C) Copyright IBM Corp. 2018, 2020.
2+
* (C) Copyright IBM Corp. 2020.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -89,8 +89,7 @@ public class StatusValue
8989
[JsonProperty("model_version", NullValueHandling = NullValueHandling.Ignore)]
9090
public string ModelVersion { get; set; }
9191
/// <summary>
92-
/// (Deprecated — use `model_version`) The model version, if it was manually provided in Watson Knowledge
93-
/// Studio.
92+
/// Deprecated — use `model_version`.
9493
/// </summary>
9594
[JsonProperty("version", NullValueHandling = NullValueHandling.Ignore)]
9695
public string Version { get; set; }

Scripts/Services/NaturalLanguageUnderstanding/V1/NaturalLanguageUnderstandingService.cs

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* (C) Copyright IBM Corp. 2018, 2020.
2+
* (C) Copyright IBM Corp. 2020.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -101,7 +101,8 @@ public NaturalLanguageUnderstandingService(string versionDate, Authenticator aut
101101
/// - Relations
102102
/// - Semantic roles
103103
/// - Sentiment
104-
/// - Syntax.
104+
/// - Syntax
105+
/// - Summarization (Experimental)
105106
///
106107
/// If a language for the input text is not specified with the `language` parameter, the service [automatically
107108
/// detects the

Scripts/Services/SpeechToText/V1/SpeechToTextService.cs

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* (C) Copyright IBM Corp. 2018, 2020.
2+
* (C) Copyright IBM Corp. 2020.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -1682,8 +1682,11 @@ private void OnCreateLanguageModelResponse(RESTConnector.Request req, RESTConnec
16821682
/// <param name="callback">The callback function that is invoked when the operation completes.</param>
16831683
/// <param name="language">The identifier of the language for which custom language or custom acoustic models
16841684
/// are to be returned. Omit the parameter to see all custom language or custom acoustic models that are owned
1685-
/// by the requesting credentials. **Note:** The `ar-AR` (Modern Standard Arabic) and `zh-CN` (Mandarin Chinese)
1686-
/// languages are not available for language model customization. (optional)</param>
1685+
/// by the requesting credentials.
1686+
///
1687+
/// To determine the languages for which customization is available, see [Language support for
1688+
/// customization](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-customization#languageSupport).
1689+
/// (optional)</param>
16871690
/// <returns><see cref="LanguageModels" />LanguageModels</returns>
16881691
public bool ListLanguageModels(Callback<LanguageModels> callback, string language = null)
16891692
{
@@ -3560,8 +3563,11 @@ private void OnCreateAcousticModelResponse(RESTConnector.Request req, RESTConnec
35603563
/// <param name="callback">The callback function that is invoked when the operation completes.</param>
35613564
/// <param name="language">The identifier of the language for which custom language or custom acoustic models
35623565
/// are to be returned. Omit the parameter to see all custom language or custom acoustic models that are owned
3563-
/// by the requesting credentials. **Note:** The `ar-AR` (Modern Standard Arabic) and `zh-CN` (Mandarin Chinese)
3564-
/// languages are not available for language model customization. (optional)</param>
3566+
/// by the requesting credentials.
3567+
///
3568+
/// To determine the languages for which customization is available, see [Language support for
3569+
/// customization](https://cloud.ibm.com/docs/speech-to-text?topic=speech-to-text-customization#languageSupport).
3570+
/// (optional)</param>
35653571
/// <returns><see cref="AcousticModels" />AcousticModels</returns>
35663572
public bool ListAcousticModels(Callback<AcousticModels> callback, string language = null)
35673573
{
@@ -3779,12 +3785,12 @@ private void OnDeleteAcousticModelResponse(RESTConnector.Request req, RESTConnec
37793785
/// model on the latest audio data. The custom acoustic model does not reflect its changed data until you train
37803786
/// it. You must use credentials for the instance of the service that owns a model to train it.
37813787
///
3782-
/// The training method is asynchronous. It can take on the order of minutes or hours to complete depending on
3783-
/// the total amount of audio data on which the custom acoustic model is being trained and the current load on
3784-
/// the service. Typically, training a custom acoustic model takes approximately two to four times the length of
3785-
/// its audio data. The actual time depends on the model being trained and the nature of the audio, such as
3786-
/// whether the audio is clean or noisy. The method returns an HTTP 200 response code to indicate that the
3787-
/// training process has begun.
3788+
/// The training method is asynchronous. Training time depends on the cumulative amount of audio data that the
3789+
/// custom acoustic model contains and the current load on the service. When you train or retrain a model, the
3790+
/// service uses all of the model's audio data in the training. Training a custom acoustic model takes
3791+
/// approximately as long as the length of its cumulative audio data. For example, it takes approximately 2
3792+
/// hours to train a model that contains a total of 2 hours of audio. The method returns an HTTP 200 response
3793+
/// code to indicate that the training process has begun.
37883794
///
37893795
/// You can monitor the status of the training by using the **Get a custom acoustic model** method to poll the
37903796
/// model's status. Use a loop to check the status once a minute. The method returns an `AcousticModel` object

0 commit comments

Comments
 (0)