cpee-llm 1.0.1 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c74dfc59f0ee935ca13bbab9135b7bbbe573e378388b1b42bf7d7319822e3452
-  data.tar.gz: 3bebf8d541a090b0732954f70e7ee08a844c83fa6facbf58d686242b8e77e8e6
+  metadata.gz: 646927187c9c5794a457b8f0d41fbc9d791c5727a9c70ab58201959aa6617097
+  data.tar.gz: c39a4b3375b52eb5d546bc909a56d0396a5b35ac4a568e368d827eed55b76818
 SHA512:
-  metadata.gz: d6adbaf916b93cd4407ff97cf5fd7d2d72187e73c68c1fa57aece7235bc08cc88adb66227d9085fb91dfa19578af61a44736e06f9dfb43530b8dabce2c1839d8
-  data.tar.gz: ed95025c3b393da1b88596a5eb0e30b05706a8aaeda9e0b0736092e8d0e7c4379d1b09f2503a7eb55c8a962e690a9c49c863ff1c3a5a891462e2027da8055193
+  metadata.gz: bbda644521022ad10e07229ff3d22b73dad79ab9fae820fcf148db6791d68a775261e40ced4f15691fe779e5d9d198fd6a7e812ab48cd21c9b65a4fd038be22f
+  data.tar.gz: 80cbabf613f66a03da91eceeda7541730c833acf573c63315f827309fe97614774334e5681a102b53dc5c61ae96020b0cae2a8b45ee70bf808d7941880dc4d15

data/README.md

@@ -1,7 +1,185 @@
 # CPEE-LLM
 
-CPEE Conversational Agents
+This gem realizes the 3 CPEE Conversational Agents
 
 * CM-A for creating models
 * EP-A for selecting endpoints
 * DF-A for creating and validating dataflow
+
+# Installation
+
+```bash
+gem install --user cpee-llm
+mkdir ~/run
+cd ~/run
+cpee-llm new cllm # scaffold; you maybe need to add installed bins to PATH
+cd cllm
+vim cpee-llm.conf # only add the connect adapters you need
+vim connect_gemini # add your key
+vim connect_gpt # add your key
+vim connect_morpheus # add your key, and change url of you morpheus hosting
+# connect adapters can be added or deleted as you wish, see rubyllm for
+# possible config options. The myllm variable always contains the requested
+# model.
+./cpee-llm start
+```
+
+These commands install and scaffold a sample server. In the same directory you
+see a set of sample connectors.
+
+# Supported LLMs
+
+We support all LLMs that https://rubyllm.org supports. Check it out.
+
+---
+
+# 1. Text → Process Model
+
+```http
+POST https://cpee.org/llm/
+```
+
+Converts a textual process description into a process model or adapts an existing model.
+
+## Parameters
+
+| Parameter | Type | Description |
+|------------|------|-------------|
+| rpst_xml | text/xml | Existing CPEE XML model |
+| user_input | text/plain | Natural language process description |
+| llm | text/plain | LLM identifier |
+| prompt_type | text/plain | `generate_noendpoints` or `adapt_noendpoints` |
+| temperature | text/plain (optional) | Defaults to 0 |
+
+**Important:** Parameter order matters.
+
+rpst\_ xml contains the content of the  `<description>` tag from the CPEE testset
+
+### Empty RPST Example
+
+```xml
+<description xmlns="http://cpee.org/ns/description/1.0"/>
+```
+
+## Response
+
+```json
+{
+  "user_input": "...",
+  "used_llm": "...",
+  "input_cpee": "...",
+  "input_intermediate": "...",
+  "output_intermediate": "...",
+  "output_cpee": "...",
+  "status": "..."
+}
+```
+
+### Key Outputs
+
+- `output_intermediate` → generated process model in Mermaid .js format
+- `output_cpee` →  CPEE XML process model
+
+## cURL Example
+
+```bash
+curl -X POST https://cpee.org/llm/ \
+  -H 'Content-Type:multipart/form-data' \
+  -F "rpst_xml=@cpee_empty_example;type=text/xml" \
+  -F "user_input=Create task A after dismissal review.;type=text/plain" \
+  -F "llm=gemini-2.5-flash-lite;type=text/plain" \
+  -F "prompt_type=generate_noendpoints;type=text/plain"
+```
+
+---
+
+# 2. Process Model → Text
+
+
+```http
+POST https://cpee.org/llm/text/llm/
+```
+
+Generates a textual process description from a process model.
+
+## Parameters
+
+| Parameter | Type |
+|-----------|------|
+| rpst_xml | text/xml |
+| llm | string |
+
+## Response
+
+```json
+{
+  "input_cpee": "...",
+  "input_intermediate": "...",
+  "output_text": "...",
+  "status": "..."
+}
+```
+
+### Key Output
+
+- `output_text` → Generated process description
+
+## cURL Example
+
+```bash
+curl -X POST https://cpee.org/llm/text/llm/ \
+  -H 'Content-Type:multipart/form-data' \
+  -F "rpst_xml=@cpee_example;type=text/xml" \
+  -F "llm=gemini-2.5-flash-lite"
+```
+
+---
+
+# 3. Generic Functionality
+
+```http
+POST https://cpee.org/llm/generic/
+```
+
+Performs arbitrary LLM tasks using a system prompt and user input.
+
+## Parameters
+
+| Parameter | Type |
+|-----------|------|
+| llm | text/plain |
+| user_input | text/plain |
+| system_prompt | text/plain |
+| format | text/plain (`true`/`false`) |
+| temperature | text/plain (optional) |
+
+## Response
+
+```json
+{
+  "user_input": "...",
+  "used_llm": "...",
+  "system_prompt": "...",
+  "llm_response": "...",
+  "status": "..."
+}
+```
+
+### Notes
+
+- `format=true` requests JSON output (guarantees valid JSON but not any specific structure).
+
+List of supporteb providers: https://rubyllm.com/chat/#getting-structured-output
+
+## cURL Example
+
+```bash
+curl -X POST https://cpee.org/llm/generic/ \
+  -H 'Content-Type:multipart/form-data' \
+  -F "llm=mistralai/Ministral-3-14B-Reasoning-2512;type=text/plain" \
+  -F "user_input=The MPON sends the dismissal to the MPOO.;type=text/plain" \
+  -F "system_prompt=Return the list of tasks.;type=text/plain" \
+  -F "format=false;type=text/plain"
+```
+
+---

