Invoke a Guardrail - Orq.ai Documentation

POST

evaluators

{id}

invoke

Invoke a Custom Evaluator

curl --request POST \
  --url https://api.orq.ai/v2/evaluators/{id}/invoke \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>",
  "output": "<string>",
  "reference": "<string>",
  "retrievals": [
    "<string>"
  ],
  "messages": [
    {
      "content": "<string>",
      "tool_calls": [
        {
          "type": "function",
          "function": {
            "name": "<string>",
            "arguments": "<string>"
          },
          "id": "<string>",
          "index": 123
        }
      ],
      "tool_call_id": "<string>"
    }
  ],
  "model": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    query: '<string>',
    output: '<string>',
    reference: '<string>',
    retrievals: ['<string>'],
    messages: [
      {
        content: '<string>',
        tool_calls: [
          {
            type: 'function',
            function: {name: '<string>', arguments: '<string>'},
            id: '<string>',
            index: 123
          }
        ],
        tool_call_id: '<string>'
      }
    ],
    model: '<string>'
  })
};

fetch('https://api.orq.ai/v2/evaluators/{id}/invoke', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.orq.ai/v2/evaluators/{id}/invoke"

payload = {
    "query": "<string>",
    "output": "<string>",
    "reference": "<string>",
    "retrievals": ["<string>"],
    "messages": [
        {
            "content": "<string>",
            "tool_calls": [
                {
                    "type": "function",
                    "function": {
                        "name": "<string>",
                        "arguments": "<string>"
                    },
                    "id": "<string>",
                    "index": 123
                }
            ],
            "tool_call_id": "<string>"
        }
    ],
    "model": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "type": "string",
  "original_value": "<string>",
  "value": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string

required

Evaluator ID

Body

application/json

query

string

Latest user message

output

string

The generated response from the model

reference

string

The reference used to compare the output

retrievals

string[]

Knowledge base retrievals

messages

object[]

The messages used to generate the output, without the last user message

Show child attributes

model

string

Model to use for LLM-based evaluators (e.g. "openai/gpt-4o")

Response

Returns the result of the evaluator run

type

enum<string>

required

Available options:

string

original_value

string | null

value

string | null

Update a Guardrail

List Guardrail versions

⌘I

Invoke a Custom Evaluator

curl --request POST \
  --url https://api.orq.ai/v2/evaluators/{id}/invoke \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>",
  "output": "<string>",
  "reference": "<string>",
  "retrievals": [
    "<string>"
  ],
  "messages": [
    {
      "content": "<string>",
      "tool_calls": [
        {
          "type": "function",
          "function": {
            "name": "<string>",
            "arguments": "<string>"
          },
          "id": "<string>",
          "index": 123
        }
      ],
      "tool_call_id": "<string>"
    }
  ],
  "model": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    query: '<string>',
    output: '<string>',
    reference: '<string>',
    retrievals: ['<string>'],
    messages: [
      {
        content: '<string>',
        tool_calls: [
          {
            type: 'function',
            function: {name: '<string>', arguments: '<string>'},
            id: '<string>',
            index: 123
          }
        ],
        tool_call_id: '<string>'
      }
    ],
    model: '<string>'
  })
};

fetch('https://api.orq.ai/v2/evaluators/{id}/invoke', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.orq.ai/v2/evaluators/{id}/invoke"

payload = {
    "query": "<string>",
    "output": "<string>",
    "reference": "<string>",
    "retrievals": ["<string>"],
    "messages": [
        {
            "content": "<string>",
            "tool_calls": [
                {
                    "type": "function",
                    "function": {
                        "name": "<string>",
                        "arguments": "<string>"
                    },
                    "id": "<string>",
                    "index": 123
                }
            ],
            "tool_call_id": "<string>"
        }
    ],
    "model": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "type": "string",
  "original_value": "<string>",
  "value": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}