Skip to content

docs: Add Fireworks.AI and Together.AI examples #1095

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

Merged
merged 3 commits into from
Mar 13, 2025

Conversation

leowalker89
Copy link
Contributor

This PR adds examples for using Fireworks.AI and Together.AI with PydanticAI to the OpenAI-compatible Models section of the documentation.

Changes:

  • Added a section for Fireworks.AI with instructions on how to get an API key and use it with OpenAIModel
  • Added a section for Together.AI with instructions on how to get an API key and use it with OpenAIModel
  • Included links to the model libraries for both providers
  • Formatted examples to match the existing style and pass Black formatting checks

I've tested both examples and verified they work correctly with the respective APIs.

These additions help users easily integrate with these popular model providers using the OpenAI-compatible interface.

Copy link
Contributor

hyperlint-ai bot commented Mar 10, 2025

PR Change Summary

Added examples for integrating Fireworks.AI and Together.AI with PydanticAI in the documentation.

  • Introduced a section for Fireworks.AI with API key instructions and usage examples.
  • Introduced a section for Together.AI with API key instructions and usage examples.
  • Included links to model libraries for both Fireworks.AI and Together.AI.
  • Formatted examples to align with existing documentation style.

Modified Files

  • docs/models.md

How can I customize these reviews?

Check out the Hyperlint AI Reviewer docs for more information on how to customize the review.

If you just want to ignore it on this PR, you can add the hyperlint-ignore label to the PR. Future changes won't trigger a Hyperlint review.

Note specifically for link checks, we only check the first 30 links in a file and we cache the results for several hours (for instance, if you just added a page, you might experience this). Our recommendation is to add hyperlint-ignore to the PR to ignore the link check for this PR.

What is Hyperlint?

Hyperlint is an AI agent that helps you write, edit, and maintain your documentation.

Learn more about the Hyperlint AI reviewer and the checks that we can run on your documentation.

@Kludex
Copy link
Member

Kludex commented Mar 12, 2025

Thanks.

@Kludex Kludex enabled auto-merge (squash) March 13, 2025 10:46
@Kludex Kludex merged commit b400887 into pydantic:main Mar 13, 2025
15 checks passed
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