Skip to content

Commit 5d3b930

Browse files
committed
Update hakes-worker README
1 parent 879db61 commit 5d3b930

1 file changed

Lines changed: 19 additions & 0 deletions

File tree

docker/hakes-worker/no-sgx/README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,25 @@
66
docker build -t hakes-hakesworker-nosgx:v1 -f docker/hakes-worker/no-sgx/Dockerfile .
77
```
88

9+
## prepare the config file
10+
11+
The config file mounted for hakes-worker container controls how it interacts with other components in HAKES to serve user requests. A sample config is show below.
12+
13+
```json
14+
{
15+
"embed_endpoint_type": "hakes-embed",
16+
"embed_endpoint_config": "",
17+
"embed_endpoint_addr": "10.10.10.28:2700",
18+
"search_worker_addrs": ["10.10.10.57:2800"],
19+
"preferred_search_worker": 0,
20+
"store_addr": "10.10.10.26:2600"
21+
}
22+
```
23+
24+
* `embed_endpoint_type`, `embed_endpoint_config` and `embed_endpoint_addr` dictate the embed service that converts raw data in user requests to embedding vectors. When the `embed_endpoint_type` is `hakes-embed`, it uses an embed-worker server or function. We also support external embedding services through the [embed-endpoint](../../../embed-endpoint/) module, such as `openai` and `huggingface` for open-ai embedding APIs and huggingface inrference endpoints.
25+
* `search_worker_addrs` points to the search-workers that maintains the vector index and `preferred_search_worker` indicates the request routing to a specific search-worker that the hakes-worker will contact.
26+
* `store_addr` points to the hakes-store service that persists the data.
27+
928
## run
1029

1130
```sh

0 commit comments

Comments
 (0)