API-dokumentaatio

Pika-aloitus ensimmäisellä pyynnöllä

Aloita tekstin generointi heti osoittamalla asiakasohjelmasi base URL:iimme ja todentamalla generoidulla API-avaimella. Liittymä noudattaa standardikäytäntöjä, joten voit käyttää olemassa olevia SDK:ita oppimatta uutta protokollaa. Lähetät syötteet uncensored malli ja vastaanota tekstivastauksia, jotka eivät sovelle tyypillisiä sisällönsuodattimia lailliseen aikuis käyttöön.

Määritä base URL ja avain

Aseta ympäristömuuttujasi ohjaamaan pyynnöt tiettyyn päätepisteeseemme. Korvaa paikkamerkkia vastaava avain rekisteröitymisen aikana luodulla avaimella. Tämä varmistaa, että kaikki myöhempät kutsut käyttävät oikeaa epärajoittavan mallin instanssia.

• Base URL: https://api.nsfwlocalllm.com/v1
• Auth-otsake: Authorization: Bearer YOUR_API_KEY

Voit varmistaa avaimen toimivan tarkistamalla models-päätepisteen. Voimassa oleva avain palauttaa saatavilla olevan mallitunnuksen välittömästi.

Lähetä chat-päättöpyyntö

Lähetä vakio chat-completion payload tekstin luomiseksi. Järjestelmä käsittelee syötteesi ja palauttaa mallin vastauksen. Käytä kohdetta uncensored malli-ID varmistaaaksesi, että osut suodattamattomaan instanssiin.

Vastaus sisältää luodun tekstin ja token-käystilastot. Voit jäsentää tämän suoraan sovelluslogiikkaasi.

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"}]
  }'

Tarkista standardit HTTP-vastauskoodit onnistumisen tai epäonnistumisen käsittelyyn.

Ota suoratoisto käyttöön reaaliaikaiseen tulostukseen

Streamaa vastauksia käyttäjien kokonaisviiveen vähentämiseksi. Ota streamaus käyttöön asettamalla stream: true pyyntörunkossa. API palauttaa sarjan palveluntason tapahtumia (SSE) sisältäviä osittaisia tokenia.

Kasakoi nämä tokenit asiakkaan puolella rekonstruoidaksesi koko viestin. Tämä lähestymistapa on ihanteellinen keskustelujärjestelyille, joissa välitön palaute on tärkeää. Viimeinen SSE-tapahtuma sisältää pyynnön kokonaistokenkäytön.

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)

Käsittele yhteyden virheet joustavasti varmistaksesi sujuvan käyttökokemuksen.

Käytä JSON-tilaa rakenteelliseen dataan

Pakota malli tuottamaan kelvollinen JSON ohjelmoitavaa käyttöä varten. Aseta response_format vastaan {"type": "json_object"} pyynnössäsi. Tämä vähentää jäennysvirheitä ja varmistaa johdonmukaiset datastruktuurit.

Käytä tätä rakenteellisten promptien luomiseen, entiteettien erittämiseen tai dynaamisen sisällön rakentamiseen. Malli noudattaa järjestelmäohjeissasi annettuja muotoilurajoituksia. Tämä on kriittistä luotettavaan integrointiin muiden palveluiden kanssa.

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);

Varmista ulostulon JSON lopullisessa päässä havaitaksesi reunatapaukset.

Ota funktiokutsut käyttöön

Laajenna mallin toimintakykyjä määrittelemällä työkalut. Välitä tools tietorakenteella funktiomäärittelyineen pyyntöön. Malli voi valita kutsua näitä funktioita kontekstin perusteella.

Tämä mahdollistaa monimutkaiset työvuot, joissa LLM päättää, milloin hakea dataa tai suorittaa toimintoja. Saat funktioparametrit vastauksesta ja suoritat ne omalla puolellasi. Palauta tulokset mallille lisäpäättelyä varten.

Aseta tool_choice vastaan auto joustavaan päätöksentekoon. Tämä ominaisuus tukee edistyneitä roolipelausskenaarioita, jotka vaativat ulkoisen datan käyttöä.

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)