classify Request Parameters
Parameter | In | Type | Comment |
---|---|---|---|
body | BaseRequest | Document’s description (string) and/or document’s info. | |
BestClassesCount | url (Optional) | string (“1”, “2”, “3”,..) | Count of the best classes to return. |
Taxonomy | url (Optional) | string ("", “default”, “iab2”, “documents”, “sentiment”, “sentiment3”) | Taxonomy to use for classification return. |
PrecisionRecallBalance | url (Optional) | string (“precision”, “recall”, “") | Balance between precision and recall. |
BaseRequest
Model:
BaseRequest {
description (string, optional),
document (FileInfo, optional)
}
FileInfo {
folder (string, optional),
name (string, optional),
password (string, optional)
}
Examples:
JSON
{
"description": "File description or raw text to classify if no document is specified",
"document":
{
"folder": "File folder",
"name": "File name",
"password" : "File password"
}
}
XML
<?xml version#"1.0"?>
<BaseRequest>
<description>File description or raw text to classify if no document is specified
</description>
<document>
<folder>File folder
</folder>
<name>File name
</name>
<password>File password
</password>
</document>
</BaseRequest>