async openai

異步 - 奧佩納

Openai的異步生鏽庫

_{此存儲庫本身創建的徽標}

概述

async-openai是Openai的非正式鏽蝕庫。

• 它基於Openai Openapi規格
• 當前功能：
  • 助手（v2）
  • 聲音的
  • 批
  • 聊天
  • 完成（遺產）
  • 嵌入
  • 文件
  • 微調
  • 圖像
  • 型號
  • 適中
  • 組織|行政
  • 實時API類型（beta）
  • 上傳
• SSE流在可用的API上
• 當利率限制時，請求（SSE流媒體除外）在包括表單提交的情況下以指數退回。
• 所有請求對象的人體工程學構建器模式。
• Microsoft Azure OpenAi服務（僅適用於匹配OpenAI規格的API）

用法

該庫從環境變量OPENAI_API_KEY讀取API鍵。

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

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

• 請訪問示例目錄有關如何使用async-openai目錄。
• 請訪問docs.rs/async-openai以獲取文檔。

實時API

僅實現用於實時API的類型，並且可以使用功能標誌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註釋均來自OpenAPI規格。沒有名稱的規格中的嵌套對象留出了適當名稱的空間。
• 測試：對於更改，需要支持測試和/或示例。如果適用，應進行現有示例，DOC測試，單元測試和集成測試以進行更改。
• 範圍：將範圍限制為官方文檔中可用的API，例如API參考或OpenAPI規格。其他LLMS或AI提供商提供與OpenAI兼容的API，但它們可能並不總是完全均等。在這種情況下，OpenAI規格優先。
• 一致性：保持代碼樣式在庫公開的所有“ API”中保持一致；它創造了出色的開發人員體驗。

該項目遵守生鏽的行為守則

免費板條箱

• OpenAi-Func-Enums提供了程序上的宏，使使用OpenAI API的工具調用功能更容易使用此庫。它還提供了衍生宏，您可以添加到現有的Clap應用程序子命令中，以用於命令行工具的自然語言使用。它還支持OpenAI的並行工具調用，並允許您在同時運行多個工具調用或擁有自己的操作系統線程之間進行選擇。
• 異步 - 奧佩納 - 瓦斯提供了wASM支持。

執照

該項目已根據MIT許可獲得許可。