Endpoint Service¶

This service is used to interact with the backend. Understandably, this is the most crucial part in the context of backend frontend integration. Given that (at the point of writing) the endpoints were still evolving, this service served as a abstraction layer, so that the rest of the webapp will not break -- when API endpoints are updated, technically, this is the only service that needs to be updated, technically.

service EndpointService¶

Utility Methods¶

meth Text to Speech¶

async textToSpeech(text: string): Promise<BehaviorSubject<Blob | null>>

Description

Method to send text to the backend for conversion to speech.

Parameters

text (string): The text that needs to be converted to speech.

Returns

Promise<BehaviorSubject<Blob | null>>

private meth Message to Api Chat History¶

private messageToApiChatHistory(message: Message[]): ApiChatHistory[]

Description

Method to convert Message array into ApiChatHistory format for backend consumption.

Parameters

message (Message[]): Array of messages to convert.

Returns

ApiChatHistory[]

private meth Message to Api Chat History with Sources¶

private messageToApiChatHistoryWithSources(message: Message[]): ApiChatHistorywithSources[]

Description

Method to convert Message array into ApiChatHistorywithSources format for backend consumption.

Parameters

message (Message[]): Array of messages to convert.

Returns

ApiChatHistorywithSources[]

private meth Profile to Api Profile¶

private profileToApiProfile(profile: Profile): ApiProfile

Description

Method to convert Profile into ApiProfile format for backend consumption.

Parameters

profile (Profile)

Returns

ApiProfile

Methods¶

meth Send Voice¶

async sendVoice(
    recording: Blob,
    profile: Profile,
    history: Message[]
): Promise<BehaviorSubject<VoiceResponse|null>>

Description

Method to send voice recording to the backend.

Parameters

recording (Blob): Binary of file recording.

profile (Profile): Active profile used in the conversation.

history (Message[]): Chat history in the conversation.

Returns

Promise<BehaviorSubject<VoiceResponse|null>>

meth Send Chat¶

async sendChat(
    message: Message,
    profile: Profile,
    history: Message[]
): Promise<BehaviorSubject<ChatReponse|null>>

Description

Method to send chat (text) message to the backend for processing

Parameters

message (Message): Chat message from user.

profile (Profile): Active profile used in the conversation.

history (Message[]): Chat history in the conversation.

Returns

Promise<BehaviorSubject<ChatResponse|null>>

Updated 22 Oct 2024

Contributor Ong Tsien Jin