Dokumentacja API: Quickstart Guide

Bazowy URL i autoryzacja

API Heretic AI jest w pełni kompatybilne z OpenAI. Wchodzisz z nim w interakcję, wskazując swojego klienta na nasz bazowy adres URL: https://api.hereticai.cc/v1. Uwierzytelnianie opiera się na jednym kluczu API na konto, generowanym natychmiast po rejestracji za pomocą Google lub e-maila. Przekaż ten klucz w Authorization nagłówek jako token Bearer. Identyfikator modelu to po prostu uncensored. Ten pojedynczy model obsługuje wszystkie Twoje żądania bez złożoności routingu. Błędy takie jak 401 oznaczają nieprawidłowy klucz, a 402 oznacza, że potrzebujesz więcej środków kryptowalutowych prepayd.

Copycurl https://api.hereticai.cc/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "generate twenty test cases"}]
  }'

Punkt końcowy Uzupełnień Czat

Wyślij żądania generowania tekstu używając POST /v1/chat/completions endpoint. API oczekuje standardowej tablicy wiadomości zawierającej historię rozmowy lub prompt. Zwraca wygenerowany tekst w choices tablicy. Jest to czysty interfejs API: tekst na wejściu, tekst na wyjściu. Płacisz tylko za zużyte tokeny. Kredyty prepay nie wygasają, a odrzucenia lub błędy nie kosztują tokenów. Podejście to eliminuje blokady subskrypcyjne i nieprzewidywalne darmowe poziomy.

Copyfrom openai import OpenAI

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

Odpowiedzi strumieniowe (SSE)

Włącz strumieniowanie tokenów w czasie rzeczywistym, ustawiając stream: true w Twoim żądaniu. API zwraca zdarzenia wysyłane przez serwer (SSE) dla każdego wygenerowanego tokena. Pozwala to na stopniowe wyświetlanie wyniku, co jest kluczowe dla aplikacji wrażliwych na opóźnienia. Statystyki użycia tokenów pojawiają się w ostatniej cząstce strumienia. Ta funkcja działa bezproblemowo ze standardowymi SDK OpenAI, które automatycznie obsługują SSE. Zapewnia natychmiastową informację zwrotną bez czekania na pełne uzupełnienie.

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)

Wywoływanie funkcji i narzędzia

API obsługuje wywoływanie funkcji z tools i tool_choice parametry. Zdefiniuj schematy swoich narzędzi w żądaniu, a model zwróci strukturyzowane wywołania funkcji, gdy będzie to odpowiednie. Umożliwia to złożone przepływy pracy, w których LLM decyduje, jakie działanie podjąć dalej. Możesz wymusić konkretne użycie narzędzi lub pozwolić modelowi na swobodny wybór. Ta funkcjonalność jest kluczowa przy budowaniu aplikacji agencjalnych, które interagują z systemami zewnętrznymi lub bazami danych.

Tryb JSON

Zapewnij deterministyczne wyniki poprzez ustawienie response_format do {"type": "json_object"}.Model ograniczy swoją odpowiedź do poprawnego formatu JSON, co jest kluczowe dla parsowania programistycznego. Zmniejsza to potrzebę poprawek regex po przetworzeniu. Gwarantuje, że wyjście może być bezpośrednio konsumowane przez Twój kod. Jest to szczególnie przydatne w zadaniach ekstrakcji danych strukturalnych lub generowania konfiguracji.

Parametry i limity

Kontroluj generowanie za pomocą standardowych parametrów takich jak temperature, top_p, a także seed. Okno kontekstowe ma pojemność 100,000 tokenów dla promptu plus uzupełnienia. Maksymalna ilość wyjściowa to 16,000 tokenów na żądanie, lub 2,048 jeśli max_tokens jest nieustawione. Limity szybkości to 300 żądań na minutę i 8 jednoczesnych żądań na klucz. Ciało żądania musi mieścić się w limicie 8 MB. Limity te zapewniają stabilne użytkowanie w dużych skalach dla programistów.

Node.js

Copyimport OpenAI from "openai";

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