Skip to content

README.md

Latest commit

 

History

History
399 lines (261 loc) · 23.5 KB

README.md

File metadata and controls

399 lines (261 loc) · 23.5 KB
Raw

Traces

Overview

Available Operations

aggregate

Aggregate trace metrics using the structured trace filter contract.

Example Usage

from orq_ai_sdk import Orq
import os


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

    res = orq.traces.aggregate()

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
from_ date ➖ N/A
to date ➖ N/A
filters List[models.TraceFilter] ➖ N/A
group_by List[str] ➖ N/A
compute List[models.TraceCompute] ➖ N/A
limit Optional[int] ➖ N/A
filter_operator Optional[str] ➖ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.AggregateTracesResponse

Errors

Error Type Status Code Content Type
models.APIDefaultError 4XX, 5XX */*

list_facets

List trace fields that support facet value discovery.

Example Usage

from orq_ai_sdk import Orq
import os


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

    res = orq.traces.list_facets()

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.ListTraceFacetsResponse

Errors

Error Type Status Code Content Type
models.APIDefaultError 4XX, 5XX */*

list_facet_values

List values and counts for one trace facet field.

Example Usage

from orq_ai_sdk import Orq
import os


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

    res = orq.traces.list_facet_values(field="<value>")

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
field str ✔️ N/A
from_ date ➖ N/A
to date ➖ N/A
limit Optional[int] ➖ N/A
filter_operator Optional[str] ➖ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.ListTraceFacetValuesResponse

Errors

Error Type Status Code Content Type
models.APIDefaultError 4XX, 5XX */*

list_fields

List currently supported static trace fields.

Example Usage

from orq_ai_sdk import Orq
import os


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

    res = orq.traces.list_fields()

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.ListTraceFieldsResponse

Errors

Error Type Status Code Content Type
models.APIDefaultError 4XX, 5XX */*

query

Run an OQL trace query. OQL is validated against the trace field registry and compiled through the trace planner.

Example Usage

from orq_ai_sdk import Orq
from orq_ai_sdk.utils import parse_datetime
import os


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

    res = orq.traces.query(from_=parse_datetime("2025-02-10T08:55:05.233Z"), to=parse_datetime("2024-12-12T15:00:42.128Z"), oql="<value>")

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
from_ date ✔️ N/A
to date ✔️ N/A
oql str ✔️ N/A
limit Optional[int] ➖ N/A
page_token Optional[str] ➖ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.QueryTracesResponse

Errors

Error Type Status Code Content Type
models.APIDefaultError 4XX, 5XX */*

search

Search trace summaries using the structured trace filter contract.

Example Usage

from orq_ai_sdk import Orq
from orq_ai_sdk.utils import parse_datetime
import os


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

    res = orq.traces.search(from_=parse_datetime("2025-05-02T22:00:26.030Z"), to=parse_datetime("2025-09-17T16:33:38.335Z"))

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
from_ date ✔️ N/A
to date ✔️ N/A
filters List[models.TraceFilter] ➖ N/A
filter_operator Optional[str] ➖ N/A
query Optional[str] ➖ N/A
sort List[models.TraceSort] ➖ N/A
limit Optional[int] ➖ N/A
page_token Optional[str] ➖ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.SearchTracesResponse

Errors

Error Type Status Code Content Type
models.APIDefaultError 4XX, 5XX */*

get

Retrieve one trace summary by trace id.

Example Usage

from orq_ai_sdk import Orq
import os


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

    res = orq.traces.get(trace_id="<id>")

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
trace_id str ✔️ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.GetTraceResponse

Errors

Error Type Status Code Content Type
models.APIDefaultError 4XX, 5XX */*

list_spans

List canonical span summaries for a trace.

Example Usage

from orq_ai_sdk import Orq
import os


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

    res = orq.traces.list_spans(trace_id="<id>")

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
trace_id str ✔️ N/A
limit Optional[int] ➖ N/A
page_token Optional[str] ➖ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.ListTraceSpansResponse

Errors

Error Type Status Code Content Type
models.APIDefaultError 4XX, 5XX */*

get_span

Retrieve one hydrated span.

Example Usage

from orq_ai_sdk import Orq
import os


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

    res = orq.traces.get_span(trace_id="<id>", span_id="<id>")

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
trace_id str ✔️ N/A
span_id str ✔️ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.GetTraceSpanResponse

Errors

Error Type Status Code Content Type
models.APIDefaultError 4XX, 5XX */*