Functions with Class-template

Author: draupner1

README.md

@@ -54,6 +54,16 @@ If you have added the script to your path, you can run it from anywhere:
 ![image](https://user-images.githubusercontent.com/3023775/232043124-5bcdc240-4b86-4397-9355-ff0a8dc2f3fe.png)
 ![image](https://user-images.githubusercontent.com/3023775/232043119-d25b1e93-c99b-48e6-b9c6-ccbc1270a800.png)
 
+Plug-ins
+--------
+Available from v.0.5.0
+
+You can now define your own Functions. (See OpenAI-chatAPI for details)
+
+Implement them in a Class file, and drop it in the functions directory where OAI is installed.
+
+Your functions/FuncTemplate.txt, is a class template to get you started.
+
 Options
 -------
 

functions/FuncTemplate.txt

@@ -0,0 +1,37 @@
+import requests
+import json
+import unicodedata
+# coding: utf-8 
+
+class <My_Func_Class>:
+
+  def __init__(self):
+    self.functions = [
+        {
+          "name": "<my_func_name>",
+          "description": "What it does, for chatGPT to understand",
+          "parameters": {
+            "type": "object",
+            "properties": {
+              "<param_1>": {
+                "type": "string",
+                "description": "The first parameter of <my_func_name>"
+                },
+              "<param_2": {
+                "type": "string",
+                "description": "The second parameter of <my_func_name"
+                }
+            },
+            "required": [ "<param_1>", "<param_2>" ],
+          },
+        }
+      ]
+
+  def <my_func_name>(self, <param_1>, <param_2>):
+    # Note: Any number of parameters can be used for your function.
+
+    # Do the function with the parameters available.
+    
+    # Return with text string, to be sent to ChatGPT from function.
+    # If no need to call chatGPT any more, return 'stop'. (As in storage)
+    return 'stop'

oai.py

@@ -5,6 +5,7 @@
 import sys
 import json
 import io
+import importlib, inspect
 
 from rich import pager
 from rich.console import Console
@@ -17,9 +18,13 @@
 
 
 console = Console()
-version = "0.4.1"
+version = "0.5.0"
 _session_file_ = ".messages.json"
 
+available_parameters = {}
+available_descr = {}
+available_functions = {}
+
 def get_lindata():
     lindata = "Users Kernel:" + platform.platform() + "\n" \
               "Users OS:" + os.uname().version + "\n" \
@@ -98,6 +103,25 @@ def extract_jsonstr(prompt):
       exit()
     return pro
 
+def get_fun_def(func):
+
+    for file in os.listdir(os.path.dirname(__file__)+"/functions"):
+      if file.endswith(".py"):
+        file_name = file[:-3]
+        module_name = 'functions.' + file_name
+        for name, cls in inspect.getmembers(importlib.import_module(module_name), inspect.isclass):
+          if cls.__module__ == module_name:
+           if func in dir(cls):
+            obj = cls()
+            full = inspect.getfullargspec(getattr(obj, func))
+            args = ', '.join(full.args)
+            available_functions[func] = getattr(obj, func)
+            available_parameters[func] = full.args
+            available_descr[func] = obj.functions
+            return available_descr[func][0]
+    return ""
+
+
 def main():
     desc = "This tool sends a query to OpenAIs Chat API from the command line.\n\n"\
            "A new chat session is started with -n <pre-info> and gives the opportunity to\n"\
@@ -115,6 +139,8 @@ def main():
 
     # Add arguments for expert mode, API key reset, version, and prompt
     parser.add_argument('-n', '--new', action="store_true", help='Start New Chat', dest='new')
+    parser.add_argument('-f', '--function', default='', help='Enable function call', dest='function')
+ #   parser.add_argument('name', nargs='?', default="")
     parser.add_argument('-l', '--linux', action="store_true", help='Include an assistent message with Kernel/OS/shell', dest='linux')
     parser.add_argument('-m', '--model', action="store_true", help='List models available via OpenAIs API', dest='model')
     parser.add_argument('-x', '--expert', action="store_true", help='Toggle warning', dest='expert')
@@ -180,23 +206,62 @@ def main():
         config.toggle_expert_mode()
         sys.exit()
 
+    func = ""
+    if args.function:
+        func = args.function
+        if func == "":
+            print("No function provided. Exiting...")
+            sys.exit()
+        func = get_fun_def(func)
+        if func == "":
+            print('Function not found: ' + func)
+            sys.exit()
+
     if not args.prompt:
         prompt = Prompt.ask("Documentation Request")
         if prompt == "":
             print("No prompt provided. Exiting...")
             sys.exit()
     else:
         prompt = args.prompt
+    askDict = {'role':'user', 'content':prompt}
     if os.path.isfile(_session_file_):
       messages = get_session()
-      messages.append({'role':'user', 'content':prompt})
+      messages.append(askDict)
     else:
-      messages=[{'role':'user', 'content':prompt}]
+      messages=[askDict]
 
     with console.status(f"Phoning a friend...  ", spinner="pong"):
-        openai_response = post_completion(get_chat(messages))
-        console.print(Markdown(openai_response.strip()))
-        messages.append({'role':'assistant', 'content':openai_response.strip()})
+        openai_response = get_chat(messages, func)
+        if openai_response.get("function_call"):
+          function_name = openai_response["function_call"]["name"]
+          if function_name in available_functions:
+            fuction_to_call = available_functions[function_name]
+          else:
+            print('Bad returned function name from OpenAI API')
+            print(openai_response)
+            messages.append(openai_response)
+            messages.append({"role": "function", "name": function_name, "content": func})
+            function_args = json.loads(openai_response["function_call"]["arguments"].strip())
+            console.print(Markdown(function_args.get("content").strip()))
+            put_session(messages)
+            exit()
+
+          #print(openai_response["function_call"]["arguments"].strip())
+          function_args = json.loads(openai_response["function_call"]["arguments"].strip())
+          function_response = fuction_to_call(
+            heading=function_args.get("heading"),
+            content=function_args.get("content").strip(),
+          )
+          messages.append(openai_response)
+          messages.append({"role": "function", "name": function_name, "content": function_response})
+
+          if function_response != 'stop':
+            openai_response = get_chat(messages)
+          else:
+            openai_response.content = function_args.get("content")
+        console.print(Markdown(openai_response.content.strip()))
+        messages.append({'role':'assistant', 'content':openai_response.content.strip()})
         put_session(messages)
 
 

resources/conduit.py

@@ -43,18 +43,25 @@ def get_completion(prompt):
         sys.exit()
     return response
 
-def get_chat(messages):
+def get_chat(messages, func = ""):
     openai.api_key = config.get_api_key()
     engine = config.get_model()
 
     if len(messages) == 0:
         print("Prompt is empty. Please enter a prompt.")
 
     try:
-        response = openai.ChatCompletion.create(
-            model=engine,
-            messages=messages
-        ).choices[0].message.content
+        if func == "":
+          response = openai.ChatCompletion.create(
+              model=engine,
+              messages=messages
+          ).choices[0].message
+        else:
+          response = openai.ChatCompletion.create(
+              model=engine,
+              messages=messages,
+              functions=[func]
+          ).choices[0].message
     except openai.error.APIError as e:
         # Handle API error here, e.g. retry or log
         print(f"OpenAI API returned an API Error: {e}")