Feathery · Schema
Feathery AI Extraction Configuration
Schema for a Feathery AI document extraction configuration
FormsForm BuilderMulti-Step FormsDocument IntelligenceAIFinancial ServicesInsuranceWealth ManagementeSignatureWorkflowsData IntakeSubmissionsPaymentsAuthentication
Properties
| Name | Type | Description |
|---|---|---|
| id | string | Extraction configuration identifier |
| name | string | Human-readable extraction name |
| file_type | string | Type of document/file the extraction processes |
| extraction_type | string | Extraction method |
| merge_files | boolean | Whether to merge multiple files before extraction |
| confidence_scores_enabled | boolean | Whether to include confidence scores in extraction results |
| context_rules | array | Contextual rules guiding the extraction |
| queries | array | Individual extraction queries |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://api.feathery.io/schema/extraction",
"title": "Feathery AI Extraction Configuration",
"description": "Schema for a Feathery AI document extraction configuration",
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Extraction configuration identifier"
},
"name": {
"type": "string",
"description": "Human-readable extraction name"
},
"file_type": {
"type": "string",
"enum": ["image", "csv", "meeting", "ai_query"],
"description": "Type of document/file the extraction processes"
},
"extraction_type": {
"type": "string",
"description": "Extraction method"
},
"merge_files": {
"type": "boolean",
"description": "Whether to merge multiple files before extraction"
},
"confidence_scores_enabled": {
"type": "boolean",
"description": "Whether to include confidence scores in extraction results"
},
"context_rules": {
"type": "array",
"items": { "type": "string" },
"description": "Contextual rules guiding the extraction"
},
"queries": {
"type": "array",
"items": { "$ref": "#/$defs/ExtractionQuery" },
"description": "Individual extraction queries"
}
},
"required": ["id", "name", "file_type"],
"$defs": {
"ExtractionQuery": {
"type": "object",
"properties": {
"id": { "type": "string", "format": "uuid" },
"question_type": {
"type": "string",
"enum": ["one_value", "multiple_value", "yes_no", "page_number"]
},
"entities": {
"type": "array",
"items": { "type": "string" }
},
"criteria": {
"type": "string",
"description": "Extraction instructions in natural language"
},
"data_validation_rules": {
"type": "array",
"items": { "type": "string" }
},
"run_email_mode": {
"type": "string",
"enum": ["email_only", "email_document", "document_only"]
}
},
"required": ["id", "question_type"]
}
}
}