0
Fork 0
mirror of https://github.com/TanStack/ai.git synced 2026-11-18 19:34:58 +00:00
ai/docs/reference/interfaces/DocumentPart.md
github-actions[bot] f4f32bdcc2
docs: regenerate API documentation (#1195)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
2026-08-22 08:16:20 +00:00

993 B

id title
DocumentPart DocumentPart

Interface: DocumentPart<TMetadata>

Defined in: packages/ai/src/types.ts:300

Document content part for multimodal messages (e.g., PDFs).

Type Parameters

TMetadata

TMetadata = unknown

Provider-specific metadata type (e.g., Anthropic's media_type)

Properties

metadata?

optional metadata?: TMetadata;

Defined in: packages/ai/src/types.ts:305

Provider-specific metadata (e.g., media_type for PDFs)


source

source: ContentPartSource;

Defined in: packages/ai/src/types.ts:303

Source of the document content


type

type: "document";

Defined in: packages/ai/src/types.ts:301