diff --git a/docs/api/filter-gateway.md b/docs/api/filter-gateway.md index 7e645a7da3..dba621862c 100644 --- a/docs/api/filter-gateway.md +++ b/docs/api/filter-gateway.md @@ -1477,6 +1477,17 @@ service Filter { | id | string | | the vector ID | | distance | float | | the distance between result vector and request vector | +### Status Code + +| code | desc. | +| :--: | :---------------- | +| 0 | OK | +| 1 | CANCELLED | +| 3 | INVALID_ARGUMENT | +| 4 | DEADLINE_EXCEEDED | +| 5 | NOT_FOUND | +| 13 | INTERNAL | + ## MultiSearch RPC MultiSearch RPC is the method to search objects with multiple objects in **1** request. diff --git a/docs/api/remove.md b/docs/api/remove.md index 94d9d09916..b0f4c5c641 100644 --- a/docs/api/remove.md +++ b/docs/api/remove.md @@ -369,7 +369,7 @@ gRPC has a message size limitation.
Please be careful that the size of the request exceeds the limit. -## Input +### Input - the scheme of `payload.v1.Remove.MultiRequest` diff --git a/docs/api/search.md b/docs/api/search.md index ea382e96da..dab76e0cec 100644 --- a/docs/api/search.md +++ b/docs/api/search.md @@ -700,7 +700,7 @@ Here are some common reasons and how to resolve each error. | NOT_FOUND | Search result is empty or insufficient to request result length. | Send a request with another vector or set min_num to a smaller value. | | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | -### MultiSearchByID RPC +## MultiSearchByID RPC MultiSearchByID RPC is the method to search vectors with multiple IDs in **1** request. @@ -1485,7 +1485,7 @@ Here are some common reasons and how to resolve each error. | NOT_FOUND | Search result is empty or insufficient to request result length. | Send a request with another vector or set min_num to a smaller value. | | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. | -### MultiLinearSearchByID RPC +## MultiLinearSearchByID RPC MultiLinearSearchByID RPC is the method to linear search vectors with multiple IDs in **1** request. diff --git a/docs/overview/component/agent.md b/docs/overview/component/agent.md index 1cf33ad534..8a61299fae 100644 --- a/docs/overview/component/agent.md +++ b/docs/overview/component/agent.md @@ -74,9 +74,9 @@ You have to wait to complete the CreateIndex and SaveIndex functions before sear This image shows the mechanism to create NGT index. - +NGT Index Creation Mechanism -Please refer to [Go Doc](https://pkg.go.dev/github.com/vdaas/vald@v1.3.1/pkg/agent/core/ngt/service) for other functions. +Please refer to [Go Doc](https://pkg.go.dev/github.com/vdaas/vald@VERSION@/pkg/agent/core/ngt/service) for other functions. #### Vald Agent Faiss diff --git a/docs/tutorial/get-started.md b/docs/tutorial/get-started.md index 5b711215af..5f14077cff 100644 --- a/docs/tutorial/get-started.md +++ b/docs/tutorial/get-started.md @@ -443,7 +443,7 @@ If you are interested, please refer to [SDKs](../user-guides/sdks.md).
```go _, err := client.Flush(ctx, &payload.Flush_Request{}) if err != nil { - glg.Fatal(err) + glg.Fatal(err) } ``` diff --git a/docs/user-guides/read-replica-and-rotator.md b/docs/user-guides/read-replica-and-rotator.md index 9c682eed18..56804573f9 100644 --- a/docs/user-guides/read-replica-and-rotator.md +++ b/docs/user-guides/read-replica-and-rotator.md @@ -3,7 +3,7 @@ Read replica enhances the search QPS (Queries Per Second) of the Vald cluster by deploying read-only agents in addition to the regular agents and distributing the requests among them. Read replica is deployed as Kubernetes deployments, and depending on the number of replicas (N), QPS increases by approximately 1.7 to 1.8 times \* N.
-The increase in QPS is possible with sufficient infrastructure (see [Important notes](#important-notes)). +The increase in QPS is possible with sufficient infrastructure (see Important notes).
## How to deploy read replica @@ -14,7 +14,7 @@ The read replica is managed with a separate chart from the Vald cluster and is d ### When you deploy Vald with Helm command -1. Edit `values.yaml` like below (Please refer to [deployment](deployment) for other fields.) +1. Edit `values.yaml` like below (Please refer to [deployment](../user-guides/deployment.md) for other fields.) ```yaml agent: