IDOL Category Component 24.4
IDOL Category Component Help

# ClassifierQuery

Classifies a document according to a specified classifier.

You must set ClassifierName to the name of the classifier that you want to use to classify the document. To classify a document that exists in IDOL Category Component, you can set DocRef to the IDOL document reference for the document. To classify a document that does not exist in the index, you can set QueryText to the full IDX or XML document that you want to classify.

IDOL Category Component extracts the classifier feature fields from the document you provide, and uses them to determine the class that best fits the content of the document. The action returns the best class in the `<autn:class>` tag.

## Example

    http://12.3.4.56:9020/action=ClassifierQuery&ClassifierName=food&DocRef=http://www.example.com/documents/carrots

This action uses the `food` classifier to classify the document with reference `http://www.example.com/documents/carrots`.

## Required Parameters

The following action parameters are required.

Parameter | Description
--- | ---
ClassifierName | The name of the classifier to use to classify the document.

You must set at least one of the following parameters.

Parameter | Description
--- | ---
DocRef | The IDOL document reference of the document that you want to classify.
QueryText | The IDX or XML document that you want to classify.

## Optional Parameters

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.

Copyright 2024 Open Text
Version 24.4 | Last updated September 2024

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: IDOL IDOL Category Component 24.4

Topic Title: ClassifierQuery