Class●Since v0.0

trace

Manage a LangSmith run in context.

This class can be used as both a synchronous and asynchronous context manager.

trace(
  self,
  name: str,
  run_type: ls_client.RUN_TYPE_T = 'chain',
  *,
  inputs: Optional[dict] = None,
  extra: Optional[dict] = None,
  project_name: Optional[str] = None,
  parent: Optional[Union[run_trees.RunTree, str, Mapping, Literal['ignore']]] = None,
  tags: Optional[list[str]] = None,
  metadata: Optional[Mapping[str, Any]] = None,
  client: Optional[ls_client.Client] = None,
  run_id: Optional[ls_client.ID_TYPE] = None,
  reference_example_id: Optional[ls_client.ID_TYPE] = None,
  exceptions_to_handle: Optional[tuple[type[BaseException], ...]] = None,
  attachments: Optional[schemas.Attachments] = None,
  **kwargs: Any = {}
)

Parameters

Name	Type	Description
`name`*	`str`	Name of the run.
`run_type`	`ls_client.RUN_TYPE_T`	Default:`'chain'` Type of run (e.g., `'chain'`, `'llm'`, `'tool'`).
`inputs`	`Optional[dict]`	Default:`None` Initial input data for the run.
`project_name`	`Optional[str]`	Default:`None` Project name to associate the run with.
`parent`	`Optional[Union[run_trees.RunTree, str, Mapping, Literal['ignore']]]`	Default:`None` Parent run. Can be a `RunTree`, dotted order string, or tracing headers.
`tags`	`Optional[list[str]]`	Default:`None` List of tags for the run.
`metadata`	`Optional[Mapping[str, Any]]`	Default:`None` Additional metadata for the run.
`client`	`Optional[ls_client.Client]`	Default:`None` LangSmith client for custom settings.
`run_id`	`Optional[ls_client.ID_TYPE]`	Default:`None` Preset identifier for the run.
`reference_example_id`	`Optional[ls_client.ID_TYPE]`	Default:`None` Associates run with a dataset example. Only for root runs in evaluation.
`exceptions_to_handle`	`Optional[tuple[type[BaseException], ...]]`	Default:`None` Exception types to ignore.
`extra`	`Optional[dict]`	Default:`None` Extra data to send to LangSmith. Use 'metadata' instead.

Constructors

constructor

__init__

Name	Type
name	str
run_type	ls_client.RUN_TYPE_T
inputs	Optional[dict]
extra	Optional[dict]
project_name	Optional[str]
parent	Optional[Union[run_trees.RunTree, str, Mapping, Literal['ignore']]]
tags	Optional[list[str]]
metadata	Optional[Mapping[str, Any]]
client	Optional[ls_client.Client]
run_id	Optional[ls_client.ID_TYPE]
reference_example_id	Optional[ls_client.ID_TYPE]
exceptions_to_handle	Optional[tuple[type[BaseException], ...]]
attachments	Optional[schemas.Attachments]