Skip to content

Commit

Permalink
style: format code with Gofumpt and Prettier
Browse files Browse the repository at this point in the history 
This commit fixes the style issues introduced in df4d79e according to the output
from Gofumpt and Prettier.

Details: #2741
  • Loading branch information
@deepsource-autofix
deepsource-autofix[bot] authored Dec 2, 2024
1 parent df4d79e commit 32fb34c
Show file tree
Hide file tree
Showing 10 changed files with 1,442 additions and 1,402 deletions.
752 changes: 383 additions & 369 deletions apis/docs/v1/filter.md
View file

Large diffs are not rendered by default.

14 changes: 7 additions & 7 deletions apis/docs/v1/flush.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ Flush RPC is the method to remove all vectors.
- Flush.Request
empty
### Output
- the scheme of `payload.v1.Info.Index.Count`
Expand All @@ -46,12 +47,12 @@ Flush RPC is the method to remove all vectors.

- Info.Index.Count

| field | type | label | description |
| :---: | :--- | :---- | :---------- |
| stored | uint32 | | The stored index count. |
| uncommitted | uint32 | | The uncommitted index count. |
| indexing | bool | | The indexing index count. |
| saving | bool | | The saving index count. |
| field | type | label | description |
| :---------: | :----- | :---- | :--------------------------- |
| stored | uint32 | | The stored index count. |
| uncommitted | uint32 | | The uncommitted index count. |
| indexing | bool | | The indexing index count. |
| saving | bool | | The saving index count. |

### Status Code

Expand All @@ -65,4 +66,3 @@ Flush RPC is the method to remove all vectors.
| 13 | INTERNAL |

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

286 changes: 145 additions & 141 deletions apis/docs/v1/index.md
View file

Large diffs are not rendered by default.

188 changes: 95 additions & 93 deletions apis/docs/v1/insert.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,39 +53,40 @@ Inset RPC is the method to add a new single vector.
- Insert.Request
| field | type | label | description |
| :---: | :--- | :---- | :---------- |
| vector | Object.Vector | | The vector to be inserted. |
| config | Insert.Config | | The configuration of the insert request. |
| field | type | label | description |
| :----: | :------------ | :---- | :--------------------------------------- |
| vector | Object.Vector | | The vector to be inserted. |
| config | Insert.Config | | The configuration of the insert request. |
- Object.Vector
| field | type | label | description |
| :---: | :--- | :---- | :---------- |
| id | string | | The vector ID. |
| vector | float | repeated | The vector. |
| timestamp | int64 | | timestamp represents when this vector inserted. |
| field | type | label | description |
| :-------: | :----- | :------- | :---------------------------------------------- |
| id | string | | The vector ID. |
| vector | float | repeated | The vector. |
| timestamp | int64 | | timestamp represents when this vector inserted. |
- Insert.Config
| field | type | label | description |
| :---: | :--- | :---- | :---------- |
| skip_strict_exist_check | bool | | A flag to skip exist check during insert operation. |
| filters | Filter.Config | | Filter configurations. |
| timestamp | int64 | | Insert timestamp. |
| field | type | label | description |
| :---------------------: | :------------ | :---- | :-------------------------------------------------- |
| skip_strict_exist_check | bool | | A flag to skip exist check during insert operation. |
| filters | Filter.Config | | Filter configurations. |
| timestamp | int64 | | Insert timestamp. |
- Filter.Config
| field | type | label | description |
| :---: | :--- | :---- | :---------- |
| field | type | label | description |
| :-----: | :------------ | :------- | :----------------------------------------- |
| targets | Filter.Target | repeated | Represent the filter target configuration. |
- Filter.Target
| field | type | label | description |
| :---: | :--- | :---- | :---------- |
| host | string | | The target hostname. |
| port | uint32 | | The target port. |
| field | type | label | description |
| :---: | :----- | :---- | :------------------- |
| host | string | | The target hostname. |
| port | uint32 | | The target port. |
### Output
- the scheme of `payload.v1.Object.Location`
Expand All @@ -101,26 +102,25 @@ Inset RPC is the method to add a new single vector.

- Object.Location

| field | type | label | description |
| :---: | :--- | :---- | :---------- |
| name | string | | The name of the location. |
| uuid | string | | The UUID of the vector. |
| ips | string | repeated | The IP list. |
| field | type | label | description |
| :---: | :----- | :------- | :------------------------ |
| name | string | | The name of the location. |
| uuid | string | | The UUID of the vector. |
| ips | string | repeated | The IP list. |

### Status Code

| code | description |
| :--: | :---------------- |
| 0 | OK |
| 1 | CANCELLED |
| 3 | INVALID_ARGUMENT |
| 4 | DEADLINE_EXCEEDED |
| 5 | NOT_FOUND |
| 13 | INTERNAL |
| 0 | OK |
| 1 | CANCELLED |
| 3 | INVALID_ARGUMENT |
| 4 | DEADLINE_EXCEEDED |
| 5 | NOT_FOUND |
| 13 | INTERNAL |

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


