Dokumentacja API Kimicode

Bazowy URL i autoryzacja

Połącz się z API, korzystając z podanego adresu bazowego i klucza tokena z góry opłaconego. Uwierzytelniasz się, przekazując swój klucz API w nagłówku żądania, co zapewnia, że tylko Twoje konto ma dostęp do kredytów. Zarejestruj się za pomocą Google lub e-maila, aby natychmiast otrzymać klucz bez weryfikacji telefonu.

Copycurl https://api.kimicodeapi.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "What is the current rate limit for free tier users?"}]
  }'

Twoje żądania kierują się do standardowego endpointu zgodnego z OpenAI. To rozwiązanie pozwala na podmianę naszej usługi bez przepisywania istniejącego kodu klienta, pod warunkiem aktualizacji podstawowego adresu URL i danych uwierzytelniających.

Punkt końcowy Uzupełnień Czat

Wyślij wiadomości do modelu za pomocą POST /v1/chat/completions endpoint. Musisz określić identyfikator modelu jako uncensored do dostępu do zoptymalizowanego dużego modelu językowego działającego na naszych serwerach. System akceptuje standardowe role wiadomości, takie jak user lub assistant, w rozmowach wieloetapowych.

Copyfrom openai import OpenAI

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

Ten punkt końcowy akceptuje wejście tekstowe i zwraca wygenerowany tekst. Nie obsługuje embeddingów, obrazów ani audio. Skup się na strukturze promptu, aby uzyskać najlepsze rezultaty od modelu bez cenzury.

Odpowiedzi strumieniowe (SSE)

Włącz dostarczanie tokenów w czasie rzeczywistym, ustawiając parametr stream na true w żądaniu. API zwraca fragmenty zdarzeń wysyłanych przez serwer (SSE), pozwalając Twojej aplikacji na wyświetlanie tekstu w miarę jego generowania. Ostatni fragment zawiera kompletne statystyki zużycia tokenów do celów rozliczeniowych.

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)

Strumieniowanie zmniejsza postrzeganą opóźnienie dla użytkowników końcowych. Możesz przetwarzać każdy token po jego przybyciu, co jest idealne dla interfejsów czatu. Pamiętaj, że strumieniowanie nie zmienia zachowania modelu ani opłat za tokeny.

Wywoływanie funkcji i narzędzia

Zdefiniuj narzędzia w żądaniu, aby pozwolić modelowi zwracać strukturalne wywołania funkcji. API obsługuje parametry tool_choice, pozwalając wymusić użycie przez model konkretnego narzędzia lub pozwolić mu na autonomiczną decyzję. Funkcja ta działa ze standardowymi formatami narzędzi OpenAI, co ułatwia integrację.

Copyimport OpenAI from "openai";

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

Używaj wywoływania funkcji do ekstrakcji danych lub uruchamiania akcji w swoich aplikacjach. Model interpretuje definicje narzędzi i zwraca obiekty JSON zawierające niezbędne argumenty. Ta możliwość rozszerza API poza prostą generację tekstu.

Tryb JSON i parametry

Wymuszaj ścisły output JSON poprzez ustawienie response_format do {"type": "json_object"}. Zapewnia to, że model zwraca poprawny JSON, co jest kluczowe do parsowania programistycznego. Możesz również dostosować parametry takie jak temperatura, top_p i sekwencje stop, aby kontrolować kreatywność i długość wyjścia.

Model obsługuje okno kontekstowe o rozmiarze 100 000 tokenów. Pozwala to na przekazywanie dużych ilości kontekstu w jednym żądaniu. Maksymalne wyjście to 16 000 tokenów w jednym żądaniu lub 2 048, jeśli nie określisz max_tokens.

Limity, Błędy i Kontekst

Monitoruj swoje limity zapytań, aby uniknąć przerw w usłudze. API pozwala na 300 zapytań na minutę na klucz i do 8 równoległych zapytań. Twoje ciało żądania musi mieścić się w limicie 8 MB. Jeśli przekroczysz te limity, otrzymasz błąd limitu szybkości 429.

Niepowodzenia uwierzytelniania zwracają błąd 401, jeśli klucz jest nieprawidłowy. Błąd 402 wskazuje na niewystarczające środki w koncie z góry opłaconym. Błędy podczas generowania nie zużywają Twoich tokenów. Okno kontekstu obejmuje tokeny promptu i uzupełnienia. Nieużyta kredyta nigdy nie wygasa, zapewniając, że Twoje środki w koncie z góry opłaconym pozostają dostępne do przyszłych projektów.