Skip to content

Added documentation for Google Search option #38363

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 1 commit into from
Apr 3, 2025

Conversation

IvanLH
Copy link
Contributor

@IvanLH IvanLH commented Apr 3, 2025

Proposed change

Adds missing documentation for Google Search option into the current documents.

Type of change

  • Spelling, grammar or other readability improvements (current branch).
  • Adjusted missing or incorrect information in the current documentation (current branch).
  • Added documentation for a new integration I'm adding to Home Assistant (next branch).
  • Added documentation for a new feature I'm adding to Home Assistant (next branch).
  • Removed stale or deprecated documentation.

Additional information

Checklist

  • This PR uses the correct branch, based on one of the following:
    • I made a change to the existing documentation and used the current branch.
    • I made a change that is related to an upcoming version of Home Assistant and used the next branch.
  • The documentation follows the Home Assistant documentation standards.

Summary by CodeRabbit

  • New Features
    • Added a new option in the Google Generative AI integration to enable the Google Search tool. This setting allows the AI model to perform search queries when external control interactions are restricted.

@IvanLH IvanLH requested a review from tronikos as a code owner April 3, 2025 19:28
@home-assistant home-assistant bot added current This PR goes into the current branch has-parent This PR has a parent PR in a other repo in-progress This PR/Issue is currently being worked on needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch labels Apr 3, 2025
@home-assistant
Copy link

home-assistant bot commented Apr 3, 2025

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 next branch. Please change the target branch of this PR to next and rebase if needed.

Copy link

netlify bot commented Apr 3, 2025

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit 88adc8e
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/67eee1781bfdd30008ad4fdd
😎 Deploy Preview https://deploy-preview-38363--home-assistant-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Contributor

coderabbitai bot commented Apr 3, 2025

📝 Walkthrough

Walkthrough

A new configuration option named "Enable Google Search tool" has been added to the Google Generative AI integration documentation. The option is described along with its condition: it is only available when the AI is configured not to interact with exposed entities (i.e., when "Control Home Assistant" is set to "No control"). No existing content was removed or modified, and the change solely expands the available configuration settings.

Changes

File(s) Change Summary
source/_integrations/.../google_generative_ai_conversation.markdown Added a new configuration option "Enable Google Search tool" with a description specifying its functionality and the condition that it works only when "Control Home Assistant" is set to "No control".

Sequence Diagram(s)

sequenceDiagram
    participant User as User/Administrator
    participant Config as Configuration Interface
    participant AI as Google Generative AI Integration
    participant GS as Google Search Service

    User->>Config: Open settings for Google Generative AI
    Config-->>User: Display new "Enable Google Search tool" option
    User->>Config: Select "No control" in "Control Home Assistant"
    Config->>AI: Enable "Google Search tool" configuration
    note over AI,GS: When triggered during a conversation...
    AI->>GS: Query Google Search
    GS-->>AI: Return search results
Loading

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.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
source/_integrations/google_generative_ai_conversation.markdown (1)

73-74: Enhance Documentation Clarity for "Enable Google Search tool" Option

The new configuration option is a valuable and clear addition. However, the description can be slightly rephrased for improved readability. In particular, consider splitting the long sentence into two sentences and highlighting the conditional requirement (i.e. when the "Control Home Assistant" setting is set to "No control") using quotes or backticks.

-  description: Enables the model to [query Google Search](https://ai.google.dev/gemini-api/docs/grounding), this can only be enabled when the AI is not allowed to interact with exposed entities by selecting "No control" in the Control Home Assistant setting.
+  description: Enables the model to [query Google Search](https://ai.google.dev/gemini-api/docs/grounding). This option can only be enabled when the AI is not allowed to interact with exposed entities (i.e. when the "Control Home Assistant" setting is set to "No control").
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 46dd522 and 88adc8e.

📒 Files selected for processing (1)
  • source/_integrations/google_generative_ai_conversation.markdown (1 hunks)

@home-assistant home-assistant bot added the parent-merged The parent PR has been merged already label Apr 3, 2025
@github-project-automation github-project-automation bot moved this from Todo to Approved in Documentation PRs Apr 3, 2025
@tronikos tronikos merged commit 9d2b512 into home-assistant:current Apr 3, 2025
7 checks passed
@home-assistant home-assistant bot removed in-progress This PR/Issue is currently being worked on parent-merged The parent PR has been merged already needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch labels Apr 3, 2025
@github-project-automation github-project-automation bot moved this from Approved to Done in Documentation PRs Apr 3, 2025
@home-assistant
Copy link

home-assistant bot commented Apr 3, 2025

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 next branch. Please change the target branch of this PR to next and rebase if needed.

@home-assistant home-assistant bot added in-progress This PR/Issue is currently being worked on needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch labels Apr 3, 2025
@github-actions github-actions bot locked and limited conversation to collaborators Apr 5, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
current This PR goes into the current branch has-parent This PR has a parent PR in a other repo in-progress This PR/Issue is currently being worked on needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants