Merge pull request #94 from INCATools/llm

Added `llm-change-agent`

.github/workflows/new-pr-java.yml

@@ -36,10 +36,23 @@
 
 #             // Function to check for the phrase in bodyText and comments
 #             function checkForPhrase(bodyText, comments) {
-#               const phrase = 'hey ontobot';
-              
+#               const regex = /hey\s*[^a-zA-Z0-9]*\s*ontobot/i;
+
 #               // Check if bodyText includes the phrase
-#               let result = bodyText.includes(phrase);
+#               let result = regex.test(bodyText);
+
+#               // If not found in bodyText, check in comments
+#               if (!result && comments) {
+#                 for (const comment of comments) {
+#                   if (regex.test(comment.body)) {
+#                     result = true;
+#                     break;
+#                   }
+#                 }
+#               }
+
+#               return result;
+#             }
 
 #               // Check each comment
 

README.md

@@ -3,6 +3,9 @@
   <img src="https://github.com/INCATools/ontobot-change-agent/raw/main/docs/source/logo.png" height="150">
 </p>
 -->
+## ontobot-change-agent
+
+[![DOI](https://zenodo.org/badge/513320955.svg)](https://zenodo.org/doi/10.5281/zenodo.13693637)
 
 Update ontologies using change language.
 

docs/installation.rst

@@ -20,3 +20,38 @@ To install in development mode, use the following:
     $ git clone git+https://github.com/INCATools/ontobot-change-agent.git
     $ cd ontobot-change-agent
     $ poetry install
+
+New Features
+------------
+
+.. important::
+
+    In order to make `ontobot-change-agent` capable of using llm models, you could install it with the optional
+    dependency package `llm-change-agent`. This feature is in early development and is not yet ready for general use.
+
+    To install using pip:
+
+    .. code-block:: shell
+
+        $ pip install ontobot_change_agent[llm]
+
+    OR
+
+    .. code-block:: shell
+
+        $ pip install git+https://github.com/INCATools/ontobot-change-agent.git#egg=ontobot_change_agent[llm]
+
+
+    To install in development mode, use the following:
+    .. code-block:: shell
+
+        $ poetry install --extras llm
+
+.. note::
+
+    To leverage the features of `llm-change-agent` package one would need to have any one or all of
+    the environment variables set:
+
+    - `OPENAI_API_KEY`
+    - `ANTHROPIC_API_KEY`
+    - `CBORG_API_KEY` (for LBNL users only)