FAQ Questions

Update FAQ feedback

post

Update feedback on FAQ questions (APPROVED or REJECTED) to improve future question generation.

Body

application/json

Update FAQ feedback request schema.

Attributes: faq_question_id (str): ID of the FAQ question to update feedback for. feedback (Literal["APPROVED", "REJECTED"]): Feedback type (APPROVED or REJECTED). user_comment (str | None): Optional user comment explaining the feedback. user_id (str | None): Optional user identifier for tracking.

faq_question_idstringRequired

ID of the FAQ question to update feedback for

feedbackstringRequired

Feedback type (APPROVED or REJECTED)

user_commentany ofOptional

Optional user comment explaining the feedback

stringOptional

or

nullOptional

user_idany ofOptional

Optional user identifier for tracking

stringOptional

or

nullOptional

Responses

200

Successful response of feedback update.

application/json

422

Validation Error

application/json

500

Internal Server Error

application/json

post

/faq/feedback

HTTPcURLJavaScriptPython

POST /faq/feedback HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 83

{
  "faq_question_id": "text",
  "feedback": "text",
  "user_comment": "text",
  "user_id": "text"
}

{
  "success": true,
  "faq_question_id": "faq_001",
  "feedback": "APPROVED",
  "updated_at": "2024-01-01T10:00:00Z"
}

Retrieve FAQ questions

get

Retrieve FAQ questions based on various filters with pagination support.

Query parameters

knowledge_base_idany ofOptional

Knowledge Base identifier to filter questions

stringOptional

or

nullOptional

task_idany ofOptional

Task identifier to filter questions

stringOptional

or

nullOptional

question_idany ofOptional

Specific question ID to retrieve

stringOptional

or

nullOptional

limitinteger · min: 1 · max: 1000Optional

Maximum number of questions to return

Default: 50

offsetintegerOptional

Number of questions to skip for pagination

Default: 0

Responses

200

Successful response containing FAQ questions.

application/json

422

Validation Error

application/json

500

Internal Server Error

application/json

get

/faq/manage

HTTPcURLJavaScriptPython

GET /faq/manage HTTP/1.1
Host: 
Accept: */*

{
  "data": [
    {
      "id": "faq_001",
      "question": "What is the return policy?",
      "confidence_score": 0.95,
      "source_file_ids": [
        "file_123",
        "file_124"
      ],
      "chunk_id": "chunk_001",
      "task_id": "task_12345",
      "created_at": "2024-01-01T10:00:00Z"
    }
  ],
  "total_count": 1,
  "limit": 50,
  "offset": 0,
  "has_more": false
}

Add FAQ question

post

Add a new FAQ question to the database.

Body

application/json

Add FAQ question request schema.

Attributes: knowledge_base_id (str): Knowledge Base identifier for adding new question. question (str): The FAQ question text.

task_idstringOptional

Optional task ID for inserting new generated question

Default: user_manual_entry

knowledge_base_idstringRequired

Knowledge Base identifier for adding new question

questionstringRequired

The FAQ question text

Responses

201

FAQ question successfully added.

application/json

422

Validation Error

application/json

500

Internal Server Error

application/json

post

/faq/manage

HTTPcURLJavaScriptPython

POST /faq/manage HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 76

{
  "task_id": "user_manual_entry",
  "knowledge_base_id": "text",
  "question": "text"
}

{
  "success": true,
  "question_id": "faq_001",
  "message": "FAQ question successfully added",
  "registered_at": "2024-01-01T10:00:00Z"
}

Update FAQ question

put

Update an existing FAQ question in the database.

Body

application/json

Update FAQ question request schema.

Attributes: question_id (str): ID of the question to update. question (str): The updated FAQ question text.

question_idstringRequired

ID of the question to update

questionstringRequired

The updated FAQ question text

Responses

200

FAQ question successfully updated.

application/json

422

Validation Error

application/json

500

Internal Server Error

application/json

put

/faq/manage

HTTPcURLJavaScriptPython

PUT /faq/manage HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 40

{
  "question_id": "text",
  "question": "text"
}

{
  "success": true,
  "question_id": "faq_001",
  "message": "FAQ question successfully updated",
  "updated_at": "2024-01-01T10:00:00Z"
}

Delete FAQ question

delete

Delete an existing FAQ question from the database.

Query parameters

question_idstringRequired

ID of the question to delete

Responses

200

FAQ question successfully deleted.

application/json

422

Validation Error

application/json

500

Internal Server Error

application/json

delete

/faq/manage

HTTPcURLJavaScriptPython

DELETE /faq/manage?question_id=text HTTP/1.1
Host: 
Accept: */*

{
  "success": true,
  "question_id": "faq_001",
  "message": "FAQ question successfully deleted",
  "deleted_at": "2024-01-01T10:00:00Z"
}