Namespace: Conversations

Interfaces

• CommentMessageParams
• Conversation
• ConversationConstants
• ConversationsService
• FindByIdParams
• RateMessageParams

Type Aliases

AddAssistantMessageParams

Ƭ AddAssistantMessageParams: AddMessageParams<AssistantMessage>

Defined in

packages/mongodb-rag-core/build/conversations/ConversationsService.d.ts:142

---

AddConversationMessageParams

Ƭ AddConversationMessageParams: Object

Type declaration

Name	Type
conversationId	ObjectId
message	AddSomeMessageParams

Defined in

packages/mongodb-rag-core/build/conversations/ConversationsService.d.ts:146

---

AddFunctionMessageParams

Ƭ AddFunctionMessageParams: AddMessageParams<WithCustomData<FunctionMessage>>

Defined in

packages/mongodb-rag-core/build/conversations/ConversationsService.d.ts:141

---

AddManyConversationMessagesParams

Ƭ AddManyConversationMessagesParams: Object

Type declaration

Name	Type
conversationId	ObjectId
messages	AddSomeMessageParams[]

Defined in

packages/mongodb-rag-core/build/conversations/ConversationsService.d.ts:150

---

AddMessageParams

Ƭ AddMessageParams<T>: Omit<T, "createdAt"> & { id?: ObjectId }

Type parameters

Name	Type
T	extends SomeMessage

Defined in

packages/mongodb-rag-core/build/conversations/ConversationsService.d.ts:133

---

AddSomeMessageParams

Ƭ AddSomeMessageParams: AddSystemMessageParams | AddUserMessageParams | AddAssistantMessageParams | AddFunctionMessageParams & { id?: ObjectId }

Defined in

packages/mongodb-rag-core/build/conversations/ConversationsService.d.ts:143

---

AddSystemMessageParams

Ƭ AddSystemMessageParams: AddMessageParams<SystemMessage>

Defined in

packages/mongodb-rag-core/build/conversations/ConversationsService.d.ts:139

---

AddUserMessageParams

Ƭ AddUserMessageParams: AddMessageParams<WithCustomData<UserMessage>>

Defined in

packages/mongodb-rag-core/build/conversations/ConversationsService.d.ts:140

---

AssistantMessage

Ƭ AssistantMessage: MessageBase & { functionCall?: OpenAI.ChatCompletionMessage.FunctionCall ; metadata?: AssistantMessageMetadata ; rating?: boolean ; references?: any[] ; role: "assistant" ; userComment?: string }

Defined in

packages/mongodb-rag-core/build/conversations/ConversationsService.d.ts:29

---

AssistantMessageMetadata

Ƭ AssistantMessageMetadata: Object

Index signature

▪ [k: string]: unknown

Type declaration

Name	Type	Description
verifiedAnswer?	VerifiedAnswerEventData	If the message came from the verified answers collection, contains the metadata about the verified answer.

Defined in

packages/mongodb-rag-core/build/conversations/ConversationsService.d.ts:50

---

ConversationCustomData

Ƭ ConversationCustomData: Record<string, unknown> | undefined

Defined in

packages/mongodb-rag-core/build/conversations/ConversationsService.d.ts:111

---

CreateConversationParams

Ƭ CreateConversationParams: Object

Type declaration

Name	Type
customData?	ConversationCustomData
initialMessages?	SomeMessage[]

Defined in

packages/mongodb-rag-core/build/conversations/ConversationsService.d.ts:129

---

DbMessage

Ƭ DbMessage<SomeMessage>: SomeMessage & { createdAt: Date ; id: ObjectId }

Type parameters

Name
SomeMessage

Defined in

packages/mongodb-rag-core/build/conversations/ConversationsService.d.ts:97

---

FunctionMessage

Ƭ FunctionMessage: MessageBase & { name: string ; role: "function" }

Defined in

packages/mongodb-rag-core/build/conversations/ConversationsService.d.ts:59

---

Message

Ƭ Message: DbMessage<SomeMessage>

Message stored in the database.

Defined in

packages/mongodb-rag-core/build/conversations/ConversationsService.d.ts:110

---

MessageBase

Ƭ MessageBase: Object

Type declaration

Name	Type	Description
content	string	Message that occurs in the conversation.
customData?	Record<string, unknown>	Custom data received from the client to include in the Message persisted to the database.
metadata?	Record<string, unknown>	Arbitrary data about the message that should be sent to the client.
role	string	The role of the message in the conversation.

