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

add api status code description #1679

Merged
merged 14 commits into from
Jun 6, 2022
Merged

add api status code description #1679

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
e4c813d
:pencil: add api status code description
vankichi May 25, 2022
3383a3f
:pencil: grammar check
vankichi May 27, 2022
9d8c8d2
Apply suggestions from code review
vankichi May 27, 2022
869b979
Apply suggestions from code review
vankichi Jun 2, 2022
0ec6be9
:pencil: update by feedback
vankichi Jun 2, 2022
1525567
Merge branch 'master' into documentation/docs/add-api-status-code
vankichi Jun 2, 2022
576bba2
Merge branch 'master' into documentation/docs/add-api-status-code
vankichi Jun 3, 2022
16cc6d6
Merge branch 'documentation/docs/add-api-status-code' of https://gith…
vankichi Jun 6, 2022
31c2cd7
Merge branch 'master' into documentation/docs/add-api-status-code
vankichi Jun 6, 2022
403a73f
Merge branch 'documentation/docs/add-api-status-code' of https://gith…
vankichi Jun 6, 2022
d10a727
:pencil: update by feedback
vankichi Jun 6, 2022
a6ca5e3
Update docs/api/status.md
vankichi Jun 6, 2022
5444454
Apply suggestions from code review
vankichi Jun 6, 2022
64490b0
Merge branch 'master' into documentation/docs/add-api-status-code
kpango Jun 6, 2022
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 docs/api/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,7 @@ The APIs overview tables is here:
| Insert Service | Insert new vector(s) into the Vald Agent Pods. | [Insert](../api/insert.md#insert-rpc)<br>[StreamInsert](../api/insert.md#streaminsert-rpc)<br>[MultiInsert](../api/insert.md#multiinsert-rpc) | [Vald Insert APIs](../api/insert.md) |
| Update Service | Update the exists vector(s) in the Vald Agent Pods. | [Update](../api/update.md#update-rpc)<br>[StreamUpdate](../api/update.md#streamupdate-rpc)<br>[MultiUpdate](../api/update.md#multiupdate-rpc) | [Vald Update APIs](../api/update.md) |
| 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](../api/upsert.md#upsert-rpc)<br>[StreamUpsert](../api/upsert.md#streamupsert-rpc)<br>[MultiUpdate](../api/upsert.md#multiupsert-rpc) | [Vald Upsert APIs](../api/upsert.md) |
| 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](../api/search.md#search-rpc)<br>[SearchByID](../api/search.md#searchbyid-rpc)<br>[StreamSearch](../api/search.md#streamsearch-rpc)<br>[StreamSearchByID](../api/search.md#streamsearchbyid-rpc)<br>[MultiSearch](../api/search.md#multisearch-rpc)<br>[MultiSearchByID](../api/search.md#multisearchbyid-rpc) | [Vald Search APIs](../api/search.md) |
| ^ | ^ | [LinearSearch](../api/search.md#linearsearch-rpc)<br>[LinearSearchByID](../api/search.md#linearsearchbyid-rpc)<br>[StreamLinearSearch](../api/search.md#streamlinearsearch-rpc)<br>[StreamLinearSearchByID](../api/search.md#streamlinearsearchbyid-rpc)<br>[MultiLinearSearch](../api/search.md#multilinearsearch-rpc)<br>[MultiLinearSearchByID](../api/search.md#multilinearsearchbyid-rpc) | ^ |
| 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](../api/search.md#search-rpc)<br>[SearchByID](../api/search.md#searchbyid-rpc)<br>[StreamSearch](../api/search.md#streamsearch-rpc)<br>[StreamSearchByID](../api/search.md#streamsearchbyid-rpc)<br>[MultiSearch](../api/search.md#multisearch-rpc)<br>[MultiSearchByID](../api/search.md#multisearchbyid-rpc)<br>[LinearSearch](../api/search.md#linearsearch-rpc)<br>[LinearSearchByID](../api/search.md#linearsearchbyid-rpc)<br>[StreamLinearSearch](../api/search.md#streamlinearsearch-rpc)<br>[StreamLinearSearchByID](../api/search.md#streamlinearsearchbyid-rpc)<br>[MultiLinearSearch](../api/search.md#multilinearsearch-rpc)<br>[MultiLinearSearchByID](../api/search.md#multilinearsearchbyid-rpc) | [Vald Search APIs](../api/search.md) |
| Remove Service | Remove the exists vector(s) from the Vald Agent Pods. | [Remove](../api/remove.md#remove-rpc)<br>[StreamRemove](../api/remove.md#streamremove-rpc)<br>[MultiRemove](../api/remove.md#multiremove-rpc) | [Vald Remove APIs](../api/remove.md) |
| Object Service | Get information of vector(s) indexed into the Vald Agent Pods. | [Exists](../api/object.md#exists-rpc)<br>[GetObject](../api/object.md#getobject-rpc)<br>[StreamGetObject](../api/object.md#streamgetobject-rpc) | [Vald Object APIs](../api/object.md) |

Expand Down
Loading