Module rust_ai::openai

OpenAI endpoint collection

OpenAI

Introduction

This module provides functionalities accessable from OpenAI’s RESTful API endpoints.

You should have a valid API Key first. Put the key in config.yml, see README.md for instance.

These types are re-exported from submodules:

• Audio: audio transcriptions and translations;
• ChatCompletion: ChatGPT like capabilities for text/code completion;
• Completion: GPT-3 based text/code completion;
• Edit: text content manipulation;
• Embedding: Ada based embedding extraction;
• Moderation: content violation detection;
• Model: an enum represents all available OpenAI public models.

Support List

Category	Variant	Tested Models	Stream
Chat completions	-	gpt-3.5-turbo, gpt-3.5-turbo-0301, text-davinci-003, text-davinci-002, code-davinci-0021	yes
Completions	-	gpt-3.5-turbo, gpt-3.5-turbo-0301, text-davinci-003	yes
Edits	-	text-davinci-edit-001, code-davinci-edit-001	-
Images	Generations	dall-e2	-
Images	Edits	dall-e2	-
Images	Variations	dall-e2	-
Embeddings	-	text-embedding-ada-0023	-
Audios	Transcriptions	whisper-1	-
Audios	Translation	whisper-1	-
Moderation	-	text-moderation-latest4, text-moderation-stable	-

Note:

• Updated on March 24rd, 2023.
• OpenAI’s Fine Tunes endpoints are currently not supported.

---

1. GPT-4 series cannot be tested due to author of this crate is still in the waitlist. ↩

2. dall-e is an hypothetical name of the unknown model. Currently, OpenAI doesn’t support manually specify model for image related tasks. So DALL·E models are not valid variants of Model enum. ↩

3. You may notice the actual model behind Embedding API to be text-embedding-ada-002-v2 (March 23rd, 2023). ↩

4. OpenAI’s responses for moderation indicate usage of text-moderation-004 model (March 23rd, 2023). But developers cannot use its API endpoints to specify variants other than text-moderation-latest and text-moderation-stable. ↩

Re-exports

• pub use apis::chat_completion::ChatCompletion;
• pub use apis::completion::Completion;
• pub use apis::edit::Edit;
• pub use apis::image::Image;
• pub use apis::embedding::Embedding;
• pub use apis::audio::Audio;
• pub use apis::moderation::Moderation;
• pub use types::model::Model;

Modules

• apis
  OpenAI capabilities
• endpoint
  API endpoint definitions
• types
  Type definitions for OpenAI