API Reference

Extract

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Validate Extraction Schema

ExtractV2SchemaValidateResponse Extract.ValidateSchema(ExtractValidateSchemaParamsparameters, CancellationTokencancellationToken = default)

POST/api/v2/extract/schema/validation

Validate a JSON schema for extraction.

ParametersExpand Collapse

ExtractValidateSchemaParams parameters

required IReadOnlyDictionary<string, DataSchema?> dataSchema

JSON Schema to validate for use with extract jobs

IReadOnlyDictionary<string, JsonElement>

IReadOnlyList<JsonElement>

string

Double

Boolean

ReturnsExpand Collapse

class ExtractV2SchemaValidateResponse:

Response schema for schema validation.

required IReadOnlyDictionary<string, DataSchema?> DataSchema

Validated JSON Schema, ready for use in extract jobs

One of the following:

IReadOnlyDictionary<string, JsonElement>

IReadOnlyList<JsonElement>

string

Double

Boolean

Validate Extraction Schema

C#

HTTP

TypeScript

Python

Go

Java

C#

CLI Tool

ExtractValidateSchemaParams parameters = new()
{
    DataSchema = new Dictionary<string, DataSchema?>()
    {
        { "properties", new(
            new Dictionary<string, JsonElement>()
            {
                { "invoice_number", JsonSerializer.SerializeToElement("bar") },
                { "line_items", JsonSerializer.SerializeToElement("bar") },
                { "total_amount", JsonSerializer.SerializeToElement("bar") },
                { "vendor_name", JsonSerializer.SerializeToElement("bar") },
            }
        ) },
        { "required", new(

            [
                JsonSerializer.SerializeToElement("invoice_number"),
                JsonSerializer.SerializeToElement("total_amount"),
                JsonSerializer.SerializeToElement("vendor_name"),
            ]
        ) },
        { "type", "object" },
    },
};

var extractV2SchemaValidateResponse = await client.Extract.ValidateSchema(parameters);

Console.WriteLine(extractV2SchemaValidateResponse);

200 example

{
  "data_schema": {
    "foo": {
      "foo": "bar"
    }
  }
}

Returns Examples

200 example

{
  "data_schema": {
    "foo": {
      "foo": "bar"
    }
  }
}