Method SetElementsFromJsonScheme

Namespace

LMKit.Extraction

Assembly

LM-Kit.NET.dll

SetElementsFromJsonScheme(string)

Configures the text extraction elements by parsing a JSON scheme.

public void SetElementsFromJsonScheme(string jsonScheme)

Parameters

jsonScheme string

A string containing the JSON scheme that defines the structure, types, and optional descriptions of the extraction elements. The JSON scheme can define simple elements, arrays, or complex objects with nested properties.

Examples

// Example JSON scheme with various element definitions:
string jsonScheme = @"
{
  ""FirstName"": {
    ""type"": ""String"",
    ""description"": ""The first name of the person""
  },
  ""LastName"": {
    ""type"": ""String"",
    ""description"": ""The last name of the person""
  },
  ""Age"": {
    ""type"": ""Integer"",
    ""description"": ""The age of the person""
  },
  ""ImportantDates"": {
    ""type"": ""Date"",
    ""description"": ""List of important dates"",
    ""isArray"": true
  },
  ""Address"": {
    ""description"": ""Mailing address"",
    ""properties"": {
      ""Street"": {
        ""type"": ""String"",
        ""description"": ""Street name""
      },
      ""City"": {
        ""type"": ""String"",
        ""description"": ""City name""
      },
      ""ZipCode"": {
        ""type"": ""Integer"",
        ""description"": ""Postal code""
      }
    }
  }
}";

// Configure extraction elements based on the JSON scheme.
textExtraction.SetElementsFromJsonScheme(jsonScheme);

Remarks

This method uses ParseJsonScheme(string) to convert the JSON scheme into a list of TextExtractionElement instances, which is then assigned to the Elements property. The JSON scheme should follow the expected format, supporting keys such as "type", "description", "isArray", and "properties". For a simple element, you can provide a JSON object with a "type" and an optional "description". For a complex object, use the "properties" key to define its inner elements. To define an array of elements, either use a JSON array containing a single type string or set "isArray" to true in the element definition.