kendra / Client / query
query#
- kendra.Client.query(**kwargs)#
Searches an index given an input query.
Note
If you are working with large language models (LLMs) or implementing retrieval augmented generation (RAG) systems, you can use Amazon Kendra’s Retrieve API, which can return longer semantically relevant passages. We recommend using the
RetrieveAPI instead of filing a service limit increase to increase theQueryAPI document excerpt length.You can configure boosting or relevance tuning at the query level to override boosting at the index level, filter based on document fields/attributes and faceted search, and filter based on the user or their group access to documents. You can also include certain fields in the response that might provide useful additional information.
A query response contains three types of results.
Relevant suggested answers. The answers can be either a text excerpt or table excerpt. The answer can be highlighted in the excerpt.
Matching FAQs or questions-answer from your FAQ file.
Relevant documents. This result type includes an excerpt of the document with the document title. The searched terms can be highlighted in the excerpt.
You can specify that the query return only one type of result using the
QueryResultTypeFilterparameter. Each query returns the 100 most relevant results. If you filter result type to only question-answers, a maximum of four results are returned. If you filter result type to only answers, a maximum of three results are returned.See also: AWS API Documentation
Request Syntax
response = client.query( IndexId='string', QueryText='string', AttributeFilter={ 'AndAllFilters': [ {'... recursive ...'}, ], 'OrAllFilters': [ {'... recursive ...'}, ], 'NotFilter': {'... recursive ...'}, 'EqualsTo': { 'Key': 'string', 'Value': { 'StringValue': 'string', 'StringListValue': [ 'string', ], 'LongValue': 123, 'DateValue': datetime(2015, 1, 1) } }, 'ContainsAll': { 'Key': 'string', 'Value': { 'StringValue': 'string', 'StringListValue': [ 'string', ], 'LongValue': 123, 'DateValue': datetime(2015, 1, 1) } }, 'ContainsAny': { 'Key': 'string', 'Value': { 'StringValue': 'string', 'StringListValue': [ 'string', ], 'LongValue': 123, 'DateValue': datetime(2015, 1, 1) } }, 'GreaterThan': { 'Key': 'string', 'Value': { 'StringValue': 'string', 'StringListValue': [ 'string', ], 'LongValue': 123, 'DateValue': datetime(2015, 1, 1) } }, 'GreaterThanOrEquals': { 'Key': 'string', 'Value': { 'StringValue': 'string', 'StringListValue': [ 'string', ], 'LongValue': 123, 'DateValue': datetime(2015, 1, 1) } }, 'LessThan': { 'Key': 'string', 'Value': { 'StringValue': 'string', 'StringListValue': [ 'string', ], 'LongValue': 123, 'DateValue': datetime(2015, 1, 1) } }, 'LessThanOrEquals': { 'Key': 'string', 'Value': { 'StringValue': 'string', 'StringListValue': [ 'string', ], 'LongValue': 123, 'DateValue': datetime(2015, 1, 1) } } }, Facets=[ { 'DocumentAttributeKey': 'string', 'Facets': {'... recursive ...'}, 'MaxResults': 123 }, ], RequestedDocumentAttributes=[ 'string', ], QueryResultTypeFilter='DOCUMENT'|'QUESTION_ANSWER'|'ANSWER', DocumentRelevanceOverrideConfigurations=[ { 'Name': 'string', 'Relevance': { 'Freshness': True|False, 'Importance': 123, 'Duration': 'string', 'RankOrder': 'ASCENDING'|'DESCENDING', 'ValueImportanceMap': { 'string': 123 } } }, ], PageNumber=123, PageSize=123, SortingConfiguration={ 'DocumentAttributeKey': 'string', 'SortOrder': 'DESC'|'ASC' }, SortingConfigurations=[ { 'DocumentAttributeKey': 'string', 'SortOrder': 'DESC'|'ASC' }, ], UserContext={ 'Token': 'string', 'UserId': 'string', 'Groups': [ 'string', ], 'DataSourceGroups': [ { 'GroupId': 'string', 'DataSourceId': 'string' }, ] }, VisitorId='string', SpellCorrectionConfiguration={ 'IncludeQuerySpellCheckSuggestions': True|False }, CollapseConfiguration={ 'DocumentAttributeKey': 'string', 'SortingConfigurations': [ { 'DocumentAttributeKey': 'string', 'SortOrder': 'DESC'|'ASC' }, ], 'MissingAttributeKeyStrategy': 'IGNORE'|'COLLAPSE'|'EXPAND', 'Expand': True|False, 'ExpandConfiguration': { 'MaxResultItemsToExpand': 123, 'MaxExpandedResultsPerItem': 123 } } )
- Parameters:
IndexId (string) –
[REQUIRED]
The identifier of the index for the search.
QueryText (string) – 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. For example,
Timeoff AND October AND Category:HRis counted as 3 tokens:timeoff,october,hr. For more information, see Searching with advanced query syntax in the Amazon Kendra Developer Guide.AttributeFilter (dict) –
Filters search results by document fields/attributes. You can only provide one attribute filter; however, the
AndAllFilters,NotFilter, andOrAllFiltersparameters contain a list of other filters.The
AttributeFilterparameter means you can create a set of filtering rules that a document must satisfy to be included in the query results.AndAllFilters (list) –
Performs a logical
ANDoperation on all filters that you specify.(dict) –
Filters the search results based on document attributes or fields.
You can filter results using attributes for your particular documents. The attributes must exist in your index. For example, if your documents include the custom attribute “Department”, you can filter documents that belong to the “HR” department. You would use the
EqualsTooperation to filter results or documents with “Department” equals to “HR”.You can use
AndAllFiltersandAndOrFiltersin combination with each other or with other operations such asEqualsTo. For example:AndAllFiltersEqualsTo: “Department”, “HR”AndOrFiltersContainsAny: “Project Name”, [“new hires”, “new hiring”]
This example filters results or documents that belong to the HR department and belong to projects that contain “new hires” or “new hiring” in the project name (must use
ContainAnywithStringListValue). This example is filtering with a depth of 2.You cannot filter more than a depth of 2, otherwise you receive a
ValidationExceptionexception with the message “AttributeFilter cannot have a depth of more than 2.” Also, if you use more than 10 attribute filters in a given list forAndAllFiltersorOrAllFilters, you receive aValidationExceptionwith the message “AttributeFilter cannot have a length of more than 10”.For examples of using
AttributeFilter, see Using document attributes to filter search results.
OrAllFilters (list) –
Performs a logical
ORoperation on all filters that you specify.(dict) –
Filters the search results based on document attributes or fields.
You can filter results using attributes for your particular documents. The attributes must exist in your index. For example, if your documents include the custom attribute “Department”, you can filter documents that belong to the “HR” department. You would use the
EqualsTooperation to filter results or documents with “Department” equals to “HR”.You can use
AndAllFiltersandAndOrFiltersin combination with each other or with other operations such asEqualsTo. For example:AndAllFiltersEqualsTo: “Department”, “HR”AndOrFiltersContainsAny: “Project Name”, [“new hires”, “new hiring”]
This example filters results or documents that belong to the HR department and belong to projects that contain “new hires” or “new hiring” in the project name (must use
ContainAnywithStringListValue). This example is filtering with a depth of 2.You cannot filter more than a depth of 2, otherwise you receive a
ValidationExceptionexception with the message “AttributeFilter cannot have a depth of more than 2.” Also, if you use more than 10 attribute filters in a given list forAndAllFiltersorOrAllFilters, you receive aValidationExceptionwith the message “AttributeFilter cannot have a length of more than 10”.For examples of using
AttributeFilter, see Using document attributes to filter search results.
NotFilter (dict) –
Performs a logical
NOToperation on all filters that you specify.EqualsTo (dict) –
Performs an equals operation on document attributes/fields and their values.
Key (string) – [REQUIRED]
The identifier for the attribute.
Value (dict) – [REQUIRED]
The value of the attribute.
StringValue (string) –
A string, such as “department”.
StringListValue (list) –
A list of strings. The default maximum length or number of strings is 10.
(string) –
LongValue (integer) –
A long integer value.
DateValue (datetime) –
A date expressed as an ISO 8601 string.
It is important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
ContainsAll (dict) –
Returns true when a document contains all of the specified document attributes/fields. This filter is only applicable to StringListValue.
Key (string) – [REQUIRED]
The identifier for the attribute.
Value (dict) – [REQUIRED]
The value of the attribute.
StringValue (string) –
A string, such as “department”.
StringListValue (list) –
A list of strings. The default maximum length or number of strings is 10.
(string) –
LongValue (integer) –
A long integer value.
DateValue (datetime) –
A date expressed as an ISO 8601 string.
It is important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
ContainsAny (dict) –
Returns true when a document contains any of the specified document attributes/fields. This filter is only applicable to StringListValue.
Key (string) – [REQUIRED]
The identifier for the attribute.
Value (dict) – [REQUIRED]
The value of the attribute.
StringValue (string) –
A string, such as “department”.
StringListValue (list) –
A list of strings. The default maximum length or number of strings is 10.
(string) –
LongValue (integer) –
A long integer value.
DateValue (datetime) –
A date expressed as an ISO 8601 string.
It is important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
GreaterThan (dict) –
Performs a greater than operation on document attributes/fields and their values. Use with the document attribute type
DateorLong.Key (string) – [REQUIRED]
The identifier for the attribute.
Value (dict) – [REQUIRED]
The value of the attribute.
StringValue (string) –
A string, such as “department”.
StringListValue (list) –
A list of strings. The default maximum length or number of strings is 10.
(string) –
LongValue (integer) –
A long integer value.
DateValue (datetime) –
A date expressed as an ISO 8601 string.
It is important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
GreaterThanOrEquals (dict) –
Performs a greater or equals than operation on document attributes/fields and their values. Use with the document attribute type
DateorLong.Key (string) – [REQUIRED]
The identifier for the attribute.
Value (dict) – [REQUIRED]
The value of the attribute.
StringValue (string) –
A string, such as “department”.
StringListValue (list) –
A list of strings. The default maximum length or number of strings is 10.
(string) –
LongValue (integer) –
A long integer value.
DateValue (datetime) –
A date expressed as an ISO 8601 string.
It is important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
LessThan (dict) –
Performs a less than operation on document attributes/fields and their values. Use with the document attribute type
DateorLong.Key (string) – [REQUIRED]
The identifier for the attribute.
Value (dict) – [REQUIRED]
The value of the attribute.
StringValue (string) –
A string, such as “department”.
StringListValue (list) –
A list of strings. The default maximum length or number of strings is 10.
(string) –
LongValue (integer) –
A long integer value.
DateValue (datetime) –
A date expressed as an ISO 8601 string.
It is important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
LessThanOrEquals (dict) –
Performs a less than or equals operation on document attributes/fields and their values. Use with the document attribute type
DateorLong.Key (string) – [REQUIRED]
The identifier for the attribute.
Value (dict) – [REQUIRED]
The value of the attribute.
StringValue (string) –
A string, such as “department”.
StringListValue (list) –
A list of strings. The default maximum length or number of strings is 10.
(string) –
LongValue (integer) –
A long integer value.
DateValue (datetime) –
A date expressed as an ISO 8601 string.
It is important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
Facets (list) –
An array of documents fields/attributes for faceted search. Amazon Kendra returns a count for each field key specified. This helps your users narrow their search.
(dict) –
Information about a document attribute or field. You can use document attributes as facets.
For example, the document attribute or facet “Department” includes the values “HR”, “Engineering”, and “Accounting”. You can display these values in the search results so that documents can be searched by department.
You can display up to 10 facet values per facet for a query. If you want to increase this limit, contact Support.
DocumentAttributeKey (string) –
The unique key for the document attribute.
Facets (list) –
An array of document attributes that are nested facets within a facet.
For example, the document attribute or facet “Department” includes a value called “Engineering”. In addition, the document attribute or facet “SubDepartment” includes the values “Frontend” and “Backend” for documents assigned to “Engineering”. You can display nested facets in the search results so that documents can be searched not only by department but also by a sub department within a department. This helps your users further narrow their search.
You can only have one nested facet within a facet. If you want to increase this limit, contact Support.
MaxResults (integer) –
Maximum number of facet values per facet. The default is 10. You can use this to limit the number of facet values to less than 10. If you want to increase the default, contact Support.
RequestedDocumentAttributes (list) –
An array of document fields/attributes to include in the response. You can limit the response to include certain document fields. By default, all document attributes are included in the response.
(string) –
QueryResultTypeFilter (string) – Sets the type of query result or response. Only results for the specified type are returned.
DocumentRelevanceOverrideConfigurations (list) –
Overrides relevance tuning configurations of fields/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 for fields at the index level, and 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.
(dict) –
Overrides the document relevance properties of a custom index field.
Name (string) – [REQUIRED]
The name of the index field.
Relevance (dict) – [REQUIRED]
Provides information for tuning the relevance of a field in a search. When a query includes terms that match the field, the results are given a boost in the response based on these tuning parameters.
Freshness (boolean) –
Indicates that this field determines how “fresh” a document is. For example, if document 1 was created on November 5, and document 2 was created on October 31, document 1 is “fresher” than document 2. Only applies to
DATEfields.Importance (integer) –
The relative importance of the field in the search. Larger numbers provide more of a boost than smaller numbers.
Duration (string) –
Specifies the time period that the boost applies to. For example, to make the boost apply to documents with the field value within the last month, you would use “2628000s”. Once the field value is beyond the specified range, the effect of the boost drops off. The higher the importance, the faster the effect drops off. If you don’t specify a value, the default is 3 months. The value of the field is a numeric string followed by the character “s”, for example “86400s” for one day, or “604800s” for one week.
Only applies to
DATEfields.RankOrder (string) –
Determines how values should be interpreted.
When the
RankOrderfield isASCENDING, higher numbers are better. For example, a document with a rating score of 10 is higher ranking than a document with a rating score of 1.When the
RankOrderfield isDESCENDING, lower numbers are better. For example, in a task tracking application, a priority 1 task is more important than a priority 5 task.Only applies to
LONGfields.ValueImportanceMap (dict) –
A list of values that should be given a different boost when they appear in the result list. For example, if you are boosting a field called “department”, query terms that match the department field are boosted in the result. However, you can add entries from the department field to boost documents with those values higher.
For example, you can add entries to the map with names of departments. If you add “HR”,5 and “Legal”,3 those departments are given special attention when they appear in the metadata of a document. When those terms appear they are given the specified importance instead of the regular importance for the boost.
(string) –
(integer) –
PageNumber (integer) – Query results are returned in pages the size of the
PageSizeparameter. By default, Amazon Kendra returns the first page of results. Use this parameter to get result pages after the first one.PageSize (integer) – 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.
SortingConfiguration (dict) –
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.
DocumentAttributeKey (string) – [REQUIRED]
The name of the document attribute used to sort the response. You can use any field that has the
Sortableflag set to true.You can also sort by any of the following built-in attributes:
_category
_created_at
_last_updated_at
_version
_view_count
SortOrder (string) – [REQUIRED]
The order that the results should be returned in. In case of ties, the relevance assigned to the result by Amazon Kendra is used as the tie-breaker.
SortingConfigurations (list) –
Provides configuration information to determine how the results of a query are sorted.
You can set upto 3 fields that Amazon Kendra should sort the results on, and specify whether the results should be sorted in ascending or descending order. The sort field quota can be increased.
If you don’t provide a sorting configuration, the results are sorted by the relevance that Amazon Kendra determines for the result. In the case of ties in sorting the results, the results are sorted by relevance.
(dict) –
Specifies the document attribute to use to sort the response to a Amazon Kendra query. You can specify a single attribute for sorting. The attribute must have the
Sortableflag set totrue, otherwise Amazon Kendra returns an exception.You can sort attributes of the following types.
Date value
Long value
String value
You can’t sort attributes of the following type.
String list value
DocumentAttributeKey (string) – [REQUIRED]
The name of the document attribute used to sort the response. You can use any field that has the
Sortableflag set to true.You can also sort by any of the following built-in attributes:
_category
_created_at
_last_updated_at
_version
_view_count
SortOrder (string) – [REQUIRED]
The order that the results should be returned in. In case of ties, the relevance assigned to the result by Amazon Kendra is used as the tie-breaker.
UserContext (dict) –
The user context token or user and group information.
Token (string) –
The user context token for filtering search results for a user. It must be a JWT or a JSON token.
UserId (string) –
The identifier of the user you want to filter search results based on their access to documents.
Groups (list) –
The list of groups you want to filter search results based on the groups’ access to documents.
(string) –
DataSourceGroups (list) –
The list of data source groups you want to filter search results based on groups’ access to documents in that data source.
(dict) –
Data source information for user context filtering.
GroupId (string) – [REQUIRED]
The identifier of the group you want to add to your list of groups. This is for filtering search results based on the groups’ access to documents.
DataSourceId (string) – [REQUIRED]
The identifier of the data source group you want to add to your list of data source groups. This is for filtering search results based on the groups’ access to documents in that data source.
VisitorId (string) – Provides an identifier for a specific user. The
VisitorIdshould be a unique identifier, such as a GUID. Don’t use personally identifiable information, such as the user’s email address, as theVisitorId.SpellCorrectionConfiguration (dict) –
Enables suggested spell corrections for queries.
IncludeQuerySpellCheckSuggestions (boolean) – [REQUIRED]
TRUEto suggest spell corrections for queries.
CollapseConfiguration (dict) –
Provides configuration to determine how to group results by document attribute value, and how to display them (collapsed or expanded) under a designated primary document for each group.
DocumentAttributeKey (string) – [REQUIRED]
The document attribute used to group search results. You can use any attribute that has the
Sortableflag set to true. You can also sort by any of the following built-in attributes:”_category”,”_created_at”, “_last_updated_at”, “_version”, “_view_count”.SortingConfigurations (list) –
A prioritized list of document attributes/fields that determine the primary document among those in a collapsed group.
(dict) –
Specifies the document attribute to use to sort the response to a Amazon Kendra query. You can specify a single attribute for sorting. The attribute must have the
Sortableflag set totrue, otherwise Amazon Kendra returns an exception.You can sort attributes of the following types.
Date value
Long value
String value
You can’t sort attributes of the following type.
String list value
DocumentAttributeKey (string) – [REQUIRED]
The name of the document attribute used to sort the response. You can use any field that has the
Sortableflag set to true.You can also sort by any of the following built-in attributes:
_category
_created_at
_last_updated_at
_version
_view_count
SortOrder (string) – [REQUIRED]
The order that the results should be returned in. In case of ties, the relevance assigned to the result by Amazon Kendra is used as the tie-breaker.
MissingAttributeKeyStrategy (string) –
Specifies the behavior for documents without a value for the collapse attribute.
Amazon Kendra offers three customization options:
Choose to
COLLAPSEall documents with null or missing values in one group. This is the default configuration.Choose to
IGNOREdocuments with null or missing values. Ignored documents will not appear in query results.Choose to
EXPANDeach document with a null or missing value into a group of its own.
Expand (boolean) –
Specifies whether to expand the collapsed results.
ExpandConfiguration (dict) –
Provides configuration information to customize expansion options for a collapsed group.
MaxResultItemsToExpand (integer) –
The number of collapsed search result groups to expand. If you set this value to 10, for example, only the first 10 out of 100 result groups will have expand functionality.
MaxExpandedResultsPerItem (integer) –
The number of expanded results to show per collapsed primary document. For instance, if you set this value to 3, then at most 3 results per collapsed group will be displayed.
- Return type:
dict
- Returns:
Response Syntax
{ 'QueryId': 'string', 'ResultItems': [ { 'Id': 'string', 'Type': 'DOCUMENT'|'QUESTION_ANSWER'|'ANSWER', 'Format': 'TABLE'|'TEXT', 'AdditionalAttributes': [ { 'Key': 'string', 'ValueType': 'TEXT_WITH_HIGHLIGHTS_VALUE', 'Value': { 'TextWithHighlightsValue': { 'Text': 'string', 'Highlights': [ { 'BeginOffset': 123, 'EndOffset': 123, 'TopAnswer': True|False, 'Type': 'STANDARD'|'THESAURUS_SYNONYM' }, ] } } }, ], 'DocumentId': 'string', 'DocumentTitle': { 'Text': 'string', 'Highlights': [ { 'BeginOffset': 123, 'EndOffset': 123, 'TopAnswer': True|False, 'Type': 'STANDARD'|'THESAURUS_SYNONYM' }, ] }, 'DocumentExcerpt': { 'Text': 'string', 'Highlights': [ { 'BeginOffset': 123, 'EndOffset': 123, 'TopAnswer': True|False, 'Type': 'STANDARD'|'THESAURUS_SYNONYM' }, ] }, 'DocumentURI': 'string', 'DocumentAttributes': [ { 'Key': 'string', 'Value': { 'StringValue': 'string', 'StringListValue': [ 'string', ], 'LongValue': 123, 'DateValue': datetime(2015, 1, 1) } }, ], 'ScoreAttributes': { 'ScoreConfidence': 'VERY_HIGH'|'HIGH'|'MEDIUM'|'LOW'|'NOT_AVAILABLE' }, 'FeedbackToken': 'string', 'TableExcerpt': { 'Rows': [ { 'Cells': [ { 'Value': 'string', 'TopAnswer': True|False, 'Highlighted': True|False, 'Header': True|False }, ] }, ], 'TotalNumberOfRows': 123 }, 'CollapsedResultDetail': { 'DocumentAttribute': { 'Key': 'string', 'Value': { 'StringValue': 'string', 'StringListValue': [ 'string', ], 'LongValue': 123, 'DateValue': datetime(2015, 1, 1) } }, 'ExpandedResults': [ { 'Id': 'string', 'DocumentId': 'string', 'DocumentTitle': { 'Text': 'string', 'Highlights': [ { 'BeginOffset': 123, 'EndOffset': 123, 'TopAnswer': True|False, 'Type': 'STANDARD'|'THESAURUS_SYNONYM' }, ] }, 'DocumentExcerpt': { 'Text': 'string', 'Highlights': [ { 'BeginOffset': 123, 'EndOffset': 123, 'TopAnswer': True|False, 'Type': 'STANDARD'|'THESAURUS_SYNONYM' }, ] }, 'DocumentURI': 'string', 'DocumentAttributes': [ { 'Key': 'string', 'Value': { 'StringValue': 'string', 'StringListValue': [ 'string', ], 'LongValue': 123, 'DateValue': datetime(2015, 1, 1) } }, ] }, ] } }, ], 'FacetResults': [ { 'DocumentAttributeKey': 'string', 'DocumentAttributeValueType': 'STRING_VALUE'|'STRING_LIST_VALUE'|'LONG_VALUE'|'DATE_VALUE', 'DocumentAttributeValueCountPairs': [ { 'DocumentAttributeValue': { 'StringValue': 'string', 'StringListValue': [ 'string', ], 'LongValue': 123, 'DateValue': datetime(2015, 1, 1) }, 'Count': 123, 'FacetResults': {'... recursive ...'} }, ] }, ], 'TotalNumberOfResults': 123, 'Warnings': [ { 'Message': 'string', 'Code': 'QUERY_LANGUAGE_INVALID_SYNTAX' }, ], 'SpellCorrectedQueries': [ { 'SuggestedQueryText': 'string', 'Corrections': [ { 'BeginOffset': 123, 'EndOffset': 123, 'Term': 'string', 'CorrectedTerm': 'string' }, ] }, ], 'FeaturedResultsItems': [ { 'Id': 'string', 'Type': 'DOCUMENT'|'QUESTION_ANSWER'|'ANSWER', 'AdditionalAttributes': [ { 'Key': 'string', 'ValueType': 'TEXT_WITH_HIGHLIGHTS_VALUE', 'Value': { 'TextWithHighlightsValue': { 'Text': 'string', 'Highlights': [ { 'BeginOffset': 123, 'EndOffset': 123, 'TopAnswer': True|False, 'Type': 'STANDARD'|'THESAURUS_SYNONYM' }, ] } } }, ], 'DocumentId': 'string', 'DocumentTitle': { 'Text': 'string', 'Highlights': [ { 'BeginOffset': 123, 'EndOffset': 123, 'TopAnswer': True|False, 'Type': 'STANDARD'|'THESAURUS_SYNONYM' }, ] }, 'DocumentExcerpt': { 'Text': 'string', 'Highlights': [ { 'BeginOffset': 123, 'EndOffset': 123, 'TopAnswer': True|False, 'Type': 'STANDARD'|'THESAURUS_SYNONYM' }, ] }, 'DocumentURI': 'string', 'DocumentAttributes': [ { 'Key': 'string', 'Value': { 'StringValue': 'string', 'StringListValue': [ 'string', ], 'LongValue': 123, 'DateValue': datetime(2015, 1, 1) } }, ], 'FeedbackToken': 'string' }, ] }
Response Structure
(dict) –
QueryId (string) –
The identifier for the search. You also use
QueryIdto identify the search when using the SubmitFeedback API.ResultItems (list) –
The results of the search.
(dict) –
A single query result.
A query result contains information about a document returned by the query. This includes the original location of the document, a list of attributes assigned to the document, and relevant text from the document that satisfies the query.
Id (string) –
The unique identifier for the query result item id (
Id) and the query result item document id (DocumentId) combined. The value of this field changes with every request, even when you have the same documents.Type (string) –
The type of document within the response. For example, a response could include a question-answer that’s relevant to the query.
Format (string) –
If the
Typeof document within the response isANSWER, then it is either aTABLEanswer orTEXTanswer. If it’s a table answer, a table excerpt is returned inTableExcerpt. If it’s a text answer, a text excerpt is returned inDocumentExcerpt.AdditionalAttributes (list) –
One or more additional fields/attributes associated with the query result.
(dict) –
An attribute returned from an index query.
Key (string) –
The key that identifies the attribute.
ValueType (string) –
The data type of the
Valueproperty.Value (dict) –
An object that contains the attribute value.
TextWithHighlightsValue (dict) –
The text associated with the attribute and information about the highlight to apply to the text.
Text (string) –
The text to display to the user.
Highlights (list) –
The beginning and end of the text that should be highlighted.
(dict) –
Provides information that you can use to highlight a search result so that your users can quickly identify terms in the response.
BeginOffset (integer) –
The zero-based location in the response string where the highlight starts.
EndOffset (integer) –
The zero-based location in the response string where the highlight ends.
TopAnswer (boolean) –
Indicates whether the response is the best response. True if this is the best response; otherwise, false.
Type (string) –
The highlight type.
DocumentId (string) –
The identifier for the document.
DocumentTitle (dict) –
The title of the document. Contains the text of the title and information for highlighting the relevant terms in the title.
Text (string) –
The text to display to the user.
Highlights (list) –
The beginning and end of the text that should be highlighted.
(dict) –
Provides information that you can use to highlight a search result so that your users can quickly identify terms in the response.
BeginOffset (integer) –
The zero-based location in the response string where the highlight starts.
EndOffset (integer) –
The zero-based location in the response string where the highlight ends.
TopAnswer (boolean) –
Indicates whether the response is the best response. True if this is the best response; otherwise, false.
Type (string) –
The highlight type.
DocumentExcerpt (dict) –
An extract of the text in the document. Contains information about highlighting the relevant terms in the excerpt.
Text (string) –
The text to display to the user.
Highlights (list) –
The beginning and end of the text that should be highlighted.
(dict) –
Provides information that you can use to highlight a search result so that your users can quickly identify terms in the response.
BeginOffset (integer) –
The zero-based location in the response string where the highlight starts.
EndOffset (integer) –
The zero-based location in the response string where the highlight ends.
TopAnswer (boolean) –
Indicates whether the response is the best response. True if this is the best response; otherwise, false.
Type (string) –
The highlight type.
DocumentURI (string) –
The URI of the original location of the document.
DocumentAttributes (list) –
An array of document fields/attributes assigned to a document in the search results. For example, the document author (
_author) or the source URI (_source_uri) of the document.(dict) –
A document attribute or metadata field. To create custom document attributes, see Custom attributes.
Key (string) –
The identifier for the attribute.
Value (dict) –
The value of the attribute.
StringValue (string) –
A string, such as “department”.
StringListValue (list) –
A list of strings. The default maximum length or number of strings is 10.
(string) –
LongValue (integer) –
A long integer value.
DateValue (datetime) –
A date expressed as an ISO 8601 string.
It is important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
ScoreAttributes (dict) –
Indicates the confidence level of Amazon Kendra providing a relevant result for the query. Each result is placed into a bin that indicates the confidence,
VERY_HIGH,HIGH,MEDIUMandLOW. You can use the score to determine if a response meets the confidence needed for your application.The field is only set to
LOWwhen theTypefield is set toDOCUMENTand Amazon Kendra is not confident that the result is relevant to the query.ScoreConfidence (string) –
A relative ranking for how relevant the response is to the query.
FeedbackToken (string) –
A token that identifies a particular result from a particular query. Use this token to provide click-through feedback for the result. For more information, see Submitting feedback.
TableExcerpt (dict) –
An excerpt from a table within a document.
Rows (list) –
A list of rows in the table excerpt.
(dict) –
Information about a row in a table excerpt.
Cells (list) –
A list of table cells in a row.
(dict) –
Provides information about a table cell in a table excerpt.
Value (string) –
The actual value or content within a table cell. A table cell could contain a date value of a year, or a string value of text, for example.
TopAnswer (boolean) –
TRUEif the response of the table cell is the top answer. This is the cell value or content with the highest confidence score or is the most relevant to the query.Highlighted (boolean) –
TRUEmeans that the table cell has a high enough confidence and is relevant to the query, so the value or content should be highlighted.Header (boolean) –
TRUEmeans that the table cell should be treated as a header.
TotalNumberOfRows (integer) –
A count of the number of rows in the original table within the document.
CollapsedResultDetail (dict) –
Provides details about a collapsed group of search results.
DocumentAttribute (dict) –
The value of the document attribute that results are collapsed on.
Key (string) –
The identifier for the attribute.
Value (dict) –
The value of the attribute.
StringValue (string) –
A string, such as “department”.
StringListValue (list) –
A list of strings. The default maximum length or number of strings is 10.
(string) –
LongValue (integer) –
A long integer value.
DateValue (datetime) –
A date expressed as an ISO 8601 string.
It is important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
ExpandedResults (list) –
A list of results in the collapsed group.
(dict) –
A single expanded result in a collapsed group of search results.
An expanded result item contains information about an expanded result document within a collapsed group of search results. This includes the original location of the document, a list of attributes assigned to the document, and relevant text from the document that satisfies the query.
Id (string) –
The identifier for the expanded result.
DocumentId (string) –
The idenitifier of the document.
DocumentTitle (dict) –
Provides text and information about where to highlight the text.
Text (string) –
The text to display to the user.
Highlights (list) –
The beginning and end of the text that should be highlighted.
(dict) –
Provides information that you can use to highlight a search result so that your users can quickly identify terms in the response.
BeginOffset (integer) –
The zero-based location in the response string where the highlight starts.
EndOffset (integer) –
The zero-based location in the response string where the highlight ends.
TopAnswer (boolean) –
Indicates whether the response is the best response. True if this is the best response; otherwise, false.
Type (string) –
The highlight type.
DocumentExcerpt (dict) –
Provides text and information about where to highlight the text.
Text (string) –
The text to display to the user.
Highlights (list) –
The beginning and end of the text that should be highlighted.
(dict) –
Provides information that you can use to highlight a search result so that your users can quickly identify terms in the response.
BeginOffset (integer) –
The zero-based location in the response string where the highlight starts.
EndOffset (integer) –
The zero-based location in the response string where the highlight ends.
TopAnswer (boolean) –
Indicates whether the response is the best response. True if this is the best response; otherwise, false.
Type (string) –
The highlight type.
DocumentURI (string) –
The URI of the original location of the document.
DocumentAttributes (list) –
An array of document attributes assigned to a document in the search results. For example, the document author (“_author”) or the source URI (“_source_uri”) of the document.
(dict) –
A document attribute or metadata field. To create custom document attributes, see Custom attributes.
Key (string) –
The identifier for the attribute.
Value (dict) –
The value of the attribute.
StringValue (string) –
A string, such as “department”.
StringListValue (list) –
A list of strings. The default maximum length or number of strings is 10.
(string) –
LongValue (integer) –
A long integer value.
DateValue (datetime) –
A date expressed as an ISO 8601 string.
It is important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
FacetResults (list) –
Contains the facet results. A
FacetResultcontains the counts for each field/attribute key that was specified in theFacetsinput parameter.(dict) –
The facet values for the documents in the response.
DocumentAttributeKey (string) –
The key for the facet values. This is the same as the
DocumentAttributeKeyprovided in the query.DocumentAttributeValueType (string) –
The data type of the facet value. This is the same as the type defined for the index field when it was created.
DocumentAttributeValueCountPairs (list) –
An array of key/value pairs, where the key is the value of the attribute and the count is the number of documents that share the key value.
(dict) –
Provides the count of documents that match a particular document attribute or field when doing a faceted search.
DocumentAttributeValue (dict) –
The value of the attribute/field. For example, “HR”.
StringValue (string) –
A string, such as “department”.
StringListValue (list) –
A list of strings. The default maximum length or number of strings is 10.
(string) –
LongValue (integer) –
A long integer value.
DateValue (datetime) –
A date expressed as an ISO 8601 string.
It is important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
Count (integer) –
The number of documents in the response that have the attribute/field value for the key.
FacetResults (list) –
Contains the results of a document attribute/field that is a nested facet. A
FacetResultcontains the counts for each facet nested within a facet.For example, the document attribute or facet “Department” includes a value called “Engineering”. In addition, the document attribute or facet “SubDepartment” includes the values “Frontend” and “Backend” for documents assigned to “Engineering”. You can display nested facets in the search results so that documents can be searched not only by department but also by a sub department within a department. The counts for documents that belong to “Frontend” and “Backend” within “Engineering” are returned for a query.
TotalNumberOfResults (integer) –
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.
Warnings (list) –
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.
(dict) –
The warning code and message that explains a problem with a query.
Message (string) –
The message that explains the problem with the query.
Code (string) –
The code used to show the type of warning for the query.
SpellCorrectedQueries (list) –
A list of information related to suggested spell corrections for a query.
(dict) –
A query with suggested spell corrections.
SuggestedQueryText (string) –
The query with the suggested spell corrections.
Corrections (list) –
The corrected misspelled word or words in a query.
(dict) –
A corrected misspelled word in a query.
BeginOffset (integer) –
The zero-based location in the response string or text where the corrected word starts.
EndOffset (integer) –
The zero-based location in the response string or text where the corrected word ends.
Term (string) –
The string or text of a misspelled word in a query.
CorrectedTerm (string) –
The string or text of a corrected misspelled word in a query.
FeaturedResultsItems (list) –
The list of featured result items. Featured results are displayed at the top of the search results page, placed above all other results for certain queries. If there’s an exact match of a query, then certain documents are featured in the search results.
(dict) –
A single featured result item. A featured result is displayed at the top of the search results page, placed above all other results for certain queries. If there’s an exact match of a query, then certain documents are featured in the search results.
Id (string) –
The identifier of the featured result.
Type (string) –
The type of document within the featured result response. For example, a response could include a question-answer type that’s relevant to the query.
AdditionalAttributes (list) –
One or more additional attributes associated with the featured result.
(dict) –
An attribute returned from an index query.
Key (string) –
The key that identifies the attribute.
ValueType (string) –
The data type of the
Valueproperty.Value (dict) –
An object that contains the attribute value.
TextWithHighlightsValue (dict) –
The text associated with the attribute and information about the highlight to apply to the text.
Text (string) –
The text to display to the user.
Highlights (list) –
The beginning and end of the text that should be highlighted.
(dict) –
Provides information that you can use to highlight a search result so that your users can quickly identify terms in the response.
BeginOffset (integer) –
The zero-based location in the response string where the highlight starts.
EndOffset (integer) –
The zero-based location in the response string where the highlight ends.
TopAnswer (boolean) –
Indicates whether the response is the best response. True if this is the best response; otherwise, false.
Type (string) –
The highlight type.
DocumentId (string) –
The identifier of the featured document.
DocumentTitle (dict) –
Provides text and information about where to highlight the text.
Text (string) –
The text to display to the user.
Highlights (list) –
The beginning and end of the text that should be highlighted.
(dict) –
Provides information that you can use to highlight a search result so that your users can quickly identify terms in the response.
BeginOffset (integer) –
The zero-based location in the response string where the highlight starts.
EndOffset (integer) –
The zero-based location in the response string where the highlight ends.
TopAnswer (boolean) –
Indicates whether the response is the best response. True if this is the best response; otherwise, false.
Type (string) –
The highlight type.
DocumentExcerpt (dict) –
Provides text and information about where to highlight the text.
Text (string) –
The text to display to the user.
Highlights (list) –
The beginning and end of the text that should be highlighted.
(dict) –
Provides information that you can use to highlight a search result so that your users can quickly identify terms in the response.
BeginOffset (integer) –
The zero-based location in the response string where the highlight starts.
EndOffset (integer) –
The zero-based location in the response string where the highlight ends.
TopAnswer (boolean) –
Indicates whether the response is the best response. True if this is the best response; otherwise, false.
Type (string) –
The highlight type.
DocumentURI (string) –
The source URI location of the featured document.
DocumentAttributes (list) –
An array of document attributes assigned to a featured document in the search results. For example, the document author (
_author) or the source URI (_source_uri) of the document.(dict) –
A document attribute or metadata field. To create custom document attributes, see Custom attributes.
Key (string) –
The identifier for the attribute.
Value (dict) –
The value of the attribute.
StringValue (string) –
A string, such as “department”.
StringListValue (list) –
A list of strings. The default maximum length or number of strings is 10.
(string) –
LongValue (integer) –
A long integer value.
DateValue (datetime) –
A date expressed as an ISO 8601 string.
It is important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
FeedbackToken (string) –
A token that identifies a particular featured result from a particular query. Use this token to provide click-through feedback for the result. For more information, see Submitting feedback.
Exceptions