Introduction of /get-information endpoint, new link features, recommendation section and more

[oscaramos]

Description

1.New Endpoint: A fresh /get-information endpoint has been created to:

• Supply information about the supported diagrams, along with their associated documentation links.
• Offer guidelines for rendering diagrams. These guidelines comprise the syntax specifics for the diagram languages and valuable advice to enhance the rendering process. I noticed that using the use case diagram guidelines significantly elevates the diagram's visual quality.
• Tackle issue #9 by moving the examples text from description_for_model to the new endpoint, thereby enabling the provision of examples for each diagram type within every diagram language, free from the constraints of the character limit.

2.New Link Features: The incorporation of two essential links has been facilitated:

• "View this diagram in a new tab": This link aids in viewing the diagram in a separate tab, particularly beneficial for larger diagrams.
• "Access the diagram documentation of": This link grants users access to the rendered diagram's documentation, contributing to a better understanding of the capabilities of the diagram language.

3.Recommendation Section: A novel section dedicated to offering suggestions for diagram improvement and proposing alternative diagram types has been introduced:

• "Ways to improve the diagram to provide more detail or clarity": This feature allows for brainstorming and the development of novel ideas.
• "Other types of diagrams that could be used to render the same concept": This feature suggests alternative diagram types that might align better with the user's needs. This innovation is related to issue #8 and acts like a user-friendly navigational tool amongst a variety of diagram types.

4.Editor Links: Links to the Graphviz and Vega Lite editors have been included for easy editing of diagrams.

I'll continue improving the prompt engineering for more consistent results, adding more diagram syntaxes along with their guidelines.

Kindly review these changes and provide your valuable feedback or suggestions.

Examples

Show me a mindmap about a mindmap

Show me how a food critic can interact with a restaurant

Illustrate a sequence diagram of an HTTP request and response involving a user, browser, and a server

[h4rk8s]

I pulled the code locally and went through the experience. I think this branch is great and has reached a production-level standard. As an ordinary user, I sincerely @bra1nDump to consider merging this branch.

[bra1nDump]

Wow! Amazing additions to the functionality! Great screenshots as always Oscar!! Platuml diagram looks very cool!

The idea of using a pre-flight request to get more context is pretty innovative.

I think it is close, but still needs some touch up work on making sure the user experience is good. Main thing I want to iterate on is speed. Basically we want to deliver the diagram to the user as fast as possible and avoid bombarding them with too much info.

Here is my detailed feedback:

Avoid overwhelming and slowing the user down

• Lets ensure that if the user did not provide a request for a specific diagram type we can deliver them the default diagram using mermaid graph TB as fast as possible. GPT-4 and plugin invocation take a long time already, and I don't think we should delay it any more with fetching additional context.
• We should cut down the amount of text we return to the user dramatically.
  • Lets specifically instruct gpt to not explain what is shown on the diagram, as in my experience that is just duplicative of what the image already shows and just wastes characters.
  • Lets limit the suggestions for followup modification to 1-2 suggestion.
  • If we have included suggestions in this conversation already, don't include them anymore, unless user specifically asks for them. When I iterate on a given diagram, I don't want to see too many suggestions keep popping up if I already have an idea what I want to diagram to show. Instead we can add a special key phrase "show diagram suggestions" that would show that info separately.

Deployment

• Lets make sure this change will not break existing clients. We ran into this issue in the past, so lets try to prevent it from happening again. If thats the case we can merge this branch into main, but not submit the plugin for review just yet.
• As much as I love the new additions, I don't think we should deploy the plugin. Show Me is currently in the popular tab, and if we update I imagine we would loose that spot.

Here are some screenshots from the OpenAI plugin developer forum related to the issue.

I have also created a brand new post related to the Popular tab.

[oscaramos]

@bra1nDump Thanks a lot for your feedback on these features! I just had a look at the feedback, and I'm grateful for it. I'll take your suggestions on board and make the necessary adjustments.

[bra1nDump]

Testing locally - even when diagram type not requested it still prefers to use the info route first causing a delay. Maybe more prompt eng needed?

[bra1nDump]

I love this!!

To view ideas for improving the diagram, use the key phrase "show ideas".
To view other types of diagram and languages, use the key phrase "explore diagrams".

Succinct and actionable at the same time.

[bra1nDump]

I don't like the fact that it shows the preview for this link. Its not actionable and takes the attention away from the diagram itself and other content. It does that sometimes for other links too. Any idea what might be causing this? Maybe we can try instructing it to not render previews for links?

[oscaramos]

About that preview. I will prevent showing that preview by just replacing the link to show only the text

[oscaramos]

Testing locally - even when diagram type not requested it still prefers to use the info route first causing a delay. Maybe more prompt eng needed?

I will work on fix it. I expect to make these changes tonight

[oscaramos]

Description

I envisioned this plugin to be a captivating assistant that empowers users in selecting the ideal diagram from a diverse range of languages and types.

Here are more remarkable enhancements introduced in this pull request:

1. Usage of key phrases: Users can now employ key phrases like "show ideas" or "explore diagrams" to effortlessly navigate through the plugin's capabilities. These key phrases create a streamlined flow of interaction, similar to using concise commands to navigate through a menu.
2. Diagram Carousel: This carousel allows users to quickly browse through available diagrams, providing a visual preview of the options at their disposal. Clicking on an image within the carousel reveals detailed documentation about the corresponding diagram type. The diagram carousel shows when using the explore diagrams key like this one.
3. Themes: Support for exploring themes in PlantUML, Mermaid, and D2. Users can now explore various visual styles and appearances, enabling them to customize their diagrams to match their preferences or the overall theme of their project.
4. Replacement of Information Endpoint by DiagramGuidelines Endpoint: In order to provide more precise and consistent results, the information endpoint was replaced with the diagram guidelines endpoint. This updated endpoint offers additional context and guidance, helping users render diagrams accurately by providing syntax and guidelines specific to each diagram type.
5. Reduce hallucinations: By utilizing a well-structured list-based data structure, we have minimized hallucinations in the diagram links when using the "explore diagrams" key phrase. This improvement ensures that the displayed diagram options closely align with the user's intended query, minimizing confusion and improving the relevance of the results.
6. Addition of Editor Links: Incorporating editor links for various diagram types, including nomnoml, actdiag, blockdiag, nwdiag, and rackdiag. These editor links provide users with a more diverse range of resources, allowing them to leverage different diagramming tools to create their diagrams. Notably, this enhancement includes support for editors that do not provide autofill functionality, such as D2 or DBML, thereby offering greater flexibility to users.

Examples

Compare the output of the "show me a mindmap about a mindmap" example earlier on this PR here with the new one here: