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

Jump to bottom

Add new API parameter and update observability docs #1966

Merged
merged 3 commits into from
Mar 10, 2023
Merged

Add new API parameter and update observability docs #1966

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7ae3264
:pencil: add new API parameter and update o11y docs
vankichi Mar 9, 2023
dfb5c1f
Apply suggestions from code review
vankichi Mar 9, 2023
c75089d
Update docs/user-guides/observability-configuration.md
vankichi Mar 9, 2023
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
66 changes: 36 additions & 30 deletions docs/api/filter-gateway.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -485,11 +485,12 @@ service Filter {

- Update.Config

| field | type | label | required | desc. |
| :---------------------: | :------------ | :---- | :------: | :-------------------------------------------------------------------------------------------------- |
| skip_strict_exist_check | bool | | | check the same vector is already updated or not.<br>the ID should be unique if the value is `true`. |
| timestamp | int64 | | | the timestamp of the vector updated.<br>if it is N/A, the current time will be used. |
| filters | Filter.Config | | | configuration for filter |
| field | type | label | required | desc. |
| :----------------------: | :------------ | :---- | :------: | :-------------------------------------------------------------------------------------------------- |
| skip_strict_exist_check | bool | | | check the same vector is already updated or not.<br>the ID should be unique if the value is `true`. |
| timestamp | int64 | | | the timestamp of the vector updated.<br>if it is N/A, the current time will be used. |
| filters | Filter.Config | | | configuration for filter |
| disabled_balanced_update | bool | | | A flag to disable balanced update (split remove -&gt; insert operation) during update operation. |

- Filter.Target

Expand Down Expand Up @@ -606,11 +607,12 @@ service Filter {

- Update.Config

| field | type | label | required | desc. |
| :---------------------: | :------------ | :---- | :------: | :-------------------------------------------------------------------------------------------------- |
| skip_strict_exist_check | bool | | | check the same vector is already updated or not.<br>the ID should be unique if the value is `true`. |
| timestamp | int64 | | | the timestamp of the vector updated.<br>if it is N/A, the current time will be used. |
| filters | Filter.Config | | | configuration for filter |
| field | type | label | required | desc. |
| :----------------------: | :------------ | :---- | :------: | :-------------------------------------------------------------------------------------------------- |
| skip_strict_exist_check | bool | | | check the same vector is already updated or not.<br>the ID should be unique if the value is `true`. |
| timestamp | int64 | | | the timestamp of the vector updated.<br>if it is N/A, the current time will be used. |
| filters | Filter.Config | | | configuration for filter |
| disabled_balanced_update | bool | | | A flag to disable balanced update (split remove -&gt; insert operation) during update operation. |

- Filter.Target

Expand Down Expand Up @@ -766,11 +768,12 @@ service Filter {

- Update.Config

| field | type | label | required | desc. |
| :---------------------: | :------------ | :---- | :------: | :-------------------------------------------------------------------------------------------------- |
| skip_strict_exist_check | bool | | | check the same vector is already updated or not.<br>the ID should be unique if the value is `true`. |
| timestamp | int64 | | | the timestamp of the vector updated.<br>if it is N/A, the current time will be used. |
| filters | Filter.Config | | | configuration for filter |
| field | type | label | required | desc. |
| :----------------------: | :------------ | :---- | :------: | :-------------------------------------------------------------------------------------------------- |
| skip_strict_exist_check | bool | | | check the same vector is already updated or not.<br>the ID should be unique if the value is `true`. |
| timestamp | int64 | | | the timestamp of the vector updated.<br>if it is N/A, the current time will be used. |
| filters | Filter.Config | | | configuration for filter |
| disabled_balanced_update | bool | | | A flag to disable balanced update (split remove -&gt; insert operation) during update operation. |

- Filter.Target

Expand Down Expand Up @@ -897,11 +900,12 @@ service Filter {

- Update.Config

| field | type | label | required | desc. |
| :---------------------: | :------------ | :---- | :------: | :--------------------------------------------------------------------------------------------------- |
| skip_strict_exist_check | bool | | | check the same vector is already upserted or not.<br>the ID should be unique if the value is `true`. |
| timestamp | int64 | | | the timestamp of the vector upserted.<br>if it is N/A, the current time will be used. |
| filters | Filter.Config | | | configuration for filter |
| field | type | label | required | desc. |
| :----------------------: | :------------ | :---- | :------: | :--------------------------------------------------------------------------------------------------- |
| skip_strict_exist_check | bool | | | check the same vector is already upserted or not.<br>the ID should be unique if the value is `true`. |
| timestamp | int64 | | | the timestamp of the vector upserted.<br>if it is N/A, the current time will be used. |
| filters | Filter.Config | | | configuration for filter |
| disabled_balanced_update | bool | | | A flag to disable balanced update (split remove -&gt; insert operation) during update operation. |

- Filter.Target

Expand Down Expand Up @@ -1015,11 +1019,12 @@ service Filter {

- Update.Config

| field | type | label | required | desc. |
| :---------------------: | :------------ | :---- | :------: | :--------------------------------------------------------------------------------------------------- |
| skip_strict_exist_check | bool | | | check the same vector is already upserted or not.<br>the ID should be unique if the value is `true`. |
| timestamp | int64 | | | the timestamp of the vector upserted.<br>if it is N/A, the current time will be used. |
| filters | Filter.Config | | | configuration for filter |
| field | type | label | required | desc. |
| :----------------------: | :------------ | :---- | :------: | :--------------------------------------------------------------------------------------------------- |
| skip_strict_exist_check | bool | | | check the same vector is already upserted or not.<br>the ID should be unique if the value is `true`. |
| timestamp | int64 | | | the timestamp of the vector upserted.<br>if it is N/A, the current time will be used. |
| filters | Filter.Config | | | configuration for filter |
| disabled_balanced_update | bool | | | A flag to disable balanced update (split remove -&gt; insert operation) during update operation. |

- Filter.Target

Expand Down Expand Up @@ -1175,11 +1180,12 @@ service Filter {

- Update.Config

| field | type | label | required | desc. |
| :---------------------: | :------------ | :---- | :------: | :--------------------------------------------------------------------------------------------------- |
| skip_strict_exist_check | bool | | | check the same vector is already upserted or not.<br>the ID should be unique if the value is `true`. |
| timestamp | int64 | | | the timestamp of the vector upserted.<br>if it is N/A, the current time will be used. |
| filters | Filter.Config | | | configuration for filter |
| field | type | label | required | desc. |
| :----------------------: | :------------ | :---- | :------: | :--------------------------------------------------------------------------------------------------- |
| skip_strict_exist_check | bool | | | check the same vector is already upserted or not.<br>the ID should be unique if the value is `true`. |
| timestamp | int64 | | | the timestamp of the vector upserted.<br>if it is N/A, the current time will be used. |
| filters | Filter.Config | | | configuration for filter |
| disabled_balanced_update | bool | | | A flag to disable balanced update (split remove -&gt; insert operation) during update operation. |

- Filter.Target

Expand Down
33 changes: 18 additions & 15 deletions docs/api/update.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,11 +53,12 @@ Update RPC is the method to update a single vector.

- Update.Config

| field | type | label | required | desc. |
| :---------------------: | :------------ | :---- | :------: | :--------------------------------------------------------------------------------------------------- |
| skip_strict_exist_check | bool | | | check the same vector is already inserted or not.<br>the ID should be unique if the value is `true`. |
| timestamp | int64 | | | the timestamp of the vector updated.<br>if it is N/A, the current time will be used. |
| filters | Filter.Config | | | configuration for filter |
| field | type | label | required | desc. |
| :----------------------: | :------------ | :---- | :------: | :--------------------------------------------------------------------------------------------------- |
| skip_strict_exist_check | bool | | | check the same vector is already inserted or not.<br>the ID should be unique if the value is `true`. |
| timestamp | int64 | | | the timestamp of the vector updated.<br>if it is N/A, the current time will be used. |
| filters | Filter.Config | | | configuration for filter |
| disabled_balanced_update | bool | | | A flag to disable balanced update (split remove -&gt; insert operation) during update operation. |

- Object.Vector

Expand Down Expand Up @@ -141,11 +142,12 @@ It's the recommended method to update the large amount of vectors.

- Update.Config

| field | type | label | required | desc. |
| :---------------------: | :------------ | :---- | :------: | :--------------------------------------------------------------------------------------------------- |
| skip_strict_exist_check | bool | | | check the same vector is already inserted or not.<br>the ID should be unique if the value is `true`. |
| timestamp | int64 | | | the timestamp of the vector updated.<br>if it is N/A, the current time will be used. |
| filters | Filter.Config | | | configuration for filter |
| field | type | label | required | desc. |
| :----------------------: | :------------ | :---- | :------: | :--------------------------------------------------------------------------------------------------- |
| skip_strict_exist_check | bool | | | check the same vector is already inserted or not.<br>the ID should be unique if the value is `true`. |
| timestamp | int64 | | | the timestamp of the vector updated.<br>if it is N/A, the current time will be used. |
| filters | Filter.Config | | | configuration for filter |
| disabled_balanced_update | bool | | | A flag to disable balanced update (split remove -&gt; insert operation) during update operation. |

- Object.Vector

Expand Down Expand Up @@ -262,11 +264,12 @@ Please be careful that the size of the request exceed the limit.

- Update.Config

| field | type | label | required | desc. |
| :---------------------: | :------------ | :---- | :------: | :--------------------------------------------------------------------------------------------------- |
| skip_strict_exist_check | bool | | | check the same vector is already inserted or not.<br>the ID should be unique if the value is `true`. |
| timestamp | int64 | | | the timestamp of the vector updated.<br>if it is N/A, the current time will be used. |
| filters | Filter.Config | | | configuration for filter |
| field | type | label | required | desc. |
| :----------------------: | :------------ | :---- | :------: | :--------------------------------------------------------------------------------------------------- |
| skip_strict_exist_check | bool | | | check the same vector is already inserted or not.<br>the ID should be unique if the value is `true`. |
| timestamp | int64 | | | the timestamp of the vector updated.<br>if it is N/A, the current time will be used. |
| filters | Filter.Config | | | configuration for filter |
| disabled_balanced_update | bool | | | A flag to disable balanced update (split remove -&gt; insert operation) during update operation. |

- Object.Vector

Expand Down
Loading