Package ai.extend.resources.file.requests

Class FileGetRequest

java.lang.Object

ai.extend.resources.file.requests.FileGetRequest

public final class FileGetRequest
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FileGetRequest.Builder

Method Summary

Modifier and Type	Method	Description
static FileGetRequest.Builder	builder()
boolean	equals(java.lang.Object other)
java.util.Map<java.lang.String,java.lang.Object>	getAdditionalProperties()
java.util.Optional<java.lang.Boolean>	getHtml()
java.util.Optional<java.lang.Boolean>	getMarkdown()
java.util.Optional<java.lang.Boolean>	getRawText()
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getRawText

public java.util.Optional<java.lang.Boolean> getRawText()

Returns:

If set to true, the raw text content of the file will be included in the response. This is useful for indexing text-based files like PDFs, Word Documents, etc.

getMarkdown

public java.util.Optional<java.lang.Boolean> getMarkdown()

Returns:

If set to true, the markdown content of the file will be included in the response. This is useful for indexing very clean content into RAG pipelines for files like PDFs, Word Documents, etc.

Only available for files with a type of PDF, IMG, or .doc/.docx files that were auto-converted to PDFs.

getHtml

public java.util.Optional<java.lang.Boolean> getHtml()

Returns:

If set to true, the html content of the file will be included in the response. This is useful for indexing html content into RAG pipelines.

Only available for files with a type of DOCX.

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

getAdditionalProperties

public java.util.Map<java.lang.String,java.lang.Object> getAdditionalProperties()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

builder

public static FileGetRequest.Builder builder()