Package ai.extend.types

Class File.Builder

java.lang.Object

ai.extend.types.File.Builder

All Implemented Interfaces:

File._FinalStage, File.CreatedAtStage, File.IdStage, File.MetadataStage, File.NameStage, File.UpdatedAtStage

Enclosing class:

File

public static final class File.Builder
extends java.lang.Object
implements File.IdStage, File.NameStage, File.MetadataStage, File.CreatedAtStage, File.UpdatedAtStage, File._FinalStage

Method Summary

Modifier and Type	Method	Description
File	build()
File._FinalStage	contents(Nullable<FileContents> contents)	Deprecated: Use the POST /parse_runs endpoint instead to parse and retrieve file contents.
File._FinalStage	contents(FileContents contents)	Deprecated: Use the POST /parse_runs endpoint instead to parse and retrieve file contents.
File._FinalStage	contents(java.util.Optional<FileContents> contents)	Deprecated: Use the POST /parse_runs endpoint instead to parse and retrieve file contents.
File.UpdatedAtStage	createdAt(java.time.OffsetDateTime createdAt)
File.Builder	from(File other)
File.NameStage	id(java.lang.String id)	ID for the file.
File.CreatedAtStage	metadata(FileMetadata metadata)
File.MetadataStage	name(java.lang.String name)	The name of the file
File._FinalStage	parentFileId(Nullable<java.lang.String> parentFileId)	ID of the parent file.
File._FinalStage	parentFileId(java.lang.String parentFileId)	ID of the parent file.
File._FinalStage	parentFileId(java.util.Optional<java.lang.String> parentFileId)	ID of the parent file.
File._FinalStage	presignedUrl(Nullable<java.lang.String> presignedUrl)	A presigned URL to download the file.
File._FinalStage	presignedUrl(java.lang.String presignedUrl)	A presigned URL to download the file.
File._FinalStage	presignedUrl(java.util.Optional<java.lang.String> presignedUrl)	A presigned URL to download the file.
File._FinalStage	type(Nullable<FileType> type)	The type of the file.
File._FinalStage	type(FileType type)	The type of the file.
File._FinalStage	type(java.util.Optional<FileType> type)	The type of the file.
File._FinalStage	updatedAt(java.time.OffsetDateTime updatedAt)

Methods inherited from class java.lang.Object

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

Method Detail

from

public File.Builder from(File other)

Specified by:

from in interface File.IdStage

id

public File.NameStage id(@NotNull
                         java.lang.String id)

ID for the file.

Example: "file_xK9mLPqRtN3vS8wF5hB2cQ"

ID for the file.

Example: "file_xK9mLPqRtN3vS8wF5hB2cQ"

Specified by:

id in interface File.IdStage

Returns:

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

name

public File.MetadataStage name(@NotNull
                               java.lang.String name)

The name of the file

Example: "Invoices.pdf"

The name of the file

Example: "Invoices.pdf"

Specified by:

name in interface File.NameStage

Returns:

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

metadata

public File.CreatedAtStage metadata(@NotNull
                                    FileMetadata metadata)

Specified by:

metadata in interface File.MetadataStage

createdAt

public File.UpdatedAtStage createdAt(@NotNull
                                     java.time.OffsetDateTime createdAt)

Specified by:

createdAt in interface File.CreatedAtStage

updatedAt

public File._FinalStage updatedAt(@NotNull
                                  java.time.OffsetDateTime updatedAt)

Specified by:

updatedAt in interface File.UpdatedAtStage

contents

public File._FinalStage contents(Nullable<FileContents> contents)

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.

Specified by:

contents in interface File._FinalStage

Returns:

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

contents

public File._FinalStage contents(FileContents contents)

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.

Specified by:

contents in interface File._FinalStage

Returns:

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

contents

public File._FinalStage contents(java.util.Optional<FileContents> contents)

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.

Specified by:

contents in interface File._FinalStage

parentFileId

public File._FinalStage parentFileId(Nullable<java.lang.String> parentFileId)

ID of the parent file.

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

Specified by:

parentFileId in interface File._FinalStage

Returns:

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

parentFileId

public File._FinalStage parentFileId(java.lang.String parentFileId)

ID of the parent file.

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

Specified by:

parentFileId in interface File._FinalStage

Returns:

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

parentFileId

public File._FinalStage parentFileId(java.util.Optional<java.lang.String> parentFileId)

ID of the parent file.

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

Specified by:

parentFileId in interface File._FinalStage

presignedUrl

public File._FinalStage presignedUrl(Nullable<java.lang.String> presignedUrl)

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).

Specified by:

presignedUrl in interface File._FinalStage

Returns:

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

presignedUrl

public File._FinalStage presignedUrl(java.lang.String presignedUrl)

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).

Specified by:

presignedUrl in interface File._FinalStage

Returns:

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

presignedUrl

public File._FinalStage presignedUrl(java.util.Optional<java.lang.String> presignedUrl)

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).

Specified by:

presignedUrl in interface File._FinalStage

type

public File._FinalStage type(Nullable<FileType> type)

The type of the file.

Availability: Present when the file type could be determined.

Specified by:

type in interface File._FinalStage

Returns:

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

type

public File._FinalStage type(FileType type)

The type of the file.

Availability: Present when the file type could be determined.

Specified by:

type in interface File._FinalStage

Returns:

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

type

public File._FinalStage type(java.util.Optional<FileType> type)

The type of the file.

Availability: Present when the file type could be determined.

Specified by:

type in interface File._FinalStage

build

public File build()

Specified by:

build in interface File._FinalStage