MongoDbAtlasConfiguration ¶

class MongoDbAtlasConfiguration(TypedDict, closed=True):
    endpoint: "capo_bedrock_agent.types.mongo_db_atlas_endpoint.MongoDbAtlasEndpoint"
    """<p>The endpoint URL of your MongoDB Atlas cluster for your knowledge base.</p>"""
    database_name: (
        "capo_bedrock_agent.types.mongo_db_atlas_database_name.MongoDbAtlasDatabaseName"
    )
    """<p>The database name in your MongoDB Atlas cluster for your knowledge base.</p>"""
    collection_name: "capo_bedrock_agent.types.mongo_db_atlas_collection_name.MongoDbAtlasCollectionName"
    """<p>The collection name of the knowledge base in MongoDB Atlas.</p>"""
    vector_index_name: (
        "capo_bedrock_agent.types.mongo_db_atlas_index_name.MongoDbAtlasIndexName"
    )
    """<p>The name of the MongoDB Atlas vector search index.</p>"""
    credentials_secret_arn: "capo_bedrock_agent.types.secret_arn.SecretArn"
    """<p>The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that contains user credentials for your MongoDB Atlas cluster.</p>"""
    field_mapping: (
        "capo_bedrock_agent.types.mongo_db_atlas_field_mapping.MongoDbAtlasFieldMapping"
    )
    """<p>Contains the names of the fields to which to map information about the vector store.</p>"""
    endpoint_service_name: NotRequired[
        "capo_bedrock_agent.types.mongo_db_atlas_endpoint_service_name.MongoDbAtlasEndpointServiceName"
    ]
    """<p>The name of the VPC endpoint service in your account that is connected to your MongoDB Atlas cluster.</p>"""
    text_index_name: NotRequired[
        "capo_bedrock_agent.types.mongo_db_atlas_index_name.MongoDbAtlasIndexName"
    ]
    """<p>The name of the text search index in the MongoDB collection. This is required for using the hybrid search feature.</p>"""