Request
Endpoint:
POST
https://api.meaningcloud.com/class-2.0
If you are working with an on-premises installation, you will need to substitute api.meaningcloud.com by your own server address.
Content-Type:
multipart/form-dataParameters:
| Name | Description | Values | Notes |
|---|---|---|---|
key | Authorization key for using MeaningCloud services. Create an account for free to create your key. | Required | |
verbose | Verbose mode. When active, it shows additional information about the classification, specifically, it shows the terms that have been used for classifying a text within a category along with how they influence the relevance of the category for the processed text. | y: enabledn: disabled | Optional. Default: n |
debug | Debug mode. When enabled, it shows additional debug information about the rules in the model that have been fired. | y: enabledn: disabled | Optional. Default: n |
title | Descriptive title of the content. The terms relevant for the classification process found in the title will have more influence in the classification than if they were in the text. | UTF-8 encoded text (plain text, HTML or XML). | Optional. |
abstract | Descriptive abstract of the content. The terms relevant for the classification process found in the abstract will have more influence in the classification than if they were in the text (but less than the ones in the title). | UTF-8 encoded text (plain text, HTML or XML). | Optional. |
txt | Text to analyze | UTF-8 encoded text (plain text, HTML or XML). | Use only one |
url | URL of the document to analyze. Non-authenticated HTTP(s) and FTP supported. See supported formats. | ||
doc | Input file with the content to analyze. See supported formats. | ||
model | Classification model to use. It will define into which categories the text may be classified. | See models section. | Required |
categories_filter | List of prefixes of the code of the categories to which the classification is limited. Each value will be separated by '|'. All the categories that do not start with any of the prefixes specified in the list will not be taken account in the classification. For example, if only a clasification within the human interest category, the prefix used would be 0800. All the codes associated to the categories can be seen in the classification models section. | Optional. | |
expand_hierarchy | It allows you to select if in the results you want to include the parents or the ancestors of the category/categories in which the content has been classified. It only applies to models with explicit hierarchy. | n: no expansionp: only parentsa: ancestors | Optional. Default: n |
Important
The fields txt, doc and url are mutually exclusive; in other words, at least one of them must not be empty (a content parameter is required), and in cases where more than one of them has a value assigned, only one will be processed. The precedence order is txt, url and doc.
Featured Posts
Useful Links
2022 © All Rights Reserved | Data protection policy | Terms and conditions | Data Processing AgreementMeaningCloud is a a trademark by MeaningCloud LLC