# Instructor, The Most Popular Library for Simple Structured Outputs
Instructor is the most popular Python library for working with structured outputs from large language models (LLMs), boasting over 600,000 monthly downloads. Built on top of Pydantic, it provides a simple, transparent, and user-friendly API to manage validation, retries, and streaming responses. Get ready to supercharge your LLM workflows with the community's top choice!
[](https://twitter.com/jxnlco)
[](https://discord.gg/bD9YE9JArw)
[](https://pypi.python.org/pypi/instructor)
## Want your logo on our website?
If your company uses Instructor a lot, we'd love to have your logo on our website! Please fill out [this form](https://q7gjsgfstrp.typeform.com/to/wluQlVVQ)
## Key Features
- **Response Models**: Specify Pydantic models to define the structure of your LLM outputs
- **Retry Management**: Easily configure the number of retry attempts for your requests
- **Validation**: Ensure LLM responses conform to your expectations with Pydantic validation
- **Streaming Support**: Work with Lists and Partial responses effortlessly
- **Flexible Backends**: Seamlessly integrate with various LLM providers beyond OpenAI
- **Support in many Languages**: We support many languages including [Python](https://python.useinstructor.com), [TypeScript](https://js.useinstructor.com), [Ruby](https://ruby.useinstructor.com), [Go](https://go.useinstructor.com), and [Elixir](https://hex.pm/packages/instructor)
## Get Started in Minutes
Install Instructor with a single command:
```bash
pip install -U instructor
```
Now, let's see Instructor in action with a simple example:
```python
import instructor
from pydantic import BaseModel
from openai import OpenAI
# Define your desired output structure
class UserInfo(BaseModel):
name: str
age: int
# Patch the OpenAI client
client = instructor.from_openai(OpenAI())
# Extract structured data from natural language
user_info = client.chat.completions.create(
model="gpt-4o-mini",
response_model=UserInfo,
messages=[{"role": "user", "content": "John Doe is 30 years old."}],
)
print(user_info.name)
#> John Doe
print(user_info.age)
#> 30
```
### Using Hooks
Instructor provides a powerful hooks system that allows you to intercept and log various stages of the LLM interaction process. Here's a simple example demonstrating how to use hooks:
```python
import instructor
from openai import OpenAI
from pydantic import BaseModel
class UserInfo(BaseModel):
name: str
age: int
# Initialize the OpenAI client with Instructor
client = instructor.from_openai(OpenAI())
# Define hook functions
def log_kwargs(**kwargs):
print(f"Function called with kwargs: {kwargs}")
def log_exception(exception: Exception):
print(f"An exception occurred: {str(exception)}")
client.on("completion:kwargs", log_kwargs)
client.on("completion:error", log_exception)
user_info = client.chat.completions.create(
model="gpt-4o-mini",
response_model=UserInfo,
messages=[
{"role": "user", "content": "Extract the user name: 'John is 20 years old'"}
],
)
"""
{
'args': (),
'kwargs': {
'messages': [
{
'role': 'user',
'content': "Extract the user name: 'John is 20 years old'",
}
],
'model': 'gpt-4o-mini',
'tools': [
{
'type': 'function',
'function': {
'name': 'UserInfo',
'description': 'Correctly extracted `UserInfo` with all the required parameters with correct types',
'parameters': {
'properties': {
'name': {'title': 'Name', 'type': 'string'},
'age': {'title': 'Age', 'type': 'integer'},
},
'required': ['age', 'name'],
'type': 'object',
},
},
}
],
'tool_choice': {'type': 'function', 'function': {'name': 'UserInfo'}},
},
}
"""
print(f"Name: {user_info.name}, Age: {user_info.age}")
#> Name: John, Age: 20
```
This example demonstrates:
1. A pre-execution hook that logs all kwargs passed to the function.
2. An exception hook that logs any exceptions that occur during execution.
The hooks provide valuable insights into the function's inputs and any errors,
enhancing debugging and monitoring capabilities.
### Using Anthropic Models
```python
import instructor
from anthropic import Anthropic
from pydantic import BaseModel
class User(BaseModel):
name: str
age: int
client = instructor.from_anthropic(Anthropic())
# note that client.chat.completions.create will also work
resp = client.messages.create(
model="claude-3-opus-20240229",
max_tokens=1024,
system="You are a world class AI that excels at extracting user data from a sentence",
messages=[
{
"role": "user",
"content": "Extract Jason is 25 years old.",
}
],
response_model=User,
)
assert isinstance(resp, User)
assert resp.name == "Jason"
assert resp.age == 25
```
### Using Cohere Models
Make sure to install `cohere` and set your system environment variable with `export CO_API_KEY=<YOUR_COHERE_API_KEY>`.
```
pip install cohere
```
```python
import instructor
import cohere
from pydantic import BaseModel
class User(BaseModel):
name: str
age: int
client = instructor.from_cohere(cohere.Client())
# note that client.chat.completions.create will also work
resp = client.chat.completions.create(
model="command-r-plus",
max_tokens=1024,
messages=[
{
"role": "user",
"content": "Extract Jason is 25 years old.",
}
],
response_model=User,
)
assert isinstance(resp, User)
assert resp.name == "Jason"
assert resp.age == 25
```
### Using Gemini Models
Make sure you [install](https://ai.google.dev/api/python/google/generativeai#setup) the Google AI Python SDK. You should set a `GOOGLE_API_KEY` environment variable with your API key.
Gemini tool calling also requires `jsonref` to be installed.
```
pip install google-generativeai jsonref
```
```python
import instructor
import google.generativeai as genai
from pydantic import BaseModel
class User(BaseModel):
name: str
age: int
# genai.configure(api_key=os.environ["API_KEY"]) # alternative API key configuration
client = instructor.from_gemini(
client=genai.GenerativeModel(
model_name="models/gemini-1.5-flash-latest", # model defaults to "gemini-pro"
),
mode=instructor.Mode.GEMINI_JSON,
)
```
Alternatively, you can [call Gemini from the OpenAI client](https://cloud.google.com/vertex-ai/generative-ai/docs/multimodal/call-gemini-using-openai-library#python). You'll have to setup [`gcloud`](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-dev), get setup on Vertex AI, and install the Google Auth library.
```sh
pip install google-auth
```
```python
import google.auth
import google.auth.transport.requests
import instructor
from openai import OpenAI
from pydantic import BaseModel
creds, project = google.auth.default()
auth_req = google.auth.transport.requests.Request()
creds.refresh(auth_req)
# Pass the Vertex endpoint and authentication to the OpenAI SDK
PROJECT = 'PROJECT_ID'
LOCATION = (
'LOCATION' # https://cloud.google.com/vertex-ai/generative-ai/docs/learn/locations
)
base_url = f'https://{LOCATION}-aiplatform.googleapis.com/v1beta1/projects/{PROJECT}/locations/{LOCATION}/endpoints/openapi'
client = instructor.from_openai(
OpenAI(base_url=base_url, api_key=creds.token), mode=instructor.Mode.JSON
)
# JSON mode is req'd
class User(BaseModel):
name: str
age: int
resp = client.chat.completions.create(
model="google/gemini-1.5-flash-001",
max_tokens=1024,
messages=[
{
"role": "user",
"content": "Extract Jason is 25 years old.",
}
],
response_model=User,
)
assert isinstance(resp, User)
assert resp.name == "Jason"
assert resp.age == 25
```
### Using Litellm
```python
import instructor
from litellm import completion
from pydantic import BaseModel
class User(BaseModel):
name: str
age: int
client = instructor.from_litellm(completion)
resp = client.chat.completions.create(
model="claude-3-opus-20240229",
max_tokens=1024,
messages=[
{
"role": "user",
"content": "Extract Jason is 25 years old.",
}
],
response_model=User,
)
assert isinstance(resp, User)
assert resp.name == "Jason"
assert resp.age == 25
```
## Types are inferred correctly
This was the dream of Instructor but due to the patching of OpenAI, it wasn't possible for me to get typing to work well. Now, with the new client, we can get typing to work well! We've also added a few `create_*` methods to make it easier to create iterables and partials, and to access the original completion.
### Calling `create`
```python
import openai
import instructor
from pydantic import BaseModel
class User(BaseModel):
name: str
age: int
client = instructor.from_openai(openai.OpenAI())
user = client.chat.completions.create(
model="gpt-4-turbo-preview",
messages=[
{"role": "user", "content": "Create a user"},
],
response_model=User,
)
```
Now if you use an IDE, you can see the type is correctly inferred.
### Handling async: `await create`
This will also work correctly with asynchronous clients.
```python
import openai
import instructor
from pydantic import BaseModel
client = instructor.from_openai(openai.AsyncOpenAI())
class User(BaseModel):
name: str
age: int
async def extract():
return await client.chat.completions.create(
model="gpt-4-turbo-preview",
messages=[
{"role": "user", "content": "Create a user"},
],
response_model=User,
)
```
Notice that simply because we return the `create` method, the `extract()` function will return the correct user type.
### Returning the original completion: `create_with_completion`
You can also return the original completion object
```python
import openai
import instructor
from pydantic import BaseModel
client = instructor.from_openai(openai.OpenAI())
class User(BaseModel):
name: str
age: int
user, completion = client.chat.completions.create_with_completion(
model="gpt-4-turbo-preview",
messages=[
{"role": "user", "content": "Create a user"},
],
response_model=User,
)
```
### Streaming Partial Objects: `create_partial`
In order to handle streams, we still support `Iterable[T]` and `Partial[T]` but to simplify the type inference, we've added `create_iterable` and `create_partial` methods as well!
```python
import openai
import instructor
from pydantic import BaseModel
client = instructor.from_openai(openai.OpenAI())
class User(BaseModel):
name: str
age: int
user_stream = client.chat.completions.create_partial(
model="gpt-4-turbo-preview",
messages=[
{"role": "user", "content": "Create a user"},
],
response_model=User,
)
for user in user_stream:
print(user)
#> name=None age=None
#> name=None age=None
#> name=None age=None
#> name=None age=None
#> name=None age=None
#> name=None age=None
#> name='John Doe' age=None
#> name='John Doe' age=None
#> name='John Doe' age=None
#> name='John Doe' age=30
#> name='John Doe' age=30
# name=None age=None
# name='' age=None
# name='John' age=None
# name='John Doe' age=None
# name='John Doe' age=30
```
Notice now that the type inferred is `Generator[User, None]`
### Streaming Iterables: `create_iterable`
We get an iterable of objects when we want to extract multiple objects.
```python
import openai
import instructor
from pydantic import BaseModel
client = instructor.from_openai(openai.OpenAI())
class User(BaseModel):
name: str
age: int
users = client.chat.completions.create_iterable(
model="gpt-4-turbo-preview",
messages=[
{"role": "user", "content": "Create 2 users"},
],
response_model=User,
)
for user in users:
print(user)
#> name='John Doe' age=30
#> name='Jane Doe' age=28
# User(name='John Doe', age=30)
# User(name='Jane Smith', age=25)
```
## [Evals](https://github.com/jxnl/instructor/tree/main/tests/llm/test_openai/evals#how-to-contribute-writing-and-running-evaluation-tests)
We invite you to contribute to evals in `pytest` as a way to monitor the quality of the OpenAI models and the `instructor` library. To get started check out the evals for [Anthropic](https://github.com/jxnl/instructor/blob/main/tests/llm/test_anthropic/evals/test_simple.py) and [OpenAI](https://github.com/jxnl/instructor/tree/main/tests/llm/test_openai/evals#how-to-contribute-writing-and-running-evaluation-tests) and contribute your own evals in the form of pytest tests. These evals will be run once a week and the results will be posted.
## Contributing
If you want to help, checkout some of the issues marked as `good-first-issue` or `help-wanted` found [here](https://github.com/jxnl/instructor/labels/good%20first%20issue). They could be anything from code improvements, a guest blog post, or a new cookbook.
## CLI
We also provide some added CLI functionality for easy convenience:
- `instructor jobs` : This helps with the creation of fine-tuning jobs with OpenAI. Simple use `instructor jobs create-from-file --help` to get started creating your first fine-tuned GPT-3.5 model
- `instructor files` : Manage your uploaded files with ease. You'll be able to create, delete and upload files all from the command line
- `instructor usage` : Instead of heading to the OpenAI site each time, you can monitor your usage from the CLI and filter by date and time period. Note that usage often takes ~5-10 minutes to update from OpenAI's side
## License
This project is licensed under the terms of the MIT License.
# Contributors
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
<!-- ALL-CONTRIBUTORS-LIST:END -->
<a href="https://github.com/jxnl/instructor/graphs/contributors">
<img src="https://contrib.rocks/image?repo=jxnl/instructor" />
</a>
Raw data
{
"_id": null,
"home_page": "https://github.com/jxnl/instructor",
"name": "instructor",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Jason Liu",
"author_email": "jason@jxnl.co",
"download_url": "https://files.pythonhosted.org/packages/b5/5f/5326d811f8cd59fc4fffbd629c91eeb82a345a2375ad34500c2755aab4d8/instructor-1.7.0.tar.gz",
"platform": null,
"description": "# Instructor, The Most Popular Library for Simple Structured Outputs\n\nInstructor is the most popular Python library for working with structured outputs from large language models (LLMs), boasting over 600,000 monthly downloads. Built on top of Pydantic, it provides a simple, transparent, and user-friendly API to manage validation, retries, and streaming responses. Get ready to supercharge your LLM workflows with the community's top choice!\n\n[](https://twitter.com/jxnlco)\n[](https://discord.gg/bD9YE9JArw)\n[](https://pypi.python.org/pypi/instructor)\n\n## Want your logo on our website?\n\nIf your company uses Instructor a lot, we'd love to have your logo on our website! Please fill out [this form](https://q7gjsgfstrp.typeform.com/to/wluQlVVQ)\n\n## Key Features\n\n- **Response Models**: Specify Pydantic models to define the structure of your LLM outputs\n- **Retry Management**: Easily configure the number of retry attempts for your requests\n- **Validation**: Ensure LLM responses conform to your expectations with Pydantic validation\n- **Streaming Support**: Work with Lists and Partial responses effortlessly\n- **Flexible Backends**: Seamlessly integrate with various LLM providers beyond OpenAI\n- **Support in many Languages**: We support many languages including [Python](https://python.useinstructor.com), [TypeScript](https://js.useinstructor.com), [Ruby](https://ruby.useinstructor.com), [Go](https://go.useinstructor.com), and [Elixir](https://hex.pm/packages/instructor)\n\n## Get Started in Minutes\n\nInstall Instructor with a single command:\n\n```bash\npip install -U instructor\n```\n\nNow, let's see Instructor in action with a simple example:\n\n```python\nimport instructor\nfrom pydantic import BaseModel\nfrom openai import OpenAI\n\n\n# Define your desired output structure\nclass UserInfo(BaseModel):\n name: str\n age: int\n\n\n# Patch the OpenAI client\nclient = instructor.from_openai(OpenAI())\n\n# Extract structured data from natural language\nuser_info = client.chat.completions.create(\n model=\"gpt-4o-mini\",\n response_model=UserInfo,\n messages=[{\"role\": \"user\", \"content\": \"John Doe is 30 years old.\"}],\n)\n\nprint(user_info.name)\n#> John Doe\nprint(user_info.age)\n#> 30\n```\n\n### Using Hooks\n\nInstructor provides a powerful hooks system that allows you to intercept and log various stages of the LLM interaction process. Here's a simple example demonstrating how to use hooks:\n\n```python\nimport instructor\nfrom openai import OpenAI\nfrom pydantic import BaseModel\n\n\nclass UserInfo(BaseModel):\n name: str\n age: int\n\n\n# Initialize the OpenAI client with Instructor\nclient = instructor.from_openai(OpenAI())\n\n\n# Define hook functions\ndef log_kwargs(**kwargs):\n print(f\"Function called with kwargs: {kwargs}\")\n\n\ndef log_exception(exception: Exception):\n print(f\"An exception occurred: {str(exception)}\")\n\n\nclient.on(\"completion:kwargs\", log_kwargs)\nclient.on(\"completion:error\", log_exception)\n\nuser_info = client.chat.completions.create(\n model=\"gpt-4o-mini\",\n response_model=UserInfo,\n messages=[\n {\"role\": \"user\", \"content\": \"Extract the user name: 'John is 20 years old'\"}\n ],\n)\n\n\"\"\"\n{\n 'args': (),\n 'kwargs': {\n 'messages': [\n {\n 'role': 'user',\n 'content': \"Extract the user name: 'John is 20 years old'\",\n }\n ],\n 'model': 'gpt-4o-mini',\n 'tools': [\n {\n 'type': 'function',\n 'function': {\n 'name': 'UserInfo',\n 'description': 'Correctly extracted `UserInfo` with all the required parameters with correct types',\n 'parameters': {\n 'properties': {\n 'name': {'title': 'Name', 'type': 'string'},\n 'age': {'title': 'Age', 'type': 'integer'},\n },\n 'required': ['age', 'name'],\n 'type': 'object',\n },\n },\n }\n ],\n 'tool_choice': {'type': 'function', 'function': {'name': 'UserInfo'}},\n },\n }\n\"\"\"\n\nprint(f\"Name: {user_info.name}, Age: {user_info.age}\")\n#> Name: John, Age: 20\n``` \n\nThis example demonstrates:\n1. A pre-execution hook that logs all kwargs passed to the function.\n2. An exception hook that logs any exceptions that occur during execution.\n\nThe hooks provide valuable insights into the function's inputs and any errors,\nenhancing debugging and monitoring capabilities.\n\n### Using Anthropic Models\n\n```python\nimport instructor\nfrom anthropic import Anthropic\nfrom pydantic import BaseModel\n\n\nclass User(BaseModel):\n name: str\n age: int\n\n\nclient = instructor.from_anthropic(Anthropic())\n\n# note that client.chat.completions.create will also work\nresp = client.messages.create(\n model=\"claude-3-opus-20240229\",\n max_tokens=1024,\n system=\"You are a world class AI that excels at extracting user data from a sentence\",\n messages=[\n {\n \"role\": \"user\",\n \"content\": \"Extract Jason is 25 years old.\",\n }\n ],\n response_model=User,\n)\n\nassert isinstance(resp, User)\nassert resp.name == \"Jason\"\nassert resp.age == 25\n```\n\n### Using Cohere Models\n\nMake sure to install `cohere` and set your system environment variable with `export CO_API_KEY=<YOUR_COHERE_API_KEY>`.\n\n```\npip install cohere\n```\n\n```python\nimport instructor\nimport cohere\nfrom pydantic import BaseModel\n\n\nclass User(BaseModel):\n name: str\n age: int\n\n\nclient = instructor.from_cohere(cohere.Client())\n\n# note that client.chat.completions.create will also work\nresp = client.chat.completions.create(\n model=\"command-r-plus\",\n max_tokens=1024,\n messages=[\n {\n \"role\": \"user\",\n \"content\": \"Extract Jason is 25 years old.\",\n }\n ],\n response_model=User,\n)\n\nassert isinstance(resp, User)\nassert resp.name == \"Jason\"\nassert resp.age == 25\n```\n\n### Using Gemini Models\n\nMake sure you [install](https://ai.google.dev/api/python/google/generativeai#setup) the Google AI Python SDK. You should set a `GOOGLE_API_KEY` environment variable with your API key.\nGemini tool calling also requires `jsonref` to be installed.\n\n```\npip install google-generativeai jsonref\n```\n\n```python\nimport instructor\nimport google.generativeai as genai\nfrom pydantic import BaseModel\n\n\nclass User(BaseModel):\n name: str\n age: int\n\n\n# genai.configure(api_key=os.environ[\"API_KEY\"]) # alternative API key configuration\nclient = instructor.from_gemini(\n client=genai.GenerativeModel(\n model_name=\"models/gemini-1.5-flash-latest\", # model defaults to \"gemini-pro\"\n ),\n mode=instructor.Mode.GEMINI_JSON,\n)\n```\n\nAlternatively, you can [call Gemini from the OpenAI client](https://cloud.google.com/vertex-ai/generative-ai/docs/multimodal/call-gemini-using-openai-library#python). You'll have to setup [`gcloud`](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-dev), get setup on Vertex AI, and install the Google Auth library.\n\n```sh\npip install google-auth\n```\n\n```python\nimport google.auth\nimport google.auth.transport.requests\nimport instructor\nfrom openai import OpenAI\nfrom pydantic import BaseModel\n\ncreds, project = google.auth.default()\nauth_req = google.auth.transport.requests.Request()\ncreds.refresh(auth_req)\n\n# Pass the Vertex endpoint and authentication to the OpenAI SDK\nPROJECT = 'PROJECT_ID'\nLOCATION = (\n 'LOCATION' # https://cloud.google.com/vertex-ai/generative-ai/docs/learn/locations\n)\nbase_url = f'https://{LOCATION}-aiplatform.googleapis.com/v1beta1/projects/{PROJECT}/locations/{LOCATION}/endpoints/openapi'\n\nclient = instructor.from_openai(\n OpenAI(base_url=base_url, api_key=creds.token), mode=instructor.Mode.JSON\n)\n\n\n# JSON mode is req'd\nclass User(BaseModel):\n name: str\n age: int\n\n\nresp = client.chat.completions.create(\n model=\"google/gemini-1.5-flash-001\",\n max_tokens=1024,\n messages=[\n {\n \"role\": \"user\",\n \"content\": \"Extract Jason is 25 years old.\",\n }\n ],\n response_model=User,\n)\n\nassert isinstance(resp, User)\nassert resp.name == \"Jason\"\nassert resp.age == 25\n```\n\n### Using Litellm\n\n```python\nimport instructor\nfrom litellm import completion\nfrom pydantic import BaseModel\n\n\nclass User(BaseModel):\n name: str\n age: int\n\n\nclient = instructor.from_litellm(completion)\n\nresp = client.chat.completions.create(\n model=\"claude-3-opus-20240229\",\n max_tokens=1024,\n messages=[\n {\n \"role\": \"user\",\n \"content\": \"Extract Jason is 25 years old.\",\n }\n ],\n response_model=User,\n)\n\nassert isinstance(resp, User)\nassert resp.name == \"Jason\"\nassert resp.age == 25\n```\n\n## Types are inferred correctly\n\nThis was the dream of Instructor but due to the patching of OpenAI, it wasn't possible for me to get typing to work well. Now, with the new client, we can get typing to work well! We've also added a few `create_*` methods to make it easier to create iterables and partials, and to access the original completion.\n\n### Calling `create`\n\n```python\nimport openai\nimport instructor\nfrom pydantic import BaseModel\n\n\nclass User(BaseModel):\n name: str\n age: int\n\n\nclient = instructor.from_openai(openai.OpenAI())\n\nuser = client.chat.completions.create(\n model=\"gpt-4-turbo-preview\",\n messages=[\n {\"role\": \"user\", \"content\": \"Create a user\"},\n ],\n response_model=User,\n)\n```\n\nNow if you use an IDE, you can see the type is correctly inferred.\n\n\n\n### Handling async: `await create`\n\nThis will also work correctly with asynchronous clients.\n\n```python\nimport openai\nimport instructor\nfrom pydantic import BaseModel\n\n\nclient = instructor.from_openai(openai.AsyncOpenAI())\n\n\nclass User(BaseModel):\n name: str\n age: int\n\n\nasync def extract():\n return await client.chat.completions.create(\n model=\"gpt-4-turbo-preview\",\n messages=[\n {\"role\": \"user\", \"content\": \"Create a user\"},\n ],\n response_model=User,\n )\n```\n\nNotice that simply because we return the `create` method, the `extract()` function will return the correct user type.\n\n\n\n### Returning the original completion: `create_with_completion`\n\nYou can also return the original completion object\n\n```python\nimport openai\nimport instructor\nfrom pydantic import BaseModel\n\n\nclient = instructor.from_openai(openai.OpenAI())\n\n\nclass User(BaseModel):\n name: str\n age: int\n\n\nuser, completion = client.chat.completions.create_with_completion(\n model=\"gpt-4-turbo-preview\",\n messages=[\n {\"role\": \"user\", \"content\": \"Create a user\"},\n ],\n response_model=User,\n)\n```\n\n\n\n### Streaming Partial Objects: `create_partial`\n\nIn order to handle streams, we still support `Iterable[T]` and `Partial[T]` but to simplify the type inference, we've added `create_iterable` and `create_partial` methods as well!\n\n```python\nimport openai\nimport instructor\nfrom pydantic import BaseModel\n\n\nclient = instructor.from_openai(openai.OpenAI())\n\n\nclass User(BaseModel):\n name: str\n age: int\n\n\nuser_stream = client.chat.completions.create_partial(\n model=\"gpt-4-turbo-preview\",\n messages=[\n {\"role\": \"user\", \"content\": \"Create a user\"},\n ],\n response_model=User,\n)\n\nfor user in user_stream:\n print(user)\n #> name=None age=None\n #> name=None age=None\n #> name=None age=None\n #> name=None age=None\n #> name=None age=None\n #> name=None age=None\n #> name='John Doe' age=None\n #> name='John Doe' age=None\n #> name='John Doe' age=None\n #> name='John Doe' age=30\n #> name='John Doe' age=30\n # name=None age=None\n # name='' age=None\n # name='John' age=None\n # name='John Doe' age=None\n # name='John Doe' age=30\n```\n\nNotice now that the type inferred is `Generator[User, None]`\n\n\n\n### Streaming Iterables: `create_iterable`\n\nWe get an iterable of objects when we want to extract multiple objects.\n\n```python\nimport openai\nimport instructor\nfrom pydantic import BaseModel\n\n\nclient = instructor.from_openai(openai.OpenAI())\n\n\nclass User(BaseModel):\n name: str\n age: int\n\n\nusers = client.chat.completions.create_iterable(\n model=\"gpt-4-turbo-preview\",\n messages=[\n {\"role\": \"user\", \"content\": \"Create 2 users\"},\n ],\n response_model=User,\n)\n\nfor user in users:\n print(user)\n #> name='John Doe' age=30\n #> name='Jane Doe' age=28\n # User(name='John Doe', age=30)\n # User(name='Jane Smith', age=25)\n```\n\n\n\n## [Evals](https://github.com/jxnl/instructor/tree/main/tests/llm/test_openai/evals#how-to-contribute-writing-and-running-evaluation-tests)\n\nWe invite you to contribute to evals in `pytest` as a way to monitor the quality of the OpenAI models and the `instructor` library. To get started check out the evals for [Anthropic](https://github.com/jxnl/instructor/blob/main/tests/llm/test_anthropic/evals/test_simple.py) and [OpenAI](https://github.com/jxnl/instructor/tree/main/tests/llm/test_openai/evals#how-to-contribute-writing-and-running-evaluation-tests) and contribute your own evals in the form of pytest tests. These evals will be run once a week and the results will be posted.\n\n## Contributing\n\nIf you want to help, checkout some of the issues marked as `good-first-issue` or `help-wanted` found [here](https://github.com/jxnl/instructor/labels/good%20first%20issue). They could be anything from code improvements, a guest blog post, or a new cookbook.\n\n## CLI\n\nWe also provide some added CLI functionality for easy convenience:\n\n- `instructor jobs` : This helps with the creation of fine-tuning jobs with OpenAI. Simple use `instructor jobs create-from-file --help` to get started creating your first fine-tuned GPT-3.5 model\n\n- `instructor files` : Manage your uploaded files with ease. You'll be able to create, delete and upload files all from the command line\n\n- `instructor usage` : Instead of heading to the OpenAI site each time, you can monitor your usage from the CLI and filter by date and time period. Note that usage often takes ~5-10 minutes to update from OpenAI's side\n\n## License\n\nThis project is licensed under the terms of the MIT License.\n\n# Contributors\n\n<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->\n<!-- prettier-ignore-start -->\n<!-- markdownlint-disable -->\n\n<!-- markdownlint-restore -->\n<!-- prettier-ignore-end -->\n\n<!-- ALL-CONTRIBUTORS-LIST:END -->\n\n<a href=\"https://github.com/jxnl/instructor/graphs/contributors\">\n <img src=\"https://contrib.rocks/image?repo=jxnl/instructor\" />\n</a>\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "structured outputs for llm",
"version": "1.7.0",
"project_urls": {
"Homepage": "https://github.com/jxnl/instructor",
"Repository": "https://github.com/jxnl/instructor"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "07842351df1678678f4a0a2c251f986d05e0ba090199f7a9f39e6d152b314946",
"md5": "0e206b2c6c26e5c6acbfcb4893f6dad0",
"sha256": "0bff965d71a5398aed9d3f728e07ffb7b5050569c81f306c0e5a8d022071fe29"
},
"downloads": -1,
"filename": "instructor-1.7.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0e206b2c6c26e5c6acbfcb4893f6dad0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 70145,
"upload_time": "2024-11-27T16:07:32",
"upload_time_iso_8601": "2024-11-27T16:07:32.364675Z",
"url": "https://files.pythonhosted.org/packages/07/84/2351df1678678f4a0a2c251f986d05e0ba090199f7a9f39e6d152b314946/instructor-1.7.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b55f5326d811f8cd59fc4fffbd629c91eeb82a345a2375ad34500c2755aab4d8",
"md5": "35cbc1594aee9e7432860f78f1afe317",
"sha256": "51b308ae9c5e4d56096514be785ac4f28f710c91bed80af74412fc21593431b3"
},
"downloads": -1,
"filename": "instructor-1.7.0.tar.gz",
"has_sig": false,
"md5_digest": "35cbc1594aee9e7432860f78f1afe317",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 57079,
"upload_time": "2024-11-27T16:07:33",
"upload_time_iso_8601": "2024-11-27T16:07:33.686974Z",
"url": "https://files.pythonhosted.org/packages/b5/5f/5326d811f8cd59fc4fffbd629c91eeb82a345a2375ad34500c2755aab4d8/instructor-1.7.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-27 16:07:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jxnl",
"github_project": "instructor",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [],
"lcname": "instructor"
}
JSON
