refactor(sdk): rename json and fn to be more explicit

sdk-python/test/openai_api/format_finder.py → sdk-python/test/openai/format_finder.py

@@ -1,7 +1,7 @@
 import os
 
 
-def extract_reference(full_data: str) -> str:
+def extract_chatcompletion_ref(full_data: str) -> str:
     start_index = full_data.find("chat_completion_example |")
     result = full_data[start_index:]
     result = result.replace("chat_completion_example |", "")

sdk-python/test/openai/update_format.py

@@ -0,0 +1,12 @@
+import json
+import os
+
+from format_finder import extract_chatcompletion_ref, fetch_api_format
+
+result = fetch_api_format()
+result = extract_chatcompletion_ref(result)
+print("Updating the OpenAI API reference format to:\n", result)
+
+reference_path = os.path.abspath("./test/openai_api/chatcompletion_ref.json")
+with open(reference_path, "w") as f:
+    json.dump(result, f)

sdk-python/test/openai_api/validate_format.py → sdk-python/test/openai/validate_format.py

@@ -1,25 +1,27 @@
 import json
 import os
 
-from format_finder import extract_reference, fetch_api_format
+from format_finder import extract_chatcompletion_ref, fetch_api_format
 
 print(
     "====================== Start validating the OpenAI API reference format"
     " ======================"
 )
 result = fetch_api_format()
 
-reference_path = os.path.abspath("./test/openai_api/reference_format.json")
+reference_path = os.path.abspath("./test/openai/chatcompletion_ref.json")
 with open(reference_path, "r") as f:
     reference = json.load(f)
     if result.find(reference) != -1:
         print("The OpenAI API format is up-to-date.")
     else:
         message = (
-            "The OpenAI API format has changed. Run "
-            + "'poetry run python test/openai_api/update_format.py' "
-            + "to update the test.\nCurrent format:"
-            + extract_reference(result)
+            "The OpenAI API format has changed. "
+            + "Please update the extraction of data in openai_listener.py "
+            + "and the reference format in chatcompletion.json by running "
+            + "'poetry run python test/openai_api/update_format.py'."
+            + "\nCurrent format:"
+            + extract_chatcompletion_ref(result)
             + "\nPrevious format:"
             + reference
         )