Update AI Task example to be IoT related #39900

balloob · 2025-07-07T09:21:08Z

Proposed change

Update the AI task example for structured output to be AI related.

Still need to verify the example works 100% as expected.

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).
- I've opened up a PR to add logos and icons in Brands repository.
Added documentation for a new feature I'm adding to Home Assistant (next branch).
Removed stale or deprecated documentation.

Additional information

Link to parent pull request in the codebase:
Link to parent pull request in the Brands repository:
This PR fixes or closes issue: fixes #

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
- Updated the example YAML script to demonstrate generating a weather and indoor comfort report instead of a user profile.
- Example now includes humorous weather descriptions and indoor comfort assessments based on sensor data.
- Notification action in the example displays the new report details.

home-assistant · 2025-07-07T09:21:11Z

It seems that this PR is targeted against an incorrect branch. Documentation updates which apply to our current stable release should target the current branch. Please change the target branch of this PR to current and rebase if needed. If this is documentation for a new feature, please add a link to that PR in your description.

netlify · 2025-07-07T09:21:12Z

✅ Deploy Preview for home-assistant-docs ready!

Name	Link
🔨 Latest commit	`890fd51`
🔍 Latest deploy log	https://app.netlify.com/projects/home-assistant-docs/deploys/68761464872a030008b5239c
😎 Deploy Preview	https://deploy-preview-39900--home-assistant-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

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

Copilot

Pull Request Overview

This PR updates the AI Task integration documentation example to demonstrate a more IoT-related use case. The change replaces a generic "fake user profile generation" example with a practical "weather and comfort report" example that leverages actual Home Assistant sensor data.

Updates the example script from user profile generation to weather and comfort reporting
Integrates real Home Assistant entities like outdoor temperature, weather conditions, and indoor sensors
Maintains the same structural format while demonstrating more relevant IoT functionality

source/_integrations/ai_task.markdown

coderabbitai · 2025-07-13T20:04:43Z

📝 Walkthrough

Walkthrough

The documentation for the ai_task.generate_data action was updated by replacing the previous example, which generated a user profile, with a new example that creates a weather and indoor comfort report based on sensor data. Variable names and notification content were modified to reflect the new context.

Changes

File	Change Summary
source/_integrations/ai_task.markdown	Replaced user profile generation example with weather and comfort report example in documentation. Updated variable names and notification details accordingly.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant ai_task.generate_data
    participant Notification

    User ->> ai_task.generate_data: Provide sensor data (outdoor temp, weather, indoor temp, humidity)
    ai_task.generate_data ->> ai_task.generate_data: Generate weather description & comfort assessment
    ai_task.generate_data -->> User: Return comfort_report (weather_description, indoor_comfort_assessment)
    User ->> Notification: Display weather description and comfort assessment

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.
- Explain this complex logic.
- 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 explain this code block.
- @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 explain its main purpose.
- @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@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.

home-assistant · 2025-07-13T20:06:23Z

It seems that this PR is targeted against an incorrect branch. Documentation updates which apply to our current stable release should target the current branch. Please change the target branch of this PR to current and rebase if needed. If this is documentation for a new feature, please add a link to that PR in your description.

coderabbitai

Actionable comments posted: 0

♻️ Duplicate comments (1)

source/_integrations/ai_task.markdown (1)
62-62: “Funny” tone still conflicts with HA doc style guidelines
This line is identical to the one previously flagged. Please switch to a neutral tone such as:
Generate an engaging weather description and assess indoor comfort level.

🧹 Nitpick comments (1)

source/_integrations/ai_task.markdown (1)
56-61: Consider using explicit weather attributes for temperature instead of a separate sensor

states('weather.home') already exposes temperature and other weather attributes. Pulling outdoor temperature from a dedicated sensor.outdoor_temperature is fine if your setup provides it, but many users won’t have that entity out-of-the-box.
To make the example more generally applicable you could pull the temperature from the weather entity itself:
- Outdoor temperature: {{ state_attr('weather.home', 'temperature') }}°C
This avoids a potential “entity not found” pitfall for new users.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between 73e6a1d and 7ac187e.

📒 Files selected for processing (1)

source/_integrations/ai_task.markdown (1 hunks)

🔇 Additional comments (1)

source/_integrations/ai_task.markdown (1)

74-83: Response-variable wiring looks correct
comfort_report.data.weather_description and .indoor_comfort match the keys defined under structure, and the indentation is valid YAML. Users should be able to paste this straight into a script.

source/_integrations/ai_task.markdown

c0ffeeca7

Thank you, @balloob 👍

home-assistant bot assigned balloob Jul 7, 2025

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 next This PR goes into the next branch labels Jul 7, 2025

balloob marked this pull request as ready for review July 13, 2025 20:03

Copilot AI review requested due to automatic review settings July 13, 2025 20:03

Copilot AI reviewed Jul 13, 2025

View reviewed changes

source/_integrations/ai_task.markdown Show resolved Hide resolved

Update AI Task example to be AI related

7ac187e

balloob force-pushed the update-example-iot-related branch from 917ace7 to 7ac187e Compare July 13, 2025 20:03

balloob removed 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 Jul 13, 2025

home-assistant bot added the in-progress This PR/Issue is currently being worked on label Jul 13, 2025

home-assistant bot added the needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch label Jul 13, 2025

coderabbitai bot reviewed Jul 13, 2025

View reviewed changes

Add template example

890fd51

balloob commented Jul 16, 2025

View reviewed changes

source/_integrations/ai_task.markdown Outdated Show resolved Hide resolved

Remove no longer needed mode.

03bad4d

c0ffeeca7 reviewed Jul 16, 2025

View reviewed changes

source/_integrations/ai_task.markdown Outdated Show resolved Hide resolved

source/_integrations/ai_task.markdown Outdated Show resolved Hide resolved

source/_integrations/ai_task.markdown Outdated Show resolved Hide resolved

Apply suggestions from code review

abca4f1

c0ffeeca7 approved these changes Jul 16, 2025

View reviewed changes

balloob merged commit acb1f3f into next Jul 16, 2025
5 checks passed

balloob deleted the update-example-iot-related branch July 16, 2025 12:36

home-assistant bot removed needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch in-progress This PR/Issue is currently being worked on labels Jul 16, 2025

github-actions bot locked and limited conversation to collaborators Jul 17, 2025

Uh oh!

Update AI Task example to be IoT related #39900

Update AI Task example to be IoT related #39900

Uh oh!

Conversation

balloob commented Jul 7, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Proposed change

Type of change

Additional information

Checklist

Summary by CodeRabbit

Uh oh!

home-assistant bot commented Jul 7, 2025

Uh oh!

netlify bot commented Jul 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for home-assistant-docs ready!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Uh oh!

coderabbitai bot commented Jul 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

home-assistant bot commented Jul 13, 2025

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

c0ffeeca7 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

balloob commented Jul 7, 2025 •

edited by coderabbitai bot

Loading

netlify bot commented Jul 7, 2025 •

edited

Loading

coderabbitai bot commented Jul 13, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)