Retrieve Full Document Content | PrivateGPT

Retrieve the full content of filtered documents. This endpoint provides access to complete document content rather than semantic chunks. Use this when you need the entire context of documents rather than relevant excerpts. Key Features: - Full Content: Get complete documents rather than chunks - Multiple Formats: Return as markdown text or structured objects - Node Type Filtering: Include or exclude images, tables, and other node types - Node ID Filtering: Retrieve specific sections by their node IDs - Filtered Retrieval: Select specific documents using metadata filters - Bulk Retrieval: Get multiple documents in one request Format Options: - markdown (default): Returns flattened markdown text representation - object: Returns hierarchical tree structure with typed nodes Content Filtering: - Use include to retrieve only specific node types - Use exclude to omit unwanted content types - Use node_ids to retrieve specific sections or nodes by ID - Supports TextNode, ImageNode, TableNode, and other node types Subtree Filtering: - Specify node_ids to retrieve only certain sections/nodes - Set include_children=True (default) to get full subtrees - Set include_children=False to get only specified nodes - Set include_ancestors=True to include parent context Notes: - Node type filtering is applied to all retrieved documents - Object format preserves document structure and hierarchy - Markdown format provides a flattened, readable text representation - When node_ids is specified, returns filtered tree structure

Retrieve the full content of filtered documents.

This endpoint provides access to complete document content rather than semantic chunks. Use this when you need the entire context of documents rather than relevant excerpts.

Key Features:

Full Content: Get complete documents rather than chunks
Multiple Formats: Return as markdown text or structured objects
Node Type Filtering: Include or exclude images, tables, and other node types
Node ID Filtering: Retrieve specific sections by their node IDs
Filtered Retrieval: Select specific documents using metadata filters
Bulk Retrieval: Get multiple documents in one request

Format Options:

markdown (default): Returns flattened markdown text representation
object: Returns hierarchical tree structure with typed nodes

Content Filtering:

Use include to retrieve only specific node types
Use exclude to omit unwanted content types
Use node_ids to retrieve specific sections or nodes by ID
Supports TextNode, ImageNode, TableNode, and other node types

Subtree Filtering:

Specify node_ids to retrieve only certain sections/nodes
Set include_children=True (default) to get full subtrees
Set include_children=False to get only specified nodes
Set include_ancestors=True to include parent context

Notes:

Node type filtering is applied to all retrieved documents
Object format preserves document structure and hierarchy
Markdown format provides a flattened, readable text representation
When node_ids is specified, returns filtered tree structure

Request

This endpoint expects an object.

context_filterobjectRequired

Filter to select documents to retrieve. Supports filtering by collection, artifacts, and metadata.

formatenumOptional

Format for returned content. 'object' returns structured data, 'markdown' returns content formatted as markdown text.

Allowed values:

filterobjectOptional

Content filtering options to include or exclude specific node types. Use this to control the types of content returned in the response.

max_tokensintegerOptional>=1

Maximum number of tokens to return in the content. If not set, returns full content of the documents.

Response

This endpoint returns an object.

datalist of objects

List of documents with their full content

Errors

401

Unauthorized

422

Unprocessable Entity