bump

docs/openai_schema.md

@@ -36,4 +36,23 @@ user_details = UserDetails.from_response(completion)
 print(user_details)  # name="John Doe", age=30
 ```
 
+## Using the decorator 
+
+You can also use a decorator but i recommend the class since you get nice autocompletes with VSCode
+
+```python
+import openai
+from openai_function_call import openai_schema
+
+from pydantic import Field, BaseModel
+
+@openai_schema
+class UserDetails(BaseModel):
+    """Details of a user"""
+    name: str = Field(..., description="users's full name")
+    age: int
+```
+
+## OpenAISchema
+
 ::: openai_function_call.OpenAISchema

mkdocs.yml

@@ -13,6 +13,11 @@ plugins:
             members_order: alphabetical
 repo_url: https://github.com/jxnl/openai_function_call
 markdown_extensions:
+  - pymdownx.critic
+  - pymdownx.caret
+  - pymdownx.keys
+  - pymdownx.mark
+  - pymdownx.tilde
   - pymdownx.highlight:
       anchor_linenums: true
       line_spans: __span

openai_function_call/function_calls.py

@@ -84,6 +84,9 @@ class OpenAISchema(BaseModel):
     @classmethod
     @property
     def openai_schema(cls):
+        """
+        Return the schema of the class in the format of OpenAI's schema
+        """
         schema = cls.schema()
         parameters = {
             k: v for k, v in schema.items() if k not in ("title", "description")
@@ -98,6 +101,7 @@ def openai_schema(cls):
 
     @classmethod
     def from_response(cls, completion, throw_error=True):
+        """Execute the function from the response of an openai chat completion"""
         message = completion.choices[0].message
 
         if throw_error:
@@ -116,7 +120,7 @@ def openai_schema(cls):
         raise TypeError("Class must be a subclass of pydantic.BaseModel")
 
     @wraps(cls, updated=())
-    class Wrapper(cls, OpenAISchema):
+    class Wrapper(cls, OpenAISchema):  # type: ignore
         pass
 
     return Wrapper