Records
This page presents the record value types returned by Oracle Agent Memory stores and search APIs.
Base Record
class oracleagentmemory.apis.records.Record
Bases: object
Base persisted record returned by memory stores and search results.
- Parameters:
- id
str– Stable identifier for the stored record. - record_type
str– Logical record type such as"message","memory","guideline","fact","preference","thread","user_profile", or"agent_profile". - content
str | None– Optional textual payload stored for the record. - timestamp
str | None– Optional event timestamp associated with the record. - metadata
dict[str, Any] | None– Optional JSON-like metadata payload attached to the record.
- id
Scoped Record
class oracleagentmemory.apis.records.ScopedRecord
Bases: Record
Persisted record that exposes public scope identifiers.
ScopedRecord is the shared base class for record types whose public
shape includes scoping attributes like thread_id, user_id, and
agent_id. Typical examples are threads, messages, and memories.
- Parameters:
- thread_id
str | None– Optional thread scope identifier stored with the record. - user_id
str | None– Optional user scope identifier stored with the record. - agent_id
str | None– Optional agent scope identifier stored with the record. - id
str - record_type
str - content
str | None - timestamp
str | None - metadata
dict[str, Any] | None
- thread_id
Message Records
class oracleagentmemory.apis.records.MessageRecord
Bases: ScopedRecord
Chat message record.
- Parameters:
- id
str - content
str | None - timestamp
str | None - metadata
dict[str, Any] | None - thread_id
str | None - user_id
str | None - agent_id
str | None - role
str | None
- id
Memory Records
class oracleagentmemory.apis.records.MemoryRecord
Bases: ScopedRecord
Durable memory record.
- Parameters:
- id
str - content
str | None - timestamp
str | None - metadata
dict[str, Any] | None - thread_id
str | None - user_id
str | None - agent_id
str | None
- id
Guideline Records
class oracleagentmemory.apis.records.GuidelineRecord
Bases: ScopedRecord
Guideline record stored separately from general memories.
- Parameters:
- id
str - content
str | None - timestamp
str | None - metadata
dict[str, Any] | None - thread_id
str | None - user_id
str | None - agent_id
str | None
- id
Fact Records
class oracleagentmemory.apis.records.FactRecord
Bases: ScopedRecord
Fact record stored separately from general memories.
- Parameters:
- id
str - content
str | None - timestamp
str | None - metadata
dict[str, Any] | None - thread_id
str | None - user_id
str | None - agent_id
str | None
- id
Preference Records
class oracleagentmemory.apis.records.PreferenceRecord
Bases: ScopedRecord
Preference record stored separately from general memories.
- Parameters:
- id
str - content
str | None - timestamp
str | None - metadata
dict[str, Any] | None - thread_id
str | None - user_id
str | None - agent_id
str | None
- id
User Profile Records
class oracleagentmemory.apis.records.UserProfileRecord
Bases: Record
Unscoped user profile record.
- Parameters:
- id
str - content
str | None - timestamp
str | None - metadata
dict[str, Any] | None
- id
Agent Profile Records
class oracleagentmemory.apis.records.AgentProfileRecord
Bases: Record
Unscoped agent profile record.
- Parameters:
- id
str - content
str | None - timestamp
str | None - metadata
dict[str, Any] | None
- id
Thread Records
class oracleagentmemory.apis.records.ThreadRecord
Bases: ScopedRecord
Thread-scoped store record.
- Parameters:
- id
str - content
str | None - timestamp
str | None - metadata
dict[str, Any] | None - thread_id
str | None - user_id
str | None - agent_id
str | None - runtime_config
dict[str, Any] | None
- id
Helper
oracleagentmemory.apis.records.build_record
Construct the most specific record implementation for a stored row.
- Parameters:
- record_type
str– Canonical record type label. - record_id
str– Stable public identifier for the record. - content
str | None– Optional textual payload. - thread_id
str | None– Optional thread scope identifier for scoped record types. - user_id
str | None– Optional user scope identifier for scoped record types. - agent_id
str | None– Optional agent scope identifier for scoped record types. - role
str | None– Optional chat role, used only for message records. - timestamp
str | None– Optional event timestamp. - metadata
dict[str, Any] | None– Optional metadata payload. - kwargs
Any– Additional keyword arguments for specific record types.
- record_type
- Returns:
The most specific record class known for
record_type. - Return type: Record