qwen3-asr-api.json 520 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958695969606961696269636964696569666967696869696970697169726973697469756976697769786979698069816982698369846985698669876988698969906991699269936994699569966997699869997000700170027003700470057006700770087009701070117012701370147015701670177018701970207021702270237024702570267027702870297030703170327033703470357036703770387039704070417042704370447045704670477048704970507051705270537054705570567057705870597060706170627063706470657066706770687069707070717072707370747075707670777078707970807081708270837084708570867087708870897090709170927093709470957096709770987099710071017102710371047105710671077108710971107111711271137114711571167117711871197120712171227123712471257126712771287129713071317132713371347135713671377138713971407141714271437144714571467147714871497150715171527153715471557156715771587159716071617162716371647165716671677168716971707171717271737174717571767177717871797180718171827183718471857186718771887189719071917192719371947195719671977198719972007201720272037204720572067207720872097210721172127213721472157216721772187219722072217222722372247225722672277228722972307231723272337234723572367237723872397240724172427243724472457246724772487249725072517252725372547255725672577258725972607261726272637264726572667267726872697270727172727273727472757276727772787279728072817282728372847285728672877288728972907291729272937294729572967297729872997300730173027303730473057306730773087309731073117312731373147315731673177318731973207321732273237324732573267327732873297330733173327333733473357336733773387339734073417342734373447345734673477348734973507351735273537354735573567357735873597360736173627363736473657366736773687369737073717372737373747375737673777378737973807381738273837384738573867387738873897390739173927393739473957396739773987399740074017402740374047405740674077408740974107411741274137414741574167417741874197420742174227423742474257426742774287429743074317432743374347435743674377438743974407441744274437444744574467447744874497450745174527453745474557456745774587459746074617462746374647465746674677468746974707471747274737474747574767477747874797480748174827483748474857486748774887489749074917492749374947495749674977498749975007501750275037504750575067507750875097510751175127513751475157516751775187519752075217522752375247525752675277528752975307531753275337534753575367537753875397540754175427543754475457546754775487549755075517552755375547555755675577558755975607561756275637564756575667567756875697570757175727573757475757576757775787579758075817582758375847585758675877588758975907591759275937594759575967597759875997600760176027603760476057606760776087609761076117612761376147615761676177618761976207621762276237624762576267627762876297630763176327633763476357636763776387639764076417642764376447645764676477648764976507651765276537654765576567657765876597660766176627663766476657666766776687669767076717672767376747675767676777678767976807681768276837684768576867687768876897690769176927693769476957696769776987699770077017702770377047705770677077708770977107711771277137714771577167717771877197720772177227723772477257726772777287729773077317732773377347735773677377738773977407741774277437744774577467747774877497750775177527753775477557756775777587759776077617762776377647765776677677768776977707771777277737774777577767777777877797780778177827783778477857786778777887789779077917792779377947795779677977798779978007801780278037804780578067807780878097810781178127813781478157816781778187819782078217822782378247825782678277828782978307831783278337834783578367837783878397840784178427843784478457846784778487849785078517852785378547855785678577858785978607861786278637864786578667867786878697870787178727873787478757876787778787879788078817882788378847885788678877888788978907891789278937894789578967897789878997900790179027903790479057906790779087909791079117912791379147915791679177918791979207921792279237924792579267927792879297930793179327933793479357936793779387939794079417942794379447945794679477948794979507951795279537954795579567957795879597960796179627963796479657966796779687969797079717972797379747975797679777978797979807981798279837984798579867987798879897990799179927993799479957996799779987999800080018002800380048005800680078008800980108011801280138014801580168017801880198020802180228023802480258026802780288029803080318032803380348035803680378038803980408041804280438044804580468047804880498050805180528053805480558056805780588059806080618062806380648065806680678068806980708071807280738074807580768077807880798080808180828083808480858086808780888089809080918092809380948095809680978098809981008101810281038104810581068107810881098110811181128113811481158116811781188119812081218122812381248125812681278128812981308131813281338134813581368137813881398140814181428143814481458146814781488149815081518152815381548155815681578158815981608161816281638164816581668167816881698170817181728173817481758176817781788179818081818182818381848185818681878188818981908191819281938194819581968197819881998200820182028203820482058206820782088209821082118212821382148215821682178218821982208221822282238224822582268227822882298230823182328233823482358236823782388239824082418242824382448245824682478248824982508251825282538254825582568257825882598260826182628263826482658266826782688269827082718272827382748275827682778278827982808281828282838284828582868287828882898290829182928293829482958296829782988299830083018302830383048305830683078308830983108311831283138314831583168317831883198320832183228323832483258326832783288329833083318332833383348335833683378338833983408341834283438344834583468347834883498350835183528353835483558356835783588359836083618362836383648365836683678368836983708371837283738374837583768377837883798380838183828383838483858386838783888389839083918392839383948395839683978398839984008401840284038404840584068407840884098410841184128413841484158416841784188419842084218422842384248425842684278428842984308431843284338434843584368437843884398440844184428443844484458446844784488449845084518452845384548455845684578458845984608461846284638464846584668467846884698470847184728473847484758476847784788479848084818482848384848485848684878488848984908491849284938494849584968497849884998500850185028503850485058506850785088509851085118512851385148515851685178518851985208521852285238524852585268527852885298530853185328533853485358536853785388539854085418542854385448545854685478548854985508551855285538554855585568557855885598560856185628563856485658566856785688569857085718572857385748575857685778578857985808581858285838584858585868587858885898590859185928593859485958596859785988599860086018602860386048605860686078608860986108611861286138614861586168617861886198620862186228623862486258626862786288629863086318632863386348635863686378638863986408641864286438644864586468647864886498650865186528653865486558656865786588659866086618662866386648665866686678668866986708671867286738674867586768677867886798680868186828683868486858686868786888689869086918692869386948695869686978698869987008701870287038704870587068707870887098710871187128713871487158716871787188719872087218722872387248725872687278728872987308731873287338734873587368737873887398740874187428743874487458746874787488749875087518752875387548755875687578758875987608761876287638764876587668767876887698770877187728773877487758776877787788779878087818782878387848785878687878788878987908791879287938794879587968797879887998800880188028803880488058806880788088809881088118812881388148815881688178818881988208821882288238824882588268827882888298830883188328833883488358836883788388839884088418842884388448845884688478848884988508851885288538854885588568857885888598860886188628863886488658866886788688869887088718872887388748875887688778878887988808881888288838884888588868887888888898890889188928893889488958896889788988899890089018902890389048905890689078908890989108911891289138914891589168917891889198920892189228923892489258926892789288929893089318932893389348935893689378938893989408941894289438944894589468947894889498950895189528953895489558956895789588959896089618962896389648965896689678968896989708971897289738974897589768977897889798980898189828983898489858986898789888989899089918992899389948995899689978998899990009001900290039004900590069007900890099010901190129013901490159016901790189019902090219022902390249025902690279028902990309031903290339034903590369037903890399040904190429043904490459046904790489049905090519052905390549055905690579058905990609061906290639064906590669067906890699070907190729073907490759076907790789079908090819082908390849085908690879088908990909091909290939094909590969097909890999100910191029103910491059106910791089109911091119112911391149115911691179118911991209121912291239124912591269127912891299130913191329133913491359136913791389139914091419142914391449145914691479148914991509151915291539154915591569157915891599160916191629163916491659166916791689169917091719172917391749175917691779178917991809181918291839184918591869187918891899190919191929193919491959196919791989199920092019202920392049205920692079208920992109211921292139214921592169217921892199220922192229223922492259226922792289229923092319232923392349235923692379238923992409241924292439244924592469247924892499250925192529253925492559256925792589259926092619262926392649265926692679268926992709271927292739274927592769277927892799280928192829283928492859286928792889289929092919292929392949295929692979298929993009301930293039304930593069307930893099310931193129313931493159316931793189319932093219322932393249325932693279328932993309331933293339334933593369337933893399340934193429343934493459346934793489349935093519352935393549355935693579358935993609361936293639364936593669367936893699370937193729373937493759376937793789379938093819382938393849385938693879388938993909391939293939394939593969397939893999400940194029403940494059406940794089409941094119412941394149415941694179418941994209421942294239424942594269427942894299430943194329433943494359436943794389439944094419442944394449445944694479448944994509451945294539454945594569457945894599460946194629463946494659466946794689469947094719472947394749475947694779478947994809481948294839484948594869487948894899490949194929493949494959496949794989499950095019502950395049505950695079508950995109511951295139514951595169517951895199520952195229523952495259526952795289529953095319532953395349535953695379538953995409541954295439544954595469547954895499550955195529553955495559556955795589559956095619562956395649565956695679568956995709571957295739574957595769577957895799580958195829583958495859586958795889589959095919592959395949595959695979598959996009601960296039604960596069607960896099610961196129613961496159616961796189619962096219622962396249625962696279628962996309631963296339634963596369637963896399640964196429643964496459646964796489649965096519652965396549655965696579658965996609661966296639664966596669667966896699670967196729673967496759676967796789679968096819682968396849685968696879688968996909691969296939694969596969697969896999700970197029703970497059706970797089709971097119712971397149715971697179718971997209721972297239724972597269727972897299730973197329733973497359736973797389739974097419742974397449745974697479748974997509751975297539754975597569757975897599760976197629763976497659766976797689769977097719772977397749775977697779778977997809781978297839784978597869787978897899790979197929793979497959796979797989799980098019802980398049805980698079808980998109811981298139814981598169817981898199820982198229823982498259826982798289829983098319832983398349835983698379838983998409841984298439844984598469847984898499850985198529853985498559856985798589859986098619862986398649865986698679868986998709871987298739874987598769877987898799880988198829883988498859886988798889889989098919892989398949895989698979898989999009901990299039904990599069907990899099910991199129913991499159916991799189919992099219922992399249925992699279928992999309931993299339934993599369937993899399940994199429943994499459946994799489949995099519952995399549955995699579958995999609961996299639964996599669967996899699970997199729973997499759976997799789979998099819982998399849985998699879988998999909991999299939994999599969997999899991000010001100021000310004100051000610007100081000910010100111001210013100141001510016100171001810019100201002110022100231002410025100261002710028100291003010031100321003310034100351003610037100381003910040100411004210043100441004510046100471004810049100501005110052100531005410055100561005710058100591006010061100621006310064100651006610067100681006910070100711007210073100741007510076100771007810079100801008110082100831008410085100861008710088100891009010091100921009310094100951009610097100981009910100101011010210103101041010510106101071010810109101101011110112101131011410115101161011710118101191012010121101221012310124101251012610127101281012910130101311013210133101341013510136101371013810139101401014110142101431014410145101461014710148101491015010151101521015310154101551015610157101581015910160101611016210163101641016510166101671016810169101701017110172101731017410175101761017710178101791018010181101821018310184101851018610187101881018910190101911019210193101941019510196101971019810199102001020110202102031020410205102061020710208102091021010211102121021310214102151021610217102181021910220102211022210223102241022510226102271022810229102301023110232102331023410235102361023710238102391024010241102421024310244102451024610247102481024910250102511025210253102541025510256102571025810259102601026110262102631026410265102661026710268102691027010271102721027310274102751027610277102781027910280102811028210283102841028510286102871028810289102901029110292102931029410295102961029710298102991030010301103021030310304103051030610307103081030910310103111031210313103141031510316103171031810319103201032110322103231032410325103261032710328103291033010331103321033310334103351033610337103381033910340103411034210343103441034510346103471034810349103501035110352103531035410355103561035710358103591036010361103621036310364103651036610367103681036910370103711037210373103741037510376103771037810379103801038110382103831038410385103861038710388103891039010391103921039310394103951039610397103981039910400104011040210403104041040510406104071040810409104101041110412104131041410415104161041710418104191042010421104221042310424104251042610427104281042910430104311043210433104341043510436104371043810439104401044110442104431044410445104461044710448104491045010451104521045310454104551045610457104581045910460104611046210463104641046510466104671046810469104701047110472104731047410475104761047710478104791048010481104821048310484104851048610487104881048910490104911049210493104941049510496104971049810499105001050110502105031050410505105061050710508105091051010511105121051310514105151051610517105181051910520105211052210523105241052510526105271052810529105301053110532105331053410535105361053710538105391054010541105421054310544105451054610547105481054910550105511055210553105541055510556105571055810559105601056110562105631056410565105661056710568105691057010571105721057310574105751057610577105781057910580105811058210583105841058510586105871058810589105901059110592105931059410595105961059710598105991060010601106021060310604106051060610607106081060910610106111061210613106141061510616106171061810619106201062110622106231062410625106261062710628106291063010631106321063310634106351063610637106381063910640106411064210643106441064510646106471064810649106501065110652106531065410655106561065710658106591066010661106621066310664106651066610667106681066910670106711067210673106741067510676106771067810679106801068110682106831068410685106861068710688106891069010691106921069310694106951069610697106981069910700107011070210703107041070510706107071070810709107101071110712107131071410715107161071710718107191072010721107221072310724107251072610727107281072910730107311073210733107341073510736107371073810739107401074110742107431074410745107461074710748107491075010751107521075310754107551075610757107581075910760107611076210763107641076510766107671076810769107701077110772107731077410775107761077710778107791078010781107821078310784107851078610787107881078910790107911079210793107941079510796107971079810799108001080110802108031080410805108061080710808108091081010811108121081310814108151081610817108181081910820108211082210823108241082510826108271082810829108301083110832108331083410835108361083710838108391084010841108421084310844108451084610847108481084910850108511085210853108541085510856108571085810859108601086110862108631086410865108661086710868108691087010871108721087310874108751087610877108781087910880108811088210883108841088510886108871088810889108901089110892108931089410895108961089710898108991090010901109021090310904109051090610907109081090910910109111091210913109141091510916109171091810919109201092110922109231092410925109261092710928109291093010931109321093310934109351093610937109381093910940109411094210943109441094510946109471094810949109501095110952109531095410955109561095710958109591096010961109621096310964109651096610967109681096910970109711097210973109741097510976109771097810979109801098110982109831098410985109861098710988109891099010991109921099310994109951099610997109981099911000110011100211003110041100511006110071100811009110101101111012110131101411015110161101711018110191102011021110221102311024110251102611027110281102911030110311103211033110341103511036110371103811039110401104111042110431104411045110461104711048110491105011051110521105311054110551105611057110581105911060110611106211063110641106511066110671106811069110701107111072110731107411075110761107711078110791108011081110821108311084110851108611087110881108911090110911109211093110941109511096110971109811099111001110111102111031110411105111061110711108111091111011111111121111311114111151111611117111181111911120111211112211123111241112511126111271112811129111301113111132111331113411135111361113711138111391114011141111421114311144111451114611147111481114911150111511115211153111541115511156111571115811159111601116111162111631116411165111661116711168111691117011171111721117311174111751117611177111781117911180111811118211183111841118511186111871118811189111901119111192111931119411195111961119711198111991120011201112021120311204112051120611207112081120911210112111121211213112141121511216112171121811219112201122111222112231122411225112261122711228112291123011231112321123311234112351123611237112381123911240112411124211243112441124511246112471124811249112501125111252112531125411255112561125711258112591126011261112621126311264112651126611267112681126911270112711127211273112741127511276112771127811279112801128111282112831128411285112861128711288112891129011291112921129311294112951129611297112981129911300113011130211303113041130511306113071130811309113101131111312113131131411315113161131711318113191132011321113221132311324113251132611327113281132911330113311133211333113341133511336113371133811339113401134111342113431134411345113461134711348113491135011351113521135311354113551135611357113581135911360113611136211363113641136511366113671136811369113701137111372113731137411375113761137711378113791138011381113821138311384113851138611387113881138911390113911139211393113941139511396113971139811399114001140111402114031140411405114061140711408114091141011411114121141311414114151141611417114181141911420114211142211423114241142511426114271142811429114301143111432114331143411435114361143711438114391144011441114421144311444114451144611447114481144911450114511145211453114541145511456114571145811459114601146111462114631146411465114661146711468114691147011471114721147311474114751147611477114781147911480114811148211483114841148511486114871148811489114901149111492114931149411495114961149711498114991150011501115021150311504115051150611507115081150911510115111151211513115141151511516115171151811519115201152111522115231152411525115261152711528115291153011531115321153311534115351153611537115381153911540115411154211543115441154511546115471154811549115501155111552115531155411555115561155711558115591156011561115621156311564115651156611567115681156911570115711157211573115741157511576115771157811579115801158111582115831158411585115861158711588115891159011591115921159311594115951159611597115981159911600116011160211603116041160511606116071160811609116101161111612116131161411615116161161711618116191162011621116221162311624116251162611627116281162911630116311163211633116341163511636116371163811639116401164111642116431164411645116461164711648116491165011651116521165311654116551165611657116581165911660116611166211663116641166511666116671166811669116701167111672116731167411675116761167711678116791168011681116821168311684116851168611687116881168911690116911169211693116941169511696116971169811699117001170111702117031170411705117061170711708117091171011711117121171311714117151171611717117181171911720117211172211723117241172511726117271172811729117301173111732117331173411735117361173711738117391174011741117421174311744117451174611747117481174911750117511175211753117541175511756117571175811759117601176111762117631176411765117661176711768117691177011771117721177311774117751177611777117781177911780117811178211783117841178511786117871178811789117901179111792117931179411795117961179711798117991180011801118021180311804118051180611807118081180911810118111181211813118141181511816118171181811819118201182111822118231182411825118261182711828118291183011831118321183311834118351183611837118381183911840118411184211843118441184511846118471184811849118501185111852118531185411855118561185711858118591186011861118621186311864118651186611867118681186911870118711187211873118741187511876118771187811879118801188111882118831188411885118861188711888118891189011891118921189311894118951189611897118981189911900119011190211903119041190511906119071190811909119101191111912119131191411915119161191711918119191192011921119221192311924119251192611927119281192911930119311193211933119341193511936119371193811939119401194111942119431194411945119461194711948119491195011951119521195311954119551195611957119581195911960119611196211963119641196511966119671196811969119701197111972119731197411975119761197711978119791198011981119821198311984119851198611987119881198911990119911199211993119941199511996119971199811999120001200112002120031200412005120061200712008120091201012011120121201312014120151201612017120181201912020120211202212023120241202512026120271202812029120301203112032120331203412035120361203712038120391204012041120421204312044120451204612047120481204912050120511205212053120541205512056120571205812059120601206112062120631206412065120661206712068120691207012071120721207312074120751207612077120781207912080120811208212083120841208512086120871208812089120901209112092120931209412095120961209712098120991210012101121021210312104121051210612107121081210912110121111211212113121141211512116121171211812119121201212112122121231212412125121261212712128121291213012131121321213312134121351213612137121381213912140121411214212143121441214512146121471214812149121501215112152121531215412155121561215712158121591216012161121621216312164121651216612167121681216912170121711217212173121741217512176121771217812179121801218112182121831218412185121861218712188121891219012191121921219312194121951219612197121981219912200122011220212203122041220512206122071220812209122101221112212122131221412215122161221712218122191222012221122221222312224122251222612227122281222912230122311223212233122341223512236122371223812239122401224112242122431224412245122461224712248122491225012251122521225312254122551225612257122581225912260122611226212263122641226512266122671226812269122701227112272122731227412275122761227712278122791228012281122821228312284122851228612287122881228912290122911229212293122941229512296122971229812299123001230112302123031230412305123061230712308123091231012311123121231312314123151231612317123181231912320123211232212323123241232512326123271232812329123301233112332123331233412335123361233712338123391234012341123421234312344123451234612347123481234912350123511235212353123541235512356123571235812359123601236112362123631236412365123661236712368123691237012371123721237312374123751237612377123781237912380123811238212383123841238512386123871238812389123901239112392123931239412395123961239712398123991240012401124021240312404124051240612407124081240912410124111241212413124141241512416124171241812419124201242112422124231242412425124261242712428124291243012431124321243312434124351243612437124381243912440124411244212443124441244512446124471244812449124501245112452124531245412455124561245712458124591246012461124621246312464124651246612467124681246912470124711247212473124741247512476124771247812479124801248112482124831248412485124861248712488124891249012491124921249312494124951249612497124981249912500125011250212503125041250512506125071250812509125101251112512125131251412515125161251712518125191252012521125221252312524125251252612527125281252912530125311253212533125341253512536125371253812539125401254112542125431254412545125461254712548125491255012551125521255312554125551255612557125581255912560125611256212563125641256512566125671256812569125701257112572125731257412575125761257712578125791258012581125821258312584125851258612587125881258912590125911259212593125941259512596125971259812599126001260112602126031260412605126061260712608126091261012611126121261312614126151261612617126181261912620126211262212623126241262512626126271262812629126301263112632126331263412635126361263712638126391264012641126421264312644126451264612647126481264912650126511265212653126541265512656126571265812659126601266112662126631266412665126661266712668126691267012671126721267312674126751267612677126781267912680126811268212683126841268512686126871268812689126901269112692126931269412695126961269712698126991270012701127021270312704127051270612707127081270912710127111271212713127141271512716127171271812719127201272112722127231272412725127261272712728127291273012731127321273312734127351273612737127381273912740127411274212743127441274512746127471274812749127501275112752127531275412755127561275712758127591276012761127621276312764127651276612767127681276912770127711277212773127741277512776127771277812779127801278112782127831278412785127861278712788127891279012791127921279312794127951279612797127981279912800128011280212803128041280512806128071280812809128101281112812128131281412815128161281712818128191282012821128221282312824128251282612827128281282912830128311283212833128341283512836128371283812839128401284112842128431284412845128461284712848128491285012851128521285312854128551285612857128581285912860128611286212863128641286512866128671286812869128701287112872128731287412875128761287712878128791288012881128821288312884128851288612887128881288912890128911289212893128941289512896128971289812899129001290112902129031290412905129061290712908129091291012911129121291312914129151291612917129181291912920129211292212923129241292512926129271292812929129301293112932129331293412935129361293712938129391294012941129421294312944129451294612947129481294912950129511295212953129541295512956129571295812959129601296112962129631296412965129661296712968129691297012971129721297312974129751297612977129781297912980129811298212983129841298512986129871298812989129901299112992129931299412995129961299712998129991300013001130021300313004130051300613007130081300913010130111301213013130141301513016130171301813019130201302113022130231302413025130261302713028130291303013031130321303313034130351303613037130381303913040130411304213043130441304513046130471304813049130501305113052130531305413055130561305713058130591306013061130621306313064130651306613067130681306913070130711307213073130741307513076130771307813079130801308113082130831308413085130861308713088130891309013091130921309313094130951309613097130981309913100131011310213103131041310513106131071310813109131101311113112131131311413115131161311713118131191312013121131221312313124131251312613127131281312913130131311313213133131341313513136131371313813139131401314113142131431314413145131461314713148131491315013151131521315313154131551315613157131581315913160131611316213163131641316513166131671316813169131701317113172131731317413175131761317713178131791318013181131821318313184131851318613187131881318913190131911319213193131941319513196131971319813199132001320113202132031320413205132061320713208132091321013211132121321313214132151321613217132181321913220132211322213223132241322513226132271322813229132301323113232132331323413235132361323713238132391324013241132421324313244132451324613247132481324913250132511325213253132541325513256132571325813259132601326113262132631326413265132661326713268132691327013271132721327313274132751327613277132781327913280132811328213283132841328513286132871328813289132901329113292132931329413295132961329713298132991330013301133021330313304133051330613307133081330913310133111331213313133141331513316133171331813319133201332113322133231332413325133261332713328133291333013331133321333313334133351333613337133381333913340133411334213343133441334513346133471334813349133501335113352133531335413355133561335713358133591336013361133621336313364133651336613367133681336913370133711337213373133741337513376133771337813379133801338113382133831338413385133861338713388133891339013391133921339313394133951339613397133981339913400134011340213403134041340513406134071340813409134101341113412134131341413415134161341713418134191342013421134221342313424134251342613427134281342913430134311343213433134341343513436134371343813439134401344113442134431344413445134461344713448134491345013451134521345313454134551345613457134581345913460134611346213463134641346513466134671346813469134701347113472134731347413475134761347713478134791348013481134821348313484134851348613487134881348913490134911349213493134941349513496134971349813499135001350113502135031350413505135061350713508135091351013511135121351313514135151351613517135181351913520135211352213523135241352513526135271352813529135301353113532135331353413535135361353713538135391354013541135421354313544135451354613547135481354913550135511355213553135541355513556135571355813559135601356113562135631356413565135661356713568135691357013571135721357313574135751357613577135781357913580135811358213583135841358513586135871358813589135901359113592135931359413595135961359713598135991360013601136021360313604136051360613607136081360913610136111361213613136141361513616136171361813619
  1. {
  2. "openapi": "3.1.0",
  3. "info": {
  4. "title": "FastAPI",
  5. "version": "0.1.0"
  6. },
  7. "paths": {
  8. "/scale_elastic_ep": {
  9. "post": {
  10. "summary": "Scale Elastic Ep",
  11. "operationId": "scale_elastic_ep_scale_elastic_ep_post",
  12. "responses": {
  13. "200": {
  14. "description": "Successful Response",
  15. "content": {
  16. "application/json": {
  17. "schema": {
  18. "additionalProperties": true,
  19. "type": "object",
  20. "title": "Response 200 Scale Elastic Ep Scale Elastic Ep Post"
  21. }
  22. }
  23. }
  24. },
  25. "400": {
  26. "description": "Bad Request",
  27. "content": {
  28. "application/json": {
  29. "schema": {
  30. "$ref": "#/components/schemas/ErrorResponse"
  31. }
  32. }
  33. }
  34. },
  35. "408": {
  36. "description": "Request Timeout",
  37. "content": {
  38. "application/json": {
  39. "schema": {
  40. "$ref": "#/components/schemas/ErrorResponse"
  41. }
  42. }
  43. }
  44. },
  45. "500": {
  46. "description": "Internal Server Error",
  47. "content": {
  48. "application/json": {
  49. "schema": {
  50. "$ref": "#/components/schemas/ErrorResponse"
  51. }
  52. }
  53. }
  54. }
  55. }
  56. }
  57. },
  58. "/is_scaling_elastic_ep": {
  59. "post": {
  60. "summary": "Is Scaling Elastic Ep",
  61. "operationId": "is_scaling_elastic_ep_is_scaling_elastic_ep_post",
  62. "responses": {
  63. "200": {
  64. "description": "Successful Response",
  65. "content": {
  66. "application/json": {
  67. "schema": {}
  68. }
  69. }
  70. }
  71. }
  72. }
  73. },
  74. "/tokenize": {
  75. "post": {
  76. "summary": "Tokenize",
  77. "operationId": "tokenize_tokenize_post",
  78. "requestBody": {
  79. "content": {
  80. "application/json": {
  81. "schema": {
  82. "anyOf": [
  83. {
  84. "$ref": "#/components/schemas/TokenizeCompletionRequest"
  85. },
  86. {
  87. "$ref": "#/components/schemas/TokenizeChatRequest"
  88. }
  89. ],
  90. "title": "Request"
  91. }
  92. }
  93. },
  94. "required": true
  95. },
  96. "responses": {
  97. "200": {
  98. "description": "Successful Response",
  99. "content": {
  100. "application/json": {
  101. "schema": {}
  102. }
  103. }
  104. },
  105. "400": {
  106. "description": "Bad Request",
  107. "content": {
  108. "application/json": {
  109. "schema": {
  110. "$ref": "#/components/schemas/ErrorResponse"
  111. }
  112. }
  113. }
  114. },
  115. "404": {
  116. "description": "Not Found",
  117. "content": {
  118. "application/json": {
  119. "schema": {
  120. "$ref": "#/components/schemas/ErrorResponse"
  121. }
  122. }
  123. }
  124. },
  125. "422": {
  126. "description": "Validation Error",
  127. "content": {
  128. "application/json": {
  129. "schema": {
  130. "$ref": "#/components/schemas/HTTPValidationError"
  131. }
  132. }
  133. }
  134. },
  135. "500": {
  136. "description": "Internal Server Error",
  137. "content": {
  138. "application/json": {
  139. "schema": {
  140. "$ref": "#/components/schemas/ErrorResponse"
  141. }
  142. }
  143. }
  144. },
  145. "501": {
  146. "description": "Not Implemented",
  147. "content": {
  148. "application/json": {
  149. "schema": {
  150. "$ref": "#/components/schemas/ErrorResponse"
  151. }
  152. }
  153. }
  154. }
  155. }
  156. }
  157. },
  158. "/detokenize": {
  159. "post": {
  160. "summary": "Detokenize",
  161. "operationId": "detokenize_detokenize_post",
  162. "requestBody": {
  163. "content": {
  164. "application/json": {
  165. "schema": {
  166. "$ref": "#/components/schemas/DetokenizeRequest"
  167. }
  168. }
  169. },
  170. "required": true
  171. },
  172. "responses": {
  173. "200": {
  174. "description": "Successful Response",
  175. "content": {
  176. "application/json": {
  177. "schema": {}
  178. }
  179. }
  180. },
  181. "400": {
  182. "description": "Bad Request",
  183. "content": {
  184. "application/json": {
  185. "schema": {
  186. "$ref": "#/components/schemas/ErrorResponse"
  187. }
  188. }
  189. }
  190. },
  191. "404": {
  192. "description": "Not Found",
  193. "content": {
  194. "application/json": {
  195. "schema": {
  196. "$ref": "#/components/schemas/ErrorResponse"
  197. }
  198. }
  199. }
  200. },
  201. "422": {
  202. "description": "Validation Error",
  203. "content": {
  204. "application/json": {
  205. "schema": {
  206. "$ref": "#/components/schemas/HTTPValidationError"
  207. }
  208. }
  209. }
  210. },
  211. "500": {
  212. "description": "Internal Server Error",
  213. "content": {
  214. "application/json": {
  215. "schema": {
  216. "$ref": "#/components/schemas/ErrorResponse"
  217. }
  218. }
  219. }
  220. }
  221. }
  222. }
  223. },
  224. "/inference/v1/generate": {
  225. "post": {
  226. "summary": "Generate",
  227. "operationId": "generate_inference_v1_generate_post",
  228. "requestBody": {
  229. "content": {
  230. "application/json": {
  231. "schema": {
  232. "$ref": "#/components/schemas/GenerateRequest"
  233. }
  234. }
  235. },
  236. "required": true
  237. },
  238. "responses": {
  239. "200": {
  240. "description": "Successful Response",
  241. "content": {
  242. "application/json": {
  243. "schema": {}
  244. },
  245. "text/event-stream": {}
  246. }
  247. },
  248. "400": {
  249. "description": "Bad Request",
  250. "content": {
  251. "application/json": {
  252. "schema": {
  253. "$ref": "#/components/schemas/ErrorResponse"
  254. }
  255. }
  256. }
  257. },
  258. "404": {
  259. "description": "Not Found",
  260. "content": {
  261. "application/json": {
  262. "schema": {
  263. "$ref": "#/components/schemas/ErrorResponse"
  264. }
  265. }
  266. }
  267. },
  268. "422": {
  269. "description": "Validation Error",
  270. "content": {
  271. "application/json": {
  272. "schema": {
  273. "$ref": "#/components/schemas/HTTPValidationError"
  274. }
  275. }
  276. }
  277. },
  278. "500": {
  279. "description": "Internal Server Error",
  280. "content": {
  281. "application/json": {
  282. "schema": {
  283. "$ref": "#/components/schemas/ErrorResponse"
  284. }
  285. }
  286. }
  287. }
  288. }
  289. }
  290. },
  291. "/pause": {
  292. "post": {
  293. "summary": "Pause Generation",
  294. "description": "Pause generation requests to allow weight updates.\n\nArgs:\n wait_for_inflight_requests: When ``True`` waits for in-flight\n requests to finish before pausing. When ``False`` (default),\n aborts any in-flight requests immediately.\n clear_cache: Whether to clear KV/prefix caches after draining.",
  295. "operationId": "pause_generation_pause_post",
  296. "parameters": [
  297. {
  298. "name": "wait_for_inflight_requests",
  299. "in": "query",
  300. "required": false,
  301. "schema": {
  302. "type": "boolean",
  303. "default": false,
  304. "title": "Wait For Inflight Requests"
  305. }
  306. },
  307. {
  308. "name": "clear_cache",
  309. "in": "query",
  310. "required": false,
  311. "schema": {
  312. "type": "boolean",
  313. "default": true,
  314. "title": "Clear Cache"
  315. }
  316. }
  317. ],
  318. "responses": {
  319. "200": {
  320. "description": "Successful Response",
  321. "content": {
  322. "application/json": {
  323. "schema": {}
  324. }
  325. }
  326. },
  327. "422": {
  328. "description": "Validation Error",
  329. "content": {
  330. "application/json": {
  331. "schema": {
  332. "$ref": "#/components/schemas/HTTPValidationError"
  333. }
  334. }
  335. }
  336. }
  337. }
  338. }
  339. },
  340. "/resume": {
  341. "post": {
  342. "summary": "Resume Generation",
  343. "description": "Resume generation after a pause.",
  344. "operationId": "resume_generation_resume_post",
  345. "responses": {
  346. "200": {
  347. "description": "Successful Response",
  348. "content": {
  349. "application/json": {
  350. "schema": {}
  351. }
  352. }
  353. }
  354. }
  355. }
  356. },
  357. "/is_paused": {
  358. "get": {
  359. "summary": "Is Paused",
  360. "description": "Return the current pause status.",
  361. "operationId": "is_paused_is_paused_get",
  362. "responses": {
  363. "200": {
  364. "description": "Successful Response",
  365. "content": {
  366. "application/json": {
  367. "schema": {}
  368. }
  369. }
  370. }
  371. }
  372. }
  373. },
  374. "/metrics": {
  375. "get": {
  376. "summary": "Metrics",
  377. "description": "Endpoint that serves Prometheus metrics.",
  378. "operationId": "metrics_metrics_get",
  379. "responses": {
  380. "200": {
  381. "description": "Successful Response",
  382. "content": {
  383. "text/plain; version=1.0.0; charset=utf-8": {
  384. "schema": {
  385. "type": "string"
  386. }
  387. }
  388. }
  389. }
  390. }
  391. }
  392. },
  393. "/health": {
  394. "get": {
  395. "summary": "Health",
  396. "description": "Health check.",
  397. "operationId": "health_health_get",
  398. "responses": {
  399. "200": {
  400. "description": "Successful Response"
  401. }
  402. }
  403. }
  404. },
  405. "/load": {
  406. "get": {
  407. "summary": "Get Server Load Metrics",
  408. "operationId": "get_server_load_metrics_load_get",
  409. "responses": {
  410. "200": {
  411. "description": "Successful Response",
  412. "content": {
  413. "application/json": {
  414. "schema": {}
  415. }
  416. }
  417. }
  418. }
  419. }
  420. },
  421. "/v1/models": {
  422. "get": {
  423. "summary": "Show Available Models",
  424. "operationId": "show_available_models_v1_models_get",
  425. "responses": {
  426. "200": {
  427. "description": "Successful Response",
  428. "content": {
  429. "application/json": {
  430. "schema": {}
  431. }
  432. }
  433. }
  434. }
  435. }
  436. },
  437. "/version": {
  438. "get": {
  439. "summary": "Show Version",
  440. "operationId": "show_version_version_get",
  441. "responses": {
  442. "200": {
  443. "description": "Successful Response",
  444. "content": {
  445. "application/json": {
  446. "schema": {}
  447. }
  448. }
  449. }
  450. }
  451. }
  452. },
  453. "/v1/responses": {
  454. "post": {
  455. "summary": "Create Responses",
  456. "operationId": "create_responses_v1_responses_post",
  457. "requestBody": {
  458. "content": {
  459. "application/json": {
  460. "schema": {
  461. "$ref": "#/components/schemas/ResponsesRequest"
  462. }
  463. }
  464. },
  465. "required": true
  466. },
  467. "responses": {
  468. "200": {
  469. "description": "Successful Response",
  470. "content": {
  471. "application/json": {
  472. "schema": {}
  473. },
  474. "text/event-stream": {}
  475. }
  476. },
  477. "400": {
  478. "description": "Bad Request",
  479. "content": {
  480. "application/json": {
  481. "schema": {
  482. "$ref": "#/components/schemas/ErrorResponse"
  483. }
  484. }
  485. }
  486. },
  487. "404": {
  488. "description": "Not Found",
  489. "content": {
  490. "application/json": {
  491. "schema": {
  492. "$ref": "#/components/schemas/ErrorResponse"
  493. }
  494. }
  495. }
  496. },
  497. "422": {
  498. "description": "Validation Error",
  499. "content": {
  500. "application/json": {
  501. "schema": {
  502. "$ref": "#/components/schemas/HTTPValidationError"
  503. }
  504. }
  505. }
  506. },
  507. "500": {
  508. "description": "Internal Server Error",
  509. "content": {
  510. "application/json": {
  511. "schema": {
  512. "$ref": "#/components/schemas/ErrorResponse"
  513. }
  514. }
  515. }
  516. }
  517. }
  518. }
  519. },
  520. "/v1/responses/{response_id}": {
  521. "get": {
  522. "summary": "Retrieve Responses",
  523. "operationId": "retrieve_responses_v1_responses__response_id__get",
  524. "parameters": [
  525. {
  526. "name": "response_id",
  527. "in": "path",
  528. "required": true,
  529. "schema": {
  530. "type": "string",
  531. "title": "Response Id"
  532. }
  533. },
  534. {
  535. "name": "starting_after",
  536. "in": "query",
  537. "required": false,
  538. "schema": {
  539. "anyOf": [
  540. {
  541. "type": "integer"
  542. },
  543. {
  544. "type": "null"
  545. }
  546. ],
  547. "title": "Starting After"
  548. }
  549. },
  550. {
  551. "name": "stream",
  552. "in": "query",
  553. "required": false,
  554. "schema": {
  555. "anyOf": [
  556. {
  557. "type": "boolean"
  558. },
  559. {
  560. "type": "null"
  561. }
  562. ],
  563. "default": false,
  564. "title": "Stream"
  565. }
  566. }
  567. ],
  568. "responses": {
  569. "200": {
  570. "description": "Successful Response",
  571. "content": {
  572. "application/json": {
  573. "schema": {}
  574. }
  575. }
  576. },
  577. "422": {
  578. "description": "Validation Error",
  579. "content": {
  580. "application/json": {
  581. "schema": {
  582. "$ref": "#/components/schemas/HTTPValidationError"
  583. }
  584. }
  585. }
  586. }
  587. }
  588. }
  589. },
  590. "/v1/responses/{response_id}/cancel": {
  591. "post": {
  592. "summary": "Cancel Responses",
  593. "operationId": "cancel_responses_v1_responses__response_id__cancel_post",
  594. "parameters": [
  595. {
  596. "name": "response_id",
  597. "in": "path",
  598. "required": true,
  599. "schema": {
  600. "type": "string",
  601. "title": "Response Id"
  602. }
  603. }
  604. ],
  605. "responses": {
  606. "200": {
  607. "description": "Successful Response",
  608. "content": {
  609. "application/json": {
  610. "schema": {}
  611. }
  612. }
  613. },
  614. "422": {
  615. "description": "Validation Error",
  616. "content": {
  617. "application/json": {
  618. "schema": {
  619. "$ref": "#/components/schemas/HTTPValidationError"
  620. }
  621. }
  622. }
  623. }
  624. }
  625. }
  626. },
  627. "/v1/messages": {
  628. "post": {
  629. "summary": "Create Messages",
  630. "operationId": "create_messages_v1_messages_post",
  631. "requestBody": {
  632. "content": {
  633. "application/json": {
  634. "schema": {
  635. "$ref": "#/components/schemas/AnthropicMessagesRequest"
  636. }
  637. }
  638. },
  639. "required": true
  640. },
  641. "responses": {
  642. "200": {
  643. "description": "Successful Response",
  644. "content": {
  645. "application/json": {
  646. "schema": {}
  647. },
  648. "text/event-stream": {}
  649. }
  650. },
  651. "400": {
  652. "description": "Bad Request",
  653. "content": {
  654. "application/json": {
  655. "schema": {
  656. "$ref": "#/components/schemas/AnthropicErrorResponse"
  657. }
  658. }
  659. }
  660. },
  661. "404": {
  662. "description": "Not Found",
  663. "content": {
  664. "application/json": {
  665. "schema": {
  666. "$ref": "#/components/schemas/AnthropicErrorResponse"
  667. }
  668. }
  669. }
  670. },
  671. "422": {
  672. "description": "Validation Error",
  673. "content": {
  674. "application/json": {
  675. "schema": {
  676. "$ref": "#/components/schemas/HTTPValidationError"
  677. }
  678. }
  679. }
  680. },
  681. "500": {
  682. "description": "Internal Server Error",
  683. "content": {
  684. "application/json": {
  685. "schema": {
  686. "$ref": "#/components/schemas/AnthropicErrorResponse"
  687. }
  688. }
  689. }
  690. }
  691. }
  692. }
  693. },
  694. "/v1/chat/completions": {
  695. "post": {
  696. "summary": "Create Chat Completion",
  697. "operationId": "create_chat_completion_v1_chat_completions_post",
  698. "requestBody": {
  699. "content": {
  700. "application/json": {
  701. "schema": {
  702. "$ref": "#/components/schemas/ChatCompletionRequest"
  703. }
  704. }
  705. },
  706. "required": true
  707. },
  708. "responses": {
  709. "200": {
  710. "description": "Successful Response",
  711. "content": {
  712. "application/json": {
  713. "schema": {}
  714. },
  715. "text/event-stream": {}
  716. }
  717. },
  718. "400": {
  719. "description": "Bad Request",
  720. "content": {
  721. "application/json": {
  722. "schema": {
  723. "$ref": "#/components/schemas/ErrorResponse"
  724. }
  725. }
  726. }
  727. },
  728. "404": {
  729. "description": "Not Found",
  730. "content": {
  731. "application/json": {
  732. "schema": {
  733. "$ref": "#/components/schemas/ErrorResponse"
  734. }
  735. }
  736. }
  737. },
  738. "422": {
  739. "description": "Validation Error",
  740. "content": {
  741. "application/json": {
  742. "schema": {
  743. "$ref": "#/components/schemas/HTTPValidationError"
  744. }
  745. }
  746. }
  747. },
  748. "500": {
  749. "description": "Internal Server Error",
  750. "content": {
  751. "application/json": {
  752. "schema": {
  753. "$ref": "#/components/schemas/ErrorResponse"
  754. }
  755. }
  756. }
  757. }
  758. }
  759. }
  760. },
  761. "/v1/completions": {
  762. "post": {
  763. "summary": "Create Completion",
  764. "operationId": "create_completion_v1_completions_post",
  765. "requestBody": {
  766. "content": {
  767. "application/json": {
  768. "schema": {
  769. "$ref": "#/components/schemas/CompletionRequest"
  770. }
  771. }
  772. },
  773. "required": true
  774. },
  775. "responses": {
  776. "200": {
  777. "description": "Successful Response",
  778. "content": {
  779. "application/json": {
  780. "schema": {}
  781. },
  782. "text/event-stream": {}
  783. }
  784. },
  785. "400": {
  786. "description": "Bad Request",
  787. "content": {
  788. "application/json": {
  789. "schema": {
  790. "$ref": "#/components/schemas/ErrorResponse"
  791. }
  792. }
  793. }
  794. },
  795. "404": {
  796. "description": "Not Found",
  797. "content": {
  798. "application/json": {
  799. "schema": {
  800. "$ref": "#/components/schemas/ErrorResponse"
  801. }
  802. }
  803. }
  804. },
  805. "422": {
  806. "description": "Validation Error",
  807. "content": {
  808. "application/json": {
  809. "schema": {
  810. "$ref": "#/components/schemas/HTTPValidationError"
  811. }
  812. }
  813. }
  814. },
  815. "500": {
  816. "description": "Internal Server Error",
  817. "content": {
  818. "application/json": {
  819. "schema": {
  820. "$ref": "#/components/schemas/ErrorResponse"
  821. }
  822. }
  823. }
  824. }
  825. }
  826. }
  827. },
  828. "/v1/audio/transcriptions": {
  829. "post": {
  830. "summary": "Create Transcriptions",
  831. "operationId": "create_transcriptions_v1_audio_transcriptions_post",
  832. "requestBody": {
  833. "content": {
  834. "application/x-www-form-urlencoded": {
  835. "schema": {
  836. "$ref": "#/components/schemas/TranscriptionRequest"
  837. }
  838. }
  839. },
  840. "required": true
  841. },
  842. "responses": {
  843. "200": {
  844. "description": "Successful Response",
  845. "content": {
  846. "application/json": {
  847. "schema": {}
  848. },
  849. "text/event-stream": {}
  850. }
  851. },
  852. "400": {
  853. "description": "Bad Request",
  854. "content": {
  855. "application/json": {
  856. "schema": {
  857. "$ref": "#/components/schemas/ErrorResponse"
  858. }
  859. }
  860. }
  861. },
  862. "422": {
  863. "description": "Unprocessable Entity",
  864. "content": {
  865. "application/json": {
  866. "schema": {
  867. "$ref": "#/components/schemas/ErrorResponse"
  868. }
  869. }
  870. }
  871. },
  872. "500": {
  873. "description": "Internal Server Error",
  874. "content": {
  875. "application/json": {
  876. "schema": {
  877. "$ref": "#/components/schemas/ErrorResponse"
  878. }
  879. }
  880. }
  881. }
  882. }
  883. }
  884. },
  885. "/v1/audio/translations": {
  886. "post": {
  887. "summary": "Create Translations",
  888. "operationId": "create_translations_v1_audio_translations_post",
  889. "requestBody": {
  890. "content": {
  891. "application/x-www-form-urlencoded": {
  892. "schema": {
  893. "$ref": "#/components/schemas/TranslationRequest"
  894. }
  895. }
  896. },
  897. "required": true
  898. },
  899. "responses": {
  900. "200": {
  901. "description": "Successful Response",
  902. "content": {
  903. "application/json": {
  904. "schema": {}
  905. },
  906. "text/event-stream": {}
  907. }
  908. },
  909. "400": {
  910. "description": "Bad Request",
  911. "content": {
  912. "application/json": {
  913. "schema": {
  914. "$ref": "#/components/schemas/ErrorResponse"
  915. }
  916. }
  917. }
  918. },
  919. "422": {
  920. "description": "Unprocessable Entity",
  921. "content": {
  922. "application/json": {
  923. "schema": {
  924. "$ref": "#/components/schemas/ErrorResponse"
  925. }
  926. }
  927. }
  928. },
  929. "500": {
  930. "description": "Internal Server Error",
  931. "content": {
  932. "application/json": {
  933. "schema": {
  934. "$ref": "#/components/schemas/ErrorResponse"
  935. }
  936. }
  937. }
  938. }
  939. }
  940. }
  941. },
  942. "/ping": {
  943. "get": {
  944. "summary": "Ping",
  945. "description": "Ping check. Endpoint required for SageMaker",
  946. "operationId": "ping_ping_get",
  947. "responses": {
  948. "200": {
  949. "description": "Successful Response"
  950. }
  951. }
  952. },
  953. "post": {
  954. "summary": "Ping",
  955. "description": "Ping check. Endpoint required for SageMaker",
  956. "operationId": "ping_ping_post",
  957. "responses": {
  958. "200": {
  959. "description": "Successful Response"
  960. }
  961. }
  962. }
  963. },
  964. "/invocations": {
  965. "post": {
  966. "summary": "Decorated Func",
  967. "description": "The actual wrapped handler function that applies transformations.",
  968. "operationId": "decorated_func_invocations_post",
  969. "responses": {
  970. "200": {
  971. "description": "Successful Response",
  972. "content": {
  973. "application/json": {
  974. "schema": {}
  975. }
  976. }
  977. },
  978. "400": {
  979. "description": "Bad Request",
  980. "content": {
  981. "application/json": {
  982. "schema": {
  983. "$ref": "#/components/schemas/ErrorResponse"
  984. }
  985. }
  986. }
  987. },
  988. "415": {
  989. "description": "Unsupported Media Type",
  990. "content": {
  991. "application/json": {
  992. "schema": {
  993. "$ref": "#/components/schemas/ErrorResponse"
  994. }
  995. }
  996. }
  997. },
  998. "500": {
  999. "description": "Internal Server Error",
  1000. "content": {
  1001. "application/json": {
  1002. "schema": {
  1003. "$ref": "#/components/schemas/ErrorResponse"
  1004. }
  1005. }
  1006. }
  1007. }
  1008. }
  1009. }
  1010. },
  1011. "/classify": {
  1012. "post": {
  1013. "summary": "Create Classify",
  1014. "operationId": "create_classify_classify_post",
  1015. "requestBody": {
  1016. "content": {
  1017. "application/json": {
  1018. "schema": {
  1019. "anyOf": [
  1020. {
  1021. "$ref": "#/components/schemas/ClassificationCompletionRequest"
  1022. },
  1023. {
  1024. "$ref": "#/components/schemas/ClassificationChatRequest"
  1025. }
  1026. ],
  1027. "title": "Request"
  1028. }
  1029. }
  1030. },
  1031. "required": true
  1032. },
  1033. "responses": {
  1034. "200": {
  1035. "description": "Successful Response",
  1036. "content": {
  1037. "application/json": {
  1038. "schema": {}
  1039. }
  1040. }
  1041. },
  1042. "422": {
  1043. "description": "Validation Error",
  1044. "content": {
  1045. "application/json": {
  1046. "schema": {
  1047. "$ref": "#/components/schemas/HTTPValidationError"
  1048. }
  1049. }
  1050. }
  1051. }
  1052. }
  1053. }
  1054. },
  1055. "/v1/embeddings": {
  1056. "post": {
  1057. "summary": "Create Embedding",
  1058. "operationId": "create_embedding_v1_embeddings_post",
  1059. "requestBody": {
  1060. "content": {
  1061. "application/json": {
  1062. "schema": {
  1063. "anyOf": [
  1064. {
  1065. "$ref": "#/components/schemas/EmbeddingCompletionRequest"
  1066. },
  1067. {
  1068. "$ref": "#/components/schemas/EmbeddingChatRequest"
  1069. }
  1070. ],
  1071. "title": "Request"
  1072. }
  1073. }
  1074. },
  1075. "required": true
  1076. },
  1077. "responses": {
  1078. "200": {
  1079. "description": "Successful Response",
  1080. "content": {
  1081. "application/json": {
  1082. "schema": {}
  1083. }
  1084. }
  1085. },
  1086. "400": {
  1087. "description": "Bad Request",
  1088. "content": {
  1089. "application/json": {
  1090. "schema": {
  1091. "$ref": "#/components/schemas/ErrorResponse"
  1092. }
  1093. }
  1094. }
  1095. },
  1096. "422": {
  1097. "description": "Validation Error",
  1098. "content": {
  1099. "application/json": {
  1100. "schema": {
  1101. "$ref": "#/components/schemas/HTTPValidationError"
  1102. }
  1103. }
  1104. }
  1105. },
  1106. "500": {
  1107. "description": "Internal Server Error",
  1108. "content": {
  1109. "application/json": {
  1110. "schema": {
  1111. "$ref": "#/components/schemas/ErrorResponse"
  1112. }
  1113. }
  1114. }
  1115. }
  1116. }
  1117. }
  1118. },
  1119. "/score": {
  1120. "post": {
  1121. "summary": "Create Score",
  1122. "operationId": "create_score_score_post",
  1123. "requestBody": {
  1124. "content": {
  1125. "application/json": {
  1126. "schema": {
  1127. "$ref": "#/components/schemas/ScoreRequest"
  1128. }
  1129. }
  1130. },
  1131. "required": true
  1132. },
  1133. "responses": {
  1134. "200": {
  1135. "description": "Successful Response",
  1136. "content": {
  1137. "application/json": {
  1138. "schema": {}
  1139. }
  1140. }
  1141. },
  1142. "400": {
  1143. "description": "Bad Request",
  1144. "content": {
  1145. "application/json": {
  1146. "schema": {
  1147. "$ref": "#/components/schemas/ErrorResponse"
  1148. }
  1149. }
  1150. }
  1151. },
  1152. "422": {
  1153. "description": "Validation Error",
  1154. "content": {
  1155. "application/json": {
  1156. "schema": {
  1157. "$ref": "#/components/schemas/HTTPValidationError"
  1158. }
  1159. }
  1160. }
  1161. },
  1162. "500": {
  1163. "description": "Internal Server Error",
  1164. "content": {
  1165. "application/json": {
  1166. "schema": {
  1167. "$ref": "#/components/schemas/ErrorResponse"
  1168. }
  1169. }
  1170. }
  1171. }
  1172. }
  1173. }
  1174. },
  1175. "/v1/score": {
  1176. "post": {
  1177. "summary": "Create Score V1",
  1178. "operationId": "create_score_v1_v1_score_post",
  1179. "requestBody": {
  1180. "content": {
  1181. "application/json": {
  1182. "schema": {
  1183. "$ref": "#/components/schemas/ScoreRequest"
  1184. }
  1185. }
  1186. },
  1187. "required": true
  1188. },
  1189. "responses": {
  1190. "200": {
  1191. "description": "Successful Response",
  1192. "content": {
  1193. "application/json": {
  1194. "schema": {}
  1195. }
  1196. }
  1197. },
  1198. "400": {
  1199. "description": "Bad Request",
  1200. "content": {
  1201. "application/json": {
  1202. "schema": {
  1203. "$ref": "#/components/schemas/ErrorResponse"
  1204. }
  1205. }
  1206. }
  1207. },
  1208. "422": {
  1209. "description": "Validation Error",
  1210. "content": {
  1211. "application/json": {
  1212. "schema": {
  1213. "$ref": "#/components/schemas/HTTPValidationError"
  1214. }
  1215. }
  1216. }
  1217. },
  1218. "500": {
  1219. "description": "Internal Server Error",
  1220. "content": {
  1221. "application/json": {
  1222. "schema": {
  1223. "$ref": "#/components/schemas/ErrorResponse"
  1224. }
  1225. }
  1226. }
  1227. }
  1228. }
  1229. }
  1230. },
  1231. "/rerank": {
  1232. "post": {
  1233. "summary": "Do Rerank",
  1234. "operationId": "do_rerank_rerank_post",
  1235. "requestBody": {
  1236. "content": {
  1237. "application/json": {
  1238. "schema": {
  1239. "$ref": "#/components/schemas/RerankRequest"
  1240. }
  1241. }
  1242. },
  1243. "required": true
  1244. },
  1245. "responses": {
  1246. "200": {
  1247. "description": "Successful Response",
  1248. "content": {
  1249. "application/json": {
  1250. "schema": {}
  1251. }
  1252. }
  1253. },
  1254. "400": {
  1255. "description": "Bad Request",
  1256. "content": {
  1257. "application/json": {
  1258. "schema": {
  1259. "$ref": "#/components/schemas/ErrorResponse"
  1260. }
  1261. }
  1262. }
  1263. },
  1264. "422": {
  1265. "description": "Validation Error",
  1266. "content": {
  1267. "application/json": {
  1268. "schema": {
  1269. "$ref": "#/components/schemas/HTTPValidationError"
  1270. }
  1271. }
  1272. }
  1273. },
  1274. "500": {
  1275. "description": "Internal Server Error",
  1276. "content": {
  1277. "application/json": {
  1278. "schema": {
  1279. "$ref": "#/components/schemas/ErrorResponse"
  1280. }
  1281. }
  1282. }
  1283. }
  1284. }
  1285. }
  1286. },
  1287. "/v1/rerank": {
  1288. "post": {
  1289. "summary": "Do Rerank V1",
  1290. "operationId": "do_rerank_v1_v1_rerank_post",
  1291. "requestBody": {
  1292. "content": {
  1293. "application/json": {
  1294. "schema": {
  1295. "$ref": "#/components/schemas/RerankRequest"
  1296. }
  1297. }
  1298. },
  1299. "required": true
  1300. },
  1301. "responses": {
  1302. "200": {
  1303. "description": "Successful Response",
  1304. "content": {
  1305. "application/json": {
  1306. "schema": {}
  1307. }
  1308. }
  1309. },
  1310. "400": {
  1311. "description": "Bad Request",
  1312. "content": {
  1313. "application/json": {
  1314. "schema": {
  1315. "$ref": "#/components/schemas/ErrorResponse"
  1316. }
  1317. }
  1318. }
  1319. },
  1320. "422": {
  1321. "description": "Validation Error",
  1322. "content": {
  1323. "application/json": {
  1324. "schema": {
  1325. "$ref": "#/components/schemas/HTTPValidationError"
  1326. }
  1327. }
  1328. }
  1329. },
  1330. "500": {
  1331. "description": "Internal Server Error",
  1332. "content": {
  1333. "application/json": {
  1334. "schema": {
  1335. "$ref": "#/components/schemas/ErrorResponse"
  1336. }
  1337. }
  1338. }
  1339. }
  1340. }
  1341. }
  1342. },
  1343. "/v2/rerank": {
  1344. "post": {
  1345. "summary": "Do Rerank V2",
  1346. "operationId": "do_rerank_v2_v2_rerank_post",
  1347. "requestBody": {
  1348. "content": {
  1349. "application/json": {
  1350. "schema": {
  1351. "$ref": "#/components/schemas/RerankRequest"
  1352. }
  1353. }
  1354. },
  1355. "required": true
  1356. },
  1357. "responses": {
  1358. "200": {
  1359. "description": "Successful Response",
  1360. "content": {
  1361. "application/json": {
  1362. "schema": {}
  1363. }
  1364. }
  1365. },
  1366. "400": {
  1367. "description": "Bad Request",
  1368. "content": {
  1369. "application/json": {
  1370. "schema": {
  1371. "$ref": "#/components/schemas/ErrorResponse"
  1372. }
  1373. }
  1374. }
  1375. },
  1376. "422": {
  1377. "description": "Validation Error",
  1378. "content": {
  1379. "application/json": {
  1380. "schema": {
  1381. "$ref": "#/components/schemas/HTTPValidationError"
  1382. }
  1383. }
  1384. }
  1385. },
  1386. "500": {
  1387. "description": "Internal Server Error",
  1388. "content": {
  1389. "application/json": {
  1390. "schema": {
  1391. "$ref": "#/components/schemas/ErrorResponse"
  1392. }
  1393. }
  1394. }
  1395. }
  1396. }
  1397. }
  1398. },
  1399. "/pooling": {
  1400. "post": {
  1401. "summary": "Create Pooling",
  1402. "operationId": "create_pooling_pooling_post",
  1403. "requestBody": {
  1404. "content": {
  1405. "application/json": {
  1406. "schema": {
  1407. "anyOf": [
  1408. {
  1409. "$ref": "#/components/schemas/PoolingCompletionRequest"
  1410. },
  1411. {
  1412. "$ref": "#/components/schemas/PoolingChatRequest"
  1413. },
  1414. {
  1415. "$ref": "#/components/schemas/IOProcessorRequest"
  1416. }
  1417. ],
  1418. "title": "Request"
  1419. }
  1420. }
  1421. },
  1422. "required": true
  1423. },
  1424. "responses": {
  1425. "200": {
  1426. "description": "Successful Response",
  1427. "content": {
  1428. "application/json": {
  1429. "schema": {}
  1430. }
  1431. }
  1432. },
  1433. "400": {
  1434. "description": "Bad Request",
  1435. "content": {
  1436. "application/json": {
  1437. "schema": {
  1438. "$ref": "#/components/schemas/ErrorResponse"
  1439. }
  1440. }
  1441. }
  1442. },
  1443. "422": {
  1444. "description": "Validation Error",
  1445. "content": {
  1446. "application/json": {
  1447. "schema": {
  1448. "$ref": "#/components/schemas/HTTPValidationError"
  1449. }
  1450. }
  1451. }
  1452. },
  1453. "500": {
  1454. "description": "Internal Server Error",
  1455. "content": {
  1456. "application/json": {
  1457. "schema": {
  1458. "$ref": "#/components/schemas/ErrorResponse"
  1459. }
  1460. }
  1461. }
  1462. }
  1463. }
  1464. }
  1465. }
  1466. },
  1467. "components": {
  1468. "schemas": {
  1469. "Action": {
  1470. "properties": {
  1471. "commands": {
  1472. "items": {
  1473. "type": "string"
  1474. },
  1475. "type": "array",
  1476. "title": "Commands"
  1477. },
  1478. "max_output_length": {
  1479. "anyOf": [
  1480. {
  1481. "type": "integer"
  1482. },
  1483. {
  1484. "type": "null"
  1485. }
  1486. ],
  1487. "title": "Max Output Length"
  1488. },
  1489. "timeout_ms": {
  1490. "anyOf": [
  1491. {
  1492. "type": "integer"
  1493. },
  1494. {
  1495. "type": "null"
  1496. }
  1497. ],
  1498. "title": "Timeout Ms"
  1499. }
  1500. },
  1501. "additionalProperties": true,
  1502. "type": "object",
  1503. "required": [
  1504. "commands"
  1505. ],
  1506. "title": "Action",
  1507. "description": "The shell commands and limits that describe how to run the tool call."
  1508. },
  1509. "ActionClick": {
  1510. "properties": {
  1511. "button": {
  1512. "type": "string",
  1513. "enum": [
  1514. "left",
  1515. "right",
  1516. "wheel",
  1517. "back",
  1518. "forward"
  1519. ],
  1520. "title": "Button"
  1521. },
  1522. "type": {
  1523. "type": "string",
  1524. "const": "click",
  1525. "title": "Type"
  1526. },
  1527. "x": {
  1528. "type": "integer",
  1529. "title": "X"
  1530. },
  1531. "y": {
  1532. "type": "integer",
  1533. "title": "Y"
  1534. }
  1535. },
  1536. "additionalProperties": true,
  1537. "type": "object",
  1538. "required": [
  1539. "button",
  1540. "type",
  1541. "x",
  1542. "y"
  1543. ],
  1544. "title": "ActionClick",
  1545. "description": "A click action."
  1546. },
  1547. "ActionDoubleClick": {
  1548. "properties": {
  1549. "type": {
  1550. "type": "string",
  1551. "const": "double_click",
  1552. "title": "Type"
  1553. },
  1554. "x": {
  1555. "type": "integer",
  1556. "title": "X"
  1557. },
  1558. "y": {
  1559. "type": "integer",
  1560. "title": "Y"
  1561. }
  1562. },
  1563. "additionalProperties": true,
  1564. "type": "object",
  1565. "required": [
  1566. "type",
  1567. "x",
  1568. "y"
  1569. ],
  1570. "title": "ActionDoubleClick",
  1571. "description": "A double click action."
  1572. },
  1573. "ActionDrag": {
  1574. "properties": {
  1575. "path": {
  1576. "items": {
  1577. "$ref": "#/components/schemas/ActionDragPath"
  1578. },
  1579. "type": "array",
  1580. "title": "Path"
  1581. },
  1582. "type": {
  1583. "type": "string",
  1584. "const": "drag",
  1585. "title": "Type"
  1586. }
  1587. },
  1588. "additionalProperties": true,
  1589. "type": "object",
  1590. "required": [
  1591. "path",
  1592. "type"
  1593. ],
  1594. "title": "ActionDrag",
  1595. "description": "A drag action."
  1596. },
  1597. "ActionDragPath": {
  1598. "properties": {
  1599. "x": {
  1600. "type": "integer",
  1601. "title": "X"
  1602. },
  1603. "y": {
  1604. "type": "integer",
  1605. "title": "Y"
  1606. }
  1607. },
  1608. "additionalProperties": true,
  1609. "type": "object",
  1610. "required": [
  1611. "x",
  1612. "y"
  1613. ],
  1614. "title": "ActionDragPath",
  1615. "description": "An x/y coordinate pair, e.g. `{ x: 100, y: 200 }`."
  1616. },
  1617. "ActionFind": {
  1618. "properties": {
  1619. "pattern": {
  1620. "type": "string",
  1621. "title": "Pattern"
  1622. },
  1623. "type": {
  1624. "type": "string",
  1625. "const": "find",
  1626. "title": "Type"
  1627. },
  1628. "url": {
  1629. "type": "string",
  1630. "title": "Url"
  1631. }
  1632. },
  1633. "additionalProperties": true,
  1634. "type": "object",
  1635. "required": [
  1636. "pattern",
  1637. "type",
  1638. "url"
  1639. ],
  1640. "title": "ActionFind",
  1641. "description": "Action type \"find\": Searches for a pattern within a loaded page."
  1642. },
  1643. "ActionKeypress": {
  1644. "properties": {
  1645. "keys": {
  1646. "items": {
  1647. "type": "string"
  1648. },
  1649. "type": "array",
  1650. "title": "Keys"
  1651. },
  1652. "type": {
  1653. "type": "string",
  1654. "const": "keypress",
  1655. "title": "Type"
  1656. }
  1657. },
  1658. "additionalProperties": true,
  1659. "type": "object",
  1660. "required": [
  1661. "keys",
  1662. "type"
  1663. ],
  1664. "title": "ActionKeypress",
  1665. "description": "A collection of keypresses the model would like to perform."
  1666. },
  1667. "ActionMove": {
  1668. "properties": {
  1669. "type": {
  1670. "type": "string",
  1671. "const": "move",
  1672. "title": "Type"
  1673. },
  1674. "x": {
  1675. "type": "integer",
  1676. "title": "X"
  1677. },
  1678. "y": {
  1679. "type": "integer",
  1680. "title": "Y"
  1681. }
  1682. },
  1683. "additionalProperties": true,
  1684. "type": "object",
  1685. "required": [
  1686. "type",
  1687. "x",
  1688. "y"
  1689. ],
  1690. "title": "ActionMove",
  1691. "description": "A mouse move action."
  1692. },
  1693. "ActionOpenPage": {
  1694. "properties": {
  1695. "type": {
  1696. "type": "string",
  1697. "const": "open_page",
  1698. "title": "Type"
  1699. },
  1700. "url": {
  1701. "type": "string",
  1702. "title": "Url"
  1703. }
  1704. },
  1705. "additionalProperties": true,
  1706. "type": "object",
  1707. "required": [
  1708. "type",
  1709. "url"
  1710. ],
  1711. "title": "ActionOpenPage",
  1712. "description": "Action type \"open_page\" - Opens a specific URL from search results."
  1713. },
  1714. "ActionScreenshot": {
  1715. "properties": {
  1716. "type": {
  1717. "type": "string",
  1718. "const": "screenshot",
  1719. "title": "Type"
  1720. }
  1721. },
  1722. "additionalProperties": true,
  1723. "type": "object",
  1724. "required": [
  1725. "type"
  1726. ],
  1727. "title": "ActionScreenshot",
  1728. "description": "A screenshot action."
  1729. },
  1730. "ActionScroll": {
  1731. "properties": {
  1732. "scroll_x": {
  1733. "type": "integer",
  1734. "title": "Scroll X"
  1735. },
  1736. "scroll_y": {
  1737. "type": "integer",
  1738. "title": "Scroll Y"
  1739. },
  1740. "type": {
  1741. "type": "string",
  1742. "const": "scroll",
  1743. "title": "Type"
  1744. },
  1745. "x": {
  1746. "type": "integer",
  1747. "title": "X"
  1748. },
  1749. "y": {
  1750. "type": "integer",
  1751. "title": "Y"
  1752. }
  1753. },
  1754. "additionalProperties": true,
  1755. "type": "object",
  1756. "required": [
  1757. "scroll_x",
  1758. "scroll_y",
  1759. "type",
  1760. "x",
  1761. "y"
  1762. ],
  1763. "title": "ActionScroll",
  1764. "description": "A scroll action."
  1765. },
  1766. "ActionSearch": {
  1767. "properties": {
  1768. "query": {
  1769. "type": "string",
  1770. "title": "Query"
  1771. },
  1772. "type": {
  1773. "type": "string",
  1774. "const": "search",
  1775. "title": "Type"
  1776. },
  1777. "queries": {
  1778. "anyOf": [
  1779. {
  1780. "items": {
  1781. "type": "string"
  1782. },
  1783. "type": "array"
  1784. },
  1785. {
  1786. "type": "null"
  1787. }
  1788. ],
  1789. "title": "Queries"
  1790. },
  1791. "sources": {
  1792. "anyOf": [
  1793. {
  1794. "items": {
  1795. "$ref": "#/components/schemas/ActionSearchSource"
  1796. },
  1797. "type": "array"
  1798. },
  1799. {
  1800. "type": "null"
  1801. }
  1802. ],
  1803. "title": "Sources"
  1804. }
  1805. },
  1806. "additionalProperties": true,
  1807. "type": "object",
  1808. "required": [
  1809. "query",
  1810. "type"
  1811. ],
  1812. "title": "ActionSearch",
  1813. "description": "Action type \"search\" - Performs a web search query."
  1814. },
  1815. "ActionSearchSource": {
  1816. "properties": {
  1817. "type": {
  1818. "type": "string",
  1819. "const": "url",
  1820. "title": "Type"
  1821. },
  1822. "url": {
  1823. "type": "string",
  1824. "title": "Url"
  1825. }
  1826. },
  1827. "additionalProperties": true,
  1828. "type": "object",
  1829. "required": [
  1830. "type",
  1831. "url"
  1832. ],
  1833. "title": "ActionSearchSource",
  1834. "description": "A source used in the search."
  1835. },
  1836. "ActionType": {
  1837. "properties": {
  1838. "text": {
  1839. "type": "string",
  1840. "title": "Text"
  1841. },
  1842. "type": {
  1843. "type": "string",
  1844. "const": "type",
  1845. "title": "Type"
  1846. }
  1847. },
  1848. "additionalProperties": true,
  1849. "type": "object",
  1850. "required": [
  1851. "text",
  1852. "type"
  1853. ],
  1854. "title": "ActionType",
  1855. "description": "An action to type in text."
  1856. },
  1857. "ActionWait": {
  1858. "properties": {
  1859. "type": {
  1860. "type": "string",
  1861. "const": "wait",
  1862. "title": "Type"
  1863. }
  1864. },
  1865. "additionalProperties": true,
  1866. "type": "object",
  1867. "required": [
  1868. "type"
  1869. ],
  1870. "title": "ActionWait",
  1871. "description": "A wait action."
  1872. },
  1873. "AnnotationContainerFileCitation": {
  1874. "properties": {
  1875. "container_id": {
  1876. "type": "string",
  1877. "title": "Container Id"
  1878. },
  1879. "end_index": {
  1880. "type": "integer",
  1881. "title": "End Index"
  1882. },
  1883. "file_id": {
  1884. "type": "string",
  1885. "title": "File Id"
  1886. },
  1887. "filename": {
  1888. "type": "string",
  1889. "title": "Filename"
  1890. },
  1891. "start_index": {
  1892. "type": "integer",
  1893. "title": "Start Index"
  1894. },
  1895. "type": {
  1896. "type": "string",
  1897. "const": "container_file_citation",
  1898. "title": "Type"
  1899. }
  1900. },
  1901. "additionalProperties": true,
  1902. "type": "object",
  1903. "required": [
  1904. "container_id",
  1905. "end_index",
  1906. "file_id",
  1907. "filename",
  1908. "start_index",
  1909. "type"
  1910. ],
  1911. "title": "AnnotationContainerFileCitation",
  1912. "description": "A citation for a container file used to generate a model response."
  1913. },
  1914. "AnnotationFileCitation": {
  1915. "properties": {
  1916. "file_id": {
  1917. "type": "string",
  1918. "title": "File Id"
  1919. },
  1920. "filename": {
  1921. "type": "string",
  1922. "title": "Filename"
  1923. },
  1924. "index": {
  1925. "type": "integer",
  1926. "title": "Index"
  1927. },
  1928. "type": {
  1929. "type": "string",
  1930. "const": "file_citation",
  1931. "title": "Type"
  1932. }
  1933. },
  1934. "additionalProperties": true,
  1935. "type": "object",
  1936. "required": [
  1937. "file_id",
  1938. "filename",
  1939. "index",
  1940. "type"
  1941. ],
  1942. "title": "AnnotationFileCitation",
  1943. "description": "A citation to a file."
  1944. },
  1945. "AnnotationFilePath": {
  1946. "properties": {
  1947. "file_id": {
  1948. "type": "string",
  1949. "title": "File Id"
  1950. },
  1951. "index": {
  1952. "type": "integer",
  1953. "title": "Index"
  1954. },
  1955. "type": {
  1956. "type": "string",
  1957. "const": "file_path",
  1958. "title": "Type"
  1959. }
  1960. },
  1961. "additionalProperties": true,
  1962. "type": "object",
  1963. "required": [
  1964. "file_id",
  1965. "index",
  1966. "type"
  1967. ],
  1968. "title": "AnnotationFilePath",
  1969. "description": "A path to a file."
  1970. },
  1971. "AnnotationURLCitation": {
  1972. "properties": {
  1973. "end_index": {
  1974. "type": "integer",
  1975. "title": "End Index"
  1976. },
  1977. "start_index": {
  1978. "type": "integer",
  1979. "title": "Start Index"
  1980. },
  1981. "title": {
  1982. "type": "string",
  1983. "title": "Title"
  1984. },
  1985. "type": {
  1986. "type": "string",
  1987. "const": "url_citation",
  1988. "title": "Type"
  1989. },
  1990. "url": {
  1991. "type": "string",
  1992. "title": "Url"
  1993. }
  1994. },
  1995. "additionalProperties": true,
  1996. "type": "object",
  1997. "required": [
  1998. "end_index",
  1999. "start_index",
  2000. "title",
  2001. "type",
  2002. "url"
  2003. ],
  2004. "title": "AnnotationURLCitation",
  2005. "description": "A citation for a web resource used to generate a model response."
  2006. },
  2007. "AnthropicContentBlock": {
  2008. "properties": {
  2009. "type": {
  2010. "type": "string",
  2011. "enum": [
  2012. "text",
  2013. "image",
  2014. "tool_use",
  2015. "tool_result"
  2016. ],
  2017. "title": "Type"
  2018. },
  2019. "text": {
  2020. "anyOf": [
  2021. {
  2022. "type": "string"
  2023. },
  2024. {
  2025. "type": "null"
  2026. }
  2027. ],
  2028. "title": "Text"
  2029. },
  2030. "source": {
  2031. "anyOf": [
  2032. {
  2033. "additionalProperties": true,
  2034. "type": "object"
  2035. },
  2036. {
  2037. "type": "null"
  2038. }
  2039. ],
  2040. "title": "Source"
  2041. },
  2042. "id": {
  2043. "anyOf": [
  2044. {
  2045. "type": "string"
  2046. },
  2047. {
  2048. "type": "null"
  2049. }
  2050. ],
  2051. "title": "Id"
  2052. },
  2053. "name": {
  2054. "anyOf": [
  2055. {
  2056. "type": "string"
  2057. },
  2058. {
  2059. "type": "null"
  2060. }
  2061. ],
  2062. "title": "Name"
  2063. },
  2064. "input": {
  2065. "anyOf": [
  2066. {
  2067. "additionalProperties": true,
  2068. "type": "object"
  2069. },
  2070. {
  2071. "type": "null"
  2072. }
  2073. ],
  2074. "title": "Input"
  2075. },
  2076. "content": {
  2077. "anyOf": [
  2078. {
  2079. "type": "string"
  2080. },
  2081. {
  2082. "items": {
  2083. "additionalProperties": true,
  2084. "type": "object"
  2085. },
  2086. "type": "array"
  2087. },
  2088. {
  2089. "type": "null"
  2090. }
  2091. ],
  2092. "title": "Content"
  2093. },
  2094. "is_error": {
  2095. "anyOf": [
  2096. {
  2097. "type": "boolean"
  2098. },
  2099. {
  2100. "type": "null"
  2101. }
  2102. ],
  2103. "title": "Is Error"
  2104. }
  2105. },
  2106. "type": "object",
  2107. "required": [
  2108. "type"
  2109. ],
  2110. "title": "AnthropicContentBlock",
  2111. "description": "Content block in message"
  2112. },
  2113. "AnthropicError": {
  2114. "properties": {
  2115. "type": {
  2116. "type": "string",
  2117. "title": "Type"
  2118. },
  2119. "message": {
  2120. "type": "string",
  2121. "title": "Message"
  2122. }
  2123. },
  2124. "type": "object",
  2125. "required": [
  2126. "type",
  2127. "message"
  2128. ],
  2129. "title": "AnthropicError",
  2130. "description": "Error structure for Anthropic API"
  2131. },
  2132. "AnthropicErrorResponse": {
  2133. "properties": {
  2134. "type": {
  2135. "type": "string",
  2136. "const": "error",
  2137. "title": "Type",
  2138. "default": "error"
  2139. },
  2140. "error": {
  2141. "$ref": "#/components/schemas/AnthropicError"
  2142. }
  2143. },
  2144. "type": "object",
  2145. "required": [
  2146. "error"
  2147. ],
  2148. "title": "AnthropicErrorResponse",
  2149. "description": "Error response structure for Anthropic API"
  2150. },
  2151. "AnthropicMessage": {
  2152. "properties": {
  2153. "role": {
  2154. "type": "string",
  2155. "enum": [
  2156. "user",
  2157. "assistant"
  2158. ],
  2159. "title": "Role"
  2160. },
  2161. "content": {
  2162. "anyOf": [
  2163. {
  2164. "type": "string"
  2165. },
  2166. {
  2167. "items": {
  2168. "$ref": "#/components/schemas/AnthropicContentBlock"
  2169. },
  2170. "type": "array"
  2171. }
  2172. ],
  2173. "title": "Content"
  2174. }
  2175. },
  2176. "type": "object",
  2177. "required": [
  2178. "role",
  2179. "content"
  2180. ],
  2181. "title": "AnthropicMessage",
  2182. "description": "Message structure"
  2183. },
  2184. "AnthropicMessagesRequest": {
  2185. "properties": {
  2186. "model": {
  2187. "type": "string",
  2188. "title": "Model"
  2189. },
  2190. "messages": {
  2191. "items": {
  2192. "$ref": "#/components/schemas/AnthropicMessage"
  2193. },
  2194. "type": "array",
  2195. "title": "Messages"
  2196. },
  2197. "max_tokens": {
  2198. "type": "integer",
  2199. "title": "Max Tokens"
  2200. },
  2201. "metadata": {
  2202. "anyOf": [
  2203. {
  2204. "additionalProperties": true,
  2205. "type": "object"
  2206. },
  2207. {
  2208. "type": "null"
  2209. }
  2210. ],
  2211. "title": "Metadata"
  2212. },
  2213. "stop_sequences": {
  2214. "anyOf": [
  2215. {
  2216. "items": {
  2217. "type": "string"
  2218. },
  2219. "type": "array"
  2220. },
  2221. {
  2222. "type": "null"
  2223. }
  2224. ],
  2225. "title": "Stop Sequences"
  2226. },
  2227. "stream": {
  2228. "anyOf": [
  2229. {
  2230. "type": "boolean"
  2231. },
  2232. {
  2233. "type": "null"
  2234. }
  2235. ],
  2236. "title": "Stream",
  2237. "default": false
  2238. },
  2239. "system": {
  2240. "anyOf": [
  2241. {
  2242. "type": "string"
  2243. },
  2244. {
  2245. "items": {
  2246. "$ref": "#/components/schemas/AnthropicContentBlock"
  2247. },
  2248. "type": "array"
  2249. },
  2250. {
  2251. "type": "null"
  2252. }
  2253. ],
  2254. "title": "System"
  2255. },
  2256. "temperature": {
  2257. "anyOf": [
  2258. {
  2259. "type": "number"
  2260. },
  2261. {
  2262. "type": "null"
  2263. }
  2264. ],
  2265. "title": "Temperature"
  2266. },
  2267. "tool_choice": {
  2268. "anyOf": [
  2269. {
  2270. "$ref": "#/components/schemas/AnthropicToolChoice"
  2271. },
  2272. {
  2273. "type": "null"
  2274. }
  2275. ]
  2276. },
  2277. "tools": {
  2278. "anyOf": [
  2279. {
  2280. "items": {
  2281. "$ref": "#/components/schemas/AnthropicTool"
  2282. },
  2283. "type": "array"
  2284. },
  2285. {
  2286. "type": "null"
  2287. }
  2288. ],
  2289. "title": "Tools"
  2290. },
  2291. "top_k": {
  2292. "anyOf": [
  2293. {
  2294. "type": "integer"
  2295. },
  2296. {
  2297. "type": "null"
  2298. }
  2299. ],
  2300. "title": "Top K"
  2301. },
  2302. "top_p": {
  2303. "anyOf": [
  2304. {
  2305. "type": "number"
  2306. },
  2307. {
  2308. "type": "null"
  2309. }
  2310. ],
  2311. "title": "Top P"
  2312. }
  2313. },
  2314. "type": "object",
  2315. "required": [
  2316. "model",
  2317. "messages",
  2318. "max_tokens"
  2319. ],
  2320. "title": "AnthropicMessagesRequest",
  2321. "description": "Anthropic Messages API request"
  2322. },
  2323. "AnthropicTool": {
  2324. "properties": {
  2325. "name": {
  2326. "type": "string",
  2327. "title": "Name"
  2328. },
  2329. "description": {
  2330. "anyOf": [
  2331. {
  2332. "type": "string"
  2333. },
  2334. {
  2335. "type": "null"
  2336. }
  2337. ],
  2338. "title": "Description"
  2339. },
  2340. "input_schema": {
  2341. "additionalProperties": true,
  2342. "type": "object",
  2343. "title": "Input Schema"
  2344. }
  2345. },
  2346. "type": "object",
  2347. "required": [
  2348. "name",
  2349. "input_schema"
  2350. ],
  2351. "title": "AnthropicTool",
  2352. "description": "Tool definition"
  2353. },
  2354. "AnthropicToolChoice": {
  2355. "properties": {
  2356. "type": {
  2357. "type": "string",
  2358. "enum": [
  2359. "auto",
  2360. "any",
  2361. "tool"
  2362. ],
  2363. "title": "Type"
  2364. },
  2365. "name": {
  2366. "anyOf": [
  2367. {
  2368. "type": "string"
  2369. },
  2370. {
  2371. "type": "null"
  2372. }
  2373. ],
  2374. "title": "Name"
  2375. }
  2376. },
  2377. "type": "object",
  2378. "required": [
  2379. "type"
  2380. ],
  2381. "title": "AnthropicToolChoice",
  2382. "description": "Tool Choice definition"
  2383. },
  2384. "ApplyPatchCall": {
  2385. "properties": {
  2386. "call_id": {
  2387. "type": "string",
  2388. "title": "Call Id"
  2389. },
  2390. "operation": {
  2391. "anyOf": [
  2392. {
  2393. "$ref": "#/components/schemas/ApplyPatchCallOperationCreateFile"
  2394. },
  2395. {
  2396. "$ref": "#/components/schemas/ApplyPatchCallOperationDeleteFile"
  2397. },
  2398. {
  2399. "$ref": "#/components/schemas/ApplyPatchCallOperationUpdateFile"
  2400. }
  2401. ],
  2402. "title": "Operation"
  2403. },
  2404. "status": {
  2405. "type": "string",
  2406. "enum": [
  2407. "in_progress",
  2408. "completed"
  2409. ],
  2410. "title": "Status"
  2411. },
  2412. "type": {
  2413. "type": "string",
  2414. "const": "apply_patch_call",
  2415. "title": "Type"
  2416. },
  2417. "id": {
  2418. "anyOf": [
  2419. {
  2420. "type": "string"
  2421. },
  2422. {
  2423. "type": "null"
  2424. }
  2425. ],
  2426. "title": "Id"
  2427. }
  2428. },
  2429. "additionalProperties": true,
  2430. "type": "object",
  2431. "required": [
  2432. "call_id",
  2433. "operation",
  2434. "status",
  2435. "type"
  2436. ],
  2437. "title": "ApplyPatchCall",
  2438. "description": "A tool call representing a request to create, delete, or update files using diff patches."
  2439. },
  2440. "ApplyPatchCallOperationCreateFile": {
  2441. "properties": {
  2442. "diff": {
  2443. "type": "string",
  2444. "title": "Diff"
  2445. },
  2446. "path": {
  2447. "type": "string",
  2448. "title": "Path"
  2449. },
  2450. "type": {
  2451. "type": "string",
  2452. "const": "create_file",
  2453. "title": "Type"
  2454. }
  2455. },
  2456. "additionalProperties": true,
  2457. "type": "object",
  2458. "required": [
  2459. "diff",
  2460. "path",
  2461. "type"
  2462. ],
  2463. "title": "ApplyPatchCallOperationCreateFile",
  2464. "description": "Instruction for creating a new file via the apply_patch tool."
  2465. },
  2466. "ApplyPatchCallOperationDeleteFile": {
  2467. "properties": {
  2468. "path": {
  2469. "type": "string",
  2470. "title": "Path"
  2471. },
  2472. "type": {
  2473. "type": "string",
  2474. "const": "delete_file",
  2475. "title": "Type"
  2476. }
  2477. },
  2478. "additionalProperties": true,
  2479. "type": "object",
  2480. "required": [
  2481. "path",
  2482. "type"
  2483. ],
  2484. "title": "ApplyPatchCallOperationDeleteFile",
  2485. "description": "Instruction for deleting an existing file via the apply_patch tool."
  2486. },
  2487. "ApplyPatchCallOperationUpdateFile": {
  2488. "properties": {
  2489. "diff": {
  2490. "type": "string",
  2491. "title": "Diff"
  2492. },
  2493. "path": {
  2494. "type": "string",
  2495. "title": "Path"
  2496. },
  2497. "type": {
  2498. "type": "string",
  2499. "const": "update_file",
  2500. "title": "Type"
  2501. }
  2502. },
  2503. "additionalProperties": true,
  2504. "type": "object",
  2505. "required": [
  2506. "diff",
  2507. "path",
  2508. "type"
  2509. ],
  2510. "title": "ApplyPatchCallOperationUpdateFile",
  2511. "description": "Instruction for updating an existing file via the apply_patch tool."
  2512. },
  2513. "ApplyPatchCallOutput": {
  2514. "properties": {
  2515. "call_id": {
  2516. "type": "string",
  2517. "title": "Call Id"
  2518. },
  2519. "status": {
  2520. "type": "string",
  2521. "enum": [
  2522. "completed",
  2523. "failed"
  2524. ],
  2525. "title": "Status"
  2526. },
  2527. "type": {
  2528. "type": "string",
  2529. "const": "apply_patch_call_output",
  2530. "title": "Type"
  2531. },
  2532. "id": {
  2533. "anyOf": [
  2534. {
  2535. "type": "string"
  2536. },
  2537. {
  2538. "type": "null"
  2539. }
  2540. ],
  2541. "title": "Id"
  2542. },
  2543. "output": {
  2544. "anyOf": [
  2545. {
  2546. "type": "string"
  2547. },
  2548. {
  2549. "type": "null"
  2550. }
  2551. ],
  2552. "title": "Output"
  2553. }
  2554. },
  2555. "additionalProperties": true,
  2556. "type": "object",
  2557. "required": [
  2558. "call_id",
  2559. "status",
  2560. "type"
  2561. ],
  2562. "title": "ApplyPatchCallOutput",
  2563. "description": "The streamed output emitted by an apply patch tool call."
  2564. },
  2565. "ApplyPatchTool": {
  2566. "properties": {
  2567. "type": {
  2568. "type": "string",
  2569. "const": "apply_patch",
  2570. "title": "Type"
  2571. }
  2572. },
  2573. "additionalProperties": true,
  2574. "type": "object",
  2575. "required": [
  2576. "type"
  2577. ],
  2578. "title": "ApplyPatchTool",
  2579. "description": "Allows the assistant to create, delete, or update files using unified diffs."
  2580. },
  2581. "Audio": {
  2582. "properties": {
  2583. "id": {
  2584. "type": "string",
  2585. "title": "Id"
  2586. }
  2587. },
  2588. "additionalProperties": true,
  2589. "type": "object",
  2590. "required": [
  2591. "id"
  2592. ],
  2593. "title": "Audio",
  2594. "description": "Data about a previous audio response from the model.\n[Learn more](https://platform.openai.com/docs/guides/audio)."
  2595. },
  2596. "AudioURL": {
  2597. "properties": {
  2598. "url": {
  2599. "type": "string",
  2600. "title": "Url"
  2601. }
  2602. },
  2603. "additionalProperties": true,
  2604. "type": "object",
  2605. "required": [
  2606. "url"
  2607. ],
  2608. "title": "AudioURL"
  2609. },
  2610. "Author": {
  2611. "properties": {
  2612. "role": {
  2613. "$ref": "#/components/schemas/Role"
  2614. },
  2615. "name": {
  2616. "anyOf": [
  2617. {
  2618. "type": "string"
  2619. },
  2620. {
  2621. "type": "null"
  2622. }
  2623. ],
  2624. "title": "Name"
  2625. }
  2626. },
  2627. "type": "object",
  2628. "required": [
  2629. "role"
  2630. ],
  2631. "title": "Author"
  2632. },
  2633. "ChatCompletionAssistantMessageParam": {
  2634. "properties": {
  2635. "role": {
  2636. "type": "string",
  2637. "const": "assistant",
  2638. "title": "Role"
  2639. },
  2640. "audio": {
  2641. "anyOf": [
  2642. {
  2643. "$ref": "#/components/schemas/Audio"
  2644. },
  2645. {
  2646. "type": "null"
  2647. }
  2648. ]
  2649. },
  2650. "content": {
  2651. "anyOf": [
  2652. {
  2653. "type": "string"
  2654. },
  2655. {
  2656. "items": {
  2657. "anyOf": [
  2658. {
  2659. "$ref": "#/components/schemas/ChatCompletionContentPartTextParam"
  2660. },
  2661. {
  2662. "$ref": "#/components/schemas/ChatCompletionContentPartRefusalParam"
  2663. }
  2664. ]
  2665. },
  2666. "type": "array"
  2667. },
  2668. {
  2669. "type": "null"
  2670. }
  2671. ],
  2672. "title": "Content"
  2673. },
  2674. "function_call": {
  2675. "anyOf": [
  2676. {
  2677. "$ref": "#/components/schemas/FunctionCall"
  2678. },
  2679. {
  2680. "type": "null"
  2681. }
  2682. ]
  2683. },
  2684. "name": {
  2685. "type": "string",
  2686. "title": "Name"
  2687. },
  2688. "refusal": {
  2689. "anyOf": [
  2690. {
  2691. "type": "string"
  2692. },
  2693. {
  2694. "type": "null"
  2695. }
  2696. ],
  2697. "title": "Refusal"
  2698. },
  2699. "tool_calls": {
  2700. "items": {
  2701. "anyOf": [
  2702. {
  2703. "$ref": "#/components/schemas/ChatCompletionMessageFunctionToolCallParam"
  2704. },
  2705. {
  2706. "$ref": "#/components/schemas/ChatCompletionMessageCustomToolCallParam"
  2707. }
  2708. ]
  2709. },
  2710. "type": "array",
  2711. "title": "Tool Calls"
  2712. }
  2713. },
  2714. "additionalProperties": true,
  2715. "type": "object",
  2716. "required": [
  2717. "role"
  2718. ],
  2719. "title": "ChatCompletionAssistantMessageParam",
  2720. "description": "Messages sent by the model in response to user messages."
  2721. },
  2722. "ChatCompletionContentPartAudioEmbedsParam": {
  2723. "properties": {
  2724. "audio_embeds": {
  2725. "anyOf": [
  2726. {
  2727. "type": "string"
  2728. },
  2729. {
  2730. "additionalProperties": {
  2731. "type": "string"
  2732. },
  2733. "type": "object"
  2734. },
  2735. {
  2736. "type": "null"
  2737. }
  2738. ],
  2739. "title": "Audio Embeds"
  2740. },
  2741. "type": {
  2742. "type": "string",
  2743. "const": "audio_embeds",
  2744. "title": "Type"
  2745. },
  2746. "uuid": {
  2747. "anyOf": [
  2748. {
  2749. "type": "string"
  2750. },
  2751. {
  2752. "type": "null"
  2753. }
  2754. ],
  2755. "title": "Uuid"
  2756. }
  2757. },
  2758. "additionalProperties": true,
  2759. "type": "object",
  2760. "required": [
  2761. "type"
  2762. ],
  2763. "title": "ChatCompletionContentPartAudioEmbedsParam"
  2764. },
  2765. "ChatCompletionContentPartAudioParam": {
  2766. "properties": {
  2767. "audio_url": {
  2768. "$ref": "#/components/schemas/AudioURL"
  2769. },
  2770. "type": {
  2771. "type": "string",
  2772. "const": "audio_url",
  2773. "title": "Type"
  2774. }
  2775. },
  2776. "additionalProperties": true,
  2777. "type": "object",
  2778. "required": [
  2779. "audio_url",
  2780. "type"
  2781. ],
  2782. "title": "ChatCompletionContentPartAudioParam"
  2783. },
  2784. "ChatCompletionContentPartImageEmbedsParam": {
  2785. "properties": {
  2786. "image_embeds": {
  2787. "anyOf": [
  2788. {
  2789. "type": "string"
  2790. },
  2791. {
  2792. "additionalProperties": {
  2793. "type": "string"
  2794. },
  2795. "type": "object"
  2796. },
  2797. {
  2798. "type": "null"
  2799. }
  2800. ],
  2801. "title": "Image Embeds"
  2802. },
  2803. "type": {
  2804. "type": "string",
  2805. "const": "image_embeds",
  2806. "title": "Type"
  2807. },
  2808. "uuid": {
  2809. "anyOf": [
  2810. {
  2811. "type": "string"
  2812. },
  2813. {
  2814. "type": "null"
  2815. }
  2816. ],
  2817. "title": "Uuid"
  2818. }
  2819. },
  2820. "additionalProperties": true,
  2821. "type": "object",
  2822. "required": [
  2823. "type"
  2824. ],
  2825. "title": "ChatCompletionContentPartImageEmbedsParam"
  2826. },
  2827. "ChatCompletionContentPartImageParam": {
  2828. "properties": {
  2829. "image_url": {
  2830. "$ref": "#/components/schemas/ImageURL"
  2831. },
  2832. "type": {
  2833. "type": "string",
  2834. "const": "image_url",
  2835. "title": "Type"
  2836. }
  2837. },
  2838. "additionalProperties": true,
  2839. "type": "object",
  2840. "required": [
  2841. "image_url",
  2842. "type"
  2843. ],
  2844. "title": "ChatCompletionContentPartImageParam",
  2845. "description": "Learn about [image inputs](https://platform.openai.com/docs/guides/vision)."
  2846. },
  2847. "ChatCompletionContentPartInputAudioParam": {
  2848. "properties": {
  2849. "input_audio": {
  2850. "$ref": "#/components/schemas/InputAudio"
  2851. },
  2852. "type": {
  2853. "type": "string",
  2854. "const": "input_audio",
  2855. "title": "Type"
  2856. }
  2857. },
  2858. "additionalProperties": true,
  2859. "type": "object",
  2860. "required": [
  2861. "input_audio",
  2862. "type"
  2863. ],
  2864. "title": "ChatCompletionContentPartInputAudioParam",
  2865. "description": "Learn about [audio inputs](https://platform.openai.com/docs/guides/audio)."
  2866. },
  2867. "ChatCompletionContentPartRefusalParam": {
  2868. "properties": {
  2869. "refusal": {
  2870. "type": "string",
  2871. "title": "Refusal"
  2872. },
  2873. "type": {
  2874. "type": "string",
  2875. "const": "refusal",
  2876. "title": "Type"
  2877. }
  2878. },
  2879. "additionalProperties": true,
  2880. "type": "object",
  2881. "required": [
  2882. "refusal",
  2883. "type"
  2884. ],
  2885. "title": "ChatCompletionContentPartRefusalParam"
  2886. },
  2887. "ChatCompletionContentPartTextParam": {
  2888. "properties": {
  2889. "text": {
  2890. "type": "string",
  2891. "title": "Text"
  2892. },
  2893. "type": {
  2894. "type": "string",
  2895. "const": "text",
  2896. "title": "Type"
  2897. }
  2898. },
  2899. "additionalProperties": true,
  2900. "type": "object",
  2901. "required": [
  2902. "text",
  2903. "type"
  2904. ],
  2905. "title": "ChatCompletionContentPartTextParam",
  2906. "description": "Learn about [text inputs](https://platform.openai.com/docs/guides/text-generation)."
  2907. },
  2908. "ChatCompletionContentPartVideoParam": {
  2909. "properties": {
  2910. "video_url": {
  2911. "$ref": "#/components/schemas/VideoURL"
  2912. },
  2913. "type": {
  2914. "type": "string",
  2915. "const": "video_url",
  2916. "title": "Type"
  2917. }
  2918. },
  2919. "additionalProperties": true,
  2920. "type": "object",
  2921. "required": [
  2922. "video_url",
  2923. "type"
  2924. ],
  2925. "title": "ChatCompletionContentPartVideoParam"
  2926. },
  2927. "ChatCompletionDeveloperMessageParam": {
  2928. "properties": {
  2929. "content": {
  2930. "anyOf": [
  2931. {
  2932. "type": "string"
  2933. },
  2934. {
  2935. "items": {
  2936. "$ref": "#/components/schemas/ChatCompletionContentPartTextParam"
  2937. },
  2938. "type": "array"
  2939. }
  2940. ],
  2941. "title": "Content"
  2942. },
  2943. "role": {
  2944. "type": "string",
  2945. "const": "developer",
  2946. "title": "Role"
  2947. },
  2948. "name": {
  2949. "type": "string",
  2950. "title": "Name"
  2951. }
  2952. },
  2953. "additionalProperties": true,
  2954. "type": "object",
  2955. "required": [
  2956. "content",
  2957. "role"
  2958. ],
  2959. "title": "ChatCompletionDeveloperMessageParam",
  2960. "description": "Developer-provided instructions that the model should follow, regardless of\nmessages sent by the user. With o1 models and newer, `developer` messages\nreplace the previous `system` messages."
  2961. },
  2962. "ChatCompletionFunctionMessageParam": {
  2963. "properties": {
  2964. "content": {
  2965. "anyOf": [
  2966. {
  2967. "type": "string"
  2968. },
  2969. {
  2970. "type": "null"
  2971. }
  2972. ],
  2973. "title": "Content"
  2974. },
  2975. "name": {
  2976. "type": "string",
  2977. "title": "Name"
  2978. },
  2979. "role": {
  2980. "type": "string",
  2981. "const": "function",
  2982. "title": "Role"
  2983. }
  2984. },
  2985. "additionalProperties": true,
  2986. "type": "object",
  2987. "required": [
  2988. "content",
  2989. "name",
  2990. "role"
  2991. ],
  2992. "title": "ChatCompletionFunctionMessageParam"
  2993. },
  2994. "ChatCompletionFunctionToolParam": {
  2995. "properties": {
  2996. "function": {
  2997. "$ref": "#/components/schemas/openai__types__shared_params__function_definition__FunctionDefinition"
  2998. },
  2999. "type": {
  3000. "type": "string",
  3001. "const": "function",
  3002. "title": "Type"
  3003. }
  3004. },
  3005. "additionalProperties": true,
  3006. "type": "object",
  3007. "required": [
  3008. "function",
  3009. "type"
  3010. ],
  3011. "title": "ChatCompletionFunctionToolParam",
  3012. "description": "A function tool that can be used to generate a response."
  3013. },
  3014. "ChatCompletionMessageCustomToolCallParam": {
  3015. "properties": {
  3016. "id": {
  3017. "type": "string",
  3018. "title": "Id"
  3019. },
  3020. "custom": {
  3021. "$ref": "#/components/schemas/Custom"
  3022. },
  3023. "type": {
  3024. "type": "string",
  3025. "const": "custom",
  3026. "title": "Type"
  3027. }
  3028. },
  3029. "additionalProperties": true,
  3030. "type": "object",
  3031. "required": [
  3032. "id",
  3033. "custom",
  3034. "type"
  3035. ],
  3036. "title": "ChatCompletionMessageCustomToolCallParam",
  3037. "description": "A call to a custom tool created by the model."
  3038. },
  3039. "ChatCompletionMessageFunctionToolCallParam": {
  3040. "properties": {
  3041. "id": {
  3042. "type": "string",
  3043. "title": "Id"
  3044. },
  3045. "function": {
  3046. "$ref": "#/components/schemas/Function"
  3047. },
  3048. "type": {
  3049. "type": "string",
  3050. "const": "function",
  3051. "title": "Type"
  3052. }
  3053. },
  3054. "additionalProperties": true,
  3055. "type": "object",
  3056. "required": [
  3057. "id",
  3058. "function",
  3059. "type"
  3060. ],
  3061. "title": "ChatCompletionMessageFunctionToolCallParam",
  3062. "description": "A call to a function tool created by the model."
  3063. },
  3064. "ChatCompletionNamedFunction": {
  3065. "properties": {
  3066. "name": {
  3067. "type": "string",
  3068. "title": "Name"
  3069. }
  3070. },
  3071. "additionalProperties": true,
  3072. "type": "object",
  3073. "required": [
  3074. "name"
  3075. ],
  3076. "title": "ChatCompletionNamedFunction"
  3077. },
  3078. "ChatCompletionNamedToolChoiceParam": {
  3079. "properties": {
  3080. "function": {
  3081. "$ref": "#/components/schemas/ChatCompletionNamedFunction"
  3082. },
  3083. "type": {
  3084. "type": "string",
  3085. "const": "function",
  3086. "title": "Type",
  3087. "default": "function"
  3088. }
  3089. },
  3090. "additionalProperties": true,
  3091. "type": "object",
  3092. "required": [
  3093. "function"
  3094. ],
  3095. "title": "ChatCompletionNamedToolChoiceParam"
  3096. },
  3097. "ChatCompletionRequest": {
  3098. "properties": {
  3099. "messages": {
  3100. "items": {
  3101. "anyOf": [
  3102. {
  3103. "$ref": "#/components/schemas/ChatCompletionDeveloperMessageParam"
  3104. },
  3105. {
  3106. "$ref": "#/components/schemas/ChatCompletionSystemMessageParam"
  3107. },
  3108. {
  3109. "$ref": "#/components/schemas/ChatCompletionUserMessageParam"
  3110. },
  3111. {
  3112. "$ref": "#/components/schemas/ChatCompletionAssistantMessageParam"
  3113. },
  3114. {
  3115. "$ref": "#/components/schemas/ChatCompletionToolMessageParam"
  3116. },
  3117. {
  3118. "$ref": "#/components/schemas/ChatCompletionFunctionMessageParam"
  3119. },
  3120. {
  3121. "$ref": "#/components/schemas/CustomChatCompletionMessageParam"
  3122. },
  3123. {
  3124. "$ref": "#/components/schemas/Message"
  3125. }
  3126. ]
  3127. },
  3128. "type": "array",
  3129. "title": "Messages"
  3130. },
  3131. "model": {
  3132. "anyOf": [
  3133. {
  3134. "type": "string"
  3135. },
  3136. {
  3137. "type": "null"
  3138. }
  3139. ],
  3140. "title": "Model"
  3141. },
  3142. "frequency_penalty": {
  3143. "anyOf": [
  3144. {
  3145. "type": "number"
  3146. },
  3147. {
  3148. "type": "null"
  3149. }
  3150. ],
  3151. "title": "Frequency Penalty",
  3152. "default": 0
  3153. },
  3154. "logit_bias": {
  3155. "anyOf": [
  3156. {
  3157. "additionalProperties": {
  3158. "type": "number"
  3159. },
  3160. "type": "object"
  3161. },
  3162. {
  3163. "type": "null"
  3164. }
  3165. ],
  3166. "title": "Logit Bias"
  3167. },
  3168. "logprobs": {
  3169. "anyOf": [
  3170. {
  3171. "type": "boolean"
  3172. },
  3173. {
  3174. "type": "null"
  3175. }
  3176. ],
  3177. "title": "Logprobs",
  3178. "default": false
  3179. },
  3180. "top_logprobs": {
  3181. "anyOf": [
  3182. {
  3183. "type": "integer"
  3184. },
  3185. {
  3186. "type": "null"
  3187. }
  3188. ],
  3189. "title": "Top Logprobs",
  3190. "default": 0
  3191. },
  3192. "max_tokens": {
  3193. "anyOf": [
  3194. {
  3195. "type": "integer"
  3196. },
  3197. {
  3198. "type": "null"
  3199. }
  3200. ],
  3201. "title": "Max Tokens",
  3202. "deprecated": true
  3203. },
  3204. "max_completion_tokens": {
  3205. "anyOf": [
  3206. {
  3207. "type": "integer"
  3208. },
  3209. {
  3210. "type": "null"
  3211. }
  3212. ],
  3213. "title": "Max Completion Tokens"
  3214. },
  3215. "n": {
  3216. "anyOf": [
  3217. {
  3218. "type": "integer"
  3219. },
  3220. {
  3221. "type": "null"
  3222. }
  3223. ],
  3224. "title": "N",
  3225. "default": 1
  3226. },
  3227. "presence_penalty": {
  3228. "anyOf": [
  3229. {
  3230. "type": "number"
  3231. },
  3232. {
  3233. "type": "null"
  3234. }
  3235. ],
  3236. "title": "Presence Penalty",
  3237. "default": 0
  3238. },
  3239. "response_format": {
  3240. "anyOf": [
  3241. {
  3242. "$ref": "#/components/schemas/ResponseFormat"
  3243. },
  3244. {
  3245. "$ref": "#/components/schemas/StructuralTagResponseFormat"
  3246. },
  3247. {
  3248. "$ref": "#/components/schemas/LegacyStructuralTagResponseFormat"
  3249. },
  3250. {
  3251. "type": "null"
  3252. }
  3253. ],
  3254. "title": "Response Format"
  3255. },
  3256. "seed": {
  3257. "anyOf": [
  3258. {
  3259. "type": "integer",
  3260. "maximum": "9.223372036854776e+18",
  3261. "minimum": -9223372036854776000
  3262. },
  3263. {
  3264. "type": "null"
  3265. }
  3266. ],
  3267. "title": "Seed"
  3268. },
  3269. "stop": {
  3270. "anyOf": [
  3271. {
  3272. "type": "string"
  3273. },
  3274. {
  3275. "items": {
  3276. "type": "string"
  3277. },
  3278. "type": "array"
  3279. },
  3280. {
  3281. "type": "null"
  3282. }
  3283. ],
  3284. "title": "Stop",
  3285. "default": []
  3286. },
  3287. "stream": {
  3288. "anyOf": [
  3289. {
  3290. "type": "boolean"
  3291. },
  3292. {
  3293. "type": "null"
  3294. }
  3295. ],
  3296. "title": "Stream",
  3297. "default": false
  3298. },
  3299. "stream_options": {
  3300. "anyOf": [
  3301. {
  3302. "$ref": "#/components/schemas/StreamOptions"
  3303. },
  3304. {
  3305. "type": "null"
  3306. }
  3307. ]
  3308. },
  3309. "temperature": {
  3310. "anyOf": [
  3311. {
  3312. "type": "number"
  3313. },
  3314. {
  3315. "type": "null"
  3316. }
  3317. ],
  3318. "title": "Temperature"
  3319. },
  3320. "top_p": {
  3321. "anyOf": [
  3322. {
  3323. "type": "number"
  3324. },
  3325. {
  3326. "type": "null"
  3327. }
  3328. ],
  3329. "title": "Top P"
  3330. },
  3331. "tools": {
  3332. "anyOf": [
  3333. {
  3334. "items": {
  3335. "$ref": "#/components/schemas/ChatCompletionToolsParam"
  3336. },
  3337. "type": "array"
  3338. },
  3339. {
  3340. "type": "null"
  3341. }
  3342. ],
  3343. "title": "Tools"
  3344. },
  3345. "tool_choice": {
  3346. "anyOf": [
  3347. {
  3348. "type": "string",
  3349. "const": "none"
  3350. },
  3351. {
  3352. "type": "string",
  3353. "const": "auto"
  3354. },
  3355. {
  3356. "type": "string",
  3357. "const": "required"
  3358. },
  3359. {
  3360. "$ref": "#/components/schemas/ChatCompletionNamedToolChoiceParam"
  3361. },
  3362. {
  3363. "type": "null"
  3364. }
  3365. ],
  3366. "title": "Tool Choice",
  3367. "default": "none"
  3368. },
  3369. "reasoning_effort": {
  3370. "anyOf": [
  3371. {
  3372. "type": "string",
  3373. "enum": [
  3374. "low",
  3375. "medium",
  3376. "high"
  3377. ]
  3378. },
  3379. {
  3380. "type": "null"
  3381. }
  3382. ],
  3383. "title": "Reasoning Effort"
  3384. },
  3385. "include_reasoning": {
  3386. "type": "boolean",
  3387. "title": "Include Reasoning",
  3388. "default": true
  3389. },
  3390. "parallel_tool_calls": {
  3391. "anyOf": [
  3392. {
  3393. "type": "boolean"
  3394. },
  3395. {
  3396. "type": "null"
  3397. }
  3398. ],
  3399. "title": "Parallel Tool Calls",
  3400. "default": true
  3401. },
  3402. "user": {
  3403. "anyOf": [
  3404. {
  3405. "type": "string"
  3406. },
  3407. {
  3408. "type": "null"
  3409. }
  3410. ],
  3411. "title": "User"
  3412. },
  3413. "use_beam_search": {
  3414. "type": "boolean",
  3415. "title": "Use Beam Search",
  3416. "default": false
  3417. },
  3418. "top_k": {
  3419. "anyOf": [
  3420. {
  3421. "type": "integer"
  3422. },
  3423. {
  3424. "type": "null"
  3425. }
  3426. ],
  3427. "title": "Top K"
  3428. },
  3429. "min_p": {
  3430. "anyOf": [
  3431. {
  3432. "type": "number"
  3433. },
  3434. {
  3435. "type": "null"
  3436. }
  3437. ],
  3438. "title": "Min P"
  3439. },
  3440. "repetition_penalty": {
  3441. "anyOf": [
  3442. {
  3443. "type": "number"
  3444. },
  3445. {
  3446. "type": "null"
  3447. }
  3448. ],
  3449. "title": "Repetition Penalty"
  3450. },
  3451. "length_penalty": {
  3452. "type": "number",
  3453. "title": "Length Penalty",
  3454. "default": 1
  3455. },
  3456. "stop_token_ids": {
  3457. "anyOf": [
  3458. {
  3459. "items": {
  3460. "type": "integer"
  3461. },
  3462. "type": "array"
  3463. },
  3464. {
  3465. "type": "null"
  3466. }
  3467. ],
  3468. "title": "Stop Token Ids",
  3469. "default": []
  3470. },
  3471. "include_stop_str_in_output": {
  3472. "type": "boolean",
  3473. "title": "Include Stop Str In Output",
  3474. "default": false
  3475. },
  3476. "ignore_eos": {
  3477. "type": "boolean",
  3478. "title": "Ignore Eos",
  3479. "default": false
  3480. },
  3481. "min_tokens": {
  3482. "type": "integer",
  3483. "title": "Min Tokens",
  3484. "default": 0
  3485. },
  3486. "skip_special_tokens": {
  3487. "type": "boolean",
  3488. "title": "Skip Special Tokens",
  3489. "default": true
  3490. },
  3491. "spaces_between_special_tokens": {
  3492. "type": "boolean",
  3493. "title": "Spaces Between Special Tokens",
  3494. "default": true
  3495. },
  3496. "truncate_prompt_tokens": {
  3497. "anyOf": [
  3498. {
  3499. "type": "integer",
  3500. "maximum": "9.223372036854776e+18",
  3501. "minimum": -1
  3502. },
  3503. {
  3504. "type": "null"
  3505. }
  3506. ],
  3507. "title": "Truncate Prompt Tokens"
  3508. },
  3509. "prompt_logprobs": {
  3510. "anyOf": [
  3511. {
  3512. "type": "integer"
  3513. },
  3514. {
  3515. "type": "null"
  3516. }
  3517. ],
  3518. "title": "Prompt Logprobs"
  3519. },
  3520. "allowed_token_ids": {
  3521. "anyOf": [
  3522. {
  3523. "items": {
  3524. "type": "integer"
  3525. },
  3526. "type": "array"
  3527. },
  3528. {
  3529. "type": "null"
  3530. }
  3531. ],
  3532. "title": "Allowed Token Ids"
  3533. },
  3534. "bad_words": {
  3535. "items": {
  3536. "type": "string"
  3537. },
  3538. "type": "array",
  3539. "title": "Bad Words"
  3540. },
  3541. "echo": {
  3542. "type": "boolean",
  3543. "title": "Echo",
  3544. "description": "If true, the new message will be prepended with the last message if they belong to the same role.",
  3545. "default": false
  3546. },
  3547. "add_generation_prompt": {
  3548. "type": "boolean",
  3549. "title": "Add Generation Prompt",
  3550. "description": "If true, the generation prompt will be added to the chat template. This is a parameter used by chat template in tokenizer config of the model.",
  3551. "default": true
  3552. },
  3553. "continue_final_message": {
  3554. "type": "boolean",
  3555. "title": "Continue Final Message",
  3556. "description": "If this is set, the chat will be formatted so that the final message in the chat is open-ended, without any EOS tokens. The model will continue this message rather than starting a new one. This allows you to \"prefill\" part of the model's response for it. Cannot be used at the same time as `add_generation_prompt`.",
  3557. "default": false
  3558. },
  3559. "add_special_tokens": {
  3560. "type": "boolean",
  3561. "title": "Add Special Tokens",
  3562. "description": "If true, special tokens (e.g. BOS) will be added to the prompt on top of what is added by the chat template. For most models, the chat template takes care of adding the special tokens so this should be set to false (as is the default).",
  3563. "default": false
  3564. },
  3565. "documents": {
  3566. "anyOf": [
  3567. {
  3568. "items": {
  3569. "additionalProperties": {
  3570. "type": "string"
  3571. },
  3572. "type": "object"
  3573. },
  3574. "type": "array"
  3575. },
  3576. {
  3577. "type": "null"
  3578. }
  3579. ],
  3580. "title": "Documents",
  3581. "description": "A list of dicts representing documents that will be accessible to the model if it is performing RAG (retrieval-augmented generation). If the template does not support RAG, this argument will have no effect. We recommend that each document should be a dict containing \"title\" and \"text\" keys."
  3582. },
  3583. "chat_template": {
  3584. "anyOf": [
  3585. {
  3586. "type": "string"
  3587. },
  3588. {
  3589. "type": "null"
  3590. }
  3591. ],
  3592. "title": "Chat Template",
  3593. "description": "A Jinja template to use for this conversion. As of transformers v4.44, default chat template is no longer allowed, so you must provide a chat template if the tokenizer does not define one."
  3594. },
  3595. "chat_template_kwargs": {
  3596. "anyOf": [
  3597. {
  3598. "additionalProperties": true,
  3599. "type": "object"
  3600. },
  3601. {
  3602. "type": "null"
  3603. }
  3604. ],
  3605. "title": "Chat Template Kwargs",
  3606. "description": "Additional keyword args to pass to the template renderer. Will be accessible by the chat template."
  3607. },
  3608. "mm_processor_kwargs": {
  3609. "anyOf": [
  3610. {
  3611. "additionalProperties": true,
  3612. "type": "object"
  3613. },
  3614. {
  3615. "type": "null"
  3616. }
  3617. ],
  3618. "title": "Mm Processor Kwargs",
  3619. "description": "Additional kwargs to pass to the HF processor."
  3620. },
  3621. "structured_outputs": {
  3622. "anyOf": [
  3623. {
  3624. "$ref": "#/components/schemas/StructuredOutputsParams"
  3625. },
  3626. {
  3627. "type": "null"
  3628. }
  3629. ],
  3630. "description": "Additional kwargs for structured outputs"
  3631. },
  3632. "priority": {
  3633. "type": "integer",
  3634. "title": "Priority",
  3635. "description": "The priority of the request (lower means earlier handling; default: 0). Any priority other than 0 will raise an error if the served model does not use priority scheduling.",
  3636. "default": 0
  3637. },
  3638. "request_id": {
  3639. "type": "string",
  3640. "title": "Request Id",
  3641. "description": "The request_id related to this request. If the caller does not set it, a random_uuid will be generated. This id is used through out the inference process and return in response."
  3642. },
  3643. "logits_processors": {
  3644. "anyOf": [
  3645. {
  3646. "items": {
  3647. "anyOf": [
  3648. {
  3649. "type": "string"
  3650. },
  3651. {
  3652. "$ref": "#/components/schemas/LogitsProcessorConstructor"
  3653. }
  3654. ]
  3655. },
  3656. "type": "array"
  3657. },
  3658. {
  3659. "type": "null"
  3660. }
  3661. ],
  3662. "title": "Logits Processors",
  3663. "description": "A list of either qualified names of logits processors, or constructor objects, to apply when sampling. A constructor is a JSON object with a required 'qualname' field specifying the qualified name of the processor class/factory, and optional 'args' and 'kwargs' fields containing positional and keyword arguments. For example: {'qualname': 'my_module.MyLogitsProcessor', 'args': [1, 2], 'kwargs': {'param': 'value'}}."
  3664. },
  3665. "return_tokens_as_token_ids": {
  3666. "anyOf": [
  3667. {
  3668. "type": "boolean"
  3669. },
  3670. {
  3671. "type": "null"
  3672. }
  3673. ],
  3674. "title": "Return Tokens As Token Ids",
  3675. "description": "If specified with 'logprobs', tokens are represented as strings of the form 'token_id:{token_id}' so that tokens that are not JSON-encodable can be identified."
  3676. },
  3677. "return_token_ids": {
  3678. "anyOf": [
  3679. {
  3680. "type": "boolean"
  3681. },
  3682. {
  3683. "type": "null"
  3684. }
  3685. ],
  3686. "title": "Return Token Ids",
  3687. "description": "If specified, the result will include token IDs alongside the generated text. In streaming mode, prompt_token_ids is included only in the first chunk, and token_ids contains the delta tokens for each chunk. This is useful for debugging or when you need to map generated text back to input tokens."
  3688. },
  3689. "cache_salt": {
  3690. "anyOf": [
  3691. {
  3692. "type": "string"
  3693. },
  3694. {
  3695. "type": "null"
  3696. }
  3697. ],
  3698. "title": "Cache Salt",
  3699. "description": "If specified, the prefix cache will be salted with the provided string to prevent an attacker to guess prompts in multi-user environments. The salt should be random, protected from access by 3rd parties, and long enough to be unpredictable (e.g., 43 characters base64-encoded, corresponding to 256 bit)."
  3700. },
  3701. "kv_transfer_params": {
  3702. "anyOf": [
  3703. {
  3704. "additionalProperties": true,
  3705. "type": "object"
  3706. },
  3707. {
  3708. "type": "null"
  3709. }
  3710. ],
  3711. "title": "Kv Transfer Params",
  3712. "description": "KVTransfer parameters used for disaggregated serving."
  3713. },
  3714. "vllm_xargs": {
  3715. "anyOf": [
  3716. {
  3717. "additionalProperties": {
  3718. "anyOf": [
  3719. {
  3720. "type": "string"
  3721. },
  3722. {
  3723. "type": "integer"
  3724. },
  3725. {
  3726. "type": "number"
  3727. },
  3728. {
  3729. "items": {
  3730. "anyOf": [
  3731. {
  3732. "type": "string"
  3733. },
  3734. {
  3735. "type": "integer"
  3736. },
  3737. {
  3738. "type": "number"
  3739. }
  3740. ]
  3741. },
  3742. "type": "array"
  3743. }
  3744. ]
  3745. },
  3746. "type": "object"
  3747. },
  3748. {
  3749. "type": "null"
  3750. }
  3751. ],
  3752. "title": "Vllm Xargs",
  3753. "description": "Additional request parameters with (list of) string or numeric values, used by custom extensions."
  3754. }
  3755. },
  3756. "additionalProperties": true,
  3757. "type": "object",
  3758. "required": [
  3759. "messages"
  3760. ],
  3761. "title": "ChatCompletionRequest"
  3762. },
  3763. "ChatCompletionSystemMessageParam": {
  3764. "properties": {
  3765. "content": {
  3766. "anyOf": [
  3767. {
  3768. "type": "string"
  3769. },
  3770. {
  3771. "items": {
  3772. "$ref": "#/components/schemas/ChatCompletionContentPartTextParam"
  3773. },
  3774. "type": "array"
  3775. }
  3776. ],
  3777. "title": "Content"
  3778. },
  3779. "role": {
  3780. "type": "string",
  3781. "const": "system",
  3782. "title": "Role"
  3783. },
  3784. "name": {
  3785. "type": "string",
  3786. "title": "Name"
  3787. }
  3788. },
  3789. "additionalProperties": true,
  3790. "type": "object",
  3791. "required": [
  3792. "content",
  3793. "role"
  3794. ],
  3795. "title": "ChatCompletionSystemMessageParam",
  3796. "description": "Developer-provided instructions that the model should follow, regardless of\nmessages sent by the user. With o1 models and newer, use `developer` messages\nfor this purpose instead."
  3797. },
  3798. "ChatCompletionToolMessageParam": {
  3799. "properties": {
  3800. "content": {
  3801. "anyOf": [
  3802. {
  3803. "type": "string"
  3804. },
  3805. {
  3806. "items": {
  3807. "$ref": "#/components/schemas/ChatCompletionContentPartTextParam"
  3808. },
  3809. "type": "array"
  3810. }
  3811. ],
  3812. "title": "Content"
  3813. },
  3814. "role": {
  3815. "type": "string",
  3816. "const": "tool",
  3817. "title": "Role"
  3818. },
  3819. "tool_call_id": {
  3820. "type": "string",
  3821. "title": "Tool Call Id"
  3822. }
  3823. },
  3824. "additionalProperties": true,
  3825. "type": "object",
  3826. "required": [
  3827. "content",
  3828. "role",
  3829. "tool_call_id"
  3830. ],
  3831. "title": "ChatCompletionToolMessageParam"
  3832. },
  3833. "ChatCompletionToolsParam": {
  3834. "properties": {
  3835. "type": {
  3836. "type": "string",
  3837. "const": "function",
  3838. "title": "Type",
  3839. "default": "function"
  3840. },
  3841. "function": {
  3842. "$ref": "#/components/schemas/FunctionDefinition"
  3843. }
  3844. },
  3845. "additionalProperties": true,
  3846. "type": "object",
  3847. "required": [
  3848. "function"
  3849. ],
  3850. "title": "ChatCompletionToolsParam"
  3851. },
  3852. "ChatCompletionUserMessageParam": {
  3853. "properties": {
  3854. "content": {
  3855. "anyOf": [
  3856. {
  3857. "type": "string"
  3858. },
  3859. {
  3860. "items": {
  3861. "anyOf": [
  3862. {
  3863. "$ref": "#/components/schemas/ChatCompletionContentPartTextParam"
  3864. },
  3865. {
  3866. "$ref": "#/components/schemas/ChatCompletionContentPartImageParam"
  3867. },
  3868. {
  3869. "$ref": "#/components/schemas/ChatCompletionContentPartInputAudioParam"
  3870. },
  3871. {
  3872. "$ref": "#/components/schemas/File"
  3873. }
  3874. ]
  3875. },
  3876. "type": "array"
  3877. }
  3878. ],
  3879. "title": "Content"
  3880. },
  3881. "role": {
  3882. "type": "string",
  3883. "const": "user",
  3884. "title": "Role"
  3885. },
  3886. "name": {
  3887. "type": "string",
  3888. "title": "Name"
  3889. }
  3890. },
  3891. "additionalProperties": true,
  3892. "type": "object",
  3893. "required": [
  3894. "content",
  3895. "role"
  3896. ],
  3897. "title": "ChatCompletionUserMessageParam",
  3898. "description": "Messages sent by an end user, containing prompts or additional context\ninformation."
  3899. },
  3900. "ClassificationChatRequest": {
  3901. "properties": {
  3902. "model": {
  3903. "anyOf": [
  3904. {
  3905. "type": "string"
  3906. },
  3907. {
  3908. "type": "null"
  3909. }
  3910. ],
  3911. "title": "Model"
  3912. },
  3913. "messages": {
  3914. "items": {
  3915. "anyOf": [
  3916. {
  3917. "$ref": "#/components/schemas/ChatCompletionDeveloperMessageParam"
  3918. },
  3919. {
  3920. "$ref": "#/components/schemas/ChatCompletionSystemMessageParam"
  3921. },
  3922. {
  3923. "$ref": "#/components/schemas/ChatCompletionUserMessageParam"
  3924. },
  3925. {
  3926. "$ref": "#/components/schemas/ChatCompletionAssistantMessageParam"
  3927. },
  3928. {
  3929. "$ref": "#/components/schemas/ChatCompletionToolMessageParam"
  3930. },
  3931. {
  3932. "$ref": "#/components/schemas/ChatCompletionFunctionMessageParam"
  3933. },
  3934. {
  3935. "$ref": "#/components/schemas/CustomChatCompletionMessageParam"
  3936. },
  3937. {
  3938. "$ref": "#/components/schemas/Message"
  3939. }
  3940. ]
  3941. },
  3942. "type": "array",
  3943. "title": "Messages"
  3944. },
  3945. "truncate_prompt_tokens": {
  3946. "anyOf": [
  3947. {
  3948. "type": "integer",
  3949. "minimum": -1
  3950. },
  3951. {
  3952. "type": "null"
  3953. }
  3954. ],
  3955. "title": "Truncate Prompt Tokens"
  3956. },
  3957. "user": {
  3958. "anyOf": [
  3959. {
  3960. "type": "string"
  3961. },
  3962. {
  3963. "type": "null"
  3964. }
  3965. ],
  3966. "title": "User"
  3967. },
  3968. "add_generation_prompt": {
  3969. "type": "boolean",
  3970. "title": "Add Generation Prompt",
  3971. "description": "If true, the generation prompt will be added to the chat template. This is a parameter used by chat template in tokenizer config of the model.",
  3972. "default": false
  3973. },
  3974. "add_special_tokens": {
  3975. "type": "boolean",
  3976. "title": "Add Special Tokens",
  3977. "description": "If true, special tokens (e.g. BOS) will be added to the prompt on top of what is added by the chat template. For most models, the chat template takes care of adding the special tokens so this should be set to false (as is the default).",
  3978. "default": false
  3979. },
  3980. "chat_template": {
  3981. "anyOf": [
  3982. {
  3983. "type": "string"
  3984. },
  3985. {
  3986. "type": "null"
  3987. }
  3988. ],
  3989. "title": "Chat Template",
  3990. "description": "A Jinja template to use for this conversion. As of transformers v4.44, default chat template is no longer allowed, so you must provide a chat template if the tokenizer does not define one."
  3991. },
  3992. "chat_template_kwargs": {
  3993. "anyOf": [
  3994. {
  3995. "additionalProperties": true,
  3996. "type": "object"
  3997. },
  3998. {
  3999. "type": "null"
  4000. }
  4001. ],
  4002. "title": "Chat Template Kwargs",
  4003. "description": "Additional keyword args to pass to the template renderer. Will be accessible by the chat template."
  4004. },
  4005. "mm_processor_kwargs": {
  4006. "anyOf": [
  4007. {
  4008. "additionalProperties": true,
  4009. "type": "object"
  4010. },
  4011. {
  4012. "type": "null"
  4013. }
  4014. ],
  4015. "title": "Mm Processor Kwargs",
  4016. "description": "Additional kwargs to pass to the HF processor."
  4017. },
  4018. "priority": {
  4019. "type": "integer",
  4020. "title": "Priority",
  4021. "description": "The priority of the request (lower means earlier handling; default: 0). Any priority other than 0 will raise an error if the served model does not use priority scheduling.",
  4022. "default": 0
  4023. },
  4024. "request_id": {
  4025. "type": "string",
  4026. "title": "Request Id",
  4027. "description": "The request_id related to this request. If the caller does not set it, a random_uuid will be generated. This id is used through out the inference process and return in response."
  4028. },
  4029. "softmax": {
  4030. "anyOf": [
  4031. {
  4032. "type": "boolean"
  4033. },
  4034. {
  4035. "type": "null"
  4036. }
  4037. ],
  4038. "title": "Softmax",
  4039. "description": "softmax will be deprecated, please use use_activation instead."
  4040. },
  4041. "activation": {
  4042. "anyOf": [
  4043. {
  4044. "type": "boolean"
  4045. },
  4046. {
  4047. "type": "null"
  4048. }
  4049. ],
  4050. "title": "Activation",
  4051. "description": "activation will be deprecated, please use use_activation instead."
  4052. },
  4053. "use_activation": {
  4054. "anyOf": [
  4055. {
  4056. "type": "boolean"
  4057. },
  4058. {
  4059. "type": "null"
  4060. }
  4061. ],
  4062. "title": "Use Activation",
  4063. "description": "Whether to use activation for classification outputs. Default is True."
  4064. }
  4065. },
  4066. "additionalProperties": true,
  4067. "type": "object",
  4068. "required": [
  4069. "messages"
  4070. ],
  4071. "title": "ClassificationChatRequest"
  4072. },
  4073. "ClassificationCompletionRequest": {
  4074. "properties": {
  4075. "model": {
  4076. "anyOf": [
  4077. {
  4078. "type": "string"
  4079. },
  4080. {
  4081. "type": "null"
  4082. }
  4083. ],
  4084. "title": "Model"
  4085. },
  4086. "input": {
  4087. "anyOf": [
  4088. {
  4089. "items": {
  4090. "type": "string"
  4091. },
  4092. "type": "array"
  4093. },
  4094. {
  4095. "type": "string"
  4096. }
  4097. ],
  4098. "title": "Input"
  4099. },
  4100. "truncate_prompt_tokens": {
  4101. "anyOf": [
  4102. {
  4103. "type": "integer",
  4104. "minimum": -1
  4105. },
  4106. {
  4107. "type": "null"
  4108. }
  4109. ],
  4110. "title": "Truncate Prompt Tokens"
  4111. },
  4112. "user": {
  4113. "anyOf": [
  4114. {
  4115. "type": "string"
  4116. },
  4117. {
  4118. "type": "null"
  4119. }
  4120. ],
  4121. "title": "User"
  4122. },
  4123. "priority": {
  4124. "type": "integer",
  4125. "title": "Priority",
  4126. "description": "The priority of the request (lower means earlier handling; default: 0). Any priority other than 0 will raise an error if the served model does not use priority scheduling.",
  4127. "default": 0
  4128. },
  4129. "add_special_tokens": {
  4130. "type": "boolean",
  4131. "title": "Add Special Tokens",
  4132. "description": "If true (the default), special tokens (e.g. BOS) will be added to the prompt.",
  4133. "default": true
  4134. },
  4135. "request_id": {
  4136. "type": "string",
  4137. "title": "Request Id",
  4138. "description": "The request_id related to this request. If the caller does not set it, a random_uuid will be generated. This id is used through out the inference process and return in response."
  4139. },
  4140. "softmax": {
  4141. "anyOf": [
  4142. {
  4143. "type": "boolean"
  4144. },
  4145. {
  4146. "type": "null"
  4147. }
  4148. ],
  4149. "title": "Softmax",
  4150. "description": "softmax will be deprecated, please use use_activation instead."
  4151. },
  4152. "activation": {
  4153. "anyOf": [
  4154. {
  4155. "type": "boolean"
  4156. },
  4157. {
  4158. "type": "null"
  4159. }
  4160. ],
  4161. "title": "Activation",
  4162. "description": "activation will be deprecated, please use use_activation instead."
  4163. },
  4164. "use_activation": {
  4165. "anyOf": [
  4166. {
  4167. "type": "boolean"
  4168. },
  4169. {
  4170. "type": "null"
  4171. }
  4172. ],
  4173. "title": "Use Activation",
  4174. "description": "Whether to use activation for classification outputs. Default is True."
  4175. }
  4176. },
  4177. "additionalProperties": true,
  4178. "type": "object",
  4179. "required": [
  4180. "input"
  4181. ],
  4182. "title": "ClassificationCompletionRequest"
  4183. },
  4184. "CodeInterpreter": {
  4185. "properties": {
  4186. "container": {
  4187. "anyOf": [
  4188. {
  4189. "type": "string"
  4190. },
  4191. {
  4192. "$ref": "#/components/schemas/CodeInterpreterContainerCodeInterpreterToolAuto"
  4193. }
  4194. ],
  4195. "title": "Container"
  4196. },
  4197. "type": {
  4198. "type": "string",
  4199. "const": "code_interpreter",
  4200. "title": "Type"
  4201. }
  4202. },
  4203. "additionalProperties": true,
  4204. "type": "object",
  4205. "required": [
  4206. "container",
  4207. "type"
  4208. ],
  4209. "title": "CodeInterpreter",
  4210. "description": "A tool that runs Python code to help generate a response to a prompt."
  4211. },
  4212. "CodeInterpreterContainerCodeInterpreterToolAuto": {
  4213. "properties": {
  4214. "type": {
  4215. "type": "string",
  4216. "const": "auto",
  4217. "title": "Type"
  4218. },
  4219. "file_ids": {
  4220. "anyOf": [
  4221. {
  4222. "items": {
  4223. "type": "string"
  4224. },
  4225. "type": "array"
  4226. },
  4227. {
  4228. "type": "null"
  4229. }
  4230. ],
  4231. "title": "File Ids"
  4232. },
  4233. "memory_limit": {
  4234. "anyOf": [
  4235. {
  4236. "type": "string",
  4237. "enum": [
  4238. "1g",
  4239. "4g",
  4240. "16g",
  4241. "64g"
  4242. ]
  4243. },
  4244. {
  4245. "type": "null"
  4246. }
  4247. ],
  4248. "title": "Memory Limit"
  4249. }
  4250. },
  4251. "additionalProperties": true,
  4252. "type": "object",
  4253. "required": [
  4254. "type"
  4255. ],
  4256. "title": "CodeInterpreterContainerCodeInterpreterToolAuto",
  4257. "description": "Configuration for a code interpreter container.\n\nOptionally specify the IDs of the files to run the code on."
  4258. },
  4259. "ComparisonFilter": {
  4260. "properties": {
  4261. "key": {
  4262. "type": "string",
  4263. "title": "Key"
  4264. },
  4265. "type": {
  4266. "type": "string",
  4267. "enum": [
  4268. "eq",
  4269. "ne",
  4270. "gt",
  4271. "gte",
  4272. "lt",
  4273. "lte"
  4274. ],
  4275. "title": "Type"
  4276. },
  4277. "value": {
  4278. "anyOf": [
  4279. {
  4280. "type": "string"
  4281. },
  4282. {
  4283. "type": "number"
  4284. },
  4285. {
  4286. "type": "boolean"
  4287. },
  4288. {
  4289. "items": {
  4290. "anyOf": [
  4291. {
  4292. "type": "string"
  4293. },
  4294. {
  4295. "type": "number"
  4296. }
  4297. ]
  4298. },
  4299. "type": "array"
  4300. }
  4301. ],
  4302. "title": "Value"
  4303. }
  4304. },
  4305. "additionalProperties": true,
  4306. "type": "object",
  4307. "required": [
  4308. "key",
  4309. "type",
  4310. "value"
  4311. ],
  4312. "title": "ComparisonFilter",
  4313. "description": "A filter used to compare a specified attribute key to a given value using a defined comparison operation."
  4314. },
  4315. "CompletionRequest": {
  4316. "properties": {
  4317. "model": {
  4318. "anyOf": [
  4319. {
  4320. "type": "string"
  4321. },
  4322. {
  4323. "type": "null"
  4324. }
  4325. ],
  4326. "title": "Model"
  4327. },
  4328. "prompt": {
  4329. "anyOf": [
  4330. {
  4331. "items": {
  4332. "type": "integer"
  4333. },
  4334. "type": "array"
  4335. },
  4336. {
  4337. "items": {
  4338. "items": {
  4339. "type": "integer"
  4340. },
  4341. "type": "array"
  4342. },
  4343. "type": "array"
  4344. },
  4345. {
  4346. "type": "string"
  4347. },
  4348. {
  4349. "items": {
  4350. "type": "string"
  4351. },
  4352. "type": "array"
  4353. },
  4354. {
  4355. "type": "null"
  4356. }
  4357. ],
  4358. "title": "Prompt"
  4359. },
  4360. "echo": {
  4361. "anyOf": [
  4362. {
  4363. "type": "boolean"
  4364. },
  4365. {
  4366. "type": "null"
  4367. }
  4368. ],
  4369. "title": "Echo",
  4370. "default": false
  4371. },
  4372. "frequency_penalty": {
  4373. "anyOf": [
  4374. {
  4375. "type": "number"
  4376. },
  4377. {
  4378. "type": "null"
  4379. }
  4380. ],
  4381. "title": "Frequency Penalty",
  4382. "default": 0
  4383. },
  4384. "logit_bias": {
  4385. "anyOf": [
  4386. {
  4387. "additionalProperties": {
  4388. "type": "number"
  4389. },
  4390. "type": "object"
  4391. },
  4392. {
  4393. "type": "null"
  4394. }
  4395. ],
  4396. "title": "Logit Bias"
  4397. },
  4398. "logprobs": {
  4399. "anyOf": [
  4400. {
  4401. "type": "integer"
  4402. },
  4403. {
  4404. "type": "null"
  4405. }
  4406. ],
  4407. "title": "Logprobs"
  4408. },
  4409. "max_tokens": {
  4410. "anyOf": [
  4411. {
  4412. "type": "integer"
  4413. },
  4414. {
  4415. "type": "null"
  4416. }
  4417. ],
  4418. "title": "Max Tokens",
  4419. "default": 16
  4420. },
  4421. "n": {
  4422. "type": "integer",
  4423. "title": "N",
  4424. "default": 1
  4425. },
  4426. "presence_penalty": {
  4427. "anyOf": [
  4428. {
  4429. "type": "number"
  4430. },
  4431. {
  4432. "type": "null"
  4433. }
  4434. ],
  4435. "title": "Presence Penalty",
  4436. "default": 0
  4437. },
  4438. "seed": {
  4439. "anyOf": [
  4440. {
  4441. "type": "integer",
  4442. "maximum": "9.223372036854776e+18",
  4443. "minimum": -9223372036854776000
  4444. },
  4445. {
  4446. "type": "null"
  4447. }
  4448. ],
  4449. "title": "Seed"
  4450. },
  4451. "stop": {
  4452. "anyOf": [
  4453. {
  4454. "type": "string"
  4455. },
  4456. {
  4457. "items": {
  4458. "type": "string"
  4459. },
  4460. "type": "array"
  4461. },
  4462. {
  4463. "type": "null"
  4464. }
  4465. ],
  4466. "title": "Stop",
  4467. "default": []
  4468. },
  4469. "stream": {
  4470. "anyOf": [
  4471. {
  4472. "type": "boolean"
  4473. },
  4474. {
  4475. "type": "null"
  4476. }
  4477. ],
  4478. "title": "Stream",
  4479. "default": false
  4480. },
  4481. "stream_options": {
  4482. "anyOf": [
  4483. {
  4484. "$ref": "#/components/schemas/StreamOptions"
  4485. },
  4486. {
  4487. "type": "null"
  4488. }
  4489. ]
  4490. },
  4491. "suffix": {
  4492. "anyOf": [
  4493. {
  4494. "type": "string"
  4495. },
  4496. {
  4497. "type": "null"
  4498. }
  4499. ],
  4500. "title": "Suffix"
  4501. },
  4502. "temperature": {
  4503. "anyOf": [
  4504. {
  4505. "type": "number"
  4506. },
  4507. {
  4508. "type": "null"
  4509. }
  4510. ],
  4511. "title": "Temperature"
  4512. },
  4513. "top_p": {
  4514. "anyOf": [
  4515. {
  4516. "type": "number"
  4517. },
  4518. {
  4519. "type": "null"
  4520. }
  4521. ],
  4522. "title": "Top P"
  4523. },
  4524. "user": {
  4525. "anyOf": [
  4526. {
  4527. "type": "string"
  4528. },
  4529. {
  4530. "type": "null"
  4531. }
  4532. ],
  4533. "title": "User"
  4534. },
  4535. "use_beam_search": {
  4536. "type": "boolean",
  4537. "title": "Use Beam Search",
  4538. "default": false
  4539. },
  4540. "top_k": {
  4541. "anyOf": [
  4542. {
  4543. "type": "integer"
  4544. },
  4545. {
  4546. "type": "null"
  4547. }
  4548. ],
  4549. "title": "Top K"
  4550. },
  4551. "min_p": {
  4552. "anyOf": [
  4553. {
  4554. "type": "number"
  4555. },
  4556. {
  4557. "type": "null"
  4558. }
  4559. ],
  4560. "title": "Min P"
  4561. },
  4562. "repetition_penalty": {
  4563. "anyOf": [
  4564. {
  4565. "type": "number"
  4566. },
  4567. {
  4568. "type": "null"
  4569. }
  4570. ],
  4571. "title": "Repetition Penalty"
  4572. },
  4573. "length_penalty": {
  4574. "type": "number",
  4575. "title": "Length Penalty",
  4576. "default": 1
  4577. },
  4578. "stop_token_ids": {
  4579. "anyOf": [
  4580. {
  4581. "items": {
  4582. "type": "integer"
  4583. },
  4584. "type": "array"
  4585. },
  4586. {
  4587. "type": "null"
  4588. }
  4589. ],
  4590. "title": "Stop Token Ids",
  4591. "default": []
  4592. },
  4593. "include_stop_str_in_output": {
  4594. "type": "boolean",
  4595. "title": "Include Stop Str In Output",
  4596. "default": false
  4597. },
  4598. "ignore_eos": {
  4599. "type": "boolean",
  4600. "title": "Ignore Eos",
  4601. "default": false
  4602. },
  4603. "min_tokens": {
  4604. "type": "integer",
  4605. "title": "Min Tokens",
  4606. "default": 0
  4607. },
  4608. "skip_special_tokens": {
  4609. "type": "boolean",
  4610. "title": "Skip Special Tokens",
  4611. "default": true
  4612. },
  4613. "spaces_between_special_tokens": {
  4614. "type": "boolean",
  4615. "title": "Spaces Between Special Tokens",
  4616. "default": true
  4617. },
  4618. "truncate_prompt_tokens": {
  4619. "anyOf": [
  4620. {
  4621. "type": "integer",
  4622. "maximum": "9.223372036854776e+18",
  4623. "minimum": -1
  4624. },
  4625. {
  4626. "type": "null"
  4627. }
  4628. ],
  4629. "title": "Truncate Prompt Tokens"
  4630. },
  4631. "allowed_token_ids": {
  4632. "anyOf": [
  4633. {
  4634. "items": {
  4635. "type": "integer"
  4636. },
  4637. "type": "array"
  4638. },
  4639. {
  4640. "type": "null"
  4641. }
  4642. ],
  4643. "title": "Allowed Token Ids"
  4644. },
  4645. "prompt_logprobs": {
  4646. "anyOf": [
  4647. {
  4648. "type": "integer"
  4649. },
  4650. {
  4651. "type": "null"
  4652. }
  4653. ],
  4654. "title": "Prompt Logprobs"
  4655. },
  4656. "prompt_embeds": {
  4657. "anyOf": [
  4658. {
  4659. "type": "string",
  4660. "format": "binary"
  4661. },
  4662. {
  4663. "items": {
  4664. "type": "string",
  4665. "format": "binary"
  4666. },
  4667. "type": "array"
  4668. },
  4669. {
  4670. "type": "null"
  4671. }
  4672. ],
  4673. "title": "Prompt Embeds"
  4674. },
  4675. "add_special_tokens": {
  4676. "type": "boolean",
  4677. "title": "Add Special Tokens",
  4678. "description": "If true (the default), special tokens (e.g. BOS) will be added to the prompt.",
  4679. "default": true
  4680. },
  4681. "response_format": {
  4682. "anyOf": [
  4683. {
  4684. "$ref": "#/components/schemas/ResponseFormat"
  4685. },
  4686. {
  4687. "$ref": "#/components/schemas/StructuralTagResponseFormat"
  4688. },
  4689. {
  4690. "$ref": "#/components/schemas/LegacyStructuralTagResponseFormat"
  4691. },
  4692. {
  4693. "type": "null"
  4694. }
  4695. ],
  4696. "title": "Response Format",
  4697. "description": "Similar to chat completion, this parameter specifies the format of output. Only {'type': 'json_object'}, {'type': 'json_schema'}, {'type': 'structural_tag'}, or {'type': 'text' } is supported."
  4698. },
  4699. "structured_outputs": {
  4700. "anyOf": [
  4701. {
  4702. "$ref": "#/components/schemas/StructuredOutputsParams"
  4703. },
  4704. {
  4705. "type": "null"
  4706. }
  4707. ],
  4708. "description": "Additional kwargs for structured outputs"
  4709. },
  4710. "priority": {
  4711. "type": "integer",
  4712. "title": "Priority",
  4713. "description": "The priority of the request (lower means earlier handling; default: 0). Any priority other than 0 will raise an error if the served model does not use priority scheduling.",
  4714. "default": 0
  4715. },
  4716. "request_id": {
  4717. "type": "string",
  4718. "title": "Request Id",
  4719. "description": "The request_id related to this request. If the caller does not set it, a random_uuid will be generated. This id is used through out the inference process and return in response."
  4720. },
  4721. "logits_processors": {
  4722. "anyOf": [
  4723. {
  4724. "items": {
  4725. "anyOf": [
  4726. {
  4727. "type": "string"
  4728. },
  4729. {
  4730. "$ref": "#/components/schemas/LogitsProcessorConstructor"
  4731. }
  4732. ]
  4733. },
  4734. "type": "array"
  4735. },
  4736. {
  4737. "type": "null"
  4738. }
  4739. ],
  4740. "title": "Logits Processors",
  4741. "description": "A list of either qualified names of logits processors, or constructor objects, to apply when sampling. A constructor is a JSON object with a required 'qualname' field specifying the qualified name of the processor class/factory, and optional 'args' and 'kwargs' fields containing positional and keyword arguments. For example: {'qualname': 'my_module.MyLogitsProcessor', 'args': [1, 2], 'kwargs': {'param': 'value'}}."
  4742. },
  4743. "return_tokens_as_token_ids": {
  4744. "anyOf": [
  4745. {
  4746. "type": "boolean"
  4747. },
  4748. {
  4749. "type": "null"
  4750. }
  4751. ],
  4752. "title": "Return Tokens As Token Ids",
  4753. "description": "If specified with 'logprobs', tokens are represented as strings of the form 'token_id:{token_id}' so that tokens that are not JSON-encodable can be identified."
  4754. },
  4755. "return_token_ids": {
  4756. "anyOf": [
  4757. {
  4758. "type": "boolean"
  4759. },
  4760. {
  4761. "type": "null"
  4762. }
  4763. ],
  4764. "title": "Return Token Ids",
  4765. "description": "If specified, the result will include token IDs alongside the generated text. In streaming mode, prompt_token_ids is included only in the first chunk, and token_ids contains the delta tokens for each chunk. This is useful for debugging or when you need to map generated text back to input tokens."
  4766. },
  4767. "cache_salt": {
  4768. "anyOf": [
  4769. {
  4770. "type": "string"
  4771. },
  4772. {
  4773. "type": "null"
  4774. }
  4775. ],
  4776. "title": "Cache Salt",
  4777. "description": "If specified, the prefix cache will be salted with the provided string to prevent an attacker to guess prompts in multi-user environments. The salt should be random, protected from access by 3rd parties, and long enough to be unpredictable (e.g., 43 characters base64-encoded, corresponding to 256 bit)."
  4778. },
  4779. "kv_transfer_params": {
  4780. "anyOf": [
  4781. {
  4782. "additionalProperties": true,
  4783. "type": "object"
  4784. },
  4785. {
  4786. "type": "null"
  4787. }
  4788. ],
  4789. "title": "Kv Transfer Params",
  4790. "description": "KVTransfer parameters used for disaggregated serving."
  4791. },
  4792. "vllm_xargs": {
  4793. "anyOf": [
  4794. {
  4795. "additionalProperties": {
  4796. "anyOf": [
  4797. {
  4798. "type": "string"
  4799. },
  4800. {
  4801. "type": "integer"
  4802. },
  4803. {
  4804. "type": "number"
  4805. }
  4806. ]
  4807. },
  4808. "type": "object"
  4809. },
  4810. {
  4811. "type": "null"
  4812. }
  4813. ],
  4814. "title": "Vllm Xargs",
  4815. "description": "Additional request parameters with string or numeric values, used by custom extensions."
  4816. }
  4817. },
  4818. "additionalProperties": true,
  4819. "type": "object",
  4820. "title": "CompletionRequest"
  4821. },
  4822. "CompoundFilter": {
  4823. "properties": {
  4824. "filters": {
  4825. "items": {
  4826. "anyOf": [
  4827. {
  4828. "$ref": "#/components/schemas/ComparisonFilter"
  4829. },
  4830. {}
  4831. ]
  4832. },
  4833. "type": "array",
  4834. "title": "Filters"
  4835. },
  4836. "type": {
  4837. "type": "string",
  4838. "enum": [
  4839. "and",
  4840. "or"
  4841. ],
  4842. "title": "Type"
  4843. }
  4844. },
  4845. "additionalProperties": true,
  4846. "type": "object",
  4847. "required": [
  4848. "filters",
  4849. "type"
  4850. ],
  4851. "title": "CompoundFilter",
  4852. "description": "Combine multiple filters using `and` or `or`."
  4853. },
  4854. "ComputerCallOutput": {
  4855. "properties": {
  4856. "call_id": {
  4857. "type": "string",
  4858. "title": "Call Id"
  4859. },
  4860. "output": {
  4861. "$ref": "#/components/schemas/ResponseComputerToolCallOutputScreenshotParam"
  4862. },
  4863. "type": {
  4864. "type": "string",
  4865. "const": "computer_call_output",
  4866. "title": "Type"
  4867. },
  4868. "id": {
  4869. "anyOf": [
  4870. {
  4871. "type": "string"
  4872. },
  4873. {
  4874. "type": "null"
  4875. }
  4876. ],
  4877. "title": "Id"
  4878. },
  4879. "acknowledged_safety_checks": {
  4880. "anyOf": [
  4881. {
  4882. "items": {
  4883. "$ref": "#/components/schemas/ComputerCallOutputAcknowledgedSafetyCheck"
  4884. },
  4885. "type": "array"
  4886. },
  4887. {
  4888. "type": "null"
  4889. }
  4890. ],
  4891. "title": "Acknowledged Safety Checks"
  4892. },
  4893. "status": {
  4894. "anyOf": [
  4895. {
  4896. "type": "string",
  4897. "enum": [
  4898. "in_progress",
  4899. "completed",
  4900. "incomplete"
  4901. ]
  4902. },
  4903. {
  4904. "type": "null"
  4905. }
  4906. ],
  4907. "title": "Status"
  4908. }
  4909. },
  4910. "additionalProperties": true,
  4911. "type": "object",
  4912. "required": [
  4913. "call_id",
  4914. "output",
  4915. "type"
  4916. ],
  4917. "title": "ComputerCallOutput",
  4918. "description": "The output of a computer tool call."
  4919. },
  4920. "ComputerCallOutputAcknowledgedSafetyCheck": {
  4921. "properties": {
  4922. "id": {
  4923. "type": "string",
  4924. "title": "Id"
  4925. },
  4926. "code": {
  4927. "anyOf": [
  4928. {
  4929. "type": "string"
  4930. },
  4931. {
  4932. "type": "null"
  4933. }
  4934. ],
  4935. "title": "Code"
  4936. },
  4937. "message": {
  4938. "anyOf": [
  4939. {
  4940. "type": "string"
  4941. },
  4942. {
  4943. "type": "null"
  4944. }
  4945. ],
  4946. "title": "Message"
  4947. }
  4948. },
  4949. "additionalProperties": true,
  4950. "type": "object",
  4951. "required": [
  4952. "id"
  4953. ],
  4954. "title": "ComputerCallOutputAcknowledgedSafetyCheck",
  4955. "description": "A pending safety check for the computer call."
  4956. },
  4957. "ComputerTool": {
  4958. "properties": {
  4959. "display_height": {
  4960. "type": "integer",
  4961. "title": "Display Height"
  4962. },
  4963. "display_width": {
  4964. "type": "integer",
  4965. "title": "Display Width"
  4966. },
  4967. "environment": {
  4968. "type": "string",
  4969. "enum": [
  4970. "windows",
  4971. "mac",
  4972. "linux",
  4973. "ubuntu",
  4974. "browser"
  4975. ],
  4976. "title": "Environment"
  4977. },
  4978. "type": {
  4979. "type": "string",
  4980. "const": "computer_use_preview",
  4981. "title": "Type"
  4982. }
  4983. },
  4984. "additionalProperties": true,
  4985. "type": "object",
  4986. "required": [
  4987. "display_height",
  4988. "display_width",
  4989. "environment",
  4990. "type"
  4991. ],
  4992. "title": "ComputerTool",
  4993. "description": "A tool that controls a virtual computer.\n\nLearn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use)."
  4994. },
  4995. "Content": {
  4996. "properties": {},
  4997. "type": "object",
  4998. "title": "Content"
  4999. },
  5000. "Custom": {
  5001. "properties": {
  5002. "input": {
  5003. "type": "string",
  5004. "title": "Input"
  5005. },
  5006. "name": {
  5007. "type": "string",
  5008. "title": "Name"
  5009. }
  5010. },
  5011. "additionalProperties": true,
  5012. "type": "object",
  5013. "required": [
  5014. "input",
  5015. "name"
  5016. ],
  5017. "title": "Custom",
  5018. "description": "The custom tool that the model called."
  5019. },
  5020. "CustomChatCompletionContentSimpleAudioParam": {
  5021. "properties": {
  5022. "audio_url": {
  5023. "anyOf": [
  5024. {
  5025. "type": "string"
  5026. },
  5027. {
  5028. "type": "null"
  5029. }
  5030. ],
  5031. "title": "Audio Url"
  5032. }
  5033. },
  5034. "additionalProperties": true,
  5035. "type": "object",
  5036. "title": "CustomChatCompletionContentSimpleAudioParam",
  5037. "description": "A simpler version of the param that only accepts a plain audio_url.\n\nExample:\n{\n \"audio_url\": \"https://example.com/audio.mp3\"\n}"
  5038. },
  5039. "CustomChatCompletionContentSimpleImageParam": {
  5040. "properties": {
  5041. "image_url": {
  5042. "anyOf": [
  5043. {
  5044. "type": "string"
  5045. },
  5046. {
  5047. "type": "null"
  5048. }
  5049. ],
  5050. "title": "Image Url"
  5051. },
  5052. "uuid": {
  5053. "anyOf": [
  5054. {
  5055. "type": "string"
  5056. },
  5057. {
  5058. "type": "null"
  5059. }
  5060. ],
  5061. "title": "Uuid"
  5062. }
  5063. },
  5064. "additionalProperties": true,
  5065. "type": "object",
  5066. "title": "CustomChatCompletionContentSimpleImageParam",
  5067. "description": "A simpler version of the param that only accepts a plain image_url.\nThis is supported by OpenAI API, although it is not documented.\n\nExample:\n{\n \"image_url\": \"https://example.com/image.jpg\"\n}"
  5068. },
  5069. "CustomChatCompletionContentSimpleVideoParam": {
  5070. "properties": {
  5071. "video_url": {
  5072. "anyOf": [
  5073. {
  5074. "type": "string"
  5075. },
  5076. {
  5077. "type": "null"
  5078. }
  5079. ],
  5080. "title": "Video Url"
  5081. },
  5082. "uuid": {
  5083. "anyOf": [
  5084. {
  5085. "type": "string"
  5086. },
  5087. {
  5088. "type": "null"
  5089. }
  5090. ],
  5091. "title": "Uuid"
  5092. }
  5093. },
  5094. "additionalProperties": true,
  5095. "type": "object",
  5096. "title": "CustomChatCompletionContentSimpleVideoParam",
  5097. "description": "A simpler version of the param that only accepts a plain audio_url.\n\nExample:\n{\n \"video_url\": \"https://example.com/video.mp4\"\n}"
  5098. },
  5099. "CustomChatCompletionMessageParam": {
  5100. "properties": {
  5101. "role": {
  5102. "type": "string",
  5103. "title": "Role"
  5104. },
  5105. "content": {
  5106. "anyOf": [
  5107. {
  5108. "type": "string"
  5109. },
  5110. {
  5111. "items": {
  5112. "anyOf": [
  5113. {
  5114. "$ref": "#/components/schemas/ChatCompletionContentPartTextParam"
  5115. },
  5116. {
  5117. "$ref": "#/components/schemas/ChatCompletionContentPartImageParam"
  5118. },
  5119. {
  5120. "$ref": "#/components/schemas/ChatCompletionContentPartInputAudioParam"
  5121. },
  5122. {
  5123. "$ref": "#/components/schemas/File"
  5124. },
  5125. {
  5126. "$ref": "#/components/schemas/ChatCompletionContentPartAudioParam"
  5127. },
  5128. {
  5129. "$ref": "#/components/schemas/ChatCompletionContentPartVideoParam"
  5130. },
  5131. {
  5132. "$ref": "#/components/schemas/ChatCompletionContentPartRefusalParam"
  5133. },
  5134. {
  5135. "$ref": "#/components/schemas/CustomChatCompletionContentSimpleImageParam"
  5136. },
  5137. {
  5138. "$ref": "#/components/schemas/ChatCompletionContentPartImageEmbedsParam"
  5139. },
  5140. {
  5141. "$ref": "#/components/schemas/ChatCompletionContentPartAudioEmbedsParam"
  5142. },
  5143. {
  5144. "$ref": "#/components/schemas/CustomChatCompletionContentSimpleAudioParam"
  5145. },
  5146. {
  5147. "$ref": "#/components/schemas/CustomChatCompletionContentSimpleVideoParam"
  5148. },
  5149. {
  5150. "type": "string"
  5151. },
  5152. {
  5153. "$ref": "#/components/schemas/CustomThinkCompletionContentParam"
  5154. }
  5155. ]
  5156. },
  5157. "type": "array"
  5158. }
  5159. ],
  5160. "title": "Content"
  5161. },
  5162. "name": {
  5163. "type": "string",
  5164. "title": "Name"
  5165. },
  5166. "tool_call_id": {
  5167. "anyOf": [
  5168. {
  5169. "type": "string"
  5170. },
  5171. {
  5172. "type": "null"
  5173. }
  5174. ],
  5175. "title": "Tool Call Id"
  5176. },
  5177. "tool_calls": {
  5178. "anyOf": [
  5179. {
  5180. "items": {
  5181. "$ref": "#/components/schemas/ChatCompletionMessageFunctionToolCallParam"
  5182. },
  5183. "type": "array"
  5184. },
  5185. {
  5186. "type": "null"
  5187. }
  5188. ],
  5189. "title": "Tool Calls"
  5190. },
  5191. "reasoning": {
  5192. "anyOf": [
  5193. {
  5194. "type": "string"
  5195. },
  5196. {
  5197. "type": "null"
  5198. }
  5199. ],
  5200. "title": "Reasoning"
  5201. },
  5202. "tools": {
  5203. "anyOf": [
  5204. {
  5205. "items": {
  5206. "$ref": "#/components/schemas/ChatCompletionFunctionToolParam"
  5207. },
  5208. "type": "array"
  5209. },
  5210. {
  5211. "type": "null"
  5212. }
  5213. ],
  5214. "title": "Tools"
  5215. }
  5216. },
  5217. "additionalProperties": true,
  5218. "type": "object",
  5219. "required": [
  5220. "role"
  5221. ],
  5222. "title": "CustomChatCompletionMessageParam",
  5223. "description": "Enables custom roles in the Chat Completion API."
  5224. },
  5225. "CustomThinkCompletionContentParam": {
  5226. "properties": {
  5227. "thinking": {
  5228. "type": "string",
  5229. "title": "Thinking"
  5230. },
  5231. "closed": {
  5232. "type": "boolean",
  5233. "title": "Closed"
  5234. },
  5235. "type": {
  5236. "type": "string",
  5237. "const": "thinking",
  5238. "title": "Type"
  5239. }
  5240. },
  5241. "additionalProperties": true,
  5242. "type": "object",
  5243. "required": [
  5244. "thinking",
  5245. "type"
  5246. ],
  5247. "title": "CustomThinkCompletionContentParam",
  5248. "description": "A Think Completion Content Param that accepts a plain text and a boolean.\n\nExample:\n{\n \"thinking\": \"I am thinking about the answer\",\n \"closed\": True,\n \"type\": \"thinking\"\n}"
  5249. },
  5250. "CustomTool": {
  5251. "properties": {
  5252. "name": {
  5253. "type": "string",
  5254. "title": "Name"
  5255. },
  5256. "type": {
  5257. "type": "string",
  5258. "const": "custom",
  5259. "title": "Type"
  5260. },
  5261. "description": {
  5262. "anyOf": [
  5263. {
  5264. "type": "string"
  5265. },
  5266. {
  5267. "type": "null"
  5268. }
  5269. ],
  5270. "title": "Description"
  5271. },
  5272. "format": {
  5273. "anyOf": [
  5274. {
  5275. "$ref": "#/components/schemas/Text"
  5276. },
  5277. {
  5278. "$ref": "#/components/schemas/Grammar"
  5279. },
  5280. {
  5281. "type": "null"
  5282. }
  5283. ],
  5284. "title": "Format"
  5285. }
  5286. },
  5287. "additionalProperties": true,
  5288. "type": "object",
  5289. "required": [
  5290. "name",
  5291. "type"
  5292. ],
  5293. "title": "CustomTool",
  5294. "description": "A custom tool that processes input using a specified format.\n\nLearn more about [custom tools](https://platform.openai.com/docs/guides/function-calling#custom-tools)"
  5295. },
  5296. "DetokenizeRequest": {
  5297. "properties": {
  5298. "model": {
  5299. "anyOf": [
  5300. {
  5301. "type": "string"
  5302. },
  5303. {
  5304. "type": "null"
  5305. }
  5306. ],
  5307. "title": "Model"
  5308. },
  5309. "tokens": {
  5310. "items": {
  5311. "type": "integer"
  5312. },
  5313. "type": "array",
  5314. "title": "Tokens"
  5315. }
  5316. },
  5317. "additionalProperties": true,
  5318. "type": "object",
  5319. "required": [
  5320. "tokens"
  5321. ],
  5322. "title": "DetokenizeRequest"
  5323. },
  5324. "EasyInputMessageParam": {
  5325. "properties": {
  5326. "content": {
  5327. "anyOf": [
  5328. {
  5329. "type": "string"
  5330. },
  5331. {
  5332. "items": {
  5333. "anyOf": [
  5334. {
  5335. "$ref": "#/components/schemas/ResponseInputTextParam"
  5336. },
  5337. {
  5338. "$ref": "#/components/schemas/ResponseInputImageParam"
  5339. },
  5340. {
  5341. "$ref": "#/components/schemas/ResponseInputFileParam"
  5342. }
  5343. ]
  5344. },
  5345. "type": "array"
  5346. }
  5347. ],
  5348. "title": "Content"
  5349. },
  5350. "role": {
  5351. "type": "string",
  5352. "enum": [
  5353. "user",
  5354. "assistant",
  5355. "system",
  5356. "developer"
  5357. ],
  5358. "title": "Role"
  5359. },
  5360. "type": {
  5361. "type": "string",
  5362. "const": "message",
  5363. "title": "Type"
  5364. }
  5365. },
  5366. "additionalProperties": true,
  5367. "type": "object",
  5368. "required": [
  5369. "content",
  5370. "role"
  5371. ],
  5372. "title": "EasyInputMessageParam",
  5373. "description": "A message input to the model with a role indicating instruction following\nhierarchy. Instructions given with the `developer` or `system` role take\nprecedence over instructions given with the `user` role. Messages with the\n`assistant` role are presumed to have been generated by the model in previous\ninteractions."
  5374. },
  5375. "EmbeddingChatRequest": {
  5376. "properties": {
  5377. "model": {
  5378. "anyOf": [
  5379. {
  5380. "type": "string"
  5381. },
  5382. {
  5383. "type": "null"
  5384. }
  5385. ],
  5386. "title": "Model"
  5387. },
  5388. "messages": {
  5389. "items": {
  5390. "anyOf": [
  5391. {
  5392. "$ref": "#/components/schemas/ChatCompletionDeveloperMessageParam"
  5393. },
  5394. {
  5395. "$ref": "#/components/schemas/ChatCompletionSystemMessageParam"
  5396. },
  5397. {
  5398. "$ref": "#/components/schemas/ChatCompletionUserMessageParam"
  5399. },
  5400. {
  5401. "$ref": "#/components/schemas/ChatCompletionAssistantMessageParam"
  5402. },
  5403. {
  5404. "$ref": "#/components/schemas/ChatCompletionToolMessageParam"
  5405. },
  5406. {
  5407. "$ref": "#/components/schemas/ChatCompletionFunctionMessageParam"
  5408. },
  5409. {
  5410. "$ref": "#/components/schemas/CustomChatCompletionMessageParam"
  5411. },
  5412. {
  5413. "$ref": "#/components/schemas/Message"
  5414. }
  5415. ]
  5416. },
  5417. "type": "array",
  5418. "title": "Messages"
  5419. },
  5420. "encoding_format": {
  5421. "type": "string",
  5422. "enum": [
  5423. "float",
  5424. "base64",
  5425. "bytes",
  5426. "bytes_only"
  5427. ],
  5428. "title": "Encoding Format",
  5429. "default": "float"
  5430. },
  5431. "dimensions": {
  5432. "anyOf": [
  5433. {
  5434. "type": "integer"
  5435. },
  5436. {
  5437. "type": "null"
  5438. }
  5439. ],
  5440. "title": "Dimensions"
  5441. },
  5442. "user": {
  5443. "anyOf": [
  5444. {
  5445. "type": "string"
  5446. },
  5447. {
  5448. "type": "null"
  5449. }
  5450. ],
  5451. "title": "User"
  5452. },
  5453. "truncate_prompt_tokens": {
  5454. "anyOf": [
  5455. {
  5456. "type": "integer",
  5457. "minimum": -1
  5458. },
  5459. {
  5460. "type": "null"
  5461. }
  5462. ],
  5463. "title": "Truncate Prompt Tokens"
  5464. },
  5465. "add_generation_prompt": {
  5466. "type": "boolean",
  5467. "title": "Add Generation Prompt",
  5468. "description": "If true, the generation prompt will be added to the chat template. This is a parameter used by chat template in tokenizer config of the model.",
  5469. "default": false
  5470. },
  5471. "continue_final_message": {
  5472. "type": "boolean",
  5473. "title": "Continue Final Message",
  5474. "description": "If this is set, the chat will be formatted so that the final message in the chat is open-ended, without any EOS tokens. The model will continue this message rather than starting a new one. This allows you to \"prefill\" part of the model's response for it. Cannot be used at the same time as `add_generation_prompt`.",
  5475. "default": false
  5476. },
  5477. "add_special_tokens": {
  5478. "type": "boolean",
  5479. "title": "Add Special Tokens",
  5480. "description": "If true, special tokens (e.g. BOS) will be added to the prompt on top of what is added by the chat template. For most models, the chat template takes care of adding the special tokens so this should be set to false (as is the default).",
  5481. "default": false
  5482. },
  5483. "chat_template": {
  5484. "anyOf": [
  5485. {
  5486. "type": "string"
  5487. },
  5488. {
  5489. "type": "null"
  5490. }
  5491. ],
  5492. "title": "Chat Template",
  5493. "description": "A Jinja template to use for this conversion. As of transformers v4.44, default chat template is no longer allowed, so you must provide a chat template if the tokenizer does not define one."
  5494. },
  5495. "chat_template_kwargs": {
  5496. "anyOf": [
  5497. {
  5498. "additionalProperties": true,
  5499. "type": "object"
  5500. },
  5501. {
  5502. "type": "null"
  5503. }
  5504. ],
  5505. "title": "Chat Template Kwargs",
  5506. "description": "Additional keyword args to pass to the template renderer. Will be accessible by the chat template."
  5507. },
  5508. "mm_processor_kwargs": {
  5509. "anyOf": [
  5510. {
  5511. "additionalProperties": true,
  5512. "type": "object"
  5513. },
  5514. {
  5515. "type": "null"
  5516. }
  5517. ],
  5518. "title": "Mm Processor Kwargs",
  5519. "description": "Additional kwargs to pass to the HF processor."
  5520. },
  5521. "priority": {
  5522. "type": "integer",
  5523. "title": "Priority",
  5524. "description": "The priority of the request (lower means earlier handling; default: 0). Any priority other than 0 will raise an error if the served model does not use priority scheduling.",
  5525. "default": 0
  5526. },
  5527. "request_id": {
  5528. "type": "string",
  5529. "title": "Request Id",
  5530. "description": "The request_id related to this request. If the caller does not set it, a random_uuid will be generated. This id is used through out the inference process and return in response."
  5531. },
  5532. "normalize": {
  5533. "anyOf": [
  5534. {
  5535. "type": "boolean"
  5536. },
  5537. {
  5538. "type": "null"
  5539. }
  5540. ],
  5541. "title": "Normalize",
  5542. "description": "Whether to normalize the embeddings outputs. Default is True."
  5543. },
  5544. "embed_dtype": {
  5545. "type": "string",
  5546. "enum": [
  5547. "float32",
  5548. "float16",
  5549. "bfloat16",
  5550. "fp8_e4m3",
  5551. "fp8_e5m2"
  5552. ],
  5553. "title": "Embed Dtype",
  5554. "description": "What dtype to use for encoding. Default to using float32 for base64 encoding to match the OpenAI python client behavior. This parameter will affect base64 and binary_response.",
  5555. "default": "float32"
  5556. },
  5557. "endianness": {
  5558. "type": "string",
  5559. "enum": [
  5560. "native",
  5561. "big",
  5562. "little"
  5563. ],
  5564. "title": "Endianness",
  5565. "description": "What endianness to use for encoding. Default to using native for base64 encoding to match the OpenAI python client behavior.This parameter will affect base64 and binary_response.",
  5566. "default": "native"
  5567. }
  5568. },
  5569. "additionalProperties": true,
  5570. "type": "object",
  5571. "required": [
  5572. "messages"
  5573. ],
  5574. "title": "EmbeddingChatRequest"
  5575. },
  5576. "EmbeddingCompletionRequest": {
  5577. "properties": {
  5578. "model": {
  5579. "anyOf": [
  5580. {
  5581. "type": "string"
  5582. },
  5583. {
  5584. "type": "null"
  5585. }
  5586. ],
  5587. "title": "Model"
  5588. },
  5589. "input": {
  5590. "anyOf": [
  5591. {
  5592. "items": {
  5593. "type": "integer"
  5594. },
  5595. "type": "array"
  5596. },
  5597. {
  5598. "items": {
  5599. "items": {
  5600. "type": "integer"
  5601. },
  5602. "type": "array"
  5603. },
  5604. "type": "array"
  5605. },
  5606. {
  5607. "type": "string"
  5608. },
  5609. {
  5610. "items": {
  5611. "type": "string"
  5612. },
  5613. "type": "array"
  5614. }
  5615. ],
  5616. "title": "Input"
  5617. },
  5618. "encoding_format": {
  5619. "type": "string",
  5620. "enum": [
  5621. "float",
  5622. "base64",
  5623. "bytes",
  5624. "bytes_only"
  5625. ],
  5626. "title": "Encoding Format",
  5627. "default": "float"
  5628. },
  5629. "dimensions": {
  5630. "anyOf": [
  5631. {
  5632. "type": "integer"
  5633. },
  5634. {
  5635. "type": "null"
  5636. }
  5637. ],
  5638. "title": "Dimensions"
  5639. },
  5640. "user": {
  5641. "anyOf": [
  5642. {
  5643. "type": "string"
  5644. },
  5645. {
  5646. "type": "null"
  5647. }
  5648. ],
  5649. "title": "User"
  5650. },
  5651. "truncate_prompt_tokens": {
  5652. "anyOf": [
  5653. {
  5654. "type": "integer",
  5655. "minimum": -1
  5656. },
  5657. {
  5658. "type": "null"
  5659. }
  5660. ],
  5661. "title": "Truncate Prompt Tokens"
  5662. },
  5663. "add_special_tokens": {
  5664. "type": "boolean",
  5665. "title": "Add Special Tokens",
  5666. "description": "If true (the default), special tokens (e.g. BOS) will be added to the prompt.",
  5667. "default": true
  5668. },
  5669. "priority": {
  5670. "type": "integer",
  5671. "title": "Priority",
  5672. "description": "The priority of the request (lower means earlier handling; default: 0). Any priority other than 0 will raise an error if the served model does not use priority scheduling.",
  5673. "default": 0
  5674. },
  5675. "request_id": {
  5676. "type": "string",
  5677. "title": "Request Id",
  5678. "description": "The request_id related to this request. If the caller does not set it, a random_uuid will be generated. This id is used through out the inference process and return in response."
  5679. },
  5680. "normalize": {
  5681. "anyOf": [
  5682. {
  5683. "type": "boolean"
  5684. },
  5685. {
  5686. "type": "null"
  5687. }
  5688. ],
  5689. "title": "Normalize",
  5690. "description": "Whether to normalize the embeddings outputs. Default is True."
  5691. },
  5692. "embed_dtype": {
  5693. "type": "string",
  5694. "enum": [
  5695. "float32",
  5696. "float16",
  5697. "bfloat16",
  5698. "fp8_e4m3",
  5699. "fp8_e5m2"
  5700. ],
  5701. "title": "Embed Dtype",
  5702. "description": "What dtype to use for encoding. Default to using float32 for base64 encoding to match the OpenAI python client behavior. This parameter will affect base64 and binary_response.",
  5703. "default": "float32"
  5704. },
  5705. "endianness": {
  5706. "type": "string",
  5707. "enum": [
  5708. "native",
  5709. "big",
  5710. "little"
  5711. ],
  5712. "title": "Endianness",
  5713. "description": "What endianness to use for encoding. Default to using native for base64 encoding to match the OpenAI python client behavior.This parameter will affect base64 and binary_response.",
  5714. "default": "native"
  5715. }
  5716. },
  5717. "additionalProperties": true,
  5718. "type": "object",
  5719. "required": [
  5720. "input"
  5721. ],
  5722. "title": "EmbeddingCompletionRequest"
  5723. },
  5724. "ErrorInfo": {
  5725. "properties": {
  5726. "message": {
  5727. "type": "string",
  5728. "title": "Message"
  5729. },
  5730. "type": {
  5731. "type": "string",
  5732. "title": "Type"
  5733. },
  5734. "param": {
  5735. "anyOf": [
  5736. {
  5737. "type": "string"
  5738. },
  5739. {
  5740. "type": "null"
  5741. }
  5742. ],
  5743. "title": "Param"
  5744. },
  5745. "code": {
  5746. "type": "integer",
  5747. "title": "Code"
  5748. }
  5749. },
  5750. "additionalProperties": true,
  5751. "type": "object",
  5752. "required": [
  5753. "message",
  5754. "type",
  5755. "code"
  5756. ],
  5757. "title": "ErrorInfo"
  5758. },
  5759. "ErrorResponse": {
  5760. "properties": {
  5761. "error": {
  5762. "$ref": "#/components/schemas/ErrorInfo"
  5763. }
  5764. },
  5765. "additionalProperties": true,
  5766. "type": "object",
  5767. "required": [
  5768. "error"
  5769. ],
  5770. "title": "ErrorResponse"
  5771. },
  5772. "File": {
  5773. "properties": {
  5774. "file": {
  5775. "$ref": "#/components/schemas/FileFile"
  5776. },
  5777. "type": {
  5778. "type": "string",
  5779. "const": "file",
  5780. "title": "Type"
  5781. }
  5782. },
  5783. "additionalProperties": true,
  5784. "type": "object",
  5785. "required": [
  5786. "file",
  5787. "type"
  5788. ],
  5789. "title": "File",
  5790. "description": "Learn about [file inputs](https://platform.openai.com/docs/guides/text) for text generation."
  5791. },
  5792. "FileFile": {
  5793. "properties": {
  5794. "file_data": {
  5795. "type": "string",
  5796. "title": "File Data"
  5797. },
  5798. "file_id": {
  5799. "type": "string",
  5800. "title": "File Id"
  5801. },
  5802. "filename": {
  5803. "type": "string",
  5804. "title": "Filename"
  5805. }
  5806. },
  5807. "additionalProperties": true,
  5808. "type": "object",
  5809. "title": "FileFile"
  5810. },
  5811. "FileSearchTool": {
  5812. "properties": {
  5813. "type": {
  5814. "type": "string",
  5815. "const": "file_search",
  5816. "title": "Type"
  5817. },
  5818. "vector_store_ids": {
  5819. "items": {
  5820. "type": "string"
  5821. },
  5822. "type": "array",
  5823. "title": "Vector Store Ids"
  5824. },
  5825. "filters": {
  5826. "anyOf": [
  5827. {
  5828. "$ref": "#/components/schemas/ComparisonFilter"
  5829. },
  5830. {
  5831. "$ref": "#/components/schemas/CompoundFilter"
  5832. },
  5833. {
  5834. "type": "null"
  5835. }
  5836. ],
  5837. "title": "Filters"
  5838. },
  5839. "max_num_results": {
  5840. "anyOf": [
  5841. {
  5842. "type": "integer"
  5843. },
  5844. {
  5845. "type": "null"
  5846. }
  5847. ],
  5848. "title": "Max Num Results"
  5849. },
  5850. "ranking_options": {
  5851. "anyOf": [
  5852. {
  5853. "$ref": "#/components/schemas/RankingOptions"
  5854. },
  5855. {
  5856. "type": "null"
  5857. }
  5858. ]
  5859. }
  5860. },
  5861. "additionalProperties": true,
  5862. "type": "object",
  5863. "required": [
  5864. "type",
  5865. "vector_store_ids"
  5866. ],
  5867. "title": "FileSearchTool",
  5868. "description": "A tool that searches for relevant content from uploaded files.\n\nLearn more about the [file search tool](https://platform.openai.com/docs/guides/tools-file-search)."
  5869. },
  5870. "Filters": {
  5871. "properties": {
  5872. "allowed_domains": {
  5873. "anyOf": [
  5874. {
  5875. "items": {
  5876. "type": "string"
  5877. },
  5878. "type": "array"
  5879. },
  5880. {
  5881. "type": "null"
  5882. }
  5883. ],
  5884. "title": "Allowed Domains"
  5885. }
  5886. },
  5887. "additionalProperties": true,
  5888. "type": "object",
  5889. "title": "Filters",
  5890. "description": "Filters for the search."
  5891. },
  5892. "Function": {
  5893. "properties": {
  5894. "arguments": {
  5895. "type": "string",
  5896. "title": "Arguments"
  5897. },
  5898. "name": {
  5899. "type": "string",
  5900. "title": "Name"
  5901. }
  5902. },
  5903. "additionalProperties": true,
  5904. "type": "object",
  5905. "required": [
  5906. "arguments",
  5907. "name"
  5908. ],
  5909. "title": "Function",
  5910. "description": "The function that the model called."
  5911. },
  5912. "FunctionCall": {
  5913. "properties": {
  5914. "arguments": {
  5915. "type": "string",
  5916. "title": "Arguments"
  5917. },
  5918. "name": {
  5919. "type": "string",
  5920. "title": "Name"
  5921. }
  5922. },
  5923. "additionalProperties": true,
  5924. "type": "object",
  5925. "required": [
  5926. "arguments",
  5927. "name"
  5928. ],
  5929. "title": "FunctionCall",
  5930. "description": "Deprecated and replaced by `tool_calls`.\n\nThe name and arguments of a function that should be called, as generated by the model."
  5931. },
  5932. "FunctionCallOutput": {
  5933. "properties": {
  5934. "call_id": {
  5935. "type": "string",
  5936. "title": "Call Id"
  5937. },
  5938. "output": {
  5939. "anyOf": [
  5940. {
  5941. "type": "string"
  5942. },
  5943. {
  5944. "items": {
  5945. "anyOf": [
  5946. {
  5947. "$ref": "#/components/schemas/ResponseInputTextContentParam"
  5948. },
  5949. {
  5950. "$ref": "#/components/schemas/ResponseInputImageContentParam"
  5951. },
  5952. {
  5953. "$ref": "#/components/schemas/ResponseInputFileContentParam"
  5954. }
  5955. ]
  5956. },
  5957. "type": "array"
  5958. }
  5959. ],
  5960. "title": "Output"
  5961. },
  5962. "type": {
  5963. "type": "string",
  5964. "const": "function_call_output",
  5965. "title": "Type"
  5966. },
  5967. "id": {
  5968. "anyOf": [
  5969. {
  5970. "type": "string"
  5971. },
  5972. {
  5973. "type": "null"
  5974. }
  5975. ],
  5976. "title": "Id"
  5977. },
  5978. "status": {
  5979. "anyOf": [
  5980. {
  5981. "type": "string",
  5982. "enum": [
  5983. "in_progress",
  5984. "completed",
  5985. "incomplete"
  5986. ]
  5987. },
  5988. {
  5989. "type": "null"
  5990. }
  5991. ],
  5992. "title": "Status"
  5993. }
  5994. },
  5995. "additionalProperties": true,
  5996. "type": "object",
  5997. "required": [
  5998. "call_id",
  5999. "output",
  6000. "type"
  6001. ],
  6002. "title": "FunctionCallOutput",
  6003. "description": "The output of a function tool call."
  6004. },
  6005. "FunctionDefinition": {
  6006. "properties": {
  6007. "name": {
  6008. "type": "string",
  6009. "title": "Name"
  6010. },
  6011. "description": {
  6012. "anyOf": [
  6013. {
  6014. "type": "string"
  6015. },
  6016. {
  6017. "type": "null"
  6018. }
  6019. ],
  6020. "title": "Description"
  6021. },
  6022. "parameters": {
  6023. "anyOf": [
  6024. {
  6025. "additionalProperties": true,
  6026. "type": "object"
  6027. },
  6028. {
  6029. "type": "null"
  6030. }
  6031. ],
  6032. "title": "Parameters"
  6033. }
  6034. },
  6035. "additionalProperties": true,
  6036. "type": "object",
  6037. "required": [
  6038. "name"
  6039. ],
  6040. "title": "FunctionDefinition"
  6041. },
  6042. "FunctionShellTool": {
  6043. "properties": {
  6044. "type": {
  6045. "type": "string",
  6046. "const": "shell",
  6047. "title": "Type"
  6048. }
  6049. },
  6050. "additionalProperties": true,
  6051. "type": "object",
  6052. "required": [
  6053. "type"
  6054. ],
  6055. "title": "FunctionShellTool",
  6056. "description": "A tool that allows the model to execute shell commands."
  6057. },
  6058. "FunctionTool": {
  6059. "properties": {
  6060. "name": {
  6061. "type": "string",
  6062. "title": "Name"
  6063. },
  6064. "parameters": {
  6065. "anyOf": [
  6066. {
  6067. "additionalProperties": true,
  6068. "type": "object"
  6069. },
  6070. {
  6071. "type": "null"
  6072. }
  6073. ],
  6074. "title": "Parameters"
  6075. },
  6076. "strict": {
  6077. "anyOf": [
  6078. {
  6079. "type": "boolean"
  6080. },
  6081. {
  6082. "type": "null"
  6083. }
  6084. ],
  6085. "title": "Strict"
  6086. },
  6087. "type": {
  6088. "type": "string",
  6089. "const": "function",
  6090. "title": "Type"
  6091. },
  6092. "description": {
  6093. "anyOf": [
  6094. {
  6095. "type": "string"
  6096. },
  6097. {
  6098. "type": "null"
  6099. }
  6100. ],
  6101. "title": "Description"
  6102. }
  6103. },
  6104. "additionalProperties": true,
  6105. "type": "object",
  6106. "required": [
  6107. "name",
  6108. "type"
  6109. ],
  6110. "title": "FunctionTool",
  6111. "description": "Defines a function in your own code the model can choose to call.\n\nLearn more about [function calling](https://platform.openai.com/docs/guides/function-calling)."
  6112. },
  6113. "GenerateRequest": {
  6114. "properties": {
  6115. "request_id": {
  6116. "type": "string",
  6117. "title": "Request Id",
  6118. "description": "The request_id related to this request. If the caller does not set it, a random_uuid will be generated. This id is used through out the inference process and return in response."
  6119. },
  6120. "token_ids": {
  6121. "items": {
  6122. "type": "integer"
  6123. },
  6124. "type": "array",
  6125. "title": "Token Ids"
  6126. },
  6127. "features": {
  6128. "anyOf": [
  6129. {
  6130. "type": "string"
  6131. },
  6132. {
  6133. "type": "null"
  6134. }
  6135. ],
  6136. "title": "Features"
  6137. },
  6138. "sampling_params": {
  6139. "properties": {
  6140. "n": {
  6141. "type": "integer",
  6142. "title": "N",
  6143. "default": 1
  6144. },
  6145. "presence_penalty": {
  6146. "type": "number",
  6147. "title": "Presence Penalty",
  6148. "default": 0
  6149. },
  6150. "frequency_penalty": {
  6151. "type": "number",
  6152. "title": "Frequency Penalty",
  6153. "default": 0
  6154. },
  6155. "repetition_penalty": {
  6156. "type": "number",
  6157. "title": "Repetition Penalty",
  6158. "default": 1
  6159. },
  6160. "temperature": {
  6161. "type": "number",
  6162. "title": "Temperature",
  6163. "default": 1
  6164. },
  6165. "top_p": {
  6166. "type": "number",
  6167. "title": "Top P",
  6168. "default": 1
  6169. },
  6170. "top_k": {
  6171. "type": "integer",
  6172. "title": "Top K",
  6173. "default": 0
  6174. },
  6175. "min_p": {
  6176. "type": "number",
  6177. "title": "Min P",
  6178. "default": 0
  6179. },
  6180. "seed": {
  6181. "anyOf": [
  6182. {
  6183. "type": "integer"
  6184. },
  6185. {
  6186. "type": "null"
  6187. }
  6188. ],
  6189. "title": "Seed"
  6190. },
  6191. "stop": {
  6192. "anyOf": [
  6193. {
  6194. "type": "string"
  6195. },
  6196. {
  6197. "items": {
  6198. "type": "string"
  6199. },
  6200. "type": "array"
  6201. },
  6202. {
  6203. "type": "null"
  6204. }
  6205. ],
  6206. "title": "Stop"
  6207. },
  6208. "stop_token_ids": {
  6209. "anyOf": [
  6210. {
  6211. "items": {
  6212. "type": "integer"
  6213. },
  6214. "type": "array"
  6215. },
  6216. {
  6217. "type": "null"
  6218. }
  6219. ],
  6220. "title": "Stop Token Ids"
  6221. },
  6222. "ignore_eos": {
  6223. "type": "boolean",
  6224. "title": "Ignore Eos",
  6225. "default": false
  6226. },
  6227. "max_tokens": {
  6228. "anyOf": [
  6229. {
  6230. "type": "integer"
  6231. },
  6232. {
  6233. "type": "null"
  6234. }
  6235. ],
  6236. "title": "Max Tokens",
  6237. "default": 16
  6238. },
  6239. "min_tokens": {
  6240. "type": "integer",
  6241. "title": "Min Tokens",
  6242. "default": 0
  6243. },
  6244. "logprobs": {
  6245. "anyOf": [
  6246. {
  6247. "type": "integer"
  6248. },
  6249. {
  6250. "type": "null"
  6251. }
  6252. ],
  6253. "title": "Logprobs"
  6254. },
  6255. "prompt_logprobs": {
  6256. "anyOf": [
  6257. {
  6258. "type": "integer"
  6259. },
  6260. {
  6261. "type": "null"
  6262. }
  6263. ],
  6264. "title": "Prompt Logprobs"
  6265. },
  6266. "flat_logprobs": {
  6267. "type": "boolean",
  6268. "title": "Flat Logprobs",
  6269. "default": false
  6270. },
  6271. "detokenize": {
  6272. "type": "boolean",
  6273. "title": "Detokenize",
  6274. "default": true
  6275. },
  6276. "skip_special_tokens": {
  6277. "type": "boolean",
  6278. "title": "Skip Special Tokens",
  6279. "default": true
  6280. },
  6281. "spaces_between_special_tokens": {
  6282. "type": "boolean",
  6283. "title": "Spaces Between Special Tokens",
  6284. "default": true
  6285. },
  6286. "logits_processors": {
  6287. "anyOf": [
  6288. {},
  6289. {
  6290. "type": "null"
  6291. }
  6292. ],
  6293. "title": "Logits Processors"
  6294. },
  6295. "include_stop_str_in_output": {
  6296. "type": "boolean",
  6297. "title": "Include Stop Str In Output",
  6298. "default": false
  6299. },
  6300. "truncate_prompt_tokens": {
  6301. "anyOf": [
  6302. {
  6303. "type": "integer"
  6304. },
  6305. {
  6306. "type": "null"
  6307. }
  6308. ],
  6309. "title": "Truncate Prompt Tokens"
  6310. },
  6311. "output_kind": {
  6312. "$ref": "#/components/schemas/RequestOutputKind",
  6313. "default": 0
  6314. },
  6315. "skip_clone": {
  6316. "type": "boolean",
  6317. "title": "Skip Clone",
  6318. "default": false
  6319. },
  6320. "output_text_buffer_length": {
  6321. "type": "integer",
  6322. "title": "Output Text Buffer Length",
  6323. "default": 0
  6324. },
  6325. "_all_stop_token_ids": {
  6326. "items": {
  6327. "type": "integer"
  6328. },
  6329. "type": "array",
  6330. "uniqueItems": true,
  6331. "title": "All Stop Token Ids"
  6332. },
  6333. "structured_outputs": {
  6334. "anyOf": [
  6335. {
  6336. "$ref": "#/components/schemas/StructuredOutputsParams"
  6337. },
  6338. {
  6339. "type": "null"
  6340. }
  6341. ]
  6342. },
  6343. "logit_bias": {
  6344. "anyOf": [
  6345. {
  6346. "additionalProperties": {
  6347. "type": "number"
  6348. },
  6349. "type": "object"
  6350. },
  6351. {
  6352. "type": "null"
  6353. }
  6354. ],
  6355. "title": "Logit Bias"
  6356. },
  6357. "allowed_token_ids": {
  6358. "anyOf": [
  6359. {
  6360. "items": {
  6361. "type": "integer"
  6362. },
  6363. "type": "array"
  6364. },
  6365. {
  6366. "type": "null"
  6367. }
  6368. ],
  6369. "title": "Allowed Token Ids"
  6370. },
  6371. "extra_args": {
  6372. "anyOf": [
  6373. {
  6374. "additionalProperties": true,
  6375. "type": "object"
  6376. },
  6377. {
  6378. "type": "null"
  6379. }
  6380. ],
  6381. "title": "Extra Args"
  6382. },
  6383. "bad_words": {
  6384. "anyOf": [
  6385. {
  6386. "items": {
  6387. "type": "string"
  6388. },
  6389. "type": "array"
  6390. },
  6391. {
  6392. "type": "null"
  6393. }
  6394. ],
  6395. "title": "Bad Words"
  6396. },
  6397. "_bad_words_token_ids": {
  6398. "anyOf": [
  6399. {
  6400. "items": {
  6401. "items": {
  6402. "type": "integer"
  6403. },
  6404. "type": "array"
  6405. },
  6406. "type": "array"
  6407. },
  6408. {
  6409. "type": "null"
  6410. }
  6411. ],
  6412. "title": "Bad Words Token Ids"
  6413. },
  6414. "skip_reading_prefix_cache": {
  6415. "anyOf": [
  6416. {
  6417. "type": "boolean"
  6418. },
  6419. {
  6420. "type": "null"
  6421. }
  6422. ],
  6423. "title": "Skip Reading Prefix Cache"
  6424. }
  6425. },
  6426. "type": "object",
  6427. "required": [
  6428. "n",
  6429. "presence_penalty",
  6430. "frequency_penalty",
  6431. "repetition_penalty",
  6432. "temperature",
  6433. "top_p",
  6434. "top_k",
  6435. "min_p",
  6436. "seed",
  6437. "stop",
  6438. "stop_token_ids",
  6439. "ignore_eos",
  6440. "max_tokens",
  6441. "min_tokens",
  6442. "logprobs",
  6443. "prompt_logprobs",
  6444. "flat_logprobs",
  6445. "detokenize",
  6446. "skip_special_tokens",
  6447. "spaces_between_special_tokens",
  6448. "logits_processors",
  6449. "include_stop_str_in_output",
  6450. "truncate_prompt_tokens",
  6451. "output_kind",
  6452. "skip_clone",
  6453. "output_text_buffer_length",
  6454. "_all_stop_token_ids",
  6455. "structured_outputs",
  6456. "logit_bias",
  6457. "allowed_token_ids",
  6458. "extra_args",
  6459. "bad_words",
  6460. "_bad_words_token_ids",
  6461. "skip_reading_prefix_cache"
  6462. ],
  6463. "title": "Sampling Params"
  6464. },
  6465. "model": {
  6466. "anyOf": [
  6467. {
  6468. "type": "string"
  6469. },
  6470. {
  6471. "type": "null"
  6472. }
  6473. ],
  6474. "title": "Model"
  6475. },
  6476. "stream": {
  6477. "anyOf": [
  6478. {
  6479. "type": "boolean"
  6480. },
  6481. {
  6482. "type": "null"
  6483. }
  6484. ],
  6485. "title": "Stream",
  6486. "default": false
  6487. },
  6488. "stream_options": {
  6489. "anyOf": [
  6490. {
  6491. "$ref": "#/components/schemas/StreamOptions"
  6492. },
  6493. {
  6494. "type": "null"
  6495. }
  6496. ]
  6497. },
  6498. "cache_salt": {
  6499. "anyOf": [
  6500. {
  6501. "type": "string"
  6502. },
  6503. {
  6504. "type": "null"
  6505. }
  6506. ],
  6507. "title": "Cache Salt",
  6508. "description": "If specified, the prefix cache will be salted with the provided string to prevent an attacker to guess prompts in multi-user environments. The salt should be random, protected from access by 3rd parties, and long enough to be unpredictable (e.g., 43 characters base64-encoded, corresponding to 256 bit)."
  6509. },
  6510. "priority": {
  6511. "type": "integer",
  6512. "title": "Priority",
  6513. "description": "The priority of the request (lower means earlier handling; default: 0). Any priority other than 0 will raise an error if the served model does not use priority scheduling.",
  6514. "default": 0
  6515. },
  6516. "kv_transfer_params": {
  6517. "anyOf": [
  6518. {
  6519. "additionalProperties": true,
  6520. "type": "object"
  6521. },
  6522. {
  6523. "type": "null"
  6524. }
  6525. ],
  6526. "title": "Kv Transfer Params",
  6527. "description": "KVTransfer parameters used for disaggregated serving."
  6528. }
  6529. },
  6530. "type": "object",
  6531. "required": [
  6532. "token_ids",
  6533. "sampling_params"
  6534. ],
  6535. "title": "GenerateRequest"
  6536. },
  6537. "Grammar": {
  6538. "properties": {
  6539. "definition": {
  6540. "type": "string",
  6541. "title": "Definition"
  6542. },
  6543. "syntax": {
  6544. "type": "string",
  6545. "enum": [
  6546. "lark",
  6547. "regex"
  6548. ],
  6549. "title": "Syntax"
  6550. },
  6551. "type": {
  6552. "type": "string",
  6553. "const": "grammar",
  6554. "title": "Type"
  6555. }
  6556. },
  6557. "additionalProperties": true,
  6558. "type": "object",
  6559. "required": [
  6560. "definition",
  6561. "syntax",
  6562. "type"
  6563. ],
  6564. "title": "Grammar",
  6565. "description": "A grammar defined by the user."
  6566. },
  6567. "HTTPValidationError": {
  6568. "properties": {
  6569. "detail": {
  6570. "items": {
  6571. "$ref": "#/components/schemas/ValidationError"
  6572. },
  6573. "type": "array",
  6574. "title": "Detail"
  6575. }
  6576. },
  6577. "type": "object",
  6578. "title": "HTTPValidationError"
  6579. },
  6580. "IOProcessorRequest": {
  6581. "properties": {
  6582. "model": {
  6583. "anyOf": [
  6584. {
  6585. "type": "string"
  6586. },
  6587. {
  6588. "type": "null"
  6589. }
  6590. ],
  6591. "title": "Model"
  6592. },
  6593. "priority": {
  6594. "type": "integer",
  6595. "title": "Priority",
  6596. "default": 0
  6597. },
  6598. "data": {
  6599. "title": "Data"
  6600. },
  6601. "task": {
  6602. "type": "string",
  6603. "enum": [
  6604. "embed",
  6605. "classify",
  6606. "score",
  6607. "token_embed",
  6608. "token_classify",
  6609. "plugin"
  6610. ],
  6611. "title": "Task",
  6612. "default": "plugin"
  6613. },
  6614. "encoding_format": {
  6615. "type": "string",
  6616. "enum": [
  6617. "float",
  6618. "base64",
  6619. "bytes",
  6620. "bytes_only"
  6621. ],
  6622. "title": "Encoding Format",
  6623. "default": "float"
  6624. },
  6625. "embed_dtype": {
  6626. "type": "string",
  6627. "enum": [
  6628. "float32",
  6629. "float16",
  6630. "bfloat16",
  6631. "fp8_e4m3",
  6632. "fp8_e5m2"
  6633. ],
  6634. "title": "Embed Dtype",
  6635. "description": "What dtype to use for encoding. Default to using float32 for base64 encoding to match the OpenAI python client behavior. This parameter will affect base64 and binary_response.",
  6636. "default": "float32"
  6637. },
  6638. "endianness": {
  6639. "type": "string",
  6640. "enum": [
  6641. "native",
  6642. "big",
  6643. "little"
  6644. ],
  6645. "title": "Endianness",
  6646. "description": "What endianness to use for encoding. Default to using native for base64 encoding to match the OpenAI python client behavior.This parameter will affect base64 and binary_response.",
  6647. "default": "native"
  6648. }
  6649. },
  6650. "additionalProperties": true,
  6651. "type": "object",
  6652. "required": [
  6653. "data"
  6654. ],
  6655. "title": "IOProcessorRequest"
  6656. },
  6657. "ImageGeneration": {
  6658. "properties": {
  6659. "type": {
  6660. "type": "string",
  6661. "const": "image_generation",
  6662. "title": "Type"
  6663. },
  6664. "background": {
  6665. "anyOf": [
  6666. {
  6667. "type": "string",
  6668. "enum": [
  6669. "transparent",
  6670. "opaque",
  6671. "auto"
  6672. ]
  6673. },
  6674. {
  6675. "type": "null"
  6676. }
  6677. ],
  6678. "title": "Background"
  6679. },
  6680. "input_fidelity": {
  6681. "anyOf": [
  6682. {
  6683. "type": "string",
  6684. "enum": [
  6685. "high",
  6686. "low"
  6687. ]
  6688. },
  6689. {
  6690. "type": "null"
  6691. }
  6692. ],
  6693. "title": "Input Fidelity"
  6694. },
  6695. "input_image_mask": {
  6696. "anyOf": [
  6697. {
  6698. "$ref": "#/components/schemas/ImageGenerationInputImageMask"
  6699. },
  6700. {
  6701. "type": "null"
  6702. }
  6703. ]
  6704. },
  6705. "model": {
  6706. "anyOf": [
  6707. {
  6708. "type": "string"
  6709. },
  6710. {
  6711. "type": "string",
  6712. "enum": [
  6713. "gpt-image-1",
  6714. "gpt-image-1-mini"
  6715. ]
  6716. },
  6717. {
  6718. "type": "null"
  6719. }
  6720. ],
  6721. "title": "Model"
  6722. },
  6723. "moderation": {
  6724. "anyOf": [
  6725. {
  6726. "type": "string",
  6727. "enum": [
  6728. "auto",
  6729. "low"
  6730. ]
  6731. },
  6732. {
  6733. "type": "null"
  6734. }
  6735. ],
  6736. "title": "Moderation"
  6737. },
  6738. "output_compression": {
  6739. "anyOf": [
  6740. {
  6741. "type": "integer"
  6742. },
  6743. {
  6744. "type": "null"
  6745. }
  6746. ],
  6747. "title": "Output Compression"
  6748. },
  6749. "output_format": {
  6750. "anyOf": [
  6751. {
  6752. "type": "string",
  6753. "enum": [
  6754. "png",
  6755. "webp",
  6756. "jpeg"
  6757. ]
  6758. },
  6759. {
  6760. "type": "null"
  6761. }
  6762. ],
  6763. "title": "Output Format"
  6764. },
  6765. "partial_images": {
  6766. "anyOf": [
  6767. {
  6768. "type": "integer"
  6769. },
  6770. {
  6771. "type": "null"
  6772. }
  6773. ],
  6774. "title": "Partial Images"
  6775. },
  6776. "quality": {
  6777. "anyOf": [
  6778. {
  6779. "type": "string",
  6780. "enum": [
  6781. "low",
  6782. "medium",
  6783. "high",
  6784. "auto"
  6785. ]
  6786. },
  6787. {
  6788. "type": "null"
  6789. }
  6790. ],
  6791. "title": "Quality"
  6792. },
  6793. "size": {
  6794. "anyOf": [
  6795. {
  6796. "type": "string",
  6797. "enum": [
  6798. "1024x1024",
  6799. "1024x1536",
  6800. "1536x1024",
  6801. "auto"
  6802. ]
  6803. },
  6804. {
  6805. "type": "null"
  6806. }
  6807. ],
  6808. "title": "Size"
  6809. }
  6810. },
  6811. "additionalProperties": true,
  6812. "type": "object",
  6813. "required": [
  6814. "type"
  6815. ],
  6816. "title": "ImageGeneration",
  6817. "description": "A tool that generates images using the GPT image models."
  6818. },
  6819. "ImageGenerationCall": {
  6820. "properties": {
  6821. "id": {
  6822. "type": "string",
  6823. "title": "Id"
  6824. },
  6825. "result": {
  6826. "anyOf": [
  6827. {
  6828. "type": "string"
  6829. },
  6830. {
  6831. "type": "null"
  6832. }
  6833. ],
  6834. "title": "Result"
  6835. },
  6836. "status": {
  6837. "type": "string",
  6838. "enum": [
  6839. "in_progress",
  6840. "completed",
  6841. "generating",
  6842. "failed"
  6843. ],
  6844. "title": "Status"
  6845. },
  6846. "type": {
  6847. "type": "string",
  6848. "const": "image_generation_call",
  6849. "title": "Type"
  6850. }
  6851. },
  6852. "additionalProperties": true,
  6853. "type": "object",
  6854. "required": [
  6855. "id",
  6856. "status",
  6857. "type"
  6858. ],
  6859. "title": "ImageGenerationCall",
  6860. "description": "An image generation request made by the model."
  6861. },
  6862. "ImageGenerationInputImageMask": {
  6863. "properties": {
  6864. "file_id": {
  6865. "anyOf": [
  6866. {
  6867. "type": "string"
  6868. },
  6869. {
  6870. "type": "null"
  6871. }
  6872. ],
  6873. "title": "File Id"
  6874. },
  6875. "image_url": {
  6876. "anyOf": [
  6877. {
  6878. "type": "string"
  6879. },
  6880. {
  6881. "type": "null"
  6882. }
  6883. ],
  6884. "title": "Image Url"
  6885. }
  6886. },
  6887. "additionalProperties": true,
  6888. "type": "object",
  6889. "title": "ImageGenerationInputImageMask",
  6890. "description": "Optional mask for inpainting.\n\nContains `image_url`\n(string, optional) and `file_id` (string, optional)."
  6891. },
  6892. "ImageURL": {
  6893. "properties": {
  6894. "url": {
  6895. "type": "string",
  6896. "title": "Url"
  6897. },
  6898. "detail": {
  6899. "type": "string",
  6900. "enum": [
  6901. "auto",
  6902. "low",
  6903. "high"
  6904. ],
  6905. "title": "Detail"
  6906. }
  6907. },
  6908. "additionalProperties": true,
  6909. "type": "object",
  6910. "required": [
  6911. "url"
  6912. ],
  6913. "title": "ImageURL"
  6914. },
  6915. "InputAudio": {
  6916. "properties": {
  6917. "data": {
  6918. "type": "string",
  6919. "title": "Data"
  6920. },
  6921. "format": {
  6922. "type": "string",
  6923. "enum": [
  6924. "wav",
  6925. "mp3"
  6926. ],
  6927. "title": "Format"
  6928. }
  6929. },
  6930. "additionalProperties": true,
  6931. "type": "object",
  6932. "required": [
  6933. "data",
  6934. "format"
  6935. ],
  6936. "title": "InputAudio"
  6937. },
  6938. "ItemReference": {
  6939. "properties": {
  6940. "id": {
  6941. "type": "string",
  6942. "title": "Id"
  6943. },
  6944. "type": {
  6945. "anyOf": [
  6946. {
  6947. "type": "string",
  6948. "const": "item_reference"
  6949. },
  6950. {
  6951. "type": "null"
  6952. }
  6953. ],
  6954. "title": "Type"
  6955. }
  6956. },
  6957. "additionalProperties": true,
  6958. "type": "object",
  6959. "required": [
  6960. "id"
  6961. ],
  6962. "title": "ItemReference",
  6963. "description": "An internal identifier for an item to reference."
  6964. },
  6965. "JsonSchemaResponseFormat": {
  6966. "properties": {
  6967. "name": {
  6968. "type": "string",
  6969. "title": "Name"
  6970. },
  6971. "description": {
  6972. "anyOf": [
  6973. {
  6974. "type": "string"
  6975. },
  6976. {
  6977. "type": "null"
  6978. }
  6979. ],
  6980. "title": "Description"
  6981. },
  6982. "schema": {
  6983. "anyOf": [
  6984. {
  6985. "additionalProperties": true,
  6986. "type": "object"
  6987. },
  6988. {
  6989. "type": "null"
  6990. }
  6991. ],
  6992. "title": "Schema"
  6993. },
  6994. "strict": {
  6995. "anyOf": [
  6996. {
  6997. "type": "boolean"
  6998. },
  6999. {
  7000. "type": "null"
  7001. }
  7002. ],
  7003. "title": "Strict"
  7004. }
  7005. },
  7006. "additionalProperties": true,
  7007. "type": "object",
  7008. "required": [
  7009. "name"
  7010. ],
  7011. "title": "JsonSchemaResponseFormat"
  7012. },
  7013. "LegacyStructuralTag": {
  7014. "properties": {
  7015. "begin": {
  7016. "type": "string",
  7017. "title": "Begin"
  7018. },
  7019. "schema": {
  7020. "anyOf": [
  7021. {
  7022. "additionalProperties": true,
  7023. "type": "object"
  7024. },
  7025. {
  7026. "type": "null"
  7027. }
  7028. ],
  7029. "title": "Schema"
  7030. },
  7031. "end": {
  7032. "type": "string",
  7033. "title": "End"
  7034. }
  7035. },
  7036. "additionalProperties": true,
  7037. "type": "object",
  7038. "required": [
  7039. "begin",
  7040. "end"
  7041. ],
  7042. "title": "LegacyStructuralTag"
  7043. },
  7044. "LegacyStructuralTagResponseFormat": {
  7045. "properties": {
  7046. "type": {
  7047. "type": "string",
  7048. "const": "structural_tag",
  7049. "title": "Type"
  7050. },
  7051. "structures": {
  7052. "items": {
  7053. "$ref": "#/components/schemas/LegacyStructuralTag"
  7054. },
  7055. "type": "array",
  7056. "title": "Structures"
  7057. },
  7058. "triggers": {
  7059. "items": {
  7060. "type": "string"
  7061. },
  7062. "type": "array",
  7063. "title": "Triggers"
  7064. }
  7065. },
  7066. "additionalProperties": true,
  7067. "type": "object",
  7068. "required": [
  7069. "type",
  7070. "structures",
  7071. "triggers"
  7072. ],
  7073. "title": "LegacyStructuralTagResponseFormat"
  7074. },
  7075. "LocalShell": {
  7076. "properties": {
  7077. "type": {
  7078. "type": "string",
  7079. "const": "local_shell",
  7080. "title": "Type"
  7081. }
  7082. },
  7083. "additionalProperties": true,
  7084. "type": "object",
  7085. "required": [
  7086. "type"
  7087. ],
  7088. "title": "LocalShell",
  7089. "description": "A tool that allows the model to execute shell commands in a local environment."
  7090. },
  7091. "LocalShellCall": {
  7092. "properties": {
  7093. "id": {
  7094. "type": "string",
  7095. "title": "Id"
  7096. },
  7097. "action": {
  7098. "$ref": "#/components/schemas/LocalShellCallAction"
  7099. },
  7100. "call_id": {
  7101. "type": "string",
  7102. "title": "Call Id"
  7103. },
  7104. "status": {
  7105. "type": "string",
  7106. "enum": [
  7107. "in_progress",
  7108. "completed",
  7109. "incomplete"
  7110. ],
  7111. "title": "Status"
  7112. },
  7113. "type": {
  7114. "type": "string",
  7115. "const": "local_shell_call",
  7116. "title": "Type"
  7117. }
  7118. },
  7119. "additionalProperties": true,
  7120. "type": "object",
  7121. "required": [
  7122. "id",
  7123. "action",
  7124. "call_id",
  7125. "status",
  7126. "type"
  7127. ],
  7128. "title": "LocalShellCall",
  7129. "description": "A tool call to run a command on the local shell."
  7130. },
  7131. "LocalShellCallAction": {
  7132. "properties": {
  7133. "command": {
  7134. "items": {
  7135. "type": "string"
  7136. },
  7137. "type": "array",
  7138. "title": "Command"
  7139. },
  7140. "env": {
  7141. "additionalProperties": {
  7142. "type": "string"
  7143. },
  7144. "type": "object",
  7145. "title": "Env"
  7146. },
  7147. "type": {
  7148. "type": "string",
  7149. "const": "exec",
  7150. "title": "Type"
  7151. },
  7152. "timeout_ms": {
  7153. "anyOf": [
  7154. {
  7155. "type": "integer"
  7156. },
  7157. {
  7158. "type": "null"
  7159. }
  7160. ],
  7161. "title": "Timeout Ms"
  7162. },
  7163. "user": {
  7164. "anyOf": [
  7165. {
  7166. "type": "string"
  7167. },
  7168. {
  7169. "type": "null"
  7170. }
  7171. ],
  7172. "title": "User"
  7173. },
  7174. "working_directory": {
  7175. "anyOf": [
  7176. {
  7177. "type": "string"
  7178. },
  7179. {
  7180. "type": "null"
  7181. }
  7182. ],
  7183. "title": "Working Directory"
  7184. }
  7185. },
  7186. "additionalProperties": true,
  7187. "type": "object",
  7188. "required": [
  7189. "command",
  7190. "env",
  7191. "type"
  7192. ],
  7193. "title": "LocalShellCallAction",
  7194. "description": "Execute a shell command on the server."
  7195. },
  7196. "LocalShellCallOutput": {
  7197. "properties": {
  7198. "id": {
  7199. "type": "string",
  7200. "title": "Id"
  7201. },
  7202. "output": {
  7203. "type": "string",
  7204. "title": "Output"
  7205. },
  7206. "type": {
  7207. "type": "string",
  7208. "const": "local_shell_call_output",
  7209. "title": "Type"
  7210. },
  7211. "status": {
  7212. "anyOf": [
  7213. {
  7214. "type": "string",
  7215. "enum": [
  7216. "in_progress",
  7217. "completed",
  7218. "incomplete"
  7219. ]
  7220. },
  7221. {
  7222. "type": "null"
  7223. }
  7224. ],
  7225. "title": "Status"
  7226. }
  7227. },
  7228. "additionalProperties": true,
  7229. "type": "object",
  7230. "required": [
  7231. "id",
  7232. "output",
  7233. "type"
  7234. ],
  7235. "title": "LocalShellCallOutput",
  7236. "description": "The output of a local shell tool call."
  7237. },
  7238. "LogitsProcessorConstructor": {
  7239. "properties": {
  7240. "qualname": {
  7241. "type": "string",
  7242. "title": "Qualname"
  7243. },
  7244. "args": {
  7245. "anyOf": [
  7246. {
  7247. "items": {},
  7248. "type": "array"
  7249. },
  7250. {
  7251. "type": "null"
  7252. }
  7253. ],
  7254. "title": "Args"
  7255. },
  7256. "kwargs": {
  7257. "anyOf": [
  7258. {
  7259. "additionalProperties": true,
  7260. "type": "object"
  7261. },
  7262. {
  7263. "type": "null"
  7264. }
  7265. ],
  7266. "title": "Kwargs"
  7267. }
  7268. },
  7269. "additionalProperties": false,
  7270. "type": "object",
  7271. "required": [
  7272. "qualname"
  7273. ],
  7274. "title": "LogitsProcessorConstructor"
  7275. },
  7276. "Logprob": {
  7277. "properties": {
  7278. "token": {
  7279. "type": "string",
  7280. "title": "Token"
  7281. },
  7282. "bytes": {
  7283. "items": {
  7284. "type": "integer"
  7285. },
  7286. "type": "array",
  7287. "title": "Bytes"
  7288. },
  7289. "logprob": {
  7290. "type": "number",
  7291. "title": "Logprob"
  7292. },
  7293. "top_logprobs": {
  7294. "items": {
  7295. "$ref": "#/components/schemas/LogprobTopLogprob"
  7296. },
  7297. "type": "array",
  7298. "title": "Top Logprobs"
  7299. }
  7300. },
  7301. "additionalProperties": true,
  7302. "type": "object",
  7303. "required": [
  7304. "token",
  7305. "bytes",
  7306. "logprob",
  7307. "top_logprobs"
  7308. ],
  7309. "title": "Logprob",
  7310. "description": "The log probability of a token."
  7311. },
  7312. "LogprobTopLogprob": {
  7313. "properties": {
  7314. "token": {
  7315. "type": "string",
  7316. "title": "Token"
  7317. },
  7318. "bytes": {
  7319. "items": {
  7320. "type": "integer"
  7321. },
  7322. "type": "array",
  7323. "title": "Bytes"
  7324. },
  7325. "logprob": {
  7326. "type": "number",
  7327. "title": "Logprob"
  7328. }
  7329. },
  7330. "additionalProperties": true,
  7331. "type": "object",
  7332. "required": [
  7333. "token",
  7334. "bytes",
  7335. "logprob"
  7336. ],
  7337. "title": "LogprobTopLogprob",
  7338. "description": "The top log probability of a token."
  7339. },
  7340. "Mcp": {
  7341. "properties": {
  7342. "server_label": {
  7343. "type": "string",
  7344. "title": "Server Label"
  7345. },
  7346. "type": {
  7347. "type": "string",
  7348. "const": "mcp",
  7349. "title": "Type"
  7350. },
  7351. "allowed_tools": {
  7352. "anyOf": [
  7353. {
  7354. "items": {
  7355. "type": "string"
  7356. },
  7357. "type": "array"
  7358. },
  7359. {
  7360. "$ref": "#/components/schemas/McpAllowedToolsMcpToolFilter"
  7361. },
  7362. {
  7363. "type": "null"
  7364. }
  7365. ],
  7366. "title": "Allowed Tools"
  7367. },
  7368. "authorization": {
  7369. "anyOf": [
  7370. {
  7371. "type": "string"
  7372. },
  7373. {
  7374. "type": "null"
  7375. }
  7376. ],
  7377. "title": "Authorization"
  7378. },
  7379. "connector_id": {
  7380. "anyOf": [
  7381. {
  7382. "type": "string",
  7383. "enum": [
  7384. "connector_dropbox",
  7385. "connector_gmail",
  7386. "connector_googlecalendar",
  7387. "connector_googledrive",
  7388. "connector_microsoftteams",
  7389. "connector_outlookcalendar",
  7390. "connector_outlookemail",
  7391. "connector_sharepoint"
  7392. ]
  7393. },
  7394. {
  7395. "type": "null"
  7396. }
  7397. ],
  7398. "title": "Connector Id"
  7399. },
  7400. "headers": {
  7401. "anyOf": [
  7402. {
  7403. "additionalProperties": {
  7404. "type": "string"
  7405. },
  7406. "type": "object"
  7407. },
  7408. {
  7409. "type": "null"
  7410. }
  7411. ],
  7412. "title": "Headers"
  7413. },
  7414. "require_approval": {
  7415. "anyOf": [
  7416. {
  7417. "$ref": "#/components/schemas/McpRequireApprovalMcpToolApprovalFilter"
  7418. },
  7419. {
  7420. "type": "string",
  7421. "enum": [
  7422. "always",
  7423. "never"
  7424. ]
  7425. },
  7426. {
  7427. "type": "null"
  7428. }
  7429. ],
  7430. "title": "Require Approval"
  7431. },
  7432. "server_description": {
  7433. "anyOf": [
  7434. {
  7435. "type": "string"
  7436. },
  7437. {
  7438. "type": "null"
  7439. }
  7440. ],
  7441. "title": "Server Description"
  7442. },
  7443. "server_url": {
  7444. "anyOf": [
  7445. {
  7446. "type": "string"
  7447. },
  7448. {
  7449. "type": "null"
  7450. }
  7451. ],
  7452. "title": "Server Url"
  7453. }
  7454. },
  7455. "additionalProperties": true,
  7456. "type": "object",
  7457. "required": [
  7458. "server_label",
  7459. "type"
  7460. ],
  7461. "title": "Mcp",
  7462. "description": "Give the model access to additional tools via remote Model Context Protocol\n(MCP) servers. [Learn more about MCP](https://platform.openai.com/docs/guides/tools-remote-mcp)."
  7463. },
  7464. "McpAllowedToolsMcpToolFilter": {
  7465. "properties": {
  7466. "read_only": {
  7467. "anyOf": [
  7468. {
  7469. "type": "boolean"
  7470. },
  7471. {
  7472. "type": "null"
  7473. }
  7474. ],
  7475. "title": "Read Only"
  7476. },
  7477. "tool_names": {
  7478. "anyOf": [
  7479. {
  7480. "items": {
  7481. "type": "string"
  7482. },
  7483. "type": "array"
  7484. },
  7485. {
  7486. "type": "null"
  7487. }
  7488. ],
  7489. "title": "Tool Names"
  7490. }
  7491. },
  7492. "additionalProperties": true,
  7493. "type": "object",
  7494. "title": "McpAllowedToolsMcpToolFilter",
  7495. "description": "A filter object to specify which tools are allowed."
  7496. },
  7497. "McpApprovalRequest": {
  7498. "properties": {
  7499. "id": {
  7500. "type": "string",
  7501. "title": "Id"
  7502. },
  7503. "arguments": {
  7504. "type": "string",
  7505. "title": "Arguments"
  7506. },
  7507. "name": {
  7508. "type": "string",
  7509. "title": "Name"
  7510. },
  7511. "server_label": {
  7512. "type": "string",
  7513. "title": "Server Label"
  7514. },
  7515. "type": {
  7516. "type": "string",
  7517. "const": "mcp_approval_request",
  7518. "title": "Type"
  7519. }
  7520. },
  7521. "additionalProperties": true,
  7522. "type": "object",
  7523. "required": [
  7524. "id",
  7525. "arguments",
  7526. "name",
  7527. "server_label",
  7528. "type"
  7529. ],
  7530. "title": "McpApprovalRequest",
  7531. "description": "A request for human approval of a tool invocation."
  7532. },
  7533. "McpApprovalResponse": {
  7534. "properties": {
  7535. "approval_request_id": {
  7536. "type": "string",
  7537. "title": "Approval Request Id"
  7538. },
  7539. "approve": {
  7540. "type": "boolean",
  7541. "title": "Approve"
  7542. },
  7543. "type": {
  7544. "type": "string",
  7545. "const": "mcp_approval_response",
  7546. "title": "Type"
  7547. },
  7548. "id": {
  7549. "anyOf": [
  7550. {
  7551. "type": "string"
  7552. },
  7553. {
  7554. "type": "null"
  7555. }
  7556. ],
  7557. "title": "Id"
  7558. },
  7559. "reason": {
  7560. "anyOf": [
  7561. {
  7562. "type": "string"
  7563. },
  7564. {
  7565. "type": "null"
  7566. }
  7567. ],
  7568. "title": "Reason"
  7569. }
  7570. },
  7571. "additionalProperties": true,
  7572. "type": "object",
  7573. "required": [
  7574. "approval_request_id",
  7575. "approve",
  7576. "type"
  7577. ],
  7578. "title": "McpApprovalResponse",
  7579. "description": "A response to an MCP approval request."
  7580. },
  7581. "McpCall": {
  7582. "properties": {
  7583. "id": {
  7584. "type": "string",
  7585. "title": "Id"
  7586. },
  7587. "arguments": {
  7588. "type": "string",
  7589. "title": "Arguments"
  7590. },
  7591. "name": {
  7592. "type": "string",
  7593. "title": "Name"
  7594. },
  7595. "server_label": {
  7596. "type": "string",
  7597. "title": "Server Label"
  7598. },
  7599. "type": {
  7600. "type": "string",
  7601. "const": "mcp_call",
  7602. "title": "Type"
  7603. },
  7604. "approval_request_id": {
  7605. "anyOf": [
  7606. {
  7607. "type": "string"
  7608. },
  7609. {
  7610. "type": "null"
  7611. }
  7612. ],
  7613. "title": "Approval Request Id"
  7614. },
  7615. "error": {
  7616. "anyOf": [
  7617. {
  7618. "type": "string"
  7619. },
  7620. {
  7621. "type": "null"
  7622. }
  7623. ],
  7624. "title": "Error"
  7625. },
  7626. "output": {
  7627. "anyOf": [
  7628. {
  7629. "type": "string"
  7630. },
  7631. {
  7632. "type": "null"
  7633. }
  7634. ],
  7635. "title": "Output"
  7636. },
  7637. "status": {
  7638. "anyOf": [
  7639. {
  7640. "type": "string",
  7641. "enum": [
  7642. "in_progress",
  7643. "completed",
  7644. "incomplete",
  7645. "calling",
  7646. "failed"
  7647. ]
  7648. },
  7649. {
  7650. "type": "null"
  7651. }
  7652. ],
  7653. "title": "Status"
  7654. }
  7655. },
  7656. "additionalProperties": true,
  7657. "type": "object",
  7658. "required": [
  7659. "id",
  7660. "arguments",
  7661. "name",
  7662. "server_label",
  7663. "type"
  7664. ],
  7665. "title": "McpCall",
  7666. "description": "An invocation of a tool on an MCP server."
  7667. },
  7668. "McpListTools": {
  7669. "properties": {
  7670. "id": {
  7671. "type": "string",
  7672. "title": "Id"
  7673. },
  7674. "server_label": {
  7675. "type": "string",
  7676. "title": "Server Label"
  7677. },
  7678. "tools": {
  7679. "items": {
  7680. "$ref": "#/components/schemas/McpListToolsTool"
  7681. },
  7682. "type": "array",
  7683. "title": "Tools"
  7684. },
  7685. "type": {
  7686. "type": "string",
  7687. "const": "mcp_list_tools",
  7688. "title": "Type"
  7689. },
  7690. "error": {
  7691. "anyOf": [
  7692. {
  7693. "type": "string"
  7694. },
  7695. {
  7696. "type": "null"
  7697. }
  7698. ],
  7699. "title": "Error"
  7700. }
  7701. },
  7702. "additionalProperties": true,
  7703. "type": "object",
  7704. "required": [
  7705. "id",
  7706. "server_label",
  7707. "tools",
  7708. "type"
  7709. ],
  7710. "title": "McpListTools",
  7711. "description": "A list of tools available on an MCP server."
  7712. },
  7713. "McpListToolsTool": {
  7714. "properties": {
  7715. "input_schema": {
  7716. "title": "Input Schema"
  7717. },
  7718. "name": {
  7719. "type": "string",
  7720. "title": "Name"
  7721. },
  7722. "annotations": {
  7723. "anyOf": [
  7724. {},
  7725. {
  7726. "type": "null"
  7727. }
  7728. ],
  7729. "title": "Annotations"
  7730. },
  7731. "description": {
  7732. "anyOf": [
  7733. {
  7734. "type": "string"
  7735. },
  7736. {
  7737. "type": "null"
  7738. }
  7739. ],
  7740. "title": "Description"
  7741. }
  7742. },
  7743. "additionalProperties": true,
  7744. "type": "object",
  7745. "required": [
  7746. "input_schema",
  7747. "name"
  7748. ],
  7749. "title": "McpListToolsTool",
  7750. "description": "A tool available on an MCP server."
  7751. },
  7752. "McpRequireApprovalMcpToolApprovalFilter": {
  7753. "properties": {
  7754. "always": {
  7755. "anyOf": [
  7756. {
  7757. "$ref": "#/components/schemas/McpRequireApprovalMcpToolApprovalFilterAlways"
  7758. },
  7759. {
  7760. "type": "null"
  7761. }
  7762. ]
  7763. },
  7764. "never": {
  7765. "anyOf": [
  7766. {
  7767. "$ref": "#/components/schemas/McpRequireApprovalMcpToolApprovalFilterNever"
  7768. },
  7769. {
  7770. "type": "null"
  7771. }
  7772. ]
  7773. }
  7774. },
  7775. "additionalProperties": true,
  7776. "type": "object",
  7777. "title": "McpRequireApprovalMcpToolApprovalFilter",
  7778. "description": "Specify which of the MCP server's tools require approval.\n\nCan be\n`always`, `never`, or a filter object associated with tools\nthat require approval."
  7779. },
  7780. "McpRequireApprovalMcpToolApprovalFilterAlways": {
  7781. "properties": {
  7782. "read_only": {
  7783. "anyOf": [
  7784. {
  7785. "type": "boolean"
  7786. },
  7787. {
  7788. "type": "null"
  7789. }
  7790. ],
  7791. "title": "Read Only"
  7792. },
  7793. "tool_names": {
  7794. "anyOf": [
  7795. {
  7796. "items": {
  7797. "type": "string"
  7798. },
  7799. "type": "array"
  7800. },
  7801. {
  7802. "type": "null"
  7803. }
  7804. ],
  7805. "title": "Tool Names"
  7806. }
  7807. },
  7808. "additionalProperties": true,
  7809. "type": "object",
  7810. "title": "McpRequireApprovalMcpToolApprovalFilterAlways",
  7811. "description": "A filter object to specify which tools are allowed."
  7812. },
  7813. "McpRequireApprovalMcpToolApprovalFilterNever": {
  7814. "properties": {
  7815. "read_only": {
  7816. "anyOf": [
  7817. {
  7818. "type": "boolean"
  7819. },
  7820. {
  7821. "type": "null"
  7822. }
  7823. ],
  7824. "title": "Read Only"
  7825. },
  7826. "tool_names": {
  7827. "anyOf": [
  7828. {
  7829. "items": {
  7830. "type": "string"
  7831. },
  7832. "type": "array"
  7833. },
  7834. {
  7835. "type": "null"
  7836. }
  7837. ],
  7838. "title": "Tool Names"
  7839. }
  7840. },
  7841. "additionalProperties": true,
  7842. "type": "object",
  7843. "title": "McpRequireApprovalMcpToolApprovalFilterNever",
  7844. "description": "A filter object to specify which tools are allowed."
  7845. },
  7846. "Message": {
  7847. "properties": {
  7848. "author": {
  7849. "$ref": "#/components/schemas/Author"
  7850. },
  7851. "content": {
  7852. "items": {
  7853. "$ref": "#/components/schemas/Content"
  7854. },
  7855. "type": "array",
  7856. "title": "Content"
  7857. },
  7858. "channel": {
  7859. "anyOf": [
  7860. {
  7861. "type": "string"
  7862. },
  7863. {
  7864. "type": "null"
  7865. }
  7866. ],
  7867. "title": "Channel"
  7868. },
  7869. "recipient": {
  7870. "anyOf": [
  7871. {
  7872. "type": "string"
  7873. },
  7874. {
  7875. "type": "null"
  7876. }
  7877. ],
  7878. "title": "Recipient"
  7879. },
  7880. "content_type": {
  7881. "anyOf": [
  7882. {
  7883. "type": "string"
  7884. },
  7885. {
  7886. "type": "null"
  7887. }
  7888. ],
  7889. "title": "Content Type"
  7890. }
  7891. },
  7892. "type": "object",
  7893. "required": [
  7894. "author"
  7895. ],
  7896. "title": "Message"
  7897. },
  7898. "OperationCreateFile": {
  7899. "properties": {
  7900. "diff": {
  7901. "type": "string",
  7902. "title": "Diff"
  7903. },
  7904. "path": {
  7905. "type": "string",
  7906. "title": "Path"
  7907. },
  7908. "type": {
  7909. "type": "string",
  7910. "const": "create_file",
  7911. "title": "Type"
  7912. }
  7913. },
  7914. "additionalProperties": true,
  7915. "type": "object",
  7916. "required": [
  7917. "diff",
  7918. "path",
  7919. "type"
  7920. ],
  7921. "title": "OperationCreateFile",
  7922. "description": "Instruction describing how to create a file via the apply_patch tool."
  7923. },
  7924. "OperationDeleteFile": {
  7925. "properties": {
  7926. "path": {
  7927. "type": "string",
  7928. "title": "Path"
  7929. },
  7930. "type": {
  7931. "type": "string",
  7932. "const": "delete_file",
  7933. "title": "Type"
  7934. }
  7935. },
  7936. "additionalProperties": true,
  7937. "type": "object",
  7938. "required": [
  7939. "path",
  7940. "type"
  7941. ],
  7942. "title": "OperationDeleteFile",
  7943. "description": "Instruction describing how to delete a file via the apply_patch tool."
  7944. },
  7945. "OperationUpdateFile": {
  7946. "properties": {
  7947. "diff": {
  7948. "type": "string",
  7949. "title": "Diff"
  7950. },
  7951. "path": {
  7952. "type": "string",
  7953. "title": "Path"
  7954. },
  7955. "type": {
  7956. "type": "string",
  7957. "const": "update_file",
  7958. "title": "Type"
  7959. }
  7960. },
  7961. "additionalProperties": true,
  7962. "type": "object",
  7963. "required": [
  7964. "diff",
  7965. "path",
  7966. "type"
  7967. ],
  7968. "title": "OperationUpdateFile",
  7969. "description": "Instruction describing how to update a file via the apply_patch tool."
  7970. },
  7971. "OutcomeExit": {
  7972. "properties": {
  7973. "exit_code": {
  7974. "type": "integer",
  7975. "title": "Exit Code"
  7976. },
  7977. "type": {
  7978. "type": "string",
  7979. "const": "exit",
  7980. "title": "Type"
  7981. }
  7982. },
  7983. "additionalProperties": true,
  7984. "type": "object",
  7985. "required": [
  7986. "exit_code",
  7987. "type"
  7988. ],
  7989. "title": "OutcomeExit",
  7990. "description": "Indicates that the shell commands finished and returned an exit code."
  7991. },
  7992. "OutcomeTimeout": {
  7993. "properties": {
  7994. "type": {
  7995. "type": "string",
  7996. "const": "timeout",
  7997. "title": "Type"
  7998. }
  7999. },
  8000. "additionalProperties": true,
  8001. "type": "object",
  8002. "required": [
  8003. "type"
  8004. ],
  8005. "title": "OutcomeTimeout",
  8006. "description": "Indicates that the shell call exceeded its configured time limit."
  8007. },
  8008. "Output": {
  8009. "properties": {
  8010. "outcome": {
  8011. "anyOf": [
  8012. {
  8013. "$ref": "#/components/schemas/OutputOutcomeTimeout"
  8014. },
  8015. {
  8016. "$ref": "#/components/schemas/OutputOutcomeExit"
  8017. }
  8018. ],
  8019. "title": "Outcome"
  8020. },
  8021. "stderr": {
  8022. "type": "string",
  8023. "title": "Stderr"
  8024. },
  8025. "stdout": {
  8026. "type": "string",
  8027. "title": "Stdout"
  8028. },
  8029. "created_by": {
  8030. "anyOf": [
  8031. {
  8032. "type": "string"
  8033. },
  8034. {
  8035. "type": "null"
  8036. }
  8037. ],
  8038. "title": "Created By"
  8039. }
  8040. },
  8041. "additionalProperties": true,
  8042. "type": "object",
  8043. "required": [
  8044. "outcome",
  8045. "stderr",
  8046. "stdout"
  8047. ],
  8048. "title": "Output",
  8049. "description": "The content of a shell tool call output that was emitted."
  8050. },
  8051. "OutputImage": {
  8052. "properties": {
  8053. "type": {
  8054. "type": "string",
  8055. "const": "image",
  8056. "title": "Type"
  8057. },
  8058. "url": {
  8059. "type": "string",
  8060. "title": "Url"
  8061. }
  8062. },
  8063. "additionalProperties": true,
  8064. "type": "object",
  8065. "required": [
  8066. "type",
  8067. "url"
  8068. ],
  8069. "title": "OutputImage",
  8070. "description": "The image output from the code interpreter."
  8071. },
  8072. "OutputLogs": {
  8073. "properties": {
  8074. "logs": {
  8075. "type": "string",
  8076. "title": "Logs"
  8077. },
  8078. "type": {
  8079. "type": "string",
  8080. "const": "logs",
  8081. "title": "Type"
  8082. }
  8083. },
  8084. "additionalProperties": true,
  8085. "type": "object",
  8086. "required": [
  8087. "logs",
  8088. "type"
  8089. ],
  8090. "title": "OutputLogs",
  8091. "description": "The logs output from the code interpreter."
  8092. },
  8093. "OutputOutcomeExit": {
  8094. "properties": {
  8095. "exit_code": {
  8096. "type": "integer",
  8097. "title": "Exit Code"
  8098. },
  8099. "type": {
  8100. "type": "string",
  8101. "const": "exit",
  8102. "title": "Type"
  8103. }
  8104. },
  8105. "additionalProperties": true,
  8106. "type": "object",
  8107. "required": [
  8108. "exit_code",
  8109. "type"
  8110. ],
  8111. "title": "OutputOutcomeExit",
  8112. "description": "Indicates that the shell commands finished and returned an exit code."
  8113. },
  8114. "OutputOutcomeTimeout": {
  8115. "properties": {
  8116. "type": {
  8117. "type": "string",
  8118. "const": "timeout",
  8119. "title": "Type"
  8120. }
  8121. },
  8122. "additionalProperties": true,
  8123. "type": "object",
  8124. "required": [
  8125. "type"
  8126. ],
  8127. "title": "OutputOutcomeTimeout",
  8128. "description": "Indicates that the shell call exceeded its configured time limit."
  8129. },
  8130. "PendingSafetyCheck": {
  8131. "properties": {
  8132. "id": {
  8133. "type": "string",
  8134. "title": "Id"
  8135. },
  8136. "code": {
  8137. "anyOf": [
  8138. {
  8139. "type": "string"
  8140. },
  8141. {
  8142. "type": "null"
  8143. }
  8144. ],
  8145. "title": "Code"
  8146. },
  8147. "message": {
  8148. "anyOf": [
  8149. {
  8150. "type": "string"
  8151. },
  8152. {
  8153. "type": "null"
  8154. }
  8155. ],
  8156. "title": "Message"
  8157. }
  8158. },
  8159. "additionalProperties": true,
  8160. "type": "object",
  8161. "required": [
  8162. "id"
  8163. ],
  8164. "title": "PendingSafetyCheck",
  8165. "description": "A pending safety check for the computer call."
  8166. },
  8167. "PoolingChatRequest": {
  8168. "properties": {
  8169. "model": {
  8170. "anyOf": [
  8171. {
  8172. "type": "string"
  8173. },
  8174. {
  8175. "type": "null"
  8176. }
  8177. ],
  8178. "title": "Model"
  8179. },
  8180. "messages": {
  8181. "items": {
  8182. "anyOf": [
  8183. {
  8184. "$ref": "#/components/schemas/ChatCompletionDeveloperMessageParam"
  8185. },
  8186. {
  8187. "$ref": "#/components/schemas/ChatCompletionSystemMessageParam"
  8188. },
  8189. {
  8190. "$ref": "#/components/schemas/ChatCompletionUserMessageParam"
  8191. },
  8192. {
  8193. "$ref": "#/components/schemas/ChatCompletionAssistantMessageParam"
  8194. },
  8195. {
  8196. "$ref": "#/components/schemas/ChatCompletionToolMessageParam"
  8197. },
  8198. {
  8199. "$ref": "#/components/schemas/ChatCompletionFunctionMessageParam"
  8200. },
  8201. {
  8202. "$ref": "#/components/schemas/CustomChatCompletionMessageParam"
  8203. },
  8204. {
  8205. "$ref": "#/components/schemas/Message"
  8206. }
  8207. ]
  8208. },
  8209. "type": "array",
  8210. "title": "Messages"
  8211. },
  8212. "encoding_format": {
  8213. "type": "string",
  8214. "enum": [
  8215. "float",
  8216. "base64",
  8217. "bytes",
  8218. "bytes_only"
  8219. ],
  8220. "title": "Encoding Format",
  8221. "default": "float"
  8222. },
  8223. "dimensions": {
  8224. "anyOf": [
  8225. {
  8226. "type": "integer"
  8227. },
  8228. {
  8229. "type": "null"
  8230. }
  8231. ],
  8232. "title": "Dimensions"
  8233. },
  8234. "user": {
  8235. "anyOf": [
  8236. {
  8237. "type": "string"
  8238. },
  8239. {
  8240. "type": "null"
  8241. }
  8242. ],
  8243. "title": "User"
  8244. },
  8245. "truncate_prompt_tokens": {
  8246. "anyOf": [
  8247. {
  8248. "type": "integer",
  8249. "minimum": -1
  8250. },
  8251. {
  8252. "type": "null"
  8253. }
  8254. ],
  8255. "title": "Truncate Prompt Tokens"
  8256. },
  8257. "add_generation_prompt": {
  8258. "type": "boolean",
  8259. "title": "Add Generation Prompt",
  8260. "description": "If true, the generation prompt will be added to the chat template. This is a parameter used by chat template in tokenizer config of the model.",
  8261. "default": false
  8262. },
  8263. "continue_final_message": {
  8264. "type": "boolean",
  8265. "title": "Continue Final Message",
  8266. "description": "If this is set, the chat will be formatted so that the final message in the chat is open-ended, without any EOS tokens. The model will continue this message rather than starting a new one. This allows you to \"prefill\" part of the model's response for it. Cannot be used at the same time as `add_generation_prompt`.",
  8267. "default": false
  8268. },
  8269. "add_special_tokens": {
  8270. "type": "boolean",
  8271. "title": "Add Special Tokens",
  8272. "description": "If true, special tokens (e.g. BOS) will be added to the prompt on top of what is added by the chat template. For most models, the chat template takes care of adding the special tokens so this should be set to false (as is the default).",
  8273. "default": false
  8274. },
  8275. "chat_template": {
  8276. "anyOf": [
  8277. {
  8278. "type": "string"
  8279. },
  8280. {
  8281. "type": "null"
  8282. }
  8283. ],
  8284. "title": "Chat Template",
  8285. "description": "A Jinja template to use for this conversion. As of transformers v4.44, default chat template is no longer allowed, so you must provide a chat template if the tokenizer does not define one."
  8286. },
  8287. "chat_template_kwargs": {
  8288. "anyOf": [
  8289. {
  8290. "additionalProperties": true,
  8291. "type": "object"
  8292. },
  8293. {
  8294. "type": "null"
  8295. }
  8296. ],
  8297. "title": "Chat Template Kwargs",
  8298. "description": "Additional keyword args to pass to the template renderer. Will be accessible by the chat template."
  8299. },
  8300. "mm_processor_kwargs": {
  8301. "anyOf": [
  8302. {
  8303. "additionalProperties": true,
  8304. "type": "object"
  8305. },
  8306. {
  8307. "type": "null"
  8308. }
  8309. ],
  8310. "title": "Mm Processor Kwargs",
  8311. "description": "Additional kwargs to pass to the HF processor."
  8312. },
  8313. "priority": {
  8314. "type": "integer",
  8315. "title": "Priority",
  8316. "description": "The priority of the request (lower means earlier handling; default: 0). Any priority other than 0 will raise an error if the served model does not use priority scheduling.",
  8317. "default": 0
  8318. },
  8319. "request_id": {
  8320. "type": "string",
  8321. "title": "Request Id",
  8322. "description": "The request_id related to this request. If the caller does not set it, a random_uuid will be generated. This id is used through out the inference process and return in response."
  8323. },
  8324. "normalize": {
  8325. "anyOf": [
  8326. {
  8327. "type": "boolean"
  8328. },
  8329. {
  8330. "type": "null"
  8331. }
  8332. ],
  8333. "title": "Normalize",
  8334. "description": "Whether to normalize the embeddings outputs. Default is True."
  8335. },
  8336. "embed_dtype": {
  8337. "type": "string",
  8338. "enum": [
  8339. "float32",
  8340. "float16",
  8341. "bfloat16",
  8342. "fp8_e4m3",
  8343. "fp8_e5m2"
  8344. ],
  8345. "title": "Embed Dtype",
  8346. "description": "What dtype to use for encoding. Default to using float32 for base64 encoding to match the OpenAI python client behavior. This parameter will affect base64 and binary_response.",
  8347. "default": "float32"
  8348. },
  8349. "endianness": {
  8350. "type": "string",
  8351. "enum": [
  8352. "native",
  8353. "big",
  8354. "little"
  8355. ],
  8356. "title": "Endianness",
  8357. "description": "What endianness to use for encoding. Default to using native for base64 encoding to match the OpenAI python client behavior.This parameter will affect base64 and binary_response.",
  8358. "default": "native"
  8359. },
  8360. "task": {
  8361. "anyOf": [
  8362. {
  8363. "type": "string",
  8364. "enum": [
  8365. "embed",
  8366. "classify",
  8367. "score",
  8368. "token_embed",
  8369. "token_classify",
  8370. "plugin"
  8371. ]
  8372. },
  8373. {
  8374. "type": "null"
  8375. }
  8376. ],
  8377. "title": "Task"
  8378. },
  8379. "softmax": {
  8380. "anyOf": [
  8381. {
  8382. "type": "boolean"
  8383. },
  8384. {
  8385. "type": "null"
  8386. }
  8387. ],
  8388. "title": "Softmax",
  8389. "description": "softmax will be deprecated, please use use_activation instead."
  8390. },
  8391. "activation": {
  8392. "anyOf": [
  8393. {
  8394. "type": "boolean"
  8395. },
  8396. {
  8397. "type": "null"
  8398. }
  8399. ],
  8400. "title": "Activation",
  8401. "description": "activation will be deprecated, please use use_activation instead."
  8402. },
  8403. "use_activation": {
  8404. "anyOf": [
  8405. {
  8406. "type": "boolean"
  8407. },
  8408. {
  8409. "type": "null"
  8410. }
  8411. ],
  8412. "title": "Use Activation",
  8413. "description": "Whether to use activation for classification outputs. If it is a classify or token_classify task, the default is True; for other tasks, this value should be None."
  8414. }
  8415. },
  8416. "additionalProperties": true,
  8417. "type": "object",
  8418. "required": [
  8419. "messages"
  8420. ],
  8421. "title": "PoolingChatRequest"
  8422. },
  8423. "PoolingCompletionRequest": {
  8424. "properties": {
  8425. "model": {
  8426. "anyOf": [
  8427. {
  8428. "type": "string"
  8429. },
  8430. {
  8431. "type": "null"
  8432. }
  8433. ],
  8434. "title": "Model"
  8435. },
  8436. "input": {
  8437. "anyOf": [
  8438. {
  8439. "items": {
  8440. "type": "integer"
  8441. },
  8442. "type": "array"
  8443. },
  8444. {
  8445. "items": {
  8446. "items": {
  8447. "type": "integer"
  8448. },
  8449. "type": "array"
  8450. },
  8451. "type": "array"
  8452. },
  8453. {
  8454. "type": "string"
  8455. },
  8456. {
  8457. "items": {
  8458. "type": "string"
  8459. },
  8460. "type": "array"
  8461. }
  8462. ],
  8463. "title": "Input"
  8464. },
  8465. "encoding_format": {
  8466. "type": "string",
  8467. "enum": [
  8468. "float",
  8469. "base64",
  8470. "bytes",
  8471. "bytes_only"
  8472. ],
  8473. "title": "Encoding Format",
  8474. "default": "float"
  8475. },
  8476. "dimensions": {
  8477. "anyOf": [
  8478. {
  8479. "type": "integer"
  8480. },
  8481. {
  8482. "type": "null"
  8483. }
  8484. ],
  8485. "title": "Dimensions"
  8486. },
  8487. "user": {
  8488. "anyOf": [
  8489. {
  8490. "type": "string"
  8491. },
  8492. {
  8493. "type": "null"
  8494. }
  8495. ],
  8496. "title": "User"
  8497. },
  8498. "truncate_prompt_tokens": {
  8499. "anyOf": [
  8500. {
  8501. "type": "integer",
  8502. "minimum": -1
  8503. },
  8504. {
  8505. "type": "null"
  8506. }
  8507. ],
  8508. "title": "Truncate Prompt Tokens"
  8509. },
  8510. "add_special_tokens": {
  8511. "type": "boolean",
  8512. "title": "Add Special Tokens",
  8513. "description": "If true (the default), special tokens (e.g. BOS) will be added to the prompt.",
  8514. "default": true
  8515. },
  8516. "priority": {
  8517. "type": "integer",
  8518. "title": "Priority",
  8519. "description": "The priority of the request (lower means earlier handling; default: 0). Any priority other than 0 will raise an error if the served model does not use priority scheduling.",
  8520. "default": 0
  8521. },
  8522. "request_id": {
  8523. "type": "string",
  8524. "title": "Request Id",
  8525. "description": "The request_id related to this request. If the caller does not set it, a random_uuid will be generated. This id is used through out the inference process and return in response."
  8526. },
  8527. "normalize": {
  8528. "anyOf": [
  8529. {
  8530. "type": "boolean"
  8531. },
  8532. {
  8533. "type": "null"
  8534. }
  8535. ],
  8536. "title": "Normalize",
  8537. "description": "Whether to normalize the embeddings outputs. Default is True."
  8538. },
  8539. "embed_dtype": {
  8540. "type": "string",
  8541. "enum": [
  8542. "float32",
  8543. "float16",
  8544. "bfloat16",
  8545. "fp8_e4m3",
  8546. "fp8_e5m2"
  8547. ],
  8548. "title": "Embed Dtype",
  8549. "description": "What dtype to use for encoding. Default to using float32 for base64 encoding to match the OpenAI python client behavior. This parameter will affect base64 and binary_response.",
  8550. "default": "float32"
  8551. },
  8552. "endianness": {
  8553. "type": "string",
  8554. "enum": [
  8555. "native",
  8556. "big",
  8557. "little"
  8558. ],
  8559. "title": "Endianness",
  8560. "description": "What endianness to use for encoding. Default to using native for base64 encoding to match the OpenAI python client behavior.This parameter will affect base64 and binary_response.",
  8561. "default": "native"
  8562. },
  8563. "task": {
  8564. "anyOf": [
  8565. {
  8566. "type": "string",
  8567. "enum": [
  8568. "embed",
  8569. "classify",
  8570. "score",
  8571. "token_embed",
  8572. "token_classify",
  8573. "plugin"
  8574. ]
  8575. },
  8576. {
  8577. "type": "null"
  8578. }
  8579. ],
  8580. "title": "Task"
  8581. },
  8582. "softmax": {
  8583. "anyOf": [
  8584. {
  8585. "type": "boolean"
  8586. },
  8587. {
  8588. "type": "null"
  8589. }
  8590. ],
  8591. "title": "Softmax",
  8592. "description": "softmax will be deprecated, please use use_activation instead."
  8593. },
  8594. "activation": {
  8595. "anyOf": [
  8596. {
  8597. "type": "boolean"
  8598. },
  8599. {
  8600. "type": "null"
  8601. }
  8602. ],
  8603. "title": "Activation",
  8604. "description": "activation will be deprecated, please use use_activation instead."
  8605. },
  8606. "use_activation": {
  8607. "anyOf": [
  8608. {
  8609. "type": "boolean"
  8610. },
  8611. {
  8612. "type": "null"
  8613. }
  8614. ],
  8615. "title": "Use Activation",
  8616. "description": "Whether to use activation for classification outputs. If it is a classify or token_classify task, the default is True; for other tasks, this value should be None."
  8617. }
  8618. },
  8619. "additionalProperties": true,
  8620. "type": "object",
  8621. "required": [
  8622. "input"
  8623. ],
  8624. "title": "PoolingCompletionRequest"
  8625. },
  8626. "RankingOptions": {
  8627. "properties": {
  8628. "hybrid_search": {
  8629. "anyOf": [
  8630. {
  8631. "$ref": "#/components/schemas/RankingOptionsHybridSearch"
  8632. },
  8633. {
  8634. "type": "null"
  8635. }
  8636. ]
  8637. },
  8638. "ranker": {
  8639. "anyOf": [
  8640. {
  8641. "type": "string",
  8642. "enum": [
  8643. "auto",
  8644. "default-2024-11-15"
  8645. ]
  8646. },
  8647. {
  8648. "type": "null"
  8649. }
  8650. ],
  8651. "title": "Ranker"
  8652. },
  8653. "score_threshold": {
  8654. "anyOf": [
  8655. {
  8656. "type": "number"
  8657. },
  8658. {
  8659. "type": "null"
  8660. }
  8661. ],
  8662. "title": "Score Threshold"
  8663. }
  8664. },
  8665. "additionalProperties": true,
  8666. "type": "object",
  8667. "title": "RankingOptions",
  8668. "description": "Ranking options for search."
  8669. },
  8670. "RankingOptionsHybridSearch": {
  8671. "properties": {
  8672. "embedding_weight": {
  8673. "type": "number",
  8674. "title": "Embedding Weight"
  8675. },
  8676. "text_weight": {
  8677. "type": "number",
  8678. "title": "Text Weight"
  8679. }
  8680. },
  8681. "additionalProperties": true,
  8682. "type": "object",
  8683. "required": [
  8684. "embedding_weight",
  8685. "text_weight"
  8686. ],
  8687. "title": "RankingOptionsHybridSearch",
  8688. "description": "Weights that control how reciprocal rank fusion balances semantic embedding matches versus sparse keyword matches when hybrid search is enabled."
  8689. },
  8690. "Reasoning": {
  8691. "properties": {
  8692. "effort": {
  8693. "anyOf": [
  8694. {
  8695. "type": "string",
  8696. "enum": [
  8697. "none",
  8698. "minimal",
  8699. "low",
  8700. "medium",
  8701. "high",
  8702. "xhigh"
  8703. ]
  8704. },
  8705. {
  8706. "type": "null"
  8707. }
  8708. ],
  8709. "title": "Effort"
  8710. },
  8711. "generate_summary": {
  8712. "anyOf": [
  8713. {
  8714. "type": "string",
  8715. "enum": [
  8716. "auto",
  8717. "concise",
  8718. "detailed"
  8719. ]
  8720. },
  8721. {
  8722. "type": "null"
  8723. }
  8724. ],
  8725. "title": "Generate Summary"
  8726. },
  8727. "summary": {
  8728. "anyOf": [
  8729. {
  8730. "type": "string",
  8731. "enum": [
  8732. "auto",
  8733. "concise",
  8734. "detailed"
  8735. ]
  8736. },
  8737. {
  8738. "type": "null"
  8739. }
  8740. ],
  8741. "title": "Summary"
  8742. }
  8743. },
  8744. "additionalProperties": true,
  8745. "type": "object",
  8746. "title": "Reasoning",
  8747. "description": "**gpt-5 and o-series models only**\n\nConfiguration options for\n[reasoning models](https://platform.openai.com/docs/guides/reasoning)."
  8748. },
  8749. "RequestOutputKind": {
  8750. "type": "integer",
  8751. "enum": [
  8752. 0,
  8753. 1,
  8754. 2
  8755. ],
  8756. "title": "RequestOutputKind"
  8757. },
  8758. "RerankRequest": {
  8759. "properties": {
  8760. "model": {
  8761. "anyOf": [
  8762. {
  8763. "type": "string"
  8764. },
  8765. {
  8766. "type": "null"
  8767. }
  8768. ],
  8769. "title": "Model"
  8770. },
  8771. "query": {
  8772. "anyOf": [
  8773. {
  8774. "type": "string"
  8775. },
  8776. {
  8777. "$ref": "#/components/schemas/ScoreMultiModalParam"
  8778. }
  8779. ],
  8780. "title": "Query"
  8781. },
  8782. "documents": {
  8783. "anyOf": [
  8784. {
  8785. "items": {
  8786. "type": "string"
  8787. },
  8788. "type": "array"
  8789. },
  8790. {
  8791. "$ref": "#/components/schemas/ScoreMultiModalParam"
  8792. }
  8793. ],
  8794. "title": "Documents"
  8795. },
  8796. "top_n": {
  8797. "type": "integer",
  8798. "title": "Top N"
  8799. },
  8800. "truncate_prompt_tokens": {
  8801. "anyOf": [
  8802. {
  8803. "type": "integer",
  8804. "minimum": -1
  8805. },
  8806. {
  8807. "type": "null"
  8808. }
  8809. ],
  8810. "title": "Truncate Prompt Tokens"
  8811. },
  8812. "mm_processor_kwargs": {
  8813. "anyOf": [
  8814. {
  8815. "additionalProperties": true,
  8816. "type": "object"
  8817. },
  8818. {
  8819. "type": "null"
  8820. }
  8821. ],
  8822. "title": "Mm Processor Kwargs",
  8823. "description": "Additional kwargs to pass to the HF processor."
  8824. },
  8825. "priority": {
  8826. "type": "integer",
  8827. "title": "Priority",
  8828. "description": "The priority of the request (lower means earlier handling; default: 0). Any priority other than 0 will raise an error if the served model does not use priority scheduling.",
  8829. "default": 0
  8830. },
  8831. "softmax": {
  8832. "anyOf": [
  8833. {
  8834. "type": "boolean"
  8835. },
  8836. {
  8837. "type": "null"
  8838. }
  8839. ],
  8840. "title": "Softmax",
  8841. "description": "softmax will be deprecated, please use use_activation instead."
  8842. },
  8843. "activation": {
  8844. "anyOf": [
  8845. {
  8846. "type": "boolean"
  8847. },
  8848. {
  8849. "type": "null"
  8850. }
  8851. ],
  8852. "title": "Activation",
  8853. "description": "activation will be deprecated, please use use_activation instead."
  8854. },
  8855. "use_activation": {
  8856. "anyOf": [
  8857. {
  8858. "type": "boolean"
  8859. },
  8860. {
  8861. "type": "null"
  8862. }
  8863. ],
  8864. "title": "Use Activation",
  8865. "description": "Whether to use activation for classification outputs. Default is True."
  8866. }
  8867. },
  8868. "additionalProperties": true,
  8869. "type": "object",
  8870. "required": [
  8871. "query",
  8872. "documents"
  8873. ],
  8874. "title": "RerankRequest"
  8875. },
  8876. "ResponseApplyPatchToolCall": {
  8877. "properties": {
  8878. "id": {
  8879. "type": "string",
  8880. "title": "Id"
  8881. },
  8882. "call_id": {
  8883. "type": "string",
  8884. "title": "Call Id"
  8885. },
  8886. "operation": {
  8887. "anyOf": [
  8888. {
  8889. "$ref": "#/components/schemas/OperationCreateFile"
  8890. },
  8891. {
  8892. "$ref": "#/components/schemas/OperationDeleteFile"
  8893. },
  8894. {
  8895. "$ref": "#/components/schemas/OperationUpdateFile"
  8896. }
  8897. ],
  8898. "title": "Operation"
  8899. },
  8900. "status": {
  8901. "type": "string",
  8902. "enum": [
  8903. "in_progress",
  8904. "completed"
  8905. ],
  8906. "title": "Status"
  8907. },
  8908. "type": {
  8909. "type": "string",
  8910. "const": "apply_patch_call",
  8911. "title": "Type"
  8912. },
  8913. "created_by": {
  8914. "anyOf": [
  8915. {
  8916. "type": "string"
  8917. },
  8918. {
  8919. "type": "null"
  8920. }
  8921. ],
  8922. "title": "Created By"
  8923. }
  8924. },
  8925. "additionalProperties": true,
  8926. "type": "object",
  8927. "required": [
  8928. "id",
  8929. "call_id",
  8930. "operation",
  8931. "status",
  8932. "type"
  8933. ],
  8934. "title": "ResponseApplyPatchToolCall",
  8935. "description": "A tool call that applies file diffs by creating, deleting, or updating files."
  8936. },
  8937. "ResponseApplyPatchToolCallOutput": {
  8938. "properties": {
  8939. "id": {
  8940. "type": "string",
  8941. "title": "Id"
  8942. },
  8943. "call_id": {
  8944. "type": "string",
  8945. "title": "Call Id"
  8946. },
  8947. "status": {
  8948. "type": "string",
  8949. "enum": [
  8950. "completed",
  8951. "failed"
  8952. ],
  8953. "title": "Status"
  8954. },
  8955. "type": {
  8956. "type": "string",
  8957. "const": "apply_patch_call_output",
  8958. "title": "Type"
  8959. },
  8960. "created_by": {
  8961. "anyOf": [
  8962. {
  8963. "type": "string"
  8964. },
  8965. {
  8966. "type": "null"
  8967. }
  8968. ],
  8969. "title": "Created By"
  8970. },
  8971. "output": {
  8972. "anyOf": [
  8973. {
  8974. "type": "string"
  8975. },
  8976. {
  8977. "type": "null"
  8978. }
  8979. ],
  8980. "title": "Output"
  8981. }
  8982. },
  8983. "additionalProperties": true,
  8984. "type": "object",
  8985. "required": [
  8986. "id",
  8987. "call_id",
  8988. "status",
  8989. "type"
  8990. ],
  8991. "title": "ResponseApplyPatchToolCallOutput",
  8992. "description": "The output emitted by an apply patch tool call."
  8993. },
  8994. "ResponseCodeInterpreterToolCall": {
  8995. "properties": {
  8996. "id": {
  8997. "type": "string",
  8998. "title": "Id"
  8999. },
  9000. "code": {
  9001. "anyOf": [
  9002. {
  9003. "type": "string"
  9004. },
  9005. {
  9006. "type": "null"
  9007. }
  9008. ],
  9009. "title": "Code"
  9010. },
  9011. "container_id": {
  9012. "type": "string",
  9013. "title": "Container Id"
  9014. },
  9015. "outputs": {
  9016. "anyOf": [
  9017. {
  9018. "items": {
  9019. "anyOf": [
  9020. {
  9021. "$ref": "#/components/schemas/OutputLogs"
  9022. },
  9023. {
  9024. "$ref": "#/components/schemas/OutputImage"
  9025. }
  9026. ]
  9027. },
  9028. "type": "array"
  9029. },
  9030. {
  9031. "type": "null"
  9032. }
  9033. ],
  9034. "title": "Outputs"
  9035. },
  9036. "status": {
  9037. "type": "string",
  9038. "enum": [
  9039. "in_progress",
  9040. "completed",
  9041. "incomplete",
  9042. "interpreting",
  9043. "failed"
  9044. ],
  9045. "title": "Status"
  9046. },
  9047. "type": {
  9048. "type": "string",
  9049. "const": "code_interpreter_call",
  9050. "title": "Type"
  9051. }
  9052. },
  9053. "additionalProperties": true,
  9054. "type": "object",
  9055. "required": [
  9056. "id",
  9057. "container_id",
  9058. "status",
  9059. "type"
  9060. ],
  9061. "title": "ResponseCodeInterpreterToolCall",
  9062. "description": "A tool call to run code."
  9063. },
  9064. "ResponseCodeInterpreterToolCallParam": {
  9065. "properties": {
  9066. "id": {
  9067. "type": "string",
  9068. "title": "Id"
  9069. },
  9070. "code": {
  9071. "anyOf": [
  9072. {
  9073. "type": "string"
  9074. },
  9075. {
  9076. "type": "null"
  9077. }
  9078. ],
  9079. "title": "Code"
  9080. },
  9081. "container_id": {
  9082. "type": "string",
  9083. "title": "Container Id"
  9084. },
  9085. "outputs": {
  9086. "anyOf": [
  9087. {
  9088. "items": {
  9089. "anyOf": [
  9090. {
  9091. "$ref": "#/components/schemas/OutputLogs"
  9092. },
  9093. {
  9094. "$ref": "#/components/schemas/OutputImage"
  9095. }
  9096. ]
  9097. },
  9098. "type": "array"
  9099. },
  9100. {
  9101. "type": "null"
  9102. }
  9103. ],
  9104. "title": "Outputs"
  9105. },
  9106. "status": {
  9107. "type": "string",
  9108. "enum": [
  9109. "in_progress",
  9110. "completed",
  9111. "incomplete",
  9112. "interpreting",
  9113. "failed"
  9114. ],
  9115. "title": "Status"
  9116. },
  9117. "type": {
  9118. "type": "string",
  9119. "const": "code_interpreter_call",
  9120. "title": "Type"
  9121. }
  9122. },
  9123. "additionalProperties": true,
  9124. "type": "object",
  9125. "required": [
  9126. "id",
  9127. "code",
  9128. "container_id",
  9129. "outputs",
  9130. "status",
  9131. "type"
  9132. ],
  9133. "title": "ResponseCodeInterpreterToolCallParam",
  9134. "description": "A tool call to run code."
  9135. },
  9136. "ResponseCompactionItem": {
  9137. "properties": {
  9138. "id": {
  9139. "type": "string",
  9140. "title": "Id"
  9141. },
  9142. "encrypted_content": {
  9143. "type": "string",
  9144. "title": "Encrypted Content"
  9145. },
  9146. "type": {
  9147. "type": "string",
  9148. "const": "compaction",
  9149. "title": "Type"
  9150. },
  9151. "created_by": {
  9152. "anyOf": [
  9153. {
  9154. "type": "string"
  9155. },
  9156. {
  9157. "type": "null"
  9158. }
  9159. ],
  9160. "title": "Created By"
  9161. }
  9162. },
  9163. "additionalProperties": true,
  9164. "type": "object",
  9165. "required": [
  9166. "id",
  9167. "encrypted_content",
  9168. "type"
  9169. ],
  9170. "title": "ResponseCompactionItem",
  9171. "description": "A compaction item generated by the [`v1/responses/compact` API](https://platform.openai.com/docs/api-reference/responses/compact)."
  9172. },
  9173. "ResponseCompactionItemParamParam": {
  9174. "properties": {
  9175. "encrypted_content": {
  9176. "type": "string",
  9177. "title": "Encrypted Content"
  9178. },
  9179. "type": {
  9180. "type": "string",
  9181. "const": "compaction",
  9182. "title": "Type"
  9183. },
  9184. "id": {
  9185. "anyOf": [
  9186. {
  9187. "type": "string"
  9188. },
  9189. {
  9190. "type": "null"
  9191. }
  9192. ],
  9193. "title": "Id"
  9194. }
  9195. },
  9196. "additionalProperties": true,
  9197. "type": "object",
  9198. "required": [
  9199. "encrypted_content",
  9200. "type"
  9201. ],
  9202. "title": "ResponseCompactionItemParamParam",
  9203. "description": "A compaction item generated by the [`v1/responses/compact` API](https://platform.openai.com/docs/api-reference/responses/compact)."
  9204. },
  9205. "ResponseComputerToolCall": {
  9206. "properties": {
  9207. "id": {
  9208. "type": "string",
  9209. "title": "Id"
  9210. },
  9211. "action": {
  9212. "anyOf": [
  9213. {
  9214. "$ref": "#/components/schemas/ActionClick"
  9215. },
  9216. {
  9217. "$ref": "#/components/schemas/ActionDoubleClick"
  9218. },
  9219. {
  9220. "$ref": "#/components/schemas/ActionDrag"
  9221. },
  9222. {
  9223. "$ref": "#/components/schemas/ActionKeypress"
  9224. },
  9225. {
  9226. "$ref": "#/components/schemas/ActionMove"
  9227. },
  9228. {
  9229. "$ref": "#/components/schemas/ActionScreenshot"
  9230. },
  9231. {
  9232. "$ref": "#/components/schemas/ActionScroll"
  9233. },
  9234. {
  9235. "$ref": "#/components/schemas/ActionType"
  9236. },
  9237. {
  9238. "$ref": "#/components/schemas/ActionWait"
  9239. }
  9240. ],
  9241. "title": "Action"
  9242. },
  9243. "call_id": {
  9244. "type": "string",
  9245. "title": "Call Id"
  9246. },
  9247. "pending_safety_checks": {
  9248. "items": {
  9249. "$ref": "#/components/schemas/PendingSafetyCheck"
  9250. },
  9251. "type": "array",
  9252. "title": "Pending Safety Checks"
  9253. },
  9254. "status": {
  9255. "type": "string",
  9256. "enum": [
  9257. "in_progress",
  9258. "completed",
  9259. "incomplete"
  9260. ],
  9261. "title": "Status"
  9262. },
  9263. "type": {
  9264. "type": "string",
  9265. "const": "computer_call",
  9266. "title": "Type"
  9267. }
  9268. },
  9269. "additionalProperties": true,
  9270. "type": "object",
  9271. "required": [
  9272. "id",
  9273. "action",
  9274. "call_id",
  9275. "pending_safety_checks",
  9276. "status",
  9277. "type"
  9278. ],
  9279. "title": "ResponseComputerToolCall",
  9280. "description": "A tool call to a computer use tool.\n\nSee the\n[computer use guide](https://platform.openai.com/docs/guides/tools-computer-use) for more information."
  9281. },
  9282. "ResponseComputerToolCallOutputScreenshotParam": {
  9283. "properties": {
  9284. "type": {
  9285. "type": "string",
  9286. "const": "computer_screenshot",
  9287. "title": "Type"
  9288. },
  9289. "file_id": {
  9290. "type": "string",
  9291. "title": "File Id"
  9292. },
  9293. "image_url": {
  9294. "type": "string",
  9295. "title": "Image Url"
  9296. }
  9297. },
  9298. "additionalProperties": true,
  9299. "type": "object",
  9300. "required": [
  9301. "type"
  9302. ],
  9303. "title": "ResponseComputerToolCallOutputScreenshotParam",
  9304. "description": "A computer screenshot image used with the computer use tool."
  9305. },
  9306. "ResponseComputerToolCallParam": {
  9307. "properties": {
  9308. "id": {
  9309. "type": "string",
  9310. "title": "Id"
  9311. },
  9312. "action": {
  9313. "anyOf": [
  9314. {
  9315. "$ref": "#/components/schemas/ActionClick"
  9316. },
  9317. {
  9318. "$ref": "#/components/schemas/ActionDoubleClick"
  9319. },
  9320. {
  9321. "$ref": "#/components/schemas/ActionDrag"
  9322. },
  9323. {
  9324. "$ref": "#/components/schemas/ActionKeypress"
  9325. },
  9326. {
  9327. "$ref": "#/components/schemas/ActionMove"
  9328. },
  9329. {
  9330. "$ref": "#/components/schemas/ActionScreenshot"
  9331. },
  9332. {
  9333. "$ref": "#/components/schemas/ActionScroll"
  9334. },
  9335. {
  9336. "$ref": "#/components/schemas/ActionType"
  9337. },
  9338. {
  9339. "$ref": "#/components/schemas/ActionWait"
  9340. }
  9341. ],
  9342. "title": "Action"
  9343. },
  9344. "call_id": {
  9345. "type": "string",
  9346. "title": "Call Id"
  9347. },
  9348. "pending_safety_checks": {
  9349. "items": {
  9350. "$ref": "#/components/schemas/openai__types__responses__response_computer_tool_call_param__PendingSafetyCheck"
  9351. },
  9352. "type": "array",
  9353. "title": "Pending Safety Checks"
  9354. },
  9355. "status": {
  9356. "type": "string",
  9357. "enum": [
  9358. "in_progress",
  9359. "completed",
  9360. "incomplete"
  9361. ],
  9362. "title": "Status"
  9363. },
  9364. "type": {
  9365. "type": "string",
  9366. "const": "computer_call",
  9367. "title": "Type"
  9368. }
  9369. },
  9370. "additionalProperties": true,
  9371. "type": "object",
  9372. "required": [
  9373. "id",
  9374. "action",
  9375. "call_id",
  9376. "pending_safety_checks",
  9377. "status",
  9378. "type"
  9379. ],
  9380. "title": "ResponseComputerToolCallParam",
  9381. "description": "A tool call to a computer use tool.\n\nSee the\n[computer use guide](https://platform.openai.com/docs/guides/tools-computer-use) for more information."
  9382. },
  9383. "ResponseCustomToolCall": {
  9384. "properties": {
  9385. "call_id": {
  9386. "type": "string",
  9387. "title": "Call Id"
  9388. },
  9389. "input": {
  9390. "type": "string",
  9391. "title": "Input"
  9392. },
  9393. "name": {
  9394. "type": "string",
  9395. "title": "Name"
  9396. },
  9397. "type": {
  9398. "type": "string",
  9399. "const": "custom_tool_call",
  9400. "title": "Type"
  9401. },
  9402. "id": {
  9403. "anyOf": [
  9404. {
  9405. "type": "string"
  9406. },
  9407. {
  9408. "type": "null"
  9409. }
  9410. ],
  9411. "title": "Id"
  9412. }
  9413. },
  9414. "additionalProperties": true,
  9415. "type": "object",
  9416. "required": [
  9417. "call_id",
  9418. "input",
  9419. "name",
  9420. "type"
  9421. ],
  9422. "title": "ResponseCustomToolCall",
  9423. "description": "A call to a custom tool created by the model."
  9424. },
  9425. "ResponseCustomToolCallOutputParam": {
  9426. "properties": {
  9427. "call_id": {
  9428. "type": "string",
  9429. "title": "Call Id"
  9430. },
  9431. "output": {
  9432. "anyOf": [
  9433. {
  9434. "type": "string"
  9435. },
  9436. {
  9437. "items": {
  9438. "anyOf": [
  9439. {
  9440. "$ref": "#/components/schemas/ResponseInputTextParam"
  9441. },
  9442. {
  9443. "$ref": "#/components/schemas/ResponseInputImageParam"
  9444. },
  9445. {
  9446. "$ref": "#/components/schemas/ResponseInputFileParam"
  9447. }
  9448. ]
  9449. },
  9450. "type": "array"
  9451. }
  9452. ],
  9453. "title": "Output"
  9454. },
  9455. "type": {
  9456. "type": "string",
  9457. "const": "custom_tool_call_output",
  9458. "title": "Type"
  9459. },
  9460. "id": {
  9461. "type": "string",
  9462. "title": "Id"
  9463. }
  9464. },
  9465. "additionalProperties": true,
  9466. "type": "object",
  9467. "required": [
  9468. "call_id",
  9469. "output",
  9470. "type"
  9471. ],
  9472. "title": "ResponseCustomToolCallOutputParam",
  9473. "description": "The output of a custom tool call from your code, being sent back to the model."
  9474. },
  9475. "ResponseCustomToolCallParam": {
  9476. "properties": {
  9477. "call_id": {
  9478. "type": "string",
  9479. "title": "Call Id"
  9480. },
  9481. "input": {
  9482. "type": "string",
  9483. "title": "Input"
  9484. },
  9485. "name": {
  9486. "type": "string",
  9487. "title": "Name"
  9488. },
  9489. "type": {
  9490. "type": "string",
  9491. "const": "custom_tool_call",
  9492. "title": "Type"
  9493. },
  9494. "id": {
  9495. "type": "string",
  9496. "title": "Id"
  9497. }
  9498. },
  9499. "additionalProperties": true,
  9500. "type": "object",
  9501. "required": [
  9502. "call_id",
  9503. "input",
  9504. "name",
  9505. "type"
  9506. ],
  9507. "title": "ResponseCustomToolCallParam",
  9508. "description": "A call to a custom tool created by the model."
  9509. },
  9510. "ResponseFileSearchToolCall": {
  9511. "properties": {
  9512. "id": {
  9513. "type": "string",
  9514. "title": "Id"
  9515. },
  9516. "queries": {
  9517. "items": {
  9518. "type": "string"
  9519. },
  9520. "type": "array",
  9521. "title": "Queries"
  9522. },
  9523. "status": {
  9524. "type": "string",
  9525. "enum": [
  9526. "in_progress",
  9527. "searching",
  9528. "completed",
  9529. "incomplete",
  9530. "failed"
  9531. ],
  9532. "title": "Status"
  9533. },
  9534. "type": {
  9535. "type": "string",
  9536. "const": "file_search_call",
  9537. "title": "Type"
  9538. },
  9539. "results": {
  9540. "anyOf": [
  9541. {
  9542. "items": {
  9543. "$ref": "#/components/schemas/Result"
  9544. },
  9545. "type": "array"
  9546. },
  9547. {
  9548. "type": "null"
  9549. }
  9550. ],
  9551. "title": "Results"
  9552. }
  9553. },
  9554. "additionalProperties": true,
  9555. "type": "object",
  9556. "required": [
  9557. "id",
  9558. "queries",
  9559. "status",
  9560. "type"
  9561. ],
  9562. "title": "ResponseFileSearchToolCall",
  9563. "description": "The results of a file search tool call.\n\nSee the\n[file search guide](https://platform.openai.com/docs/guides/tools-file-search) for more information."
  9564. },
  9565. "ResponseFileSearchToolCallParam": {
  9566. "properties": {
  9567. "id": {
  9568. "type": "string",
  9569. "title": "Id"
  9570. },
  9571. "queries": {
  9572. "items": {
  9573. "type": "string"
  9574. },
  9575. "type": "array",
  9576. "title": "Queries"
  9577. },
  9578. "status": {
  9579. "type": "string",
  9580. "enum": [
  9581. "in_progress",
  9582. "searching",
  9583. "completed",
  9584. "incomplete",
  9585. "failed"
  9586. ],
  9587. "title": "Status"
  9588. },
  9589. "type": {
  9590. "type": "string",
  9591. "const": "file_search_call",
  9592. "title": "Type"
  9593. },
  9594. "results": {
  9595. "anyOf": [
  9596. {
  9597. "items": {
  9598. "$ref": "#/components/schemas/openai__types__responses__response_file_search_tool_call_param__Result"
  9599. },
  9600. "type": "array"
  9601. },
  9602. {
  9603. "type": "null"
  9604. }
  9605. ],
  9606. "title": "Results"
  9607. }
  9608. },
  9609. "additionalProperties": true,
  9610. "type": "object",
  9611. "required": [
  9612. "id",
  9613. "queries",
  9614. "status",
  9615. "type"
  9616. ],
  9617. "title": "ResponseFileSearchToolCallParam",
  9618. "description": "The results of a file search tool call.\n\nSee the\n[file search guide](https://platform.openai.com/docs/guides/tools-file-search) for more information."
  9619. },
  9620. "ResponseFormat": {
  9621. "properties": {
  9622. "type": {
  9623. "type": "string",
  9624. "enum": [
  9625. "text",
  9626. "json_object",
  9627. "json_schema"
  9628. ],
  9629. "title": "Type"
  9630. },
  9631. "json_schema": {
  9632. "anyOf": [
  9633. {
  9634. "$ref": "#/components/schemas/JsonSchemaResponseFormat"
  9635. },
  9636. {
  9637. "type": "null"
  9638. }
  9639. ]
  9640. }
  9641. },
  9642. "additionalProperties": true,
  9643. "type": "object",
  9644. "required": [
  9645. "type"
  9646. ],
  9647. "title": "ResponseFormat"
  9648. },
  9649. "ResponseFormatJSONObject": {
  9650. "properties": {
  9651. "type": {
  9652. "type": "string",
  9653. "const": "json_object",
  9654. "title": "Type"
  9655. }
  9656. },
  9657. "additionalProperties": true,
  9658. "type": "object",
  9659. "required": [
  9660. "type"
  9661. ],
  9662. "title": "ResponseFormatJSONObject",
  9663. "description": "JSON object response format.\n\nAn older method of generating JSON responses.\nUsing `json_schema` is recommended for models that support it. Note that the\nmodel will not generate JSON without a system or user message instructing it\nto do so."
  9664. },
  9665. "ResponseFormatText": {
  9666. "properties": {
  9667. "type": {
  9668. "type": "string",
  9669. "const": "text",
  9670. "title": "Type"
  9671. }
  9672. },
  9673. "additionalProperties": true,
  9674. "type": "object",
  9675. "required": [
  9676. "type"
  9677. ],
  9678. "title": "ResponseFormatText",
  9679. "description": "Default response format. Used to generate text responses."
  9680. },
  9681. "ResponseFormatTextJSONSchemaConfig": {
  9682. "properties": {
  9683. "name": {
  9684. "type": "string",
  9685. "title": "Name"
  9686. },
  9687. "schema": {
  9688. "additionalProperties": true,
  9689. "type": "object",
  9690. "title": "Schema"
  9691. },
  9692. "type": {
  9693. "type": "string",
  9694. "const": "json_schema",
  9695. "title": "Type"
  9696. },
  9697. "description": {
  9698. "anyOf": [
  9699. {
  9700. "type": "string"
  9701. },
  9702. {
  9703. "type": "null"
  9704. }
  9705. ],
  9706. "title": "Description"
  9707. },
  9708. "strict": {
  9709. "anyOf": [
  9710. {
  9711. "type": "boolean"
  9712. },
  9713. {
  9714. "type": "null"
  9715. }
  9716. ],
  9717. "title": "Strict"
  9718. }
  9719. },
  9720. "additionalProperties": true,
  9721. "type": "object",
  9722. "required": [
  9723. "name",
  9724. "schema",
  9725. "type"
  9726. ],
  9727. "title": "ResponseFormatTextJSONSchemaConfig",
  9728. "description": "JSON Schema response format.\n\nUsed to generate structured JSON responses.\nLearn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs)."
  9729. },
  9730. "ResponseFunctionShellCallOutputContentParam": {
  9731. "properties": {
  9732. "outcome": {
  9733. "anyOf": [
  9734. {
  9735. "$ref": "#/components/schemas/OutcomeTimeout"
  9736. },
  9737. {
  9738. "$ref": "#/components/schemas/OutcomeExit"
  9739. }
  9740. ],
  9741. "title": "Outcome"
  9742. },
  9743. "stderr": {
  9744. "type": "string",
  9745. "title": "Stderr"
  9746. },
  9747. "stdout": {
  9748. "type": "string",
  9749. "title": "Stdout"
  9750. }
  9751. },
  9752. "additionalProperties": true,
  9753. "type": "object",
  9754. "required": [
  9755. "outcome",
  9756. "stderr",
  9757. "stdout"
  9758. ],
  9759. "title": "ResponseFunctionShellCallOutputContentParam",
  9760. "description": "Captured stdout and stderr for a portion of a shell tool call output."
  9761. },
  9762. "ResponseFunctionShellToolCall": {
  9763. "properties": {
  9764. "id": {
  9765. "type": "string",
  9766. "title": "Id"
  9767. },
  9768. "action": {
  9769. "$ref": "#/components/schemas/Action"
  9770. },
  9771. "call_id": {
  9772. "type": "string",
  9773. "title": "Call Id"
  9774. },
  9775. "status": {
  9776. "type": "string",
  9777. "enum": [
  9778. "in_progress",
  9779. "completed",
  9780. "incomplete"
  9781. ],
  9782. "title": "Status"
  9783. },
  9784. "type": {
  9785. "type": "string",
  9786. "const": "shell_call",
  9787. "title": "Type"
  9788. },
  9789. "created_by": {
  9790. "anyOf": [
  9791. {
  9792. "type": "string"
  9793. },
  9794. {
  9795. "type": "null"
  9796. }
  9797. ],
  9798. "title": "Created By"
  9799. }
  9800. },
  9801. "additionalProperties": true,
  9802. "type": "object",
  9803. "required": [
  9804. "id",
  9805. "action",
  9806. "call_id",
  9807. "status",
  9808. "type"
  9809. ],
  9810. "title": "ResponseFunctionShellToolCall",
  9811. "description": "A tool call that executes one or more shell commands in a managed environment."
  9812. },
  9813. "ResponseFunctionShellToolCallOutput": {
  9814. "properties": {
  9815. "id": {
  9816. "type": "string",
  9817. "title": "Id"
  9818. },
  9819. "call_id": {
  9820. "type": "string",
  9821. "title": "Call Id"
  9822. },
  9823. "max_output_length": {
  9824. "anyOf": [
  9825. {
  9826. "type": "integer"
  9827. },
  9828. {
  9829. "type": "null"
  9830. }
  9831. ],
  9832. "title": "Max Output Length"
  9833. },
  9834. "output": {
  9835. "items": {
  9836. "$ref": "#/components/schemas/Output"
  9837. },
  9838. "type": "array",
  9839. "title": "Output"
  9840. },
  9841. "status": {
  9842. "type": "string",
  9843. "enum": [
  9844. "in_progress",
  9845. "completed",
  9846. "incomplete"
  9847. ],
  9848. "title": "Status"
  9849. },
  9850. "type": {
  9851. "type": "string",
  9852. "const": "shell_call_output",
  9853. "title": "Type"
  9854. },
  9855. "created_by": {
  9856. "anyOf": [
  9857. {
  9858. "type": "string"
  9859. },
  9860. {
  9861. "type": "null"
  9862. }
  9863. ],
  9864. "title": "Created By"
  9865. }
  9866. },
  9867. "additionalProperties": true,
  9868. "type": "object",
  9869. "required": [
  9870. "id",
  9871. "call_id",
  9872. "output",
  9873. "status",
  9874. "type"
  9875. ],
  9876. "title": "ResponseFunctionShellToolCallOutput",
  9877. "description": "The output of a shell tool call that was emitted."
  9878. },
  9879. "ResponseFunctionToolCall": {
  9880. "properties": {
  9881. "arguments": {
  9882. "type": "string",
  9883. "title": "Arguments"
  9884. },
  9885. "call_id": {
  9886. "type": "string",
  9887. "title": "Call Id"
  9888. },
  9889. "name": {
  9890. "type": "string",
  9891. "title": "Name"
  9892. },
  9893. "type": {
  9894. "type": "string",
  9895. "const": "function_call",
  9896. "title": "Type"
  9897. },
  9898. "id": {
  9899. "anyOf": [
  9900. {
  9901. "type": "string"
  9902. },
  9903. {
  9904. "type": "null"
  9905. }
  9906. ],
  9907. "title": "Id"
  9908. },
  9909. "status": {
  9910. "anyOf": [
  9911. {
  9912. "type": "string",
  9913. "enum": [
  9914. "in_progress",
  9915. "completed",
  9916. "incomplete"
  9917. ]
  9918. },
  9919. {
  9920. "type": "null"
  9921. }
  9922. ],
  9923. "title": "Status"
  9924. }
  9925. },
  9926. "additionalProperties": true,
  9927. "type": "object",
  9928. "required": [
  9929. "arguments",
  9930. "call_id",
  9931. "name",
  9932. "type"
  9933. ],
  9934. "title": "ResponseFunctionToolCall",
  9935. "description": "A tool call to run a function.\n\nSee the\n[function calling guide](https://platform.openai.com/docs/guides/function-calling) for more information."
  9936. },
  9937. "ResponseFunctionToolCallParam": {
  9938. "properties": {
  9939. "arguments": {
  9940. "type": "string",
  9941. "title": "Arguments"
  9942. },
  9943. "call_id": {
  9944. "type": "string",
  9945. "title": "Call Id"
  9946. },
  9947. "name": {
  9948. "type": "string",
  9949. "title": "Name"
  9950. },
  9951. "type": {
  9952. "type": "string",
  9953. "const": "function_call",
  9954. "title": "Type"
  9955. },
  9956. "id": {
  9957. "type": "string",
  9958. "title": "Id"
  9959. },
  9960. "status": {
  9961. "type": "string",
  9962. "enum": [
  9963. "in_progress",
  9964. "completed",
  9965. "incomplete"
  9966. ],
  9967. "title": "Status"
  9968. }
  9969. },
  9970. "additionalProperties": true,
  9971. "type": "object",
  9972. "required": [
  9973. "arguments",
  9974. "call_id",
  9975. "name",
  9976. "type"
  9977. ],
  9978. "title": "ResponseFunctionToolCallParam",
  9979. "description": "A tool call to run a function.\n\nSee the\n[function calling guide](https://platform.openai.com/docs/guides/function-calling) for more information."
  9980. },
  9981. "ResponseFunctionWebSearch": {
  9982. "properties": {
  9983. "id": {
  9984. "type": "string",
  9985. "title": "Id"
  9986. },
  9987. "action": {
  9988. "anyOf": [
  9989. {
  9990. "$ref": "#/components/schemas/ActionSearch"
  9991. },
  9992. {
  9993. "$ref": "#/components/schemas/ActionOpenPage"
  9994. },
  9995. {
  9996. "$ref": "#/components/schemas/ActionFind"
  9997. }
  9998. ],
  9999. "title": "Action"
  10000. },
  10001. "status": {
  10002. "type": "string",
  10003. "enum": [
  10004. "in_progress",
  10005. "searching",
  10006. "completed",
  10007. "failed"
  10008. ],
  10009. "title": "Status"
  10010. },
  10011. "type": {
  10012. "type": "string",
  10013. "const": "web_search_call",
  10014. "title": "Type"
  10015. }
  10016. },
  10017. "additionalProperties": true,
  10018. "type": "object",
  10019. "required": [
  10020. "id",
  10021. "action",
  10022. "status",
  10023. "type"
  10024. ],
  10025. "title": "ResponseFunctionWebSearch",
  10026. "description": "The results of a web search tool call.\n\nSee the\n[web search guide](https://platform.openai.com/docs/guides/tools-web-search) for more information."
  10027. },
  10028. "ResponseFunctionWebSearchParam": {
  10029. "properties": {
  10030. "id": {
  10031. "type": "string",
  10032. "title": "Id"
  10033. },
  10034. "action": {
  10035. "anyOf": [
  10036. {
  10037. "$ref": "#/components/schemas/openai__types__responses__response_function_web_search_param__ActionSearch"
  10038. },
  10039. {
  10040. "$ref": "#/components/schemas/ActionOpenPage"
  10041. },
  10042. {
  10043. "$ref": "#/components/schemas/ActionFind"
  10044. }
  10045. ],
  10046. "title": "Action"
  10047. },
  10048. "status": {
  10049. "type": "string",
  10050. "enum": [
  10051. "in_progress",
  10052. "searching",
  10053. "completed",
  10054. "failed"
  10055. ],
  10056. "title": "Status"
  10057. },
  10058. "type": {
  10059. "type": "string",
  10060. "const": "web_search_call",
  10061. "title": "Type"
  10062. }
  10063. },
  10064. "additionalProperties": true,
  10065. "type": "object",
  10066. "required": [
  10067. "id",
  10068. "action",
  10069. "status",
  10070. "type"
  10071. ],
  10072. "title": "ResponseFunctionWebSearchParam",
  10073. "description": "The results of a web search tool call.\n\nSee the\n[web search guide](https://platform.openai.com/docs/guides/tools-web-search) for more information."
  10074. },
  10075. "ResponseInputFile": {
  10076. "properties": {
  10077. "type": {
  10078. "type": "string",
  10079. "const": "input_file",
  10080. "title": "Type"
  10081. },
  10082. "file_data": {
  10083. "anyOf": [
  10084. {
  10085. "type": "string"
  10086. },
  10087. {
  10088. "type": "null"
  10089. }
  10090. ],
  10091. "title": "File Data"
  10092. },
  10093. "file_id": {
  10094. "anyOf": [
  10095. {
  10096. "type": "string"
  10097. },
  10098. {
  10099. "type": "null"
  10100. }
  10101. ],
  10102. "title": "File Id"
  10103. },
  10104. "file_url": {
  10105. "anyOf": [
  10106. {
  10107. "type": "string"
  10108. },
  10109. {
  10110. "type": "null"
  10111. }
  10112. ],
  10113. "title": "File Url"
  10114. },
  10115. "filename": {
  10116. "anyOf": [
  10117. {
  10118. "type": "string"
  10119. },
  10120. {
  10121. "type": "null"
  10122. }
  10123. ],
  10124. "title": "Filename"
  10125. }
  10126. },
  10127. "additionalProperties": true,
  10128. "type": "object",
  10129. "required": [
  10130. "type"
  10131. ],
  10132. "title": "ResponseInputFile",
  10133. "description": "A file input to the model."
  10134. },
  10135. "ResponseInputFileContentParam": {
  10136. "properties": {
  10137. "type": {
  10138. "type": "string",
  10139. "const": "input_file",
  10140. "title": "Type"
  10141. },
  10142. "file_data": {
  10143. "anyOf": [
  10144. {
  10145. "type": "string"
  10146. },
  10147. {
  10148. "type": "null"
  10149. }
  10150. ],
  10151. "title": "File Data"
  10152. },
  10153. "file_id": {
  10154. "anyOf": [
  10155. {
  10156. "type": "string"
  10157. },
  10158. {
  10159. "type": "null"
  10160. }
  10161. ],
  10162. "title": "File Id"
  10163. },
  10164. "file_url": {
  10165. "anyOf": [
  10166. {
  10167. "type": "string"
  10168. },
  10169. {
  10170. "type": "null"
  10171. }
  10172. ],
  10173. "title": "File Url"
  10174. },
  10175. "filename": {
  10176. "anyOf": [
  10177. {
  10178. "type": "string"
  10179. },
  10180. {
  10181. "type": "null"
  10182. }
  10183. ],
  10184. "title": "Filename"
  10185. }
  10186. },
  10187. "additionalProperties": true,
  10188. "type": "object",
  10189. "required": [
  10190. "type"
  10191. ],
  10192. "title": "ResponseInputFileContentParam",
  10193. "description": "A file input to the model."
  10194. },
  10195. "ResponseInputFileParam": {
  10196. "properties": {
  10197. "type": {
  10198. "type": "string",
  10199. "const": "input_file",
  10200. "title": "Type"
  10201. },
  10202. "file_data": {
  10203. "type": "string",
  10204. "title": "File Data"
  10205. },
  10206. "file_id": {
  10207. "anyOf": [
  10208. {
  10209. "type": "string"
  10210. },
  10211. {
  10212. "type": "null"
  10213. }
  10214. ],
  10215. "title": "File Id"
  10216. },
  10217. "file_url": {
  10218. "type": "string",
  10219. "title": "File Url"
  10220. },
  10221. "filename": {
  10222. "type": "string",
  10223. "title": "Filename"
  10224. }
  10225. },
  10226. "additionalProperties": true,
  10227. "type": "object",
  10228. "required": [
  10229. "type"
  10230. ],
  10231. "title": "ResponseInputFileParam",
  10232. "description": "A file input to the model."
  10233. },
  10234. "ResponseInputImage": {
  10235. "properties": {
  10236. "detail": {
  10237. "type": "string",
  10238. "enum": [
  10239. "low",
  10240. "high",
  10241. "auto"
  10242. ],
  10243. "title": "Detail"
  10244. },
  10245. "type": {
  10246. "type": "string",
  10247. "const": "input_image",
  10248. "title": "Type"
  10249. },
  10250. "file_id": {
  10251. "anyOf": [
  10252. {
  10253. "type": "string"
  10254. },
  10255. {
  10256. "type": "null"
  10257. }
  10258. ],
  10259. "title": "File Id"
  10260. },
  10261. "image_url": {
  10262. "anyOf": [
  10263. {
  10264. "type": "string"
  10265. },
  10266. {
  10267. "type": "null"
  10268. }
  10269. ],
  10270. "title": "Image Url"
  10271. }
  10272. },
  10273. "additionalProperties": true,
  10274. "type": "object",
  10275. "required": [
  10276. "detail",
  10277. "type"
  10278. ],
  10279. "title": "ResponseInputImage",
  10280. "description": "An image input to the model.\n\nLearn about [image inputs](https://platform.openai.com/docs/guides/vision)."
  10281. },
  10282. "ResponseInputImageContentParam": {
  10283. "properties": {
  10284. "type": {
  10285. "type": "string",
  10286. "const": "input_image",
  10287. "title": "Type"
  10288. },
  10289. "detail": {
  10290. "anyOf": [
  10291. {
  10292. "type": "string",
  10293. "enum": [
  10294. "low",
  10295. "high",
  10296. "auto"
  10297. ]
  10298. },
  10299. {
  10300. "type": "null"
  10301. }
  10302. ],
  10303. "title": "Detail"
  10304. },
  10305. "file_id": {
  10306. "anyOf": [
  10307. {
  10308. "type": "string"
  10309. },
  10310. {
  10311. "type": "null"
  10312. }
  10313. ],
  10314. "title": "File Id"
  10315. },
  10316. "image_url": {
  10317. "anyOf": [
  10318. {
  10319. "type": "string"
  10320. },
  10321. {
  10322. "type": "null"
  10323. }
  10324. ],
  10325. "title": "Image Url"
  10326. }
  10327. },
  10328. "additionalProperties": true,
  10329. "type": "object",
  10330. "required": [
  10331. "type"
  10332. ],
  10333. "title": "ResponseInputImageContentParam",
  10334. "description": "An image input to the model.\n\nLearn about [image inputs](https://platform.openai.com/docs/guides/vision)"
  10335. },
  10336. "ResponseInputImageParam": {
  10337. "properties": {
  10338. "detail": {
  10339. "type": "string",
  10340. "enum": [
  10341. "low",
  10342. "high",
  10343. "auto"
  10344. ],
  10345. "title": "Detail"
  10346. },
  10347. "type": {
  10348. "type": "string",
  10349. "const": "input_image",
  10350. "title": "Type"
  10351. },
  10352. "file_id": {
  10353. "anyOf": [
  10354. {
  10355. "type": "string"
  10356. },
  10357. {
  10358. "type": "null"
  10359. }
  10360. ],
  10361. "title": "File Id"
  10362. },
  10363. "image_url": {
  10364. "anyOf": [
  10365. {
  10366. "type": "string"
  10367. },
  10368. {
  10369. "type": "null"
  10370. }
  10371. ],
  10372. "title": "Image Url"
  10373. }
  10374. },
  10375. "additionalProperties": true,
  10376. "type": "object",
  10377. "required": [
  10378. "detail",
  10379. "type"
  10380. ],
  10381. "title": "ResponseInputImageParam",
  10382. "description": "An image input to the model.\n\nLearn about [image inputs](https://platform.openai.com/docs/guides/vision)."
  10383. },
  10384. "ResponseInputText": {
  10385. "properties": {
  10386. "text": {
  10387. "type": "string",
  10388. "title": "Text"
  10389. },
  10390. "type": {
  10391. "type": "string",
  10392. "const": "input_text",
  10393. "title": "Type"
  10394. }
  10395. },
  10396. "additionalProperties": true,
  10397. "type": "object",
  10398. "required": [
  10399. "text",
  10400. "type"
  10401. ],
  10402. "title": "ResponseInputText",
  10403. "description": "A text input to the model."
  10404. },
  10405. "ResponseInputTextContentParam": {
  10406. "properties": {
  10407. "text": {
  10408. "type": "string",
  10409. "title": "Text"
  10410. },
  10411. "type": {
  10412. "type": "string",
  10413. "const": "input_text",
  10414. "title": "Type"
  10415. }
  10416. },
  10417. "additionalProperties": true,
  10418. "type": "object",
  10419. "required": [
  10420. "text",
  10421. "type"
  10422. ],
  10423. "title": "ResponseInputTextContentParam",
  10424. "description": "A text input to the model."
  10425. },
  10426. "ResponseInputTextParam": {
  10427. "properties": {
  10428. "text": {
  10429. "type": "string",
  10430. "title": "Text"
  10431. },
  10432. "type": {
  10433. "type": "string",
  10434. "const": "input_text",
  10435. "title": "Type"
  10436. }
  10437. },
  10438. "additionalProperties": true,
  10439. "type": "object",
  10440. "required": [
  10441. "text",
  10442. "type"
  10443. ],
  10444. "title": "ResponseInputTextParam",
  10445. "description": "A text input to the model."
  10446. },
  10447. "ResponseOutputMessage": {
  10448. "properties": {
  10449. "id": {
  10450. "type": "string",
  10451. "title": "Id"
  10452. },
  10453. "content": {
  10454. "items": {
  10455. "anyOf": [
  10456. {
  10457. "$ref": "#/components/schemas/ResponseOutputText"
  10458. },
  10459. {
  10460. "$ref": "#/components/schemas/ResponseOutputRefusal"
  10461. }
  10462. ]
  10463. },
  10464. "type": "array",
  10465. "title": "Content"
  10466. },
  10467. "role": {
  10468. "type": "string",
  10469. "const": "assistant",
  10470. "title": "Role"
  10471. },
  10472. "status": {
  10473. "type": "string",
  10474. "enum": [
  10475. "in_progress",
  10476. "completed",
  10477. "incomplete"
  10478. ],
  10479. "title": "Status"
  10480. },
  10481. "type": {
  10482. "type": "string",
  10483. "const": "message",
  10484. "title": "Type"
  10485. }
  10486. },
  10487. "additionalProperties": true,
  10488. "type": "object",
  10489. "required": [
  10490. "id",
  10491. "content",
  10492. "role",
  10493. "status",
  10494. "type"
  10495. ],
  10496. "title": "ResponseOutputMessage",
  10497. "description": "An output message from the model."
  10498. },
  10499. "ResponseOutputMessageParam": {
  10500. "properties": {
  10501. "id": {
  10502. "type": "string",
  10503. "title": "Id"
  10504. },
  10505. "content": {
  10506. "items": {
  10507. "anyOf": [
  10508. {
  10509. "$ref": "#/components/schemas/ResponseOutputTextParam"
  10510. },
  10511. {
  10512. "$ref": "#/components/schemas/ResponseOutputRefusalParam"
  10513. }
  10514. ]
  10515. },
  10516. "type": "array",
  10517. "title": "Content"
  10518. },
  10519. "role": {
  10520. "type": "string",
  10521. "const": "assistant",
  10522. "title": "Role"
  10523. },
  10524. "status": {
  10525. "type": "string",
  10526. "enum": [
  10527. "in_progress",
  10528. "completed",
  10529. "incomplete"
  10530. ],
  10531. "title": "Status"
  10532. },
  10533. "type": {
  10534. "type": "string",
  10535. "const": "message",
  10536. "title": "Type"
  10537. }
  10538. },
  10539. "additionalProperties": true,
  10540. "type": "object",
  10541. "required": [
  10542. "id",
  10543. "content",
  10544. "role",
  10545. "status",
  10546. "type"
  10547. ],
  10548. "title": "ResponseOutputMessageParam",
  10549. "description": "An output message from the model."
  10550. },
  10551. "ResponseOutputRefusal": {
  10552. "properties": {
  10553. "refusal": {
  10554. "type": "string",
  10555. "title": "Refusal"
  10556. },
  10557. "type": {
  10558. "type": "string",
  10559. "const": "refusal",
  10560. "title": "Type"
  10561. }
  10562. },
  10563. "additionalProperties": true,
  10564. "type": "object",
  10565. "required": [
  10566. "refusal",
  10567. "type"
  10568. ],
  10569. "title": "ResponseOutputRefusal",
  10570. "description": "A refusal from the model."
  10571. },
  10572. "ResponseOutputRefusalParam": {
  10573. "properties": {
  10574. "refusal": {
  10575. "type": "string",
  10576. "title": "Refusal"
  10577. },
  10578. "type": {
  10579. "type": "string",
  10580. "const": "refusal",
  10581. "title": "Type"
  10582. }
  10583. },
  10584. "additionalProperties": true,
  10585. "type": "object",
  10586. "required": [
  10587. "refusal",
  10588. "type"
  10589. ],
  10590. "title": "ResponseOutputRefusalParam",
  10591. "description": "A refusal from the model."
  10592. },
  10593. "ResponseOutputText": {
  10594. "properties": {
  10595. "annotations": {
  10596. "items": {
  10597. "anyOf": [
  10598. {
  10599. "$ref": "#/components/schemas/AnnotationFileCitation"
  10600. },
  10601. {
  10602. "$ref": "#/components/schemas/AnnotationURLCitation"
  10603. },
  10604. {
  10605. "$ref": "#/components/schemas/AnnotationContainerFileCitation"
  10606. },
  10607. {
  10608. "$ref": "#/components/schemas/AnnotationFilePath"
  10609. }
  10610. ]
  10611. },
  10612. "type": "array",
  10613. "title": "Annotations"
  10614. },
  10615. "text": {
  10616. "type": "string",
  10617. "title": "Text"
  10618. },
  10619. "type": {
  10620. "type": "string",
  10621. "const": "output_text",
  10622. "title": "Type"
  10623. },
  10624. "logprobs": {
  10625. "anyOf": [
  10626. {
  10627. "items": {
  10628. "$ref": "#/components/schemas/Logprob"
  10629. },
  10630. "type": "array"
  10631. },
  10632. {
  10633. "type": "null"
  10634. }
  10635. ],
  10636. "title": "Logprobs"
  10637. }
  10638. },
  10639. "additionalProperties": true,
  10640. "type": "object",
  10641. "required": [
  10642. "annotations",
  10643. "text",
  10644. "type"
  10645. ],
  10646. "title": "ResponseOutputText",
  10647. "description": "A text output from the model."
  10648. },
  10649. "ResponseOutputTextParam": {
  10650. "properties": {
  10651. "annotations": {
  10652. "items": {
  10653. "anyOf": [
  10654. {
  10655. "$ref": "#/components/schemas/AnnotationFileCitation"
  10656. },
  10657. {
  10658. "$ref": "#/components/schemas/AnnotationURLCitation"
  10659. },
  10660. {
  10661. "$ref": "#/components/schemas/AnnotationContainerFileCitation"
  10662. },
  10663. {
  10664. "$ref": "#/components/schemas/AnnotationFilePath"
  10665. }
  10666. ]
  10667. },
  10668. "type": "array",
  10669. "title": "Annotations"
  10670. },
  10671. "text": {
  10672. "type": "string",
  10673. "title": "Text"
  10674. },
  10675. "type": {
  10676. "type": "string",
  10677. "const": "output_text",
  10678. "title": "Type"
  10679. },
  10680. "logprobs": {
  10681. "items": {
  10682. "$ref": "#/components/schemas/Logprob"
  10683. },
  10684. "type": "array",
  10685. "title": "Logprobs"
  10686. }
  10687. },
  10688. "additionalProperties": true,
  10689. "type": "object",
  10690. "required": [
  10691. "annotations",
  10692. "text",
  10693. "type"
  10694. ],
  10695. "title": "ResponseOutputTextParam",
  10696. "description": "A text output from the model."
  10697. },
  10698. "ResponsePrompt": {
  10699. "properties": {
  10700. "id": {
  10701. "type": "string",
  10702. "title": "Id"
  10703. },
  10704. "variables": {
  10705. "anyOf": [
  10706. {
  10707. "additionalProperties": {
  10708. "anyOf": [
  10709. {
  10710. "type": "string"
  10711. },
  10712. {
  10713. "$ref": "#/components/schemas/ResponseInputText"
  10714. },
  10715. {
  10716. "$ref": "#/components/schemas/ResponseInputImage"
  10717. },
  10718. {
  10719. "$ref": "#/components/schemas/ResponseInputFile"
  10720. }
  10721. ]
  10722. },
  10723. "type": "object"
  10724. },
  10725. {
  10726. "type": "null"
  10727. }
  10728. ],
  10729. "title": "Variables"
  10730. },
  10731. "version": {
  10732. "anyOf": [
  10733. {
  10734. "type": "string"
  10735. },
  10736. {
  10737. "type": "null"
  10738. }
  10739. ],
  10740. "title": "Version"
  10741. }
  10742. },
  10743. "additionalProperties": true,
  10744. "type": "object",
  10745. "required": [
  10746. "id"
  10747. ],
  10748. "title": "ResponsePrompt",
  10749. "description": "Reference to a prompt template and its variables.\n[Learn more](https://platform.openai.com/docs/guides/text?api-mode=responses#reusable-prompts)."
  10750. },
  10751. "ResponseReasoningItem": {
  10752. "properties": {
  10753. "id": {
  10754. "type": "string",
  10755. "title": "Id"
  10756. },
  10757. "summary": {
  10758. "items": {
  10759. "$ref": "#/components/schemas/Summary"
  10760. },
  10761. "type": "array",
  10762. "title": "Summary"
  10763. },
  10764. "type": {
  10765. "type": "string",
  10766. "const": "reasoning",
  10767. "title": "Type"
  10768. },
  10769. "content": {
  10770. "anyOf": [
  10771. {
  10772. "items": {
  10773. "$ref": "#/components/schemas/openai__types__responses__response_reasoning_item__Content"
  10774. },
  10775. "type": "array"
  10776. },
  10777. {
  10778. "type": "null"
  10779. }
  10780. ],
  10781. "title": "Content"
  10782. },
  10783. "encrypted_content": {
  10784. "anyOf": [
  10785. {
  10786. "type": "string"
  10787. },
  10788. {
  10789. "type": "null"
  10790. }
  10791. ],
  10792. "title": "Encrypted Content"
  10793. },
  10794. "status": {
  10795. "anyOf": [
  10796. {
  10797. "type": "string",
  10798. "enum": [
  10799. "in_progress",
  10800. "completed",
  10801. "incomplete"
  10802. ]
  10803. },
  10804. {
  10805. "type": "null"
  10806. }
  10807. ],
  10808. "title": "Status"
  10809. }
  10810. },
  10811. "additionalProperties": true,
  10812. "type": "object",
  10813. "required": [
  10814. "id",
  10815. "summary",
  10816. "type"
  10817. ],
  10818. "title": "ResponseReasoningItem",
  10819. "description": "A description of the chain of thought used by a reasoning model while generating\na response. Be sure to include these items in your `input` to the Responses API\nfor subsequent turns of a conversation if you are manually\n[managing context](https://platform.openai.com/docs/guides/conversation-state)."
  10820. },
  10821. "ResponseReasoningItemParam": {
  10822. "properties": {
  10823. "id": {
  10824. "type": "string",
  10825. "title": "Id"
  10826. },
  10827. "summary": {
  10828. "items": {
  10829. "$ref": "#/components/schemas/Summary"
  10830. },
  10831. "type": "array",
  10832. "title": "Summary"
  10833. },
  10834. "type": {
  10835. "type": "string",
  10836. "const": "reasoning",
  10837. "title": "Type"
  10838. },
  10839. "content": {
  10840. "items": {
  10841. "$ref": "#/components/schemas/openai__types__responses__response_reasoning_item_param__Content"
  10842. },
  10843. "type": "array",
  10844. "title": "Content"
  10845. },
  10846. "encrypted_content": {
  10847. "anyOf": [
  10848. {
  10849. "type": "string"
  10850. },
  10851. {
  10852. "type": "null"
  10853. }
  10854. ],
  10855. "title": "Encrypted Content"
  10856. },
  10857. "status": {
  10858. "type": "string",
  10859. "enum": [
  10860. "in_progress",
  10861. "completed",
  10862. "incomplete"
  10863. ],
  10864. "title": "Status"
  10865. }
  10866. },
  10867. "additionalProperties": true,
  10868. "type": "object",
  10869. "required": [
  10870. "id",
  10871. "summary",
  10872. "type"
  10873. ],
  10874. "title": "ResponseReasoningItemParam",
  10875. "description": "A description of the chain of thought used by a reasoning model while generating\na response. Be sure to include these items in your `input` to the Responses API\nfor subsequent turns of a conversation if you are manually\n[managing context](https://platform.openai.com/docs/guides/conversation-state)."
  10876. },
  10877. "ResponseTextConfig": {
  10878. "properties": {
  10879. "format": {
  10880. "anyOf": [
  10881. {
  10882. "$ref": "#/components/schemas/ResponseFormatText"
  10883. },
  10884. {
  10885. "$ref": "#/components/schemas/ResponseFormatTextJSONSchemaConfig"
  10886. },
  10887. {
  10888. "$ref": "#/components/schemas/ResponseFormatJSONObject"
  10889. },
  10890. {
  10891. "type": "null"
  10892. }
  10893. ],
  10894. "title": "Format"
  10895. },
  10896. "verbosity": {
  10897. "anyOf": [
  10898. {
  10899. "type": "string",
  10900. "enum": [
  10901. "low",
  10902. "medium",
  10903. "high"
  10904. ]
  10905. },
  10906. {
  10907. "type": "null"
  10908. }
  10909. ],
  10910. "title": "Verbosity"
  10911. }
  10912. },
  10913. "additionalProperties": true,
  10914. "type": "object",
  10915. "title": "ResponseTextConfig",
  10916. "description": "Configuration options for a text response from the model.\n\nCan be plain\ntext or structured JSON data. Learn more:\n- [Text inputs and outputs](https://platform.openai.com/docs/guides/text)\n- [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs)"
  10917. },
  10918. "ResponsesRequest": {
  10919. "properties": {
  10920. "background": {
  10921. "anyOf": [
  10922. {
  10923. "type": "boolean"
  10924. },
  10925. {
  10926. "type": "null"
  10927. }
  10928. ],
  10929. "title": "Background",
  10930. "default": false
  10931. },
  10932. "include": {
  10933. "anyOf": [
  10934. {
  10935. "items": {
  10936. "type": "string",
  10937. "enum": [
  10938. "code_interpreter_call.outputs",
  10939. "computer_call_output.output.image_url",
  10940. "file_search_call.results",
  10941. "message.input_image.image_url",
  10942. "message.output_text.logprobs",
  10943. "reasoning.encrypted_content"
  10944. ]
  10945. },
  10946. "type": "array"
  10947. },
  10948. {
  10949. "type": "null"
  10950. }
  10951. ],
  10952. "title": "Include"
  10953. },
  10954. "input": {
  10955. "anyOf": [
  10956. {
  10957. "type": "string"
  10958. },
  10959. {
  10960. "items": {
  10961. "anyOf": [
  10962. {
  10963. "$ref": "#/components/schemas/EasyInputMessageParam"
  10964. },
  10965. {
  10966. "$ref": "#/components/schemas/openai__types__responses__response_input_item_param__Message"
  10967. },
  10968. {
  10969. "$ref": "#/components/schemas/ResponseOutputMessageParam"
  10970. },
  10971. {
  10972. "$ref": "#/components/schemas/ResponseFileSearchToolCallParam"
  10973. },
  10974. {
  10975. "$ref": "#/components/schemas/ResponseComputerToolCallParam"
  10976. },
  10977. {
  10978. "$ref": "#/components/schemas/ComputerCallOutput"
  10979. },
  10980. {
  10981. "$ref": "#/components/schemas/ResponseFunctionWebSearchParam"
  10982. },
  10983. {
  10984. "$ref": "#/components/schemas/ResponseFunctionToolCallParam"
  10985. },
  10986. {
  10987. "$ref": "#/components/schemas/FunctionCallOutput"
  10988. },
  10989. {
  10990. "$ref": "#/components/schemas/ResponseReasoningItemParam"
  10991. },
  10992. {
  10993. "$ref": "#/components/schemas/ResponseCompactionItemParamParam"
  10994. },
  10995. {
  10996. "$ref": "#/components/schemas/openai__types__responses__response_input_item_param__ImageGenerationCall"
  10997. },
  10998. {
  10999. "$ref": "#/components/schemas/ResponseCodeInterpreterToolCallParam"
  11000. },
  11001. {
  11002. "$ref": "#/components/schemas/openai__types__responses__response_input_item_param__LocalShellCall"
  11003. },
  11004. {
  11005. "$ref": "#/components/schemas/LocalShellCallOutput"
  11006. },
  11007. {
  11008. "$ref": "#/components/schemas/ShellCall"
  11009. },
  11010. {
  11011. "$ref": "#/components/schemas/ShellCallOutput"
  11012. },
  11013. {
  11014. "$ref": "#/components/schemas/ApplyPatchCall"
  11015. },
  11016. {
  11017. "$ref": "#/components/schemas/ApplyPatchCallOutput"
  11018. },
  11019. {
  11020. "$ref": "#/components/schemas/openai__types__responses__response_input_item_param__McpListTools"
  11021. },
  11022. {
  11023. "$ref": "#/components/schemas/McpApprovalRequest"
  11024. },
  11025. {
  11026. "$ref": "#/components/schemas/McpApprovalResponse"
  11027. },
  11028. {
  11029. "$ref": "#/components/schemas/openai__types__responses__response_input_item_param__McpCall"
  11030. },
  11031. {
  11032. "$ref": "#/components/schemas/ResponseCustomToolCallOutputParam"
  11033. },
  11034. {
  11035. "$ref": "#/components/schemas/ResponseCustomToolCallParam"
  11036. },
  11037. {
  11038. "$ref": "#/components/schemas/ItemReference"
  11039. },
  11040. {
  11041. "$ref": "#/components/schemas/ResponseOutputMessage"
  11042. },
  11043. {
  11044. "$ref": "#/components/schemas/ResponseFileSearchToolCall"
  11045. },
  11046. {
  11047. "$ref": "#/components/schemas/ResponseFunctionToolCall"
  11048. },
  11049. {
  11050. "$ref": "#/components/schemas/ResponseFunctionWebSearch"
  11051. },
  11052. {
  11053. "$ref": "#/components/schemas/ResponseComputerToolCall"
  11054. },
  11055. {
  11056. "$ref": "#/components/schemas/ResponseReasoningItem"
  11057. },
  11058. {
  11059. "$ref": "#/components/schemas/ResponseCompactionItem"
  11060. },
  11061. {
  11062. "$ref": "#/components/schemas/ImageGenerationCall"
  11063. },
  11064. {
  11065. "$ref": "#/components/schemas/ResponseCodeInterpreterToolCall"
  11066. },
  11067. {
  11068. "$ref": "#/components/schemas/LocalShellCall"
  11069. },
  11070. {
  11071. "$ref": "#/components/schemas/ResponseFunctionShellToolCall"
  11072. },
  11073. {
  11074. "$ref": "#/components/schemas/ResponseFunctionShellToolCallOutput"
  11075. },
  11076. {
  11077. "$ref": "#/components/schemas/ResponseApplyPatchToolCall"
  11078. },
  11079. {
  11080. "$ref": "#/components/schemas/ResponseApplyPatchToolCallOutput"
  11081. },
  11082. {
  11083. "$ref": "#/components/schemas/McpCall"
  11084. },
  11085. {
  11086. "$ref": "#/components/schemas/McpListTools"
  11087. },
  11088. {
  11089. "$ref": "#/components/schemas/McpApprovalRequest"
  11090. },
  11091. {
  11092. "$ref": "#/components/schemas/ResponseCustomToolCall"
  11093. }
  11094. ]
  11095. },
  11096. "type": "array"
  11097. }
  11098. ],
  11099. "title": "Input"
  11100. },
  11101. "instructions": {
  11102. "anyOf": [
  11103. {
  11104. "type": "string"
  11105. },
  11106. {
  11107. "type": "null"
  11108. }
  11109. ],
  11110. "title": "Instructions"
  11111. },
  11112. "max_output_tokens": {
  11113. "anyOf": [
  11114. {
  11115. "type": "integer"
  11116. },
  11117. {
  11118. "type": "null"
  11119. }
  11120. ],
  11121. "title": "Max Output Tokens"
  11122. },
  11123. "max_tool_calls": {
  11124. "anyOf": [
  11125. {
  11126. "type": "integer"
  11127. },
  11128. {
  11129. "type": "null"
  11130. }
  11131. ],
  11132. "title": "Max Tool Calls"
  11133. },
  11134. "metadata": {
  11135. "anyOf": [
  11136. {
  11137. "additionalProperties": {
  11138. "type": "string"
  11139. },
  11140. "type": "object"
  11141. },
  11142. {
  11143. "type": "null"
  11144. }
  11145. ],
  11146. "title": "Metadata"
  11147. },
  11148. "model": {
  11149. "anyOf": [
  11150. {
  11151. "type": "string"
  11152. },
  11153. {
  11154. "type": "null"
  11155. }
  11156. ],
  11157. "title": "Model"
  11158. },
  11159. "logit_bias": {
  11160. "anyOf": [
  11161. {
  11162. "additionalProperties": {
  11163. "type": "number"
  11164. },
  11165. "type": "object"
  11166. },
  11167. {
  11168. "type": "null"
  11169. }
  11170. ],
  11171. "title": "Logit Bias"
  11172. },
  11173. "parallel_tool_calls": {
  11174. "anyOf": [
  11175. {
  11176. "type": "boolean"
  11177. },
  11178. {
  11179. "type": "null"
  11180. }
  11181. ],
  11182. "title": "Parallel Tool Calls",
  11183. "default": true
  11184. },
  11185. "previous_response_id": {
  11186. "anyOf": [
  11187. {
  11188. "type": "string"
  11189. },
  11190. {
  11191. "type": "null"
  11192. }
  11193. ],
  11194. "title": "Previous Response Id"
  11195. },
  11196. "prompt": {
  11197. "anyOf": [
  11198. {
  11199. "$ref": "#/components/schemas/ResponsePrompt"
  11200. },
  11201. {
  11202. "type": "null"
  11203. }
  11204. ]
  11205. },
  11206. "reasoning": {
  11207. "anyOf": [
  11208. {
  11209. "$ref": "#/components/schemas/Reasoning"
  11210. },
  11211. {
  11212. "type": "null"
  11213. }
  11214. ]
  11215. },
  11216. "service_tier": {
  11217. "type": "string",
  11218. "enum": [
  11219. "auto",
  11220. "default",
  11221. "flex",
  11222. "scale",
  11223. "priority"
  11224. ],
  11225. "title": "Service Tier",
  11226. "default": "auto"
  11227. },
  11228. "store": {
  11229. "anyOf": [
  11230. {
  11231. "type": "boolean"
  11232. },
  11233. {
  11234. "type": "null"
  11235. }
  11236. ],
  11237. "title": "Store",
  11238. "default": true
  11239. },
  11240. "stream": {
  11241. "anyOf": [
  11242. {
  11243. "type": "boolean"
  11244. },
  11245. {
  11246. "type": "null"
  11247. }
  11248. ],
  11249. "title": "Stream",
  11250. "default": false
  11251. },
  11252. "temperature": {
  11253. "anyOf": [
  11254. {
  11255. "type": "number"
  11256. },
  11257. {
  11258. "type": "null"
  11259. }
  11260. ],
  11261. "title": "Temperature"
  11262. },
  11263. "text": {
  11264. "anyOf": [
  11265. {
  11266. "$ref": "#/components/schemas/ResponseTextConfig"
  11267. },
  11268. {
  11269. "type": "null"
  11270. }
  11271. ]
  11272. },
  11273. "tool_choice": {
  11274. "anyOf": [
  11275. {
  11276. "type": "string",
  11277. "enum": [
  11278. "none",
  11279. "auto",
  11280. "required"
  11281. ]
  11282. },
  11283. {
  11284. "$ref": "#/components/schemas/ToolChoiceAllowed"
  11285. },
  11286. {
  11287. "$ref": "#/components/schemas/ToolChoiceTypes"
  11288. },
  11289. {
  11290. "$ref": "#/components/schemas/ToolChoiceFunction"
  11291. },
  11292. {
  11293. "$ref": "#/components/schemas/ToolChoiceMcp"
  11294. },
  11295. {
  11296. "$ref": "#/components/schemas/ToolChoiceCustom"
  11297. },
  11298. {
  11299. "$ref": "#/components/schemas/ToolChoiceApplyPatch"
  11300. },
  11301. {
  11302. "$ref": "#/components/schemas/ToolChoiceShell"
  11303. }
  11304. ],
  11305. "title": "Tool Choice",
  11306. "default": "auto"
  11307. },
  11308. "tools": {
  11309. "items": {
  11310. "anyOf": [
  11311. {
  11312. "$ref": "#/components/schemas/FunctionTool"
  11313. },
  11314. {
  11315. "$ref": "#/components/schemas/FileSearchTool"
  11316. },
  11317. {
  11318. "$ref": "#/components/schemas/ComputerTool"
  11319. },
  11320. {
  11321. "$ref": "#/components/schemas/WebSearchTool"
  11322. },
  11323. {
  11324. "$ref": "#/components/schemas/Mcp"
  11325. },
  11326. {
  11327. "$ref": "#/components/schemas/CodeInterpreter"
  11328. },
  11329. {
  11330. "$ref": "#/components/schemas/ImageGeneration"
  11331. },
  11332. {
  11333. "$ref": "#/components/schemas/LocalShell"
  11334. },
  11335. {
  11336. "$ref": "#/components/schemas/FunctionShellTool"
  11337. },
  11338. {
  11339. "$ref": "#/components/schemas/CustomTool"
  11340. },
  11341. {
  11342. "$ref": "#/components/schemas/WebSearchPreviewTool"
  11343. },
  11344. {
  11345. "$ref": "#/components/schemas/ApplyPatchTool"
  11346. }
  11347. ]
  11348. },
  11349. "type": "array",
  11350. "title": "Tools"
  11351. },
  11352. "top_logprobs": {
  11353. "anyOf": [
  11354. {
  11355. "type": "integer"
  11356. },
  11357. {
  11358. "type": "null"
  11359. }
  11360. ],
  11361. "title": "Top Logprobs",
  11362. "default": 0
  11363. },
  11364. "top_p": {
  11365. "anyOf": [
  11366. {
  11367. "type": "number"
  11368. },
  11369. {
  11370. "type": "null"
  11371. }
  11372. ],
  11373. "title": "Top P"
  11374. },
  11375. "top_k": {
  11376. "anyOf": [
  11377. {
  11378. "type": "integer"
  11379. },
  11380. {
  11381. "type": "null"
  11382. }
  11383. ],
  11384. "title": "Top K"
  11385. },
  11386. "truncation": {
  11387. "anyOf": [
  11388. {
  11389. "type": "string",
  11390. "enum": [
  11391. "auto",
  11392. "disabled"
  11393. ]
  11394. },
  11395. {
  11396. "type": "null"
  11397. }
  11398. ],
  11399. "title": "Truncation",
  11400. "default": "disabled"
  11401. },
  11402. "user": {
  11403. "anyOf": [
  11404. {
  11405. "type": "string"
  11406. },
  11407. {
  11408. "type": "null"
  11409. }
  11410. ],
  11411. "title": "User"
  11412. },
  11413. "request_id": {
  11414. "type": "string",
  11415. "title": "Request Id",
  11416. "description": "The request_id related to this request. If the caller does not set it, a random_uuid will be generated. This id is used through out the inference process and return in response."
  11417. },
  11418. "mm_processor_kwargs": {
  11419. "anyOf": [
  11420. {
  11421. "additionalProperties": true,
  11422. "type": "object"
  11423. },
  11424. {
  11425. "type": "null"
  11426. }
  11427. ],
  11428. "title": "Mm Processor Kwargs",
  11429. "description": "Additional kwargs to pass to the HF processor."
  11430. },
  11431. "priority": {
  11432. "type": "integer",
  11433. "title": "Priority",
  11434. "description": "The priority of the request (lower means earlier handling; default: 0). Any priority other than 0 will raise an error if the served model does not use priority scheduling.",
  11435. "default": 0
  11436. },
  11437. "cache_salt": {
  11438. "anyOf": [
  11439. {
  11440. "type": "string"
  11441. },
  11442. {
  11443. "type": "null"
  11444. }
  11445. ],
  11446. "title": "Cache Salt",
  11447. "description": "If specified, the prefix cache will be salted with the provided string to prevent an attacker to guess prompts in multi-user environments. The salt should be random, protected from access by 3rd parties, and long enough to be unpredictable (e.g., 43 characters base64-encoded, corresponding to 256 bit)."
  11448. },
  11449. "enable_response_messages": {
  11450. "type": "boolean",
  11451. "title": "Enable Response Messages",
  11452. "description": "Dictates whether or not to return messages as part of the response object. Currently only supported fornon-background and gpt-oss only. ",
  11453. "default": false
  11454. },
  11455. "previous_input_messages": {
  11456. "anyOf": [
  11457. {
  11458. "items": {
  11459. "anyOf": [
  11460. {
  11461. "$ref": "#/components/schemas/Message"
  11462. },
  11463. {
  11464. "additionalProperties": true,
  11465. "type": "object"
  11466. }
  11467. ]
  11468. },
  11469. "type": "array"
  11470. },
  11471. {
  11472. "type": "null"
  11473. }
  11474. ],
  11475. "title": "Previous Input Messages"
  11476. }
  11477. },
  11478. "additionalProperties": true,
  11479. "type": "object",
  11480. "required": [
  11481. "input"
  11482. ],
  11483. "title": "ResponsesRequest"
  11484. },
  11485. "Result": {
  11486. "properties": {
  11487. "attributes": {
  11488. "anyOf": [
  11489. {
  11490. "additionalProperties": {
  11491. "anyOf": [
  11492. {
  11493. "type": "string"
  11494. },
  11495. {
  11496. "type": "number"
  11497. },
  11498. {
  11499. "type": "boolean"
  11500. }
  11501. ]
  11502. },
  11503. "type": "object"
  11504. },
  11505. {
  11506. "type": "null"
  11507. }
  11508. ],
  11509. "title": "Attributes"
  11510. },
  11511. "file_id": {
  11512. "anyOf": [
  11513. {
  11514. "type": "string"
  11515. },
  11516. {
  11517. "type": "null"
  11518. }
  11519. ],
  11520. "title": "File Id"
  11521. },
  11522. "filename": {
  11523. "anyOf": [
  11524. {
  11525. "type": "string"
  11526. },
  11527. {
  11528. "type": "null"
  11529. }
  11530. ],
  11531. "title": "Filename"
  11532. },
  11533. "score": {
  11534. "anyOf": [
  11535. {
  11536. "type": "number"
  11537. },
  11538. {
  11539. "type": "null"
  11540. }
  11541. ],
  11542. "title": "Score"
  11543. },
  11544. "text": {
  11545. "anyOf": [
  11546. {
  11547. "type": "string"
  11548. },
  11549. {
  11550. "type": "null"
  11551. }
  11552. ],
  11553. "title": "Text"
  11554. }
  11555. },
  11556. "additionalProperties": true,
  11557. "type": "object",
  11558. "title": "Result"
  11559. },
  11560. "Role": {
  11561. "type": "string",
  11562. "enum": [
  11563. "user",
  11564. "assistant",
  11565. "system",
  11566. "developer",
  11567. "tool"
  11568. ],
  11569. "title": "Role",
  11570. "description": "The role of a message author (mirrors ``chat::Role``)."
  11571. },
  11572. "ScoreMultiModalParam": {
  11573. "properties": {
  11574. "content": {
  11575. "items": {
  11576. "anyOf": [
  11577. {
  11578. "$ref": "#/components/schemas/ChatCompletionContentPartImageParam"
  11579. },
  11580. {
  11581. "$ref": "#/components/schemas/ChatCompletionContentPartImageEmbedsParam"
  11582. },
  11583. {
  11584. "$ref": "#/components/schemas/ChatCompletionContentPartTextParam"
  11585. },
  11586. {
  11587. "$ref": "#/components/schemas/ChatCompletionContentPartVideoParam"
  11588. }
  11589. ]
  11590. },
  11591. "type": "array",
  11592. "title": "Content"
  11593. }
  11594. },
  11595. "additionalProperties": true,
  11596. "type": "object",
  11597. "required": [
  11598. "content"
  11599. ],
  11600. "title": "ScoreMultiModalParam",
  11601. "description": "A specialized parameter type for scoring multimodal content\n\nThe reasons why don't reuse `CustomChatCompletionMessageParam` directly:\n1. Score tasks don't need the 'role' field (user/assistant/system) that's required in chat completions\n2. Including chat-specific fields would confuse users about their purpose in scoring\n3. This is a more focused interface that only exposes what's needed for scoring"
  11602. },
  11603. "ScoreRequest": {
  11604. "properties": {
  11605. "model": {
  11606. "anyOf": [
  11607. {
  11608. "type": "string"
  11609. },
  11610. {
  11611. "type": "null"
  11612. }
  11613. ],
  11614. "title": "Model"
  11615. },
  11616. "text_1": {
  11617. "anyOf": [
  11618. {
  11619. "items": {
  11620. "type": "string"
  11621. },
  11622. "type": "array"
  11623. },
  11624. {
  11625. "type": "string"
  11626. },
  11627. {
  11628. "$ref": "#/components/schemas/ScoreMultiModalParam"
  11629. }
  11630. ],
  11631. "title": "Text 1"
  11632. },
  11633. "text_2": {
  11634. "anyOf": [
  11635. {
  11636. "items": {
  11637. "type": "string"
  11638. },
  11639. "type": "array"
  11640. },
  11641. {
  11642. "type": "string"
  11643. },
  11644. {
  11645. "$ref": "#/components/schemas/ScoreMultiModalParam"
  11646. }
  11647. ],
  11648. "title": "Text 2"
  11649. },
  11650. "truncate_prompt_tokens": {
  11651. "anyOf": [
  11652. {
  11653. "type": "integer",
  11654. "minimum": -1
  11655. },
  11656. {
  11657. "type": "null"
  11658. }
  11659. ],
  11660. "title": "Truncate Prompt Tokens"
  11661. },
  11662. "mm_processor_kwargs": {
  11663. "anyOf": [
  11664. {
  11665. "additionalProperties": true,
  11666. "type": "object"
  11667. },
  11668. {
  11669. "type": "null"
  11670. }
  11671. ],
  11672. "title": "Mm Processor Kwargs",
  11673. "description": "Additional kwargs to pass to the HF processor."
  11674. },
  11675. "priority": {
  11676. "type": "integer",
  11677. "title": "Priority",
  11678. "description": "The priority of the request (lower means earlier handling; default: 0). Any priority other than 0 will raise an error if the served model does not use priority scheduling.",
  11679. "default": 0
  11680. },
  11681. "softmax": {
  11682. "anyOf": [
  11683. {
  11684. "type": "boolean"
  11685. },
  11686. {
  11687. "type": "null"
  11688. }
  11689. ],
  11690. "title": "Softmax",
  11691. "description": "softmax will be deprecated, please use use_activation instead."
  11692. },
  11693. "activation": {
  11694. "anyOf": [
  11695. {
  11696. "type": "boolean"
  11697. },
  11698. {
  11699. "type": "null"
  11700. }
  11701. ],
  11702. "title": "Activation",
  11703. "description": "activation will be deprecated, please use use_activation instead."
  11704. },
  11705. "use_activation": {
  11706. "anyOf": [
  11707. {
  11708. "type": "boolean"
  11709. },
  11710. {
  11711. "type": "null"
  11712. }
  11713. ],
  11714. "title": "Use Activation",
  11715. "description": "Whether to use activation for classification outputs. Default is True."
  11716. }
  11717. },
  11718. "additionalProperties": true,
  11719. "type": "object",
  11720. "required": [
  11721. "text_1",
  11722. "text_2"
  11723. ],
  11724. "title": "ScoreRequest"
  11725. },
  11726. "ShellCall": {
  11727. "properties": {
  11728. "action": {
  11729. "$ref": "#/components/schemas/ShellCallAction"
  11730. },
  11731. "call_id": {
  11732. "type": "string",
  11733. "title": "Call Id"
  11734. },
  11735. "type": {
  11736. "type": "string",
  11737. "const": "shell_call",
  11738. "title": "Type"
  11739. },
  11740. "id": {
  11741. "anyOf": [
  11742. {
  11743. "type": "string"
  11744. },
  11745. {
  11746. "type": "null"
  11747. }
  11748. ],
  11749. "title": "Id"
  11750. },
  11751. "status": {
  11752. "anyOf": [
  11753. {
  11754. "type": "string",
  11755. "enum": [
  11756. "in_progress",
  11757. "completed",
  11758. "incomplete"
  11759. ]
  11760. },
  11761. {
  11762. "type": "null"
  11763. }
  11764. ],
  11765. "title": "Status"
  11766. }
  11767. },
  11768. "additionalProperties": true,
  11769. "type": "object",
  11770. "required": [
  11771. "action",
  11772. "call_id",
  11773. "type"
  11774. ],
  11775. "title": "ShellCall",
  11776. "description": "A tool representing a request to execute one or more shell commands."
  11777. },
  11778. "ShellCallAction": {
  11779. "properties": {
  11780. "commands": {
  11781. "items": {
  11782. "type": "string"
  11783. },
  11784. "type": "array",
  11785. "title": "Commands"
  11786. },
  11787. "max_output_length": {
  11788. "anyOf": [
  11789. {
  11790. "type": "integer"
  11791. },
  11792. {
  11793. "type": "null"
  11794. }
  11795. ],
  11796. "title": "Max Output Length"
  11797. },
  11798. "timeout_ms": {
  11799. "anyOf": [
  11800. {
  11801. "type": "integer"
  11802. },
  11803. {
  11804. "type": "null"
  11805. }
  11806. ],
  11807. "title": "Timeout Ms"
  11808. }
  11809. },
  11810. "additionalProperties": true,
  11811. "type": "object",
  11812. "required": [
  11813. "commands"
  11814. ],
  11815. "title": "ShellCallAction",
  11816. "description": "The shell commands and limits that describe how to run the tool call."
  11817. },
  11818. "ShellCallOutput": {
  11819. "properties": {
  11820. "call_id": {
  11821. "type": "string",
  11822. "title": "Call Id"
  11823. },
  11824. "output": {
  11825. "items": {
  11826. "$ref": "#/components/schemas/ResponseFunctionShellCallOutputContentParam"
  11827. },
  11828. "type": "array",
  11829. "title": "Output"
  11830. },
  11831. "type": {
  11832. "type": "string",
  11833. "const": "shell_call_output",
  11834. "title": "Type"
  11835. },
  11836. "id": {
  11837. "anyOf": [
  11838. {
  11839. "type": "string"
  11840. },
  11841. {
  11842. "type": "null"
  11843. }
  11844. ],
  11845. "title": "Id"
  11846. },
  11847. "max_output_length": {
  11848. "anyOf": [
  11849. {
  11850. "type": "integer"
  11851. },
  11852. {
  11853. "type": "null"
  11854. }
  11855. ],
  11856. "title": "Max Output Length"
  11857. }
  11858. },
  11859. "additionalProperties": true,
  11860. "type": "object",
  11861. "required": [
  11862. "call_id",
  11863. "output",
  11864. "type"
  11865. ],
  11866. "title": "ShellCallOutput",
  11867. "description": "The streamed output items emitted by a shell tool call."
  11868. },
  11869. "StreamOptions": {
  11870. "properties": {
  11871. "include_usage": {
  11872. "anyOf": [
  11873. {
  11874. "type": "boolean"
  11875. },
  11876. {
  11877. "type": "null"
  11878. }
  11879. ],
  11880. "title": "Include Usage",
  11881. "default": true
  11882. },
  11883. "continuous_usage_stats": {
  11884. "anyOf": [
  11885. {
  11886. "type": "boolean"
  11887. },
  11888. {
  11889. "type": "null"
  11890. }
  11891. ],
  11892. "title": "Continuous Usage Stats",
  11893. "default": false
  11894. }
  11895. },
  11896. "additionalProperties": true,
  11897. "type": "object",
  11898. "title": "StreamOptions"
  11899. },
  11900. "StructuralTagResponseFormat": {
  11901. "properties": {
  11902. "type": {
  11903. "type": "string",
  11904. "const": "structural_tag",
  11905. "title": "Type"
  11906. },
  11907. "format": {
  11908. "title": "Format"
  11909. }
  11910. },
  11911. "additionalProperties": true,
  11912. "type": "object",
  11913. "required": [
  11914. "type",
  11915. "format"
  11916. ],
  11917. "title": "StructuralTagResponseFormat"
  11918. },
  11919. "StructuredOutputsParams": {
  11920. "properties": {
  11921. "json": {
  11922. "anyOf": [
  11923. {
  11924. "type": "string"
  11925. },
  11926. {
  11927. "additionalProperties": true,
  11928. "type": "object"
  11929. },
  11930. {
  11931. "type": "null"
  11932. }
  11933. ],
  11934. "title": "Json"
  11935. },
  11936. "regex": {
  11937. "anyOf": [
  11938. {
  11939. "type": "string"
  11940. },
  11941. {
  11942. "type": "null"
  11943. }
  11944. ],
  11945. "title": "Regex"
  11946. },
  11947. "choice": {
  11948. "anyOf": [
  11949. {
  11950. "items": {
  11951. "type": "string"
  11952. },
  11953. "type": "array"
  11954. },
  11955. {
  11956. "type": "null"
  11957. }
  11958. ],
  11959. "title": "Choice"
  11960. },
  11961. "grammar": {
  11962. "anyOf": [
  11963. {
  11964. "type": "string"
  11965. },
  11966. {
  11967. "type": "null"
  11968. }
  11969. ],
  11970. "title": "Grammar"
  11971. },
  11972. "json_object": {
  11973. "anyOf": [
  11974. {
  11975. "type": "boolean"
  11976. },
  11977. {
  11978. "type": "null"
  11979. }
  11980. ],
  11981. "title": "Json Object"
  11982. },
  11983. "disable_fallback": {
  11984. "type": "boolean",
  11985. "title": "Disable Fallback",
  11986. "default": false
  11987. },
  11988. "disable_any_whitespace": {
  11989. "type": "boolean",
  11990. "title": "Disable Any Whitespace",
  11991. "default": false
  11992. },
  11993. "disable_additional_properties": {
  11994. "type": "boolean",
  11995. "title": "Disable Additional Properties",
  11996. "default": false
  11997. },
  11998. "whitespace_pattern": {
  11999. "anyOf": [
  12000. {
  12001. "type": "string"
  12002. },
  12003. {
  12004. "type": "null"
  12005. }
  12006. ],
  12007. "title": "Whitespace Pattern"
  12008. },
  12009. "structural_tag": {
  12010. "anyOf": [
  12011. {
  12012. "type": "string"
  12013. },
  12014. {
  12015. "type": "null"
  12016. }
  12017. ],
  12018. "title": "Structural Tag"
  12019. },
  12020. "_backend": {
  12021. "anyOf": [
  12022. {
  12023. "type": "string"
  12024. },
  12025. {
  12026. "type": "null"
  12027. }
  12028. ],
  12029. "title": "Backend"
  12030. },
  12031. "_backend_was_auto": {
  12032. "type": "boolean",
  12033. "title": "Backend Was Auto",
  12034. "default": false
  12035. }
  12036. },
  12037. "type": "object",
  12038. "title": "StructuredOutputsParams"
  12039. },
  12040. "Summary": {
  12041. "properties": {
  12042. "text": {
  12043. "type": "string",
  12044. "title": "Text"
  12045. },
  12046. "type": {
  12047. "type": "string",
  12048. "const": "summary_text",
  12049. "title": "Type"
  12050. }
  12051. },
  12052. "additionalProperties": true,
  12053. "type": "object",
  12054. "required": [
  12055. "text",
  12056. "type"
  12057. ],
  12058. "title": "Summary",
  12059. "description": "A summary text from the model."
  12060. },
  12061. "Text": {
  12062. "properties": {
  12063. "type": {
  12064. "type": "string",
  12065. "const": "text",
  12066. "title": "Type"
  12067. }
  12068. },
  12069. "additionalProperties": true,
  12070. "type": "object",
  12071. "required": [
  12072. "type"
  12073. ],
  12074. "title": "Text",
  12075. "description": "Unconstrained free-form text."
  12076. },
  12077. "TokenizeChatRequest": {
  12078. "properties": {
  12079. "model": {
  12080. "anyOf": [
  12081. {
  12082. "type": "string"
  12083. },
  12084. {
  12085. "type": "null"
  12086. }
  12087. ],
  12088. "title": "Model"
  12089. },
  12090. "messages": {
  12091. "items": {
  12092. "anyOf": [
  12093. {
  12094. "$ref": "#/components/schemas/ChatCompletionDeveloperMessageParam"
  12095. },
  12096. {
  12097. "$ref": "#/components/schemas/ChatCompletionSystemMessageParam"
  12098. },
  12099. {
  12100. "$ref": "#/components/schemas/ChatCompletionUserMessageParam"
  12101. },
  12102. {
  12103. "$ref": "#/components/schemas/ChatCompletionAssistantMessageParam"
  12104. },
  12105. {
  12106. "$ref": "#/components/schemas/ChatCompletionToolMessageParam"
  12107. },
  12108. {
  12109. "$ref": "#/components/schemas/ChatCompletionFunctionMessageParam"
  12110. },
  12111. {
  12112. "$ref": "#/components/schemas/CustomChatCompletionMessageParam"
  12113. },
  12114. {
  12115. "$ref": "#/components/schemas/Message"
  12116. }
  12117. ]
  12118. },
  12119. "type": "array",
  12120. "title": "Messages"
  12121. },
  12122. "add_generation_prompt": {
  12123. "type": "boolean",
  12124. "title": "Add Generation Prompt",
  12125. "description": "If true, the generation prompt will be added to the chat template. This is a parameter used by chat template in tokenizer config of the model.",
  12126. "default": true
  12127. },
  12128. "return_token_strs": {
  12129. "anyOf": [
  12130. {
  12131. "type": "boolean"
  12132. },
  12133. {
  12134. "type": "null"
  12135. }
  12136. ],
  12137. "title": "Return Token Strs",
  12138. "description": "If true, also return the token strings corresponding to the token ids.",
  12139. "default": false
  12140. },
  12141. "continue_final_message": {
  12142. "type": "boolean",
  12143. "title": "Continue Final Message",
  12144. "description": "If this is set, the chat will be formatted so that the final message in the chat is open-ended, without any EOS tokens. The model will continue this message rather than starting a new one. This allows you to \"prefill\" part of the model's response for it. Cannot be used at the same time as `add_generation_prompt`.",
  12145. "default": false
  12146. },
  12147. "add_special_tokens": {
  12148. "type": "boolean",
  12149. "title": "Add Special Tokens",
  12150. "description": "If true, special tokens (e.g. BOS) will be added to the prompt on top of what is added by the chat template. For most models, the chat template takes care of adding the special tokens so this should be set to false (as is the default).",
  12151. "default": false
  12152. },
  12153. "chat_template": {
  12154. "anyOf": [
  12155. {
  12156. "type": "string"
  12157. },
  12158. {
  12159. "type": "null"
  12160. }
  12161. ],
  12162. "title": "Chat Template",
  12163. "description": "A Jinja template to use for this conversion. As of transformers v4.44, default chat template is no longer allowed, so you must provide a chat template if the tokenizer does not define one."
  12164. },
  12165. "chat_template_kwargs": {
  12166. "anyOf": [
  12167. {
  12168. "additionalProperties": true,
  12169. "type": "object"
  12170. },
  12171. {
  12172. "type": "null"
  12173. }
  12174. ],
  12175. "title": "Chat Template Kwargs",
  12176. "description": "Additional keyword args to pass to the template renderer. Will be accessible by the chat template."
  12177. },
  12178. "mm_processor_kwargs": {
  12179. "anyOf": [
  12180. {
  12181. "additionalProperties": true,
  12182. "type": "object"
  12183. },
  12184. {
  12185. "type": "null"
  12186. }
  12187. ],
  12188. "title": "Mm Processor Kwargs",
  12189. "description": "Additional kwargs to pass to the HF processor."
  12190. },
  12191. "tools": {
  12192. "anyOf": [
  12193. {
  12194. "items": {
  12195. "$ref": "#/components/schemas/ChatCompletionToolsParam"
  12196. },
  12197. "type": "array"
  12198. },
  12199. {
  12200. "type": "null"
  12201. }
  12202. ],
  12203. "title": "Tools",
  12204. "description": "A list of tools the model may call."
  12205. }
  12206. },
  12207. "additionalProperties": true,
  12208. "type": "object",
  12209. "required": [
  12210. "messages"
  12211. ],
  12212. "title": "TokenizeChatRequest"
  12213. },
  12214. "TokenizeCompletionRequest": {
  12215. "properties": {
  12216. "model": {
  12217. "anyOf": [
  12218. {
  12219. "type": "string"
  12220. },
  12221. {
  12222. "type": "null"
  12223. }
  12224. ],
  12225. "title": "Model"
  12226. },
  12227. "prompt": {
  12228. "type": "string",
  12229. "title": "Prompt"
  12230. },
  12231. "add_special_tokens": {
  12232. "type": "boolean",
  12233. "title": "Add Special Tokens",
  12234. "description": "If true (the default), special tokens (e.g. BOS) will be added to the prompt.",
  12235. "default": true
  12236. },
  12237. "return_token_strs": {
  12238. "anyOf": [
  12239. {
  12240. "type": "boolean"
  12241. },
  12242. {
  12243. "type": "null"
  12244. }
  12245. ],
  12246. "title": "Return Token Strs",
  12247. "description": "If true, also return the token strings corresponding to the token ids.",
  12248. "default": false
  12249. }
  12250. },
  12251. "additionalProperties": true,
  12252. "type": "object",
  12253. "required": [
  12254. "prompt"
  12255. ],
  12256. "title": "TokenizeCompletionRequest"
  12257. },
  12258. "ToolChoiceAllowed": {
  12259. "properties": {
  12260. "mode": {
  12261. "type": "string",
  12262. "enum": [
  12263. "auto",
  12264. "required"
  12265. ],
  12266. "title": "Mode"
  12267. },
  12268. "tools": {
  12269. "items": {
  12270. "additionalProperties": true,
  12271. "type": "object"
  12272. },
  12273. "type": "array",
  12274. "title": "Tools"
  12275. },
  12276. "type": {
  12277. "type": "string",
  12278. "const": "allowed_tools",
  12279. "title": "Type"
  12280. }
  12281. },
  12282. "additionalProperties": true,
  12283. "type": "object",
  12284. "required": [
  12285. "mode",
  12286. "tools",
  12287. "type"
  12288. ],
  12289. "title": "ToolChoiceAllowed",
  12290. "description": "Constrains the tools available to the model to a pre-defined set."
  12291. },
  12292. "ToolChoiceApplyPatch": {
  12293. "properties": {
  12294. "type": {
  12295. "type": "string",
  12296. "const": "apply_patch",
  12297. "title": "Type"
  12298. }
  12299. },
  12300. "additionalProperties": true,
  12301. "type": "object",
  12302. "required": [
  12303. "type"
  12304. ],
  12305. "title": "ToolChoiceApplyPatch",
  12306. "description": "Forces the model to call the apply_patch tool when executing a tool call."
  12307. },
  12308. "ToolChoiceCustom": {
  12309. "properties": {
  12310. "name": {
  12311. "type": "string",
  12312. "title": "Name"
  12313. },
  12314. "type": {
  12315. "type": "string",
  12316. "const": "custom",
  12317. "title": "Type"
  12318. }
  12319. },
  12320. "additionalProperties": true,
  12321. "type": "object",
  12322. "required": [
  12323. "name",
  12324. "type"
  12325. ],
  12326. "title": "ToolChoiceCustom",
  12327. "description": "Use this option to force the model to call a specific custom tool."
  12328. },
  12329. "ToolChoiceFunction": {
  12330. "properties": {
  12331. "name": {
  12332. "type": "string",
  12333. "title": "Name"
  12334. },
  12335. "type": {
  12336. "type": "string",
  12337. "const": "function",
  12338. "title": "Type"
  12339. }
  12340. },
  12341. "additionalProperties": true,
  12342. "type": "object",
  12343. "required": [
  12344. "name",
  12345. "type"
  12346. ],
  12347. "title": "ToolChoiceFunction",
  12348. "description": "Use this option to force the model to call a specific function."
  12349. },
  12350. "ToolChoiceMcp": {
  12351. "properties": {
  12352. "server_label": {
  12353. "type": "string",
  12354. "title": "Server Label"
  12355. },
  12356. "type": {
  12357. "type": "string",
  12358. "const": "mcp",
  12359. "title": "Type"
  12360. },
  12361. "name": {
  12362. "anyOf": [
  12363. {
  12364. "type": "string"
  12365. },
  12366. {
  12367. "type": "null"
  12368. }
  12369. ],
  12370. "title": "Name"
  12371. }
  12372. },
  12373. "additionalProperties": true,
  12374. "type": "object",
  12375. "required": [
  12376. "server_label",
  12377. "type"
  12378. ],
  12379. "title": "ToolChoiceMcp",
  12380. "description": "Use this option to force the model to call a specific tool on a remote MCP server."
  12381. },
  12382. "ToolChoiceShell": {
  12383. "properties": {
  12384. "type": {
  12385. "type": "string",
  12386. "const": "shell",
  12387. "title": "Type"
  12388. }
  12389. },
  12390. "additionalProperties": true,
  12391. "type": "object",
  12392. "required": [
  12393. "type"
  12394. ],
  12395. "title": "ToolChoiceShell",
  12396. "description": "Forces the model to call the shell tool when a tool call is required."
  12397. },
  12398. "ToolChoiceTypes": {
  12399. "properties": {
  12400. "type": {
  12401. "type": "string",
  12402. "enum": [
  12403. "file_search",
  12404. "web_search_preview",
  12405. "computer_use_preview",
  12406. "web_search_preview_2025_03_11",
  12407. "image_generation",
  12408. "code_interpreter"
  12409. ],
  12410. "title": "Type"
  12411. }
  12412. },
  12413. "additionalProperties": true,
  12414. "type": "object",
  12415. "required": [
  12416. "type"
  12417. ],
  12418. "title": "ToolChoiceTypes",
  12419. "description": "Indicates that the model should use a built-in tool to generate a response.\n[Learn more about built-in tools](https://platform.openai.com/docs/guides/tools)."
  12420. },
  12421. "TranscriptionRequest": {
  12422. "properties": {
  12423. "file": {
  12424. "type": "string",
  12425. "format": "binary",
  12426. "title": "File"
  12427. },
  12428. "model": {
  12429. "anyOf": [
  12430. {
  12431. "type": "string"
  12432. },
  12433. {
  12434. "type": "null"
  12435. }
  12436. ],
  12437. "title": "Model"
  12438. },
  12439. "language": {
  12440. "anyOf": [
  12441. {
  12442. "type": "string"
  12443. },
  12444. {
  12445. "type": "null"
  12446. }
  12447. ],
  12448. "title": "Language"
  12449. },
  12450. "prompt": {
  12451. "type": "string",
  12452. "title": "Prompt",
  12453. "default": ""
  12454. },
  12455. "response_format": {
  12456. "type": "string",
  12457. "enum": [
  12458. "json",
  12459. "text",
  12460. "srt",
  12461. "verbose_json",
  12462. "vtt"
  12463. ],
  12464. "title": "Response Format",
  12465. "default": "json"
  12466. },
  12467. "timestamp_granularities[]": {
  12468. "items": {
  12469. "type": "string",
  12470. "enum": [
  12471. "word",
  12472. "segment"
  12473. ]
  12474. },
  12475. "type": "array",
  12476. "title": "Timestamp Granularities[]",
  12477. "default": []
  12478. },
  12479. "stream": {
  12480. "anyOf": [
  12481. {
  12482. "type": "boolean"
  12483. },
  12484. {
  12485. "type": "null"
  12486. }
  12487. ],
  12488. "title": "Stream",
  12489. "default": false
  12490. },
  12491. "stream_include_usage": {
  12492. "anyOf": [
  12493. {
  12494. "type": "boolean"
  12495. },
  12496. {
  12497. "type": "null"
  12498. }
  12499. ],
  12500. "title": "Stream Include Usage",
  12501. "default": false
  12502. },
  12503. "stream_continuous_usage_stats": {
  12504. "anyOf": [
  12505. {
  12506. "type": "boolean"
  12507. },
  12508. {
  12509. "type": "null"
  12510. }
  12511. ],
  12512. "title": "Stream Continuous Usage Stats",
  12513. "default": false
  12514. },
  12515. "vllm_xargs": {
  12516. "anyOf": [
  12517. {
  12518. "additionalProperties": {
  12519. "anyOf": [
  12520. {
  12521. "type": "string"
  12522. },
  12523. {
  12524. "type": "integer"
  12525. },
  12526. {
  12527. "type": "number"
  12528. }
  12529. ]
  12530. },
  12531. "type": "object"
  12532. },
  12533. {
  12534. "type": "null"
  12535. }
  12536. ],
  12537. "title": "Vllm Xargs",
  12538. "description": "Additional request parameters with string or numeric values, used by custom extensions."
  12539. },
  12540. "to_language": {
  12541. "anyOf": [
  12542. {
  12543. "type": "string"
  12544. },
  12545. {
  12546. "type": "null"
  12547. }
  12548. ],
  12549. "title": "To Language"
  12550. },
  12551. "temperature": {
  12552. "type": "number",
  12553. "title": "Temperature",
  12554. "default": 0
  12555. },
  12556. "top_p": {
  12557. "anyOf": [
  12558. {
  12559. "type": "number"
  12560. },
  12561. {
  12562. "type": "null"
  12563. }
  12564. ],
  12565. "title": "Top P"
  12566. },
  12567. "top_k": {
  12568. "anyOf": [
  12569. {
  12570. "type": "integer"
  12571. },
  12572. {
  12573. "type": "null"
  12574. }
  12575. ],
  12576. "title": "Top K"
  12577. },
  12578. "min_p": {
  12579. "anyOf": [
  12580. {
  12581. "type": "number"
  12582. },
  12583. {
  12584. "type": "null"
  12585. }
  12586. ],
  12587. "title": "Min P"
  12588. },
  12589. "seed": {
  12590. "anyOf": [
  12591. {
  12592. "type": "integer",
  12593. "maximum": "9.223372036854776e+18",
  12594. "minimum": -9223372036854776000
  12595. },
  12596. {
  12597. "type": "null"
  12598. }
  12599. ],
  12600. "title": "Seed"
  12601. },
  12602. "frequency_penalty": {
  12603. "anyOf": [
  12604. {
  12605. "type": "number"
  12606. },
  12607. {
  12608. "type": "null"
  12609. }
  12610. ],
  12611. "title": "Frequency Penalty",
  12612. "default": 0
  12613. },
  12614. "repetition_penalty": {
  12615. "anyOf": [
  12616. {
  12617. "type": "number"
  12618. },
  12619. {
  12620. "type": "null"
  12621. }
  12622. ],
  12623. "title": "Repetition Penalty"
  12624. },
  12625. "presence_penalty": {
  12626. "anyOf": [
  12627. {
  12628. "type": "number"
  12629. },
  12630. {
  12631. "type": "null"
  12632. }
  12633. ],
  12634. "title": "Presence Penalty",
  12635. "default": 0
  12636. },
  12637. "max_completion_tokens": {
  12638. "anyOf": [
  12639. {
  12640. "type": "integer"
  12641. },
  12642. {
  12643. "type": "null"
  12644. }
  12645. ],
  12646. "title": "Max Completion Tokens"
  12647. }
  12648. },
  12649. "additionalProperties": true,
  12650. "type": "object",
  12651. "required": [
  12652. "file"
  12653. ],
  12654. "title": "TranscriptionRequest"
  12655. },
  12656. "TranslationRequest": {
  12657. "properties": {
  12658. "file": {
  12659. "type": "string",
  12660. "format": "binary",
  12661. "title": "File"
  12662. },
  12663. "model": {
  12664. "anyOf": [
  12665. {
  12666. "type": "string"
  12667. },
  12668. {
  12669. "type": "null"
  12670. }
  12671. ],
  12672. "title": "Model"
  12673. },
  12674. "prompt": {
  12675. "type": "string",
  12676. "title": "Prompt",
  12677. "default": ""
  12678. },
  12679. "response_format": {
  12680. "type": "string",
  12681. "enum": [
  12682. "json",
  12683. "text",
  12684. "srt",
  12685. "verbose_json",
  12686. "vtt"
  12687. ],
  12688. "title": "Response Format",
  12689. "default": "json"
  12690. },
  12691. "seed": {
  12692. "anyOf": [
  12693. {
  12694. "type": "integer",
  12695. "maximum": "9.223372036854776e+18",
  12696. "minimum": -9223372036854776000
  12697. },
  12698. {
  12699. "type": "null"
  12700. }
  12701. ],
  12702. "title": "Seed"
  12703. },
  12704. "temperature": {
  12705. "type": "number",
  12706. "title": "Temperature",
  12707. "default": 0
  12708. },
  12709. "language": {
  12710. "anyOf": [
  12711. {
  12712. "type": "string"
  12713. },
  12714. {
  12715. "type": "null"
  12716. }
  12717. ],
  12718. "title": "Language"
  12719. },
  12720. "to_language": {
  12721. "anyOf": [
  12722. {
  12723. "type": "string"
  12724. },
  12725. {
  12726. "type": "null"
  12727. }
  12728. ],
  12729. "title": "To Language"
  12730. },
  12731. "stream": {
  12732. "anyOf": [
  12733. {
  12734. "type": "boolean"
  12735. },
  12736. {
  12737. "type": "null"
  12738. }
  12739. ],
  12740. "title": "Stream",
  12741. "default": false
  12742. },
  12743. "stream_include_usage": {
  12744. "anyOf": [
  12745. {
  12746. "type": "boolean"
  12747. },
  12748. {
  12749. "type": "null"
  12750. }
  12751. ],
  12752. "title": "Stream Include Usage",
  12753. "default": false
  12754. },
  12755. "stream_continuous_usage_stats": {
  12756. "anyOf": [
  12757. {
  12758. "type": "boolean"
  12759. },
  12760. {
  12761. "type": "null"
  12762. }
  12763. ],
  12764. "title": "Stream Continuous Usage Stats",
  12765. "default": false
  12766. },
  12767. "max_completion_tokens": {
  12768. "anyOf": [
  12769. {
  12770. "type": "integer"
  12771. },
  12772. {
  12773. "type": "null"
  12774. }
  12775. ],
  12776. "title": "Max Completion Tokens"
  12777. }
  12778. },
  12779. "additionalProperties": true,
  12780. "type": "object",
  12781. "required": [
  12782. "file"
  12783. ],
  12784. "title": "TranslationRequest"
  12785. },
  12786. "UserLocation": {
  12787. "properties": {
  12788. "type": {
  12789. "type": "string",
  12790. "const": "approximate",
  12791. "title": "Type"
  12792. },
  12793. "city": {
  12794. "anyOf": [
  12795. {
  12796. "type": "string"
  12797. },
  12798. {
  12799. "type": "null"
  12800. }
  12801. ],
  12802. "title": "City"
  12803. },
  12804. "country": {
  12805. "anyOf": [
  12806. {
  12807. "type": "string"
  12808. },
  12809. {
  12810. "type": "null"
  12811. }
  12812. ],
  12813. "title": "Country"
  12814. },
  12815. "region": {
  12816. "anyOf": [
  12817. {
  12818. "type": "string"
  12819. },
  12820. {
  12821. "type": "null"
  12822. }
  12823. ],
  12824. "title": "Region"
  12825. },
  12826. "timezone": {
  12827. "anyOf": [
  12828. {
  12829. "type": "string"
  12830. },
  12831. {
  12832. "type": "null"
  12833. }
  12834. ],
  12835. "title": "Timezone"
  12836. }
  12837. },
  12838. "additionalProperties": true,
  12839. "type": "object",
  12840. "required": [
  12841. "type"
  12842. ],
  12843. "title": "UserLocation",
  12844. "description": "The user's location."
  12845. },
  12846. "ValidationError": {
  12847. "properties": {
  12848. "loc": {
  12849. "items": {
  12850. "anyOf": [
  12851. {
  12852. "type": "string"
  12853. },
  12854. {
  12855. "type": "integer"
  12856. }
  12857. ]
  12858. },
  12859. "type": "array",
  12860. "title": "Location"
  12861. },
  12862. "msg": {
  12863. "type": "string",
  12864. "title": "Message"
  12865. },
  12866. "type": {
  12867. "type": "string",
  12868. "title": "Error Type"
  12869. }
  12870. },
  12871. "type": "object",
  12872. "required": [
  12873. "loc",
  12874. "msg",
  12875. "type"
  12876. ],
  12877. "title": "ValidationError"
  12878. },
  12879. "VideoURL": {
  12880. "properties": {
  12881. "url": {
  12882. "type": "string",
  12883. "title": "Url"
  12884. }
  12885. },
  12886. "additionalProperties": true,
  12887. "type": "object",
  12888. "required": [
  12889. "url"
  12890. ],
  12891. "title": "VideoURL"
  12892. },
  12893. "WebSearchPreviewTool": {
  12894. "properties": {
  12895. "type": {
  12896. "type": "string",
  12897. "enum": [
  12898. "web_search_preview",
  12899. "web_search_preview_2025_03_11"
  12900. ],
  12901. "title": "Type"
  12902. },
  12903. "search_context_size": {
  12904. "anyOf": [
  12905. {
  12906. "type": "string",
  12907. "enum": [
  12908. "low",
  12909. "medium",
  12910. "high"
  12911. ]
  12912. },
  12913. {
  12914. "type": "null"
  12915. }
  12916. ],
  12917. "title": "Search Context Size"
  12918. },
  12919. "user_location": {
  12920. "anyOf": [
  12921. {
  12922. "$ref": "#/components/schemas/UserLocation"
  12923. },
  12924. {
  12925. "type": "null"
  12926. }
  12927. ]
  12928. }
  12929. },
  12930. "additionalProperties": true,
  12931. "type": "object",
  12932. "required": [
  12933. "type"
  12934. ],
  12935. "title": "WebSearchPreviewTool",
  12936. "description": "This tool searches the web for relevant results to use in a response.\n\nLearn more about the [web search tool](https://platform.openai.com/docs/guides/tools-web-search)."
  12937. },
  12938. "WebSearchTool": {
  12939. "properties": {
  12940. "type": {
  12941. "type": "string",
  12942. "enum": [
  12943. "web_search",
  12944. "web_search_2025_08_26"
  12945. ],
  12946. "title": "Type"
  12947. },
  12948. "filters": {
  12949. "anyOf": [
  12950. {
  12951. "$ref": "#/components/schemas/Filters"
  12952. },
  12953. {
  12954. "type": "null"
  12955. }
  12956. ]
  12957. },
  12958. "search_context_size": {
  12959. "anyOf": [
  12960. {
  12961. "type": "string",
  12962. "enum": [
  12963. "low",
  12964. "medium",
  12965. "high"
  12966. ]
  12967. },
  12968. {
  12969. "type": "null"
  12970. }
  12971. ],
  12972. "title": "Search Context Size"
  12973. },
  12974. "user_location": {
  12975. "anyOf": [
  12976. {
  12977. "$ref": "#/components/schemas/openai__types__responses__web_search_tool__UserLocation"
  12978. },
  12979. {
  12980. "type": "null"
  12981. }
  12982. ]
  12983. }
  12984. },
  12985. "additionalProperties": true,
  12986. "type": "object",
  12987. "required": [
  12988. "type"
  12989. ],
  12990. "title": "WebSearchTool",
  12991. "description": "Search the Internet for sources related to the prompt.\n\nLearn more about the\n[web search tool](https://platform.openai.com/docs/guides/tools-web-search)."
  12992. },
  12993. "openai__types__responses__response_computer_tool_call_param__PendingSafetyCheck": {
  12994. "properties": {
  12995. "id": {
  12996. "type": "string",
  12997. "title": "Id"
  12998. },
  12999. "code": {
  13000. "anyOf": [
  13001. {
  13002. "type": "string"
  13003. },
  13004. {
  13005. "type": "null"
  13006. }
  13007. ],
  13008. "title": "Code"
  13009. },
  13010. "message": {
  13011. "anyOf": [
  13012. {
  13013. "type": "string"
  13014. },
  13015. {
  13016. "type": "null"
  13017. }
  13018. ],
  13019. "title": "Message"
  13020. }
  13021. },
  13022. "additionalProperties": true,
  13023. "type": "object",
  13024. "required": [
  13025. "id"
  13026. ],
  13027. "title": "PendingSafetyCheck",
  13028. "description": "A pending safety check for the computer call."
  13029. },
  13030. "openai__types__responses__response_file_search_tool_call_param__Result": {
  13031. "properties": {
  13032. "attributes": {
  13033. "anyOf": [
  13034. {
  13035. "additionalProperties": {
  13036. "anyOf": [
  13037. {
  13038. "type": "string"
  13039. },
  13040. {
  13041. "type": "number"
  13042. },
  13043. {
  13044. "type": "boolean"
  13045. }
  13046. ]
  13047. },
  13048. "type": "object"
  13049. },
  13050. {
  13051. "type": "null"
  13052. }
  13053. ],
  13054. "title": "Attributes"
  13055. },
  13056. "file_id": {
  13057. "type": "string",
  13058. "title": "File Id"
  13059. },
  13060. "filename": {
  13061. "type": "string",
  13062. "title": "Filename"
  13063. },
  13064. "score": {
  13065. "type": "number",
  13066. "title": "Score"
  13067. },
  13068. "text": {
  13069. "type": "string",
  13070. "title": "Text"
  13071. }
  13072. },
  13073. "additionalProperties": true,
  13074. "type": "object",
  13075. "title": "Result"
  13076. },
  13077. "openai__types__responses__response_function_web_search_param__ActionSearch": {
  13078. "properties": {
  13079. "query": {
  13080. "type": "string",
  13081. "title": "Query"
  13082. },
  13083. "type": {
  13084. "type": "string",
  13085. "const": "search",
  13086. "title": "Type"
  13087. },
  13088. "queries": {
  13089. "items": {
  13090. "type": "string"
  13091. },
  13092. "type": "array",
  13093. "title": "Queries"
  13094. },
  13095. "sources": {
  13096. "items": {
  13097. "$ref": "#/components/schemas/ActionSearchSource"
  13098. },
  13099. "type": "array",
  13100. "title": "Sources"
  13101. }
  13102. },
  13103. "additionalProperties": true,
  13104. "type": "object",
  13105. "required": [
  13106. "query",
  13107. "type"
  13108. ],
  13109. "title": "ActionSearch",
  13110. "description": "Action type \"search\" - Performs a web search query."
  13111. },
  13112. "openai__types__responses__response_input_item_param__ImageGenerationCall": {
  13113. "properties": {
  13114. "id": {
  13115. "type": "string",
  13116. "title": "Id"
  13117. },
  13118. "result": {
  13119. "anyOf": [
  13120. {
  13121. "type": "string"
  13122. },
  13123. {
  13124. "type": "null"
  13125. }
  13126. ],
  13127. "title": "Result"
  13128. },
  13129. "status": {
  13130. "type": "string",
  13131. "enum": [
  13132. "in_progress",
  13133. "completed",
  13134. "generating",
  13135. "failed"
  13136. ],
  13137. "title": "Status"
  13138. },
  13139. "type": {
  13140. "type": "string",
  13141. "const": "image_generation_call",
  13142. "title": "Type"
  13143. }
  13144. },
  13145. "additionalProperties": true,
  13146. "type": "object",
  13147. "required": [
  13148. "id",
  13149. "result",
  13150. "status",
  13151. "type"
  13152. ],
  13153. "title": "ImageGenerationCall",
  13154. "description": "An image generation request made by the model."
  13155. },
  13156. "openai__types__responses__response_input_item_param__LocalShellCall": {
  13157. "properties": {
  13158. "id": {
  13159. "type": "string",
  13160. "title": "Id"
  13161. },
  13162. "action": {
  13163. "$ref": "#/components/schemas/openai__types__responses__response_input_item_param__LocalShellCallAction"
  13164. },
  13165. "call_id": {
  13166. "type": "string",
  13167. "title": "Call Id"
  13168. },
  13169. "status": {
  13170. "type": "string",
  13171. "enum": [
  13172. "in_progress",
  13173. "completed",
  13174. "incomplete"
  13175. ],
  13176. "title": "Status"
  13177. },
  13178. "type": {
  13179. "type": "string",
  13180. "const": "local_shell_call",
  13181. "title": "Type"
  13182. }
  13183. },
  13184. "additionalProperties": true,
  13185. "type": "object",
  13186. "required": [
  13187. "id",
  13188. "action",
  13189. "call_id",
  13190. "status",
  13191. "type"
  13192. ],
  13193. "title": "LocalShellCall",
  13194. "description": "A tool call to run a command on the local shell."
  13195. },
  13196. "openai__types__responses__response_input_item_param__LocalShellCallAction": {
  13197. "properties": {
  13198. "command": {
  13199. "items": {
  13200. "type": "string"
  13201. },
  13202. "type": "array",
  13203. "title": "Command"
  13204. },
  13205. "env": {
  13206. "additionalProperties": {
  13207. "type": "string"
  13208. },
  13209. "type": "object",
  13210. "title": "Env"
  13211. },
  13212. "type": {
  13213. "type": "string",
  13214. "const": "exec",
  13215. "title": "Type"
  13216. },
  13217. "timeout_ms": {
  13218. "anyOf": [
  13219. {
  13220. "type": "integer"
  13221. },
  13222. {
  13223. "type": "null"
  13224. }
  13225. ],
  13226. "title": "Timeout Ms"
  13227. },
  13228. "user": {
  13229. "anyOf": [
  13230. {
  13231. "type": "string"
  13232. },
  13233. {
  13234. "type": "null"
  13235. }
  13236. ],
  13237. "title": "User"
  13238. },
  13239. "working_directory": {
  13240. "anyOf": [
  13241. {
  13242. "type": "string"
  13243. },
  13244. {
  13245. "type": "null"
  13246. }
  13247. ],
  13248. "title": "Working Directory"
  13249. }
  13250. },
  13251. "additionalProperties": true,
  13252. "type": "object",
  13253. "required": [
  13254. "command",
  13255. "env",
  13256. "type"
  13257. ],
  13258. "title": "LocalShellCallAction",
  13259. "description": "Execute a shell command on the server."
  13260. },
  13261. "openai__types__responses__response_input_item_param__McpCall": {
  13262. "properties": {
  13263. "id": {
  13264. "type": "string",
  13265. "title": "Id"
  13266. },
  13267. "arguments": {
  13268. "type": "string",
  13269. "title": "Arguments"
  13270. },
  13271. "name": {
  13272. "type": "string",
  13273. "title": "Name"
  13274. },
  13275. "server_label": {
  13276. "type": "string",
  13277. "title": "Server Label"
  13278. },
  13279. "type": {
  13280. "type": "string",
  13281. "const": "mcp_call",
  13282. "title": "Type"
  13283. },
  13284. "approval_request_id": {
  13285. "anyOf": [
  13286. {
  13287. "type": "string"
  13288. },
  13289. {
  13290. "type": "null"
  13291. }
  13292. ],
  13293. "title": "Approval Request Id"
  13294. },
  13295. "error": {
  13296. "anyOf": [
  13297. {
  13298. "type": "string"
  13299. },
  13300. {
  13301. "type": "null"
  13302. }
  13303. ],
  13304. "title": "Error"
  13305. },
  13306. "output": {
  13307. "anyOf": [
  13308. {
  13309. "type": "string"
  13310. },
  13311. {
  13312. "type": "null"
  13313. }
  13314. ],
  13315. "title": "Output"
  13316. },
  13317. "status": {
  13318. "type": "string",
  13319. "enum": [
  13320. "in_progress",
  13321. "completed",
  13322. "incomplete",
  13323. "calling",
  13324. "failed"
  13325. ],
  13326. "title": "Status"
  13327. }
  13328. },
  13329. "additionalProperties": true,
  13330. "type": "object",
  13331. "required": [
  13332. "id",
  13333. "arguments",
  13334. "name",
  13335. "server_label",
  13336. "type"
  13337. ],
  13338. "title": "McpCall",
  13339. "description": "An invocation of a tool on an MCP server."
  13340. },
  13341. "openai__types__responses__response_input_item_param__McpListTools": {
  13342. "properties": {
  13343. "id": {
  13344. "type": "string",
  13345. "title": "Id"
  13346. },
  13347. "server_label": {
  13348. "type": "string",
  13349. "title": "Server Label"
  13350. },
  13351. "tools": {
  13352. "items": {
  13353. "$ref": "#/components/schemas/openai__types__responses__response_input_item_param__McpListToolsTool"
  13354. },
  13355. "type": "array",
  13356. "title": "Tools"
  13357. },
  13358. "type": {
  13359. "type": "string",
  13360. "const": "mcp_list_tools",
  13361. "title": "Type"
  13362. },
  13363. "error": {
  13364. "anyOf": [
  13365. {
  13366. "type": "string"
  13367. },
  13368. {
  13369. "type": "null"
  13370. }
  13371. ],
  13372. "title": "Error"
  13373. }
  13374. },
  13375. "additionalProperties": true,
  13376. "type": "object",
  13377. "required": [
  13378. "id",
  13379. "server_label",
  13380. "tools",
  13381. "type"
  13382. ],
  13383. "title": "McpListTools",
  13384. "description": "A list of tools available on an MCP server."
  13385. },
  13386. "openai__types__responses__response_input_item_param__McpListToolsTool": {
  13387. "properties": {
  13388. "input_schema": {
  13389. "title": "Input Schema"
  13390. },
  13391. "name": {
  13392. "type": "string",
  13393. "title": "Name"
  13394. },
  13395. "annotations": {
  13396. "anyOf": [
  13397. {},
  13398. {
  13399. "type": "null"
  13400. }
  13401. ],
  13402. "title": "Annotations"
  13403. },
  13404. "description": {
  13405. "anyOf": [
  13406. {
  13407. "type": "string"
  13408. },
  13409. {
  13410. "type": "null"
  13411. }
  13412. ],
  13413. "title": "Description"
  13414. }
  13415. },
  13416. "additionalProperties": true,
  13417. "type": "object",
  13418. "required": [
  13419. "input_schema",
  13420. "name"
  13421. ],
  13422. "title": "McpListToolsTool",
  13423. "description": "A tool available on an MCP server."
  13424. },
  13425. "openai__types__responses__response_input_item_param__Message": {
  13426. "properties": {
  13427. "content": {
  13428. "items": {
  13429. "anyOf": [
  13430. {
  13431. "$ref": "#/components/schemas/ResponseInputTextParam"
  13432. },
  13433. {
  13434. "$ref": "#/components/schemas/ResponseInputImageParam"
  13435. },
  13436. {
  13437. "$ref": "#/components/schemas/ResponseInputFileParam"
  13438. }
  13439. ]
  13440. },
  13441. "type": "array",
  13442. "title": "Content"
  13443. },
  13444. "role": {
  13445. "type": "string",
  13446. "enum": [
  13447. "user",
  13448. "system",
  13449. "developer"
  13450. ],
  13451. "title": "Role"
  13452. },
  13453. "status": {
  13454. "type": "string",
  13455. "enum": [
  13456. "in_progress",
  13457. "completed",
  13458. "incomplete"
  13459. ],
  13460. "title": "Status"
  13461. },
  13462. "type": {
  13463. "type": "string",
  13464. "const": "message",
  13465. "title": "Type"
  13466. }
  13467. },
  13468. "additionalProperties": true,
  13469. "type": "object",
  13470. "required": [
  13471. "content",
  13472. "role"
  13473. ],
  13474. "title": "Message",
  13475. "description": "A message input to the model with a role indicating instruction following\nhierarchy. Instructions given with the `developer` or `system` role take\nprecedence over instructions given with the `user` role."
  13476. },
  13477. "openai__types__responses__response_reasoning_item__Content": {
  13478. "properties": {
  13479. "text": {
  13480. "type": "string",
  13481. "title": "Text"
  13482. },
  13483. "type": {
  13484. "type": "string",
  13485. "const": "reasoning_text",
  13486. "title": "Type"
  13487. }
  13488. },
  13489. "additionalProperties": true,
  13490. "type": "object",
  13491. "required": [
  13492. "text",
  13493. "type"
  13494. ],
  13495. "title": "Content",
  13496. "description": "Reasoning text from the model."
  13497. },
  13498. "openai__types__responses__response_reasoning_item_param__Content": {
  13499. "properties": {
  13500. "text": {
  13501. "type": "string",
  13502. "title": "Text"
  13503. },
  13504. "type": {
  13505. "type": "string",
  13506. "const": "reasoning_text",
  13507. "title": "Type"
  13508. }
  13509. },
  13510. "additionalProperties": true,
  13511. "type": "object",
  13512. "required": [
  13513. "text",
  13514. "type"
  13515. ],
  13516. "title": "Content",
  13517. "description": "Reasoning text from the model."
  13518. },
  13519. "openai__types__responses__web_search_tool__UserLocation": {
  13520. "properties": {
  13521. "city": {
  13522. "anyOf": [
  13523. {
  13524. "type": "string"
  13525. },
  13526. {
  13527. "type": "null"
  13528. }
  13529. ],
  13530. "title": "City"
  13531. },
  13532. "country": {
  13533. "anyOf": [
  13534. {
  13535. "type": "string"
  13536. },
  13537. {
  13538. "type": "null"
  13539. }
  13540. ],
  13541. "title": "Country"
  13542. },
  13543. "region": {
  13544. "anyOf": [
  13545. {
  13546. "type": "string"
  13547. },
  13548. {
  13549. "type": "null"
  13550. }
  13551. ],
  13552. "title": "Region"
  13553. },
  13554. "timezone": {
  13555. "anyOf": [
  13556. {
  13557. "type": "string"
  13558. },
  13559. {
  13560. "type": "null"
  13561. }
  13562. ],
  13563. "title": "Timezone"
  13564. },
  13565. "type": {
  13566. "anyOf": [
  13567. {
  13568. "type": "string",
  13569. "const": "approximate"
  13570. },
  13571. {
  13572. "type": "null"
  13573. }
  13574. ],
  13575. "title": "Type"
  13576. }
  13577. },
  13578. "additionalProperties": true,
  13579. "type": "object",
  13580. "title": "UserLocation",
  13581. "description": "The approximate location of the user."
  13582. },
  13583. "openai__types__shared_params__function_definition__FunctionDefinition": {
  13584. "properties": {
  13585. "name": {
  13586. "type": "string",
  13587. "title": "Name"
  13588. },
  13589. "description": {
  13590. "type": "string",
  13591. "title": "Description"
  13592. },
  13593. "parameters": {
  13594. "additionalProperties": true,
  13595. "type": "object",
  13596. "title": "Parameters"
  13597. },
  13598. "strict": {
  13599. "anyOf": [
  13600. {
  13601. "type": "boolean"
  13602. },
  13603. {
  13604. "type": "null"
  13605. }
  13606. ],
  13607. "title": "Strict"
  13608. }
  13609. },
  13610. "additionalProperties": true,
  13611. "type": "object",
  13612. "required": [
  13613. "name"
  13614. ],
  13615. "title": "FunctionDefinition"
  13616. }
  13617. }
  13618. }
  13619. }