IDOL Category Component 12.13

# CategoryFindRelevantSentences

Return the most relevant sentences in a document, a file, or a piece of text, based on training about which documents are relevant and which are irrelevant.

In most cases, you train two categories (one with relevant data and one with irrelevant data), and build the categories by using the CategoryBuild action with the Relevance parameter. If you create only one Relevance category, `CategoryFindRelevantSentences` returns all sentences. If you create more than two categories, you must use the RelevantCat parameter for the CategorySetDetails action to mark one of the categories as the relevant category, and all other categories are treated as irrelevant. The `CategoryFindRelevantSentences` action requires one of the child categories to be set as the RelevantCat.

Like Simple categories, you create groups of Relevance categories by creating them under different parent categories. When you send the `CategoryFindRelevantSentences` action, you must specify the parent ID to determine which set of Relevance categories to use.

You can specify secure documents for this action. Use the SecurityInfo parameter to specify the security string to use.

NOTE: This is an administrative action that can be sent only by users that belong to an authorization role that allows the `Admin` standard role, or which enables the action explicitly. See Authorization Roles Configuration Parameters.

## Example

    http://12.3.4.56:9020/action=CategoryFindRelevantSentences&Parent=123&DocID=456

This action finds relevant sentences in the document with the ID `456`, based on the relevance categories contained in the parent category `123`.

## Required Parameters

The following action parameters are required.

Parameter | Description
--- | ---
Parent | The parent of the Relevance categories.

You must set one of the following parameters.

Parameter | Description
--- | ---
DocID | The document IDs of documents to find relevant sentences in.
DocRef | The references of documents to find relevant sentences in.
QueryText | The text to find relevant sentences from.

## Optional Parameters

This action accepts the following optional parameters.

Parameter | Description
--- | ---
DatabaseMatch | Databases where documents are stored from which relevant sentences are found.
Language | The language of the query text.
NumResults | The number of relevant sentences to return.
QueryFile | The file to find relevant sentences from.
SecurityInfo | Security details for the user that sends the action.

This action accepts the following standard ACI action parameters.

Parameter | Description
--- | ---
ActionID | A string to use to identify an ACI action.
EncryptResponse | Encrypt the output.
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.

## Comments

You must specify one of the following parameters:

- DocID

- DocRef

- QueryText

© Copyright 2022 Micro Focus or one of its affiliates
Version 12.13 | Last updated October 2022

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 swpdl.idoldocsfeedback@microfocus.com.

We appreciate your feedback!

Product: IDOL IDOL Category Component 12.13

Topic Title: CategoryFindRelevantSentences