1 个稳定版本

1.1.0	2023 年 1 月 12 日

在 #采样中排名 #30

MIT 许可证

150KB
2K SLoC

openai-rs 的 Rust API 客户端

语言模型的采样和微调 API

概述

此 API 客户端由 OpenAPI Generator 项目生成。通过使用远程服务器上的 openapi-spec，您可以轻松地生成 API 客户端。

API 版本：1.1.0
包版本：1.1.0
构建包：org.openapitools.codegen.languages.RustClientCodegen

安装

将包放在名为 openapi-rs 的目录下，并在 Cargo.toml 下的 [dependencies] 中添加以下内容：

openapi-rs = { path = "./openapi-rs" }

API 端点文档

所有 URI 都相对于 https://api.openai.com/v1

类	方法	HTTP 请求	描述
OpenAiApi	cancel_fine_tune	POST /fine-tunes/{fine_tune_id}/cancel	立即取消微调作业。
OpenAiApi	create_answer	POST /answers	使用提供的文档和示例回答指定的问题。端点首先搜索提供的文档或文件以找到相关上下文。然后将相关上下文与提供的示例和问题结合，以创建用于完成的提示。
OpenAiApi	create_classification	POST /classifications	使用提供的示例对指定的 `query` 进行分类。端点首先搜索标记的示例以选择与特定查询最相关的示例。然后，将相关示例与查询结合，以通过完成端点生成最终标签。标记的示例可以通过上传的 `file` 提供，或者通过使用 `examples` 参数明确列出以进行快速测试和小规模用例。
OpenAiApi	create_completion	POST /completions	为提供的提示和参数创建完成
OpenAiApi	create_edit	POST /edits	为提供的输入、指令和参数创建新的编辑
OpenAiApi	create_embedding	POST /embeddings	创建表示输入文本的嵌入向量。
OpenAiApi	create_file	POST /files	上传包含文档的文件，以用于各种端点/功能。目前，一个组织上传的所有文件的总大小可达1 GB。如需提高存储限制，请联系我们。
OpenAiApi	create_fine_tune	POST /fine-tunes	创建一个作业，从给定的数据集中微调指定的模型。响应包括作业的详细信息，包括作业状态和完成后的微调模型名称。[了解更多关于微调](https://github.com/docs/guides/fine-tuning)
OpenAiApi	create_image	POST /images/generations	根据提示创建图像。
OpenAiApi	create_image_edit	POST /images/edits	根据原始图像和提示创建编辑或扩展的图像。
OpenAiApi	create_image_variation	POST /images/variations	创建给定图像的变体。
OpenAiApi	create_moderation	POST /moderations	判断文本是否违反OpenAI的内容政策。
OpenAiApi	create_search	POST /engines/{engine_id}/search	搜索端点计算提供的查询与文档之间的相似度分数。如果文档数量不超过200个，可以直接传递给API。要超出200个文档的限制，可以在离线处理文档，然后在查询时间进行高效检索。当设置`file`时，搜索端点将搜索给定文件中的所有文档，并返回最多`max_rerank`个文档。这些文档将与其搜索分数一起返回。相似度分数是一个通常在0到300之间（有时会更高）的积极分数，其中分数高于200通常意味着文档与查询在语义上是相似的。
OpenAiApi	delete_file	DELETE /files/{file_id}	删除文件。
OpenAiApi	delete_model	DELETE /models/{model}	删除微调模型。您必须拥有组织中的所有者角色。
OpenAiApi	download_file	GET /files/{file_id}/content	返回指定文件的正文。
OpenAiApi	list_engines	GET /engines	列出当前可用的（非微调）模型，并提供每个模型的基本信息，例如所有者和可用性。
OpenAiApi	list_files	GET /files	返回属于用户组织的文件列表。
OpenAiApi	list_fine_tune_events	GET /fine-tunes/{fine_tune_id}/events	获取微调作业的细粒度状态更新。
OpenAiApi	list_fine_tunes	GET /fine-tunes	列出您组织的微调作业。
OpenAiApi	list_models	GET /models	列出当前可用的模型，并提供每个模型的基本信息，例如所有者和可用性。
OpenAiApi	retrieve_engine	GET /engines/{engine_id}	检索模型实例，提供有关模型的基本信息，例如所有者和可用性。
OpenAiApi	retrieve_file	GET /files/{file_id}	返回有关特定文件的信息。
OpenAiApi	retrieve_fine_tune	GET /fine-tunes/{fine_tune_id}	获取微调作业的信息。[了解更多关于微调](https://github.com/docs/guides/fine-tuning)
OpenAiApi	retrieve_model	GET /models/{model}	检索模型实例，提供有关模型的基本信息，例如所有者和权限。

模型文档

要获取生成的文档，请使用

cargo doc --open

作者

依赖项

~4–16MB
~247K SLoC