Skip to content

Commit cdb4e03

Browse files
joshuayaopre-commit-ci[bot]Copilot
authored andcommitted
Refine DocIndexRetriever READMEs (opea-project#2180)
Signed-off-by: Yi Yao <yi.a.yao@intel.com> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: alexsin368 <alex.sin@intel.com>
1 parent daa96a9 commit cdb4e03

File tree

1 file changed

+6
-29
lines changed

1 file changed

+6
-29
lines changed

DocIndexRetriever/README.md

Lines changed: 6 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -68,37 +68,14 @@ flowchart LR
6868
6969
```
7070

71-
## We provided DocRetriever with different deployment infra
71+
## Deployment Options
7272

73-
- [docker xeon version](docker_compose/intel/cpu/xeon/README.md) => minimum endpoints, easy to setup
74-
- [docker gaudi version](docker_compose/intel/hpu/gaudi/README.md) => with extra tei_gaudi endpoint, faster
73+
The table below lists currently available deployment options. They outline in detail the implementation of this example on selected hardware.
7574

76-
## We allow users to set retriever/reranker hyperparams via requests
77-
78-
Example usage:
79-
80-
```python
81-
url = "http://{host_ip}:{port}/v1/retrievaltool".format(host_ip=host_ip, port=port)
82-
payload = {
83-
"messages": query, # must be a string, this is a required field
84-
"k": 5, # retriever top k
85-
"top_n": 2, # reranker top n
86-
}
87-
response = requests.post(url, json=payload)
88-
```
89-
90-
**Note**: `messages` is the required field. You can also pass in parameters for the retriever and reranker in the request. The parameters that can changed are listed below.
91-
92-
1. retriever
93-
* search_type: str = "similarity"
94-
* k: int = 4
95-
* distance_threshold: Optional[float] = None
96-
* fetch_k: int = 20
97-
* lambda_mult: float = 0.5
98-
* score_threshold: float = 0.2
99-
100-
2. reranker
101-
* top_n: int = 1
75+
| Category | Deployment Option | Guide |
76+
| ---------------------- | ----------------- | ----------------------------------------------------------------------------------- |
77+
| On-premise Deployments | Docker compose | [DocIndexRetriever deployment on Xeon](./docker_compose/intel/cpu/xeon/README.md) |
78+
| | | [DocIndexRetriever deployment on Gaudi](./docker_compose/intel/hpu/gaudi/README.md) |
10279

10380
## Validated Configurations
10481

0 commit comments

Comments
 (0)