全部產品
Search

搜尋本產品

    ：DescribeDocument - 查看文檔詳細資料

    文件中心

    ：DescribeDocument - 查看文檔詳細資料

    更新時間：Mar 21, 2026

    查看文檔詳細資料。

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    gpdb:DescribeDocument

    create

    *Document

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

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    DBInstanceId

    string

    是

    執行個體 ID。

    說明

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

    gp-xxxxxxxxx
    Namespace

    string

    否

    命名空間，預設為 public。

    說明

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

    mynamespace
    NamespacePassword

    string

    是

    命名空間對應的密碼。

    說明

    本值為 CreateNamespace 介面指定。

    testpassword
    Collection

    string

    是

    文件庫名稱。

    說明

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

    document
    RegionId

    string

    是

    執行個體所在 Region ID。

    cn-hangzhou
    FileName

    string

    是

    文檔名。

    說明

    可以通過 ListDocuments 介面查看文檔列表。

    music.txt

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    RequestId

    string

    請求 ID。

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

    string

    介面返回詳細資料。

    success
    Status

    string

    API 執行狀態，取值如下：

    • success：執行成功。

    • fail：執行失敗。

    success
    FileName

    string

    檔案名稱。

    music.txt
    FileExt

    string

    副檔名。

    txt
    FileVersion

    integer

    文檔版本。每次更新上傳同一文檔時，此值會+1。

    1
    FileMtime

    string

    文檔最新修改時間。

    2023-11-01 10:01:01.123456
    Source

    string

    文檔來源。

    OSS

    DocumentLoader

    string

    文檔載入器名稱。

    RapidOCRPDFLoader
    TextSplitter

    string

    文檔切分器名稱。

    ChineseRecursiveTextSplitter
    FileSize

    integer

    檔案大小，單位為位元組。

    10000
    FileMd5

    string

    檔案 MD5 值。

    b8078c9591413550f8963e37e24abcea
    DocsCount

    integer

    文檔被切分的數量。

    100
    FileUrl

    string

    文檔的下載地址，有效期間為 2h。

    http://oss.xxx/music.txt
    PlainChunkFileUrl

    string

    被切分後的純文字(不帶 Metadata)下載地址，每行是一個 chunk，有效期間為 2h。

    http://oss.xxx/music_plain_chunk.txt
    ChunkFileUrl

    string

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

    http://oss.xxx/music_chunk.jsonl
    DocumentLoaderResultFileUrl

    string

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

    http://oss.xxx/adbpg_loader_result.md

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
  "Message": "success",
  "Status": "success",
  "FileName": "music.txt",
  "FileExt": "txt",
  "FileVersion": 1,
  "FileMtime": "2023-11-01 10:01:01.123456",
  "Source": "OSS\n",
  "DocumentLoader": "RapidOCRPDFLoader",
  "TextSplitter": "ChineseRecursiveTextSplitter",
  "FileSize": 10000,
  "FileMd5": "b8078c9591413550f8963e37e24abcea",
  "DocsCount": 100,
  "FileUrl": "http://oss.xxx/music.txt",
  "PlainChunkFileUrl": "http://oss.xxx/music_plain_chunk.txt",
  "ChunkFileUrl": "http://oss.xxx/music_chunk.jsonl",
  "DocumentLoaderResultFileUrl": "http://oss.xxx/adbpg_loader_result.md"
}

    錯誤碼

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

    變更歷史

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