Aller au contenu
SDK

SDK

N'importe quel SDK OpenAI ou Anthropic fonctionne tel quel.

Shannon parle les formats OpenAI et Anthropic sur le réseau, donc vous utilisez tels quels les SDK officiels des deux. Vous changez trois valeurs dans le client : l'URL de base, la clé API et l'id du modèle. Le reste de votre code ne change pas.

Ce qu'il faut régler

Réglage SDK OpenAI SDK Anthropic
URL de base https://api.shannon-ai.com/v1 https://api.shannon-ai.com
Clé API Votre clé Shannon. Le SDK l'envoie comme Authorization: Bearer. Votre clé Shannon. Le SDK l'envoie comme x-api-key.
Modèle Un id de modèle publié, par exemple shannon-3. Un id de modèle publié, par exemple shannon-1.6-lite.
Points de terminaison atteints /v1/chat/completions, /v1/responses, /v1/models /v1/messages, /v1/messages/count_tokens
Variables d'environnement OPENAI_API_KEY et OPENAI_BASE_URL, lues par les SDK Python et JavaScript quand vous ne passez aucune valeur. ANTHROPIC_API_KEY et ANTHROPIC_BASE_URL, lues par les SDK Python et TypeScript quand vous ne passez aucune valeur.

Les deux URL de base diffèrent par /v1 : un SDK OpenAI ajoute /chat/completions à son URL de base, un SDK Anthropic ajoute /v1/messages. Un nom de modèle que Shannon ne publie pas reçoit la réponse 400 avec unknown model. Modèles et tarifs

Votre clé se trouve sur la page Clés et utilisation. Clés et utilisation

SDK OpenAI

Les SDK OpenAI officiels appellent POST /v1/chat/completions et POST /v1/responses. Chaque exemple envoie un message d'utilisateur et affiche la réponse.

# pip install openai
from openai import OpenAI

client = OpenAI(
    api_key="YOUR_API_KEY",
    base_url="https://api.shannon-ai.com/v1",
)

response = client.chat.completions.create(
    model="shannon-3",
    messages=[{"role": "user", "content": "Hello, Shannon!"}],
)
print(response.choices[0].message.content)
Langage Installation Option d'URL de base Source
Python pip install openai base_url openai/openai-python
JavaScript / TypeScript npm install openai baseURL openai/openai-node
Go go get github.com/openai/openai-go/v3 option.WithBaseURL openai/openai-go
Java com.openai:openai-java baseUrl openai/openai-java
.NET dotnet add package OpenAI OpenAIClientOptions.Endpoint openai/openai-dotnet

Chaque champ des deux points de terminaison est décrit sur leurs propres pages. Chat Completions API Responses

SDK Anthropic

Les SDK Anthropic officiels appellent POST /v1/messages. Ils exigent max_tokens à chaque appel, donc les exemples utilisent shannon-1.6-lite, qui l'applique. Chaque exemple affiche les blocs de texte de la réponse.

# pip install anthropic
import anthropic

client = anthropic.Anthropic(
    api_key="YOUR_API_KEY",
    base_url="https://api.shannon-ai.com",
)

message = client.messages.create(
    model="shannon-1.6-lite",
    max_tokens=1024,
    messages=[{"role": "user", "content": "Hello, Shannon!"}],
)
for block in message.content:
    if block.type == "text":
        print(block.text)
Langage Installation Option d'URL de base Source
Python pip install anthropic base_url anthropics/anthropic-sdk-python
TypeScript npm install @anthropic-ai/sdk baseURL anthropics/anthropic-sdk-typescript
Go go get github.com/anthropics/anthropic-sdk-go option.WithBaseURL anthropics/anthropic-sdk-go
Java com.anthropic:anthropic-java baseUrl anthropics/anthropic-sdk-java

Le format Messages et ses différences sont sur la page de compatibilité Anthropic. Format anthropique

Ce sur quoi les SDK peuvent compter

  • Un champ de requête que l'API n'utilise pas est accepté. Un champ que l'API connaît, envoyé avec un mauvais type, reçoit la réponse 422.
  • Les en-têtes de version et de beta que les SDK ajoutent (anthropic-version, anthropic-beta, openai-beta) sont acceptés. Aucun n'est obligatoire.
  • Le model d'une réponse est l'id publié, donc vous pouvez le renvoyer tel quel.
  • Sur /v1/messages, une réponse peut commencer par un bloc thinking. Lisez les blocs de type text au lieu de prendre le premier bloc.
  • Le streaming fonctionne avec les helpers de flux propres au SDK. L'utilisation arrive à la fin de chaque flux.
  • Chaque réponse porte un en-tête x-request-id. Envoyez votre propre x-request-id et la même valeur revient.

SDK de la communauté

Les clients écrits pour l'API OpenAI par d'autres auteurs fonctionnent de la même façon : donnez au client l'URL de base avec /v1, votre clé et un id de modèle Shannon. Ils sont maintenus par leurs auteurs, pas par Shannon.

Langage Installation Client
Go go get github.com/sashabaranov/go-openai sashabaranov/go-openai
Ruby gem install ruby-openai alexrudall/ruby-openai
PHP composer require openai-php/client openai-php/client
Rust cargo add async-openai 64bit/async-openai

Sans SDK

Vous n'avez pas besoin d'un SDK. Tout client HTTP capable d'envoyer du JSON fonctionne :

  • POST avec un corps JSON et l'en-tête Content-Type: application/json. Sans lui, la requête reçoit la réponse 415.
  • Votre clé dans Authorization: Bearer <key> ou dans x-api-key: <key>. Les deux fonctionnent sur chaque point de terminaison.
  • Un corps jusqu'à 32 MiB.
  • Avec "stream": true, la réponse est un flux de server-sent events (text/event-stream). Lisez-la ligne par ligne et ne la mettez pas en tampon.
  • Une erreur est un corps JSON avec error.type et error.message, accompagné du statut HTTP.
curl https://api.shannon-ai.com/v1/chat/completions \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "shannon-3",
    "messages": [{"role": "user", "content": "Hello, Shannon!"}]
  }'

Pour les événements d'un flux et les types d'erreur, voir : Diffusion en continu Gestion des erreurs