HKUSTMDI/mdi-sam-server 项目API接口详解

项目概述

HKUSTMDI/mdi-sam-server 是一个基于SAM(Segment Anything Model)模型的服务端实现，提供图像分割相关的API接口。该项目主要面向需要图像分割功能的开发者，通过简单的API调用即可获得专业的图像分割结果。

接口基础信息

请求规范

所有API请求需要遵循以下规范：

• 请求头必须包含：Content-Type:application/json
• 需要身份验证的接口需在请求头中包含token：token:xxxx
• 请求体采用JSON格式

接口列表

项目提供以下三个核心接口：

1. predict - SAM模型预测接口，用于获取图像指定位置的mask
2. preload - 图片预加载接口，可提高后续predict速度
3. health - 健康检查接口

predict接口详解

接口功能

predict接口是项目的核心功能，它基于SAM模型对输入的图像进行分割处理。用户可以通过提供图像URL和提示信息(点或矩形框)来获取精确的分割结果。

请求方式

• 方法：POST
• URL：${prefix_url}/predict

请求参数

参数名	类型	必填	描述
tasks	JSON	是	包含待处理图片信息的数组
task_id	string	是	任务唯一标识
params	JSON	是	预测参数配置
model_version	string	否	SAM模型类型，默认sam_vit_l
img_type	string	否	图片类型，默认normal，可选sdpc/svs/tiff/normal

请求示例

基础请求结构

{
    "tasks": [
        {
            "data": {
                "image": "图片URL"
            }
        }
    ],
    "task_id": "任务ID",
    "params": {
        "context": {
            "result": [
                // 提示信息(点或矩形框)
            ]
        }
    }
}

提示信息类型

1. 点模式(keypointlabels)

{
    "original_width": 3840,
    "original_height": 2160,
    "image_rotation": 0,
    "value": {
        "x": 80.31,
        "y": 43.67,
        "width": 0.28,
        "keypointlabels": ["标签"]
    },
    "is_positive": true,
    "type": "keypointlabels",
    "origin": "manual"
}

2. 矩形模式(rectanglelabels)

{
    "original_width": 3840,
    "original_height": 2160,
    "image_rotation": 0,
    "value": {
        "x": 55,
        "y": 44,
        "width": 8,
        "height": 10,
        "rectanglelabels": ["标签"]
    },
    "type": "rectanglelabels",
    "origin": "manual"
}

响应结构

{
    "results": [
        {
            "model_version": "模型信息",
            "result": [
                {
                    "id": "结果ID",
                    "original_height": 2160,
                    "original_width": 3840,
                    "score": 0.73,
                    "type": "brushlabels",
                    "value": {
                        "bbox": [1501,570,642,730],
                        "brushlabels": ["标签"],
                        "format": "rle",
                        "rle": [...]
                    }
                }
            ]
        }
    ]
}

使用场景示例

1. 点提示分割

通过提供正负点提示，引导模型进行精确分割：

{
    "tasks": [{"data": {"image": "图片URL"}}],
    "params": {
        "context": {
            "result": [
                // 正点1
                {"value": {"x":50,"y":50,"keypointlabels":["标签"]},"is_positive":true},
                // 正点2
                {"value": {"x":44,"y":50,"keypointlabels":["标签"]},"is_positive":true},
                // 负点
                {"value": {"x":50,"y":40,"keypointlabels":["标签"]},"is_positive":false}
            ]
        }
    }
}

2. 矩形提示分割

通过提供矩形区域提示，快速获取目标分割结果：

{
    "tasks": [{"data": {"image": "图片URL"}}],
    "params": {
        "context": {
            "result": [
                {
                    "value": {
                        "x":55,"y":44,"width":8,"height":10,
                        "rectanglelabels":["标签"]
                    },
                    "type":"rectanglelabels"
                }
            ]
        }
    }
}

3. WSI图像分割

针对大尺寸WSI(Whole Slide Image)图像的特殊处理：

{
    "img_type": "sdpc",
    "params": {
        "context": {
            "cur_scale": 1.1,
            "result": [
                // 可混合使用点和矩形提示
            ]
        }
    }
}

preload接口详解

接口功能

preload接口用于预加载图像到模型中，可显著提高后续predict接口的响应速度。但需要注意：WSI类型图片不支持此功能。

请求方式

• 方法：POST/GET
• URL：${prefix_url}/preload

请求参数

参数名	类型	必填	描述
url	string	是	需要预加载的图片URL
task_id	string	是	任务唯一标识

使用示例

{
    "url": "图片URL",
    "task_id": "任务ID"
}

health接口详解

接口功能

简单的健康检查接口，用于验证服务是否正常运行。

请求方式

• 方法：GET
• URL：${prefix_url}/health

响应示例

{
    "code": 200,
    "model_class": "SamMLBackend",
    "msg": "ok"
}

性能优化建议

1. 合理使用preload：对于需要多次处理的普通图片，先调用preload接口可显著提高后续处理速度
2. 选择合适的提示类型：点提示适合精细分割，矩形提示适合快速获取大致区域
3. 模型版本选择：根据需求平衡精度和速度，较大模型精度更高但速度较慢
4. WSI图像处理：注意必须提供cur_scale参数，并正确设置img_type

常见问题

1. Q: WSI图片为什么不能使用preload？ A: WSI图片通常体积巨大，预加载会占用大量内存，因此设计为实时处理模式。

2. Q: 如何选择正负点提示？ A: 正点应标记在目标区域内，负点应标记在非目标区域但容易被误识别的位置。

3. Q: 分割效果不理想怎么办？ A: 可以尝试增加提示点的数量，或调整提示点的位置，必要时可混合使用点和矩形提示。

通过本文的详细讲解，开发者应该能够充分理解并使用HKUSTMDI/mdi-sam-server项目提供的API接口，实现高效的图像分割功能。