Documentation | Spans

API Reference

Spans

SpansResource

Methods

client.spans.batch() ->

SpanBatchResponse

post/v5/spans/batch

Create Spans in Batch

Parameters

items:

Iterable

[

Item

]

name: str

start_timestamp: Union[str, datetime]

(format: date-time)

trace_id: str

(maxLength: 38)

id for grouping traces together, uuid is recommended

id: Optional[str]

The id of the span

application_interaction_id: Optional[str]

The optional application interaction ID this span belongs to

application_variant_id: Optional[str]

The optional application variant ID this span belongs to

end_timestamp: Optional[Union[str, datetime]]

(format: date-time)

group_id: Optional[str]

Reference to a group_id

input: Optional[Dict[str,

object

]]

metadata: Optional[Dict[str,

object

]]

output: Optional[Dict[str,

object

]]

parent_id: Optional[str]

Reference to a parent span_id

status: Optional[

SpanStatus

]

type: Optional[

SpanType

]

Returns

class SpanBatchResponse:

items: List[

Span

]

object: Optional[Literal["list"]]

(default: "list")

Request example

from datetime import datetime
from scale_gp_beta import SGPClient

client = SGPClient(
    api_key="My API Key",
)
response = client.spans.batch(
    items=[{
        "name": "name",
        "start_timestamp": datetime.fromisoformat("2019-12-27T18:11:19.117"),
        "trace_id": "trace_id",
    }],
)
print(response.items)

200Example

{
  "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"
    }
  ],
  "object": "list"
}

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

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