> ## Documentation Index
> Fetch the complete documentation index at: https://docs.flowx.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# AI Assistant
> Answers questions about the FlowX.AI platform as well as your organization's business domain based on uploaded documentation.
## Overview
The AI Assistant provides intelligent documentation support for both the FlowX.AI platform and your organization's business domain. It functions as a knowledge hub that can quickly search, retrieve, and synthesize information from both built-in FlowX.AI documentation and custom uploaded documents. You can ask natural language questions and receive well-formatted, accurate answers drawn from up-to-date documentation sources.
***
## Key capabilities
The AI Assistant offers specialized content search functionality across different documentation sources:
Provides answers to questions about the FlowX.AI platform, its features, configuration options, and best practices. Accesses a comprehensive repository of approximately 1,000 documentation chunks (318,000 tokens).
Upload your organization's business domain documentation so the assistant can answer domain-specific questions alongside platform queries.
Handles direct questions, keyword searches, or general topic inquiries related to the platform and uploaded documentation.
Delivers answers in well-formatted markdown for readability, with rapid response times for most queries. Documentation ingestion takes approximately 12 seconds.
***
## How it works
The AI Assistant architecture follows a retrieval-augmented generation approach:
```mermaid theme={"system"}
%%{
init: {
'theme': 'base',
'themeVariables': {
'primaryColor': '#f1774a',
'primaryTextColor': '#000',
'primaryBorderColor': '#000',
'lineColor': '#6b6b6b',
'secondaryColor': '#f3b861',
'tertiaryColor': '#000'
}
}
}%%
graph TD;
Start([Start]):::primary
Check_Prompt[Check Prompt]:::secondary
Rewrite_Query[Rewrite Query]:::secondary
Retrieve_Documents[Retrieve Documents]:::secondary
Grade_Documents[Grade Documents]:::secondary
Generate_Answer[Generate Answer]:::secondary
Generate_Greetings[Generate Greetings]:::secondary
END([END]):::primary
Start --> Check_Prompt;
Check_Prompt --> Rewrite_Query;
Check_Prompt --> Generate_Greetings;
Rewrite_Query --> Retrieve_Documents;
Retrieve_Documents --> Grade_Documents;
Grade_Documents --> Generate_Answer;
Generate_Answer --> END;
Generate_Greetings --> END;
%% Styling
classDef primary fill:#f1774a,stroke:#000,stroke-width:1px,color:#000;
classDef secondary fill:#f3b861,stroke:#000,stroke-width:1px,color:#000;
```
The workflow begins with query refinement, followed by document retrieval and relevance grading. Based on the quality of retrieved information, the system can generate an immediate response, process a more complex response asynchronously, or refuse to answer if no relevant documentation is found.
***
## How to use
The AI Assistant is accessible within the FlowX.AI Platform:
Find the AI Assistant in the help section of the platform interface.
Use the chat-based interface to type natural language questions. View responses in real-time with markdown formatting, and follow up with additional questions in a conversational manner.
Upload your organization's documentation through the document upload interface in the assistant section. You can select files from your local system or provide URLs to documentation resources.
Access saved conversations to reference past interactions. The assistant maintains context between sessions.
***
## Best practices
### DO the following
**Be specific with your questions:**
Clearly articulate what information you need about the FlowX.AI platform or your organization's business domain. The more specific your question, the more precise the answer will be.
**Reference platform components:**
Mention specific features, modules, or functions you're asking about to help the assistant retrieve the most relevant documentation.
**Provide context:**
When asking follow-up questions, include relevant context or reference your previous inquiry to help the assistant understand the conversation flow.
**Ask about best practices:**
The assistant can provide guidance on recommended approaches and implementation strategies based on official documentation.
### DON'T do these
**Don't ask about undocumented features:**
The assistant relies on available documentation and may not be able to provide information about unreleased or undocumented functionality.
**Don't expect troubleshooting of specific implementations:**
While the assistant can provide general guidance, it cannot debug custom code or analyze specific implementation issues without detailed context.
**Don't assume complete knowledge:**
If documentation doesn't cover a particular topic, the assistant may not be able to provide comprehensive information on that subject.
**Don't ask unrelated questions:**
The assistant is specialized in FlowX.AI platform and your organization's business domain documentation and may not provide accurate answers on unrelated topics.
***
## Related resources
Create and configure custom AI agents for your organization
Assists with process analysis and optimization recommendations
Helps design and build UI components and process flows