Package ai.extend.requests

Class ParseRequest

java.lang.Object

ai.extend.requests.ParseRequest

public final class ParseRequest
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ParseRequest._FinalStage
static class	ParseRequest.Builder
static interface	ParseRequest.FileStage

Method Summary

Modifier and Type	Method	Description
static ParseRequest.FileStage	builder()
boolean	equals(java.lang.Object other)
java.util.Map<java.lang.String,java.lang.Object>	getAdditionalProperties()
java.util.Optional<ParseConfig>	getConfig()
java.util.Optional<DataRetention>	getDataRetention()
java.util.Optional<java.lang.String>	getExtendWorkspaceId()
ParseRequestFile	getFile()
java.util.Optional<java.util.Map<java.lang.String,java.lang.Object>>	getMetadata()
java.util.Optional<ParseRequestResponseType>	getResponseType()
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.

getResponseType

public java.util.Optional<ParseRequestResponseType> getResponseType()

Returns:

Controls the format of the response chunks. Defaults to json if not specified.

• json - Returns parsed outputs in the response body
• url - Return a presigned URL to the parsed content in the response body

getFile

public ParseRequestFile getFile()

Returns:

The file to be parsed. Files can be provided as a URL or an Extend file ID.

getConfig

public java.util.Optional<ParseConfig> getConfig()

getMetadata

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

getDataRetention

public java.util.Optional<DataRetention> getDataRetention()

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 ParseRequest.FileStage builder()