Action: text-metadata-generation

Generates metadata from an input PDF file and performs similarity matching against a set of provided metadata examples to return the most relevant results.

Requirements

Input files must be PDF
objectKeys must contain only PDF paths
kSimilarMetadata - must be provided and contain at least one item

Provide kSimilarMetadata in a POST request to enhance the quality of the API response, providing multiple example objects is highly recommended, as it helps the API generate more accurate and contextually relevant results. Each item in kSimilarMetadata should be a dictionary (JSON object) containing representative example data.

Example If the input file is "Hyland Employee Handbook US Policies", your request might include metadata like:

 "KSimilarMetadata" : [
   {
    "document:title": "Emerging Markets Overview",
    "document:date": "2024-11-15",
    "entity:company": "Noventis Group",
    "entity:organization": "Global Economic Forum",
    "entity:person": "Alex R. Minden",
    "event:location": "New Bristol, Terranova",
    "keywords:tags": "economy|markets|Noventis|GEF|Terranova|report",
    "document:type": "market analysis",
    "document:category": "Economics & Finance",
    "summary:text": "This report provides a comprehensive analysis of financial trends and investment opportunities across emerging markets in the Terranova region, focusing on the strategies employed by Noventis Group.",
    "references:list": [
      "Terranova Financial Bulletin, Vol. 12","GEF Annual Review 2023","Noventis Group Internal Strategy Memo"]
  }
]

Output

Dictionary of generated metadata fields and values
See Schema

Result: The response will include a textMetadata object containing detailed information extracted from the image.

"textMetadata": {
        "isSuccess": true,
        "result": {
          "document:category": "Human Resources",
          "document:date": "2017-01-01",
          "document:title": "2017 Hyland Software, Inc. Employee Handbook",
          "document:type": "employee handbook",
          "entity:company": "Hyland Software, Inc.",
          "keywords:tags": "hyland|employee|handbook|policies|employment|compensation|benefits|time off",
          "summary:text": "The 2017 Hyland Software, Inc. Employee Handbook covers a wide range of policies and guidelines related to employment at Hyland, including confidentiality, equal employment opportunity, drug and alcohol use, attendance, employee conduct, compensation, benefits, and time off."
        },

Requirements​

Output​

Requirements

Output