Léim go dtí an t-ábhar
Clós Súgartha API

Clós Súgartha API

Idirghníomhach

Bain triail as gach múnla agus críochphointe sa bhrabhsálaí le d'eochair féin — aschur sruthaithe, cigire iarratais, agus cód ginte is féidir leat a ghreamú díreach isteach i d'aip.

Seol an Clós Súgartha

Is consól comhrá é an playground don API ag /docs/playground. Labhraíonn tú le múnla, agus seolann an playground na hiarratais chéanna a sheolfadh do chód: chuig ceann de thrí chríochphointe, leis an múnla, an prompt córais, na paraiméadair agus na huirlisí a shocraíonn tú. Is féidir gach iarratas a léamh ar ais mar chód agus mar imeachtaí sruth.

Tosú

  • Tabhair eochair dó — Nuair a bhíonn tú sínithe isteach, úsáideann an playground eochair API do chuntais agus taispeánann sé d'iarmhéid. Mura bhfuil tú sínithe isteach, roghnaigh Add key agus greamaigh eochair: coinnítear sa chluaisín seo amháin í agus ní shábháiltear riamh í.
  • Roghnaigh críochphointe agus múnla — Tá an lasc críochphointe agus an roghnóir múnla sa bharra uachtair. Tosaíonn comhrá nua ar Chat Completions le shannon-3.
  • Seol teachtaireacht — Clóscríobh thíos agus brúigh Enter. Téann gach freagra isteach sa chomhrá, mar sin leanann an chéad teachtaireacht eile é. Tairgeann an scáileán folamh trí prompt tosaigh agus sampla réitithe do ghlao uirlise.

Gheobhaidh tú d'eochair agus rothlóidh tú í ar an leathanach Eochracha agus úsáid. Eochracha agus úsáid

Críochphointí agus múnlaí

Socraíonn an lasc críochphointe cén fhormáid iarratais a thógann an playground. Is féidir leat é a athrú i lár comhrá; fanann na teachtaireachtaí.

Críochphointe An t-iarratas a sheolann sé Tagairt
Chat Completions POST /v1/chat/completions Chat Completions
Responses POST /v1/responses Responses API
Messages POST /v1/messages Formáid Antraipeach

Liostaíonn an roghnóir múnla an méid a fhilleann GET /v1/models. Is féidir cuardach a dhéanamh ann, coinníonn sé do mhúnlaí le déanaí ar bharr, agus taispeánann sé do gach múnla an praghas in aghaidh gach 1M token, an fhuinneog comhthéacs agus marcanna le haghaidh uirlisí, ionchur íomhá, réasúnaíocht agus aschur struchtúrtha.

An comhrá

  • Sruthaíonn freagraí isteach sa chomhrá agus iad á scríobh. Taispeántar réasúnaíocht an mhúnla i mbloc dá chuid féin ar féidir leat é a fhilleadh.
  • Faoi gach freagra: an t-am go dtí an chéad token, tokens in aghaidh an tsoicind, an t-am caite, tokens ionchuir agus aschuir lena gcodanna taiscthe agus réasúnaíochta, meastachán ar chostas an chasta, an chúis chríochnaithe agus id an fhreagra.
  • Is féidir teachtaireacht leat a chur in eagar agus a sheoladh arís ón bpointe sin. Is féidir freagra a athghiniúint. Is féidir teachtaireacht a scriosadh, agus is féidir an scriosadh a chur ar ceal ar feadh cúpla soicind.
  • Cuireann Stop nó an eochair Esc deireadh le freagra atá á scríobh.
  • Ceanglaítear íomhánna leis an gcnaipe íomhá, trí ghreamú nó trí chomhad a scaoileadh, do mhúnlaí a ghlacann le híomhánna. Athraítear méid íomhá go 1,568 picteilín ar a imeall fada sula seoltar í. Scipeáiltear comhad os cionn 30 MB.
  • Taispeánann an comhdhéantóir agus an prompt córais líon token. Do na múnlaí open-weight óstáilte is é an líon beacht ó POST /v1/tokenize é. Do na múnlaí eile is meastachán é, marcáilte le ≈.
  • Taispeánann iarratas a theip cad atá le déanamh ansin: socraigh eochair nuair a diúltaíodh don eochair, athlán nuair a úsáideadh an t-iarmhéid, líon na soicindí le fanacht tar éis an iomarca iarratas, nó atriail tar éis earráide freastalaí.

Socruithe iarratais

Osclaíonn an cnaipe Settings painéal le sé chluaisín. Baineann na socruithe leis an gcomhrá: coinníonn gach comhrá a shocruithe féin.

