

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

# テキスト分析 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 オペレーションを使用する方法の詳細については、「[テキスト分析バッチ API](textanalysis-batchapi.md)」を参照してください。

**Topics**
+ [エンティティの検出 (バージョン 2)](textanalysis-entitiesv2.md)
+ [PHI の検出](textanalysis-phi.md)
+ [テキスト分析バッチ API](textanalysis-batchapi.md)

# エンティティの検出 (バージョン 2)
<a name="textanalysis-entitiesv2"></a>

**DetectEntitiesV2** を使用して、単一ファイル内でエンティティを検出します。または、**StartEntitiesDetectionV2Job** を使用して、複数のファイルでバッチ分析を行います。以下のカテゴリのエンティティを検出できます。
+ `ANATOMY:` 人体の部位または体組織への参照、およびそれらの人体の部位または体組織の位置への参照を検出します。
+ `BEHAVIORAL_ENVIRONMENTAL_SOCIAL`: 人の健康に影響を与える環境内の行動や状態を検出します。これには、喫煙、アルコールの摂取、娯楽目的の薬物使用、アレルギー、性別、人種/民族が含まれます。
+ `MEDICAL_CONDITION:` 病状の兆候、症状、および診断を検出します。
+ `MEDICATION:` 患者の薬剤および投与量の情報を検出します。
+ `PROTECTED_HEALTH_INFORMATION:` 患者の個人情報を検出します。
+ `TEST_TREATMENT_PROCEDURE:` 病状を判断するために使用されている処置を検出します。
+ `TIME_EXPRESSION:` 検出されたエンティティに関連付けられている時間に関連するエンティティを検出します。

6 つのすべてのカテゴリが **DetectEntitiesV2** オペレーションで検出されます。PHI の検出に固有の分析では、単一ファイルで **DetectPHI** を使用し、バッチ分析に **StartPHIDetectionJob** を使用します。

 Amazon Comprehend Medical は、次のクラスで情報を検出します。
+ エンティティ: 人々、治療、薬剤、病状などの関連オブジェクトの名前へのテキスト参照。**例えば、`ibuprofen`。
+ カテゴリ: エンティティが属する一般化されたグループ。**例えば、「Ibuprofen」(イブプロフェン) は `MEDICATION` カテゴリに属します。
+ タイプ: 単一カテゴリ内で検出されるエンティティのタイプ。**例えば、「Ibuprofen」(イブプロフェン) は `MEDICATION` カテゴリ内の `GENERIC_NAME` タイプです。
+ 属性: 薬剤の投与量など、エンティティに関連する情報。**例えば、`200 mg` は Ibuprofen (イブプロフェン) エンティティの属性です。
+ *特性*: 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` カテゴリは、人の健康に影響を与える環境内の行動や状態の言及を検出します。

### タイプ
<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` カテゴリは、病状の兆候、症状、および診断を検出します。このカテゴリには、1 つのエンティティタイプ、4 つの属性、および 4 つの特性があります。1 つまたは複数の特性を 1 つのタイプに関連付けることができます。属性および属性と診断の関係に関するコンテキスト情報が検出され、`RELATIONSHIP_EXTRACTION.` によって `DX_NAME` にマッピングされます。例えば、テキスト「chronic pain in left leg」(左脚の慢性疼痛) では、「chronic」(慢性) が属性 `ACUITY` として検出され、「left」(左) が属性 `DIRECTION` として検出され、「leg」(脚) が属性 `SYSTEM_ORGAN_SITE` として検出されます。これらの各属性の関係は、信頼スコアとともに病状エンティティ「pain」(疼痛) にマッピングされます。

