Skip to main content

Class: ConversationService

Constructors​

constructor​

• new ConversationService(config): ConversationService

Parameters​

NameType
configConversationServiceConfig

Returns​

ConversationService

Defined in​

packages/mongodb-chatbot-ui/src/services/conversations.ts:175

Properties​

getFetchOptions​

• Private getFetchOptions: () => ConversationFetchOptions & { headers: Headers }

Type declaration​

▸ (): ConversationFetchOptions & { headers: Headers }

Returns​

ConversationFetchOptions & { headers: Headers }

Defined in​

packages/mongodb-chatbot-ui/src/services/conversations.ts:171


serverUrl​

• Private serverUrl: string

Defined in​

packages/mongodb-chatbot-ui/src/services/conversations.ts:170

Methods​

addMessage​

▸ addMessage(«destructured»): Promise<MessageData>

Parameters​

NameType
«destructured»{ conversationId: string } & AddMessageRequestBody

Returns​

Promise<MessageData>

Defined in​

packages/mongodb-chatbot-ui/src/services/conversations.ts:274


addMessageStreaming​

▸ addMessageStreaming(«destructured»): Promise<void>

Parameters​

NameType
«destructured»{ conversationId: string ; maxRetries?: number ; onMetadata: (metadata: AssistantMessageMetadata) => void ; onReferences: (references: { metadata?: objectOutputType<{ sourceName: ZodOptional<ZodString> ; sourceType: ZodOptional<ZodString> ; tags: ZodOptional<ZodArray<ZodString, "many">> }, ZodTypeAny, "passthrough"> ; title: string ; url: string }[]) => void ; onResponseDelta: (delta: string) => void ; onResponseFinished: (messageId: string) => void ; signal?: AbortSignal } & AddMessageRequestBody

Returns​

Promise<void>

Defined in​

packages/mongodb-chatbot-ui/src/services/conversations.ts:312


commentMessage​

▸ commentMessage(«destructured»): Promise<void>

Parameters​

NameType
«destructured»Object
› commentstring
› conversationIdstring
› messageIdstring

Returns​

Promise<void>

Defined in​

packages/mongodb-chatbot-ui/src/services/conversations.ts:494


createConversation​

▸ createConversation(): Promise<ConversationData>

Returns​

Promise<ConversationData>

Defined in​

packages/mongodb-chatbot-ui/src/services/conversations.ts:241


getConversation​

▸ getConversation(conversationId): Promise<ConversationData>

Parameters​

NameType
conversationIdstring

Returns​

Promise<ConversationData>

Defined in​

packages/mongodb-chatbot-ui/src/services/conversations.ts:261


getUrl​

▸ getUrl(path, queryParams?): string

Parameters​

NameType
pathstring
queryParamsRecord<string, string>

Returns​

string

Defined in​

packages/mongodb-chatbot-ui/src/services/conversations.ts:224


mergeHeaders​

▸ mergeHeaders(headers1, headers2): Headers

Parameters​

NameType
headers1Headers
headers2Headers

Returns​

Headers

Defined in​

packages/mongodb-chatbot-ui/src/services/conversations.ts:209


rateMessage​

▸ rateMessage(«destructured»): Promise<boolean>

Parameters​

NameType
«destructured»Object
› conversationIdstring
› messageIdstring
› ratingboolean

Returns​

Promise<boolean>

Defined in​

packages/mongodb-chatbot-ui/src/services/conversations.ts:466