Skip to content

DocumentMetadataConfiguration

Source code in docs_src/capo_kendra/types/document_metadata_configuration.py 
16
17
18
19
20
21
22
23
24
class DocumentMetadataConfiguration(TypedDict, closed=True):
    name: "capo_kendra.types.document_metadata_configuration_name.DocumentMetadataConfigurationName"
    """<p>The name of the index field.</p>"""
    type: "capo_kendra.types.document_attribute_value_type.DocumentAttributeValueType"
    """<p>The data type of the index field. </p>"""
    relevance: NotRequired["capo_kendra.types.relevance.Relevance"]
    """<p>Provides tuning parameters to determine how the field affects the search results.</p>"""
    search: NotRequired["capo_kendra.types.search.Search"]
    """<p>Provides information about how the field is used during a search.</p>"""

name instance-attribute 

name: DocumentMetadataConfigurationName

The name of the index field.

relevance instance-attribute 

relevance: NotRequired[Relevance]

Provides tuning parameters to determine how the field affects the search results.

search instance-attribute 

search: NotRequired[Search]

Provides information about how the field is used during a search.

type instance-attribute 

type: DocumentAttributeValueType

The data type of the index field.