Guide de démarrage pour les utilisateurs d'Ollama

Prérequis

Pour utiliser cette API, vous avez besoin d'un compte actif avec une clé API valide. Inscrivez-vous sur la page Obtenir la clé API en utilisant Google ou un e-mail et un mot de passe. Aucun numéro de téléphone n'est requis. Vous devez également disposer d'un SDK de langage pris en charge installé sur votre machine. Ce guide couvre Python et Node.js, les clients les plus courants pour les endpoints compatibles OpenAI. L'API sert un seul modèle sans censure identifié par uncensored. Il accepte le texte et retourne du texte. Il n'y a pas de fonctionnalités d'embedding, d'image ou d'audio. Toutes les requêtes sont envoyées à https://api.ollamaapi.cc/v1.

Installer le SDK

Installez le SDK officiel pour votre langage préféré. Pour Python, utilisez pip. Pour Node.js, utilisez npm. Ces bibliothèques gèrent automatiquement le protocole HTTP, la sérialisation JSON et le streaming. Vous n'avez pas besoin d'écrire des requêtes HTTP brutes sauf si vous préférez ce niveau de contrôle. Les SDK sont bien documentés et largement utilisés en production. Assurez-vous que votre environnement correspond aux exigences du SDK. Python 3.8+ et Node.js 18+ sont recommandés. Maintenez vos dépendances à jour pour éviter les problèmes de compatibilité avec les nouveaux paramètres de modèle.

Configurer le client

Définissez l'URL de base sur notre endpoint. C'est le seul changement de configuration nécessaire pour passer d'OpenAI à notre service sans censure. Transmettez votre clé API en tant qu'en-tête d'autorisation. Le SDK s'occupera du reste. Ne modifiez pas le nom du modèle en gpt-4 ou similaire ; utilisez uncensored. L'API suit strictement le protocole de chat-completions d'OpenAI. Tout client qui fonctionne avec OpenAI fonctionnera ici avec ces deux modifications. Cela rend la migration ou les tests A/B simples. Vous pouvez exécuter les deux API côte à côte pour comparer les sorties.

Envoyer la première requête

Effectuez une requête POST vers /v1/chat/completions. Incluez l’ID du modèle, le prompt système et le message de l’utilisateur. L’API renvoie une réponse textuelle. Si vous disposez de crédit, la requête aboutit. Si vous n’avez pas de crédit, vous obtenez une erreur 402. Si votre clé est invalide, vous obtenez une erreur 401. Ces erreurs sont standard et faciles à gérer dans le code. Le modèle n’accepte pas le contenu adulte légal, ce qui le rend utile pour l’écriture créative, la recherche en sécurité ou le chat sans censure. Consultez votre solde sur le tableau de bord si vous avez un doute sur le crédit restant.

Réponses en streaming

Activez le streaming en définissant stream: true. L'API retourne les tokens au fur et à mesure de leur génération. Cela réduit la latence perçue pour les utilisateurs. Le dernier chunk contient l'utilisation totale des tokens pour la facturation. Le streaming est pris en charge par tous les SDK officiels. Il est essentiel pour les interfaces de chat où vous souhaitez afficher le texte au fur et à mesure de son écriture. Le serveur envoie des Server-Sent Events (SSE). Votre bibliothèque cliente gère l'analyse. Vous n'avez pas besoin de gérer le flux d'événements manuellement sauf si vous construisez un client personnalisé.

Limites, erreurs et contexte

La fenêtre de contexte est de 100 000 tokens au total, avec une sortie maximale de 32 000 tokens. Les requêtes sont limitées à 300 par minute et à 8 requêtes simultanées par clé. Le corps de la requête doit être inférieur à 8 Mo. Les erreurs incluent 401 pour les clés invalides, 402 pour le crédit insuffisant et 429 pour les limites de débit. Ce sont des codes HTTP standard. Gérez-les correctement dans votre application. Le modèle bloque le contenu sexuel impliquant des mineurs. Tout autre contenu est autorisé. Le crédit n'expire jamais, vous pouvez donc suspendre l'utilisation sans perdre vos fonds. Utilisez la page de support pour les problèmes de remboursement.

cURL

Copycurl https://api.ollamaapi.cc/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Write a blunt product review of a cheap VPN."}]
  }'

Python

Copyfrom openai import OpenAI

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

Node.js

Copyimport OpenAI from "openai";

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

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)