3b366f43e6
This pull request introduces several changes to implement and manage usage limits for the Captain AI service. The key changes include adding configuration for plan limits, updating error messages, modifying controllers and models to handle usage limits, and updating tests to ensure the new functionality works correctly. ## Implementation Checklist - [x] Ability to configure captain limits per check - [x] Update response for `usage_limits` to include captain limits - [x] Methods to increment or reset captain responses limits in the `limits` column for the `Account` model - [x] Check documents limit using a count query - [x] Ensure Captain hand-off if a limit is reached - [x] Ensure limits are enforced for Copilot Chat - [x] Ensure limits are reset when stripe webhook comes in - [x] Increment usage for FAQ generation and Contact notes - [x] Ensure documents limit is enforced These changes ensure that the Captain AI service operates within the defined usage limits for different subscription plans, providing appropriate error messages and handling when limits are exceeded.
87 lines
2.1 KiB
Ruby
87 lines
2.1 KiB
Ruby
module Captain::ChatHelper
|
|
def search_documentation_tool
|
|
{
|
|
type: 'function',
|
|
function: {
|
|
name: 'search_documentation',
|
|
description: "Use this function to get documentation on functionalities you don't know about.",
|
|
parameters: {
|
|
type: 'object',
|
|
properties: {
|
|
search_query: {
|
|
type: 'string',
|
|
description: 'The search query to look up in the documentation.'
|
|
}
|
|
},
|
|
required: ['search_query']
|
|
}
|
|
}
|
|
}
|
|
end
|
|
|
|
def request_chat_completion
|
|
response = @client.chat(
|
|
parameters: {
|
|
model: @model,
|
|
messages: @messages,
|
|
tools: [search_documentation_tool],
|
|
response_format: { type: 'json_object' }
|
|
}
|
|
)
|
|
|
|
handle_response(response)
|
|
@response
|
|
end
|
|
|
|
def handle_response(response)
|
|
message = response.dig('choices', 0, 'message')
|
|
if message['tool_calls']
|
|
process_tool_calls(message['tool_calls'])
|
|
else
|
|
@response = JSON.parse(message['content'].strip)
|
|
end
|
|
end
|
|
|
|
def process_tool_calls(tool_calls)
|
|
process_tool_call(tool_calls.first)
|
|
end
|
|
|
|
def process_tool_call(tool_call)
|
|
return unless tool_call['function']['name'] == 'search_documentation'
|
|
|
|
query = JSON.parse(tool_call['function']['arguments'])['search_query']
|
|
sections = fetch_documentation(query)
|
|
append_tool_response(sections)
|
|
request_chat_completion
|
|
end
|
|
|
|
def fetch_documentation(query)
|
|
@assistant
|
|
.responses
|
|
.approved
|
|
.search(query)
|
|
.map { |response| format_response(response) }.join
|
|
end
|
|
|
|
def format_response(response)
|
|
formatted_response = "
|
|
Question: #{response.question}
|
|
Answer: #{response.answer}
|
|
"
|
|
if response.documentable.present? && response.documentable.try(:external_link)
|
|
formatted_response += "
|
|
Source: #{response.documentable.external_link}
|
|
"
|
|
end
|
|
|
|
formatted_response
|
|
end
|
|
|
|
def append_tool_response(sections)
|
|
@messages << {
|
|
role: 'assistant',
|
|
content: "Found the following FAQs in the documentation:\n #{sections}"
|
|
}
|
|
end
|
|
end
|