Skip to content

NativeIndexConfiguration

Source code in docs_src/capo_qbusiness/types/native_index_configuration.py
class NativeIndexConfiguration(TypedDict, closed=True):
    index_id: "capo_qbusiness.types.index_id.IndexId"
    """<p>The identifier for the Amazon Q Business index.</p>"""
    version: NotRequired["capo_qbusiness.types.long.Long"]
    """<p>A read-only field that specifies the version of the <code>NativeIndexConfiguration</code>.</p> <p>Amazon Q Business introduces enhanced document retrieval capabilities in version 2 of <code>NativeIndexConfiguration</code>, focusing on streamlined metadata boosting that prioritizes recency and source relevance to deliver more accurate responses to your queries. Version 2 has the following differences from version 1:</p> <ul> <li> <p>Version 2 supports a single Date field (created_at OR last_updated_at) for recency boosting</p> </li> <li> <p>Version 2 supports a single String field with an ordered list of up to 5 values</p> </li> <li> <p>Version 2 introduces number-based boost levels (ONE, TWO) alongside the text-based levels</p> </li> <li> <p>Version 2 allows specifying prioritization between Date and String fields</p> </li> <li> <p>Version 2 maintains backward compatibility with existing configurations</p> </li> </ul>"""
    boosting_override: NotRequired[
        "capo_qbusiness.types.document_attribute_boosting_override_map.DocumentAttributeBoostingOverrideMap"
    ]
    """<p>Overrides the default boosts applied by Amazon Q Business to supported document attribute data types.</p>"""

boosting_override instance-attribute

boosting_override: NotRequired[DocumentAttributeBoostingOverrideMap]

Overrides the default boosts applied by Amazon Q Business to supported document attribute data types.

index_id instance-attribute

index_id: IndexId

The identifier for the Amazon Q Business index.

version instance-attribute

version: NotRequired[Long]

A read-only field that specifies the version of the NativeIndexConfiguration.

Amazon Q Business introduces enhanced document retrieval capabilities in version 2 of NativeIndexConfiguration, focusing on streamlined metadata boosting that prioritizes recency and source relevance to deliver more accurate responses to your queries. Version 2 has the following differences from version 1:

  • Version 2 supports a single Date field (created_at OR last_updated_at) for recency boosting

  • Version 2 supports a single String field with an ordered list of up to 5 values

  • Version 2 introduces number-based boost levels (ONE, TWO) alongside the text-based levels

  • Version 2 allows specifying prioritization between Date and String fields

  • Version 2 maintains backward compatibility with existing configurations