Defined in

packages/mongodb-rag-core/build/conversations/ConversationsService.d.ts:7

---

SomeMessage

Ƭ SomeMessage: UserMessage | AssistantMessage | SystemMessage | FunctionMessage

Message in the Conversation.

Defined in

packages/mongodb-rag-core/build/conversations/ConversationsService.d.ts:96

---

SystemMessage

Ƭ SystemMessage: MessageBase & { role: "system" }

Defined in

packages/mongodb-rag-core/build/conversations/ConversationsService.d.ts:26

---

UserMessage

Ƭ UserMessage: MessageBase & { contentForLlm?: string ; contextContent?: Partial<WithScore<EmbeddedContent>>[] ; embedding?: number[] ; preprocessedContent?: string ; rejectQuery?: boolean ; role: "user" }

Defined in

packages/mongodb-rag-core/build/conversations/ConversationsService.d.ts:63

---

VerifiedAnswerEventData

Ƭ VerifiedAnswerEventData: Pick<VerifiedAnswer, "_id" | "created" | "updated">

Defined in

packages/mongodb-rag-core/build/conversations/ConversationsService.d.ts:58

Variables

defaultConversationConstants

• Const defaultConversationConstants: ConversationConstants

Defined in

packages/mongodb-rag-core/build/conversations/ConversationsService.d.ts:208

Functions

createMessage

▸ createMessage(messageParams): { content: string ; createdAt: Date ; customData?: Record<string, unknown> ; id: ObjectId ; metadata?: Record<string, unknown> ; role: "system" } | { content: string ; contentForLlm?: string ; contextContent?: Partial<WithScore>[] ; createdAt: Date ; customData?: Record<string, unknown> ; embedding?: number[] ; id: ObjectId ; metadata?: Record<string, unknown> ; preprocessedContent?: string ; rejectQuery?: boolean ; role: "user" } | { content: string ; createdAt: Date ; customData?: Record<string, unknown> ; id: ObjectId ; metadata?: Record<string, unknown> ; name: string ; role: "function" } | { content: string ; createdAt: Date ; customData?: Record<string, unknown> ; functionCall?: ChatCompletionMessage.FunctionCall ; id: ObjectId ; metadata?: Record<string, unknown> & AssistantMessageMetadata ; rating?: boolean ; references?: { metadata?: objectOutputType ; title: string ; url: string }[] ; role: "assistant" ; userComment?: string }

Parameters

Name	Type
messageParams	AddSomeMessageParams

Returns

{ content: string ; createdAt: Date ; customData?: Record<string, unknown> ; id: ObjectId ; metadata?: Record<string, unknown> ; role: "system" } | { content: string ; contentForLlm?: string ; contextContent?: Partial<WithScore>[] ; createdAt: Date ; customData?: Record<string, unknown> ; embedding?: number[] ; id: ObjectId ; metadata?: Record<string, unknown> ; preprocessedContent?: string ; rejectQuery?: boolean ; role: "user" } | { content: string ; createdAt: Date ; customData?: Record<string, unknown> ; id: ObjectId ; metadata?: Record<string, unknown> ; name: string ; role: "function" } | { content: string ; createdAt: Date ; customData?: Record<string, unknown> ; functionCall?: ChatCompletionMessage.FunctionCall ; id: ObjectId ; metadata?: Record<string, unknown> & AssistantMessageMetadata ; rating?: boolean ; references?: { metadata?: objectOutputType ; title: string ; url: string }[] ; role: "assistant" ; userComment?: string }

Defined in

packages/mongodb-rag-core/build/conversations/MongoDbConversations.d.ts:7

---

createMessageFromOpenAIChatMessage

▸ createMessageFromOpenAIChatMessage(chatMessage): Message

Create a Message object from the OpenAiChatMessage object.

Parameters

Name	Type
chatMessage	AddSomeMessageParams

Returns

Message

Defined in

packages/mongodb-rag-core/build/conversations/MongoDbConversations.d.ts:57

---

makeMongoDbConversationsService

▸ makeMongoDbConversationsService(database, conversationConstants?): ConversationsService

Create ConversationsService that uses MongoDB as a data store.

Parameters

Name	Type
database	Db
conversationConstants?	ConversationConstants

Returns

ConversationsService

Defined in

packages/mongodb-rag-core/build/conversations/MongoDbConversations.d.ts:6