Skip to main content
知識庫

GetIndexJobStatus

查詢指定的知識庫建立任務或知識庫追加任務的目前狀態。

介面說明

  • RAM 使用者（子帳號）需要首先取得阿里雲百煉的 API 權限（AliyunBailianDataFullAccess或AliyunBailianDataReadOnlyAccess均可，已包括 sfm:GetIndexJobStatus 權限點），並加入一個業務空間後，方可呼叫本介面。阿里雲帳號（主帳號）可直接呼叫無須授權。建議您透過最新版阿里雲百煉 SDK來呼叫本介面。
  • 您需要有一個正在執行中的知識庫作業任務（建立知識庫任務可以呼叫 SubmitIndexJob 介面，建立知識庫追加任務可以呼叫 SubmitIndexAddDocumentsJob 介面），並且取得相應的JobId。
  • 本介面呼叫間隔建議在 5 秒以上。
  • 本介面具有冪等性。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：
  • 操作：是指具體的許可權點。
  • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
  • 資源類型：是指操作中支援授權的資源類型。具體說明如下：
    • 對於必選的資源類型，用前面加 * 表示。
    • 對於不支援資源級授權的操作，用全部資源表示。
  • 條件關鍵字：是指雲產品自身定義的條件關鍵字。
  • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

sfm:GetIndexJobStatus

get

*All Resource

*

無無

請求文法 

GET /{WorkspaceId}/index/job/status HTTP/1.1

路徑參數

名稱

類型

必填

描述

樣本值

WorkspaceId

string

是

業務空間 ID，請確保您要操作的知識庫在此業務空間中。取得方式請參見如何使用業務空間。

llm-3z7uw7fwz0vexxxx

請求參數

名稱

類型

必填

描述

樣本值

JobId

string

是

知識庫作業任務 ID，即 SubmitIndexJob 介面或 SubmitIndexAddDocumentsJob 介面返回的Data.Id。

20230718xxxx-146c93bf

IndexId

string

是

知識庫 ID，即 CreateIndex 介面返回的Data.Id。

79c0alxxxx

PageNumber

integer

否

SubmitIndexJob 介面和 SubmitIndexAddDocumentsJob 介面均支援批次匯入檔案。本介面返回的欄位包括知識庫作業任務的總狀態Status及各檔案匯入的狀態Document.Status。若檔案較多，可透過PageNumber參數進行分頁查詢。起始值為 1，預設值為 1。

1

pageSize

integer

否

指定分頁查詢時每頁展示的檔案匯入任務數量。最大值不限。預設值為 10。

10

返回參數

名稱

類型

描述

樣本值

object

Schema of Response

Code

string

錯誤狀態碼。

Index.Forbidden

Data

object

介面業務資料欄位。

Documents

array<object>

本次匯入的檔案列表。

object

檔案物件。

Code

string

錯誤狀態碼。

Index.Document.ChunkError

DocId

string

檔案 ID。

file_9a65732555b54d5ea10796ca5742ba22_xxxxxxxx

DocName

string

檔案名稱。

XXX产品介绍

Message

string

錯誤資訊。

document parse error

Status

string

檔案匯入狀態。可能值：

  • INSERT_ERROR：檔案匯入失敗。

  • RUNNING：檔案匯入中。

  • DELETED：檔案已刪除。

  • FINISH：檔案匯入成功。

RUNNING

GmtModified

integer

JobId

string

作業任務 ID。

66122af12a4e45ddae6bd6c84555xxxx

Status

string

知識庫作業任務的目前狀態。可能值：

  • COMPLETED：執行成功。

  • FAILED：執行失敗。

  • RUNNING：執行中。

  • PENDING：等待執行。

枚舉值：

  • COMPLETED :

    執行成功。

  • FAILED :

    執行失敗。

  • RUNNING :

    執行中。

  • PENDING :

    等待執行。

PENDING

Message

string

錯誤資訊。

User not authorized to operate on the specified resource.

RequestId

string

請求 ID。

17204B98-xxxx-4F9A-8464-2446A84821CA

Status

string

介面返回的狀態碼。

200

Success

boolean

介面呼叫是否成功，可能值為：

  • true：成功。

  • false：失敗。

true

樣本

正常返回樣本 JSON格式 
{
  "Code": "Index.Forbidden",
  "Data": {
    "Documents": [
      {
        "Code": "Index.Document.ChunkError",
        "DocId": "file_9a65732555b54d5ea10796ca5742ba22_xxxxxxxx",
        "DocName": "XXX产品介绍",
        "Message": "document parse error",
        "Status": "RUNNING",
        "GmtModified": 0
      }
    ],
    "JobId": "66122af12a4e45ddae6bd6c84555xxxx",
    "Status": "PENDING"
  },
  "Message": "User not authorized to operate on the specified resource.",
  "RequestId": "17204B98-xxxx-4F9A-8464-2446A84821CA",
  "Status": "200",
  "Success": true
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。
應用調用
應用組件
Assistant API（下線中）
更多