Skip to content

BedrockEmbeddingModelConfiguration

Source code in docs_src/capo_bedrock_agent/types/bedrock_embedding_model_configuration.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
class BedrockEmbeddingModelConfiguration(TypedDict, closed=True):
    dimensions: NotRequired["capo_bedrock_agent.types.dimensions.Dimensions"]
    """<p>The dimensions details for the vector configuration used on the Bedrock embeddings model.</p>"""
    embedding_data_type: NotRequired[
        "capo_bedrock_agent.types.embedding_data_type.EmbeddingDataType"
    ]
    """<p>The data type for the vectors when using a model to convert text into vector embeddings. The model must support the specified data type for vector embeddings. Floating-point (float32) is the default data type, and is supported by most models for vector embeddings. See <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-supported.html">Supported embeddings models</a> for information on the available models and their vector data types.</p>"""
    audio: NotRequired[
        "capo_bedrock_agent.types.audio_configurations.AudioConfigurations"
    ]
    """<p>Configuration settings for processing audio content in multimodal knowledge bases.</p> <important> <p>This field is deprecated. Use <code>modelConfiguration</code> instead.</p> </important>"""
    video: NotRequired[
        "capo_bedrock_agent.types.video_configurations.VideoConfigurations"
    ]
    """<p>Configuration settings for processing video content in multimodal knowledge bases.</p> <important> <p>This field is deprecated. Use <code>modelConfiguration</code> instead.</p> </important>"""
    model_configuration: NotRequired["object"]
    """<p>Model-specific configuration for the embedding model, provided as a JSON object. Use this field to specify settings that apply to the embedding model that you selected, such as how audio and video files are divided into segments.</p> <p>The fields that this object accepts depend on the embedding model. For the settings that each model accepts, see the documentation for that model.</p> <p>For an example of a <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateKnowledgeBase.html">CreateKnowledgeBase</a> request that uses this field to configure a multimodal embedding model, see the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateKnowledgeBase.html#API_agent_CreateKnowledgeBase_Examples">Examples</a> section of <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateKnowledgeBase.html">CreateKnowledgeBase</a>.</p>"""

audio instance-attribute 

audio: NotRequired[AudioConfigurations]

Configuration settings for processing audio content in multimodal knowledge bases.

This field is deprecated. Use modelConfiguration instead.

dimensions instance-attribute 

dimensions: NotRequired[Dimensions]

The dimensions details for the vector configuration used on the Bedrock embeddings model.

embedding_data_type instance-attribute 

embedding_data_type: NotRequired[EmbeddingDataType]

The data type for the vectors when using a model to convert text into vector embeddings. The model must support the specified data type for vector embeddings. Floating-point (float32) is the default data type, and is supported by most models for vector embeddings. See Supported embeddings models for information on the available models and their vector data types.

model_configuration instance-attribute 

model_configuration: NotRequired[object]

Model-specific configuration for the embedding model, provided as a JSON object. Use this field to specify settings that apply to the embedding model that you selected, such as how audio and video files are divided into segments.

The fields that this object accepts depend on the embedding model. For the settings that each model accepts, see the documentation for that model.

For an example of a CreateKnowledgeBase request that uses this field to configure a multimodal embedding model, see the Examples section of CreateKnowledgeBase.

video instance-attribute 

video: NotRequired[VideoConfigurations]

Configuration settings for processing video content in multimodal knowledge bases.

This field is deprecated. Use modelConfiguration instead.