open assistant api
1.0.0
API ผู้ช่วยอัจฉริยะ AI ที่ไม่อยู่นอกกรอบ AI
ภาษาอังกฤษ | 简体中文 | 日本語
Open Assistant API เป็นโอเพนซอร์ซ API ผู้ช่วย AI ที่เป็นโฮสต์ตัวเองซึ่งเป็นโฮสต์ตัวเองซึ่งเข้ากันได้กับอินเทอร์เฟซ OpenAI อย่างเป็นทางการ สามารถใช้โดยตรงกับไคลเอนต์ OpenAI อย่างเป็นทางการเพื่อสร้างแอปพลิเคชัน LLM
รองรับ API หนึ่งรายการสำหรับการรวมเข้ากับโมเดลเชิงพาณิชย์และส่วนตัวมากขึ้น
รองรับเครื่องยนต์ R2R Rag 。
ด้านล่างนี้เป็นตัวอย่างของการใช้ห้องสมุด Openai Python openai อย่างเป็นทางการ:
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"
)| คุณสมบัติ | API ผู้ช่วยเปิด | ผู้ช่วย Openai API |
|---|---|---|
| กลยุทธ์ระบบนิเวศ | โอเพ่นซอร์ส | แหล่งกำเนิด |
| เครื่องยนต์ผ้าขี้ริ้ว | สนับสนุน R2R | ที่ได้รับการสนับสนุน |
| การค้นหาทางอินเทอร์เน็ต | ที่ได้รับการสนับสนุน | ไม่รองรับ |
| ฟังก์ชั่นที่กำหนดเอง | ที่ได้รับการสนับสนุน | ที่ได้รับการสนับสนุน |
| เครื่องมือในตัว | ที่ขยายได้ | ไม่สามารถขยายได้ |
| ล่ามรหัส | อยู่ระหว่างการพัฒนา | ที่ได้รับการสนับสนุน |
| หลายรูปแบบ | ที่ได้รับการสนับสนุน | ที่ได้รับการสนับสนุน |
| การสนับสนุน LLM | รองรับ LLMS เพิ่มเติม | GPT เท่านั้น |
| เอาท์พุทการสตรีมข้อความ | การสนับสนุน | ที่ได้รับการสนับสนุน |
| การปรับใช้ในท้องถิ่น | ที่ได้รับการสนับสนุน | ไม่รองรับ |
วิธีที่ง่ายที่สุดในการเริ่มต้น API ผู้ช่วยเปิดคือการเรียกใช้ไฟล์ Docker-compose.yml ตรวจสอบให้แน่ใจว่ามีการติดตั้ง Docker และ Docker Compose บนเครื่องของคุณก่อนที่จะทำงาน
ไปที่ไดเรกทอรีรากของโครงการเปิด docker-compose.yml , กรอกคีย์ OpenAI API_KEY และ Bing Search (ไม่บังคับ)
# openai api_key (supports OneAPI api_key)
OPENAI_API_KEY= < openai_api_key >
# bing search key (optional)
BING_SUBSCRIPTION_KEY= < bing_subscription_key >ขอแนะนำให้กำหนดค่าเอ็นจิ้น R2R RAG เพื่อแทนที่การใช้งาน RAG เริ่มต้นเพื่อให้ความสามารถ RAG ที่ดีขึ้น คุณสามารถเรียนรู้และใช้ R2R ผ่านที่เก็บ 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 >docker compose up -dURL ฐาน API: http://127.0.0.1:8086/api/v1
ที่อยู่เอกสารอินเตอร์เฟส: http://127.0.0.1:8086/docs
ในตัวอย่างนี้ผู้ช่วย AI ถูกสร้างขึ้นและดำเนินการโดยใช้ไลบรารีไคลเอนต์ OpenAI อย่างเป็นทางการ หากคุณต้องการสำรวจวิธีการใช้งานอื่น ๆ เช่นการสตรีมเอาท์พุทเครื่องมือ (web_search, การดึง, ฟังก์ชั่น) ฯลฯ คุณสามารถค้นหารหัสที่เกี่ยวข้องภายใต้ไดเรกทอรีตัวอย่าง ก่อนที่จะทำงานคุณจะต้องเรียกใช้ pip install openai เพื่อติดตั้งไลบรารี Python openai
# !pip install openai
export PYTHONPATH= $( pwd )
python examples/run_assistant.py การแยกผู้ใช้อย่างง่ายมีให้ตามโทเค็นเพื่อให้เป็นไปตามข้อกำหนดการปรับใช้ SaaS สามารถเปิดใช้งานได้โดยการกำหนดค่า APP_AUTH_ENABLE
Authorization: Bearer *** ในส่วนหัวสำหรับการตรวจสอบสิทธิ์APP_AUTH_ADMIN_TOKEN และค่าเริ่มต้นเป็น "ผู้ดูแลระบบ"ตามข้อกำหนดของ OpenAPI/Swagger มันช่วยให้สามารถรวมเครื่องมือต่าง ๆ เข้ากับผู้ช่วยเสริมสร้างศักยภาพและเพิ่มความสามารถในการเชื่อมต่อกับโลกภายนอก
เข้าร่วมช่อง Slack เพื่อดูรุ่นใหม่หารือเกี่ยวกับปัญหาและมีส่วนร่วมในการโต้ตอบของชุมชน
เข้าร่วมช่อง Discord เพื่อโต้ตอบกับสมาชิกชุมชนคนอื่น ๆ
เข้าร่วมกลุ่ม WeChat:
เราอ้างถึงและพึ่งพาโครงการต่อไปนี้เป็นหลัก:
โปรดอ่านเอกสารการบริจาคของเราเพื่อเรียนรู้วิธีการมีส่วนร่วม
ที่เก็บนี้เป็นไปตามใบอนุญาตโอเพนซอร์ส MIT สำหรับข้อมูลเพิ่มเติมโปรดดูไฟล์ใบอนุญาต
