Text Detection¶

class ibm_watsonx_ai.foundation_models.moderations.Guardian(api_client, detectors)[source]¶

Bases: WMLResource

Guardian is responsible for text detection using configured detectors.

Parameters:

api_client (APIClient) – The APIClient instance
detectors (dict, GuardianDetectors) – A dict of detector configurations

Example:

from ibm_watsonx_ai import APIClient, Credentials
from ibm_watsonx_ai.foundation_models.moderations import Guardian

credentials = Credentials(
    url = "<url>",
    api_key = IAM_API_KEY
)
api_client = APIClient(credentials)

detectors = {
    "granite_guardian": {"threshold": 0.4}
}

guardian = Guardian(
    api_client=api_client,
    detectors=detectors
)

detect(text, detectors=None)[source]¶

Detects elements in the given text using specified detectors.

Parameters:

text (str) – The input text to analyze
detectors (dict, GuardianDetectors, optional) – A dict of detector configurations

Example:

text = "I would like to say some `Indecent words`."

response = guardian.detect(text=text)