# GetQueryTagValues

Returns the values that occur in the specified parametric field in the results of a query.

You specify the query by using the Text and FieldText parameters, in the same way as for a Query action. You can also specify many of the other Query action parameters to restrict the list of documents that the `GetQueryTagValues` action uses.

You must specify the name of the parametric fields in the FieldName parameter. The action returns a list of values that occur in these fields, for all documents that match the initial query.

NOTE: By default, `GetQueryTagValues` returns the values that occur in the specified FieldName for all the documents in your index that match the query. The MaxResults configuration parameter does not apply to `GetQueryTagValues`.

To restrict the number of documents that the action examines to find query matches, you must set MaxResults in the action.

To restrict the number of field values that the action returns, you can set MaxValues.

## Example

    http://12.3.4.56:9000/action=GetQueryTagValues&FieldName=GRAPE,COUNTRY&Text=A smooth red wine that complements game

This action requests the values of `GRAPE` and `COUNTRY` fields in documents that are conceptually similar to the specified Text.

## Required Parameters

The following action parameters are required.

Parameter | Description
--- | ---
FieldName | The parametric fields whose values you want to return.

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

The following optional parameters affect the list of tag values that the action returns.

Parameter | Description
--- | ---
AllowNonParametricFields | Allows IDOL Server to return values for non-parametric fields.
CustomWeight | Whether to use your custom term weight file, if one exists.
DateOffset | The offset to apply to the specified DatePeriod.
DatePeriod | Returns documents for a specified time period (when FieldName is an `autn_date` metadata field).
DocumentCount | Returns the number of documents that contain a parametric tag value.
FieldDependence | Allows you to find sets of values that occur together.
FieldDependenceMultiLevel | Whether to display the FieldDependence value results in a hierarchical structure.
MaxValues | The maximum number of top results to display.
Merge | Merges the values of multiple parametric fields.
Predict | Whether to predict the total parametric value document count.
Print | Whether to print values or just ValueDetails information.
Ranges | The parametric ranges that you want to return.
RestrictedValues | Restricts tag values for fields in both the FieldText and FieldName parameters to only those values that satisfy the FieldText.
Sort | The display order to use for results.
Start | Print results from this position onwards.
Synchronous | Whether to run the action synchronously or asynchronously.
TotalValues | Whether to display the total number of matches.
ValueDetails | Returns the calculated total number, numeric total, average, and ranges of values in a field.
ValuePercentiles | The percentiles to show in the ValueDetails response.
ValueRestriction | A string filter to use to restrict the values that return.

The following parameters define the query to use to find the documents that the action uses.

Parameter | Description
--- | ---
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 Server to return documents in any language.
AutoPhrase | Applies automatic phrase quotations to all terms in the query text.
CaseSensitive | Determines the case sensitivity of field specifiers.
Combine | Combine results that derive from the same source.
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.
FieldCheck | Match results that have a specified value in a FieldCheckType field.
FieldRestriction | Restrict the query terms to a field.
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.
IgnoreSpecials | Ignore certain special characters.
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 result documents must have.
MatchID | Document IDs for documents that you want to return.
MatchLanguage | The language that result documents must have.
MatchLanguageType | The language type that result documents must have.
MatchReference | Document references that can return.
MaxDate | The maximum creation date that a document can have.
MaxID | The highest document ID to return.
MaxLinksPerTerm | Reduce the maximum occurrence of each term for categorization.
MaxQueryTerms | The maximum number of terms to use in the query.
MaxResults | The maximum number of results documents to examine for matches.
MaxScore | The maximum score that results can obtain.
MinDate | The minimum creation date that a document can have.
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.
QuerySort | The sort operation to use on the query results that GetQueryTagValues uses to return tag values.
ReferenceField | Restricts the DontMatchReference and MatchReference parameters to the specified reference field.
SecurityInfo | The security details.
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.
Synonym | Whether to run a synonym query.
TextParse | The format of the Text.
TimeoutMS | The period after which the action times out.
UserMetaFields | Creates a new metafield by performing a mathematical operation on document fields.
WeighFieldText | Adjusts results relevance according to FieldText matching.

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 FieldName, and at least one of the following parameters:

- Text

- FieldText

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

_FT_HTML5_bannerTitle.htm