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.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
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.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | DocumentRelevanceOverrideConfigurations |
An array of documents attributes. Amazon Kendra returns a count for each attribute key specified. This helps your users narrow their search.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | Facets |
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
The unique identifier of the index to search. The identifier is returned in the response from the CreateIndex
API.
Required? | True |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
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.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
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.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Changes the cmdlet behavior to return the value passed to the QueryText parameter. The -PassThru parameter is deprecated, use -Select '^QueryText' instead. This parameter will be removed in a future version.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Sets the type of query. Only results for the specified query type are returned.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
The text to search for.
Required? | False |
Position? | 1 |
Accept pipeline input? | True (ByValue, ByPropertyName) |
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.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | RequestedDocumentAttributes |
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Kendra.Model.QueryResponse). Specifying the name of a property of type Amazon.Kendra.Model.QueryResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-SortingConfiguration_DocumentAttributeKey <
String>
The name of the document attribute used to sort the response. You can use any field that has the
Sortable
flag set to true.You can also sort by any of the following built-in attributes:
- _category
- _created_at
- _last_updated_at
- _version
- _view_count
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
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.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-SpellCorrectionConfiguration_IncludeQuerySpellCheckSuggestion <
Boolean>
TRUE
to suggest spell corrections for queries.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | SpellCorrectionConfiguration_IncludeQuerySpellCheckSuggestions |
The list of data source groups you want to filter search results based on groups' access to documents in that data source.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | UserContext_DataSourceGroups |
The list of groups you want to filter search results based on the groups' access to documents.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | UserContext_Groups |
The user context token for filtering search results for a user. It must be a JWT or a JSON token.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
The identifier of the user you want to filter search results based on their access to documents.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
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
.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |