Add missing description for ai tokenizers in DSL

apache · Jan 9, 2025 · 0307817 · 0307817
1 parent bb79c01
commit 0307817
Show file tree

Hide file tree

Showing 19 changed files with 44 additions and 17 deletions.
diff --git a/...rc/generated/resources/org/apache/camel/catalog/models/langChain4jCharacterTokenizer.json b/...rc/generated/resources/org/apache/camel/catalog/models/langChain4jCharacterTokenizer.json
@@ -3,6 +3,7 @@
     "kind": "model",
     "name": "langChain4jCharacterTokenizer",
     "title": "LangChain4J Tokenizer with character splitter",
+    "description": "Camel AI: Tokenizer for splitting by character.",
     "deprecated": false,
     "firstVersion": "4.8.0",
     "label": "eip,transformation,ai",

diff --git a/...log/src/generated/resources/org/apache/camel/catalog/models/langChain4jLineTokenizer.json b/...log/src/generated/resources/org/apache/camel/catalog/models/langChain4jLineTokenizer.json
@@ -3,6 +3,7 @@
     "kind": "model",
     "name": "langChain4jLineTokenizer",
     "title": "LangChain4J Tokenizer with line splitter",
+    "description": "Camel AI: Tokenizer for splitting line by line.",
     "deprecated": false,
     "firstVersion": "4.8.0",
     "label": "eip,transformation,ai",

diff --git a/...rc/generated/resources/org/apache/camel/catalog/models/langChain4jParagraphTokenizer.json b/...rc/generated/resources/org/apache/camel/catalog/models/langChain4jParagraphTokenizer.json
@@ -3,6 +3,7 @@
     "kind": "model",
     "name": "langChain4jParagraphTokenizer",
     "title": "LangChain4J Tokenizer with paragraph splitter",
+    "description": "Camel AI: Tokenizer for splitting by paragraphs.",
     "deprecated": false,
     "firstVersion": "4.8.0",
     "label": "eip,transformation,ai",

diff --git a/...src/generated/resources/org/apache/camel/catalog/models/langChain4jSentenceTokenizer.json b/...src/generated/resources/org/apache/camel/catalog/models/langChain4jSentenceTokenizer.json
@@ -3,6 +3,7 @@
     "kind": "model",
     "name": "langChain4jSentenceTokenizer",
     "title": "LangChain4J Tokenizer with sentence splitter",
+    "description": "Camel AI: Tokenizer for splitting by sentences.",
     "deprecated": false,
     "firstVersion": "4.8.0",
     "label": "eip,transformation,ai",

diff --git a/...log/src/generated/resources/org/apache/camel/catalog/models/langChain4jWordTokenizer.json b/...log/src/generated/resources/org/apache/camel/catalog/models/langChain4jWordTokenizer.json
@@ -3,6 +3,7 @@
     "kind": "model",
     "name": "langChain4jWordTokenizer",
     "title": "LangChain4J Tokenizer with word splitter",
+    "description": "Camel AI: Tokenizer for splitting by word.",
     "deprecated": false,
     "firstVersion": "4.8.0",
     "label": "eip,transformation,ai",

diff --git a/...g/camel-catalog/src/generated/resources/org/apache/camel/catalog/schemas/camel-spring.xsd b/...g/camel-catalog/src/generated/resources/org/apache/camel/catalog/schemas/camel-spring.xsd
@@ -870,7 +870,7 @@ Deprecated: null
     <xs:annotation>
       <xs:documentation xml:lang="en">
 <![CDATA[
-null
+Camel AI: Tokenizer for splitting by character.
 ]]>
       </xs:documentation>
     </xs:annotation>
@@ -879,7 +879,7 @@ null
     <xs:annotation>
       <xs:documentation xml:lang="en">
 <![CDATA[
-null
+Camel AI: Tokenizer for splitting line by line.
 ]]>
       </xs:documentation>
     </xs:annotation>
