[Feature]: Add full type annotations for the library

[ishaan-jaff]

The Feature

you have some basic typing but I mean actually having models or even TypedDicts for all the parameters.
Here is the current completion signature attached, where "messages" and "functions" are just typed as "List".
My type checker shows an issue because it's unknown what's in the list

Motivation, pitch

user request

Twitter / LinkedIn details

No response

[ishaan-jaff]

ideally those properties are in the code as models.

So you would have something like:
messages: list[MessageModel],
functions: list[FunctionModel]

And the MessageModel could look like:

class MessageModel(TypedDict):
role: str
content: str | None
name: string | None
function_call: FunctionCall | None

[JamesHutchison]

Is this completed? Is it just missing the py.typed marker?

[ishaan-jaff]

Nope - open to contributions on this @JamesHutchison

[krrishdholakia]

this contribution would be very appreciated @JamesHutchison

[edwinjosegeorge]

@ishaan-jaff could you have a look at the PR. Did you meant annotating with the TypedDict? I referenced the OpenAI spec to replicate the type check.

[edwinjosegeorge]

I find couple of existing issues that have similar objective, Improving code quality by adding type annotations.

• [Feature]: Add LiteLLM Type stubs for mypy #360
• [Feature]: add library stubs to LiteLLM #1540
• ci: added typechecking #1537
• pre commit first configuration #511

I am interested to work on it. See #3291

[krrishdholakia]

please help here - this would be very useful @edwinjosegeorge