Dokumentasi API

Mula Cepat untuk permintaan pertama anda

Mula menjana teks serta-merta dengan mengarahkan klien anda ke URL asas kami dan mengesahkan diri dengan kunci API yang dijana. Antara muka mengikut konvensyen standard, jadi anda boleh menggunakan SDK sedia ada tanpa mempelajari protokol baru. Anda akan menghantar prompt ke uncensored model dan terima respons teks yang tidak menggunakan penapis kandungan biasa untuk penggunaan dewasa yang sah.

Konfigurkan URL asas dan kunci

Tetapkan pembolehubah persekitaran anda untuk mengarahkan permintaan ke hujung titik khusus kami. Gantikan kunci tempat letak dengan yang dijana semasa pendaftaran. Ini memastikan semua panggilan seterusnya menggunakan contoh model uncensored yang betul.

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

Anda boleh mengesahkan kunci anda berfungsi dengan memeriksa endpoint model. Kunci yang sah akan memulangkan ID model yang tersedia serta-merta.

Hantar permintaan penyelesaian sembang

Payload penyelesaian chat standard untuk menjana teks. Sistem memproses input anda dan mengembalikan respons model. Gunakan uncensored ID model untuk memastikan anda mencapai instance tanpa penapis.

Respons termasuk teks yang dijana dan statistik penggunaan token. Anda boleh mengekstrak ini terus ke dalam logik 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 kod status HTTP standard untuk mengendalikan kes kejayaan atau kegagalan.

Aktifkan penstriman untuk output masa nyata

Alirkan respon untuk mengurangkan latensi yang dirasakan untuk pengguna anda. Dayakan aliran dengan menetapkan stream: true dalam badan permintaan anda. API ini mengembalikan siri Acara yang Dihantar Pelayan (SSE) yang mengandungi token separa.

Kumpulkan token ini di sisi klien untuk membina semula mesej penuh. Pendekatan ini sesuai untuk antara muka sembang di mana maklum balas segera amat penting. Acara SSE akhir mengandungi jumlah 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 ralat sambungan dengan baik untuk memastikan pengalaman pengguna yang lancar.

Gunakan mod JSON untuk data terstruktur

Paksa model untuk mengeluarkan JSON sah untuk penggunaan programatik. Tetapkan response_format ke {"type": "json_object"} dalam permintaan anda. Ini mengurangkan ralat penguraian dan memastikan struktur data yang konsisten.

Gunakan ini untuk menjana prompt berstruktur, mengekstrak entiti, atau membina kandungan dinamik. Model mematuhi kekangan format yang diberikan dalam arahan sistem anda. Ini penting untuk integrasi yang boleh dipercayai dengan perkhidmatan 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);

Sahkan output JSON di hujung anda untuk menangkap sebarang kes sempadan.

Laksanakan pemanggilan fungsi

Takrifkan alat untuk meluaskan keupayaan model. Lulus tools array with function definitions to the request. The model can choose to call these functions based on the context.

Ini membolehkan aliran kerja kompleks di mana LLM memutuskan bila untuk mendapatkan data atau melaksanakan tindakan. Anda menerima argumen fungsi dalam respons dan melaksanakannya di pihak anda. Hantar semula hasilnya kepada model untuk penalaran lanjut.

Tetapkan tool_choice ke auto untuk pembuatan keputusan yang fleksibel. Ciri ini menyokong senario roleplay lanjutan yang memerlukan akses data luaran.

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)