Package ai.extend.resources.extractors.requests

Class ExtractorsCreateRequest

java.lang.Object

ai.extend.resources.extractors.requests.ExtractorsCreateRequest

public final class ExtractorsCreateRequest
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ExtractorsCreateRequest._FinalStage
static class	ExtractorsCreateRequest.Builder
static interface	ExtractorsCreateRequest.NameStage

Method Summary

Modifier and Type	Method	Description
static ExtractorsCreateRequest.NameStage	builder()
boolean	equals(java.lang.Object other)
java.util.Map<java.lang.String,java.lang.Object>	getAdditionalProperties()
java.util.Optional<java.lang.String>	getCloneExtractorId()
java.util.Optional<ExtractConfigJson>	getConfig()
java.util.Optional<ExtractorsCreateRequestGenerate>	getGenerate()
java.lang.String	getName()
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getName

public java.lang.String getName()

Returns:

The name of the extractor.

getCloneExtractorId

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

Returns:

The ID of an existing extractor to clone. If provided, the new extractor will be created with the same config as the extractor with this ID. Cannot be provided together with config or generate.

Example: "ex_BMdfq_yWM3sT-ZzvCnA3f"

getConfig

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

Returns:

The configuration for the extractor. Cannot be provided together with cloneExtractorId or generate.

getGenerate

public java.util.Optional<ExtractorsCreateRequestGenerate> getGenerate()

Returns:

If provided, an extraction schema is automatically generated from the supplied sample documents and applied to the extractor's draft. The response includes the extractor with the generated schema already in place.

Cannot be provided together with config or cloneExtractorId.

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 ExtractorsCreateRequest.NameStage builder()