config_example.yaml

rules:




  input:
    - name: "language_detection"
      type: "language_detection"
      enabled: true
      order_number: 1
      config:
        url: "https://api-inference.huggingface.co/models/papluca/xlm-roberta-base-language-detection"
        apikey: ""
      action:
        type: "block" # blocking and logging
    - name: "pii_example"
      type: "pii_filter"
      enabled: true
      order_number: 2
      config:
        model_name: "value1"
        model_url: "value2"
        model_type: ""
        plugin_name: "pii"
        piiservice:
          Debug: false
          Port: 8080
          PIIMethod: LLM
          RuleBased:
            PIIEntities:
              - PERSON
              - EMAIL_ADDRESS
              - PHONE_NUMBER
              - CREDIT_CARD
              - US_SSN
              - GENERIC_PII
          NLPEngineName: transformers
          Models:
            - LangCode: en
              ModelName:
                spacy: en_core_web_sm
                transformers: dslim/bert-base-NER
          NERModelConfig:
            ModelToPresidioEntityMapping:
              loc: LOCATION
              location: LOCATION
              org: ORGANIZATION
              organization: ORGANIZATION
              per: PERSON
              person: PERSON
              phone: PHONE_NUMBER
      action:
        type: "block" # blocking and logging
    #      - type: "mask" # masking and logging
    #      - type: "monitoring" # logging

    - name: "prompt_injection_example"
      type: "prompt_injection"
      plugin_name: "prompt_injection_llm"
      threshold: 0.85
      enabled: true
      order_number: 3
      config:
        plugin_name: "prompt_injection_llm"
        threshold: 0.85
      action:
        type: "block"
  #      - type: "monitoring" # logging
    - name: "llamaguard_check"
      type: "llama_guard"
      enabled: true
      order_number: 4
      config:
        plugin_name: "llama_guard"
        threshold: 0.5
        relation: ">"
        # can be left empty, in that case every categgory is included.
        #categories: ["S1","S7"]

      action:
        type: "block"

    - name: "PromptGuard Injection Detection"
      type: "prompt_guard"
      enabled: true
      order_number: 5
      config:
        plugin_name: "prompt_guard"
        threshold: 0.7
        relation: ">"
        temperature: 3.0
      action:
        type: "block"
  output:
    - name: "pii_example"
      type: "pii_filter"
      config:
        model_name: "value1"
        model_url: "value2"
        model_type: ""
      action:
        type: "block"
providers:
  huggingface:
    enabled: false
  openai:
    enabled: false
settings:
  audit_logging:
    enabled: false
  cache:
    enabled: true
    ttl: 3600
    prefix: openshield
  context_cache:
    enabled: true
  database:
    auto_migration: true
    uri: postgresql://
  network:
    port: 10
  rate_limiting:
    enabled: true
    max: 100
    window: 60
  redis:
    ssl: true
    uri: rediss://
  rule_server:
    url: http://localhost:8000
  usage_logging:
    enabled: false