Skip to content

Add modern FastAPI integration example with dependency injection - #2305

Open
Jacob-hash999 wants to merge 1 commit into
567-labs:mainfrom
Jacob-hash999:add-modern-fastapi-example
Open

Add modern FastAPI integration example with dependency injection#2305
Jacob-hash999 wants to merge 1 commit into
567-labs:mainfrom
Jacob-hash999:add-modern-fastapi-example

Conversation

@Jacob-hash999

Copy link
Copy Markdown

Add Modern FastAPI Integration Example (2026)

Summary

Updated FastAPI example to use current Instructor API (from_provider) instead of deprecated dsl module. Added dependency injection, async patterns, and proper error
handling.

Problem

The existing examples/fastapi_app/main.py uses the deprecated DSL API:

  • Uses dsl.ChatCompletion, ResponseSchema (no longer documented)
  • Not using current instructor.from_provider() pattern
  • Confusing for new users following the README

Solution

Created examples/modern-fastapi-integration/modern_fastapi_example.py showing 2026 best practices:

Before (old API):

task = (
    dsl.ChatCompletion(name="...")
    | dsl.SystemTask(task="...")
    | SearchRequest
)
return await task.acreate()

After (new API):
client = instructor.from_provider("openai/gpt-4o-mini")
result = client.chat.completions.create(
    response_model=List[SearchQuery],
    messages=[...],
)
return SearchResponse(queries=result)

Features

-Modern API: Uses instructor.from_provider()
-Dependency Injection: FastAPI best practice for sharing clients
-Async: Proper async/await patterns
-Error Handling: HTTPException with informative messages
-Type Safety: Full type hints for IDE support
-Production Ready: Includes health check endpoint

Testing

python examples/modern-fastapi-integration/modern_fastapi_example.py

# Then test:
curl -X POST http://localhost:8000/search \
     -H "Content-Type: application/json" \
     -d '{"text": "Find ML engineers with Python experience"}'

Why This Matters

I use Instructor daily in production and the DSL example was confusing when I started. This example follows the README patterns and will help new users get started faster.

jxnl added a commit that referenced this pull request Aug 3, 2026
## Summary

- accumulate declared, nested, and unknown numeric OpenAI/Anthropic
usage fields across retries while preserving non-numeric metadata
- add corrective feedback when a Responses API retry receives no tool
call
- preserve raw iterable type hints through sync and async v2
parallel-tool wrappers
- strengthen API-key-free coverage for current and future SDK usage
counters

## Consolidated and superseded items

- closes #2493
- consolidates contributor work from #2498, #2500, and #2501 with
original commit authorship preserved
- supersedes #2497 because it drops unknown `model_extra` counters
- supersedes #2499 because its hand-maintained provider field lists
would drift as SDKs evolve

## Validation

- focused changed-surface suite: `110 passed`
- broad offline v2/coverage suite: `2368 passed, 91 skipped, 73
deselected`
- Ruff check and format check: passed
- scoped `ty check`: passed
- `uv lock --check`: passed
- pre-commit hooks and `git diff --check`: passed

The 73 deselected tests require live provider credentials. An unfiltered
local run confirmed its 22 failures were provider network connections in
the restricted environment; GitHub provider jobs remain the
authoritative validation for those paths.

## Intentionally skipped

- provider additions or expansions: #2436, #2435, #2423, #2409, #2384,
#2322, #2306, #2298, #2283, #2168, #2086; issues #2408, #2383, #2365,
#2260, #2084, #2076
- broad architecture, product, security, or streaming decisions: #2394,
#2392, #2357, #2356, #2355, #2351, #2321, #2307, #2287, #2263; issues
#2479, #2403, #2393, #2391, #2316, #2272, #2056
- dependency batch: #2433
- nontrivial examples and editorial/resource additions: #2468, #2405,
#2401, #2354, #2346, #2311, #2305; issue #2404

These remain open because they need dedicated product, architecture,
provider, security, dependency, or editorial review and are not required
for the `1.15.5` patch release.

<!-- CURSOR_SUMMARY -->
---

> [!NOTE]
> **Medium Risk**
> Changes retry usage totals and reask message content on failure paths;
scope is limited and heavily covered by tests, with no auth or
data-store changes.
> 
> **Overview**
> Bundles three v2 retry and wrapper fixes for a patch release.
> 
> **Retry usage accounting** replaces hand-maintained token field sums
with generic `_accumulate_models` on Pydantic usage objects. Numeric
fields (including nested models and `model_extra` counters) add across
retries; booleans and other non-numeric metadata are not treated as
billable. OpenAI and Anthropic paths share this logic.
> 
> **OpenAI Responses reask** appends a user correction when
`RESPONSES_TOOLS` validation fails but the output has no tool calls
(e.g. reasoning-only), so retries include feedback instead of repeating
the same request.
> 
> **Parallel tools** in `patch_v2` skips `prepare_response_model` and
does not replace `response_model` with the handler’s prepared wrapper
for parallel modes, keeping raw `Iterable[...]` hints so schemas and
parsed results include every member type.
> 
> <sup>Reviewed by [Cursor Bugbot](https://cursor.com/bugbot) for commit
bbddca1. Configure
[here](https://www.cursor.com/dashboard/bugbot).</sup>
<!-- /CURSOR_SUMMARY -->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants