Add 'agent_id' input field to intent_conversation_api.md file #2520
Conversation
As the `api/conversation/process` endpoint uses the (conversation action)[https://www.home-assistant.io/integrations/conversation/], the `agent_id` can be used and must be documented.
📝 WalkthroughWalkthroughThe documentation for the Conversation API has been updated to include a new optional input field called Changes
Sequence DiagramsequenceDiagram
participant Client
participant ConversationAPI
participant Agent
Client->>ConversationAPI: Request with optional agent_id
alt Specific Agent Selected
ConversationAPI->>Agent: Route to specified agent
else Default Agent
ConversationAPI->>Agent: Route to home_assistant
end
Agent-->>ConversationAPI: Process request
ConversationAPI-->>Client: Return response
The sequence diagram illustrates how the new Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 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: 1
🧹 Nitpick comments (1)
docs/intent_conversation_api.md (1)
Line range hint
8-24: Add agent_id to the JSON examplesThe documentation shows example JSON payloads but they don't include the
agent_idfield. While optional, it would be helpful to show the field in at least one example to demonstrate its usage.Update the REST API example:
{ "text": "turn on the lights in the living room", - "language": "en" + "language": "en", + "agent_id": "_home_assistant_" }And the WebSocket API example:
{ "type": "conversation/process", "text": "turn on the lights in the living room", - "language": "en" + "language": "en", + "agent_id": "_home_assistant_" }
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/intent_conversation_api.md(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
docs/intent_conversation_api.md (6)
Pattern */**(html|markdown|md): - For instructional content in documentation, use a direct and authoritative tone. Avoid expressions of politeness such as 'may' or 'please', and ensure the goal of the instruction is fronted.
- Apply the Microsoft Style Guide to ensure documentation maintains clarity and conciseness.
- In step-by-step instructions, front the location phrase in the instructional sentence.
- In step-by-step instructions, front the 'goal' in the instructional sentence.
- In step-by-step instructions, if in doubt what to front, front the 'goal' before the location phrase in the instructional sentence.
- do not hyphenate terms like 'top-right' or 'bottom-left' with 'corner'
Pattern */**(html|markdown|md): - Use bold to mark UI strings.
- If "" are used to mark UI strings, replace them by bold.
Pattern */**(html|markdown|md): - Be brief in your replies and don't add fluff like "thank you for..." and "Please let me know if"
Pattern */**(html|markdown|md): - Use sentence-style capitalization also in headings.
Pattern */**(html|markdown|md): do not comment on HTML used for icons
Pattern */**(html|markdown|md): Avoid flagging inline HTML for embedding videos in future reviews for this repository.
| @@ -34,6 +34,7 @@ The following input fields are available: | |||
| |-------------------|--------|---------------------------------------------------------------------------------------------| | |||
| | `text` | string | Input sentence. | | |||
| | `language` | string | Optional. Language of the input sentence (defaults to configured language). | | |||
| | `agent_id` | string | Optional. Conversation agent to process the request (defaults _home_assistant_). | | |||
There was a problem hiding this comment.
🛠️ Refactor suggestion
Update formatting and style of the agent_id description
The description needs several style improvements:
- Remove parentheses around the default value
- Use sentence-style capitalization
- Use "to" instead of implied relationship
-| `agent_id` | string | Optional. Conversation agent to process the request (defaults _home_assistant_). |
+| `agent_id` | string | Optional. Conversation agent to process the request. Defaults to _home_assistant_. |📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| | `agent_id` | string | Optional. Conversation agent to process the request (defaults _home_assistant_). | | |
| | `agent_id` | string | Optional. Conversation agent to process the request. Defaults to _home_assistant_. | |
As the
api/conversation/processendpoint uses the conversation action, theagent_idcan be used and must be documented.Proposed change
Just document the
agent_idinput field.Type of change
Additional information
Info taken from this forum thread.
Summary by CodeRabbit
agent_idinput fieldagent_idto API request payload examples