API Reference
Start typing to search…

AutoGenerate a Schema

post https://app.docupanda.io/schema/autogenerate

Generate a schema based on a list of documents. Leave the instructions empty if you want the AI to use its best judgment, or provide instructions to indicate your preference to how the schema should be generated. Best results are achieved when you provide a varied list of documents that represent the full range of type of documents you expect to process, and when you provide clear instructions to what you expect the schema to capture and how you want it to be structured.

Body Params
string

Name of the schema to be defined. For example rental contracts

documentIds
array of strings

List of document IDs to use for schema generation.

Document IDs
string

The dataset to which the documents belong.

string

Instructions on how to create the schema.

string

Guidelines to apply to the schema to documents when standardizing.

boolean
Defaults to true

Whether to standardize the input documents using the newly created schema after generation.Note that standardizing documents costs credits just as if you had called the /standardize endpoint directly

string

Advanced Feature
Mode of standardization to run, if standardizing using the schema.

Responses

Response body
object
string
required

Unique identifier for the autogenerate schema job.

string
required

Current status of the job.

processing completed error

string

Unique identifier for the schema being generated. The schema is only available when the job is completed.

string

Name of the schema being generated.

standardizationIds
array of strings

List of standardization IDs for the documents used to generate the schema. These will only become available after schema generation is complete, and only if standardizeUsingSchema is set to true.

Standardization IDs
standardizationJobIds
array of strings

List of standardization job IDs for the documents used to generate the schema. These will only become available after schema generation is complete, and only if standardizeUsingSchema is set to true.

Standardization Job IDs

Updated 5 days ago

Did this page help you?
Language
Credentials

Updated 5 days ago

Did this page help you?