Add a workaround for using Google Search in Google Generative AI #38391
Conversation
home-assistant
bot
added
current
|
It seems that this PR is targeted against an incorrect branch since it has a parent PR on one of our codebases. Documentation that needs to be updated for an upcoming release should target the |
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe update adds a new "Google Search" section to the Google Generative AI conversation documentation. This section provides a workaround for using the Google Search tool by detailing the configuration of a secondary Google Generative AI service. It also clarifies that the "Enable Google Search tool" option is available only when the "Control Home Assistant" setting is set to "No control." Additionally, the changes include a new script alias ( Changes
Sequence Diagram(s)sequenceDiagram
participant U as User
participant C as Google Generative AI Conversation
participant S as Assist: Search Google Script
participant G as Google Search API
U->>C: Initiates query via conversation
C->>S: Delegates non smart-home related query
S->>G: Executes Google search with provided query
G-->>S: Returns search results
S-->>C: Forwards search results
C-->>U: Displays processed response
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
source/_integrations/google_generative_ai_conversation.markdown (2)
77-81: New "Google Search" Section and API Limitation Explanation:
The introduction of the "## Google Search" section effectively outlines the API limitation by explaining that using the tool with other features leads to a400 INVALID_ARGUMENTerror. For enhanced readability, consider adding a comma after the introductory phrase on line 79 (e.g., after "Due to an API limitation") as suggested by static analysis.🧰 Tools
🪛 LanguageTool
[typographical] ~79-~79: Consider adding a comma after this introductory phrase.
Context: ...sic %} ## Google Search Due to an API limitation we cannot have the [Google Search tool]...(ACCORDING_TO_COMMA)
🪛 markdownlint-cli2 (0.17.2)
80-80: Trailing spaces
Expected: 0 or 2; Actual: 1(MD009, no-trailing-spaces)
82-127: Comprehensive Workaround Details with Minor Formatting Suggestions:
The detailed steps within the{% details "Workaround for Google Search tool" %}block provide a clear, step-by-step guide for users to set up a secondary Google Generative AI service with the Google Search tool enabled. The included YAML snippet for the script alias ("Assist: Search Google") is well-structured and informative.Suggestions:
- The ordered list items at lines 123–125 currently use numbering (11, 12, 13) that may conflict with common markdown style guidelines. Consider renumbering these items (e.g., using “1.” repeatedly or a sequential “1, 2, 3…”) to improve consistency.
- Also, verify that any trailing spaces (as noted by static analysis on line 80) are removed to adhere to markdown formatting best practices.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
123-123: Ordered list item prefix
Expected: 1; Actual: 11; Style: 1/2/3(MD029, ol-prefix)
124-124: Ordered list item prefix
Expected: 2; Actual: 12; Style: 1/2/3(MD029, ol-prefix)
125-125: Ordered list item prefix
Expected: 3; Actual: 13; Style: 1/2/3(MD029, ol-prefix)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/google_generative_ai_conversation.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/google_generative_ai_conversation.markdown
[typographical] ~79-~79: Consider adding a comma after this introductory phrase.
Context: ...sic %} ## Google Search Due to an API limitation we cannot have the [Google Search tool]...
(ACCORDING_TO_COMMA)
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/google_generative_ai_conversation.markdown
80-80: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
123-123: Ordered list item prefix
Expected: 1; Actual: 11; Style: 1/2/3
(MD029, ol-prefix)
124-124: Ordered list item prefix
Expected: 2; Actual: 12; Style: 1/2/3
(MD029, ol-prefix)
125-125: Ordered list item prefix
Expected: 3; Actual: 13; Style: 1/2/3
(MD029, ol-prefix)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - home-assistant-docs
- GitHub Check: Header rules - home-assistant-docs
- GitHub Check: Pages changed - home-assistant-docs
🔇 Additional comments (1)
source/_integrations/google_generative_ai_conversation.markdown (1)
74-74: Clarification Added for Google Search Tool Setting:
The updated description in this line clearly explains that the Google Search tool can only be enabled when the "Control Home Assistant" setting is set to "No control". This added clarification helps users understand the limitations up front.
home-assistant
bot
removed
needs-rebase
Proposed change
Add a workaround for using Google Search in Google Generative AI
Credits to @Andrerm124 and @swever826
See home-assistant/core#141712
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit
New Features
Documentation