Skip to content

Fix yaml in Google Generative AI #38481

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Apr 11, 2025
Merged

Fix yaml in Google Generative AI #38481

merged 1 commit into from
Apr 11, 2025

Conversation

tronikos
Copy link
Member

@tronikos tronikos commented Apr 10, 2025 •
edited by coderabbitai bot
Loading

Proposed change

Wrap yaml with raw

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

  • Documentation
    • Improved integration guidelines with a new example script that demonstrates how to process and capture voice assistant conversation responses.
    • Provided clear, step-by-step instructions to help users implement conversational actions effectively.

@home-assistant home-assistant bot added the current This PR goes into the current branch label Apr 10, 2025
@netlify Netlify
Copy link

netlify bot commented Apr 10, 2025 •
edited
Loading

✅ Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit 5a91727
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/67f854f4bea4f20008e5c83a
😎 Deploy Preview https://deploy-preview-38481--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.

@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Apr 10, 2025

📝 Walkthrough

Walkthrough

The changes update the documentation for the Google Generative AI integration by adding a new YAML script example. This example is now encapsulated between {% raw %} and {% endraw %} tags to preserve template syntax. The YAML snippet defines a sequence of actions for processing a conversation, including specifying an agent ID, providing text input, and capturing the response. No modifications were made to the exported or public entities.

Changes

File(s) Change Summary
source/_integrations/google_generative_ai_conversation.markdown Added a YAML script example enclosed in {% raw %}/{% endraw %} tags. The script defines a sequence with actions for processing conversation input and capturing output.

Sequence Diagram(s)

sequenceDiagram
    participant User as Voice Assistant/User
    participant Doc as YAML Script Example
    participant AI as Google Generative AI Integration

    User->>Doc: Initiates conversation (with text input)
    Doc->>AI: Calls conversation.process (agent: conversation.google_generative_ai_2)
    AI-->>Doc: Returns response (captured in variable)
    Doc-->>User: Provides result
Loading

Assessment against linked issues

Objective Addressed Explanation
Templates not showing up in Google Generative AI sample script (#38480) ✅
📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between efd49b4 and 5a91727.

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

95-124: YAML Raw Formatting Added:
The addition of the {% raw %} and {% endraw %} tags around the YAML code block ensures that the snippet is rendered exactly as intended without any interference from the templating engine. This change directly addresses the PR objective by enhancing the readability and usability of the sample in the documentation.

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

123-123: Fenced code blocks should be surrounded by blank lines
null

(MD031, blanks-around-fences)

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.

c0ffeeca7
c0ffeeca7 approved these changes Apr 11, 2025
View reviewed changes
Copy link
Contributor

@c0ffeeca7 c0ffeeca7 left a comment

Choose a reason for hiding this comment

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

Thank you, @tronikos 👍

@github-project-automation github-project-automation bot moved this from Todo to Approved in Documentation PRs Apr 11, 2025
@c0ffeeca7 c0ffeeca7 merged commit 1d1d23d into current Apr 11, 2025
9 checks passed
@c0ffeeca7 c0ffeeca7 deleted the tronikos-patch-2 branch April 11, 2025 11:29
@github-project-automation github-project-automation bot moved this from Approved to Done in Documentation PRs Apr 11, 2025
@github-actions github-actions bot locked and limited conversation to collaborators Apr 12, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@c0ffeeca7 c0ffeeca7 c0ffeeca7 approved these changes

Assignees
No one assigned
Labels
current This PR goes into the current branch
Projects
No open projects
Documentation PRs
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Templates not showing up in Google Generative AI sample script
2 participants
@tronikos @c0ffeeca7