2.3.3-QA Knowledge Query

1. Overview

• Interface name: QA single knowledge query

• Version number: v1.0.0

2. Information

• Request method: GET

• Request URL: https://DOMAIN/openapi/v1/knowledge/qa/

• Domain: Refer to "Service address description"

3. Request parameters

Request header http header field:

Parameter name	Type	Required	Description
Content-Type	string	Yes	Fixedapplication/json
cybertron-robot-key	string	Yes	Robot key
cybertron-robot-token	string	Yes	Robot token

Request body field:

Parameter name	Type	Required	Description
username	string	Yes	User account
knowledge_base_id	string	Yes	Knowledge Base id
folder_id	string	Yes	folder id
page	int	Yes	Number of pages, default is 1
pagesize	int	No	The number of results returned per page, default is 10

4. Response field description

HTTP status code: 200 OK

Response field description:

Field Name	Type	Description
code	string	"000000" is normal, other exceptions
message	string	Status description
data	object	message body
total	int	Total record number
page	int	Current page number
page_size	int	Records per page
has_next	bool	Is it possible to turn the page backwards
has_previous	bool	Can I turn the page forward
max_page_num	int	Total page count
list	array	content (same import part)

5. Example

Request Example:

curl 'https://_DOMAIN_/openapi/v1/knowledge/qa/?username=[e-mail]&knowledge_base_id=5700&folder_id=13184' \
-H 'Content-Type: application/json' \
-H 'cybertron-robot-key: l8ia2IOc*************Z724%2BU%3D' \
-H 'cybertron-robot-token: MTc0Mzk5****************************************cGRCUTg9' \
-X GET -d '{}'

Response example:

{
    "code": "000000",
    "message": "ok",
    "data": {
        "total": 4,
        "list": [
            {
                "id": 66962,
                "knowledge_image_list": [],
                "creator_name": "zhengdong.zhou",
                "editor_name": "",
                "question": "1",
                "answer": "2",
                "data_source": 1,
                "create_time": "2024-07-22 11:43:21",
                "update_time": "2024-07-22 11:43:21",
                "knowledge_image": "{}",
                "emb_status": 2,
                "batch_unique": null,
                "file_name": null,
                "save_name": null,
                "folder": 2895,
                "knowledge_base": 324,
                "knowledge_provider": 61,
                "editor": null,
                "correct_source": null
            },
            {
                "id": 66963,
                "knowledge_image_list": [],
                "creator_name": "zhengdong.zhou",
                "editor_name": "zhengdong.zhou",
                "question": "Hello",
                "Answer": "I'm fine1111",
                "data_source": 1,
                "create_time": "2024-07-22 11:57:43",
                "update_time": "2024-07-22 13:54:04",
                "knowledge_image": "{}",
                "emb_status": 2,
                "batch_unique": null,
                "file_name": null,
                "save_name": null,
                "folder": 2895,
                "knowledge_base": 324,
                "knowledge_provider": 61,
                "editor": 61,
                "correct_source": null
            }
        ],
        "page": 1,
        "page_size": 2,
        "has_next": true,
        "has_previous": false,
        "max_page_num": 2
    }
}