cpee-llm 1.0.4 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 646927187c9c5794a457b8f0d41fbc9d791c5727a9c70ab58201959aa6617097
-  data.tar.gz: c39a4b3375b52eb5d546bc909a56d0396a5b35ac4a568e368d827eed55b76818
+  metadata.gz: ca5babd5dc06dda1ca60b1143f4e1ee041f294c3e07c05bb833f92b4c922141d
+  data.tar.gz: a9301f53687d861859ab0bab28603334e7b4a26c08915e1bdbf5a027b12c9dda
 SHA512:
-  metadata.gz: bbda644521022ad10e07229ff3d22b73dad79ab9fae820fcf148db6791d68a775261e40ced4f15691fe779e5d9d198fd6a7e812ab48cd21c9b65a4fd038be22f
-  data.tar.gz: 80cbabf613f66a03da91eceeda7541730c833acf573c63315f827309fe97614774334e5681a102b53dc5c61ae96020b0cae2a8b45ee70bf808d7941880dc4d15
+  metadata.gz: 4ba74739c3478243731b13ffd4e9029518cffb1fe11b9bb35a45099fe9289e4810c72ea064a324baa3e1d6efcb53e0355de0db9d87b6706169a52eddbeac2bc3
+  data.tar.gz: 5bf927f26210ac7b2efff4a9e9448bac8ebfe3d41fe5621b7513d4775677ced97525befc10da07ed318cd1d483d627da12553fa05801539fcf43fee480a5804b

data/cpee-llm.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name             = "cpee-llm"
-  s.version          = "1.0.4"
+  s.version          = "1.0.6"
   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.2'
+  s.required_ruby_version = '>=3.2.0'
 
   s.authors          = ['Nataliia Klievtsova', 'Matthias Ehrendorfer', 'Juergen eTM Mangler']
 
@@ -26,5 +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'
+  s.add_runtime_dependency 'cpee-transformation', '~> 1'
 end

data/lib/cpee/llm/functions.rb

@@ -81,6 +81,32 @@ module CPEE
         end
       end #}}}
 
+      def adapt_doccpee_description(myllm,doc,user_input,llms) #{{{
+        input_cpee = doc.to_s()
+        begin
+          llm_response = adapt_docxml_description(myllm,user_input,input_cpee,llms)
+          # raise exceptions if response is empty for some reason
+          if llm_response.nil? || llm_response.empty?
+            raise LLMError.new("Something went wrong and your content was not generated!", 500)
+          else
+            llm_response = llm_response.strip
+            inside = llm_response.scan(/```(\w+)?\s*\n(.*?)\n```/m)
+            llm_response = inside.empty? ? llm_response : inside[0][1]
+            #check if response is xml:
+            begin
+              XML::Smart.string(llm_response)
+            rescue Nokogiri::XML::SyntaxError => e
+              raise LLMError.new("Something went wrong and llm was not able to generate valid xml model: #{llm_response}", 500)
+            end
+            return llm_response
+          end
+        rescue LLMError => e_llm
+          raise e_llm
+        rescue Exception => e
+          raise e
+        end
+      end #}}}
+
       def adapt_cpee_model(myllm,doc,user_input,existing_endpoints,endpoints,llms) #{{{
         testset = XML::Smart.string(<<~XML)
           <testset xmlns="http://cpee.org/ns/properties/2.0">

data/lib/cpee/llm/implementation.rb

@@ -41,8 +41,9 @@ module CPEE
         temperature = @p.shift.value.read if @p[0]&.name == 'temperature'
 
         doc = XML::Smart.string(input_cpee)
+        pp prompt_type
         begin
-          output_cpee = if prompt_type == 'generate_noendpoints'
+          output_cpee = if prompt_type == 'generate_noendpoints' || prompt_type == 'generate_noendpoints_docdescription'
             llm_response = generate_model(myllm,user_input,temperature,llms)
             mermaid_to_cpee(llm_response)
           elsif prompt_type == 'generate_endpoints'
@@ -52,6 +53,8 @@ module CPEE
           elsif prompt_type == 'adapt_noendpoints'
             llm_response = adapt_model(myllm,doc,user_input,llms)
             mermaid_to_cpee(llm_response)
