

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

# 文本分析 API 操作
<a name="comprehendmedical-textanalysis"></a>

使用 Amazon Comprehend Medical 检查临床文档，并使用预先训练的自然语言处理 (NLP) 模型获得有关其内容的各种见解。您可以对单个文件执行分析，也可以对存储在 Amazon Simple Storage Service (S3) 存储桶中的多个文件执行批量分析。

借助 Amazon Comprehend Medical，您可以对文档执行以下操作：
+ [检测实体（版本 2）](textanalysis-entitiesv2.md)：检查非结构化临床文本，检测文本中对医疗信息的引用，如医学状况、治疗、检查和结果以及药物。此版本使用的模型与最初的 Detect entities API 不同，并且输出中有一些更改。
+ [检测 PHI](textanalysis-phi.md)：检查非结构化临床文本，以检测对受保护的健康信息 (PHI) 的文本引用，例如姓名和地址。

Amazon Comprehend Medical 还包括多个 API 操作，您可以使用这些操作对临床文件进行批量文本分析。要了解有关使用这些 API 操作的更多信息，请参阅 [批量文本分析 APIs](textanalysis-batchapi.md)。

**Topics**
+ [

# 检测实体（版本 2）
](textanalysis-entitiesv2.md)
+ [

# 检测 PHI
](textanalysis-phi.md)
+ [

# 批量文本分析 APIs
](textanalysis-batchapi.md)

# 检测实体（版本 2）
<a name="textanalysis-entitiesv2"></a>

使用 **DetectEntitiesV2** 检测单个文件中的实体，或者使用 **StartEntitiesDetectionV2J** ob 对多个文件进行批量分析。您可以检测以下类别的实体：
+ `ANATOMY:` 检测对身体部位或身体系统以及这些部位或系统的位置的表述。
+ `BEHAVIORAL_ENVIRONMENTAL_SOCIAL`：检测环境中影响个人健康的行为和状况。其中包括吸烟、饮酒、吸毒、过敏、性别和种族/民族。
+ `MEDICAL_CONDITION:` 检测医学状况的体征、症状和诊断。
+ `MEDICATION:` 检测患者的药物和剂量信息。
+ `PROTECTED_HEALTH_INFORMATION:` 检测患者的个人信息。
+ `TEST_TREATMENT_PROCEDURE:` 检测用于确定医学状况的程序。
+ `TIME_EXPRESSION:` 检测与检测到的实体关联的时间实体。

**DetectEntitiesV2** 操作可以检测到所有六个类别。要进行特定于检测 PHI 的分析，请对单个文件使用 **detectPhi**，使用 Start **PHIDetectionJob** 进行批量分析。

 Amazon Comprehend Medical 可以检测以下类别的信息：
+ *实体：*对人员、治疗方法、药物和医学状况等相关对象名称的文字表述。例如 `ibuprofen`。
+ *类别：*实体所属的广义分类。例如，布洛芬属于 `MEDICATION` 类别。
+ *类型：*检测到的实体在单个类别中的类型。例如，布洛芬属于 `MEDICATION` 类别的 `GENERIC_NAME` 类型。
+ *属性：*与实体相关的信息，例如药物剂量。例如，`200 mg` 是布洛芬实体的属性。
+ *特征：*Amazon Comprehend Medical 根据背景信息对实体的了解。例如，如果患者未服用某种药物，则该药物具有 `NEGATION` 特征。
+ *关系类型：*实体与属性之间的关系。

Amazon Comprehend Medical 会为您提供实体在输入文本中的位置。在 Amazon Comprehend 控制台中，位置以图形方式显示。当您使用 API 时，它会通过数值偏移来显示位置。

每个实体和属性都包含一个得分，用来表明 Amazon Comprehend Medical 对检测准确性的置信度。每个属性也有一个关系分数。该得分可以表明 Amazon Comprehend Medical 对该属性与其父实体之间关系的准确性的置信度。请针对您的使用场景确定适当的置信度阈值。需要高准确性时，请使用高置信度阈值。筛选出不符合阈值的数据。

## 解剖学类别
<a name="anatomy-v2"></a>

