office-dynamixs-ai/doc/RAG_WORKFLOW.md

The RAG Workflow Integration

The RAG system is integrated via the BPMN Model. There are several ways how the RAG information can be indexed, updated and deleted.

Indexing

To index a process instance the Signal Adapter ai.dynamixs.rag.RAGIndexAdapter is used. The adapter expects a DataObject PromptDefinition associated with the corresponding event and a workflow configuration defining the LLM endpoint

<imixs-ai name="INDEX">
  <endpoint>https://llama.cpp2.imixs.com/</endpoint>
  <debug>true</debug>
</imixs-ai>

The debug flag is optional and can be set to true to log index information.

The PromptDefinition associated by a DataObject defines the text to generate the embeddings.

<?xml version="1.0" encoding="UTF-8"?>
<PromptDefinition>
  <prompt_options>{}</prompt_options>
  <prompt><![CDATA[<itemvalue>$workflowgroup</itemvalue>: <itemvalue>$workflowstatus</itemvalue>
<itemvalue>$workflowsummary</itemvalue>

# Summary
<itemvalue>$workflowabstract</itemvalue>

]]>
    </prompt>
</PromptDefinition>

The RAG System does not only store the embeddings but also the following Workflow Meta Information

• ModelVersion - the $modelversion item assigned to the process instance at the time of the indexing
• TaskId - the $taskId item assigned to the process instance at the time of the indexing

Note: The workflow meta information is generated at the time of the indexing and does not necessary match the current workflow status!

Update

To update the workflow metadata only, plugin class ai.dynamixs.rag.RAGIndexPlugin can be used. This plugin is used to update the workflow model version and the workflow status only but not the embedings. The update is only be performed if an index already exists.

The update is performed automatically in each workflow processing cycle. To disabled a metadata update in single specific event you can define the following workflow definition:

<rag-index name="DISABLE"></rag-index>

In this case the plugin will be disabled.

Delete

To delete a RAG index the plugin class ai.dynamixs.rag.RAGPlugin can be used in the DELETE mode:

<rag-index name="DELETE"></rag-index>

This will remove the index for the current workitem.