Neptune ML 推論端點 API - Amazon Neptune

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

Neptune ML 推論端點 API

推論端點動作:

CreateMLEndpoint (動作)

        此 API 的 AWS CLI 名稱是:create-ml-endpoint

建立新的 Neptune ML 推論端點,此推論端點可讓您查詢模型訓練程序所建構的特定模型。請參閱使用端點命令管理推論端點

在已啟用 IAM 身分驗證的 Neptune 叢集中調用此操作時,發出請求的 IAM 使用者或角色必須附加一個政策,在該叢集中允許 neptune-db:CreateMLEndpoint IAM 動作。

請求

  • id (在 CLI 中:--id) – 字串,類型為:string (UTF-8 編碼的字串)。

    新推論端點的唯一識別符。預設值為自動產生的時間戳記名稱。

  • instanceCount (在 CLI 中:--instance-count) – 整數,類型為:integer (帶正負號的 32 位元整數)。

    要部署到端點進行預測的 Amazon EC2 執行個體數量下限。預設為 1

  • instanceType (在 CLI 中:--instance-type) – 字串,類型為:string (UTF-8 編碼的字串)。

    用於線上服務的 Neptune ML 執行個體類型。預設值為 ml.m5.xlarge。為推論端點選擇 ML 執行個體,取決於任務類型、圖形大小以及您的預算。

  • mlModelTrainingJobId (在 CLI 中:--ml-model-training-job-id) – 字串,類型為:string (UTF-8 編碼的字串)。

    已完成模型訓練工作的工作 ID,該工作已建立推論端點將指向的模型。您必須提供 mlModelTrainingJobIdmlModelTransformJobId

  • mlModelTransformJobId (在 CLI 中:--ml-model-transform-job-id) – 字串,類型為:string (UTF-8 編碼的字串)。

    已完成模型轉換工作的工作 ID。您必須提供 mlModelTrainingJobIdmlModelTransformJobId

  • modelName (在 CLI 中:--model-name) – 字串,類型為:string (UTF-8 編碼的字串)。

    用於訓練的模型類型。根據預設,Neptune ML 模型會自動以資料處理中使用的 modelType 為基礎,但您可以在這裡指定不同的模型類型。預設值為 rgcn 用於異質圖和 kge 用於知識圖譜。異質圖的唯一有效值是 rgcn。知識圖譜的有效值為:kgetransedistmult、和 rotate

  • neptuneIamRoleArn (在 CLI 中:--neptune-iam-role-arn) – 字串,類型為:string (UTF-8 編碼的字串)。

    IAM 角色的 ARN,此角色可讓 Neptune 存取 SageMaker 和 Amazon S3 資源。這必須列示在您的資料庫叢集參數群組中,否則會擲回錯誤。

  • update (在 CLI 中:--update) – 布林值,類型為:boolean (布林值 (true 或 false))。

    如果設定為 trueupdate 指示這是更新請求。預設值為 false。您必須提供 mlModelTrainingJobIdmlModelTransformJobId

  • volumeEncryptionKMSKey (在 CLI 中:--volume-encryption-kms-key) – 字串,類型為:string (UTF-8 編碼的字串)。

    SageMaker 用來加密儲存磁碟區上資料的 Amazon Key Management Service (Amazon KMS) 金鑰,而該儲存磁碟區附加到執行訓練工作的 ML 運算執行個體。預設值為 None (無)。

回應

  • arn – 字串,類型為:string (UTF-8 編碼的字串)。

    新推論端點的 ARN。

  • creationTimeInMillis - Long 整數,類型為:long (帶有正負號的 64 位元整數)。

    端點建立時間,以毫秒為單位。

  • id – 字串,類型為:string (UTF-8 編碼的字串)。

    新推論端點的唯一 ID。

ListMLEndpoints (動作)

        此 API 的 AWS CLI 名稱是:list-ml-endpoints

列出現有的推論端點。請參閱使用端點命令管理推論端點

在已啟用 IAM 身分驗證的 Neptune 叢集中調用此操作時,發出請求的 IAM 使用者或角色必須附加一個政策,在該叢集中允許 neptune-db:ListMLEndpoints IAM 動作。

請求

  • maxItems (在 CLI 中:--max-items) – ListMLEndpointsInputMaxItemsInteger,類型為:integer (帶有正負號的 32 位元整數),不小於 1 或大於 1024 ?st?s。

    要傳回的項目數目上限 (從 1 到 1024;預設值為 10)。

  • neptuneIamRoleArn (在 CLI 中:--neptune-iam-role-arn) – 字串,類型為:string (UTF-8 編碼的字串)。

    IAM 角色的 ARN,此角色可讓 Neptune 存取 SageMaker 和 Amazon S3 資源。這必須列示在您的資料庫叢集參數群組中,否則會發生錯誤。

回應

  • ids – 字串,類型為:string (UTF-8 編碼的字串)。

    來自推論端點 ID 清單的頁面。

GetMLEndpoint (動作)

        此 API 的 AWS CLI 名稱是:get-ml-endpoint

擷取有關推論端點的詳細資訊。請參閱使用端點命令管理推論端點

在已啟用 IAM 身分驗證的 Neptune 叢集中調用此操作時,發出請求的 IAM 使用者或角色必須附加一個政策,在該叢集中允許 neptune-db:GetMLEndpointStatus IAM 動作。

請求

  • id (在 CLI 中:--id) – 必要:字串,類型為:string (UTF-8 編碼的字串)。

    推論端點的唯一識別符。

  • neptuneIamRoleArn (在 CLI 中:--neptune-iam-role-arn) – 字串,類型為:string (UTF-8 編碼的字串)。

    IAM 角色的 ARN,此角色可讓 Neptune 存取 SageMaker 和 Amazon S3 資源。這必須列示在您的資料庫叢集參數群組中,否則會發生錯誤。

回應

  • endpointMlResourceDefinition 物件。

    端點定義。

  • endpointConfigMlConfigDefinition 物件。

    端點組態

  • id – 字串,類型為:string (UTF-8 編碼的字串)。

    推論端點的唯一識別符。

  • status – 字串,類型為:string (UTF-8 編碼的字串)。

    推論端點的狀態。

DeleteMLEndpoint (動作)

        此 API 的 AWS CLI 名稱是:delete-ml-endpoint

取消建立 Neptune ML 推論端點。請參閱使用端點命令管理推論端點

在已啟用 IAM 身分驗證的 Neptune 叢集中調用此操作時,發出請求的 IAM 使用者或角色必須附加一個政策,在該叢集中允許 neptune-db:DeleteMLEndpoint IAM 動作。

請求

  • clean (在 CLI 中:--clean) – 布林值,類型為:boolean (布林值 (true 或 false))。

    如果此旗標設定為 TRUE,則應在工作停止時刪除所有 Neptune ML S3 成品。預設值為 FALSE

  • id (在 CLI 中:--id) – 必要:字串,類型為:string (UTF-8 編碼的字串)。

    推論端點的唯一識別符。

  • neptuneIamRoleArn (在 CLI 中:--neptune-iam-role-arn) – 字串,類型為:string (UTF-8 編碼的字串)。

    IAM 角色的 ARN,此角色可讓 Neptune 存取 SageMaker 和 Amazon S3 資源。這必須列示在您的資料庫叢集參數群組中,否則會擲回錯誤。

回應

  • status – 字串,類型為:string (UTF-8 編碼的字串)。

    取消的狀態。