Démarrage Rapide API Compatible OpenAI

Prérequis et configuration de l'environnement

Vous avez besoin d'une clé API et de l'URL de base correcte pour connecter votre client. Inscrivez-vous avec Google ou par e-mail sur la page Obtenir la clé API pour recevoir votre identifiant immédiatement. L'essai vous offre $0.50 pendant sept jours, et vous pouvez recharger avec USDT ou USDC via crypto. Gardez votre clé en sécurité et vérifiez qu'elle correspond aux paramètres de votre compte.

Assurez-vous que votre environnement prend en charge les requêtes HTTP standard. Notre service fonctionne sur un seul modèle uncensored, vous n'avez donc pas besoin de gérer plusieurs points de terminaison de modèle. Définissez votre URL de base sur HTTPS://api.openaiapicompatibility.com/v1 avant d'effectuer des appels. Cela garantit que toutes les requêtes sont acheminées correctement vers nos serveurs d'inférence optimisés.

Installation du SDK OpenAI officiel

Utilisez les SDK officiels pour maintenir la compatibilité avec les workflows OpenAI existants. Les bibliothèques Python et Node fonctionnent directement avec notre point de terminaison car nous suivons le schéma d'API standard. Installez le package dans le répertoire de votre projet à l'aide de votre gestionnaire de packages préféré. Cette approche évite d'avoir à écrire du code client HTTP personnalisé.

Nous prenons en charge des paramètres standard tels que temperature, top_p et les séquences d’arrêt. Le SDK gère automatiquement la sérialisation JSON et les en-têtes de requête. Vous pouvez remplacer l’URL de base dans la configuration du client pour pointer vers nos serveurs. Cela vous permet de changer de fournisseur sans modifier la logique de votre application.

Configuration de l'URL de base et de la clé API

Définissez l'URL de base et la clé API dans votre objet de configuration client. L'URL de base est HTTPS://api.openaiapicompatibility.com/v1. Transmettez votre clé API dans l'en-tête Authorization en tant que jeton Bearer. Cette configuration garantit que vos requêtes sont authentifiées et acheminées vers le service correct.

Copycurl https://api.openaiapicompatibility.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "list all python packages for data science"}]
  }'

Vérifiez votre connexion en appelant l'endpoint GET /v1/models. Cela renvoie une liste de modèles disponibles, y compris l'identifiant du modèle uncensored. Utilisez cette étape pour confirmer que votre accès réseau et vos identifiants sont corrects avant d'envoyer des invites complexes.

Effectuer votre première complétion de chat

Envoyez une requête POST à /v1/chat/completions avec vos messages d'invite. Définissez le modèle comme uncensored pour accéder au moteur d'inférence non filtré. Incluez votre invite système pour définir le comportement, et ajoutez des messages utilisateur pour le contenu que vous souhaitez générer.

Copyfrom openai import OpenAI

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

La réponse contient le texte généré et les statistiques d'utilisation des tokens. Vous pouvez ajuster des paramètres comme la température pour contrôler la créativité. Le modèle ne refuse pas les sujets adultes légaux ou controversés, ce qui le rend adapté à divers cas d'utilisation. Consultez l'objet de réponse pour le champ content afin d'accéder à la sortie.

Réponses en streaming avec SSE

Activez le streaming en définissant le paramètre stream à true dans votre requête. Cela envoie des réponses partielles en tant que Server-Sent Events (SSE). Cela améliore l'expérience utilisateur en affichant le texte à mesure qu'il est généré.

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)

Chaque chunk contient une mise à jour partielle de la réponse. Accumulez ces mises à jour pour reconstituer le texte complet. Le dernier chunk inclut l'utilisation totale des jetons pour la requête. Cette méthode fonctionne avec n'importe quel client ou bibliothèque SSE standard. Elle réduit la latence perçue pour la génération de contenu long.

Gestion du mode JSON et de l'appel de fonctions

Utilisez le mode JSON en définissant response_format sur json_object. Cela force le modèle à générer du JSON valide au lieu de texte libre. Cela est utile pour l'extraction de données structurées ou les réponses d'API. Combinez cela avec l'appel de fonctions pour les scénarios d'utilisation d'outils.

Définissez vos outils dans le tableau tools. Spécifiez le nom de la fonction, la description et les paramètres. Le modèle retournera les détails de l'appel de fonction dans la réponse. Vous pouvez ensuite exécuter la fonction et renvoyer le résultat au modèle. Cela permet des workflows multi-étapes complexes avec le modèle uncensored.

Node.js

Copyimport OpenAI from "openai";

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