jeans/developers.home-assistant
jeans/developers.home-assistant
1
0
Fork 0
mirror of https://github.com/home-assistant/developers.home-assistant.git synced 2025-07-14 12:56:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add example usage for unregistering an LLM API (#2524)

Browse Source 
* Add example usage for unregistering an LLM API

* Update example to be based on a config entry
This commit is contained in:
Allen Porter 2025-01-09 08:52:36 -08:00 committed by GitHub
parent 0abbc5dcbe
commit 5ffe47872d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 9 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
docs/core/llm/index.md
View File

@ -242,6 +242,7 @@ The `ToolInput` has following attributes:
The API object allows creating API instances. An API Instance represents a collection of tools that will be made available to the LLM. The API object allows creating API instances. An API Instance represents a collection of tools that will be made available to the LLM.
```python ```python
from homeassistant.config_entries import ConfigEntry
from homeassistant.core import HomeAssistant from homeassistant.core import HomeAssistant
from homeassistant.helper import llm from homeassistant.helper import llm
from homeassistant.util import dt as dt_util from homeassistant.util import dt as dt_util
@ -251,14 +252,6 @@ from homeassistant.util.json import JsonObjectType
class MyAPI(API): class MyAPI(API):
"""My own API for LLMs.""" """My own API for LLMs."""
def __init__(self, hass: HomeAssistant) -> None:
"""Init the class."""
super().__init__(
hass=hass,
id="my_unique_key",
name="My own API",
)
async def async_get_api_instance(self, llm_context: LLMContext) -> APIInstance: async def async_get_api_instance(self, llm_context: LLMContext) -> APIInstance:
"""Return the instance of the API.""" """Return the instance of the API."""
return APIInstance( return APIInstance(
@ -269,9 +262,15 @@ class MyAPI(API):
) )
async def async_setup_api(hass: HomeAssistant) -> None: async def async_setup_api(hass: HomeAssistant, entry: ConfigEntry) -> None:
"""Register the API with Home Assistant.""" """Register the API with Home Assistant."""
llm.async_register_api(hass, MyAPI()) # If the API is associated with a Config Entry, the LLM API must be
# unregistered when the config entry is unloaded.
unreg = llm.async_register_api(
hass,
MyAPI(hass, f"my_unique_key-{entry.entry_id}", entry.title)
)
entry.async_on_unload(unreg)
``` ```
The `llm.API` class has the following attributes: The `llm.API` class has the following attributes: