OntologyExtractionResult

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/cloudmersive/json-schema/cloudmersive-ontology-extraction-result-schema.json",
  "title": "OntologyExtractionResult",
  "description": "Result of extracting structured data from a document using its business document ontology",
  "x-generated": "2026-11-05",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/cloudmersive-ontology-api-openapi.yml#/components/schemas/OntologyExtractionResult",
  "type": "object",
  "properties": {
    "Successful": {
      "description": "True if a populated ontology was produced, false otherwise",
      "type": "boolean"
    },
    "DocumentSummary": {
      "description": "One-paragraph plain-language summary of the document; populated when IncludeSummary is enabled",
      "type": "string"
    },
    "OntologyCode": {
      "description": "The taxonomy category applied to the document, in domain.category.subtype form (for example, finance.invoice.vendor_invoice)",
      "type": "string"
    },
    "OntologyTitle": {
      "description": "Human-readable title of the document type (for example, \"Vendor Invoice\")",
      "type": "string"
    },
    "WasAutoClassified": {
      "description": "True if the category was determined automatically because no classification was supplied in the request",
      "type": "boolean"
    },
    "ClassificationConfidenceScore": {
      "format": "double",
      "description": "Classification confidence score between 0.0 and 1.0; populated only when the category was determined automatically",
      "type": "number"
    },
    "AnalysisRationale": {
      "description": "Plain-language rationale for the classification; populated when the category was determined automatically and IncludeAnalysisRationale is enabled",
      "type": "string"
    },
    "OntologyTemplateFound": {
      "description": "True if a data template was available for the document type",
      "type": "boolean"
    },
    "PopulatedOntology": {
      "description": "The extracted data as a JSON object of field values (field name to value; nested objects for object fields, arrays of objects for array fields).  Fields not found in the document are null.  Null when no template was available for the document type."
    }
  },
  "additionalProperties": false
}