This is an automated email from the ASF dual-hosted git repository. Croway pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/camel-spring-boot.git
commit ad7331b5addd42f642e3697399351cf62d575380 Author: croway <[email protected]> AuthorDate: Tue Sep 15 13:43:14 2026 +0200 Add camel-langchain4j-ingest-starter camel-langchain4j-ingest splits, embeds and stores documents into a LangChain4j EmbeddingStore but never got a Spring Boot starter. Generate it with starter-create and regenerate the docs, catalog and dependencies BOM entries. Add a smoke test verifying camel.component.langchain4j-ingest.* Spring Boot properties are copied onto the component's nested LangChain4jIngestConfiguration. Co-Authored-By: Claude Sonnet 5 <[email protected]> --- .../camel/springboot/catalog/components.properties | 1 + .../catalog/components/langchain4j-ingest.json | 56 +++++ .../camel-langchain4j-ingest-starter/pom.xml | 48 ++++ .../src/main/docs/langchain4j-ingest.json | 111 ++++++++++ ...angChain4jIngestComponentAutoConfiguration.java | 74 +++++++ .../LangChain4jIngestComponentConfiguration.java | 244 +++++++++++++++++++++ .../LangChain4jIngestComponentConverter.java | 57 +++++ .../src/main/resources/META-INF/LICENSE.txt | 203 +++++++++++++++++ .../src/main/resources/META-INF/NOTICE.txt | 11 + ...rk.boot.autoconfigure.AutoConfiguration.imports | 18 ++ ...hain4jIngestComponentAutoConfigurationTest.java | 57 +++++ components-starter/pom.xml | 1 + docs/spring-boot/modules/ROOT/nav.adoc | 1 + .../ROOT/pages/starters/langchain4j-ingest.adoc | 44 ++++ tooling/camel-spring-boot-dependencies/pom.xml | 5 + 15 files changed, 931 insertions(+) diff --git a/catalog/camel-catalog-provider-springboot/src/main/resources/org/apache/camel/springboot/catalog/components.properties b/catalog/camel-catalog-provider-springboot/src/main/resources/org/apache/camel/springboot/catalog/components.properties index daaa1e4740c..003c235048d 100644 --- a/catalog/camel-catalog-provider-springboot/src/main/resources/org/apache/camel/springboot/catalog/components.properties +++ b/catalog/camel-catalog-provider-springboot/src/main/resources/org/apache/camel/springboot/catalog/components.properties @@ -249,6 +249,7 @@ langchain4j-agent langchain4j-chat langchain4j-embeddings langchain4j-embeddingstore +langchain4j-ingest langchain4j-web-search language ldap diff --git a/catalog/camel-catalog-provider-springboot/src/main/resources/org/apache/camel/springboot/catalog/components/langchain4j-ingest.json b/catalog/camel-catalog-provider-springboot/src/main/resources/org/apache/camel/springboot/catalog/components/langchain4j-ingest.json new file mode 100644 index 00000000000..3c1a0899252 --- /dev/null +++ b/catalog/camel-catalog-provider-springboot/src/main/resources/org/apache/camel/springboot/catalog/components/langchain4j-ingest.json @@ -0,0 +1,56 @@ +{ + "component": { + "kind": "component", + "name": "langchain4j-ingest", + "title": "LangChain4j Ingest", + "description": "Ingest documents into a LangChain4j EmbeddingStore: split, embed and store the message body.", + "deprecated": false, + "firstVersion": "4.23.0", + "label": "ai", + "javaType": "org.apache.camel.component.langchain4j.ingest.LangChain4jIngestComponent", + "supportLevel": "Preview", + "groupId": "org.apache.camel.springboot", + "artifactId": "camel-langchain4j-ingest-starter", + "version": "4.23.0-SNAPSHOT", + "scheme": "langchain4j-ingest", + "extendsScheme": "", + "syntax": "langchain4j-ingest:pipelineName", + "async": false, + "api": false, + "consumerOnly": false, + "producerOnly": true, + "lenientProperties": false, + "browsable": false, + "remote": true + }, + "componentProperties": { + "configuration": { "index": 0, "kind": "property", "displayName": "Configuration", "group": "producer", "label": "", "required": false, "type": "object", "javaType": "org.apache.camel.component.langchain4j.ingest.LangChain4jIngestConfiguration", "deprecated": false, "autowired": false, "secret": false, "description": "The configuration." }, + "documentIdHeader": { "index": 1, "kind": "property", "displayName": "Document Id Header", "group": "producer", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "CamelLangChain4jIngestDocumentId", "configurationClass": "org.apache.camel.component.langchain4j.ingest.LangChain4jIngestConfiguration", "configurationField": "configuration", "description": "Name of the header carrying [...] + "embeddingBatchSize": { "index": 2, "kind": "property", "displayName": "Embedding Batch Size", "group": "producer", "label": "", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 32, "configurationClass": "org.apache.camel.component.langchain4j.ingest.LangChain4jIngestConfiguration", "configurationField": "configuration", "description": "How many segments are embedded per request to the embedding model. [...] + "embeddingModel": { "index": 3, "kind": "property", "displayName": "Embedding Model", "group": "producer", "label": "", "required": false, "type": "object", "javaType": "dev.langchain4j.model.embedding.EmbeddingModel", "deprecated": false, "deprecationNote": "", "autowired": true, "secret": false, "configurationClass": "org.apache.camel.component.langchain4j.ingest.LangChain4jIngestConfiguration", "configurationField": "configuration", "description": "The EmbeddingModel to embed segm [...] + "embeddingStore": { "index": 4, "kind": "property", "displayName": "Embedding Store", "group": "producer", "label": "", "required": false, "type": "object", "javaType": "dev.langchain4j.store.embedding.EmbeddingStore<dev.langchain4j.data.segment.TextSegment>", "deprecated": false, "deprecationNote": "", "autowired": true, "secret": false, "configurationClass": "org.apache.camel.component.langchain4j.ingest.LangChain4jIngestConfiguration", "configurationField": "configuration", "descr [...] + "lazyStartProducer": { "index": 5, "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 [...] + "maxOverlapSize": { "index": 6, "kind": "property", "displayName": "Max Overlap Size", "group": "producer", "label": "", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 50, "configurationClass": "org.apache.camel.component.langchain4j.ingest.LangChain4jIngestConfiguration", "configurationField": "configuration", "description": "How much of the previous segment each segment repeats, in characters. Overl [...] + "maxSegmentSize": { "index": 7, "kind": "property", "displayName": "Max Segment Size", "group": "producer", "label": "", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 500, "configurationClass": "org.apache.camel.component.langchain4j.ingest.LangChain4jIngestConfiguration", "configurationField": "configuration", "description": "Maximum size of one segment, in characters." }, + "autowiredEnabled": { "index": 8, "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 [...] + "documentSplitter": { "index": 9, "kind": "property", "displayName": "Document Splitter", "group": "advanced", "label": "advanced", "required": false, "type": "object", "javaType": "dev.langchain4j.data.document.DocumentSplitter", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.langchain4j.ingest.LangChain4jIngestConfiguration", "configurationField": "configuration", "description": "The DocumentSplitter deciding how a docume [...] + "idempotentRepository": { "index": 10, "kind": "property", "displayName": "Idempotent Repository", "group": "advanced", "label": "advanced", "required": false, "type": "object", "javaType": "org.apache.camel.spi.IdempotentRepository", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.langchain4j.ingest.LangChain4jIngestConfiguration", "configurationField": "configuration", "description": "The IdempotentRepository remembering a [...] + "maxDocumentSize": { "index": 11, "kind": "property", "displayName": "Max Document Size", "group": "advanced", "label": "advanced", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 0, "configurationClass": "org.apache.camel.component.langchain4j.ingest.LangChain4jIngestConfiguration", "configurationField": "configuration", "description": "Maximum size of one document in characters, applied to the text a [...] + }, + "headers": { + "CamelLangChain4jIngestDocumentId": { "index": 0, "kind": "header", "displayName": "", "group": "producer", "label": "", "required": false, "javaType": "String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The stable document id of the ingested payload, read when the documentIdHeader endpoint option does not name another header. The CamelLangChain4jIngestDocumentId exchange property, when set, takes precedence over any header.", "c [...] + }, + "properties": { + "pipelineName": { "index": 0, "kind": "path", "displayName": "Pipeline Name", "group": "producer", "label": "", "required": true, "type": "string", "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The pipeline name, stamped on every written segment as the camel_ingest_pipeline metadata and used in error messages" }, + "documentIdHeader": { "index": 1, "kind": "parameter", "displayName": "Document Id Header", "group": "producer", "label": "", "required": false, "type": "string", "javaType": "java.lang.String", "deprecated": false, "autowired": false, "secret": false, "defaultValue": "CamelLangChain4jIngestDocumentId", "configurationClass": "org.apache.camel.component.langchain4j.ingest.LangChain4jIngestConfiguration", "configurationField": "configuration", "description": "Name of the header carryin [...] + "embeddingBatchSize": { "index": 2, "kind": "parameter", "displayName": "Embedding Batch Size", "group": "producer", "label": "", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 32, "configurationClass": "org.apache.camel.component.langchain4j.ingest.LangChain4jIngestConfiguration", "configurationField": "configuration", "description": "How many segments are embedded per request to the embedding model. [...] + "embeddingModel": { "index": 3, "kind": "parameter", "displayName": "Embedding Model", "group": "producer", "label": "", "required": false, "type": "object", "javaType": "dev.langchain4j.model.embedding.EmbeddingModel", "deprecated": false, "deprecationNote": "", "autowired": true, "secret": false, "configurationClass": "org.apache.camel.component.langchain4j.ingest.LangChain4jIngestConfiguration", "configurationField": "configuration", "description": "The EmbeddingModel to embed seg [...] + "embeddingStore": { "index": 4, "kind": "parameter", "displayName": "Embedding Store", "group": "producer", "label": "", "required": false, "type": "object", "javaType": "dev.langchain4j.store.embedding.EmbeddingStore<dev.langchain4j.data.segment.TextSegment>", "deprecated": false, "deprecationNote": "", "autowired": true, "secret": false, "configurationClass": "org.apache.camel.component.langchain4j.ingest.LangChain4jIngestConfiguration", "configurationField": "configuration", "desc [...] + "maxOverlapSize": { "index": 5, "kind": "parameter", "displayName": "Max Overlap Size", "group": "producer", "label": "", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 50, "configurationClass": "org.apache.camel.component.langchain4j.ingest.LangChain4jIngestConfiguration", "configurationField": "configuration", "description": "How much of the previous segment each segment repeats, in characters. Over [...] + "maxSegmentSize": { "index": 6, "kind": "parameter", "displayName": "Max Segment Size", "group": "producer", "label": "", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 500, "configurationClass": "org.apache.camel.component.langchain4j.ingest.LangChain4jIngestConfiguration", "configurationField": "configuration", "description": "Maximum size of one segment, in characters." }, + "lazyStartProducer": { "index": 7, "kind": "parameter", "displayName": "Lazy Start Producer", "group": "producer (advanced)", "label": "producer,advanced", "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 produc [...] + "documentSplitter": { "index": 8, "kind": "parameter", "displayName": "Document Splitter", "group": "advanced", "label": "advanced", "required": false, "type": "object", "javaType": "dev.langchain4j.data.document.DocumentSplitter", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.langchain4j.ingest.LangChain4jIngestConfiguration", "configurationField": "configuration", "description": "The DocumentSplitter deciding how a docum [...] + "idempotentRepository": { "index": 9, "kind": "parameter", "displayName": "Idempotent Repository", "group": "advanced", "label": "advanced", "required": false, "type": "object", "javaType": "org.apache.camel.spi.IdempotentRepository", "deprecated": false, "autowired": false, "secret": false, "configurationClass": "org.apache.camel.component.langchain4j.ingest.LangChain4jIngestConfiguration", "configurationField": "configuration", "description": "The IdempotentRepository remembering a [...] + "maxDocumentSize": { "index": 10, "kind": "parameter", "displayName": "Max Document Size", "group": "advanced", "label": "advanced", "required": false, "type": "integer", "javaType": "int", "deprecated": false, "autowired": false, "secret": false, "defaultValue": 0, "configurationClass": "org.apache.camel.component.langchain4j.ingest.LangChain4jIngestConfiguration", "configurationField": "configuration", "description": "Maximum size of one document in characters, applied to the text [...] + } +} diff --git a/components-starter/camel-langchain4j-ingest-starter/pom.xml b/components-starter/camel-langchain4j-ingest-starter/pom.xml new file mode 100644 index 00000000000..36eb327528f --- /dev/null +++ b/components-starter/camel-langchain4j-ingest-starter/pom.xml @@ -0,0 +1,48 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + +--> +<project xmlns="http://maven.apache.org/POM/4.0.0"; xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd";> + <modelVersion>4.0.0</modelVersion> + <parent> + <groupId>org.apache.camel.springboot</groupId> + <artifactId>components-starter</artifactId> + <version>4.23.0-SNAPSHOT</version> + </parent> + <artifactId>camel-langchain4j-ingest-starter</artifactId> + <packaging>jar</packaging> + <name>Camel SB Starters :: langchain4j-ingest</name> + <dependencies> + <dependency> + <groupId>org.springframework.boot</groupId> + <artifactId>spring-boot-starter</artifactId> + <version>${spring-boot-version}</version> + </dependency> + <dependency> + <groupId>org.apache.camel</groupId> + <artifactId>camel-langchain4j-ingest</artifactId> + <version>${camel-version}</version> + </dependency> + <!--START OF GENERATED CODE--> + <dependency> + <groupId>org.apache.camel.springboot</groupId> + <artifactId>camel-core-starter</artifactId> + </dependency> + <!--END OF GENERATED CODE--> + </dependencies> +</project> diff --git a/components-starter/camel-langchain4j-ingest-starter/src/main/docs/langchain4j-ingest.json b/components-starter/camel-langchain4j-ingest-starter/src/main/docs/langchain4j-ingest.json new file mode 100644 index 00000000000..0ea26ff7750 --- /dev/null +++ b/components-starter/camel-langchain4j-ingest-starter/src/main/docs/langchain4j-ingest.json @@ -0,0 +1,111 @@ +{ + "groups": [ + { + "name": "camel.component.langchain4j-ingest", + "type": "org.apache.camel.component.langchain4j.ingest.springboot.LangChain4jIngestComponentConfiguration", + "sourceType": "org.apache.camel.component.langchain4j.ingest.springboot.LangChain4jIngestComponentConfiguration" + }, + { + "name": "camel.component.langchain4j-ingest.customizer", + "type": "org.apache.camel.spring.boot.ComponentConfigurationPropertiesCommon$CustomizerProperties", + "sourceType": "org.apache.camel.component.langchain4j.ingest.springboot.LangChain4jIngestComponentConfiguration", + "sourceMethod": "getCustomizer()" + } + ], + "properties": [ + { + "name": "camel.component.langchain4j-ingest.autowired-enabled", + "type": "java.lang.Boolean", + "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 type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.", + "sourceType": "org.apache.camel.component.langchain4j.ingest.springboot.LangChain4jIngestComponentConfiguration", + "defaultValue": true + }, + { + "name": "camel.component.langchain4j-ingest.configuration", + "type": "org.apache.camel.component.langchain4j.ingest.LangChain4jIngestConfiguration", + "description": "The configuration. The option is a org.apache.camel.component.langchain4j.ingest.LangChain4jIngestConfiguration type.", + "sourceType": "org.apache.camel.component.langchain4j.ingest.springboot.LangChain4jIngestComponentConfiguration" + }, + { + "name": "camel.component.langchain4j-ingest.customizer.enabled", + "type": "java.lang.Boolean", + "sourceType": "org.apache.camel.spring.boot.ComponentConfigurationPropertiesCommon$CustomizerProperties" + }, + { + "name": "camel.component.langchain4j-ingest.document-id-header", + "type": "java.lang.String", + "description": "Name of the header carrying the document id, such as CamelAwsS3Key for an S3 consumer or CamelKafkaKey for a Kafka one. The CamelLangChain4jIngestDocumentId exchange property, when set, takes precedence - a route that parses documents captures the id into that property before the parse, so a document cannot forge its own identity. An exchange without an id fails.", + "sourceType": "org.apache.camel.component.langchain4j.ingest.springboot.LangChain4jIngestComponentConfiguration", + "defaultValue": "CamelLangChain4jIngestDocumentId" + }, + { + "name": "camel.component.langchain4j-ingest.document-splitter", + "type": "dev.langchain4j.data.document.DocumentSplitter", + "description": "The DocumentSplitter deciding how a document becomes segments, referenced as #bean:name - LangChain4j ships alternatives beside the default recursive one. When set, maxSegmentSize and maxOverlapSize are ignored (they parameterize the default splitter only). Segments returned without the identity metadata are re-stamped, so a custom splitter cannot break citation. Not looked up by type on purpose - an application may hold unrelated splitters. The option is a dev.lang [...] + "sourceType": "org.apache.camel.component.langchain4j.ingest.springboot.LangChain4jIngestComponentConfiguration" + }, + { + "name": "camel.component.langchain4j-ingest.embedding-batch-size", + "type": "java.lang.Integer", + "description": "How many segments are embedded per request to the embedding model. Providers with generous per-request limits ingest large documents faster with a bigger batch; a batch carries at most embeddingBatchSize x maxSegmentSize characters, so tune the two together against the provider's token limits.", + "sourceType": "org.apache.camel.component.langchain4j.ingest.springboot.LangChain4jIngestComponentConfiguration", + "defaultValue": 32 + }, + { + "name": "camel.component.langchain4j-ingest.embedding-model", + "type": "dev.langchain4j.model.embedding.EmbeddingModel", + "description": "The EmbeddingModel to embed segments with. When not set, the single bean of that type in the registry is used; zero or several beans fail the endpoint start with an error naming this option. The option is a dev.langchain4j.model.embedding.EmbeddingModel type.", + "sourceType": "org.apache.camel.component.langchain4j.ingest.springboot.LangChain4jIngestComponentConfiguration" + }, + { + "name": "camel.component.langchain4j-ingest.embedding-store", + "type": "dev.langchain4j.store.embedding.EmbeddingStore<dev.langchain4j.data.segment.TextSegment>", + "description": "The EmbeddingStore to write segments to. When not set, the single bean of that type in the registry is used; zero or several beans fail the endpoint start with an error naming this option. The option is a dev.langchain4j.store.embedding.EmbeddingStore<dev.langchain4j.data.segment.TextSegment> type.", + "sourceType": "org.apache.camel.component.langchain4j.ingest.springboot.LangChain4jIngestComponentConfiguration" + }, + { + "name": "camel.component.langchain4j-ingest.enabled", + "type": "java.lang.Boolean", + "description": "Whether to enable auto configuration of the langchain4j-ingest component. This is enabled by default.", + "sourceType": "org.apache.camel.component.langchain4j.ingest.springboot.LangChain4jIngestComponentConfiguration" + }, + { + "name": "camel.component.langchain4j-ingest.idempotent-repository", + "type": "org.apache.camel.spi.IdempotentRepository", + "description": "The IdempotentRepository remembering already ingested document ids, referenced as #bean:name. When set, a delivery whose id was already written is answered with a skipped result instead of being re-ingested: first write wins per id. A blank document releases its claim, so a later, populated delivery under the same id still ingests. The claim is eager: a duplicate racing an in-flight first delivery is answered skipped even if that delivery then fails - with an at-lea [...] + "sourceType": "org.apache.camel.component.langchain4j.ingest.springboot.LangChain4jIngestComponentConfiguration" + }, + { + "name": "camel.component.langchain4j-ingest.lazy-start-producer", + "type": "java.lang.Boolean", + "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 during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the [...] + "sourceType": "org.apache.camel.component.langchain4j.ingest.springboot.LangChain4jIngestComponentConfiguration", + "defaultValue": false + }, + { + "name": "camel.component.langchain4j-ingest.max-document-size", + "type": "java.lang.Integer", + "description": "Maximum size of one document in characters, applied to the text about to be split; 0, the default, means no limit. The pipeline holds a document in memory whole, so the cap is the protection against oversized - on a consumer-fed pipeline, attacker-sized - payloads. An oversized document fails the exchange cleanly and, with a repository configured, releases its dedup claim.", + "sourceType": "org.apache.camel.component.langchain4j.ingest.springboot.LangChain4jIngestComponentConfiguration", + "defaultValue": 0 + }, + { + "name": "camel.component.langchain4j-ingest.max-overlap-size", + "type": "java.lang.Integer", + "description": "How much of the previous segment each segment repeats, in characters. Overlap keeps a sentence split across a boundary retrievable from either side.", + "sourceType": "org.apache.camel.component.langchain4j.ingest.springboot.LangChain4jIngestComponentConfiguration", + "defaultValue": 50 + }, + { + "name": "camel.component.langchain4j-ingest.max-segment-size", + "type": "java.lang.Integer", + "description": "Maximum size of one segment, in characters.", + "sourceType": "org.apache.camel.component.langchain4j.ingest.springboot.LangChain4jIngestComponentConfiguration", + "defaultValue": 500 + } + ], + "hints": [], + "ignored": { + "properties": [] + } +} \ No newline at end of file diff --git a/components-starter/camel-langchain4j-ingest-starter/src/main/java/org/apache/camel/component/langchain4j/ingest/springboot/LangChain4jIngestComponentAutoConfiguration.java b/components-starter/camel-langchain4j-ingest-starter/src/main/java/org/apache/camel/component/langchain4j/ingest/springboot/LangChain4jIngestComponentAutoConfiguration.java new file mode 100644 index 00000000000..8a7268c7d2b --- /dev/null +++ b/components-starter/camel-langchain4j-ingest-starter/src/main/java/org/apache/camel/component/langchain4j/ingest/springboot/LangChain4jIngestComponentAutoConfiguration.java @@ -0,0 +1,74 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.camel.component.langchain4j.ingest.springboot; + +import org.apache.camel.CamelContext; +import org.apache.camel.Component; +import org.apache.camel.component.langchain4j.ingest.LangChain4jIngestComponent; +import org.apache.camel.spi.ComponentCustomizer; +import org.apache.camel.spring.boot.CamelAutoConfiguration; +import org.apache.camel.spring.boot.ComponentConfigurationProperties; +import org.apache.camel.spring.boot.util.CamelPropertiesHelper; +import org.apache.camel.spring.boot.util.ConditionalOnCamelContextAndAutoConfigurationBeans; +import org.apache.camel.spring.boot.util.ConditionalOnHierarchicalProperties; +import org.apache.camel.spring.boot.util.HierarchicalPropertiesEvaluator; +import org.springframework.boot.autoconfigure.AutoConfiguration; +import org.springframework.boot.context.properties.EnableConfigurationProperties; +import org.springframework.context.ApplicationContext; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Conditional; +import org.springframework.context.annotation.Lazy; + +/** + * Generated by camel-package-maven-plugin - do not edit this file! + */ +@AutoConfiguration(after = {CamelAutoConfiguration.class, LangChain4jIngestComponentConverter.class}) +@Conditional(ConditionalOnCamelContextAndAutoConfigurationBeans.class) +@EnableConfigurationProperties({ComponentConfigurationProperties.class,LangChain4jIngestComponentConfiguration.class}) +@ConditionalOnHierarchicalProperties({"camel.component", "camel.component.langchain4j-ingest"}) +public class LangChain4jIngestComponentAutoConfiguration { + + private final ApplicationContext applicationContext; + private final LangChain4jIngestComponentConfiguration configuration; + + public LangChain4jIngestComponentAutoConfiguration( + org.springframework.context.ApplicationContext applicationContext, + org.apache.camel.component.langchain4j.ingest.springboot.LangChain4jIngestComponentConfiguration configuration) { + this.applicationContext = applicationContext; + this.configuration = configuration; + } + + @Lazy + @Bean + public ComponentCustomizer configureLangChain4jIngestComponent() { + return new ComponentCustomizer() { + @Override + public void configure(String name, Component target) { + CamelPropertiesHelper.copyConfigurationProperties(target.getCamelContext(), applicationContext, + "camel.component.langchain4j-ingest", configuration, target); + } + @Override + public boolean isEnabled(String name, Component target) { + return HierarchicalPropertiesEvaluator.evaluate( + applicationContext, + "camel.component.customizer", + "camel.component.langchain4j-ingest.customizer") + && target instanceof LangChain4jIngestComponent; + } + }; + } +} \ No newline at end of file diff --git a/components-starter/camel-langchain4j-ingest-starter/src/main/java/org/apache/camel/component/langchain4j/ingest/springboot/LangChain4jIngestComponentConfiguration.java b/components-starter/camel-langchain4j-ingest-starter/src/main/java/org/apache/camel/component/langchain4j/ingest/springboot/LangChain4jIngestComponentConfiguration.java new file mode 100644 index 00000000000..346d160dc00 --- /dev/null +++ b/components-starter/camel-langchain4j-ingest-starter/src/main/java/org/apache/camel/component/langchain4j/ingest/springboot/LangChain4jIngestComponentConfiguration.java @@ -0,0 +1,244 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.camel.component.langchain4j.ingest.springboot; + +import dev.langchain4j.data.document.DocumentSplitter; +import dev.langchain4j.data.segment.TextSegment; +import dev.langchain4j.model.embedding.EmbeddingModel; +import dev.langchain4j.store.embedding.EmbeddingStore; +import org.apache.camel.component.langchain4j.ingest.LangChain4jIngestConfiguration; +import org.apache.camel.spi.IdempotentRepository; +import org.apache.camel.spring.boot.ComponentConfigurationPropertiesCommon; +import org.springframework.boot.context.properties.ConfigurationProperties; + +/** + * Ingest documents into a LangChain4j EmbeddingStore: split, embed and store + * the message body. + * + * Generated by camel-package-maven-plugin - do not edit this file! + */ +@ConfigurationProperties(prefix = "camel.component.langchain4j-ingest") +public class LangChain4jIngestComponentConfiguration + extends + ComponentConfigurationPropertiesCommon { + + /** + * Whether to enable auto configuration of the langchain4j-ingest component. + * This is enabled by default. + */ + private Boolean enabled; + /** + * The configuration. The option is a + * org.apache.camel.component.langchain4j.ingest.LangChain4jIngestConfiguration type. + */ + private LangChain4jIngestConfiguration configuration; + /** + * Name of the header carrying the document id, such as CamelAwsS3Key for an + * S3 consumer or CamelKafkaKey for a Kafka one. The + * CamelLangChain4jIngestDocumentId exchange property, when set, takes + * precedence - a route that parses documents captures the id into that + * property before the parse, so a document cannot forge its own identity. + * An exchange without an id fails. + */ + private String documentIdHeader = "CamelLangChain4jIngestDocumentId"; + /** + * How many segments are embedded per request to the embedding model. + * Providers with generous per-request limits ingest large documents faster + * with a bigger batch; a batch carries at most embeddingBatchSize x + * maxSegmentSize characters, so tune the two together against the + * provider's token limits. + */ + private Integer embeddingBatchSize = 32; + /** + * The EmbeddingModel to embed segments with. When not set, the single bean + * of that type in the registry is used; zero or several beans fail the + * endpoint start with an error naming this option. The option is a + * dev.langchain4j.model.embedding.EmbeddingModel type. + */ + private EmbeddingModel embeddingModel; + /** + * The EmbeddingStore to write segments to. When not set, the single bean of + * that type in the registry is used; zero or several beans fail the + * endpoint start with an error naming this option. The option is a + * dev.langchain4j.store.embedding.EmbeddingStore<dev.langchain4j.data.segment.TextSegment> type. + */ + private EmbeddingStore<TextSegment> embeddingStore; + /** + * 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 during starting + * and cause the route to fail being started. By deferring this startup to + * be lazy then the startup failure can be handled during routing messages + * via Camel's routing error handlers. Beware that when the first message is + * processed then creating and starting the producer may take a little time + * and prolong the total processing time of the processing. + */ + private Boolean lazyStartProducer = false; + /** + * How much of the previous segment each segment repeats, in characters. + * Overlap keeps a sentence split across a boundary retrievable from either + * side. + */ + private Integer maxOverlapSize = 50; + /** + * Maximum size of one segment, in characters. + */ + private Integer maxSegmentSize = 500; + /** + * 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 type, which + * then gets configured on the component. This can be used for automatic + * configuring JDBC data sources, JMS connection factories, AWS Clients, + * etc. + */ + private Boolean autowiredEnabled = true; + /** + * The DocumentSplitter deciding how a document becomes segments, referenced + * as #bean:name - LangChain4j ships alternatives beside the default + * recursive one. When set, maxSegmentSize and maxOverlapSize are ignored + * (they parameterize the default splitter only). Segments returned without + * the identity metadata are re-stamped, so a custom splitter cannot break + * citation. Not looked up by type on purpose - an application may hold + * unrelated splitters. The option is a + * dev.langchain4j.data.document.DocumentSplitter type. + */ + private DocumentSplitter documentSplitter; + /** + * The IdempotentRepository remembering already ingested document ids, + * referenced as #bean:name. When set, a delivery whose id was already + * written is answered with a skipped result instead of being re-ingested: + * first write wins per id. A blank document releases its claim, so a later, + * populated delivery under the same id still ingests. The claim is eager: a + * duplicate racing an in-flight first delivery is answered skipped even if + * that delivery then fails - with an at-least-once source the skipped + * duplicate is acknowledged and the failed original may be the only other + * copy, so pair eager deduplication with a source that redelivers on + * failure. Not looked up by type on purpose - an application may hold + * unrelated idempotent repositories. The repository is started but never + * stopped by the endpoint (it may be shared); a persistent repository's + * lifecycle belongs to whoever created it. The option is a + * org.apache.camel.spi.IdempotentRepository type. + */ + private IdempotentRepository idempotentRepository; + /** + * Maximum size of one document in characters, applied to the text about to + * be split; 0, the default, means no limit. The pipeline holds a document + * in memory whole, so the cap is the protection against oversized - on a + * consumer-fed pipeline, attacker-sized - payloads. An oversized document + * fails the exchange cleanly and, with a repository configured, releases + * its dedup claim. + */ + private Integer maxDocumentSize = 0; + + public LangChain4jIngestConfiguration getConfiguration() { + return configuration; + } + + public void setConfiguration(LangChain4jIngestConfiguration configuration) { + this.configuration = configuration; + } + + public String getDocumentIdHeader() { + return documentIdHeader; + } + + public void setDocumentIdHeader(String documentIdHeader) { + this.documentIdHeader = documentIdHeader; + } + + public Integer getEmbeddingBatchSize() { + return embeddingBatchSize; + } + + public void setEmbeddingBatchSize(Integer embeddingBatchSize) { + this.embeddingBatchSize = embeddingBatchSize; + } + + public EmbeddingModel getEmbeddingModel() { + return embeddingModel; + } + + public void setEmbeddingModel(EmbeddingModel embeddingModel) { + this.embeddingModel = embeddingModel; + } + + public EmbeddingStore<TextSegment> getEmbeddingStore() { + return embeddingStore; + } + + public void setEmbeddingStore(EmbeddingStore<TextSegment> embeddingStore) { + this.embeddingStore = embeddingStore; + } + + public Boolean getLazyStartProducer() { + return lazyStartProducer; + } + + public void setLazyStartProducer(Boolean lazyStartProducer) { + this.lazyStartProducer = lazyStartProducer; + } + + public Integer getMaxOverlapSize() { + return maxOverlapSize; + } + + public void setMaxOverlapSize(Integer maxOverlapSize) { + this.maxOverlapSize = maxOverlapSize; + } + + public Integer getMaxSegmentSize() { + return maxSegmentSize; + } + + public void setMaxSegmentSize(Integer maxSegmentSize) { + this.maxSegmentSize = maxSegmentSize; + } + + public Boolean getAutowiredEnabled() { + return autowiredEnabled; + } + + public void setAutowiredEnabled(Boolean autowiredEnabled) { + this.autowiredEnabled = autowiredEnabled; + } + + public DocumentSplitter getDocumentSplitter() { + return documentSplitter; + } + + public void setDocumentSplitter(DocumentSplitter documentSplitter) { + this.documentSplitter = documentSplitter; + } + + public IdempotentRepository getIdempotentRepository() { + return idempotentRepository; + } + + public void setIdempotentRepository( + IdempotentRepository idempotentRepository) { + this.idempotentRepository = idempotentRepository; + } + + public Integer getMaxDocumentSize() { + return maxDocumentSize; + } + + public void setMaxDocumentSize(Integer maxDocumentSize) { + this.maxDocumentSize = maxDocumentSize; + } +} \ No newline at end of file diff --git a/components-starter/camel-langchain4j-ingest-starter/src/main/java/org/apache/camel/component/langchain4j/ingest/springboot/LangChain4jIngestComponentConverter.java b/components-starter/camel-langchain4j-ingest-starter/src/main/java/org/apache/camel/component/langchain4j/ingest/springboot/LangChain4jIngestComponentConverter.java new file mode 100644 index 00000000000..e45694f0e9d --- /dev/null +++ b/components-starter/camel-langchain4j-ingest-starter/src/main/java/org/apache/camel/component/langchain4j/ingest/springboot/LangChain4jIngestComponentConverter.java @@ -0,0 +1,57 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.camel.component.langchain4j.ingest.springboot; + +import java.util.LinkedHashSet; +import java.util.Set; +import org.apache.camel.spring.boot.util.BeanReferenceHelper; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.context.properties.ConfigurationPropertiesBinding; +import org.springframework.context.ApplicationContext; +import org.springframework.context.annotation.Configuration; +import org.springframework.core.convert.TypeDescriptor; +import org.springframework.core.convert.converter.GenericConverter; +import org.springframework.stereotype.Component; + +/** + * Generated by camel-package-maven-plugin - do not edit this file! + */ +@Configuration(proxyBeanMethods = false) +@ConfigurationPropertiesBinding +@Component +public class LangChain4jIngestComponentConverter implements GenericConverter { + + @Autowired + private ApplicationContext applicationContext; + + public Set<ConvertiblePair> getConvertibleTypes() { + Set<ConvertiblePair> answer = new LinkedHashSet<>(); + answer.add(new ConvertiblePair(String.class, org.apache.camel.component.langchain4j.ingest.LangChain4jIngestConfiguration.class)); + answer.add(new ConvertiblePair(String.class, dev.langchain4j.model.embedding.EmbeddingModel.class)); + answer.add(new ConvertiblePair(String.class, dev.langchain4j.store.embedding.EmbeddingStore.class)); + answer.add(new ConvertiblePair(String.class, dev.langchain4j.data.document.DocumentSplitter.class)); + answer.add(new ConvertiblePair(String.class, org.apache.camel.spi.IdempotentRepository.class)); + return answer; + } + + public Object convert( + Object source, + TypeDescriptor sourceType, + TypeDescriptor targetType) { + return BeanReferenceHelper.resolveBeanReference(applicationContext, source, targetType, "camel.component.langchain4j-ingest"); + } +} \ No newline at end of file diff --git a/components-starter/camel-langchain4j-ingest-starter/src/main/resources/META-INF/LICENSE.txt b/components-starter/camel-langchain4j-ingest-starter/src/main/resources/META-INF/LICENSE.txt new file mode 100644 index 00000000000..6b0b1270ff0 --- /dev/null +++ b/components-starter/camel-langchain4j-ingest-starter/src/main/resources/META-INF/LICENSE.txt @@ -0,0 +1,203 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + diff --git a/components-starter/camel-langchain4j-ingest-starter/src/main/resources/META-INF/NOTICE.txt b/components-starter/camel-langchain4j-ingest-starter/src/main/resources/META-INF/NOTICE.txt new file mode 100644 index 00000000000..2e215bf2e6b --- /dev/null +++ b/components-starter/camel-langchain4j-ingest-starter/src/main/resources/META-INF/NOTICE.txt @@ -0,0 +1,11 @@ + ========================================================================= + == NOTICE file corresponding to the section 4 d of == + == the Apache License, Version 2.0, == + == in this case for the Apache Camel distribution. == + ========================================================================= + + This product includes software developed by + The Apache Software Foundation (http://www.apache.org/). + + Please read the different LICENSE files present in the licenses directory of + this distribution. diff --git a/components-starter/camel-langchain4j-ingest-starter/src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports b/components-starter/camel-langchain4j-ingest-starter/src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports new file mode 100644 index 00000000000..931ca09e543 --- /dev/null +++ b/components-starter/camel-langchain4j-ingest-starter/src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports @@ -0,0 +1,18 @@ +## --------------------------------------------------------------------------- +## Licensed to the Apache Software Foundation (ASF) under one or more +## contributor license agreements. See the NOTICE file distributed with +## this work for additional information regarding copyright ownership. +## The ASF licenses this file to You under the Apache License, Version 2.0 +## (the "License"); you may not use this file except in compliance with +## the License. You may obtain a copy of the License at +## +## http://www.apache.org/licenses/LICENSE-2.0 +## +## Unless required by applicable law or agreed to in writing, software +## distributed under the License is distributed on an "AS IS" BASIS, +## WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +## See the License for the specific language governing permissions and +## limitations under the License. +## --------------------------------------------------------------------------- +org.apache.camel.component.langchain4j.ingest.springboot.LangChain4jIngestComponentConverter +org.apache.camel.component.langchain4j.ingest.springboot.LangChain4jIngestComponentAutoConfiguration diff --git a/components-starter/camel-langchain4j-ingest-starter/src/test/java/org/apache/camel/component/langchain4j/ingest/springboot/LangChain4jIngestComponentAutoConfigurationTest.java b/components-starter/camel-langchain4j-ingest-starter/src/test/java/org/apache/camel/component/langchain4j/ingest/springboot/LangChain4jIngestComponentAutoConfigurationTest.java new file mode 100644 index 00000000000..a3890f35851 --- /dev/null +++ b/components-starter/camel-langchain4j-ingest-starter/src/test/java/org/apache/camel/component/langchain4j/ingest/springboot/LangChain4jIngestComponentAutoConfigurationTest.java @@ -0,0 +1,57 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.camel.component.langchain4j.ingest.springboot; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertInstanceOf; + +import org.apache.camel.CamelContext; +import org.apache.camel.component.langchain4j.ingest.LangChain4jIngestComponent; +import org.apache.camel.spring.boot.CamelAutoConfiguration; +import org.apache.camel.test.spring.junit6.CamelSpringBootTest; + +import org.junit.jupiter.api.Test; + +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.test.annotation.DirtiesContext; + +@DirtiesContext +@CamelSpringBootTest +@SpringBootTest(classes = { CamelAutoConfiguration.class, LangChain4jIngestComponentAutoConfiguration.class }, + properties = { + "camel.component.langchain4j-ingest.max-segment-size = 1000", + "camel.component.langchain4j-ingest.max-overlap-size = 100", + "camel.component.langchain4j-ingest.document-id-header = MyDocumentId" }) +public class LangChain4jIngestComponentAutoConfigurationTest { + + @Autowired + CamelContext context; + + @Test + public void componentIsAutoConfigured() { + LangChain4jIngestComponent component = assertInstanceOf(LangChain4jIngestComponent.class, + context.getComponent("langchain4j-ingest")); + + // set through camel.component.langchain4j-ingest.*, so this asserts the Spring + // Boot properties are copied onto the component's nested + // LangChain4jIngestConfiguration by the starter + assertEquals(1000, component.getConfiguration().getMaxSegmentSize()); + assertEquals(100, component.getConfiguration().getMaxOverlapSize()); + assertEquals("MyDocumentId", component.getConfiguration().getDocumentIdHeader()); + } +} diff --git a/components-starter/pom.xml b/components-starter/pom.xml index 6305e67bb88..c0e48fd43c0 100644 --- a/components-starter/pom.xml +++ b/components-starter/pom.xml @@ -353,6 +353,7 @@ <module>camel-langchain4j-chat-starter</module> <module>camel-langchain4j-embeddings-starter</module> <module>camel-langchain4j-embeddingstore-starter</module> + <module>camel-langchain4j-ingest-starter</module> <module>camel-langchain4j-tokenizer-starter</module> <module>camel-langchain4j-web-search-starter</module> <module>camel-language-starter</module> diff --git a/docs/spring-boot/modules/ROOT/nav.adoc b/docs/spring-boot/modules/ROOT/nav.adoc index c26db1ac94c..20a46153d78 100644 --- a/docs/spring-boot/modules/ROOT/nav.adoc +++ b/docs/spring-boot/modules/ROOT/nav.adoc @@ -252,6 +252,7 @@ ** xref:starters/langchain4j-chat.adoc[LangChain4j Chat] ** xref:starters/langchain4j-embeddings.adoc[LangChain4j Embeddings] ** xref:starters/langchain4j-embeddingstore.adoc[LangChain4j Embedding Store] +** xref:starters/langchain4j-ingest.adoc[LangChain4j Ingest] ** xref:starters/langchain4j-tokenizer.adoc[Langchain4j Tokenizer] ** xref:starters/langchain4j-web-search.adoc[LangChain4j Web Search] ** xref:starters/language.adoc[Language] diff --git a/docs/spring-boot/modules/ROOT/pages/starters/langchain4j-ingest.adoc b/docs/spring-boot/modules/ROOT/pages/starters/langchain4j-ingest.adoc new file mode 100644 index 00000000000..f3050888923 --- /dev/null +++ b/docs/spring-boot/modules/ROOT/pages/starters/langchain4j-ingest.adoc @@ -0,0 +1,44 @@ +// Do not edit directly! +// This file was generated by camel-spring-boot-generator-maven-plugin += LangChain4j Ingest +:artifactid: camel-langchain4j-ingest-starter + +Ingest documents into a LangChain4j EmbeddingStore: split, embed and store the message body. + +== What's inside + +* xref:{csb-camel-components}::langchain4j-ingest-component.adoc[LangChain4j Ingest component], URI syntax: `langchain4j-ingest:pipelineName` + +Please refer to the above links for usage and configuration details. + +== Maven coordinates + +[source,xml] +---- +<dependency> + <groupId>org.apache.camel.springboot</groupId> + <artifactId>camel-langchain4j-ingest-starter</artifactId> +</dependency> +---- + +== Spring Boot Auto-Configuration + +The starter supports 13 options, which are listed below. + +[width="100%",cols="2,5,^1,2",options="header"] +|=== +| Name | Description | Default | Type +| camel.component.langchain4j-ingest.autowired-enabled | 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 type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. | true | Boolean +| camel.component.langchain4j-ingest.configuration | The configuration. The option is a org.apache.camel.component.langchain4j.ingest.LangChain4jIngestConfiguration type. | | LangChain4jIngestConfiguration +| camel.component.langchain4j-ingest.document-id-header | Name of the header carrying the document id, such as CamelAwsS3Key for an S3 consumer or CamelKafkaKey for a Kafka one. The CamelLangChain4jIngestDocumentId exchange property, when set, takes precedence - a route that parses documents captures the id into that property before the parse, so a document cannot forge its own identity. An exchange without an id fails. | CamelLangChain4jIngestDocumentId | String +| camel.component.langchain4j-ingest.document-splitter | The DocumentSplitter deciding how a document becomes segments, referenced as #bean:name - LangChain4j ships alternatives beside the default recursive one. When set, maxSegmentSize and maxOverlapSize are ignored (they parameterize the default splitter only). Segments returned without the identity metadata are re-stamped, so a custom splitter cannot break citation. Not looked up by type on purpose - an application may hold unrelated [...] +| camel.component.langchain4j-ingest.embedding-batch-size | How many segments are embedded per request to the embedding model. Providers with generous per-request limits ingest large documents faster with a bigger batch; a batch carries at most embeddingBatchSize x maxSegmentSize characters, so tune the two together against the provider's token limits. | 32 | Integer +| camel.component.langchain4j-ingest.embedding-model | The EmbeddingModel to embed segments with. When not set, the single bean of that type in the registry is used; zero or several beans fail the endpoint start with an error naming this option. The option is a dev.langchain4j.model.embedding.EmbeddingModel type. | | EmbeddingModel +| camel.component.langchain4j-ingest.embedding-store | The EmbeddingStore to write segments to. When not set, the single bean of that type in the registry is used; zero or several beans fail the endpoint start with an error naming this option. The option is a dev.langchain4j.store.embedding.EmbeddingStore<dev.langchain4j.data.segment.TextSegment> type. | | TextSegment> +| camel.component.langchain4j-ingest.enabled | Whether to enable auto configuration of the langchain4j-ingest component. This is enabled by default. | | Boolean +| camel.component.langchain4j-ingest.idempotent-repository | The IdempotentRepository remembering already ingested document ids, referenced as #bean:name. When set, a delivery whose id was already written is answered with a skipped result instead of being re-ingested: first write wins per id. A blank document releases its claim, so a later, populated delivery under the same id still ingests. The claim is eager: a duplicate racing an in-flight first delivery is answered skipped even if th [...] +| camel.component.langchain4j-ingest.lazy-start-producer | 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 during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is pro [...] +| camel.component.langchain4j-ingest.max-document-size | Maximum size of one document in characters, applied to the text about to be split; 0, the default, means no limit. The pipeline holds a document in memory whole, so the cap is the protection against oversized - on a consumer-fed pipeline, attacker-sized - payloads. An oversized document fails the exchange cleanly and, with a repository configured, releases its dedup claim. | 0 | Integer +| camel.component.langchain4j-ingest.max-overlap-size | How much of the previous segment each segment repeats, in characters. Overlap keeps a sentence split across a boundary retrievable from either side. | 50 | Integer +| camel.component.langchain4j-ingest.max-segment-size | Maximum size of one segment, in characters. | 500 | Integer +|=== diff --git a/tooling/camel-spring-boot-dependencies/pom.xml b/tooling/camel-spring-boot-dependencies/pom.xml index 3fe3b30623e..1143323c96c 100644 --- a/tooling/camel-spring-boot-dependencies/pom.xml +++ b/tooling/camel-spring-boot-dependencies/pom.xml @@ -1622,6 +1622,11 @@ <artifactId>camel-langchain4j-embeddingstore-starter</artifactId> <version>${project.version}</version> </dependency> + <dependency> + <groupId>org.apache.camel.springboot</groupId> + <artifactId>camel-langchain4j-ingest-starter</artifactId> + <version>${project.version}</version> + </dependency> <dependency> <groupId>org.apache.camel.springboot</groupId> <artifactId>camel-langchain4j-tokenizer-starter</artifactId>
