SDK
SDK ຂອງ OpenAI ຫຼື Anthropic ໃດກໍໃຊ້ໄດ້ທັນທີ.
Shannon ໃຊ້ຮູບແບບ wire ຂອງທັງ OpenAI ແລະ Anthropic, ດັ່ງນັ້ນທ່ານໃຊ້ SDK ທາງການຂອງທັງສອງຕາມທີ່ມັນເປັນ. ທ່ານປ່ຽນສາມຄ່າໃນ client: base URL, API key ແລະ id ຂອງ model. ໂຄ້ດສ່ວນທີ່ເຫຼືອຄືເກົ່າ.
ສິ່ງທີ່ຕ້ອງຕັ້ງ
| ການຕັ້ງຄ່າ | SDK ຂອງ OpenAI | SDK ຂອງ Anthropic |
|---|---|---|
| Base URL | https://api.shannon-ai.com/v1 | https://api.shannon-ai.com |
| API key | key Shannon ຂອງທ່ານ. SDK ສົ່ງມັນເປັນ Authorization: Bearer. | key Shannon ຂອງທ່ານ. SDK ສົ່ງມັນເປັນ x-api-key. |
| Model | id ຂອງ model ທີ່ເຜີຍແຜ່, ຕົວຢ່າງ shannon-3. | id ຂອງ model ທີ່ເຜີຍແຜ່, ຕົວຢ່າງ shannon-1.6-lite. |
| Endpoint ທີ່ເຂົ້າເຖິງ | /v1/chat/completions, /v1/responses, /v1/models | /v1/messages, /v1/messages/count_tokens |
| ຕົວແປ environment | OPENAI_API_KEY ແລະ OPENAI_BASE_URL, ຖືກອ່ານໂດຍ SDK ຂອງ Python ແລະ JavaScript ເມື່ອທ່ານບໍ່ສົ່ງຄ່າ. | ANTHROPIC_API_KEY ແລະ ANTHROPIC_BASE_URL, ຖືກອ່ານໂດຍ SDK ຂອງ Python ແລະ TypeScript ເມື່ອທ່ານບໍ່ສົ່ງຄ່າ. |
ສອງ base URL ຕ່າງກັນທີ່ /v1: SDK ຂອງ OpenAI ເພີ່ມ /chat/completions ໃສ່ base URL ຂອງມັນ, SDK ຂອງ Anthropic ເພີ່ມ /v1/messages. ຊື່ model ທີ່ Shannon ບໍ່ເຜີຍແຜ່ຖືກຕອບດ້ວຍ 400 ແລະ unknown model. Model ແລະ ລາຄາ
key ຂອງທ່ານຢູ່ໃນໜ້າ Keys & usage. Keys & usage
SDK ຂອງ OpenAI
SDK ທາງການຂອງ OpenAI ເອີ້ນ 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
SDK ຂອງ Anthropic
SDK ທາງການຂອງ Anthropic ເອີ້ນ POST /v1/messages. ພວກມັນບັງຄັບ max_tokens ໃນທຸກການເອີ້ນ, ດັ່ງນັ້ນຕົວຢ່າງໃຊ້ shannon-1.6-lite, ເຊິ່ງນຳໃຊ້ມັນ. ແຕ່ລະຕົວຢ່າງພິມ block ຂໍ້ຄວາມຂອງຄຳຕອບ.
# 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 compatibility. Anthropic
ສິ່ງທີ່ SDK ເພິ່ງພາໄດ້
- ຟີລດ໌ຂອງຄຳຮ້ອງຂໍທີ່ API ບໍ່ໃຊ້ຖືກຮັບໄວ້. ຟີລດ໌ທີ່ API ຮູ້ຈັກ ແຕ່ສົ່ງດ້ວຍປະເພດຜິດ ຖືກຕອບດ້ວຍ
422. - header ເວີຊັນ ແລະ beta ທີ່ SDK ເພີ່ມ (
anthropic-version,anthropic-beta,openai-beta) ຖືກຮັບໄວ້. ບໍ່ມີອັນໃດຈຳເປັນ. modelຂອງຄຳຕອບແມ່ນ id ທີ່ເຜີຍແຜ່, ດັ່ງນັ້ນທ່ານສົ່ງມັນກັບຄືນຕາມທີ່ມັນເປັນໄດ້.- ໃນ
/v1/messagesຄຳຕອບອາດເລີ່ມດ້ວຍ blockthinking. ໃຫ້ອ່ານ block ປະເພດtextແທນການເອົາ block ທຳອິດ. - Streaming ເຮັດວຽກຜ່ານ stream helper ຂອງ SDK ເອງ. Usage ມາຮອດທ້າຍທຸກ stream.
- ທຸກຄຳຕອບມີ header
x-request-id. ສົ່ງx-request-idຂອງທ່ານເອງ ແລ້ວຄ່າດຽວກັນຈະກັບມາ.
SDK ຂອງຊຸມຊົນ
client ທີ່ຜູ້ຂຽນອື່ນຂຽນສຳລັບ API ຂອງ OpenAI ໃຊ້ໄດ້ແບບດຽວກັນ: ໃຫ້ base URL ພ້ອມ /v1, key ຂອງທ່ານ ແລະ id ຂອງ model Shannon ແກ່ client. ສິ່ງເຫຼົ່ານີ້ຜູ້ຂຽນເປັນຜູ້ບຳລຸງຮັກສາ, ບໍ່ແມ່ນ Shannon.
| ພາສາ | ຕິດຕັ້ງ | Client |
|---|---|---|
| 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 client ໃດກໍໄດ້ທີ່ສົ່ງ JSON ໄດ້ກໍໃຊ້ໄດ້:
POSTພ້ອມ body JSON ແລະ headerContent-Type: application/json. ຖ້າບໍ່ມີມັນ ຄຳຮ້ອງຂໍຖືກຕອບດ້ວຍ415.- key ຂອງທ່ານໃນ
Authorization: Bearer <key>ຫຼື ໃນx-api-key: <key>. ທັງສອງໃຊ້ໄດ້ໃນທຸກ endpoint. - body ສູງສຸດ 32 MiB.
- ດ້ວຍ
"stream": trueຄຳຕອບແມ່ນ stream ຂອງ server-sent event (text/event-stream). ອ່ານເທື່ອລະແຖວ ແລະ ຢ່າ buffer ມັນ. - ຂໍ້ຜິດພາດແມ່ນ body JSON ທີ່ມີ
error.typeແລະerror.message, ຄຽງຄູ່ HTTP status.
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); ສຳລັບ event ຂອງ stream ແລະ ປະເພດຂໍ້ຜິດພາດ, ເບິ່ງ: ສະຕຣີມມິ້ງ ການຈັດການຂໍ້ຜິດພາດ