AI Assistant user guide

This page will review the best ways to use the AI Assistant to get the most effective results.

The Secoda AI Assistant enhances your ability to quickly find information and document resources within your workspace using a simple, chat-like interface. This guide will help you understand how to effectively use the AI Assistant both within the Secoda platform and in your everyday workflows.

How to Use the AI Assistant

1. Engaging with the AI Assistant:

  • Access: Click into the AI Assistant window within the Secoda UI to start an interaction. You can also find the AI Assistant on all resource pages (see video below).

  • Chatting: Simply type your question in plain language and receive answers directly in the chat. Check out some Prompts and AI Use Cases to help you get started in understanding the power of this feature.

  • Documentation: Use the AI to automatically generate descriptions for your metadata with just one click AI Description Editor.

2. Incorporating AI in Your Workflows:

Best Practices for Interacting with the AI Assistant

1. Understand Data Query Capabilities

Verify with your workspace Admin whether the AI Assistant can run direct data queries. If enabled, you can ask data-specific questions like "How many customers do we have?" and get the number in just a few seconds. Clicking "Show steps" will provide you with the steps that it took to find that answer, including any SQL queries it ran on the backend to provide more context.

If queries aren't enabled, avoid questions about the actual content of the data that isn't referenced in the metadata or documentation. In this case, the data itself is not being sent to OpenAI so we are unable to give accurate results. Instead, try asking it to write a query for the data you're hoping to learn about.

2. Be Specific

When you know the exact resource you're inquiring about, use the @ symbol followed by the resource name to direct the AI accurately.

Examples:

  • "Can you tell me more about how the @Sales Dashboard was created and which resources it uses?"

  • "How would I join the @orders and @payments tables in a query?"

  • "What downstream resources would be affected if I deprecated the @customers table?"

3. Provide feedback

4. Keep It Fresh

Start new chats every 3-4 questions to ensure clarity and reset the context for the AI, enhancing response accuracy.

5. Keep Questions Concise and Direct

Clear and succinct questions yield the best responses. Avoid overly complex or vague prompts that might confuse the AI.

Unsure where to start?

Check out our list of Prompts that you can ask the tool.

By following these guidelines, you can significantly enhance your productivity and data understanding using the Secoda AI Assistant.

Don't just take our word for it! Ask the tool itself 😉

Last updated