API Augure

Créer une complétion de chat. Accepte le même format de requête que le point de terminaison de complétion de chat d’OpenAI.

Paramètres

Chaque message du tableau messages possède un role ("system", "user" ou "assistant") et un content de type chaîne.

Images et documents

content peut aussi être un tableau de parties. En plus des parties text, un message utilisateur peut contenir des parties image_url(PNG, JPEG, WebP ou GIF en data URL base64) et des parties file(un PDF en data URL base64). Les PDF sont lus par la passerelle : la couche texte est extraite directement, et les documents numérisés passent automatiquement par la reconnaissance de caractères (OCR). Envoyez le PDF lui-même plutôt qu’une image de ses pages; vous conservez le texte exact, et ça fonctionne avec tous les modèles.

curl -X POST https://api.augureai.ca/v1/chat/completions \
  -H "Authorization: Bearer VOTRE_CLE_API" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "ossington-5",
    "messages": [{
      "role": "user",
      "content": [
        {"type": "text", "text": "Extrais le numéro de facture, la date, le fournisseur et le total en JSON."},
        {"type": "file", "file": {
          "filename": "facture-2041.pdf",
          "file_data": "data:application/pdf;base64,JVBERi0xLjQK..."
        }}
      ]
    }]
  }'

import base64
from openai import OpenAI

client = OpenAI(api_key="VOTRE_CLE_API", base_url="https://api.augureai.ca/v1")
pdf = base64.b64encode(open("facture-2041.pdf", "rb").read()).decode()

response = client.chat.completions.create(
    model="ossington-5",
    messages=[{
        "role": "user",
        "content": [
            {"type": "text", "text": "Extrais le numéro de facture, la date, le fournisseur et le total en JSON."},
            {"type": "file", "file": {
                "filename": "facture-2041.pdf",
                "file_data": f"data:application/pdf;base64,{pdf}",
            }},
        ],
    }],
)
print(response.choices[0].message.content)

Chaque PDF peut faire jusqu’à 25 Mo et 200 pages, dans la limite de 35 Mo par requête. Une partie file accepte aussi les chiffriers (.xlsx ou .csv en data URL, 100 premières lignes de chaque feuille). Les images sont lues par notre moteur de vision et transmises au modèle sous forme de texte; ajoutez "augure_ocr": true à une partie image_url pour obtenir une transcription OCR mot à mot, sans description. La passerelle ne conserve aucune copie du fichier une fois la requête terminée.

Exemple de requête

curl -X POST https://api.augureai.ca/v1/chat/completions \
  -H "Authorization: Bearer VOTRE_CLE_API" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "ossington-5",
    "messages": [
      {"role": "system", "content": "Tu es un assistant utile."},
      {"role": "user", "content": "Qu'est-ce que le Code civil du Québec?"}
    ]
  }'

Exemple de réponse

{
  "id": "chatcmpl-a9adf17e-5ff3-4804-b01e-f7cbd30ae996",
  "object": "chat.completion",
  "created": 1771286577,
  "model": "ossington-5",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "Le Code civil du Québec (CCQ) est..."
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 24,
    "completion_tokens": 150,
    "total_tokens": 174
  },
  "_augure": {
    "gateway_region": "ca-montreal-1",
    "inference_region": "augure-cloud",
    "request_id": "a9adf17e-5ff3-4804-b01e-f7cbd30ae996"
  }
}

Streaming

Définissez "stream": true pour recevoir des événements Server-Sent Events. Chaque événement est un fragment JSON contenant un objet delta avec le contenu incrémental. Le flux se termine par data: [DONE]. Ajoutez "stream_options": {"include_usage": true} pour recevoir, juste avant, un dernier fragment contenant l’objet usage(avec un tableau choices vide).

curl -N -X POST https://api.augureai.ca/v1/chat/completions \
  -H "Authorization: Bearer VOTRE_CLE_API" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "tofino-2.5",
    "messages": [{"role": "user", "content": "Bonjour"}],
    "stream": true
  }'

Consommation et coût

Chaque réponse contient un objet usage avec prompt_tokens, completion_tokens et total_tokens; multipliez par les tarifs de chaque modèle ci-dessus pour connaître le coût d’un appel. Votre tableau de bord développeur présente les mêmes chiffres par modèle, par jour et par clé, avec le coût en dollars canadiens aux tarifs publiés. Le texte extrait d’un PDF joint compte dans les jetons d’entrée comme n’importe quel autre contenu.