StructuredCategoryCreate

Create a structured category from training documents.

A structured category is a category that IDOL trains and uses to categorize based on the structured content in a document; that is, the fields and their values, rather than the unstructured text. IDOL trains the categories using the parametric fields in the documents that you specify.

When you create a structured category, you set Name to the name of the new category, and StateID to the state ID for a set of documents that you want to use to train the category. You can optionally include SecurityInfo to use secure documents in the category training.

After you create your structured categories, you create a structured classifier, which you can then query to categorize your documents. See StructuredClassifierCreate.

Example

http://12.3.4.56:9020/action=StructuredCategoryCreate&Name=FILM&StateID=B8UGIK95FKJG-23

This action creates a FILM structured category, trained with the documents represented in the IDOL state ID B8UGIK95FKJG-23.

Required Parameters

The following action parameters are required.

Parameter Description
Name The name of the structured category to create.
StateID A state token that defines the documents that you want to use to train the new structured category.

Optional Parameters

This action accepts the following optional parameters.

Parameter Description
SecurityInfo A security info string to use to access the training documents.

This action accepts the following standard ACI action parameters.

Parameter Description
ActionID A string to use to identify an ACI action.
FileName The file to write output to.
ForceTemplateRefresh Forces the server to load the template from disk.
Output Writes output to a file.
ResponseFormat The format of the action output.
Template The template to use for the action output.
TemplateParamCSVs A list of variables to use for the specified template.