cayu.tools.knowledge

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.

ListKnowledgeTool

from cayu.tools import ListKnowledgeTool

Bases: Tool.

init (method)

ListKnowledgeTool.__init__(spec: ToolSpec | None=None) -> None

name (property)

ListKnowledgeTool.name() -> str

execution_profile_identity (property)

ListKnowledgeTool.execution_profile_identity() -> ExecutionProfileBehaviorIdentity | None

Return the stable behavior declaration frozen with this tool’s spec.

retain_arguments_for_model (property)

ListKnowledgeTool.retain_arguments_for_model() -> bool

Retain 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)

ListKnowledgeTool.description() -> str

schema (property)

ListKnowledgeTool.schema() -> dict[str, Any]

run (method)

async ListKnowledgeTool.run(ctx: ToolContext, args: dict) -> ToolResult

Release source · Runtime guarantees · Capability guides

ReadKnowledgeTool

from cayu.tools import ReadKnowledgeTool

Bases: Tool.

init (method)

ReadKnowledgeTool.__init__(spec: ToolSpec | None=None) -> None

name (property)

ReadKnowledgeTool.name() -> str

execution_profile_identity (property)

ReadKnowledgeTool.execution_profile_identity() -> ExecutionProfileBehaviorIdentity | None

Return the stable behavior declaration frozen with this tool’s spec.

retain_arguments_for_model (property)

ReadKnowledgeTool.retain_arguments_for_model() -> bool

Retain 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)

ReadKnowledgeTool.description() -> str

schema (property)

ReadKnowledgeTool.schema() -> dict[str, Any]

run (method)

async ReadKnowledgeTool.run(ctx: ToolContext, args: dict) -> ToolResult

Release source · Runtime guarantees · Capability guides

RememberKnowledgePolicy

from cayu.tools import RememberKnowledgePolicy

Application policy for model-authored knowledge writes.

Bases: BaseModel.

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
governance	KnowledgeGovernanceConfig	Field(default_factory=KnowledgeGovernanceConfig)
default_namespace	str	DEFAULT_KNOWLEDGE_NAMESPACE
default_visibility	KnowledgeVisibility	KnowledgeVisibility.GLOBAL
allowed_kinds	tuple[str, ...] | None	None
default_kind	str	'fact'
default_created_by	str	'model'
require_labels	dict[str, str]	Field(default_factory=dict)

validate_clean_nonblank_fields (method)

RememberKnowledgePolicy.validate_clean_nonblank_fields(value: str, info) -> str

validate_default_created_by (method)

RememberKnowledgePolicy.validate_default_created_by(value: object) -> str

validate_allowed_kinds (method)

RememberKnowledgePolicy.validate_allowed_kinds(value) -> tuple[str, ...] | None

copy_required_labels (method)

RememberKnowledgePolicy.copy_required_labels(value) -> dict[str, str]

copy_governance (method)

RememberKnowledgePolicy.copy_governance(value: object) -> object

validate_status_policy (method)

RememberKnowledgePolicy.validate_status_policy() -> RememberKnowledgePolicy

Release source · Runtime guarantees · Capability guides

RememberKnowledgeTool

from cayu.tools import RememberKnowledgeTool

Bases: Tool.

init (method)

RememberKnowledgeTool.__init__(spec: ToolSpec | None=None, *, policy: RememberKnowledgePolicy | dict[str, Any] | None=None, activation_policy: KnowledgeActivationPolicy | None=None, max_text_bytes: int=DEFAULT_REMEMBER_KNOWLEDGE_MAX_BYTES, chunk_target_bytes: int=DEFAULT_REMEMBER_KNOWLEDGE_CHUNK_TARGET_BYTES, max_chunks: int=DEFAULT_REMEMBER_KNOWLEDGE_MAX_CHUNKS) -> None

name (property)

RememberKnowledgeTool.name() -> str

execution_profile_identity (property)

RememberKnowledgeTool.execution_profile_identity() -> ExecutionProfileBehaviorIdentity | None

Return the stable behavior declaration frozen with this tool’s spec.

retain_arguments_for_model (property)

RememberKnowledgeTool.retain_arguments_for_model() -> bool

description (property)

RememberKnowledgeTool.description() -> str

schema (property)

RememberKnowledgeTool.schema() -> dict[str, Any]

run (method)

async RememberKnowledgeTool.run(ctx: ToolContext, args: dict) -> ToolResult

aclose (method)

async RememberKnowledgeTool.aclose(*, timeout_s: float=10.0) -> bool

Seal and drain publications retained beyond their invoking callers.

aenter (method)

async RememberKnowledgeTool.__aenter__() -> RememberKnowledgeTool

aexit (method)

async RememberKnowledgeTool.__aexit__(*_exc_info: object) -> None

Release source · Runtime guarantees · Capability guides

SearchKnowledgeTool

from cayu.tools import SearchKnowledgeTool

Bases: Tool.

init (method)

SearchKnowledgeTool.__init__(spec: ToolSpec | None=None, *, allow_score_override: bool=False, auto_min_score: float | None=DEFAULT_AUTO_SEMANTIC_MIN_SCORE, default_namespace: str=DEFAULT_KNOWLEDGE_NAMESPACE) -> None

name (property)

SearchKnowledgeTool.name() -> str

execution_profile_identity (property)

SearchKnowledgeTool.execution_profile_identity() -> ExecutionProfileBehaviorIdentity | None

Return the stable behavior declaration frozen with this tool’s spec.

retain_arguments_for_model (property)

SearchKnowledgeTool.retain_arguments_for_model() -> bool

Retain 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)

SearchKnowledgeTool.description() -> str

schema (property)

SearchKnowledgeTool.schema() -> dict[str, Any]

run (method)

async SearchKnowledgeTool.run(ctx: ToolContext, args: dict) -> ToolResult

Release source · Runtime guarantees · Capability guides