https://neuml.github.io/txtai/embeddings/

[ ] [ ]
Skip to content
logo
txtai
Embeddings
( ) ( )
[                    ]
Initializing search

 
neuml/txtai
logo txtai
 
neuml/txtai

  * Home
  * Why txtai?
  * Installation
  * Examples
  * [*]
    Embeddings
    Embeddings
      + Configuration
      + Methods
      + Query Guide
  * [ ]
    Pipeline
    Pipeline
      + [ ] Audio Audio
          o Transcription
      + [ ] Data Data
          o Segmentation
          o Tabular
          o Textractor
      + [ ] Image Image
          o Caption
          o Objects
      + [ ] Text Text
          o Extractor
          o Labels
          o Similarity
          o Summary
          o Translation
      + [ ] Train Train
          o HF ONNX
          o ML ONNX
          o Trainer
  * [ ]
    Workflow
    Workflow
      + Task
      + File
      + Image
      + Retrieve
      + Service
      + Storage
      + Url
      + Workflow
  * [ ]
    API
    API
      + Configuration
      + Cluster
      + Docker
  * Further Reading

Table of contents

  * Build
  * Index
  * Search

 

Embeddings

embeddings embeddings

Embeddings is the engine that delivers semantic search. Data is
transformed into embeddings vectors where similar concepts will
produce similar vectors. Indexes both large and small are built with
these vectors. The indexes are used find results that have the same
meaning, not necessarily the same keywords.

The following code snippet shows how to build and search an
embeddings index.

from txtai.embeddings import Embeddings

# Create embeddings model, backed by sentence-transformers & transformers
embeddings = Embeddings({"path": "sentence-transformers/nli-mpnet-base-v2"})

data = [
  "US tops 5 million confirmed virus cases",
  "Canada's last fully intact ice shelf has suddenly collapsed, " +
  "forming a Manhattan-sized iceberg",
  "Beijing mobilises invasion craft along coast as Taiwan tensions escalate",
  "The National Park Service warns against sacrificing slower friends " +
  "in a bear attack",
  "Maine man wins $1M from $25 lottery ticket",
  "Make huge profits without work, earn up to $100,000 a day"
]

# Create an index for the list of text
embeddings.index([(uid, text, None) for uid, text in enumerate(data)])

print("%-20s %s" % ("Query", "Best Match"))
print("-" * 50)

# Run an embeddings search for each query
for query in ("feel good story", "climate change", "public health story", "war",
              "wildlife", "asia", "lucky", "dishonest junk"):
    # Extract uid of first result
    # search result format: (uid, score)
    uid = embeddings.search(query, 1)[0][0]

    # Print text
    print("%-20s %s" % (query, data[uid]))

Build

An embeddings instance can be created as follows:

embeddings = Embeddings({"path": "sentence-transformers/nli-mpnet-base-v2"})

The example above builds a transformers based embeddings instance. In
this case, when loading and searching for data, a transformers model
is used to vectorize data. The embeddings instance is configuration
driven based on what is passed in the constructor. A number of
different options are supported to cover a wide variety of use cases.

Index

After creating a new Embeddings instance, the next step is adding
data to it.

embeddings.index([(uid, text, None) for uid, text in enumerate(data)])

The index method takes an iterable collection of tuples with three
values.

Element                          Description
id      unique record id
data    input data to index, can be text, a dictionary or object
tags    optional tags string, used to mark/label data as it's indexed

The input iterable can be a list and/or a generator. Generators help
with indexing very large datasets as only portions of the data is in
memory at any given time.

txtai buffers data to temporary storage along the way during indexing
as embeddings vectors can be quite large (for example 768 dimensions
of float32 is 768 * 4 = 3072 bytes per vector).

Search

Once data is indexed, it is ready for search.

embeddings.search(query, limit)

The search method takes two parameters, the query and query limit.
The results format is different based on whether content is stored or
not.

  * List of (id, score) when content is disabled
  * List of {**query columns} when content is enabled

 
Previous Examples
 
Next Configuration
(c) NeuML LLC, Apache-2.0 License
Made with Material for MkDocs