Merge pull request #60 from vacmar01/main

add `structured` function for structured output

Author: jph00

lisette/_modidx.py

@@ -51,7 +51,8 @@
                               'lisette.core.patch_litellm': ('core.html#patch_litellm', 'lisette/core.py'),
                               'lisette.core.random_tool_id': ('core.html#random_tool_id', 'lisette/core.py'),
                               'lisette.core.remove_cache_ckpts': ('core.html#remove_cache_ckpts', 'lisette/core.py'),
-                              'lisette.core.stream_with_complete': ('core.html#stream_with_complete', 'lisette/core.py')},
+                              'lisette.core.stream_with_complete': ('core.html#stream_with_complete', 'lisette/core.py'),
+                              'lisette.core.structured': ('core.html#structured', 'lisette/core.py')},
             'lisette.usage': { 'lisette.usage.LisetteUsageLogger': ('usage.html#lisetteusagelogger', 'lisette/usage.py'),
                                'lisette.usage.LisetteUsageLogger.__init__': ('usage.html#lisetteusagelogger.__init__', 'lisette/usage.py'),
                                'lisette.usage.LisetteUsageLogger._log_usage': ( 'usage.html#lisetteusagelogger._log_usage',

lisette/core.py

@@ -4,7 +4,7 @@
 
 # %% auto 0
 __all__ = ['sonn45', 'opus45', 'detls_tag', 're_tools', 'effort', 'patch_litellm', 'remove_cache_ckpts', 'contents', 'mk_msg',
-           'fmt2hist', 'mk_msgs', 'stream_with_complete', 'lite_mk_func', 'ToolResponse', 'cite_footnote',
+           'fmt2hist', 'mk_msgs', 'stream_with_complete', 'lite_mk_func', 'ToolResponse', 'structured', 'cite_footnote',
            'cite_footnotes', 'Chat', 'random_tool_id', 'mk_tc', 'mk_tc_req', 'mk_tc_result', 'mk_tc_results',
            'astream_with_complete', 'AsyncChat', 'mk_tr_details', 'AsyncStreamFormatter', 'adisplay_stream']
 
@@ -213,6 +213,28 @@ def _lite_call_func(tc,ns,raise_on_err=True):
     else: res = str(res)
     return {"tool_call_id": tc.id, "role": "tool", "name": tc.function.name, "content": res}
 
+# %% ../nbs/00_core.ipynb
+import json
+
+# %% ../nbs/00_core.ipynb
+from fastcore.meta import delegates
+
+# %% ../nbs/00_core.ipynb
+@delegates(completion)
+def structured(
+    m,          # The LiteLLM model string
+    msgs:list,  # A list of messages 
+    tool,       # The tool to be used for creating the structured output. Can also be a class, dataclass or Pydantic model        
+    **kwargs):
+    "Return the value of the tool call (generally used for structured outputs)"
+    t = lite_mk_func(tool)
+    
+    r = completion(m, msgs, tools=[t], tool_choice=t, **kwargs)
+
+    args = json.loads(r.choices[0].message.tool_calls[0].function.arguments)
+
+    return tool(**args)
+
 # %% ../nbs/00_core.ipynb
 def _has_search(m):
     i = get_model_info(m)