Skip to main content

Interface: LangSmithPluginOptions

langsmith.LangSmithPluginOptions

Options for LangSmithPlugin.

Secrets (the LangSmith API key) are never accepted here as plaintext and never cross a Temporal boundary — supply a pre-constructed Client (which reads LANGSMITH_API_KEY from the worker/client process env) or let the plugin construct a default client from the environment.

Plugins is an experimental feature; APIs may change without notice.

Properties​

addTemporalRuns​

• Optional addTemporalRuns: boolean

When true, emit first-class runs for Temporal operations themselves (StartWorkflow:, RunActivity:, HandleSignal:, …) in addition to the user's traceable runs. When false (default), only the user's traceable runs are emitted — trace context still propagates across boundaries so they nest correctly.

client​

• Optional client: Client

The LangSmith client runs are emitted to. Defaults to new Client(), which reads LANGSMITH_API_KEY / LANGSMITH_ENDPOINT from the process environment. Lives only in the worker/client process — never serialized.

metadata​

• Optional metadata: Record<string, unknown>

Metadata merged into every run the plugin emits (credential keys scrubbed).

projectName​

• Optional projectName: string

Target LangSmith project for every emitted run.

tags​

• Optional tags: string[]

Tags attached to every run the plugin emits.