Searches an active index. Use this API to search your documents using query. The Query operation enables to do faceted search and to filter results based on document attributes.
It also enables you to provide user context that Amazon Kendra uses to enforce document access control in the search results.
Amazon Kendra searches your index for text content and question and answer (FAQ) content. By default the response contains three types of results.
Relevant passages
Matching FAQs
Relevant documents
You can specify that the query return only one type of result using the QueryResultTypeConfig parameter.
Searches an active index. Use this API to search your documents using query. The Query operation enables to do faceted search and to filter results based on document attributes.
It also enables you to provide user context that Amazon Kendra uses to enforce document access control in the search results.
Amazon Kendra searches your index for text content and question and answer (FAQ) content. By default the response contains three types of results.
Relevant passages
Matching FAQs
Relevant documents
You can specify that the query return only one type of result using the QueryResultTypeConfig parameter.
Each query returns the 100 most relevant results.
" }, "StartDataSourceSyncJob":{ "name":"StartDataSourceSyncJob", @@ -916,7 +916,7 @@ }, "Edition":{ "shape":"IndexEdition", - "documentation":"The Amazon Kendra edition to use for the index. Choose DEVELOPER_EDITION for indexes intended for development, testing, or proof of concept. Use ENTERPRISE_EDITION for your production databases. Once you set the edition for an index, it can't be changed.
The Amazon Kendra edition to use for the index. Choose DEVELOPER_EDITION for indexes intended for development, testing, or proof of concept. Use ENTERPRISE_EDITION for your production databases. Once you set the edition for an index, it can't be changed.
The Edition parameter is optional. If you don't supply a value, the default is ENTERPRISE_EDITION.
The key for the facet values. This is the same as the DocumentAttributeKey provided in the query.
The data type of the facet value. This is the same as the type defined for the index field when it was created.
" + }, "DocumentAttributeValueCountPairs":{ "shape":"DocumentAttributeValueCountPairList", "documentation":"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.
" @@ -2347,7 +2351,7 @@ }, "TotalNumberOfResults":{ "shape":"Integer", - "documentation":"The number of items returned by the search. Use this to determine when you have requested the last set of results.
" + "documentation":"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.
" } } }, @@ -2388,7 +2392,7 @@ }, "ScoreAttributes":{ "shape":"ScoreAttributes", - "documentation":"Indicates the confidence that Amazon Kendra has that a result matches the query that you provided. Each result is placed into a bin that indicates the confidence, VERY_HIGH, HIGH, and MEDIUM. You can use the score to determine if a response meets the confidence needed for your application.
Confidence scores are only returned for results with the Type field set to QUESTION_ANSWER or ANSWER. This field is not returned if the Type field is set to DOCUMENT.
Indicates the confidence that Amazon Kendra has that a result matches the query that you provided. Each result is placed into a bin that indicates the confidence, VERY_HIGH, HIGH, MEDIUM and LOW. You can use the score to determine if a response meets the confidence needed for your application.
The field is only set to LOW when the Type field is set to DOCUMENT and Amazon Kendra is not confident that the result matches the query.
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.
" @@ -2826,7 +2830,8 @@ "enum":[ "VERY_HIGH", "HIGH", - "MEDIUM" + "MEDIUM", + "LOW" ] }, "Search":{