Validate Extraction Schema

extract.validate_schema() -> ExtractV2SchemaValidateResponse

POST/api/v2/extract/schema/validation

Validate a JSON schema for extraction.

ParametersExpand Collapse

data_schema: Dict[str, Union[Dict[str, object], Iterable[object], str, 3 more]]

JSON Schema to validate for use with extract jobs

One of the following:

Dict[str, object]

Iterable[object]

str

float

bool

ReturnsExpand Collapse

class ExtractV2SchemaValidateResponse: …

Response schema for schema validation.

data_schema: Dict[str, Union[Dict[str, object], List[object], str, 3 more]]

Validated JSON Schema, ready for use in extract jobs

One of the following:

Dict[str, object]

List[object]

str

float

bool

Validate Extraction Schema

import os
from llama_cloud import LlamaCloud

client = LlamaCloud(
    api_key=os.environ.get("LLAMA_CLOUD_API_KEY"),  # This is the default and can be omitted
)
extract_v2_schema_validate_response = client.extract.validate_schema(
    data_schema={
        "properties": {
            "vendor_name": "bar",
            "invoice_number": "bar",
            "total_amount": "bar",
            "line_items": "bar",
        },
        "required": ["vendor_name", "invoice_number", "total_amount"],
        "type": "object",
    },
)
print(extract_v2_schema_validate_response.data_schema)

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

Returns Examples

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