QueryRequest

public struct QueryRequest : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

  • 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.

    Declaration

    Swift

    public let attributeFilter: AttributeFilter?

  • An array of documents attributes. Amazon Kendra returns a count for each attribute key specified. You can use this information to help narrow the search for your user.

    Declaration

    Swift

    public let facets: [Facet]?

  • The unique identifier of the index to search. The identifier is returned in the response from the operation.

    Declaration

    Swift

    public let indexId: String

  • 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.

    Declaration

    Swift

    public let pageNumber: Int?

  • 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.

    Declaration

    Swift

    public let pageSize: Int?

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

    Declaration

    Swift

    public let queryResultTypeFilter: QueryResultType?

  • The text to search for.

    Declaration

    Swift

    public let queryText: String

  • An array of document attributes to include in the response. No other document attributes are included in the response. By default all document attributes are included in the response.

    Declaration

    Swift

    public let requestedDocumentAttributes: [String]?

  • 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.

    Declaration

    Swift

    public let sortingConfiguration: SortingConfiguration?

  • Undocumented

    Declaration

    Swift

    public init(attributeFilter: AttributeFilter? = nil, facets: [Facet]? = nil, indexId: String, pageNumber: Int? = nil, pageSize: Int? = nil, queryResultTypeFilter: QueryResultType? = nil, queryText: String, requestedDocumentAttributes: [String]? = nil, sortingConfiguration: SortingConfiguration? = nil)

  • Declaration

    Swift

    public func validate(name: String) throws