From 132ab1de11d9eb9e99df0ae0fc0a1ff89684c9a4 Mon Sep 17 00:00:00 2001 From: Junsei Ando Date: Tue, 14 Mar 2023 11:14:29 +0900 Subject: [PATCH] fix documentaion typo disable_balanced_update --- docs/api/filter-gateway.md | 72 +++++++++++++++++++------------------- docs/api/update.md | 36 +++++++++---------- docs/api/upsert.md | 36 +++++++++---------- 3 files changed, 72 insertions(+), 72 deletions(-) diff --git a/docs/api/filter-gateway.md b/docs/api/filter-gateway.md index af6b82c44b..7e645a7da3 100644 --- a/docs/api/filter-gateway.md +++ b/docs/api/filter-gateway.md @@ -485,12 +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.
the ID should be unique if the value is `true`. | - | timestamp | int64 | | | the timestamp of the vector updated.
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 -> insert operation) during update operation. | + | field | type | label | required | desc. | + | :---------------------: | :------------ | :---- | :------: | :-------------------------------------------------------------------------------------------------- | + | skip_strict_exist_check | bool | | | check the same vector is already updated or not.
the ID should be unique if the value is `true`. | + | timestamp | int64 | | | the timestamp of the vector updated.
if it is N/A, the current time will be used. | + | filters | Filter.Config | | | configuration for filter | + | disable_balanced_update | bool | | | A flag to disable balanced update (split remove -> insert operation) during update operation. | - Filter.Target @@ -607,12 +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.
the ID should be unique if the value is `true`. | - | timestamp | int64 | | | the timestamp of the vector updated.
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 -> insert operation) during update operation. | + | field | type | label | required | desc. | + | :---------------------: | :------------ | :---- | :------: | :-------------------------------------------------------------------------------------------------- | + | skip_strict_exist_check | bool | | | check the same vector is already updated or not.
the ID should be unique if the value is `true`. | + | timestamp | int64 | | | the timestamp of the vector updated.
if it is N/A, the current time will be used. | + | filters | Filter.Config | | | configuration for filter | + | disable_balanced_update | bool | | | A flag to disable balanced update (split remove -> insert operation) during update operation. | - Filter.Target @@ -768,12 +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.
the ID should be unique if the value is `true`. | - | timestamp | int64 | | | the timestamp of the vector updated.
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 -> insert operation) during update operation. | + | field | type | label | required | desc. | + | :---------------------: | :------------ | :---- | :------: | :-------------------------------------------------------------------------------------------------- | + | skip_strict_exist_check | bool | | | check the same vector is already updated or not.
the ID should be unique if the value is `true`. | + | timestamp | int64 | | | the timestamp of the vector updated.
if it is N/A, the current time will be used. | + | filters | Filter.Config | | | configuration for filter | + | disable_balanced_update | bool | | | A flag to disable balanced update (split remove -> insert operation) during update operation. | - Filter.Target @@ -900,12 +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.
the ID should be unique if the value is `true`. | - | timestamp | int64 | | | the timestamp of the vector upserted.
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 -> insert operation) during update operation. | + | field | type | label | required | desc. | + | :---------------------: | :------------ | :---- | :------: | :--------------------------------------------------------------------------------------------------- | + | skip_strict_exist_check | bool | | | check the same vector is already upserted or not.
the ID should be unique if the value is `true`. | + | timestamp | int64 | | | the timestamp of the vector upserted.
if it is N/A, the current time will be used. | + | filters | Filter.Config | | | configuration for filter | + | disable_balanced_update | bool | | | A flag to disable balanced update (split remove -> insert operation) during update operation. | - Filter.Target @@ -1019,12 +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.
the ID should be unique if the value is `true`. | - | timestamp | int64 | | | the timestamp of the vector upserted.
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 -> insert operation) during update operation. | + | field | type | label | required | desc. | + | :---------------------: | :------------ | :---- | :------: | :--------------------------------------------------------------------------------------------------- | + | skip_strict_exist_check | bool | | | check the same vector is already upserted or not.
the ID should be unique if the value is `true`. | + | timestamp | int64 | | | the timestamp of the vector upserted.
if it is N/A, the current time will be used. | + | filters | Filter.Config | | | configuration for filter | + | disable_balanced_update | bool | | | A flag to disable balanced update (split remove -> insert operation) during update operation. | - Filter.Target @@ -1180,12 +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.
the ID should be unique if the value is `true`. | - | timestamp | int64 | | | the timestamp of the vector upserted.
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 -> insert operation) during update operation. | + | field | type | label | required | desc. | + | :---------------------: | :------------ | :---- | :------: | :--------------------------------------------------------------------------------------------------- | + | skip_strict_exist_check | bool | | | check the same vector is already upserted or not.
the ID should be unique if the value is `true`. | + | timestamp | int64 | | | the timestamp of the vector upserted.
if it is N/A, the current time will be used. | + | filters | Filter.Config | | | configuration for filter | + | disable_balanced_update | bool | | | A flag to disable balanced update (split remove -> insert operation) during update operation. | - Filter.Target diff --git a/docs/api/update.md b/docs/api/update.md index 6ea21393b0..1c3d2c06e5 100644 --- a/docs/api/update.md +++ b/docs/api/update.md @@ -53,12 +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.
the ID should be unique if the value is `true`. | - | timestamp | int64 | | | the timestamp of the vector updated.
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 -> insert operation) during update operation. | + | field | type | label | required | desc. | + | :---------------------: | :------------ | :---- | :------: | :--------------------------------------------------------------------------------------------------- | + | skip_strict_exist_check | bool | | | check the same vector is already inserted or not.
the ID should be unique if the value is `true`. | + | timestamp | int64 | | | the timestamp of the vector updated.
if it is N/A, the current time will be used. | + | filters | Filter.Config | | | configuration for filter | + | disable_balanced_update | bool | | | A flag to disable balanced update (split remove -> insert operation) during update operation. | - Object.Vector @@ -142,12 +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.
the ID should be unique if the value is `true`. | - | timestamp | int64 | | | the timestamp of the vector updated.
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 -> insert operation) during update operation. | + | field | type | label | required | desc. | + | :---------------------: | :------------ | :---- | :------: | :--------------------------------------------------------------------------------------------------- | + | skip_strict_exist_check | bool | | | check the same vector is already inserted or not.
the ID should be unique if the value is `true`. | + | timestamp | int64 | | | the timestamp of the vector updated.
if it is N/A, the current time will be used. | + | filters | Filter.Config | | | configuration for filter | + | disable_balanced_update | bool | | | A flag to disable balanced update (split remove -> insert operation) during update operation. | - Object.Vector @@ -264,12 +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.
the ID should be unique if the value is `true`. | - | timestamp | int64 | | | the timestamp of the vector updated.
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 -> insert operation) during update operation. | + | field | type | label | required | desc. | + | :---------------------: | :------------ | :---- | :------: | :--------------------------------------------------------------------------------------------------- | + | skip_strict_exist_check | bool | | | check the same vector is already inserted or not.
the ID should be unique if the value is `true`. | + | timestamp | int64 | | | the timestamp of the vector updated.
if it is N/A, the current time will be used. | + | filters | Filter.Config | | | configuration for filter | + | disable_balanced_update | bool | | | A flag to disable balanced update (split remove -> insert operation) during update operation. | - Object.Vector diff --git a/docs/api/upsert.md b/docs/api/upsert.md index c3f7e7eb75..b4bdc77373 100644 --- a/docs/api/upsert.md +++ b/docs/api/upsert.md @@ -57,12 +57,12 @@ Upsert RPC is the method to update a single vector and add a new single vector. - Upsert.Config - | field | type | label | required | desc. | - | :----------------------: | :------------ | :---- | :------: | :--------------------------------------------------------------------------------------------------- | - | skip_strict_exist_check | bool | | | check the same vector is already inserted or not.
the ID should be unique if the value is `true`. | - | timestamp | int64 | | | the timestamp of the vector updated/inserted.
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 -> insert operation) during update operation. | + | field | type | label | required | desc. | + | :---------------------: | :------------ | :---- | :------: | :--------------------------------------------------------------------------------------------------- | + | skip_strict_exist_check | bool | | | check the same vector is already inserted or not.
the ID should be unique if the value is `true`. | + | timestamp | int64 | | | the timestamp of the vector updated/inserted.
if it is N/A, the current time will be used. | + | filters | Filter.Config | | | configuration for filter | + | disable_balanced_update | bool | | | A flag to disable balanced update (split remove -> insert operation) during update operation. | - Object.Vector @@ -145,12 +145,12 @@ It’s the recommended method to upsert a large number of vectors. - Upsert.Config - | field | type | label | required | desc. | - | :----------------------: | :------------ | :---- | :------: | :--------------------------------------------------------------------------------------------------- | - | skip_strict_exist_check | bool | | | check the same vector is already inserted or not.
the ID should be unique if the value is `true`. | - | timestamp | int64 | | | the timestamp of the vector updated/inserted.
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 -> insert operation) during update operation. | + | field | type | label | required | desc. | + | :---------------------: | :------------ | :---- | :------: | :--------------------------------------------------------------------------------------------------- | + | skip_strict_exist_check | bool | | | check the same vector is already inserted or not.
the ID should be unique if the value is `true`. | + | timestamp | int64 | | | the timestamp of the vector updated/inserted.
if it is N/A, the current time will be used. | + | filters | Filter.Config | | | configuration for filter | + | disable_balanced_update | bool | | | A flag to disable balanced update (split remove -> insert operation) during update operation. | - Object.Vector @@ -266,12 +266,12 @@ Please be careful that the size of the request exceeds the limit. - Upsert.Config - | field | type | label | required | desc. | - | :----------------------: | :------------ | :---- | :------: | :----------------------------------------------------------------------------------------------------------- | - | skip_strict_exist_check | bool | | | check the same vector is already updated/inserted or not.
the ID should be unique if the value is `true`. | - | timestamp | int64 | | | the timestamp of the vector updated/inserted.
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 -> insert operation) during update operation. | + | field | type | label | required | desc. | + | :---------------------: | :------------ | :---- | :------: | :----------------------------------------------------------------------------------------------------------- | + | skip_strict_exist_check | bool | | | check the same vector is already updated/inserted or not.
the ID should be unique if the value is `true`. | + | timestamp | int64 | | | the timestamp of the vector updated/inserted.
if it is N/A, the current time will be used. | + | filters | Filter.Config | | | configuration for filter | + | disable_balanced_update | bool | | | A flag to disable balanced update (split remove -> insert operation) during update operation. | - Object.Vector