Query
Allows you to submit a natural language, Boolean, bracketed Boolean, keyword, field, or fuzzy query to IDOL Content Component.
You must specify query syntax by setting Text or FieldText, or both.
Example
http://12.3.4.56:9100/action=Query&Text=Gene analysis discovered methods to determine the exact sequence of nucleotides that compose a specific gene
This action requests documents that are conceptually similar to the specified text.
Required Parameters
You must set at least one of the following parameters.
| Parameter | Description |
|---|---|
| FieldText | Add a field restriction to the query. |
| Text | The query text. |
Optional Parameters
This action accepts the following optional parameters.
| Parameter | Description |
|---|---|
| Abridged | (Internal parameter) Whether to send abridged results to the DAH. |
| AbsWeight | Use absolute weights, rather than percentage relevance. |
| AgentBooleanField | A field that contains Boolean agent expressions. |
| AgentParamsField | A field that contains extra query parameters for AgentBoolean queries. |
| AgentSecurityField | A field that contains the SecurityInfo for secure documents in AgentBoolean queries. |
| AnyLanguage | Allows IDOL Content Component to return documents in any language. |
| AutoPhrase | Applies automatic phrase quotations to all terms in the query text before sentence-breaking, N-gram breaking, or decomposition. |
| CaseSensitive | Determines the case sensitivity of field specifiers. |
| Characters | The number of characters that a summary can contain. |
| Cluster | Clusters the results that IDOL 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. |
| DefaultOperator | The default operator to use between query terms in the text. |
| DetectLanguageType | Detect the correct language type of the text. |
| 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. |
| FieldRestriction | Restrict the query terms to a field. |
| FieldText | Add a field restriction to the query. |
| FieldTextField | A field that contains a FieldText expression to use. |
| HardFieldRestriction | Specifies that the fields in FieldRestriction are the only fields allowed in the matching process for both FieldText and Text. |
| 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. |
| IgnoreSpecials | Ignore certain special characters. |
| 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. |
| MatchAllTerms | Whether to return only results that match all query terms. |
| 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. |
| MaxLinksPerTerm | Reduce the maximum occurrence of each term for categorization. |
| MaxPrintChars | The maximum number of characters to print in fields. |
| MaxQueryTerms | The maximum number of terms to use in the query. |
| 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. |
| MultiStage | Use multistage query for the DAH. |
| MultiStageInfo | The VDBs to use for the multistage query. |
| MultiStageMinResults | The minimum number of results to return in the multistage query. |
| MultiStagePageBackward | Page backward in the multistage query. |
| MultiStageStartState | The start state for the multistage query. |
| MultiStageTotalStages | The total number of stages for the multistage query. |
| OutputEncoding | The encoding to convert the results to. |
| PageInfo | Whether to return the page numbers of pages that contain the query terms, within each result document. |
| PerformanceAnalysis | Return query performance information. |
| Predict | Whether to predict the total number of results. |
| 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 in the results. |
| QuerySummaryAdvanced | Whether to enable the advanced algorithm for query summaries, for Dynamic Summaries and Automatic Query Guidance. |
| QuerySummaryIDs | Whether to include the IDs of parent documents for query summary phrases in the response. |
| QuerySummaryLength | The maximum number of best terms to use in a query summary. |
| QuerySummaryMaxDocLength | The maximum number of characters in each document to use to generate a query summary. |
| QuerySummaryNumbers | Whether to allow numeric and alphanumeric values in query summaries. |
| QuerySummaryPhraseLength | The maximum number of terms to include in each query summary phrase. |
| QuerySummaryPlus | Whether to enable the QuerySummaryPlus algorithm for query summaries. |
| QuerySummaryStopPhraseMode | Disable the configured QuerySummaryStopPhraseMode. |
| QuerySummaryTerms | The number of terms to use to generate a query summary. |
| QuerySummaryWhiteListMode | Disable the configured QuerySummaryWhiteListMode. |
| ReferenceField | Restricts the DontMatchReference and MatchReference parameters to the specified reference field. |
| SecurityInfo | The security details. |
| Sentences | The number of sentences that the summary can contain. |
| ShowReasons | Whether to include details of the matching words and phrases in a result. |
| SingleMatch | Return a single result. |
| Sort | The display order to use for results. |
| SourceFields | A list of fields to use to generate a QuerySummary. |
| Checks the spelling of terms in the Text. | |
| 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. |
| StateMatchID | The state token of a group of documents to return. |
| StateMatchOriginalSection | Whether to return only sections from a state token that were matched in the original query. |
| Stemming | Whether to use stemming for advanced search. |
| StoredStateDetail | Return Engine and EngineIndex elements for result documents, as well as child server details. |
| 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. |
| StoreState | Whether to store results in a state token. |
| Summary | The type of summary to return with the results. |
| Synchronous | Whether to run the action synchronously or asynchronously. |
| Synonym | Whether to run a synonym query. |
| Text | The query text. |
| TextParse | The format of the Text. |
| TimeoutMS | The period after which the action times out. |
| TotalResults | Displays the total number of results found. |
| UserMetaFields | Creates a new metafield by performing a mathematical operation on document fields. |
| 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. |