TraceData¶

class opik.api_objects.trace.TraceData(id: str = <factory>, name: str | None = None, start_time: ~datetime.datetime | None = <factory>, end_time: ~datetime.datetime | None = None, metadata: ~typing.Dict[str, ~typing.Any] | None = None, input: ~typing.Dict[str, ~typing.Any] | None = None, output: ~typing.Dict[str, ~typing.Any] | None = None, tags: ~typing.List[str] | None = None, feedback_scores: ~typing.List[~opik.types.FeedbackScoreDict] | None = None, project_name: str | None = None, created_by: ~typing.Literal['evaluation'] | None = None, error_info: ~opik.types.ErrorInfoDict | None = None, thread_id: str | None = None, attachments: ~typing.List[~opik.api_objects.attachment.attachment.Attachment] | None = None)¶

Bases: object

The TraceData object is returned when calling opik.opik_context.get_current_trace_data() from a tracked function.

id: str¶

name: str | None = None¶

start_time: datetime | None¶

end_time: datetime | None = None¶

metadata: Dict[str, Any] | None = None¶

input: Dict[str, Any] | None = None¶

output: Dict[str, Any] | None = None¶

tags: List[str] | None = None¶

feedback_scores: List[FeedbackScoreDict] | None = None¶

project_name: str | None = None¶

created_by: Literal['evaluation'] | None = None¶

error_info: ErrorInfoDict | None = None¶

thread_id: str | None = None¶

attachments: List[Attachment] | None = None¶

create_child_span_data(name: str | None = None, type: Literal['general', 'tool', 'llm', 'guardrail'] = 'general', start_time: datetime | None = None, end_time: datetime | None = None, metadata: Dict[str, Any] | None = None, input: Dict[str, Any] | None = None, output: Dict[str, Any] | None = None, tags: List[str] | None = None, usage: Dict[str, Any] | OpikUsage | None = None, feedback_scores: List[FeedbackScoreDict] | None = None, model: str | None = None, provider: LLMProvider | str | None = None, error_info: ErrorInfoDict | None = None, total_cost: float | None = None, attachments: List[Attachment] | None = None) → SpanData¶

update(**new_data: Any) → TraceData¶

init_end_time() → TraceData¶

property as_start_parameters: Dict[str, Any]¶: Returns parameters of this trace to be sent to the server when starting a new trace.

property as_parameters: Dict[str, Any]¶: Returns all parameters of this trace to be sent to the server.