Package ai.extend.resources.extractors.requests

Class ExtractorsCreateRequest.Builder

java.lang.Object

ai.extend.resources.extractors.requests.ExtractorsCreateRequest.Builder

All Implemented Interfaces:

ExtractorsCreateRequest._FinalStage, ExtractorsCreateRequest.NameStage

Enclosing class:

ExtractorsCreateRequest

public static final class ExtractorsCreateRequest.Builder
extends java.lang.Object
implements ExtractorsCreateRequest.NameStage, ExtractorsCreateRequest._FinalStage

Method Summary

Modifier and Type	Method	Description
ExtractorsCreateRequest	build()
ExtractorsCreateRequest._FinalStage	cloneExtractorId(java.lang.String cloneExtractorId)	The ID of an existing extractor to clone.
ExtractorsCreateRequest._FinalStage	cloneExtractorId(java.util.Optional<java.lang.String> cloneExtractorId)	The ID of an existing extractor to clone.
ExtractorsCreateRequest._FinalStage	config(ExtractConfigJson config)	The configuration for the extractor.
ExtractorsCreateRequest._FinalStage	config(java.util.Optional<ExtractConfigJson> config)	The configuration for the extractor.
ExtractorsCreateRequest.Builder	from(ExtractorsCreateRequest other)
ExtractorsCreateRequest._FinalStage	generate(ExtractorsCreateRequestGenerate generate)	If provided, an extraction schema is automatically generated from the supplied sample documents and applied to the extractor's draft.
ExtractorsCreateRequest._FinalStage	generate(java.util.Optional<ExtractorsCreateRequestGenerate> generate)	If provided, an extraction schema is automatically generated from the supplied sample documents and applied to the extractor's draft.
ExtractorsCreateRequest._FinalStage	name(java.lang.String name)	The name of the extractor.

Methods inherited from class java.lang.Object

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

Method Detail

from

public ExtractorsCreateRequest.Builder from(ExtractorsCreateRequest other)

Specified by:

from in interface ExtractorsCreateRequest.NameStage

name

public ExtractorsCreateRequest._FinalStage name(@NotNull
                                                java.lang.String name)

The name of the extractor.

The name of the extractor.

Specified by:

name in interface ExtractorsCreateRequest.NameStage

Returns:

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

generate

public ExtractorsCreateRequest._FinalStage generate(ExtractorsCreateRequestGenerate generate)

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.

Specified by:

generate in interface ExtractorsCreateRequest._FinalStage

Returns:

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

generate

public ExtractorsCreateRequest._FinalStage generate(java.util.Optional<ExtractorsCreateRequestGenerate> generate)

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.

Specified by:

generate in interface ExtractorsCreateRequest._FinalStage

config

public ExtractorsCreateRequest._FinalStage config(ExtractConfigJson config)

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

Specified by:

config in interface ExtractorsCreateRequest._FinalStage

Returns:

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

config

public ExtractorsCreateRequest._FinalStage config(java.util.Optional<ExtractConfigJson> config)

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

Specified by:

config in interface ExtractorsCreateRequest._FinalStage

cloneExtractorId

public ExtractorsCreateRequest._FinalStage cloneExtractorId(java.lang.String cloneExtractorId)

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"

Specified by:

cloneExtractorId in interface ExtractorsCreateRequest._FinalStage

Returns:

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

cloneExtractorId

public ExtractorsCreateRequest._FinalStage cloneExtractorId(java.util.Optional<java.lang.String> cloneExtractorId)

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"

Specified by:

cloneExtractorId in interface ExtractorsCreateRequest._FinalStage

build

public ExtractorsCreateRequest build()

Specified by:

build in interface ExtractorsCreateRequest._FinalStage