SDK-ներ
Ցանկացած OpenAI կամ Anthropic SDK աշխատում է անմիջապես։
Shannon-ը խոսում է OpenAI-ի և Anthropic-ի wire ձևաչափերով, ուստի երկուսի պաշտոնական 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։ |
| Endpoint-ները, որոնց այն հասնում է | /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 էջում է։ Բանալիներ և օգտագործում
OpenAI SDK-ներ
Պաշտոնական OpenAI SDK-ները կանչում են POST /v1/chat/completions և POST /v1/responses։ Յուրաքանչյուր օրինակ ուղարկում է մեկ user հաղորդագրություն և տպում պատասխանը։
# 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 |
Երկու endpoint-ների յուրաքանչյուր դաշտ նկարագրված է իրենց էջերում։ 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())); | Լեզու | Տեղադրում | 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-ով։ - SDK-ների ավելացրած տարբերակի և beta header-ները (
anthropic-version,anthropic-beta,openai-beta) ընդունվում են։ Դրանցից ոչ մեկը պարտադիր չէ։ - Պատասխանի
model-ը հրապարակված id-ն է, ուստի կարող եք այն հետ ուղարկել այնպես, ինչպես կա։ /v1/messages-ում պատասխանը կարող է սկսվելthinkingբլոկով։ Կարդացեքtextտեսակի բլոկները՝ առաջին բլոկը վերցնելու փոխարեն։- Streaming-ն աշխատում է SDK-ի սեփական stream օգնականներով։ Usage-ը գալիս է յուրաքանչյուր հոսքի վերջում։
- Յուրաքանչյուր պատասխան կրում է
x-request-idheader։ Ուղարկեք ձեր սեփական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 պետք չէ։ Աշխատում է ցանկացած HTTP կլիենտ, որը կարող է ուղարկել JSON.
POSTJSON մարմնով ևContent-Type: application/jsonheader-ով։ Առանց դրա հարցումը պատասխանվում է415-ով։- Ձեր բանալին՝
Authorization: Bearer <key>-ում կամx-api-key: <key>-ում։ Երկուսն էլ աշխատում են յուրաքանչյուր endpoint-ի վրա։ - Մինչև 32 MiB մարմին։
"stream": true-ի դեպքում պատասխանը server-sent event հոսք է (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); Հոսքի իրադարձությունների և սխալի տեսակների համար տե՛ս. Ստրիմինգ Սխալների մշակում