diff --git a/dynamixs-ai-rag/pom.xml b/dynamixs-ai-rag/pom.xml deleted file mode 100644 index 7ed471f..0000000 --- a/dynamixs-ai-rag/pom.xml +++ /dev/null @@ -1,147 +0,0 @@ - - 4.0.0 - - - dynamixs-ai - ai.dynamixs - 1.0.0 - - dynamixs-ai-rag - jar - Dynamixs AI RAG Library - - - - - - - - - maven-compiler-plugin - 3.8.1 - - ${java.source} - ${java.target} - - - - - - org.apache.maven.plugins - maven-surefire-plugin - 2.22.2 - - - - - - org.apache.maven.plugins - maven-surefire-plugin - 3.3.1 - - - default-test - test - - test - - - - --add-opens java.base/java.lang=ALL-UNNAMED - - - - - - - - - - - - - jakarta.platform - jakarta.jakartaee-api - ${jakarta.version} - provided - - - - org.eclipse.microprofile - microprofile - ${microprofile.version} - pom - provided - - - - - org.imixs.workflow - imixs-workflow-core - - - org.imixs.workflow - imixs-workflow-engine - - - org.imixs.workflow - imixs-workflow-jax-rs - - - org.imixs.workflow - imixs-workflow-faces - - - org.imixs.workflow - imixs-workflow-index-lucene - - - - - org.imixs.workflow - imixs-marty - - - - - org.imixs.workflow - imixs-archive-api - - - - - - org.imixs.workflow - imixs-ai-workflow - - - - - org.apache.cassandra - java-driver-core - ${apache.cassandra.driver.version} - - - org.apache.cassandra - java-driver-query-builder - ${apache.cassandra.driver.version} - - - org.apache.cassandra - java-driver-mapper-runtime - ${apache.cassandra.driver.version} - - - - - \ No newline at end of file diff --git a/dynamixs-ai-rag/src/main/java/ai/dynamixs/DynamixsSetupService.java b/dynamixs-ai-rag/src/main/java/ai/dynamixs/DynamixsSetupService.java deleted file mode 100644 index 5598344..0000000 --- a/dynamixs-ai-rag/src/main/java/ai/dynamixs/DynamixsSetupService.java +++ /dev/null @@ -1,69 +0,0 @@ -/******************************************************************************* - * Imixs Workflow - * Copyright (C) 2001, 2011 Imixs Software Solutions GmbH, - * http://www.imixs.com - * - * This program is free software; you can redistribute it and/or - * modify it under the terms of the GNU General Public License - * as published by the Free Software Foundation; either version 2 - * of the License, or (at your option) any later version. - * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - * General Public License for more details. - * - * You can receive a copy of the GNU General Public - * License at http://www.gnu.org/licenses/gpl.html - * - * Project: - * http://www.imixs.org - * http://java.net/projects/imixs-workflow - * - * Contributors: - * Imixs Software Solutions GmbH - initial API and implementation - * Ralph Soika - Software Developer - *******************************************************************************/ - -package ai.dynamixs; - -import java.util.logging.Logger; - -import org.imixs.workflow.engine.SetupEvent; - -import jakarta.annotation.security.DeclareRoles; -import jakarta.annotation.security.RolesAllowed; -import jakarta.ejb.Stateless; -import jakarta.enterprise.event.Observes; - -/** - * This DynamixsSetupService reacts on the - * 'org.imixs.workflow.engine.SetupEvent' and initializes a Cassandra Session. - * If the connection can not be established immediately the method retries a - * connection every 10 seconds. - * - * - * - * - * @author rsoika - * - */ -@DeclareRoles({ "org.imixs.ACCESSLEVEL.NOACCESS", "org.imixs.ACCESSLEVEL.READERACCESS", - "org.imixs.ACCESSLEVEL.AUTHORACCESS", "org.imixs.ACCESSLEVEL.EDITORACCESS", - "org.imixs.ACCESSLEVEL.MANAGERACCESS" }) -@RolesAllowed({ "org.imixs.ACCESSLEVEL.NOACCESS", "org.imixs.ACCESSLEVEL.READERACCESS", - "org.imixs.ACCESSLEVEL.AUTHORACCESS", "org.imixs.ACCESSLEVEL.EDITORACCESS", - "org.imixs.ACCESSLEVEL.MANAGERACCESS" }) -@Stateless -public class DynamixsSetupService { - private static Logger logger = Logger.getLogger(DynamixsSetupService.class.getName()); - - /** - * Init.... - * - * @param setupEvent - */ - public void setup(@Observes SetupEvent setupEvent) { - // - } -} diff --git a/dynamixs-ai-rag/src/main/java/ai/dynamixs/rag/RAGAdapter.java b/dynamixs-ai-rag/src/main/java/ai/dynamixs/rag/RAGAdapter.java deleted file mode 100644 index bad8f47..0000000 --- a/dynamixs-ai-rag/src/main/java/ai/dynamixs/rag/RAGAdapter.java +++ /dev/null @@ -1,386 +0,0 @@ -/* - * Imixs-Workflow - * - * Copyright (C) 2001-2020 Imixs Software Solutions GmbH, - * http://www.imixs.com - * - * This program is free software; you can redistribute it and/or - * modify it under the terms of the GNU General Public License - * as published by the Free Software Foundation; either version 2 - * of the License, or (at your option) any later version. - * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - * General Public License for more details. - * - * You can receive a copy of the GNU General Public - * License at http://www.gnu.org/licenses/gpl.html - * - * Project: - * https://www.imixs.org - * https://github.com/imixs/imixs-workflow - * - * Contributors: - * Imixs Software Solutions GmbH - Project Management - * Ralph Soika - Software Developer - */ - -package ai.dynamixs.rag; - -import java.util.List; -import java.util.Optional; -import java.util.logging.Level; -import java.util.logging.Logger; -import java.util.stream.Collectors; - -import org.eclipse.microprofile.config.inject.ConfigProperty; -import org.imixs.ai.workflow.OpenAIAPIService; -import org.imixs.workflow.ItemCollection; -import org.imixs.workflow.SignalAdapter; -import org.imixs.workflow.engine.EventLogService; -import org.imixs.workflow.engine.WorkflowService; -import org.imixs.workflow.exceptions.AdapterException; -import org.imixs.workflow.exceptions.PluginException; - -import ai.dynamixs.rag.cluster.ClusterException; -import ai.dynamixs.rag.cluster.ClusterService; -import ai.dynamixs.rag.cluster.RetrievalResult; -import ai.dynamixs.rag.events.RAGEventService; -import jakarta.inject.Inject; - -/** - * The RAGAdapter is used for Retrieval-Augmented Generation workflows. - *

- * The adapter operates in two modes: - *

- * In the 'INDEX' mode the adapter evaluates an associated imixs-ai prompt - * definition and generates - based on the given prompt template - a text to be - * indexed in the RAG database. - * - * 

- * {@code
-
-    llm.service.endpoint
-    true
-
- * }
- *
- *

- * In the 'RETRIEVAL' mode, the adapter evaluates an associated imixs-ai prompt - * definition to get retrieval embeddings from the RAG database. - * - * 

- * {@code
-
-    llm.service.endpoint
-    true
-
- * }
- *
- * - * In both modes the Endpoint defines the Rest API endpoint of the llama-cpp - * http server or any compatible OpenAI / Open API rest service endpoint. - *

- * The Prompt Template is based on the concepts of Imixs-AI: - * - * 

- * {@code
-
-
-    < index_options>{"n_predict": 4096, "temperature": 0}< /index_options>
-    $workflowgroup: $workflowstatus
-        # Summary
-        $workflowsummary
-        offer.summary
-    ]]>
- 
- * }
- *
- * - * The index Process is - * - * @author Ralph Soika - * @version 1.0 - * - */ -public class RAGAdapter implements SignalAdapter { - - public static final String ML_ENTITY = "entity"; - public static final String API_ERROR = "API_ERROR"; - - public static final String RAG_INDEX = "INDEX"; - public static final String RAG_RETRIEVAL = "RETRIEVAL"; - - private static Logger logger = Logger.getLogger(RAGAdapter.class.getName()); - - @Inject - @ConfigProperty(name = OpenAIAPIService.ENV_LLM_SERVICE_ENDPOINT) - Optional serviceEndpoint; - - @Inject - private WorkflowService workflowService; - - @Inject - EventLogService eventLogService; - - @Inject - private OpenAIAPIService llmService; - - @Inject - private ClusterService clusterService; - - /** - * Default Constructor - */ - public RAGAdapter() { - super(); - } - - /** - * CDI Constructor to inject WorkflowService - * - * @param workflowService - */ - @Inject - public RAGAdapter(WorkflowService workflowService) { - super(); - this.workflowService = workflowService; - } - - public void setWorkflowService(WorkflowService workflowService) { - this.workflowService = workflowService; - } - - /** - * This method parses the LLM Event definitions. - * - * For each PROMPT the method posts a context data (e.g text from an attachment) - * to the Imixs-AI Analyse service endpoint - * - * @throws PluginException - */ - public ItemCollection execute(ItemCollection workitem, ItemCollection event) - throws AdapterException, PluginException { - - logger.finest("...running api adapter..."); - - // read optional configuration form the model or imixs.properties.... - List llmIndexDefinitions = workflowService.evalWorkflowResultXML(event, "imixs-ai", - RAG_INDEX, workitem, false); - List llmRetrievalDefinitions = workflowService.evalWorkflowResultXML(event, "imixs-ai", - RAG_RETRIEVAL, workitem, false); - - // verify if we have an INDEX configuration - if (llmIndexDefinitions != null && llmIndexDefinitions.size() > 0) { - createIndex(llmIndexDefinitions, workitem, event); - } - - // verify if we have an RETRIEVAL configuration - if (llmRetrievalDefinitions != null && llmRetrievalDefinitions.size() > 0) { - createRetrieval(llmRetrievalDefinitions, workitem, event); - } - - return workitem; - } - - /** - * Creates a RAG Index for a Workitem based on IndexDefinitions - * - * @param llmIndexDefinitions - * @param workitem - * @param event - * @throws PluginException - * @throws AdapterException - */ - private void createIndex(List llmIndexDefinitions, ItemCollection workitem, ItemCollection event) - throws PluginException, AdapterException { - long processingTime = System.currentTimeMillis(); - String llmAPIEndpoint = null; - boolean llmAPIDebug = false; - try { - for (ItemCollection indexDefinition : llmIndexDefinitions) { - llmAPIEndpoint = parseLLMEndpointByBPMN(indexDefinition); - // do we have a valid endpoint? - if (llmAPIEndpoint == null || llmAPIEndpoint.isEmpty()) { - throw new PluginException(RAGAdapter.class.getSimpleName(), API_ERROR, - "imixs-ai configuration error: no llm service endpoint defined!"); - } - if ("true".equalsIgnoreCase(indexDefinition.getItemValueString("debug"))) { - llmAPIDebug = true; - } - - logger.info("├── post RAG index request: " + llmAPIEndpoint); - String promptTemplate = llmService.loadPromptTemplate(event); - indexDefinition.setItemValue("promptTemplate", promptTemplate); - indexDefinition.setItemValue("debug", llmAPIDebug); - indexDefinition.setItemValue("endpoint", llmAPIEndpoint); - - if (llmAPIDebug) { - logger.info("│ ├── PromptTemplate: "); - logger.info(promptTemplate); - } - - // Build the prompt template... - String llmPrompt = llmService.buildPrompt(promptTemplate, workitem); - if (llmPrompt.isBlank()) { - throw new PluginException( - RAGAdapter.class.getSimpleName(), API_ERROR, - "Unable to parse prompt for RAG indexing"); - } - indexDefinition.setItemValue("prompt", llmPrompt); - - // send eventLog .... - eventLogService.createEvent( - RAGEventService.EVENTLOG_TOPIC_RAG_EVENT_INDEX, - workitem.getUniqueID(), - indexDefinition); - - // if (llmAPIDebug) { - // logger.info("│ ├── Total Prompt Length = " + llmPrompt.length()); - // logger.info("│ ├── Prompt: "); - // logger.info(llmPrompt); - // } - - // // remove old embeddings - // clusterService.removeAllEmbeddings(workitem.getUniqueID()); - // // chunk text.... - // List chunk_list = RAGUtil.chunkMarkupDocument(llmPrompt); - // for (String chunk : chunk_list) { - // if (llmAPIDebug) { - // logger.info("│ ├── 🔸 chunk: "); - // logger.info(chunk); - // } - // List indexResult = llmService.postEmbedding(chunk, llmAPIEndpoint, - // llmAPIDebug); - // // write to cassandra - // clusterService.insertVector(workitem.getUniqueID(), - // workitem.getModelVersion(), - // workitem.getTaskID(), - // chunk, - // indexResult); - // if (llmAPIDebug) { - // logger.info("│ ├── ⇨ " + indexResult.size() + " floats stored in RAG db."); - // } - // } - - if (llmAPIDebug) { - logger.info( - "├── ✅ Total processing time: " + (System.currentTimeMillis() - processingTime) + "ms"); - } - } - } catch (PluginException e) { - logger.severe("├── ⚠️ Failed to post embeddings: " + e.getMessage()); - throw e; - } - } - - /** - * Creates a RAG retrieval for a Worktiem based on RetrievalDefinitions - * - * @param llmRetrievalfDefinitions - * @param workitem - * @param event - * @throws PluginException - * @throws AdapterException - */ - private void createRetrieval(List llmRetrievalfDefinitions, ItemCollection workitem, - ItemCollection event) throws PluginException, AdapterException { - long processingTime = System.currentTimeMillis(); - String llmAPIEndpoint = null; - boolean llmAPIDebug = false; - try { - for (ItemCollection indexDefinition : llmRetrievalfDefinitions) { - llmAPIEndpoint = parseLLMEndpointByBPMN(indexDefinition); - // do we have a valid endpoint? - if (llmAPIEndpoint == null || llmAPIEndpoint.isEmpty()) { - throw new PluginException(RAGAdapter.class.getSimpleName(), API_ERROR, - "imixs-ai configuration error: no llm service endpoint defined!"); - } - if ("true".equalsIgnoreCase(indexDefinition.getItemValueString("debug"))) { - llmAPIDebug = true; - } - - logger.info("├── post RAG Retrievalf request: " + llmAPIEndpoint); - String promptTemplate = llmService.loadPromptTemplate(event); - logger.info("│ ├── PromptTemplate: "); - logger.info(promptTemplate); - String llmPrompt = llmService.buildPrompt(promptTemplate, workitem); - if (llmPrompt.isBlank()) { - throw new PluginException( - RAGAdapter.class.getSimpleName(), API_ERROR, - "Unable to parse prompt for RAG indexing"); - } - if (llmAPIDebug) { - logger.info("│ ├── Total Prompt Length = " + llmPrompt.length()); - logger.info("│ ├── Prompt: "); - logger.info(llmPrompt); - } - - // retrieve prompt.... - List embeddings = llmService.postEmbedding(llmPrompt, llmAPIEndpoint, llmAPIDebug); - if (llmAPIDebug) { - logger.info("├── ⇨ " + embeddings.size() + " floats stored in RAG db."); - } - // search cassandra - List retrievalResultList = clusterService.searchEmbeddings(embeddings, 5); - List listOfIds = retrievalResultList.stream() - .map(RetrievalResult::getUniqueId) - .collect(Collectors.toList()); - workitem.setItemValue("product.ref", listOfIds); - if (llmAPIDebug) { - logger.info( - "├── found " + retrievalResultList.size() + " matches"); - logger.info( - "├── ✅ Total processing time: " + (System.currentTimeMillis() - processingTime) + "ms"); - } - } - } catch (PluginException e) { - logger.severe("├── ⚠️ Failed to post embeddings: " + e.getMessage()); - throw e; - } catch (ClusterException e) { - throw new PluginException(RAGAdapter.class.getSimpleName(), API_ERROR, e.getMessage(), e); - } - } - - /** - * This helper method parses the ml api endpoint either provided by a model - * definition or a imixs.property or an environment variable. - *

- * If not api endpoint is defined by the model the adapter uses the default api - * endpoint. - * - * @param llmPrompt - * @return - * @throws PluginException - */ - private String parseLLMEndpointByBPMN(ItemCollection llmPrompt) throws PluginException { - boolean debug = logger.isLoggable(Level.FINE); - String llmAPIEndpoint = null; - - // Test if the model provides a API Endpoint. - llmAPIEndpoint = null; - if (llmPrompt != null) { - llmAPIEndpoint = llmPrompt.getItemValueString("endpoint"); - } - - // switch to default api endpoint? - if (llmAPIEndpoint == null || llmAPIEndpoint.isEmpty()) { - // set defautl api endpoint if defined - if (serviceEndpoint.isPresent() && !serviceEndpoint.get().isEmpty()) { - llmAPIEndpoint = serviceEndpoint.get(); - } - } - if (debug) { - logger.info("......llm api endpoint " + llmAPIEndpoint); - } - - // adapt text... - llmAPIEndpoint = workflowService.adaptText(llmAPIEndpoint, null); - if (!llmAPIEndpoint.endsWith("/")) { - llmAPIEndpoint = llmAPIEndpoint + "/"; - } - return llmAPIEndpoint; - } - -} diff --git a/dynamixs-ai-rag/src/main/java/ai/dynamixs/rag/RAGPlugin.java b/dynamixs-ai-rag/src/main/java/ai/dynamixs/rag/RAGPlugin.java deleted file mode 100644 index f75f1e2..0000000 --- a/dynamixs-ai-rag/src/main/java/ai/dynamixs/rag/RAGPlugin.java +++ /dev/null @@ -1,107 +0,0 @@ -/* - * Imixs-Workflow - * - * Copyright (C) 2001-2020 Imixs Software Solutions GmbH, - * http://www.imixs.com - * - * This program is free software; you can redistribute it and/or - * modify it under the terms of the GNU General Public License - * as published by the Free Software Foundation; either version 2 - * of the License, or (at your option) any later version. - * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - * General Public License for more details. - * - * You can receive a copy of the GNU General Public - * License at http://www.gnu.org/licenses/gpl.html - * - * Project: - * https://www.imixs.org - * https://github.com/imixs/imixs-workflow - * - * Contributors: - * Imixs Software Solutions GmbH - Project Management - * Ralph Soika - Software Developer - */ - -package ai.dynamixs.rag; - -import java.util.List; -import java.util.logging.Logger; - -import org.imixs.workflow.ItemCollection; -import org.imixs.workflow.engine.EventLogService; -import org.imixs.workflow.engine.WorkflowService; -import org.imixs.workflow.engine.plugins.AbstractPlugin; -import org.imixs.workflow.exceptions.PluginException; - -import ai.dynamixs.rag.events.RAGEventService; -import jakarta.inject.Inject; - -/** - * The RAGIndexPlugin updates the workflow meta data for existing embeddings. - * The plugin can be deactivated with: - *

- * - * 

-  {@code
-   
-      false  
-   
-    }
- *
- *

- * The tag 'debug' is optional - * - * - * @author rsoika - * - */ -public class RAGPlugin extends AbstractPlugin { - - private static final Logger logger = Logger.getLogger(RAGPlugin.class.getName()); - - @Inject - private WorkflowService workflowService; - - @Inject - EventLogService eventLogService; - - @Override - public ItemCollection run(ItemCollection workitem, ItemCollection event) throws PluginException { - List deleteDefinitions = null; - List disableDefinitions = null; - - logger.finest("running TaxonomyPlugin"); - String workflowResult = event.getItemValueString("workflow.result"); - if (workflowResult.contains(" 0) { - // no op! - return workitem; - } - - // delete mode? - if (deleteDefinitions != null && deleteDefinitions.size() > 0) { - eventLogService.createEvent(RAGEventService.EVENTLOG_TOPIC_RAG_EVENT_DELETE, workitem.getUniqueID()); - return workitem; - } - - // default update meta information - eventLogService.createEvent(RAGEventService.EVENTLOG_TOPIC_RAG_EVENT_UPDATE, workitem.getUniqueID()); - - return workitem; - - } - -} diff --git a/dynamixs-ai-rag/src/main/java/ai/dynamixs/rag/RAGUtil.java b/dynamixs-ai-rag/src/main/java/ai/dynamixs/rag/RAGUtil.java deleted file mode 100644 index 4bd341a..0000000 --- a/dynamixs-ai-rag/src/main/java/ai/dynamixs/rag/RAGUtil.java +++ /dev/null @@ -1,101 +0,0 @@ -/* - * Imixs-Workflow - * - * Copyright (C) 2001-2020 Imixs Software Solutions GmbH, - * http://www.imixs.com - * - * This program is free software; you can redistribute it and/or - * modify it under the terms of the GNU General Public License - * as published by the Free Software Foundation; either version 2 - * of the License, or (at your option) any later version. - * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - * General Public License for more details. - * - * You can receive a copy of the GNU General Public - * License at http://www.gnu.org/licenses/gpl.html - * - * Project: - * https://www.imixs.org - * https://github.com/imixs/imixs-workflow - * - * Contributors: - * Imixs Software Solutions GmbH - Project Management - * Ralph Soika - Software Developer - */ - -package ai.dynamixs.rag; - -import java.util.ArrayList; -import java.util.List; -import java.util.logging.Logger; -import java.util.regex.Matcher; -import java.util.regex.Pattern; - -/** - * The RAGUtil provides methods to chunk markup text - * - * @author Ralph Soika - * @version 1.0 - * - */ -public class RAGUtil { - - private static Logger logger = Logger.getLogger(RAGAdapter.class.getName()); - - /** - * This helper method creates smaller text chunks from a large markup text. - */ - public static List chunkMarkupDocument(String markupText) { - List chunks = new ArrayList<>(); - StringBuilder currentChunk = new StringBuilder(); - - // Regex für Abschnitts-Header (# oder **) - Pattern sectionPattern = Pattern.compile("^(# .+|\\*\\*.+\\*\\*)", Pattern.MULTILINE); - Matcher matcher = sectionPattern.matcher(markupText); - - int lastEnd = 0; - while (matcher.find()) { - // Text zwischen den Headern - String sectionContent = markupText.substring(lastEnd, matcher.start()).trim(); - - if (!sectionContent.isEmpty()) { - // Füge Inhalt zum aktuellen Chunk hinzu - if (currentChunk.length() + sectionContent.length() > 500) { - flushChunk(chunks, currentChunk); - } - currentChunk.append(sectionContent).append("\n"); - } - - // Header selbst behandeln - String header = matcher.group(1); - if (currentChunk.length() + header.length() > 300) { - flushChunk(chunks, currentChunk); - } - currentChunk.append(header).append("\n"); - - lastEnd = matcher.end(); - } - - // Restlichen Text nach dem letzten Header - String remainingContent = markupText.substring(lastEnd).trim(); - if (!remainingContent.isEmpty()) { - currentChunk.append(remainingContent); - flushChunk(chunks, currentChunk); - } else if (currentChunk.length() > 0) { - chunks.add(currentChunk.toString().trim()); - } - - return chunks; - } - - private static void flushChunk(List chunks, StringBuilder currentChunk) { - if (currentChunk.length() > 0) { - chunks.add(currentChunk.toString().trim()); - currentChunk.setLength(0); - } - } - -} diff --git a/dynamixs-ai-rag/src/main/java/ai/dynamixs/rag/cluster/ClusterException.java b/dynamixs-ai-rag/src/main/java/ai/dynamixs/rag/cluster/ClusterException.java deleted file mode 100644 index 0bda617..0000000 --- a/dynamixs-ai-rag/src/main/java/ai/dynamixs/rag/cluster/ClusterException.java +++ /dev/null @@ -1,99 +0,0 @@ -/******************************************************************************* - * Imixs Workflow - * Copyright (C) 2001, 2011 Imixs Software Solutions GmbH, - * http://www.imixs.com - * - * This program is free software; you can redistribute it and/or - * modify it under the terms of the GNU General Public License - * as published by the Free Software Foundation; either version 2 - * of the License, or (at your option) any later version. - * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - * General Public License for more details. - * - * You can receive a copy of the GNU General Public - * License at http://www.gnu.org/licenses/gpl.html - * - * Project: - * http://www.imixs.org - * http://java.net/projects/imixs-workflow - * - * Contributors: - * Imixs Software Solutions GmbH - initial API and implementation - * Ralph Soika - Software Developer - *******************************************************************************/ - -package ai.dynamixs.rag.cluster; - -/** - * The ClusterService provides methods to persist the content of a Imixs AI - * dataset into a Cassandra keystore. - *

- * The ClusterService creates a Core-KeySpace automatically which is used for - * the internal management. - * - * @author rsoika - * @version 1.0 - */ -public class ClusterException extends Exception { - - private static final long serialVersionUID = 1L; - - protected String errorContext = "UNDEFINED"; - protected String errorCode = "UNDEFINED"; - - public static final String INVALID_DOCUMENT_OBJECT = "INVALID_DOCUMENT_OBJECT"; - public static final String INVALID_KEYSPACE = "INVALID_KEYSPACE"; - public static final String CLUSTER_ERROR = "CLUSTER_ERROR"; - public static final String INVALID_WORKITEM = "INVALID_WORKITEM"; - public static final String MD5_ERROR = "MD5_ERROR"; - - public static final String MISSING_CONTACTPOINT = "MISSING_CONTACTPOINT"; - public static final String SYNC_ERROR = "SYNC_ERROR"; - - public ClusterException(String aErrorCode, String message) { - super(message); - errorCode = aErrorCode; - - } - - public ClusterException(String aErrorContext, String aErrorCode, String message) { - super(message); - errorContext = aErrorContext; - errorCode = aErrorCode; - - } - - public ClusterException(String aErrorContext, String aErrorCode, String message, Exception e) { - super(message, e); - errorContext = aErrorContext; - errorCode = aErrorCode; - - } - - public ClusterException(String aErrorCode, String message, Exception e) { - super(message, e); - - errorCode = aErrorCode; - - } - - public String getErrorContext() { - return errorContext; - } - - public void setErrorContext(String errorContext) { - this.errorContext = errorContext; - } - - public String getErrorCode() { - return errorCode; - } - - public void setErrorCode(String errorCode) { - this.errorCode = errorCode; - } - -} diff --git a/dynamixs-ai-rag/src/main/java/ai/dynamixs/rag/cluster/ClusterService.java b/dynamixs-ai-rag/src/main/java/ai/dynamixs/rag/cluster/ClusterService.java deleted file mode 100644 index 4868e60..0000000 --- a/dynamixs-ai-rag/src/main/java/ai/dynamixs/rag/cluster/ClusterService.java +++ /dev/null @@ -1,753 +0,0 @@ -package ai.dynamixs.rag.cluster; - -import java.net.InetSocketAddress; -import java.util.ArrayList; -import java.util.Arrays; -import java.util.Collections; -import java.util.HashMap; -import java.util.List; -import java.util.Map; -import java.util.Optional; -import java.util.UUID; -import java.util.logging.Level; -import java.util.logging.Logger; -import java.util.stream.Collectors; - -import org.eclipse.microprofile.config.inject.ConfigProperty; - -import com.datastax.oss.driver.api.core.CqlSession; -import com.datastax.oss.driver.api.core.CqlSessionBuilder; -import com.datastax.oss.driver.api.core.InvalidKeyspaceException; -import com.datastax.oss.driver.api.core.cql.BoundStatement; -import com.datastax.oss.driver.api.core.cql.PreparedStatement; -import com.datastax.oss.driver.api.core.cql.ResultSet; -import com.datastax.oss.driver.api.core.cql.Row; -import com.datastax.oss.driver.api.core.data.CqlVector; -import com.datastax.oss.driver.api.core.servererrors.InvalidQueryException; - -import jakarta.annotation.PostConstruct; -import jakarta.annotation.PreDestroy; -import jakarta.annotation.Resource; -import jakarta.ejb.Singleton; -import jakarta.ejb.Startup; -import jakarta.ejb.Timeout; -import jakarta.ejb.Timer; -import jakarta.ejb.TimerConfig; -import jakarta.ejb.TimerService; -import jakarta.inject.Inject; - -/** - * The ClusterService provides methods to persist the content of a Imixs - * Document into a Cassandra keystore. - *

- * The service saves the content in XML format. The size of an XML - * representation of a Imixs document is only slightly different in size from - * the serialized map object. This is the reason why we do not store the - * document map in a serialized object format. - *

- * The ClusterService creates a Core-KeySpace automatically which is used for - * the internal management. - * - * @author rsoika - * - */ -@Singleton -@Startup -public class ClusterService { - - public static final String KEYSPACE_REGEX = "^[a-z_]*[^-]$"; - public static final int SEARCH_LIMIT_MAX = 100; - - // mandatory environment settings - public static final String ENV_EMBEDDINGS_CLUSTER_CONTACTPOINTS = "EMBEDDINGS_CLUSTER_CONTACTPOINTS"; - public static final String ENV_EMBEDDINGS_CLUSTER_KEYSPACE = "EMBEDDINGS_CLUSTER_KEYSPACE"; - - public static final int DIMENSIONS = 768; - // public static final int DIMENSIONS = 384; - - // optional environment settings - public static final String ENV_EMBEDDINGS_CLUSTER_AUTH_USER = "EMBEDDINGS_CLUSTER_AUTH_USER"; - public static final String ENV_EMBEDDINGS_CLUSTER_AUTH_PASSWORD = "EMBEDDINGS_CLUSTER_AUTH_PASSWORD"; - public static final String ENV_EMBEDDINGS_CLUSTER_SSL = "EMBEDDINGS_CLUSTER_SSL"; - public static final String ENV_EMBEDDINGS_CLUSTER_SSL_TRUSTSTOREPATH = "EMBEDDINGS_CLUSTER_SSL_TRUSTSTOREPATH"; - public static final String ENV_EMBEDDINGS_CLUSTER_SSL_TRUSTSTOREPASSWORD = "EMBEDDINGS_CLUSTER_SSL_TRUSTSTOREPASSWORD"; - public static final String ENV_EMBEDDINGS_CLUSTER_SSL_KEYSTOREPATH = "EMBEDDINGS_CLUSTER_SSL_KEYSTOREPATH"; - public static final String ENV_EMBEDDINGS_CLUSTER_SSL_KEYSTOREPASSWORD = "EMBEDDINGS_CLUSTER_SSL_KEYSTOREPASSWORD"; - - public static final String ENV_EMBEDDINGS_CLUSTER_REPLICATION_FACTOR = "EMBEDDINGS_CLUSTER_REPLICATION_FACTOR"; - public static final String ENV_EMBEDDINGS_CLUSTER_REPLICATION_CLASS = "EMBEDDINGS_CLUSTER_REPLICATION_CLASS"; - - // workflow rest service endpoint - public static final String ENV_WORKFLOW_SERVICE_ENDPOINT = "WORKFLOW_SERVICE_ENDPOINT"; - public static final String ENV_WORKFLOW_SERVICE_USER = "WORKFLOW_SERVICE_USER"; - public static final String ENV_WORKFLOW_SERVICE_PASSWORD = "WORKFLOW_SERVICE_PASSWORD"; - public static final String ENV_WORKFLOW_SERVICE_AUTHMETHOD = "WORKFLOW_SERVICE_AUTHMETHOD"; - - private static Logger logger = Logger.getLogger(ClusterService.class.getName()); - - @Inject - @ConfigProperty(name = ENV_EMBEDDINGS_CLUSTER_REPLICATION_FACTOR, defaultValue = "1") - String repFactor; - - @Inject - @ConfigProperty(name = ENV_EMBEDDINGS_CLUSTER_REPLICATION_CLASS, defaultValue = "SimpleStrategy") - String repClass; - - @Inject - @ConfigProperty(name = ENV_EMBEDDINGS_CLUSTER_CONTACTPOINTS) - Optional contactPoint; - - @Inject - @ConfigProperty(name = ENV_EMBEDDINGS_CLUSTER_KEYSPACE) - Optional keySpace; - - @Inject - @ConfigProperty(name = ENV_EMBEDDINGS_CLUSTER_AUTH_USER) - Optional userid; - - @Inject - @ConfigProperty(name = ENV_EMBEDDINGS_CLUSTER_AUTH_PASSWORD) - Optional password; - - @Inject - @ConfigProperty(name = ENV_EMBEDDINGS_CLUSTER_SSL, defaultValue = "false") - boolean bUseSSL; - - @Inject - @ConfigProperty(name = ENV_EMBEDDINGS_CLUSTER_SSL_TRUSTSTOREPATH) - Optional truststorePath; - - @Inject - @ConfigProperty(name = ENV_EMBEDDINGS_CLUSTER_SSL_TRUSTSTOREPASSWORD) - Optional truststorePwd; - - @Inject - @ConfigProperty(name = ENV_EMBEDDINGS_CLUSTER_SSL_KEYSTOREPATH) - Optional keystorePath; - - @Inject - @ConfigProperty(name = ENV_EMBEDDINGS_CLUSTER_SSL_KEYSTOREPASSWORD) - Optional keystorePwd; - - private CqlSession session; - - private PreparedStatement insertVectorStmt; - // private PreparedStatement searchVectorStmt; - private final Map searchVectorStatements = new HashMap<>(); - private PreparedStatement selectVectorStmt; - private PreparedStatement removeVectorStmt; - private PreparedStatement selectChunksStmt = null; - private PreparedStatement updateChunkStmt = null; - - @Resource - private TimerService timerService; - - @PostConstruct - public void init() { - scheduleClusterCheck(); - } - - /** - * Versucht, die Session herzustellen. Bei Fehler wird ein neuer Timer geplant. - */ - private void scheduleClusterCheck() { - try { - logger.log(Level.INFO, "├── connecting Cassandra cluster..."); - getSession(); - logger.log(Level.INFO, "├── ✅ successfully connected to cassandra!"); - } catch (ClusterException e) { - logger.log(Level.WARNING, "├── " + e.getMessage()); - logger.log(Level.WARNING, "├── ⚠️ cluster not ready yet. retrying in 10 seconds..."); - // retry in 10 sec - timerService.createSingleActionTimer(10000, new TimerConfig()); - } - } - - /** - * called by timer. Tries to connect cassandra clauster - */ - @Timeout - public void retryClusterCheck(Timer timer) { - scheduleClusterCheck(); // retry Check - } - - @PreDestroy - private void tearDown() { - // close session and cluster object - if (session != null) { - session.close(); - } - } - - /** - * Returns the Cassandra Session object. If the session is not yet created, the - * method tries to init the session the first time. If initialization failed the - * method throws a ClusterException - *

- * Note: the initialization is only successful if the cassandra cluster is fully - * started. - *

- * The method also verifies the keyspace and creates a table schema if not yet - * available. - * - * @return - */ - public CqlSession getSession() throws ClusterException { - if (session == null) { - try { - logger.info("├── initializing cluster and keyspace..."); - session = initSessionWithKeyspace(); - logger.info("│ ├── ✅ schema status = OK"); - - createSchema(); - - } catch (Exception e) { - throw new ClusterException(ClusterException.CLUSTER_ERROR, - "Failed to init cassandra session: " + e.getMessage(), e); - } - } - return session; - } - - /** - * This method opens the configured keyspace. If the keyspace does no yet exist - * it creates a new keyspace with the table schema - * - * @return - * @throws ClusterException - */ - private CqlSession initSessionWithKeyspace() throws ClusterException { - // validate keyspace name - String keySpacename = keySpace.orElseThrow( - () -> new ClusterException(ClusterException.INVALID_KEYSPACE, "EMBEDDINGS_CLUSTER_KEYSPACE not set!")); - - if (!isValidKeyspaceName(keySpacename)) { - throw new ClusterException(ClusterException.INVALID_KEYSPACE, - "keyspace '" + keySpacename + "' name invalid."); - } - - try { - // try to connect keyspace ... - session = createSession(keySpacename); - logger.info("│ ├── ✅ keyspace '" + keySpacename + "' status = OK"); - return session; - } catch (InvalidQueryException | InvalidKeyspaceException e) { - logger.warning("│ ├── ⚠️ Keyspace does not yet exist, creating new keyspace..."); - // Create a basic session object to create the keyspace.... - session = createSession(null); - createKeySpace(keySpacename); - // close and reconnect session... - session.close(); - session = createSession(keySpacename); - - return session; - } - } - - /** - * This method creates a Cassandra Cluster object. The cluster is defined by - * ContactPoints provided in the environmetn variable - * 'EMBEDDINGS__CLUSTER_CONTACTPOINTS' or in the imixs.property - * 'archive.cluster.contactpoints' - * - * @return Cassandra Cluster instacne - */ - - private CqlSession createSession(String keyspace) throws ClusterException { - CqlSessionBuilder builder = CqlSession.builder(); - // Boolean used to check if at least one host could be resolved - boolean found = false; - - if (!contactPoint.isPresent() || contactPoint.get().isEmpty()) { - throw new ClusterException(ClusterException.MISSING_CONTACTPOINT, - "missing cluster contact points - verify configuration!"); - } - - logger.info("│ ├── cluster connecting: " + contactPoint.get()); - String[] hosts = contactPoint.get().split(","); - for (String host : hosts) { - try { - logger.info("│ ├── adding host: " + host + ":9042"); - builder.addContactPoint(new InetSocketAddress(host, 9042)); - // One host could be resolved - found = true; - } catch (IllegalArgumentException e) { - // This host could not be resolved so we log a message and keep going - logger.warning("...the host '" + host + "' is unknown so it will be ignored"); - } - } - if (!found) { - // No host could be resolved so we throw an exception - throw new IllegalStateException("All provided hosts are unknown - check cluster status and configuration!"); - } - // set optional credentials... - if (userid.isPresent() && !userid.get().isEmpty()) { - builder = builder.withAuthCredentials(userid.get(), password.get()); - } - - if (keyspace != null) { - builder.withKeyspace(keyspace); - } - builder.withLocalDatacenter("datacenter1"); - return builder.build(); - } - - /** - * Test if the keyspace name is valid. - * - * @param keySpace - * @return - */ - public boolean isValidKeyspaceName(String keySpace) { - if (keySpace == null || keySpace.isEmpty()) { - return false; - } - return keySpace.matches(KEYSPACE_REGEX); - } - - /** - * This method creates a cassandra keySpace - * - * @param cluster - */ - private void createKeySpace(String keySpace) throws ClusterException { - logger.info("│ ├── creating new keyspace '" + keySpace + "'..."); - - String statement = "CREATE KEYSPACE IF NOT EXISTS " + keySpace + " WITH replication = {'class': '" + repClass - + "', 'replication_factor': " + repFactor + "};"; - - session.execute(statement); - logger.info("│ ├── ✅ keyspace '" + keySpace + "' created."); - - } - - /** - * This method creates the keySpace schema. - * - * CREATE TABLE embeddings.document_vectors ( business_document_id uuid, - * chunk_id text, chunk_text text, content_vector VECTOR , PRIMARY - * KEY (business_document_id, chunk_id) ); ); - * - * @param cluster - */ - private void createSchema() throws ClusterException { - - logger.info("│ ├── verify schema..."); - // now create table schemas - String query = "CREATE TABLE IF NOT EXISTS document_vectors (\n" + // - " id text,\n" + // - " chunk_id uuid,\n" + // - " model_version text,\n" + // - " task_id int,\n" + // - " content_chunk text,\n" + // - " content_vector VECTOR ,\n" + // - " PRIMARY KEY (id, chunk_id)\n" + // - ");"; - session.execute(query); - - logger.info("│ ├── verify index..."); - query = "CREATE INDEX IF NOT EXISTS edv_ann_index\n" + // - " ON document_vectors(content_vector) USING 'sai';"; - session.execute(query); - - // Additional indexes for metadata filtering - query = "CREATE INDEX IF NOT EXISTS idx_model_version " + // - " ON document_vectors(model_version) USING 'sai';"; - session.execute(query); - query = "CREATE INDEX IF NOT EXISTS idx_task_id " + // - " ON document_vectors(task_id) USING 'sai';"; - session.execute(query); - - logger.info("│ ├── ✅ database schema OK."); - } - - /** - * Inserts an embedding together with a content chunk into the database. The - * uniqueID is the reference to the corresponding workitem holding the full meta - * data. - * - * @param uniqueID - * @param modelVersion - * @param taskId - * @param content - * @param vector - * @throws ClusterException - */ - public void insertVector(String uniqueID, String modelVersion, int taskId, String content, List vector) - throws ClusterException { - - // Prepare statement? - if (insertVectorStmt == null) { - String insertQuery = "INSERT INTO document_vectors " - + "(id, chunk_id, model_version, task_id, content_chunk, content_vector) VALUES (?, ?, ?, ?, ?, ?)"; - insertVectorStmt = session.prepare(insertQuery); - } - - try { - // Generiere UUID - UUID chunk_id = UUID.randomUUID(); - // CqlVector - CqlVector cqlVector = CqlVector.newInstance(vector); - - BoundStatement boundStmt = insertVectorStmt.bind(uniqueID, chunk_id, modelVersion, taskId, content, - cqlVector); - session.execute(boundStmt); - - } catch (Exception e) { - throw new ClusterException(ClusterException.CLUSTER_ERROR, - "Failed to insert embeddings into keyspace: " + e.getMessage(), e); - } - } - - /** - * Removes all embeddings for a given uniqueID. The method returns true if - * entries have existed. - * - * @param uniqueID - * @param content - * @param vector - * @throws ClusterException - */ - public boolean removeAllEmbeddings(String uniqueID) throws ClusterException { - // Prepare statement if not already done - if (removeVectorStmt == null) { - String deleteQuery = "DELETE FROM document_vectors WHERE id = ?"; - removeVectorStmt = session.prepare(deleteQuery); - } - - try { - // test if entries exist - long count = countIndexEntries(uniqueID); - if (count > 0) { - // remove all - BoundStatement deleteBoundStmt = removeVectorStmt.bind(uniqueID); - session.execute(deleteBoundStmt); - logger.info("│ ├── ✅ Removed " + count + " entries for uniqueID: " + uniqueID); - return true; - } else { - // logger.info("│ ├── ℹ️ No entries found for uniqueID: " + uniqueID); - } - - } catch (Exception e) { - throw new ClusterException(ClusterException.CLUSTER_ERROR, - "Failed to remove entries for uniqueID '" + uniqueID + "': " + e.getMessage(), e); - } - return false; - } - - /** - * This method returns the number of index entries with the given uniqueId. The - * method can be used to test if index data is available. - * - * @param uniqueId - * @return - count of entries, or 0 if no entries exist - * @throws ClusterException - */ - public long countIndexEntries(String uniqueId) throws ClusterException { - if (selectVectorStmt == null) { - String selectQuery = "SELECT COUNT(*) FROM document_vectors WHERE id = ?"; - selectVectorStmt = session.prepare(selectQuery); - } - try { - // test if entries exist - BoundStatement selectBoundStmt = selectVectorStmt.bind(uniqueId); - ResultSet resultSet = session.execute(selectBoundStmt); - Row row = resultSet.one(); - - if (row != null) { - long count = row.getLong(0); - return count; - } - } catch (Exception e) { - throw new ClusterException(ClusterException.CLUSTER_ERROR, - "Failed to lookup entries for uniqueID '" + uniqueId + "': " + e.getMessage(), e); - } - return 0; - } - - /** - * Performs a semantic search on the document vector database using cosine - * similarity. - *

- * This method searches for the most relevant document chunks based on the - * provided query embedding. If multiple chunks exist for the same document ID, - * only the chunk with the highest similarity score is returned. The results are - * sorted by relevance score in descending order. - *

- * The params 'modelVrsions' and 'taskIds' are optional and can be used to - * refine the search result to specific process instances only. - * - * @param queryEmbedding The embedding vector of the search query as a list of - * float values. The dimensionality must match the - * DIMENSIONS constant used in the database schema. - * @return A list of {@link RetrievalResult} objects containing the most - * relevant documents, limited to a maximum of 5 results. Each result - * includes the document ID, the best matching content chunk, and the - * similarity score. The list is sorted by similarity score in - * descending order (most relevant first). - * @throws ClusterException if the database query fails or if there's an error - * processing the embedding vector - * - * @see RetrievalResult - * @since 1.0 - */ - public List searchEmbeddings(List embedding, - int maxResults, - List modelVersions, - List taskIds, - Integer taskIdRangeStart, - Integer taskIdRangeEnd) throws ClusterException { - - if (maxResults <= 0) { - throw new ClusterException(ClusterException.CLUSTER_ERROR, - "maxResults must be greater than 0, but was: " + maxResults); - } - // Calculate a reasonable DB limit based on maxResults - // Factor 3-4 times to have enough chunks for deduplication. - int searchLimit = Math.min(maxResults * 4, SEARCH_LIMIT_MAX); // Max 100 - - StringBuilder queryBuilder = new StringBuilder(); - queryBuilder.append("SELECT id, model_version, task_id, content_chunk, ") - .append("similarity_cosine(content_vector, ?) ") - .append("FROM document_vectors "); - - List whereConditions = new ArrayList<>(); - // Model version filtering (with wildcard support) - if (modelVersions != null && !modelVersions.isEmpty()) { - List modelConditions = new ArrayList<>(); - for (String modelVersion : modelVersions) { - if (modelVersion.endsWith("*")) { - // Wildcard search using LIKE - modelConditions.add("model_version LIKE ?"); - } else { - // Exact match - modelConditions.add("model_version = ?"); - } - } - whereConditions.add("(" + String.join(" OR ", modelConditions) + ")"); - } - - // Task ID filtering - either list or range - if (taskIds != null && !taskIds.isEmpty()) { - whereConditions.add("task_id IN " + formatInClause(taskIds.size())); - } else if (taskIdRangeStart != null && taskIdRangeEnd != null) { - whereConditions.add("task_id >= ? AND task_id <= ?"); - } else if (taskIdRangeStart != null) { - whereConditions.add("task_id >= ?"); - } else if (taskIdRangeEnd != null) { - whereConditions.add("task_id <= ?"); - } - - if (!whereConditions.isEmpty()) { - queryBuilder.append("WHERE ").append(String.join(" AND ", whereConditions)).append(" "); - } - - queryBuilder.append("ORDER BY content_vector ANN OF ? LIMIT ").append(searchLimit); - // Prepare statement (with caching) - String statementKey = buildStatementKey(searchLimit, modelVersions, taskIds, - taskIdRangeStart, taskIdRangeEnd); - PreparedStatement searchStmt = searchVectorStatements.get(statementKey); - if (searchStmt == null) { - searchStmt = session.prepare(queryBuilder.toString()); - searchVectorStatements.put(statementKey, searchStmt); - } - - try { - // use CqlVector - CqlVector cqlVector = CqlVector.newInstance(embedding); - // Build parameters list - List params = new ArrayList<>(); - params.add(cqlVector); // First parameter for similarity calculation - - // Add model version parameters - if (modelVersions != null && !modelVersions.isEmpty()) { - for (String modelVersion : modelVersions) { - if (modelVersion.endsWith("*")) { - // Convert wildcard to LIKE pattern - params.add(modelVersion.substring(0, modelVersion.length() - 1) + "%"); - } else { - params.add(modelVersion); - } - } - } - - // Add task ID parameters - if (taskIds != null && !taskIds.isEmpty()) { - params.addAll(taskIds); - } else if (taskIdRangeStart != null && taskIdRangeEnd != null) { - params.add(taskIdRangeStart); - params.add(taskIdRangeEnd); - } else if (taskIdRangeStart != null) { - params.add(taskIdRangeStart); - } else if (taskIdRangeEnd != null) { - params.add(taskIdRangeEnd); - } - - params.add(cqlVector); - - ResultSet resultRows = session.execute(searchStmt.bind(params.toArray())); - - // track best Similarity per uniqueID - Map bestMatches = new HashMap<>(); - - for (Row row : resultRows) { - String id = row.getString(0); - String contentChunk = row.getString(3); - Float similarity = row.getFloat(4); - // test if we already have a match - RetrievalResult existingMatch = bestMatches.get(id); - - if (existingMatch == null || similarity > existingMatch.getScore()) { - // better match found! - bestMatches.put(id, new RetrievalResult(id, contentChunk, similarity)); - logger.info("│ ├── Found/Updated document: " + id + " with score: " + similarity); - } - } - // Sortiere nach Score (absteigend) und gebe Top 5 zurück - List result = bestMatches.values().stream() - .sorted((a, b) -> Float.compare(b.getScore(), a.getScore())) - .limit(maxResults) - .peek(match -> { - System.out.println("--------------"); - System.out.println("- $UniqueID: " + match.getUniqueId()); - System.out.println("- Relevance Score: " + match.getScore()); - System.out.println(""); - System.out.println("- Best Matching Content: "); - System.out.println(match.getContent()); - System.out.println(""); - }) - .collect(Collectors.toList()); - - logger.info("│ ├── ✅ Retrieved " + result.size() + " relevant documents"); - return result; - - } catch (Exception e) { - throw new ClusterException(ClusterException.CLUSTER_ERROR, - "Failed to select embeddings from keyspace: " + e.getMessage(), e); - } - } - - public List searchEmbeddings(List embedding, - int maxResults) throws ClusterException { - - return searchEmbeddings(embedding, maxResults, null, null, null, null); - } - - // Range-based search - public List searchEmbeddingsWithTaskRange(List embedding, int maxResults, - List modelVersions, - int taskIdStart, int taskIdEnd) - throws ClusterException { - return searchEmbeddings(embedding, maxResults, modelVersions, null, taskIdStart, taskIdEnd); - } - - // Wildcard model search - public List searchEmbeddingsWithModelWildcard(List embedding, int maxResults, - String modelPattern, - List taskIds) - throws ClusterException { - return searchEmbeddings(embedding, maxResults, Arrays.asList(modelPattern), taskIds, null, null); - } - - /** - * Update the workflow meta data. The method returns true if a index with the - * given uniqueId was found - * - * @param uniqueId - * @param modelVersion - * @param taskId - * @return true if an update was performed - * @throws ClusterException - */ - public boolean updateMetaData(String uniqueId, String modelVersion, int taskId) - throws ClusterException { - - // Prepare statements if not already done - if (selectChunksStmt == null) { - String selectQuery = "SELECT chunk_id FROM document_vectors WHERE id = ?"; - selectChunksStmt = session.prepare(selectQuery); - } - - if (updateChunkStmt == null) { - String updateQuery = "UPDATE document_vectors SET model_version = ?, task_id = ? WHERE id = ? AND chunk_id = ?"; - updateChunkStmt = session.prepare(updateQuery); - } - try { - // 1. Alle chunk_ids für die uniqueId ermitteln - BoundStatement selectBoundStmt = selectChunksStmt.bind(uniqueId); - ResultSet resultSet = session.execute(selectBoundStmt); - - List chunkIds = new ArrayList<>(); - for (Row row : resultSet) { - chunkIds.add(row.getUuid("chunk_id")); - } - - if (chunkIds.isEmpty()) { - logger.info("│ ├── ℹ️ No entries found for uniqueID: " + uniqueId); - return false; - } - - // 2. Jede gefundene chunk_id einzeln updaten - int updateCount = 0; - for (UUID chunkId : chunkIds) { - BoundStatement updateBoundStmt = updateChunkStmt.bind(modelVersion, taskId, uniqueId, chunkId); - session.execute(updateBoundStmt); - updateCount++; - } - - logger.info("│ ├── Updated metadata for " + updateCount + " entries with uniqueID: " + - uniqueId + " (model: " + modelVersion + ", task: " + taskId + ")"); - return true; - - } catch (Exception e) { - throw new ClusterException(ClusterException.CLUSTER_ERROR, - "Failed to update metadata for uniqueID '" + uniqueId + "': " + e.getMessage(), e); - } - - } - - /** - * Helper method to prepare a IN clause - * - * @param size - * @return - */ - private String formatInClause(int size) { - return "(" + String.join(",", Collections.nCopies(size, "?")) + ")"; - } - - /** - * Helper method to build a key for specific select statement with parameters. - * This key is used to cache prepared statements - * - * @param dbLimit - * @param modelVersions - * @param taskIds - * @param taskIdRangeStart - * @param taskIdRangeEnd - * @return - */ - private String buildStatementKey(int dbLimit, List modelVersions, List taskIds, - Integer taskIdRangeStart, Integer taskIdRangeEnd) { - StringBuilder keyBuilder = new StringBuilder("search_").append(dbLimit); - - if (modelVersions != null) { - keyBuilder.append("_mv").append(modelVersions.size()); - // Add wildcard indicator - long wildcardCount = modelVersions.stream().mapToLong(mv -> mv.endsWith("*") ? 1 : 0).sum(); - keyBuilder.append("w").append(wildcardCount); - } - - if (taskIds != null && !taskIds.isEmpty()) { - keyBuilder.append("_ti").append(taskIds.size()); - } else if (taskIdRangeStart != null || taskIdRangeEnd != null) { - keyBuilder.append("_tr"); - if (taskIdRangeStart != null) - keyBuilder.append("s"); - if (taskIdRangeEnd != null) - keyBuilder.append("e"); - } - - return keyBuilder.toString(); - } -} diff --git a/dynamixs-ai-rag/src/main/java/ai/dynamixs/rag/cluster/RetrievalResult.java b/dynamixs-ai-rag/src/main/java/ai/dynamixs/rag/cluster/RetrievalResult.java deleted file mode 100644 index 4078c98..0000000 --- a/dynamixs-ai-rag/src/main/java/ai/dynamixs/rag/cluster/RetrievalResult.java +++ /dev/null @@ -1,70 +0,0 @@ -package ai.dynamixs.rag.cluster; - -/** - * Represents a single result from a semantic search operation in the RAG - * (Retrieval-Augmented Generation) system. - * - * This immutable data class encapsulates the information about a document that - * was retrieved based on semantic similarity to a query. Each result contains - * the document's unique identifier, the content of the best matching chunk, and - * the similarity score that indicates how well the document matches the search - * query. - * - *

- * The similarity score is typically a cosine similarity value between the query - * embedding and the document's content embedding, where higher values indicate - * better matches. - *

- * - *

- * Usage Example: - *

- * - * 
{@code
- * List results = searchEmbeddings(queryVector);
- * for (RetrievalResult result : results) {
- *     System.out.println("Document: " + result.getUniqueId() +
- *             " (Score: " + result.getScore() + ")");
- *     System.out.println("Content: " + result.getContent());
- * }
- * }
- * - * @author Your Name - * @version 1.0 - * @since 1.0 - * @see #getUniqueId() - * @see #getContent() - * @see #getScore() - */ -public class RetrievalResult { - private final String uniqueId; - private final String content; - private final Float score; - - public RetrievalResult(String uniqueID, String content, Float score) { - this.uniqueId = uniqueID; - this.content = content; - this.score = score; - } - - public String getUniqueId() { - return uniqueId; - } - - public String getContent() { - return content; - } - - public Float getScore() { - return score; - } - - @Override - public String toString() { - return "RetrievalResult{" + - "$uniqueId='" + uniqueId + '\'' + - ", score=" + score + - ", content='" + content.substring(0, Math.min(50, content.length())) + "...'" + - '}'; - } -} diff --git a/dynamixs-ai-rag/src/main/java/ai/dynamixs/rag/events/RAGEventScheduler.java b/dynamixs-ai-rag/src/main/java/ai/dynamixs/rag/events/RAGEventScheduler.java deleted file mode 100644 index 0e1b5e7..0000000 --- a/dynamixs-ai-rag/src/main/java/ai/dynamixs/rag/events/RAGEventScheduler.java +++ /dev/null @@ -1,145 +0,0 @@ -/* - * Imixs-Workflow - * - * Copyright (C) 2001-2020 Imixs Software Solutions GmbH, - * http://www.imixs.com - * - * This program is free software; you can redistribute it and/or - * modify it under the terms of the GNU General Public License - * as published by the Free Software Foundation; either version 2 - * of the License, or (at your option) any later version. - * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - * General Public License for more details. - * - * You can receive a copy of the GNU General Public - * License at http://www.gnu.org/licenses/gpl.html - * - * Project: - * https://www.imixs.org - * https://github.com/imixs/imixs-workflow - * - * Contributors: - * Imixs Software Solutions GmbH - Project Management - * Ralph Soika - Software Developer - */ - -package ai.dynamixs.rag.events; - -import static org.imixs.workflow.engine.AsyncEventSchedulerConfig.ASYNCEVENT_PROCESSOR_DEADLOCK; -import static org.imixs.workflow.engine.AsyncEventSchedulerConfig.ASYNCEVENT_PROCESSOR_ENABLED; -import static org.imixs.workflow.engine.AsyncEventSchedulerConfig.ASYNCEVENT_PROCESSOR_INITIALDELAY; -import static org.imixs.workflow.engine.AsyncEventSchedulerConfig.ASYNCEVENT_PROCESSOR_INTERVAL; - -import java.util.logging.Level; -import java.util.logging.Logger; - -import org.eclipse.microprofile.config.inject.ConfigProperty; -import org.imixs.workflow.engine.AsyncEventService; -import org.imixs.workflow.engine.EventLogService; - -import jakarta.annotation.PostConstruct; -import jakarta.annotation.Resource; -import jakarta.annotation.security.DeclareRoles; -import jakarta.annotation.security.RunAs; -import jakarta.ejb.Singleton; -import jakarta.ejb.Startup; -import jakarta.ejb.Timeout; -import jakarta.ejb.Timer; -import jakarta.ejb.TimerConfig; -import jakarta.ejb.TimerService; -import jakarta.inject.Inject; - -/** - * The RAGEventScheduler starts a scheduler service to process RAG events in an - * asynchronous way by calling the RAGEventService. - *

- * The AsyncEventScheduler runs on a non-persistent ejb timer with the same - * interval settings as the AsyncEventProcessor - *

- * RAGEventScheduler 'ASYNCEVENT_PROCESSOR_INTERVAL' and an optional delay - * defined by 'ASYNCEVENT_PROCESSOR_INITIALDELAY'. To enable the processor - * 'ASYNCEVENT_PROCESSOR_ENABLED' must be set to true (default=false). - * 'ASYNCEVENT_PROCESSOR_DEADLOCK' deadlock timeout - *

- * In a clustered environment this timer runs in each cluster member that - * contains the EJB. So this means the non-persistent EJB Timer scales - * horizontal within a clustered environment – e.g. a Kubernetes cluster. - * - * @see AsyncEventService - * @version 1.1 - * @author rsoika - * - */ -@DeclareRoles({ "org.imixs.ACCESSLEVEL.MANAGERACCESS" }) -@RunAs("org.imixs.ACCESSLEVEL.MANAGERACCESS") -@Startup -@Singleton -public class RAGEventScheduler { - - // enabled - @Inject - @ConfigProperty(name = ASYNCEVENT_PROCESSOR_ENABLED, defaultValue = "false") - boolean enabled; - - // timeout interval in ms - @Inject - @ConfigProperty(name = ASYNCEVENT_PROCESSOR_INTERVAL, defaultValue = "1000") - long interval; - - // initial delay in ms - @Inject - @ConfigProperty(name = ASYNCEVENT_PROCESSOR_INITIALDELAY, defaultValue = "0") - long initialDelay; - - // deadlock timeout interval in ms - @Inject - @ConfigProperty(name = ASYNCEVENT_PROCESSOR_DEADLOCK, defaultValue = "60000") - long deadLockInterval; - - private static final Logger logger = Logger.getLogger(RAGEventScheduler.class.getName()); - - @Resource - TimerService timerService; - - @Inject - RAGEventService ragEventService; - - @Inject - EventLogService eventLogService; - - @PostConstruct - public void init() { - if (enabled) { - - // Registering a non-persistent Timer Service. - final TimerConfig timerConfig = new TimerConfig(); - timerConfig.setInfo("Imixs-Workflow AsyncEventScheduler"); - timerConfig.setPersistent(false); - timerService.createIntervalTimer(initialDelay, interval, timerConfig); - logger.log(Level.INFO, "├── ✅ Started RAGEventScheduler - initalDelay={0} inverval={1}", - new Object[] { initialDelay, interval }); - - } - } - - /** - * The method delegates the event processing to the stateless ejb - * AsyncEventProcessor. - *

- * Before processing the eventLog the method releases possible dead locks first. - * Both methods are running in separate transactions - * - */ - @Timeout - public void run(Timer timer) { - eventLogService.releaseDeadLocks(deadLockInterval, - RAGEventService.EVENTLOG_TOPIC_RAG_EVENT_INDEX, - RAGEventService.EVENTLOG_TOPIC_RAG_EVENT_UPDATE, - RAGEventService.EVENTLOG_TOPIC_RAG_EVENT_DELETE); - ragEventService.processEventLog(); - } - -} diff --git a/dynamixs-ai-rag/src/main/java/ai/dynamixs/rag/events/RAGEventService.java b/dynamixs-ai-rag/src/main/java/ai/dynamixs/rag/events/RAGEventService.java deleted file mode 100644 index 8071dde..0000000 --- a/dynamixs-ai-rag/src/main/java/ai/dynamixs/rag/events/RAGEventService.java +++ /dev/null @@ -1,214 +0,0 @@ -/* - * Imixs-Workflow - * - * Copyright (C) 2001-2020 Imixs Software Solutions GmbH, - * http://www.imixs.com - * - * This program is free software; you can redistribute it and/or - * modify it under the terms of the GNU General Public License - * as published by the Free Software Foundation; either version 2 - * of the License, or (at your option) any later version. - * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - * General Public License for more details. - * - * You can receive a copy of the GNU General Public - * License at http://www.gnu.org/licenses/gpl.html - * - * Project: - * https://www.imixs.org - * https://github.com/imixs/imixs-workflow - * - * Contributors: - * Imixs Software Solutions GmbH - Project Management - * Ralph Soika - Software Developer - */ - -package ai.dynamixs.rag.events; - -import java.util.List; -import java.util.logging.Level; -import java.util.logging.Logger; - -import org.imixs.ai.workflow.OpenAIAPIService; -import org.imixs.workflow.ItemCollection; -import org.imixs.workflow.engine.AsyncEventScheduler; -import org.imixs.workflow.engine.EventLogService; -import org.imixs.workflow.engine.WorkflowService; -import org.imixs.workflow.engine.jpa.EventLog; -import org.imixs.workflow.exceptions.PluginException; - -import ai.dynamixs.rag.RAGUtil; -import ai.dynamixs.rag.cluster.ClusterException; -import ai.dynamixs.rag.cluster.ClusterService; -import jakarta.annotation.security.DeclareRoles; -import jakarta.annotation.security.RolesAllowed; -import jakarta.ejb.Stateless; -import jakarta.ejb.TransactionAttribute; -import jakarta.ejb.TransactionAttributeType; -import jakarta.inject.Inject; -import jakarta.persistence.OptimisticLockException; - -/** - * The AsyncEventService can be used to process workflow events in an - * asynchronous batch process. The AsyncEventService lookup eventLog entries of - * the topic "async.event". - *

- * The processor look up the workItem and starts a processing life cycle. - *

- * The AsyncEventService is called only by the AsyncEventScheduler which is - * implementing a ManagedScheduledExecutorService. - *

- * To prevent concurrent processes to handle the same workitems the batch - * process uses a Optimistic lock strategy. After fetching new event log entries - * the processor updates the eventLog entry in a new transaction and set the - * topic to 'batch.process.lock'. After that update we can be sure that no other - * process is dealing with these entries. After completing the processing step - * the eventlog entry will be removed. - *

- * To avoid ad deadlock the processor set an expiration time on the lock, so the - * lock will be auto-released after 1 minute (batch.processor.deadlock). - * - * @see AsyncEventScheduler - * @version 1.0 - * @author rsoika - * - */ -@DeclareRoles({ "org.imixs.ACCESSLEVEL.NOACCESS", "org.imixs.ACCESSLEVEL.READERACCESS", - "org.imixs.ACCESSLEVEL.AUTHORACCESS", "org.imixs.ACCESSLEVEL.EDITORACCESS", - "org.imixs.ACCESSLEVEL.MANAGERACCESS" }) -@RolesAllowed({ "org.imixs.ACCESSLEVEL.NOACCESS", "org.imixs.ACCESSLEVEL.READERACCESS", - "org.imixs.ACCESSLEVEL.AUTHORACCESS", "org.imixs.ACCESSLEVEL.EDITORACCESS", - "org.imixs.ACCESSLEVEL.MANAGERACCESS" }) -@Stateless -public class RAGEventService { - - public static final String EVENTLOG_TOPIC_RAG_EVENT_INDEX = "rag.event.index"; - public static final String EVENTLOG_TOPIC_RAG_EVENT_DELETE = "rag.event.delete"; - public static final String EVENTLOG_TOPIC_RAG_EVENT_UPDATE = "rag.event.update"; - - private static final Logger logger = Logger.getLogger(RAGEventService.class.getName()); - - @Inject - EventLogService eventLogService; - - @Inject - private WorkflowService workflowService; - - @Inject - private ClusterService clusterService; - - @Inject - private OpenAIAPIService llmService; - - /** - * The method lookups for RAG event log entries and updates the RAG index - * information - *

- * Each eventLogEntry provides optional a prompt template - * - */ - @TransactionAttribute(value = TransactionAttributeType.REQUIRES_NEW) - public void processEventLog() { - long l = System.currentTimeMillis(); - - // test for new event log entries by timeout... - List events = eventLogService.findEventsByTimeout(100, - RAGEventService.EVENTLOG_TOPIC_RAG_EVENT_INDEX, - RAGEventService.EVENTLOG_TOPIC_RAG_EVENT_UPDATE, - RAGEventService.EVENTLOG_TOPIC_RAG_EVENT_DELETE); - - if (events.size() > 0) { - logger.log(Level.INFO, "├── 🔃 processing {0} RAG events....", events.size()); - - for (EventLog eventLogEntry : events) { - try { - - // first try to lock the eventLog entry.... - if (eventLogService.lock(eventLogEntry)) { - ItemCollection workitem = workflowService.getWorkItem(eventLogEntry.getRef()); - if (workitem == null) { - logger.log(Level.WARNING, "│ ├── ⚠️ unable to read workitem: " + eventLogEntry.getRef()); - eventLogService.removeEvent(eventLogEntry.getId()); - continue; - } - switch (eventLogEntry.getTopic()) { - case RAGEventService.EVENTLOG_TOPIC_RAG_EVENT_DELETE + ".lock": - // remove embeddings - clusterService.removeAllEmbeddings(eventLogEntry.getRef()); - break; - - case RAGEventService.EVENTLOG_TOPIC_RAG_EVENT_UPDATE + ".lock": - // update workflow status - clusterService.updateMetaData(eventLogEntry.getRef(), workitem.getModelVersion(), - workitem.getTaskID()); - break; - case RAGEventService.EVENTLOG_TOPIC_RAG_EVENT_INDEX + ".lock": - - // get indexDefinition - ItemCollection indexDefinition = new ItemCollection(eventLogEntry.getData()); - String llmAPIEndpoint = indexDefinition.getItemValueString("endpoint"); - boolean debug = indexDefinition.getItemValueBoolean("debug"); - // String llmPromptTemplate = - // indexDefinition.getItemValueString("promptTemplate"); - String llmPrompt = indexDefinition.getItemValueString("prompt"); - - if (debug) { - logger.info("│ ├── Total Prompt Length = " + llmPrompt.length()); - logger.info("│ ├── Prompt: "); - logger.info(llmPrompt); - } - - // remove old embeddings - clusterService.removeAllEmbeddings(workitem.getUniqueID()); - // chunk text.... - List chunk_list = RAGUtil.chunkMarkupDocument(llmPrompt); - for (String chunk : chunk_list) { - if (debug) { - logger.info("│ ├── 🔸 chunk: "); - logger.info(chunk); - } - List indexResult = llmService.postEmbedding(chunk, llmAPIEndpoint, debug); - // write to cassandra - clusterService.insertVector(workitem.getUniqueID(), - workitem.getModelVersion(), - workitem.getTaskID(), - chunk, - indexResult); - if (debug) { - logger.info("│ ├── ⇨ " + indexResult.size() + " floats stored in RAG db."); - } - } - break; - default: - // no op - } - - // finally remove the event log entry... - eventLogService.removeEvent(eventLogEntry.getId()); - } - - } catch (OptimisticLockException e) { - // lock was not possible - continue.... - logger.log(Level.INFO, "...unable to lock AsyncEvent: {0}", e.getMessage()); - } catch (ClusterException e) { - logger.log(Level.WARNING, e.getErrorCode() + " - " + e.getMessage()); - // remove the event log entry... - eventLogService.removeEvent(eventLogEntry.getId()); - } catch (PluginException e) { - logger.log(Level.WARNING, e.getErrorCode() + " - " + e.getMessage()); - // remove the event log entry... - eventLogService.removeEvent(eventLogEntry.getId()); - } - - } - - logger.log(Level.INFO, "├── ✅ {0} RAGEvents processed in {1}ms", - new Object[] { events.size(), System.currentTimeMillis() - l }); - - } - } - -} diff --git a/dynamixs-ai-rag/src/main/resources/META-INF/COPYRIGHT b/dynamixs-ai-rag/src/main/resources/META-INF/COPYRIGHT deleted file mode 100644 index 8a0be04..0000000 --- a/dynamixs-ai-rag/src/main/resources/META-INF/COPYRIGHT +++ /dev/null @@ -1,30 +0,0 @@ - Imixs-Office-Workflow - Copyright (C) 2001-2018 Imixs Software Solutions GmbH, - http://www.imixs.com - -This program is free software: you can redistribute it and/or modify -it under the terms of the GNU General Public License as published by -the Free Software Foundation, either version 3 of the License, or -(at your option) any later version. - -This program is distributed in the hope that it will be useful, -but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -GNU General Public License for more details. - -You should have received a copy of the GNU General Public License -along with this program. If not, see . - - - Project: - http://www.imixs.org - - Contributors: - Imixs Software Solutions GmbH - initial API and implementation - Ralph Soika - Software Developer - - - - - - diff --git a/dynamixs-ai-rag/src/main/resources/META-INF/LICENSE b/dynamixs-ai-rag/src/main/resources/META-INF/LICENSE deleted file mode 100644 index 810fce6..0000000 --- a/dynamixs-ai-rag/src/main/resources/META-INF/LICENSE +++ /dev/null @@ -1,621 +0,0 @@ - GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The GNU General Public License is a free, copyleft license for -software and other kinds of works. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -the GNU General Public License is intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. We, the Free Software Foundation, use the -GNU General Public License for most of our software; it applies also to -any other work released this way by its authors. You can apply it to -your programs, too. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - To protect your rights, we need to prevent others from denying you -these rights or asking you to surrender the rights. Therefore, you have -certain responsibilities if you distribute copies of the software, or if -you modify it: responsibilities to respect the freedom of others. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must pass on to the recipients the same -freedoms that you received. You must make sure that they, too, receive -or can get the source code. And you must show them these terms so they -know their rights. - - Developers that use the GNU GPL protect your rights with two steps: -(1) assert copyright on the software, and (2) offer you this License -giving you legal permission to copy, distribute and/or modify it. - - For the developers' and authors' protection, the GPL clearly explains -that there is no warranty for this free software. For both users' and -authors' sake, the GPL requires that modified versions be marked as -changed, so that their problems will not be attributed erroneously to -authors of previous versions. - - Some devices are designed to deny users access to install or run -modified versions of the software inside them, although the manufacturer -can do so. This is fundamentally incompatible with the aim of -protecting users' freedom to change the software. The systematic -pattern of such abuse occurs in the area of products for individuals to -use, which is precisely where it is most unacceptable. Therefore, we -have designed this version of the GPL to prohibit the practice for those -products. If such problems arise substantially in other domains, we -stand ready to extend this provision to those domains in future versions -of the GPL, as needed to protect the freedom of users. - - Finally, every program is threatened constantly by software patents. -States should not allow patents to restrict development and use of -software on general-purpose computers, but in those that do, we wish to -avoid the special danger that patents applied to a free program could -make it effectively proprietary. To prevent this, the GPL assures that -patents cannot be used to render the program non-free. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - - 13. Use with the GNU Affero General Public License. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU Affero General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the special requirements of the GNU Affero General Public License, -section 13, concerning interaction through a network will apply to the -combination as such. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU General Public License from time to time. Such new versions will -be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - - Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS diff --git a/dynamixs-ai-rag/src/main/resources/META-INF/beans.xml b/dynamixs-ai-rag/src/main/resources/META-INF/beans.xml deleted file mode 100644 index debd97c..0000000 --- a/dynamixs-ai-rag/src/main/resources/META-INF/beans.xml +++ /dev/null @@ -1,6 +0,0 @@ - - - \ No newline at end of file diff --git a/dynamixs-ai-rag/src/main/resources/copyright.txt b/dynamixs-ai-rag/src/main/resources/copyright.txt deleted file mode 100644 index c3f6c4f..0000000 --- a/dynamixs-ai-rag/src/main/resources/copyright.txt +++ /dev/null @@ -1,10 +0,0 @@ - Imixs Workflow Technology - Copyright (C) 2010 Imixs Software Solutions GmbH, - http://www.imixs.com - - - - Contributors: - Imixs Software Solutions GmbH - initial implementation - Ralph Soika - \ No newline at end of file diff --git a/dynamixs-ai-rag/src/main/resources/licence.txt b/dynamixs-ai-rag/src/main/resources/licence.txt deleted file mode 100644 index 88592e6..0000000 --- a/dynamixs-ai-rag/src/main/resources/licence.txt +++ /dev/null @@ -1 +0,0 @@ - ?? \ No newline at end of file