README

这是一个针对 OpenAI API 的非官方 SDK。 OpenAI API 可应用于涉及理解或生成自然语言或代码的几乎所有任务。我们提供一系列不同级别能力的模型，适用于不同的任务，以及自定义模型微调的能力。这些模型可用于从内容生成到语义搜索和分类的各种任务。

SDK 安装

Composer

composer require "speakeasy-sdks/openai-php-sdk"

认证

OpenAI API 使用 API 密钥进行认证。访问您的 API 密钥页面以获取您请求中使用的 API 密钥。

请记住，您的 API 密钥是秘密！ 不要与他人共享，也不要在任何客户端代码（浏览器、应用程序）中暴露。生产请求必须通过您自己的后端服务器路由，您的 API 密钥可以从环境变量或密钥管理服务安全地加载。

所有 API 请求都应该在 Authorization HTTP 头中包含您的 API 密钥，如下所示

Authorization: Bearer YOUR_API_KEY

SDK 示例用法

SDK 可用操作

openAI

• cancelFineTune - 立即取消微调作业。

• createAnswer - 使用提供的文档和示例回答指定的问题。

该端点首先在提供的文档或文件上搜索，以找到相关的上下文。然后将相关的上下文与提供的示例和问题结合起来，以创建用于完成的提示。

• createChatCompletion - 为聊天消息创建完成
• createClassification - 使用提供的示例对指定的 查询 进行分类。

该端点首先搜索标记的示例，以选择与特定查询最相关的示例。然后，将相关的示例与查询结合起来，通过完成端点生成最终标签。

标记的示例可以通过上传的 文件 提供，或者通过在请求中显式列出 examples 参数来快速测试和小规模用例。

• createCompletion - 为提供的提示和参数创建完成

• createEdit - 为提供的输入、指令和参数创建新的编辑。

• createEmbedding - 创建表示输入文本的嵌入向量。

• createFile - 上传包含要用于各种端点/功能的文档的文件。目前，一个组织上传的所有文件的大小可达 1 GB。如果您需要提高存储限制，请与我们联系。

• createFineTune - 从给定的数据集中创建微调指定模型的作业。

响应包括作业的详细信息，包括作业状态和完成后的微调模型名称。

了解更多关于微调的信息

• createImage - 根据提示创建图像。
• createImageEdit - 根据原始图像和提示创建编辑或扩展的图像。
• createImageVariation - 创建给定图像的变体。
• createModeration - 判断文本是否违反 OpenAI 的内容政策
• createSearch - 搜索端点计算提供的查询与文档之间的相似度分数。如果没有超过200个文档，可以直接将文档传递给API。

要超越200个文档的限制，可以在离线处理文档，然后在查询时高效检索。当设置file时，搜索端点将搜索给定文件中的所有文档，并返回最多max_rerank个文档。这些文档将与其搜索分数一起返回。

相似度分数是一个介于0到300之间的正分数（有时可能会更高），其中分数超过200通常表示文档与查询在语义上是相似的。

• createTranscription - 将音频转录成输入语言。

• createTranslation - 将音频翻译成英文。

• deleteFile - 删除一个文件。

• deleteModel - 删除一个微调模型。您必须拥有组织中的所有者角色。

• downloadFile - 返回指定文件的全部内容。

• listEngines - 列出目前可用的（非微调）模型，并提供了每个模型的基本信息，如所有者和可用性。

• listFiles - 返回属于用户组织的文件列表。

• listFineTuneEvents - 获取微调作业的精细状态更新。

• listFineTunes - 列出您组织的微调作业。

• listModels - 列出目前可用的模型，并提供了每个模型的基本信息，如所有者和可用性。

• retrieveEngine - 获取模型实例，提供有关所有者和可用性的基本信息。

• retrieveFile - 返回特定文件的信息。

• retrieveFineTune - 获取微调作业的信息。

了解更多关于微调的信息

• retrieveModel - 获取模型实例，提供有关模型的所有者和权限的基本信息。

由Speakeasy生成的SDK