See: newQuery smart constructor.

Create a value of Query with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:attributeFilter:Query', query_attributeFilter - Enables filtered searches based on document attributes. You can only provide one attribute filter; however, the AndAllFilters, NotFilter, and OrAllFilters parameters contain a list of other filters.

The AttributeFilter parameter enables you to create a set of filtering rules that a document must satisfy to be included in the query results.

$sel:documentRelevanceOverrideConfigurations:Query', query_documentRelevanceOverrideConfigurations - Overrides relevance tuning configurations of fields or attributes set at the index level.

If you use this API to override the relevance tuning configured at the index level, but there is no relevance tuning configured at the index level, then Amazon Kendra does not apply any relevance tuning.

If there is relevance tuning configured at the index level, but you do not use this API to override any relevance tuning in the index, then Amazon Kendra uses the relevance tuning that is configured at the index level.

If there is relevance tuning configured for fields at the index level, but you use this API to override only some of these fields, then for the fields you did not override, the importance is set to 1.

Query, query_facets - An array of documents attributes. Amazon Kendra returns a count for each attribute key specified. This helps your users narrow their search.

$sel:pageNumber:Query', query_pageNumber - Query results are returned in pages the size of the PageSize parameter. By default, Amazon Kendra returns the first page of results. Use this parameter to get result pages after the first one.

$sel:pageSize:Query', query_pageSize - Sets the number of results that are returned in each page of results. The default page size is 10. The maximum number of results returned is 100. If you ask for more than 100 results, only 100 are returned.

$sel:queryResultTypeFilter:Query', query_queryResultTypeFilter - Sets the type of query. Only results for the specified query type are returned.

$sel:queryText:Query', query_queryText - The input query text for the search. Amazon Kendra truncates queries at 30 token words, which excludes punctuation and stop words. Truncation still applies if you use Boolean or more advanced, complex queries.

$sel:requestedDocumentAttributes:Query', query_requestedDocumentAttributes - An array of document attributes to include in the response. You can limit the response to include certain document attributes. By default all document attributes are included in the response.

$sel:sortingConfiguration:Query', query_sortingConfiguration - Provides information that determines how the results of the query are sorted. You can set the field that Amazon Kendra should sort the results on, and specify whether the results should be sorted in ascending or descending order. In the case of ties in sorting the results, the results are sorted by relevance.

If you don't provide sorting configuration, the results are sorted by the relevance that Amazon Kendra determines for the result.

$sel:spellCorrectionConfiguration:Query', query_spellCorrectionConfiguration - Enables suggested spell corrections for queries.

$sel:userContext:Query', query_userContext - The user context token or user and group information.

$sel:visitorId:Query', query_visitorId - Provides an identifier for a specific user. The VisitorId should be a unique identifier, such as a GUID. Don't use personally identifiable information, such as the user's email address, as the VisitorId.

$sel:indexId:Query', query_indexId - The identifier of the index to search. The identifier is returned in the response from the CreateIndex API.

Enables filtered searches based on document attributes. You can only provide one attribute filter; however, the AndAllFilters, NotFilter, and OrAllFilters parameters contain a list of other filters.

The AttributeFilter parameter enables you to create a set of filtering rules that a document must satisfy to be included in the query results.

Overrides relevance tuning configurations of fields or attributes set at the index level.

If you use this API to override the relevance tuning configured at the index level, but there is no relevance tuning configured at the index level, then Amazon Kendra does not apply any relevance tuning.

If there is relevance tuning configured at the index level, but you do not use this API to override any relevance tuning in the index, then Amazon Kendra uses the relevance tuning that is configured at the index level.

If there is relevance tuning configured for fields at the index level, but you use this API to override only some of these fields, then for the fields you did not override, the importance is set to 1.

An array of documents attributes. Amazon Kendra returns a count for each attribute key specified. This helps your users narrow their search.

Query results are returned in pages the size of the PageSize parameter. By default, Amazon Kendra returns the first page of results. Use this parameter to get result pages after the first one.

Sets the number of results that are returned in each page of results. The default page size is 10. The maximum number of results returned is 100. If you ask for more than 100 results, only 100 are returned.

Sets the type of query. Only results for the specified query type are returned.

The input query text for the search. Amazon Kendra truncates queries at 30 token words, which excludes punctuation and stop words. Truncation still applies if you use Boolean or more advanced, complex queries.

An array of document attributes to include in the response. You can limit the response to include certain document attributes. By default all document attributes are included in the response.

Provides information that determines how the results of the query are sorted. You can set the field that Amazon Kendra should sort the results on, and specify whether the results should be sorted in ascending or descending order. In the case of ties in sorting the results, the results are sorted by relevance.

If you don't provide sorting configuration, the results are sorted by the relevance that Amazon Kendra determines for the result.

Enables suggested spell corrections for queries.

The user context token or user and group information.

Provides an identifier for a specific user. The VisitorId should be a unique identifier, such as a GUID. Don't use personally identifiable information, such as the user's email address, as the VisitorId.

The identifier of the index to search. The identifier is returned in the response from the CreateIndex API.

See: newQueryResponse smart constructor.

Create a value of QueryResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

QueryResponse, queryResponse_facetResults - Contains the facet results. A FacetResult contains the counts for each attribute key that was specified in the Facets input parameter.

$sel:queryId:QueryResponse', queryResponse_queryId - The identifier for the search. You use QueryId to identify the search when using the feedback API.

$sel:resultItems:QueryResponse', queryResponse_resultItems - The results of the search.

$sel:spellCorrectedQueries:QueryResponse', queryResponse_spellCorrectedQueries - A list of information related to suggested spell corrections for a query.

$sel:totalNumberOfResults:QueryResponse', queryResponse_totalNumberOfResults - The total number of items found by the search; however, you can only retrieve up to 100 items. For example, if the search found 192 items, you can only retrieve the first 100 of the items.

$sel:warnings:QueryResponse', queryResponse_warnings - A list of warning codes and their messages on problems with your query.

Amazon Kendra currently only supports one type of warning, which is a warning on invalid syntax used in the query. For examples of invalid query syntax, see Searching with advanced query syntax.

$sel:httpStatus:QueryResponse', queryResponse_httpStatus - The response's http status code.

Contains the facet results. A FacetResult contains the counts for each attribute key that was specified in the Facets input parameter.

The identifier for the search. You use QueryId to identify the search when using the feedback API.

The results of the search.

A list of information related to suggested spell corrections for a query.

The total number of items found by the search; however, you can only retrieve up to 100 items. For example, if the search found 192 items, you can only retrieve the first 100 of the items.

A list of warning codes and their messages on problems with your query.

Amazon Kendra currently only supports one type of warning, which is a warning on invalid syntax used in the query. For examples of invalid query syntax, see Searching with advanced query syntax.

The response's http status code.