### Troubleshooting

The request process may not be completed when the response code is NOT `0 (OK)`.
Expand All @@ -134,6 +134,7 @@ Here are some common reasons and how to resolve each error.
| DEADLINE_EXCEEDED | The RPC timeout setting is too short on the client/server side. | Check the gRPC timeout setting on both the client and server sides and fix it if needed. |
| ALREADY_EXISTS | Request ID is already inserted. | Change request ID. |
| INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. |

## StreamInsert RPC

StreamInsert RPC is the method to add new multiple vectors using the [bidirectional streaming RPC](https://grpc.io/docs/what-is-grpc/core-concepts/#bidirectional-streaming-rpc).<br>
Expand Down Expand Up @@ -176,39 +177,40 @@ It's the recommended method to insert a large number of vectors.
- Insert.Request
| field | type | label | description |
| :---: | :--- | :---- | :---------- |
| vector | Object.Vector | | The vector to be inserted. |
| config | Insert.Config | | The configuration of the insert request. |
| field | type | label | description |
| :----: | :------------ | :---- | :--------------------------------------- |
| vector | Object.Vector | | The vector to be inserted. |
| config | Insert.Config | | The configuration of the insert request. |
- Object.Vector
| field | type | label | description |
| :---: | :--- | :---- | :---------- |
| id | string | | The vector ID. |
| vector | float | repeated | The vector. |
| timestamp | int64 | | timestamp represents when this vector inserted. |
| field | type | label | description |
| :-------: | :----- | :------- | :---------------------------------------------- |
| id | string | | The vector ID. |
| vector | float | repeated | The vector. |
| timestamp | int64 | | timestamp represents when this vector inserted. |
- Insert.Config
| field | type | label | description |
| :---: | :--- | :---- | :---------- |
| skip_strict_exist_check | bool | | A flag to skip exist check during insert operation. |
| filters | Filter.Config | | Filter configurations. |
| timestamp | int64 | | Insert timestamp. |
| field | type | label | description |
| :---------------------: | :------------ | :---- | :-------------------------------------------------- |
| skip_strict_exist_check | bool | | A flag to skip exist check during insert operation. |
| filters | Filter.Config | | Filter configurations. |
| timestamp | int64 | | Insert timestamp. |
- Filter.Config
| field | type | label | description |
| :---: | :--- | :---- | :---------- |
| field | type | label | description |
| :-----: | :------------ | :------- | :----------------------------------------- |
| targets | Filter.Target | repeated | Represent the filter target configuration. |
- Filter.Target
| field | type | label | description |
| :---: | :--- | :---- | :---------- |
| host | string | | The target hostname. |
| port | uint32 | | The target port. |
| field | type | label | description |
| :---: | :----- | :---- | :------------------- |
| host | string | | The target hostname. |
| port | uint32 | | The target port. |
### Output
- the scheme of `payload.v1.Object.StreamLocation`
Expand All @@ -229,18 +231,18 @@ It's the recommended method to insert a large number of vectors.

- Object.StreamLocation

| field | type | label | description |
| :---: | :--- | :---- | :---------- |
| location | Object.Location | | The vector location. |
| status | google.rpc.Status | | The RPC error status. |
| field | type | label | description |
| :------: | :---------------- | :---- | :-------------------- |
| location | Object.Location | | The vector location. |
| status | google.rpc.Status | | The RPC error status. |

- Object.Location

| field | type | label | description |
| :---: | :--- | :---- | :---------- |
| name | string | | The name of the location. |
| uuid | string | | The UUID of the vector. |
| ips | string | repeated | The IP list. |
| field | type | label | description |
| :---: | :----- | :------- | :------------------------ |
| name | string | | The name of the location. |
| uuid | string | | The UUID of the vector. |
| ips | string | repeated | The IP list. |

### Status Code

Expand All @@ -256,7 +258,6 @@ It's the recommended method to insert a large number of vectors.

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


### Troubleshooting

The request process may not be completed when the response code is NOT `0 (OK)`.
Expand All @@ -270,6 +271,7 @@ Here are some common reasons and how to resolve each error.
| DEADLINE_EXCEEDED | The RPC timeout setting is too short on the client/server side. | Check the gRPC timeout setting on both the client and server sides and fix it if needed. |
| ALREADY_EXISTS | Request ID is already inserted. | Change request ID. |
| INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second. |

## MultiInsert RPC

MultiInsert RPC is the method to add multiple new vectors in **1** request.
Expand Down Expand Up @@ -318,45 +320,46 @@ Please be careful that the size of the request exceeds the limit.
- Insert.MultiRequest
| field | type | label | description |
| :---: | :--- | :---- | :---------- |
| field | type | label | description |
| :------: | :------------- | :------- | :----------------------------------------- |
| requests | Insert.Request | repeated | Represent multiple insert request content. |
- Insert.Request
| field | type | label | description |
| :---: | :--- | :---- | :---------- |
| vector | Object.Vector | | The vector to be inserted. |
| config | Insert.Config | | The configuration of the insert request. |
| field | type | label | description |
| :----: | :------------ | :---- | :--------------------------------------- |
| vector | Object.Vector | | The vector to be inserted. |
| config | Insert.Config | | The configuration of the insert request. |
- Object.Vector
| field | type | label | description |
| :---: | :--- | :---- | :---------- |
| id | string | | The vector ID. |
| vector | float | repeated | The vector. |
| timestamp | int64 | | timestamp represents when this vector inserted. |
| field | type | label | description |
| :-------: | :----- | :------- | :---------------------------------------------- |
| id | string | | The vector ID. |
| vector | float | repeated | The vector. |
| timestamp | int64 | | timestamp represents when this vector inserted. |
- Insert.Config
| field | type | label | description |
| :---: | :--- | :---- | :---------- |
| skip_strict_exist_check | bool | | A flag to skip exist check during insert operation. |
| filters | Filter.Config | | Filter configurations. |
| timestamp | int64 | | Insert timestamp. |
| field | type | label | description |
| :---------------------: | :------------ | :---- | :-------------------------------------------------- |
| skip_strict_exist_check | bool | | A flag to skip exist check during insert operation. |
| filters | Filter.Config | | Filter configurations. |
| timestamp | int64 | | Insert timestamp. |
- Filter.Config
| field | type | label | description |
| :---: | :--- | :---- | :---------- |
| field | type | label | description |
| :-----: | :------------ | :------- | :----------------------------------------- |
| targets | Filter.Target | repeated | Represent the filter target configuration. |
- Filter.Target
| field | type | label | description |
| :---: | :--- | :---- | :---------- |
| host | string | | The target hostname. |
| port | uint32 | | The target port. |
| field | type | label | description |
| :---: | :----- | :---- | :------------------- |
| host | string | | The target hostname. |
| port | uint32 | | The target port. |
### Output
- the scheme of `payload.v1.Object.Locations`
Expand All @@ -376,17 +379,17 @@ Please be careful that the size of the request exceeds the limit.

- Object.Locations

| field | type | label | description |
| :---: | :--- | :---- | :---------- |
| locations | Object.Location | repeated | |
| field | type | label | description |
| :-------: | :-------------- | :------- | :---------- |
| locations | Object.Location | repeated | |

- Object.Location

| field | type | label | description |
| :---: | :--- | :---- | :---------- |
| name | string | | The name of the location. |
| uuid | string | | The UUID of the vector. |
| ips | string | repeated | The IP list. |
| field | type | label | description |
| :---: | :----- | :------- | :------------------------ |
| name | string | | The name of the location. |
| uuid | string | | The UUID of the vector. |
| ips | string | repeated | The IP list. |

### Status Code

Expand All @@ -402,7 +405,6 @@ Please be careful that the size of the request exceeds the limit.

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


### Troubleshooting

The request process may not be completed when the response code is NOT `0 (OK)`.
Expand Down
26 changes: 13 additions & 13 deletions apis/docs/v1/mirror.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,16 +34,17 @@ Register RPC is the method to register other Vald Mirror Gateway targets.
- Mirror.Targets
| field | type | label | description |
| :---: | :--- | :---- | :---------- |
| field | type | label | description |
| :-----: | :------------ | :------- | :------------------------------- |
| targets | Mirror.Target | repeated | The multiple target information. |
- Mirror.Target
| field | type | label | description |
| :---: | :--- | :---- | :---------- |
| host | string | | The target hostname. |
| port | uint32 | | The target port. |
| field | type | label | description |
| :---: | :----- | :---- | :------------------- |
| host | string | | The target hostname. |
| port | uint32 | | The target port. |
### Output
- the scheme of `payload.v1.Mirror.Targets`
Expand All @@ -62,16 +63,16 @@ Register RPC is the method to register other Vald Mirror Gateway targets.

- Mirror.Targets

| field | type | label | description |
| :---: | :--- | :---- | :---------- |
| field | type | label | description |
| :-----: | :------------ | :------- | :------------------------------- |
| targets | Mirror.Target | repeated | The multiple target information. |

- Mirror.Target

| field | type | label | description |
| :---: | :--- | :---- | :---------- |
| host | string | | The target hostname. |
| port | uint32 | | The target port. |
| field | type | label | description |
| :---: | :----- | :---- | :------------------- |
| host | string | | The target hostname. |
| port | uint32 | | The target port. |

### Status Code

Expand All @@ -84,4 +85,3 @@ Register RPC is the method to register other Vald Mirror Gateway targets.
| 13 | INTERNAL |

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

Loading

0 comments on commit 32fb34c

Please sign in to comment.