add doc with instructions for openrouter #473
Conversation
|
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Summary of ChangesHello @MarvelNwachukwu, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request significantly expands the documentation for ADK-TS agents by integrating OpenRouter as a new, flexible option for LLM configuration. The changes aim to provide users with a unified and simplified way to access a diverse range of models from various providers, enhancing the framework's versatility and user experience. This update includes detailed setup guides, benefits, and usage examples, making it easier for developers to leverage OpenRouter's capabilities. Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request adds comprehensive documentation for integrating OpenRouter as a model provider. The changes are well-structured and clearly explain the setup, usage, and benefits of OpenRouter. I've identified a couple of minor issues in the example code snippets that could improve the accuracy and robustness of the documentation for users. Overall, this is a great addition to the docs.
| | Google | `google/gemini-2.5-pro` | Advanced reasoning, multimodal | | ||
| | OpenAI | `openai/gpt-4o` | Powerful general-purpose model | | ||
| | Anthropic | `anthropic/claude-sonnet-4-5-20250929` | Excellent for analysis and coding | | ||
| | Meta | `meta-llama/llama-3.3-70b-instruct` | Open source, strong performance | |
There was a problem hiding this comment.
There appears to be a typo in the Llama 3 model name. According to OpenRouter's documentation, the model identifier is meta-llama/llama-3-70b-instruct, not llama-3.3-70b-instruct. Using the incorrect name will cause errors for users who copy this example.
| Meta | `meta-llama/llama-3-70b-instruct` | Open source, strong performance |
| TELEGRAM_BOT_TOKEN: z.string(), | ||
| LLM_MODEL: z.string().default("google/gemini-2.5-flash"), | ||
| OPENROUTER_API_KEY: z.string(), |
There was a problem hiding this comment.
For required environment variables like API keys, it's a good practice to ensure they are not empty strings. Using z.string().min(1) instead of just z.string() will enforce this and make the configuration example more robust. This applies to both TELEGRAM_BOT_TOKEN and OPENROUTER_API_KEY.
TELEGRAM_BOT_TOKEN: z.string().min(1),
LLM_MODEL: z.string().default("google/gemini-2.5-flash"),
OPENROUTER_API_KEY: z.string().min(1),
| }); | ||
| ``` | ||
|
|
||
| ### Example: Environment-Based Configuration |
There was a problem hiding this comment.
Let's remove this example section, because there is nothing unique or different about it. It is the same as building any ADK-TS agent and you have already covered the setup in "Setup Requirements", so it is just duplicating the same content.
Adebesin-Cell
left a comment
Adebesin-Cell
left a comment
There was a problem hiding this comment.
Looks good! Kindly fix @Timonwa's suggestion and we can merge
Pull Request
Description
Related Issue
Type of Change
How Has This Been Tested?
Checklist
Screenshots (if applicable)
Additional Notes