`ANATOMY` 类别可以检测对身体部位或身体系统以及这些部位或系统的位置的表述。

### 类型
<a name="anatomy-type-v2"></a>
+ `SYSTEM_ORGAN_SITE`：身体系统、解剖学位置或区域以及身体部位。

### 属性
<a name="anatomy-attribute-v2"></a>
+ `DIRECTION`：方位词。例如左、右、内侧、外侧、上、下、后、前、远端、近端、对侧、双侧、同侧、背侧、腹侧等。

## 行为、环境和社会健康类别
<a name="behavioral-category-v2"></a>

`BEHAVIORAL_ENVIRONMENTAL_SOCIAL` 类别可以检测对环境中影响个人健康的行为和状况的表述。

### Type
<a name="behavioral-type-v2"></a>
+ `ALCOHOL_CONSUMPTION`：用使用状态、频率、数量和持续时间来说明患者的饮酒量。
+ `ALLERGIES`：定义患者的过敏和对过敏原的反应。
+ `GENDER`：表明性别认同。
+ `RACE_ETHNICITY`: 表明患者所属的特定种族和族裔群体。
+ `REC_DRUG_USE`：用使用状态、频率、数量和持续时间来说明患者的吸毒量。
+ `TOBACCO_USE`：用使用状态、频率、数量和持续时间来说明患者的吸烟量。属性

检测到的以下属性仅适用于 `ALCOHOL_CONSUMPTION`、`TOBACCO_USE` 和 `REC_DRUG_USE`：
+ `AMOUNT`：酒精、烟草或毒品的使用量。
+ `DURATION`：酒精、烟草或毒品的使用时间。
+ `FREQUENCY`：酒精、烟草或毒品的使用频率。

### 特征
<a name="behavioral-trait-v2"></a>

检测到的以下特征仅适用于 `ALCOHOL_CONSUMPTION`、`ALLERGIES`、`TOBACCO_USE` 和 `REC_DRUG_USE`：
+ `NEGATION`：表明结果为阴性或行动未执行。
+ `PAST_HISTORY`：表明酒精、烟草或毒品的使用来自患者的过去（现在之前）。

## 医学状况类别
<a name="medical-condition-v2"></a>

`MEDICAL_CONDITION` 类别可以检测医学状况的体征、症状和诊断。该类别具有一种实体类型、四个属性和四个特征。一个或多个特征可以与一个类型关联。有关属性的背景信息及其与诊断的关系会通过 `RELATIONSHIP_EXTRACTION.` 被检测到并映射到 `DX_NAME`。例如，从文本“左腿慢性疼痛”中，“慢性”会被检测为属性 `ACUITY`，“左”会被检测为属性 `DIRECTION`，“腿”会被检测为属性 `SYSTEM_ORGAN_SITE`。这些属性的关系会被映射到医学状况实体“疼痛”，并附带一个置信度得分。

### 类型
<a name="medical-condition-type-v2"></a>
+ `DX_NAME`：列出的所有医学状况。`DX_NAME` 类型包括目前的疾病、就诊原因和病史。

### 属性
<a name="medical-condition-attribute-v2"></a>
+ `ACUITY`：确定疾病的猛烈程度，例如慢性、急性、突发性、持续性或渐进性。
+ `DIRECTION`：方位词。例如左、右、内侧、外侧、上、下、后、前、远端、近端、对侧、双侧、同侧、背侧或腹侧。
+ `SYSTEM_ORGAN_SITE`：解剖学位置。
+ `QUALITY`：医学状况的任何描述词语，例如阶段或等级。

### 特征
<a name="medical-condition-trait-v2"></a>
+ `DIAGNOSIS`：被确定为症状的原因或结果的医学状况。症状可以通过体检结果、实验室或放射学报告或任何其他方式发现。
+ `HYPOTHETICAL`：表明医学状况是一种假设。
+ `LOW_CONFIDENCE`：表明医学状况具有高度不确定性。这与提供的置信度分数没有直接关系。
+ `NEGATION`：表明结果为阴性或行动未执行。
+ `PERTAINS_TO_FAMILY`：表明医学状况与患者家属有关，与患者无关。
+ `SIGN`：医生报告的医学状况。
+ `SYMPTOM`：患者报告的医学状况。

