Metadata

In Alfred's Intelligent Document Processing (IDP) platform, the concept of Metadata is intricately linked with tags and plays a vital role in extracting specific data points from content, particularly files. Metadata in Alfred is unique in that it is associated with a specific tag and encompasses data points intended to be extracted based on the file's classified content.

This section of the API documentation focuses on the Metadata management functionalities within Alfred. It provides users with detailed insights into the metadata fields defined for a given tag and the intricate processes involved in data extraction. Users can access information about the various metadata fields linked to each tag, along with their specific extraction rules and configurations.

The Metadata system in Alfred is enhanced by a proprietary templating system known as Rack, which allows for the chaining and augmentation of metadata fields. This system offers a high degree of flexibility and precision in data extraction. Additionally, Alfred supports both preprocessing and post-processing extensions, which can be implemented using a subset of Python, tailored to fit the platform's operational context.

While the API endpoints provide information about the existing metadata fields and their details, the creation and modification of these fields and their properties are not performed through the API. Instead, they are managed via Alfred's configuration UI. This approach ensures a controlled and secure environment for setting up and adjusting the metadata extraction rules and parameters.

Understanding the Metadata configuration and its role in Alfred's document processing workflow is essential for users. It allows them to comprehend how classified content is processed further for data extraction and how they can leverage Alfred's advanced capabilities for tailored data point retrieval. This section aims to guide users through the complexities of Metadata in Alfred, highlighting its importance in achieving detailed and accurate data extraction from processed documents.

Get metadata fields by tag ID

GET https://tagshelf.host/api/metadata/tag/:tag-id

Get a list of metadata fields from the specified Tag.

Path Parameters

Name	Type	Description
tag-id	UUID	Tag ID

Headers

Name	Type	Description
X-TagshelfAPI-Key	String	Application API Key
Authorization	String	Bearer <access_token> or amx <hmac_token>

200 OK

[
    {
        "id": "2b92cce2-c43d-4fbb-b619-13e451c958d7",
        "tag_id": "0bb267ab-2a58-4123-9550-1d6043b161db",
        "name": "PSSNombre",
        "tag_name": "Reclamaciones Medicas"
    },
    {
        "id": "cd25004e-5eda-4758-a7a6-144e6d5f8abc",
        "tag_id": "0bb267ab-2a58-4123-9550-1d6043b161db",
        "name": "CoPago",
        "tag_name": "Reclamaciones Medicas"
    },
    {
        "id": "78d9ea8d-be82-4e34-8749-1eef33cfa7bc",
        "tag_id": "0bb267ab-2a58-4123-9550-1d6043b161db",
        "name": "Fecha",
        "tag_name": "Reclamaciones Medicas"
    },
    ...
]

Get metadata field by ID

GET https://tagshelf.host/api/metadata/detail/:metadata-id

Get details of the specified metadata field by ID.

Path Parameters

Name	Type	Description
metadata-id	UUID	Metadata ID

Headers

Name	Type	Description
X-TagshelfAPI-Key	String	Application API Key
Authorization	String	Bearer <access_token> or amx <hmac_token>

200 OK

{
    "id": "2b92cce2-c43d-4fbb-b619-13e451c958d7",
    "tag_id": "0bb267ab-2a58-4123-9550-1d6043b161db",
    "name": "PSSNombre"
}