Mis on StepFun API ja millal seda kasutada?
StepFun Open Platform on arendajatele mõeldud API, mille abil saab StepFuni mudeleid rakendustesse integreerida. See on mõeldud arendajatele, kes loovad vestlusliideseid, dokumentide ja piltide analüüsi, programmeerimistööriistu, otsinguga täiendatud rakendusi, agentide töövooge, häälerakendusi ja muud tarkvara, mis vajab mudeli loodud vastuseid.
Platvorm järgib OpenAI-ga ühilduvaid tavasid. See tähendab, et OpenAI API-ga tuttavad arendajad saavad tavaliselt sama üldist kliendimustrit uuesti kasutada, muutes ainult API-võtit, baas-URL-i ja mudeli nime. StepFun dokumenteerib nii uuemat Responses API-t kui ka Chat Completions API-t. Responses API on peamine valik uute rakenduste jaoks, mis kasutavad toetatud mudeleid, näiteks Step 5 Preview'd ja Step 3.7 Flashi; Chat Completions jääb kättesaadavaks laiema mudeliühilduvuse jaoks.
Tegemist on kasutuspõhise arendajateenusega, mitte fikseeritud hinnaga tarbijatellimusega. Vajate platvormikontot ja API-võtit ning kulud sõltuvad kasutatavast mudelist ja ressurssidest.
Kellele see on mõeldud?
- Arendajatele, kes soovivad OpenAI-ga ühilduvat liidest ja SDK-põhist töövoogu.
- Meeskondadele, kes loovad hiinakeelseid või multimodaalseid rakendusi.
- Rakendustele, mis vajavad teksti-, nägemis-, heli-, pildi- või reaalaja häälemudeleid.
- Toodetele, mis vajavad voogedastust, funktsioonikutseid, failisisendit, veebiotsingut või struktureeritud JSON-vastuseid.
- Arendajatele, kes hindavad mudelipõhist hinnastamist, selle asemel et osta üht piiramatut API-paketti.
StepFun ei pruugi sobida, kui vajate üle maailma ühtlaselt kättesaadavat teenust, sõltumatult kontrollitud ettevõtete privaatsusgarantiisid või API-funktsioone, mida dokumenteeritakse kõigis piirkondades ja mudelites järjepidevalt.
Kuidas saada juurdepääs ja luua API mandaadid?
API kasutamiseks on vaja StepFun Open Platformi kontot ja API-võtit. Platvormi kohta tehtud uuring kinnitab, et API-võtmed on nõutavad, kuid ei kinnita ühtset konto loomise või võtme genereerimise töövoogu. Konto ja võtme hankimise kohta vaadake platvormi praegust konsooli ja dokumentatsiooni.
Individuaalkontod peavad avaldatud päringupiirangute tasemete kasutamiseks läbima isikusamasuse kontrolli. Hoidke võtit oma serveris või saladuste halduris; ärge paigutage seda brauseri JavaScripti, mobiilirakendusse ega lähtekoodihoidlasse. Tüüpiline keskkonnamuutujate seadistus on järgmine:
export STEPFUN_API_KEY="your_api_key"Platvormi esitatud rahvusvaheline API baas-URL on https://api.stepfun.ai/v1. Dokumentatsioon ja konsool asuvad eraldi aadressil platform.stepfun.ai.
Millise API ja mudeli peaksite valima?
| Vajadus | Alustuseks | Oluline erinevus |
|---|---|---|
| Uus rakendus, mis kasutab toetatud uuemat mudelit | Responses API | Esitatud uuringu kohaselt soovitatav Step 5 Preview ja Step 3.7 Flashi jaoks. |
| Lai ühilduvus olemasolevate integratsioonidega | Chat Completions API | Seda toetatakse endiselt, kuid mudelipõhised funktsioonid võivad erineda. |
| Tekst ja arutlus | Step 5 Preview või Step 3.7 Flash | Enne konkreetsele funktsioonile tuginemist kontrollige praegust mudelidokumentatsiooni. |
| Üldine mudelikasutus väiksemate kuludega | Step 3.5 Flash | Selle avaldatud rahvusvahelised tokenihinnad on madalamad kui loetletud Step 5 Preview ja Step 3.7 Flashi hinnad. |
| Reaalaja hääl | Toetatud reaalajamudelid | Kasutab tavalise sünkroonse päringu asemel WebSocket-põhist reaalajaliidest. |
Mudelite võimalused ei ole identsed. Enne arutluse, nägemise, heli, tööriistade, struktureeritud väljundi või reaalajafunktsioonide ühendamist tootmiskeskkonnas kontrollige praegust mudelilehte. StepFuni praegustes platvormimaterjalides on esile tõstetud Step 5 Preview, Step 3.7 Flash, Step 3.5 Flash ja StepAudio 3.
Esimese päringu tegemine
Järgmine päring kasutab Responses API-t otse HTTP kaudu. Näide on hoitud lihtsana: saatke tekst, valige mudel ja lugege tagastatud vastuseobjekti.
curl https://api.stepfun.ai/v1/responses
-H "Authorization: Bearer $STEPFUN_API_KEY"
-H "Content-Type: application/json"
-d '{
"model": "step-3.7-flash",
"input": "Explain what an API key is in two sentences."
}'Kasutage täpselt seda mudelitunnust, mida näidatakse StepFuni praeguses mudelidokumentatsioonis. Uuring tuvastab mudeliperekonnad ja kaubanduslikud nimed, kuid ei esita iga mudeli puhul garanteeritud tunnuse õigekirja.
Sama API-t saab kasutada ka OpenAI Pythoni SDK-ga, muutes baas-URL-i ja sisestades StepFuni võtme:
from openai import OpenAI
client = OpenAI(
api_key="your_api_key",
base_url="https://api.stepfun.ai/v1",
)
response = client.responses.create(
model="step-3.7-flash",
input="Explain what an API key is in two sentences.",
)
print(response.output_text)StepFun dokumenteerib ametlikult OpenAI-ga ühilduvat Pythoni ja JavaScripti SDK kasutust. Teiste keelte jaoks on võimalik kasutada otse HTTP-d. Uuring ei kinnita eraldi esimese osapoole StepFuni Pythoni, JavaScripti või PHP SDK kohustuslikku kasutamist.
Vastuse mõistmine
Responses API tulemus on struktureeritud vastuseobjekt, mitte lihtsalt paljas tekstijada. See võib sisaldada loodud väljundiüksusi, kasutusandmeid, tööriistakutseid ja muid metaandmeid. SDK-d võivad pakkuda tavalise tekstiväljundi jaoks mugavusatribuuti, näiteks output_text, kuid tööriistu või multimodaalseid tulemusi kasutavad rakendused peaksid uurima struktureeritud väljundiüksusi.
Tootmiskoodi puhul käsitlege vähemalt järgmisi olukordi:
- Tavaline tekstiväljund, mida kuvatakse kasutajale või edastatakse rakenduse järgmisele komponendile.
- Voogedastussündmused, kui päringut voogedastatakse.
- Funktsiooni- või tööriistakutsed, mille puhul rakendus peab koodi käivitama ja tulemuse tagastama.
- Veateated, mille põhjuseks võivad olla kehtetud mandaadid, toetamata mudelifunktsioonid, vigane sisend või päringupiirangud.
- Kasutusandmed, mida kasutatakse arveldamiseks ja jälgimiseks.
Kuidas StepFun API hinnastamine toimib?
StepFun kasutab kasutuspõhist hinnastamist. Olenevalt teenusest võib arveldamine põhineda sisendtokenitel, väljundtokenitel, vahemällu salvestatud sisendtokenitel, tähemärkidel, kestusel, piltidel, otsingukutsetel või failisalvestusel. Step Plani tellimusjuurdepääs on API kasutuspõhisest arveldamisest eraldi.
Esitatud uuringus on loetletud järgmised praegused rahvusvahelised tokenihinnad:
| Mudel | Sisend vahemälutabamuse puudumisel | Sisend vahemälutabamuse korral | Väljund |
|---|---|---|---|
| Step 5 Preview | 1,00 $ miljoni tokeni kohta | 0,05 $ miljoni tokeni kohta | 2,70 $ miljoni tokeni kohta |
| Step 3.7 Flash | 0,20 $ miljoni tokeni kohta | 0,04 $ miljoni tokeni kohta | 1,15 $ miljoni tokeni kohta |
| Step 3.5 Flash | 0,10 $ miljoni tokeni kohta | 0,02 $ miljoni tokeni kohta | 0,30 $ miljoni tokeni kohta |
Muud loetletud hinnad hõlmavad 0,006 dollarit internetiotsingu kutse kohta, 0,02 dollarit pildiotsingu kutse kohta ja 0,08 dollarit gigabaidi kohta päevas failisalvestuse eest. Hinnad ja mudelite kättesaadavus võivad muutuda, seega kasutage tootmiseelarve hindamisel praegust hinnadokumentatsiooni.
Tegeliku päringu maksumuse hindamisel arvestage nii sisend- kui ka väljundtokeneid, korduvaid viiba eesliiteid, mis võivad kvalifitseeruda vahemällu salvestatud sisendiks, tööriista- või otsingukutseid ning üles laaditud failide säilitusaega. Ärge ajage API-tasusid segamini tarbija- või Step Plani tellimuse hindadega.
Olulised API võimalused
Multimodaalne sisend
StepFun pakub keele-, nägemis-, heli-, pildigeneratsiooni- ja reaalaja häälemudeleid ning -teenuseid. Platvorm toetab pildisisendit ja laiemasse ökosüsteemi kuulub failide ning meedia töötlemine. Funktsioonide tugi sõltub mudelist, seega peaks rakendus valima saadetava sisenditüübi jaoks dokumenteeritud mudeli, mitte eeldama, et iga mudel toetab kõiki modaalsusi.
Väljundi voogedastus
Voogedastus võimaldab rakendusel saada osalist väljundit juba mudeli genereerimise ajal, selle asemel et oodata täielikku vastust. StepFun toetab tavaliste API-interaktsioonide voogedastust serveri saadetud sündmuste kaudu. Samuti pakub see reaalajakasutuseks WebSocket-liidest.
Voogedastus on kasulik vestlusliideste ja pikkade vastuste puhul, kuid klient peab järkjärgulised sündmused kokku panema, katkestatud ühendusi käsitlema ega tohi pidada lõpetamata voogu lõplikuks vastuseks.
Funktsioonide ja tööriistade kutsumine
Funktsioonikutse võimaldab mudelil taotleda teie rakenduse kirjeldatud toimingut, näiteks tellimuse andmete otsimist või sisemise andmebaasi päringut. Mudel ei käivita teie funktsiooni automaatselt. Teie server peab argumendid valideerima, toimingu tegema ja tulemuse mudelile tagasi saatma.
Lihtsustatud Responsesi päringus saab funktsiooni kirjeldada näiteks nii:
{
"model": "step-3.7-flash",
"input": "Find the status of order 1842.",
"tools": [
{
"type": "function",
"name": "get_order_status",
"description": "Look up an order by its identifier",
"parameters": {
"type": "object",
"properties": {
"order_id": { "type": "string" }
},
"required": ["order_id"],
"additionalProperties": false
}
}
]
}Tööriistade skeemid peaksid olema kitsalt piiritletud ja valideeritud. Käsitlege tööriista argumente mitteusaldusväärse sisendina, rakendage autoriseerimist rakendusekoodis ja ärge lubage mudeli loodud päringul ärireeglitest mööda minna.
Failid ja dokumenditöövood
Platvorm pakub faili-API-sid ja toetab failide üleslaadimist. Üles laaditud sisu saab kasutada toetatud failianalüüsi- või multimodaalsetes töövoogudes ning salvestuse eest võetakse loetletud tasu 0,08 dollarit gigabaidi kohta päevas. Täpsed toetatud failitüübid, päringuparameetrid, säilitamise tingimused ja mudelite ühilduvus tuleb üle kontrollida praegusest faili-API dokumentatsioonist.
Struktureeritud JSON-väljundid
Toetatud on struktureeritud väljundid, sealhulgas JSON Schema põhised väljundid. See on kasulik, kui tulemust peab tarbima tarkvara, mitte kuvama otse inimesele, näiteks dokumendist väljade eraldamisel või klassifitseerimisobjekti tagastamisel.
Isegi skeemi kasutamisel valideerige tagastatud andmed oma rakenduses. Skeem võib piirata vastuse kuju, kuid ei taga, et väärtused on faktiliselt õiged või ilma täiendava kontrollita ohutud.
Veebiotsing ja reaalajateenused
Platvorm toetab veebi- ja pildiotsingut tasuliste tööriistakutsetena ning pakub WebSocketi kaudu reaalaja hääleliideseid. Need erinevad tavalisest tekstigeneratsioonist: otsinguga kaasnevad kutsepõhised tasud ja väliste allikate varieeruvus, reaalaja hääl aga nõuab ühenduse haldamist ja mudelipõhist tuge.
Täiustatud näited ja arendustööriistad
Voogedastatava päringu puhul lisage valitud API toetatud voogedastusvalik ja töödelge serveri saadetud sündmusi nende saabumise ajal. Täpsed sündmuste nimed peaksid pärinema StepFuni praegusest Responsesi või Chat Completionsi viitest, mitte olema teise pakkuja teostuse põhjal kõvakodeeritud.
JavaScripti puhul on dokumenteeritud OpenAI-ga ühilduv muster konfigureerida OpenAI klient StepFuni võtme ja baas-URL-iga ning kutsuda seejärel vastavat Responsesi või Chat Completionsi meetodit. Teise keele või HTTP-raamistiku kasutamisel jääb kõige kaasaskantavamaks võimaluseks otse HTTP.
StepFun pakub ka AI Studiot ja arendajatele mõeldud programme, sealhulgas Agent Builder Programi ja Startup Programi. Need võivad aidata eksperimenteerimisel või juurdepääsuprogrammides, kuid ei asenda tootmise API dokumentatsiooni, arveldusreegleid ega turbeülevaatust.
Piirangud ja tootmiskeskkonna kaalutlused
Individuaalsed päringupiirangud sõltuvad kumulatiivse saldo lisamise tasemetest. Avaldatud näited on järgmised:
| Tase | Samaaegsus | Päringuid minutis | Tokeneid minutis |
|---|---|---|---|
| V0 | 5 | 100 | 500 000 |
| V4 | 130 | 2 600 | 13 000 000 |
Ettevõtetele mõeldud piirangud on saadaval müügi kaudu. Need on konto tasemel avaldatud tasemed, mitte garantii, et iga mudel või lõpp-punkt käitub identselt. Ajutiste päringupiirangu vastuste korral rakendage viivitusega korduskatseid, piirake samaaegsust ja jälgige tokenikasutust.
Esitatud uuringus ei kinnitatud avalikku numbrilist latentsuseesmärki ega SLA-d. API pakub tavalist sünkroonset HTTP-d, SSE-voogedastust ja WebSocket-põhiseid reaalajaliideseid, kuid tootmismeeskonnad peaksid mõõtma latentsust oma viipade, piirkondade, mudelivalikute ja liiklusmustrite puhul.
Ka privaatsus vajab ülevaatamist. Platvormi kasutajaprivaatsuse materjalides märgitakse, et tuvastamata kujul ja turvaliselt töödeldud vestlusandmeid võidakse mudelite optimeerimiseks kasutada, kui vastav kasutuskogemuse programm on lubatud; kasutajad saavad selle programmi keelata. Ajutisi vestlusi käsitletakse eraldi ning nende kohta öeldakse, et neid ei kasutata mudelite treenimiseks ega vastuste optimeerimiseks. Enne konfidentsiaalsete, reguleeritud või isikuandmete saatmist tutvuge praeguse privaatsuspoliitikaga.
Mudelite kasutuselt kõrvaldamise ja migreerimise teated on olulised, sest mudelite kättesaadavus muutub. Kinnitage kasutatud mudelinimi, jälgige StepFuni migratsiooniteateid ja hoidke varu- või migratsiooniplaani, selle asemel et eeldada mudeli tähtajatut kättesaadavust.
Eelised ja piirangud
Eelised
- OpenAI-ga ühilduvad HTTP- ja SDK-mustrid vähendavad prototüübi loomisele kuluvat vaeva.
- Responses, Chat Completions, voogedastus, tööriistad, failid, struktureeritud väljundid ja reaalajaliidesed katavad laia valiku rakendusekujundusi.
- Avaldatud tokenihinnad sisaldavad suhteliselt soodsaid valikuid, näiteks Step 3.5 Flashi.
- Laiem platvorm pakub keele-, nägemis-, heli-, pildi- ja hääleteenuseid, mille tugi sõltub konkreetsest mudelist.
Piirangud
- Mudelite funktsioonid, lõpp-punktide tugi, hinnad ja kasutuselt kõrvaldamise olek võivad kiiresti muutuda.
- Individuaalseid päringupiiranguid mõjutavad isikusamasuse kontroll ja kumulatiivse saldo lisamise tasemed.
- Avalikku numbrilist latentsuse- ega SLA-eesmärki ei kinnitatud.
- Kättesaadavus, dokumentatsioon, arveldamine ja registreerimine võivad piirkonniti erineda; ökosüsteem on suunatud Hiinale ning mõnele juurdepääsule on vaja Hiina mobiilinumbri kinnitamist.
- Enne tundliku sisu saatmist tuleb üle vaadata privaatsus- ja andmekasutuse seaded.
Millal on StepFun API hea või halb valik?
StepFun on mõistlik valik, kui soovite OpenAI-ga ühilduvat API-t, vajate hiinakeelseid või multimodaalseid võimalusi, hindate kasutuspõhist hinnastamist või soovite üht platvormi, mis hõlmab teksti, nägemist, tööriistu, faile, otsingut ja reaalaja häält. Seda tasub eriti hinnata siis, kui avaldatud mudelihinnad ja vajalik funktsioonikomplekt sobivad teie töökoormusega.
See on nõrgem valik, kui teie rakendus sõltub üle maailma ühtsest kontole juurdepääsust, iga funktsiooni kohta olemasolevast küpsest ingliskeelsest dokumentatsioonist, avalikult dokumenteeritud SLA-st, mudelite pikaajalisest ja muutumatust kättesaadavusest või sõltumatult kontrollitud ettevõtete privaatsusgarantiidest. Enne tootmiskasutusele võtmist testige täpset mudelit ja lõpp-punkti, mida kavatsete kasutada, kinnitage piirkondlik juurdepääs ja arveldamine, vaadake üle privaatsusseaded ning tehke koormustest vastavalt kehtivale päringupiirangu tasemele.