知識庫(新版)
建立知識庫
POST /api/knowledge-bases/
請求內容
請求參數
embeddingModel
string (uuid)
否
rerankerModel
string (uuid)
否
name
string
是
description
string
否
numberOfRetrievedChunks
integer
否
sentenceWindowSize
integer
否
enableHyde
boolean
否
similarityCutoff
number (double)
否
enableRerank
boolean
否
chatbots
array[IdName]
否
請求結構範例
{
"embeddingModel"?: string (uuid) // 非必填
"rerankerModel"?: string (uuid) // 非必填
"name": string
"description"?: string // 非必填
"numberOfRetrievedChunks"?: integer // 非必填
"sentenceWindowSize"?: integer // 非必填
"enableHyde"?: boolean // 非必填
"similarityCutoff"?: number (double) // 非必填
"enableRerank"?: boolean // 非必填
"chatbots"?: [ // 非必填
{
"id": string (uuid)
"name"?: string // 非必填
}
]
}
請求範例值
{
"embeddingModel": "550e8400-e29b-41d4-a716-446655440000",
"rerankerModel": "550e8400-e29b-41d4-a716-446655440000",
"name": "request_string",
"description": "request_string",
"numberOfRetrievedChunks": 123,
"sentenceWindowSize": 123,
"enableHyde": true,
"similarityCutoff": 123,
"enableRerank": true,
"chatbots": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "request_string"
}
]
}
程式碼範例
# 呼叫 API 示例 (Shell)
curl -X POST "https://api.maiagent.ai/api/knowledge-bases/" \
-H "Authorization: Api-Key YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"embeddingModel": "550e8400-e29b-41d4-a716-446655440000",
"rerankerModel": "550e8400-e29b-41d4-a716-446655440000",
"name": "request_string",
"description": "request_string",
"numberOfRetrievedChunks": 123,
"sentenceWindowSize": 123,
"enableHyde": true,
"similarityCutoff": 123,
"enableRerank": true,
"chatbots": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "request_string"
}
]
}'
# 請確認在執行前替換 YOUR_API_KEY 並核對請求資料。
回應內容
狀態碼: 201
回應結構範例
{
"id": string (uuid)
"user"?: string (uuid) // 非必填
"organization"?: string (uuid) // 非必填
"embeddingModel"?: string (uuid) // 非必填
"rerankerModel"?: string (uuid) // 非必填
"name": string
"description"?: string // 非必填
"numberOfRetrievedChunks"?: integer // 非必填
"sentenceWindowSize"?: integer // 非必填
"enableHyde"?: boolean // 非必填
"similarityCutoff"?: number (double) // 非必填
"enableRerank"?: boolean // 非必填
"labels": [
{
"id": string (uuid)
"name"?: string // 非必填
}
]
"chatbots"?: [ // 非必填
{
"id": string (uuid)
"name"?: string // 非必填
}
]
"filesCount": integer // 回傳此知識庫下的 ChatbotFile 數量
"createdAt": string (timestamp)
"updatedAt": string (timestamp)
}
回應範例值
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"user": "550e8400-e29b-41d4-a716-446655440000",
"organization": "550e8400-e29b-41d4-a716-446655440000",
"embeddingModel": "550e8400-e29b-41d4-a716-446655440000",
"rerankerModel": "550e8400-e29b-41d4-a716-446655440000",
"name": "response_string",
"description": "response_string",
"numberOfRetrievedChunks": 456,
"sentenceWindowSize": 456,
"enableHyde": false,
"similarityCutoff": 456,
"enableRerank": false,
"labels": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "response_string"
}
],
"chatbots": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "response_string"
}
],
"filesCount": 456,
"createdAt": "response_string",
"updatedAt": "response_string"
}
列出所有知識庫
GET /api/knowledge-bases/
參數
embeddingModel
❌
string
page
❌
integer
A page number within the paginated result set.
pageSize
❌
integer
Number of results to return per page.
query
❌
string
rerankerModel
❌
string
程式碼範例
# 呼叫 API 示例 (Shell)
curl -X GET "https://api.maiagent.ai/api/knowledge-bases/?embeddingModel=550e8400-e29b-41d4-a716-446655440000&page=1&pageSize=1&query=example&rerankerModel=550e8400-e29b-41d4-a716-446655440000" \
-H "Authorization: Api-Key YOUR_API_KEY"
# 請確認在執行前替換 YOUR_API_KEY 並核對請求資料。
回應內容
狀態碼: 200
回應結構範例
{
"count": integer
"next"?: string (uri) // 非必填
"previous"?: string (uri) // 非必填
"results": [
{
"id": string (uuid)
"user"?: string (uuid) // 非必填
"organization"?: string (uuid) // 非必填
"embeddingModel"?: string (uuid) // 非必填
"rerankerModel"?: string (uuid) // 非必填
"name": string
"description"?: string // 非必填
"numberOfRetrievedChunks"?: integer // 非必填
"sentenceWindowSize"?: integer // 非必填
"enableHyde"?: boolean // 非必填
"similarityCutoff"?: number (double) // 非必填
"enableRerank"?: boolean // 非必填
"labels": [
{
"id": string (uuid)
"name"?: string // 非必填
}
]
"chatbots"?: [ // 非必填
{
"id": string (uuid)
"name"?: string // 非必填
}
]
"filesCount": integer // 回傳此知識庫下的 ChatbotFile 數量
"createdAt": string (timestamp)
"updatedAt": string (timestamp)
}
]
}
回應範例值
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"user": "550e8400-e29b-41d4-a716-446655440000",
"organization": "550e8400-e29b-41d4-a716-446655440000",
"embeddingModel": "550e8400-e29b-41d4-a716-446655440000",
"rerankerModel": "550e8400-e29b-41d4-a716-446655440000",
"name": "response_string",
"description": "response_string",
"numberOfRetrievedChunks": 456,
"sentenceWindowSize": 456,
"enableHyde": false,
"similarityCutoff": 456,
"enableRerank": false,
"labels": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "response_string"
}
],
"chatbots": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "response_string"
}
],
"filesCount": 456,
"createdAt": "response_string",
"updatedAt": "response_string"
}
]
}
取得特定知識庫詳情
GET /api/knowledge-bases/{id}/
參數
id
✅
string
A UUID string identifying this knowledge base.
程式碼範例
# 呼叫 API 示例 (Shell)
curl -X GET "https://api.maiagent.ai/api/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/" \
-H "Authorization: Api-Key YOUR_API_KEY"
# 請確認在執行前替換 YOUR_API_KEY 並核對請求資料。
回應內容
狀態碼: 200
回應結構範例
{
"id": string (uuid)
"user"?: string (uuid) // 非必填
"organization"?: string (uuid) // 非必填
"embeddingModel"?: string (uuid) // 非必填
"rerankerModel"?: string (uuid) // 非必填
"name": string
"description"?: string // 非必填
"numberOfRetrievedChunks"?: integer // 非必填
"sentenceWindowSize"?: integer // 非必填
"enableHyde"?: boolean // 非必填
"similarityCutoff"?: number (double) // 非必填
"enableRerank"?: boolean // 非必填
"labels": [
{
"id": string (uuid)
"name"?: string // 非必填
}
]
"chatbots"?: [ // 非必填
{
"id": string (uuid)
"name"?: string // 非必填
}
]
"filesCount": integer // 回傳此知識庫下的 ChatbotFile 數量
"createdAt": string (timestamp)
"updatedAt": string (timestamp)
}
回應範例值
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"user": "550e8400-e29b-41d4-a716-446655440000",
"organization": "550e8400-e29b-41d4-a716-446655440000",
"embeddingModel": "550e8400-e29b-41d4-a716-446655440000",
"rerankerModel": "550e8400-e29b-41d4-a716-446655440000",
"name": "response_string",
"description": "response_string",
"numberOfRetrievedChunks": 456,
"sentenceWindowSize": 456,
"enableHyde": false,
"similarityCutoff": 456,
"enableRerank": false,
"labels": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "response_string"
}
],
"chatbots": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "response_string"
}
],
"filesCount": 456,
"createdAt": "response_string",
"updatedAt": "response_string"
}
更新知識庫
PUT /api/knowledge-bases/{id}/
參數
id
✅
string
A UUID string identifying this knowledge base.
請求內容
請求參數
user
string (uuid)
否
organization
string (uuid)
否
embeddingModel
string (uuid)
否
rerankerModel
string (uuid)
否
name
string
是
description
string
否
numberOfRetrievedChunks
integer
否
sentenceWindowSize
integer
否
enableHyde
boolean
否
similarityCutoff
number (double)
否
enableRerank
boolean
否
chatbots
array[IdName]
否
請求結構範例
{
"user"?: string (uuid) // 非必填
"organization"?: string (uuid) // 非必填
"embeddingModel"?: string (uuid) // 非必填
"rerankerModel"?: string (uuid) // 非必填
"name": string
"description"?: string // 非必填
"numberOfRetrievedChunks"?: integer // 非必填
"sentenceWindowSize"?: integer // 非必填
"enableHyde"?: boolean // 非必填
"similarityCutoff"?: number (double) // 非必填
"enableRerank"?: boolean // 非必填
"chatbots"?: [ // 非必填
{
"id": string (uuid)
"name"?: string // 非必填
}
]
}
請求範例值
{
"user": "550e8400-e29b-41d4-a716-446655440000",
"organization": "550e8400-e29b-41d4-a716-446655440000",
"embeddingModel": "550e8400-e29b-41d4-a716-446655440000",
"rerankerModel": "550e8400-e29b-41d4-a716-446655440000",
"name": "request_string",
"description": "request_string",
"numberOfRetrievedChunks": 123,
"sentenceWindowSize": 123,
"enableHyde": true,
"similarityCutoff": 123,
"enableRerank": true,
"chatbots": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "request_string"
}
]
}
程式碼範例
# 呼叫 API 示例 (Shell)
curl -X PUT "https://api.maiagent.ai/api/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/" \
-H "Authorization: Api-Key YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"user": "550e8400-e29b-41d4-a716-446655440000",
"organization": "550e8400-e29b-41d4-a716-446655440000",
"embeddingModel": "550e8400-e29b-41d4-a716-446655440000",
"rerankerModel": "550e8400-e29b-41d4-a716-446655440000",
"name": "request_string",
"description": "request_string",
"numberOfRetrievedChunks": 123,
"sentenceWindowSize": 123,
"enableHyde": true,
"similarityCutoff": 123,
"enableRerank": true,
"chatbots": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "request_string"
}
]
}'
# 請確認在執行前替換 YOUR_API_KEY 並核對請求資料。
回應內容
狀態碼: 200
回應結構範例
{
"id": string (uuid)
"user"?: string (uuid) // 非必填
"organization"?: string (uuid) // 非必填
"embeddingModel"?: string (uuid) // 非必填
"rerankerModel"?: string (uuid) // 非必填
"name": string
"description"?: string // 非必填
"numberOfRetrievedChunks"?: integer // 非必填
"sentenceWindowSize"?: integer // 非必填
"enableHyde"?: boolean // 非必填
"similarityCutoff"?: number (double) // 非必填
"enableRerank"?: boolean // 非必填
"labels": [
{
"id": string (uuid)
"name"?: string // 非必填
}
]
"chatbots"?: [ // 非必填
{
"id": string (uuid)
"name"?: string // 非必填
}
]
"filesCount": integer // 回傳此知識庫下的 ChatbotFile 數量
"createdAt": string (timestamp)
"updatedAt": string (timestamp)
}
回應範例值
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"user": "550e8400-e29b-41d4-a716-446655440000",
"organization": "550e8400-e29b-41d4-a716-446655440000",
"embeddingModel": "550e8400-e29b-41d4-a716-446655440000",
"rerankerModel": "550e8400-e29b-41d4-a716-446655440000",
"name": "response_string",
"description": "response_string",
"numberOfRetrievedChunks": 456,
"sentenceWindowSize": 456,
"enableHyde": false,
"similarityCutoff": 456,
"enableRerank": false,
"labels": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "response_string"
}
],
"chatbots": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "response_string"
}
],
"filesCount": 456,
"createdAt": "response_string",
"updatedAt": "response_string"
}
部分更新知識庫
PATCH /api/knowledge-bases/{id}/
參數
id
✅
string
A UUID string identifying this knowledge base.
請求內容
請求參數
user
string (uuid)
否
organization
string (uuid)
否
embeddingModel
string (uuid)
否
rerankerModel
string (uuid)
否
name
string
否
description
string
否
numberOfRetrievedChunks
integer
否
sentenceWindowSize
integer
否
enableHyde
boolean
否
similarityCutoff
number (double)
否
enableRerank
boolean
否
chatbots
array[IdName]
否
請求結構範例
{
"user"?: string (uuid) // 非必填
"organization"?: string (uuid) // 非必填
"embeddingModel"?: string (uuid) // 非必填
"rerankerModel"?: string (uuid) // 非必填
"name"?: string // 非必填
"description"?: string // 非必填
"numberOfRetrievedChunks"?: integer // 非必填
"sentenceWindowSize"?: integer // 非必填
"enableHyde"?: boolean // 非必填
"similarityCutoff"?: number (double) // 非必填
"enableRerank"?: boolean // 非必填
"chatbots"?: [ // 非必填
{
"id": string (uuid)
"name"?: string // 非必填
}
]
}
請求範例值
{
"user": "550e8400-e29b-41d4-a716-446655440000",
"organization": "550e8400-e29b-41d4-a716-446655440000",
"embeddingModel": "550e8400-e29b-41d4-a716-446655440000",
"rerankerModel": "550e8400-e29b-41d4-a716-446655440000",
"name": "request_string",
"description": "request_string",
"numberOfRetrievedChunks": 123,
"sentenceWindowSize": 123,
"enableHyde": true,
"similarityCutoff": 123,
"enableRerank": true,
"chatbots": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "request_string"
}
]
}
程式碼範例
# 呼叫 API 示例 (Shell)
curl -X PATCH "https://api.maiagent.ai/api/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/" \
-H "Authorization: Api-Key YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"user": "550e8400-e29b-41d4-a716-446655440000",
"organization": "550e8400-e29b-41d4-a716-446655440000",
"embeddingModel": "550e8400-e29b-41d4-a716-446655440000",
"rerankerModel": "550e8400-e29b-41d4-a716-446655440000",
"name": "request_string",
"description": "request_string",
"numberOfRetrievedChunks": 123,
"sentenceWindowSize": 123,
"enableHyde": true,
"similarityCutoff": 123,
"enableRerank": true,
"chatbots": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "request_string"
}
]
}'
# 請確認在執行前替換 YOUR_API_KEY 並核對請求資料。
回應內容
狀態碼: 200
回應結構範例
{
"id": string (uuid)
"user"?: string (uuid) // 非必填
"organization"?: string (uuid) // 非必填
"embeddingModel"?: string (uuid) // 非必填
"rerankerModel"?: string (uuid) // 非必填
"name": string
"description"?: string // 非必填
"numberOfRetrievedChunks"?: integer // 非必填
"sentenceWindowSize"?: integer // 非必填
"enableHyde"?: boolean // 非必填
"similarityCutoff"?: number (double) // 非必填
"enableRerank"?: boolean // 非必填
"labels": [
{
"id": string (uuid)
"name"?: string // 非必填
}
]
"chatbots"?: [ // 非必填
{
"id": string (uuid)
"name"?: string // 非必填
}
]
"filesCount": integer // 回傳此知識庫下的 ChatbotFile 數量
"createdAt": string (timestamp)
"updatedAt": string (timestamp)
}
回應範例值
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"user": "550e8400-e29b-41d4-a716-446655440000",
"organization": "550e8400-e29b-41d4-a716-446655440000",
"embeddingModel": "550e8400-e29b-41d4-a716-446655440000",
"rerankerModel": "550e8400-e29b-41d4-a716-446655440000",
"name": "response_string",
"description": "response_string",
"numberOfRetrievedChunks": 456,
"sentenceWindowSize": 456,
"enableHyde": false,
"similarityCutoff": 456,
"enableRerank": false,
"labels": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "response_string"
}
],
"chatbots": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "response_string"
}
],
"filesCount": 456,
"createdAt": "response_string",
"updatedAt": "response_string"
}
刪除知識庫
DELETE /api/knowledge-bases/{id}/
參數
id
✅
string
A UUID string identifying this knowledge base.
程式碼範例
# 呼叫 API 示例 (Shell)
curl -X DELETE "https://api.maiagent.ai/api/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/" \
-H "Authorization: Api-Key YOUR_API_KEY"
# 請確認在執行前替換 YOUR_API_KEY 並核對請求資料。
回應內容
204
No response body
創建新標籤
POST /api/knowledge-bases/{knowledgeBasePk}/labels/
參數
knowledgeBasePk
✅
string
請求內容
請求參數
name
string
是
請求結構範例
{
"name": string
}
請求範例值
{
"name": "request_string"
}
程式碼範例
# 呼叫 API 示例 (Shell)
curl -X POST "https://api.maiagent.ai/api/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/labels/" \
-H "Authorization: Api-Key YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "request_string"
}'
# 請確認在執行前替換 YOUR_API_KEY 並核對請求資料。
回應內容
狀態碼: 201
回應結構範例
{
"id": string (uuid)
"name"?: string // 非必填
}
回應範例值
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "response_string"
}
列出知識庫中的標籤
GET /api/knowledge-bases/{knowledgeBasePk}/labels/
參數
knowledgeBasePk
✅
string
page
❌
integer
A page number within the paginated result set.
pageSize
❌
integer
Number of results to return per page.
程式碼範例
# 呼叫 API 示例 (Shell)
curl -X GET "https://api.maiagent.ai/api/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/labels/?page=1&pageSize=1" \
-H "Authorization: Api-Key YOUR_API_KEY"
# 請確認在執行前替換 YOUR_API_KEY 並核對請求資料。
回應內容
狀態碼: 200
回應結構範例
{
"count": integer
"next"?: string (uri) // 非必填
"previous"?: string (uri) // 非必填
"results": [
{
"id": string (uuid)
"name"?: string // 非必填
}
]
}
回應範例值
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "response_string"
}
]
}
取得特定標籤詳情
GET /api/knowledge-bases/{knowledgeBasePk}/labels/{id}/
參數
id
✅
string
A UUID string identifying this knowledge base label.
knowledgeBasePk
✅
string
程式碼範例
# 呼叫 API 示例 (Shell)
curl -X GET "https://api.maiagent.ai/api/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/labels/550e8400-e29b-41d4-a716-446655440000/" \
-H "Authorization: Api-Key YOUR_API_KEY"
# 請確認在執行前替換 YOUR_API_KEY 並核對請求資料。
回應內容
狀態碼: 200
回應結構範例
{
"id": string (uuid)
"name"?: string // 非必填
}
回應範例值
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "response_string"
}
更新標籤
PUT /api/knowledge-bases/{knowledgeBasePk}/labels/{id}/
參數
id
✅
string
A UUID string identifying this knowledge base label.
knowledgeBasePk
✅
string
請求內容
請求參數
name
string
是
請求結構範例
{
"name": string
}
請求範例值
{
"name": "request_string"
}
程式碼範例
# 呼叫 API 示例 (Shell)
curl -X PUT "https://api.maiagent.ai/api/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/labels/550e8400-e29b-41d4-a716-446655440000/" \
-H "Authorization: Api-Key YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "request_string"
}'
# 請確認在執行前替換 YOUR_API_KEY 並核對請求資料。
回應內容
狀態碼: 200
回應結構範例
{
"name": string
}
回應範例值
{
"name": "response_string"
}
部分更新標籤
PATCH /api/knowledge-bases/{knowledgeBasePk}/labels/{id}/
參數
id
✅
string
A UUID string identifying this knowledge base label.
knowledgeBasePk
✅
string
請求內容
請求參數
name
string
否
請求結構範例
{
"name"?: string // 非必填
}
請求範例值
{
"name": "request_string"
}
程式碼範例
# 呼叫 API 示例 (Shell)
curl -X PATCH "https://api.maiagent.ai/api/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/labels/550e8400-e29b-41d4-a716-446655440000/" \
-H "Authorization: Api-Key YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "request_string"
}'
# 請確認在執行前替換 YOUR_API_KEY 並核對請求資料。
回應內容
狀態碼: 200
回應結構範例
{
"id": string (uuid)
"name"?: string // 非必填
}
回應範例值
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "response_string"
}
刪除標籤
DELETE /api/knowledge-bases/{knowledgeBasePk}/labels/{id}/
參數
id
✅
string
A UUID string identifying this knowledge base label.
knowledgeBasePk
✅
string
程式碼範例
# 呼叫 API 示例 (Shell)
curl -X DELETE "https://api.maiagent.ai/api/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/labels/550e8400-e29b-41d4-a716-446655440000/" \
-H "Authorization: Api-Key YOUR_API_KEY"
# 請確認在執行前替換 YOUR_API_KEY 並核對請求資料。
回應內容
204
No response body
上傳檔案到知識庫
POST /api/knowledge-bases/{knowledgeBasePk}/files/
參數
knowledgeBasePk
✅
string
請求內容
請求參數
files
array[ChatbotFileCreate]
是
請求結構範例
{
"files": [
{
"filename": string // 檔案名稱
"file": string (uri) // 要上傳的檔案
"knowledgeBase"?: string (uuid) // 非必填
"parser"?: string (uuid) // 非必填
"labels"?: [ // 非必填
{
"id": string (uuid)
"name"?: string // 非必填
}
]
"rawUserDefineMetadata"?: object // 非必填
}
]
}
請求範例值
{
"files": [
{
"filename": "request_string",
"file": "request_string",
"knowledgeBase": "550e8400-e29b-41d4-a716-446655440000",
"parser": "550e8400-e29b-41d4-a716-446655440000",
"labels": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "request_string"
}
],
"rawUserDefineMetadata": null
}
]
}
程式碼範例
# 呼叫 API 示例 (Shell)
curl -X POST "https://api.maiagent.ai/api/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/files/" \
-H "Authorization: Api-Key YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"files": [
{
"filename": "request_string",
"file": "request_string",
"knowledgeBase": "550e8400-e29b-41d4-a716-446655440000",
"parser": "550e8400-e29b-41d4-a716-446655440000",
"labels": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "request_string"
}
],
"rawUserDefineMetadata": null
}
]
}'
# 請確認在執行前替換 YOUR_API_KEY 並核對請求資料。
回應內容
狀態碼: 201
回應結構範例
{
"files": [
{
"id": string (uuid)
"filename": string // 檔案名稱
"file": string (uri) // 要上傳的檔案
"fileType": string
"knowledgeBase"?: string (uuid) // 非必填
"size": integer
"status": object
"parser"?: string (uuid) // 非必填
"labels"?: [ // 非必填
{
"id": string (uuid)
"name"?: string // 非必填
}
]
"rawUserDefineMetadata"?: object // 非必填
"createdAt": string (timestamp)
}
]
}
回應範例值
{
"files": [
{
"name": "example.pdf",
"content": "回應的base64encoded_file_content",
"contentType": "application/pdf"
}
]
}
批量刪除檔案
POST /api/knowledge-bases/{knowledgeBasePk}/files/batch-delete/
參數
knowledgeBasePk
✅
string
請求內容
請求參數
ids
array[string]
是
請求結構範例
{
"ids": [
string (uuid)
]
}
請求範例值
{
"ids": [
"550e8400-e29b-41d4-a716-446655440000"
]
}
程式碼範例
# 呼叫 API 示例 (Shell)
curl -X POST "https://api.maiagent.ai/api/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/files/batch-delete/" \
-H "Authorization: Api-Key YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"ids": [
"550e8400-e29b-41d4-a716-446655440000"
]
}'
# 請確認在執行前替換 YOUR_API_KEY 並核對請求資料。
回應內容
狀態碼: 200
回應結構範例
{
"ids": [
string (uuid)
]
}
回應範例值
{
"ids": [
"550e8400-e29b-41d4-a716-446655440000"
]
}
列出知識庫中的檔案
GET /api/knowledge-bases/{knowledgeBasePk}/files/
參數
knowledgeBasePk
✅
string
fileType
❌
string
檔案類型過濾,例如:pdf、docx、txt、xlsx 等
knowledgeBase
❌
string
知識庫 ID
page
❌
integer
A page number within the paginated result set.
pageSize
❌
integer
Number of results to return per page.
query
❌
string
搜尋關鍵字,可以搜尋檔案名稱或檔案 ID
status
❌
string
檔案狀態過濾,可選值:initial(初始化)、processing(處理中)、done(完成)、deleting(刪除中)、deleted(已刪除)、failed(失敗)
initial
- Initialprocessing
- Processingdone
- Donedeleting
- Deletingdeleted
- Deletedfailed
- Failed
程式碼範例
# 呼叫 API 示例 (Shell)
curl -X GET "https://api.maiagent.ai/api/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/files/?fileType=example&knowledgeBase=550e8400-e29b-41d4-a716-446655440000&page=1&pageSize=1&query=example&status=deleted" \
-H "Authorization: Api-Key YOUR_API_KEY"
# 請確認在執行前替換 YOUR_API_KEY 並核對請求資料。
回應內容
狀態碼: 200
回應結構範例
{
"count": integer
"next"?: string (uri) // 非必填
"previous"?: string (uri) // 非必填
"results": [
{
"id": string (uuid)
"filename": string // 檔案名稱
"file": string (uri) // 要上傳的檔案
"fileType": string
"knowledgeBase"?: string (uuid) // 非必填
"size": integer
"status": object
"parser":
{
"id": string (uuid)
"name": string
"provider": string (enum: maiagent, llama, azure) // * `maiagent` - MaiAgent
* `llama` - Llama
* `azure` - Azure
"order"?: integer // 非必填
}
"labels"?: [ // 非必填
{
"id": string (uuid)
"name"?: string // 非必填
}
]
"rawUserDefineMetadata"?: object // 非必填
"createdAt": string (timestamp)
}
]
}
回應範例值
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"filename": "response_string",
"file": "response_string",
"fileType": "response_string",
"knowledgeBase": "550e8400-e29b-41d4-a716-446655440000",
"size": 456,
"status": {},
"parser": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "response_string",
"provider": "maiagent",
"order": 456
},
"labels": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "response_string"
}
],
"rawUserDefineMetadata": null,
"createdAt": "response_string"
}
]
}
取得特定檔案詳情
GET /api/knowledge-bases/{knowledgeBasePk}/files/{id}/
參數
id
✅
string
A UUID string identifying this Chatbot 檔案.
knowledgeBasePk
✅
string
程式碼範例
# 呼叫 API 示例 (Shell)
curl -X GET "https://api.maiagent.ai/api/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/files/550e8400-e29b-41d4-a716-446655440000/" \
-H "Authorization: Api-Key YOUR_API_KEY"
# 請確認在執行前替換 YOUR_API_KEY 並核對請求資料。
回應內容
狀態碼: 200
回應結構範例
{
"id": string (uuid)
"filename": string // 檔案名稱
"file": string (uri) // 要上傳的檔案
"fileType": string
"knowledgeBase"?: string (uuid) // 非必填
"size": integer
"status": object
"parser":
{
"id": string (uuid)
"name": string
"provider": string (enum: maiagent, llama, azure) // * `maiagent` - MaiAgent
* `llama` - Llama
* `azure` - Azure
"order"?: integer // 非必填
}
"labels"?: [ // 非必填
{
"id": string (uuid)
"name"?: string // 非必填
}
]
"rawUserDefineMetadata"?: object // 非必填
"createdAt": string (timestamp)
}
回應範例值
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"filename": "response_string",
"file": "response_string",
"fileType": "response_string",
"knowledgeBase": "550e8400-e29b-41d4-a716-446655440000",
"size": 456,
"status": {},
"parser": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "response_string",
"provider": "maiagent",
"order": 456
},
"labels": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "response_string"
}
],
"rawUserDefineMetadata": null,
"createdAt": "response_string"
}
列出知識庫中特定檔案的文字節點
GET /api/knowledge-bases/{knowledgeBasePk}/text-nodes/
參數
knowledgeBasePk
✅
string
chatbotFile
✅
string
檔案 ID
cursor
❌
string
The pagination cursor value.
pageSize
❌
integer
Number of results to return per page.
程式碼範例
# 呼叫 API 示例 (Shell)
curl -X GET "https://api.maiagent.ai/api/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/text-nodes/?chatbotFile=example&cursor=example&pageSize=1" \
-H "Authorization: Api-Key YOUR_API_KEY"
# 請確認在執行前替換 YOUR_API_KEY 並核對請求資料。
回應內容
狀態碼: 200
回應結構範例
{
"next"?: string (uri) // 非必填
"previous"?: string (uri) // 非必填
"results": [
{
"id": string (uuid)
"charactersCount": integer
"hitsCount": integer
"text": string
"updatedAt": string (timestamp)
"filename": string
"chatbotFile": string (uuid)
"pageNumber": integer
}
]
}
回應範例值
{
"next": "http://api.example.org/accounts/?cursor=cD00ODY%3D\"",
"previous": "http://api.example.org/accounts/?cursor=cj0xJnA9NDg3",
"results": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"charactersCount": 456,
"hitsCount": 456,
"text": "response_string",
"updatedAt": "response_string",
"filename": "response_string",
"chatbotFile": "550e8400-e29b-41d4-a716-446655440000",
"pageNumber": 456
}
]
}
取得特定文字節點詳情
GET /api/knowledge-bases/{knowledgeBasePk}/text-nodes/{id}/
參數
id
✅
string
A UUID string identifying this ChatbotTextNode.
knowledgeBasePk
✅
string
程式碼範例
# 呼叫 API 示例 (Shell)
curl -X GET "https://api.maiagent.ai/api/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/text-nodes/550e8400-e29b-41d4-a716-446655440000/" \
-H "Authorization: Api-Key YOUR_API_KEY"
# 請確認在執行前替換 YOUR_API_KEY 並核對請求資料。
回應內容
狀態碼: 200
回應結構範例
{
"id": string (uuid)
"charactersCount": integer
"hitsCount": integer
"text": string
"updatedAt": string (timestamp)
"filename": string
"chatbotFile": string (uuid)
"pageNumber": integer
}
回應範例值
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"charactersCount": 456,
"hitsCount": 456,
"text": "response_string",
"updatedAt": "response_string",
"filename": "response_string",
"chatbotFile": "550e8400-e29b-41d4-a716-446655440000",
"pageNumber": 456
}
更新檔案資訊
PUT /api/knowledge-bases/{knowledgeBasePk}/files/{id}/
參數
id
✅
string
A UUID string identifying this Chatbot 檔案.
knowledgeBasePk
✅
string
請求內容
請求參數
filename
string
是
檔案名稱
file
string (uri)
是
要上傳的檔案
knowledgeBase
string (uuid)
否
parser
string (uuid)
否
labels
array[IdName]
否
rawUserDefineMetadata
object
否
請求結構範例
{
"filename": string // 檔案名稱
"file": string (uri) // 要上傳的檔案
"knowledgeBase"?: string (uuid) // 非必填
"parser"?: string (uuid) // 非必填
"labels"?: [ // 非必填
{
"id": string (uuid)
"name"?: string // 非必填
}
]
"rawUserDefineMetadata"?: object // 非必填
}
請求範例值
{
"filename": "request_string",
"file": "request_string",
"knowledgeBase": "550e8400-e29b-41d4-a716-446655440000",
"parser": "550e8400-e29b-41d4-a716-446655440000",
"labels": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "request_string"
}
],
"rawUserDefineMetadata": null
}
程式碼範例
# 呼叫 API 示例 (Shell)
curl -X PUT "https://api.maiagent.ai/api/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/files/550e8400-e29b-41d4-a716-446655440000/" \
-H "Authorization: Api-Key YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"filename": "request_string",
"file": "request_string",
"knowledgeBase": "550e8400-e29b-41d4-a716-446655440000",
"parser": "550e8400-e29b-41d4-a716-446655440000",
"labels": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "request_string"
}
],
"rawUserDefineMetadata": null
}'
# 請確認在執行前替換 YOUR_API_KEY 並核對請求資料。
回應內容
狀態碼: 200
回應結構範例
{
"id": string (uuid)
"filename": string // 檔案名稱
"file": string (uri) // 要上傳的檔案
"fileType": string
"knowledgeBase"?: string (uuid) // 非必填
"size": integer
"status": object
"parser"?: string (uuid) // 非必填
"labels"?: [ // 非必填
{
"id": string (uuid)
"name"?: string // 非必填
}
]
"rawUserDefineMetadata"?: object // 非必填
"createdAt": string (timestamp)
}
回應範例值
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"filename": "response_string",
"file": "response_string",
"fileType": "response_string",
"knowledgeBase": "550e8400-e29b-41d4-a716-446655440000",
"size": 456,
"status": {},
"parser": "550e8400-e29b-41d4-a716-446655440000",
"labels": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "response_string"
}
],
"rawUserDefineMetadata": null,
"createdAt": "response_string"
}
部分更新檔案
PATCH /api/knowledge-bases/{knowledgeBasePk}/files/{id}/
參數
id
✅
string
A UUID string identifying this Chatbot 檔案.
knowledgeBasePk
✅
string
請求內容
請求參數
filename
string
否
檔案名稱
file
string (uri)
否
要上傳的檔案
knowledgeBase
string (uuid)
否
parser
object
否
labels
array[IdName]
否
rawUserDefineMetadata
object
否
請求結構範例
{
"filename"?: string // 檔案名稱 (非必填)
"file"?: string (uri) // 要上傳的檔案 (非必填)
"knowledgeBase"?: string (uuid) // 非必填
"parser"?: // 非必填
{
"name": string
"provider": string (enum: maiagent, llama, azure) // * `maiagent` - MaiAgent
* `llama` - Llama
* `azure` - Azure
"order"?: integer // 非必填
}
"labels"?: [ // 非必填
{
"id": string (uuid)
"name"?: string // 非必填
}
]
"rawUserDefineMetadata"?: object // 非必填
}
請求範例值
{
"filename": "request_string",
"file": "request_string",
"knowledgeBase": "550e8400-e29b-41d4-a716-446655440000",
"parser": {
"name": "request_string",
"provider": "maiagent",
"order": 123
},
"labels": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "request_string"
}
],
"rawUserDefineMetadata": null
}
程式碼範例
# 呼叫 API 示例 (Shell)
curl -X PATCH "https://api.maiagent.ai/api/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/files/550e8400-e29b-41d4-a716-446655440000/" \
-H "Authorization: Api-Key YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"filename": "request_string",
"file": "request_string",
"knowledgeBase": "550e8400-e29b-41d4-a716-446655440000",
"parser": {
"name": "request_string",
"provider": "maiagent",
"order": 123
},
"labels": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "request_string"
}
],
"rawUserDefineMetadata": null
}'
# 請確認在執行前替換 YOUR_API_KEY 並核對請求資料。
回應內容
狀態碼: 200
回應結構範例
{
"id": string (uuid)
"filename": string // 檔案名稱
"file": string (uri) // 要上傳的檔案
"fileType": string
"knowledgeBase"?: string (uuid) // 非必填
"size": integer
"status": object
"parser":
{
"id": string (uuid)
"name": string
"provider": string (enum: maiagent, llama, azure) // * `maiagent` - MaiAgent
* `llama` - Llama
* `azure` - Azure
"order"?: integer // 非必填
}
"labels"?: [ // 非必填
{
"id": string (uuid)
"name"?: string // 非必填
}
]
"rawUserDefineMetadata"?: object // 非必填
"createdAt": string (timestamp)
}
回應範例值
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"filename": "response_string",
"file": "response_string",
"fileType": "response_string",
"knowledgeBase": "550e8400-e29b-41d4-a716-446655440000",
"size": 456,
"status": {},
"parser": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "response_string",
"provider": "maiagent",
"order": 456
},
"labels": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "response_string"
}
],
"rawUserDefineMetadata": null,
"createdAt": "response_string"
}
刪除檔案
DELETE /api/knowledge-bases/{knowledgeBasePk}/files/{id}/
參數
id
✅
string
A UUID string identifying this Chatbot 檔案.
knowledgeBasePk
✅
string
程式碼範例
# 呼叫 API 示例 (Shell)
curl -X DELETE "https://api.maiagent.ai/api/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/files/550e8400-e29b-41d4-a716-446655440000/" \
-H "Authorization: Api-Key YOUR_API_KEY"
# 請確認在執行前替換 YOUR_API_KEY 並核對請求資料。
回應內容
204
No response body
創建新的 FAQ
POST /api/knowledge-bases/{knowledgeBasePk}/faqs/
參數
knowledgeBasePk
✅
string
請求內容
請求參數
chatbot
string (uuid)
否
question
string
是
answer
string
是
labels
array[IdName]
否
rawUserDefineMetadata
object
否
knowledgeBase
string (uuid)
否
請求結構範例
{
"chatbot"?: string (uuid) // 非必填
"question": string
"answer": string
"labels"?: [ // 非必填
{
"id": string (uuid)
"name"?: string // 非必填
}
]
"rawUserDefineMetadata"?: object // 非必填
"knowledgeBase"?: string (uuid) // 非必填
}
請求範例值
{
"chatbot": "550e8400-e29b-41d4-a716-446655440000",
"question": "request_string",
"answer": "request_string",
"labels": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "request_string"
}
],
"rawUserDefineMetadata": null,
"knowledgeBase": "550e8400-e29b-41d4-a716-446655440000"
}
程式碼範例
# 呼叫 API 示例 (Shell)
curl -X POST "https://api.maiagent.ai/api/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/faqs/" \
-H "Authorization: Api-Key YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"chatbot": "550e8400-e29b-41d4-a716-446655440000",
"question": "request_string",
"answer": "request_string",
"labels": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "request_string"
}
],
"rawUserDefineMetadata": null,
"knowledgeBase": "550e8400-e29b-41d4-a716-446655440000"
}'
# 請確認在執行前替換 YOUR_API_KEY 並核對請求資料。
回應內容
狀態碼: 201
回應結構範例
{
"id": string (uuid)
"question": string
"answer": string
"hitsCount": integer
"labels"?: [ // 非必填
{
"id": string (uuid)
"name"?: string // 非必填
}
]
"rawUserDefineMetadata"?: object // 非必填
"knowledgeBase"?: string (uuid) // 非必填
}
回應範例值
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"question": "response_string",
"answer": "response_string",
"hitsCount": 456,
"labels": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "response_string"
}
],
"rawUserDefineMetadata": null,
"knowledgeBase": "550e8400-e29b-41d4-a716-446655440000"
}
批量刪除 FAQ
POST /api/knowledge-bases/{knowledgeBasePk}/faqs/batch-delete/
參數
knowledgeBasePk
✅
string
請求內容
請求參數
ids
array[string]
否
請求結構範例
{
"ids"?: [ // 非必填
string (uuid)
]
}
請求範例值
{
"ids": [
"550e8400-e29b-41d4-a716-446655440000"
]
}
程式碼範例
# 呼叫 API 示例 (Shell)
curl -X POST "https://api.maiagent.ai/api/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/faqs/batch-delete/" \
-H "Authorization: Api-Key YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"ids": [
"550e8400-e29b-41d4-a716-446655440000"
]
}'
# 請確認在執行前替換 YOUR_API_KEY 並核對請求資料。
回應內容
204
No response body
列出特定知識庫的所有 FAQ
GET /api/knowledge-bases/{knowledgeBasePk}/faqs/
參數
knowledgeBasePk
✅
string
page
❌
integer
A page number within the paginated result set.
pageSize
❌
integer
Number of results to return per page.
query
❌
string
程式碼範例
# 呼叫 API 示例 (Shell)
curl -X GET "https://api.maiagent.ai/api/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/faqs/?page=1&pageSize=1&query=example" \
-H "Authorization: Api-Key YOUR_API_KEY"
# 請確認在執行前替換 YOUR_API_KEY 並核對請求資料。
回應內容
狀態碼: 200
回應結構範例
{
"count": integer
"next"?: string (uri) // 非必填
"previous"?: string (uri) // 非必填
"results": [
{
"id": string (uuid)
"question": string
"answer": string
"hitsCount": integer
"labels"?: [ // 非必填
{
"id": string (uuid)
"name"?: string // 非必填
}
]
"rawUserDefineMetadata"?: object // 非必填
"knowledgeBase"?: string (uuid) // 非必填
}
]
}
回應範例值
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"question": "response_string",
"answer": "response_string",
"hitsCount": 456,
"labels": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "response_string"
}
],
"rawUserDefineMetadata": null,
"knowledgeBase": "550e8400-e29b-41d4-a716-446655440000"
}
]
}
取得特定 FAQ 詳情
GET /api/knowledge-bases/{knowledgeBasePk}/faqs/{id}/
參數
id
✅
string
A UUID string identifying this FAQ.
knowledgeBasePk
✅
string
程式碼範例
# 呼叫 API 示例 (Shell)
curl -X GET "https://api.maiagent.ai/api/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/faqs/550e8400-e29b-41d4-a716-446655440000/" \
-H "Authorization: Api-Key YOUR_API_KEY"
# 請確認在執行前替換 YOUR_API_KEY 並核對請求資料。
回應內容
狀態碼: 200
回應結構範例
{
"id": string (uuid)
"question": string
"answer": string
"hitsCount": integer
"labels"?: [ // 非必填
{
"id": string (uuid)
"name"?: string // 非必填
}
]
"rawUserDefineMetadata"?: object // 非必填
"knowledgeBase"?: string (uuid) // 非必填
}
回應範例值
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"question": "response_string",
"answer": "response_string",
"hitsCount": 456,
"labels": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "response_string"
}
],
"rawUserDefineMetadata": null,
"knowledgeBase": "550e8400-e29b-41d4-a716-446655440000"
}
更新 FAQ
PUT /api/knowledge-bases/{knowledgeBasePk}/faqs/{id}/
參數
id
✅
string
A UUID string identifying this FAQ.
knowledgeBasePk
✅
string
請求內容
請求參數
question
string
是
answer
string
是
labels
array[IdName]
否
rawUserDefineMetadata
object
否
knowledgeBase
string (uuid)
否
請求結構範例
{
"question": string
"answer": string
"labels"?: [ // 非必填
{
"id": string (uuid)
"name"?: string // 非必填
}
]
"rawUserDefineMetadata"?: object // 非必填
"knowledgeBase"?: string (uuid) // 非必填
}
請求範例值
{
"question": "request_string",
"answer": "request_string",
"labels": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "request_string"
}
],
"rawUserDefineMetadata": null,
"knowledgeBase": "550e8400-e29b-41d4-a716-446655440000"
}
程式碼範例
# 呼叫 API 示例 (Shell)
curl -X PUT "https://api.maiagent.ai/api/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/faqs/550e8400-e29b-41d4-a716-446655440000/" \
-H "Authorization: Api-Key YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"question": "request_string",
"answer": "request_string",
"labels": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "request_string"
}
],
"rawUserDefineMetadata": null,
"knowledgeBase": "550e8400-e29b-41d4-a716-446655440000"
}'
# 請確認在執行前替換 YOUR_API_KEY 並核對請求資料。
回應內容
狀態碼: 200
回應結構範例
{
"id": string (uuid)
"question": string
"answer": string
"hitsCount": integer
"labels"?: [ // 非必填
{
"id": string (uuid)
"name"?: string // 非必填
}
]
"rawUserDefineMetadata"?: object // 非必填
"knowledgeBase"?: string (uuid) // 非必填
}
回應範例值
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"question": "response_string",
"answer": "response_string",
"hitsCount": 456,
"labels": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "response_string"
}
],
"rawUserDefineMetadata": null,
"knowledgeBase": "550e8400-e29b-41d4-a716-446655440000"
}
部分更新 FAQ
PATCH /api/knowledge-bases/{knowledgeBasePk}/faqs/{id}/
參數
id
✅
string
A UUID string identifying this FAQ.
knowledgeBasePk
✅
string
請求內容
請求參數
question
string
否
answer
string
否
labels
array[IdName]
否
rawUserDefineMetadata
object
否
knowledgeBase
string (uuid)
否
請求結構範例
{
"question"?: string // 非必填
"answer"?: string // 非必填
"labels"?: [ // 非必填
{
"id": string (uuid)
"name"?: string // 非必填
}
]
"rawUserDefineMetadata"?: object // 非必填
"knowledgeBase"?: string (uuid) // 非必填
}
請求範例值
{
"question": "request_string",
"answer": "request_string",
"labels": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "request_string"
}
],
"rawUserDefineMetadata": null,
"knowledgeBase": "550e8400-e29b-41d4-a716-446655440000"
}
程式碼範例
# 呼叫 API 示例 (Shell)
curl -X PATCH "https://api.maiagent.ai/api/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/faqs/550e8400-e29b-41d4-a716-446655440000/" \
-H "Authorization: Api-Key YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"question": "request_string",
"answer": "request_string",
"labels": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "request_string"
}
],
"rawUserDefineMetadata": null,
"knowledgeBase": "550e8400-e29b-41d4-a716-446655440000"
}'
# 請確認在執行前替換 YOUR_API_KEY 並核對請求資料。
回應內容
狀態碼: 200
回應結構範例
{
"id": string (uuid)
"question": string
"answer": string
"hitsCount": integer
"labels"?: [ // 非必填
{
"id": string (uuid)
"name"?: string // 非必填
}
]
"rawUserDefineMetadata"?: object // 非必填
"knowledgeBase"?: string (uuid) // 非必填
}
回應範例值
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"question": "response_string",
"answer": "response_string",
"hitsCount": 456,
"labels": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "response_string"
}
],
"rawUserDefineMetadata": null,
"knowledgeBase": "550e8400-e29b-41d4-a716-446655440000"
}
刪除 FAQ
DELETE /api/knowledge-bases/{knowledgeBasePk}/faqs/{id}/
參數
id
✅
string
A UUID string identifying this FAQ.
knowledgeBasePk
✅
string
程式碼範例
# 呼叫 API 示例 (Shell)
curl -X DELETE "https://api.maiagent.ai/api/knowledge-bases/550e8400-e29b-41d4-a716-446655440000/faqs/550e8400-e29b-41d4-a716-446655440000/" \
-H "Authorization: Api-Key YOUR_API_KEY"
# 請確認在執行前替換 YOUR_API_KEY 並核對請求資料。
回應內容
204
No response body
Last updated
Was this helpful?