ANN Search Operator: Faiss

author: shiyu

Desription

Search embedding in Faiss, please make sure you have inserted data to Faiss before search.

Code Example

please insert data into faiss first.

Example

Write a same pipeline with explicit inputs/outputs name specifications:

from towhee.dc2 import pipe, ops

p = pipe.input('vec')  \
    .flat_map('vec', 'rows', ops.ann_search.faiss(findex='index.bin'))  \
    .map('rows', ('id', 'score'), lambda x: (x[0], x[1], x[2]))  \
    .output('id', 'score')

p('cat')

Factory Constructor

Create the operator via the following factory method:

ann_search.faiss(findex)

Parameters:

findex: str or faiss.INDEX

The path to faiss index file or faiss index.

Interface

Parameters:

query: list

Query embeddings in Faiss

Returns: Entity

Return the results in Faiss with key and score.