Documentation

Spans

SpansResource

Methods

create() ->
Span
post/v5/spans

Create Span

retrieve() ->
Span
get/v5/spans/{span_id}

Get Span

update(, ) ->
Span
patch/v5/spans/{span_id}

Update Span

batch() ->
SpanBatchResponse
post/v5/spans/batch

Create Spans in Batch

upsert_batch() ->
SpanUpsertBatchResponse
put/v5/spans/batch

Upsert Spans in Batch

search() -> SyncCursorPage[
Span
]
post/v5/spans/search

Search and list spans

Parameters
ending_before: Optional[str]
from_ts: Optional[Union[str, datetime]]
(format: date-time)

The starting (oldest) timestamp in ISO format.

limit: Optional[int]
(maximum: 1000, minimum: 1, default: 100)
sort_order: Optional[Literal["asc", "desc"]]
(default: "asc")
"asc"
"desc"
starting_after: Optional[str]
to_ts: Optional[Union[str, datetime]]
(format: date-time)

The ending (most recent) timestamp in ISO format.

application_variant_ids: Optional[
SequenceNotStr
[str]]

Filter by application variant IDs

assessment_types: Optional[
SequenceNotStr
[str]]

Filter spans by traces that have assessments of these types

excluded_span_ids: Optional[
SequenceNotStr
[str]]

List of span IDs to exclude from results

excluded_trace_ids: Optional[
SequenceNotStr
[str]]

List of trace IDs to exclude from results

extra_metadata: Optional[Dict[str,
object
]]

Filter on custom metadata key-value pairs

group_id: Optional[str]

Filter by group ID

max_duration_ms: Optional[int]

Maximum span duration in milliseconds (inclusive)

min_duration_ms: Optional[int]

Minimum span duration in milliseconds (inclusive)

names: Optional[
SequenceNotStr
[str]]

Filter by trace/span name

parents_only: Optional[
bool
]

Only fetch spans that are the top-level (ie. have no parent_id)

search_texts: Optional[
SequenceNotStr
[str]]

Free text search across span input and output fields

span_ids: Optional[
SequenceNotStr
[str]]

Filter by span IDs

statuses: Optional[List[
SpanStatus
]]

Filter on span status

"SUCCESS"
"ERROR"
"CANCELED"
trace_ids: Optional[
SequenceNotStr
[str]]

Filter by trace IDs

types: Optional[List[
SpanType
]]
"TEXT_INPUT"
"TEXT_OUTPUT"
"COMPLETION_INPUT"
"COMPLETION"
"KB_RETRIEVAL"
"KB_INPUT"
"RERANKING"
"EXTERNAL_ENDPOINT"
"PROMPT_ENGINEERING"
"DOCUMENT_INPUT"
"MAP_REDUCE"
"DOCUMENT_SEARCH"
"DOCUMENT_PROMPT"
"CUSTOM"
"CODE_EXECUTION"
"DATA_MANIPULATION"
"EVALUATION"
"FILE_RETRIEVAL"
"KB_ADD_CHUNK"
"KB_MANAGEMENT"
"GUARDRAIL"
"TRACER"
"AGENT_TRACER"
"AGENT_WORKFLOW"
"STANDALONE"
Returns
Span
id: str
account_id: str
name: str
start_timestamp:
datetime
(format: date-time)
trace_id: str
(maxLength: 38)

id for grouping traces together, uuid is recommended

application_interaction_id: Optional[str]

The interaction ID this span belongs to

application_variant_id: Optional[str]

The id of the application variant this span belongs to

created_by: Optional[Identity]

The identity that created the entity.

end_timestamp: Optional[datetime]
(format: date-time)
group_id: Optional[str]

Reference to a group_id

input: Optional[Dict[str,
object
]]
metadata: Optional[Dict[str,
object
]]
object: Optional[Literal["span"]]
(default: "span")
output: Optional[Dict[str,
object
]]
parent_id: Optional[str]

Reference to a parent span_id

status: Optional[SpanStatus]
type: Optional[SpanType]
Request example
200Example

Domain types

class Span: ...
SpanStatus = Literal["SUCCESS", "ERROR", "CANCELED"]
SpanType = Literal["TEXT_INPUT", "TEXT_OUTPUT", "COMPLETION_INPUT", "COMPLETION", "KB_RETRIEVAL", "KB_INPUT", "RERANKING", "EXTERNAL_ENDPOINT", "PROMPT_ENGINEERING", "DOCUMENT_INPUT", "MAP_REDUCE", "DOCUMENT_SEARCH", "DOCUMENT_PROMPT", "CUSTOM", "CODE_EXECUTION", "DATA_MANIPULATION", "EVALUATION", "FILE_RETRIEVAL", "KB_ADD_CHUNK", "KB_MANAGEMENT", "GUARDRAIL", "TRACER", "AGENT_TRACER", "AGENT_WORKFLOW", "STANDALONE"]