Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release update contents #214

Closed
wants to merge 2 commits into from
Closed

Release update contents #214

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9f69ff4
:pencil: Update contents by GitHub Actions
vdaas-ci Oct 28, 2024
a28b107
:robot: auto update stage :arrow_up:
vdaas-ci Oct 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions content/docs/user-guides/sdks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Sdks_user Guides"
date: 2024-02-15T17:10:16+09:00
date: 2024-10-28T08:20:09Z
draft: false
weight: 1400
description: Sends request and receives response from the Vald cluster
Expand All @@ -27,7 +27,6 @@ Here is the list of Official SDKs.
- [Java](https://github.com/vdaas/vald-client-java)
- [Python](https://github.com/vdaas/vald-client-python)
- [Node.js](https://github.com/vdaas/vald-client-node)
- [Clojure](https://github.com/vdaas/vald-client-clj)

## How to use SDKs

Expand Down
3 changes: 1 addition & 2 deletions content/docs/v1.7/api/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Api_v1.7/Api"
date: 2024-08-08T10:35:18+09:00
date: 2024-10-28T08:21:05Z
draft: false
weight: 0
---
Expand All @@ -22,7 +22,6 @@ The APIs overview tables is here:
| Upsert Service | Update the exists vector(s) in the Vald Agent Pods or Insert new vector(s) into the Vald Agent Pods if the vector is not exists. | [Upsert](/docs/v1.7/api/upsert#upsert-rpc)<br>[StreamUpsert](/docs/v1.7/api/upsert#streamupsert-rpc)<br>[MultiUpdate](/docs/v1.7/api/upsert#multiupsert-rpc) | [Vald Upsert APIs](/docs/v1.7/api/upsert) |
| Search Service | Search nearest neighbor vectors using query (vectors or IDs).<br>There are 2 types of Search methods: Search (means ANN Search) and LinearSearch. | [Search](/docs/v1.7/api/search#search-rpc)<br>[SearchByID](/docs/v1.7/api/search#searchbyid-rpc)<br>[StreamSearch](/docs/v1.7/api/search#streamsearch-rpc)<br>[StreamSearchByID](/docs/v1.7/api/search#streamsearchbyid-rpc)<br>[MultiSearch](/docs/v1.7/api/search#multisearch-rpc)<br>[MultiSearchByID](/docs/v1.7/api/search#multisearchbyid-rpc)<br>[LinearSearch](/docs/v1.7/api/search#linearsearch-rpc)<br>[LinearSearchByID](/docs/v1.7/api/search#linearsearchbyid-rpc)<br>[StreamLinearSearch](/docs/v1.7/api/search#streamlinearsearch-rpc)<br>[StreamLinearSearchByID](/docs/v1.7/api/search#streamlinearsearchbyid-rpc)<br>[MultiLinearSearch](/docs/v1.7/api/search#multilinearsearch-rpc)<br>[MultiLinearSearchByID](/docs/v1.7/api/search#multilinearsearchbyid-rpc) | [Vald Search APIs](/docs/v1.7/api/search) |
| Remove Service | Remove the exists vector(s) from the Vald Agent Pods. | [Remove](/docs/v1.7/api/remove#remove-rpc)<br>[StreamRemove](/docs/v1.7/api/remove#streamremove-rpc)<br>[MultiRemove](/docs/v1.7/api/remove#multiremove-rpc) | [Vald Remove APIs](/docs/v1.7/api/remove) |
| Flush Service | Remove the exists all vector(s) from the Vald Agent Pods. | [Flush](/docs/v1.7/api/flush#flush-rpc)<br> | [Vald Flush APIs](/docs/v1.7/api/flush) |
| Object Service | Get information of vector(s) indexed into the Vald Agent Pods. | [Exists](/docs/v1.7/api/object#exists-rpc)<br>[GetObject](/docs/v1.7/api/object#getobject-rpc)<br>[StreamGetObject](/docs/v1.7/api/object#streamgetobject-rpc) | [Vald Object APIs](/docs/v1.7/api/object) |

<br>
Expand Down
6 changes: 3 additions & 3 deletions content/docs/v1.7/api/build_proto.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Build_proto_v1.7/Api"
date: 2024-08-08T10:35:18+09:00
date: 2024-10-28T08:21:05Z
draft: false
weight: 1100
description: How to build gRPC proto files for calling API to your Vald cluster
Expand Down Expand Up @@ -238,9 +238,9 @@ There are many tools for building proto in Rust, we use [tonic](https://github.c
}
```

1. `src/client.rs`
1. `src/clinet.rs`

There are 4 steps in `src/client.rs`:
There are 4 steps in `src/clinet.rs`:

1. Load dataset
1. Insert vector to Vald cluster
Expand Down
15 changes: 2 additions & 13 deletions content/docs/v1.7/api/filter-gateway.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Filter Gateway_v1.7/Api"
date: 2024-08-08T10:35:18+09:00
date: 2024-10-28T08:21:05Z
draft: false
weight: 800
description: How to use CRUD API with filter gateway
Expand All @@ -13,7 +13,7 @@ menu:

## Overview

Filter Server is responsible for providing insert, update, upsert and search interface for `Vald Filter Gateway`.
Filter Servie is responsible for providing insert, update, upsert and search interface for `Vald Filter Gateway`.

Vald Filter Gateway forward user request to user-defined ingress/egress filter components allowing user to run custom logic.

Expand Down Expand Up @@ -1488,17 +1488,6 @@ 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.
Expand Down
78 changes: 0 additions & 78 deletions content/docs/v1.7/api/flush.md
View file
Open in desktop

This file was deleted.

11 changes: 4 additions & 7 deletions content/docs/v1.7/api/insert.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Insert_v1.7/Api"
date: 2024-10-16T16:06:00+09:00
date: 2024-10-28T08:21:05Z
draft: false
weight: 100
description: Insert vectors to the Vald cluster
Expand Down Expand Up @@ -108,10 +108,9 @@ Inset RPC is the method to add a new single vector.
| 3 | INVALID_ARGUMENT |
| 4 | DEADLINE_EXCEEDED |
| 6 | ALREADY_EXISTS |
| 10 | ABORTED |
| 13 | INTERNAL |

Please refer to [Response Status Code](/docs/v1.7/status) for more details.
Please refer to [Response Status Code](./status) for more details.

### Troubleshooting

Expand Down Expand Up @@ -234,10 +233,9 @@ It's the recommended method to insert a large number of vectors.
| 3 | INVALID_ARGUMENT |
| 4 | DEADLINE_EXCEEDED |
| 6 | ALREADY_EXISTS |
| 10 | ABORTED |
| 13 | INTERNAL |

Please refer to [Response Status Code](/docs/v1.7/status) for more details.
Please refer to [Response Status Code](./status) for more details.

### Troubleshooting

Expand Down Expand Up @@ -357,10 +355,9 @@ Please be careful that the size of the request exceeds the limit.
| 3 | INVALID_ARGUMENT |
| 4 | DEADLINE_EXCEEDED |
| 6 | ALREADY_EXISTS |
| 10 | ABORTED |
| 13 | INTERNAL |

Please refer to [Response Status Code](/docs/v1.7/status) for more details.
Please refer to [Response Status Code](./status) for more details.

### Troubleshooting

Expand Down
96 changes: 0 additions & 96 deletions content/docs/v1.7/api/mirror-gateway.md
View file
Open in desktop

This file was deleted.

8 changes: 4 additions & 4 deletions content/docs/v1.7/api/object.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Object_v1.7/Api"
date: 2024-10-16T16:06:00+09:00
date: 2024-10-28T08:21:05Z
draft: false
weight: 700
description: Get object information in the Vald cluster
Expand Down Expand Up @@ -78,7 +78,7 @@ Exists RPC is the method to check that a vector exists in the `vald-agent`.
| 5 | NOT_FOUND |
| 13 | INTERNAL |

Please refer to [Response Status Code](/docs/v1.7/status) for more details.
Please refer to [Response Status Code](./status) for more details.

### Troubleshooting

Expand Down Expand Up @@ -159,7 +159,7 @@ GetObject RPC is the method to get the metadata of a vector inserted into the `v
| 5 | NOT_FOUND |
| 13 | INTERNAL |

Please refer to [Response Status Code](/docs/v1.7/status) for more details.
Please refer to [Response Status Code](./status) for more details.

### Troubleshooting

Expand Down Expand Up @@ -253,7 +253,7 @@ Each Upsert request and response are independent.
| 5 | NOT_FOUND |
| 13 | INTERNAL |

Please refer to [Response Status Code](/docs/v1.7/status) for more details.
Please refer to [Response Status Code](./status) for more details.

### Troubleshooting

Expand Down
Loading
Loading