OpenAI Unity

Lihat Neocortex untuk integrasi NPC pintar yang mudah!

Paket Openai Unity

Paket Unity tidak resmi yang memungkinkan Anda menggunakan API OpenAI secara langsung di Unity Game Engine.

Cara menggunakan

Tutorial YouTube

Anda dapat menemukan tutorial video khusus untuk cara menggunakan paket ini di daftar putar YouTube ini.

https://www.youtube.com/playlist?list=plre-fzieels1-c7qifzyzeq50id08fcjo

Mengimpor paket

Untuk mengimpor paket, ikuti langkah -langkah ini:

• Open Unity 2019 atau lebih baru
• Pergi ke Window > Package Manager
• Klik tombol + dan pilih Add package from git URL
• Tempel url repositori https://github.com/srcnalt/openai-unity.git dan klik Add

Menyiapkan Akun OpenAI Anda

Untuk menggunakan API OpenAI, Anda harus memiliki akun Openai. Ikuti langkah -langkah ini untuk membuat akun dan menghasilkan kunci API:

• Kunjungi https://openai.com/api dan daftar untuk akun
• Setelah Anda membuat akun, kunjungi https://beta.openai.com/account/api-keys
• Buat kunci rahasia baru dan simpan

Menyimpan kredensial Anda

Untuk membuat permintaan ke API OpenAI, Anda perlu menggunakan kunci API dan nama organisasi Anda (jika berlaku). Untuk menghindari mengekspos kunci API Anda di proyek Unity Anda, Anda dapat menyimpannya di penyimpanan lokal perangkat Anda.

Untuk melakukan ini, ikuti langkah -langkah ini:

• Buat folder yang disebut .openai di direktori home Anda (misalnya C:UserUserName for windows atau ~ for linux atau mac)
• Buat file yang disebut auth.json di folder .openai
• Tambahkan bidang API_Key dan bidang organisasi (jika berlaku) ke file auth.json dan simpan
• Berikut adalah contoh dari seperti apa file auth.json Anda seperti:

{
    "api_key" : " sk-...W6yi " ,
    "organization" : " org-...L7W "
}

Anda juga dapat meneruskan kunci API Anda ke OpenAIApi CTOR saat membuat contohnya tetapi sekali lagi, ini tidak disarankan!

 var openai = new OpenAIApi ( " sk-Me8...6yi " ) ;

Penting: Kunci API Anda adalah rahasia. Jangan membaginya dengan orang lain atau mengeksposnya dalam kode sisi klien apa pun (misalnya browser, aplikasi). Jika Anda menggunakan OpenAi untuk produksi, pastikan untuk menjalankannya di sisi server, di mana kunci API Anda dapat dimuat dengan aman dari variabel lingkungan atau layanan manajemen kunci.

Membuat permintaan ke OpenAPI

Anda dapat menggunakan kelas OpenAIApi untuk membuat permintaan async ke API OpenAI.

Semua metode tidak sinkron dan dapat diakses langsung dari instance kelas OpenAIApi .

Berikut adalah contoh cara membuat permintaan:

 private async void SendRequest ( )
{
    var req = new CreateChatCompletionRequest
    {
        Model = " gpt-3.5-turbo " ,
        Messages = new List < ChatMessage > ( )
        {
            new ChatMessage ( )
            {
                Role = " user " ,
                Content = " Hello! "
            }
        }
    } ;
    var res = await openai . CreateChatCompletion ( req ) ;
}

Untuk membuat permintaan aliran, Anda dapat menggunakan metode CreateCompletionAsync dan CreateChatCompletionAsync . Metode -metode ini akan mengatur properti Stream dari permintaan ke true dan mengembalikan tanggapan melalui panggilan balik respons. Dalam hal ini respons teks disimpan di properti Delta dari bidang Choices di penyelesaian obrolan.

 var req = new CreateChatCompletionRequest {
    Model = " gpt-3.5-turbo " ,
    Messages = new List < ChatMessage >
    {
        new ChatMessage ( )
        {
            Role = " user " ,
            Content = " Write a 100 word long short story in La Fontaine style. "
        }
    } ,
    Temperature = 0.7f ,
} ;
    
openai . CreateChatCompletionAsync ( req , 
    ( responses ) => {
        var result = string . Join ( " " , responses . Select ( response => response . Choices [ 0 ] . Delta . Content ) ) ;
        Debug . Log ( result ) ;
    } , 
    ( ) => {
        Debug . Log ( " completed " ) ;
    } , 
    new CancellationTokenSource ( )
) ;

Contoh proyek

Paket ini mencakup dua adegan sampel yang dapat Anda impor melalui manajer paket:

• CHATGPT CAMEN: CHATGPT sederhana seperti contoh obrolan.
• Sampel Dalle: Teks Dall.e Contoh Pembuatan Gambar.

Masalah yang diketahui

• Tidak dapat melihat hasil gambar di WebGL builds: karena kebijakan CORS penyimpanan gambar openai di WebGL lokal Builds Anda akan mendapatkan URL gambar yang dihasilkan namun tidak akan diunduh menggunakan UnityWebRequest sampai Anda menjalankannya dari LocalHost, di server.

• Respons streaming hanya kosong di WebGL build: Unity 2020 WebGL memiliki bug di mana respons stream kembali kosong. Anda dapat memperbarui dan mencoba dengan versi Unity yang lebih baru.

Versi persatuan yang didukung untuk build WebGL

Tabel berikut menunjukkan versi Unity yang didukung untuk WebGL Builds:

Versi Persatuan	Windows	Linux	MacOS	Webgl	Android	IOS	Oculus 2
2022.3.x	✅	️	️	️	✅	✅	✅
2021.3.x	✅	️	️	️	✅	✅	✅
2020.3.x	✅	️	️	️	✅	✅	✅
2019.4.x	✅	️	️	️	️	️	️

✅ = didukung	️ = Tidak diuji	⛔ = tidak didukung

Harap laporkan masalah apa pun yang Anda hadapi dengan build.

Bacaan lebih lanjut

Untuk informasi lebih lanjut tentang cara menggunakan berbagai parameter permintaan, silakan merujuk ke dokumentasi OpenAI: https://platform.openai.com/docs/api-reference