檢索文件內容

Retrieve contents of a document by its ID.

get

Returns the content of the document with the specified ID, along with the index of the latest retrieved chunk. Each call fetches up to 20 chunks. To get more, use the end_chunk value from the response as the start_chunk for the next call.

Path parameters
document_idintegerRequired

The ID of the document to retrieve contents for.

Query parameters
start_chunkintegerOptional

Indicate the starting chunk that you want to retrieve. If not specified, the default value is 0.

end_chunkintegerOptional

Indicate the ending chunk that you want to retrieve. If not specified, the default value is start_chunk + 20.

Responses
200
Content of the document and index of the latest retrieved chunk.
application/json
get
GET /api/v1/documents/{document_id}/contents/ HTTP/1.1
Host: api.rememberizer.ai
Accept: */*
{
  "content": "text",
  "end_chunk": 20
}

範例請求

curl -X GET \
  "https://api.rememberizer.ai/api/v1/documents/12345/contents/?start_chunk=0&end_chunk=20" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

YOUR_JWT_TOKEN 替換為您的實際 JWT 令牌,並將 12345 替換為實際的文件 ID。

路徑參數

參數
類型
描述

document_id

整數

必填。 要檢索內容的文件 ID。

查詢參數

參數
類型
描述

start_chunk

整數

起始區塊索引。預設為 0。

end_chunk

整數

結束區塊索引。預設為 start_chunk + 20。

回應格式

{
  "content": "文件片段的完整文本內容...",
  "end_chunk": 20
}

錯誤回應

狀態碼
描述

404

文件未找到

500

內部伺服器錯誤

大型文件的分頁

對於大型文件,內容被拆分成多個區塊。您可以通過多次請求來檢索完整文件:

  1. 先發送一個請求,設置 start_chunk=0

  2. 使用返回的 end_chunk 值作為下一個請求的 start_chunk

  3. 繼續進行,直到檢索到所有區塊

此端點返回文件的原始文本內容,允許您訪問完整信息以進行詳細處理或分析。

Last updated