Skip to content

Update instructor tutorial #7784

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
1 commit merged into from
Jan 15, 2025
Merged

Update instructor tutorial #7784

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 17 additions & 32 deletions docs/my-website/docs/tutorials/instructor.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,32 +1,22 @@
# Instructor - Function Calling

Use LiteLLM Router with [jxnl's instructor library](https://github.com/jxnl/instructor) for function calling in prod.
Use LiteLLM with [jxnl's instructor library](https://github.com/jxnl/instructor) for function calling in prod.

## Usage

```python
import litellm
from litellm import Router
import os

import instructor
from litellm import completion
from pydantic import BaseModel

litellm.set_verbose = True # 馃憟 print DEBUG LOGS
os.environ["LITELLM_LOG"] = "DEBUG" # 馃憟 print DEBUG LOGS

client = instructor.patch(
Router(
model_list=[
{
"model_name": "gpt-3.5-turbo", openai model name
"litellm_params": { # params for litellm completion/embedding call - e.g.: https://github.com/BerriAI/litellm/blob/62a591f90c99120e1a51a8445f5c3752586868ea/litellm/router.py#L111
"model": "azure/chatgpt-v-2",
"api_key": os.getenv("AZURE_API_KEY"),
"api_version": os.getenv("AZURE_API_VERSION"),
"api_base": os.getenv("AZURE_API_BASE"),
},
}
]
)
)
client = instructor.from_litellm(completion)

# import dotenv
# dotenv.load_dotenv()


class UserDetail(BaseModel):
Expand All @@ -35,7 +25,7 @@ class UserDetail(BaseModel):


user = client.chat.completions.create(
model="gpt-3.5-turbo",
model="gpt-4o-mini",
response_model=UserDetail,
messages=[
{"role": "user", "content": "Extract Jason is 25 years old"},
Expand All @@ -52,25 +42,20 @@ print(f"user: {user}")
## Async Calls

```python
import litellm
import asyncio
import instructor
from litellm import Router
import instructor, asyncio
from pydantic import BaseModel

aclient = instructor.apatch(
aclient = instructor.patch(
Router(
model_list=[
{
"model_name": "gpt-3.5-turbo",
"litellm_params": {
"model": "azure/chatgpt-v-2",
"api_key": os.getenv("AZURE_API_KEY"),
"api_version": os.getenv("AZURE_API_VERSION"),
"api_base": os.getenv("AZURE_API_BASE"),
},
"model_name": "gpt-4o-mini",
"litellm_params": {"model": "gpt-4o-mini"},
}
],
default_litellm_params={"acompletion": True}, # 馃憟 IMPORTANT - tells litellm to route to async completion function.
default_litellm_params={"acompletion": True}, # 馃憟 IMPORTANT - tells litellm to route to async completion function.
)
)

Expand All @@ -82,7 +67,7 @@ class UserExtract(BaseModel):

async def main():
model = await aclient.chat.completions.create(
model="gpt-3.5-turbo",
model="gpt-4o-mini",
response_model=UserExtract,
messages=[
{"role": "user", "content": "Extract jason is 25 years old"},
Expand Down