Annotations SDK Reference - Orq.ai Documentation

Annotations

Create an Annotation

Attach one or more annotations to a specific span. Each annotation references an evaluator by key and supplies a value (string for text/single-select, number for range, array for multi-select).

from orq_ai_sdk import Orq
import os

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

    orq.annotations.create(trace_id="<id>", span_id="<id>", annotations=[])

    # Use the SDK ...

Show Parameters

{
    "trace_id": str,  # required
    "span_id": str,  # required
    "annotations": {  # required
        "key": str,  # required
        "value": Union[str, float, List[str]],  # required
    },
    "metadata": {  # optional
        "identity_id": Optional[str],
    },
}

Delete an Annotation

Remove one or more annotations from a specific span by their evaluator keys.

from orq_ai_sdk import Orq
import os

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

    orq.annotations.delete(trace_id="<id>", span_id="<id>", keys=[
        "<value 1>",
    ])

    # Use the SDK ...

Show Parameters

{
    "trace_id": str,  # required
    "span_id": str,  # required
    "keys": List[str],  # required
}

Responses SDK Reference

API Keys SDK Reference

⌘I

​Annotations

​Create an Annotation

​Delete an Annotation

Annotations

Create an Annotation

Delete an Annotation