多器官分割SegmentOAR的语法及示例_视觉智能开放平台(VIAPI)-阿里云帮助中心

功能描述

多器官分割能力针对放疗场景，基于输入的胸部CT图像，进行危及器官的识别与分割。

说明

您可以进入在线咨询获取在线人工帮助。
阿里云视觉智能开放平台视觉AI能力API接入、接口使用或问题咨询等，请通过钉钉群（23109592）加入阿里云视觉智能开放平台咨询群联系我们。

接入指引

1. 注册阿里云账号：打开阿里云官网，在阿里云官网右上角，单击立即注册，按照操作提示完成账号注册。

2. 开通能力：请确保您已开通图像分析处理，若未开通服务请立即开通。

3. 创建AccessKey：请确保您已创建AccessKey，如果您使用的是子账号AccessKey，您需要给子账号赋予AliyunVIAPIFullAccess权限，具体操作，请参见RAM授权。

4. 在线调试（可选）：您可以通过OpenAPI Explorer在线调试能力，查看完整的调用示例代码及SDK依赖信息，也可以下载完整的工程。

5. 开发接入步骤：

在SDK总览中选择您要接入使用的SDK语言。
在对应语言的SDK文档中找到AI类目为图像分析处理（imageprocess）的SDK包进行安装。
参考文档中提供的示例代码进行适当修改后调用。

6. 示例代码：该能力常用语言查询异步任务结果的示例代码，请参见查询异步任务结果示例代码。

7. 客户端直接调用：该能力常用的客户端调用方式包括以下几种。

输入限制

图像格式：DICOM、NIFTI。
图像分辨率：不小于512×512像素。
如果输入格式为DICOM，每次请求帧数最少20帧，最多600帧；如果输入格式为NIFTI，每次请求须有且仅有一例数据。
URL地址中不能包含中文字符。

调用步骤

该能力为异步能力，需分两步进行调用。

第一步调用SegmentOAR接口提交任务，请求成功后，得到一个任务ID。

第二步调用GetAsyncJobResult接口查询结果，根据任务ID查询任务执行状态和结果。如果任务还在处理中，可稍等一段时间后再进行查询。

计费说明

多器官分割能力目前处于公测期，可免费调用。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	SegmentOAR	系统规定参数。取值：SegmentOAR。
URLList.N.URL	String	是	https://viapi-test.oss-cn-shanghai.aliyuncs.com/test/xxx/c001.dcm	图像URL地址。推荐使用上海地域的OSS链接，对于文件在本地或者非上海地域OSS链接的情况，请参见文件URL处理。说明 URLList.N.URL中的N为该图像URL在当前List中的顺序（从1开始）。当直接使用API请求时，输入URLList的填充会以URLList.1.URL=url1，URLList.2.URL=url2，......的方式指定参数和参数值，参数对以&连接，其中url1、url2、......等具体值请根据实际情况进行替换；当使用SDK填充URLList时，可直接使用SDK提供的相应的方法。
DataFormat	String	是	NIFTI	图像的格式。目前只支持以下两种：DICOM、NIFTI。
OrgId	String	是	7ff51bfe-e73d-11ea-827d-506b4b3f3cf6	数据来源机构代码。
OrgName	String	是	测试组织	数据来源机构名称。
Contrast	Boolean	否	true	是否增强CT。 true：增强CT false：平扫CT
MaskList.N	Long	否	1024,2048	长整形数组，对应的器官输出。建议为空。算法默认输出全部器官的结果。
BodyPart	String	否	CHEST	期望输出的危及器官所在的身体部位。 CHEST：胸部 HEAD&NECK：头颈部。空字段：算法自动检测。

返回数据

名称	类型	示例值	描述
RequestId	String	57784EDF-7322-1559-89C2-26A08570B26B	请求ID。
Data	Object		返回的结果数据内容。该数据需要在异步任务执行成功后，通过调用GetAsyncJobResult接口，对其Result字段进行JSON反序列化之后得到。
ResultURL	String	http://vibktprfx-prod-prod-aic-med-cn-shanghai.oss-cn-shanghai.aliyuncs.com/calc-cacs/2020-09-29/2020-09-29-11%3A07%3A41-D74FE0DF-8F80-41EB-B08B-2E67053587EC.tar.gz?Expires=1601350661&OSSAccessKeyId=LTAI4FoLmvQ9urWXgSRp**&Signature=iB16ms28Y5mzB11ghYUd7upCi4**	分割结果下载地址，有效时间5分钟。
Message	String	该调用为异步调用，任务已提交成功，请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。	提交异步任务后的提示信息。

