Skip to main content
POST
/
evaluation
/
evaluate
Evaluate a prompt using qualifire's custom detectors
curl --request POST \
  --url https://proxy.qualifire.ai/api/evaluation/evaluate \
  --header 'Content-Type: application/json' \
  --header 'X-Qualifire-API-Key: <api-key>' \
  --data '{
  "assertions": [
    "<string>"
  ],
  "consistency_check": true,
  "dangerous_content_check": true,
  "hallucinations_check": true,
  "harassment_check": true,
  "hate_speech_check": true,
  "input": "<string>",
  "messages": [
    {
      "content": "<string>",
      "role": "<string>"
    }
  ],
  "output": "<string>",
  "pii_check": true,
  "prompt_injections": true,
  "sexual_content_check": true,
  "syntax_checks": {
    "javascript": {
      "args": "<string>"
    },
    "json": {
      "args": "<string>"
    },
    "length": {
      "args": "<string>"
    },
    "sql": {
      "args": "<string>"
    },
    "word count": {
      "args": "<string>"
    }
  }
}'
{
  "evaluationResults": [
    {
      "results": [
        {
          "claim": "<string>",
          "confidence_score": 123,
          "label": "<string>",
          "name": "<string>",
          "quote": "<string>",
          "reason": "<string>",
          "score": 123
        }
      ],
      "type": "<string>"
    }
  ],
  "score": 123,
  "status": "<string>"
}

Authorizations

​
X-Qualifire-API-Key
string
header
required

Body

application/json

Evaluation request

​
assertions
string[]
​
consistency_check
boolean
​
dangerous_content_check
boolean
​
hallucinations_check
boolean
​
harassment_check
boolean
​
hate_speech_check
boolean
​
input
string
​
messages
object[]
​
output
string
​
pii_check
boolean
​
prompt_injections
boolean
​
sexual_content_check
boolean
​
syntax_checks
object

Response

200 - application/json

OK

​
evaluationResults
object[]
​
score
number
​
status
string