-
Notifications
You must be signed in to change notification settings - Fork 1.4k
add examples to use the gateway aside from the shorthand #3484
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.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
dsfaccini
wants to merge
8
commits into
pydantic:main
Choose a base branch
from
dsfaccini:gateway-docs
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
09a04ee
add examples to pass an api key and route through a non default provider
dsfaccini 8d8d8fe
move examples to usage
dsfaccini f2a0687
include hello world in the same code block
dsfaccini 0b4cb93
better formatting for third example
dsfaccini 21ebce0
sort imports in codeblocks
dsfaccini e74f5e6
Merge branch 'main' into gateway-docs
dsfaccini b70b486
Merge branch 'main' into gateway-docs
dsfaccini 103da1a
Merge branch 'main' into gateway-docs
DouweM File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -119,18 +119,63 @@ export PYDANTIC_AI_GATEWAY_API_KEY="YOUR_PYDANTIC_AI_GATEWAY_API_KEY" | |
|
|
||
| You can access multiple models with the same API key, as shown in the code snippet below. | ||
|
|
||
| ```python {title="hello_world.py"} | ||
| from pydantic_ai import Agent | ||
| === "Hello World" | ||
|
|
||
| agent = Agent('gateway/openai:gpt-5') | ||
| ```python {title="hello_world.py"} | ||
| from pydantic_ai import Agent | ||
|
|
||
| result = agent.run_sync('Where does "hello world" come from?') | ||
| print(result.output) | ||
| """ | ||
| The first known use of "hello, world" was in a 1974 textbook about the C programming language. | ||
| """ | ||
| ``` | ||
| agent = Agent('gateway/openai:gpt-5') | ||
|
|
||
| result = agent.run_sync('Where does "hello world" come from?') | ||
| print(result.output) | ||
| """ | ||
| The first known use of "hello, world" was in a 1974 textbook about the C programming language. | ||
| """ | ||
| ``` | ||
|
|
||
| === "Passing API Key directly" | ||
|
|
||
| Pass your API key directly using the provider: | ||
|
|
||
| ```python {title="passing_api_key.py"} | ||
| from pydantic_ai import Agent | ||
| from pydantic_ai.models.openai import OpenAIChatModel | ||
| from pydantic_ai.providers.gateway import gateway_provider | ||
|
|
||
| provider = gateway_provider('openai', api_key='PYDANTIC_AI_GATEWAY_API_KEY') | ||
| model = OpenAIChatModel('gpt-5', provider=provider) | ||
| agent = Agent(model) | ||
|
|
||
| result = agent.run_sync('Where does "hello world" come from?') | ||
| print(result.output) | ||
| """ | ||
| The first known use of "hello, world" was in a 1974 textbook about the C programming language. | ||
| """ | ||
| ``` | ||
|
|
||
| === "Using a different upstream provider" | ||
|
|
||
| If you're using a different upstream provider, you can specify it in the route parameter: | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @dmontagu Can you review the terminology here please? I don't think route and upstream provider are interchangeable like this |
||
|
|
||
| ```python {title="routing_via_provider.py"} | ||
| from pydantic_ai import Agent | ||
| from pydantic_ai.models.openai import OpenAIChatModel | ||
| from pydantic_ai.providers.gateway import gateway_provider | ||
|
|
||
| provider = gateway_provider( | ||
| 'openai', | ||
| api_key='PYDANTIC_AI_GATEWAY_API_KEY', | ||
| route='modal-ai' | ||
| ) | ||
| model = OpenAIChatModel('gpt-5', provider=provider) | ||
| agent = Agent(model) | ||
|
|
||
| result = agent.run_sync('Where does "hello world" come from?') | ||
| print(result.output) | ||
| """ | ||
| The first known use of "hello, world" was in a 1974 textbook about the C programming language. | ||
| """ | ||
| ``` | ||
|
|
||
| ### Claude Code | ||
|
|
||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should link to the API docs for this function, so people can read the docstrings etc