Package ai.extend.resources.files.requests

Class FilesRetrieveRequest

java.lang.Object

ai.extend.resources.files.requests.FilesRetrieveRequest

public final class FilesRetrieveRequest
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FilesRetrieveRequest.Builder

Method Summary

Modifier and Type	Method	Description
static FilesRetrieveRequest.Builder	builder()
boolean	equals(java.lang.Object other)
java.util.Map<java.lang.String,java.lang.Object>	getAdditionalProperties()
java.util.Optional<java.lang.String>	getExtendWorkspaceId()
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

getExtendWorkspaceId

public java.util.Optional<java.lang.String> getExtendWorkspaceId()

Returns:

The workspace ID to target. Required when using an organization-scoped API key; optional for workspace-scoped keys (the key is already tied to a workspace). See Authentication for details on API key scopes.

getRawText

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

Returns:

Deprecated: Use POST /parse_runs instead to parse file contents and get contents or GET /parse_runs/{id} to retrieve the results async if file is already parsed. Files parsed with versions >2.x will not support this parameter.

If set to true, the raw text content of the file will be included in the response.

getMarkdown

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

Returns:

Deprecated: Use POST /parse_runs instead to parse file contents and get contents or GET /parse_runs/{id} to retrieve the results async if file is already parsed. Files parsed with versions >2.x will not support this parameter.

If set to true, the markdown content of the file will be included in the response.

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

getHtml

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

Returns:

Deprecated: Use POST /parse_runs instead to parse file contents and get contents or GET /parse_runs/{id} to retrieve the results async if file is already parsed. Files parsed with versions >2.x will not support this parameter.

If set to true, the html content of the file will be included in the response.

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 FilesRetrieveRequest.Builder builder()