Basic Concepts of VYSP.AI Security API

Understanding the core components of the VYSP.AI API is crucial for effectively using and integrating it into your systems. Here are the key components:

Gates

Gates are predefined entry points for data. They define how data is received and dictate which flow the data will enter for processing. Each Gate has an API Key that is used within the client libraries to associate your requests with the correct flow.

tl;dr Gates are AI application firewalls that secure your models and your end users from malicious or otherwise high-risk content, fully configurable by you.

Flows

Each Gate contains 2 Flows, 1 for input to your application/model, and 1 for output from your application/model. Using both Flows is essential in keeping operational and security risk minimal. Flows are defined sequences that data follows once it enters a gate. Each Flow consists of several Rules that are applied to the data sequentially.

tl;dr Each Gate has an input Flow and an output Flow, and you can use them to apply ML models on input and output data from your AI application.

Rules

Rules are ML filters and detectors applied to input and/or output within a flow. Depending on whether it is an output flow or an input flow, you have access to a different set of rules. There are currently 25 different types of Rules available for use on VYSP.AI.

tl;dr Rules are ML models applied to input and output from your application, to check for harmful/risky content.

Knowledge Databases

Knowledge Databases are repositories of documents used during Gate checks to validate and cross-reference information. They play a crucial role in enhancing the accuracy and reliability of requests through the Fact Check Rule type. You can create multiple Knowledge Databases, and upload PDF or TXT documents to them as you see fit. We are working on allowing customized vectorization settings.

tl:dr Knowledge Databases allow you to make sure your model is returning correct data. You can upload domain-specific PDF documents or TXT documents.