Intelligent enterprise search service powered by machine learning
awskendra.search
query
(TEXT, Required): Natural language query to search for in your Kendra index. For example: ‘How do I reset my password?’ or ‘sales report Q3 2024’
pageSize
(NUMBER, Optional): Number of results to return per page. Maximum is 100. If not specified, defaults to 10attributeFilter(see example below){"EqualsTo": {"Key": "field", "Value": "text"}}
queryResultType
(SELECT, Optional): Filter results by type. Options: All results, Documents only, Answers only, Questions and answers onlypageNumber
(NUMBER, Optional): Page number to retrieve (1-10 for page size 10, 1-2 for page size 50). Note: AWS Kendra limits total retrievable results to 100facets
(MULTI_LINE_TEXT, Optional): JSON array of document attribute names to get facet counts. Simple format: <JSON array>
. Advanced format with max results: (see example below)sortingConfiguration
(MULTI_LINE_TEXT, Optional): JSON object to sort results. Format: (see example below). IMPORTANT: Use ‘Get Index Configuration’ first to verify which fields are sortable. Only fields marked as sortable in your index will workspellCorrection
(SELECT, Optional): Enable automatic spell correction for queries to improve search accuracy. Options: Enabled, DisableduserContext
(MULTI_LINE_TEXT, Optional): JSON object for user-specific filtering. GenAI format: JSON: email_id = user@example.com
. Standard format: (JSON format)visitorId
(TEXT, Optional): Unique identifier for tracking user sessions (e.g., a GUID). Do not use personally identifiable information like emailrequestedDocumentAttributes
(MULTI_LINE_TEXT, Optional): JSON array of document attribute names to include in response (max 100). Common fields: <JSON array>
. Reduces response size by limiting fieldscollapseConfiguration
(MULTI_LINE_TEXT, Optional): JSON object to group/collapse similar results. Basic: (see example below). With expansion: (see example below)documentRelevanceOverrides
(MULTI_LINE_TEXT, Optional): JSON array to boost specific fields/values. Format: (see example below)totalResults
: Total number of results foundresults
: Array of result objects containing:
id
: Document IDtitle
: Document titleexcerpt
: Document excerpturi
: Document URIscore
: Relevance scoreattributes
: Document attributes (if available)facets
: Facet results if requestedspellSuggestions
: Spell correction suggestions if availablefeaturedResults
: Featured results if availableawskendra.getIndexConfiguration
indexName
: Name of the indexstatus
: Index statusedition
: Index editionfields
: Array of field objects containing:
name
: Field nametype
: Field type (STRING, DATE, LONG, etc.)searchable
: Whether field is searchablesortable
: Whether field is sortablefacetable
: Whether field is facetabledisplayable
: Whether field is displayableimportance
: Field importance scoresummary
: Summary statistics including:
totalFields
: Total number of fieldssortableFields
: List of sortable field namessearchableFields
: List of searchable field namesdateFields
: List of date field namessortableDateFields
: List of sortable date field namesIssue | Solution |
---|---|
Authentication failed | Verify your API Key (AWS Credentials) credentials |
Rate limit exceeded | Reduce request frequency |
Data not found | Check permissions and data availability |
Connection timeout | Verify network connectivity |