Package ai.extend.types

Class FileContents.Builder

java.lang.Object

ai.extend.types.FileContents.Builder

Enclosing class:

FileContents

public static final class FileContents.Builder
extends java.lang.Object

Method Summary

Modifier and Type	Method	Description
FileContents	build()
FileContents.Builder	from(FileContents other)
FileContents.Builder	pages(java.util.List<FileContentsPagesItem> pages)
FileContents.Builder	pages(java.util.Optional<java.util.List<FileContentsPagesItem>> pages)	Page-level content for document file types.
FileContents.Builder	rawText(java.lang.String rawText)
FileContents.Builder	rawText(java.util.Optional<java.lang.String> rawText)	The raw text content of the file.
FileContents.Builder	sections(java.util.List<FileContentsSectionsItem> sections)
FileContents.Builder	sections(java.util.Optional<java.util.List<FileContentsSectionsItem>> sections)	Section-level content for documents that support section-based chunking.
FileContents.Builder	sheets(java.util.List<FileContentsSheetsItem> sheets)
FileContents.Builder	sheets(java.util.Optional<java.util.List<FileContentsSheetsItem>> sheets)	Sheet-level content for spreadsheet file types.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

from

public FileContents.Builder from(FileContents other)

rawText

public FileContents.Builder rawText(java.util.Optional<java.lang.String> rawText)

The raw text content of the file. Available for all file types when the rawText query parameter is set to true.

• PDF/IMG: Concatenated raw text from all pages
• DOCX: The document's raw text
• CSV: Concatenated chunks or CSV text
• EXCEL: Not included (use sheets instead)
• TXT/XML/HTML: The file's text content

rawText

public FileContents.Builder rawText(java.lang.String rawText)

pages

public FileContents.Builder pages(java.util.Optional<java.util.List<FileContentsPagesItem>> pages)

Page-level content for document file types.

• PDF/IMG: Contains pageNumber, pageHeight, pageWidth, and markdown (if markdown query param is true)
• DOCX: Contains pageNumber and html (if html query param is true)
• Other file types: Empty array

pages

public FileContents.Builder pages(java.util.List<FileContentsPagesItem> pages)

sections

public FileContents.Builder sections(java.util.Optional<java.util.List<FileContentsSectionsItem>> sections)

Section-level content for documents that support section-based chunking. Available for PDF and IMG file types.

sections

public FileContents.Builder sections(java.util.List<FileContentsSectionsItem> sections)

sheets

public FileContents.Builder sheets(java.util.Optional<java.util.List<FileContentsSheetsItem>> sheets)

Sheet-level content for spreadsheet file types. Available for EXCEL files.

sheets

public FileContents.Builder sheets(java.util.List<FileContentsSheetsItem> sheets)

build

public FileContents build()