The Syntasa Help Agent delivers the best results when questions are phrased clearly and aligned with documented Syntasa terminology. Because the agent searches public documentation directly, question quality has a significant impact on answer accuracy and relevance.
This article outlines best practices for interacting effectively with the Help Agent.
Use Official Syntasa Terminology
The Help Agent performs best when users phrase questions using terminology that matches the product and documentation.
Examples of preferred terms include:
- Connection
- Process type
- Object type
- Workflow
- App
- Graph node
- Event store
- Audience builder
For example:
- “How do I create a connection?” produces better results than:
- “How do I plug in my data source?”
Ask One Question at a Time
Focused questions generate more precise and actionable answers.
Preferred example:
How do I create a GCS connection?Less effective example:
Tell me everything about connections, workflows, and audiences.Be Specific About the Scenario
Providing context improves documentation matching accuracy.
Examples include specifying:
- The template type
- The cloud provider
- The connection type
- The process category
Example:
What process types are available in the AUDIENCE_BUILDER_APP template?Specify Platform Variants
Certain configurations vary depending on the environment or deployment model.
Users should specify when relevant:
- GCP vs AWS
- Synthesizer vs Audience Builder templates
- GCS vs BigQuery vs S3 vs DATABASE connections
This helps the agent generate more accurate and context-aware guidance.
Request Tables for Comparisons
When comparing multiple items, users can explicitly request table-based responses.
Example:
Compare the EVENT_LOADER and AA_LOADER process types in a table.The agent automatically uses structured table formatting when comparing three or more items.
Use Follow-Up Questions
The Help Agent supports conversational follow-up interactions within the same session.
Examples:
- “Can you elaborate on step 3?”
- “What does templateKey accept?”
- “What happens if I skip validation?”
This allows users to progressively explore deeper technical details.
Things to Avoid
Do Not Ask the Agent to Modify Your Environment
The Help Agent cannot interact with live systems or configurations.
Examples of unsupported requests:
- “List my apps”
- “Diagnose this error”
These tasks belong to other specialized agents.
Do Not Expect Environment-Specific Knowledge
The agent only knows public Syntasa documentation and cannot access:
- Your applications
- Your connections
- Your datasets
- Your account-specific configuration
Avoid Non-Syntasa Programming Questions
Questions unrelated to the Syntasa platform are intentionally out of scope.
Example:
How do I write a Spark UDF in general?
Conclusion
Effective use of the Syntasa Help Agent depends on asking focused, platform-specific, and well-structured questions. By using official terminology, specifying scenarios clearly, and leveraging follow-up conversations, users can obtain faster, more accurate, and more actionable documentation guidance.