cayu.tools.search
Public Cayu API. Definitions are grouped by their public source module, and definitions from private implementation modules appear on their package’s page; adding a symbol does not move existing links. The import shown at each entry is a supported public namespace. Read the Python API overview and install the required extra.
SearchTextTool
Section titled “SearchTextTool”from cayu.tools import SearchTextToolBounded runner-backed workspace text search.
Bases: Tool.
Fields and attributes
Section titled “Fields and attributes”Defaults below are source expressions; Field(...) includes schema/validation settings and default_factory creates a fresh value. Inherited declarations are included. Constructor behavior follows the model or dataclass shown in the bases/decorators.
| Name | Type | Default |
|---|---|---|
spec |
class attribute |
_search_text_tool_spec(default_limit=DEFAULT_SEARCH_LIMIT, max_limit=MAX_SEARCH_LIMIT) |
init (method)
Section titled “init (method)”SearchTextTool.__init__(*, default_limit: int=DEFAULT_SEARCH_LIMIT, max_limit: int=MAX_SEARCH_LIMIT, max_preview_bytes: int=DEFAULT_SEARCH_PREVIEW_LIMIT_BYTES, max_result_bytes: int=DEFAULT_SEARCH_RESULT_LIMIT_BYTES, timeout_s: int=DEFAULT_SEARCH_TIMEOUT_SECONDS, capture_limit_bytes: int=DEFAULT_SEARCH_CAPTURE_LIMIT_BYTES, max_file_size_bytes: int=DEFAULT_SEARCH_MAX_FILE_SIZE_BYTES, exclude_directories: Iterable[str]=DEFAULT_SEARCH_EXCLUDE_DIRECTORIES, protected_entry_names: Iterable[str]=(), spec: ToolSpec | None=None) -> Nonename (property)
Section titled “name (property)”SearchTextTool.name() -> strexecution_profile_identity (property)
Section titled “execution_profile_identity (property)”SearchTextTool.execution_profile_identity() -> ExecutionProfileBehaviorIdentity | NoneReturn the stable behavior declaration frozen with this tool’s spec.
retain_arguments_for_model (property)
Section titled “retain_arguments_for_model (property)”SearchTextTool.retain_arguments_for_model() -> boolRetain bounded redacted original inputs privately for the same profile.
Independent of audit publication; oversized and compacted-away inputs may be omitted. This does not grant knowledge read or activation rights.
description (property)
Section titled “description (property)”SearchTextTool.description() -> strschema (property)
Section titled “schema (property)”SearchTextTool.schema() -> dict[str, Any]run (method)
Section titled “run (method)”async SearchTextTool.run(ctx: ToolContext, args: dict[str, Any]) -> ToolResult