1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74

//! 
//! # 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`][crate::openai::Audio]: audio transcriptions and translations;
//! - [`ChatCompletion`][crate::openai::ChatCompletion]: ChatGPT like capabilities for text/code completion;
//! - [`Completion`][crate::openai::Completion]: GPT-3 based text/code completion;
//! - [`Edit`][crate::openai::Edit]: text content manipulation;
//! - [`Embedding`][crate::openai::Embedding]: Ada based embedding extraction;
//! - [`Moderation`][crate::openai::Moderation]: content violation detection;
//! - [`Model`][crate::openai::Model]: an enum represents all available OpenAI public models.
//! 
//! ## Support List
//! 
//! | Category         | Variant        | Tested Models            | Stream |
//! | :--------------- | :------------- | :----------------------- | :----: |
//! | Chat completions | -              | `gpt-4`, `gpt-4-0314`, `gpt-4-0613`, `gpt-3.5-turbo`, `gpt-3.5-turbo-16k`, `gpt-3.5-turbo-16k-0613`, `gpt-3.5-turbo-0613`, `gpt-3.5-turbo-0301`, `text-davinci-003`, `text-davinci-002`, `code-davinci-002`[^note_3] | yes    |ext-davinci-002`, `code-davinci-002` | yes    |
//! | Completions      | -              | `gpt-3.5-turbo`, `gpt-3.5-turbo-16k`, `gpt-3.5-turbo-16k-0613`, `gpt-3.5-turbo-0613`, `gpt-3.5-turbo-0301`, `text-davinci-003`       | yes    |   | yes    |
//! | Edits            | -              | `text-davinci-edit-001`, `code-davinci-edit-001`  | -      |
//! | Images           | Generations    | `dall-e`[^note_1]        | -      |
//! | Images           | Edits          | `dall-e`[^note_1]        | -      |
//! | Images           | Variations     | `dall-e`[^note_1]        | -      |
//! | Embeddings       | -              | `text-embedding-ada-002`[^note_4] | -      |
//! | Audios           | Transcriptions | `whisper-1`              | -      |
//! | Audios           | Translation    | `whisper-1`              | -      |
//! | Moderation       | -              | `text-moderation-latest`[^note_2], `text-moderation-stable` | -      |
//! 
//! Note: 
//! - Updated on June 16th, 2023.
//! - OpenAI's Fine Tunes endpoints are currently not supported.
//! 
//! [^note_1]: `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.
//! 
//! [^note_2]: 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`.
//! 
//! [^note_3]: GPT-4/GPT-4-0314/GPT-4-0613 tested, GPT-4-32K/GPT-4-32K-0314 not tested 
//! because developer currently only has access to 8K token ones (May 6th, 
//! 2023).
//! 
//! [^note_4]: You may notice the actual model behind Embedding API to be 
//! `text-embedding-ada-002-v2` (March 23rd, 2023).

////////////////////////////////////////////////////////////////////////////////

/// API endpoint definitions
pub mod endpoint;

/// Type definitions for OpenAI
pub mod types;

/// OpenAI capabilities
pub mod apis;

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;