docs: migration of Python Sdk docs#2164
Conversation
Summary of ChangesHello @rapid-killer-9, 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 enhances the Python SDK documentation by integrating new sections that clarify package selection and provide a comprehensive overview of the available SDKs. The changes aim to improve user experience by offering explicit guidance on choosing the correct SDK for various application frameworks and presenting a structured summary of each package's purpose and details. 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
|
There was a problem hiding this comment.
Code Review
This pull request updates the Python SDK documentation to include guidance on which package to use and a summary table of available packages. The changes are clear and helpful. I've added a few comments to fix a broken link, improve formatting, and adhere to common file conventions.
anubhav756
left a comment
There was a problem hiding this comment.
Please make sure to:
- Also update the respective SDK repos READMEs to have minimal instructions and deep-link to the guides on this docsite.
- Ensure we have the latest changes from all the SDK repos' READMEs right before we remove the existing content from them (as they are migrated here now) and replace them with appropriate minimal instructions.
This PR migrates the toolbox-adk Python SDK documentation to the main documentation site. It ensures all technical guides and references are centralized and up-to-date with the latest project standards. **Key Changes** - Documentation Migration: Ported comprehensive content from the Python SDK repository to the main docsite, covering installation, basic usage, and advanced configurations. - Compatibility Updates: Updated the documentation to support the current Hugo version used by the site. - Model Update: Updated all Gemini model references to Gemini 3 Preview to align with the latest SDK capabilities. - Content Enhancement: Added detailed guides for: - Transport Protocols: Documentation on supported transport protocols, including Model Context Protocol (MCP) and native Toolbox HTTP. - Authentication Strategies: Extensive coverage of various authentication methods using CredentialStrategy, such as Workload Identity, OAuth2, API keys, and manual credentials. - Advanced Configuration: Outlined options for adding custom headers, global parameter binding, and implementing pre_hook and post_hook functions for tool invocation. --------- Co-authored-by: Anubhav Dhawan <anubhavdhawan@google.com>
## Description Migrating docs from python Sdk to the main docsite for `toolbox-llamaindex` --------- Co-authored-by: Anubhav Dhawan <anubhavdhawan@google.com> Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
This PR migrates the toolbox-langchain Python SDK documentation to the main documentation site. It ensures all technical guides and references are centralized and up-to-date with the latest project standards. **Key Changes** - Documentation Migration: Ported comprehensive content from the Python SDK repository to the main docsite, covering installation, quickstart examples, and detailed usage instructions for integrating with popular AI frameworks like LangChain and LangGraph. - Compatibility Updates: Updated the documentation to support the current Hugo version used by the site. - Model Update: Updated all Gemini model references to Gemini 3 Preview to align with the latest SDK capabilities. - Content Enhancement: Added detailed guides for: - Framework Integration: Detailed examples and guidance on integrating the SDK with both LangChain and LangGraph, including graph configurations. - Authentication Mechanisms: Coverage of client-to-server authentication (specifically for Google Cloud environments like Cloud Run) and tool-specific authentication using OIDC/Google OAuth 2.0 ID tokens. - Advanced Usage: Guidance on binding parameter values to tools for security and consistency, alongside instructions for utilizing asynchronous interfaces to improve performance. --------- Co-authored-by: Anubhav Dhawan <anubhavdhawan@google.com> Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
This PR migrates the toolbox-core Python SDK documentation to the main documentation site. It ensures all technical guides and references are centralized and up-to-date with the latest project standards. **Key Changes** - Documentation Migration: Ported comprehensive content from the Python SDK repository to the main docsite, covering installation, setup, and core features. - Compatibility Updates: Updated the documentation to support the current Hugo version used by the site. - Model Update: Updated all Gemini model references to Gemini 3 Preview to align with the latest SDK capabilities. - Content Enhancement: Added detailed guides for: - SDK Usage and Quickstart: Clear instructions for installation and minimal examples for both asynchronous and synchronous operations. - Authentication Mechanisms: Guidance for client-to-server authentication (e.g., Cloud Run) and per-tool authentication using ID token retriever functions. - Advanced Features: Detailed explanations on binding parameter values to tools, either statically or dynamically. - Framework Integration: Practical integration examples with frameworks such as LangGraph. --------- Co-authored-by: Anubhav Dhawan <anubhavdhawan@google.com> Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
|
🧨 Preview deployments removed. |
Docs Migration across Sdk repo (py, js & go) to genai-toolbox repo This is a parent branch for all the sdks py - #2164 js - #2329 go - #2292 This pr will also solve [Issue](#1182) --------- Co-authored-by: Anmol Shukla <shuklaanmol@google.com> Co-authored-by: Anubhav Dhawan <anubhavdhawan@google.com> Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Docs Migration across Sdk repo (py, js & go) to genai-toolbox repo This is a parent branch for all the sdks py - #2164 js - #2329 go - #2292 This pr will also solve [Issue](#1182) --------- Co-authored-by: Anmol Shukla <shuklaanmol@google.com> Co-authored-by: Anubhav Dhawan <anubhavdhawan@google.com> Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> 87f2eaf
) Docs Migration across Sdk repo (py, js & go) to genai-toolbox repo This is a parent branch for all the sdks py - googleapis#2164 js - googleapis#2329 go - googleapis#2292 This pr will also solve [Issue](googleapis#1182) --------- Co-authored-by: Anmol Shukla <shuklaanmol@google.com> Co-authored-by: Anubhav Dhawan <anubhavdhawan@google.com> Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> 87f2eaf
) Docs Migration across Sdk repo (py, js & go) to genai-toolbox repo This is a parent branch for all the sdks py - googleapis#2164 js - googleapis#2329 go - googleapis#2292 This pr will also solve [Issue](googleapis#1182) --------- Co-authored-by: Anmol Shukla <shuklaanmol@google.com> Co-authored-by: Anubhav Dhawan <anubhavdhawan@google.com> Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> 87f2eaf
Docs Migration across Sdk repo (py, js & go) to genai-toolbox repo This is a parent branch for all the sdks py - googleapis/mcp-toolbox#2164 js - googleapis/mcp-toolbox#2329 go - googleapis/mcp-toolbox#2292 This pr will also solve [Issue](googleapis/mcp-toolbox#1182) --------- Co-authored-by: Anmol Shukla <shuklaanmol@google.com> Co-authored-by: Anubhav Dhawan <anubhavdhawan@google.com> Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Docs Migration from python SDK repo to genai-toolbox repo.
This branch is used as parent branch for python Sdk docs migration
child branch: