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
PythonlangsmithclientClientget_insights_report
Method●Since v0.7

get_insights_report

Fetch an Insights report by ID or from a prior report object.

Copy
get_insights_report(
  self,
  *,
  id: str | uuid.UUID | None = None,
  report: ls_schemas.InsightsReport | None = None,
  project_id: str | uuid.UUID | None = None,
  include_runs: bool = True
) -> ls_schemas.InsightsReportResult

Parameters

NameTypeDescription
idstr | uuid.UUID | None
Default:None

The Insights report ID (aka clustering job ID). Provide with project_id if report is not provided.

reportls_schemas.InsightsReport | None
Default:None

An InsightsReport object returned by generate_insights or poll_insights. If provided, id and project_id must be omitted.

project_idstr | uuid.UUID | None
Default:None

The tracing project (session) ID associated with the report. Required if report is not provided.

include_runsbool
Default:True

Whether to include all runs for the report.

View source on GitHub