-
Notifications
You must be signed in to change notification settings - Fork 21
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
38 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
# Flag Embedding extractor (BGE) | ||
|
||
This extracctor uses FlagEmbedding that can map any text to a low-dimensional dense vector which can be used for tasks like retrieval, classification, clustering, or semantic search. It uses [BGE base model](https://huggingface.co/BAAI/bge-base-en) from [HuggingFace](https://huggingface.co/). | ||
|
||
Example input: | ||
|
||
```text | ||
The quick brown fox jumps over the lazy dog. | ||
``` | ||
|
||
Example output: | ||
|
||
```json | ||
{ | ||
"embedding": [ | ||
510.3, | ||
240.2, | ||
... | ||
] | ||
} | ||
``` | ||
|
||
## Usage | ||
|
||
Try out the extractor. Write your favorite (foreign) quote. | ||
|
||
```bash | ||
cd flag_embedding | ||
indexify extractor extract --text "The quick brown fox jumps over the lazy dog." | ||
``` | ||
|
||
## Container | ||
|
||
* The container is not published yet. * | ||
|
||
```bash | ||
docker run -it indexify-extractors/flag_embedding extractor extract --text "The quick brown fox jumps over the lazy dog." | ||
``` |