Project: Vald (App Definition and Development / Database)
File: filter-gateway.md

Vald Filter Gateway is the component to communicate user-defined ingress/egress filter components with requests. Vald Filter Gateway is an optional component in the Vald cluster allowing the user to run user-defined custom logic with ingress/egress filter components. The responsibility is to bypass the user request or response between the Vald cluster and the user-defined ingress filter (or egress filter) component. Ingress filtering is the pre-process before the request is processed by the Vald LB Gateway. This is useful, e.g., when you want to vectorize object data (when you want to handle object data directly as the request query) or when you want to pad the vector, etc. Here are the steps of pre-processing with the ingress filter: The user's request flows from the filter gateway to the ingress filter component when using the Ingress filter. Ingress filter performs arbitrary processing for each user and returns the result to the filter gateway. The filter gateway forwards the ingress filter result to the Vald LB Gateway.(The Vald LB Gateway migration process is the same as when the ingress filter is not used. Click for a detailed data flow.) <img src="../../../assets/docs/overview/component/filter-gateway/ingressfilteringblob.svg" alt="example data flow of ingress filtering with blob data" /> <img src="../../../assets/docs/overview/component/filter-gateway/ingressfilteringvector.svg" alt="example data flow of ingress filtering with vector" /> There are two types of ingress filtering methods: generating the vector and the vector filtering. In generating the vector, for example, you can vectorize object data using your favorite model. The filtering vector allows you to filter out vectors that contain outliers so that they are not indexed. Vald officially offers two types of ingress filter components. Of course, you can use your own implemented ingress filter component. When using it, please make sure to meet the following interface. The scheme of ingress filter service ```rpc // https://github.com/vdaas/vald/blob/main/apis/proto/v1/filter/ingress/ingress_filter.proto service Filter { // Represent the RPC to generate the vector. rpc GenVector(payload.v1.Object.Blob) returns (payload.v1.Object.Vector) { option (google.api.http) = { post : "/filter/ingress/object" body : "*" }; } // Represent the RPC to filter the vector. rpc FilterVector(payload.v1.Object.Vector) returns (payload.v1.Object.Vector) { option (google.api.http) = { post : "/filter/ingress/vector" body : "*" }; } } ``` The scheme of `payload.v1.Object.Blob` and `payload.v1.Object.Vector` ```rpc // https://github.com/vdaas/vald/blob/main/apis/proto/v1/payload/payload.proto // Represent the binary object. message Blob { // The object

string id = 1 [ (validate.rules).string.min_len = 1 ]; // The binary object. bytes object = 2; } // Represent a vector. message Vector { // The vector ID. string id = 1 [ (validate.rules).string.min_len = 1 ]; // The vector. repeated float vector = 2 [ (validate.rules).repeated .min_items = 2 ]; } ``` Egress filtering is mainly used as the post-processing for the search result returned from the Vald LB Gateway. Egress filtering returns the search results filtered by the egress filter component to the requesting user. Here are the steps of pre-processing with the egress filter: The filter gateway receives the search results from the Vald LB Gateway and forwards them to the egress filter component. The egress filter component filters the search results and returns the filtered search results to the Filter Gateway. The filter gateway returns the filtered search results to the user. <img src="../../../assets/docs/overview/component/filter-gateway/egress_filtering.svg" alt="search data flow with egress filtering" /> There are two types of egress filtering methods: distance filtering and vector filtering. In distance filtering, for example, you can add a process to exclude vectors that exceed the upper limit of distance from the search results. Vector filtering allows you to add the process: for example, to remove different categories' vectors from the search results. (e.g., excluding kid's T-shirts from the search for adult's T-shirts.) If you want to use this feature, please deploy your own egress filter component, which meets the following interface. The scheme of egress filter service ```rpc // https://github.com/vdaas/vald/blob/main/apis/proto/v1/filter/ingress/egress_filter.proto service Filter { // Represent the RPC to filter the distance. rpc FilterDistance(payload.v1.Object.Distance) returns (payload.v1.Object.Distance) { option (google.api.http) = { post : "/filter/egress/distance" body : "*" }; } // Represent the RPC to filter the vector. rpc FilterVector(payload.v1.Object.Vector) returns (payload.v1.Object.Vector) { option (google.api.http) = { post : "/filter/egress/vector" body : "*" }; } } ``` The scheme of `payload.v1.Object.Distance` and `payload.v1.Object.Vector` ```rpc // https://github.com/vdaas/vald/blob/main/apis/proto/v1/payload/payload.proto // Represent the ID and distance pair. message Distance { // The vector ID. string id = 1; // The distance. float distance = 2; } // Represent a vector. message Vector { // The vector ID. string id = 1 [ (validate.rules).string.min_len = 1 ]; // The vector. repeated float vector = 2 [ (validate.rules).repeated .min_items = 2 ]; } ```