Guides API Reference HTTP API

Functions

agent tool extension mcp secret openThread / open_thread sqlite localMemory / local_memory localKnowledge / local_knowledge scriptedModel / scripted_model fakeSandbox / fake_sandbox host

Agents and runs

Agent RunResult RunStream RunContext Tool McpServer Extension Hooks Skill Secret Store ConfigError ConfigErrorCode

Threads and evals

Thread CaseExpectation SavedCase

Host

Model adapters

Model ModelContext ModelInfo ModelRequest ModelResponse ModelChunk LookupResult LookupCapability

Sandbox adapters

Sandbox SandboxAuthority SandboxContext SandboxInfo SandboxSession ExecOutput ExecResult

Memory and knowledge adapters

MemoryProvider KnowledgeProvider Scope Binding MemoryRecord RecordRef MemoryHit KnowledgeSource DocVersion KnowledgeHit Doc SearchBackend SearchHit

Channel adapters

ChannelAdapter ChannelCapabilities RawRequest RawResponse VerifiedDelivery Inbound DeliveryOutcome

DocVersion

What KnowledgeProvider.ingest returns: the admitted version of a document and the store revision after the ingest.

Fields

doc_idstringrequired

The document's id (the source's source_id).

versionstringrequired

The admitted version's id, non-empty. local_knowledge uses the first 16 hex characters of the content's sha256, so the same bytes are the same version.

content_sha256Sha256required

The sha256 of the admitted bytes, lowercase hex.

revisionnumberrequired

The store's monotonic revision after this ingest.

KnowledgeSource

One document to admit into a knowledge base, as the framework hands it to KnowledgeProvider.ingest.

KnowledgeHit

One matching passage, as a provider returns it from search.

On this page