Knowledge Base
Manage contents for your chatbot instant replies using our RAG engine. Populate your KBs using your own contents (URLs, sitemaps, PDFs, DOCX, text or FAQs). Our semantic engine will help you provide the best answers based on user questions using advanced Semantic indexing and the OpenAI generative AI. More info
The Knowledge Base model
id
String
The unique identifier for the knowledge base which is given by Tiledesk.
name
String
The knowledge base name.
id_project
String
The unique identifier of the project
preview_settings
Object
The settings for the knowledge base preview
default
Boolean
Specify if the knowledge base is the default one
Get all knowledge bases
GET https://api.tiledesk.com/v3/:project_id/kb/namespace/all
Allows listing all the knowledge bases of a project. Returns at least the default knowledge base.
Path Parameters
project_id
string
The Project Id is a unique code assigned to your project when you create it in Tiledesk.
Headers
Authorization
string
Authorization token. Basic Auth or JWT
Response (200)
[
{
"default": true,
"id_project": "63ad512e70d5ed0012ad6286",
"id": "63ad512e70d5ed0012ad6286",
"name": "Customer Support",
"preview_settings": {
"model": "gpt-3.5-turbo",
"max_tokens": 128,
"temperature": 0.7,
"top_k": 4,
"context": "You are an awesome AI Assistant."
},
"createdAt": "2024-06-20T13:49:04.006Z",
"updatedAt": "2024-06-21T10:52:55.235Z"
},
{
"default": false,
"id_project": "63ad512e70d5ed0012ad6286",
"id": "66755b6b9fee7f001357bc7f",
"name": "Sales",
"preview_settings": {
"model": "gpt-3.5-turbo",
"max_tokens": 128,
"temperature": 0.7,
"top_k": 4,
"context": "You are an awesome AI Assistant."
},
"createdAt": "2024-06-21T10:52:27.111Z",
"updatedAt": "2024-06-21T10:52:27.111Z"
}
]Example
Create new knowledge base
POST https://api.tiledesk.com/v3/:project_id/kb/namespace
Allows creating a new knowledge base for a project.
Path Parameters
project_id
string
The Project Id is a unique code assigned to your project when you create it in Tiledesk.
Headers
Authorization
string
Authorization token. Basic Auth or JWT
Request Body
name
string
The name of the knowledge base.
Response (200)
Example
Update a knowledge base
PUT https://api.tiledesk.com/v3/:project_id/kb/namespace/:id
Allows updating a knowledge base info and preview settings.
Path Parameters
project_id
string
The Project Id is a unique code assigned to your project when you create it in Tiledesk.
id
string
The unique identifier for the knowledge base
Headers
Authorization
string
Authorization token. Basic Auth or JWT
Request Body
name
string
The name of the knowledge base.
preview_settings
object
The AI settings for the knowledge base settings.
Response (200)
Example
Delete a knowledge base
DELETE https://api.tiledesk.com/v3/:project_id/kb/namespace/:id
Allows deleting the whole knowledge base or its contents only.
Path Parameters
project_id
string
The Project Id is a unique code assigned to your project when you create it in Tiledesk.
id
string
The unique identifier for the knowledge base
Query Parameters
contents_only
boolean
(Optional) if TRUE will delete only the contents
Headers
Authorization
string
Authorization token. Basic Auth or JWT
Response (200)
Example
Related
Last updated 1 year ago
Was this helpful?