Open topic with navigation

# Suggest

Finds documents that are conceptually similar to one or more specified documents or document sections.

HPE Content Component extracts the best terms and weights from the document that you provide, and uses these terms to query the index for similar documents.

By default, HPE Content Component extracts the best 40 terms. You can configure the number of terms to use by using the SuggestTerms configuration parameter.

## Example

    http://12.3.4.56:9000/action=Suggest&ID=100

This action uses port `9000` to request documents that are conceptually similar to the document with the ID `100` from HPE Content Component, which is located on a machine with the IP address `12.3.4.56`.

## Parameters

Parameter | Description | Required
--- | --- | ---
Abridged | (Internal parameter) Whether to send abridged results to the DAH. |
AbsWeight | Use absolute weights, rather than percentage relevance. |
CaseSensitive | Determines the case sensitivity of field specifiers. |
Characters | The number of characters that a summary can contain. |
Cluster | Clusters the results that HPE Content Component returns. |
ClusterThreshold | The percentage relevance that documents must have to each other to be grouped in a cluster. |
ClusterTitleLength | The maximum number of characters in a cluster title. |
Combine | Combine results that derive from the same source. |
CombineNumber | Increases the number of results that the action returns, if you set Combine to `FieldCheck`, or to a reference field. |
CustomWeight | Whether to use your custom term weight file, if one exists. |
DAHEndState | Define the range of results to return in a batch. |
DAHStartState | Returns results in batches. |
DatabaseMatch | The database to retrieve results from. |
DontMatchID | Document IDs for documents that you do not want to return. |
DontMatchReference | References for documents that you do not want to return. |
EndTag | The end HTML tag to apply to highlighted terms. |
FieldCheck | Match results that have a specified value in a FieldCheckType field. |
FieldRecurse | Returns the chain of values in a document ReferenceMemoryMappedType field. |
FieldText | Add a field restriction to the query. | See Comments
Highlight | Whether to highlight link terms or sentences in the results. |
HighlightTagTerm | Adds an attribute to the StartTag to indicate the term that is highlighted. |
ID | The ID of the documents to suggest on. | See Comments
IRS | Send the query to an instant response server (IRS). |
LanguageType | The language type of the query text. |
LinkFieldText | The `FieldText` expression to match in the linked documents, when FieldText contains an expression with the LINK field specifier. |
MatchEncoding | The encoding that a document must have to return. |
MatchID | Document IDs for documents that you want to return. |
MatchLanguage | The language that a document must have to return. |
MatchLanguageType | The language type that a document must have to return. |
MatchReference | Document references that can return. |
MaxDate | The maximum creation date that a document can have to return. |
MaxID | The highest document ID to return. |
MaxPrintChars | The maximum number of characters to print in fields. |
MaxResults | The maximum number of results to print. |
MaxScore | The maximum score that results can obtain. |
MinDate | The minimum creation date that a document can have to return. |
MinID | The minimum document ID to list. |
MinLinks | The minimum number of links in results documents. |
MinScore | The minimum score that results must have. |
MinTermLength | The minimum length that a term can have after stemming. |
OutputEncoding | The encoding to convert the results to. |
PerformanceAnalysis | Return query performance information. |
Predict | Whether to predict the total number of results. |
Print | Defines the fields to display. |
PrintEngine | Whether to display information about the DAH child servers that results come from. |
PrintFields | Overrides fields that display by default. |
QuerySummary | Return a summary of the best terms and phrases of the results. |
Reference | The references of results to suggest results for. | See Comments
ReferenceField | The reference field that contains the reference values that you specify for Reference, DontMatchReference, and MatchReference. |
SecurityInfo | The security details. |
Sentences | The number of sentences that the summary can contain. |
SingleMatch | Return a single result. |
Sort | The display order to use for results. |
Start | Print results from this position onwards. |
StartTag | The opening HTML tag to apply to highlighted terms. |
StateDontMatchID | The state token of a group of documents to not return. |
StateID | A state token that specifies the documents to suggest on. | See Comments
StateMatchID | The state token of a group of documents to return. |
Stemming | Whether to use stemming for advanced search. |
StoreState | Whether to store results in a state token. |
StoredStateField | The field that contains reference values to use to create the state token. |
StoredStateTokenLifetime | The length of time to keep the stored state token. |
Summary | The type of summary to return with the results. |
Synchronous | Whether to run the action synchronously or asynchronously. |
TimeoutMS | The period after which the action times out. |
TotalResults | Displays the total number of results found. |
WeighFieldText | Adjusts results relevance according to FieldText matching. |
XMLMeta | Whether to return additional metadata for each result. |

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 set one or more of the following parameters to specify the documents that you want to use to suggest on:

- ID

- Reference

- StateID

NOTE:

If you use a Distributed Action Handler (DAH) to distribute the `Suggest` action, you cannot use any parameters that specify the IDs of documents. Use parameters that identify documents by their reference instead.

© 2017 Hewlett Packard Enterprise Development LP | Send documentation feedback to HPE 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 AutonomyTPFeedback@hpe.com. We appreciate your feedback! Product: Topic Title: Help Topic: Feedback:

_HP_HTML5_bannerTitle.htm