เริ่มต้นสำหรับผู้ใช้ Ollama

ข้อกำหนดเบื้องต้น

ในการใช้งาน API นี้ คุณต้องมีบัญชีที่ใช้งานอยู่และคีย์ API ที่ถูกต้อง ไปที่หน้า รับคีย์ API เพื่อสมัครสมาชิกโดยใช้ Google หรืออีเมลพร้อมรหัสผ่าน ไม่จำเป็นต้องใช้หมายเลขโทรศัพท์ คุณยังต้องติดตั้ง SDK ภาษาที่รองรับบนเครื่องของคุณ คู่มือนี้ครอบคลุม Python และ Node.js ซึ่งเป็นไคลเอนต์ที่พบบ่อยที่สุดสำหรับเอนด์พอยต์ที่เข้ากันได้กับ OpenAI API นี้ให้บริการโมเดลแบบไม่เซ็นเซอร์เพียงโมเดลเดียวที่ระบุโดย uncensored API รับข้อความและส่งกลับข้อความ ไม่มีฟีเจอร์ embeddings รูปภาพ หรือเสียง คำขอทั้งหมดไปยัง https://api.ollamaapi.cc/v1

ติดตั้ง SDK

ติดตั้ง SDK ทางการสำหรับภาษาที่คุณต้องการ สำหรับ Python ใช้ pip สำหรับ Node.js ใช้ npm ไลบรารีเหล่านี้จัดการโปรโตคอล HTTP การทำ serialization JSON และการสตรีมมิงโดยอัตโนมัติ คุณไม่จำเป็นต้องเขียนคำขอ HTTP แบบดิบเว้นแต่คุณจะชอบระดับการควบคุมนี้ SDK มีการบันทึกเอกสารอย่างดีและใช้งานทั่วไปในสภาพแวดล้อมการผลิต ตรวจสอบให้แน่ใจว่าสภาพแวดล้อมของคุณตรงกับข้อกำหนดของ SDK แนะนำ Python 3.8+ และ Node.js 18+ อัปเดต dependencies ของคุณให้ทันสมัยเพื่อหลีกเลี่ยงปัญหาความเข้ากันได้กับพารามิเตอร์โมเดลใหม่

กำหนดค่าไคลเอนต์

ตั้งค่า URL พื้นฐานไปยังเอนด์พอยต์ของเรา นี่คือการเปลี่ยนแปลงการกำหนดค่าเพียงอย่างเดียวที่จำเป็นในการเปลี่ยนจาก OpenAI มาบริการไม่เซ็นเซอร์ของเรา ส่งคีย์ API ของคุณเป็นหัวเรื่องการตรวจสอบสิทธิ์ SDK จะจัดการส่วนที่เหลือ ไม่ต้องเปลี่ยนชื่อโมเดลเป็น gpt-4 หรือคล้ายกัน; ใช้ uncensored API ปฏิบัติตามโปรโตคอล chat-completions ของ OpenAI อย่างเคร่งครัด ไคลเอนต์ใดๆ ที่ทำงานกับ OpenAI จะทำงานที่นี่ด้วยการเปลี่ยนแปลงสองประการนี้ ทำให้การย้ายหรือการทดสอบ A/B ง่ายขึ้น คุณสามารถรัน API ทั้งสองข้างเคียงเพื่อเปรียบเทียบผลลัพธ์

ส่งคำขอแรก

ส่งคำขอ POST ไปยัง /v1/chat/completions รวม ID โมเดล พรอมต์ระบบ และข้อความผู้ใช้ API คืนข้อความตอบกลับ หากมีเครดิต คำขอจะสำเร็จ หากไม่มีเครดิต คุณจะได้รับการผิดพลาด 402 หากคีย์ของคุณไม่ถูกต้อง คุณจะได้รับการผิดพลาด 401 ข้อผิดพลาดเหล่านี้เป็นมาตรฐานและจัดการได้ง่ายในโค้ด โมเดลไม่ปฏิเสธเนื้อหาผู้ใหญ่ที่ถูกต้องตามกฎหมาย ทำให้มีประโยชน์สำหรับการเขียนเชิงสร้างสรรค์ การวิจัยความปลอดภัย หรือแชทแบบไม่เซ็นเซอร์ ตรวจสอบยอดเงินของคุณบนแดชบอร์ดหากคุณไม่แน่ใจเกี่ยวกับเครดิตที่เหลือ

