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(ExtractValidateSchemaParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

POST/api/v2/extract/schema/validation

Validate a JSON schema for extraction.

ParametersExpand Collapse

ExtractValidateSchemaParams params

ExtractV2SchemaValidateRequest extractV2SchemaValidateRequest

Request schema for validating an extraction schema.

ReturnsExpand Collapse

class ExtractV2SchemaValidateResponse:

Response schema for schema validation.

DataSchema dataSchema

Validated JSON Schema, ready for use in extract jobs

One of the following:

class UnionMember0:

List<JsonValue>

String

double

boolean

Validate Extraction Schema

Java

HTTP

TypeScript

Python

Java

Go

CLI Tool

package com.llamacloud_prod.api.example;

import com.llamacloud_prod.api.client.LlamaCloudClient;
import com.llamacloud_prod.api.client.okhttp.LlamaCloudOkHttpClient;
import com.llamacloud_prod.api.core.JsonValue;
import com.llamacloud_prod.api.models.extract.ExtractV2SchemaValidateRequest;
import com.llamacloud_prod.api.models.extract.ExtractV2SchemaValidateResponse;
import com.llamacloud_prod.api.models.extract.ExtractValidateSchemaParams;
import java.util.List;
import java.util.Map;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        LlamaCloudClient client = LlamaCloudOkHttpClient.fromEnv();

        ExtractV2SchemaValidateRequest params = ExtractV2SchemaValidateRequest.builder()
            .dataSchema(ExtractV2SchemaValidateRequest.DataSchema.builder()
                .putAdditionalProperty("properties", JsonValue.from(Map.of(
                  "vendor_name",
                  "bar",
                  "invoice_number",
                  "bar",
                  "total_amount",
                  "bar",
                  "line_items",
                  "bar"
                )))
                .putAdditionalProperty("required", JsonValue.from(List.of(
                  "vendor_name",
                  "invoice_number",
                  "total_amount"
                )))
                .putAdditionalProperty("type", JsonValue.from("object"))
                .build())
            .build();
        ExtractV2SchemaValidateResponse extractV2SchemaValidateResponse = client.extract().validateSchema(params);
    }
}

200 example

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

Returns Examples

200 example

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