@@ -888,7 +888,7 @@ null
     <xs:annotation>
       <xs:documentation xml:lang="en">
 <![CDATA[
-null
+Camel AI: Tokenizer for splitting by paragraphs.
 ]]>
       </xs:documentation>
     </xs:annotation>
@@ -897,7 +897,7 @@ null
     <xs:annotation>
       <xs:documentation xml:lang="en">
 <![CDATA[
-null
+Camel AI: Tokenizer for splitting by sentences.
 ]]>
       </xs:documentation>
     </xs:annotation>
@@ -906,7 +906,7 @@ null
     <xs:annotation>
       <xs:documentation xml:lang="en">
 <![CDATA[
-null
+Camel AI: Tokenizer for splitting by word.
 ]]>
       </xs:documentation>
     </xs:annotation>

diff --git a/...ed/resources/META-INF/org/apache/camel/model/tokenizer/langChain4jCharacterTokenizer.json b/...ed/resources/META-INF/org/apache/camel/model/tokenizer/langChain4jCharacterTokenizer.json
@@ -3,6 +3,7 @@
     "kind": "model",
     "name": "langChain4jCharacterTokenizer",
     "title": "LangChain4J Tokenizer with character splitter",
+    "description": "Camel AI: Tokenizer for splitting by character.",
     "deprecated": false,
     "firstVersion": "4.8.0",
     "label": "eip,transformation,ai",

diff --git a/...nerated/resources/META-INF/org/apache/camel/model/tokenizer/langChain4jLineTokenizer.json b/...nerated/resources/META-INF/org/apache/camel/model/tokenizer/langChain4jLineTokenizer.json
@@ -3,6 +3,7 @@
     "kind": "model",
     "name": "langChain4jLineTokenizer",
     "title": "LangChain4J Tokenizer with line splitter",
+    "description": "Camel AI: Tokenizer for splitting line by line.",
     "deprecated": false,
     "firstVersion": "4.8.0",
     "label": "eip,transformation,ai",

diff --git a/...ed/resources/META-INF/org/apache/camel/model/tokenizer/langChain4jParagraphTokenizer.json b/...ed/resources/META-INF/org/apache/camel/model/tokenizer/langChain4jParagraphTokenizer.json
@@ -3,6 +3,7 @@
     "kind": "model",
     "name": "langChain4jParagraphTokenizer",
     "title": "LangChain4J Tokenizer with paragraph splitter",
+    "description": "Camel AI: Tokenizer for splitting by paragraphs.",
     "deprecated": false,
     "firstVersion": "4.8.0",
     "label": "eip,transformation,ai",

diff --git a/...ted/resources/META-INF/org/apache/camel/model/tokenizer/langChain4jSentenceTokenizer.json b/...ted/resources/META-INF/org/apache/camel/model/tokenizer/langChain4jSentenceTokenizer.json
@@ -3,6 +3,7 @@
     "kind": "model",
     "name": "langChain4jSentenceTokenizer",
     "title": "LangChain4J Tokenizer with sentence splitter",
+    "description": "Camel AI: Tokenizer for splitting by sentences.",
     "deprecated": false,
     "firstVersion": "4.8.0",
     "label": "eip,transformation,ai",

diff --git a/...nerated/resources/META-INF/org/apache/camel/model/tokenizer/langChain4jWordTokenizer.json b/...nerated/resources/META-INF/org/apache/camel/model/tokenizer/langChain4jWordTokenizer.json
@@ -3,6 +3,7 @@
     "kind": "model",
     "name": "langChain4jWordTokenizer",
     "title": "LangChain4J Tokenizer with word splitter",
+    "description": "Camel AI: Tokenizer for splitting by word.",
     "deprecated": false,
     "firstVersion": "4.8.0",
     "label": "eip,transformation,ai",

diff --git a/...c/main/java/org/apache/camel/model/tokenizer/LangChain4jCharacterTokenizerDefinition.java b/...c/main/java/org/apache/camel/model/tokenizer/LangChain4jCharacterTokenizerDefinition.java
@@ -14,7 +14,6 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-
 package org.apache.camel.model.tokenizer;
 
 import jakarta.xml.bind.annotation.XmlAccessType;
