Fara í efni
SDK

SDK

Öll OpenAI og Anthropic SDK virka beint úr kassanum.

Shannon talar bæði OpenAI og Anthropic samskiptasniðin, svo þú notar opinberu SDK beggja óbreytt. Þú breytir þremur gildum í biðlaranum: base URL, API lyklinum og líkanaauðkenninu. Restin af kóðanum þínum helst eins.

Hvað á að stilla

Stilling OpenAI SDK Anthropic SDK
Base URL https://api.shannon-ai.com/v1 https://api.shannon-ai.com
API lykill Shannon lykillinn þinn. SDK sendir hann sem Authorization: Bearer. Shannon lykillinn þinn. SDK sendir hann sem x-api-key.
Líkan Útgefið líkanaauðkenni, til dæmis shannon-3. Útgefið líkanaauðkenni, til dæmis shannon-1.6-lite.
Endapunktar sem það nær til /v1/chat/completions, /v1/responses, /v1/models /v1/messages, /v1/messages/count_tokens
Umhverfisbreytur OPENAI_API_KEY og OPENAI_BASE_URL, lesnar af Python og JavaScript SDK þegar þú gefur ekkert gildi. ANTHROPIC_API_KEY og ANTHROPIC_BASE_URL, lesnar af Python og TypeScript SDK þegar þú gefur ekkert gildi.

Base URL-in tvö eru mismunandi um /v1: OpenAI SDK bætir /chat/completions við base URL sitt, Anthropic SDK bætir við /v1/messages. Líkanaheiti sem Shannon gefur ekki út fær svarið 400 og unknown model. Líkön og verð

Lykillinn þinn er á síðunni Keys & usage. Lyklar og notkun

OpenAI SDK

Opinberu OpenAI SDK safnsöfnin kalla á POST /v1/chat/completions og POST /v1/responses. Hvert dæmi sendir ein notendaskilaboð og prentar svarið.

# 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)
Tungumál Uppsetning Base URL valkostur Uppspretta
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

Hver reitur beggja endapunktanna er lýst á þeirra eigin síðum. Chat Completions Responses API

Anthropic SDK

Opinberu Anthropic SDK safnsöfnin kalla á POST /v1/messages. Þau krefjast max_tokens í hverju kalli, svo dæmin nota shannon-1.6-lite, sem tekur tillit til þess. Hvert dæmi prentar textablokkir svarsins.

# 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)
Tungumál Uppsetning Base URL valkostur Uppspretta
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

Messages sniðið og munur þess er á síðunni um Anthropic samhæfni. Anthropic

Hverju SDK geta treyst á

  • Beiðnisreitur sem API notar ekki er samþykktur. Reitur sem API þekkir, sendur með rangri gerð, fær svarið 422.
  • Útgáfu- og beta-hausarnir sem SDK bæta við (anthropic-version, anthropic-beta, openai-beta) eru samþykktir. Enginn þeirra er nauðsynlegur.
  • model í svari er útgefna auðkennið, svo þú getur sent það til baka óbreytt.
  • Á /v1/messages getur svar byrjað á thinking blokk. Lestu blokkir af gerðinni text í stað þess að taka fyrstu blokkina.
  • Streymi virkar í gegnum streymishjálpara SDK sjálfs. Notkun berst í lok hvers streymis.
  • Hvert svar ber x-request-id haus. Sendu þitt eigið x-request-id og sama gildi kemur til baka.

SDK frá samfélaginu

Biðlarar sem aðrir höfundar hafa skrifað fyrir OpenAI API virka á sama hátt: gefðu biðlaranum base URL með /v1, lykilinn þinn og Shannon líkanaauðkenni. Höfundar þeirra viðhalda þeim, ekki Shannon.

Tungumál Uppsetning Biðlari
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

Án SDK

Þú þarft ekki SDK. Hver HTTP-biðlari sem getur sent JSON virkar:

  • POST með JSON-meginmáli og hausnum Content-Type: application/json. Án hans er beiðninni svarað með 415.
  • Lykillinn þinn í Authorization: Bearer <key> eða í x-api-key: <key>. Hvort tveggja virkar á öllum endapunktum.
  • Meginmál allt að 32 MiB.
  • Með "stream": true er svarið server-sent event straumur (text/event-stream). Lestu hann línu fyrir línu og biðminnisgeymdu hann ekki.
  • Villa er JSON-meginmál með error.type og error.message, ásamt HTTP-stöðunni.
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!"}]
  }'

Um atburði streymis og villugerðir, sjá: Streymi Villumeðhöndlun