This is an automated email from the ASF dual-hosted git repository.
tsato pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
The following commit(s) were added to refs/heads/main by this push:
new d33b68d9bf4 camel-ai - Add Message Headers sections to all AI
component docs
d33b68d9bf4 is described below
commit d33b68d9bf4db5f58ab33f4a038526efa275e43b
Author: Tadayoshi Sato <sato.tadayo...@gmail.com>
AuthorDate: Fri Jul 12 14:37:45 2024 +0900
camel-ai - Add Message Headers sections to all AI component docs
---
.../org/apache/camel/catalog/components/djl.json | 3 ++
.../org/apache/camel/component/djl/djl.json | 3 ++
.../apache/camel/component/djl/DJLEndpoint.java | 2 +-
.../src/main/docs/langchain4j-chat-component.adoc | 4 +++
.../docs/langchain4j-embeddings-component.adoc | 4 +++
.../src/main/docs/milvus-component.adoc | 4 +++
.../src/main/docs/pinecone-component.adoc | 4 +++
.../endpoint/dsl/DJLEndpointBuilderFactory.java | 37 ++++++++++++++++++++++
8 files changed, 60 insertions(+), 1 deletion(-)
diff --git
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/djl.json
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/djl.json
index 47235846b2a..c3d8b92e989 100644
---
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/djl.json
+++
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/djl.json
@@ -26,6 +26,9 @@
"lazyStartProducer": { "index": 0, "kind": "property", "displayName":
"Lazy Start Producer", "group": "producer", "label": "producer", "required":
false, "type": "boolean", "javaType": "boolean", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": false, "description":
"Whether the producer should be started lazy (on the first message). By
starting lazy you can use this to allow CamelContext and routes to startup in
situations where a producer may otherwise fail [...]
"autowiredEnabled": { "index": 1, "kind": "property", "displayName":
"Autowired Enabled", "group": "advanced", "label": "advanced", "required":
false, "type": "boolean", "javaType": "boolean", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": true, "description":
"Whether autowiring is enabled. This is used for automatic autowiring options
(the option must be marked as autowired) by looking up in the registry to find
if there is a single instance of matching t [...]
},
+ "headers": {
+ "CamelDjlInput": { "index": 0, "kind": "header", "displayName": "",
"group": "producer", "label": "", "required": false, "javaType": "",
"deprecated": false, "deprecationNote": "", "autowired": false, "secret":
false, "description": "The input data used for prediction", "constantName":
"org.apache.camel.component.djl.DJLConstants#INPUT" }
+ },
"properties": {
"application": { "index": 0, "kind": "path", "displayName": "Application",
"group": "producer", "label": "", "required": true, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "deprecationNote": "",
"autowired": false, "secret": false, "description": "Application name" },
"artifactId": { "index": 1, "kind": "parameter", "displayName": "Artifact
Id", "group": "producer", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "Model Artifact" },
diff --git
a/components/camel-ai/camel-djl/src/generated/resources/META-INF/org/apache/camel/component/djl/djl.json
b/components/camel-ai/camel-djl/src/generated/resources/META-INF/org/apache/camel/component/djl/djl.json
index 47235846b2a..c3d8b92e989 100644
---
a/components/camel-ai/camel-djl/src/generated/resources/META-INF/org/apache/camel/component/djl/djl.json
+++
b/components/camel-ai/camel-djl/src/generated/resources/META-INF/org/apache/camel/component/djl/djl.json
@@ -26,6 +26,9 @@
"lazyStartProducer": { "index": 0, "kind": "property", "displayName":
"Lazy Start Producer", "group": "producer", "label": "producer", "required":
false, "type": "boolean", "javaType": "boolean", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": false, "description":
"Whether the producer should be started lazy (on the first message). By
starting lazy you can use this to allow CamelContext and routes to startup in
situations where a producer may otherwise fail [...]
"autowiredEnabled": { "index": 1, "kind": "property", "displayName":
"Autowired Enabled", "group": "advanced", "label": "advanced", "required":
false, "type": "boolean", "javaType": "boolean", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": true, "description":
"Whether autowiring is enabled. This is used for automatic autowiring options
(the option must be marked as autowired) by looking up in the registry to find
if there is a single instance of matching t [...]
},
+ "headers": {
+ "CamelDjlInput": { "index": 0, "kind": "header", "displayName": "",
"group": "producer", "label": "", "required": false, "javaType": "",
"deprecated": false, "deprecationNote": "", "autowired": false, "secret":
false, "description": "The input data used for prediction", "constantName":
"org.apache.camel.component.djl.DJLConstants#INPUT" }
+ },
"properties": {
"application": { "index": 0, "kind": "path", "displayName": "Application",
"group": "producer", "label": "", "required": true, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "deprecationNote": "",
"autowired": false, "secret": false, "description": "Application name" },
"artifactId": { "index": 1, "kind": "parameter", "displayName": "Artifact
Id", "group": "producer", "label": "", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "Model Artifact" },
diff --git
a/components/camel-ai/camel-djl/src/main/java/org/apache/camel/component/djl/DJLEndpoint.java
b/components/camel-ai/camel-djl/src/main/java/org/apache/camel/component/djl/DJLEndpoint.java
index 7e69a172a91..4f20b84579c 100644
---
a/components/camel-ai/camel-djl/src/main/java/org/apache/camel/component/djl/DJLEndpoint.java
+++
b/components/camel-ai/camel-djl/src/main/java/org/apache/camel/component/djl/DJLEndpoint.java
@@ -30,7 +30,7 @@ import org.apache.camel.support.DefaultEndpoint;
* Infer Deep Learning models from message exchanges data using Deep Java
Library (DJL).
*/
@UriEndpoint(firstVersion = "3.3.0", scheme = "djl", title = "Deep Java
Library", syntax = "djl:application",
- remote = false, category = { Category.AI }, producerOnly = true)
+ remote = false, category = { Category.AI }, producerOnly = true,
headersClass = DJLConstants.class)
public class DJLEndpoint extends DefaultEndpoint {
@UriPath
diff --git
a/components/camel-ai/camel-langchain4j-chat/src/main/docs/langchain4j-chat-component.adoc
b/components/camel-ai/camel-langchain4j-chat/src/main/docs/langchain4j-chat-component.adoc
index 7ee743e5329..ae2d1649ab9 100644
---
a/components/camel-ai/camel-langchain4j-chat/src/main/docs/langchain4j-chat-component.adoc
+++
b/components/camel-ai/camel-langchain4j-chat/src/main/docs/langchain4j-chat-component.adoc
@@ -53,6 +53,10 @@ include::partial$component-endpoint-options.adoc[]
// endpoint options: END
+// component headers: START
+include::partial$component-endpoint-headers.adoc[]
+// component headers: END
+
include::spring-boot:partial$starter.adoc[]
== Using a specific Chat Model
diff --git
a/components/camel-ai/camel-langchain4j-embeddings/src/main/docs/langchain4j-embeddings-component.adoc
b/components/camel-ai/camel-langchain4j-embeddings/src/main/docs/langchain4j-embeddings-component.adoc
index ab9cae0e2d9..924a6b13f49 100644
---
a/components/camel-ai/camel-langchain4j-embeddings/src/main/docs/langchain4j-embeddings-component.adoc
+++
b/components/camel-ai/camel-langchain4j-embeddings/src/main/docs/langchain4j-embeddings-component.adoc
@@ -40,4 +40,8 @@ include::partial$component-endpoint-options.adoc[]
// endpoint options: END
+// component headers: START
+include::partial$component-endpoint-headers.adoc[]
+// component headers: END
+
include::spring-boot:partial$starter.adoc[]
diff --git
a/components/camel-ai/camel-milvus/src/main/docs/milvus-component.adoc
b/components/camel-ai/camel-milvus/src/main/docs/milvus-component.adoc
index 7706e326b99..4edfeb8a948 100644
--- a/components/camel-ai/camel-milvus/src/main/docs/milvus-component.adoc
+++ b/components/camel-ai/camel-milvus/src/main/docs/milvus-component.adoc
@@ -40,6 +40,10 @@ include::partial$component-endpoint-options.adoc[]
// endpoint options: END
+// component headers: START
+include::partial$component-endpoint-headers.adoc[]
+// component headers: END
+
== Collection Samples
In the route below, we use the milvus component to create a collection named
_test_ with the given parameters:
diff --git
a/components/camel-ai/camel-pinecone/src/main/docs/pinecone-component.adoc
b/components/camel-ai/camel-pinecone/src/main/docs/pinecone-component.adoc
index 41f53233e38..1c69d99010e 100644
--- a/components/camel-ai/camel-pinecone/src/main/docs/pinecone-component.adoc
+++ b/components/camel-ai/camel-pinecone/src/main/docs/pinecone-component.adoc
@@ -40,5 +40,9 @@ include::partial$component-endpoint-options.adoc[]
// endpoint options: END
+// component headers: START
+include::partial$component-endpoint-headers.adoc[]
+// component headers: END
+
include::spring-boot:partial$starter.adoc[]
diff --git
a/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/DJLEndpointBuilderFactory.java
b/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/DJLEndpointBuilderFactory.java
index c91ea2bb376..032c1bee54a 100644
---
a/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/DJLEndpointBuilderFactory.java
+++
b/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/DJLEndpointBuilderFactory.java
@@ -148,6 +148,20 @@ public interface DJLEndpointBuilderFactory {
}
public interface DJLBuilders {
+ /**
+ * Deep Java Library (camel-djl)
+ * Infer Deep Learning models from message exchanges data using Deep
+ * Java Library (DJL).
+ *
+ * Category: ai
+ * Since: 3.3
+ * Maven coordinates: org.apache.camel:camel-djl
+ *
+ * @return the dsl builder for the headers' name.
+ */
+ default DJLHeaderNameBuilder djl() {
+ return DJLHeaderNameBuilder.INSTANCE;
+ }
/**
* Deep Java Library (camel-djl)
* Infer Deep Learning models from message exchanges data using Deep
@@ -192,6 +206,29 @@ public interface DJLEndpointBuilderFactory {
}
}
+ /**
+ * The builder of headers' name for the Deep Java Library component.
+ */
+ public static class DJLHeaderNameBuilder {
+ /**
+ * The internal instance of the builder used to access to all the
+ * methods representing the name of headers.
+ */
+ private static final DJLHeaderNameBuilder INSTANCE = new
DJLHeaderNameBuilder();
+
+ /**
+ * The input data used for prediction.
+ *
+ * The option is a: {@code } type.
+ *
+ * Group: producer
+ *
+ * @return the name of the header {@code DjlInput}.
+ */
+ public String djlInput() {
+ return "CamelDjlInput";
+ }
+ }
static DJLEndpointBuilder endpointBuilder(String componentName, String
path) {
class DJLEndpointBuilderImpl extends AbstractEndpointBuilder
implements DJLEndpointBuilder, AdvancedDJLEndpointBuilder {
public DJLEndpointBuilderImpl(String path) {
