StructuredExtractionRequest

Describes a structured data extraction request for ExtractStructured. Carries a schema envelope — {"schema": <JSON 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.

using Nutrient;

Construction

public StructuredExtractionRequest()

Properties

Instructions

public string Instructions { get; set; }

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.

Type: string

Schema

public string Schema { get; set; }

The schema envelope as a JSON string: {"schema": <JSON Schema>}. Required. The inner schema describes the fields to extract; each property’s description tells the extractor what belongs there. An envelope constraints member is accepted and reserved for future post-extraction validation.

Type: string

Resource management

public void Dispose()

StructuredExtractionRequest implements IDisposable. Call Dispose() or use a C# using declaration to release its native handle right away. If you don’t, the handle is released when the object is garbage collected.