SDK
Çdo SDK e OpenAI ose Anthropic funksionon menjëherë.
Shannon flet format e linjës OpenAI dhe Anthropic, prandaj i përdorni SDK-të zyrtare të të dyjave siç janë. Ndryshoni tri vlera te klienti: URL-në bazë, çelësin API dhe id-në e modelit. Pjesa tjetër e kodit tuaj mbetet e njëjtë.
Çfarë të caktoni
| Cilësimi | SDK-të OpenAI | SDK-të Anthropic |
|---|---|---|
| URL bazë | https://api.shannon-ai.com/v1 | https://api.shannon-ai.com |
| Çelësi API | Çelësi juaj Shannon. SDK-ja e dërgon si Authorization: Bearer. | Çelësi juaj Shannon. SDK-ja e dërgon si x-api-key. |
| Modeli | Një id modeli e publikuar, për shembull shannon-3. | Një id modeli e publikuar, për shembull shannon-1.6-lite. |
| Endpoint-et që arrin | /v1/chat/completions, /v1/responses, /v1/models | /v1/messages, /v1/messages/count_tokens |
| Variablat e mjedisit | OPENAI_API_KEY dhe OPENAI_BASE_URL, të lexuara nga SDK-të Python dhe JavaScript kur nuk jepni vlerë. | ANTHROPIC_API_KEY dhe ANTHROPIC_BASE_URL, të lexuara nga SDK-të Python dhe TypeScript kur nuk jepni vlerë. |
Dy URL-të bazë ndryshojnë me /v1: një SDK OpenAI shton /chat/completions te URL-ja e vet bazë, një SDK Anthropic shton /v1/messages. Një emër modeli që Shannon nuk e publikon merr përgjigje 400 dhe unknown model. Modelet dhe çmimet
Çelësi juaj është në faqen Çelësat dhe përdorimi. Çelësat dhe përdorimi
SDK-të OpenAI
SDK-të zyrtare OpenAI thërrasin POST /v1/chat/completions dhe POST /v1/responses. Çdo shembull dërgon një mesazh përdoruesi dhe printon përgjigjen.
# 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); | Gjuha | Instalimi | Opsioni i URL-së bazë | Burimi |
|---|---|---|---|
| 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 |
Çdo fushë e dy endpoint-eve përshkruhet në faqet e tyre. Chat Completions Responses API
SDK-të Anthropic
SDK-të zyrtare Anthropic thërrasin POST /v1/messages. Ato kërkojnë max_tokens në çdo thirrje, prandaj shembujt përdorin shannon-1.6-lite, që e zbaton. Çdo shembull printon blloqet e tekstit të përgjigjes.
# 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())); | Gjuha | Instalimi | Opsioni i URL-së bazë | Burimi |
|---|---|---|---|
| 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 |
Formati Messages dhe dallimet e tij janë në faqen e pajtueshmërisë me Anthropic. Formati Anthropic
Çfarë mund të mbështesin SDK-të
- Një fushë kërkese që API-ja nuk e përdor pranohet. Një fushë që API-ja e njeh, e dërguar me lloj të gabuar, merr përgjigje
422. - Header-at e versionit dhe beta që shtojnë SDK-të (
anthropic-version,anthropic-beta,openai-beta) pranohen. Asnjëri nuk kërkohet. modeli një përgjigjeje është id-ja e publikuar, kështu që mund ta dërgoni mbrapsht siç është.- Në
/v1/messagesnjë përgjigje mund të fillojë me një bllokthinking. Lexoni blloqet e llojittextnë vend që të merrni blokun e parë. - Streaming funksionon përmes ndihmësve të stream-it të vetë SDK-së. Përdorimi arrin në fund të çdo stream-i.
- Çdo përgjigje mban një header
x-request-id. Dërgonix-request-idtuaj dhe kthehet e njëjta vlerë.
SDK-të e komunitetit
Klientët e shkruar për API-n OpenAI nga autorë të tjerë funksionojnë njësoj: jepini klientit URL-në bazë me /v1, çelësin tuaj dhe një id modeli Shannon. Këta mirëmbahen nga autorët e tyre, jo nga Shannon.
| Gjuha | Instalimi | Klienti |
|---|---|---|
| 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 |
Pa SDK
Nuk keni nevojë për SDK. Funksionon çdo klient HTTP që mund të dërgojë JSON:
POSTme trup JSON dhe header-inContent-Type: application/json. Pa të kërkesa merr përgjigje415.- Çelësi juaj te
Authorization: Bearer <key>ose tex-api-key: <key>. Të dyja funksionojnë në çdo endpoint. - Një trup deri në 32 MiB.
- Me
"stream": truepërgjigjja është një stream server-sent events (text/event-stream). Lexojeni rresht pas rreshti dhe mos e ruani në buffer. - Një gabim është një trup JSON me
error.typedheerror.message, pranë statusit 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); Për ngjarjet e një stream-i dhe llojet e gabimeve, shihni: Transmetim Trajtimi i gabimeve