Skip to content

VectorKnowledgeBaseConfiguration

Source code in docs_src/capo_bedrock_agent/types/vector_knowledge_base_configuration.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
class VectorKnowledgeBaseConfiguration(TypedDict, closed=True):
    embedding_model_arn: (
        "capo_bedrock_agent.types.bedrock_embedding_model_arn.BedrockEmbeddingModelArn"
    )
    """<p>The Amazon Resource Name (ARN) of the model used to create vector embeddings for the knowledge base.</p>"""
    embedding_model_configuration: NotRequired[
        "capo_bedrock_agent.types.embedding_model_configuration.EmbeddingModelConfiguration"
    ]
    """<p>The embeddings model configuration details for the vector model used in Knowledge Base.</p>"""
    supplemental_data_storage_configuration: NotRequired[
        "capo_bedrock_agent.types.supplemental_data_storage_configuration.SupplementalDataStorageConfiguration"
    ]
    """<p>If you include multimodal data from your data source, use this object to specify configurations for the storage location of the images extracted from your documents. These images can be retrieved and returned to the end user. They can also be used in generation when using <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html">RetrieveAndGenerate</a>.</p>"""

embedding_model_arn instance-attribute 

embedding_model_arn: BedrockEmbeddingModelArn

The Amazon Resource Name (ARN) of the model used to create vector embeddings for the knowledge base.

embedding_model_configuration instance-attribute 

embedding_model_configuration: NotRequired[EmbeddingModelConfiguration]

The embeddings model configuration details for the vector model used in Knowledge Base.

supplemental_data_storage_configuration instance-attribute 

supplemental_data_storage_configuration: NotRequired[
    SupplementalDataStorageConfiguration
]

If you include multimodal data from your data source, use this object to specify configurations for the storage location of the images extracted from your documents. These images can be retrieved and returned to the end user. They can also be used in generation when using RetrieveAndGenerate.