Create Plugin: Update scenes app with LLM example #873
Conversation
…hat are more than one word long
…hat are more than one word long
…na/plugin-tools into add-llm-scenes-app-example
|
|
|
Hello! 👋 This repository uses Auto for releasing packages using PR labels. ✨ This PR can be merged. It will not be considered when calculating future versions of the npm packages and will not appear in the changelogs. |
nmarrs
added
the
no-changelog
| @@ -66,7 +66,7 @@ const getDrilldownsAppScene = () => { | |||
|
|
|||
| return new SceneAppPage({ | |||
| url: prefixRoute(`${ROUTES.WithDrilldown}`) + `/room/${roomName}/temperature`, | |||
| title: `${roomName} overview`, | |||
| title: `${decodeURI(roomName)} overview`, | |||
There was a problem hiding this comment.
This change is fixing an issue that was addressed in old dead repo (see here for context)
| pages: [ | ||
| new SceneAppPage({ | ||
| title: 'Page with LLM integration', | ||
| subTitle: 'This page showcases basic LLM integration within a scenes app', |
There was a problem hiding this comment.
expand the LLM abbreviation here for clarity
There was a problem hiding this comment.
This is a nice idea but, I am not a fan of offering examples for plugins that rely in experimental apis. They will easily change, break and this example will quickly become non functional
I'd like to hear @sympatheticmoose opinion in this one
Hey @academo! Thanks for the review! Totally understandable the concern about things breaking given the reliance of this on the grafana experimental package. For additional context, the API that this demo is using is our wrappers around OpenAIs chat completion API. Our wrapper API code has been stable since we first wrote it 8+ months ago so concern around breaking changes breaking things might not be as big of an issue :) We will need to include some docs / instructions in the readme though on how to install and set up the LLM plugin as that is required for this demo to work. Those instructions probably could go inline if we detect the plugin isn't installed / configured correctly |
The best course of action would be to move those APIs out of the experimental package, then use the stable released APIs in this example. |
There was a problem hiding this comment.
Hey @nmarrs - thanks for looking at this!
The template examples we provide should be fairly barebones to allow them to act as a starting point for development, whilst neat I feel this probably overcomplicates matters and is more niche. Is there a reason we would want this in create-plugin as opposed to https://github.com/grafana/grafana-plugin-examples/tree/main/examples?
Edit: just seen grafana/grafana-plugin-examples#273 - I think this is the best route forward for now, but maybe as a separate example
Hi @sympatheticmoose! Thanks for the reply. I think the main idea behind having these examples inside I understand your point on simplicity, maybe would only including the basic LLM integration example make sense while I could include / reference to the "more complex" example that can live over in the grafana plugin examples repo? This would still accomplish the point on discoverability but reduce the introduced complexity a fair amount. |
Update the create plugin template scenes app to include a example integrating the LLM plugin
NOTE: I'm not sure how to test this locally, but will work on figuring this out when I am back in next week. In meantime, with LLM plugin configured here are the demos that should be possible with these changes 🦖
basic.llm.integration.question.1.mov
basic.llm.integration.question.2.mov
advanced.llm.integration.backup.mov
Related PR: grafana/grafana-plugin-examples#273