## 药物类别
<a name="medication-v2"></a>

`MEDICATION` 类别可以检测患者的药物和剂量信息。一个或多个属性可以应用于一个类型。

### 类型
<a name="medication-type-v2"></a>
+ `BRAND_NAME`：药物或治疗剂的受版权保护的品牌名称。
+ `GENERIC_NAME`：药物或治疗剂的非品牌名称、成分名称或配方混合物。

### 属性
<a name="medication-attribute-v2"></a>
+ `DOSAGE`：医嘱用药量。
+ `DURATION`：用药持续时间。
+ `FORM`：药物的形式。
+ `FREQUENCY`：用药频率。
+ `RATE`: 药物的给药率（主要用于药物输液或 IVs）。
+ `ROUTE_OR_MODE`：药物的用药方法。
+ `STRENGTH`：药物强度。

### 特征
<a name="medication-trait-v2"></a>
+ `NEGATION`：表明患者没有用药。
+ `PAST_HISTORY`：表明检测到的药物来自患者的过去（现在之前）。

## 受保护健康信息类别
<a name="protected-health-information-v2"></a>

`PROTECTED_HEALTH_INFORMATION` 类别可以检测患者的个人信息。要详细了解这一操作，请参阅[检测 PHI](textanalysis-phi.md)。

### 类型
<a name="protected-health-information-types-v2"></a>
+ `ADDRESS`：任何机构、单位或机构内的病房的地址的所有地理细分信息。
+ `AGE`：提及的所有年龄信息、年龄范围或任何年龄。其中包括患者、家庭成员或其他人的信息。除非另有说明，否则默认单位为岁。
+ `EMAIL`：任何电子邮件地址。
+ `ID`：社会保障号码、病历号、机构识别号、临床试验号、证书或执照号、车辆或设备号、护理地点或提供者。其中还包括患者的任何生物识别数字，例如身高、体重或实验室数值。
+ `NAME`：所有姓名。通常是患者、家属或提供者的姓名。
+ `PHONE_OR_FAX`：任何电话、传真或寻呼机号码。不包括指定电话号码，例如 1-800-QUIT-NOW 和 911。
+ `PROFESSION`：与患者或患者家属有关的任何职业或雇主。其中不包括记录中提及的临床医生的职业。

## 检查、治疗和手术类别
<a name="test-treatment-procedure-v2"></a>

`TEST_TREATMENT_PROCEDURE` 类别可以检测用于确定医学状况的程序。一个或多个属性可以与 `TEST_NAME` 类型的实体相关。

### 类型
<a name="test-treatment-procedure-types-v2"></a>
+ `PROCEDURE_NAME`：对患者进行的一次性干预措施，用于治疗疾病或为患者提供护理。
+ `TEST_NAME`：对患者执行的诊断、测量、筛查或评级程序，最后可能产生结果数值。其中包括用于确定诊断、排除或确定病情或对患者进行评级或打分的任何程序、流程、评估或评分。
+ `TREATMENT_NAME`：在一段时间内为对抗疾病或失调而采取的干预措施。其中包括药物，例如抗病毒药物和疫苗接种。

### 属性
<a name="test-treatment-procedure-attributes-v2"></a>
+ `TEST_VALUE`：检查结果。仅适用于 `TEST_NAME` 实体类型。
+ `TEST_UNIT`：检查结果数值可能采用的计量单位。仅适用于 `TEST_NAME` 实体类型。

### 特征
<a name="test-treatment-procedure-traits-v2"></a>
+ `FUTURE`：表明检查、治疗或手术是将在临床记录中的主题事件之后发生的行动或事件。
+ `HYPOTHETICAL`：表明检查、治疗或手术是一种假设。
+ `NEGATION`：表明结果为阴性或行动未执行。
+ `PAST_HISTORY`：表明检查、治疗或手术来自患者的过去（现在之前）。

## 时间类别
<a name="time-expression-v2"></a>

