SDK
Всеки SDK на OpenAI или Anthropic работи веднага.
Shannon говори мрежовите формати на OpenAI и на Anthropic, така че използвате официалните SDK на двата такива, каквито са. В клиента променяте три стойности: базовия URL, API ключа и id на модела. Остатъкът от кода Ви остава същият.
Какво да зададете
| Настройка | SDK на OpenAI | SDK на Anthropic |
|---|---|---|
| Базов 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, четени от SDK за Python и JavaScript, когато не подадете стойност. | ANTHROPIC_API_KEY и ANTHROPIC_BASE_URL, четени от SDK за Python и TypeScript, когато не подадете стойност. |
Двата базови URL се различават по /v1: SDK на OpenAI добавя /chat/completions към своя базов URL, SDK на Anthropic добавя /v1/messages. Име на модел, което Shannon не публикува, получава отговор 400 и unknown model. Модели и цени
Ключът Ви е на страницата Keys & usage. Keys & usage
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); | Език | Инсталиране | Опция за базов 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
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())); | Език | Инсталиране | Опция за базов 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на отговора е публикуваното id, така че можете да го изпратите обратно такова, каквото е.- На
/v1/messagesотговорът може да започва с блокthinking. Четете блоковете от типtext, вместо да вземате първия блок. - Стрийминг работи чрез собствените помощници за стрийм на SDK. Употребата (usage) пристига в края на всеки стрийм.
- Всеки отговор носи хедър
x-request-id. Изпратете свойx-request-idи същата стойност се връща.
Community SDK
Клиенти, написани за API на OpenAI от други автори, работят по същия начин: дайте на клиента базовия URL с /v1, Вашия ключ и id на модел на 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>. И двата работят на всеки ендпоинт. - Тяло до 32 MiB.
- При
"stream": trueотговорът е поток от server-sent events (text/event-stream). Четете го ред по ред и не го буферирайте. - Грешката е 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); За събитията на стрийм и типовете грешки вижте: Стрийминг Обработка на грешки