Package ai.extend.requests

Class ExtractRequest

java.lang.Object

ai.extend.requests.ExtractRequest

public final class ExtractRequest
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ExtractRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ExtractRequest.Builder	builder()
boolean	equals(java.lang.Object other)
java.util.Map<java.lang.String,java.lang.Object>	getAdditionalProperties()
java.util.Optional<ExtractConfigJson>	getConfig()
java.util.Optional<ExtractRequestExtractor>	getExtractor()
java.util.Optional<ExtractRequestFile>	getFile()
java.util.Optional<java.util.Map<java.lang.String,java.lang.Object>>	getMetadata()
java.util.Optional<MultiFileRunPackage>	getPackage()
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getExtractor

public java.util.Optional<ExtractRequestExtractor> getExtractor()

Returns:

Reference to an existing extractor. Mutually exclusive with config — provide one or the other, or omit both to have Extend infer a schema from the document.

getConfig

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

Returns:

Inline extract configuration. Mutually exclusive with extractor — provide one or the other, or omit both to have Extend infer a schema from the document.

getFile

public java.util.Optional<ExtractRequestFile> getFile()

Returns:

The file to be extracted from. Mutually exclusive with package — provide one or the other.

Files can be provided as a URL, Extend file ID, or raw text.

getPackage

public java.util.Optional<MultiFileRunPackage> getPackage()

Returns:

A collection of files to extract from together in a single run. Mutually exclusive with file — provide one or the other.

See Multifile Extraction for details.

getMetadata

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

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