[incubator-nlpcraft] branch master updated: Update NCDialogFlowItem.java

[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 4a8fa0f  Update NCDialogFlowItem.java
4a8fa0f is described below

commit 4a8fa0fde1ac15075ed2b0ed09bd4b7a03560dc9
Author: Aaron Radzinski <ar...@datalingvo.com>
AuthorDate: Mon Mar 28 14:15:15 2022 -0700

    Update NCDialogFlowItem.java
---
 .../src/main/scala/org/apache/nlpcraft/NCDialogFlowItem.java   | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)

diff --git a/nlpcraft/src/main/scala/org/apache/nlpcraft/NCDialogFlowItem.java b/nlpcraft/src/main/scala/org/apache/nlpcraft/NCDialogFlowItem.java
index f5519e3..4ea757f 100644
--- a/nlpcraft/src/main/scala/org/apache/nlpcraft/NCDialogFlowItem.java
+++ b/nlpcraft/src/main/scala/org/apache/nlpcraft/NCDialogFlowItem.java
@@ -18,18 +18,24 @@
 package org.apache.nlpcraft;
 
 /**
+ * An item of the dialog flow. Dialog flow is a chronologically ordered list of dialog flow items. Each item
+ * represents a snapshot of winning intent's match and its associated data. List of dialog flow items
+ * is passed into a custom user-defined dialog flow match method.
  *
+ * @see NCConversation#getDialogFlow() 
  */
 public interface NCDialogFlowItem {
     /**
+     * Gets the intent match container.
      *
-     * @return
+     * @return Intent match container.
      */
     NCIntentMatch getIntentMatch();
 
     /**
+     * Gets the input request descriptor.
      *
-     * @return
+     * @return Input request descriptor.
      */
     NCRequest getRequest();