Text2InsightStop - Stop a Question
Stop a data analysis task that is currently running.
Interface Description
When an analysis task is taking too long or the user wants to interrupt the current analysis, this interface can be called to stop the execution of a specified question. After stopping, the dataType of the last message in the polling results will become finish_stop.
Usage Notes
- Only effective for questions with a status of
running. - The stop operation cannot be undone.
- Intermediate results already produced are still available via the polling interface.
Request Method
Request Parameters
| Parameter | Location | Type | Required | Description |
|---|---|---|---|---|
| tenantId | Query + Body | Integer | Yes | Tenant ID |
| userId | Query + Body | Integer | Yes | User ID |
| sessionId | Body | Integer | Yes | Conversation session ID |
| questionId | Body | Integer | Yes | ID of the question to stop |
| loginToken | Query + Body | String | Yes | Authentication Token |
Response Parameters
| Parameter | Type | Description |
|---|---|---|
| success | Boolean | Whether the request was successful |
Request Example
Response Example
Successful response:
Error Codes
| Error Code | Description |
|---|---|
| success=false | Token is invalid, question does not exist, question has already completed, or insufficient permissions |
Related Documentation
- Text2InsightQuery — Submit an analysis request to obtain a questionId
- SafeQuestionPoll — After stopping, polling can continue; the last message dataType will be finish_stop
- Quick Start — Complete end-to-end example
