Answers a borrower's questions from a curated knowledge base rather than from the model's general knowledge, with the source behind each answer.
Used when
At any point in the conversation, alongside whichever subject is open.
Collects
The question, and the subject it was asked from.
Returns
The answer, and the document it came from.
The question itself, recorded, so an unanswered one becomes a knowledge-base gap.
Evidence
bot-faq-support
chatbot-knowledge-update
Operations
FAQ bot service
GET/
Get Bot Knowledge
getKnowledge
Get knowledge of faq bot
Get extra bot knowledge
Response
application/json
Invalid key for service
{
"message": "Please check the key you used to call this service",
"url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post"
}
application/json
The product has encountered an internal server error
{
"message": "The product has encountered an internal server error"
}
Response 403application/json
2 fields
Invalid key for service
Field
Type
Description
message
string
—
url
string
—
Response 500application/json
1 fields
The product has encountered an internal server error
Field
Type
Description
message
string
Error Message
Response 503application/json
1 fields
Service Unavailable
Field
Type
Description
message
string
Error message
Other responses
200
POST/
Update Bot Knowledge
updateBotKnowledge
Update knowledge
Patch bot
Response
application/json
Invalid key for service
{
"message": "Please check the key you used to call this service",
"url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post"
}
application/json
The product has encountered an internal server error
{
"message": "The product has encountered an internal server error"
}
Response 400application/json
1 fields
Bad Request
Field
Type
Description
message
string
Error message
Response 403application/json
2 fields
Invalid key for service
Field
Type
Description
message
string
—
url
string
—
Response 500application/json
1 fields
The product has encountered an internal server error
Field
Type
Description
message
string
Error Message
Response 503application/json
1 fields
Service Unavailable
Field
Type
Description
message
string
Error message
Other responses
200
DELETE/{knowledge_id}
Delete Bot Knowledge
deleteKnowledge
Delete extra knowledge
Delete extra bot knowdlege from faq-bot-service
Response
application/json
Invalid key for service
{
"message": "Please check the key you used to call this service",
"url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post"
}
application/json
The product has encountered an internal server error
{
"message": "The product has encountered an internal server error"
}
Parameters
1
Parameter
Type
Example
Description
knowledge_idrequired
stringpath
id_knowledge
Knowledge id
Response 400application/json
1 fields
Bad Request
Field
Type
Description
message
string
Error message
Response 403application/json
2 fields
Invalid key for service
Field
Type
Description
message
string
—
url
string
—
Response 500application/json
1 fields
The product has encountered an internal server error
{
"message": "Please check the key you used to call this service",
"url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post"
}
application/json
The product has encountered an internal server error
{
"message": "The product has encountered an internal server error"
}
Response 403application/json
2 fields
Invalid key for service
Field
Type
Description
message
string
—
url
string
—
Response 500application/json
1 fields
The product has encountered an internal server error
Field
Type
Description
message
string
Error Message
Response 503application/json
1 fields
Service Unavailable
Field
Type
Description
message
string
Error message
Other responses
200
POST/sync
Sync Bot Knowledge
syncBotKnowledgeSlab
Sync knowledge
Slab webhook for updating bot knowledge from Slab and knowledge database
Response
application/json
Invalid key for service
{
"message": "Please check the key you used to call this service",
"url": "https://staircase.stoplight.io/docs/api-reference/customer-account-manager-service.yml/paths/~1products~1refresh/post"
}
application/json
The product has encountered an internal server error
{
"message": "The product has encountered an internal server error"
}
Response 403application/json
2 fields
Invalid key for service
Field
Type
Description
message
string
—
url
string
—
Response 500application/json
1 fields
The product has encountered an internal server error