1 个不稳定版本

0.1.0	2023年4月2日

#36 in #sampling

MIT 协议

160KB
2.5K SLoC

Rust API客户端用于openai-lib

用于从和微调语言模型中采样的API

概述

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

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

安装

将包放入名为 openai-lib 的目录下，并将以下内容添加到 Cargo.toml 中的 [dependencies]

openai-lib = { path = "./openai-lib" }

API端点文档

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

类	方法	HTTP请求	描述
OpenAiApi	cancel_fine_tune	POST /fine-tunes/{fine_tune_id}/cancel	立即取消微调作业。
OpenAiApi	create_answer	POST /answers	使用提供的文档和示例回答指定的问题。端点首先搜索提供的文档或文件以找到相关上下文。将相关上下文与提供的示例和问题结合，为 completion 创建提示。
OpenAiApi	create_chat_completion	POST /chat/completions	为聊天消息创建完成
OpenAiApi	create_classification	POST /classifications	使用提供的示例对指定的 `query` 进行分类。端点首先搜索标记的示例以选择与特定查询最相关的示例。然后，将相关示例与查询结合，通过 completions 端点构造提示，以生成最终标签。标记的示例可以通过上传 `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	创建一个作业，从给定的数据集中微调指定的模型。响应包括排队作业的详细信息，包括作业状态和完成后的微调模型名称。了解更多关于微调的信息
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	create_transcription	POST /audio/transcriptions	将音频转录为输入语言。
OpenAiApi	create_translation	POST /audio/translations	将音频翻译成英语。
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}	获取微调作业的信息。了解更多关于微调的信息
OpenAiApi	retrieve_model	GET /models/{model}	检索一个模型实例，提供有关模型的基本信息，例如所有者和权限。

模型文档

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

cargo doc --open

作者

依赖项

~4–16MB
~247K SLoC