⚠️Prompt

Prompt validations validate the input / output data and give users details about the violations according to user passed rules.

YAML Specifications

Currently there are two sections in validation suits specifications through YAML those are :

format-rules

format-rules contain rules that checks validation related to the formatting of input/output. One example could be we can validate if the given json contains all the expected keys or not.

1. To use format rules we need to define format-rules section in our YAML file.

2. After adding format-rules section we need to add the rule i.e, key-validate rule. ( key-validate rule is for validating if all the keys expected in data are present or not)

rules.yaml

format-rules:
    - key-validate : [username, id, email ]

validation-rules

validation-rules section contains different rules to validate the data against constraints provided in rules. For a simple example rule could be like validating the length of data or checking percentage of sentiment, complexity of the text.

• datatype - in datatype rule parameter we can validate our input for certain datatype. Expected set of values (’string’, ‘integer’, ‘boolean’, ‘float’)

Important: first rule must be for datatype in rules yaml file.

// validation rule for username key
 - validation-rules:
    - username:
        - datatype : string

• len-validate - If we want to validate length of the input, We can use this field to validate the length of input / output.

  • len-validate has four attributes

    • gt - greater than value

    • lt - less than value

    • gte - greater than equal to value

    • lte - less than equal to

rules.yaml

 - validation-rules:
    - username:
        - datatype : string
        - len-validate: {"gt":0,"lt":10}

• choice-validate - Validating the input/output is from the expected set of values. In choice validate we can pass set of values as list those are acceptable.

rules.yaml

 - validation-rules:
    - username:
        - datatype : string
        - len-validate: {"gt":0,"lt":10}
    - role:
        - datatype: syamtring
        - choice-validate: [admin, staff]

• range-validate - Validating an integer of an float value is between certain limit.

  • range-validate has four attributes same as len-validate ‘gt’, ‘lt’, ‘gte’, and ‘lte’.

rules.yaml

 - validation-rules:
    - username:
        - datatype : string
        - len-validate: {"gt":0,"lt":10}
    - role:
        - datatype: string
        - choice-validate: [admin, staff]
    - age:
        - datatype: integer
        - range-validate: {gt:0, lt: 50}

• text-complexity-validate - Validating the text complexity of text phrases.

rules.yaml

 - validation-rules:
    - username:
        - datatype : string
        - len-validate: {"gt":0,"lt":10}
    - role:
        - datatype: string
        - choice-validate: [admin, staff]
    - age:
        - datatype: integer
        - range-validate: {gt:0, lt: 50}
    - security-phrase:
        - datatype: string
        - text-complexity-validate : {lt: 0.9}

• sentiment-polarity-validate - For validating sentiment polarity range of an input/output “sentiment-polarity-validate” key can be used.

rules.yaml

 - validation-rules:
    - username:
        - datatype : string
        - len-validate: {"gt":0,"lt":10}
    - role:
        - datatype: string
        - choice-validate: [admin, staff]
    - age:
        - datatype: integer
        - range-validate: {gt:0, lt: 50}
    - quote:
        - datatype: string
        - sentiment-polarity-validate : {gt:0, lt: 0.9}

• profanity-validate -for validating the profanity in phrase we can use this validation option.The value is returned in percentage so the values of range should be in consideration of 1 to 100 percentage.

rules.yaml

 - validation-rules:
    - username:
        - datatype : string
        - len-validate: {"gt":0,"lt":10}
    - role:
        - datatype: string
        - choice-validate: [admin, staff]
    - age:
        - datatype: integer
        - range-validate: {gt:0, lt: 50}
    - caption:
        - datatype: string
        - profanity-validate : {lt: 10}

How to Use

• Validation methods can be used for both input and output validations. Its as simple as inheriting a library and passing your data.

Input / Output Validation

Python

#import the library method for InputValidation
#and output validation
>>> from censius.validation.prompt import InputValidator, OutputValidator

>>> ip_obj = InputValidator('rules.yaml') #pass your yamlfile path
>>> Data loaded from 'rules.yaml' successfully.
>>> user_data = {"username":"rahuljain", "password":"rah","disease":"headache"}
>>> ip_obj.validate(user_data)

Total Violations found
{
    "key-validate": [],
    "username": [],
    "password": [
        "input value range less than rule violated"
    ],
    "disease": []
}

op_obj = OutputValidator('rules.yaml') #pass your yamlfile path
op_obj = validate(api_data)