refactor: add Prompting and FunctionCalling classes

api/terraform/python/openai_api/lambda_openai_function/config/everlasting-gobstopper.yaml

@@ -1,48 +1,60 @@
 ---
-# Complete search terms that will trigger the chatbot to use your customized system prompt.
-search_terms:
-  strings:
-    - Gobstopper
-    - Gobstoppers
-    - Gobbstopper
-    - Gobbstoppers
-  pairs:
-    - - everlasting
-      - gobstopper
-    - - everlasting
-      - gobstoppers
-function_description: Get additional information about the Everlasting Gobstopper product created by Willy Wonka Chocolate Factory. Information includes sales promotions, coupon codes, company contact information and biographical background on the company founder.
-system_prompt: >
-  You are a helpful marketing agent for the [Willy Wonka Chocolate Factory](https://wwcf.com).
-# Information provided to the OpenAI "Function Calling" algorithm to help it generate custom responses.
-additional_information:
-  contact:
-    - name: Willy Wonka
-    - title: Founder and CEO
-    - location: 1234 Chocolate Factory Way, Chocolate City, Chocolate State, USA
-    - phone: +1 123-456-7890
-    - website: https://wwcf.com
-    - whatsapp: +11234567890
-    - email: ww@wwcf.com
-  biographical: >
-    Willy Wonka is a fictional character appearing in British author Roald Dahl's 1964 children's novel Charlie and the Chocolate Factory, its 1972 sequel Charlie and the Great Glass Elevator and several films based on those books. He is the eccentric founder and proprietor of the Wonka Chocolate Factory
-  sales_promotions:
-    - name: Everlasting Gobstopper
-      description: >
-        The Everlasting Gobstopper is a candy that, according to Willy Wonka, "Never Gets Smaller Or Ever Gets Eaten". It is the main focus of Charlie and the Chocolate Factory, both the 1971 film and the 2005 film, and Willy Wonka and the Chocolate Factory, the 1971 film adaptation of the novel.
-      price: $1.00
-      image: https://upload.wikimedia.org/wikipedia/commons/thumb/6/6e/Everlasting_Gobstopper.jpg/220px-Everlasting_Gobstopper.jpg
-    - name: Wonka Bar
-      description: >
-        Wonka Bars are a fictional brand of chocolate made by Willy Wonka, and also a chocolate bar inspired by the Willy Wonka Bar from the novel and the films Willy Wonka & the Chocolate Factory and Charlie and the Chocolate Factory.
-      price: $1.00
-      image: https://upload.wikimedia.org/wikipedia/commons/thumb/6/6e/Everlasting_Gobstopper.jpg/220px-Everlasting_Gobstopper.jpg
-  coupon_codes:
-    - name: 10% off
-      code: 10OFF
-      description: >
-        10% off your next purchase
-    - name: 20% off
-      code: 20OFF
-      description: >
-        20% off your next purchase
+meta_data:
+  config_path: aws_openai/lambda_openai_function/custom_configs/everlasting-gobstopper.yaml
+  # The name of your chatbot.
+  name: EverlastingGobstopper
+  # The description of your chatbot.
+  description: Get additional information about the Everlasting Gobstopper product created by Willy Wonka Chocolate Factory. Information includes sales promotions, coupon codes, company contact information and biographical background on the company founder.
+  # The version of your chatbot.
+  version: 0.1.0
+  # The author of your chatbot.
+  author: Lawrence McDaniel
+prompting:
+  # Complete search terms that will trigger the chatbot to use your customized system prompt.
+  search_terms:
+    strings:
+      - Gobstopper
+      - Gobstoppers
+      - Gobbstopper
+      - Gobbstoppers
+    pairs:
+      - - everlasting
+        - gobstopper
+      - - everlasting
+        - gobstoppers
+  system_prompt: >
+    You are a helpful marketing agent for the [Willy Wonka Chocolate Factory](https://wwcf.com).
+function_calling:
+  function_description: Get additional information about the Everlasting Gobstopper product created by Willy Wonka Chocolate Factory. Information includes sales promotions, coupon codes, company contact information and biographical background on the company founder.
+  # Information provided to the OpenAI "Function Calling" algorithm to help it generate custom responses.
+  additional_information:
+    contact:
+      - name: Willy Wonka
+      - title: Founder and CEO
+      - location: 1234 Chocolate Factory Way, Chocolate City, Chocolate State, USA
+      - phone: +1 123-456-7890
+      - website: https://wwcf.com
+      - whatsapp: +11234567890
+      - email: ww@wwcf.com
+    biographical: >
+      Willy Wonka is a fictional character appearing in British author Roald Dahl's 1964 children's novel Charlie and the Chocolate Factory, its 1972 sequel Charlie and the Great Glass Elevator and several films based on those books. He is the eccentric founder and proprietor of the Wonka Chocolate Factory
+    sales_promotions:
+      - name: Everlasting Gobstopper
+        description: >
+          The Everlasting Gobstopper is a candy that, according to Willy Wonka, "Never Gets Smaller Or Ever Gets Eaten". It is the main focus of Charlie and the Chocolate Factory, both the 1971 film and the 2005 film, and Willy Wonka and the Chocolate Factory, the 1971 film adaptation of the novel.
+        price: $1.00
+        image: https://upload.wikimedia.org/wikipedia/commons/thumb/6/6e/Everlasting_Gobstopper.jpg/220px-Everlasting_Gobstopper.jpg
+      - name: Wonka Bar
+        description: >
+          Wonka Bars are a fictional brand of chocolate made by Willy Wonka, and also a chocolate bar inspired by the Willy Wonka Bar from the novel and the films Willy Wonka & the Chocolate Factory and Charlie and the Chocolate Factory.
+        price: $1.00
+        image: https://upload.wikimedia.org/wikipedia/commons/thumb/6/6e/Everlasting_Gobstopper.jpg/220px-Everlasting_Gobstopper.jpg
+    coupon_codes:
+      - name: 10% off
+        code: 10OFF
+        description: >
+          10% off your next purchase
+      - name: 20% off
+        code: 20OFF
+        description: >
+          20% off your next purchase

api/terraform/python/openai_api/lambda_openai_function/config/example-configuration.yaml

@@ -1,32 +1,40 @@
 ---
-#------------------------------------------------------------
-# search terms that will trigger the chatbot to use this customized configuration.
-#------------------------------------------------------------
-search_terms:
-  strings:
-    - example function calling configuration
-  pairs:
-    - - Example
-      - configuration
-#------------------------------------------------------------
-# if this module is able to locate any of the search terms in the user prompt
-# then this is the system prompt will be used to generate the response, and the function_description that will be provided to OpenAI API.
-#------------------------------------------------------------
-system_prompt: >
-  Your job is to provide helpful technical information about the OpenAI API Function Calling feature. You should include the following information in your response:
-  "Congratulations!!! OpenAI API Function Calling chose to call this function. Here is the additional information that you requested:"
-function_description: an example custom configuration to integrate with OpenAI API Function Calling additional information function, in this module.
-#------------------------------------------------------------
-# if a.) this module is able to locate any of the search terms in the user prompt
-#    b.) OpenAI API Function Calling opts to call this function
-# then this is the data that will be returned by function_refers_to.get_additional_info()
-#------------------------------------------------------------
-additional_information:
-  platform_provider: OpenAI
-  about: >
-    In an API call, you can describe functions and have the model intelligently choose to output a JSON object containing arguments to call one or many functions. The Chat Completions API does not call the function; instead, the model generates JSON that you can use to call the function in your code.
-    The latest models (gpt-3.5-turbo-1106 and gpt-4-1106-preview) have been trained to both detect when a function should to be called (depending on the input) and to respond with JSON that adheres to the function signature more closely than previous models. With this capability also comes potential risks. We strongly recommend building in user confirmation flows before taking actions that impact the world on behalf of users (sending an email, posting something online, making a purchase, etc).
-  links:
-    - documentation: https://platform.openai.com/docs/guides/function-calling
-    - website: https://openai.com/
-    - wikipedia: https://en.wikipedia.org/wiki/OpenAI
+meta_data:
+  config_path: aws_openai/lambda_openai_function/custom_configs/example-configuration.yaml
+  name: ExampleConfiguration
+  description: an example custom configuration to integrate with OpenAI API Function Calling additional information function, in this module.
+  version: 0.1.0
+  author: Lawrence McDaniel
+prompting:
+  #------------------------------------------------------------
+  # search terms that will trigger the chatbot to use this customized configuration.
+  #------------------------------------------------------------
+  search_terms:
+    strings:
+      - example function calling configuration
+    pairs:
+      - - Example
+        - configuration
+  system_prompt: >
+    Your job is to provide helpful technical information about the OpenAI API Function Calling feature. You should include the following information in your response:
+    "Congratulations!!! OpenAI API Function Calling chose to call this function. Here is the additional information that you requested:"
+function_calling:
+  #------------------------------------------------------------
+  # if this module is able to locate any of the search terms in the user prompt
+  # then this is the system prompt will be used to generate the response, and the function_description that will be provided to OpenAI API.
+  #------------------------------------------------------------
+  function_description: an example custom configuration to integrate with OpenAI API Function Calling additional information function, in this module.
+  #------------------------------------------------------------
+  # if a.) this module is able to locate any of the search terms in the user prompt
+  #    b.) OpenAI API Function Calling opts to call this function
+  # then this is the data that will be returned by function_refers_to.get_additional_info()
+  #------------------------------------------------------------
+  additional_information:
+    platform_provider: OpenAI
+    about: >
+      In an API call, you can describe functions and have the model intelligently choose to output a JSON object containing arguments to call one or many functions. The Chat Completions API does not call the function; instead, the model generates JSON that you can use to call the function in your code.
+      The latest models (gpt-3.5-turbo-1106 and gpt-4-1106-preview) have been trained to both detect when a function should to be called (depending on the input) and to respond with JSON that adheres to the function signature more closely than previous models. With this capability also comes potential risks. We strongly recommend building in user confirmation flows before taking actions that impact the world on behalf of users (sending an email, posting something online, making a purchase, etc).
+    links:
+      - documentation: https://platform.openai.com/docs/guides/function-calling
+      - website: https://openai.com/
+      - wikipedia: https://en.wikipedia.org/wiki/OpenAI