ドキュメントの内容を取得

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