fix(parallel): enhance error handling in get_types_array and add test case (#423)

ellipsis.yaml

@@ -3,7 +3,7 @@ version: 1.1
 pr_review:
   auto_review_enabled: true
   auto_summarize_pr: true
-  confidence_threshold: 0.9
+  confidence_threshold: 0.85
   rules:
     # Control what gets flagged during PR review with custom rules. Here are some to get you started:
     - "Code should be DRY (Dont Repeat Yourself)"
@@ -13,3 +13,4 @@ pr_review:
     - "If library code changes, expect documentation to be updated"
     - "If library code changes, check if tests are updated"
     - "If a new `md` file is created in `docs` make sure its added to mkdocs.yml"
+    - "Assertions should always have an error message that is formatted well. "

instructor/dsl/parallel.py

@@ -46,7 +46,8 @@ class ParallelBase:
 
 def get_types_array(typehint: Type[Iterable[Union[T]]]) -> Tuple[Type[T], ...]:
     should_be_iterable = get_origin(typehint)
-    assert should_be_iterable is Iterable
+    if should_be_iterable is not Iterable:
+        raise TypeError(f"Model should be with Iterable instead if {typehint}")
 
     if get_origin(get_args(typehint)[0]) is Union:
         # works for Iterable[Union[int, str]]

instructor/patch.py

@@ -339,9 +339,10 @@ async def retry_async(
                                 "name": response.choices[0]
                                 .message.tool_calls[0]
                                 .function.name,
-                                "content": "failure",
+                                "content": "Exceptions found\n{e}\nRecall the function correctly.",
                             }
                         )
+
                     kwargs["messages"].append(
                         {
                             "role": "user",

tests/openai/test_parallel.py

@@ -14,6 +14,23 @@ class GoogleSearch(BaseModel):
     query: str
 
 
+def test_sync_parallel_tools__error(client):
+    client = instructor.patch(client, mode=instructor.Mode.PARALLEL_TOOLS)
+
+    with pytest.raises(TypeError):
+        resp = client.chat.completions.create(
+            model="gpt-4-turbo-preview",
+            messages=[
+                {"role": "system", "content": "You must always use tools"},
+                {
+                    "role": "user",
+                    "content": "What is the weather in toronto and dallas and who won the super bowl?",
+                },
+            ],
+            response_model=Weather,
+        )
+
+
 def test_sync_parallel_tools_or(client):
     client = instructor.patch(client, mode=instructor.Mode.PARALLEL_TOOLS)
     resp = client.chat.completions.create(