feat: make prompt required for all completion requests (#4)

Author: Brandon Meyerowitz

commonbase/completion.py

@@ -20,7 +20,7 @@ def _get_sdk_version() -> str:
 
 def _format_body(
     project_id: str,
-    prompt: Optional[str] = None,
+    prompt: str,
     variables: Optional[dict[str, str]] = None,
     chat_context: Optional[ChatContext] = None,
     user_id: Optional[str] = None,
@@ -48,7 +48,7 @@ def _format_body(
 def _send_completion_request(
     api_key: str,
     project_id: str,
-    prompt: Optional[str],
+    prompt: str,
     variables: Optional[dict[str, str]],
     chat_context: Optional[ChatContext],
     user_id: Optional[str],
@@ -99,7 +99,7 @@ def create(
         cls,
         api_key: str,
         project_id: str,
-        prompt: Optional[str] = None,
+        prompt: str,
         variables: Optional[dict[str, str]] = None,
         chat_context: Optional[ChatContext] = None,
         user_id: Optional[str] = None,
@@ -115,7 +115,7 @@ def create(
             The Commonbase API key used to authenticate the request.
         project_id : str
             The ID of the Commonbase project.
-        prompt : str, optional
+        prompt : str
             The prompt for which a completion is generated.
         variables : dict[str, str], optional
             The list of variables to use with Commonbase managed prompts.
@@ -163,7 +163,7 @@ def stream(
         cls,
         api_key: str,
         project_id: str,
-        prompt: Optional[str] = None,
+        prompt: str,
         variables: Optional[dict[str, str]] = None,
         chat_context: Optional[ChatContext] = None,
         user_id: Optional[str] = None,

commonbase/tests/test_completion.py

@@ -8,34 +8,51 @@
 
 def test_create_no_api_key():
     with pytest.raises(CommonbaseException):
-        Completion.create(api_key=None, project_id="")
+        Completion.create(
+            api_key=None, project_id=os.getenv("CB_PROJECT_ID") or "", prompt=""
+        )
 
 
 def test_create_no_project_id():
     with pytest.raises(CommonbaseApiException):
-        Completion.create(api_key="", project_id=None)  # type: ignore
+        Completion.create(api_key=os.getenv("CB_API_KEY") or "", project_id=None, prompt="")  # type: ignore
+
+
+def test_create_no_prompt():
+    with pytest.raises(CommonbaseApiException):
+        Completion.create(api_key=os.getenv("CB_API_KEY") or "", project_id=os.getenv("CB_PROJECT_ID") or "", prompt=None)  # type: ignore
 
 
 def test_stream_no_api_key():
     with pytest.raises(CommonbaseException):
-        for _ in Completion.stream(api_key=None, project_id=""):
+        for _ in Completion.stream(api_key=None, project_id=os.getenv("CB_PROJECT_ID") or "", prompt=""):  # type: ignore
             pass
 
 
 def test_stream_no_project_id():
     with pytest.raises(CommonbaseApiException):
-        for _ in Completion.stream(api_key="", project_id=None, prompt=""):  # type: ignore
+        for _ in Completion.stream(api_key=os.getenv("CB_API_KEY") or "", project_id=None, prompt=""):  # type: ignore
+            pass
+
+
+def test_stream_no_prompt():
+    with pytest.raises(CommonbaseApiException):
+        for _ in Completion.stream(api_key=os.getenv("CB_API_KEY") or "", project_id=os.getenv("CB_PROJECT_ID") or "", prompt=None):  # type: ignore
             pass
 
 
 def test_create_invalid_project_id():
     with pytest.raises(CommonbaseApiException):
-        Completion.create(api_key="", project_id="", prompt="Hello")
+        Completion.create(
+            api_key=os.getenv("CB_API_KEY") or "", project_id="", prompt="Hello"
+        )
 
 
 def test_stream_invalid_project_id():
     with pytest.raises(CommonbaseApiException):
-        for _ in Completion.stream(api_key="", project_id="", prompt="Hello"):
+        for _ in Completion.stream(
+            api_key=os.getenv("CB_API_KEY") or "", project_id="", prompt="Hello"
+        ):
             pass
 
 
@@ -74,6 +91,7 @@ def test_completion_variables():
     result = Completion.create(
         api_key=os.getenv("CB_API_KEY") or "",
         project_id=os.getenv("CB_PROJECT_ID") or "",
+        prompt="My name is {{user_name}} and my email is {{email}}",
         variables={"user_name": "USERNAME", "email": "USER@COMPANY.COM"},
     )
 

examples/completion.ipynb

@@ -104,7 +104,8 @@
         "\n",
         "result = commonbase.Completion.create(\n",
         "    api_key=\"API_KEY\",\n",
-        "    project_id=\"PROJECT_ID\", \n",
+        "    project_id=\"PROJECT_ID\",\n",
+        "    prompt=\"A new user {{user_name}} just signed up with {{email}}. Say hello!\", \n",
         "    variables={\n",
         "        \"user_name\": \"USERNAME\",\n",
         "        \"email\": \"USERNAME@COMPANY.COM\"\n",