Class: ConversationService
Constructors
constructor
• new ConversationService(config): ConversationService
Parameters
| Name | Type |
|---|---|
config | ConversationServiceConfig |
Returns
Defined in
packages/mongodb-chatbot-ui/src/services/conversations.ts:170
Properties
fetchOptions
• Private fetchOptions: Omit<RequestInit, "body" | "method" | "headers" | "signal"> & { headers?: Headers } & { headers: Headers }
Defined in
packages/mongodb-chatbot-ui/src/services/conversations.ts:168
serverUrl
• Private serverUrl: string
Defined in
packages/mongodb-chatbot-ui/src/services/conversations.ts:167
Methods
addMessage
▸ addMessage(«destructured»): Promise<MessageData>
Parameters
| Name | Type |
|---|---|
«destructured» | Object |
› conversationId | string |
› message | string |
Returns
Promise<MessageData>
Defined in
packages/mongodb-chatbot-ui/src/services/conversations.ts:263
addMessageStreaming
▸ addMessageStreaming(«destructured»): Promise<void>
Parameters
| Name | Type |
|---|---|
«destructured» | Object |
› conversationId | string |
› maxRetries? | number |
› message | string |
› 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 |
Returns
Promise<void>
Defined in
packages/mongodb-chatbot-ui/src/services/conversations.ts:295
commentMessage
▸ commentMessage(«destructured»): Promise<void>
Parameters
| Name | Type |
|---|---|
«destructured» | Object |
› comment | string |
› conversationId | string |
› messageId | string |
Returns
Promise<void>
Defined in
packages/mongodb-chatbot-ui/src/services/conversations.ts:469
createConversation
▸ createConversation(): Promise<ConversationData>
Returns
Promise<ConversationData>
Defined in
packages/mongodb-chatbot-ui/src/services/conversations.ts:230
getConversation
▸ getConversation(conversationId): Promise<ConversationData>
Parameters
| Name | Type |
|---|---|
conversationId | string |
Returns
Promise<ConversationData>
Defined in
packages/mongodb-chatbot-ui/src/services/conversations.ts:250
getUrl
▸ getUrl(path, queryParams?): string
Parameters
| Name | Type |
|---|---|
path | string |
queryParams | Record<string, string> |
Returns
string
Defined in
packages/mongodb-chatbot-ui/src/services/conversations.ts:213
mergeHeaders
▸ mergeHeaders(headers1, headers2): Headers
Parameters
| Name | Type |
|---|---|
headers1 | Headers |
headers2 | Headers |
Returns
Headers
Defined in
packages/mongodb-chatbot-ui/src/services/conversations.ts:198
rateMessage
▸ rateMessage(«destructured»): Promise<boolean>
Parameters
| Name | Type |
|---|---|
«destructured» | Object |
› conversationId | string |
› messageId | string |
› rating | boolean |
Returns
Promise<boolean>
Defined in
packages/mongodb-chatbot-ui/src/services/conversations.ts:441