Skip to main content

Evals

All Evals

Get all Evaluators
from orq_ai_sdk import Orq
import os

with Orq(
    api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:

    res = orq.evals.all(limit=10)

    # Handle response
    print(res)

Create an Eval

Create an Evaluator
from orq_ai_sdk import Orq
import os

with Orq(
    api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:

    res = orq.evals.create(request={
        "output_type": "string",
        "type": "http_eval",
        "url": "https://total-unit.name",
        "method": "GET",
        "headers": {
            "key": "<value>",
            "key1": "<value>",
            "key2": "<value>",
        },
        "payload": {
            "key": "<value>",
        },
        "path": "Default",
        "description": "",
        "key": "<key>",
    })

    # Handle response
    print(res)

Update an Eval

Update an Evaluator
from orq_ai_sdk import Orq
import os

with Orq(
    api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:

    res = orq.evals.update(id="<id>", path="Default")

    # Handle response
    print(res)

Delete an Eval

Delete an Evaluator
from orq_ai_sdk import Orq
import os

with Orq(
    api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:

    orq.evals.delete(id="<id>")

    # Use the SDK ...

Invoke an Eval

Invoke a Custom Evaluator
from orq_ai_sdk import Orq
import os

with Orq(
    api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:

    res = orq.evals.invoke(id="<id>", messages=[
        {
            "role": "tool",
            "content": [],
        },
    ])

    # Handle response
    print(res)

Evaluators Versions

Returns version history for a specific evaluator
from orq_ai_sdk import Orq
import os

with Orq(
    api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:

    res = orq.evals.get_v2_evaluators_id_versions(id="<id>", limit=10)

    # Handle response
    print(res)