docs: add Pydantic AI guide + Hermes standalone provider-plugin section#75
Conversation
…tion
- Pydantic AI: new integration guide (AI Frameworks). Type-safe agents on
Eden AI via OpenAIChatModel + OpenAIProvider; house-style env var
EDEN_AI_API_KEY.
- Hermes: add an optional "First-class provider plugin" section documenting
the standalone model-provider plugin route (native --provider eden-ai),
alongside the existing custom-provider setup. Additive edit only.
Non-runnable Python snippets (pydantic-ai import; Hermes internal
`providers` import) are marked with {/* skip-test */} so the snippet
execution CI skips them.
Includes pydantic-ai icon SVG and docs.json nav entry.
WalkthroughAdded a Pydantic AI integration guide and navigation entry, expanded Hermes documentation with Eden AI provider-plugin instructions, and updated Hermes article metadata. ChangesPydantic AI Integration
Hermes Provider Plugin
Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related PRs
Suggested reviewers: Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
…al-small-2603) in Pydantic AI + Hermes plugin snippet
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@v3/integrations/hermes.mdx`:
- Line 132: Verify that the tab name in the code-fence metadata renders visibly
as __init__.py rather than init.py; if the renderer treats underscores as
formatting, escape the underscores while preserving the intended filename.
In `@v3/integrations/pydantic-ai.mdx`:
- Line 54: The Pydantic AI documentation uses nonstandard API-key placeholders.
In v3/integrations/pydantic-ai.mdx at lines 54, 106, 131, and 162, replace
“YOUR_EDEN_AI_API_KEY” with “api_token”; at line 54, optionally mention
“sandbox_api_token” in the adjacent comment. At line 182, replace
“your_api_key_here” with “api_token”.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: b497e59d-ded2-423b-811a-cb375f43fad2
⛔ Files ignored due to path filters (1)
integration-logo/pydantic-ai-icondoc.svgis excluded by!**/*.svg
📒 Files selected for processing (3)
docs.jsonv3/integrations/hermes.mdxv3/integrations/pydantic-ai.mdx
|
|
||
| <CodeGroup> | ||
| {/* skip-test */} | ||
| ```python __init__.py |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Verify the rendering of double underscores in the tab name.
If the tab name renders incorrectly as init.py, users might mistakenly name the file init.py, which would break the Python module. Please verify that it renders correctly as __init__.py, and consider escaping the underscores (e.g., \_\_init\_\_.py) if needed. As per coding guidelines, avoid using double underscores (__name__) in code blocks as they may render as bold in some contexts — always verify inside code fences.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@v3/integrations/hermes.mdx` at line 132, Verify that the tab name in the
code-fence metadata renders visibly as __init__.py rather than init.py; if the
renderer treats underscores as formatting, escape the underscores while
preserving the intended filename.
Source: Coding guidelines
| model = OpenAIChatModel( | ||
| "openai/gpt-5.5", | ||
| provider=OpenAIProvider( | ||
| api_key="YOUR_EDEN_AI_API_KEY", # Get from https://app.edenai.run |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Use standard token types in code examples.
The documentation uses placeholders like YOUR_EDEN_AI_API_KEY and your_api_key_here. As per coding guidelines, code examples must distinguish token types by using api_token for production and sandbox_api_token for testing (no real provider calls).
v3/integrations/pydantic-ai.mdx#L54-L54: Replace"YOUR_EDEN_AI_API_KEY"with"api_token", and optionally notesandbox_api_tokenin the adjacent comment.v3/integrations/pydantic-ai.mdx#L106-L106: Replace"YOUR_EDEN_AI_API_KEY"with"api_token".v3/integrations/pydantic-ai.mdx#L131-L131: Replace"YOUR_EDEN_AI_API_KEY"with"api_token".v3/integrations/pydantic-ai.mdx#L162-L162: Replace"YOUR_EDEN_AI_API_KEY"with"api_token".v3/integrations/pydantic-ai.mdx#L182-L182: Replaceyour_api_key_herewithapi_token.
📍 Affects 1 file
v3/integrations/pydantic-ai.mdx#L54-L54(this comment)v3/integrations/pydantic-ai.mdx#L106-L106v3/integrations/pydantic-ai.mdx#L131-L131v3/integrations/pydantic-ai.mdx#L162-L162v3/integrations/pydantic-ai.mdx#L182-L182
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@v3/integrations/pydantic-ai.mdx` at line 54, The Pydantic AI documentation
uses nonstandard API-key placeholders. In v3/integrations/pydantic-ai.mdx at
lines 54, 106, 131, and 162, replace “YOUR_EDEN_AI_API_KEY” with “api_token”; at
line 54, optionally mention “sandbox_api_token” in the adjacent comment. At line
182, replace “your_api_key_here” with “api_token”.
Source: Coding guidelines
2 participants
What
OpenAIChatModel+OpenAIProvider, pointed athttps://api.edenai.run/v3.--provider eden-ai), alongside the existingcustom-provider setup.Files
v3/integrations/pydantic-ai.mdx(new) +integration-logo/pydantic-ai-icondoc.svg(new, square, brand magenta)v3/integrations/hermes.mdx(edit: +1 section,dateModifiedbump)docs.json—pydantic-aiadded to AI FrameworksConventions
<TechArticleSchema>+<CodeGroup>).EDEN_AI_API_KEYfor Pydantic AI; Hermes keepsEDENAI_API_KEY(derived from the base-URL host).providersimport) are marked{/* skip-test */}so the snippet-execution CI skips them.To confirm before merge
register_provider/ProviderProfilefields) vs the current plugin loader.Summary by CodeRabbit
New Features
Documentation