కంటెంట్‌కు వెళ్లండి
SDKలు

SDKలు

ఏ OpenAI లేదా Anthropic SDK అయినా వెంటనే పనిచేస్తుంది.

Shannon OpenAI మరియు Anthropic వైర్ ఫార్మాట్‌లను రెండింటినీ అర్థం చేసుకుంటుంది, కాబట్టి మీరు రెండింటి అధికారిక SDKలను ఉన్నవి ఉన్నట్లే వాడవచ్చు. క్లయింట్‌లో మూడు విలువలను మారుస్తారు: base URL, API కీ మరియు మోడల్ id. మీ కోడ్‌లో మిగతాది అలాగే ఉంటుంది.

ఏమి సెట్ చేయాలి

సెట్టింగ్ OpenAI SDKలు Anthropic SDKలు
Base URL https://api.shannon-ai.com/v1 https://api.shannon-ai.com
API కీ మీ Shannon కీ. SDK దాన్ని Authorization: Bearer గా పంపుతుంది. మీ Shannon కీ. SDK దాన్ని x-api-key గా పంపుతుంది.
మోడల్ ప్రచురించిన మోడల్ id, ఉదాహరణకు shannon-3. ప్రచురించిన మోడల్ id, ఉదాహరణకు shannon-1.6-lite.
చేరే ఎండ్‌పాయింట్‌లు /v1/chat/completions, /v1/responses, /v1/models /v1/messages, /v1/messages/count_tokens
ఎన్విరాన్‌మెంట్ వేరియబుల్స్ OPENAI_API_KEY మరియు OPENAI_BASE_URL; మీరు విలువ ఇవ్వనప్పుడు Python మరియు JavaScript SDKలు వీటిని చదువుతాయి. ANTHROPIC_API_KEY మరియు ANTHROPIC_BASE_URL; మీరు విలువ ఇవ్వనప్పుడు Python మరియు TypeScript SDKలు వీటిని చదువుతాయి.

రెండు base URLల మధ్య తేడా /v1: OpenAI SDK తన base URL కు /chat/completions ను జోడిస్తుంది, Anthropic SDK /v1/messages ను జోడిస్తుంది. Shannon ప్రచురించని మోడల్ పేరుకు 400 మరియు unknown model తో సమాధానం వస్తుంది. మోడల్స్ & ధరలు

మీ కీ Keys & usage పేజీలో ఉంది. Keys & usage

OpenAI SDKలు

అధికారిక OpenAI SDKలు POST /v1/chat/completions మరియు POST /v1/responses ను కాల్ చేస్తాయి. ప్రతి నమూనా ఒక యూజర్ మెసేజ్‌ను పంపి సమాధానాన్ని ప్రింట్ చేస్తుంది.

# 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)
భాష ఇన్‌స్టాల్ Base URL ఆప్షన్ సోర్స్
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

ఈ రెండు ఎండ్‌పాయింట్‌ల ప్రతి ఫీల్డ్ వాటి స్వంత పేజీలలో వివరించబడింది. Chat Completions Responses API

Anthropic SDKలు

అధికారిక Anthropic SDKలు POST /v1/messages ను కాల్ చేస్తాయి. అవి ప్రతి కాల్‌లో max_tokens ను తప్పనిసరి చేస్తాయి, కాబట్టి నమూనాలు దాన్ని అమలు చేసే shannon-1.6-lite ను ఉపయోగిస్తాయి. ప్రతి నమూనా సమాధానంలోని టెక్స్ట్ బ్లాక్‌లను ప్రింట్ చేస్తుంది.

# 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)
భాష ఇన్‌స్టాల్ Base URL ఆప్షన్ సోర్స్
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 ఫార్మాట్ మరియు దాని తేడాలు Anthropic compatibility పేజీలో ఉన్నాయి. Anthropic ఫార్మాట్

SDKలు ఆధారపడగలిగేవి

  • API ఉపయోగించని రిక్వెస్ట్ ఫీల్డ్‌ను అంగీకరిస్తుంది. API కి తెలిసిన ఫీల్డ్‌ను తప్పు రకంతో పంపితే 422 తో సమాధానం వస్తుంది.
  • SDKలు జోడించే version మరియు beta హెడర్లు (anthropic-version, anthropic-beta, openai-beta) అంగీకరించబడతాయి. వాటిలో ఏదీ తప్పనిసరి కాదు.
  • సమాధానంలోని model ప్రచురించిన id, కాబట్టి దాన్ని అలాగే తిరిగి పంపవచ్చు.
  • /v1/messages లో సమాధానం thinking బ్లాక్‌తో మొదలవవచ్చు. మొదటి బ్లాక్‌ను తీసుకోకుండా, text రకం బ్లాక్‌లను చదవండి.
  • స్ట్రీమింగ్ SDK యొక్క స్వంత స్ట్రీమ్ హెల్పర్ల ద్వారా పనిచేస్తుంది. ప్రతి స్ట్రీమ్ చివరిలో usage వస్తుంది.
  • ప్రతి సమాధానంలో x-request-id హెడర్ ఉంటుంది. మీ స్వంత x-request-id ను పంపితే అదే విలువ తిరిగి వస్తుంది.

కమ్యూనిటీ SDKలు

ఇతర రచయితలు OpenAI API కోసం రాసిన క్లయింట్‌లు కూడా ఇదే విధంగా పనిచేస్తాయి: క్లయింట్‌కు /v1 తో base URL, మీ కీ మరియు Shannon మోడల్ id ఇవ్వండి. వీటిని వాటి రచయితలు నిర్వహిస్తారు, Shannon కాదు.

భాష ఇన్‌స్టాల్ క్లయింట్
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

SDK లేకుండా

మీకు SDK అవసరం లేదు. JSON పంపగల ఏ HTTP క్లయింట్ అయినా పనిచేస్తుంది:

  • JSON బాడీ మరియు Content-Type: application/json హెడర్‌తో POST. అది లేకపోతే రిక్వెస్ట్‌కు 415 తో సమాధానం వస్తుంది.
  • మీ కీ Authorization: Bearer <key> లో లేదా x-api-key: <key> లో. రెండూ ప్రతి ఎండ్‌పాయింట్‌లో పనిచేస్తాయి.
  • 32 MiB వరకు ఉండే బాడీ.
  • "stream": true తో సమాధానం server-sent event స్ట్రీమ్ (text/event-stream) అవుతుంది. దాన్ని లైన్ వారీగా చదవండి మరియు బఫర్ చేయవద్దు.
  • ఎర్రర్ అంటే HTTP స్టేటస్ పక్కన error.type మరియు error.message ఉన్న JSON బాడీ.
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!"}]
  }'

స్ట్రీమ్ ఈవెంట్‌లు మరియు ఎర్రర్ రకాల కోసం చూడండి: స్ట్రీమింగ్ ఎరర్ హ్యాండ్లింగ్