cpee-llm 1.0.2 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e0d18f88f4bc0727522bc34d61c10df0e565d1eb07c741d5205cdf2028b1b8b
-  data.tar.gz: 00e8d8cd775a32eed1a95b0b10497c506af54cfc20c9eafd37a1f0b971af5c78
+  metadata.gz: 646927187c9c5794a457b8f0d41fbc9d791c5727a9c70ab58201959aa6617097
+  data.tar.gz: c39a4b3375b52eb5d546bc909a56d0396a5b35ac4a568e368d827eed55b76818
 SHA512:
-  metadata.gz: 7f687a3d87195bc7780ec21c21ad5b24dbbaf8b406c5268b41fe991a3bf47c4bcbf9298bb3cdf227d9e0be80aad852add68d868023ba03ff52f0db07d39207d1
-  data.tar.gz: 00d10455ce802848328d76d9f6312260d6ffba07639348218dc91ef9d1720af07673f32d55599201eb3d3701fc4bed75c9a63d813bff39ca568720c6d3d5f7cf
+  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.2"
+  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']
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cpee-llm
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.4
 platform: ruby
 authors:
 - Nataliia Klievtsova
@@ -157,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:
   - - ">="