nixos/pay-respects: add aiIntegration option
Signed-off-by: Fernando Rodrigues <alpha@sigmasquadron.net>
This commit is contained in:
parent
fd946aa774
commit
0b329e444e
@ -7,6 +7,7 @@
|
|||||||
let
|
let
|
||||||
inherit (lib)
|
inherit (lib)
|
||||||
getExe
|
getExe
|
||||||
|
isBool
|
||||||
literalExpression
|
literalExpression
|
||||||
maintainers
|
maintainers
|
||||||
mkEnableOption
|
mkEnableOption
|
||||||
@ -15,24 +16,54 @@ let
|
|||||||
mkOption
|
mkOption
|
||||||
mkPackageOption
|
mkPackageOption
|
||||||
optionalString
|
optionalString
|
||||||
|
replaceChars
|
||||||
|
substring
|
||||||
|
toLower
|
||||||
types
|
types
|
||||||
;
|
;
|
||||||
inherit (types) listOf str;
|
inherit (types)
|
||||||
|
bool
|
||||||
|
either
|
||||||
|
listOf
|
||||||
|
str
|
||||||
|
submodule
|
||||||
|
;
|
||||||
|
|
||||||
cfg = config.programs.pay-respects;
|
cfg = config.programs.pay-respects;
|
||||||
|
|
||||||
settingsFormat = pkgs.formats.toml { };
|
settingsFormat = pkgs.formats.toml { };
|
||||||
inherit (settingsFormat) generate type;
|
inherit (settingsFormat) generate type;
|
||||||
|
|
||||||
|
finalPackage =
|
||||||
|
if cfg.aiIntegration != true then
|
||||||
|
(pkgs.runCommand "pay-respects-wrapper"
|
||||||
|
{
|
||||||
|
nativeBuildInputs = [ pkgs.makeBinaryWrapper ];
|
||||||
|
inherit (cfg.package) meta;
|
||||||
|
}
|
||||||
|
''
|
||||||
|
mkdir -p $out/bin
|
||||||
|
makeWrapper ${getExe cfg.package} $out/bin/${cfg.package.meta.mainProgram} \
|
||||||
|
${optionalString (cfg.aiIntegration == false) "--set _PR_AI_DISABLE true"}
|
||||||
|
${optionalString (cfg.aiIntegration != false) ''
|
||||||
|
--set _PR_AI_URL ${cfg.aiIntegration.url} \
|
||||||
|
--set _PR_AI_MODEL ${cfg.aiIntegration.model} \
|
||||||
|
--set _PR_AI_LOCALE ${cfg.aiIntegration.locale}
|
||||||
|
''}
|
||||||
|
''
|
||||||
|
)
|
||||||
|
else
|
||||||
|
cfg.package;
|
||||||
|
|
||||||
initScript =
|
initScript =
|
||||||
shell:
|
shell:
|
||||||
if (shell != "fish") then
|
if (shell != "fish") then
|
||||||
''
|
''
|
||||||
eval $(${getExe cfg.package} ${shell} --alias ${cfg.alias})
|
eval $(${getExe finalPackage} ${shell} --alias ${cfg.alias})
|
||||||
''
|
''
|
||||||
else
|
else
|
||||||
''
|
''
|
||||||
${getExe cfg.package} ${shell} --alias ${cfg.alias} | source
|
${getExe finalPackage} ${shell} --alias ${cfg.alias} | source
|
||||||
'';
|
'';
|
||||||
in
|
in
|
||||||
{
|
{
|
||||||
@ -79,14 +110,69 @@ in
|
|||||||
Each rule module should start with the `command` attribute that specifies the command name. See the [upstream documentation](https://codeberg.org/iff/pay-respects/src/branch/main/rules.md) for more information.
|
Each rule module should start with the `command` attribute that specifies the command name. See the [upstream documentation](https://codeberg.org/iff/pay-respects/src/branch/main/rules.md) for more information.
|
||||||
'';
|
'';
|
||||||
};
|
};
|
||||||
|
aiIntegration = mkOption {
|
||||||
|
default = false;
|
||||||
|
example = {
|
||||||
|
url = "http://127.0.0.1:11434/v1/chat/completions";
|
||||||
|
model = "llama3";
|
||||||
|
locale = "nl-be";
|
||||||
|
};
|
||||||
|
description = ''
|
||||||
|
Whether to enable `pay-respects`' LLM integration. When there is no rule for a given error, `pay-respects` can query an OpenAI-compatible API endpoint for command corrections.
|
||||||
|
|
||||||
|
- If this is set to `false`, all LLM-related features are disabled.
|
||||||
|
- If this is set to `true`, the default OpenAI endpoint will be used, using upstream's API key. This default API key may be rate-limited.
|
||||||
|
- You can also set a custom API endpoint, large language model and locale for command corrections. Simply access the `aiIntegration.url`, `aiIntegration.model` and `aiIntegration.locale` options, as described in the example.
|
||||||
|
- Take a look at the [services.ollama](#opt-services.ollama.enable) NixOS module if you wish to host a local large language model for `pay-respects`.
|
||||||
|
|
||||||
|
For all of these methods, you can set a custom secret API key by using the `_PR_AI_API_KEY` environment variable.
|
||||||
|
'';
|
||||||
|
type = either bool (submodule {
|
||||||
|
options = {
|
||||||
|
url = mkOption {
|
||||||
|
default = "";
|
||||||
|
example = "https://api.openai.com/v1/chat/completions";
|
||||||
|
type = str;
|
||||||
|
description = "The OpenAI-compatible API endpoint that `pay-respects` will query for command corrections.";
|
||||||
|
};
|
||||||
|
model = mkOption {
|
||||||
|
default = "";
|
||||||
|
example = "llama3";
|
||||||
|
type = str;
|
||||||
|
description = "The model used by `pay-respects` to generate command corrections.";
|
||||||
|
};
|
||||||
|
locale = mkOption {
|
||||||
|
default = toLower (replaceChars [ "_" ] [ "-" ] (substring 0 5 config.i18n.defaultLocale));
|
||||||
|
example = "nl-be";
|
||||||
|
type = str;
|
||||||
|
description = ''
|
||||||
|
The locale to be used for LLM responses.
|
||||||
|
The accepted format is a lowercase [`ISO 639-1` language code](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes), followed by a dash '-', followed by a lowercase [`ISO 3166-1 alpha-2` country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
|
||||||
|
'';
|
||||||
|
};
|
||||||
|
};
|
||||||
|
});
|
||||||
|
};
|
||||||
};
|
};
|
||||||
};
|
};
|
||||||
|
|
||||||
config = mkIf cfg.enable {
|
config = mkIf cfg.enable {
|
||||||
|
assertions =
|
||||||
|
map
|
||||||
|
(attr: {
|
||||||
|
assertion = (!isBool cfg.aiIntegration) -> (cfg.aiIntegration.${attr} != "");
|
||||||
|
message = ''
|
||||||
|
programs.pay-respects.aiIntegration is configured as a submodule, but you have not configured a value for programs.pay-respects.aiIntegration.${attr}!
|
||||||
|
'';
|
||||||
|
})
|
||||||
|
[
|
||||||
|
"url"
|
||||||
|
"model"
|
||||||
|
];
|
||||||
environment = mkMerge (
|
environment = mkMerge (
|
||||||
[
|
[
|
||||||
{
|
{
|
||||||
systemPackages = [ cfg.package ];
|
systemPackages = [ finalPackage ];
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
++ map (rule: {
|
++ map (rule: {
|
||||||
|
Loading…
x
Reference in New Issue
Block a user