| Column Name | Column Data Type |
|---|
index_id Required Input Column
The identifier of the index for the search. | VARCHAR |
attribute_filter Input Column
Filters search results by document fields/attributes. You can only provide one attribute filter; however, the AndAllFilters, NotFilter, and OrAllFilters parameters contain a list of other filters. The AttributeFilter parameter means you can create a set of filtering rules that a document must satisfy to be included in the query results. | STRUCT(
"equals_to" STRUCT(
"key" VARCHAR,
"value" STRUCT(
"string_value" VARCHAR,
"string_list_value" VARCHAR[],
"long_value" BIGINT,
"date_value" TIMESTAMP_S
)
),
"contains_all" STRUCT(
"key" VARCHAR,
"value" STRUCT(
"string_value" VARCHAR,
"string_list_value" VARCHAR[],
"long_value" BIGINT,
"date_value" TIMESTAMP_S
)
),
"contains_any" STRUCT(
"key" VARCHAR,
"value" STRUCT(
"string_value" VARCHAR,
"string_list_value" VARCHAR[],
"long_value" BIGINT,
"date_value" TIMESTAMP_S
)
),
"greater_than" STRUCT(
"key" VARCHAR,
"value" STRUCT(
"string_value" VARCHAR,
"string_list_value" VARCHAR[],
"long_value" BIGINT,
"date_value" TIMESTAMP_S
)
),
"greater_than_or_equals" STRUCT(
"key" VARCHAR,
"value" STRUCT(
"string_value" VARCHAR,
"string_list_value" VARCHAR[],
"long_value" BIGINT,
"date_value" TIMESTAMP_S
)
),
"less_than" STRUCT(
"key" VARCHAR,
"value" STRUCT(
"string_value" VARCHAR,
"string_list_value" VARCHAR[],
"long_value" BIGINT,
"date_value" TIMESTAMP_S
)
),
"less_than_or_equals" STRUCT(
"key" VARCHAR,
"value" STRUCT(
"string_value" VARCHAR,
"string_list_value" VARCHAR[],
"long_value" BIGINT,
"date_value" TIMESTAMP_S
)
)
) |
Show child fields- attribute_filter.contains_all
Returns true when a document contains all of the specified document attributes/fields. This filter is only applicable to StringListValue. Show child fields- attribute_filter.contains_all.key
The identifier for the attribute. - attribute_filter.contains_all.value
The value of the attribute. Show child fields- attribute_filter.contains_all.value.date_value
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. - attribute_filter.contains_all.value.long_value
A long integer value. - attribute_filter.contains_all.value.string_list_value[]
- attribute_filter.contains_all.value.string_value
A string, such as "department".
- attribute_filter.contains_any
Returns true when a document contains any of the specified document attributes/fields. This filter is only applicable to StringListValue. Show child fields- attribute_filter.contains_any.key
The identifier for the attribute. - attribute_filter.contains_any.value
The value of the attribute. Show child fields- attribute_filter.contains_any.value.date_value
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. - attribute_filter.contains_any.value.long_value
A long integer value. - attribute_filter.contains_any.value.string_list_value[]
- attribute_filter.contains_any.value.string_value
A string, such as "department".
- attribute_filter.equals_to
Performs an equals operation on document attributes/fields and their values. Show child fields- attribute_filter.equals_to.key
The identifier for the attribute. - attribute_filter.equals_to.value
The value of the attribute. Show child fields- attribute_filter.equals_to.value.date_value
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. - attribute_filter.equals_to.value.long_value
A long integer value. - attribute_filter.equals_to.value.string_list_value[]
- attribute_filter.equals_to.value.string_value
A string, such as "department".
- attribute_filter.greater_than
Performs a greater than operation on document attributes/fields and their values. Use with the document attribute type Date or Long. Show child fields- attribute_filter.greater_than.key
The identifier for the attribute. - attribute_filter.greater_than.value
The value of the attribute. Show child fields- attribute_filter.greater_than.value.date_value
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. - attribute_filter.greater_than.value.long_value
A long integer value. - attribute_filter.greater_than.value.string_list_value[]
- attribute_filter.greater_than.value.string_value
A string, such as "department".
- attribute_filter.greater_than_or_equals
Performs a greater or equals than operation on document attributes/fields and their values. Use with the document attribute type Date or Long. Show child fields- attribute_filter.greater_than_or_equals.key
The identifier for the attribute. - attribute_filter.greater_than_or_equals.value
The value of the attribute. Show child fields- attribute_filter.greater_than_or_equals.value.date_value
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. - attribute_filter.greater_than_or_equals.value.long_value
A long integer value. - attribute_filter.greater_than_or_equals.value.string_list_value[]
- attribute_filter.greater_than_or_equals.value.string_value
A string, such as "department".
- attribute_filter.less_than
Performs a less than operation on document attributes/fields and their values. Use with the document attribute type Date or Long. Show child fields- attribute_filter.less_than.key
The identifier for the attribute. - attribute_filter.less_than.value
The value of the attribute. Show child fields- attribute_filter.less_than.value.date_value
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. - attribute_filter.less_than.value.long_value
A long integer value. - attribute_filter.less_than.value.string_list_value[]
- attribute_filter.less_than.value.string_value
A string, such as "department".
- attribute_filter.less_than_or_equals
Performs a less than or equals operation on document attributes/fields and their values. Use with the document attribute type Date or Long. Show child fields- attribute_filter.less_than_or_equals.key
The identifier for the attribute. - attribute_filter.less_than_or_equals.value
The value of the attribute. Show child fields- attribute_filter.less_than_or_equals.value.date_value
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. - attribute_filter.less_than_or_equals.value.long_value
A long integer value. - attribute_filter.less_than_or_equals.value.string_list_value[]
- attribute_filter.less_than_or_equals.value.string_value
A string, such as "department".
|
collapse_configuration Input Column
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. | STRUCT(
"document_attribute_key" VARCHAR,
"sorting_configurations" STRUCT(
"document_attribute_key" VARCHAR,
"sort_order" VARCHAR
)[],
"missing_attribute_key_strategy" VARCHAR,
"expand" BOOLEAN,
"expand_configuration" STRUCT(
"max_result_items_to_expand" BIGINT,
"max_expanded_results_per_item" BIGINT
)
) |
Show child fields- collapse_configuration.document_attribute_key
The document attribute used to group search results. You can use any attribute 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". - collapse_configuration.expand
Specifies whether to expand the collapsed results. - collapse_configuration.expand_configuration
Provides configuration information to customize expansion options for a collapsed group. Show child fields- collapse_configuration.expand_configuration.max_expanded_results_per_item
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. - collapse_configuration.expand_configuration.max_result_items_to_expand
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.
- collapse_configuration.missing_attribute_key_strategy
Specifies the behavior for documents without a value for the collapse attribute. Amazon Kendra offers three customization options: -
Choose to COLLAPSE all documents with null or missing values in one group. This is the default configuration. -
Choose to IGNORE documents with null or missing values. Ignored documents will not appear in query results. -
Choose to EXPAND each document with a null or missing value into a group of its own. - collapse_configuration.sorting_configurations[]
Show child fields- collapse_configuration.sorting_configurations[].document_attribute_key
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 - collapse_configuration.sorting_configurations[].sort_order
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.
|
document_relevance_override_configurations Input Column
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. | STRUCT(
"name" VARCHAR,
"relevance" STRUCT(
"freshness" BOOLEAN,
"importance" BIGINT,
"duration" VARCHAR,
"rank_order" VARCHAR,
"value_importance_map" MAP(VARCHAR, BIGINT)
)
)[] |
Show child fields- document_relevance_override_configurations[]
Show child fields- document_relevance_override_configurations[].name
The name of the index field. - document_relevance_override_configurations[].relevance
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. Show child fields- document_relevance_override_configurations[].relevance.duration
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 DATE fields. - document_relevance_override_configurations[].relevance.freshness
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 DATE fields. - document_relevance_override_configurations[].relevance.importance
The relative importance of the field in the search. Larger numbers provide more of a boost than smaller numbers. - document_relevance_override_configurations[].relevance.rank_order
Determines how values should be interpreted. When the RankOrder field is ASCENDING, 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 RankOrder field is DESCENDING, 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 LONG fields. - document_relevance_override_configurations[].relevance.value_importance_map
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.
|
facets Input Column
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. | STRUCT(
"document_attribute_key" VARCHAR,
"max_results" BIGINT
)[] |
Show child fields- facets[]
Show child fields- facets[].document_attribute_key
The unique key for the document attribute. - facets[].max_results
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.
|
page_number Input Column
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. | BIGINT |
page_size Input Column
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. | BIGINT |
query_result_type_filter Input Column
Sets the type of query result or response. Only results for the specified type are returned. | VARCHAR |
query_text Input Column
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:HR is counted as 3 tokens: timeoff, october, hr. For more information, see Searching with advanced query syntax in the Amazon Kendra Developer Guide. | VARCHAR |
requested_document_attributes Input Column
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. | VARCHAR[] |
Show child fields- requested_document_attributes[]
|
sorting_configuration Input Column
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. | STRUCT(
"document_attribute_key" VARCHAR,
"sort_order" VARCHAR
) |
Show child fields- sorting_configuration.document_attribute_key
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 - sorting_configuration.sort_order
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.
|
sorting_configurations Input Column
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. | STRUCT(
"document_attribute_key" VARCHAR,
"sort_order" VARCHAR
)[] |
Show child fields- sorting_configurations[]
Show child fields- sorting_configurations[].document_attribute_key
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 - sorting_configurations[].sort_order
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.
|
spell_correction_configuration Input Column
Enables suggested spell corrections for queries. | STRUCT(
"include_query_spell_check_suggestions" BOOLEAN
) |
Show child fields- spell_correction_configuration.include_query_spell_check_suggestions
TRUE to suggest spell corrections for queries.
|
user_context Input Column
The user context token or user and group information. | STRUCT(
"token" VARCHAR,
"user_id" VARCHAR,
"groups" VARCHAR[],
"data_source_groups" STRUCT(
"group_id" VARCHAR,
"data_source_id" VARCHAR
)[]
) |
Show child fields- user_context.data_source_groups[]
Show child fields- user_context.data_source_groups[].data_source_id
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. - user_context.data_source_groups[].group_id
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.
- user_context.groups[]
- user_context.token
The user context token for filtering search results for a user. It must be a JWT or a JSON token. - user_context.user_id
The identifier of the user you want to filter search results based on their access to documents.
|
visitor_id Input Column
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. | VARCHAR |
_aws_profile Input Column
The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role. | STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
) |
Show child fields- _aws_profile.account_id
The AWS account id - _aws_profile.assumed_role_arn
The ARN of the assumed role - _aws_profile.name
The unique name of the profile. - _aws_profile.organization
Information about this profile's membership in the AWS organization. Show child fields- _aws_profile.organization.account_name
The name of account speciifed by the organization - _aws_profile.organization.id
The organization id - _aws_profile.organization.master_account
Show child fields- _aws_profile.organization.master_account.email
The organization master account email address - _aws_profile.organization.master_account.id
The organization master account id
- _aws_profile.organization.parents[]
Show child fields- _aws_profile.organization.parents[].id
The id of the parent - _aws_profile.organization.parents[].name
The name of the parent - _aws_profile.organization.parents[].tags[]
Show child fields- _aws_profile.organization.parents[].tags[].key
- _aws_profile.organization.parents[].tags[].value
- _aws_profile.organization.parents[].type
The type of parent can be an organization unit or a root
- _aws_profile.organization.tags[]
Show child fields- _aws_profile.organization.tags[].key
- _aws_profile.organization.tags[].value
- _aws_profile.type
The type of profile, either 'credentials' or 'assumed_role' - _aws_profile.via_profile_name
This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.
|
_aws_region Input Column
The AWS region to use. | VARCHAR |
facet_results
Contains the facet results. A FacetResult contains the counts for each field/attribute key that was specified in the Facets input parameter. | STRUCT(
"document_attribute_key" VARCHAR,
"document_attribute_value_type" VARCHAR,
"document_attribute_value_count_pairs" STRUCT(
"document_attribute_value" STRUCT(
"string_value" VARCHAR,
"string_list_value" VARCHAR[],
"long_value" BIGINT,
"date_value" TIMESTAMP_S
),
"count" BIGINT
)[]
)[] |
Show child fields- facet_results[]
Show child fields- facet_results[].document_attribute_key
The key for the facet values. This is the same as the DocumentAttributeKey provided in the query. - facet_results[].document_attribute_value_count_pairs[]
Show child fields- facet_results[].document_attribute_value_count_pairs[].count
The number of documents in the response that have the attribute/field value for the key. - facet_results[].document_attribute_value_count_pairs[].document_attribute_value
The value of the attribute/field. For example, "HR". Show child fields- facet_results[].document_attribute_value_count_pairs[].document_attribute_value.date_value
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. - facet_results[].document_attribute_value_count_pairs[].document_attribute_value.long_value
A long integer value. - facet_results[].document_attribute_value_count_pairs[].document_attribute_value.string_list_value[]
- facet_results[].document_attribute_value_count_pairs[].document_attribute_value.string_value
A string, such as "department".
- facet_results[].document_attribute_value_type
The data type of the facet value. This is the same as the type defined for the index field when it was created.
|
featured_results_items
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. | STRUCT(
"id" VARCHAR,
"type" VARCHAR,
"additional_attributes" STRUCT(
"key" VARCHAR,
"value_type" VARCHAR,
"value" STRUCT(
"text_with_highlights_value" STRUCT(
"text" VARCHAR,
"highlights" STRUCT(
"begin_offset" BIGINT,
"end_offset" BIGINT,
"top_answer" BOOLEAN,
"type" VARCHAR
)[]
)
)
)[],
"document_id" VARCHAR,
"document_title" STRUCT(
"text" VARCHAR,
"highlights" STRUCT(
"begin_offset" BIGINT,
"end_offset" BIGINT,
"top_answer" BOOLEAN,
"type" VARCHAR
)[]
),
"document_excerpt" STRUCT(
"text" VARCHAR,
"highlights" STRUCT(
"begin_offset" BIGINT,
"end_offset" BIGINT,
"top_answer" BOOLEAN,
"type" VARCHAR
)[]
),
"document_uri" VARCHAR,
"document_attributes" STRUCT(
"key" VARCHAR,
"value" STRUCT(
"string_value" VARCHAR,
"string_list_value" VARCHAR[],
"long_value" BIGINT,
"date_value" TIMESTAMP_S
)
)[],
"feedback_token" VARCHAR
)[] |
Show child fields- featured_results_items[]
Show child fields- featured_results_items[].additional_attributes[]
Show child fields- featured_results_items[].additional_attributes[].key
The key that identifies the attribute. - featured_results_items[].additional_attributes[].value
An object that contains the attribute value. Show child fields- featured_results_items[].additional_attributes[].value.text_with_highlights_value
The text associated with the attribute and information about the highlight to apply to the text. Show child fields- featured_results_items[].additional_attributes[].value.text_with_highlights_value.highlights[]
Show child fields- featured_results_items[].additional_attributes[].value.text_with_highlights_value.highlights[].begin_offset
The zero-based location in the response string where the highlight starts. - featured_results_items[].additional_attributes[].value.text_with_highlights_value.highlights[].end_offset
The zero-based location in the response string where the highlight ends. - featured_results_items[].additional_attributes[].value.text_with_highlights_value.highlights[].top_answer
Indicates whether the response is the best response. True if this is the best response; otherwise, false. - featured_results_items[].additional_attributes[].value.text_with_highlights_value.highlights[].type
The highlight type.
- featured_results_items[].additional_attributes[].value.text_with_highlights_value.text
The text to display to the user.
- featured_results_items[].additional_attributes[].value_type
The data type of the Value property.
- featured_results_items[].document_attributes[]
Show child fields- featured_results_items[].document_attributes[].key
The identifier for the attribute. - featured_results_items[].document_attributes[].value
The value of the attribute. Show child fields- featured_results_items[].document_attributes[].value.date_value
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. - featured_results_items[].document_attributes[].value.long_value
A long integer value. - featured_results_items[].document_attributes[].value.string_list_value[]
- featured_results_items[].document_attributes[].value.string_value
A string, such as "department".
- featured_results_items[].document_excerpt
Provides text and information about where to highlight the text. Show child fields- featured_results_items[].document_excerpt.highlights[]
Show child fields- featured_results_items[].document_excerpt.highlights[].begin_offset
The zero-based location in the response string where the highlight starts. - featured_results_items[].document_excerpt.highlights[].end_offset
The zero-based location in the response string where the highlight ends. - featured_results_items[].document_excerpt.highlights[].top_answer
Indicates whether the response is the best response. True if this is the best response; otherwise, false. - featured_results_items[].document_excerpt.highlights[].type
The highlight type.
- featured_results_items[].document_excerpt.text
The text to display to the user.
- featured_results_items[].document_id
The identifier of the featured document. - featured_results_items[].document_title
Provides text and information about where to highlight the text. Show child fields- featured_results_items[].document_title.highlights[]
Show child fields- featured_results_items[].document_title.highlights[].begin_offset
The zero-based location in the response string where the highlight starts. - featured_results_items[].document_title.highlights[].end_offset
The zero-based location in the response string where the highlight ends. - featured_results_items[].document_title.highlights[].top_answer
Indicates whether the response is the best response. True if this is the best response; otherwise, false. - featured_results_items[].document_title.highlights[].type
The highlight type.
- featured_results_items[].document_title.text
The text to display to the user.
- featured_results_items[].document_uri
The source URI location of the featured document. - featured_results_items[].feedback_token
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. - featured_results_items[].id
The identifier of the featured result. - featured_results_items[].type
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.
|
query_id
The identifier for the search. You also use QueryId to identify the search when using the SubmitFeedback API. | VARCHAR |
result_items
The results of the search. | STRUCT(
"id" VARCHAR,
"type" VARCHAR,
"format" VARCHAR,
"additional_attributes" STRUCT(
"key" VARCHAR,
"value_type" VARCHAR,
"value" STRUCT(
"text_with_highlights_value" STRUCT(
"text" VARCHAR,
"highlights" STRUCT(
"begin_offset" BIGINT,
"end_offset" BIGINT,
"top_answer" BOOLEAN,
"type" VARCHAR
)[]
)
)
)[],
"document_id" VARCHAR,
"document_title" STRUCT(
"text" VARCHAR,
"highlights" STRUCT(
"begin_offset" BIGINT,
"end_offset" BIGINT,
"top_answer" BOOLEAN,
"type" VARCHAR
)[]
),
"document_excerpt" STRUCT(
"text" VARCHAR,
"highlights" STRUCT(
"begin_offset" BIGINT,
"end_offset" BIGINT,
"top_answer" BOOLEAN,
"type" VARCHAR
)[]
),
"document_uri" VARCHAR,
"document_attributes" STRUCT(
"key" VARCHAR,
"value" STRUCT(
"string_value" VARCHAR,
"string_list_value" VARCHAR[],
"long_value" BIGINT,
"date_value" TIMESTAMP_S
)
)[],
"score_attributes" STRUCT(
"score_confidence" VARCHAR
),
"feedback_token" VARCHAR,
"table_excerpt" STRUCT(
"rows" STRUCT(
"cells" STRUCT(
"value" VARCHAR,
"top_answer" BOOLEAN,
"highlighted" BOOLEAN,
"header" BOOLEAN
)[]
)[],
"total_number_of_rows" BIGINT
),
"collapsed_result_detail" STRUCT(
"document_attribute" STRUCT(
"key" VARCHAR,
"value" STRUCT(
"string_value" VARCHAR,
"string_list_value" VARCHAR[],
"long_value" BIGINT,
"date_value" TIMESTAMP_S
)
),
"expanded_results" STRUCT(
"id" VARCHAR,
"document_id" VARCHAR,
"document_title" STRUCT(
"text" VARCHAR,
"highlights" STRUCT(
"begin_offset" BIGINT,
"end_offset" BIGINT,
"top_answer" BOOLEAN,
"type" VARCHAR
)[]
),
"document_excerpt" STRUCT(
"text" VARCHAR,
"highlights" STRUCT(
"begin_offset" BIGINT,
"end_offset" BIGINT,
"top_answer" BOOLEAN,
"type" VARCHAR
)[]
),
"document_uri" VARCHAR,
"document_attributes" STRUCT(
"key" VARCHAR,
"value" STRUCT(
"string_value" VARCHAR,
"string_list_value" VARCHAR[],
"long_value" BIGINT,
"date_value" TIMESTAMP_S
)
)[]
)[]
)
)[] |
Show child fields- result_items[]
Show child fields- result_items[].additional_attributes[]
Show child fields- result_items[].additional_attributes[].key
The key that identifies the attribute. - result_items[].additional_attributes[].value
An object that contains the attribute value. Show child fields- result_items[].additional_attributes[].value.text_with_highlights_value
The text associated with the attribute and information about the highlight to apply to the text. Show child fields- result_items[].additional_attributes[].value.text_with_highlights_value.highlights[]
Show child fields- result_items[].additional_attributes[].value.text_with_highlights_value.highlights[].begin_offset
The zero-based location in the response string where the highlight starts. - result_items[].additional_attributes[].value.text_with_highlights_value.highlights[].end_offset
The zero-based location in the response string where the highlight ends. - result_items[].additional_attributes[].value.text_with_highlights_value.highlights[].top_answer
Indicates whether the response is the best response. True if this is the best response; otherwise, false. - result_items[].additional_attributes[].value.text_with_highlights_value.highlights[].type
The highlight type.
- result_items[].additional_attributes[].value.text_with_highlights_value.text
The text to display to the user.
- result_items[].additional_attributes[].value_type
The data type of the Value property.
- result_items[].collapsed_result_detail
Provides details about a collapsed group of search results. Show child fields- result_items[].collapsed_result_detail.document_attribute
The value of the document attribute that results are collapsed on. Show child fields- result_items[].collapsed_result_detail.document_attribute.key
The identifier for the attribute. - result_items[].collapsed_result_detail.document_attribute.value
The value of the attribute. Show child fields- result_items[].collapsed_result_detail.document_attribute.value.date_value
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. - result_items[].collapsed_result_detail.document_attribute.value.long_value
A long integer value. - result_items[].collapsed_result_detail.document_attribute.value.string_list_value[]
- result_items[].collapsed_result_detail.document_attribute.value.string_value
A string, such as "department".
- result_items[].collapsed_result_detail.expanded_results[]
Show child fields- result_items[].collapsed_result_detail.expanded_results[].document_attributes[]
Show child fields- result_items[].collapsed_result_detail.expanded_results[].document_attributes[].key
The identifier for the attribute. - result_items[].collapsed_result_detail.expanded_results[].document_attributes[].value
The value of the attribute. Show child fields- result_items[].collapsed_result_detail.expanded_results[].document_attributes[].value.date_value
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. - result_items[].collapsed_result_detail.expanded_results[].document_attributes[].value.long_value
A long integer value. - result_items[].collapsed_result_detail.expanded_results[].document_attributes[].value.string_list_value[]
- result_items[].collapsed_result_detail.expanded_results[].document_attributes[].value.string_value
A string, such as "department".
- result_items[].collapsed_result_detail.expanded_results[].document_excerpt
Provides text and information about where to highlight the text. Show child fields- result_items[].collapsed_result_detail.expanded_results[].document_excerpt.highlights[]
Show child fields- result_items[].collapsed_result_detail.expanded_results[].document_excerpt.highlights[].begin_offset
The zero-based location in the response string where the highlight starts. - result_items[].collapsed_result_detail.expanded_results[].document_excerpt.highlights[].end_offset
The zero-based location in the response string where the highlight ends. - result_items[].collapsed_result_detail.expanded_results[].document_excerpt.highlights[].top_answer
Indicates whether the response is the best response. True if this is the best response; otherwise, false. - result_items[].collapsed_result_detail.expanded_results[].document_excerpt.highlights[].type
The highlight type.
- result_items[].collapsed_result_detail.expanded_results[].document_excerpt.text
The text to display to the user.
- result_items[].collapsed_result_detail.expanded_results[].document_id
The idenitifier of the document. - result_items[].collapsed_result_detail.expanded_results[].document_title
Provides text and information about where to highlight the text. Show child fields- result_items[].collapsed_result_detail.expanded_results[].document_title.highlights[]
Show child fields- result_items[].collapsed_result_detail.expanded_results[].document_title.highlights[].begin_offset
The zero-based location in the response string where the highlight starts. - result_items[].collapsed_result_detail.expanded_results[].document_title.highlights[].end_offset
The zero-based location in the response string where the highlight ends. - result_items[].collapsed_result_detail.expanded_results[].document_title.highlights[].top_answer
Indicates whether the response is the best response. True if this is the best response; otherwise, false. - result_items[].collapsed_result_detail.expanded_results[].document_title.highlights[].type
The highlight type.
- result_items[].collapsed_result_detail.expanded_results[].document_title.text
The text to display to the user.
- result_items[].collapsed_result_detail.expanded_results[].document_uri
The URI of the original location of the document. - result_items[].collapsed_result_detail.expanded_results[].id
The identifier for the expanded result.
- result_items[].document_attributes[]
Show child fields- result_items[].document_attributes[].key
The identifier for the attribute. - result_items[].document_attributes[].value
The value of the attribute. Show child fields- result_items[].document_attributes[].value.date_value
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. - result_items[].document_attributes[].value.long_value
A long integer value. - result_items[].document_attributes[].value.string_list_value[]
- result_items[].document_attributes[].value.string_value
A string, such as "department".
- result_items[].document_excerpt
An extract of the text in the document. Contains information about highlighting the relevant terms in the excerpt. Show child fields- result_items[].document_excerpt.highlights[]
Show child fields- result_items[].document_excerpt.highlights[].begin_offset
The zero-based location in the response string where the highlight starts. - result_items[].document_excerpt.highlights[].end_offset
The zero-based location in the response string where the highlight ends. - result_items[].document_excerpt.highlights[].top_answer
Indicates whether the response is the best response. True if this is the best response; otherwise, false. - result_items[].document_excerpt.highlights[].type
The highlight type.
- result_items[].document_excerpt.text
The text to display to the user.
- result_items[].document_id
The identifier for the document. - result_items[].document_title
The title of the document. Contains the text of the title and information for highlighting the relevant terms in the title. Show child fields- result_items[].document_title.highlights[]
Show child fields- result_items[].document_title.highlights[].begin_offset
The zero-based location in the response string where the highlight starts. - result_items[].document_title.highlights[].end_offset
The zero-based location in the response string where the highlight ends. - result_items[].document_title.highlights[].top_answer
Indicates whether the response is the best response. True if this is the best response; otherwise, false. - result_items[].document_title.highlights[].type
The highlight type.
- result_items[].document_title.text
The text to display to the user.
- result_items[].document_uri
The URI of the original location of the document. - result_items[].feedback_token
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. - result_items[].format
If the Type of document within the response is ANSWER, then it is either a TABLE answer or TEXT answer. If it's a table answer, a table excerpt is returned in TableExcerpt. If it's a text answer, a text excerpt is returned in DocumentExcerpt. - result_items[].id
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. - result_items[].score_attributes
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, 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 is relevant to the query. Show child fields- result_items[].score_attributes.score_confidence
A relative ranking for how relevant the response is to the query.
- result_items[].table_excerpt
An excerpt from a table within a document. Show child fields- result_items[].table_excerpt.rows[]
Show child fields- result_items[].table_excerpt.rows[].cells[]
Show child fields- result_items[].table_excerpt.rows[].cells[].header
TRUE means that the table cell should be treated as a header. - result_items[].table_excerpt.rows[].cells[].highlighted
TRUE means that the table cell has a high enough confidence and is relevant to the query, so the value or content should be highlighted. - result_items[].table_excerpt.rows[].cells[].top_answer
TRUE if 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. - result_items[].table_excerpt.rows[].cells[].value
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.
- result_items[].table_excerpt.total_number_of_rows
A count of the number of rows in the original table within the document.
- result_items[].type
The type of document within the response. For example, a response could include a question-answer that's relevant to the query.
|
spell_corrected_queries
A list of information related to suggested spell corrections for a query. | STRUCT(
"suggested_query_text" VARCHAR,
"corrections" STRUCT(
"begin_offset" BIGINT,
"end_offset" BIGINT,
"term" VARCHAR,
"corrected_term" VARCHAR
)[]
)[] |
Show child fields- spell_corrected_queries[]
Show child fields- spell_corrected_queries[].corrections[]
Show child fields- spell_corrected_queries[].corrections[].begin_offset
The zero-based location in the response string or text where the corrected word starts. - spell_corrected_queries[].corrections[].corrected_term
The string or text of a corrected misspelled word in a query. - spell_corrected_queries[].corrections[].end_offset
The zero-based location in the response string or text where the corrected word ends. - spell_corrected_queries[].corrections[].term
The string or text of a misspelled word in a query.
- spell_corrected_queries[].suggested_query_text
The query with the suggested spell corrections.
|
total_number_of_results
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. | BIGINT |
warnings
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. | STRUCT(
"message" VARCHAR,
"code" VARCHAR
)[] |
Show child fields- warnings[]
Show child fields- warnings[].code
The code used to show the type of warning for the query. - warnings[].message
The message that explains the problem with the query.
|