SDKs
Mae unrhyw SDK OpenAI neu Anthropic yn gweithio'n syth.
Mae Shannon yn siarad fformatau gwifren OpenAI ac Anthropic, felly rydych yn defnyddio SDKs swyddogol y ddau fel y maent. Rydych yn newid tri gwerth yn y cleient: yr URL sylfaen, yr allwedd API ac id y model. Mae gweddill eich cod yn aros yr un fath.
Beth i'w osod
| Gosodiad | SDKs OpenAI | SDKs Anthropic |
|---|---|---|
| URL sylfaen | https://api.shannon-ai.com/v1 | https://api.shannon-ai.com |
| Allwedd API | Eich allwedd Shannon. Mae'r SDK yn ei hanfon fel Authorization: Bearer. | Eich allwedd Shannon. Mae'r SDK yn ei hanfon fel x-api-key. |
| Model | Id model cyhoeddedig, er enghraifft shannon-3. | Id model cyhoeddedig, er enghraifft shannon-1.6-lite. |
| Pwyntiau terfyn y mae'n eu cyrraedd | /v1/chat/completions, /v1/responses, /v1/models | /v1/messages, /v1/messages/count_tokens |
| Newidynnau amgylchedd | OPENAI_API_KEY a OPENAI_BASE_URL, a ddarllenir gan SDKs Python a JavaScript pan na basiwch werth. | ANTHROPIC_API_KEY a ANTHROPIC_BASE_URL, a ddarllenir gan SDKs Python a TypeScript pan na basiwch werth. |
Mae'r ddau URL sylfaen yn wahanol o ran /v1: mae SDK OpenAI yn ychwanegu /chat/completions at ei URL sylfaen, mae SDK Anthropic yn ychwanegu /v1/messages. Atebir enw model nad yw Shannon yn ei gyhoeddi â 400 ac unknown model. Modelau a phrisiau
Mae eich allwedd ar y dudalen Keys & usage. Allweddi a defnydd
SDKs OpenAI
Mae SDKs swyddogol OpenAI yn galw POST /v1/chat/completions a POST /v1/responses. Mae pob enghraifft yn anfon un neges defnyddiwr ac yn argraffu'r ateb.
# 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); | Iaith | Gosod | Opsiwn URL sylfaen | Ffynhonnell |
|---|---|---|---|
| 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 |
Disgrifir pob maes o'r ddau bwynt terfyn ar eu tudalennau eu hunain. Chat Completions Responses API
SDKs Anthropic
Mae SDKs swyddogol Anthropic yn galw POST /v1/messages. Maent yn gofyn am max_tokens ar bob galwad, felly mae'r enghreifftiau'n defnyddio shannon-1.6-lite, sy'n ei gymhwyso. Mae pob enghraifft yn argraffu blociau testun yr ateb.
# 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())); | Iaith | Gosod | Opsiwn URL sylfaen | Ffynhonnell |
|---|---|---|---|
| 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 |
Mae'r fformat Messages a'i wahaniaethau ar dudalen cydnawsedd Anthropic. Anthropic
Yr hyn y gall yr SDKs ddibynnu arno
- Derbynnir maes cais nad yw'r API yn ei ddefnyddio. Atebir maes y mae'r API yn ei adnabod, a anfonir gyda'r math anghywir, â
422. - Derbynnir y penawdau fersiwn a beta y mae'r SDKs yn eu hychwanegu (
anthropic-version,anthropic-beta,openai-beta). Nid oes angen yr un ohonynt. modelateb yw'r id cyhoeddedig, felly gallwch ei anfon yn ôl fel y mae.- Ar
/v1/messagesgall ateb ddechrau gyda blocthinking. Darllenwch y blociau o'r mathtextyn lle cymryd y bloc cyntaf. - Mae ffrydio'n gweithio drwy gynorthwywyr ffrwd yr SDK ei hun. Mae usage yn cyrraedd ar ddiwedd pob ffrwd.
- Mae pob ateb yn cario pennawd
x-request-id. Anfonwch eichx-request-ideich hun ac mae'r un gwerth yn dod yn ôl.
SDKs cymunedol
Mae cleientiaid a ysgrifennwyd ar gyfer API OpenAI gan awduron eraill yn gweithio yn yr un ffordd: rhowch yr URL sylfaen gyda /v1, eich allwedd ac id model Shannon i'r cleient. Mae'r rhain yn cael eu cynnal gan eu hawduron, nid gan Shannon.
| Iaith | Gosod | Cleient |
|---|---|---|
| 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 |
Heb SDK
Nid oes angen SDK arnoch. Mae unrhyw gleient HTTP sy'n gallu anfon JSON yn gweithio:
POSTgyda chorff JSON a'r pennawdContent-Type: application/json. Hebddo atebir y cais â415.- Eich allwedd yn
Authorization: Bearer <key>neu ynx-api-key: <key>. Mae'r ddau'n gweithio ar bob pwynt terfyn. - Corff hyd at 32 MiB.
- Gyda
"stream": truemae'r ateb yn ffrwd o ddigwyddiadau a anfonir gan y gweinydd (text/event-stream). Darllenwch ef fesul llinell a pheidiwch â'i glustogi. - Corff JSON gydag
error.typeacerror.messageyw gwall, wrth ymyl y statws 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); Ar gyfer digwyddiadau ffrwd a'r mathau o wallau, gweler: Ffrydio Rheoli gwallau