Skip to main content
POST
/
v1
/
intent
/
evaluate
Evaluate an agent tool call
curl --request POST \
  --url https://gateway.inviolet.ai/v1/intent/evaluate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "tool_call": {
    "name": "lookup_customer",
    "arguments": {}
  },
  "user_id": "<string>",
  "session_id": "<string>",
  "conversation_id": "<string>",
  "data_source_id": "<string>",
  "shadow_mode": false
}
'
{
  "intent_label": "customer_support_lookup",
  "intent_event_id": "<string>",
  "confidence": 0.5,
  "data_elements": [
    "<string>"
  ],
  "shadow_mode": true,
  "processing_time_ms": 123,
  "approval_request_id": "<string>"
}

Authorizations

​
Authorization
string
header
required

API key minted at /developer/api-keys. Three scopes: read_only, policy_write, admin.

Body

application/json
​
tool_call
object
required
​
user_id
string

Optional — attributes the evaluation to a user.

​
session_id
string
​
conversation_id
string
​
data_source_id
string
​
shadow_mode
boolean
default:false

Response

Evaluation result.

​
outcome
enum<string>
required
Available options:
allowed,
denied,
pending_approval,
approved,
shadow_denied
​
intent_label
string
required
Example:

"customer_support_lookup"

​
intent_event_id
string
​
intent_class
enum<string>
Available options:
reporting,
export,
admin,
lookup,
analysis,
write,
other
​
confidence
number
Required range: 0 <= x <= 1
​
data_elements
string[]
​
shadow_mode
boolean
​
processing_time_ms
integer
​
approval_request_id
string | null