SDK
Любой SDK OpenAI или Anthropic работает сразу, без настройки.
Shannon понимает форматы OpenAI и Anthropic, поэтому официальные SDK обоих можно использовать как есть. В клиенте меняются три значения: базовый URL, API-ключ и id модели. Остальной код остается прежним.
Что настроить
| Настройка | OpenAI SDK | Anthropic SDK |
|---|---|---|
| Базовый 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: OpenAI SDK добавляет к своему базовому 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) // 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
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) // 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 для потоков. Данные об использовании приходят в конце каждого потока.
- В каждом ответе есть заголовок
x-request-id. Отправьте свойx-request-id, и то же значение вернется.
SDK сообщества
Клиенты для OpenAI API, написанные другими авторами, работают так же: передайте клиенту базовый 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); О событиях потока и типах ошибок см.: Потоковая передача Обработка ошибок