Skip to content

Commit

Permalink
Merge pull request #24 from carlson-svg/patch-1
Browse files Browse the repository at this point in the history
Update README.md for clearer use on runpod.io UI
  • Loading branch information
pandyamarut authored Jan 23, 2025
2 parents acd1a2a + 6f21e13 commit b17a6a7
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,13 +124,37 @@ You may use `/run` (asynchronous, start job and return job ID) or `/runsync` (sy
Inputs:
* `model`: name of one of the deployed models.
* `input`: single text string or list of texts to embed
#### Sample Usage on runpod.io
```json
{
"input": {
"model": "BAAI/bge-small-en-v1.5",
"input": "Hello World"
}
}
```

### Reranking
Inputs:
* `model`: name of one of the deployed models
* `query`: query text (single string)
* `docs`: list of documents to rerank by query
* `return_docs`: whether to return the reranked documents or not
#### Sample Usage on runpod.io
```json
{
"input": {
"model": "BAAI/bge-reranker-large",
"query": "Which product has warranty coverage?",
"docs": [
"Product A comes with a 2-year warranty",
"Product B is available in red and blue colors",
"All electronics include a standard 1-year warranty"
],
"return_docs": true
}
}
```


# Acknowledgements
Expand Down

0 comments on commit b17a6a7

Please sign in to comment.