Tag
The Tag namespace plays a pivotal role in the automated classification and organization of files. This section of the API documentation is dedicated to exploring the concept and functionality of tags within Alfred, providing users with a comprehensive understanding of how tags are used and managed in the system.
Tags in Alfred are automated labels assigned to files, reflecting their content, nature, or processing status. These tags are critical for categorizing files efficiently, enhancing searchability, and streamlining document management workflows. The documentation delves into the various aspects of Alfred's tagging system, including the types of tags used, their significance in the automated classification process, and their role in the overall document processing lifecycle.
While the direct assignment and modification of tags via the API are not available, this section aims to equip users with a thorough understanding of the tagging mechanism. It highlights the importance of tags in ensuring an organized and efficient processing environment and provides insights into the underlying logic and criteria employed by Alfred's automated tagging system.
Understanding the tag infrastructure is vital for users to effectively navigate and utilize Alfred's IDP capabilities, ensuring that they can align their document processing needs with the automated classifications provided by the system. This knowledge is also instrumental in interpreting and leveraging the tags for enhanced document management and workflow optimization within Alfred.
Access Account-Specific Tag List
GET https://<env>.tagshelf.com/api/tag/all
This endpoint is tailored for users to retrieve a list of tags available within their specific customer account in Alfred. Given that a customer account can encompass multiple users, each with different access levels, this endpoint reflects the tags accessible based on the user’s permissions.
It showcases the customized set of tags, which may include a complete list or a subset, depending on the user's access rights within the account. This functionality is key for users to understand and navigate the range of classification options tailored to their account's document processing setup.
Headers
X-TagshelfAPI-Key
String
Application API Key
Authorization
String
Bearer <access_token> or amx <hmac_token>
Get Details of Custom Tags within User Access
GET https://<env>.tagshelf.com/api/tag/detail/:id
This endpoint, users can acquire detailed information about a specific tag from the set available in their customer account. The endpoint respects user-level access, providing details only on those tags the user is authorized to view. It offers insights into the tag's definition, application criteria, and any customizations specific to the account. This detailed view is crucial for users who need in-depth understanding of a tag's role and usage in their account's document processing framework.
Path Parameters
id
UUID
The id parameter in the /api/tag/detail/:id endpoint specifies the unique identifier of the tag for which detailed information is being requested. This ID is used to retrieve specific details about a particular tag, including its definition, criteria, and application within Alfred's system. It is a crucial parameter for users who need to understand the specific characteristics and usage of an individual tag.
Headers
X-TagshelfAPI-Key
String
Application API Key
Authorization
String
Bearer <access_token> or amx <hmac_token>
Classify Text Using User-Authorized Tags
GET https://<env>.tagshelf.com/api/tag/classify
This endpoint enables users to input text and see how it would be classified according to the tagging criteria and model specific to their account and access level in Alfred. This endpoint is especially useful for users to test and understand the classification logic as it applies to them, considering any customizations and updates made at the account level. It serves as a practical tool for ensuring that the automated tagging aligns with the user’s access to tags and the overall document processing strategy of their account.
Headers
X-TagshelfAPI-Key
String
Application API Key
Authorization
String
Bearer <access_token> or amx <hmac_token>
Request Body
text
String
The text parameter in the /api/tag/classify endpoint is used to input a specific snippet of text for classification testing. This endpoint applies the current tag classification criteria of the user's account to the provided text. It's designed to simulate how Alfred's automated classification system would categorize the text based on the user's accessible tags and account-specific settings. The purpose of this parameter is to enable users to evaluate and understand the tagging behavior as per their customized criteria, ensuring alignment with their document processing requirements.
Last updated
Was this helpful?