Documentation | Spans

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

client.spans.update(, ) ->

Span

patch/v5/spans/{span_id}

Update Span

Parameters

span_id: str

end_timestamp: Optional[Union[str, datetime]]

(format: date-time)

metadata: Optional[Dict[str,

object

]]

name: Optional[str]

output: Optional[Dict[str,

object

]]

status: Optional[

SpanStatus

]

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

from scale_gp_beta import SGPClient

client = SGPClient(
    api_key="My API Key",
)
span = client.spans.update(
    span_id="span_id",
)
print(span.id)

200Example

{
  "id": "id",
  "account_id": "account_id",
  "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",
  "created_by": {
    "id": "id",
    "type": "user",
    "object": "identity"
  },
  "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"
}

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