IDOL Server 24.1

# StructuredClassifierQuery

Classifies a document according to a specified structured classifier.

You must set Name to the name of the structured classifier that you want to use to classify the document. To classify a document that exists in IDOL Server, you can set use the DocID, DocRef, or StateID parameters to specify 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 Server classifies the document according to the different structured categories in your structured classifier, and returns the closest match.

## Example

    http://12.3.4.56:9000/action=StructuredClassifierQuery&Name=Film&DocRef=http://www.example.com/documents/casablanca

This action uses the `Film` structured classifier to classify the document with reference `http://www.example.com/documents/casablanca`.

## Required Parameters

The following action parameters are required.

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

You must set at least one of the following parameters.

Parameter | Description
--- | ---
DocID | The IDOL document ID of the document that you want to classify.
DocRef | The IDOL document reference of the document that you want to classify.
QueryText | The IDX or XML document that you want to classify.
StateID | An IDOL state ID that contains the documents that you want to classify.

## Optional Parameters

This action accepts the following optional parameters.

Parameter | Description
--- | ---
SecurityInfo | A security info string to use to access the query 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.

Copyright 2023 Open Text
Version 24.1 | Last updated December 2023

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 Server 24.1

Topic Title: StructuredClassifierQuery