Cluaisín Cad atá ann
System Prompt córais an chomhrá, a sheoltar le gach iarratas. Líonann cúig theimpléad isteach é, agus taispeántar a líon token.
Paraiméadair Uasmhéid token aschuir, teocht, top_p, iarracht réasúnaíochta, seicheamh stoptha, seed, agus na lasca don sruthú agus don chuardach gréasáin. Díghníomhachtaítear agus marcáiltear rialú nach bhfuil réimse aige ar an gcríochphointe roghnaithe.
Uirlisí Sainmhínithe uirlisí a sheoltar leis an iarratas: ceithre réamhshocrú (get_weather, read_file, run_shell, web_search) nó do shainmhíniú féin mar JSON, agus tool_choice (auto, none, required nó uirlis amháin de réir ainm). Nuair a ghlaonn an múnla uirlis, taispeánann an comhrá an glao le bosca don toradh. Le Offer sample results casta air, líonann cliceáil amháin toradh samplach isteach. Is féidir leat do thoradh féin a chlóscríobh freisin, agus ansin é a sheoladh chun an cas a leanúint.
Structured response_format: text, json_object nó json_schema le hainm scéime agus scéim JSON. Nuair a shocraítear scéim, seiceáiltear an freagra deireanach ina coinne agus marcáiltear sa chomhrá an bhfuil sé ag teacht léi nó nach bhfuil. Tá an cluaisín as ar an gcríochphointe Messages, agus ní thairgtear rogha nach nglacann an múnla roghnaithe léi.
Cód Iarratas an chomhrá reatha mar chód cURL, Python, Node nó Go, tógtha ón gcomhrá agus óna shocruithe. Priontáiltear an eochair mar YOUR_API_KEY. Is féidir an cód a chóipeáil nó a oscailt i radharc mór.
Imeachtaí An cas deireanach mar a chuaigh sé ar an sreang: gach imeacht sruth lena fhritháireamh ama agus scagaire, an freagra cóimeáilte, ceanntásca an fhreagra (x-request-id, content-type, retry-after, date) agus corp an iarratais. Coinnítear iad go dtí go n-athlódáiltear an leathanach.

Seiceálacha ionchuir

Seiceáiltear na luachanna a chlóscríobhann tú sula seoltar iarratas. Marcáitear luach lasmuigh den raon ag a réimse, agus coinnítear siar an seoladh go dtí go socraítear é.

Socrú Seiceáil
Uasmhéid token aschuir Slánuimhir ó 1 go max_output_tokens an mhúnla.
Teocht Uimhir ó 0 go 2. Fágann réimse folamh an réimse as an iarratas.
top_p Uimhir ó 0 go 1. Fágann réimse folamh an réimse as an iarratas.
seed Slánuimhir.
Seicheamh stoptha 4 ar a mhéad, scartha le camóga.
response_format Caithfidh sé a bheith ar cheann a nglacann an múnla roghnaithe leis. Coinnítear siar comhrá a aistrítear chuig múnla gan json_schema nó gan response_format, agus tugtar an chúis.
Íomhánna Baintear den teachtaireacht iad nuair a athraíonn tú go múnla nach nglacann ach le téacs, agus tugtar nóta.

Compare two models

Cuireann Compare two models sa roghchlár More dara roghnóir múnla leis. Téann gach teachtaireacht chuig an dá mhúnla ansin ag an am céanna, leis na socruithe céanna, agus seasann an dá fhreagra taobh le taobh, marcáilte A agus B. Is féidir leat taobh amháin a athghiniúint ina aonar. Nuair a ghlaonn taobh amháin uirlis, leanann an toradh a sheolann tú an taobh sin amháin.

Comhroinn, easpórtáil agus iompórtáil

  • Pacálann Copy share link an comhrá isteach sa nasc féin, sa chuid i ndiaidh #. Ní uaslódáiltear faic. Fágtar na híomhánna, d'eochair agus sonraí an rite dheireanaigh ar lár. An té a osclaíonn an nasc, faigheann sé an comhrá mar chomhrá nua ina playground féin.
  • Diúltaítear do chomhrá atá rófhada do nasc, agus tugtar nóta. Íoslódáil mar JSON é ina ionad.
  • Sábhálann Download conversation JSON an comhrá agus a shocruithe mar chomhad. Osclaíonn Import JSON sa phainéal comhráite a leithéid de chomhad.
  • Cóipeálann Copy as cURL an t-iarratas reatha mar ordú cURL amháin.

Cad a choinnítear cá

Cad é Cá gcoinnítear é
Comhráite, uirlisí sábháilte, múnlaí le déanaí, leagan amach na bpainéal Sa bhrabhsálaí seo. Ní sheoltar chuig Shannon iad agus ní leanann siad thú chuig gléas eile.
Eochair API I gcuimhne an chluaisín oscailte. Imíonn eochair ghreamaithe nuair a athlódáiltear an leathanach nó nuair a dhúntar an cluaisín. Nuair a bhíonn tú sínithe isteach, léitear an eochair ó do chuntas gach uair.
Imeachtaí sruth, ceanntásca agus iarratas an chasta dheireanaigh Sa leathanach oscailte, go dtí go n-athlódáiltear é.
Iarratais Seolta ó do bhrabhsálaí chuig an API le d'eochair. Áirítear iad i gcoinne d'iarmhéid cosúil le haon iarratas API eile.

Méarchlár

Eochracha Cad a dhéanann sé
Enter Seol an teachtaireacht.
Shift + Enter Tosaigh líne nua.
Ctrl + K Oscail pailéad na n-orduithe: athraigh críochphointe nó múnla, socraigh teimpléad córais, tosaigh comhrá nua, scoránaigh sruthú, uirlisí nó comparáid. Ar Mac: ⌘ K.
Esc Stop an freagra atá á scríobh, nó dún painéal oscailte ar scáileán cúng.

Seol an Clós Súgartha