문서 내용 검색¶
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로 사용합니다. - 모든 청크를 검색할 때까지 계속합니다.
이 엔드포인트는 문서의 원시 텍스트 콘텐츠를 반환하여, 자세한 처리나 분석을 위해 전체 정보를 액세스할 수 있도록 합니다.