Skip to content

Commit 74144c7

Browse files
chore(internal): sync tool docs after merge [skip ci]
1 parent 2565134 commit 74144c7

1 file changed

Lines changed: 18 additions & 6 deletions

File tree

site/src/data/tools.json

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -256,14 +256,26 @@
256256
{
257257
"name": "ha_manage_pipeline",
258258
"title": "Manage Assist Pipeline",
259-
"description": "Manage Home Assistant Assist pipelines.\n\nUse action='list' to discover pipeline IDs, action='get' to inspect one\npipeline, action='create' or action='update' to write pipeline settings,\nand action='set_preferred' to choose the preferred pipeline.\n\nEXAMPLES:\n- List pipelines: ha_manage_pipeline(action=\"list\")\n- Get one pipeline: ha_manage_pipeline(action=\"get\", pipeline_id=\"preferred\")\n- Create by cloning preferred: ha_manage_pipeline(\n action=\"create\",\n name=\"Local Assist\",\n conversation_engine=\"conversation.local_llm\",\n )\n- Create by cloning a specific pipeline: ha_manage_pipeline(\n action=\"create\",\n base_pipeline_id=\"preferred\",\n name=\"Local Assist\",\n conversation_engine=\"conversation.local_llm\",\n )\n- Update conversation agent and clear TTS voice: ha_manage_pipeline(\n action=\"update\",\n pipeline_id=\"preferred\",\n conversation_engine=\"conversation.local_llm\",\n tts_voice=\"\",\n )\n- Set preferred: ha_manage_pipeline(\n action=\"set_preferred\",\n pipeline_id=\"preferred\",\n )\n\nEmpty string clears nullable STT/TTS/wake-word fields. Non-nullable\nfields such as name, language, conversation_language, and\nconversation_engine must be omitted or non-empty.",
259+
"description": "Manage Home Assistant Assist pipelines.\n\nUse action='list' to discover pipeline IDs, action='get' to inspect one\npipeline, action='create' or action='update' to write pipeline settings,\naction='set_preferred' to choose the preferred pipeline, and\naction='process' to run a sentence through Assist.\n\naction='process' sends the sentence straight to Assist's conversation\nagent, so a matched intent executes: it turns on the light rather than\nreporting that it would. Its result carries response_type\n('action_done', 'query_answer' or 'error') and, on an error, error_code\nsuch as 'no_intent_match' — Assist declining a sentence is an answer,\nnot a tool failure, so inspect those fields rather than expecting a\nraised error. Use ha_call_service to act on an entity directly; use\nthis to test what Assist itself understands. When the built-in agent\nanswers, a matching conversation trigger runs its automation: that\nagent checks its sentence triggers before it matches intents, so this\nis not limited to intents. pipeline_id borrows a pipeline's\nconversation agent and language, but the sentence still goes to the\nagent directly. So with an agent other than the built-in one, neither\nsentence triggers nor prefer_local_intents apply — a full pipeline run\nis what adds those for other agents.\n\nEXAMPLES:\n- List pipelines: ha_manage_pipeline(action=\"list\")\n- Get one pipeline: ha_manage_pipeline(action=\"get\", pipeline_id=\"preferred\")\n- Create by cloning preferred: ha_manage_pipeline(\n action=\"create\",\n name=\"Local Assist\",\n conversation_engine=\"conversation.local_llm\",\n )\n- Create by cloning a specific pipeline: ha_manage_pipeline(\n action=\"create\",\n base_pipeline_id=\"preferred\",\n name=\"Local Assist\",\n conversation_engine=\"conversation.local_llm\",\n )\n- Update conversation agent and clear TTS voice: ha_manage_pipeline(\n action=\"update\",\n pipeline_id=\"preferred\",\n conversation_engine=\"conversation.local_llm\",\n tts_voice=\"\",\n )\n- Set preferred: ha_manage_pipeline(\n action=\"set_preferred\",\n pipeline_id=\"preferred\",\n )\n- Run a sentence: ha_manage_pipeline(\n action=\"process\",\n sentence=\"turn on the kitchen light\",\n )\n- Run it through one pipeline's agent: ha_manage_pipeline(\n action=\"process\",\n sentence=\"turn on the kitchen light\",\n pipeline_id=\"preferred\",\n )\n- Continue a conversation: ha_manage_pipeline(\n action=\"process\",\n sentence=\"and the hallway?\",\n conversation_id=\"<id from the previous response>\",\n )\n\nEmpty string clears nullable STT/TTS/wake-word fields. Non-nullable\nfields such as name, language, conversation_language, and\nconversation_engine must be omitted or non-empty.",
260260
"inputSchema": {
261261
"properties": {
262262
"action": {
263-
"type": "Annotated[PipelineAction, Field(description='Pipeline operation: list, get, create, update, or set_preferred.')]"
263+
"type": "Annotated[PipelineAction, Field(description='Pipeline operation: list, get, create, update, set_preferred, or process.')]"
264264
},
265265
"pipeline_id": {
266-
"type": "Annotated[str | None, Field(description='Assist pipeline ID. Required for get, update, and set_preferred.', default=None)]",
266+
"type": "Annotated[str | None, Field(description='Assist pipeline ID. Required for get, update, and set_preferred. Optional for process, where it selects the conversation agent and language that pipeline is configured with.', default=None)]",
267+
"default": null
268+
},
269+
"sentence": {
270+
"type": "Annotated[str | None, Field(description=\"Natural-language command to run through Assist. Required when action='process'. A matched intent executes, and with the built-in agent a sentence matching a conversation trigger runs that automation.\", default=None)]",
271+
"default": null
272+
},
273+
"conversation_id": {
274+
"type": "Annotated[str | None, Field(description='For process only, the conversation to continue. Returned in the response so follow-up sentences keep their context.', default=None)]",
275+
"default": null
276+
},
277+
"agent_id": {
278+
"type": "Annotated[str | None, Field(description=\"For process only, the conversation agent entity ID to answer, e.g. 'conversation.home_assistant'. Overrides the agent taken from pipeline_id; omit both for the default agent.\", default=None)]",
267279
"default": null
268280
},
269281
"name": {
@@ -283,7 +295,7 @@
283295
"default": null
284296
},
285297
"language": {
286-
"type": "Annotated[str | None, Field(description=\"Pipeline language, e.g. 'en'.\", default=None)]",
298+
"type": "Annotated[str | None, Field(description=\"Pipeline language, e.g. 'en'. For process, the language to recognise the sentence in.\", default=None)]",
287299
"default": null
288300
},
289301
"stt_engine": {
@@ -328,15 +340,15 @@
328340
]
329341
},
330342
"annotations": {
331-
"openWorldHint": false,
343+
"openWorldHint": true,
332344
"destructiveHint": true,
333345
"idempotentHint": false,
334346
"readOnlyHint": false
335347
},
336348
"tags": [
337349
"Assist"
338350
],
339-
"source_file": "tools_voice_assistant.py"
351+
"source_file": "tools_assist_pipeline.py"
340352
},
341353
{
342354
"name": "ha_config_get_automation",

0 commit comments

Comments
 (0)