Documentation API Ollama : Guide de démarrage rapide
Ce guide fournit les détails concrets de notre API compatible OpenAI, vous permettant de remplacer notre modèle sans censure sans modifier votre code client existant.
URL de base et authentification
L'URL de base est HTTPS://api.ollamaapidocs.com/v1. Transmettez votre clé dans l'en-tête Authorization standard.
curl https://api.ollamaapidocs.com/v1/chat/completions \
-H "Authorization: Bearer $API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "uncensored",
"messages": [{"role": "user", "content": "List installed models in the local directory"}]
}'Point de terminaison Chat Completions
Envoyez des requêtes POST à /v1/chat/completions avec le modèle défini sur uncensored.
from openai import OpenAI
client = OpenAI(base_url="https://api.ollamaapidocs.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)Support du streaming et des outils
Activez le streaming en définissant stream à true. L'API renvoie des jetons via des événements envoyés par le serveur et prend en charge l'appel de fonction.
stream = 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)Mode JSON et paramètres
Utilisez response_format json_object pour une sortie JSON stricte. Vous pouvez également ajuster la température, top_p et les séquences d'arrêt.
import OpenAI from "openai";
const client = new OpenAI({ baseURL: "https://api.ollamaapidocs.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);Limites de débit et contraintes
La limite est de 300 requêtes par minute par clé. Chaque requête prend en charge une fenêtre de contexte de 100 000 jetons.
curl https://api.ollamaapidocs.com/v1/chat/completions \
-H "Authorization: Bearer $API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "uncensored",
"messages": [{"role": "user", "content": "List installed models in the local directory"}]
}'Erreurs et fenêtre de contexte
Gérez les erreurs 401 pour les clés invalides, 402 pour l'absence de crédit et 429 pour les limites de débit. Le modèle prend en charge une fenêtre de contexte de 100,000 tokens.
from openai import OpenAI
client = OpenAI(base_url="https://api.ollamaapidocs.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)Questions fréquentes
Quelles sont les documents de l'API ollama pour ce service ?
Ce guide couvre l'URL de base, l'authentification et les endpoints de notre API hébergée. Il vous permet d'utiliser les SDK OpenAI standards avec notre modèle sans censure.
Comment gérer les réponses en streaming ?
Définissez le paramètre stream sur true dans votre requête. L'API renvoie des jetons via des Server-Sent Events, permettant un traitement en temps réel.
Que se passe-t-il si je dépasse la limite de taux ?
Vous recevrez un code d'état 429. La limite est de 300 requêtes par minute par clé, avec un maximum de 8 requêtes simultanées.
Générez votre clé API
Inscrivez-vous, copiez votre clé, et mettez à jour l'URL de base. C'est tout ce dont vous avez besoin pour commencer.
