Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Scenes app example: Add scenes app LLM plugin integration demo example #273

Open
wants to merge 9 commits into
base: main
Choose a base branch
from

Conversation

nmarrs
Copy link
Contributor

@nmarrs nmarrs commented Apr 11, 2024

Update the create plugin template scenes app to include a example integrating the LLM plugin

TODO:

  • Test locally - I'm not sure how to, but will work on figuring this out when I am back in next week
  • Update documentation
  • Fix npm dependency issues
  • re-test 😬

In meantime, with LLM plugin configured here are the demos that should be possible with these changes 🦖

As a side note it would be super cool if there was a way to somehow have a single github repo for demos vs needing to duplicate changes between this repo and plugin-tools 😬 (i.e. see this PR with duplicate changes)

basic.llm.integration.question.1.mov
basic.llm.integration.question.2.mov
advanced.llm.integration.backup.mov

Related PR: grafana/plugin-tools#873

@nmarrs nmarrs self-assigned this Apr 11, 2024
@nmarrs nmarrs requested review from a team as code owners April 11, 2024 17:18
@nmarrs nmarrs requested review from leventebalogh, wbrowne, marefr and oshirohugo and removed request for a team April 11, 2024 17:18
@CLAassistant
Copy link

CLAassistant commented Apr 11, 2024

CLA assistant check
All committers have signed the CLA.

Copy link
Contributor

@sympatheticmoose sympatheticmoose left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @nmarrs thanks again for these contributions.

As a side note it would be super cool if there was a way to somehow have a single github repo for demos vs needing to duplicate changes between this repo and plugin-tools

create-plugin templates are starting points which we try to keep fairly minimal so users don't have a ton to delete, but can still see "enough" to get started. We already get feedback that they are overly complex/cluttered.

These examples can showcase more specific functionality or be fully featured demos. A potential enhancement we are considering is to allow create-plugin to eventually also load these as templates, for example npx @grafana/create-plugin@latest --pluginType='scenesapp' --template='scenesapp-with-llm'

I think this would make a great addition to the examples repository, but can I request we split this out into its own example called something like app-with-scenes-llm and there in the example readme indicate any particular requirements or caution over experimental APIs, i.e. https://github.com/grafana/grafana-plugin-examples/tree/main/examples/app-with-service-account.

You could then remove other sections as you see fit compared to the current app-with-scenes example, to make this more focussed.

@nmarrs
Copy link
Contributor Author

nmarrs commented Apr 28, 2024

Hey @nmarrs thanks again for these contributions.

As a side note it would be super cool if there was a way to somehow have a single github repo for demos vs needing to duplicate changes between this repo and plugin-tools

create-plugin templates are starting points which we try to keep fairly minimal so users don't have a ton to delete, but can still see "enough" to get started. We already get feedback that they are overly complex/cluttered.

These examples can showcase more specific functionality or be fully featured demos. A potential enhancement we are considering is to allow create-plugin to eventually also load these as templates, for example npx @grafana/create-plugin@latest --pluginType='scenesapp' --template='scenesapp-with-llm'

I think this would make a great addition to the examples repository, but can I request we split this out into its own example called something like app-with-scenes-llm and there in the example readme indicate any particular requirements or caution over experimental APIs, i.e. https://github.com/grafana/grafana-plugin-examples/tree/main/examples/app-with-service-account.

You could then remove other sections as you see fit compared to the current app-with-scenes example, to make this more focussed.

Hey @sympatheticmoose! I think this route sounds good - I will work on splitting out this example and will re-request your review when it is ready to go. Re: create-plugin template I think it would be great to still try and include the basic LLM integration screen just for discoverability sake (see this related comment on the related create plugin PR) but will defer to your judgement there 👍

@nmarrs nmarrs reopened this Jun 20, 2024
@nmarrs nmarrs requested a review from sympatheticmoose June 20, 2024 20:49
@nmarrs
Copy link
Contributor Author

nmarrs commented Jun 20, 2024

I've gone through and updated this to be a separate example. I'm having some troubles though testing this locally as when trying to open the app plugin it gets a bad request error. This should be ready though for re-review :)

Error: Unknown Plugin
    at pluginSettings.ts:28:29
    at async As (AppRootPage.tsx:176:17)
Screen.Recording.2024-06-20.at.1.50.04.PM.mov

@nmarrs nmarrs changed the title Scenes app example: Add LLM plugin integration demo page Scenes app example: Add scenes app LLM plugin integration demo example Jun 20, 2024
@marefr marefr removed their request for review October 8, 2024 12:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: 🔬 In review
Development

Successfully merging this pull request may close these issues.

3 participants