mirror of
https://github.com/fleetdm/fleet
synced 2026-05-22 16:39:01 +00:00
044e59c7e7
Changes: - Updated the prompt helper to accept a new input: `systemPrompt`, if provided and a supported baseModel is selected, the system prompt will be included in the Open AI API request along with the prompt. - Updated the models used by the query generator to improve the speed of query generation.
80 lines
3 KiB
JavaScript
Vendored
80 lines
3 KiB
JavaScript
Vendored
module.exports = {
|
|
|
|
|
|
friendlyName: 'Prompt',
|
|
|
|
|
|
description: 'Prompt a large language model (LLM).',
|
|
|
|
|
|
inputs: {
|
|
prompt: { type: 'string', required: true, example: 'Who is running macOS 15?' },
|
|
baseModel: { type: 'string', defaultsTo: 'gpt-3.5-turbo', isIn: ['gpt-3.5-turbo', 'gpt-4o', 'o1-preview', 'o3-mini-2025-01-31', 'gpt-4o-2024-08-06', 'gpt-4o-mini-2024-07-18'] },
|
|
expectJson: { type: 'boolean', defaultsTo: false },
|
|
systemPrompt: { type: 'string', example: 'Who is running macOS 15?' },
|
|
},
|
|
|
|
|
|
exits: {
|
|
|
|
success: {
|
|
description: 'All done.',
|
|
outputDescription: 'The output from the model, parsed as JSON, if appropriate.',
|
|
outputExample: '*',
|
|
},
|
|
|
|
},
|
|
|
|
|
|
fn: async function ({prompt, baseModel, expectJson, systemPrompt}) {
|
|
|
|
if (!sails.config.custom.openAiSecret) {
|
|
throw new Error('sails.config.custom.openAiSecret not set.');
|
|
}//•
|
|
|
|
// The base model to use. https://platform.openai.com/docs/models/o1
|
|
let failureMessage = 'Failed to generate result via generative AI.';// Fallback message in case LLM API request fails.
|
|
|
|
let JSON_PROMPT_SUFFIX = `
|
|
|
|
Please do not add any text outside of the JSON report or wrap it in a code fence. Never use newline characters within double quotes.`;
|
|
let messages = [];
|
|
// If a systemPrompt was provided, add that as the first item in the messages array.
|
|
if(systemPrompt){
|
|
// If the specified baseModel does not support system prompts, log a wanring and ignore the system prompt.
|
|
if(['o1-preview', 'o3-mini-2025-01-31'].includes(baseModel)){
|
|
sails.log.warn(`Warning: the prompt helper recieved a system prompt input, but the specified baseModel (${baseModel}) does not support a system prompt. This input will be ignored in this LLM generation, please remove the system prompt or use a different base model.`);
|
|
} else {
|
|
messages.push({ role: 'system', content: systemPrompt });
|
|
}
|
|
}
|
|
// Add the user prompt to the messages.
|
|
messages.push({role: 'user', content: prompt+(expectJson? JSON_PROMPT_SUFFIX : '')});
|
|
// [?] API: https://platform.openai.com/docs/api-reference/chat/create
|
|
let openAiResponse = await sails.helpers.http.post('https://api.openai.com/v1/chat/completions', {
|
|
model: baseModel,
|
|
messages: messages,
|
|
}, {
|
|
Authorization: `Bearer ${sails.config.custom.openAiSecret}`
|
|
})
|
|
.intercept((err)=>{
|
|
return new Error(failureMessage+' Error details from LLM: '+err.stack);
|
|
});
|
|
|
|
let rawResult = openAiResponse.choices[0].message.content;
|
|
if (!expectJson) {
|
|
return rawResult;
|
|
} else {
|
|
let parsedResult;
|
|
try {
|
|
parsedResult = JSON.parse(rawResult);
|
|
} catch (err) {
|
|
throw new Error('When trying to parse a JSON result returned from the Open AI API, an error occurred. Error details from JSON.parse: '+err.stack+'\n Here is what was returned from Open AI:'+openAiResponse.choices[0].message.content);
|
|
}
|
|
return parsedResult;
|
|
}
|
|
}
|
|
|
|
|
|
};
|
|
|