[incubator-nlpcraft] branch master updated: Update NCPipeline.scala

[ar...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

aradzinski pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-nlpcraft.git


The following commit(s) were added to refs/heads/master by this push:
     new a6be1d32 Update NCPipeline.scala
a6be1d32 is described below

commit a6be1d32d9bf6edf4d0733038d9f66afb61fa26a
Author: Aaron Radzinski <ar...@datalingvo.com>
AuthorDate: Thu Dec 1 15:10:58 2022 -0800

    Update NCPipeline.scala
---
 .../scala/org/apache/nlpcraft/NCPipeline.scala     | 24 ++++++++++++++++------
 1 file changed, 18 insertions(+), 6 deletions(-)

diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/NCPipeline.scala b/nlpcraft/src/main/scala/org/apache/nlpcraft/NCPipeline.scala
index bb3d0958..569979b1 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/NCPipeline.scala
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/NCPipeline.scala
@@ -37,8 +37,20 @@ package org.apache.nlpcraft
   * *============*    +----- ---+       +----- ---+       +------------+       +-----------+
   * </pre>
   *
-  * Pipeline has the following components:
+  * The result variants are then passed further to the intent matching. Note that only one token parser
+  * and at least one entity parser is required for the minimal pipeline.
   *
+  * @see [[NCToken]]
+  * @see [[NCEntity]]
+  * @see [[NCVariant]]
+  * @see [[NCTokenParser]]
+  * @see [[NCTokenEnricher]]
+  * @see [[NCTokenValidator]]
+  * @see [[NCEntityEnricher]]
+  * @see [[NCEntityMapper]]
+  * @see [[NCEntityValidator]]
+  * @see [[NCVariantFilter]]
+  * @see [[NCEntityValidator]]
   */
 trait NCPipeline:
     /**
@@ -52,27 +64,27 @@ trait NCPipeline:
     def getEntityParsers: List[NCEntityParser]
 
     /**
-      *
+      * Gets optional list of token enrichers. Can return an empty list but never `null`.
       */
     def getTokenEnrichers: List[NCTokenEnricher] = List.empty
 
     /**
-      *
+      * Gets optional list of entity enrichers. Can return an empty list but never `null`.
       */
     def getEntityEnrichers: List[NCEntityEnricher] = List.empty
 
     /**
-      *
+      * Gets optional list of token validators. Can return an empty list but never `null`.
       */
     def getTokenValidators: List[NCTokenValidator] = List.empty
 
     /**
-      *
+      * Gets optional list of entity validators. Can return an empty list but never `null`.
       */
     def getEntityValidators: List[NCEntityValidator] = List.empty
 
     /**
-      *
+      * Gets optional list of variant filters. Can return an empty list but never `null`.
       */
     def getVariantFilters: List[NCVariantFilter] = List.empty