Get Help from Documentation
BrinqaIQ offers a Documentation Assistant that can help you find answers for questions about Brinqa Platform features and functions without leaving the platform. You can use this mode to learn about specific features, get help with setup steps, or ask clarifying questions while working in the Brinqa Platform.
For additional information about how BrinqaIQ works, data usage, and safeguards, see the BrinqaIQ Overview.
What is the Documentation Assistant?
The Documentation Assistant helps you search Brinqa documentation using natural language. It’s especially useful when setting up new configurations, troubleshooting, or learning how a feature works, all without needing to open the Brinqa Platform documentation site in a separate browser tab or window. Think of the Documentation Assistant tool as your personal research assistant, ready to help you find the information you need quickly and efficiently.
For example, when setting up a data integration for the Semgrep connector, you might ask: "What do I need to configure the Semgrep connector?"
BrinqaIQ responds with detailed setup steps, including required fields like the API URL and Access Token, and instructions on how to obtain them. This enables you to configure the integration without searching through the documentation in a separate browser tab or window.
Another example is when you want to understand how data consolidation works in the Brinqa Platform. You could ask: "How does Consolidation work?"
BrinqaIQ responds with a concise explanation of the consolidation process, including how data from multiple sources is combined, mapped to unified data models, and how to troubleshoot duplicates. This enables you to understand data consolidation without leaving the Brinqa Platform.
Example prompts
Here are some examples to help you get started with the Documentation assistant:
- How do I assign roles to users?
- How do I create a new user?
- How do I create a new data integration?
- How do I create a new dashboard?
- What are clusters and how do I use them?
- What is the difference between Integration and Orchestration?
- How are risk scores calculated?