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

Parameters

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

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[Literal["SUCCESS", "ERROR"]]

(default: "SUCCESS")

"SUCCESS"

"ERROR"

type: Optional[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", "INPUT_GUARDRAIL", "OUTPUT_GUARDRAIL", "CODE_EXECUTION", "DATA_MANIPULATION", "EVALUATION", "FILE_RETRIEVAL", "KB_ADD_CHUNK", "KB_MANAGEMENT", "TRACER", "AGENT_TRACER", "AGENT_WORKFLOW", "STANDALONE"]]

(default: "STANDALONE")

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

"INPUT_GUARDRAIL"

"OUTPUT_GUARDRAIL"

"CODE_EXECUTION"

"DATA_MANIPULATION"

"EVALUATION"

"FILE_RETRIEVAL"

"KB_ADD_CHUNK"

"KB_MANAGEMENT"

"TRACER"

"AGENT_TRACER"

"AGENT_WORKFLOW"

"STANDALONE"

Returns

Span

Request example

import os
from datetime import datetime
from scale_gp_beta import SGPClient

client = SGPClient(
    api_key=os.environ.get("SGP_API_KEY"),  # This is the default and can be omitted
)
span = client.spans.create(
    name="name",
    start_timestamp=datetime.fromisoformat("2019-12-27T18:11:19.117"),
    trace_id="trace_id",
)
print(span.id)

200Example

{
  "id": "id",
  "account_id": "account_id",
  "created_by_user_id": "created_by_user_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",
  "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.retrieve() ->

Span

get/v5/spans/{span_id}

Get Span

client.spans.update(, ) ->

Span

patch/v5/spans/{span_id}

Update Span

Domain types

class Span: ...