-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update README.md and src/README.md with dev/user instructions
- Loading branch information
Showing
2 changed files
with
30 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,31 @@ | ||
<!-- This README file is going to be the one displayed on the Grafana.com website for your plugin --> | ||
# Grafana LLM app | ||
|
||
# Llm | ||
This is a Grafana application plugin which centralizes access to LLMs across Grafana. | ||
|
||
Plugin to easily allow llm based extensions to grafana | ||
It is responsible for: | ||
|
||
- storing API keys for LLM providers | ||
- proxying requests to LLMs with auth, so that other Grafana components need not store API keys | ||
- providing Grafana Live streams of streaming responses from LLM providers (namely OpenAI) | ||
- providing LLM based extensions to Grafana's extension points (e.g. 'explain this panel') | ||
|
||
Future functionality will include: | ||
|
||
- rate limiting of requests to LLMs, for cost control | ||
- token and cost estimation | ||
- RBAC to only allow certain users to use LLM functionality | ||
|
||
## For users | ||
|
||
Install and configure this plugin to enable various LLM-related functionality across Grafana. | ||
This will include new functionality inside Grafana itself, such as explaining panels, or | ||
in plugins, such as natural language query editors. | ||
|
||
All LLM requests will be routed via this plugin, which ensures the correct API key is being | ||
used and rate limited appropriately. | ||
|
||
## For plugin developers | ||
|
||
This plugin is not designed to be directly interacted with; instead, we will provide convenience | ||
functions in the [`@grafana/experimental`][experimental] package which will communicate with this | ||
plugin, if installed. See the [`grafana-llm-examples`] repository for examples of how this works. |