@okcashpro/okai v0.1.7-alpha.1 / IDatabaseAdapter
Interface: IDatabaseAdapter
Interface for database operations
Properties
db
db:
any
Database instance
Defined in
packages/core/src/types.ts:788
Methods
init()
init():
Promise<void>
Optional initialization
Returns
Promise<void>
Defined in
packages/core/src/types.ts:791
close()
close():
Promise<void>
Close database connection
Returns
Promise<void>
Defined in
packages/core/src/types.ts:794
getAccountById()
getAccountById(
userId):Promise<Account>
Get account by ID
Parameters
• userId: `${string}-${string}-${string}-${string}-${string}`
Returns
Promise<Account>
Defined in
packages/core/src/types.ts:797
createAccount()
createAccount(
account):Promise<boolean>
Create new account
Parameters
• account: Account
Returns
Promise<boolean>
Defined in
packages/core/src/types.ts:800
getMemories()
getMemories(
params):Promise<Memory[]>
Get memories matching criteria
Parameters
• params
• params.roomId: `${string}-${string}-${string}-${string}-${string}`
• params.count?: number
• params.unique?: boolean
• params.tableName: string
• params.agentId: `${string}-${string}-${string}-${string}-${string}`
• params.start?: number
• params.end?: number
Returns
Promise<Memory[]>
Defined in
packages/core/src/types.ts:803
getMemoryById()
getMemoryById(
id):Promise<Memory>
Parameters
• id: `${string}-${string}-${string}-${string}-${string}`
Returns
Promise<Memory>
Defined in
packages/core/src/types.ts:813
getMemoriesByRoomIds()
getMemoriesByRoomIds(
params):Promise<Memory[]>
Parameters
• params
• params.tableName: string
• params.agentId: `${string}-${string}-${string}-${string}-${string}`
• params.roomIds: `${string}-${string}-${string}-${string}-${string}`[]
Returns
Promise<Memory[]>
Defined in
packages/core/src/types.ts:815
getCachedEmbeddings()
getCachedEmbeddings(
params):Promise<object[]>
Parameters
• params
• params.query_table_name: string
• params.query_threshold: number
• params.query_input: string
• params.query_field_name: string
• params.query_field_sub_name: string
• params.query_match_count: number
Returns
Promise<object[]>
Defined in
packages/core/src/types.ts:821
log()
log(
params):Promise<void>
Parameters
• params
• params.body
• params.userId: `${string}-${string}-${string}-${string}-${string}`
• params.roomId: `${string}-${string}-${string}-${string}-${string}`
• params.type: string
Returns
Promise<void>
Defined in
packages/core/src/types.ts:830
getActorDetails()
getActorDetails(
params):Promise<Actor[]>
Parameters
• params
• params.roomId: `${string}-${string}-${string}-${string}-${string}`
Returns
Promise<Actor[]>
Defined in
packages/core/src/types.ts:837
searchMemories()
searchMemories(
params):Promise<Memory[]>
Parameters
• params
• params.tableName: string
• params.agentId: `${string}-${string}-${string}-${string}-${string}`
• params.roomId: `${string}-${string}-${string}-${string}-${string}`
• params.embedding: number[]
• params.match_threshold: number
• params.match_count: number
• params.unique: boolean
Returns
Promise<Memory[]>
Defined in
packages/core/src/types.ts:839
updateGoalStatus()
updateGoalStatus(
params):Promise<void>
Parameters
• params
• params.goalId: `${string}-${string}-${string}-${string}-${string}`
• params.status: GoalStatus
Returns
Promise<void>
Defined in
packages/core/src/types.ts:849
searchMemoriesByEmbedding()
searchMemoriesByEmbedding(
embedding,params):Promise<Memory[]>
Parameters
• embedding: number[]
• params
• params.match_threshold?: number
• params.count?: number
• params.roomId?: `${string}-${string}-${string}-${string}-${string}`
• params.agentId?: `${string}-${string}-${string}-${string}-${string}`
• params.unique?: boolean
• params.tableName: string
Returns
Promise<Memory[]>
Defined in
packages/core/src/types.ts:854
createMemory()
createMemory(
memory,tableName,unique?):Promise<void>
Parameters
• memory: Memory
• tableName: string
• unique?: boolean
Returns
Promise<void>
Defined in
packages/core/src/types.ts:866
removeMemory()
removeMemory(
memoryId,tableName):Promise<void>
Parameters
• memoryId: `${string}-${string}-${string}-${string}-${string}`
• tableName: string
Returns
Promise<void>
Defined in
packages/core/src/types.ts:872
removeAllMemories()
removeAllMemories(
roomId,tableName):Promise<void>
Parameters
• roomId: `${string}-${string}-${string}-${string}-${string}`
• tableName: string
Returns
Promise<void>
Defined in
packages/core/src/types.ts:874
countMemories()
countMemories(
roomId,unique?,tableName?):Promise<number>
Parameters
• roomId: `${string}-${string}-${string}-${string}-${string}`
• unique?: boolean
• tableName?: string
Returns
Promise<number>
Defined in
packages/core/src/types.ts:876
getGoals()
getGoals(
params):Promise<Goal[]>
Parameters
• params
• params.agentId: `${string}-${string}-${string}-${string}-${string}`
• params.roomId: `${string}-${string}-${string}-${string}-${string}`
• params.userId?: `${string}-${string}-${string}-${string}-${string}`
• params.onlyInProgress?: boolean
• params.count?: number
Returns
Promise<Goal[]>
Defined in
packages/core/src/types.ts:882
updateGoal()
updateGoal(
goal):Promise<void>
Parameters
• goal: Goal
Returns
Promise<void>
Defined in
packages/core/src/types.ts:890
createGoal()
createGoal(
goal):Promise<void>
Parameters
• goal: Goal
Returns
Promise<void>
Defined in
packages/core/src/types.ts:892
removeGoal()
removeGoal(
goalId):Promise<void>
Parameters
• goalId: `${string}-${string}-${string}-${string}-${string}`
Returns
Promise<void>
Defined in
packages/core/src/types.ts:894
removeAllGoals()
removeAllGoals(
roomId):Promise<void>
Parameters
• roomId: `${string}-${string}-${string}-${string}-${string}`
Returns
Promise<void>
Defined in
packages/core/src/types.ts:896
getRoom()
getRoom(
roomId):Promise<`${string}-${string}-${string}-${string}-${string}`>
Parameters
• roomId: `${string}-${string}-${string}-${string}-${string}`
Returns
Promise<`${string}-${string}-${string}-${string}-${string}`>
Defined in
packages/core/src/types.ts:898
createRoom()
createRoom(
roomId?):Promise<`${string}-${string}-${string}-${string}-${string}`>
Parameters
• roomId?: `${string}-${string}-${string}-${string}-${string}`
Returns
Promise<`${string}-${string}-${string}-${string}-${string}`>
Defined in
packages/core/src/types.ts:900
removeRoom()
removeRoom(
roomId):Promise<void>
Parameters
• roomId: `${string}-${string}-${string}-${string}-${string}`
Returns
Promise<void>
Defined in
packages/core/src/types.ts:902
getRoomsForParticipant()
getRoomsForParticipant(
userId):Promise<`${string}-${string}-${string}-${string}-${string}`[]>
Parameters
• userId: `${string}-${string}-${string}-${string}-${string}`
Returns
Promise<`${string}-${string}-${string}-${string}-${string}`[]>
Defined in
packages/core/src/types.ts:904
getRoomsForParticipants()
getRoomsForParticipants(
userIds):Promise<`${string}-${string}-${string}-${string}-${string}`[]>
Parameters
• userIds: `${string}-${string}-${string}-${string}-${string}`[]
Returns
Promise<`${string}-${string}-${string}-${string}-${string}`[]>
Defined in
packages/core/src/types.ts:906
addParticipant()
addParticipant(
userId,roomId):Promise<boolean>
Parameters
• userId: `${string}-${string}-${string}-${string}-${string}`
• roomId: `${string}-${string}-${string}-${string}-${string}`
Returns
Promise<boolean>
Defined in
packages/core/src/types.ts:908
removeParticipant()
removeParticipant(
userId,roomId):Promise<boolean>
Parameters
• userId: `${string}-${string}-${string}-${string}-${string}`
• roomId: `${string}-${string}-${string}-${string}-${string}`
Returns
Promise<boolean>
Defined in
packages/core/src/types.ts:910
getParticipantsForAccount()
getParticipantsForAccount(
userId):Promise<Participant[]>
Parameters
• userId: `${string}-${string}-${string}-${string}-${string}`
Returns
Promise<Participant[]>
Defined in
packages/core/src/types.ts:912
getParticipantsForRoom()
getParticipantsForRoom(
roomId):Promise<`${string}-${string}-${string}-${string}-${string}`[]>
Parameters
• roomId: `${string}-${string}-${string}-${string}-${string}`
Returns
Promise<`${string}-${string}-${string}-${string}-${string}`[]>
Defined in
packages/core/src/types.ts:914
getParticipantUserState()
getParticipantUserState(
roomId,userId):Promise<"FOLLOWED"|"MUTED">
Parameters
• roomId: `${string}-${string}-${string}-${string}-${string}`
• userId: `${string}-${string}-${string}-${string}-${string}`
Returns
Promise<"FOLLOWED" | "MUTED">
Defined in
packages/core/src/types.ts:916
setParticipantUserState()
setParticipantUserState(
roomId,userId,state):Promise<void>
Parameters
• roomId: `${string}-${string}-${string}-${string}-${string}`
• userId: `${string}-${string}-${string}-${string}-${string}`
• state: "FOLLOWED" | "MUTED"
Returns
Promise<void>
Defined in
packages/core/src/types.ts:921
createRelationship()
createRelationship(
params):Promise<boolean>
Parameters
• params
• params.userA: `${string}-${string}-${string}-${string}-${string}`
• params.userB: `${string}-${string}-${string}-${string}-${string}`
Returns
Promise<boolean>
Defined in
packages/core/src/types.ts:927
getRelationship()
getRelationship(
params):Promise<Relationship>
Parameters
• params
• params.userA: `${string}-${string}-${string}-${string}-${string}`
• params.userB: `${string}-${string}-${string}-${string}-${string}`
Returns
Promise<Relationship>
Defined in
packages/core/src/types.ts:929
getRelationships()
getRelationships(
params):Promise<Relationship[]>
Parameters
• params
• params.userId: `${string}-${string}-${string}-${string}-${string}`
Returns
Promise<Relationship[]>