前言¶
DeepSeek Harness (DSH) 的核心设计理念是「一切皆插件」。当需要在智能体流程中处理实体证件并提取结构化信息时,通常涉及繁琐的图像处理和解析逻辑。xby-ocr-pass 插件旨在将这一过程封装为标准接口,使开发者能够直接调用识别能力。
插件介绍¶
这是一个由 xby-skill 维护的模型推理类插件,开源协议为 MIT。它专注于处理港澳通行证和台湾通行证,能够识别证件号码、姓名、性别、出生日期、有效期、签发地点等信息,并支持 MRZ(机读码)解析。
安装¶
在终端中执行以下命令进行安装:
dsh plugin --profile web add github:xby_skill/xby-ocr-pass
安装完成后,插件将随 DSH 进程启动并生效。
核心功能¶
插件提供以下四个主要功能接口:
-
set_xby_apikey
在聊天或交互环境中设置 API 密钥。该设置会自动持久化,重启 DSH 后依然有效。 -
ocr_pass
执行通行证识别。需要输入图片文件链接。识别结果包含通行证号码、姓名、性别、出生日期、有效期、签发地点等字段,支持 MRZ 机读码解析。 -
ocr_pass_for_data_base64
执行通行证识别。需要输入图片文件的 BASE64 编码。识别逻辑同上,但数据输入方式为编码字符串。 -
ocr_pass_for_data_file
执行通行证识别。需要输入图片文件的文件路径。识别逻辑同上,但数据输入方式为本地文件路径。
配置与使用¶
获取密钥¶
插件依赖外部 OCR 服务,需要配置 API 密钥。请前往 小笨羊官网 注册并获取密钥。
使用步骤¶
- 在 DSH 环境中调用
set_xby_apikey接口,传入从官网获取的密钥。 - 根据输入数据的来源,选择
ocr_pass、ocr_pass_for_data_base64或ocr_pass_for_data_file。 - 确保输入的图片链接、BASE64 编码或文件路径有效且符合证件格式。
注意事项¶
- 插件运行需要有效的 API 密钥,否则无法完成识别。
- 不同的识别命令对输入数据的要求不同:
ocr_pass依赖链接,后两者依赖 Base64 或文件路径。 - 使用前建议检查源码与许可证(MIT),确保符合项目合规要求。