取得文件內容¶
GET /documents/{document_id}/contents/¶
Retrieve contents of a document by its ID.
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.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
document_id |
path | integer | yes | The ID of the document to retrieve contents for. |
start_chunk |
query | integer | Indicate the starting chunk that you want to retrieve. If not specified, the default value is 0. | |
end_chunk |
query | integer | 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.404— Document not found.500— Internal server error.
範例請求¶
curl -X GET
"https://api.rememberizer.ai/api/v1/documents/12345/contents/?start_chunk=0&end_chunk=20"
-H "Authorization: Bearer YOUR_JWT_TOKEN"
Info
將 YOUR_JWT_TOKEN 替換為您的實際 JWT 令牌,並將 12345 替換為實際的文件 ID。
const getDocumentContents = async (documentId, startChunk = 0, endChunk = 20) => {
const url = new URL(`https://api.rememberizer.ai/api/v1/documents/${documentId}/contents/`);
url.searchParams.append('start_chunk', startChunk);
url.searchParams.append('end_chunk', endChunk);
const response = await fetch(url.toString(), {
method: 'GET',
headers: {
'Authorization': 'Bearer YOUR_JWT_TOKEN'
}
});
const data = await response.json();
console.log(data);
// 如果還有更多的區塊,您可以獲取它們
if (data.end_chunk < totalChunks) {
// 獲取下一組區塊
await getDocumentContents(documentId, data.end_chunk, data.end_chunk + 20);
}
};
getDocumentContents(12345);
Info
將 YOUR_JWT_TOKEN 替換為您的實際 JWT 令牌,並將 12345 替換為實際的文件 ID。
import requests
def get_document_contents(document_id, start_chunk=0, end_chunk=20):
headers = {
"Authorization": "Bearer YOUR_JWT_TOKEN"
}
params = {
"start_chunk": start_chunk,
"end_chunk": end_chunk
}
response = requests.get(
f"https://api.rememberizer.ai/api/v1/documents/{document_id}/contents/",
headers=headers,
params=params
)
data = response.json()
print(data)
# 如果還有更多的區塊,您可以獲取它們
# 這是一個簡單的範例 - 您可能想要實現一個適當的遞迴檢查
if 'end_chunk' in data and data['end_chunk'] < total_chunks:
get_document_contents(document_id, data['end_chunk'], data['end_chunk'] + 20)
get_document_contents(12345)
Info
將 YOUR_JWT_TOKEN 替換為您的實際 JWT 令牌,並將 12345 替換為實際的文件 ID。
路徑參數¶
| 參數 | 類型 | 描述 |
|---|---|---|
| document_id | 整數 | 必填。 要檢索內容的文件 ID。 |
查詢參數¶
| 參數 | 類型 | 描述 |
|---|---|---|
| start_chunk | 整數 | 起始區塊索引。預設為 0。 |
| end_chunk | 整數 | 結束區塊索引。預設為 start_chunk + 20。 |
回應格式¶
錯誤回應¶
| 狀態碼 | 描述 |
|---|---|
| 404 | 文件未找到 |
| 500 | 內部伺服器錯誤 |
大型文件的分頁¶
對於大型文件,內容被拆分成多個區塊。您可以通過多次請求來檢索完整文件:
- 先發送一個請求,設置
start_chunk=0 - 使用返回的
end_chunk值作為下一個請求的start_chunk - 繼續進行,直到檢索到所有區塊
此端點返回文件的原始文本內容,允許您訪問完整信息以進行詳細處理或分析。