Guide de démarrage rapide de l'API Ollama

Configuration de l'URL de base et de l'authentification

Configurez votre client pour pointer vers notre point de terminaison hébergé. Définissez le base_url à https://api.apiollama.com/v1 et fournissez votre clé dans le Authorization header. L'authentification utilise le standard Bearer schéma. Vous pouvez générer une clé via Google ou e-mail sur le tableau de bord. Le système crée une clé active par compte.

Copycurl https://api.apiollama.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "list installed models"}]
  }'

Conservez votre clé en sécurité. Si vous avez besoin d'une clé fraîche, générez-en une nouvelle dans le tableau de bord et l'ancienne devient inactive immédiatement. Aucun numéro de téléphone n'est requis pour la configuration. Cette configuration fonctionne avec n'importe quel client compatible OpenAI.

POST /v1/chat/completions : Envoi des requêtes

Envoyez votre première requête de complétion de chat en utilisant le point de terminaison standard. Spécifiez l'ID du modèle comme uncensored dans le corps de la requête. L'API accepte des tableaux de messages standard contenant les rôles system, user et assistant. Cela fonctionne avec n'importe quel SDK qui prend en charge le format OpenAI. Assurez-vous d'inclure le model field in every request.

Copyfrom openai import OpenAI

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

Les requêtes sont traitées via nos serveurs. Le modèle répond par du texte généré en fonction de votre invite. Vous pouvez ajuster les paramètres tels que temperature ou top_p pour contrôler l'aléatoire. Le système retourne un objet de réponse complet contenant le contenu généré.

GET /v1/models : Liste des modèles disponibles

Interrogez le point de terminaison des modèles pour vérifier les options disponibles. Envoyez une requête GET à /v1/models pour lister les modèles hébergés. La réponse inclut le id field set to uncensored. Ce point de terminaison confirme que votre clé API dispose des autorisations valides. Il renvoie des métadonnées sur la configuration du modèle.

Copyimport OpenAI from "openai";

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

Utilisez cet appel pour déboguer les problèmes de connexion. Si le point de terminaison renvoie une erreur, vérifiez votre en-tête d'authentification. Le point de terminaison fournit une liste simple des modèles disponibles. Vous pouvez vérifier l'état du service sans envoyer une demande de chat complète.

Réponses en streaming avec les événements envoyés par le serveur

Activez le streaming en définissant le stream parameter à true. L'API retourne Server-Sent Events (SSE) pour la livraison de jetons en temps réel. Chaque chunk contient des mises à jour de contenu partiel. Le dernier chunk inclut les statistiques complètes d'utilisation des jetons. Cela réduit la latence perçue pour les réponses longues.

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)

Gérer le flux SSE dans le code de votre client. Traitez chaque événement à son arrivée. Le dernier événement contient le usage objet avec les comptes de jetons d'entrée et de sortie. Le streaming fonctionne avec tous les paramètres pris en charge. Il fournit un retour immédiat pour les applications interactives.

Paramètres de configuration : Température, Top-p et plus

Ajustez le comportement de génération à l'aide de paramètres standard. Définissez temperature pour l'aléatoire et top_p pour l'échantillonnage par noyau. Utilisez stop séquences pour interrompre la génération prématurément. Le seed le paramètre garantit des résultats reproductibles. Vous pouvez également définir presence_penalty et frequency_penalty pour le contrôle du style.

Le mode JSON est disponible via response_format. Définissez ceci sur json_object pour des sorties structurées. Le modèle respecte le format spécifié. Ces paramètres s'appliquent à toutes les requêtes. Utilisez-les pour affiner le style de réponse.

Gestion des erreurs et suivi de l'utilisation des tokens

Gérez les erreurs HTTP courantes dans votre application. Un statut 401 indique une clé API invalide. Un statut 402 signifie que votre crédit prépayé est épuisé. Un statut 429 signale que vous avez dépassé la limite de débit. Consultez le corps de la réponse pour des messages d'erreur détaillés. Les refus dus à la politique de contenu sont gratuits.

La fenêtre de contexte prend en charge 100 000 tokens au total. Le débit de sortie est limité à 2 048 tokens si max_tokens n'est pas défini. L'utilisation des jetons est rapportée dans le dernier fragment du flux. Les erreurs ne consomment pas de crédit.