การตอบสนองแบบสตรีมมิง

เปิดใช้งานสตรีมมิงโดยการตั้งค่า stream: true API ส่งโทเคนออกมาเมื่อมีการสร้างข้อความ ซึ่งช่วยลดความล่าช้าที่ผู้ใช้รู้สึก โมดูลสุดท้ายมีการใช้งานโทเคนรวมสำหรับการเรียกเก็บเงิน สตรีมมิงรองรับโดย SDK ทางการทั้งหมด สิ่งจำเป็นสำหรับอินเทอร์เฟซแชทที่คุณต้องการแสดงข้อความเมื่อพิมพ์ เซิร์ฟเวอร์ส่งเหตุการณ์ส่งจากเซิร์ฟเวอร์ (SSE) ไลบรารีไคลเอนต์ของคุณจัดการการแยกวิเคราะห์ คุณไม่จำเป็นต้องจัดการสตรีมเหตุการณ์ด้วยตนเอง เว้นแต่คุณจะสร้างไคลเอนต์แบบกำหนดเอง

ขีดจำกัด ข้อผิดพลาด และหน้าต่างบริบท

หน้าต่างบริบทมีโทเคนรวม 100,000 โทเคน พร้อมการส่งออกสูงสุด 32,000 โทเคน คำขอจำกัดไว้ที่ 300 คำขอต่อนาทีและ 8 คำขอพร้อมกันต่อคีย์ ร่างคำขอต้องมีขนาดไม่เกิน 8 MB ข้อผิดพลาดรวมถึง 401 สำหรับคีย์ที่ไม่ถูกต้อง 402 สำหรับเครดิตไม่เพียงพอ และ 429 สำหรับขีดจำกัดอัตรา นี่คือรหัส HTTP มาตรฐาน จัดการอย่างเหมาะสมในแอปพลิเคชันของคุณ โมเดลบล็อกเนื้อหาทางเพศที่เกี่ยวข้องกับเด็กอายุต่ำกว่า 18 ปี เนื้อหาอื่น ๆ ทั้งหมดได้รับอนุญาต เครดิตไม่หมดอายุ ดังนั้นคุณสามารถหยุดการใช้งานโดยไม่สูญเสียเงิน ใช้หน้าการสนับสนุนสำหรับปัญหาการคืนเงิน

cURL

Copycurl https://api.ollamaapi.cc/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Write a blunt product review of a cheap VPN."}]
  }'

Python

Copyfrom openai import OpenAI

client = OpenAI(base_url="https://api.ollamaapi.cc/v1", api_key="YOUR_KEY")

resp = client.chat.completions.create(
    model="uncensored",
    messages=[{"role": "user", "content": "Summarise this thread without softening it."}],
)
print(resp.choices[0].message.content)

Node.js

Copyimport OpenAI from "openai";

const client = new OpenAI({ baseURL: "https://api.ollamaapi.cc/v1", apiKey: process.env.API_KEY });

const resp = await client.chat.completions.create({
  model: "uncensored",
  messages: [{ role: "user", content: "Draft a villain monologue for my game." }],
});
console.log(resp.choices[0].message.content);

สตรีมมิง

Copystream = client.chat.completions.create(
    model="uncensored",
    messages=[{"role": "user", "content": "Tell the story in second person."}],
    stream=True,
)
for chunk in stream:
    if chunk.choices and chunk.choices[0].delta.content:
        print(chunk.choices[0].delta.content, end="", flush=True)