15 KiB
title, weight
| title | weight |
|---|---|
| Working with ColBERT | 6 |
How to Generate ColBERT Multivectors with FastEmbed
Qdrant supports multivector representations and with FastEmbed you can use ColBERT to generate multivector embeddings. FastEmbed will provide an optimized pipeline to utilize these embeddings in your search tasks.
ColBERT is a powerful model created as a more production-suitable alternative to cross-encoders
for reranking. Its improved inference time with preserved high reranking quality is possible due to the late interaction mechanism.
What is late interaction? Cross-encoders ingest both a query and a document as one input, and all the interactions between query
and document parts happen "early", inside the model, which produces the similarity score based on how related these parts are.
Late interaction models, such as ColBERT, generate one vector per term (token) in a document (quer separately
(this is why the embeddings the model produces are multivectors) and the similarity score is computed "later"
between these vectors (query/document parts), outside of the model.
ColBERT with multivector embeddings is more precise than dense embedding models like BAAI/bge-small-en-v1.5,
which embed a whole document (and query) into just a single vector.
Consequently, ColBERT requires significantly more resources, so it should be primarily used for reranking rather than first-stage retrieval.
The first-stage simple fast retriever can retrieve 100-500 examples. Then, you can rank the remaining results using ColBERT.
However, in this section, we are just showing you how to use the ColBERT with FastEmbed, so we use it as a first-stage retriever on a toy dataset. You can see how to use ColBERT as a reranker in our Multi-stage queries documentation.
Setup
Install fastembed.
pip install fastembed
Imports late interaction models for text embedding.
from fastembed import LateInteractionTextEmbedding
You can list which late interaction models are supported in FastEmbed.
LateInteractionTextEmbedding.list_supported_models()
This command displays the available models. The output shows details about the model, including output embedding dimensions, model description, model size, model sources, and model file.
[{'model': 'colbert-ir/colbertv2.0',
'dim': 128,
'description': 'Late interaction model',
'size_in_GB': 0.44,
'sources': {'hf': 'colbert-ir/colbertv2.0'},
'model_file': 'model.onnx'},
{'model': 'answerdotai/answerai-colbert-small-v1',
'dim': 96,
'description': 'Text embeddings, Unimodal (text), Multilingual (~100 languages), 512 input tokens truncation, 2024 year',
'size_in_GB': 0.13,
'sources': {'hf': 'answerdotai/answerai-colbert-small-v1'},
'model_file': 'vespa_colbert.onnx'}]
Now, load the model.
embedding_model = LateInteractionTextEmbedding("colbert-ir/colbertv2.0")
The model files will be fetched and downloaded, with progress showing.
Embed data
Here is our toy dataset of movies.
We will vectorize movies descriptions with ColBERT:
descriptions = ["In 1431, Jeanne d'Arc is placed on trial on charges of heresy. The ecclesiastical jurists attempt to force Jeanne to recant her claims of holy visions.",
"A film projectionist longs to be a detective, and puts his meagre skills to work when he is framed by a rival for stealing his girlfriend's father's pocketwatch.",
"A group of high-end professional thieves start to feel the heat from the LAPD when they unknowingly leave a clue at their latest heist.",
"A petty thief with an utter resemblance to a samurai warlord is hired as the lord's double. When the warlord later dies the thief is forced to take up arms in his place.",
"A young boy named Kubo must locate a magical suit of armour worn by his late father in order to defeat a vengeful spirit from the past.",
"A biopic detailing the 2 decades that Punjabi Sikh revolutionary Udham Singh spent planning the assassination of the man responsible for the Jallianwala Bagh massacre.",
"When a machine that allows therapists to enter their patients' dreams is stolen, all hell breaks loose. Only a young female therapist, Paprika, can stop it.",
"An ordinary word processor has the worst night of his life after he agrees to visit a girl in Soho whom he met that evening at a coffee shop.",
"A story that revolves around drug abuse in the affluent north Indian State of Punjab and how the youth there have succumbed to it en-masse resulting in a socio-economic decline.",
"A world-weary political journalist picks up the story of a woman's search for her son, who was taken away from her decades ago after she became pregnant and was forced to live in a convent.",
"Concurrent theatrical ending of the TV series Neon Genesis Evangelion (1995).",
"During World War II, a rebellious U.S. Army Major is assigned a dozen convicted murderers to train and lead them into a mass assassination mission of German officers.",
"The toys are mistakenly delivered to a day-care center instead of the attic right before Andy leaves for college, and it's up to Woody to convince the other toys that they weren't abandoned and to return home.",
"A soldier fighting aliens gets to relive the same day over and over again, the day restarting every time he dies.",
"After two male musicians witness a mob hit, they flee the state in an all-female band disguised as women, but further complications set in.",
"Exiled into the dangerous forest by her wicked stepmother, a princess is rescued by seven dwarf miners who make her part of their household.",
"A renegade reporter trailing a young runaway heiress for a big story joins her on a bus heading from Florida to New York, and they end up stuck with each other when the bus leaves them behind at one of the stops.",
"Story of 40-man Turkish task force who must defend a relay station.",
"Spinal Tap, one of England's loudest bands, is chronicled by film director Marty DiBergi on what proves to be a fateful tour.",
"Oskar, an overlooked and bullied boy, finds love and revenge through Eli, a beautiful but peculiar girl."]
The vectorization is done with an embed generator function.
descriptions_embeddings = list(
embedding_model.embed(descriptions)
)
Let's check the size of one of the produced embeddings.
descriptions_embeddings[0].shape
We get the following result
(48, 128)
That means that for the first description, we have 48 vectors of lengths 128 representing it.
Upload embeddings to Qdrant
Install qdrant_client
pip install qdrant_client
Here, we're using a free cluster created in Qdrant Cloud. To get it, you need to register in Qdrant Cloud, create a free cluster, and create an API key. You can find cluster endpoint and API keys in "Cluster Details" section.
from qdrant_client import QdrantClient, models
qdrant_client = QdrantClient(
"<CLUSTER ENDPOINT>",
api_key="<CLUSTER API KEY>",
)
Now, let's create a small collection with our movie data. For that, we will use the multivectors functionality supported in Qdrant. To configure multivector collection, we need to specify:
- similarity metric between vectors;
- the size of each vector (for ColBERT, it's 128);
- similarity metric between multivectors (matrices), for example,
maximum, so for vector from matrix A, we find the most similar vector from matrix B, and their similarity score will be out matrix similarity.
qdrant_client.create_collection(
collection_name="movies",
vectors_config=models.VectorParams(
size=len(descriptions_embeddings[0][0]), #128, size of each vector produced by ColBERT
distance=models.Distance.COSINE, #similaraity metric between each vector
multivector_config=models.MultiVectorConfig(
comparator=models.MultiVectorComparator.MAX_SIM #similarity metric between multivectors (matrices)
),
),
)
To make this collection human-readable, let's save movie metadata (name, description in text form and movie's length) together with an embedded description.
metadata = [{"movie_name": "The Passion of Joan of Arc", "movie_watch_time_min": 114, "movie_description": "In 1431, Jeanne d'Arc is placed on trial on charges of heresy. The ecclesiastical jurists attempt to force Jeanne to recant her claims of holy visions."},
{"movie_name": "Sherlock Jr.", "movie_watch_time_min": 45, "movie_description": "A film projectionist longs to be a detective, and puts his meagre skills to work when he is framed by a rival for stealing his girlfriend's father's pocketwatch."},
{"movie_name": "Heat", "movie_watch_time_min": 170, "movie_description": "A group of high-end professional thieves start to feel the heat from the LAPD when they unknowingly leave a clue at their latest heist."},
{"movie_name": "Kagemusha", "movie_watch_time_min": 162, "movie_description": "A petty thief with an utter resemblance to a samurai warlord is hired as the lord's double. When the warlord later dies the thief is forced to take up arms in his place."},
{"movie_name": "Kubo and the Two Strings", "movie_watch_time_min": 101, "movie_description": "A young boy named Kubo must locate a magical suit of armour worn by his late father in order to defeat a vengeful spirit from the past."},
{"movie_name": "Sardar Udham", "movie_watch_time_min": 164, "movie_description": "A biopic detailing the 2 decades that Punjabi Sikh revolutionary Udham Singh spent planning the assassination of the man responsible for the Jallianwala Bagh massacre."},
{"movie_name": "Paprika", "movie_watch_time_min": 90, "movie_description": "When a machine that allows therapists to enter their patients' dreams is stolen, all hell breaks loose. Only a young female therapist, Paprika, can stop it."},
{"movie_name": "After Hours", "movie_watch_time_min": 97, "movie_description": "An ordinary word processor has the worst night of his life after he agrees to visit a girl in Soho whom he met that evening at a coffee shop."},
{"movie_name": "Udta Punjab", "movie_watch_time_min": 148, "movie_description": "A story that revolves around drug abuse in the affluent north Indian State of Punjab and how the youth there have succumbed to it en-masse resulting in a socio-economic decline."},
{"movie_name": "Philomena", "movie_watch_time_min": 98, "movie_description": "A world-weary political journalist picks up the story of a woman's search for her son, who was taken away from her decades ago after she became pregnant and was forced to live in a convent."},
{"movie_name": "Neon Genesis Evangelion: The End of Evangelion", "movie_watch_time_min": 87, "movie_description": "Concurrent theatrical ending of the TV series Neon Genesis Evangelion (1995)."},
{"movie_name": "The Dirty Dozen", "movie_watch_time_min": 150, "movie_description": "During World War II, a rebellious U.S. Army Major is assigned a dozen convicted murderers to train and lead them into a mass assassination mission of German officers."},
{"movie_name": "Toy Story 3", "movie_watch_time_min": 103, "movie_description": "The toys are mistakenly delivered to a day-care center instead of the attic right before Andy leaves for college, and it's up to Woody to convince the other toys that they weren't abandoned and to return home."},
{"movie_name": "Edge of Tomorrow", "movie_watch_time_min": 113, "movie_description": "A soldier fighting aliens gets to relive the same day over and over again, the day restarting every time he dies."},
{"movie_name": "Some Like It Hot", "movie_watch_time_min": 121, "movie_description": "After two male musicians witness a mob hit, they flee the state in an all-female band disguised as women, but further complications set in."},
{"movie_name": "Snow White and the Seven Dwarfs", "movie_watch_time_min": 83, "movie_description": "Exiled into the dangerous forest by her wicked stepmother, a princess is rescued by seven dwarf miners who make her part of their household."},
{"movie_name": "It Happened One Night", "movie_watch_time_min": 105, "movie_description": "A renegade reporter trailing a young runaway heiress for a big story joins her on a bus heading from Florida to New York, and they end up stuck with each other when the bus leaves them behind at one of the stops."},
{"movie_name": "Nefes: Vatan Sagolsun", "movie_watch_time_min": 128, "movie_description": "Story of 40-man Turkish task force who must defend a relay station."},
{"movie_name": "This Is Spinal Tap", "movie_watch_time_min": 82, "movie_description": "Spinal Tap, one of England's loudest bands, is chronicled by film director Marty DiBergi on what proves to be a fateful tour."},
{"movie_name": "Let the Right One In", "movie_watch_time_min": 114, "movie_description": "Oskar, an overlooked and bullied boy, finds love and revenge through Eli, a beautiful but peculiar girl."}]
qdrant_client.upload_points(
collection_name="movies",
points=[
models.PointStruct(
id=idx,
payload=metadata[idx],
vector=vector
)
for idx, vector in enumerate(descriptions_embeddings)
],
)
Querying
ColBERT uses two distinct methods for embedding documents and queries, as do we in Fastembed. However, we altered query pre-processing used in ColBERT, so we don't have to cut all queries after 32-token length but ingest longer queries directly.
qdrant_client.query_points(
collection_name="movies",
query=list(embedding_model.query_embed("A movie for kids with fantasy elements and wonders"))[0], #converting generator object into numpy.ndarray
limit=1, #How many closest to the query movies we would like to get
#with_vectors=True, #If this option is used, vectors will also be returned
with_payload=True #So metadata is provided in the output
)
The result is the following:
QueryResponse(points=[ScoredPoint(id=4, version=0, score=12.063469,
payload={'movie_name': 'Kubo and the Two Strings', 'movie_watch_time_min': 101,
'movie_description': 'A young boy named Kubo must locate a magical suit of armour worn by his late father in order to defeat a vengeful spirit from the past.'},
vector=None, shard_key=None, order_value=None)])