ReferencePython SDK ReferenceNemoguardrailsLibraryPrivateai

nemoguardrails.library.privateai.request

View as Markdown

Module for handling Private AI detection requests.

Module Contents

Functions

NameDescription
private_ai_requestSend a PII detection request to the Private AI API.

Data

log

API

nemoguardrails.library.privateai.request.private_ai_request(
    text: str,
    enabled_entities: typing.List[str],
    server_endpoint: str,
    api_key: typing.Optional[str] = None
)
async

Send a PII detection request to the Private AI API.

Parameters:

text
str

The text to analyze.

enabled_entities
List[str]

List of entity types to detect.

server_endpoint
str

The API endpoint URL.

api_key
Optional[str]Defaults to None

The API key for the Private AI service.

Returns:

The response from the Private AI API. See Private AI API reference for more details:

Raises:

  • ValueError: If api_key is missing for cloud API, if the API call fails, or if the response cannot be parsed as JSON.
nemoguardrails.library.privateai.request.log = logging.getLogger(__name__)