- * IPC图像目标检测 + * 基于阿里云物体检测 API，专门针对 IPC（网络摄像头）场景进行目标检测。 + * 检测图像中的人、宠物、车辆等目标，返回目标类型和置信度信息。 + *
*- * DetectIPCObject + * 核心优势： + *
+ * 适用场景： + *
+ * 阿里云 API 文档：DetectIPCObject + *
+ *+ * 接口路径：/object/ipc + *
* - * 应用场景 - * 智能看家：家中有人或宠物移动时可生成高精度视频，实现检测提醒功能。且可以关注宠物在家中的活动状况。 - * 智能看店：可对门店起到安防作用，尤其是在夜间，可及时知道有人进店。 - * 智能看厂：安全是厂区非常重要的事情，对于人员在岗以及人员入侵可以起到良好的监管作用。 - * 特色优势 - * 适用场景多：适应多种广泛的日常场景的目标检测，室内、室外、家居、店铺、商场、白天、夜间等。 - * 检测范围广：可检测的目标大小范围广，适用于大目标检测，也适用于较远摄像头下的小目标检测。 - * 检测效率高：高并发处理，处理时间短。 + * @author heyu + * @since 1.0.0 */ @Slf4j @RestController @@ -47,6 +65,25 @@ public class DetectIPCObjectController extends BaseController { private ADetectIPCObjectHandle aDetectIPCObjectHandle; + /** + * IPC 图像目标检测接口 + *+ * 接收图片（URL 或 Base64），调用阿里云 IPC 目标检测 API，识别图像中的人、宠物、车辆等目标。 + * 返回每个目标的类型（人/车/宠物等）和置信度评分。 + *
+ *+ * 检测结果可能包括： + *
- * 主体检测 + * 基于阿里云物体检测 API，对输入的图片进行主体检测，返回图片中主要主体（如人、物等）的位置信息。 + * 支持通过图片 URL 或 Base64 编码两种方式传入图片。 + *
*- * DetectMainBody + * 阿里云 API 文档：DetectMainBody + *
+ *+ * 适用场景： + *
+ * 接口路径：/main/body/detect + *
+ * + * @author heyu + * @since 1.0.0 */ - @Slf4j @RestController @RequestMapping("/main/body") @@ -35,6 +51,15 @@ public class DetectMainBodyController extends BaseController { private ADetectMainBodyHandle aDetectMainBodyHandle; + /** + * 主体检测接口 + *+ * 接收图片（URL 或 Base64），调用阿里云主体检测 API，返回图片中主要主体的位置坐标。 + *
+ * + * @param req 检测请求参数，包含 imageUrl 或 imageBase64（二选一） + * @return 主体位置信息，包含 x, y, width, height 坐标；若失败返回错误信息 + */ @RequestMapping("/detect") public R ipc(DetectMainBodyReq req) { diff --git a/api-web/api-interface/src/main/java/com/heyu/api/controller/objectdet/DetectObjectController.java b/api-web/api-interface/src/main/java/com/heyu/api/controller/objectdet/DetectObjectController.java index dfcebdc..0de1f41 100644 --- a/api-web/api-interface/src/main/java/com/heyu/api/controller/objectdet/DetectObjectController.java +++ b/api-web/api-interface/src/main/java/com/heyu/api/controller/objectdet/DetectObjectController.java @@ -69,7 +69,6 @@ public class DetectObjectController extends BaseController { detectObjectResp.setType(element.getType()); respList.add(detectObjectResp); - } return R.ok().setData(respList); } diff --git a/api-web/api-interface/src/main/java/com/heyu/api/controller/objectdet/DetectWhiteBaseImageController.java b/api-web/api-interface/src/main/java/com/heyu/api/controller/objectdet/DetectWhiteBaseImageController.java index b7d73ca..5f82961 100644 --- a/api-web/api-interface/src/main/java/com/heyu/api/controller/objectdet/DetectWhiteBaseImageController.java +++ b/api-web/api-interface/src/main/java/com/heyu/api/controller/objectdet/DetectWhiteBaseImageController.java @@ -19,13 +19,32 @@ import org.springframework.web.bind.annotation.RestController; import java.util.ArrayList; import java.util.List; -/*** - * https://next.api.aliyun.com/api/objectdet/2019-12-30/DetectObject?tab=DOC - * - *物体检测 - * - * DetectObject +/** + * 白底图检测控制器 + *+ * 基于阿里云物体检测 API，检测输入的图片是否为白底图（背景为白色的图片）。 + * 支持通过图片 URL 或 Base64 编码两种方式传入图片。 + *
+ *+ * 白底图通常用于证件照、商品图、资质文件等场景，本接口可自动识别图片背景是否符合白底要求。 + *
+ *+ * 阿里云 API 文档：DetectWhiteBaseImage + *
+ *+ * 适用场景： + *
+ * 接口路径：/object/detectWhiteBase + *
* + * @author heyu + * @since 1.0.0 */ @Slf4j @RestController @@ -37,6 +56,15 @@ public class DetectWhiteBaseImageController extends BaseController { @Autowired private ADetectWhiteBaseImageHandle aDetectWhiteBaseImageHandle; + /** + * 白底图检测接口 + *+ * 接收图片（URL 或 Base64），调用阿里云白底图检测 API，返回检测结果。 + *
+ * + * @param req 检测请求参数，包含 imageUrl 或 imageBase64（二选一） + * @return 白底图检测结果列表，每个元素包含 whiteBase 字段表示是否为白底图；若失败返回错误信息 + */ @RequestMapping("/detectWhiteBase") public R ipc(DetectWhiteBaseImageReq req) { diff --git a/api-web/api-interface/src/main/java/com/heyu/api/controller/ocr/GeneralBasicOcrController.java b/api-web/api-interface/src/main/java/com/heyu/api/controller/ocr/GeneralBasicOcrController.java index d5a36e2..5d8d210 100644 --- a/api-web/api-interface/src/main/java/com/heyu/api/controller/ocr/GeneralBasicOcrController.java +++ b/api-web/api-interface/src/main/java/com/heyu/api/controller/ocr/GeneralBasicOcrController.java @@ -17,10 +17,35 @@ import org.springframework.web.bind.annotation.RequestBody; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController; -/*** - * 通用文字识别（高精度基础版） +/** + * 通用文字识别控制器（高精度基础版） + *+ * 基于百度 OCR API，提供多场景文字识别能力，支持图片、PDF、OFD 等多种格式输入。 + * 返回百度原始响应，包含 words_result、words_result_num、log_id 等完整字段。 + *
+ *+ * 支持的输入格式： + *
+ * 适用场景： + *
+ * 接口路径：/general/text/orc/recognize + *
* - * 返回百度原始响应，包含 words_result、words_result_num、log_id 等完整字段 + * @author heyu + * @since 1.0.0 */ @Slf4j @RestController @@ -32,11 +57,38 @@ public class GeneralBasicOcrController extends BaseController { private BGeneralBasicHandle bGeneralBasicHandle; + /** + * 通用文字识别接口（备用路径） + *+ * 内部转发到 recognize 方法处理 + *
+ * + * @param generalBasicOcrRequest OCR 识别请求参数 + * @return OCR 识别结果 + */ @EbAuthentication(tencent = ApiConstants.TENCENT_AUTH) @RequestMapping("/recognize1") public R recognize1(@RequestBody GeneralBasicOcrRequest generalBasicOcrRequest) throws Exception { return recognize(generalBasicOcrRequest); } + + /** + * 通用文字识别接口（主路径） + *+ * 支持图片（Base64/URL）、PDF、OFD 格式的文字识别。 + * 对 Base64 参数进行 URL 编码处理，确保传输安全。 + *
+ *+ * 本地测试：http://localhost:8888/general/text/orc/recognize + *
+ * + * @param generalBasicOcrRequest OCR 识别请求参数，包含以下字段（任选其一）： + * - imageBase64：图片 Base64 编码 + * - imageUrl：图片 URL + * - pdfFile：PDF 文件 Base64 编码 + * - ofdFile：OFD 文件 Base64 编码 + * @return OCR 识别结果，包含文字内容、置信度、坐标等信息 + */ // http://localhost:8888/general/text/orc/recognize?imageBase64=3232 @EbAuthentication(tencent = ApiConstants.TENCENT_AUTH) @RequestMapping("/recognize") diff --git a/api-web/api-interface/src/main/java/com/heyu/api/controller/ocr/HighPrecisionOcrController.java b/api-web/api-interface/src/main/java/com/heyu/api/controller/ocr/HighPrecisionOcrController.java index aec5603..d2766c4 100644 --- a/api-web/api-interface/src/main/java/com/heyu/api/controller/ocr/HighPrecisionOcrController.java +++ b/api-web/api-interface/src/main/java/com/heyu/api/controller/ocr/HighPrecisionOcrController.java @@ -16,6 +16,37 @@ import org.springframework.web.bind.annotation.RequestBody; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController; +/** + * 高精度文字识别控制器 + *+ * 基于百度文档分析 Office API，提供高精度的文字识别能力。 + * 相比通用 OCR，本接口在复杂场景下识别精度更高，支持返回文字行级别的概率信息。 + *
+ *+ * 核心特性： + *
+ * 适用场景： + *
+ * 接口路径：/high/precision/orc/recognize + *
+ * + * @author heyu + * @since 1.0.0 + */ @Slf4j @RestController @RequestMapping("/high/precision/orc/") @@ -26,6 +57,27 @@ public class HighPrecisionOcrController { private BDocAnalysisOfficeHandle bDocAnalysisOfficeHandle; + /** + * 高精度文字识别接口 + *+ * 使用百度文档分析 Office API 进行高精度 OCR 识别，相比通用 OCR 提供更高的识别准确率。 + * 自动启用 lineProbability 返回每行文字的置信度，便于后续质量评估和过滤。 + *
+ *+ * 本地测试：http://localhost:8888/high/precision/orc/recognize + *
+ *+ * 示例图片：https://heyuoss.oss-cn-shanghai.aliyuncs.com/prd/testxxx.jpg + *
+ * + * @param generalBasicOcrRequest OCR 识别请求参数，包含以下字段（任选其一）： + * - imageBase64：图片 Base64 编码 + * - imageUrl：图片 URL + * - pdfFile：PDF 文件 Base64 编码 + * - ofdFile：OFD 文件 Base64 编码 + * - pdfFileNum/ofdFileNum：指定页码（可选） + * @return 高精度 OCR 识别结果，包含文字内容、坐标、置信度等信息 + */ // http://localhost:8888/high/precision/orc/recognize?imageBase64=3232 // https://heyuoss.oss-cn-shanghai.aliyuncs.com/prd/testxxx.jpg @EbAuthentication(tencent = ApiConstants.TENCENT_AUTH) diff --git a/api-web/api-interface/src/main/java/com/heyu/api/controller/qrcode/RecognizeQrCodeController.java b/api-web/api-interface/src/main/java/com/heyu/api/controller/qrcode/RecognizeQrCodeController.java index aca24bc..4c825a5 100644 --- a/api-web/api-interface/src/main/java/com/heyu/api/controller/qrcode/RecognizeQrCodeController.java +++ b/api-web/api-interface/src/main/java/com/heyu/api/controller/qrcode/RecognizeQrCodeController.java @@ -13,6 +13,37 @@ import org.springframework.beans.factory.annotation.Autowired; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController; +/** + * 二维码识别控制器 + *+ * 基于百度 QR Code API，提供二维码/条形码的识别和解析能力。 + * 支持图片 URL 或 Base64 编码两种方式传入图片，自动识别并解析二维码内容。 + *
+ *+ * 核心功能： + *
+ * 适用场景： + *
+ * 接口路径：/qrcode/recognize + *
+ * + * @author heyu + * @since 1.0.0 + */ @Slf4j @RestController @RequestMapping("/qrcode") @@ -22,6 +53,18 @@ public class RecognizeQrCodeController extends BaseController { @Autowired private BQrCodeHandle bqrCodeHandle; + /** + * 二维码识别接口 + *+ * 接收图片（URL 或 Base64），调用百度 QR Code API 进行识别和解析。 + * 启用结果缓存，相同图片的识别结果会被缓存以提升响应速度。 + *
+ * + * @param request 二维码识别请求参数，包含以下字段（任选其一）： + * - imageBase64：图片 Base64 编码 + * - imageUrl：图片 URL + * @return 二维码识别结果，包含二维码内容、类型、位置坐标等信息 + */ @RequestMapping("/recognize") @CacheResult public R recognize(BQrcodeReconizeRequest request) {