Szybki Start Integracji API Character

Zainstaluj SDK

Zacznij od zainstalowania oficjalnej biblioteki klienta dla Twojego języka. Zapewnia to kompatybilność z dostarczonym przez nas interfejsem kompatybilnym z OpenAI. Biblioteka zajmuje się za Ciebie serializacją i logiką ponawiania prób.

Dla Python użyj pip. Dla Node.js użyj npm. Ten krok trwa kilka sekund i konfiguruje środowisko dla następujących próbek kodu.

Skonfiguruj swój podstawowy URL

Wskaż klienta SDK na nasz punkt końcowy, aby uzyskać dostęp do nieograniczonego modelu. Adres bazowy to HTTPS://api.apicharacter.com/v1. Zastępuje to domyślny adres URL OpenAI w Twojej konfiguracji.

Bez tej zmiany żądania zakończą się niepowodzeniem lub trafią do niewłaściwej usługi. Musisz ustawić to tylko raz podczas inicjalizacji instancji klienta.

Ustaw swój klucz API

Wstrzyknij swój klucz do zmiennej środowiskowej lub konfiguracji klienta. Uwierzytelnianie jest wymagane w każdym żądaniu, aby śledzić zużycie kredytów z góry opłaconych. Twój klucz daje dostęp do punktu końcowego LLM bez ograniczeń.

Przechowuj tę wartość bezpiecznie. Działa jako Twoje jedyne poświadczenie do konta. Nie jest wymagany numer telefonu ani dodatkowa weryfikacja do podstawowego dostępu.

Wykonaj Swoje Pierwsze Żądanie

Wyślij proste uzupełnienie czatu, aby zweryfikować łączność. ID modelu to "uncensored". Potwierdza to poprawność Twojego klucza uwierzytelniającego i adresu URL bazowego przed rozpoczęciem budowania aplikacji.

Zobacz poniżej przykład standardowego żądania 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"}]
  }'

Obsługa odpowiedzi strumieniowych

Włącz strumieniowanie dla niższego opóźnienia w interfejsach czatu. Ustaw parametr stream na true w swoim żądaniu. SDK będzie zwracać tokeny w miarę ich generowania.

To jest krytyczne dla responsywnych doświadczeń użytkownika. Obsługujesz częściowe fragmenty, gdy przybywają za pośrednictwem 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, Błędy i Kontekst

Zrozum swoje ograniczenia, aby uniknąć przerw w usłudze. Masz okno kontekstowe 100 000 tokenów. Maksymalna odpowiedź to 16 000 tokenów, chyba że określisz inaczej.

Limit zapytań wynosi 300 zapytań na minutę. Błąd 401 oznacza nieprawidłowy klucz. Błąd 402 oznacza brak środków. Błąd 429 oznacza przekroczenie limitu. Pamiętaj o tym przy skalowaniu w środowisku produkcyjnym.

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