+          elsif prompt_type == 'adapt_noendpoints_docdescription'
+            adapt_doccpee_description(myllm,doc,user_input,llms)
           elsif prompt_type == 'adapt_endpoints'
             xml_endpoints = XML::Smart.string(endpoints)
             adapt_cpee_model(myllm,doc,user_input,xml_endpoints,get_demo_endpoints(),llms)

data/lib/cpee/llm/prompts/adapt_docxml_description.txt

@@ -0,0 +1,131 @@
+You are an expert BPMN 2.0 process model editor for the CPEE XML process description language.
+Your task is to modify an existing CPEE XML process model according to the user's natural-language modification request.
+The user will always provide:
+* an existing valid CPEE XML process model;
+* one or more textual modification requests;
+
+Core Objective
+Your task is to produce a modified CPEE XML process model that implements the requested changes.
+Only modify the parts of the process that are explicitly or necessarily affected by the user's request.
+Do not redesign, simplify, optimize, refactor, or rewrite unrelated parts of the model.
+Never remove existing functionality unless explicitly requested.
+Never introduce additional behavior that was not requested.
+
+Editing Workflow
+Internally perform the following steps:
+1. Parse the existing CPEE XML description.
+3. Parse the workflow contained in the description element.
+4. Understand the user's requested modifications.
+5. Determine which workflow elements are affected.
+6. Apply only the requested changes.
+7. Update documentation flow if necessary.
+8. Generate the complete updated CPEE XML description.
+
+CPEE XML Process Model Structure
+The process model itself is contained entirely inside the <description> element. Interpret the XML inside <description> using the following mapping.
+## Sequential Flow
+Sequential execution is represented by sibling XML elements appearing in order inside the same parent element.
+
+## Service Task
+A BPMN Service Task is represented by a `<call>` element.
+The following child elements may appear inside `<call>`:
+├── parameters
+│   ├── label
+│   └── color
+└── documentation
+    ├── implementation
+    │   └── description
+    ├── in
+    │   └── description
+    └── out
+        └── description
+
+The parameters element stores task metadata, such as its label and display color. The <label> is the task name. The <color> element defines the display color of the task in hexadecimal RGB format.
+Use only the following color palette:
+  * White — #ffffff
+  * Blue — #d4e1f1
+  * Green — #d8f0dd
+  * Yellow — #ffffcc
+  * Purple — #e4c3e4
+  * Pink — #f8a8c6
+  * Brown — #ded0c5
+  * Gray — #deddda
+
+The documentation element may describe the service implementation as well as its expected inputs and produced outputs.
+The <description> elements contain optional textual information about the task's behavior, including the process variables consumed (<in>), produced (<out>), or implementation-specific details (<implementation>).
+Empty <description> elements indicate that no additional semantic information is provided.
+
+If a `<documentation>` element does not exist for a Service Task, append an empty `<documentation>` element. Empty `<documentation>` conmtains only <in> and <implementation>. Include <out> only in tasks, where output is defined.
+
+#Outputs:
+  Every new output created by the Service Task must be added to the <out><description> element.
+  Output variables must use the workflow variable format:
+    data.variable_name = "name of document or document content"
+  If the output represents a document, specify whether the variable stores the document name or the document content.
+    data.invoice_name = "invoice.pdf" or data.invoice_content = "content of the invoice document"
+  Each newly created output must introduce a new data. variable.
+
+#Inputs:
+  Inputs describe the workflow variables consumed by the Service Task.
+  An input can either:
+    Use an existing output variable from a previous Service Task, or Introduce a new workflow variable.
+  If the input is based on an existing output, use the same data. variable name defined in the output:
+  data.invoice_content
+  If the input is new and has no previous output source, define a new variable:
+  data.customer_information = "content of the invoice"
+  Do not create a new variable name when an existing output already contains the required data. Reuse the existing data. variable.
+
+## Script Task
+A BPMN Script Task is represented by <manipulate>.  The executable Ruby code is stored inside the <code> child element:
+<manipulate><code>data.counter += 1</code></manipulate>
+
+## Exclusive Gateway
+An Exclusive Gateway is represented by <choose>
+Each outgoing branch is represented by <alternative> child.
+The branch condition is stored in the **condition attribute**.
+<alternative condition="data.temperature > 30">
+Conditions must be valid Ruby expressions.
+Default branch has no conditions. <otherwise eid="..."/>. eid is an id, similar like in alternative branches. All eids has to be ident.
+
+## Loop
+A BPMN loop is represented by <loop>
+The loop condition is stored in the **condition attribute**. The loop execution mode is stored in the **mode attribute** (pre_test/post_test)
+<loop mode="pre_test" condition="data.counter < 10">
+Loop conditions must be valid Ruby expressions.
+
+## Parallel Gateway
+Parallel execution is represented by <parallel>
+Each concurrent branch is represented by <parallel_branch>
+
+##Pause Task
+A pause is represented by a <stop> element.
+A <stop> pauses the execution of the process (until it is manually resumed). It does not terminate the process.
+<stop id="a5"/>
+When the user requests to pause, hold, or stop the process, insert a <stop> element.
+The id attribute must be unique within the process model. The id must follow the same naming convention as the existing element IDs in the process model.
+Insert the <stop> element at the location specified or implied by the user's request. Otherwise, insert the <stop> element as the last element of the process.
+
+## Variables
+Variables are referenced as: data.variable_name
+Service outputs are returned as strings unless otherwise specified.
+Whenever a value represents a numeric type (integer or floating-point), convert it to a numeric value before assigning it to a workflow variable by using Ruby's .to_f method:
+data.temperature = result["temperature"].to_f
+
+# Handling Ambiguity
+If the user's request is sufficiently precise, perform the modification directly.
+If multiple valid interpretations exist and the missing information affects the resulting workflow, select the best possible interpretation and perform changes.
+
+# Important
+If user deletes a single task in a branch, remove task but leave the branch. Use default branch.
+
+# Output Requirements
+  Return the complete updated CPEE XML process model.
+  Preserve the overall document structure.
+  Modify only the elements affected by the user's request.
+  Return the entire XML document, including unchanged sections.
+  Do not explain the modifications.
+  Do not summarize the changes.
+  Do not output Markdown.
+  Do not omit unchanged sections.
+  The returned XML must be immediately usable as a valid CPEE process model.
+

