Skip to main content
API7.ai Logo

Parameters​

See plugin common configurations for configuration options available to all plugins.

This plugin supports referencing sensitive parameter values from environment variables using the env:// prefix, or from a secret manager, such as HashiCorp Vault’s KV secrets engine, using the secret:// prefix. For more information, see environment variables in plugin and secrets.

  • comprehend

    object

    required

    AWS Comprehend configurations.

    • access_key_id

      string

      required

      AWS access key ID.

    • secret_access_key

      string

      required

      AWS secret access key. The value is encrypted with AES before being stored in etcd.

    • region

      string

      required

      AWS region.

    • endpoint

      string

      AWS Comprehend service endpoint. If not set, defaults to https://comprehend.{region}.amazonaws.com.

    • ssl_verify

      boolean

      default: true

      If true, enable TLS certificate verification.

  • moderation_categories

    object

    Key-value pairs of moderation category and their corresponding threshold.

    In each pair, the key should be one of the PROFANITY, HATE_SPEECH, INSULT, HARASSMENT_OR_ABUSE, SEXUAL, or VIOLENCE_OR_THREAT; and the threshold value should be between 0 and 1 (inclusive).

  • moderation_threshold

    number

    default: 0.5

    vaild vaule:

    between 0 and 1 inclusive

    Overall toxicity threshold. A higher value means more toxic content allowed.

    This option differs from the individual category thresholds in moderation_categories. For example, if moderation_categories is set with a PROFANITY threshold of 0.5, and a request has a PROFANITY score of 0.1, the request will not exceed the category threshold. However, if the request has other categories like SEXUAL or VIOLENCE_OR_THREAT exceeding the moderation_threshold, the request will be rejected.

  • check_request

    boolean

    default: true

    If true, moderate request content.

    Available in API7 Enterprise 3.9.16+ or 3.10.3+.

  • deny_code

    integer

    default: 200

    vaild vaule:

    between 200 and 599 inclusive

    HTTP status code returned when a request is rejected. Set a 4xx value to expose the rejection as an HTTP error.

    Available in API7 Enterprise 3.9.16+ or 3.10.3+.

  • deny_message

    string

    Message returned when a request is rejected. If unset, the plugin returns the threshold failure reason.

    Available in API7 Enterprise 3.9.16+ or 3.10.3+.

  • fail_mode

    string

    default: skip

    vaild vaule:

    skip, warn, or error

    Behavior when the plugin is bound to a Consumer and receives a request whose format it does not recognize, such as a non-AI request. With skip, the unrecognized request is passed through unchecked. With warn, the request is passed through and a warning is logged. With error, the request is rejected with HTTP 400.

    Available in API7 Enterprise from version 3.9.14.