SDKs
כל SDK של OpenAI או Anthropic עובד מיד, ללא הגדרות.
Shannon מדברת בפורמטים של OpenAI ושל Anthropic, ולכן אפשר להשתמש ב-SDK הרשמיים של שניהם כפי שהם. משנים שלושה ערכים בלקוח: ה-base URL, מפתח ה-API ומזהה המודל. שאר הקוד נשאר כפי שהוא.
מה להגדיר
| הגדרה | SDK של OpenAI | SDK של Anthropic |
|---|---|---|
| Base URL | https://api.shannon-ai.com/v1 | https://api.shannon-ai.com |
| מפתח API | מפתח Shannon שלכם. ה-SDK שולח אותו כ-Authorization: Bearer. | מפתח Shannon שלכם. ה-SDK שולח אותו כ-x-api-key. |
| מודל | מזהה מודל שפורסם, למשל shannon-3. | מזהה מודל שפורסם, למשל shannon-1.6-lite. |
| Endpoints שהוא מגיע אליהם | /v1/chat/completions, /v1/responses, /v1/models | /v1/messages, /v1/messages/count_tokens |
| משתני סביבה | OPENAI_API_KEY ו-OPENAI_BASE_URL, נקראים על ידי ה-SDK של Python ושל JavaScript כשאתם לא מעבירים ערך. | ANTHROPIC_API_KEY ו-ANTHROPIC_BASE_URL, נקראים על ידי ה-SDK של Python ושל TypeScript כשאתם לא מעבירים ערך. |
ההבדל בין שני ה-base URL הוא /v1: SDK של OpenAI מוסיף /chat/completions ל-base URL שלו, SDK של Anthropic מוסיף /v1/messages. שם מודל ש-Shannon אינה מפרסמת נענה ב-400 וב-unknown model. מודלים ותמחור
המפתח שלכם נמצא בדף מפתחות ושימוש. מפתחות ושימוש
SDK של OpenAI
ה-SDK הרשמיים של OpenAI קוראים ל-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) // npm install openai
import OpenAI from "openai";
const client = new OpenAI({
apiKey: "YOUR_API_KEY",
baseURL: "https://api.shannon-ai.com/v1",
});
const response = await client.chat.completions.create({
model: "shannon-3",
messages: [{ role: "user", content: "Hello, Shannon!" }],
});
console.log(response.choices[0].message.content); // go get github.com/openai/openai-go/v3
package main
import (
"context"
"fmt"
"github.com/openai/openai-go/v3"
"github.com/openai/openai-go/v3/option"
)
func main() {
client := openai.NewClient(
option.WithAPIKey("YOUR_API_KEY"),
option.WithBaseURL("https://api.shannon-ai.com/v1/"),
)
completion, err := client.Chat.Completions.New(context.TODO(), openai.ChatCompletionNewParams{
Model: "shannon-3",
Messages: []openai.ChatCompletionMessageParamUnion{
openai.UserMessage("Hello, Shannon!"),
},
})
if err != nil {
panic(err)
}
fmt.Println(completion.Choices[0].Message.Content)
} // Gradle: implementation("com.openai:openai-java:<version>")
import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.chat.completions.ChatCompletion;
import com.openai.models.chat.completions.ChatCompletionCreateParams;
OpenAIClient client = OpenAIOkHttpClient.builder()
.apiKey("YOUR_API_KEY")
.baseUrl("https://api.shannon-ai.com/v1")
.build();
ChatCompletionCreateParams params = ChatCompletionCreateParams.builder()
.model("shannon-3")
.addUserMessage("Hello, Shannon!")
.build();
ChatCompletion completion = client.chat().completions().create(params);
completion.choices().get(0).message().content().ifPresent(System.out::println); // dotnet add package OpenAI
using System.ClientModel;
using OpenAI;
using OpenAI.Chat;
ChatClient client = new(
model: "shannon-3",
credential: new ApiKeyCredential("YOUR_API_KEY"),
options: new OpenAIClientOptions()
{
Endpoint = new Uri("https://api.shannon-ai.com/v1")
});
ChatCompletion completion = client.CompleteChat("Hello, Shannon!");
Console.WriteLine(completion.Content[0].Text); | שפה | התקנה | אפשרות 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 |
כל שדה של שני ה-endpoints מתואר בדפים שלהם. Chat Completions Responses API
SDK של Anthropic
ה-SDK הרשמיים של Anthropic קוראים ל-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) // npm install @anthropic-ai/sdk
import Anthropic from "@anthropic-ai/sdk";
const client = new Anthropic({
apiKey: "YOUR_API_KEY",
baseURL: "https://api.shannon-ai.com",
});
const message = await client.messages.create({
model: "shannon-1.6-lite",
max_tokens: 1024,
messages: [{ role: "user", content: "Hello, Shannon!" }],
});
for (const block of message.content) {
if (block.type === "text") console.log(block.text);
} // go get github.com/anthropics/anthropic-sdk-go
package main
import (
"context"
"fmt"
"github.com/anthropics/anthropic-sdk-go"
"github.com/anthropics/anthropic-sdk-go/option"
)
func main() {
client := anthropic.NewClient(
option.WithAPIKey("YOUR_API_KEY"),
option.WithBaseURL("https://api.shannon-ai.com/"),
)
message, err := client.Messages.New(context.TODO(), anthropic.MessageNewParams{
Model: "shannon-1.6-lite",
MaxTokens: 1024,
Messages: []anthropic.MessageParam{
anthropic.NewUserMessage(anthropic.NewTextBlock("Hello, Shannon!")),
},
})
if err != nil {
panic(err)
}
for _, block := range message.Content {
if block.Type == "text" {
fmt.Println(block.Text)
}
}
} // Gradle: implementation("com.anthropic:anthropic-java:<version>")
import com.anthropic.client.AnthropicClient;
import com.anthropic.client.okhttp.AnthropicOkHttpClient;
import com.anthropic.models.messages.Message;
import com.anthropic.models.messages.MessageCreateParams;
AnthropicClient client = AnthropicOkHttpClient.builder()
.apiKey("YOUR_API_KEY")
.baseUrl("https://api.shannon-ai.com")
.build();
MessageCreateParams params = MessageCreateParams.builder()
.model("shannon-1.6-lite")
.maxTokens(1024L)
.addUserMessage("Hello, Shannon!")
.build();
Message message = client.messages().create(params);
message.content().stream()
.flatMap(block -> block.text().stream())
.forEach(text -> System.out.println(text.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. פורמט Anthropic
על מה ה-SDK יכולים לסמוך
- שדה בקשה שה-API אינו משתמש בו מתקבל. שדה שה-API מכיר, שנשלח עם סוג שגוי, נענה ב-
422. - כותרות הגרסה וה-beta שה-SDK מוסיפים (
anthropic-version,anthropic-beta,openai-beta) מתקבלות. אף אחת מהן אינה חובה. - ה-
modelשל תשובה הוא המזהה שפורסם, ולכן אפשר לשלוח אותו בחזרה כמות שהוא. - ב-
/v1/messagesתשובה יכולה להתחיל בבלוקthinking. קראו את הבלוקים מסוגtextבמקום לקחת את הבלוק הראשון. - Streaming עובד דרך עוזרי ה-stream של ה-SDK עצמו. ה-usage מגיע בסוף כל stream.
- כל תשובה נושאת כותרת
x-request-id. שלחוx-request-idמשלכם ואותו ערך יחזור.
SDK של הקהילה
לקוחות שנכתבו ל-API של OpenAI בידי מחברים אחרים עובדים באותו אופן: תנו ללקוח את ה-base URL עם /v1, את המפתח שלכם ומזהה מודל של Shannon. אלה מתוחזקים בידי מחבריהם, לא בידי 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. כל לקוח HTTP שיכול לשלוח JSON עובד:
POSTעם גוף JSON והכותרתContent-Type: application/json. בלעדיה הבקשה נענית ב-415.- המפתח שלכם ב-
Authorization: Bearer <key>או ב-x-api-key: <key>. שניהם עובדים בכל endpoint. - גוף של עד 32 MiB.
- עם
"stream": trueהתשובה היא stream של server-sent events (text/event-stream). קראו אותו שורה אחר שורה ואל תאגרו אותו ב-buffer. - שגיאה היא גוף JSON עם
error.typeו-error.message, לצד סטטוס ה-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!"}]
}' import requests
response = requests.post(
"https://api.shannon-ai.com/v1/chat/completions",
headers={"Authorization": "Bearer YOUR_API_KEY"},
json={
"model": "shannon-3",
"messages": [{"role": "user", "content": "Hello, Shannon!"}],
},
)
response.raise_for_status()
print(response.json()["choices"][0]["message"]["content"]) const response = await fetch("https://api.shannon-ai.com/v1/chat/completions", {
method: "POST",
headers: {
Authorization: "Bearer YOUR_API_KEY",
"Content-Type": "application/json",
},
body: JSON.stringify({
model: "shannon-3",
messages: [{ role: "user", content: "Hello, Shannon!" }],
}),
});
if (!response.ok) throw new Error(`HTTP ${response.status}`);
const data = await response.json();
console.log(data.choices[0].message.content); לאירועים של stream ולסוגי השגיאות, ראו: הזרמה טיפול בשגיאות