LangChain Reference home pageLangChain ReferenceLangChain Reference
  • GitHub
  • Main Docs
Deep Agents
LangChain
LangGraph
Integrations
LangSmith
  • Overview
  • Client
  • AsyncClient
  • Run Helpers
  • Run Trees
  • Evaluation
  • Schemas
  • Utilities
  • Wrappers
  • Anonymizer
  • Testing
  • Expect API
  • Middleware
  • Pytest Plugin
  • Deployment SDK
⌘I

LangChain Assistant

Ask a question to get started

Enter to send•Shift+Enter new line

Menu

OverviewClientAsyncClientRun HelpersRun TreesEvaluationSchemasUtilitiesWrappersAnonymizerTestingExpect APIMiddlewarePytest PluginDeployment SDK
Language
Theme
Pythonlangsmith_openapi_clienttypesrunRun
Class●Since v0.9

Run

Copy
Run()

Bases

BaseModel

Used in Docs

  • How to define a code evaluator
  • How to evaluate a graph
  • How to evaluate an application's intermediate steps
  • How to fetch performance metrics for an experiment

Attributes

Inherited fromBaseModel

Attributes

Amodel_fields_set: set[str]Amodel_config: ConfigDictAmodel_construct: construct

Methods

Mto_dict
—
View source on GitHub

Recursively generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Mto_json
—

Generates a JSON string representing this model as it would be received from or sent to the API (but with indentation).

Mconstruct
Mmodel_dump
—

Usage docs: https://docs.pydantic.dev/2.4/concepts/serialization/#modelmodel_dump

Mmodel_dump_json
—

Usage docs: https://docs.pydantic.dev/2.4/concepts/serialization/#modelmodel_dump_json

Classes

CConfig
attribute
id: Optional[str]
attribute
app_path: Optional[str]
attribute
attachments: Optional[Dict[str, str]]
attribute
completion_cost: Optional[float]
attribute
completion_cost_details: Optional[CompletionCostDetails]
attribute
completion_token_details: Optional[CompletionTokenDetails]
attribute
completion_tokens: Optional[int]
attribute
dotted_order: Optional[str]
attribute
end_time: Optional[datetime]
attribute
error: Optional[str]
attribute
error_preview: Optional[str]
attribute
events: Optional[List[Event]]
attribute
extra: Optional[object]
attribute
feedback_stats: Optional[Dict[str, FeedbackStats]]
attribute
first_token_time: Optional[datetime]
attribute
inputs: Optional[object]
attribute
inputs_preview: Optional[str]
attribute
is_in_dataset: Optional[bool]
attribute
is_root: Optional[bool]
attribute
latency_seconds: Optional[float]
attribute
manifest: Optional[object]
attribute
metadata: Optional[object]
attribute
name: Optional[str]
attribute
outputs: Optional[object]
attribute
outputs_preview: Optional[str]
attribute
parent_run_ids: Optional[List[str]]
attribute
price_model_id: Optional[str]
attribute
project_id: Optional[str]
attribute
prompt_cost: Optional[float]
attribute
prompt_cost_details: Optional[PromptCostDetails]
attribute
prompt_token_details: Optional[PromptTokenDetails]
attribute
prompt_tokens: Optional[int]
attribute
reference_dataset_id: Optional[str]
attribute
reference_example_id: Optional[str]
attribute
run_type: Optional[Literal['TOOL', 'CHAIN', 'LLM', 'RETRIEVER', 'EMBEDDING', 'PROMPT', 'PARSER']]
attribute
share_url: Optional[str]
attribute
start_time: Optional[datetime]
attribute
status: Optional[Literal['SUCCESS', 'ERROR', 'PENDING']]
attribute
tags: Optional[List[str]]
attribute
thread_evaluation_time: Optional[datetime]
attribute
thread_id: Optional[str]
attribute
total_cost: Optional[float]
attribute
total_tokens: Optional[int]
attribute
trace_id: Optional[str]

id is this run's UUID.

app_path identifies the application code location that produced this run, if recorded.

attachments maps each attachment file name to a pre-signed HTTPS download URL.

completion_cost is estimated USD cost for the completion.

completion_cost_details is the per-category USD breakdown of completion_cost.

Categories mirror completion_token_details. Returned only when the COMPLETION_COST_DETAILS field is requested.

completion_token_details is the per-category breakdown of completion_tokens.

Category names are model-specific (for example reasoning, audio). Returned only when the COMPLETION_TOKEN_DETAILS field is requested.

completion_tokens is the completion-side token count.

dotted_order is the hierarchical ordering key for trace trees.

end_time is when the run ended (RFC3339 date-time).

JSON null if the run has not finished yet.

error is the error message when status indicates failure.

error_preview is a truncated plain-text error snippet.

events is the ordered list of run events (for example streaming tokens).

extra is additional runtime JSON attached to the run.

feedback_stats aggregates feedback scores keyed by feedback key.

first_token_time is when the first output token was produced (RFC3339 date-time), when recorded for streamed runs.

inputs is the run input payload (arbitrary JSON object).

inputs_preview is a truncated plain-text preview of inputs.

is_in_dataset is true when this run is linked to a dataset example.

is_root is true when this run has no parent (it is the trace root).

latency_seconds is wall-clock duration from start to end in seconds.

manifest is the serialized configuration of the traced component (for example the model parameters, prompt template, or pipeline definition), when recorded.

metadata is arbitrary user-defined JSON metadata.

name is a human-readable label for the run (for example the model name, function name, or step name chosen when the run was traced).

outputs is the run output payload (arbitrary JSON object).

outputs_preview is a truncated plain-text preview of outputs.

parent_run_ids lists ancestor run UUIDs from the trace root down to the direct parent.

price_model_id identifies the pricing model UUID used for cost estimates, when recorded.

project_id is the tracing project UUID this run was logged to.

prompt_cost is estimated USD cost for the prompt.

prompt_cost_details is the per-category USD breakdown of prompt_cost.

Categories mirror prompt_token_details. Returned only when the PROMPT_COST_DETAILS field is requested.

prompt_token_details is the per-category breakdown of prompt_tokens.

Category names are model-specific (for example cache_read, cache_write). Returned only when the PROMPT_TOKEN_DETAILS field is requested.

prompt_tokens is the prompt-side token count.

reference_dataset_id is the dataset UUID for the reference example, if any.

reference_example_id is the dataset example UUID this run was compared against, if any.

run_type identifies what kind of operation this run represents (for example an LLM call, a tool invocation, or a chain step). See the RunType enum for allowed values.

share_url is the fully-qualified URL of this run's public view, rooted at the deployment's LangSmith app origin (for example https://smith.langchain.com/public/4f7a1b2c-8d9e-4a0b-9c1d-2e3f4a5b6c7d/r). It is returned only when SHARE_URL is included in selects, and only when the run has been explicitly shared; the URL remains stable until the run is unshared. Anyone with this URL can view the run anonymously, so treat it as a secret and do not log it.

start_time is when the run started (RFC3339 date-time).

status is the completion status of the run.

tags lists user-defined tags on this run.

thread_evaluation_time is thread-level evaluation timing (RFC3339 date-time), when recorded.

thread_id is the conversation thread UUID this run belongs to, if any.

total_cost is total estimated USD cost (prompt plus completion).

total_tokens is prompt plus completion tokens.

trace_id is the root trace UUID; for a root run it matches id.