`TIME_EXPRESSION` 类别可以检测与时间相关的实体。其中包括日期和时间等实体，例如 “三天前”、“今天”、“当前”、“入院当天”、“上个月”或“16 天”。此类别中的结果仅在与实体关联时才会返回。例如，“患者昨天服用了 200 毫克布洛芬”会将 `Yesterday` 作为与 `GENERIC_NAME` 实体“布洛芬”重叠的 `TIME_EXPRESSION` 实体返回。但是，在“患者昨天遛过狗”中，“昨天”不会被认定为一个实体。

### 类型
<a name="time-expression-v2-categories"></a>
+ `TIME_TO_MEDICATION_NAME`：服药的日期。此类型的特定属性为 `BRAND_NAME` 和 `GENERIC_NAME`。
+ `TIME_TO_DX_NAME`：医学状况的发生日期。此类型的属性为 `DX_NAME`。
+ `TIME_TO_TEST_NAME`：接受检查的日期。此类型的属性为 `TEST_NAME`。
+ `TIME_TO_PROCEDURE_NAME`：实施手术的日期。此类型的属性为 `PROCEDURE_NAME`。
+ `TIME_TO_TREATMENT_NAME`：进行治疗的日期。此类型的属性为 `TREATMENT_NAME`。

### 关系类型
<a name="time-expression-v2-relationship-type"></a>
+  实体与属性之间的关系。识别出的 `Relationship_type` 如下：

  `Overlap` — `TIME_EXPRESSION` 与检测到的实体一致。

# 检测 PHI
<a name="textanalysis-phi"></a>

如果在扫描临床文本时只想检测受保护健康信息 (PHI) 数据，请使用 **DetectPHI** 操作。要检测临床文本中的所有可用实体，请使用 **DetectEntitiesV2**。

本 API 最适合只需要检测 PHI 实体的使用场景。要了解非 PHI 类别的信息，请参阅[检测实体（版本 2）](textanalysis-entitiesv2.md)。

**重要**  
 Amazon Comprehend Medical 提供置信度分数，该分数表明对检测到的实体的准确性的信心。请评估这些置信度分数，为您的使用场景确定正确的置信度阈值。对于特定的合规使用场景，我们建议您通过额外的人工审查或其他方法来确认检测到的 PHI 的准确性。

