Skip to main content

Assistant

The Assistant feature brings generative AI capabilities to your Venue.sh experience in two key ways:

  • It embeds validated AI models into the Venue.sh portal.
  • It grants the AI permission to safely and securely retrieve user and your organization's catalog information from your Venue instance.

Key Capabilities​

Use the Assistant to intelligently search and discover information and complete tasks within your Venue instance related to:

  • Single (or multiple) entities in the Catalog
  • Entity details
  • Technical documentation
  • Plugins

The Assistant eliminates the need to adapt to unfamiliar, undesirable models. Just select from the list of validated AI models and you're ready to get started. The Assistant will also provide you with 4 follow-up questions to help you refine your conversation.

Another key feature of the Assistant is the ability to generate and validate Templates for your Venue instance. This feature allows you to ask the Assistant to generate the YAML file which is necessary for scaffolding new entities in your Venue instance.

tip
  • Converse with the Assistant using natural language and use the correct context and terminology.
  • If you use multiple AI tools for different types of work, or even if you just want to try a new model, you can switch from AI model to AI model with ease.
  • Conversations are kept indefinitely in history for easy recall and review, or conversations can be deleted manually.

Setting Up the Assistant​

To set up the Assistant, you need to:

  1. Navigate to the Assistant settings page
  2. Create (or edit) an Assistant configuration
  3. Configure the AI providers and models
  4. Provide the appropriate API keys for the AI providers
  5. Save the configuration

Best Practices​

Writing Effective Queries​

  • Be Specific: Include relevant details like team names, component types, or specific attributes
  • Use Context: Reference specific entities by name when possible
  • Iterate: Refine your questions based on initial results

Limitations & Considerations​

Data Freshness​

The Assistant works with data from your Venue instance, which is refreshed periodically. For real-time data, always verify against the source systems.

Model-Specific Capabilities​

Different AI models may have varying capabilities and limitations. If you're not getting the results you expect, try switching models.

Support & Feedback​

If you encounter issues or have suggestions for improving the Assistant:

  • Contact your Venue administrator
  • Submit a support ticket through the Venue.sh Support Portal here.