Neidio i'r cynnwys
SDKs

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)
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)
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.
  • model ateb yw'r id cyhoeddedig, felly gallwch ei anfon yn ôl fel y mae.
  • Ar /v1/messages gall ateb ddechrau gyda bloc thinking. Darllenwch y blociau o'r math text yn 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 eich x-request-id eich 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:

  • POST gyda chorff JSON a'r pennawd Content-Type: application/json. Hebddo atebir y cais â 415.
  • Eich allwedd yn Authorization: Bearer <key> neu yn x-api-key: <key>. Mae'r ddau'n gweithio ar bob pwynt terfyn.
  • Corff hyd at 32 MiB.
  • Gyda "stream": true mae'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.type ac error.message yw 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!"}]
  }'

Ar gyfer digwyddiadau ffrwd a'r mathau o wallau, gweler: Ffrydio Rheoli gwallau