ssprompt

? ssprompt

簡體中文| English

Change the world, even a little bit.

自從OpenAI 掀起了一輪新的AI 革命，國內外眾多玩家入場接受時代洗禮，一時間LLM 相關技術井噴，而提示工程( prompt engineering )就在其中。
它就像是為大語言模型（LLM）設計的"語言遊戲"。通過這個"遊戲"，我們可以更有效地引導LLM 來處理問題。在真正的通用智能到來前，基於當前的LLM 範式，要充分發揮LLM 的優勢，Prompt 設計越來越複雜化，進一步Prompt 的代碼化，模塊化會越發明顯，同時寫prompt 將會成為AI 時代人的基本技能。
基於此，我構思創作了ssprompt，希望每個人都能利用Prompt，享受AI 時代紅利

Quick Install

系統依賴

Ssprompt requires Python 3.10+

支持多平台使用，滿足廣大Prompt Engineer

pip 安裝

pip install ssprompt

Linux, macOS, Windows (WSL)

curl -sSL https://raw.githubusercontent.com/ptonlix/ssprompt/main/install.py | python3 -

Windows (Powershell)

(Invoke-WebRequest -Uri https://raw.githubusercontent.com/ptonlix/ssprompt/main/install.py -UseBasicParsing).Content | py -

? What it can do?

ssprompt是一個Prompt 分發管理工具，定義了一套Prompt 分發規則支持創建Prompt 工程和拉取Prompt Hub上對應Prompt 的工程文件到本地工程

注：以下為0.5.0 第一版ssprompt 的內容介紹，項目還在持續完善，如有疏漏或不足之處請包涵了解，謝謝~

命令介紹

• ssprompt new -> 新建一個新的Prompt 工程，指定工程目錄，Prompt 類型等參數
• ssprompt init -> 基於當前目錄，引導創建一個Prompt 工程
• ssprompt add -> 添加一個不同Prompt 類型和相關依賴到metafile，並生成相應的Prompt 工程目錄（工程配置文件）
• ssprompt show -> 展示本地Prompt 工程的基本信息（metafile）或拉取PromptHub 上對應工程的信息
• ssprompt pull -> 拉取遠端工程到本地項目中，相關工程可以引用Prompt 文件或代碼
• ssprompt list -> 展示當前版本ssprompt 支持的命令
• ssprompt about -> 展示ssprompt 的介紹和版本信息
• ssprompt version -> 展示ssprompt 的版本信息

更多命令參數詳情，請使用ssprompt [command] -h進一步了解

Metafile 介紹

ssprompt 通過定義prompt 工程的Meta 文件來約束管理Prompt 分發規則和內容
ssprompt 關於prompt 定義了四種類型的Prompt

• Text
• Json
• Yaml
• Python

可以按需生成對應的Prompt 上傳到PromptHub 進行分發
metafile 以Prompt 工程名稱命名,如prompt_project.yaml ，是ssprompt 管理Prompt 分發的關鍵

注：上述類型結合參考了langchain 和haystack

 # Prompt工程基础信息
meta :
  name : open #工程名称
  author :
    - ptonlix <[email protected]>
  description : " "
  license : MIT # Prompt工程遵循的协议
  llm : # Prompt支持的LLM模型
    - gpt-3.5-turbo
  readme_format : md # Readme文件格式
  tag : # Prompt工程相关类型领域，如question-generation common为公共领域
    - common
  version : 0.1.0 #版本号

# Text类型的Prompt
text_prompt :
  dirname : text #目录名称, 默认为text

# Json类型的Prompt
json_prompt :
  dirname : json #目录名称，默认为json
  list : #支持多个json类型子工程
    - dependencies :
        langchain : 0.0.266 # json解析依赖的三方库版本号，如langchain等
      name : example #子工程名，对应生成工程目录名

# Yaml类型的prompt
yaml_prompt :
  dirname : yaml #目录名称，默认为yaml
  list : #支持多个yaml类型子工程
    - dependencies :
        langchain : 0.0.266 # yaml解析依赖的三方库版本号，如langchain等
      name : example #子工程名，对应生成工程目录名

# Python类型的Prompt
python_prompt : #目录名称，默认为yaml
  dirname : python #目录名称，默认为yaml
  list : #支持多个yaml类型子工程
    - dependencies :
        langchain : 0.0.266 # Python库引用的三方库版本号，如langchain等
      name : example #子工程名，对应生成工程目录名

版本依賴規則

當前版本支持三種版本依賴規則

• Caret requirements
  • ^1.2.3
• Tilde requirements
  • ~1.2.3
• Wildcard requirements
  • 1.2.*
• laster
  • 支持最新版本

? PromptHub

目前ssprompt 生成的Prompt 工程，依賴Git 管理，通過Git 將Prompt 工程上傳到Git 倉庫以便ssprompt 拉取引用

當前默認PromptHub 託管在GitHub ptonlix/PromptHub

目前PromptHub 的Prompt 工程還在持續建設中?

後續會陸續收集和建設更多Prompt 工程發佈到我們PromptHub ☁️

? 歡迎大家上傳自己的Prompt 到PromptHub，共建一個開源的Prompt 生態

GitHub Token

由於目前GitHub API 請求訪問限制，不採用authentication 訪問，會限制一個小時只能訪問60 次，導致使用ssprompt 頻繁拉取工程時存在403 限制請求

推薦在使用ssprompt 時，設置GitHub Personal access tokens 到環境變量

 export GITHUB_ACCESS_KEY= ` Your GitHub Token ` 

Roadmap

• 搭建ssprompt 初步框架，完善基本功能
• 完善ssprompt 命令
  • pull 命令支持拉取特定類型Prompt 工程到本地
  • 支持生成默認Prompt 結構化模版
  • show 命令支持展示更多PromptHub 信息
• 搭建和完善PromptHub
  • 收集全網優秀的Prompt 案例，使用ssprompt 構建工程並上傳到PromptHub
• ssprompt 網站與文檔建設
  • ssprompt 說明文檔
  • PromptHub 網站建設

? 項目交流討論

? 掃碼聯繫作者，如果你也對本項目感興趣，歡迎加入ssprompt 項目群參與討論交流。

? 貢獻

歡迎大家貢獻力量，一起共建ssprompt，您可以做任何有益事情

• 報告錯誤
• 建議改進
• 文檔貢獻
• 代碼貢獻
  ...
  ???