Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gha3mi/foropenai
ForOpenAI - A Fortran library for OpenAI API.
https://github.com/gha3mi/foropenai
api chatgpt dall-e fortran fortran-package-manager gpt openai openai-api whisper
Last synced: about 1 month ago
JSON representation
ForOpenAI - A Fortran library for OpenAI API.
- Host: GitHub
- URL: https://github.com/gha3mi/foropenai
- Owner: gha3mi
- License: mit
- Created: 2023-07-26T21:31:40.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-01-10T22:31:09.000Z (about 1 year ago)
- Last Synced: 2024-01-10T23:28:38.589Z (about 1 year ago)
- Topics: api, chatgpt, dall-e, fortran, fortran-package-manager, gpt, openai, openai-api, whisper
- Language: Fortran
- Homepage: https://gha3mi.github.io/foropenai/
- Size: 7.19 MB
- Stars: 14
- Watchers: 1
- Forks: 1
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/gha3mi/foropenai)
[](https://github.com/gha3mi/foropenai/releases/latest)
[](https://gha3mi.github.io/foropenai/)
[](https://github.com/gha3mi/foropenai/blob/main/LICENSE)
[](https://github.com/gha3mi/foropenai/actions/workflows/CI_test.yml)
**ForOpenAI**: An **unofficial** Fortran library for OpenAI.
## How to use
**Prerequisites:**
On Ubuntu, you need to install the curl development headers. Use the following command:
```shell
sudo apt install -y libcurl4-openssl-dev
```
**Clone the repository:**
You can clone the ForOpenAI repository from GitHub using the following command:
```shell
git clone https://github.com/gha3mi/foropenai.git
```
```shell
cd foropenai
```
**OpenAI API Key Configuration:**
Your Secret API key can be located by accessing the OpenAI [User settings](https://platform.openai.com/account/api-keys).
For enhanced security and convenience, it is strongly recommended to configure the API key as an environment variable.
- On Ubuntu, use the following command, replacing `"your_api_key"` with your actual API key:
```shell
export OPENAI_API_KEY="your_api_key"
```
- (Optional) If desired for organizational purposes, you can also establish an optional environment variable on Ubuntu:
```shell
export OPENAI_ORG="your_organization"
```
- Alternatively, the OpenAI API key can be included in the `foropenai.json` configuration file.
```json
{
"base": {
"api_key": "OPENAI_API_KEY",
"organization": ""
}
}
```
**Use ChatGPT from the terminal:**
```shell
fpm run
```
**Example**
## Audio
### Create transcription
```fortran
program test_Transcription
use foropenai, only: Transcription
implicit none
type(Transcription) :: trs
call trs%set_base_data(file_name='foropenai.json')
call trs%set(file_name='foropenai.json')
call trs%create(file='test/audio.mp3')
call trs%print_file()
call trs%print_assistant_response()
call trs%finalize()
end program test_Transcription
```
#### Settings
`foropenai.json`
```json
{
"base": {
"api_key": "OPENAI_API_KEY",
"organization": ""
},
"Transcription": {
"url": "https://api.openai.com/v1/audio/transcriptions",
"model": "whisper-1",
"temperature": 0.0,
"language": "en",
"response_format": "json"
}
}
```
#### Result
```shell
file: test/audio.mp3
Whisper: FORTRAN stands for Formula Translation.
```
### Create translation
```fortran
program test_Translation
use foropenai, only: Translation
implicit none
type(Translation) :: trs
call trs%set_base_data(file_name='foropenai.json')
call trs%set(file_name='foropenai.json')
call trs%create(file='test/audio_de.mp3')
call trs%print_file()
call trs%print_assistant_response()
call trs%finalize()
end program test_Translation
```
#### Settings
`foropenai.json`
```json
{
"base": {
"api_key": "OPENAI_API_KEY",
"organization": ""
},
"Translation": {
"url": "https://api.openai.com/v1/audio/translations",
"model": "whisper-1",
"temperature": 0.0,
"response_format": "json"
}
}
```
#### Result
```shell
file: test/audio_de.mp3
Whisper: FORTRAN stands for Formula Translation and is a programming language.
```
## Chat
### Create chat completion
```fortran
program test_ChatCompletion
use foropenai, only: ChatCompletion
implicit none
type(ChatCompletion) :: chat
call chat%set_base_data(file_name='foropenai.json')
call chat%set(file_name='foropenai.json')
call chat%init_messages(n=3)
call chat%messages(1)%set(role='system', content='You are a helpful assistant.')
call chat%messages(2)%set(role='user', content='Hello?')
call chat%messages(3)%set(role='assistant', content='')
call chat%print_user_message()
call chat%create()
call chat%print_assistant_response()
call chat%usage%print()
call chat%finalize()
end program test_ChatCompletion
```
#### Settings
`foropenai.json`
```json
{
"base": {
"api_key": "OPENAI_API_KEY",
"organization": ""
},
"ChatCompletion": {
"user_name": "Ali",
"url": "https://api.openai.com/v1/chat/completions",
"model": "gpt-3.5-turbo",
"temperature": 1.0,
"max_tokens": 200,
"top_p": 1.0,
"frequency_penalty": 0.0,
"presence_penalty": 0.0,
"n": 1,
"stream": false
}
}
```
#### Result
```shell
Ali: Hello?
ChatGPT: Hello! How can I assist you today?
```
## Image
### Image Generation
```fortran
program test_ImageGeneration
use foropenai, only: ImageGeneration
implicit none
type(ImageGeneration) :: image
call image%set_base_data(file_name='foropenai.json')
call image%set(file_name='foropenai.json')
call image%create(prompt='a cat with a computer')
call image%print_prompt()
call image%print_assistant_response()
call image%finalize()
end program test_ImageGeneration
```
#### Settings
`foropenai.json`
```json
{
"base": {
"api_key": "OPENAI_API_KEY",
"organization": ""
},
"ImageGeneration": {
"user_name": "Ali",
"url": "https://api.openai.com/v1/images/generations",
"size": "1024x1024",
"n": 1,
"response_format": "url"
}
}
```
#### Result
## fpm dependency
If you want to use `ForOpenAI` as a dependency in your own fpm project,
you can easily include it by adding the following line to your `fpm.toml` file:
```toml
[dependencies]
foropenai = {git="https://github.com/gha3mi/foropenai.git"}
```
## API documentation
The most up-to-date API documentation for the master branch is available
[here](https://gha3mi.github.io/foropenai/).
To generate the API documentation for `ForOpenAI` using
[ford](https://github.com/Fortran-FOSS-Programmers/ford) run the following
command:
```shell
ford ford.yml
```
## Contributing
Contributions to `ForOpenAI` are welcome!
If you find any issues or would like to suggest improvements, please open an issue.