Skip to content

Commit

Permalink
feat: KVS API template for storing vector metadata (#2624)
Browse files Browse the repository at this point in the history
  • Loading branch information
kpango authored Sep 13, 2024
1 parent c4aa677 commit 1c45978
Show file tree
Hide file tree
Showing 21 changed files with 3,452 additions and 1,209 deletions.
51 changes: 51 additions & 0 deletions apis/docs/v1/docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,10 @@
- [Insert.MultiRequest](#payload-v1-Insert-MultiRequest)
- [Insert.ObjectRequest](#payload-v1-Insert-ObjectRequest)
- [Insert.Request](#payload-v1-Insert-Request)
- [Meta](#payload-v1-Meta)
- [Meta.Key](#payload-v1-Meta-Key)
- [Meta.KeyValue](#payload-v1-Meta-KeyValue)
- [Meta.Value](#payload-v1-Meta-Value)
- [Mirror](#payload-v1-Mirror)
- [Mirror.Target](#payload-v1-Mirror-Target)
- [Mirror.Targets](#payload-v1-Mirror-Targets)
Expand Down Expand Up @@ -116,6 +120,8 @@
- [Filter](#filter-egress-v1-Filter)
- [v1/filter/ingress/ingress_filter.proto](#v1_filter_ingress_ingress_filter-proto)
- [Filter](#filter-ingress-v1-Filter)
- [v1/meta/meta.proto](#v1_meta_meta-proto)
- [Meta](#meta-v1-Meta)
- [v1/mirror/mirror.proto](#v1_mirror_mirror-proto)
- [Mirror](#mirror-v1-Mirror)
- [v1/rpc/errdetails/error_details.proto](#v1_rpc_errdetails_error_details-proto)
Expand Down Expand Up @@ -652,6 +658,35 @@ Represent the insert request.
| vector | [Object.Vector](#payload-v1-Object-Vector) | | The vector to be inserted. |
| config | [Insert.Config](#payload-v1-Insert-Config) | | The configuration of the insert request. |

<a name="payload-v1-Meta"></a>

### Meta

<a name="payload-v1-Meta-Key"></a>

### Meta.Key

| Field | Type | Label | Description |
| ----- | ----------------- | ----- | ----------- |
| key | [string](#string) | | |

<a name="payload-v1-Meta-KeyValue"></a>

### Meta.KeyValue

| Field | Type | Label | Description |
| ----- | ------------------------------------ | ----- | ----------- |
| key | [Meta.Key](#payload-v1-Meta-Key) | | |
| value | [Meta.Value](#payload-v1-Meta-Value) | | |

<a name="payload-v1-Meta-Value"></a>

### Meta.Value

| Field | Type | Label | Description |
| ----- | ------------------------------------------- | ----- | ----------- |
| value | [google.protobuf.Any](#google-protobuf-Any) | | |

<a name="payload-v1-Mirror"></a>

### Mirror
Expand Down Expand Up @@ -1308,6 +1343,22 @@ Represent the ingress filter service.
| GenVector | [.payload.v1.Object.Blob](#payload-v1-Object-Blob) | [.payload.v1.Object.Vector](#payload-v1-Object-Vector) | Represent the RPC to generate the vector. |
| FilterVector | [.payload.v1.Object.Vector](#payload-v1-Object-Vector) | [.payload.v1.Object.Vector](#payload-v1-Object-Vector) | Represent the RPC to filter the vector. |

<a name="v1_meta_meta-proto"></a>

<p align="right"><a href="#top">Top</a></p>

## v1/meta/meta.proto

<a name="meta-v1-Meta"></a>

### Meta

| Method Name | Request Type | Response Type | Description |
| ----------- | ------------------------------------------------------ | ------------------------------------------------ | ----------- |
| Get | [.payload.v1.Meta.Key](#payload-v1-Meta-Key) | [.payload.v1.Meta.Value](#payload-v1-Meta-Value) | |
| Set | [.payload.v1.Meta.KeyValue](#payload-v1-Meta-KeyValue) | [.payload.v1.Empty](#payload-v1-Empty) | |
| Delete | [.payload.v1.Meta.Key](#payload-v1-Meta-Key) | [.payload.v1.Empty](#payload-v1-Empty) | |

<a name="v1_mirror_mirror-proto"></a>

<p align="right"><a href="#top">Top</a></p>
Expand Down
2 changes: 1 addition & 1 deletion apis/grpc/v1/agent/sidecar/sidecar_vtproto.pb.go
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ const _ = grpc.SupportPackageIsVersion7
// SidecarClient is the client API for Sidecar service.
//
// For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
type SidecarClient any
type SidecarClient interface{}

type sidecarClient struct {
cc grpc.ClientConnInterface
Expand Down
115 changes: 115 additions & 0 deletions apis/grpc/v1/meta/meta.pb.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 1c45978

Please sign in to comment.