diff --git a/API_Documentation.md b/API_Documentation.md new file mode 100644 index 0000000..f3ec8fa --- /dev/null +++ b/API_Documentation.md @@ -0,0 +1,46 @@ +## 接口文档 + +### 更新数据库 + +- **URL**: `/updateDatabase` +- **方法**: `POST` +- **描述**: 接收问题数据并异步保存为JSON文件,触发后台更新任务。 +- **请求体**: + - `question_items`: 问题项列表,每个项包含问题ID和问题列表。 + - `questionId`: str,问题的唯一标识符。 + - `questionList`: List[str],问题列表。 +- **响应**: + - `status`: str,操作状态。可能的值为 "success" 或 "error"。 + - `message`: str,操作结果消息。可能是成功消息或错误消息。 + +--- + +### 匹配问题 + +- **URL**: `/matchQuestion` +- **方法**: `POST` +- **描述**: 匹配问题的端点,根据问题在知识库中进行匹配,并返回匹配结果。 +- **请求体**: + - `question`: str,待匹配的问题。 + - `scoreThreshold`: float,匹配得分的阈值。 +- **响应**: + - `code`: int,响应状态码。200表示成功,500表示失败。 + - `msg`: str,操作结果消息。可能是成功消息或错误消息。 + - `data`: list,匹配到的问题结果列表。每个结果包含匹配的问题及其得分。 + +--- + +### 提取信息 + +- **URL**: `/extractInformation/` +- **方法**: `POST` +- **描述**: 从文本中提取信息的端点,提取姓名、卡号和身份证号信息。 +- **请求体**: + - `inputText`: str,待提取信息的文本。 +- **响应**: + - `name`: str,提取到的姓名。若未提取到姓名,则为空字符串。 + - `cardNumber`: str,提取到的卡号。若未提取到卡号,则为空字符串。 + - `idNumber`: str,提取到的身份证号。若未提取到身份证号,则为空字符串。 + +--- +