Τεκμηρίωση API

Γρήγορη Έναρξη: Το πρώτο σας request

Στείλτε το πρώτο μήνυμα στο uncensored μοντέλο αμέσως. Χρησιμοποιήστε το τυπικό endpoint chat-completions για να δημιουργήσετε κείμενο. Το μοντέλο απαντά σε prompts φυσικής γλώσσας χωρίς απορρίψεις περιεχομένου για νόμιμη χρήση ενήλικων. Αυτή η ρύθμιση λειτουργεί με οποιοδήποτε OpenAI-compatible client.

Ξεκινήστε εγκαθιστώντας το SDK για τη γλώσσα που προτιμάτε. Στη συνέχεια, διαμορφώστε το κλειδί API σας. Το παρακάτω παράδειγμα δείχνει μια βασική αίτηση curl για δοκιμή σύνδεσης.

Μπορείτε να προσαρμόσετε παραμέτρους όπως η θερμοκρασία (temperature) για να ελέγξετε την τυχαιότητα. Η απάντηση επιστρέφει το παραγόμενο κείμενο απευθείας. Αυτή η απλή ροή σας επιτρέπει να επαληθεύσετε ότι το API λειτουργεί πριν χτίσετε πιο πολύπλοκη λογική.

Copycurl https://api.apiaicharacter.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 API rate limit status?"}]
  }'

Βασικό URL και Αυθεντικοποίηση

Συνδεθείτε χρησιμοποιώντας τη dedikated βασική διεύθυνση URL για αυτό το API. Αντικαταστήστε την προεπιλεγμένη διαδρομή με τη διεύθυνση του hosted server μας. Αυτό διασφαλίζει ότι τα αιτήματά σας φτάνουν απευθείας στο uncensored μοντέλο. Η πιστοποίηση βασίζεται σε ένα μοναδικό κλειδί API ανά λογαριασμό.

Δημιουργήστε το κλειδί σας μέσω του πίνακα ελέγχου. Περάστε το στην κεφαλίδα Authorization ως Bearer token. Αυτή η μέθοδος είναι συμβατή με τα τυπικά OpenAI SDKs. Μπορείτε να εναλλάξετε παρόχους αλλάζοντας μόνο τη βάση URL και το κλειδί.

Κρατήστε το κλειδί σας ασφαλές. Παρέχει πλήρη πρόσβαση στο προκαταβλημένο credit σας. Το κλειδί αντικαθιστά οποιοδήποτε προηγούμενο ενεργό κλειδί αμέσως μετά τη δημιουργία.

Τερματικά σημεία: Chat Completions

Αλληλεπιδράστε με το μοντέλο μέσω του endpoint chat completions. Αυτό είναι το μόνο διαθέσιμο endpoint παραγωγής κειμένου. Δέχεται μηνύματα και επιστρέφει παραγόμενο κείμενο. Δεν υποστηρίζονται embeddings, εικόνες ή ήχος.

Στείλτε μια αίτηση POST στο route chat. Συμπεριλάβετε τα system και user messages σας στο body. Το μοντέλο επεξεργάζεται το context και παράγει μια απάντηση. Μπορείτε να χρησιμοποιήσετε JSON mode για δομημένη έξοδο.

Υποστηρίζεται η κλήση συναρτήσεων. Ορίστε εργαλεία και αφήστε το μοντέλο να αποφασίσει πότε να τα χρησιμοποιήσει. Αυτή η ευελιξία επιτρέπει σύνθετες ροές εργασιών για πράκτορες. Η απάντηση περιλαμβάνει το παραγόμενο περιεχόμενο και τη χρήση tokens.

Copyfrom openai import OpenAI

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

Παράμετροι: Temperature, Top P, και Stop

Ελέγξτε το στυλ εξόδου χρησιμοποιώντας τυπικές παραμέτρους. Προσαρμόστε το temperature για να αλλάξετε τη δημιουργικότητα. Οι χαμηλότερες τιμές κάνουν τις απαντήσεις πιο ντετερμινιστικές. Οι υψηλότερες τιμές εισάγουν περισσότερη ποικιλία.

Χρησιμοποιήστε το top P για φιλτράρισμα απίθανων λέξεων. Αυτό βοηθά στη διατήρηση της συνοχής επιτρέποντας ταυτόχρονα τη δημιουργικότητα. Ορίστε ακολουθίες διακοπής (stop sequences) για να τερματίσετε τη δημιουργία σε συγκεκριμένους δείκτες. Αυτό είναι χρήσιμο για τον έλεγχο της δομής της συνομιλίας.

Η παράμετρος seed επιτρέπει την αναπαραγωγιμότητα των αποτελεσμάτων. Χρησιμοποιήστε την όταν αποσφαλματώνετε τα prompts σας. Αυτές οι παράμετροι σας δίνουν ακριβέ έλεγχο στη συμπεριφορά του μοντέλου. Ρυθμίστε τις για να ταιριάζουν στις ανάγκες της εφαρμογής σας.

Copyimport OpenAI from "openai";

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

Ροή και Χρήση Tokens

Λάβετε απαντήσεις σε πραγματικό χρόνο χρησιμοποιώντας server-sent events. Το streaming μειώνει την αντιλαμβανόμενη καθυστέρηση για τους χρήστες. Το API στέλνει tokens καθώς παράγονται. Αυτό δημιουργεί μια ομαλότερη εμπειρία ανάγνωσης.

Η χρήση tokens αναφέρεται στο τελικό chunk. Αυτό σας επιτρέπει να παρακολουθείτε το κόστος με ακρίβεια. Η χρέωση βασίζεται στα πραγματικά καταναλωθέντα tokens. Τα σφάλματα και οι απορρίψεις δεν επιβαρύνουν με κόστος.

Εφαρμόστε έναν stream handler για να επεξεργαστεί τα δεδομένα. Ενημερώστε το UI καθώς φτάνουν tokens. Αυτή η προσέγγιση είναι ιδανική για διεπαφές chat. Το μοντέλο υποστηρίζει streaming για όλους τους τύπους αιτήσεων.

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)

Όρια Ρυθμού και Περιορισμοί

Κατανοήστε τα όρια για να αποφύγετε διακοπές υπηρεσίας. Μπορείτε να κάνετε 300 αιτήματα ανά λεπτό ανά κλειδί. Τα ταυτόχρονα αιτήματα περιορίζονται σε οκτώ ταυτόχρονα. Το σώμα του αιτήματος δεν πρέπει να υπερβαίνει τα 8 MB.

Διαχειριστείτε τα σφάλματα με χάρη. Η κατάσταση 401 σημαίνει ότι το κλειδί σας είναι μη έγκυρο. Η κατάσταση 402 υποδηλώνει ανεπαρκές υπόλοιπο. Η κατάσταση 429 σηματοδολεί ότι έφτασατε το όριο ρυθμού.

Το παράθυρο συμφραζομένων υποστηρίζει συνολικά 100,000 tokens. Αυτό περιλαμβάνει τόσο την εντολή εισόδου όσο και την απάντηση. Η μέγιστη έξοδος είναι 16,000 tokens ανά αίτημα. Ορίστε το max_tokens για να ελέγξετε το μήκος της εξόδου. Τα σφάλματα είναι δωρεάν, οπότε η λογική επανάληψης είναι ασφαλής.