

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

# Amazon Rekognition 自訂標籤 API 參考
<a name="custom-labels-api-reference"></a>

Amazon Rekognition 自訂標籤 API 會記錄成為 Amazon Rekognition API 參考內容的一部份。這是 Amazon Rekognition 自訂標籤 API 操作的列表，其中包括指向對應 Amazon Rekognition API 參考主題的連結。此外，本文檔中的 API 參考連結可前往相應的 Amazon Rekognition 開發人員指南 API 的參考主題。如需更多使用 API 的詳細資訊，請參閱 [ 了解 Amazon Rekognition 自訂標籤了解 Amazon Rekognition 自訂標籤  本節提供工作流程的概觀，以訓練並使用 Amazon Rekognition 自訂標籤模型搭配 主控台和 AWS SDK。 Amazon Rekognition 自訂標籤現在可以管理專案內的資料集。您可以使用 主控台和 AWS SDK 為您的專案建立資料集。如果您之前曾使用過 Amazon Rekognition 自訂標籤，您的舊資料集可能需要與新專案建立關聯。如需更多詳細資訊，請參閱 [步驟 6：(可選) 將舊資料集與新專案建立關聯](su-associate-prior-dataset.md)。   決定模型類型  您首先決定要培訓的模型類型，這取決於您的業務目標。例如，您可以培訓模型在社交媒體貼文中尋找您的標誌、識別商店貨架上的產品或對裝配線上的機器零件進行分類。 Amazon Rekognition 自訂標籤可培訓以下類型的模型：  [尋找物件、場景和概念](#tm-classification) [尋找物件位置](#tm-object-localization) [尋找品牌的位置](#tm-brand-detection-localization)  為了協助您決定要培訓的模型類型，Amazon Rekognition 自訂標籤提供您可以使用的範例專案。如需詳細資訊，請參閱[Amazon Rekognition 自訂標籤入門](getting-started.md)。  尋找物件、場景和概念  該模型預測與整個圖像相關聯的物件、場景和概念的分類。例如，您可以訓練一個模型來確定圖像是否包含 *旅遊景點*。如需範例專案，請參閱 [Image classification](getting-started.md#gs-image-classification-example)。下列湖泊影像是您可以辨識物件、場景和概念的影像類型範例。 

![在日落或日出反射雲朵和山脈的陡峭湖。](http://docs.aws.amazon.com/zh_tw/rekognition/latest/customlabels-dg/images/pateros.jpg)
 或者，您可以培訓一個將圖像分類為多個類別的模型。例如，上一張圖像可能具有 *天空顏色*、 *反射* 或 *湖泊* 等類別。如需範例專案，請參閱 [多標籤影像分類](getting-started.md#gs-multi-label-image-classification-example)。   尋找物件位置  該模型會預測圖像上物件的位置。預測包括物件位置的邊界框資訊，以及用來識別邊界框內物件的標籤。例如，下圖顯示了電路板各個部分，例如 *比較器* 或 *電位器* 周圍的邊界框。 

![元件影像顯示電路板上的 IR LED、鍋電阻和比較器晶片。](http://docs.aws.amazon.com/zh_tw/rekognition/latest/customlabels-dg/images/localization-circuit-board.png)
 [物件本地化](getting-started.md#gs-object-localization-example) 的範例專案展示了 Amazon Rekognition 自訂標籤如何使用標籤的邊界框來培訓尋找物件位置的模型。   尋找品牌的位置  Amazon Rekognition 自訂標籤可培訓在圖像上尋找品牌位置（例如商標）的模型。預測包括品牌位置的邊界框資訊，以及用來識別邊界框內物件的標籤。如需範例專案，請參閱 [品牌偵測](getting-started.md#gs-brand-detection-example)。下圖是模型可以偵測的一些品牌的範例。 

![顯示 Lambda 服務將使用者活動饋送至 Amazon Pinpoint 以取得建議的圖表。](http://docs.aws.amazon.com/zh_tw/rekognition/latest/customlabels-dg/images/brand-detection-lambda.png)
    建立模型  建立模型的步驟包括建立專案、建立培訓和測試資料集，以及培訓模型。  建立專案  Amazon Rekognition 自訂標籤專案是建立和管理模型所需的一組資源。專案會管理下列項目：  **資料集** — 用來培訓模型的圖像和圖像標籤。專案備有培訓資料集和測試資料集。 **模型** — 您培訓此軟體來尋找您的業務獨有的概念、場景和物件。您可以在一個專案中擁有多個模型版本。  建議您將專案用於單一使用案例，例如在電路板上尋找電路板零件。 您可以使用 Amazon Rekognition 自訂標籤主控台和 [建立專案](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CreateProject) API 來建立專案。如需詳細資訊，請參閱[建立專案](mp-create-project.md)。   建立培訓和測試資料集  資料集是描述這些影像的一組影像和標籤。在專案中，您可以建立培訓資料集和測試資料集，Amazon Rekognition 自訂標籤會使用它們來培訓和測試模型。 標籤可識別影像中物件周圍的物件、場景、概念或週框方塊。標籤會指定給整個圖像 (*圖像層級*)，或將標籤指定給圍繞圖像物件的邊界框。 如何標記資料集中的圖像，會決定 Amazon Rekognition 自訂標籤所建立的模型類型。例如，若要培訓尋找物件、場景和概念的模型，您可以為培訓和測試資料集中的圖像分配圖像層級標籤。如需詳細資訊，請參閱[規劃資料集](md-dataset-purpose.md)。 圖像必須為 PNG 和 JPEG 格式，並且您應該遵循輸入圖像的建議。如需詳細資訊，請參閱[準備影像](md-prepare-images.md)。  建立培訓和測試資料集 (主控台)  您可以使用單一資料集，或使用個別的培訓和測試資料集來啟動專案。如果您從單一資料集開始，Amazon Rekognition 自訂標籤會在培訓期間分割您的資料集，以便為您的專案建立培訓資料集 (80%) 和測試資料集 (20%)。如果您希望 Amazon Rekognition 自訂標籤決定要用於培訓和測試的圖像，請從單一資料集開始。為了完全控制培訓、測試和效能調整，我們建議您使用個別的培訓和測試資料集來啟動專案。 若要建立專案的資料集，請使用下列其中一種方式匯入圖像：  從本機電腦匯入圖像。 從 S3 儲存貯體匯入圖像。Amazon Rekognition 自訂標籤可以使用包含圖像的資料夾名稱來標記圖像。 匯入 Amazon SageMaker AI Ground Truth 資訊清單檔案。 複製現有 Amazon Rekognition 自訂標籤資料集。  如需詳細資訊，請參閱[建立包含影像的訓練和測試資料集](md-create-dataset.md)。 依據您匯入影像的位置而定，您的影像可能沒有標記。例如，從本機電腦匯入的影像即沒有標記。從 Amazon SageMaker AI Ground Truth 資訊清單檔案匯入的影像會加上標籤。您可以使用 Amazon Rekognition 自訂標籤主控台來新增、變更和分配標籤。如需詳細資訊，請參閱[標記檔案](md-labeling-images.md)。 若要使用主控台建立培訓和測試資料集，請參閱 [建立包含影像的訓練和測試資料集](md-create-dataset.md)。如需包含建立培訓和測試資料集的教學課程，請參閱 [分類映像](tutorial-classification.md)。   建立培訓和測試資料集 (SDK)  若要建立培訓和測試資料集，請使用 `CreateDataset` API。您可以使用 Amazon SageMaker 格式清單檔案或複製現有的 Amazon Rekognition 自訂標籤資料集來建立資料集。如需更多詳細資訊，請參閱 [建立訓練和測試資料集 (SDK)](md-create-dataset.md#cd-create-dataset-sdk)。如有必要，您可以建立自己的清單檔案。如需詳細資訊，請參閱[建立清單檔案](md-create-manifest-file.md)。    培訓模型  使用培訓資料集培訓您的模型。每次培訓模型時，都會建立新版本的模型。在培訓期間，Amazon Rekognition 自訂標籤會測試培訓模型的效能。您可以使用結果來評估和改善模型。培訓需要一段時間才能完成。您只需為成功的模型培訓付費。如需詳細資訊，請參閱[培訓 Amazon Rekognition 自訂標籤模型](training-model.md)。如果模型培訓失敗，Amazon Rekognition 自訂標籤會提供您可以使用的偵錯資訊。如需詳細資訊，請參閱[偵錯失敗的模型訓練](tm-debugging.md)。  培訓模型（主控台）  若要使用主控台培訓模型，請參閱 [培訓模型（主控台）](training-model.md#tm-console)。   培訓模型 (SDK)   您可以呼叫 [建立專案版本](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CreateProjectVersion) 來培訓 Amazon Rekognition 自訂標籤模型。如需詳細資訊，請參閱[培訓模型 (SDK)](training-model.md#tm-sdk)。    改善模型  在測試期間，Amazon Rekognition 自訂標籤會建立評估指標，讓您可以使用這些指標來改善培訓過的模型。  評估模型  使用在測試期間建立的效能指標來評估模型的效能。效能指標 (例如 F1、精確度和召回) 可讓您了解經過訓練的模型的效能，並決定是否準備好在生產中使用它。如需詳細資訊，請參閱[用於評估模型的指標](im-metrics-use.md)。  評估模型 (主控台)  如要檢視效能指標，請參閱 [存取評估指標 (主控台)](im-access-training-results.md)。   評估模型 (SDK)  要獲取效能指標，請呼叫 [描述專案版本](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DescribeProjectVersions) 以獲取測試結果。如需詳細資訊，請參閱[存取 Amazon Rekognition 自訂標籤評估指標 (SDK)](im-metrics-api.md)。測試結果包括主控台中不可用的指標，例如分類結果的混淆矩陣。測試結果以下列格式傳回：  F1 分數 — 代表模型精確度和召回的整體效能的單一值。如需詳細資訊，請參閱[F1](im-metrics-use.md#im-f1-metric)。 摘要檔案位置 — 測試摘要包括整個測試資料集的彙總評估指標，以及每個個別標籤的指標。`DescribeProjectVersions` 傳回摘要檔案的 S3 儲存貯體和資料夾位置。如需詳細資訊，請參閱[存取模型摘要檔案](im-summary-file-api.md)。 評估清單檔案快照位置 — 快照包含有關測試結果的詳細資料，包括信賴度分級和二進制分類測試的結果，例如誤報。`DescribeProjectVersions` 傳回快照檔案的 S3 儲存貯體和資料夾位置。如需詳細資訊，請參閱[解譯評估資訊清單快照](im-evaluation-manifest-snapshot-api.md)。     改善模型  如果需要改進，您可以新增更多培訓圖像或改善資料集標籤。如需詳細資訊，請參閱[改善 Amazon Rekognition 自訂標籤模型](tr-improve-model.md)。您也可以針對模型所做的預測提供意見反饋，並使用它來改善模型。如需詳細資訊，請參閱[使用模型意見回饋改善模型](ex-feedback.md)。  改善模型（主控台）  若要新增影像至資料集，請參閱 [將更多圖像新增至資料集](md-add-images.md)。若要加入或變更標籤，請參閱 [標記檔案](md-labeling-images.md)。 若要重新培訓模型，請參閱 [培訓模型（主控台）](training-model.md#tm-console)。   改善模型 (SDK)  若要將圖像新增至資料集或變更圖像的標籤，請使用 `UpdateDatasetEntries` API。`UpdateDatasetEntries` 更新或將 JSON 文件添加至清單檔案。每個 JSON 文件都包含單一圖像的資訊，例如分配的標籤或邊界框資訊。如需詳細資訊，請參閱[新增更多圖像 (SDK)](md-add-images.md#md-add-images-sdk)。若要檢視資料集中的條目，請使用 `ListDatasetEntries` API。 若要重新培訓模型，請參閱 [培訓模型 (SDK)](training-model.md#tm-sdk-datasets)。     啟動模型  在您可以使用模型之前，請先使用 Amazon Rekognition 自訂標籤主控台或 `StartProjectVersion` API 啟動模型。您需要根據模型執行時間付費。如需詳細資訊，請參閱[執行培訓過的 Amazon Rekognition 自訂標籤模型](running-model.md)。  啟動模型 (主控台)  若要使用主控台啟動模型，請參閱 [啟動 Amazon Rekognition 自訂標籤模型 (主控台)](rm-start.md#rm-start-console)。   啟動模型  您可以呼叫 [啟動模型版本](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartProjectVersion) 來啟動模型。如需詳細資訊，請參閱[啟動 Amazon Rekognition 自訂標籤模型 (SDK)](rm-start.md#rm-start-sdk)。    分析圖像  若要使用模型分析圖像，請使用 `DetectCustomLabels` API。您可以指定本機圖像或存放在 S3 儲存貯體中的圖像。此操作還需要您想要使用的模型的 Amazon Resource Name (ARN)。 如果您的模型找到物件、場景和概念，則回應會包含在圖像中找到的圖像層級標籤清單。例如，下圖展示使用 *Rooms* 範例專案找到的圖像層級標籤。 

![客廳設有火場、棕色沙發、椅子、咖啡桌和牆上的景觀美術。門通往戶外露台。](http://docs.aws.amazon.com/zh_tw/rekognition/latest/customlabels-dg/images/rooms.jpg)
 如果模型找到物件位置，則回應會包含在圖像中找到的已標籤的邊界框清單。週框方塊代表物件在影像上的位置。您可以使用邊界框資訊，在物件周圍繪製邊界框。例如，以下圖像展示了使用 *電路板範例* 專案找到的電路板零件周圍的邊界框。 

![具有 IR LED、光轉換器和電位計進行調整的電路板。](http://docs.aws.amazon.com/zh_tw/rekognition/latest/customlabels-dg/images/circuitboardparts.jpg)
 如需詳細資訊，請參閱[使用經過培訓的模型分析圖像](detecting-custom-labels.md)。   停止模型  您需要根據模型的執行時間付費。如果您不再使用模型，請使用 Amazon Rekognition 自訂標籤主控台或使用 `StopProjectVersion` API 停止模型。如需詳細資訊，請參閱[停止 Amazon Rekognition 自訂標籤模型](rm-stop.md)。  停止模型（主控台）  若要使用主控台停止執行中的模型，請參閱 [停止 Amazon Rekognition 自訂標籤模型 (主控台)](rm-stop.md#rm-stop-console)。   停止模型 (SDK)  若要停止執行中的模型，請呼叫 [停止專案版本](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StopProjectVersion)。如需詳細資訊，請參閱[停止 Amazon Rekognition 自訂標籤模型 (SDK)](rm-stop.md#rm-stop-sdk)。   ](understanding-custom-labels.md)。

## 培訓您的模型
<a name="ref-train-model"></a>

### 專案
<a name="ref-projects"></a>
+ [建立專案](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CreateProject) — 建立您的 Amazon Rekognition 自訂標籤專案，是資源（圖像、標籤、模型）和操作（培訓、評估和偵測）的邏輯分組。
+ [刪除專案](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DeleteProject) — 刪除 Amazon Rekognition 自訂標籤專案。
+ [描述專案](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DescribeProjects) — 傳回所有 Amazon Rekognition 自訂標籤專案的清單。

### 專案政策
<a name="ref-project-policies"></a>
+ [PutProjectPolicy](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_PutProjectPolicy)：將專案政策連接至信任 AWS 帳戶中的 Amazon Rekognition 自訂標籤專案。
+ [列出專案政策](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_ListProjectPolicies) — 傳回附加至專案的專案政策清單。
+ [刪除專案政策](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DeleteProjectPolicy) — 刪除現有的專案政策。

### 資料集
<a name="ref-datasets"></a>
+ [建立資料集](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CreateDataset) — 建立 Amazon Rekognition 自訂標籤資料集。
+ [刪除資料集](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DeleteDataset) — 刪除 Amazon Rekognition 自訂標籤資料集。
+ [描述資料集](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DescribeDataset) — 描述 Amazon Rekognition 自訂標籤資料集。
+ [分佈資料集條目](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DistributeDatasetEntries) — 將培訓資料集中的條目（圖像）分佈至專案的培訓資料集和測試資料集當中。
+ [列出資料集條目](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_ListDatasetEntries) — 傳回 Amazon Rekognition 自訂標籤資料集中的條目（圖像）清單。
+ [列出資料集標籤](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_ListDatasetLabels) — 傳回指派給 Amazon Rekognition 自訂標籤資料集的標籤清單。
+ [更新資料集條目](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_UpdateDatasetEntries) — 新增或更新 Amazon Rekognition 自訂標籤資料集中的條目（圖像）。

### 模型
<a name="ref-models"></a>
+ [建立專案版本](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CreateProjectVersion) — 培訓您的 Amazon Rekognition 自訂標籤模型。
+ [複製專案版本](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CopyProjectVersion) — 複製您的 Amazon Rekognition 自訂標籤模型。
+ [刪除專案版本](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DeleteProjectVersion) — 刪除 Amazon Rekognition 自訂標籤模型。
+ [描述專案版本](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DescribeProjectVersions) — 傳回特定專案中所有 Amazon Rekognition 自訂標籤模型的清單。

### 標籤
<a name="ref-datasets"></a>
+ [標籤資源](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_TagResource) — 將一個或多個鍵/值標籤新增至 Amazon Rekognition 自訂標籤模型。
+ [取消標籤資源](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_UntagResource) — 從 Amazon Rekognition 自訂標籤模型中刪除一個或多個標籤。

## 使用您的模型
<a name="ref-use-model"></a>
+ [偵測自訂標籤](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DetectCustomLabels) — 使用您的自訂標籤模型分析圖像。
+ [啟動專案版本](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartProjectVersion) — 啟動您的自訂標籤模型。
+ [停止專案版本](https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StopProjectVersion) — 停止您的自訂標籤模型。