| Name | Type | Description |
|---|---|---|
run_id* | Union[UUID, str] | The ID of the run to update. |
name | Optional[str] | Default: NoneThe name of the run. |
run_type | Optional[str] | Default: None |
start_time | Optional[datetime.datetime] | Default: None |
end_time | Optional[datetime.datetime] | Default: None |
error | Optional[str] | Default: None |
inputs | Optional[Dict] | Default: None |
outputs | Optional[Dict] | Default: None |
events | Optional[Sequence[dict]] | Default: None |
extra | Optional[Dict] | Default: None |
tags | Optional[List[str]] | Default: None |
attachments | Optional[Dict[str, Attachment]] | Default: None |
reference_example_id | Optional[Union[str, uuid.UUID]] | Default: None |
api_key | Optional[str] | Default: None |
api_url | Optional[str] | Default: None |
service_key | Optional[str] | Default: None |
tenant_id | Optional[str] | Default: None |
authorization | Optional[str] | Default: None |
cookie | Optional[str] | Default: None |
**kwargs | Any | Default: {} |
Update a run in the LangSmith API.
Sampling keys on the run's trace: pass trace_id or dotted_order when
updating a child run, or its own ID is hashed and may disagree.
The type of the run (e.g., llm, chain, tool).
The start time of the run.
The end time of the run.
The error message of the run.
The input values for the run.
The output values for the run.
The events for the run.
The extra information for the run.
The tags for the run.
A dictionary of attachments to add to the run. The keys are the attachment names, and the values are Attachment objects containing the data and mime type.
ID of the example that was the source of the run inputs. Used for runs that were part of an experiment.
The API key to use for this specific run.
The API URL to use for this specific run.
The service JWT key for service-to-service auth.
The tenant ID for multi-tenant requests.
The Authorization header value.
The Cookie header value.
Ignored, except address.
address is in beta. It sends the patch to an address,
and must match the post it belongs to: an update that
names none is resolved by run id, as every update was
before. It may change without notice.
