When you want a Tuple but can only use List

[Mr-Ruben]

As per the Instructor documentation one can use

    Primitive Types (str, int, float, bool)
    Annotated
    Literal
    Enum
    List
    Union
    Complex Types 

Let's say I want a Tuple

# Define output class structure
from pydantic import BaseModel
from typing import Tuple

class Output(BaseModel):
    Name_and_surname: Tuple[str]

Output.model_json_schema( )

{
│   'properties': {
│   │   'Name_and_surname': {
│   │   │   'maxItems': 2,
│   │   │   'minItems': 2,
│   │   │   'prefixItems': [
│   │   │   │   {'type': 'string'},
│   │   │   │   {'type': 'string'}
│   │   │   ],
│   │   │   'title': 'Name And Surname',
│   │   │   'type': 'array'
│   │   }
│   },
│   'required': ['Name_and_surname'],
│   'title': 'Output',
│   'type': 'object'
}

Which works in Pydantic

Output(Name_and_surname=("John", "Doe"))
# Output(Name_and_surname=('John', 'Doe'))

But not with Instructor

p="Mike Tyson is a legend."
call_ai_with_class(prompt=p, response_model=Output)

BadRequestError: Error code: 400 - {'error': {'message': "Invalid schema for function 'Output': In context=('properties', 'Name_and_surname'), array schema missing items", 'type': 'invalid_request_error', 'param': 'tools[0].function.parameters', 'code': 'invalid_function_parameters'}}

One can still get the Tuple and keep Instructor happy with

from pydantic import BaseModel
from typing import List, Union, Tuple

class Output(BaseModel):
    Name_and_surname: List[str]

    def __init__(self, **data):
        super().__init__(**data)
        self.Name_and_surname = tuple(self.Name_and_surname)
       

p="Mike Tyson is a legend."
call_ai_with_class(prompt=p, response_model=Output)

# {'Name_and_surname': ('Mike', 'Tyson')}

Note: In my real case the tuple was

class Output(BaseModel):
    var: Tuple[bool,str]

which ended up being

class Output(BaseModel):
    var: List[Union[bool,str]]

# or if you want to avoid getting a Pydantic warning when the list gets converted to tuple

class Output(BaseModel):
    var: Union[Tuple,List[str]]

If anyone knows a better way, feel free to chip in. I'd like to know it.