根据 HIPAA 法案，我们必须特别谨慎对待与 18 个标识符对应的 PHI。Amazon Comprehend Medical 会检测与这些标识符关联的实体，但这些实体并不会与 Safe Harbor 方法指定的列表一一对应。并非所有标识符都包含在非结构化临床文本中，但是 Amazon Comprehend Medical 能够检测所有相关的标识符。这些标识符由可用于识别患者身份的数据组成，显示在以下列表中。有关更多信息，请参阅*美国政府卫生与公共服务网站*上的[健康信息隐私](https://www.hhs.gov/hipaa/for-professionals/privacy/special-topics/de-identification/index.html)。

每个 PHI 相关实体都包含一个分数（响应中的 `Score`），用来表明 Amazon Comprehend Medical 对检测准确性的置信度。请为您的使用场景确定正确的置信度阈值，并筛选出不符合阈值的实体。在识别 PHI 时，最好使用低置信度阈值进行筛选，以便检测到更多实体。在合规使用场景中不使用检测到的实体的值时，这一点尤其重要。

**通过运行 **detectPhi 或 DetectEntities V2 操作可以检测到以下与 PHI** 相关的实体：**


**检测到的 PHI 实体**  

|  实体  |  说明  |  HIPAA 类别  | 
| --- | --- | --- | 
|  AGE  |  临床记录中提及的患者、家属或其他人的所有年龄信息、年龄范围或任何年龄。除非另有说明，否则默认单位为岁。  |  3. 与个人相关的日期  | 
| DATE | 与患者或患者护理相关的任何日期。 | 3. 与个人相关的日期 | 
|  NAME  |  临床记录中提及的所有姓名，通常属于患者、家属或提供者。  |  1. 姓名  | 
|  PHONE\$1OR\$1FAX  |  任何电话、传真、寻呼机号码；不包括指定电话号码，例如 1-800-QUIT-NOW 和 911。  |  4. Phone number（电话号码） 5. 传真号码  | 
|  EMAIL  |  任何电子邮件地址。  |  6. 电子邮件地址  | 
|  ID  |  与患者身份相关的任何数字。其中包括其社会保障号码、病历号、机构识别号、临床试验号、证书或执照号、车辆或设备号。还包括生物识别数字以及识别护理地点或提供者的数字。  |  7. 社会保障号码  8. 病历号 9. 健康计划号码 10. 账户号码 11。 Certificate/License 数字 12. 车辆识别号 13. 设备号 16. 生物识别信息 18。任何其他识别特征  | 
|  URL  |  任何网址。  |  14。 URLs  | 
|  ADDRESS  |  其中包括任何机构、指定医疗机构或机构内的病房的地址的所有地理细分信息。  |  2. 地理位置  | 
|  PROFESSION  |  包括临床记录中提及的与患者或患者家属有关的任何职业或雇主。  |  18。任何其他识别特征  | 



**示例**  


文本“病人名叫 John Smith，是一位 48 岁的教师，居住在华盛顿州西雅图。” 返回：
+ “John Smith”是 `PROTECTED_HEALTH_INFORMATION` 类别中的 `NAME` 类型的*实体*。
+ “48”是 `PROTECTED_HEALTH_INFORMATION` 类别中的 `AGE` 类型的*实体*。
+ “教师”是 `PROTECTED_HEALTH_INFORMATION` 类别中的 `PROFESSION` 类型（识别特征）的*实体*。
+ “华盛顿州西雅图”是 `PROTECTED_HEALTH_INFORMATION` 类别中的 `ADDRESS` *实体*。

在 Amazon Comprehend Medical 控制台中，其显示方式如下：

![\[Patient information card displaying name, age, profession, and address details.\]](http://docs.aws.amazon.com/zh_cn/comprehend-medical/latest/dev/images/patient.png)


使用 **DetectPHI** 操作时，响应如下所示。当您使用 “**启动作PHIDetection业**” 操作时，Amazon Comprehend Medical 会在输出位置创建一个具有这种结构的文件。

```
{
    "Entities": [
        {
            "Id": 0,
            "BeginOffset": 11,
            "EndOffset": 21,
            "Score": 0.997368335723877,
            "Text": "John Smith",
            "Category": "PROTECTED_HEALTH_INFORMATION",
            "Type": "NAME",
            "Traits": []
        },
        {
            "Id": 1,
            "BeginOffset": 25,
            "EndOffset": 27,
            "Score": 0.9998362064361572,
            "Text": "48",
            "Category": "PROTECTED_HEALTH_INFORMATION",
            "Type": "AGE",
            "Traits": []
        },
        {
            "Id": 2,
            "BeginOffset": 37,
            "EndOffset": 44,
            "Score": 0.8661606311798096,
            "Text": "teacher",
            "Category": "PROTECTED_HEALTH_INFORMATION",
            "Type": "PROFESSION",
            "Traits": []
        },
        {
            "Id": 3,
            "BeginOffset": 61,
            "EndOffset": 68,
            "Score": 0.9629441499710083,
            "Text": "Seattle",
            "Category": "PROTECTED_HEALTH_INFORMATION",
            "Type": "ADDRESS",
            "Traits": []
        },
        {
            "Id": 4,
            "BeginOffset": 78,
            "EndOffset": 88,
            "Score": 0.38217034935951233,
            "Text": "Washington",
            "Category": "PROTECTED_HEALTH_INFORMATION",
            "Type": "ADDRESS",
            "Traits": []
        }
    ],
    "UnmappedAttributes": []
}
```

# 批量文本分析 APIs
<a name="textanalysis-batchapi"></a>

使用 Amazon Comprehend Medical 分析存储在 Amazon S3 桶中的医学文本。一个批次最多分析 10 GB 文档。您可以使用控制台创建和管理批量分析作业，或者使用批处理 APIs 来检测医疗实体，包括受保护的健康信息 (PHI)。 APIs 启动、停止、列出和描述正在进行的批量分析作业。

 可以在[此处](https://aws.amazon.com/comprehend/medical/pricing/)查看批量分析和其他 Amazon Comprehend Medical 操作的定价信息。

## 重要提示
<a name="important-notice"></a>

Amazon Comprehend Medical 的批量分析操作不能代替专业的医学意见、诊断或治疗。为您的使用案例确定正确的置信度阈值，并在需要高准确度的情况下使用高置信度阈值。对于某些使用案例，结果应由经过适当培训的人力审核人员进行审核和验证。Amazon Comprehend Medical 的所有操作只能在患者护理场景中使用，并且要由训练有素的医学专家审查准确性并进行合理的医学判断。

## 使用执行批量分析 APIs
<a name="performing-batch-api"></a>

你可以使用 Amazon Comprehend Medical 控制台或亚马逊 Comprehend Medical Batch 运行批量分析作业。 APIs

**先决条件**

 在使用 Amazon Comprehend Medical API 时，请创建 AWS Identity Access and Management (IAM) 策略并将其附加到 IAM 角色。要了解有关 IAM 角色和信任策略的更多信息，请参阅 [IAM 策略和权限](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html)。

****

1. 将数据上传到 S3 桶。

1. 要启动新的分析作业，请使用 StartEntitiesDetection V2Job 操作或 “启动作PHIDetection业” 操作。开始作业时，请告知 Amazon Comprehend Medical 包含输入文件的输入 S3 桶的名称，并指定输出 S3 存储桶以便在批量分析后写入文件。

1. 使用控制台、 DescribeEntitiesDetection V2Job 操作或 Describe Job 操作监控PHIDetection任务的进度。此外， ListEntitiesDetectionV2Jobs 和 List PHIDetection Job 还允许您查看所有本体关联批量分析作业的状态。

1. 如果您需要停止正在进行的作业，请使用 StopEntitiesDetection V2Job 或 Stop PHIDetection Job 停止分析。

1. 要查看分析作业的结果，请参阅您在启动作业时配置的输出 S3 桶。

## 使用控制台执行批量分析
<a name="batch-api-console"></a>

****

1. 将数据上传到 S3 桶。

1. 要开始新的分析作业，请选择要执行的分析类型。然后，提供包含输入文件的 S3 桶的名称以及您想要向其发送输出文件的 S3 桶的名称。

1. 在作业运行期间监控其状态。在控制台中，您可以查看所有批量分析操作及其状态，包括分析的开始和结束时间。

1. 要查看分析作业的结果，请查看您在启动作业时配置的输出 S3 桶。

## 适用于批量操作的 IAM 策略
<a name="batch-iam"></a>

调用 Amazon Comprehend Medical APIs 批次的 IAM 角色必须具有授予对包含输入和输出文件的 S3 存储桶的访问权限的策略。还必须分配信任关系，让 Amazon Comprehend Medical 服务能够担任该角色。要了解有关 IAM 角色和信任策略的更多信息，请参阅 [IAM 角色](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html)。

该角色必须具有以下策略。

------
#### [ JSON ]

****  

```
{
    "Version":"2012-10-17",		 	 	 
    "Statement": [
        {
            "Action": [
                "s3:GetObject"
            ],
            "Resource": [
                "arn:aws:s3:::input-bucket/*"
            ],
            "Effect": "Allow"
        },
        {
            "Action": [
                "s3:ListBucket"
            ],
            "Resource": [
                "arn:aws:s3:::input-bucket",
                "arn:aws:s3:::output-bucket"
            ],
            "Effect": "Allow"
        },
        {
            "Action": [
                "s3:PutObject"
            ],
            "Resource": [
                "arn:aws:s3:::output-bucket/*"
            ],
            "Effect": "Allow"
        }
    ]
}
```

------

该角色必须拥有以下信任关系。建议您使用 `aws:SourceAccount ` 和 `aws:SourceArn` 条件键来防止混淆代理安全问题。要详细了解混淆的代理问题以及如何保护您的 AWS 账户，请参阅 IAM 文档中的[混淆代理问题](https://docs.aws.amazon.com/IAM/latest/UserGuide/confused-deputy.html)。

------
#### [ JSON ]

****  

```
{
   "Version":"2012-10-17",		 	 	 
   "Statement":[
      {
         "Effect":"Allow",
         "Principal":{
            "Service":[
               "comprehendmedical.amazonaws.com"
            ]
         },
         "Action":"sts:AssumeRole",
         "Condition": {
            "StringEquals": {
               "aws:SourceAccount": "account_id"
            },
            "ArnLike": {
               "aws:SourceArn": "arn:aws:comprehendmedical:us-east-1:account_id:*"
            }
         }
      }
   ]
}
```

------

## 批量分析输出文件
<a name="batch-ouput"></a>

Amazon Comprehend Medical 为批次中的每个输入文件创建一个输出文件。文件的扩展名为 `.out`。Amazon Comprehend Medical 首先使用 *AwsAccountId* *JobType* *JobId*-作为名称在输出 S3 存储桶中创建一个目录，然后将该批次的所有输出文件写入该目录。Amazon Comprehend Medical 创建这个新目录的目的是防止一个作业的输出被另一个作业的输出覆盖。

批处理操作产生的输出与同步操作的输出相同。有关 Amazon Comprehend Medical 生成的输出示例，请参阅[检测实体（版本 2）](textanalysis-entitiesv2.md)。

每个批处理操作都会生成三个清单文件，其中包含有关作业的信息。
+ `Manifest` – 总结作业。提供有关作业所用参数、作业的总大小以及已处理的文件数量的信息。
+ `success` – 提供有关已成功处理的文件的信息。包括输入和输出文件名以及输入文件的大小。
+ `unprocessed` – 列出批处理作业未处理的文件，包括每个文件的错误代码和错误消息。

Amazon Comprehend Medical 会将文件写入您为批处理作业指定的输出目录。摘要清单文件将与标题为 `Manifest_AccountId-Operation-JobId` 的文件夹一起写入输出文件夹。清单文件夹中有一个 `success` 文件夹，其中包含成功清单。还包括一个 `failed` 文件夹，其中包含未处理的文件清单。以下部分显示了清单文件的结构。

### 批处理清单文件
<a name="batch-manifest"></a>

以下是批处理清单文件的 JSON 结构。

```
{"Summary" : 
    {"Status" : "COMPLETED | FAILED | PARTIAL_SUCCESS | STOPPED", 
    "JobType" : "EntitiesDetection | PHIDetection", 
    "InputDataConfiguration" : {
        "Bucket" : "input bucket", 
        "Path" : "path to files/account ID-job type-job ID" 
    }, "OutputDataConfiguration" : {
        "Bucket" : "output bucket", 
        "Path" : "path to files" 
    }, 
    "InputFileCount" : number of files in input bucket, 
    "TotalMeteredCharacters" : total characters processed from all files, 
    "UnprocessedFilesCount" : number of files not processed, 
    "SuccessFilesCount" : total number of files processed, 
    "TotalDurationSeconds" : time required for processing, 
    "SuccessfulFilesListLocation" : "path to file", 
    "UnprocessedFilesListLocation" : "path to file",
    "FailedJobErrorMessage": "error message or if not applicable,
              The status of the job is completed"
    } 
}
```

### 成功清单文件
<a name="batch-success"></a>

以下是文件的 JSON 结构，其中包含有关已成功处理的文件的信息。

```
{
        "Files": [{
               "Input": "input path/input file name",
               "Output": "output path/output file name",
               "InputSize": size in bytes of input file
        }, {
               "Input": "input path/input file name",
               "Output": "output path/output file name",
               "InputSize": size in bytes of input file
        }]
}
```

### 未处理清单文件
<a name="batch-unprocessed"></a>

以下是清单文件的 JSON 结构，其中包含有关未处理文件的信息。

```
{
  "Files" : [ {
      "Input": "file_name_that_failed",
      "ErrorCode": "error code for exception",
      "ErrorMessage": "explanation of the error code and suggestions"
  }, 
  { ...}
  ]
}
```