SDK:t
Mikä tahansa OpenAI- tai Anthropic-SDK toimii sellaisenaan.
Shannon puhuu OpenAI:n ja Anthropicin siirtomuotoja, joten voit käyttää molempien virallisia SDK:ita sellaisinaan. Vaihdat asiakkaassa kolme arvoa: perus-URL:n, API-avaimen ja mallin id:n. Loppu koodistasi pysyy samana.
Mitä asetetaan
| Asetus | OpenAI-SDK:t | Anthropic-SDK:t |
|---|---|---|
| Perus-URL | https://api.shannon-ai.com/v1 | https://api.shannon-ai.com |
| API-avain | Shannon-avaimesi. SDK lähettää sen otsakkeena Authorization: Bearer. | Shannon-avaimesi. SDK lähettää sen otsakkeena x-api-key. |
| Malli | Julkaistu mallin id, esimerkiksi shannon-3. | Julkaistu mallin id, esimerkiksi shannon-1.6-lite. |
| Päätepisteet, jotka se tavoittaa | /v1/chat/completions, /v1/responses, /v1/models | /v1/messages, /v1/messages/count_tokens |
| Ympäristömuuttujat | OPENAI_API_KEY ja OPENAI_BASE_URL, jotka Python- ja JavaScript-SDK:t lukevat, kun et anna arvoa. | ANTHROPIC_API_KEY ja ANTHROPIC_BASE_URL, jotka Python- ja TypeScript-SDK:t lukevat, kun et anna arvoa. |
Kaksi perus-URL:ia eroavat /v1-osalla: OpenAI-SDK lisää perus-URL:ään /chat/completions, Anthropic-SDK lisää /v1/messages. Mallin nimeen, jota Shannon ei julkaise, vastataan 400:lla ja viestillä unknown model. Mallit ja hinnoittelu
Avaimesi on Keys & usage -sivulla. Avaimet ja käyttö
OpenAI-SDK:t
Viralliset OpenAI-SDK:t kutsuvat POST /v1/chat/completions ja POST /v1/responses. Jokainen esimerkki lähettää yhden käyttäjän viestin ja tulostaa vastauksen.
# 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); | Kieli | Asennus | Perus-URL-asetus | Lähde |
|---|---|---|---|
| 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 |
Näiden kahden päätepisteen jokainen kenttä on kuvattu niiden omilla sivuilla. Chat Completions Responses API
Anthropic-SDK:t
Viralliset Anthropic-SDK:t kutsuvat POST /v1/messages. Ne vaativat max_tokens-kentän jokaisessa kutsussa, joten esimerkit käyttävät mallia shannon-1.6-lite, joka ottaa sen huomioon. Jokainen esimerkki tulostaa vastauksen tekstilohkot.
# 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())); | Kieli | Asennus | Perus-URL-asetus | Lähde |
|---|---|---|---|
| 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-muoto ja sen erot ovat Anthropic-yhteensopivuus-sivulla. Antrooppinen muoto
Mihin SDK:t voivat luottaa
- Pyyntökenttä, jota API ei käytä, hyväksytään. Kenttään, jonka API tuntee ja joka lähetetään väärällä tyypillä, vastataan
422:lla. - SDK:iden lisäämät versio- ja beta-otsakkeet (
anthropic-version,anthropic-beta,openai-beta) hyväksytään. Mikään niistä ei ole pakollinen. - Vastauksen
modelon julkaistu id, joten voit lähettää sen takaisin sellaisenaan. - Päätepisteessä
/v1/messagesvastaus voi alkaathinking-lohkolla. Lue tyypintextlohkot sen sijaan, että ottaisit ensimmäisen lohkon. - Striimaus toimii SDK:n omilla striimiapufunktioilla. Käyttötiedot (usage) saapuvat jokaisen striimin lopussa.
- Jokaisessa vastauksessa on
x-request-id-otsake. Lähetä omax-request-id, niin sama arvo palaa.
Yhteisön SDK:t
Muiden tekijöiden OpenAI API:lle kirjoittamat asiakkaat toimivat samalla tavalla: anna asiakkaalle perus-URL /v1-päätteellä, avaimesi ja Shannon-mallin id. Näitä ylläpitävät niiden tekijät, ei Shannon.
| Kieli | Asennus | Asiakas |
|---|---|---|
| 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 |
Ilman SDK:ta
SDK:ta ei tarvita. Mikä tahansa HTTP-asiakas, joka osaa lähettää JSONia, toimii:
POSTJSON-rungolla ja otsakkeellaContent-Type: application/json. Ilman sitä pyyntöön vastataan415:llä.- Avaimesi otsakkeessa
Authorization: Bearer <key>tai otsakkeessax-api-key: <key>. Molemmat toimivat jokaisessa päätepisteessä. - Runko, jonka koko on enintään 32 MiB.
- Kun
"stream": true, vastaus on server-sent events -striimi (text/event-stream). Lue se rivi riviltä äläkä puskuroi sitä. - Virhe on JSON-runko, jossa on
error.typejaerror.message, HTTP-tilan vieressä.
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); Striimin tapahtumat ja virhetyypit löydät täältä: Suoratoisto Virheiden käsittely