API Reference
On this page, you will find the oracleagentmemory API reference, ordered by component.
Click on the components and section names to access the complete API documentation pages.
Agent Memory
Full reference: Agent Memory
Classes
| Class | Description |
|---|---|
OracleAgentMemory |
Agent-memory client backed by Oracle DB or a caller-provided store. |
Threads
Full reference: Threads
Classes
| Class | Description |
|---|---|
OracleThread |
Thread backed by an Oracle store. |
Message |
The in-memory message shared by threads and LLM adapters. |
Records
Full reference: Records
Classes
| Class | Description |
|---|---|
Record |
Base persisted record returned by memory stores and search results. |
MessageRecord |
Stored chat message record. |
MemoryRecord |
Durable memory record. |
GuidelineRecord |
Guideline record stored separately from general memories. |
FactRecord |
Fact record stored separately from general memories. |
UserProfileRecord |
Unscoped user profile record. |
AgentProfileRecord |
Unscoped agent profile record. |
ThreadRecord |
Thread-scoped store record. |
Search
Full reference: Search
Classes
| Class | Description |
|---|---|
Scope |
Represents a scope for information insertion or searches. |
SearchScope |
Represents the scope for a search query and therefore constrains what can be returned. |
ISearchConfig |
Interface accepted by agent-memory search APIs. |
OracleSearchResult |
Search result returned by an Oracle thread. |
MemorySearchConfig |
Base configuration for memory post-search behavior. |
TopKMemorySearchConfig |
Search configuration with a fixed maximum of direct results. |
PruningEvaluationMode |
Controls how extensively search results are evaluated during pruning. |
PruningMemorySearchConfig |
Search configuration that removes less relevant direct results. |
LLMs, Embedders and Rerankers
Full reference: LLMs, Embedders and Rerankers
Classes
| Class | Description |
|---|---|
Llm |
Adapter for generating model responses. |
LlmResponse |
A small normalized response returned by ILlm. |
IEmbedder |
Abstract interface for text embedders. |
Embedder |
Provider-backed embedder. |
OracleDBEmbedder |
Embed text by invoking Oracle AI Database embedding SQL. |
IReranker |
Abstract interface for synchronous and asynchronous document reranking. |
RerankResponse |
Complete document ranking ordered by descending relevance score. |
RerankResponseResult |
One document’s reranking result. |
Reranker |
Reranker backed by a provider-neutral rerank interface. |
MemoryExtractionConfig |
Grouped settings for automatic memory extraction. |
ImageInputLimitConfig |
Configure raw image and LLM image-request limits. |
MemoryExtractionMode |
Controls when automatic extraction and image descriptions run. |
Stores and Schema
Full reference: Stores and Schema
Classes
| Class | Description |
|---|---|
OracleMemoryStore |
Common store interface used by OracleAgentMemory. |
OracleDBMemoryStore |
Database-backed persistence for messages, documents, memories, and actor profiles. |
MemoryRetentionConfig |
Schema-level retention settings for Oracle DB-backed records. |
TimeToLiveAnchor |
Anchor used to compute an expiration timestamp from a time-to-live duration. |
SchemaPolicy |
Schema creation policy for Oracle DB stores. |
Deep Data Security
Full reference: Deep Data Security
Classes
| Class | Description |
|---|---|
Principal |
Base type identifying who receives Agent Memory policy assignments. |
DeepDataSecurityPolicy |
Identify a supported Oracle Agent Memory Deep Data Security policy. |
UserOwnRowsDeepDataSecurityPolicy |
Grant access to rows owned by the authenticated end user. |
GlobalMemoriesDeepDataSecurityPolicy |
Grant read access to global memories and links between visible memories. |
OciGroupPrincipal |
Identify an OCI IAM group that receives Agent Memory policies. |
LocalEndUserPrincipal |
Identify a local Deep Data Security end user receiving policies. |
OracleMemoryEndUserSecurityContext |
Apply an Oracle end-user security context to Agent Memory operations. |