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

Chat LangChain

What can I help with?

Enter to send·Shift+Enter new line

Menu

OverviewClientAsyncClientRun HelpersRun TreesEvaluationSchemasUtilitiesWrappersAnonymizerTestingExpect APIMiddlewarePytest PluginDeployment SDK
Language
Theme
Pythonlangsmithtypesai_search_parse_paramsAISearchParseParams
Class●Since v0.15

AISearchParseParams

Copy
AISearchParseParams()

Bases

TypedDict

Constructors

Attributes

View source on GitHub
constructor
__init__
NameType
ai_searchRequired[str]
project_idsRequired[SequenceNotStr[str]]
allow_clarificationbool
scopeLiteral['runs', 'traces', 'threads']
attribute
ai_search: Required[str]

Natural-language description of the runs, traces or threads to find, at most 2000 UTF-8 bytes.

attribute
project_ids: Required[SequenceNotStr[str]]

Tracing project UUIDs used to interpret the search.

Send the same projects to the query API.

attribute
allow_clarification: bool

When true, an ambiguous search returns clarification options instead of a single plan. Defaults to false.

attribute
scope: Literal['runs', 'traces', 'threads']

Query API to plan for: runs, traces or threads.

When omitted, it is inferred from the search and defaults to traces.