@@ -24,10 +23,14 @@
 
 import org.apache.camel.spi.Metadata;
 
+/**
+ * Camel AI: Tokenizer for splitting by character.
+ */
 @Metadata(firstVersion = "4.8.0", label = "eip,transformation,ai", title = "LangChain4J Tokenizer with character splitter")
 @XmlRootElement(name = "langChain4jCharacterTokenizer")
 @XmlAccessorType(XmlAccessType.FIELD)
 public class LangChain4jCharacterTokenizerDefinition extends LangChain4jTokenizerDefinition {
+
     public LangChain4jCharacterTokenizerDefinition() {
     }
 
@@ -50,7 +53,6 @@ protected String name() {
         @Override
         public LangChain4jCharacterTokenizerDefinition end() {
             LangChain4jCharacterTokenizerDefinition definition = new LangChain4jCharacterTokenizerDefinition();
-
             setup(definition);
             return definition;
         }

diff --git a/...el/src/main/java/org/apache/camel/model/tokenizer/LangChain4jLineTokenizerDefinition.java b/...el/src/main/java/org/apache/camel/model/tokenizer/LangChain4jLineTokenizerDefinition.java
@@ -14,7 +14,6 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-
 package org.apache.camel.model.tokenizer;
 
 import jakarta.xml.bind.annotation.XmlAccessType;
@@ -24,6 +23,9 @@
 
 import org.apache.camel.spi.Metadata;
 
+/**
+ * Camel AI: Tokenizer for splitting line by line.
+ */
 @Metadata(firstVersion = "4.8.0", label = "eip,transformation,ai", title = "LangChain4J Tokenizer with line splitter")
 @XmlRootElement(name = "langChain4jLineTokenizer")
 @XmlAccessorType(XmlAccessType.FIELD)
@@ -51,9 +53,7 @@ protected String name() {
         @Override
         public LangChain4jLineTokenizerDefinition end() {
             LangChain4jLineTokenizerDefinition definition = new LangChain4jLineTokenizerDefinition();
-
             setup(definition);
-
             return definition;
         }
     }

diff --git a/...c/main/java/org/apache/camel/model/tokenizer/LangChain4jParagraphTokenizerDefinition.java b/...c/main/java/org/apache/camel/model/tokenizer/LangChain4jParagraphTokenizerDefinition.java
@@ -14,7 +14,6 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-
 package org.apache.camel.model.tokenizer;
 
 import jakarta.xml.bind.annotation.XmlAccessType;
@@ -24,6 +23,9 @@
 
 import org.apache.camel.spi.Metadata;
 
+/**
+ * Camel AI: Tokenizer for splitting by paragraphs.
+ */
 @Metadata(firstVersion = "4.8.0", label = "eip,transformation,ai", title = "LangChain4J Tokenizer with paragraph splitter")
 @XmlRootElement(name = "langChain4jParagraphTokenizer")
 @XmlAccessorType(XmlAccessType.FIELD)
@@ -51,7 +53,6 @@ protected String name() {
         @Override
         public LangChain4jParagraphTokenizerDefinition end() {
             LangChain4jParagraphTokenizerDefinition definition = new LangChain4jParagraphTokenizerDefinition();
-
             setup(definition);
             return definition;
         }

diff --git a/...rc/main/java/org/apache/camel/model/tokenizer/LangChain4jSentenceTokenizerDefinition.java b/...rc/main/java/org/apache/camel/model/tokenizer/LangChain4jSentenceTokenizerDefinition.java
@@ -14,7 +14,6 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-
 package org.apache.camel.model.tokenizer;
 
 import jakarta.xml.bind.annotation.XmlAccessType;
@@ -24,10 +23,14 @@
 
 import org.apache.camel.spi.Metadata;
 
+/**
+ * Camel AI: Tokenizer for splitting by sentences.
+ */
 @Metadata(firstVersion = "4.8.0", label = "eip,transformation,ai", title = "LangChain4J Tokenizer with sentence splitter")
 @XmlRootElement(name = "langChain4jSentenceTokenizer")
 @XmlAccessorType(XmlAccessType.FIELD)
 public class LangChain4jSentenceTokenizerDefinition extends LangChain4jTokenizerDefinition {
+
     public LangChain4jSentenceTokenizerDefinition() {
     }
 
@@ -50,7 +53,6 @@ protected String name() {
         @Override
         public LangChain4jSentenceTokenizerDefinition end() {
             LangChain4jSentenceTokenizerDefinition definition = new LangChain4jSentenceTokenizerDefinition();
-
             setup(definition);
             return definition;
         }

diff --git a/...-model/src/main/java/org/apache/camel/model/tokenizer/LangChain4jTokenizerDefinition.java b/...-model/src/main/java/org/apache/camel/model/tokenizer/LangChain4jTokenizerDefinition.java
@@ -29,7 +29,7 @@
 import org.apache.camel.util.StringHelper;
 
 /**
- * Tokenizer that uses LangChain4j for tokenization.
+ * Camel AI: Tokenizer.
  */
 @Metadata(firstVersion = "4.8.0", label = "eip,transformation,ai", title = "LangChain4J Tokenizer")
 @XmlAccessorType(XmlAccessType.FIELD)

diff --git a/...el/src/main/java/org/apache/camel/model/tokenizer/LangChain4jWordTokenizerDefinition.java b/...el/src/main/java/org/apache/camel/model/tokenizer/LangChain4jWordTokenizerDefinition.java
@@ -14,7 +14,6 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-
 package org.apache.camel.model.tokenizer;
 
 import jakarta.xml.bind.annotation.XmlAccessType;
@@ -24,10 +23,14 @@
 
 import org.apache.camel.spi.Metadata;
 
+/**
+ * Camel AI: Tokenizer for splitting by word.
+ */
 @Metadata(firstVersion = "4.8.0", label = "eip,transformation,ai", title = "LangChain4J Tokenizer with word splitter")
 @XmlRootElement(name = "langChain4jWordTokenizer")
 @XmlAccessorType(XmlAccessType.FIELD)
 public class LangChain4jWordTokenizerDefinition extends LangChain4jTokenizerDefinition {
+
     public LangChain4jWordTokenizerDefinition() {
     }
 
@@ -50,7 +53,6 @@ protected String name() {
         @Override
         public LangChain4jWordTokenizerDefinition end() {
             LangChain4jWordTokenizerDefinition definition = new LangChain4jWordTokenizerDefinition();
-
             setup(definition);
             return definition;
         }

diff --git a/...lizers/src/generated/java/org/apache/camel/dsl/yaml/deserializers/ModelDeserializers.java b/...lizers/src/generated/java/org/apache/camel/dsl/yaml/deserializers/ModelDeserializers.java
@@ -8932,6 +8932,7 @@ protected boolean setProperty(LZFDataFormat target, String propertyKey, String p
             types = org.apache.camel.model.tokenizer.LangChain4jCharacterTokenizerDefinition.class,
             order = org.apache.camel.dsl.yaml.common.YamlDeserializerResolver.ORDER_LOWEST - 1,
             displayName = "LangChain4J Tokenizer with character splitter",
+            description = "Camel AI: Tokenizer for splitting by character.",
             deprecated = false,
             properties = {
                     @YamlProperty(name = "id", type = "string", description = "The id of this node", displayName = "Id"),
@@ -8991,6 +8992,7 @@ protected boolean setProperty(LangChain4jCharacterTokenizerDefinition target,
             types = org.apache.camel.model.tokenizer.LangChain4jLineTokenizerDefinition.class,
             order = org.apache.camel.dsl.yaml.common.YamlDeserializerResolver.ORDER_LOWEST - 1,
             displayName = "LangChain4J Tokenizer with line splitter",
+            description = "Camel AI: Tokenizer for splitting line by line.",
             deprecated = false,
             properties = {
                     @YamlProperty(name = "id", type = "string", description = "The id of this node", displayName = "Id"),
@@ -9050,6 +9052,7 @@ protected boolean setProperty(LangChain4jLineTokenizerDefinition target, String
             types = org.apache.camel.model.tokenizer.LangChain4jParagraphTokenizerDefinition.class,
             order = org.apache.camel.dsl.yaml.common.YamlDeserializerResolver.ORDER_LOWEST - 1,
             displayName = "LangChain4J Tokenizer with paragraph splitter",
+            description = "Camel AI: Tokenizer for splitting by paragraphs.",
             deprecated = false,
             properties = {
                     @YamlProperty(name = "id", type = "string", description = "The id of this node", displayName = "Id"),
@@ -9109,6 +9112,7 @@ protected boolean setProperty(LangChain4jParagraphTokenizerDefinition target,
             types = org.apache.camel.model.tokenizer.LangChain4jSentenceTokenizerDefinition.class,
             order = org.apache.camel.dsl.yaml.common.YamlDeserializerResolver.ORDER_LOWEST - 1,
             displayName = "LangChain4J Tokenizer with sentence splitter",
+            description = "Camel AI: Tokenizer for splitting by sentences.",
             deprecated = false,
             properties = {
                     @YamlProperty(name = "id", type = "string", description = "The id of this node", displayName = "Id"),
@@ -9221,6 +9225,7 @@ protected boolean setProperty(LangChain4jTokenizerDefinition target, String prop
             types = org.apache.camel.model.tokenizer.LangChain4jWordTokenizerDefinition.class,
             order = org.apache.camel.dsl.yaml.common.YamlDeserializerResolver.ORDER_LOWEST - 1,
             displayName = "LangChain4J Tokenizer with word splitter",
+            description = "Camel AI: Tokenizer for splitting by word.",
             deprecated = false,
             properties = {
                     @YamlProperty(name = "id", type = "string", description = "The id of this node", displayName = "Id"),

diff --git a/dsl/camel-yaml-dsl/camel-yaml-dsl/src/generated/resources/schema/camelYamlDsl.json b/dsl/camel-yaml-dsl/camel-yaml-dsl/src/generated/resources/schema/camelYamlDsl.json
@@ -15997,6 +15997,7 @@
       },
       "org.apache.camel.model.tokenizer.LangChain4jCharacterTokenizerDefinition" : {
         "title" : "LangChain4J Tokenizer with character splitter",
+        "description" : "Camel AI: Tokenizer for splitting by character.",
         "type" : "object",
         "additionalProperties" : false,
         "properties" : {
@@ -16026,6 +16027,7 @@
       },
       "org.apache.camel.model.tokenizer.LangChain4jLineTokenizerDefinition" : {
         "title" : "LangChain4J Tokenizer with line splitter",
+        "description" : "Camel AI: Tokenizer for splitting line by line.",
         "type" : "object",
         "additionalProperties" : false,
         "properties" : {
@@ -16055,6 +16057,7 @@
       },
       "org.apache.camel.model.tokenizer.LangChain4jParagraphTokenizerDefinition" : {
         "title" : "LangChain4J Tokenizer with paragraph splitter",
+        "description" : "Camel AI: Tokenizer for splitting by paragraphs.",
         "type" : "object",
         "additionalProperties" : false,
         "properties" : {
@@ -16084,6 +16087,7 @@
       },
       "org.apache.camel.model.tokenizer.LangChain4jSentenceTokenizerDefinition" : {
         "title" : "LangChain4J Tokenizer with sentence splitter",
+        "description" : "Camel AI: Tokenizer for splitting by sentences.",
         "type" : "object",
         "additionalProperties" : false,
         "properties" : {
@@ -16133,6 +16137,7 @@
       },
       "org.apache.camel.model.tokenizer.LangChain4jWordTokenizerDefinition" : {
         "title" : "LangChain4J Tokenizer with word splitter",
+        "description" : "Camel AI: Tokenizer for splitting by word.",
         "type" : "object",
         "additionalProperties" : false,
         "properties" : {