全部產品
Search

搜尋本產品

    ：GetUploadDocumentJob - 擷取上傳文檔任務

    文件中心

    ：GetUploadDocumentJob - 擷取上傳文檔任務

    更新時間：Mar 21, 2026

    通過JobId擷取非同步上傳文檔的任務的進度和結果。

    介面說明

    此介面為 UploadDocumentAsync 的相關介面。可通過 UploadDocumentAsync 建立一個上傳任務，並得到一個 JobId，然後通過此介面查看 Job 的執行資訊。

    說明

    使用建議

    • 按照文檔複雜度和切分後的向量條數評估逾時，一般不超過 2 小時。

    調試

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

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    gpdb:GetUploadDocumentJob

    create

    *Document

    acs:gpdb:{#regionId}:{#accountId}:document/{#DBInstanceId}

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    DBInstanceId

    string

    是

    開啟了向量引擎最佳化的執行個體 ID。

    說明

    您可以調用 DescribeDBInstances 介面查看目標地區下所有的 AnalyticDB PostgreSQL 執行個體的詳情，包括執行個體 ID。

    gp-xxxxxxxxx
    Namespace

    string

    否

    命名空間，用於租戶隔離，預設為 public。

    說明

    可以通過 CreateNamespace 建立，通過 ListNamespaces 介面查看列表。

    mynamespace
    Collection

    string

    是

    文件庫名稱。

    說明

    由 CreateDocumentCollection 介面建立。您可以調用 ListDocumentCollections 介面查看已經建立的文件庫。

    document
    RegionId

    string

    是

    執行個體所在地區 ID。

    cn-hangzhou
    NamespacePassword

    string

    是

    命名空間對應的密碼。

    說明

    本值為 CreateNamespace 介面指定。

    testpassword
    JobId

    string

    是

    上傳文檔的任務 ID，由UploadDocumentAsync介面獲得。

    bf8f7bc4-9276-44f7-9c22-1d06edc8dfd1

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    RequestId

    string

    請求 ID。

    ABB39CC3-4488-4857-905D-2E4A051D0521
    Message

    string

    介面返回詳細資料。

    success
    Status

    string

    此介面狀態，取值說明：

    • success：成功。

    • fail：失敗。

    success
    Job

    object

    上傳文檔的任務的詳細資料。

    Id

    string

    Job ID。

    231460f8-75dc-405e-a669-0c5204887e91
    Completed

    boolean

    操作是否完成。

    false
    CreateTime

    string

    任務建立時間。

    2024-01-08 16:52:04.864664
    UpdateTime

    string

    任務更新時間。

    2024-01-08 16:53:04.864664
    Status

    string

    任務狀態。取值說明：

    • Success：成功。

    • Failed：失敗，失敗原因可查看 Error 欄位。

    • Cancelling：正在取消中。

    • Cancelled：已取消。

    • Start：開始。

    • Running：執行中。

    • Pending：等待中。

    Running
    Error

    string

    當前操作異常或者失敗時的錯誤資訊。

    Failed to connect database.
    Progress

    integer

    上傳進度，此數值為進度百分比，值為 100 時表示完成。

    20
    ErrorCode

    string

    錯誤碼。

    InternalError
    ChunkResult

    object

    切分結果。

    ChunkFileUrl

    string

    切分後的檔案連結，有效期間為 2h。檔案格式為 JSONL，每一行的格式為{"page_content":"*****", "metadata": {"**":"***","**":"***"}

    http://xxx/test.jsonl
    PlainChunkFileUrl

    string

    切分後的不帶 metadata 的檔案連結，有效期間為 2h。檔案格式為純文字，每一行為一條切分塊。此檔案可方便的用於 embedding。

    http://xxx/test.txt
    DocumentLoaderResultFileUrl

    string

    ADBPGLoader 文檔解析的 markdown 結果檔案，有效期間為 2h。

    http://oss.xxx/adbpg_loader_result.md
    Usage

    object

    文檔理解或 Embedding 消耗的 token 或條數。

    EmbeddingTokens

    integer

    向量化時使用的 token 數。

    說明

    token 是指將輸入的文本分割成的最小單位；token 可以是一個單詞、一個片語、一個標點符號、一個字元等。

    475
    EmbeddingEntries

    integer

    向量化時使用的條目數。

    10

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
  "Message": "success",
  "Status": "success",
  "Job": {
    "Id": "231460f8-75dc-405e-a669-0c5204887e91",
    "Completed": false,
    "CreateTime": "2024-01-08 16:52:04.864664",
    "UpdateTime": "2024-01-08 16:53:04.864664",
    "Status": "Running",
    "Error": "Failed to connect database.",
    "Progress": 20,
    "ErrorCode": "InternalError"
  },
  "ChunkResult": {
    "ChunkFileUrl": "http://xxx/test.jsonl",
    "PlainChunkFileUrl": "http://xxx/test.txt",
    "DocumentLoaderResultFileUrl": "http://oss.xxx/adbpg_loader_result.md"
  },
  "Usage": {
    "EmbeddingTokens": 475,
    "EmbeddingEntries": 10
  }
}

    錯誤碼

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

    變更歷史

    更多資訊，參考變更詳情。