查询结果

该接口为异步接口，当前并未返回真实的请求结果，您需要通过返回的RequestId调用GetAsyncJobResult接口来获取该接口的真实请求结果。详情请参见GetAsyncJobResult。

SDK参考

阿里云视觉AI图像分析处理类目下的多器官分割能力推荐使用SDK调用，支持多种编程语言，调用时请选择AI类目为图像分析处理（imageprocess）的SDK包，文件参数通过SDK调用可支持本地文件及任意URL，具体可参见SDK总览。

示例代码

该能力常用语言查询异步任务结果的示例代码，请参见查询异步任务结果示例代码。

示例

请求示例

http(s)://imageprocess.cn-shanghai.aliyuncs.com/?Action=SegmentOAR      //更多关于访问域名（Endpoint）信息，请参见：https://help.aliyun.com/document_detail/143103.html
&URLList.1.URL=https://viapi-test.oss-cn-shanghai.aliyuncs.com/test/xxx/c001.dcm
&URLList.2.URL=https://viapi-test.oss-cn-shanghai.aliyuncs.com/test/xxx/c002.dcm
&DataFormat=NIFTI
&OrgId=7ff51bfe-e73d-11ea-827d-506b4b3f3cf6
&OrgName=测试组织
&Contrast=true
&MaskList=[1024,2048]
&BodyPart=CHEST
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<SegmentOARResponse>
    <RequestId>57784EDF-7322-1559-89C2-26A08570B26B</RequestId>
    <Message>该调用为异步调用，任务已提交成功，请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。</Message>
</SegmentOARResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "57784EDF-7322-1559-89C2-26A08570B26B",
  "Message" : "该调用为异步调用，任务已提交成功，请以requestId的值作为jobId参数调用同类目下GetAsyncJobResult接口查询任务执行状态和结果。"
}

返回示例补充说明

//查询结果：请求示例
http(s)://imageprocess.cn-shanghai.aliyuncs.com/?Action=GetAsyncJobResult
&JobId=E75FE679-0303-4DD1-8252-1143B4FA8A27
&<公共请求参数>
//查询结果：返回示例
{
  "RequestId" : "43A0AEB6-45F4-4138-8E89-E1A5D63200E3",
  "Data" : {
    "Status" : "PROCESS_SUCCESS",
    "JobId" : "186AC396-0EEC-46F1-AAA1-BF3585227427",
    "Result" : "{\"ResultURL\":\"http://vibktprfx-prod-prod-aic-med-cn-shanghai.oss-cn-shanghai.aliyuncs.com/calc-cacs/2020-09-29/2020-09-29-11%3A07%3A41-D74FE0DF-8F80-41EB-B08B-2E67053587EC.tar.gz?Expires=1601350661&OSSAccessKeyId=LTAI4FoLmvQ9urWXgSRp****&Signature=iB16ms28Y5mzB11ghYUd7upCi4****\"}"
  }
}
//Result反序列化
{
  "ResultURL" : "http://vibktprfx-prod-prod-aic-med-cn-shanghai.oss-cn-shanghai.aliyuncs.com/calc-cacs/2020-09-29/2020-09-29-11%3A07%3A41-D74FE0DF-8F80-41EB-B08B-2E67053587EC.tar.gz?Expires=1601350661&OSSAccessKeyId=LTAI4FoLmvQ9urWXgSRp****&Signature=iB16ms28Y5mzB11ghYUd7upCi4****"
}

错误码

关于多器官分割的错误码。详情请参见常见错误码。

安全声明

请确保上传的图片或文件来源符合相应的法律法规。
通过体验调试上传的临时文件有效期为1小时，在24小时后会被系统自动清理删除。