data/cpee-llm.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name             = "cpee-llm"
-  s.version          = "1.0.1"
+  s.version          = "1.0.4"
   s.platform         = Gem::Platform::RUBY
   s.license          = "LGPL-3.0-or-later"
   s.summary          = "CPEE Conversational Agents"
@@ -13,7 +13,7 @@ Gem::Specification.new do |s|
   s.bindir           = 'tools'
   s.executables      = ['cpee-llm']
 
-  s.required_ruby_version = '>=3.4'
+  s.required_ruby_version = '>=3.2'
 
   s.authors          = ['Nataliia Klievtsova', 'Matthias Ehrendorfer', 'Juergen eTM Mangler']
 
@@ -26,4 +26,5 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'typhoeus', '~> 1.4'
   s.add_runtime_dependency 'ruby_llm', '~> 1.15'
   s.add_runtime_dependency 'rag_embeddings', '~> 0'
+  s.add_runtime_dependency 'cpee-transformation', '~> 1.0'
 end

data/lib/cpee/llm/dataflow.rb

@@ -165,8 +165,6 @@ module CPEE
           end
         end
 
-        pp json_e
-        pp cpee_model
         # ==============================conditions (only alternative)=======================
         json_e['gateway_conditions'].each do |i, value|
           if i.end_with?("s")

data/lib/cpee/llm/functions.rb

@@ -16,6 +16,9 @@
 
 require_relative 'rubyllm_requests'
 require 'json'
+require 'cpee/transformation/transformer'
+require 'cpee/transformation/cpee'
+require 'cpee/transformation/mermaid'
 
 module CPEE
 
@@ -25,34 +28,22 @@ module CPEE
 
       include RubyLLM_Requests
 
