Metadata Values

Metadata Values are critical components that represent the extracted information based on metadata defined for each tag. This section of the API documentation aims to provide a comprehensive understanding of Metadata Values and their role in the document processing workflow.

Metadata in Alfred, which is planned to be renamed as "Data Points", is uniquely crafted during the on-boarding and configuration process by Tagshelf. This approach ensures that the metadata is precisely tailored to each tag (document type), allowing for the development of specific models and the extraction of contextually relevant data. This customization is a key aspect of Alfred’s ability to handle a wide array of document types with high accuracy and specificity.

This section of the documentation will focus on the read-only aspect of this feature as available through the API. Users can access information about the data extracted for each document type but cannot modify the metadata definitions themselves.

Additionally, this section will delve into how Alfred employs its Rack templating language for the transformation and expansion of these extracted values. Users will gain insights into how Alfred’s sophisticated algorithms and the Rack system work in tandem to extract and transform data, providing a deep understanding of the extraction process from raw document content to structured Metadata Values.

Get metadata values from tag ID

GET https://tagshelf.host/api/values/tag/:id

Get metadata values from Tag ID.

Path Parameters

Name	Type	Description
id	UUID	Tag ID

Headers

Name	Type	Description
Authorization	string	Bearer <access_token> or amx <hmac_token>
X-TagshelfAPI-Key	string	<app_api_key>

200 OK

{
  "currentVersion": "1.11.1.0",
  "status": "Online"
}

Get metadata values from file ID

GET https://tagshelf.host/api/values/file/:id

Get a list of metadata values from File ID

Path Parameters

Name	Type	Description
id	UUID	File ID

Headers

Name	Type	Description
Authorization	string	Bearer <access_token> or amx <hmac_token>
X-TagshelfAPI-Key	string	<app_api_key>

200 OK

[
  {
    "id": "c40e0384-9d4b-4e12-83e6-29a181f31254",
    "file_log_id": "9ddb16be-2875-4891-9edc-ec457adc252c",
    "metadata_id": "813966a3-f340-42c7-a1eb-188718c46a8a",
    "metadata_name": "InvoiceNo",
    "value": "222436",
    "classification_score": 1.0
  },
  ...
]