Updating an FAQ
Function
Update questions, answers, and similar questions for an FAQ with a specified ID.
URI
PUT /v1/{project_id}/applications/{application_id}/uni-search/faq
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Definition: Project ID. For details about how to obtain the project ID, see Obtaining a Project ID. Constraints: N/A Value range: The value can contain 1 to 64 characters. Only digits, letters, hyphens (-), and underscores (_) are allowed. The value must start with a letter. Default value: N/A |
application_id |
Yes |
String |
Definition: Application ID. For details about how to obtain the application ID, see Obtaining an Application ID. Constraints: Character string Value range: The value can contain 1 to 64 characters. Only digits, letters, hyphens (-), and underscores (_) are allowed. The value must start with a letter. Default value: N/A |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Definition: Token used for API authentication. For details about how to obtain the token, see Obtaining an IAM User Token. Constraints: N/A Value range: N/A Default value: N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
id |
Yes |
String |
Definition: FAQ ID. Constraints: N/A Value range: The maximum length is 64 characters. Default value: N/A |
question |
Yes |
String |
Definition: Question. Constraints: N/A Value range: A maximum of 1,000 characters are allowed. Default value: N/A |
answer |
Yes |
String |
Definition: Answer. Constraints: N/A Value range: The value cannot exceed 10,000 characters. Default value: N/A |
repo_id |
No |
String |
Definition: Knowledge base ID Constraints: N/A Value range: N/A Default value: N/A |
question1 |
No |
String |
Definition: Similar questions. Constraints: N/A Value range: A maximum of 1,000 characters are allowed. Default value: N/A |
question2 |
No |
String |
Definition: Similar questions. Constraints: N/A Value range: A maximum of 1,000 characters are allowed. Default value: N/A |
question3 |
No |
String |
Definition: Similar questions. Constraints: N/A Value range: A maximum of 1,000 characters are allowed. Default value: N/A |
question4 |
No |
String |
Definition: Similar questions. Constraints: N/A Value range: A maximum of 1,000 characters are allowed. Default value: N/A |
file_id |
Yes |
String |
Definition: Document ID. Constraints: N/A Value range: The value can contain a maximum of 36 characters. Default value: N/A |
category |
No |
String |
Definition: Directory, which is a single value and corresponds to a leaf node in the directory tree. Constraints: The value can contain a maximum of 255 characters, excluding control characters, private use characters, and surrogate characters. Value range: N/A Default value: N/A |
tags |
No |
String |
Definition: Tag list. Separate multiple tags by commas (,). Constraints:
Value range: N/A Default value: N/A |
Response Parameters
Status code: 200
Succeeded.
None
Example Requests
Update an FAQ instance.
/v1/b25446daeb1a41a7953c5deba2b2677a/applications/cefb2a59-2f9e-4268-b56b-eab15dc0b9d6/uni-search/faq { "answer" : "Test case answers", "repo_id" : "a8f1385b-feca-4ac6-9fe3-6929d0885e3a", "id" : "a0d6c0d0-ca60-4684-a835-8309c2062bed", "question" : "Test case 1", "question1" : "Test case 2", "question2" : "Test case 3", "question3" : "Test case 4", "question4" : "Test case 5" }
Example Responses
None
Status Codes
Status Code |
Description |
---|---|
200 |
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