Package ai.extend.types

Class FileContentsPagesItem.Builder

java.lang.Object

ai.extend.types.FileContentsPagesItem.Builder

All Implemented Interfaces:

FileContentsPagesItem._FinalStage, FileContentsPagesItem.PageNumberStage

Enclosing class:

FileContentsPagesItem

public static final class FileContentsPagesItem.Builder
extends java.lang.Object
implements FileContentsPagesItem.PageNumberStage, FileContentsPagesItem._FinalStage

Method Summary

Modifier and Type	Method	Description
FileContentsPagesItem	build()
FileContentsPagesItem.Builder	from(FileContentsPagesItem other)
FileContentsPagesItem._FinalStage	html(java.lang.String html)	Cleaned and structured html content of the page.
FileContentsPagesItem._FinalStage	html(java.util.Optional<java.lang.String> html)	Cleaned and structured html content of the page.
FileContentsPagesItem._FinalStage	markdown(java.lang.String markdown)	Cleaned and structured markdown content of this page.
FileContentsPagesItem._FinalStage	markdown(java.util.Optional<java.lang.String> markdown)	Cleaned and structured markdown content of this page.
FileContentsPagesItem._FinalStage	pageHeight(java.lang.Double pageHeight)
FileContentsPagesItem._FinalStage	pageHeight(java.util.Optional<java.lang.Double> pageHeight)
FileContentsPagesItem._FinalStage	pageNumber(int pageNumber)	The page number of this page in the document.
FileContentsPagesItem._FinalStage	pageWidth(java.lang.Double pageWidth)
FileContentsPagesItem._FinalStage	pageWidth(java.util.Optional<java.lang.Double> pageWidth)
FileContentsPagesItem._FinalStage	rawText(java.lang.String rawText)	The raw text content extracted from this page.
FileContentsPagesItem._FinalStage	rawText(java.util.Optional<java.lang.String> rawText)	The raw text content extracted from this page.

Methods inherited from class java.lang.Object

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

Method Detail

from

public FileContentsPagesItem.Builder from(FileContentsPagesItem other)

Specified by:

from in interface FileContentsPagesItem.PageNumberStage

pageNumber

public FileContentsPagesItem._FinalStage pageNumber(int pageNumber)

The page number of this page in the document.

The page number of this page in the document.

Specified by:

pageNumber in interface FileContentsPagesItem.PageNumberStage

Returns:

Reference to this so that method calls can be chained together.

html

public FileContentsPagesItem._FinalStage html(java.lang.String html)

Cleaned and structured html content of the page. Available for DOCX file types (that were not auto-converted to PDFs). Only included if the html query parameter is set to true in the endpoint request.

Specified by:

html in interface FileContentsPagesItem._FinalStage

Returns:

Reference to this so that method calls can be chained together.

html

public FileContentsPagesItem._FinalStage html(java.util.Optional<java.lang.String> html)

Cleaned and structured html content of the page. Available for DOCX file types (that were not auto-converted to PDFs). Only included if the html query parameter is set to true in the endpoint request.

Specified by:

html in interface FileContentsPagesItem._FinalStage

markdown

public FileContentsPagesItem._FinalStage markdown(java.lang.String markdown)

Cleaned and structured markdown content of this page.

Specified by:

markdown in interface FileContentsPagesItem._FinalStage

Returns:

Reference to this so that method calls can be chained together.

markdown

public FileContentsPagesItem._FinalStage markdown(java.util.Optional<java.lang.String> markdown)

Cleaned and structured markdown content of this page.

Specified by:

markdown in interface FileContentsPagesItem._FinalStage

rawText

public FileContentsPagesItem._FinalStage rawText(java.lang.String rawText)

The raw text content extracted from this page.

Specified by:

rawText in interface FileContentsPagesItem._FinalStage

Returns:

Reference to this so that method calls can be chained together.

rawText

public FileContentsPagesItem._FinalStage rawText(java.util.Optional<java.lang.String> rawText)

The raw text content extracted from this page.

Specified by:

rawText in interface FileContentsPagesItem._FinalStage

pageWidth

public FileContentsPagesItem._FinalStage pageWidth(java.lang.Double pageWidth)

Specified by:

pageWidth in interface FileContentsPagesItem._FinalStage

pageWidth

public FileContentsPagesItem._FinalStage pageWidth(java.util.Optional<java.lang.Double> pageWidth)

Specified by:

pageWidth in interface FileContentsPagesItem._FinalStage

pageHeight

public FileContentsPagesItem._FinalStage pageHeight(java.lang.Double pageHeight)

Specified by:

pageHeight in interface FileContentsPagesItem._FinalStage

pageHeight

public FileContentsPagesItem._FinalStage pageHeight(java.util.Optional<java.lang.Double> pageHeight)

Specified by:

pageHeight in interface FileContentsPagesItem._FinalStage

build

public FileContentsPagesItem build()

Specified by:

build in interface FileContentsPagesItem._FinalStage