SDKs
Qualquer SDK da OpenAI ou da Anthropic funciona sem configuração extra.
A Shannon fala os formatos de comunicação da OpenAI e da Anthropic, então você usa os SDKs oficiais de ambas como são. Você altera três valores no cliente: a URL base, a chave de API e o id do modelo. O restante do seu código permanece igual.
O que configurar
| Configuração | SDKs da OpenAI | SDKs da Anthropic |
|---|---|---|
| URL base | https://api.shannon-ai.com/v1 | https://api.shannon-ai.com |
| Chave de API | Sua chave Shannon. O SDK a envia como Authorization: Bearer. | Sua chave Shannon. O SDK a envia como x-api-key. |
| Modelo | Um id de modelo publicado, por exemplo shannon-3. | Um id de modelo publicado, por exemplo shannon-1.6-lite. |
| Endpoints que alcança | /v1/chat/completions, /v1/responses, /v1/models | /v1/messages, /v1/messages/count_tokens |
| Variáveis de ambiente | OPENAI_API_KEY e OPENAI_BASE_URL, lidas pelos SDKs de Python e JavaScript quando você não passa nenhum valor. | ANTHROPIC_API_KEY e ANTHROPIC_BASE_URL, lidas pelos SDKs de Python e TypeScript quando você não passa nenhum valor. |
As duas URLs base diferem por /v1: um SDK da OpenAI acrescenta /chat/completions à sua URL base, um SDK da Anthropic acrescenta /v1/messages. Um nome de modelo que a Shannon não publica é respondido com 400 e unknown model. Modelos e preços
Sua chave está na página Chaves e uso. Chaves e uso
SDKs da OpenAI
Os SDKs oficiais da OpenAI chamam POST /v1/chat/completions e POST /v1/responses. Cada exemplo envia uma mensagem de usuário e imprime a resposta.
# 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); | Linguagem | Instalação | Opção da URL base | Código-fonte |
|---|---|---|---|
| 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 |
Cada campo dos dois endpoints é descrito nas suas próprias páginas. Chat Completions API Responses
SDKs da Anthropic
Os SDKs oficiais da Anthropic chamam POST /v1/messages. Eles exigem max_tokens em toda chamada, por isso os exemplos usam shannon-1.6-lite, que o aplica. Cada exemplo imprime os blocos de texto da resposta.
# 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())); | Linguagem | Instalação | Opção da URL base | Código-fonte |
|---|---|---|---|
| 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 |
O formato Messages e suas diferenças estão na página de compatibilidade com a Anthropic. Formato Anthropic
Em que os SDKs podem confiar
- Um campo de requisição que a API não usa é aceito. Um campo que a API conhece, enviado com o tipo errado, é respondido com
422. - Os cabeçalhos de versão e beta que os SDKs acrescentam (
anthropic-version,anthropic-beta,openai-beta) são aceitos. Nenhum deles é obrigatório. - O
modelde uma resposta é o id publicado, então você pode enviá-lo de volta como está. - Em
/v1/messages, uma resposta pode começar com um blocothinking. Leia os blocos do tipotextem vez de pegar o primeiro bloco. - O streaming funciona pelos helpers de stream do próprio SDK. O uso chega no fim de todo stream.
- Toda resposta traz um cabeçalho
x-request-id. Envie o seu própriox-request-ide o mesmo valor volta.
SDKs da comunidade
Clientes escritos para a API da OpenAI por outros autores funcionam do mesmo jeito: informe ao cliente a URL base com /v1, a sua chave e um id de modelo Shannon. Eles são mantidos pelos seus autores, não pela Shannon.
| Linguagem | Instalação | Cliente |
|---|---|---|
| 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 |
Sem um SDK
Você não precisa de um SDK. Qualquer cliente HTTP que consiga enviar JSON funciona:
POSTcom um corpo JSON e o cabeçalhoContent-Type: application/json. Sem ele, a requisição é respondida com415.- Sua chave em
Authorization: Bearer <key>ou emx-api-key: <key>. Ambos funcionam em todos os endpoints. - Um corpo de até 32 MiB.
- Com
"stream": true, a resposta é um stream de server-sent events (text/event-stream). Leia-o linha por linha e não o armazene em buffer. - Um erro é um corpo JSON com
error.typeeerror.message, junto com o status 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); Para os eventos de um stream e os tipos de erro, veja: Streaming Tratamento de erros