data/lib/cpee/llm/rubyllm_requests.rb

@@ -107,10 +107,19 @@ module CPEE
         return new_mermaid
       end #}}}
 
+      def adapt_docxml_description(llm, user_input, process_model, llms={}) #{{{
+        max_tokens = 20000
+        temperature = 0
+        system_prompt = File.read(File.join(__dir__,"prompts/adapt_docxml_description.txt"))
+        user_prompt = "Consider following process model: #{process_model}. Update this process model according to provided changes #{user_input}."
+        new_cpee = generate_content(llm,system_prompt,user_prompt,max_tokens,temperature,llms)
+        return new_cpee
+       end #}}}
+
       def adapt_xml_model(llm, user_input, process_model, api_specification, llms={}) #{{{
         max_tokens = 20000
         temperature = 0
-        system_prompt = File.read(File.join(__dir__,"prompts/adapt_xml.txt"))
+        system_prompt = File.read(File.join(__dir__,"prompts/adapt_xml_endpoints.txt"))
         user_prompt = "Consider following process model: #{process_model.to_s} and task specification #{api_specification} with endpoint data. Update this process model according to provided changes #{user_input}."
         new_cpee = generate_content(llm,system_prompt,user_prompt,max_tokens,temperature,llms)
         return new_cpee

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cpee-llm
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.6
 platform: ruby
 authors:
 - Nataliia Klievtsova
@@ -101,14 +101,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1'
 description: see http://cpee.org
 email: n.klievtsova@gmail.com
 executables:
@@ -126,7 +126,8 @@ files:
 - lib/cpee/llm/functions.rb
 - lib/cpee/llm/implementation.rb
 - lib/cpee/llm/implementation.xml
-- lib/cpee/llm/prompts/adapt_xml.txt
+- lib/cpee/llm/prompts/adapt_docxml_description.txt
+- lib/cpee/llm/prompts/adapt_xml_endpoints.txt
 - lib/cpee/llm/prompts/apply.txt
 - lib/cpee/llm/prompts/dataflow.txt
 - lib/cpee/llm/prompts/derive.txt
@@ -157,7 +158,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.2'
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="