Dokumentasi API Endpoint Ollama
Mula membina dengan API LLM tanpa sensor kami dalam beberapa saat. Panduan ini merangkumi URL asas, pengesahan, dan integrasi SDK untuk aliran kerja API serasi OpenAI anda.
URL Asas dan Pengesahan
Gunakan URL asas yang disediakan dan kunci API untuk setiap permintaan. Endpoint ialah https://api.ollamaendpoint.com/v1Pengesahan header sebagai token Bearer. Anda menjana kunci ini serta-merta selepas log masuk dengan Google atau e-mel. Kunci ini unik bagi setiap akaun dan menggantikan sebarang kunci aktif sebelumnya.
Permintaan Pertama
Hantar penyelesaian semakan piawai untuk menjana teks. Pengenal pasti model ialah uncensored dan menerima parameter yang sama seperti klien OpenAI standard. Ini berfungsi untuk tugas LLM NSFW atau penjanaan kandungan tanpa had.
- Kaedah: POST
- Titik akhir:
/v1/chat/completions - Model:
uncensored
curl https://api.ollamaendpoint.com/v1/chat/completions \
-H "Authorization: Bearer $API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "uncensored",
"messages": [{"role": "user", "content": "Get the local ip address of this machine"}]
}'
Respons berjaya mengembalikan teks yang dijana dalam pilihan array. Semak usage bidang untuk melihat jumlah token.
Integrasi SDK Python
Pasang perpustakaan rasmi OpenAI dan konfigurasikan URL asas. Ini membolehkan anda menggunakan model ollama tanpa sensor dengan kod Python yang sudah dikenali. Tetapkan base_url dan api_key sebelum menginisialisasi klien. Kod kekal serasi dengan SDK OpenAI sedia ada.
from openai import OpenAI
client = OpenAI(base_url="https://api.ollamaendpoint.com/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)
Panggil chat.completions.create kaedah seperti yang anda lakukan untuk GPT. Struktur respons sepadan dengan jangkaan standard. Anda boleh mengalir atau mendapatkan respons penuh.
Integrasi SDK Node
Gunakan pakej OpenAI Node.js untuk berinteraksi dengan API. Konfigurasikan klien dengan URL asas khusus dan kunci API anda. Pendekatan ini berfungsi untuk aplikasi sisi pelayan atau fungsi tepi. Pakej mengendalikan serialisasi dan percubaan semula secara automatik.
import OpenAI from "openai";
const client = new OpenAI({ baseURL: "https://api.ollamaendpoint.com/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);
Panggil penamat penyelesaian dengan prompt anda. Perpustakaan mengembalikan janji yang diselesaikan kepada objek respons. Tangani ralat mengikut kod status HTTP piawai.
Respons Streaming dengan SSE
Aktifkan aliran dengan menetapkan stream: true dalam permintaan anda. pelayan mengembalikan penstriman Acara Dihantar Pelayan (SSE). Setiap pecahan mengandungi teks separa dan data penggunaan token. Pecahan terakhir termasuk statistik penggunaan lengkap untuk pengebilan. Ini mengurangkan latensi yang dirasakan untuk output panjang.
stream = 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)
Kumpulkan bahagian kandungan daripada setiap bahagian untuk membina semula respons penuh. Proses ralat apabila ia tiba dalam aliran. Bahagian terakhir mengesahkan jumlah token untuk kredit pra-bayar anda.
Had had laju dan kekangan
Setiap kunci API menyokong 300 permintaan setiap minit dan 8 permintaan serentak. Saiz badan permintaan maksimum ialah 8 MB. Tetingkap konteks ialah 100,000 token untuk gabungan prompt dan penyelesaian. Had output ialah 16,000 token per permintaan. Ralat dan penolakan tidak menelan kredit. Ralat 401 bermaksud kunci anda tidak sah. Ralat 402 menunjukkan kredit pra-dibayar tidak mencukupi. Ralat 429 bermaksud anda mencapai had kadar. Laraskan kekoncurrenan anda untuk kekal dalam had.
FAQ
Apakah URL asas untuk hujung ollama?
URL asas ialah HTTPS://api.ollamaendpoint.com/v1. Gunakan ini untuk semua panggilan API. Ia serasi dengan klien OpenAI standard.
Bagaimana cara mengendalikan respons aliran?
Tetapkan parameter stream kepada true. API ini mengembalikan Server-Sent Events. Proses setiap segmen untuk membina teks akhir. Segmen terakhir termasuk data penggunaan.
Apa yang berlaku jika saya mencapai had kadar?
Anda menerima kod status 429. Hadnya ialah 300 permintaan setiap minit per kunci. Kurangkan kekonkurenan anda atau tunggu sebelum mencuba lagi. Permintaan serentak dihadkan kepada 8.
Dapatkan Kunci API anda
Daftar, ambil kunci, arahkan ke URL asas baru. Selesai.