Nutrient Java SDK/io.nutrient.sdk.requests/SchemaGenerationRequest

SchemaGenerationRequest

public final class SchemaGenerationRequest

Describes a schema generation request for . Carries the document type the schema must represent, an optional free-form requirement, and up to five example documents that ground the schema in real layouts. The example documents are treated as representative samples of future documents the schema has to fit — not as an exhaustive list. The shape of the generated schema (field budget, nesting, target structured-output dialect) is controlled separately via SchemaGenerationSettings.

Constructors

public void SchemaGenerationRequest()

Functions

addExampleDocument

public final void addExampleDocument(Document document)

Adds an example document to the request.

getDocumentType

public final String getDocumentType()

The class of documents the schema must represent (for example, "invoice" or "lab report").

getRequirement

public final String getRequirement()

Optional natural-language description of what the schema must capture: fields of interest, granularity, naming preferences, or anything else an extraction engineer would tell a colleague.

setDocumentType

public final void setDocumentType(String value)

The class of documents the schema must represent (for example, "invoice" or "lab report").

setRequirement

public final void setRequirement(String value)

Optional natural-language description of what the schema must capture: fields of interest, granularity, naming preferences, or anything else an extraction engineer would tell a colleague.