async openai

Асинк-Опенай

Библиотека Async Rust для Openai

_{Логотип, созданный самим репо}

Обзор

async-openai -неофициальная библиотека ржавчины для Openai.

• Он основан на спецификации OpenAI OpenAPI
• Текущие функции:
  • Помощники (v2)
  • Аудио
  • Партия
  • Чат
  • Завершение (наследие)
  • Внедрения
  • Файлы
  • Тонкая настройка
  • Изображения
  • Модели
  • Модерации
  • Организации | Администрация
  • Типы API в реальном времени (бета)
  • Загружает
• SSE потоковая передача на доступных API
• Запросы (кроме потоковой передачи SSE), включая представления формы, повторно отнесены к экспоненциальному отбору при ограничении скорости.
• Эргономичный шаблон строителя для всех объектов запроса.
• Microsoft Azure Open Service (только для API -сопоставления Spectai Spec)

Использование

Библиотека считывает ключ API из переменной среды OPENAI_API_KEY .

 # On macOS/Linux
export OPENAI_API_KEY= ' sk-... ' 

 # On Windows Powershell
$ Env: OPENAI_API_KEY = ' sk-... '

• Посетите Справочник примеров о том, как использовать async-openai .
• Посетите docs.rs/async-openai для документов.

В реальном времени API

Только типы для API в реальном времени реализованы, и могут быть включены с помощью FLAG FLAG realtime . Эти типы могут измениться, если/когда Openai выпускает официальные характеристики для них.

Пример генерации изображений

 use async_openai :: {
    types :: { CreateImageRequestArgs , ImageSize , ImageResponseFormat } ,
    Client ,
} ;
use std :: error :: Error ;

# [ tokio :: main ]
async fn main ( ) -> Result < ( ) , Box < dyn Error > > {
    // create client, reads OPENAI_API_KEY environment variable for API key.
    let client = Client :: new ( ) ;

    let request = CreateImageRequestArgs :: default ( )
        . prompt ( "cats on sofa and carpet in living room" )
        . n ( 2 )
        . response_format ( ImageResponseFormat :: Url )
        . size ( ImageSize :: S256x256 )
        . user ( "async-openai" )
        . build ( ) ? ;

    let response = client . images ( ) . create ( request ) . await ? ;

    // Download and save images to ./data directory.
    // Each url is downloaded and saved in dedicated Tokio task.
    // Directory is created if it doesn't exist.
    let paths = response . save ( "./data" ) . await ? ;

    paths
        . iter ( )
        . for_each ( |path| println ! ( "Image file path: {}" , path.display ( ) ) ) ;

    Ok ( ( ) )
}

_{Масштабирован для ReadMe, фактический размер 256x256}

Вклад

Спасибо, что нашли время, чтобы внести свой вклад и улучшить проект. Я был бы счастлив, если бы ты!

Все формы вкладов, такие как новые запросы на функции, исправления ошибок, проблемы, документация, тестирование, комментарии, примеры и т. Д., Приглашаются.

Хорошей отправной точкой было бы взглянуть на существующие открытые проблемы.

Для поддержания качества проекта минимум следующего является обязательным для вклада кода:

• Имена и документация : все имена структуры, имена поля и комментарии DOC взяты из Spectapi Spec. Вложенные объекты в спецификации без имен оставляют место для создания соответствующего имени.
• Протестировано : для изменений требуется вспомогательный тест (ы) и/или пример. Существующие примеры, DOC -тесты, модульные тесты и интеграционные тесты должны быть сделаны для работы с изменениями, если это применимо.
• Сфера применения : сохраните область, ограниченную API, доступными в официальных документах, таких как ссылка API или OpenAPI Spec. Другие LLMS или AI-поставщики предлагают API-совместимых с открытыми, но они не всегда могут иметь полный паритет. В таких случаях спецификация OpenAI имеет приоритет.
• Последовательность : сохраняйте стиль кода в соответствии со всеми «API», которые раскрывает библиотека; Это создает отличный опыт разработчика.

Этот проект придерживается кода поведения ржавчины

Бесплатные ящики

• Openai-Func-enums предоставляет процедурные макросы, которые облегчают использование этой библиотеки с функцией вызова инструментов OpenAI API. Он также предоставляет Derive Macros, которые вы можете добавить в существующие подкоманды приложения CLAP для использования естественным языком инструментов командной строки. Он также поддерживает параллельные вызовы Openai и позволяет выбирать между несколькими вызовами инструментов одновременно или владеет собственными потоками ОС.
• Async-Openai-Wasm обеспечивает поддержку WASM.

Лицензия

Этот проект лицензирован по лицензии MIT.