Neptune ML 推理端点 API - Amazon Neptune
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅 中国的 Amazon Web Services 服务入门 (PDF)

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

Neptune ML 推理端点 API

推理端点操作:

CreateMLEndpoint(操作)

        此 API 的 Amazon 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。知识图谱的有效值为:kgetransedistmultrotate

  • neptuneIamRoleArn(在 CLI 中:--neptune-iam-role-arn)– 一个字符串,类型为:string(UTF-8 编码的字符串)。

    向 Neptune 提供对 SageMaker 和 Amazon S3 资源的访问权限的 IAM 角色的 ARN。必须将其列在您的数据库集群参数组中,否则将引发错误。

  • update(在 CLI 中:--update)– 一个布尔值,类型为:boolean [布尔值(true 或 false)]。

    如果设置为 true,则 update 表示这是更新请求。默认为 false。您必须提供 mlModelTrainingJobIdmlModelTransformJobId

  • volumeEncryptionKMSKey(在 CLI 中:--volume-encryption-kms-key)– 一个字符串,类型为:string(UTF-8 编码的字符串)。

    Amazon Key Management Service (Amazon KMS) 密钥,SageMaker 使用它来加密连接到运行训练任务的 ML 计算实例的存储卷上的数据。默认值为 None (无)。

响应

  • arn – 一个字符串,类型为:string(UTF-8 编码的字符串)。

    新推理端点的 ARN。

  • creationTimeInMillis – 长整型,类型为:long(有符号的 64 位整数)。

    端点创建时间,以毫秒为单位。

  • id – 一个字符串,类型为:string(UTF-8 编码的字符串)。

    新推理端点的唯一 ID。

ListMLEndpoints(操作)

        此 API 的 Amazon CLI 名称为:list-ml-endpoints

列出现有的推理端点。请参阅使用端点命令管理推理端点

在启用了 IAM 身份验证的 Neptune 集群中调用此操作时,发出请求的 IAM 用户或角色必须附加允许在该集群中执行 neptune-db:ListMLEndpoints IAM 操作的策略。

请求

  • maxItems(在 CLI 中:--max-items)– ListMLEndpointsInputMaxItemsInteger,类型为:integer(带符号的 32 位整数),不小于 1 或大于 1024。

    要返回的最大项目数(从 1 到 1024;默认值为 10)。

  • neptuneIamRoleArn(在 CLI 中:--neptune-iam-role-arn)– 一个字符串,类型为:string(UTF-8 编码的字符串)。

    向 Neptune 提供对 SageMaker 和 Amazon S3 资源的访问权限的 IAM 角色的 ARN。必须将其列在您的数据库集群参数组中,否则将发生错误。

响应

  • ids – 一个字符串,类型为:string(UTF-8 编码的字符串)。

    推理端点 ID 列表中的一页。

GetMLEndpoint(操作)

        此 API 的 Amazon 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 编码的字符串)。

    向 Neptune 提供对 SageMaker 和 Amazon S3 资源的访问权限的 IAM 角色的 ARN。必须将其列在您的数据库集群参数组中,否则将发生错误。

响应

  • endpoint – 一个 MlResourceDefinition 对象。

    端点定义。

  • endpointConfig – 一个 MlConfigDefinition 对象。

    端点配置。

  • id – 一个字符串,类型为:string(UTF-8 编码的字符串)。

    推理端点的唯一标识符。

  • status – 一个字符串,类型为:string(UTF-8 编码的字符串)。

    推理端点的状态。

DeleteMLEndpoint(操作)

        此 API 的 Amazon 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 编码的字符串)。

    向 Neptune 提供对 SageMaker 和 Amazon S3 资源的访问权限的 IAM 角色的 ARN。必须将其列在您的数据库集群参数组中,否则将引发错误。

响应

  • status – 一个字符串,类型为:string(UTF-8 编码的字符串)。

    取消的状态。