From e3ee420b1b466fc8ad6db24521dcaceb5ac2eae5 Mon Sep 17 00:00:00 2001 From: Yi Yao Date: Fri, 8 Aug 2025 15:24:47 +0800 Subject: [PATCH 1/4] Refine DocIndexRetriever READMEs Signed-off-by: Yi Yao --- DocIndexRetriever/README.md | 35 ++++++----------------------------- 1 file changed, 6 insertions(+), 29 deletions(-) diff --git a/DocIndexRetriever/README.md b/DocIndexRetriever/README.md index 8e25ca1c59..df3451aea9 100644 --- a/DocIndexRetriever/README.md +++ b/DocIndexRetriever/README.md @@ -68,37 +68,14 @@ flowchart LR ``` -## We provided DocRetriever with different deployment infra +## Deployment Options -- [docker xeon version](docker_compose/intel/cpu/xeon/README.md) => minimum endpoints, easy to setup -- [docker gaudi version](docker_compose/intel/hpu/gaudi/README.md) => with extra tei_gaudi endpoint, faster +The table below lists currently available deployment options. They outline in detail the implementation of this example on selected hardware. -## We allow users to set retriever/reranker hyperparams via requests - -Example usage: - -```python -url = "http://{host_ip}:{port}/v1/retrievaltool".format(host_ip=host_ip, port=port) -payload = { - "messages": query, # must be a string, this is a required field - "k": 5, # retriever top k - "top_n": 2, # reranker top n -} -response = requests.post(url, json=payload) -``` - -**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. - - 1. retriever - * search_type: str = "similarity" - * k: int = 4 - * distance_threshold: Optional[float] = None - * fetch_k: int = 20 - * lambda_mult: float = 0.5 - * score_threshold: float = 0.2 - - 2. reranker - * top_n: int = 1 +| Category | Deployment Option | Guide | +| ------------------------- | ---------------------------- | ------------------------------------------------------------------------ | +| On-premise Deployments | Docker compose | [ChatQnA deployment on Xeon](./docker_compose/intel/cpu/xeon/README.md) | +| | | [ChatQnA deployment on Gaudi](./docker_compose/intel/hpu/gaudi/README.md)| ## Validated Configurations From c2f4126dcd852e875620755bb92a59142742466e Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Fri, 8 Aug 2025 07:28:13 +0000 Subject: [PATCH 2/4] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- DocIndexRetriever/README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/DocIndexRetriever/README.md b/DocIndexRetriever/README.md index df3451aea9..78080261e3 100644 --- a/DocIndexRetriever/README.md +++ b/DocIndexRetriever/README.md @@ -72,10 +72,10 @@ flowchart LR The table below lists currently available deployment options. They outline in detail the implementation of this example on selected hardware. -| Category | Deployment Option | Guide | -| ------------------------- | ---------------------------- | ------------------------------------------------------------------------ | -| On-premise Deployments | Docker compose | [ChatQnA deployment on Xeon](./docker_compose/intel/cpu/xeon/README.md) | -| | | [ChatQnA deployment on Gaudi](./docker_compose/intel/hpu/gaudi/README.md)| +| Category | Deployment Option | Guide | +| ---------------------- | ----------------- | ------------------------------------------------------------------------- | +| On-premise Deployments | Docker compose | [ChatQnA deployment on Xeon](./docker_compose/intel/cpu/xeon/README.md) | +| | | [ChatQnA deployment on Gaudi](./docker_compose/intel/hpu/gaudi/README.md) | ## Validated Configurations From 3bfd5172fb254d818f58d773199faabeb66b2df5 Mon Sep 17 00:00:00 2001 From: Yi Yao Date: Mon, 11 Aug 2025 09:59:15 +0800 Subject: [PATCH 3/4] DocIndexRetriever: Apply suggestions from doc review Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- DocIndexRetriever/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/DocIndexRetriever/README.md b/DocIndexRetriever/README.md index 78080261e3..9c964b8b46 100644 --- a/DocIndexRetriever/README.md +++ b/DocIndexRetriever/README.md @@ -74,8 +74,8 @@ The table below lists currently available deployment options. They outline in de | Category | Deployment Option | Guide | | ---------------------- | ----------------- | ------------------------------------------------------------------------- | -| On-premise Deployments | Docker compose | [ChatQnA deployment on Xeon](./docker_compose/intel/cpu/xeon/README.md) | -| | | [ChatQnA deployment on Gaudi](./docker_compose/intel/hpu/gaudi/README.md) | +| On-premise Deployments | Docker compose | [DocIndexRetriever deployment on Xeon](./docker_compose/intel/cpu/xeon/README.md) | +| | | [DocIndexRetriever deployment on Gaudi](./docker_compose/intel/hpu/gaudi/README.md)| ## Validated Configurations From 997a40fe0ebff37d69c41790be3ef47de3704145 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Mon, 11 Aug 2025 01:59:54 +0000 Subject: [PATCH 4/4] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- DocIndexRetriever/README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/DocIndexRetriever/README.md b/DocIndexRetriever/README.md index 9c964b8b46..a797d2e9b2 100644 --- a/DocIndexRetriever/README.md +++ b/DocIndexRetriever/README.md @@ -72,10 +72,10 @@ flowchart LR The table below lists currently available deployment options. They outline in detail the implementation of this example on selected hardware. -| Category | Deployment Option | Guide | -| ---------------------- | ----------------- | ------------------------------------------------------------------------- | -| On-premise Deployments | Docker compose | [DocIndexRetriever deployment on Xeon](./docker_compose/intel/cpu/xeon/README.md) | -| | | [DocIndexRetriever deployment on Gaudi](./docker_compose/intel/hpu/gaudi/README.md)| +| Category | Deployment Option | Guide | +| ---------------------- | ----------------- | ----------------------------------------------------------------------------------- | +| On-premise Deployments | Docker compose | [DocIndexRetriever deployment on Xeon](./docker_compose/intel/cpu/xeon/README.md) | +| | | [DocIndexRetriever deployment on Gaudi](./docker_compose/intel/hpu/gaudi/README.md) | ## Validated Configurations