Skip to content

Commit eb02ad9

Browse files
committed
add troubleshooting and fix configuration with gpt
1 parent 167d536 commit eb02ad9

File tree

2 files changed

+69
-0
lines changed

2 files changed

+69
-0
lines changed

docs/getting-started/configuration.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -235,6 +235,8 @@ The external Semantic Table Interpretation service must expose APIs as indicated
235235

236236
### Mantistablex
237237

238+
The following keys are used by the MantistableX plugin, which relies on the GPT API for text generation, specifically for the lexicalization of an annotated table, i.e. transforming structured annotations into natural language descriptions. The table input and its annotations are sent to GPT, which generates a natural language lexicalization of the input.
239+
238240
- **`GPT_KEY`**
239241

240242
```plaintext

docs/troubleshooting.md

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
# Troubleshooting
2+
3+
This section lists common issues that may occur when using **MantistableX** and provides possible solutions.
4+
5+
---
6+
7+
## 1. GPT API does not respond
8+
9+
**Problem:** The system does not return any lexicalization or text generation from GPT.
10+
11+
**Solution:**
12+
13+
- Check that your GPT API key is correctly set in the environment variables (`OPENAI_API_KEY`).
14+
- Ensure that your internet connection is stable.
15+
- Verify that the API endpoint is reachable and not blocked by a firewall or proxy.
16+
17+
---
18+
19+
## 2. Plugin is not activated
20+
21+
**Problem:** MantistableX plugins are not working or not available in the interface.
22+
23+
**Solution:**
24+
25+
- Open the configuration file and check that the desired plugin is enabled.
26+
- Restart the application after modifying the configuration.
27+
- Verify that all required dependencies are installed.
28+
29+
---
30+
31+
## 3. Table import fails
32+
33+
**Problem:** The system cannot import a table.
34+
35+
**Solution:**
36+
37+
- Ensure that the file format is supported (e.g., CSV, JSON).
38+
- Check that the file is not corrupted or empty.
39+
- Confirm that the file path is correct and accessible.
40+
41+
---
42+
43+
## 4. Annotation not displayed
44+
45+
**Problem:** Annotations do not appear after processing a table.
46+
47+
**Solution:**
48+
49+
- Refresh the interface.
50+
- Verify that the annotation step was successfully completed in the logs.
51+
- Check that the output directory is correctly configured.
52+
53+
---
54+
55+
## 5. Unexpected error during annotation
56+
57+
**Problem:** An error message appears while generating or editing annotations.
58+
59+
**Solution:**
60+
61+
- Check the logs for more detailed error messages.
62+
- Verify that the annotation format is correct.
63+
- If using GPT-based annotation, ensure that the API rate limit has not been exceeded.
64+
65+
---
66+
67+
If issues persist, please open a ticket in the issue tracker with detailed logs and steps to reproduce the error.

0 commit comments

Comments
 (0)