feat: add functions api (#6)

Author: Brandon Meyerowitz

.gitignore

@@ -164,3 +164,6 @@ cython_debug/
 
 # VS Code
 .vscode/
+
+# direnv
+.envrc

README.md

@@ -4,7 +4,8 @@
 
 Commonbase allows developers to integrate with any popular LLM API provider
 without needing to change any code. The SDK helps with collecting data and
-feedback from the users and helps you fine-tune models for your specific use case.
+feedback from the users and helps you fine-tune models for your specific use
+case.
 
 ## Installation
 
@@ -14,9 +15,12 @@ pip install commonbase
 
 ## Usage
 
-A Project ID and API Key are required for all Commonbase requests. You can find your project ID and generate an API key in the [Commonbase Dashboard](https://commonbase.com/).
+A Project ID and API Key are required for all Commonbase requests. You can find
+your project ID and generate an API key in the
+[Commonbase Dashboard](https://commonbase.com/).
 
-To create a completion, provide your Project ID, API Key, and prompt to `Completion.create`.
+To create a text completion, provide your Project ID, API Key, and prompt to
+`Completion.create`.
 
 ```py
 import commonbase
@@ -27,9 +31,11 @@ result = commonbase.Completion.create(
     prompt="Hello!"
 )
 
-print(result.best_result)
+print(result.best_choice.text)
 ```
 
-To stream a completion as it is generated, use `Completion.stream`.
+To stream a completion as it is generated, use `ChatCompletion.stream`.
 
-For more examples, see [/examples](https://github.com/commonbaseapp/commonbase-python/tree/main/examples) or check out our [Docs](https://docs.commonbase.com/quickstart/python).
+For more examples, see
+[/examples](https://github.com/commonbaseapp/commonbase-python/tree/main/examples)
+or check out our [Docs](https://docs.commonbase.com/quickstart/python).

commonbase/__init__.py

@@ -1,16 +1,15 @@
-from commonbase.completion import Completion
-from commonbase.exceptions import CommonbaseApiException, CommonbaseException
-from commonbase.chat_context import ChatContext, ChatMessage
-from commonbase.provider_config import ProviderConfig, OpenAIParams, AnthropicParams
-from commonbase.completion_response import CompletionResponse
+from commonbase.completion import Completion, ChatCompletion  # type: ignore
+from commonbase.exceptions import CommonbaseApiException, CommonbaseException  # type: ignore
+from commonbase.provider_config import OpenAIParams, AnthropicParams  # type: ignore
+from commonbase.completion_response import CompletionResponse  # type: ignore
+from commonbase.chat_context import ChatMessage  # type: ignore
 
 __all__: [
     "Completion",
+    "ChatCompletion",
+    "ChatMessage",
     "CommonbaseException",
     "CommonbaseApiException",
-    "ChatContext",
-    "ChatMessage",
-    "ProviderConfig",
     "OpenAIParams",
     "AnthropicParams",
     "CompletionResponse",

commonbase/chat_context.py

@@ -1,16 +1,37 @@
-from typing import Literal, Sequence
-from dataclasses import dataclass, asdict
+from typing import Literal, NotRequired, TypedDict, Optional
 
 
-@dataclass
-class ChatMessage:
-    role: Literal["system", "user", "assistant"]
+class FunctionCall(TypedDict):
+    name: str
+    arguments: Optional[str]
+
+
+class RegularChatMessage(TypedDict):
+    role: Literal["system", "user"]
+    content: str
+
+
+class AssistantChatMessage(TypedDict):
+    role: Literal["assistant"]
+    content: str | None
+    function_call: NotRequired[FunctionCall]
+
+
+class FunctionChatMessage(TypedDict):
+    role: Literal["function"]
+    name: str
     content: str
 
 
-@dataclass
-class ChatContext:
-    messages: Sequence[ChatMessage]
+class FunctionCallConfigName(TypedDict):
+    name: str
+
+
+class ChatFunction(TypedDict):
+    name: str
+    description: str
+    parameters: object
+
 
-    def _as_json(self) -> dict:
-        return asdict(self)
+ChatMessage = RegularChatMessage | AssistantChatMessage | FunctionChatMessage
+FunctionCallConfig = Literal["none", "auto"] | FunctionCallConfigName