feat(ee): Add Captain features (#10665)

Migration Guide: https://chwt.app/v4/migration

This PR imports all the work related to Captain into the EE codebase. Captain represents the AI-based features in Chatwoot and includes the following key components:

- Assistant: An assistant has a persona, the product it would be trained on. At the moment, the data at which it is trained is from websites. Future integrations on Notion documents, PDF etc. This PR enables connecting an assistant to an inbox. The assistant would run the conversation every time before transferring it to an agent.
- Copilot for Agents: When an agent is supporting a customer, we will be able to offer additional help to lookup some data or fetch information from integrations etc via copilot.
- Conversation FAQ generator: When a conversation is resolved, the Captain integration would identify questions which were not in the knowledge base.
- CRM memory: Learns from the conversations and identifies important information about the contact.

---------

Co-authored-by: Vishnu Narayanan <vishnu@chatwoot.com>
Co-authored-by: Sojan <sojan@pepalo.com>
Co-authored-by: iamsivin <iamsivin@gmail.com>
Co-authored-by: Sivin Varghese <64252451+iamsivin@users.noreply.github.com>

enterprise/app/controllers/api/v1/accounts/captain/assistant_responses_controller.rb

@@ -0,0 +1,68 @@
+class Api::V1::Accounts::Captain::AssistantResponsesController < Api::V1::Accounts::BaseController
+  before_action :current_account
+  before_action -> { check_authorization(Captain::Assistant) }
+
+  before_action :set_current_page, only: [:index]
+  before_action :set_assistant, only: [:create]
+  before_action :set_responses, except: [:create]
+  before_action :set_response, only: [:show, :update, :destroy]
+
+  RESULTS_PER_PAGE = 25
+
+  def index
+    base_query = @responses
+    base_query = base_query.where(assistant_id: permitted_params[:assistant_id]) if permitted_params[:assistant_id].present?
+    base_query = base_query.where(document_id: permitted_params[:document_id]) if permitted_params[:document_id].present?
+
+    @responses_count = base_query.count
+
+    @responses = base_query.page(@current_page).per(RESULTS_PER_PAGE)
+  end
+
+  def show; end
+
+  def create
+    @response = Current.account.captain_assistant_responses.new(response_params)
+    @response.save!
+  end
+
+  def update
+    @response.update!(response_params)
+  end
+
+  def destroy
+    @response.destroy
+    head :no_content
+  end
+
+  private
+
+  def set_assistant
+    @assistant = Current.account.captain_assistants.find_by(id: params[:assistant_id])
+  end
+
+  def set_responses
+    @responses = Current.account.captain_assistant_responses.includes(:assistant, :document).ordered
+  end
+
+  def set_response
+    @response = @responses.find(permitted_params[:id])
+  end
+
+  def set_current_page
+    @current_page = permitted_params[:page] || 1
+  end
+
+  def permitted_params
+    params.permit(:id, :assistant_id, :page, :document_id, :account_id)
+  end
+
+  def response_params
+    params.require(:assistant_response).permit(
+      :question,
+      :answer,
+      :document_id,
+      :assistant_id
+    )
+  end
+end

enterprise/app/controllers/api/v1/accounts/captain/assistants_controller.rb

@@ -0,0 +1,39 @@
+class Api::V1::Accounts::Captain::AssistantsController < Api::V1::Accounts::BaseController
+  before_action :current_account
+  before_action -> { check_authorization(Captain::Assistant) }
+
+  before_action :set_assistant, only: [:show, :update, :destroy]
+
+  def index
+    @assistants = account_assistants.ordered
+  end
+
+  def show; end
+
+  def create
+    @assistant = account_assistants.create!(assistant_params)
+  end
+
+  def update
+    @assistant.update!(assistant_params)
+  end
+
+  def destroy
+    @assistant.destroy
+    head :no_content
+  end
+
+  private
+
+  def set_assistant
+    @assistant = account_assistants.find(params[:id])
+  end
+
+  def account_assistants
+    @account_assistants ||= Captain::Assistant.for_account(Current.account.id)
+  end
+
+  def assistant_params
+    params.require(:assistant).permit(:name, :description, config: [:product_name, :feature_faq, :feature_memory])
+  end
+end

enterprise/app/controllers/api/v1/accounts/captain/documents_controller.rb

@@ -0,0 +1,58 @@
+class Api::V1::Accounts::Captain::DocumentsController < Api::V1::Accounts::BaseController
+  before_action :current_account
+  before_action -> { check_authorization(Captain::Assistant) }
+
+  before_action :set_current_page, only: [:index]
+  before_action :set_documents, except: [:create]
+  before_action :set_document, only: [:show, :destroy]
+  before_action :set_assistant, only: [:create]
+  RESULTS_PER_PAGE = 25
+
+  def index
+    base_query = @documents
+    base_query = base_query.where(assistant_id: permitted_params[:assistant_id]) if permitted_params[:assistant_id].present?
+
+    @documents_count = base_query.count
+    @documents = base_query.page(@current_page).per(RESULTS_PER_PAGE)
+  end
+
+  def show; end
+
+  def create
+    return render_could_not_create_error('Missing Assistant') if @assistant.nil?
+
+    @document = @assistant.documents.build(document_params)
+    @document.save!
+  end
+
+  def destroy
+    @document.destroy
+    head :no_content
+  end
+
+  private
+
+  def set_documents
+    @documents = Current.account.captain_documents.includes(:assistant).ordered
+  end
+
+  def set_document
+    @document = @documents.find(permitted_params[:id])
+  end
+
+  def set_assistant
+    @assistant = Current.account.captain_assistants.find_by(id: document_params[:assistant_id])
+  end
+
+  def set_current_page
+    @current_page = permitted_params[:page] || 1
+  end
+
+  def permitted_params
+    params.permit(:assistant_id, :page, :id, :account_id)
+  end
+
+  def document_params
+    params.require(:document).permit(:name, :external_link, :assistant_id)
+  end
+end

enterprise/app/controllers/api/v1/accounts/captain/inboxes_controller.rb

@@ -0,0 +1,39 @@
+class Api::V1::Accounts::Captain::InboxesController < Api::V1::Accounts::BaseController
+  before_action :current_account
+  before_action -> { check_authorization(Captain::Assistant) }
+
+  before_action :set_assistant
+  def index
+    @inboxes = @assistant.inboxes
+  end
+
+  def create
+    inbox = Current.account.inboxes.find(assistant_params[:inbox_id])
+    @captain_inbox = @assistant.captain_inboxes.build(inbox: inbox)
+    @captain_inbox.save!
+  end
+
+  def destroy
+    @captain_inbox = @assistant.captain_inboxes.find_by!(inbox_id: permitted_params[:inbox_id])
+    @captain_inbox.destroy!
+    head :no_content
+  end
+
+  private
+
+  def set_assistant
+    @assistant = account_assistants.find(permitted_params[:assistant_id])
+  end
+
+  def account_assistants
+    @account_assistants ||= Current.account.captain_assistants
+  end
+
+  def permitted_params
+    params.permit(:assistant_id, :id, :account_id, :inbox_id)
+  end
+
+  def assistant_params
+    params.require(:inbox).permit(:inbox_id)
+  end
+end

enterprise/app/controllers/api/v1/accounts/response_sources_controller.rb

@@ -1,34 +0,0 @@
-class Api::V1::Accounts::ResponseSourcesController < Api::V1::Accounts::BaseController
-  before_action :current_account
-  before_action :check_authorization
-  before_action :find_response_source, only: [:add_document, :remove_document]
-
-  def parse
-    links = PageCrawlerService.new(params[:link]).page_links
-    render json: { links: links }
-  end
-
-  def create
-    @response_source = Current.account.response_sources.new(response_source_params)
-    @response_source.save!
-  end
-
-  def add_document
-    @response_source.response_documents.create!(document_link: params[:document_link])
-  end
-
-  def remove_document
-    @response_source.response_documents.find(params[:document_id]).destroy!
-  end
-
-  private
-
-  def find_response_source
-    @response_source = Current.account.response_sources.find(params[:id])
-  end
-
-  def response_source_params
-    params.require(:response_source).permit(:name, :source_link,
-                                            response_documents_attributes: [:document_link])
-  end
-end

enterprise/app/controllers/enterprise/api/v1/accounts/conversations_controller.rb

@@ -1,5 +1,29 @@
 module Enterprise::Api::V1::Accounts::ConversationsController
+  extend ActiveSupport::Concern
+  included do
+    before_action :set_assistant, only: [:copilot]
+  end
+
+  def copilot
+    assistant = @conversation.inbox.captain_assistant
+    return render json: { message: I18n.t('captain.copilot_error') } unless assistant
+
+    response = Captain::Copilot::ChatService.new(
+      assistant,
+      messages: copilot_params[:previous_messages],
+      conversation_history: @conversation.to_llm_text
+    ).execute(copilot_params[:message])
+
+    render json: { message: response }
+  end
+
   def permitted_update_params
     super.merge(params.permit(:sla_policy_id))
   end
+
+  private
+
+  def copilot_params
+    params.permit(:previous_messages, :message, :assistant_id)
+  end
 end

enterprise/app/controllers/enterprise/api/v1/accounts/inboxes_controller.rb

@@ -1,8 +1,4 @@
 module Enterprise::Api::V1::Accounts::InboxesController
-  def response_sources
-    @response_sources = @inbox.response_sources
-  end
-
   def inbox_attributes
     super + ee_inbox_attributes
   end

enterprise/app/controllers/enterprise/super_admin/app_configs_controller.rb

@@ -10,7 +10,7 @@ module Enterprise::SuperAdmin::AppConfigsController
     when 'internal'
       @allowed_configs = internal_config_options
     when 'captain'
-      @allowed_configs = %w[CAPTAIN_API_URL CAPTAIN_APP_URL]
+      @allowed_configs = %w[CAPTAIN_OPEN_AI_API_KEY]
     else
       super
     end

enterprise/app/controllers/enterprise/webhooks/firecrawl_controller.rb

@@ -0,0 +1,30 @@
+class Enterprise::Webhooks::FirecrawlController < ActionController::API
+  def process_payload
+    if crawl_page_event?
+      Captain::Tools::FirecrawlParserJob.perform_later(
+        assistant_id: permitted_params[:assistant_id],
+        payload: permitted_params[:data]
+      )
+    end
+    head :ok
+  end
+
+  private
+
+  def crawl_page_event?
+    permitted_params[:type] == 'crawl.page'
+  end
+
+  def permitted_params
+    params.permit(
+      :type,
+      :assistant_id,
+      :success,
+      :id,
+      :metadata,
+      :format,
+      :firecrawl,
+      { data: {} }
+    )
+  end
+end

enterprise/app/controllers/super_admin/response_sources_controller.rb

@@ -1,76 +0,0 @@
-class SuperAdmin::ResponseSourcesController < SuperAdmin::EnterpriseBaseController
-  # Overwrite any of the RESTful controller actions to implement custom behavior
-  # For example, you may want to send an email after a foo is updated.
-  #
-  # def update
-  #   super
-  #   send_foo_updated_email(requested_resource)
-  # end
-
-  # Override this method to specify custom lookup behavior.
-  # This will be used to set the resource for the `show`, `edit`, and `update`
-  # actions.
-  #
-  # def find_resource(param)
-  #   Foo.find_by!(slug: param)
-  # end
-
-  # The result of this lookup will be available as `requested_resource`
-
-  # Override this if you have certain roles that require a subset
-  # this will be used to set the records shown on the `index` action.
-  #
-  # def scoped_resource
-  #   if current_user.super_admin?
-  #     resource_class
-  #   else
-  #     resource_class.with_less_stuff
-  #   end
-  # end
-
-  # Override `resource_params` if you want to transform the submitted
-  # data before it's persisted. For example, the following would turn all
-  # empty values into nil values. It uses other APIs such as `resource_class`
-  # and `dashboard`:
-  #
-  # def resource_params
-  #   params.require(resource_class.model_name.param_key).
-  #     permit(dashboard.permitted_attributes(action_name)).
-  #     transform_values { |value| value == "" ? nil : value }
-  # end
-
-  # See https://administrate-demo.herokuapp.com/customizing_controller_actions
-  # for more information
-
-  before_action :set_response_source, only: %i[chat process_chat]
-
-  def chat; end
-
-  def process_chat
-    previous_messages = []
-    get_previous_messages(previous_messages)
-    robin_response = ChatGpt.new(
-      Enterprise::MessageTemplates::ResponseBotService.response_sections(params[:message], @response_source)
-    ).generate_response(
-      params[:message], previous_messages
-    )
-    message_content = robin_response['response']
-    if robin_response['context_ids'].present?
-      message_content += Enterprise::MessageTemplates::ResponseBotService.generate_sources_section(robin_response['context_ids'])
-    end
-    render json: { message: message_content }
-  end
-
-  private
-
-  def get_previous_messages(previous_messages)
-    params[:previous_messages].each do |message|
-      role = message['type'] == 'user' ? 'user' : 'system'
-      previous_messages << { content: message['message'], role: role }
-    end
-  end
-
-  def set_response_source
-    @response_source = requested_resource
-  end
-end