Package ai.extend.types

Class File

java.lang.Object

ai.extend.types.File

public final class File
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	File._FinalStage
static class	File.Builder
static interface	File.CreatedAtStage
static interface	File.IdStage
static interface	File.MetadataStage
static interface	File.NameStage
static interface	File.UpdatedAtStage

Method Summary

Modifier and Type	Method	Description
static File.IdStage	builder()
boolean	equals(java.lang.Object other)
java.util.Map<java.lang.String,java.lang.Object>	getAdditionalProperties()
java.util.Optional<FileContents>	getContents()
java.time.OffsetDateTime	getCreatedAt()
java.lang.String	getId()
FileMetadata	getMetadata()
java.lang.String	getName()
java.lang.String	getObject()
java.util.Optional<java.lang.String>	getParentFileId()
java.util.Optional<java.lang.String>	getPresignedUrl()
java.util.Optional<FileType>	getType()
java.time.OffsetDateTime	getUpdatedAt()
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getObject

public java.lang.String getObject()

Returns:

The type of object. Will always be "file".

getId

public java.lang.String getId()

Returns:

ID for the file.

Example: "file_xK9mLPqRtN3vS8wF5hB2cQ"

getName

public java.lang.String getName()

Returns:

The name of the file

Example: "Invoices.pdf"

getType

public java.util.Optional<FileType> getType()

Returns:

The type of the file.

Availability: Present when the file type could be determined.

getPresignedUrl

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

Returns:

A presigned URL to download the file. Expires after 15 minutes.

Availability: Present on GET /files/{id}. Not present on POST /files/upload or when the file is embedded in other resources (e.g., in run responses).

getParentFileId

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

Returns:

ID of the parent file.

Availability: Present for files created via a Splitter in a workflow.

getContents

public java.util.Optional<FileContents> getContents()

Returns:

Deprecated: Use the POST /parse_runs endpoint instead to parse and retrieve file contents. The parse runs endpoint provides more control over parsing configuration and better performance.

The parsed content of the file. This field will only contain data after the file has been parsed via a parse run, extract run, classify run, split run, edit run, or workflow run.

Availability: Only present and populated on GET /files/{id} when the file has been previously parsed and the corresponding query parameters are set to true. Will be null on POST /files/upload and for files that haven't been parsed. The structure varies based on file type.

getMetadata

public FileMetadata getMetadata()

getCreatedAt

public java.time.OffsetDateTime getCreatedAt()

getUpdatedAt

public java.time.OffsetDateTime getUpdatedAt()

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 File.IdStage builder()