prompt-layer-library

项目介绍：PromptLayer

PromptLayer 是一个专门为提示工程师（prompt engineer）设计的平台，为用户提供了一种便捷的方法来跟踪、管理和共享其使用 GPT 的提示技术。作为中间件，PromptLayer 位于你的代码和 OpenAI 的 Python 库之间，负责记录用户所有的 OpenAI API 请求，允许用户在 PromptLayer 仪表板中搜索和探索请求历史。

安装和使用

安装 PromptLayer

要开始使用 PromptLayer，用户首先需要通过 pip 命令安装：

pip install promptlayer

本地安装 PromptLayer

通过 pip install . 来进行本地安装。

快速开始

1. 用户需要在 PromptLayer 官网 注册一个账户。登录后，生成一个 API 密钥，并妥善保管。

2. 按指引安装 PromptLayer。

3. 在需要使用 OpenAI API 的 Python 文件中，导入 PromptLayer。通过以下代码设置，这样即可开始记录请求，无需更改其他代码：

   from promptlayer import PromptLayer
   
   promptlayer = PromptLayer(api_key="<YOUR PromptLayer API KEY pl_xxxxxx>")
   openai = promptlayer.openai

用户可以像直接导入 OpenAI 一样使用 openai，而且您的 OpenAI API 密钥不会被发送到 PromptLayer 的服务器，所有请求都是在用户本地机上完成的。

添加标签：pl_tags

PromptLayer 允许用户利用 pl_tags 参数添加标签。这些标签有助于在仪表板中跟踪和分组请求。尽管标签不是必需的，但建议使用标签以更好地管理请求。

openai.Completion.create(
  engine="text-ada-001", 
  prompt="My name is", 
  pl_tags=["name-guessing", "pipeline-2"]
)

完成请求后，用户可以在 PromptLayer 仪表板中查看其历史记录。

使用 REST API

PromptLayer 提供的 Python 库是其 REST API 的封装。如果用户使用其他语言（如 JavaScript），可以直接与 API 交互。以下为示例请求：

import requests
request_response = requests.post(
  "https://api.promptlayer.com/track-request",
  json={
    "function_name": "openai.Completion.create",
    "args": [],
    "kwargs": {"engine": "text-ada-001", "prompt": "My name is"},
    "tags": ["hello", "world"],
    "request_response": {"id": "cmpl-6TEeJCRVlqQSQqhD8CYKd1HdCcFxM", "object": "text_completion", "created": 1672425843, "model": "text-ada-001", "choices": [{"text": " advocacy\"\n\nMy name is advocacy.", "index": 0, "logprobs": None, "finish_reason": "stop"}]},
    "request_start_time": 1673987077.463504,
    "request_end_time": 1673987077.463504,
    "api_key": "pl_<YOUR API KEY>",
  },
)

贡献

PromptLayer 欢迎用户对其开源项目的贡献，包括新功能的开发、基础设施改进和文档完善。若有更多信息需求或其他疑问，可以通过 hello@promptlayer.com 联系团队。