### 型
<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`: 症状の原因または結果として決定される病状。症状は、身体所見、検査所見報告書や X 線診断報告書、またはその他の手段によって検出できます。
+ `HYPOTHETICAL`: 病状が仮説として表現されているという表示。
+ `LOW_CONFIDENCE`: 病状が不確実性が高いと表現されているという表示。これは提供された信頼度スコアとは直接関係ありません。
+ `NEGATION`: 結果またはアクションが否定的であるか、実行されていないことの表示。
+ `PERTAINS_TO_FAMILY`: 病状が患者ではなく患者の家族に関係しているという表示。
+ `SIGN`: 医師が報告した病状。
+ `SYMPTOM`: 患者が報告した病状。

## 薬剤カテゴリ
<a name="medication-v2"></a>

`MEDICATION` カテゴリは、患者の薬剤および投与量の情報を検出します。1 つまたは複数の属性を 1 つのタイプに適用できます。

### 型
<a name="medication-type-v2"></a>
+ `BRAND_NAME`: 薬剤または治療薬の、著作権で保護されたブランド名。
+ `GENERIC_NAME`: 薬剤または治療薬のブランド以外の名前、成分名、または処方の調合。

### 属性
<a name="medication-attribute-v2"></a>
+ `DOSAGE`: 指示された薬剤の量。
+ `DURATION`: 薬剤を投与すべき期間。
+ `FORM`: 薬剤の形態。
+ `FREQUENCY`: 薬剤を投与する頻度。
+ `RATE`: 薬剤の投与速度 (主に薬剤注入または IV の場合)
+ `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`: E メールアドレス。
+ `ID`: 社会保障番号、医療記録番号、施設識別番号、臨床試験番号、証明書番号や免許証番号、車両番号や機器番号、ケアの場所、または医療提供者。これには、身長、体重、検査値など、患者の生体認証番号も含まれます。
+ `NAME`: すべての名前。通常、患者、家族、または医療提供者の名前。
+ `PHONE_OR_FAX`: 電話番号、FAX 番号、またはポケットベル番号。1-800-QUIT-NOW や 911 など、名前付きの電話番号は除きます。
+ `PROFESSION`: 患者または患者の家族に関連する職業または雇用主。これには、臨床記録に記載された臨床医の職業は含まれません。

## 検査、治療、処置のカテゴリ
<a name="test-treatment-procedure-v2"></a>

`TEST_TREATMENT_PROCEDURE` カテゴリは、病状を判断するために使用されている処置を検出します。1 つまたは複数の属性を `TEST_NAME` タイプの 1 つのエンティティに関連付けることができます。

### 型
<a name="test-treatment-procedure-types-v2"></a>
+ `PROCEDURE_NAME`: 病状を治療するために、または患者ケアを提供するために、患者に行われる 1 回限りのアクションとしての治療介入。
+ `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` カテゴリは、時間に関連するエンティティを検出します。これには、「3日前」、「今日」、「現在」、「入院日」、「先月」、「16日間」など、日付や時間表現などのエンティティが含まれます。このカテゴリの結果は、エンティティに関連付けられている場合にのみ返されます。例えば、「Yesterday, the patient took 200 mg of ibuprofen」(昨日、患者は 200mg のイブプロフェンを服用した) は、`Yesterday` を `TIME_EXPRESSION` エンティティとして返し、このエンティティは `GENERIC_NAME` エンティティ「ibuprofen」(イブプロフェン) と重複します。ただし、「yesterday, the patient walked their dog.」(昨日、患者は犬を散歩させた) では、これはエンティティとして認識されません。

### 型
<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>

**DetectPHI** オペレーションは、臨床テキストのスキャン時に保護医療情報 (PHI) データを検出する場合にのみ使用します。臨床テキスト内の利用可能なエンティティをすべて検出するには、**DetectEntitiesV2** を使用してください。

この API は PHI エンティティの検出のみが必要なユースケースに最適です。PHI 以外のカテゴリの詳細については、「[エンティティの検出 (バージョン 2)](textanalysis-entitiesv2.md)」を参照してください。

**重要**  
 Amazon Comprehend Medical は、検出されたエンティティの精度に対する信頼度を示す信頼スコアを提供します。これらの信頼スコアを評価し、ユースケースに適した信頼しきい値を特定します。特定のコンプライアンスのユースケースについては、追加で人間によるレビューまたはその他の手法を使用して、検出された PHI の精度を確認することをお勧めします。

HIPAA 法では、18 個の識別子のリストに基づいた PHI を特に注意して扱う必要があります。Amazon Comprehend Medical は、これらの識別子に関連付けられたエンティティを検出しますが、これらのエンティティはセーフハーバー方式で指定されているリストに 1 対 1 でマッピングされません。すべての識別子が構造化されていない臨床テキストに含まれるわけではありませんが、Amazon Comprehend Medical は関連するすべての識別子に対応しています。これらの識別子は、以下のリストを含め、個々の患者を特定するために使用できるデータで構成されています。詳細については、米国政府の Health and Human Services ウェブサイトの [Health Information Privacy](https://www.hhs.gov/hipaa/for-professionals/privacy/special-topics/de-identification/index.html) を参照してください。**

PHI 関連の各エンティティには、Amazon Comprehend Medical が検出精度に対して持っている信頼レベルを示すスコア (レスポンス内の `Score`) が含まれます。ユースケースに適した信頼しきい値を特定し、それを満たしていないエンティティを除外します。PHI の存在を特定するときは、フィルタリングに低い信頼しきい値を使用して、より多くの数の検出されたエンティティをキャプチャすることをお勧めします。これは、コンプライアンスのユースケースで検出されたエンティティの値を使用しない場合に、特に当てはまります。

以下の PHI 関連エンティティは、**DetectPHI** オペレーションまたは **DetectEntitiesV2** オペレーションを実行することにより検出できます。


**検出される PHI エンティティ**  

|  エンティティ  |  説明  |  HIPAA カテゴリ  | 
| --- | --- | --- | 
|  AGE  |  患者、家族、または記録に関係しているそれ以外の人について、記載された年齢のすべての構成要素、年齢層、および年齢。特に明記されていない限り、デフォルトは年単位です。  |  3. 個人に関連する日付  | 
| DATE | 患者または患者ケアに関連する日付。 | 3. 個人に関連する日付 | 
|  NAME  |  臨床ノートに記載されているすべての名前。通常、患者、家族、または医療提供者に属する名前。  |  1. 名前  | 
|  PHONE\$1OR\$1FAX  |  電話、ファックス、ポケットベル。1-800-QUIT-NOW や 911 などの名前付き電話番号は除きます。  |  4. Phone number (電話番号) 5. ファックス番号  | 
|  EMAIL  |  E メールアドレス。  |  6. [E メールアドレス]  | 
|  ID  |  患者の身元に関連付けられた、あらゆる種類の番号。これには、社会保障番号、医療記録番号、施設識別番号、臨床試験番号、証明書番号や免許証番号、車両番号や機器番号が含まれます。また、生体認証番号、およびケアの場所や医療提供者を識別する番号も含まれます。  |  7. 社会保障番号  8. 医療記録番号 9. 健康保険番号 10. 口座番号 11. 証明書/免許証番号 12. 車両識別番号 13. 機器番号 16. バイオメトリック情報 18。その他の識別特性  | 
|  [URL]  |  任意のウェブ URL。  |  14. URL  | 
|  ADDRESS  |  これには、施設、名前付き医療施設、または施設内の病棟の住所のすべての地域区分が含まれます。  |  2. 地理的場所  | 
|  PROFESSION  |  患者または患者の家族に関連する、臨床記録に記載された職業または雇用主が含まれます。  |  18。その他の識別特性  | 



**例**  


テキスト「Patient is John Smith, a 48-year-old teacher and resident of Seattle, Washington.」(患者は 48 歳の教師でワシントン州シアトルの居住者であるジョン・スミスです) 上のリクエストは次のオブジェクトを返します。
+ 「John Smith」 (ジョン・スミス) を `PROTECTED_HEALTH_INFORMATION` カテゴリのタイプ `NAME` のエンティティとして返します。**
+ 「48」を `PROTECTED_HEALTH_INFORMATION` カテゴリのタイプ `AGE` のエンティティとして返します。**
+ 「teacher」(教師) を `PROTECTED_HEALTH_INFORMATION` カテゴリのタイプ `PROFESSION` (識別特性) のエンティティとして返します。**
+ 「Seattle, Washington」(ワシントン州シアトル) を `PROTECTED_HEALTH_INFORMATION` カテゴリの `ADDRESS` エンティティとして返します。**

Amazon Comprehend Medical コンソールでは、次のように表示されます。

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


**DetectPHI** オペレーションを使用する場合、レスポンスは次のようになります。**StartPHIDetectionJob** オペレーションを使用する場合、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": []
}
```

