Make use of Python type annotations to generate JSON Schemas compatible with the OpenAI function calling API from your annotated functions.
Leverages:
- pydantic for data validation and JSON schema generation.
- typing module for type annotations.
typing.Annotatedfor andpydantic.Fieldfor descriptions.
The main function is annotated_docs.json_schema.as_json_schema which takes a function as input and returns a json schema as output.
Directly from this GitHub repo using pip:
pip install "annotated_docs @ git+https://git@github.com/peterroelants/annotated-docs.git@v0.0.4"For example to rewrite the get_current_weather function from the OpenAI example using annotations:
from typing import Annotated as A, Literal as L
from pydantic import BaseModel
from annotated_docs import doc as D
class Location(BaseModel):
city: A[str, D("The city, e.g. San Francisco")]
country: A[str, D("The country, e.g. USA")]
# Example Annotated dummy function
def get_current_weather(
location: A[Location, D("Location to get the weather for.")],
unit: L["celsius", "fahrenheit"] = "fahrenheit",
) -> str:
"""Get the current weather in a given location"""
...We can generate the json schema for this function using as_json_schema:
from annotated_docs.json_schema import as_json_schema
print(as_json_schema(get_current_weather))Resulting in:
{
"name": "get_current_weather",
"parameters": {
"$defs": {
"Location": {
"properties": {
"city": {
"description": "The city, e.g. San Francisco",
"type": "string"
},
"country": {
"description": "The country, e.g. USA",
"type": "string"
}
},
"required": [
"city",
"country"
],
"type": "object"
}
},
"properties": {
"location": {
"allOf": [
{
"$ref": "#/$defs/Location"
}
],
"description": "Location to get the weather for."
},
"unit": {
"default": "fahrenheit",
"enum": [
"celsius",
"fahrenheit"
],
"type": "string"
}
},
"required": [
"location"
],
"type": "object"
},
"description": "Get the current weather in a given location"
}And we can call
from annotated_docs import call_with_json
current_weather = call_with_json(get_current_weather, function_args_from_llm)See notebooks/examples/test_function_calling.ipynb for a full example.