Skip to content

Commit

Permalink
feat: add platform info to the system prompt (#171)
Browse files Browse the repository at this point in the history
* feat: create a system info prompt

* fix: update the prompt

* chore: remove trailing comma in prompt

* feat: remove redundant platform specification

* Update gptme/prompts.py

Co-authored-by: Erik Bjäreholt <[email protected]>

* Update gptme/prompts.py

Co-authored-by: Erik Bjäreholt <[email protected]>

* feat: compile regex

---------

Co-authored-by: Erik Bjäreholt <[email protected]>
  • Loading branch information
0xbrayo and ErikBjare authored Oct 29, 2024
1 parent cdce637 commit 0288d33
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 2 deletions.
41 changes: 40 additions & 1 deletion gptme/prompts.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@
"""

import logging
import re
import os
import platform
import subprocess
from collections.abc import Generator, Iterable
from typing import Literal
Expand Down Expand Up @@ -56,6 +58,7 @@ def prompt_full(interactive: bool) -> Generator[Message, None, None]:
if interactive:
yield from prompt_user()
yield from prompt_project()
yield from prompt_systeminfo()


def prompt_short(interactive: bool) -> Generator[Message, None, None]:
Expand All @@ -81,7 +84,7 @@ def prompt_gptme(interactive: bool) -> Generator[Message, None, None]:

base_prompt = f"""
You are gptme v{__version__}, a general-purpose AI assistant powered by LLMs.
You are designed to help users with programming tasks, such as writing code, debugging, and learning new concepts.
You are designed to help users with programming tasks, such as writing code, debugging and learning new concepts.
You can run code, execute terminal commands, and access the filesystem on the local machine.
You will help the user with writing code, either from scratch or in existing projects.
You will think step by step when solving a problem, in <thinking> tags.
Expand Down Expand Up @@ -209,7 +212,43 @@ def prompt_tools(examples: bool = True) -> Generator[Message, None, None]:
yield Message("system", prompt.strip() + "\n\n")


def prompt_systeminfo() -> Generator[Message, None, None]:
"""Generate the system information prompt."""
if platform.system() == "Linux":
os_info = get_system_distro()
os_version = platform.uname().release
elif platform.system() == "Windows":
os_info = "Windows"
os_version = platform.version()
elif platform.system() == "Darwin":
os_info = "macOS"
os_version = platform.mac_ver()[0]
else:
os_info = "unknown"
os_version = ""

prompt = f"## System Information\n\n**OS:** {os_info} {os_version}".strip()

yield Message(
"system",
prompt,
)


def get_system_distro() -> str:
"""Get the system distribution name."""
regex = re.compile(r"^NAME=\"?([^\"]+)\"?")
if os.path.exists("/etc/os-release"):
with open("/etc/os-release") as f:
for line in f:
matches = re.search(regex, line)
if matches:
return matches.string[matches.start(1) : matches.end(1)]
return "Linux"


document_prompt_function(interactive=True)(prompt_gptme)
document_prompt_function()(prompt_user)
document_prompt_function()(prompt_project)
document_prompt_function()(prompt_tools)
document_prompt_function()(prompt_systeminfo)
1 change: 0 additions & 1 deletion gptme/tools/shell.py
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,6 @@ def get_installed_programs() -> set[str]:
When you send a message containing bash code, it will be executed in a stateful bash shell.
The shell will respond with the output of the execution.
Do not use EOF/HereDoc syntax to send multiline commands, as the assistant will not be able to handle it.
{'The platform is macOS.' if is_macos else ''}
These programs are available, among others:
{shell_programs_str}
Expand Down

0 comments on commit 0288d33

Please sign in to comment.