Creating an FAQ
Function
This API is used to enter questions, similar questions, and answers to create a single FAQ.
URI
POST /v1/koosearch/repos/{repo_id}/faqs
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
repo_id |
Yes |
String |
Knowledge base ID. The value is a string of 1 to 64 characters and can contain only digits, letters, hyphens (-), and underscores (_). How to obtain: Log in to the KooSearch experience platform. In the navigation tree on the left, choose Knowledge Bases to view knowledge base IDs. Each knowledge base has a unique ID stored in the vector database. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Parameter description: Token used for API authentication. For how to obtain the token, see section 3.2 "Authentication." Constraints: N/A. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
question |
Yes |
String |
Question. |
answer |
Yes |
String |
Answer. |
repo_id |
Yes |
String |
Knowledge base ID. How to obtain: Log in to the KooSearch experience platform. In the navigation tree on the left, choose Knowledge Bases to view knowledge base IDs. Each knowledge base has a unique ID stored in the vector database. |
question1 |
No |
String |
Similar questions |
question2 |
No |
String |
Similar questions |
question3 |
No |
String |
Similar questions |
question4 |
No |
String |
Similar questions |
category |
No |
String |
Directory, which is a single value and corresponds to the leaf node in the directory tree. |
tags |
No |
String |
Tag list. Separate multiple tags by commas (,). Notes:
|
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
faq_id |
String |
ID of the created FAQ. |
Example Requests
None
Example Responses
Status code: 200
Creation succeeded.
{ "faq_id" : "64b4a1bc-3e60-43dd-981c-d24828ddc8ac" }
Status Codes
Status Code |
Description |
---|---|
200 |
Creation succeeded. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot