Skip to content

RdsFieldMapping

Source code in docs_src/capo_bedrock_agent/types/rds_field_mapping.py
class RdsFieldMapping(TypedDict, closed=True):
    primary_key_field: "capo_bedrock_agent.types.column_name.ColumnName"
    """<p>The name of the field in which Amazon Bedrock stores the ID for each entry.</p>"""
    vector_field: "capo_bedrock_agent.types.column_name.ColumnName"
    """<p>The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.</p>"""
    text_field: "capo_bedrock_agent.types.column_name.ColumnName"
    """<p>The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.</p>"""
    metadata_field: "capo_bedrock_agent.types.column_name.ColumnName"
    """<p>The name of the field in which Amazon Bedrock stores metadata about the vector store.</p>"""
    custom_metadata_field: NotRequired[
        "capo_bedrock_agent.types.column_name.ColumnName"
    ]
    """<p>Provide a name for the universal metadata field where Amazon Bedrock will store any custom metadata from your data source.</p>"""

custom_metadata_field instance-attribute

custom_metadata_field: NotRequired[ColumnName]

Provide a name for the universal metadata field where Amazon Bedrock will store any custom metadata from your data source.

metadata_field instance-attribute

metadata_field: ColumnName

The name of the field in which Amazon Bedrock stores metadata about the vector store.

primary_key_field instance-attribute

primary_key_field: ColumnName

The name of the field in which Amazon Bedrock stores the ID for each entry.

text_field instance-attribute

text_field: ColumnName

The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.

vector_field instance-attribute

vector_field: ColumnName

The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.