# テキスト分析バッチ API
<a name="textanalysis-batchapi"></a>

Amazon Comprehend Medical を使用して、Amazon S3 バケットに保存されている医療テキストを分析します。1 つのバッチで最大 10 GB のドキュメントを分析します。コンソールを使用してバッチ分析ジョブを作成および管理するか、またはバッチ API を使用して保護医療情報 (PHI) などの医療エンティティを検出します。API は、継続中のバッチ分析ジョブの開始、停止、一覧表示、および説明を実行します。

 バッチ分析およびその他の Amazon Comprehend Medical オペレーションの価格情報については、[こちら](https://aws.amazon.com/comprehend/medical/pricing/)を参照してください。

## 重要な注意点
<a name="important-notice"></a>

Amazon Comprehend Medical のバッチ分析オペレーションは、専門家による医療の助言、診断、または治療の代用品ではありません。ユースケースに適した信頼しきい値を特定し、高い精度を必要とする状況では高い信頼しきい値を使用してください。特定のユースケースでは、適切な訓練を受けたレビュー担当者によって人的に結果を見直し、検証する必要があります。Amazon Comprehend Medical のすべてのオペレーションは、訓練を受けた医療専門家による正確さと健全な医療判断の確認後、患者ケアのシナリオでのみ使用してください。

## API を使用したバッチ分析の実行
<a name="performing-batch-api"></a>

バッチ分析ジョブは、Amazon Comprehend Medical コンソールまたは Amazon Comprehend Medical バッチ API を使用して実行できます。

**前提条件**

 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. 新しい分析ジョブを開始するには、StartEntitiesDetectionV2Job オペレーションまたは StartPHIDetectionJob オペレーションを使用します。ジョブを開始するときに、入力ファイルが含まれた入力 S3 バケットの名前を Amazon Comprehend Medical に指定し、バッチ分析後にファイルを書き込む出力 S3 バケットを指定します。

1. コンソールを使用するか、DescribeEntitiesDetectionV2Job オペレーションまたは DescribePHIDetectionJob オペレーションを使用して、ジョブの進行状況を監視します。また、ListEntitiesDetectionV2Jobs および ListPHIDetectionJobs を使用して、オントロジーリンクのすべてのバッチ分析ジョブのステータスを確認できます。

1. 進行中のジョブを停止する必要がある場合は、StopEntitiesDetectionV2Job または StopPHIDetectionJob を使用して分析を停止します。

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 バッチ API を呼び出す 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 は、バッチ内の入力ファイルごとに 1 つの出力ファイルを作成します。ファイルの拡張子は `.out` です。Amazon Comprehend Medical は、まず、*AwsAccountId*-*JobType*-*JobId* を名前にして出力 S3 バケット内にディレクトリを作成し、バッチのすべての出力ファイルをこのディレクトリに書き込みます。Amazon Comprehend Medical は、ジョブの出力が別のジョブの出力を上書きしないように、この新しいディレクトリを作成します。

バッチオペレーションの出力では、同期オペレーションと同じ出力が生成されます。Amazon Comprehend Medical によって生成される出力の例については、「[エンティティの検出 (バージョン 2)](textanalysis-entitiesv2.md)」を参照してください。

バッチオペレーションごとに、ジョブに関する情報が含まれた 3 つのマニフェストファイルが生成されます。
+ `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"
  }, 
  { ...}
  ]
}
```