https://github.com/codelibs/embedding-api
Sentence Encoding/Embedding Serving Server
https://github.com/codelibs/embedding-api
Last synced: 3 months ago
JSON representation
Sentence Encoding/Embedding Serving Server
- Host: GitHub
- URL: https://github.com/codelibs/embedding-api
- Owner: codelibs
- Created: 2022-03-06T13:22:45.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-03-07T06:38:25.000Z (over 1 year ago)
- Last Synced: 2025-01-28T10:36:37.580Z (5 months ago)
- Language: Python
- Homepage:
- Size: 123 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Sentence Embedding Serving Server
## Getting Started
### Run Docker
```
docker run -p 8080:8080 -it ghcr.io/codelibs/embedding-api:1.0.1
```
### Run Docker with Model Name
```
docker run -p 8080:8080 -e MODEL_NAME=intfloat/multilingual-e5-large -it ghcr.io/codelibs/embedding-api:1.0.1
```
### Use Model Cache
```
docker run -v ./model:/code/model -p 8080:8080 -it ghcr.io/codelibs/embedding-api:1.0.1
```
### Run Docker with GPU
```
docker run --gpus all -p 8080:8080 -it ghcr.io/codelibs/embedding-api:1.0.1.cuda11
```
## Request
### Embedding API
```
curl -s -H "Content-Type:application/json" -XPOST localhost:8080/encode -d '
{
"sentences": [
"This framework generates embeddings for each input sentence",
"Sentences are passed as a list of string.",
"The quick brown fox jumps over the lazy dog."
]
}'
```
### Information API
```
curl -s -H "Content-Type:application/json" -XGET localhost:8080/
```
### Ping API
```
curl -s -H "Content-Type:application/json" -XGET localhost:8080/ping
```
## Build
### Build Docker
```
docker build --rm -t ghcr.io/codelibs/embedding-api:1.0.1 .
```