Rychlý start integrace Character api

Nainstalujte SDK

Začněte instalací oficiální klientské knihovny pro váš jazyk. To zajišťuje kompatibilitu s koncovým bodem kompatibilním s OpenAI, který poskytujeme. Knihovna za vás řeší serializaci a logiku opakování.

Pro Python použijte pip. Pro Node.js použijte npm. Tento krok trvá sekundy a nastaví prostředí pro následující vzory kódu.

Konfigurujte svou základní URL

Nasměrujte klienta SDK na náš endpoint pro přístup k modelu bez omezení. Základní URL je HTTPS://api.apicharacter.com/v1. Toto nahrazuje výchozí URL OpenAI ve vaší konfiguraci.

Bez této změny požadavky selžou nebo zasáhnou nesprávnou službu. Toto musíte nastavit pouze jednou při inicializaci instance klienta.

Nastavit svůj API klíč

Vložte svůj klíč do proměnné prostředí nebo konfigurace klienta. Pro každý požadavek je vyžadována autentizace pro sledování využití vašich předplacených kreditů. Váš klíč poskytuje přístup k endpointu nekorigované LLM.

Tuto hodnotu udržujte v bezpečí. Slouží jako váš jediný prokazatelný údaj pro účet. Pro základní přístup není potřeba telefonní číslo ani další ověření.

Provést váš první požadavek

Pošlete jednoduché dokončení chatu pro ověření připojení. ID modelu je „uncensored“. Tím potvrdíte, že vaše ověření a základní URL jsou správné, než začnete budovat aplikaci.

Vidět níže příklad pro standardní požadavek cURL.

Copycurl https://api.apicharacter.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "set my name to Alex"}]
  }'

Zpracování streamovaných odpovědí

Povolte streamování pro nižší latenci ve vašich chatových rozhraních. Nastavte parametr stream na true ve svém požadavku. SDK bude poskytovat tokeny, jak jsou generovány.

To je kritické pro responzivní uživatelské zážitky. Částečné bloky zpracováváte, jak přicházejí prostřednictvím Server-Sent Events.

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)

Limity, chyby a kontext

Chápejte svá omezení, abyste předešli přerušení služby. Máte k dispozici kontextové okno o velikosti 100,000 tokenů. Maximální výstup je 16,000 tokenů, pokud neurčíte jinak.

Limit rychlosti je 300 požadavků za minutu. Chyba 401 znamená neplatný klíč. Chyba 402 znamená nulový zůstatek. Chyba 429 znamená, že jste překročili limit rychlosti. Mějte to na paměti při škálování ve výrobě.

Python

Copyfrom openai import OpenAI

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

Node.js

Copyimport OpenAI from "openai";

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