Unduh open assistant api - Unduh Kode Sumber open assistant api

open assistant api

Kode sumber lainnya

1.0.0

Unduh

Open Assistant API

API AI Intelegent AI yang out-of-the-box

Bahasa Inggris | 简体中文 | 日本語

Perkenalan

Open Assistant API adalah API AI Intelligent Sumber Open-Source, yang diselenggarakan sendiri, yang kompatibel dengan antarmuka OpenAI resmi. Ini dapat digunakan secara langsung dengan klien OpenAI resmi untuk membangun aplikasi LLM.

Ini mendukung satu API untuk integrasi dengan lebih banyak model komersial dan pribadi.

Ini mendukung mesin Rag R2R。

Penggunaan

Di bawah ini adalah contoh penggunaan Perpustakaan openai Python Resmi:

 import openai

client = openai . OpenAI (
    base_url = "http://127.0.0.1:8086/api/v1" ,
    api_key = "xxx"
)

assistant = client . beta . assistants . create (
    name = "demo" ,
    instructions = "You are a helpful assistant." ,
    model = "gpt-4-1106-preview"
)

Mengapa Memilih API Asisten Terbuka

Fitur	Open Assistant API	API Asisten Openai
Strategi ekosistem	Open source	Sumber tertutup
Mesin kain	Dukung R2R	Didukung
Pencarian Internet	Didukung	Tidak didukung
Fungsi khusus	Didukung	Didukung
Alat bawaan	Dapat diperpanjang	Tidak dapat diperpanjang
Interpreter Kode	Dalam pengembangan	Didukung
Multimodal	Didukung	Didukung
Dukungan LLM	Mendukung lebih banyak LLM	Hanya GPT
Output streaming pesan	Dukungan	Didukung
Penempatan lokal	Didukung	Tidak didukung

Dukungan LLM : Dibandingkan dengan versi OpenAI resmi, lebih banyak model dapat didukung dengan mengintegrasikan dengan satu API.
Alat : Saat ini mendukung pencarian online; dapat dengan mudah memperluas lebih banyak alat.
Mesin Rag : Jenis file yang saat ini didukung adalah TXT, HTML, Markdown, PDF, DOCX, PPTX, XLSX, PNG, MP3, MP4, dll. Kami menyediakan implementasi awal.
Output streaming pesan : Dukungan output streaming pesan untuk pengalaman pengguna yang lebih halus.
Strategi Ekosistem : Open Source, Anda dapat menggunakan layanan secara lokal dan memperluas fitur yang ada.

Awal yang cepat

Cara termudah untuk memulai API Asisten Terbuka adalah dengan menjalankan file Docker-Compose.yml. Pastikan Docker dan Docker Compose diinstal pada mesin Anda sebelum berjalan.

Konfigurasi

Buka direktori Root Proyek, buka docker-compose.yml , isi kunci pencarian OpenAI API_Key dan Bing (opsional).

 # openai api_key (supports OneAPI api_key)
OPENAI_API_KEY= < openai_api_key >

# bing search key (optional)
BING_SUBSCRIPTION_KEY= < bing_subscription_key >

Disarankan untuk mengonfigurasi mesin Rag R2R untuk menggantikan implementasi Rag default untuk memberikan kemampuan Rag yang lebih baik. Anda dapat mempelajari dan menggunakan R2R melalui repositori R2R GitHub.

 # RAG config
# FILE_SERVICE_MODULE=app.services.file.impl.oss_file.OSSFileService
FILE_SERVICE_MODULE=app.services.file.impl.r2r_file.R2RFileService
R2R_BASE_URL=http:// < r2r_api_address >
R2R_USERNAME= < r2r_username >
R2R_PASSWORD= < r2r_password >

Berlari

Jalankan dengan Docker Compose:

docker compose up -d

Akses API

URL Pangkalan API: http://127.0.0.1:8086/api/v1

Alamat dokumentasi antarmuka: http://127.0.0.1:8086/docs

Contoh Penggunaan Lengkap

Dalam contoh ini, seorang asisten AI dibuat dan dijalankan menggunakan Perpustakaan Klien Openai Resmi. Jika Anda perlu menjelajahi metode penggunaan lain, seperti streaming output, alat (Web_search, pengambilan, fungsi), dll., Anda dapat menemukan kode yang sesuai di bawah direktori Contoh. Sebelum berjalan, Anda perlu menjalankan pip install openai untuk menginstal Perpustakaan Python openai .

 # !pip install openai
export PYTHONPATH= $( pwd )
python examples/run_assistant.py

Izin

Isolasi pengguna sederhana disediakan berdasarkan token untuk memenuhi persyaratan penempatan SaaS. Ini dapat diaktifkan dengan mengonfigurasi APP_AUTH_ENABLE .

Metode otentikasi adalah token pembawa. Anda dapat memasukkan Authorization: Bearer *** di header untuk otentikasi.
Manajemen token dijelaskan di bagian token dari dokumentasi API. API yang relevan perlu diautentikasi dengan token admin, yang dikonfigurasi sebagai APP_AUTH_ADMIN_TOKEN dan default ke "admin".
Saat membuat token, Anda perlu menyediakan URL dasar dan kunci API dari model besar. Asisten yang dibuat akan menggunakan konfigurasi yang sesuai untuk mengakses model besar.

Peralatan

Menurut spesifikasi OpenAPI/Swagger, ini memungkinkan integrasi berbagai alat ke asisten, memberdayakan dan meningkatkan kemampuannya untuk terhubung dengan dunia eksternal.

Memfasilitasi menghubungkan aplikasi Anda dengan sistem atau layanan lain, memungkinkan interaksi dengan lingkungan eksternal, seperti eksekusi kode atau mengakses sumber informasi hak milik.
Selama penggunaan, Anda perlu membuat alat terlebih dahulu, dan kemudian Anda dapat mengintegrasikannya dengan asisten. Lihat kasus uji untuk detail lebih lanjut. Bantuan dengan tindakan
Jika Anda perlu menggunakan alat dengan informasi otentikasi, cukup tambahkan informasi otentikasi saat runtime. Format parameter spesifik dapat ditemukan dalam dokumentasi API. Lihat kasus uji untuk detail lebih lanjut. Jalankan dengan Auth Action

Komunitas dan dukungan

Bergabunglah dengan Slack Channel untuk melihat rilis baru, mendiskusikan masalah, dan berpartisipasi dalam interaksi masyarakat.
Bergabunglah dengan Discord Channel untuk berinteraksi dengan anggota komunitas lainnya.
Bergabunglah dengan grup WeChat: