Open topic with navigation

# CategorySuggestFromDocument

Returns categories that are similar to a document that you specify.

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

## Example

    http://12.3.4.56:9020/action=CategorySuggestFromDocument&DocID=125

This action requests categories that are conceptually similar to the document with the ID `125`.

By default, this action operates by sending a `Query` action to the Agentstore, but it can send a `SuggestOnText` query instead, if you set UseSuggestOnText. `SuggestOnText` and `Query` work slightly differently. `SuggestOnText` is faster, but `Query` is more accurate. Reducing the MaxQueryTerms when you set UseSuggestOnText to `False` (the default) speeds up the `CategorySuggestFromDocument` action, but reduces accuracy.

## Required Parameters

You must set one of the following parameters.

Parameter | Description
--- | ---
DocID | The document IDs of the documents to suggest on.
DocRef | The references of the documents to suggest on.

## Optional Parameters

This action accepts the following optional parameters.

Parameter | Description
--- | ---
AgentBoolean | Whether to use Boolean restrictions for a category.
AnyLanguage | Whether to retrieve categories that were stored in all languages.
Databases | Restricts results to a specific category database.
DatabaseMatch | The databases that contain the documents to suggest on.
FieldText | A field restriction to apply to results.
FullPathOnly | Whether to return only the full path from the schema root to the category. This parameter applies only when you set ShowCategoryPath to `True`.
IncludeTopLevel | Whether to include the top level category in a path that shows the position of the category. This parameter applies only when you set ShowCategoryPath to `True`.
MaxQueryTerms | The maximum number of terms to use in the query.
NumResults | The number of results to return.
Params | `Query` action parameters to add.
PrintFields | The category fields to display in the results.
Schema | The ID of the category to set as the root for the hierarchy, to restrict the results to this category and its descendants.
SecurityInfo | The security details for the user that sends the action.
ShowCategoryPath | Whether to show each returned category in its place in the category hierarchy.
TaxonomyName | The name of the taxonomy to restrict results to.
TextParse | Whether to treat the document as XML or IDX.
Threshold | The relevance threshold of the result categories.
UserName | The name of the user that sends the action.
UseSuggestOnText | Whether to send a `SuggestOnText` action to Agentstore, instead of a `Query` action.
Values | Values for the specified Params.

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.

© 2018 Micro Focus or one of its affiliates | Send documentation feedback to Micro Focus Close Send documentation feedback To open the configured email client on this computer, open an email window. Otherwise, copy the information below to a web mail client, and send this email to swpdl.idoldocsfeedback@microfocus.com. We appreciate your feedback! Product: Topic Title: Help Topic: Feedback:

_FT_HTML5_bannerTitle.htm