promptulate
v1.18.4
英语中文
Prightulate是Cogit Lab制作的AI代理应用程序开发框架，该框架为开发人员提供了一种通过Pythonic开发范式构建代理应用程序的极其简洁，有效的方法。董事会的核心理念是借用和整合开源社区的智慧，结合了各种开发框架的亮点，以降低进入障碍并统一开发人员之间的共识。借助提示，您可以使用最简洁的代码来操纵LLM，Agent，Tool，Tool，Rag等的组件，因为只需几行代码即可轻松完成大多数任务。
pne.chat功能将所有内容都放在您的掌握之中，以封装所有基本功能。下图显示了promptulate的核心体系结构：
启动的核心概念是，我们希望提供一种简单，pythonic且有效的方法来构建AI应用程序，这意味着您无需花费大量时间学习框架。我们希望使用pne.chat()完成大部分工作，您可以轻松地使用几行代码构建任何AI应用程序。
在下面，
pne代表提示，这是提示的昵称。p和e分别代表升降机的开始和结尾，n代表9，这是p和e之间九个字母的速记。
启动集成了Litellm的功能，支持市场上几乎所有类型的大型模型，包括但不限于以下模型：
| 提供者 | 完成 | 流 | 异步完成 | 异步流 | 异步嵌入 | 异步图像生成 |
|---|---|---|---|---|---|---|
| Openai | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| azure | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| AWS -Sagemaker | ✅ | ✅ | ✅ | ✅ | ✅ | |
| AWS-基岩 | ✅ | ✅ | ✅ | ✅ | ✅ | |
| Google -vertex_ai [gemini] | ✅ | ✅ | ✅ | ✅ | ||
| Google -Palm | ✅ | ✅ | ✅ | ✅ | ||
| Google AI Studio -Gemini | ✅ | ✅ | ||||
| Mistral AI API | ✅ | ✅ | ✅ | ✅ | ✅ | |
| Cloudflare AI工人 | ✅ | ✅ | ✅ | ✅ | ||
| 共同 | ✅ | ✅ | ✅ | ✅ | ✅ | |
| 人类 | ✅ | ✅ | ✅ | ✅ | ||
| 拥抱面 | ✅ | ✅ | ✅ | ✅ | ✅ | |
| 复制 | ✅ | ✅ | ✅ | ✅ | ||
| 在一起_ai | ✅ | ✅ | ✅ | ✅ | ||
| OpenRouter | ✅ | ✅ | ✅ | ✅ | ||
| AI21 | ✅ | ✅ | ✅ | ✅ | ||
| 贝特尼 | ✅ | ✅ | ✅ | ✅ | ||
| vllm | ✅ | ✅ | ✅ | ✅ | ||
| NLP_Cloud | ✅ | ✅ | ✅ | ✅ | ||
| Aleph Alpha | ✅ | ✅ | ✅ | ✅ | ||
| 花瓣 | ✅ | ✅ | ✅ | ✅ | ||
| 霍拉马 | ✅ | ✅ | ✅ | ✅ | ||
| Deepinfra | ✅ | ✅ | ✅ | ✅ | ||
| 困惑 | ✅ | ✅ | ✅ | ✅ | ||
| GROQ AI | ✅ | ✅ | ✅ | ✅ | ||
| 任何规模 | ✅ | ✅ | ✅ | ✅ | ||
| 航行AI | ✅ | |||||
| Xinference [Xorbits推论] | ✅ |
PEN的强大模型支持使您可以轻松构建任何第三方模型调用。
现在，让我们看看如何使用PNE运行Ollama的本地Llama3型号。
import promptulate as pne
resp : str = pne . chat ( model = "ollama/llama2" , messages = [{ "content" : "Hello, how are you?" , "role" : "user" }])？ 2024.5.14 Openai推出了他们最新的“ Omni”型号，与Turbo相比，速度和价格提高了。
您可以在任何提示应用程序中使用它的可用多模式功能！
import promptulate as pne
messages = [
{
"role" : "user" ,
"content" : [
{ "type" : "text" , "text" : "What's in this image?" },
{
"type" : "image_url" ,
"image_url" : "https://upload.wikimedia.org/wikipedia/commons/thumb/d/dd/Gfp-wisconsin-madison-the-nature-boardwalk.jpg/2560px-Gfp-wisconsin-madison-the-nature-boardwalk.jpg" ,
},
],
}
]
resp = pne . chat ( model = "gpt-4o" , messages = messages )
print ( resp )使用provider/model_name调用模型，您可以轻松构建任何第三方模型调用。
有关更多型号，请访问Litellm文档。
您还可以在入门/官方文档中查看如何使用pne.chat() 。
构建pne的精简聊天机器人
构建PNE的Gradio Chatbot
用代理构建数学应用程序
Groq，Llama3，简化构建应用程序
使用简化和PNE构建知识图
使用PNE+简化构建聊天机器人与GitHub Repo聊天
使用代理[Steamlit，toolagent，Hooks]构建数学应用程序。
ROS2的MulitModal机器人代理框架，并提示[代理]
使用shatlit和pne比较不同的模型一个操场。 [简化]
GCOP：您的GIT AI副驾驶，基于提示
pip install -U pne注意：您的Python版本应为3.8或更高。
即使PNE提供了许多模块，在90％的LLM应用程序开发方案中，您只需要使用PNE.CHAT（）函数，因此您只需要从聊天开始即可了解PNE的使用，并且当您需要使用其他模块时，您就可以了解更多有关其他模块的功能和使用。
您可以使用pne.chat()像Openai一样聊天。 OpenAI CHAT API文档：https：//platform.openai.com/docs/api-reference/chat
import promptulate as pne
messages = [
{ "role" : "system" , "content" : "You are a helpful assistant." },
{ "role" : "user" , "content" : "Who are you?" },
]
response : str = pne . chat ( messages = messages , model = "gpt-4-turbo" )
print ( response )许多第三方库可以使用OpenAi SDK将其模型称为DeepSeek。在PNE中，您可以直接使用pne.chat()函数来调用这些模型，它不需要使用OpenAI SDK，并提供了增强功能来简化开发难度。使用模型中的openai/xxx提供商前缀，您可以使用OpenAI模型进行呼叫。
import os
import promptulate as pne
os . environ [ "DEEPSEEK_API_KEY" ] = "your api key"
messages = [
{ "role" : "system" , "content" : "You are a helpful assistant." },
{ "role" : "user" , "content" : "How are you?" },
]
response = pne . chat (
messages = messages ,
model = "openai/deepseek-chat" ,
)
print ( response )强大的输出格式是LLM应用程序开发的基本基础。我们希望LLM可以返回稳定的数据。使用PNE，您可以轻松执行格式的输出。在下面的示例中，我们使用Pydantic的基本模型封装了需要返回的数据结构。
from typing import List
import promptulate as pne
from pydantic import BaseModel , Field
class LLMResponse ( BaseModel ):
provinces : List [ str ] = Field ( description = "List of provinces' names" )
resp : LLMResponse = pne . chat ( "Please tell me all provinces in China." , output_schema = LLMResponse )
print ( resp )输出：
provinces=['Anhui', 'Fujian', 'Gansu', 'Guangdong', 'Guizhou', 'Hainan', 'Hebei', 'Heilongjiang', 'Henan', 'Hubei', 'Hunan', 'Jiangsu', 'Jiangxi', 'Jilin', 'Liaoning', 'Qinghai', 'Shaanxi', 'Shandong', 'Shanxi', 'Sichuan', 'Yunnan', 'Zhejiang', 'Taiwan', 'Guangxi', 'Nei Mongol', 'Ningxia', 'Xinjiang', 'Xizang', 'Beijing', 'Chongqing', 'Shanghai', 'Tianjin', 'Hong Kong', 'Macao']
此外，受计划和解决论文的影响，PNE还允许开发人员构建能够通过计划，推理和行动来处理复杂问题的代理。可以使用enable_plan参数激活代理的计划能力。
在此示例中，我们将Tavely用作搜索引擎，这是用于在网络上搜索信息的强大工具。要使用Tavily，您需要从Tavily获取API键。
import os
os . environ [ "TAVILY_API_KEY" ] = "your_tavily_api_key"
os . environ [ "OPENAI_API_KEY" ] = "your_openai_api_key"在这种情况下，我们正在使用Langchain包裹的TavilySearchResults工具。
from langchain_community . tools . tavily_search import TavilySearchResults
tools = [ TavilySearchResults ( max_results = 5 )] import promptulate as pne
pne . chat ( "what is the hometown of the 2024 Australia open winner?" , model = "gpt-4-1106-preview" , enable_plan = True )输出：
[Agent] Assistant Agent start...
[User instruction] what is the hometown of the 2024 Australia open winner?
[Plan] {"goals": ["Find the hometown of the 2024 Australian Open winner"], "tasks": [{"task_id": 1, "description": "Identify the winner of the 2024 Australian Open."}, {"task_id": 2, "description": "Research the identified winner to find their place of birth or hometown."}, {"task_id": 3, "description": "Record the hometown of the 2024 Australian Open winner."}], "next_task_id": 1}
[Agent] Tool Agent start...
[User instruction] Identify the winner of the 2024 Australian Open.
[Thought] Since the current date is March 26, 2024, and the Australian Open typically takes place in January, the event has likely concluded for the year. To identify the winner, I should use the Tavily search tool to find the most recent information on the 2024 Australian Open winner.
[Action] tavily_search_results_json args: {'query': '2024 Australian Open winner'}
[Observation] [{'url': 'https://ausopen.com/articles/news/sinner-winner-italian-takes-first-major-ao-2024', 'content': 'The agile right-hander, who had claimed victory from a two-set deficit only once previously in his young career, is the second Italian man to achieve singles glory at a major, following Adriano Panatta in1976.With victories over Andrey Rublev, 10-time AO champion Novak Djokovic, and Medvedev, the Italian is the youngest player to defeat top 5 opponents in the final three matches of a major since Michael Stich did it at Wimbledon in 1991 – just weeks before Sinner was born.n He saved the only break he faced with an ace down the tee, and helped by scoreboard pressure, broke Medvedev by slamming a huge forehand to force an error from his more experienced rival, sealing the fourth set to take the final to a decider.n Sensing a shift in momentum as Medvedev served to close out the second at 5-3, Sinner set the RLA crowd alight with a pair of brilliant passing shots en route to creating a break point opportunity, which Medvedev snuffed out with trademark patience, drawing a forehand error from his opponent. “We are trying to get better every day, even during the tournament we try to get stronger, trying to understand every situation a little bit better, and I’m so glad to have you there supporting me, understanding me, which sometimes it’s not easy because I am a little bit young sometimes,” he said with a smile.n Medvedev, who held to love in his first three service games of the second set, piled pressure on the Italian, forcing the right-hander to produce his best tennis to save four break points in a nearly 12-minute second game.n'}, {'url': 'https://www.cbssports.com/tennis/news/australian-open-2024-jannik-sinner-claims-first-grand-slam-title-in-epic-comeback-win-over-daniil-medvedev/', 'content': '"nOur Latest Tennis StoriesnSinner makes epic comeback to win Australian OpennSinner, Sabalenka win Australian Open singles titlesn2024 Australian Open odds, Sinner vs. Medvedev picksnSabalenka defeats Zheng to win 2024 Australian Openn2024 Australian Open odds, Sabalenka vs. Zheng picksn2024 Australian Open odds, Medvedev vs. Zverev picksnAustralian Open odds: Djokovic vs. Sinner picks, betsnAustralian Open odds: Gauff vs. Sabalenka picks, betsnAustralian Open odds: Zheng vs. Yastremska picks, betsnNick Kyrgios reveals he's contemplating retirementn© 2004-2024 CBS Interactive. Jannik Sinner claims first Grand Slam title in epic comeback win over Daniil MedvedevnSinner, 22, rallied back from a two-set deficit to become the third ever Italian Grand Slam men's singles championnAfter almost four hours, Jannik Sinner climbed back from a two-set deficit to win his first ever Grand Slam title with an epic 3-6, 3-6, 6-4, 6-4, 6-3 comeback victory against Daniil Medvedev. Sinner became the first Italian man to win the Australian Open since 1976, and just the eighth man to successfully come back from two sets down in a major final.n He did not drop a single set until his meeting with Djokovic, and that win in itself was an accomplishment as Djokovic was riding a 33-match winning streak at the Australian Open and had never lost a semifinal in Melbourne.n @janniksin • @wwos • @espn • @eurosport • @wowowtennis pic.twitter.com/DTCIqWoUoRn"We are trying to get better everyday, and even during the tournament, trying to get stronger and understand the situation a little bit better," Sinner said.'}, {'url': 'https://www.bbc.com/sport/tennis/68120937', 'content': 'Live scores, results and order of playnAlerts: Get tennis news sent to your phonenRelated TopicsnTop StoriesnFA Cup: Blackburn Rovers v Wrexham - live text commentarynRussian skater Valieva given four-year ban for dopingnLinks to Barcelona are 'totally untrue' - ArtetanElsewhere on the BBCnThe truth behind the fake grooming scandalnFeaturing unseen police footage and interviews with the officers at the heart of the casenDid their father and uncle kill Nazi war criminals?n A real-life murder mystery following three brothers in their quest for the truthnWhat was it like to travel on the fastest plane?nTake a behind-the-scenes look at the supersonic story of the ConcordenToxic love, ruthless ambition and shocking betrayalnTell Me Lies follows a passionate college relationship with unimaginable consequences...n "nMarathon man Medvedev runs out of steamnMedvedev is the first player to lose two Grand Slam finals after winning the opening two setsnSo many players with the experience of a Grand Slam final have talked about how different the occasion can be, particularly if it is the first time, and potentially overwhelming.n Jannik Sinner beats Daniil Medvedev in Melbourne finalnJannik Sinner is the youngest player to win the Australian Open men's title since Novak Djokovic in 2008nJannik Sinner landed the Grand Slam title he has long promised with an extraordinary fightback to beat Daniil Medvedev in the Australian Open final.n "nSinner starts 2024 in inspired formnSinner won the first Australian Open men's final since 2005 which did not feature Roger Federer, Rafael Nadal or Novak DjokovicnSinner was brought to the forefront of conversation when discussing Grand Slam champions in 2024 following a stunning end to last season.n'}]
[Execute Result] {'thought': "The search results have provided consistent information about the winner of the 2024 Australian Open. Jannik Sinner is mentioned as the winner in multiple sources, which confirms the answer to the user's question.", 'action_name': 'finish', 'action_parameters': {'content': 'Jannik Sinner won the 2024 Australian Open.'}}
[Execute] Execute End.
[Revised Plan] {"goals": ["Find the hometown of the 2024 Australian Open winner"], "tasks": [{"task_id": 2, "description": "Research Jannik Sinner to find his place of birth or hometown."}, {"task_id": 3, "description": "Record the hometown of Jannik Sinner, the 2024 Australian Open winner."}], "next_task_id": 2}
[Agent] Tool Agent start...
[User instruction] Research Jannik Sinner to find his place of birth or hometown.
[Thought] To find Jannik Sinner's place of birth or hometown, I should use the search tool to find the most recent and accurate information.
[Action] tavily_search_results_json args: {'query': 'Jannik Sinner place of birth hometown'}
[Observation] [{'url': 'https://www.sportskeeda.com/tennis/jannik-sinner-nationality', 'content': "During the semifinal of the Cup, Sinner faced Djokovic for the third time in a row and became the first player to defeat him in a singles match. Jannik Sinner NationalitynJannik Sinner is an Italian national and was born in Innichen, a town located in the mainly German-speaking area of South Tyrol in northern Italy. A. Jannik Sinner won his maiden Masters 1000 title at the 2023 Canadian Open defeating Alex de Minaur in the straight sets of the final.n Apart from his glorious triumph at Melbourne Park in 2024, Jannik Sinner's best Grand Slam performance came at the 2023 Wimbledon, where he reached the semifinals. In 2020, Sinner became the youngest player since Novak Djokovic in 2006 to reach the quarter-finals of the French Open."}, {'url': 'https://en.wikipedia.org/wiki/Jannik_Sinner', 'content': "At the 2023 Australian Open, Sinner lost in the 4th round to eventual runner-up Stefanos Tsitsipas in 5 sets.[87]nSinner then won his seventh title at the Open Sud de France in Montpellier, becoming the first player to win a tour-level title in the season without having dropped a single set and the first since countryman Lorenzo Musetti won the title in Naples in October 2022.[88]nAt the ABN AMRO Open he defeated top seed and world No. 3 Stefanos Tsitsipas taking his revenge for the Australian Open loss, for his biggest win ever.[89] At the Cincinnati Masters, he lost in the third round to Félix Auger-Aliassime after being up a set, a break, and 2 match points.[76]nSeeded 11th at the US Open, he reached the fourth round after defeating Brandon Nakashima in four sets.[77] Next, he defeated Ilya Ivashka in a five set match lasting close to four hours to reach the quarterfinals for the first time at this Major.[78] At five hours and 26 minutes, it was the longest match of Sinner's career up until this point and the fifth-longest in the tournament history[100] as well as the second longest of the season after Andy Murray against Thanasi Kokkinakis at the Australian Open.[101]nHe reached back to back quarterfinals in Wimbledon after defeating Juan Manuel Cerundolo, Diego Schwartzman, Quentin Halys and Daniel Elahi Galan.[102] He then reached his first Major semifinal after defeating Roman Safiullin, before losing to Novak Djokovic in straight sets.[103] In the following round in the semifinals, he lost in straight sets to career rival and top seed Carlos Alcaraz who returned to world No. 1 following the tournament.[92] In Miami, he reached the quarterfinals of this tournament for a third straight year after defeating Grigor Dimitrov and Andrey Rublev, thus returning to the top 10 in the rankings at world No. In the final, he came from a two-set deficit to beat Daniil Medvedev to become the first Italian player, male or female, to win the Australian Open singles title, and the third man to win a Major (the second of which is in the Open Era), the first in 48 years.[8][122]"}, {'url': 'https://www.thesportreview.com/biography/jannik-sinner/', 'content': '• Date of birth: 16 August 2001n• Age: 22 years oldn• Place of birth: San Candido, Italyn• Nationality: Italiann• Height: 188cm / 6ft 2insn• Weight: 76kg / 167lbsn• Plays: Right-handedn• Turned Pro: 2018n• Career Prize Money: US$ 4,896,338n• Instagram: @janniksinnThe impressive 22-year-old turned professional back in 2018 and soon made an impact on the tour, breaking into the top 100 in the world rankings for the first time in 2019.n Jannik Sinner (Photo: Dubai Duty Free Tennis Championships)nSinner ended the season as number 78 in the world, becoming the youngest player since Rafael Nadal in 2003 to end the year in the top 80.n The Italian then ended the 2019 season in style, qualifying for the 2019 Next Gen ATP Finals and going on to win the tournament with a win over Alex de Minaur in the final.n Sinner then reached the main draw of a grand slam for the first time at the 2019 US Open, when he came through qualifying to reach the first round, where he lost to Stan Wawrinka.n Asked to acknowledge some of the key figures in his development, Sinner replied: “I think first of all, my family who always helped me and gave me the confidence to actually change my life when I was 13-and-a-half, 14 years old.n'}]
[Execute Result] {'thought': 'The search results have provided two different places of birth for Jannik Sinner: Innichen and San Candido. These are actually the same place, as San Candido is the Italian name and Innichen is the German name for the town. Since the user asked for the place of birth or hometown, I can now provide this information.', 'action_name': 'finish', 'action_parameters': {'content': 'Jannik Sinner was born in San Candido (Italian) / Innichen (German), Italy.'}}
[Execute] Execute End.
[Revised Plan] {"goals": ["Find the hometown of the 2024 Australian Open winner"], "tasks": [], "next_task_id": null}
[Agent Result] Jannik Sinner was born in San Candido (Italian) / Innichen (German), Italy.
[Agent] Agent End.
在代理开发的情况下，我们通常需要分割许多代理的原子成分，以实现更好的自定义。 PNE提供了雾化代理组件，例如计划者。以下示例显示了使用单独的计划者组件进行任务计划。
import promptulate as pne
model = pne . LLMFactory . build ( "gpt-4-turbo" )
planner = pne . Planner ( model , system_prompt = "You are a planner" )
plans = planner . run ( "Plan a trip to Paris" )
print ( plans )输出：
('goals', ['Plan a trip to Paris'])
('tasks', [Task(task_id=1, description='Check passport validity', status=<TaskStatus.TODO: 'todo'>), Task(task_id=2, description='Determine travel dates', status=<TaskStatus.TODO: 'todo'>), Task(task_id=3, description='Research and book flights', status=<TaskStatus.TODO: 'todo'>), Task(task_id=4, description='Book accommodations', status=<TaskStatus.TODO: 'todo'>), Task(task_id=5, description='Plan itinerary for the trip', status=<TaskStatus.TODO: 'todo'>), Task(task_id=6, description='Investigate and purchase travel insurance', status=<TaskStatus.TODO: 'todo'>), Task(task_id=7, description='Set a budget for the trip', status=<TaskStatus.TODO: 'todo'>), Task(task_id=8, description='Pack luggage', status=<TaskStatus.TODO: 'todo'>), Task(task_id=9, description='Notify bank of international travel', status=<TaskStatus.TODO: 'todo'>), Task(task_id=10, description='Check weather forecast and pack accordingly', status=<TaskStatus.TODO: 'todo'>)])
('next_task_id', 1)
有关更多详细信息，请检查入门/官方文档。
PNE框架的设计原理包括模块化，可扩展性，互操作性，鲁棒性，可维护性，安全性，效率和可用性。
遵循这些原则并应用最新的人工智能技术， pne目的是为创建自动化代理提供一个强大而灵活的框架。
有关更多信息，请联系：[email protected]
查看任何变换的内容，描述电报频道
我们感谢您有兴趣为我们的开源计划做出贡献。我们为开发人员提供了指南，概述了为提示做出贡献的步骤。请参阅本指南，以确保平稳的协作和成功的贡献。此外，您可以查看当前的开发计划以查看最新的发展进展吗？
