While the Syntasa Help Agent is designed to provide accurate and grounded documentation support, users may occasionally encounter vague results, missing information, or limitations related to version differences and unsupported request types.
This article explains common issues, troubleshooting guidance, and example questions users can ask effectively.
Example Questions You Can Ask
Getting Started and Conceptual Questions
Examples include:
- What is a Syntasa app?
- What’s the difference between a process type and an object type?
- What templates are available for new apps?
- What does an event store do?
Procedural “How-To” Questions
Examples include:
- How do I create a GCS connection?
- How do I schedule a workflow to run nightly?
- How do I configure an EVENT_LOADER node to read from BigQuery?
- How do I set up a Snowflake connection?
Configuration and Parameter Questions
Examples include:
- What parameters does the GCS connection type accept?
- How do I configure batch size on EVENT_LOADER?
- What’s the format of a connectionId field in an app spec?
Comparison Questions
Examples include:
- What’s the difference between EVENT_LOADER and AA_LOADER?
- Compare the Synthesizer and Audience Builder templates.
- When should I use a UNION node vs a JOIN node?
Common Issues and Solutions
“I Couldn't Find That Information in the Knowledge Base”
This means the agent searched the documentation but did not find a matching result.
Recommended solutions:
- Rephrase the question using official Syntasa terminology
- Narrow the question scope
- Ask a related conceptual question first
- Escalate through standard Syntasa support channels if documentation genuinely does not exist
“I Can Only Assist with Questions About Syntasa”
This occurs when the question is outside the supported documentation scope.
Examples include:
- General programming
- Weather
- Non-Syntasa technologies
Users should either rephrase the request or use another specialized tool.
Answers Feel Too Generic
Because the Help Agent only generates grounded responses from retrieved documentation, vague answers often indicate insufficiently specific queries.
Recommended actions:
- Ask for the documentation page title
- Request deeper detail on a specific step
- Ask a narrower follow-up question
The Agent Doesn’t Know About Your Apps or Data
This behavior is expected.
The Help Agent cannot access:
- Your applications
- Your workflows
- Your data
- Your account-specific environment
Those tasks belong to the App Builder Agent.
Documentation and UI Differences
In some cases, documentation may lag behind recent UI releases.
Guidance:
- Trust the live UI for exact labels and workflows
- Use the Help Agent for conceptual guidance and configuration understanding
- Report genuine inconsistencies through standard Syntasa channels
Version-Specific Configuration Keys
Sometimes a configuration key mentioned in documentation may not exist in the user’s deployed version.
Recommended action:
Which Syntasa version introduced <key>?Long Answers Are Truncated
If responses are cut off mid-sentence, users can simply ask:
Please continueor
Finish step 5The agent retains prior conversational context and can continue from where it stopped.
Conclusion
The Syntasa Help Agent is a powerful documentation-driven assistant for navigating platform workflows, configurations, and operational concepts. By understanding the types of supported questions, common limitations, and recommended troubleshooting practices, users can maximize the effectiveness of their interactions and obtain more precise, actionable guidance from the platform documentation.