Documentation | Spans

API Reference

Spans

SpansResource

Methods

client.spans.batch() ->

SpanBatchResponse

post/v5/spans/batch

Create Spans in Batch

client.spans.create() ->

Span

post/v5/spans

Create Span

client.spans.retrieve() ->

Span

get/v5/spans/{span_id}

Get Span

client.spans.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.

excluded_span_ids: Optional[List[str]]

List of span IDs to exclude from results

excluded_trace_ids: Optional[List[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

names: Optional[List[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[List[str]]

Free text search across span input and output fields

span_id: Optional[str]

Deprecated

Filter by span ID (deprecated: use span_ids instead)

span_ids: Optional[List[str]]

Filter by span IDs

statuses: Optional[List[

SpanStatus

]]

Filter on span status

"SUCCESS"

"ERROR"

"CANCELED"

trace_id: Optional[str]

Deprecated

Filter by trace ID (deprecated: use trace_ids instead)

trace_ids: Optional[List[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

Request example

from scale_gp_beta import SGPClient

client = SGPClient(
    api_key="My API Key",
)
page = client.spans.search()
page = page.items[0]
print(page.id)

200Example

{
  "has_more": true,
  "items": [
    {
      "id": "id",
      "account_id": "account_id",
      "created_by": {
        "id": "id",
        "type": "user",
        "object": "identity"
      },
      "name": "name",
      "start_timestamp": "2019-12-27T18:11:19.117Z",
      "trace_id": "trace_id",
      "application_interaction_id": "application_interaction_id",
      "application_variant_id": "application_variant_id",
      "end_timestamp": "2019-12-27T18:11:19.117Z",
      "group_id": "group_id",
      "input": {
        "foo": "bar"
      },
      "metadata": {
        "foo": "bar"
      },
      "object": "span",
      "output": {
        "foo": "bar"
      },
      "parent_id": "parent_id",
      "status": "SUCCESS",
      "type": "TEXT_INPUT"
    }
  ],
  "total": 0,
  "limit": 0,
  "object": "list"
}

client.spans.update(, ) ->

Span

patch/v5/spans/{span_id}

Update Span

client.spans.upsert_batch() ->

SpanUpsertBatchResponse

put/v5/spans/batch

Upsert Spans in Batch

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"]