Älyverkko CLI application

Problem Statement:

Analyze a set of customer reviews to determine overall sentiment and extract key features that customers appreciate or dislike about a product.

Usage Procedure:

1. User collects customer reviews in plain text format within the configured mail directory. Lets say, about 150 kilobytes of reviews per input file (this is dictated by AI model available context size).
2. Each review file is prefixed with "TOCOMPUTE:".
3. The Älyverkko CLI application processes these files, generating sentiment analysis results and feature extraction insights.
4. Results are appended to the original files in org-mode syntax, indicating AI responses.

Problem Statement:

Generate code snippets for a new software module based on detailed specifications provided by the developer.

Usage Procedure:

1. Developer writes specifications in a text file within the mail directory, prefixed with "TOCOMPUTE:". Text file also contains relevant parts of the program source code and documentation. Älyverkko CLI joinfiles subcommand can be used to facilitate such text file preparation.
2. The Älyverkko CLI application processes this file and generates the corresponding code snippets. The generated code is appended to the original specifications file, organized using org-mode syntax.
3. Developer can review proposed changes and then integrate them back into original program source code.

Note: Most of the Älyverkko CLI program code is written in such a way by AI. This script is used to facilitate the process.

Problem Statement:

Draft an outline for a book on science fiction and improve its plot.

Usage Procedure:

1. The book author writes a brief describing the outline of the plot and his book main idea for the novel.
2. Älyverkko CLI processes this description and generates an outline with suggested headings and suggests possible improvements to the plot.
3. The AI-generated outline is appended to the original brief, formatted using org-mode syntax.

To use the joinfiles command, specify the source directory containing the files you wish to join and a topic name that will be used to generate the output file name:

alyverkko-cli joinfiles -s /path/to/source/directory -t "my_topic"

If desired, you can also specify a glob pattern to match only certain files within the directory:

alyverkko-cli joinfiles -s /path/to/source/directory -p "*.java" -t "my_topic"

After joining the files, you can choose to open the resulting document in text editor for further editing or review:

alyverkko-cli joinfiles -t "my_topic" --edit

• -s, –src-dir: Specifies the source directory from which to join files.
• -p, –pattern: An optional glob pattern to match specific files within the source directory.
• -t, –topic: The topic name that will be used as a basis for the output file name and should reflect the subject matter of the joined content.
• -e, –edit: Opens the joined file in text editor after the join operation is complete.

Imagine you have a software project with various source files that you want to analyze using AI. You can use the joinfiles command to create a single document for processing:

alyverkko-cli joinfiles -s /path/to/project -p "*.java" -t "software_analysis" --edit

This will recursively search the project directory for Java source files, aggregate their contents into a file named software_analysis.org (within AI processor input files directory), and open text editor on the file, so that you can add your analysis instructions or problem statement. Finally you Initiate AI processing and after some time, you will get results and the end of the file.

The Elisp function ai-new-topic facilitates the creation and opening of a new Org-mode file dedicated to a user-defined topic within a specified directory. Now you can use this file within emacs to compose you problem statement to AI.

When ai-new-topic function triggered, it first prompts the user to input a topic name. This name will serve as the basis for the filename and the title within the document.

The function then constructs a file path by concatenating the pre-defined alyverkko-topic-files-directory (which should be set to your topics directory), the topic name, and the .org extension. If a file with this path does not already exist, the function will create a new file and open it for editing.

(defvar alyverkko-topic-files-directory "/home/user/my-ai-mail-directory/"
  "Directory where topic files are stored.")

(defun alyverkko-new-topic ()
  "Create and open a topic file in the specified directory."
  (interactive)
  (let ((topic (read-string "Enter topic name: ")))
    (let ((file-path (concat alyverkko-topic-files-directory topic ".org")))
      (if (not (file-exists-p file-path))
          (with-temp-file file-path
            ))
      (find-file file-path)
      (goto-char (point-max))
      (org-mode))))

The function alyverkko-compute is designed to enhance the workflow of users working with the Älyverkko CLI application by automating the process of marking text files for computation with a specific AI model and prompt.

When function is invoked, it detects available prompts and allows user to select one.

Thereafter function detects available models from Älyverkko CLI configuration file and allows user to select one.

Finally function inserts at the beginning of currently opened file something like this:

TOCOMPUTE: prompt=<user-chosen-prompt> model=<user-chosen-model>

• Adjust prompt-dir variable to point to your prompts directory.
• Adjust config-file variable to point to your Älyverkko CLI configuration file path.

(defun alyverkko-compute ()
  "Select a prompt and a model interactively, then insert them at the
   beginning of the current buffer."
  (interactive)
  (let ((prompt-dir "~/.config/alyverkko-cli/prompts/")
        (config-file "~/.config/alyverkko-cli/alyverkko-cli.yaml")
        (models '())
        )

    (with-temp-buffer
        (insert-file-contents config-file)
        ;; Move to the beginning of the prompts section
        (goto-char (point-min))
        (when (search-forward-regexp "^models:" nil t)
          ;; Collect all aliases
          (while (search-forward-regexp "^\\s-+- alias: \"\\([^\"]+\\)\"" nil t)
            (push (match-string 1) models))))

    (if (file-exists-p prompt-dir)
        (let* ((files (directory-files prompt-dir t "\\`[^.].*\\.txt\\'"))
               (aliases (mapcar (lambda (f) (file-name-base f)) files)))
          (if aliases
              (let ((selected-alias (completing-read "Select prompt alias: " aliases))
                    (model (completing-read "Select AI model: "              models)))
                (alyverkko-insert-tocompute-line selected-alias model))
            (message "No prompt files found.")))
      (message "Prompt directory not found."))))

(defun alyverkko-insert-tocompute-line (prompt-alias model)
  "Inserts TOCOMPUTE line with selected PROMPT-ALIAS and MODEL at the
   beginning of the buffer."
  (save-excursion
    (goto-char (point-min))
    (insert (format "TOCOMPUTE: prompt=%s model=%s\n" prompt-alias model))
    (save-buffer)))