SDK
Öll OpenAI og Anthropic SDK virka beint úr kassanum.
Shannon talar bæði OpenAI og Anthropic samskiptasniðin, svo þú notar opinberu SDK beggja óbreytt. Þú breytir þremur gildum í biðlaranum: base URL, API lyklinum og líkanaauðkenninu. Restin af kóðanum þínum helst eins.
Hvað á að stilla
| Stilling | OpenAI SDK | Anthropic SDK |
|---|---|---|
| Base URL | https://api.shannon-ai.com/v1 | https://api.shannon-ai.com |
| API lykill | Shannon lykillinn þinn. SDK sendir hann sem Authorization: Bearer. | Shannon lykillinn þinn. SDK sendir hann sem x-api-key. |
| Líkan | Útgefið líkanaauðkenni, til dæmis shannon-3. | Útgefið líkanaauðkenni, til dæmis shannon-1.6-lite. |
| Endapunktar sem það nær til | /v1/chat/completions, /v1/responses, /v1/models | /v1/messages, /v1/messages/count_tokens |
| Umhverfisbreytur | OPENAI_API_KEY og OPENAI_BASE_URL, lesnar af Python og JavaScript SDK þegar þú gefur ekkert gildi. | ANTHROPIC_API_KEY og ANTHROPIC_BASE_URL, lesnar af Python og TypeScript SDK þegar þú gefur ekkert gildi. |
Base URL-in tvö eru mismunandi um /v1: OpenAI SDK bætir /chat/completions við base URL sitt, Anthropic SDK bætir við /v1/messages. Líkanaheiti sem Shannon gefur ekki út fær svarið 400 og unknown model. Líkön og verð
Lykillinn þinn er á síðunni Keys & usage. Lyklar og notkun
OpenAI SDK
Opinberu OpenAI SDK safnsöfnin kalla á POST /v1/chat/completions og POST /v1/responses. Hvert dæmi sendir ein notendaskilaboð og prentar svarið.
# 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); | Tungumál | Uppsetning | Base URL valkostur | Uppspretta |
|---|---|---|---|
| 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 |
Hver reitur beggja endapunktanna er lýst á þeirra eigin síðum. Chat Completions Responses API
Anthropic SDK
Opinberu Anthropic SDK safnsöfnin kalla á POST /v1/messages. Þau krefjast max_tokens í hverju kalli, svo dæmin nota shannon-1.6-lite, sem tekur tillit til þess. Hvert dæmi prentar textablokkir svarsins.
# 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())); | Tungumál | Uppsetning | Base URL valkostur | Uppspretta |
|---|---|---|---|
| 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 sniðið og munur þess er á síðunni um Anthropic samhæfni. Anthropic
Hverju SDK geta treyst á
- Beiðnisreitur sem API notar ekki er samþykktur. Reitur sem API þekkir, sendur með rangri gerð, fær svarið
422. - Útgáfu- og beta-hausarnir sem SDK bæta við (
anthropic-version,anthropic-beta,openai-beta) eru samþykktir. Enginn þeirra er nauðsynlegur. modelí svari er útgefna auðkennið, svo þú getur sent það til baka óbreytt.- Á
/v1/messagesgetur svar byrjað áthinkingblokk. Lestu blokkir af gerðinnitextí stað þess að taka fyrstu blokkina. - Streymi virkar í gegnum streymishjálpara SDK sjálfs. Notkun berst í lok hvers streymis.
- Hvert svar ber
x-request-idhaus. Sendu þitt eigiðx-request-idog sama gildi kemur til baka.
SDK frá samfélaginu
Biðlarar sem aðrir höfundar hafa skrifað fyrir OpenAI API virka á sama hátt: gefðu biðlaranum base URL með /v1, lykilinn þinn og Shannon líkanaauðkenni. Höfundar þeirra viðhalda þeim, ekki Shannon.
| Tungumál | Uppsetning | Biðlari |
|---|---|---|
| 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 |
Án SDK
Þú þarft ekki SDK. Hver HTTP-biðlari sem getur sent JSON virkar:
POSTmeð JSON-meginmáli og hausnumContent-Type: application/json. Án hans er beiðninni svarað með415.- Lykillinn þinn í
Authorization: Bearer <key>eða íx-api-key: <key>. Hvort tveggja virkar á öllum endapunktum. - Meginmál allt að 32 MiB.
- Með
"stream": trueer svarið server-sent event straumur (text/event-stream). Lestu hann línu fyrir línu og biðminnisgeymdu hann ekki. - Villa er JSON-meginmál með
error.typeogerror.message, ásamt HTTP-stöðunni.
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); Um atburði streymis og villugerðir, sjá: Streymi Villumeðhöndlun