# AI in Rust

Provide a collection of third-party APIs that give public access to AI capabilities.

**WARNING**: this crate is **NOT PRODUCTION** ready.

## Support List

### OpenAI

| Category         | Variant        | Tested Models            | Stream |
| :--------------- | :------------- | :----------------------- | :----: |
| Chat completions | -              | `gpt-4-turbo-preview`, `gpt-4-0125-preview`, `gpt-4-1106-vision-preview`, `gpt-4-1106-preview`, `gpt-4-vision-preview`, `gpt-4`, `gpt-4-0314`, `gpt-4-0613`, `gpt-3.5-turbo-0125`, `gpt-3.5-turbo-1106`, `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-4-turbo-preview`, `gpt-4-0125-preview`, `gpt-4-1106-vision-preview`, `gpt-4-1106-preview`, `gpt-4-vision-preview`, `gpt-4`, `gpt-4-0314`, `gpt-4-0613`, `gpt-3.5-turbo-0125`, `gpt-3.5-turbo-1106`, `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-2`, `dall-e-3`       | -      |
| Images           | Edits          | `dall-e-2`       | -      |
| Images           | Variations     | `dall-e-2`       | -      |
| 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 Feburary 22nd, 2024.
- OpenAI's Fine Tunes endpoints are currently not supported.
- OpenAI's Assistants endpoints are currently not supported.

### Azure

| Category          | Capability | Endpoint       |
| :---------------- | :--------- | :------------- |
| Cognitive service | Speech     | Text-to-Speech, Voice-List, Speech-to-Text (Batch) |

Note: 
- Azure CN is not supported by this repo yet.

## Usage

Create a `config.yml` in your working directory, or root of this crate. Contents like this:

```yaml
openai:
  api_key: sk-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
  org_id: org-xxx
  base_endpoint: https://api.openai.com
azure:
  speech:
    key: 4c7eXXXXXXXXXXXXXXXXXXXXXXX54c32
    region: westus
```

If you prefer to load configuration from environment variables, set the contents to `RUST_AI_CONFIG` like example `chat-completion-streamed` does.

[^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).