Adding support for structured outputs

instructor/client.py

@@ -425,6 +425,7 @@ def from_openai(
             instructor.Mode.FUNCTIONS,
             instructor.Mode.PARALLEL_TOOLS,
             instructor.Mode.MD_JSON,
+            instructor.Mode.STRUCTURED_OUTPUTS,
         }
 
     if isinstance(client, openai.OpenAI):

instructor/function_calls.py

@@ -264,7 +264,7 @@ def from_response(
             Mode.warn_mode_functions_deprecation()
             return cls.parse_functions(completion, validation_context, strict)
 
-        if mode in {Mode.TOOLS, Mode.MISTRAL_TOOLS}:
+        if mode in {Mode.TOOLS, Mode.MISTRAL_TOOLS, Mode.STRUCTURED_OUTPUTS}:
             return cls.parse_tools(completion, validation_context, strict)
 
         if mode in {Mode.JSON, Mode.JSON_SCHEMA, Mode.MD_JSON}:

instructor/mode.py

@@ -19,6 +19,7 @@ class Mode(enum.Enum):
     VERTEXAI_JSON = "vertexai_json"
     GEMINI_JSON = "gemini_json"
     COHERE_JSON_SCHEMA = "json_object"
+    STRUCTURED_OUTPUTS = "structured_output"
 
     @classmethod
     def warn_mode_functions_deprecation(cls):

instructor/process_response.py

@@ -249,6 +249,18 @@ def handle_response_model(
             Mode.warn_mode_functions_deprecation()
             new_kwargs["functions"] = [response_model.openai_schema]
             new_kwargs["function_call"] = {"name": response_model.openai_schema["name"]}
+        elif mode in {Mode.STRUCTURED_OUTPUTS}:
+            new_kwargs["tools"] = [
+                {
+                    "type": "function",
+                    "function": response_model.openai_schema,
+                    "strict": True,
+                }
+            ]
+            new_kwargs["tool_choice"] = {
+                "type": "function",
+                "function": {"name": response_model.openai_schema["name"]},
+            }
         elif mode in {Mode.TOOLS, Mode.MISTRAL_TOOLS}:
             new_kwargs["tools"] = [
                 {
@@ -263,6 +275,7 @@ def handle_response_model(
                     "type": "function",
                     "function": {"name": response_model.openai_schema["name"]},
                 }
+
         elif mode in {Mode.JSON, Mode.MD_JSON, Mode.JSON_SCHEMA}:
             # If its a JSON Mode we need to massage the prompt a bit
             # in order to get the response we want in a json format

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "instructor"
-version = "1.3.7"
+version = "1.4.0"
 description = "structured outputs for llm"
 authors = ["Jason Liu <jason@jxnl.co>"]
 license = "MIT"

tests/llm/test_openai/util.py

@@ -3,4 +3,5 @@
 models = ["gpt-4o-mini"]
 modes = [
     instructor.Mode.TOOLS,
+    instructor.Mode.STRUCTURED_OUTPUTS,
 ]