图像查重API接口文档

需积分: 5 1 下载量 193 浏览量 更新于2024-08-05 收藏 9KB MD 举报
"图像查重接口_V0.6(2) copy(1).md" 本文档详细阐述了图像查重功能的RESTful API接口设计,主要用于实现图像的比对和查重服务,允许外部系统进行调用。接口设计遵循HTTP协议和JSON数据格式的标准,确保跨平台的数据交互。所有接口需满足特定规范,包括使用标准HTTP方法进行资源操作,以JSON作为输入输出格式,并严格区分大小写。同时,接口中涉及的所有字符串数据应采用UTF-8编码。 ### 图像查重接口 该接口的主要功能是检测单个图像在数据库中的重复情况,返回与查询图像相似的图像信息。如果查找到的相似图像数量超过5张,只返回前5个最相似图像的编码、名称及数据,其余图像仅返回编码和名称。每次成功调用此接口,查询的图像会被自动保存到图像数据库中,作为后续查重的参考。 #### 接口调用 调用图像查重接口的方式是通过POST请求发送到`http://10.76.153.11:30100/image_similar_api/ImageSimilar/Check`。 #### 请求参数 1. `system_code` - 不强制填写,表示系统的唯一标识,字符串类型,长度限制小于10。 2. `prv_code` - 强制填写,表示省公司的标识,字符串类型。 3. `region_code` - 强制填写,表示地区的标识,字符串类型。 4. `major_code` - 强制填写,表示专业的标识,字符串类型。 5. `image_code` - 强制填写,图像的编码,字符串类型,编码规则见附件一。 6. `image_name` - 强制填写,图像的名称,字符串类型,长度限制小于200。 7. `image_data` - 强制填写,图像的base64编码数据,字符串类型。 #### 响应参数 1. `ret_code` - 强制填写,返回结果编码,字符串类型,参照附录1了解详细编码含义。 2. `ret_message` - 强制填写,返回结果消息,当失败时提供具体错误信息,成功时显示“请求成功”。 3. `ret_data` - 强制填写,返回的结果数据,以JSON格式表示。 ### 查重结果数据 (ret_data) 这部分数据包含在`ret_data` JSON对象中,具体参数详细信息未在摘要中给出,但通常会包含相似图像的编码、名称、相似度等信息。具体的JSON结构可能如下: ```json { "images": [ { "image_code": "code1", "image_name": "name1", "similarity_score": 0.9, "image_data": "base64_encoded_data1" }, { "image_code": "code2", "image_name": "name2", "similarity_score": 0.85, "image_data": null }, ... ] } ``` 请注意,实际的JSON结构可能根据接口设计有所变化,具体还需参考完整的接口文档或实际接口返回数据。 这个图像查重接口提供了一个高效、标准化的途径,使得外部系统能够集成图像比对和查重功能,有效管理和利用图像数据。对于处理大量图像数据的系统来说,这样的接口具有重要的实用价值。