Home Assistant Unofficial Reference 2024.12.1
homeassistant.helpers.llm.ScriptTool Class Reference
Inheritance diagram for homeassistant.helpers.llm.ScriptTool:
[legend]
Collaboration diagram for homeassistant.helpers.llm.ScriptTool:
[legend]

Public Member Functions

None __init__ (self, HomeAssistant hass, str script_entity_id)
 
JsonObjectType async_call (self, HomeAssistant hass, ToolInput tool_input, LLMContext llm_context)
 

Public Attributes

 name
 
 parameters
 

Private Attributes

 _object_id
 

Additional Inherited Members

- Static Public Attributes inherited from homeassistant.helpers.llm.Tool
 None
 
 Schema
 

Detailed Description

LLM Tool representing a Script.

Definition at line 688 of file llm.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.helpers.llm.ScriptTool.__init__ (   self,
HomeAssistant  hass,
str  script_entity_id 
)
Init the class.

Definition at line 691 of file llm.py.

Member Function Documentation

◆ async_call()

JsonObjectType homeassistant.helpers.llm.ScriptTool.async_call (   self,
HomeAssistant  hass,
ToolInput  tool_input,
LLMContext   llm_context 
)
Run the script.

Reimplemented from homeassistant.helpers.llm.Tool.

Definition at line 705 of file llm.py.

Member Data Documentation

◆ _object_id

homeassistant.helpers.llm.ScriptTool._object_id
private

Definition at line 697 of file llm.py.

◆ name

homeassistant.helpers.llm.ScriptTool.name

Definition at line 697 of file llm.py.

◆ parameters

homeassistant.helpers.llm.ScriptTool.parameters

Definition at line 701 of file llm.py.


The documentation for this class was generated from the following file: