Dokumentasi API

Memulai permintaan pertama Anda

Mulai menghasilkan teks segera dengan mengarahkan klien Anda ke URL dasar kami dan mengautentikasi dengan kunci API yang dihasilkan. Antarmuka mengikuti konvensi standar, sehingga Anda dapat menggunakan SDK yang ada tanpa mempelajari protokol baru. Anda akan mengirim prompt ke uncensored model dan terima respons teks yang tidak menerapkan filter konten biasa untuk penggunaan dewasa yang sah.

Konfigurasi URL dasar dan kunci

Atur variabel lingkungan Anda untuk mengarahkan permintaan ke endpoint khusus kami. Ganti kunci placeholder dengan kunci yang dihasilkan saat pendaftaran. Ini memastikan semua panggilan berikutnya menggunakan instance model uncensored yang benar.

• URL Dasar: https://api.nsfwlocalllm.com/v1
• Header Auth: Authorization: Bearer YOUR_API_KEY

Anda dapat memverifikasi bahwa kunci Anda berfungsi dengan memeriksa endpoint model. Kunci yang valid segera mengembalikan ID model yang tersedia.

Kirimkan permintaan penyelesaian obrolan

Kirimkan payload completion chat standar untuk menghasilkan teks. Sistem memproses input Anda dan mengembalikan respons model. Gunakan uncensored ID model untuk memastikan Anda mencapai instance tanpa filter.

Respons mencakup teks yang dihasilkan dan statistik penggunaan token. Anda dapat memparse ini langsung ke dalam logika aplikasi Anda.

Copycurl https://api.nsfwlocalllm.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Send me the server uptime stats"}]
  }'

Periksa kode status HTTP standar untuk menangani kasus sukses atau gagal.

Aktifkan streaming untuk output real-time

Stream respons untuk mengurangi latensi yang dirasakan bagi pengguna Anda. Aktifkan streaming dengan mengatur stream: true dalam badan permintaan Anda. API mengembalikan serangkaian Server-Sent Events (SSE) yang berisi token parsial.

Agregasi token ini di sisi klien untuk merekonstruksi pesan lengkap. Pendekatan ini ideal untuk antarmuka obrolan di mana umpan balik segera sangat penting. Peristiwa SSE terakhir berisi total penggunaan token untuk permintaan tersebut.

Copyfrom openai import OpenAI

client = OpenAI(base_url="https://api.nsfwlocalllm.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)

Tangani kesalahan koneksi dengan baik untuk memastikan pengalaman pengguna yang lancar.

Gunakan mode JSON untuk data terstruktur

Paksa model untuk menghasilkan JSON valid untuk konsumsi pemrograman. Atur response_format ke {"type": "json_object"} dalam permintaan Anda. Ini mengurangi kesalahan parsing dan memastikan struktur data yang konsisten.

Gunakan ini untuk menghasilkan prompt terstruktur, mengekstrak entitas, atau membangun konten dinamis. Model mematuhi batasan format yang diberikan dalam instruksi sistem Anda. Ini sangat penting untuk integrasi yang andal dengan layanan lain.

Copyimport OpenAI from "openai";

const client = new OpenAI({ baseURL: "https://api.nsfwlocalllm.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);

Validkan output JSON di sisi Anda untuk menangkap kasus tepi.

Terapkan pemanggilan fungsi

Tentukan alat untuk memperluas kemampuan model. Lulus tools array dengan definisi fungsi ke permintaan. Model dapat memilih untuk memanggil fungsi-fungsi ini berdasarkan konteks.

Ini memungkinkan alur kerja kompleks di mana LLM memutuskan kapan harus mengambil data atau melakukan tindakan. Anda menerima argumen fungsi dalam respons dan mengeksekusinya di sisi Anda. Kirimkan kembali hasilnya ke model untuk penalaran lebih lanjut.

Atur tool_choice ke auto untuk pengambilan keputusan yang fleksibel. Fitur ini mendukung skenario roleplay lanjutan yang membutuhkan akses data eksternal.

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)