-        def cpee_to_mermaid(cpee) #{{{
-          srv = Riddl::Client.new('http://localhost:9295/mermaid/cpee')
-          status, res = srv.post [
-            Riddl::Parameter::Complex.new("description","text/xml",cpee),
-            Riddl::Parameter::Simple.new("type","description")
-          ]
-          if status >= 200 && status < 300
-            res
-          else
-            raise 'error when converting cpee to mermaid'
-          end
-          return res[0].value().read()
-        end #}}}
-
-        def mermaid_to_cpee(mermaid) #{{{
-          srv = Riddl::Client.new('http://localhost:9295/cpee/mermaid')
-          status, res = srv.post [
-            Riddl::Parameter::Complex.new("description","text/plain",mermaid),
-            Riddl::Parameter::Simple.new("type","description")
-          ]
-          if status >= 200 && status < 300
-            res
-          else
-            raise 'error when converting mermaid to cpee'
-          end
-          return res[0].value().read()
-        end #}}}
+      def cpee_to_mermaid(cpee) #{{{
+        model = CPEE::Transformation::Source::CPEE.new(cpee)
+        trans = CPEE::Transformation::Transformer.new(model)
+        traces = trans.build_traces
+        tree = trans.build_tree(false)
+        trans.generate_model(CPEE::Transformation::Target::Mermaid)
+      end #}}}
+      def mermaid_to_cpee(mermaid) #{{{
+        model = CPEE::Transformation::Source::Mermaid.new(mermaid)
+
+        trans = CPEE::Transformation::Transformer.new(model)
+        traces = trans.build_traces
 
+        tree = trans.build_tree(false)
+        trans.generate_model(CPEE::Transformation::Target::CPEE)
+      end #}}}
 
       def generate_model(myllm,user_input,temperature,llms) #{{{
         begin
@@ -178,10 +169,8 @@ module CPEE
             llm_response = inside.empty? ? llm_response : inside[0][1]
             #check if response is json:
             begin
-              pp "here"
               hash = JSON.parse(llm_response)
             rescue JSON::ParserError => e
-              pp "there"
               raise LLMError.new("Something went wrong and llm was not able to generate Json data flow: #{llm_response}", 500)
             end
             return llm_response

data/lib/cpee/llm/implementation.rb

@@ -41,7 +41,6 @@ module CPEE
         temperature = @p.shift.value.read if @p[0]&.name == 'temperature'
 
         doc = XML::Smart.string(input_cpee)
-        pp temperature
         begin
           output_cpee = if prompt_type == 'generate_noendpoints'
             llm_response = generate_model(myllm,user_input,temperature,llms)
@@ -64,7 +63,6 @@ module CPEE
 
         return(Riddl::Parameter::Complex.new("llm_out","application/json",{:user_input => user_input, :used_llm => myllm, :input_cpee => input_cpee, :input_intermediate => doc.root().empty?() ? "" : cpee_to_mermaid(doc.to_s()), :output_intermediate => llm_response, :output_cpee => output_cpee, :status => "Success"}.to_json()))
       rescue LLMError => e
-        pp 'here in error'
         @status = e&.http_response || 400
         return Riddl::Parameter::Complex.new("llm_out","application/json",{ :error => "#{prompt_type} #{e.message}"}.to_json())
       end
@@ -166,7 +164,6 @@ module CPEE
         begin
           dataflow = generate_dataflow(myllm,mermaid_model,api_speck,llms)
         rescue LLMError => e
-          pp e.http_response
           @status = e.http_response || 400
           return Riddl::Parameter::Complex.new("llm_out","application/json",{:error => e.message}.to_json())
         end

data/lib/cpee/llm/rubyllm_requests.rb

@@ -92,8 +92,6 @@ module CPEE
       def generate_mermaid_model(llm, user_input, temperature, llms={}) #{{{
         max_tokens = 4000
         temperature = temperature.nil? ? 0.1 : temperature.to_f
-        pp "here"
-        pp temperature
         system_prompt = File.read(File.join(__dir__,"prompts/generate1.txt"))
         user_prompt = "Consider following process description: #{user_input}. Generate a BPMN model in Mermaid.js format."
         new_mermaid = generate_content(llm,system_prompt,user_prompt,max_tokens,temperature,llms)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cpee-llm
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.4
 platform: ruby
 authors:
 - Nataliia Klievtsova
@@ -95,6 +95,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: cpee-transformation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 description: see http://cpee.org
 email: n.klievtsova@gmail.com
 executables:
@@ -143,7 +157,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.4'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="