PaloAltoNetworks / PaloAltoNetworks/pan.dev

Prisma AIRS Scan API has new schema update for prompt_detection_details

Open
#1,102 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
MDX
Stars
78
Forks
88
Avg merge
5d 17h
Merged PRs (30d)
18

Description

Documentation link

The current documentation for Prisma AIRS is missing the most recent update, which includes a new key-value pair that captures prompt detection details

Describe the problem

We simply need to update the API schema here to reflect this new functionality within the response payload

Suggested fix

Support for this example structure:

{
    "action": "block",
    "category": "malicious",
    "error": false,
    "errors": [],
    "profile_id": "59e0f670-7901-4ed7-aa38-1507788cb6cf",
    "profile_name": "AI-Firewall-High-Security-Profile",
    "prompt_detected": {
        "agent": true,
        "dlp": false,
        "injection": true,
        "malicious_code": false,
        "topic_violation": false,
        "toxic_content": true,
        "url_cats": false
    },
    "prompt_detection_details": {
        "toxic_content_details": {
            "toxic_categories": [
                "Indiscriminate Weapons",
                "Violent Crimes"
            ]
        }
    },
    "report_id": "Redd0e3c9-e7b3-4827-a200-c2eb8b618ddb",
    "response_detected": {},
    "scan_id": "edd0e3c9-e7b3-4827-a200-c2eb8b618ddb",
    "session_id": "pan_be2fad45-6907-48bc-b616-d68cd8f8e556",
    "source": "AI-Runtime-API",
    "timeout": false,
    "tool_detected": {},
    "tr_id": "pan_be2fad45-6907-48bc-b616-d68cd8f8e556"
}

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Locate the Prisma AIRS API response schema and its documentation examples in the repository, then compare them with the supplied response structure. Update the schema to include prompt_detection_details and confirm the documented response accepts the nested toxic_content_details and toxic_categories fields.

Written by the indexing model from the issue text.

Assessment

Domain
api, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.