API Doc updates

sillsdev · Mar 27, 2024 · 487d339 · 487d339
1 parent 14a96fe
commit 487d339
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 13 deletions.
diff --git a/src/Serval.Client/Client.g.cs b/src/Serval.Client/Client.g.cs
@@ -1512,10 +1512,11 @@ public partial interface ITranslationEnginesClient
         /// <br/>  * **TextId**: The client-defined name to associate source and target files.
         /// <br/>    * If the TextIds in the SourceFiles and TargetFiles match, they will be used to train the engine.
         /// <br/>    * If selected for pretranslation when building, all SourceFiles that have no TargetFile, or lines of text in a SourceFile that have missing or blank lines in the TargetFile will be pretranslated.
-        /// <br/>    * A TextId should only be used at most once in SourceFiles and in TargetFiles.
-        /// <br/>    * If the file is a Paratext project, this field should be left blank. Any TextId provided will be ignored.
-        /// <br/>* **TargetFiles**: The source files associated with the corpus
-        /// <br/>  * Same as SourceFiles.  Parallel texts must have a matching TextId.
+        /// <br/>    * If a TextId is used more than once in SourceFiles, the sources will be randomly and evenly mixed for training.
+        /// <br/>    * For pretranslating, multiple sources with the same TextId will be combined, but the first source will always take precedence (no random mixing).
+        /// <br/>    * For Paratext projects, TextId will be ignored - multiple Paratext source projects will always be mixed (as if they have the same TextId).
+        /// <br/>* **TargetFiles**: The target files associated with the corpus
+        /// <br/>  * Same as SourceFiles, except only a single instance of a TextID or a single paratext project is supported.  There is no mixing or combining of multiple targets.
         /// </remarks>
         /// <param name="id">The translation engine id</param>
         /// <param name="corpusConfig">The corpus configuration (see remarks)</param>
@@ -2742,10 +2743,11 @@ public string BaseUrl
         /// <br/>  * **TextId**: The client-defined name to associate source and target files.
         /// <br/>    * If the TextIds in the SourceFiles and TargetFiles match, they will be used to train the engine.
         /// <br/>    * If selected for pretranslation when building, all SourceFiles that have no TargetFile, or lines of text in a SourceFile that have missing or blank lines in the TargetFile will be pretranslated.
-        /// <br/>    * A TextId should only be used at most once in SourceFiles and in TargetFiles.
-        /// <br/>    * If the file is a Paratext project, this field should be left blank. Any TextId provided will be ignored.
-        /// <br/>* **TargetFiles**: The source files associated with the corpus
-        /// <br/>  * Same as SourceFiles.  Parallel texts must have a matching TextId.
+        /// <br/>    * If a TextId is used more than once in SourceFiles, the sources will be randomly and evenly mixed for training.
+        /// <br/>    * For pretranslating, multiple sources with the same TextId will be combined, but the first source will always take precedence (no random mixing).
+        /// <br/>    * For Paratext projects, TextId will be ignored - multiple Paratext source projects will always be mixed (as if they have the same TextId).
+        /// <br/>* **TargetFiles**: The target files associated with the corpus
+        /// <br/>  * Same as SourceFiles, except only a single instance of a TextID or a single paratext project is supported.  There is no mixing or combining of multiple targets.
         /// </remarks>
         /// <param name="id">The translation engine id</param>
         /// <param name="corpusConfig">The corpus configuration (see remarks)</param>

diff --git a/src/Serval.Client/Serval.Client.csproj b/src/Serval.Client/Serval.Client.csproj
@@ -2,7 +2,7 @@
 
 	<PropertyGroup>
 		<TargetFramework>netstandard2.1</TargetFramework>
-		<Version>1.3.0</Version>
+		<Version>1.3.1</Version>
 		<Description>Client classes for Serval.</Description>
 		<RootNamespace>Serval.Client</RootNamespace>
 		<NoWarn>8618</NoWarn>

diff --git a/src/Serval.Translation/Controllers/TranslationEnginesController.cs b/src/Serval.Translation/Controllers/TranslationEnginesController.cs
@@ -321,10 +321,11 @@ await _engineService.TrainSegmentPairAsync(
     ///   * **TextId**: The client-defined name to associate source and target files.
     ///     * If the TextIds in the SourceFiles and TargetFiles match, they will be used to train the engine.
     ///     * If selected for pretranslation when building, all SourceFiles that have no TargetFile, or lines of text in a SourceFile that have missing or blank lines in the TargetFile will be pretranslated.
-    ///     * A TextId should only be used at most once in SourceFiles and in TargetFiles.
-    ///     * If the file is a Paratext project, this field should be left blank. Any TextId provided will be ignored.
-    /// * **TargetFiles**: The source files associated with the corpus
-    ///   * Same as SourceFiles.  Parallel texts must have a matching TextId.
+    ///     * If a TextId is used more than once in SourceFiles, the sources will be randomly and evenly mixed for training.
+    ///     * For pretranslating, multiple sources with the same TextId will be combined, but the first source will always take precedence (no random mixing).
+    ///     * For Paratext projects, TextId will be ignored - multiple Paratext source projects will always be mixed (as if they have the same TextId).
+    /// * **TargetFiles**: The target files associated with the corpus
+    ///   * Same as SourceFiles, except only a single instance of a TextID or a single paratext project is supported.  There is no mixing or combining of multiple targets.
     /// </remarks>
     /// <param name="id">The translation engine id</param>
     /// <param name="corpusConfig">The corpus configuration (see remarks)</param>