StructuredExtractionRequest

public final class StructuredExtractionRequest

Describes a structured data extraction request for . Carries a schema envelope — {"schema": } — describing the fields the extracted data must conform to, and optional free-form instructions that steer the extraction. The envelope's schema member is a standard JSON Schema object — typically an object root whose properties carry a description telling the extractor what to put there. The envelope shape matches what schema generation produces, so a generated result can be passed straight through; an envelope constraints member is accepted and reserved for future post-extraction validation (it is not evaluated yet). Provider, model, endpoint, and confidence reporting are controlled separately via AiProcessingSettings on the document's settings.

Constructors

Link copied to clipboard

Functions

Link copied to clipboard
public final String getInstructions()
Optional natural-language instructions that steer the extraction: disambiguation rules, formatting preferences, or domain context — anything you'd tell a colleague doing the extraction by hand.
Link copied to clipboard
public final String getSchema()
The schema envelope as a JSON string: {"schema": }.
Link copied to clipboard
public final void setInstructions(String value)
Optional natural-language instructions that steer the extraction: disambiguation rules, formatting preferences, or domain context — anything you'd tell a colleague doing the extraction by hand.
Link copied to clipboard
public final void setSchema(String value)
The schema envelope as a JSON string: {"schema": }.