e9c60aec04
This PR adds LLM instrumentation on langfuse for ai-editor feature ## Type of change New feature (non-breaking change which adds functionality) Needs langfuse account and env vars to be set ## How Has This Been Tested? I configured personal langfuse credentials and instrumented the app, traces can be seen in langfuse. each conversation is one session. <img width="1683" height="714" alt="image" src="https://github.com/user-attachments/assets/3fcba1c9-63cf-44b9-a355-fd6608691559" /> <img width="1446" height="172" alt="image" src="https://github.com/user-attachments/assets/dfa6e98f-4741-4e04-9a9e-078d1f01e97b" /> ## Checklist: - [x ] My code follows the style guidelines of this project - [ x] I have performed a self-review of my code - [ x] I have commented on my code, particularly in hard-to-understand areas - [ ] I have made corresponding changes to the documentation - [ x] My changes generate no new warnings - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] New and existing unit tests pass locally with my changes - [ ] Any dependent changes have been merged and published in downstream modules --------- Co-authored-by: aakashb95 <aakash@chatwoot.com> Co-authored-by: Vishnu Narayanan <iamwishnu@gmail.com> Co-authored-by: Pranav <pranav@chatwoot.com>
82 lines
2.2 KiB
JavaScript
82 lines
2.2 KiB
JavaScript
/* global axios */
|
|
|
|
import ApiClient from '../ApiClient';
|
|
|
|
/**
|
|
* Represents the data object for a OpenAI hook.
|
|
* @typedef {Object} ConversationMessageData
|
|
* @property {string} [tone] - The tone of the message.
|
|
* @property {string} [content] - The content of the message.
|
|
* @property {string} [conversation_display_id] - The display ID of the conversation (optional).
|
|
*/
|
|
|
|
/**
|
|
* A client for the OpenAI API.
|
|
* @extends ApiClient
|
|
*/
|
|
class OpenAIAPI extends ApiClient {
|
|
/**
|
|
* Creates a new OpenAIAPI instance.
|
|
*/
|
|
constructor() {
|
|
super('integrations', { accountScoped: true });
|
|
|
|
/**
|
|
* The conversation events supported by the API.
|
|
* @type {string[]}
|
|
*/
|
|
this.conversation_events = [
|
|
'summarize',
|
|
'reply_suggestion',
|
|
'label_suggestion',
|
|
];
|
|
|
|
/**
|
|
* The message events supported by the API.
|
|
* @type {string[]}
|
|
*/
|
|
this.message_events = ['rephrase'];
|
|
}
|
|
|
|
/**
|
|
* Processes an event using the OpenAI API.
|
|
* @param {Object} options - The options for the event.
|
|
* @param {string} [options.type='rephrase'] - The type of event to process.
|
|
* @param {string} [options.content] - The content of the event.
|
|
* @param {string} [options.tone] - The tone of the event.
|
|
* @param {string} [options.conversationId] - The ID of the conversation to process the event for.
|
|
* @param {string} options.hookId - The ID of the hook to use for processing the event.
|
|
* @returns {Promise} A promise that resolves with the result of the event processing.
|
|
*/
|
|
processEvent({ type = 'rephrase', content, tone, conversationId, hookId }) {
|
|
/**
|
|
* @type {ConversationMessageData}
|
|
*/
|
|
let data = {
|
|
tone,
|
|
content,
|
|
};
|
|
|
|
// Always include conversation_display_id when available for session tracking
|
|
if (conversationId) {
|
|
data.conversation_display_id = conversationId;
|
|
}
|
|
|
|
// For conversation-level events, only send conversation_display_id
|
|
if (this.conversation_events.includes(type)) {
|
|
data = {
|
|
conversation_display_id: conversationId,
|
|
};
|
|
}
|
|
|
|
return axios.post(`${this.url}/hooks/${hookId}/process_event`, {
|
|
event: {
|
|
name: type,
|
|
data,
|
|
},
|
|
});
|
|
}
|
|
}
|
|
|
|
export default new OpenAIAPI();
|