npm 包 @arkie-ai/job-manager-client 使用教程

阅读时长 5 分钟读完

简介

@arkie-ai/job-manager-client 是一个 npm 包,提供了与 Arkie AI 任务管理器(Job Manager)交互的功能。使用该包可以方便地向 Job Manager 提交任务、获取任务状态以及取消任务等操作。

安装

使用 npm 安装 @arkie-ai/job-manager-client:

使用方法

第一步:创建 Job Manager 客户端

在使用 @arkie-ai/job-manager-client 之前,需要先创建一个 Job Manager 客户端。创建方式如下:

endpoint 是 Job Manager 的 API 地址,apiToken 是 API 认证令牌。创建成功后,客户端即可用于与 Job Manager 进行交互。

第二步:提交任务

使用客户端的 submitJob 方法提交任务。示例代码如下:

submitJob 方法接收三个参数:任务名称、任务类型以及任务参数。参数示例中,parameters 是一个对象,包含了任务所需的输入参数。

提交成功后,submitJob 方法会返回一个 jobInfo 对象,包含了任务的状态、任务 ID 等信息。可以用这些信息查询任务状态或取消任务。

第三步:查询任务状态

使用客户端的 getJob 方法查询任务状态。示例代码如下:

getJob 方法接收一个参数:任务 ID。该方法会返回一个 jobInfo 对象,包含了任务的状态、任务 ID 等信息。

第四步:取消任务

使用客户端的 cancelJob 方法取消任务。示例代码如下:

cancelJob 方法接收一个参数:任务 ID。

示例代码

下面是一个完整的示例代码,演示了如何使用 @arkie-ai/job-manager-client 提交任务、查询任务状态以及取消任务。

-- -------------------- ---- -------
----- - ---------------------- - - ----------------------------------------

----- -------- - --------------------------------------
----- -------- - -----------------

----- ------ - ------------------------ --------- -------- ---

-- ----
----- ---------- - - ----------- ------------------------------ --
----- ------- - ----- -------------------------- ------------------- ------------

-- ------
--- ------ - ---------------
----- ------- --- --------- -- ------ --- ---------- -
  ----- --- --------------- -- ------------------- -------
  ----- -------------- - ----- -----------------------------
  ------ - ----------------------
-
---------------- ---------------- -------- ---- ------ ------------

-- ----
----- --------------------------------
展开代码

总结

@arkie-ai/job-manager-client 为 Arkie AI 任务管理器的使用提供了便捷的 API,使得开发者可以轻松地将任务提交、查询任务状态以及取消任务。使用方法简单、易于理解,同时支持异步操作,非常适合在前端应用中使用。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/112258