| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958695969606961696269636964696569666967696869696970697169726973697469756976697769786979698069816982698369846985698669876988698969906991699269936994699569966997699869997000700170027003700470057006700770087009701070117012701370147015701670177018701970207021702270237024702570267027702870297030703170327033703470357036703770387039704070417042704370447045704670477048704970507051705270537054705570567057705870597060706170627063706470657066706770687069707070717072707370747075707670777078707970807081708270837084708570867087708870897090709170927093709470957096709770987099710071017102710371047105710671077108710971107111711271137114711571167117711871197120712171227123712471257126712771287129713071317132713371347135713671377138713971407141714271437144714571467147714871497150715171527153715471557156715771587159716071617162716371647165716671677168716971707171717271737174717571767177717871797180718171827183718471857186718771887189719071917192719371947195719671977198719972007201720272037204720572067207720872097210721172127213721472157216721772187219722072217222722372247225722672277228722972307231723272337234723572367237723872397240724172427243724472457246724772487249725072517252725372547255725672577258725972607261726272637264726572667267726872697270727172727273727472757276727772787279728072817282728372847285728672877288728972907291729272937294729572967297729872997300730173027303730473057306730773087309731073117312731373147315731673177318731973207321732273237324732573267327732873297330733173327333733473357336733773387339734073417342734373447345734673477348734973507351735273537354735573567357735873597360736173627363736473657366736773687369737073717372737373747375737673777378737973807381738273837384738573867387738873897390739173927393739473957396739773987399740074017402740374047405740674077408740974107411741274137414741574167417741874197420742174227423742474257426742774287429743074317432743374347435743674377438743974407441744274437444744574467447744874497450745174527453745474557456745774587459746074617462746374647465746674677468746974707471747274737474747574767477747874797480748174827483748474857486748774887489749074917492749374947495749674977498749975007501750275037504750575067507750875097510751175127513751475157516751775187519752075217522752375247525752675277528752975307531753275337534753575367537753875397540754175427543754475457546754775487549755075517552755375547555755675577558755975607561756275637564756575667567756875697570757175727573757475757576757775787579758075817582758375847585758675877588758975907591759275937594759575967597759875997600760176027603760476057606760776087609761076117612761376147615761676177618761976207621762276237624762576267627762876297630763176327633763476357636763776387639764076417642764376447645764676477648764976507651765276537654765576567657765876597660766176627663766476657666766776687669767076717672767376747675767676777678767976807681768276837684768576867687768876897690769176927693769476957696769776987699770077017702770377047705770677077708770977107711771277137714771577167717771877197720772177227723772477257726772777287729773077317732773377347735773677377738773977407741774277437744774577467747774877497750775177527753775477557756775777587759776077617762776377647765776677677768776977707771777277737774777577767777777877797780778177827783778477857786778777887789779077917792779377947795779677977798779978007801780278037804780578067807780878097810781178127813781478157816781778187819782078217822782378247825782678277828782978307831783278337834783578367837783878397840784178427843784478457846784778487849785078517852785378547855785678577858785978607861786278637864786578667867786878697870787178727873787478757876787778787879788078817882788378847885788678877888788978907891789278937894789578967897789878997900790179027903790479057906790779087909791079117912791379147915791679177918791979207921792279237924792579267927792879297930793179327933793479357936793779387939794079417942794379447945794679477948794979507951795279537954795579567957795879597960796179627963796479657966796779687969797079717972797379747975797679777978797979807981798279837984798579867987798879897990799179927993799479957996799779987999800080018002800380048005800680078008800980108011801280138014801580168017801880198020802180228023802480258026802780288029803080318032803380348035803680378038803980408041804280438044804580468047804880498050805180528053805480558056805780588059806080618062806380648065806680678068806980708071807280738074807580768077807880798080808180828083808480858086808780888089809080918092809380948095809680978098809981008101810281038104810581068107810881098110811181128113811481158116811781188119812081218122812381248125812681278128812981308131813281338134813581368137813881398140814181428143814481458146814781488149815081518152815381548155815681578158815981608161816281638164816581668167816881698170817181728173817481758176817781788179818081818182818381848185818681878188818981908191819281938194819581968197819881998200820182028203820482058206820782088209821082118212821382148215821682178218821982208221822282238224822582268227822882298230823182328233823482358236823782388239824082418242824382448245824682478248824982508251825282538254825582568257825882598260826182628263826482658266826782688269827082718272827382748275827682778278827982808281828282838284828582868287828882898290829182928293829482958296829782988299830083018302830383048305830683078308830983108311831283138314831583168317831883198320832183228323832483258326832783288329833083318332833383348335833683378338833983408341834283438344834583468347834883498350835183528353835483558356835783588359836083618362836383648365836683678368836983708371837283738374837583768377837883798380838183828383838483858386838783888389839083918392839383948395839683978398839984008401840284038404840584068407840884098410841184128413841484158416841784188419842084218422842384248425842684278428842984308431843284338434843584368437843884398440844184428443844484458446844784488449845084518452845384548455845684578458845984608461846284638464846584668467846884698470847184728473847484758476847784788479848084818482848384848485848684878488848984908491849284938494849584968497849884998500850185028503850485058506850785088509851085118512851385148515851685178518851985208521852285238524852585268527852885298530853185328533853485358536853785388539854085418542854385448545854685478548854985508551855285538554855585568557855885598560856185628563856485658566856785688569857085718572857385748575857685778578857985808581858285838584858585868587858885898590859185928593859485958596859785988599860086018602860386048605860686078608860986108611861286138614861586168617861886198620862186228623862486258626862786288629863086318632863386348635863686378638863986408641864286438644864586468647864886498650865186528653865486558656865786588659866086618662866386648665866686678668866986708671867286738674867586768677867886798680868186828683868486858686868786888689869086918692869386948695869686978698869987008701870287038704870587068707870887098710871187128713871487158716871787188719872087218722872387248725872687278728872987308731873287338734873587368737873887398740874187428743874487458746874787488749875087518752875387548755875687578758875987608761876287638764876587668767876887698770877187728773877487758776877787788779878087818782878387848785878687878788878987908791879287938794879587968797879887998800880188028803880488058806880788088809881088118812881388148815881688178818881988208821882288238824882588268827882888298830883188328833883488358836883788388839884088418842884388448845884688478848884988508851885288538854885588568857885888598860886188628863886488658866886788688869887088718872887388748875887688778878887988808881888288838884888588868887888888898890889188928893889488958896889788988899890089018902890389048905890689078908890989108911891289138914891589168917891889198920892189228923892489258926892789288929893089318932893389348935893689378938893989408941894289438944894589468947894889498950895189528953895489558956895789588959896089618962896389648965896689678968896989708971897289738974897589768977897889798980898189828983898489858986898789888989899089918992899389948995899689978998899990009001900290039004900590069007900890099010901190129013901490159016901790189019902090219022902390249025902690279028902990309031903290339034903590369037903890399040904190429043904490459046904790489049905090519052905390549055905690579058905990609061906290639064906590669067906890699070907190729073907490759076907790789079908090819082908390849085908690879088908990909091909290939094909590969097909890999100910191029103910491059106910791089109911091119112911391149115911691179118911991209121912291239124912591269127912891299130913191329133913491359136913791389139914091419142914391449145914691479148914991509151915291539154915591569157915891599160916191629163916491659166916791689169917091719172917391749175917691779178917991809181918291839184918591869187918891899190919191929193919491959196919791989199920092019202920392049205920692079208920992109211921292139214921592169217921892199220922192229223922492259226922792289229923092319232923392349235923692379238923992409241924292439244924592469247924892499250925192529253925492559256925792589259926092619262926392649265926692679268926992709271927292739274927592769277927892799280928192829283928492859286928792889289929092919292929392949295929692979298929993009301930293039304930593069307930893099310931193129313931493159316931793189319932093219322932393249325932693279328932993309331933293339334933593369337933893399340934193429343934493459346934793489349935093519352935393549355935693579358935993609361936293639364936593669367936893699370937193729373937493759376937793789379938093819382938393849385938693879388938993909391939293939394939593969397939893999400940194029403940494059406940794089409941094119412941394149415941694179418941994209421942294239424942594269427942894299430943194329433943494359436943794389439944094419442944394449445944694479448944994509451945294539454945594569457945894599460946194629463946494659466946794689469947094719472947394749475947694779478947994809481948294839484948594869487948894899490949194929493949494959496949794989499950095019502950395049505950695079508950995109511951295139514951595169517951895199520952195229523952495259526952795289529953095319532953395349535953695379538953995409541954295439544954595469547954895499550955195529553955495559556955795589559956095619562956395649565956695679568956995709571957295739574957595769577957895799580958195829583958495859586958795889589959095919592959395949595959695979598959996009601960296039604960596069607960896099610961196129613961496159616961796189619962096219622962396249625962696279628962996309631963296339634963596369637963896399640964196429643964496459646964796489649965096519652965396549655965696579658965996609661966296639664966596669667966896699670967196729673967496759676967796789679968096819682968396849685968696879688968996909691969296939694969596969697969896999700970197029703970497059706970797089709971097119712971397149715971697179718971997209721972297239724972597269727972897299730973197329733973497359736973797389739974097419742974397449745974697479748974997509751975297539754975597569757975897599760976197629763976497659766976797689769977097719772977397749775977697779778977997809781978297839784978597869787978897899790979197929793979497959796979797989799980098019802980398049805980698079808980998109811981298139814981598169817981898199820982198229823982498259826982798289829983098319832983398349835983698379838983998409841984298439844984598469847984898499850985198529853985498559856985798589859986098619862986398649865986698679868986998709871987298739874987598769877987898799880988198829883988498859886988798889889989098919892989398949895989698979898989999009901990299039904990599069907990899099910991199129913991499159916991799189919992099219922992399249925992699279928992999309931993299339934993599369937993899399940994199429943994499459946994799489949995099519952995399549955995699579958995999609961996299639964996599669967996899699970997199729973997499759976997799789979998099819982998399849985998699879988998999909991999299939994999599969997999899991000010001100021000310004100051000610007100081000910010100111001210013100141001510016100171001810019100201002110022100231002410025100261002710028100291003010031100321003310034100351003610037100381003910040100411004210043100441004510046100471004810049100501005110052100531005410055100561005710058100591006010061100621006310064100651006610067100681006910070100711007210073100741007510076100771007810079100801008110082100831008410085100861008710088100891009010091100921009310094100951009610097100981009910100101011010210103101041010510106101071010810109101101011110112101131011410115101161011710118101191012010121101221012310124101251012610127101281012910130101311013210133101341013510136101371013810139101401014110142101431014410145101461014710148101491015010151101521015310154101551015610157101581015910160101611016210163101641016510166101671016810169101701017110172101731017410175101761017710178101791018010181101821018310184101851018610187101881018910190101911019210193101941019510196101971019810199102001020110202102031020410205102061020710208102091021010211102121021310214102151021610217102181021910220102211022210223102241022510226102271022810229102301023110232102331023410235102361023710238102391024010241102421024310244102451024610247102481024910250102511025210253102541025510256102571025810259102601026110262102631026410265102661026710268102691027010271102721027310274102751027610277102781027910280102811028210283102841028510286102871028810289102901029110292102931029410295102961029710298102991030010301103021030310304103051030610307103081030910310103111031210313103141031510316103171031810319103201032110322103231032410325103261032710328103291033010331103321033310334103351033610337103381033910340103411034210343103441034510346103471034810349103501035110352103531035410355103561035710358103591036010361103621036310364103651036610367103681036910370103711037210373103741037510376103771037810379103801038110382103831038410385103861038710388103891039010391103921039310394103951039610397103981039910400104011040210403104041040510406104071040810409104101041110412104131041410415104161041710418104191042010421104221042310424104251042610427104281042910430104311043210433104341043510436104371043810439104401044110442104431044410445104461044710448104491045010451104521045310454104551045610457104581045910460104611046210463104641046510466104671046810469104701047110472104731047410475104761047710478104791048010481104821048310484104851048610487104881048910490104911049210493104941049510496104971049810499105001050110502105031050410505105061050710508105091051010511105121051310514105151051610517105181051910520105211052210523105241052510526105271052810529105301053110532105331053410535105361053710538105391054010541105421054310544105451054610547105481054910550105511055210553105541055510556105571055810559105601056110562105631056410565105661056710568105691057010571105721057310574105751057610577105781057910580105811058210583105841058510586105871058810589105901059110592105931059410595105961059710598105991060010601106021060310604106051060610607106081060910610106111061210613106141061510616106171061810619106201062110622106231062410625106261062710628106291063010631106321063310634106351063610637106381063910640106411064210643106441064510646106471064810649106501065110652106531065410655106561065710658106591066010661106621066310664106651066610667106681066910670106711067210673106741067510676106771067810679106801068110682106831068410685106861068710688106891069010691106921069310694106951069610697106981069910700107011070210703107041070510706107071070810709107101071110712107131071410715107161071710718107191072010721107221072310724107251072610727107281072910730107311073210733107341073510736107371073810739107401074110742107431074410745107461074710748107491075010751107521075310754107551075610757107581075910760107611076210763107641076510766107671076810769107701077110772107731077410775107761077710778107791078010781107821078310784107851078610787107881078910790107911079210793107941079510796107971079810799108001080110802108031080410805108061080710808108091081010811108121081310814108151081610817108181081910820108211082210823108241082510826108271082810829108301083110832108331083410835108361083710838108391084010841108421084310844108451084610847108481084910850108511085210853108541085510856108571085810859108601086110862108631086410865108661086710868108691087010871108721087310874108751087610877108781087910880108811088210883108841088510886108871088810889108901089110892108931089410895108961089710898108991090010901109021090310904109051090610907109081090910910109111091210913109141091510916109171091810919109201092110922109231092410925109261092710928109291093010931109321093310934109351093610937109381093910940109411094210943109441094510946109471094810949109501095110952109531095410955109561095710958109591096010961109621096310964109651096610967109681096910970109711097210973109741097510976109771097810979109801098110982109831098410985109861098710988109891099010991109921099310994109951099610997109981099911000110011100211003110041100511006110071100811009110101101111012110131101411015110161101711018110191102011021110221102311024110251102611027110281102911030110311103211033110341103511036110371103811039110401104111042110431104411045110461104711048110491105011051110521105311054110551105611057110581105911060110611106211063110641106511066110671106811069110701107111072110731107411075110761107711078110791108011081110821108311084110851108611087110881108911090110911109211093110941109511096110971109811099111001110111102111031110411105111061110711108111091111011111111121111311114111151111611117111181111911120111211112211123111241112511126111271112811129111301113111132111331113411135111361113711138111391114011141111421114311144111451114611147111481114911150111511115211153111541115511156111571115811159111601116111162111631116411165111661116711168111691117011171111721117311174111751117611177111781117911180111811118211183111841118511186111871118811189111901119111192111931119411195111961119711198111991120011201112021120311204112051120611207112081120911210112111121211213112141121511216112171121811219112201122111222112231122411225112261122711228112291123011231112321123311234112351123611237112381123911240112411124211243112441124511246112471124811249112501125111252112531125411255112561125711258112591126011261112621126311264112651126611267112681126911270112711127211273112741127511276112771127811279112801128111282112831128411285112861128711288112891129011291112921129311294112951129611297112981129911300113011130211303113041130511306113071130811309113101131111312113131131411315113161131711318113191132011321113221132311324113251132611327113281132911330113311133211333113341133511336113371133811339113401134111342113431134411345113461134711348113491135011351113521135311354113551135611357113581135911360113611136211363113641136511366113671136811369113701137111372113731137411375113761137711378113791138011381113821138311384113851138611387113881138911390113911139211393113941139511396113971139811399114001140111402114031140411405114061140711408114091141011411114121141311414114151141611417114181141911420114211142211423114241142511426114271142811429114301143111432114331143411435114361143711438114391144011441114421144311444114451144611447114481144911450114511145211453114541145511456114571145811459114601146111462114631146411465114661146711468114691147011471114721147311474114751147611477114781147911480114811148211483114841148511486114871148811489114901149111492114931149411495114961149711498114991150011501115021150311504115051150611507115081150911510115111151211513115141151511516115171151811519115201152111522115231152411525115261152711528115291153011531115321153311534115351153611537115381153911540115411154211543115441154511546115471154811549115501155111552115531155411555115561155711558115591156011561115621156311564115651156611567115681156911570115711157211573115741157511576115771157811579115801158111582115831158411585115861158711588115891159011591115921159311594115951159611597115981159911600116011160211603116041160511606116071160811609116101161111612116131161411615116161161711618116191162011621116221162311624116251162611627116281162911630116311163211633116341163511636116371163811639116401164111642116431164411645116461164711648116491165011651116521165311654116551165611657116581165911660116611166211663116641166511666116671166811669116701167111672116731167411675116761167711678116791168011681116821168311684116851168611687116881168911690116911169211693116941169511696116971169811699117001170111702117031170411705117061170711708117091171011711117121171311714117151171611717117181171911720117211172211723117241172511726117271172811729117301173111732117331173411735117361173711738117391174011741117421174311744117451174611747117481174911750117511175211753117541175511756117571175811759117601176111762117631176411765117661176711768117691177011771117721177311774117751177611777117781177911780117811178211783117841178511786117871178811789117901179111792117931179411795117961179711798117991180011801118021180311804118051180611807118081180911810118111181211813118141181511816118171181811819118201182111822118231182411825118261182711828118291183011831118321183311834118351183611837118381183911840118411184211843118441184511846118471184811849118501185111852118531185411855118561185711858118591186011861118621186311864118651186611867118681186911870118711187211873118741187511876118771187811879118801188111882118831188411885118861188711888118891189011891118921189311894118951189611897118981189911900119011190211903119041190511906119071190811909119101191111912119131191411915119161191711918119191192011921119221192311924119251192611927119281192911930119311193211933119341193511936119371193811939119401194111942119431194411945119461194711948119491195011951119521195311954119551195611957119581195911960119611196211963119641196511966119671196811969119701197111972119731197411975119761197711978119791198011981119821198311984119851198611987119881198911990119911199211993119941199511996119971199811999120001200112002120031200412005120061200712008120091201012011120121201312014120151201612017120181201912020120211202212023120241202512026120271202812029120301203112032120331203412035120361203712038120391204012041120421204312044120451204612047120481204912050120511205212053120541205512056120571205812059120601206112062120631206412065120661206712068120691207012071120721207312074120751207612077120781207912080120811208212083120841208512086120871208812089120901209112092120931209412095120961209712098120991210012101121021210312104121051210612107121081210912110121111211212113121141211512116121171211812119121201212112122121231212412125121261212712128121291213012131121321213312134121351213612137121381213912140121411214212143121441214512146121471214812149121501215112152121531215412155121561215712158121591216012161121621216312164121651216612167121681216912170121711217212173121741217512176121771217812179121801218112182121831218412185121861218712188121891219012191121921219312194121951219612197121981219912200122011220212203122041220512206122071220812209122101221112212122131221412215122161221712218122191222012221122221222312224122251222612227122281222912230122311223212233122341223512236122371223812239122401224112242122431224412245122461224712248122491225012251122521225312254122551225612257122581225912260122611226212263122641226512266122671226812269122701227112272122731227412275122761227712278122791228012281122821228312284122851228612287122881228912290122911229212293122941229512296122971229812299123001230112302123031230412305123061230712308123091231012311123121231312314123151231612317123181231912320123211232212323123241232512326123271232812329123301233112332123331233412335123361233712338123391234012341123421234312344123451234612347123481234912350123511235212353123541235512356123571235812359123601236112362123631236412365123661236712368123691237012371123721237312374123751237612377123781237912380123811238212383123841238512386123871238812389123901239112392123931239412395123961239712398123991240012401124021240312404124051240612407124081240912410124111241212413124141241512416124171241812419124201242112422124231242412425124261242712428124291243012431124321243312434124351243612437124381243912440124411244212443124441244512446124471244812449124501245112452124531245412455124561245712458124591246012461124621246312464124651246612467124681246912470124711247212473124741247512476124771247812479124801248112482124831248412485124861248712488124891249012491124921249312494124951249612497124981249912500125011250212503125041250512506125071250812509125101251112512125131251412515125161251712518125191252012521125221252312524125251252612527125281252912530125311253212533125341253512536125371253812539125401254112542125431254412545125461254712548125491255012551125521255312554125551255612557125581255912560125611256212563125641256512566125671256812569125701257112572125731257412575125761257712578125791258012581125821258312584125851258612587125881258912590125911259212593125941259512596125971259812599126001260112602126031260412605126061260712608126091261012611126121261312614126151261612617126181261912620126211262212623126241262512626126271262812629126301263112632126331263412635126361263712638126391264012641126421264312644126451264612647126481264912650126511265212653126541265512656126571265812659126601266112662126631266412665126661266712668126691267012671126721267312674126751267612677126781267912680126811268212683126841268512686126871268812689126901269112692126931269412695126961269712698126991270012701127021270312704127051270612707127081270912710127111271212713127141271512716127171271812719127201272112722127231272412725127261272712728127291273012731127321273312734127351273612737127381273912740127411274212743127441274512746127471274812749127501275112752127531275412755127561275712758127591276012761127621276312764127651276612767127681276912770127711277212773127741277512776127771277812779127801278112782127831278412785127861278712788127891279012791127921279312794127951279612797127981279912800128011280212803128041280512806128071280812809128101281112812128131281412815128161281712818128191282012821128221282312824128251282612827128281282912830128311283212833128341283512836128371283812839128401284112842128431284412845128461284712848128491285012851128521285312854128551285612857128581285912860128611286212863128641286512866128671286812869128701287112872128731287412875128761287712878128791288012881128821288312884128851288612887128881288912890128911289212893128941289512896128971289812899129001290112902129031290412905129061290712908129091291012911129121291312914129151291612917129181291912920129211292212923129241292512926129271292812929129301293112932129331293412935129361293712938129391294012941129421294312944129451294612947129481294912950129511295212953129541295512956129571295812959129601296112962129631296412965129661296712968129691297012971129721297312974129751297612977129781297912980129811298212983129841298512986129871298812989129901299112992129931299412995129961299712998129991300013001130021300313004130051300613007130081300913010130111301213013130141301513016130171301813019130201302113022130231302413025130261302713028130291303013031130321303313034130351303613037130381303913040130411304213043130441304513046130471304813049130501305113052130531305413055130561305713058130591306013061130621306313064130651306613067130681306913070130711307213073130741307513076130771307813079130801308113082130831308413085130861308713088130891309013091130921309313094130951309613097130981309913100131011310213103131041310513106131071310813109131101311113112131131311413115131161311713118131191312013121131221312313124131251312613127131281312913130131311313213133131341313513136131371313813139131401314113142131431314413145131461314713148131491315013151131521315313154131551315613157131581315913160131611316213163131641316513166131671316813169131701317113172131731317413175131761317713178131791318013181131821318313184131851318613187131881318913190131911319213193131941319513196131971319813199132001320113202132031320413205132061320713208132091321013211132121321313214132151321613217132181321913220132211322213223132241322513226132271322813229132301323113232132331323413235132361323713238132391324013241132421324313244132451324613247132481324913250132511325213253132541325513256132571325813259132601326113262132631326413265132661326713268132691327013271132721327313274132751327613277132781327913280132811328213283132841328513286132871328813289132901329113292132931329413295132961329713298132991330013301133021330313304133051330613307133081330913310133111331213313133141331513316133171331813319133201332113322133231332413325133261332713328133291333013331133321333313334133351333613337133381333913340133411334213343133441334513346133471334813349133501335113352133531335413355133561335713358133591336013361133621336313364133651336613367133681336913370133711337213373133741337513376133771337813379133801338113382133831338413385133861338713388133891339013391133921339313394133951339613397133981339913400134011340213403134041340513406134071340813409134101341113412134131341413415134161341713418134191342013421134221342313424134251342613427134281342913430134311343213433134341343513436134371343813439134401344113442134431344413445134461344713448134491345013451134521345313454134551345613457134581345913460134611346213463134641346513466134671346813469134701347113472134731347413475134761347713478134791348013481134821348313484134851348613487134881348913490134911349213493134941349513496134971349813499135001350113502135031350413505135061350713508135091351013511135121351313514135151351613517135181351913520135211352213523135241352513526135271352813529135301353113532135331353413535135361353713538135391354013541135421354313544135451354613547135481354913550135511355213553135541355513556135571355813559135601356113562135631356413565135661356713568135691357013571135721357313574135751357613577135781357913580135811358213583135841358513586135871358813589135901359113592135931359413595135961359713598135991360013601136021360313604136051360613607136081360913610136111361213613136141361513616136171361813619 |
- {
- "openapi": "3.1.0",
- "info": {
- "title": "FastAPI",
- "version": "0.1.0"
- },
- "paths": {
- "/scale_elastic_ep": {
- "post": {
- "summary": "Scale Elastic Ep",
- "operationId": "scale_elastic_ep_scale_elastic_ep_post",
- "responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {
- "additionalProperties": true,
- "type": "object",
- "title": "Response 200 Scale Elastic Ep Scale Elastic Ep Post"
- }
- }
- }
- },
- "400": {
- "description": "Bad Request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorResponse"
- }
- }
- }
- },
- "408": {
- "description": "Request Timeout",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorResponse"
- }
- }
- }
- },
- "500": {
- "description": "Internal Server Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorResponse"
- }
- }
- }
- }
- }
- }
- },
- "/is_scaling_elastic_ep": {
- "post": {
- "summary": "Is Scaling Elastic Ep",
- "operationId": "is_scaling_elastic_ep_is_scaling_elastic_ep_post",
- "responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
- }
- }
- }
- },
- "/tokenize": {
- "post": {
- "summary": "Tokenize",
- "operationId": "tokenize_tokenize_post",
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/TokenizeCompletionRequest"
- },
- {
- "$ref": "#/components/schemas/TokenizeChatRequest"
- }
- ],
- "title": "Request"
- }
- }
- },
- "required": true
- },
- "responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
- },
- "400": {
- "description": "Bad Request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorResponse"
- }
- }
- }
- },
- "404": {
- "description": "Not Found",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorResponse"
- }
- }
- }
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- },
- "500": {
- "description": "Internal Server Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorResponse"
- }
- }
- }
- },
- "501": {
- "description": "Not Implemented",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorResponse"
- }
- }
- }
- }
- }
- }
- },
- "/detokenize": {
- "post": {
- "summary": "Detokenize",
- "operationId": "detokenize_detokenize_post",
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/DetokenizeRequest"
- }
- }
- },
- "required": true
- },
- "responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
- },
- "400": {
- "description": "Bad Request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorResponse"
- }
- }
- }
- },
- "404": {
- "description": "Not Found",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorResponse"
- }
- }
- }
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- },
- "500": {
- "description": "Internal Server Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorResponse"
- }
- }
- }
- }
- }
- }
- },
- "/inference/v1/generate": {
- "post": {
- "summary": "Generate",
- "operationId": "generate_inference_v1_generate_post",
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/GenerateRequest"
- }
- }
- },
- "required": true
- },
- "responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {}
- },
- "text/event-stream": {}
- }
- },
- "400": {
- "description": "Bad Request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorResponse"
- }
- }
- }
- },
- "404": {
- "description": "Not Found",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorResponse"
- }
- }
- }
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- },
- "500": {
- "description": "Internal Server Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorResponse"
- }
- }
- }
- }
- }
- }
- },
- "/pause": {
- "post": {
- "summary": "Pause Generation",
- "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.",
- "operationId": "pause_generation_pause_post",
- "parameters": [
- {
- "name": "wait_for_inflight_requests",
- "in": "query",
- "required": false,
- "schema": {
- "type": "boolean",
- "default": false,
- "title": "Wait For Inflight Requests"
- }
- },
- {
- "name": "clear_cache",
- "in": "query",
- "required": false,
- "schema": {
- "type": "boolean",
- "default": true,
- "title": "Clear Cache"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- }
- }
- }
- },
- "/resume": {
- "post": {
- "summary": "Resume Generation",
- "description": "Resume generation after a pause.",
- "operationId": "resume_generation_resume_post",
- "responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
- }
- }
- }
- },
- "/is_paused": {
- "get": {
- "summary": "Is Paused",
- "description": "Return the current pause status.",
- "operationId": "is_paused_is_paused_get",
- "responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
- }
- }
- }
- },
- "/metrics": {
- "get": {
- "summary": "Metrics",
- "description": "Endpoint that serves Prometheus metrics.",
- "operationId": "metrics_metrics_get",
- "responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "text/plain; version=1.0.0; charset=utf-8": {
- "schema": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- },
- "/health": {
- "get": {
- "summary": "Health",
- "description": "Health check.",
- "operationId": "health_health_get",
- "responses": {
- "200": {
- "description": "Successful Response"
- }
- }
- }
- },
- "/load": {
- "get": {
- "summary": "Get Server Load Metrics",
- "operationId": "get_server_load_metrics_load_get",
- "responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
- }
- }
- }
- },
- "/v1/models": {
- "get": {
- "summary": "Show Available Models",
- "operationId": "show_available_models_v1_models_get",
- "responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
- }
- }
- }
- },
- "/version": {
- "get": {
- "summary": "Show Version",
- "operationId": "show_version_version_get",
- "responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
- }
- }
- }
- },
- "/v1/responses": {
- "post": {
- "summary": "Create Responses",
- "operationId": "create_responses_v1_responses_post",
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ResponsesRequest"
- }
- }
- },
- "required": true
- },
- "responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {}
- },
- "text/event-stream": {}
- }
- },
- "400": {
- "description": "Bad Request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorResponse"
- }
- }
- }
- },
- "404": {
- "description": "Not Found",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorResponse"
- }
- }
- }
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- },
- "500": {
- "description": "Internal Server Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorResponse"
- }
- }
- }
- }
- }
- }
- },
- "/v1/responses/{response_id}": {
- "get": {
- "summary": "Retrieve Responses",
- "operationId": "retrieve_responses_v1_responses__response_id__get",
- "parameters": [
- {
- "name": "response_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "title": "Response Id"
- }
- },
- {
- "name": "starting_after",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "integer"
- },
- {
- "type": "null"
- }
- ],
- "title": "Starting After"
- }
- },
- {
- "name": "stream",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ],
- "default": false,
- "title": "Stream"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- }
- }
- }
- },
- "/v1/responses/{response_id}/cancel": {
- "post": {
- "summary": "Cancel Responses",
- "operationId": "cancel_responses_v1_responses__response_id__cancel_post",
- "parameters": [
- {
- "name": "response_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "title": "Response Id"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- }
- }
- }
- },
- "/v1/messages": {
- "post": {
- "summary": "Create Messages",
- "operationId": "create_messages_v1_messages_post",
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/AnthropicMessagesRequest"
- }
- }
- },
- "required": true
- },
- "responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {}
- },
- "text/event-stream": {}
- }
- },
- "400": {
- "description": "Bad Request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/AnthropicErrorResponse"
- }
- }
- }
- },
- "404": {
- "description": "Not Found",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/AnthropicErrorResponse"
- }
- }
- }
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- },
- "500": {
- "description": "Internal Server Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/AnthropicErrorResponse"
- }
- }
- }
- }
- }
- }
- },
- "/v1/chat/completions": {
- "post": {
- "summary": "Create Chat Completion",
- "operationId": "create_chat_completion_v1_chat_completions_post",
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ChatCompletionRequest"
- }
- }
- },
- "required": true
- },
- "responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {}
- },
- "text/event-stream": {}
- }
- },
- "400": {
- "description": "Bad Request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorResponse"
- }
- }
- }
- },
- "404": {
- "description": "Not Found",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorResponse"
- }
- }
- }
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- },
- "500": {
- "description": "Internal Server Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorResponse"
- }
- }
- }
- }
- }
- }
- },
- "/v1/completions": {
- "post": {
- "summary": "Create Completion",
- "operationId": "create_completion_v1_completions_post",
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CompletionRequest"
- }
- }
- },
- "required": true
- },
- "responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {}
- },
- "text/event-stream": {}
- }
- },
- "400": {
- "description": "Bad Request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorResponse"
- }
- }
- }
- },
- "404": {
- "description": "Not Found",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorResponse"
- }
- }
- }
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- },
- "500": {
- "description": "Internal Server Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorResponse"
- }
- }
- }
- }
- }
- }
- },
- "/v1/audio/transcriptions": {
- "post": {
- "summary": "Create Transcriptions",
- "operationId": "create_transcriptions_v1_audio_transcriptions_post",
- "requestBody": {
- "content": {
- "application/x-www-form-urlencoded": {
- "schema": {
- "$ref": "#/components/schemas/TranscriptionRequest"
- }
- }
- },
- "required": true
- },
- "responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {}
- },
- "text/event-stream": {}
- }
- },
- "400": {
- "description": "Bad Request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorResponse"
- }
- }
- }
- },
- "422": {
- "description": "Unprocessable Entity",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorResponse"
- }
- }
- }
- },
- "500": {
- "description": "Internal Server Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorResponse"
- }
- }
- }
- }
- }
- }
- },
- "/v1/audio/translations": {
- "post": {
- "summary": "Create Translations",
- "operationId": "create_translations_v1_audio_translations_post",
- "requestBody": {
- "content": {
- "application/x-www-form-urlencoded": {
- "schema": {
- "$ref": "#/components/schemas/TranslationRequest"
- }
- }
- },
- "required": true
- },
- "responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {}
- },
- "text/event-stream": {}
- }
- },
- "400": {
- "description": "Bad Request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorResponse"
- }
- }
- }
- },
- "422": {
- "description": "Unprocessable Entity",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorResponse"
- }
- }
- }
- },
- "500": {
- "description": "Internal Server Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorResponse"
- }
- }
- }
- }
- }
- }
- },
- "/ping": {
- "get": {
- "summary": "Ping",
- "description": "Ping check. Endpoint required for SageMaker",
- "operationId": "ping_ping_get",
- "responses": {
- "200": {
- "description": "Successful Response"
- }
- }
- },
- "post": {
- "summary": "Ping",
- "description": "Ping check. Endpoint required for SageMaker",
- "operationId": "ping_ping_post",
- "responses": {
- "200": {
- "description": "Successful Response"
- }
- }
- }
- },
- "/invocations": {
- "post": {
- "summary": "Decorated Func",
- "description": "The actual wrapped handler function that applies transformations.",
- "operationId": "decorated_func_invocations_post",
- "responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
- },
- "400": {
- "description": "Bad Request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorResponse"
- }
- }
- }
- },
- "415": {
- "description": "Unsupported Media Type",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorResponse"
- }
- }
- }
- },
- "500": {
- "description": "Internal Server Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorResponse"
- }
- }
- }
- }
- }
- }
- },
- "/classify": {
- "post": {
- "summary": "Create Classify",
- "operationId": "create_classify_classify_post",
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/ClassificationCompletionRequest"
- },
- {
- "$ref": "#/components/schemas/ClassificationChatRequest"
- }
- ],
- "title": "Request"
- }
- }
- },
- "required": true
- },
- "responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- }
- }
- }
- },
- "/v1/embeddings": {
- "post": {
- "summary": "Create Embedding",
- "operationId": "create_embedding_v1_embeddings_post",
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/EmbeddingCompletionRequest"
- },
- {
- "$ref": "#/components/schemas/EmbeddingChatRequest"
- }
- ],
- "title": "Request"
- }
- }
- },
- "required": true
- },
- "responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
- },
- "400": {
- "description": "Bad Request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorResponse"
- }
- }
- }
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- },
- "500": {
- "description": "Internal Server Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorResponse"
- }
- }
- }
- }
- }
- }
- },
- "/score": {
- "post": {
- "summary": "Create Score",
- "operationId": "create_score_score_post",
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ScoreRequest"
- }
- }
- },
- "required": true
- },
- "responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
- },
- "400": {
- "description": "Bad Request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorResponse"
- }
- }
- }
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- },
- "500": {
- "description": "Internal Server Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorResponse"
- }
- }
- }
- }
- }
- }
- },
- "/v1/score": {
- "post": {
- "summary": "Create Score V1",
- "operationId": "create_score_v1_v1_score_post",
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ScoreRequest"
- }
- }
- },
- "required": true
- },
- "responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
- },
- "400": {
- "description": "Bad Request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorResponse"
- }
- }
- }
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- },
- "500": {
- "description": "Internal Server Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorResponse"
- }
- }
- }
- }
- }
- }
- },
- "/rerank": {
- "post": {
- "summary": "Do Rerank",
- "operationId": "do_rerank_rerank_post",
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/RerankRequest"
- }
- }
- },
- "required": true
- },
- "responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
- },
- "400": {
- "description": "Bad Request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorResponse"
- }
- }
- }
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- },
- "500": {
- "description": "Internal Server Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorResponse"
- }
- }
- }
- }
- }
- }
- },
- "/v1/rerank": {
- "post": {
- "summary": "Do Rerank V1",
- "operationId": "do_rerank_v1_v1_rerank_post",
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/RerankRequest"
- }
- }
- },
- "required": true
- },
- "responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
- },
- "400": {
- "description": "Bad Request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorResponse"
- }
- }
- }
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- },
- "500": {
- "description": "Internal Server Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorResponse"
- }
- }
- }
- }
- }
- }
- },
- "/v2/rerank": {
- "post": {
- "summary": "Do Rerank V2",
- "operationId": "do_rerank_v2_v2_rerank_post",
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/RerankRequest"
- }
- }
- },
- "required": true
- },
- "responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
- },
- "400": {
- "description": "Bad Request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorResponse"
- }
- }
- }
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- },
- "500": {
- "description": "Internal Server Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorResponse"
- }
- }
- }
- }
- }
- }
- },
- "/pooling": {
- "post": {
- "summary": "Create Pooling",
- "operationId": "create_pooling_pooling_post",
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/PoolingCompletionRequest"
- },
- {
- "$ref": "#/components/schemas/PoolingChatRequest"
- },
- {
- "$ref": "#/components/schemas/IOProcessorRequest"
- }
- ],
- "title": "Request"
- }
- }
- },
- "required": true
- },
- "responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {}
- }
- }
- },
- "400": {
- "description": "Bad Request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorResponse"
- }
- }
- }
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/HTTPValidationError"
- }
- }
- }
- },
- "500": {
- "description": "Internal Server Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ErrorResponse"
- }
- }
- }
- }
- }
- }
- }
- },
- "components": {
- "schemas": {
- "Action": {
- "properties": {
- "commands": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "title": "Commands"
- },
- "max_output_length": {
- "anyOf": [
- {
- "type": "integer"
- },
- {
- "type": "null"
- }
- ],
- "title": "Max Output Length"
- },
- "timeout_ms": {
- "anyOf": [
- {
- "type": "integer"
- },
- {
- "type": "null"
- }
- ],
- "title": "Timeout Ms"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "commands"
- ],
- "title": "Action",
- "description": "The shell commands and limits that describe how to run the tool call."
- },
- "ActionClick": {
- "properties": {
- "button": {
- "type": "string",
- "enum": [
- "left",
- "right",
- "wheel",
- "back",
- "forward"
- ],
- "title": "Button"
- },
- "type": {
- "type": "string",
- "const": "click",
- "title": "Type"
- },
- "x": {
- "type": "integer",
- "title": "X"
- },
- "y": {
- "type": "integer",
- "title": "Y"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "button",
- "type",
- "x",
- "y"
- ],
- "title": "ActionClick",
- "description": "A click action."
- },
- "ActionDoubleClick": {
- "properties": {
- "type": {
- "type": "string",
- "const": "double_click",
- "title": "Type"
- },
- "x": {
- "type": "integer",
- "title": "X"
- },
- "y": {
- "type": "integer",
- "title": "Y"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "type",
- "x",
- "y"
- ],
- "title": "ActionDoubleClick",
- "description": "A double click action."
- },
- "ActionDrag": {
- "properties": {
- "path": {
- "items": {
- "$ref": "#/components/schemas/ActionDragPath"
- },
- "type": "array",
- "title": "Path"
- },
- "type": {
- "type": "string",
- "const": "drag",
- "title": "Type"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "path",
- "type"
- ],
- "title": "ActionDrag",
- "description": "A drag action."
- },
- "ActionDragPath": {
- "properties": {
- "x": {
- "type": "integer",
- "title": "X"
- },
- "y": {
- "type": "integer",
- "title": "Y"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "x",
- "y"
- ],
- "title": "ActionDragPath",
- "description": "An x/y coordinate pair, e.g. `{ x: 100, y: 200 }`."
- },
- "ActionFind": {
- "properties": {
- "pattern": {
- "type": "string",
- "title": "Pattern"
- },
- "type": {
- "type": "string",
- "const": "find",
- "title": "Type"
- },
- "url": {
- "type": "string",
- "title": "Url"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "pattern",
- "type",
- "url"
- ],
- "title": "ActionFind",
- "description": "Action type \"find\": Searches for a pattern within a loaded page."
- },
- "ActionKeypress": {
- "properties": {
- "keys": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "title": "Keys"
- },
- "type": {
- "type": "string",
- "const": "keypress",
- "title": "Type"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "keys",
- "type"
- ],
- "title": "ActionKeypress",
- "description": "A collection of keypresses the model would like to perform."
- },
- "ActionMove": {
- "properties": {
- "type": {
- "type": "string",
- "const": "move",
- "title": "Type"
- },
- "x": {
- "type": "integer",
- "title": "X"
- },
- "y": {
- "type": "integer",
- "title": "Y"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "type",
- "x",
- "y"
- ],
- "title": "ActionMove",
- "description": "A mouse move action."
- },
- "ActionOpenPage": {
- "properties": {
- "type": {
- "type": "string",
- "const": "open_page",
- "title": "Type"
- },
- "url": {
- "type": "string",
- "title": "Url"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "type",
- "url"
- ],
- "title": "ActionOpenPage",
- "description": "Action type \"open_page\" - Opens a specific URL from search results."
- },
- "ActionScreenshot": {
- "properties": {
- "type": {
- "type": "string",
- "const": "screenshot",
- "title": "Type"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "type"
- ],
- "title": "ActionScreenshot",
- "description": "A screenshot action."
- },
- "ActionScroll": {
- "properties": {
- "scroll_x": {
- "type": "integer",
- "title": "Scroll X"
- },
- "scroll_y": {
- "type": "integer",
- "title": "Scroll Y"
- },
- "type": {
- "type": "string",
- "const": "scroll",
- "title": "Type"
- },
- "x": {
- "type": "integer",
- "title": "X"
- },
- "y": {
- "type": "integer",
- "title": "Y"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "scroll_x",
- "scroll_y",
- "type",
- "x",
- "y"
- ],
- "title": "ActionScroll",
- "description": "A scroll action."
- },
- "ActionSearch": {
- "properties": {
- "query": {
- "type": "string",
- "title": "Query"
- },
- "type": {
- "type": "string",
- "const": "search",
- "title": "Type"
- },
- "queries": {
- "anyOf": [
- {
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- {
- "type": "null"
- }
- ],
- "title": "Queries"
- },
- "sources": {
- "anyOf": [
- {
- "items": {
- "$ref": "#/components/schemas/ActionSearchSource"
- },
- "type": "array"
- },
- {
- "type": "null"
- }
- ],
- "title": "Sources"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "query",
- "type"
- ],
- "title": "ActionSearch",
- "description": "Action type \"search\" - Performs a web search query."
- },
- "ActionSearchSource": {
- "properties": {
- "type": {
- "type": "string",
- "const": "url",
- "title": "Type"
- },
- "url": {
- "type": "string",
- "title": "Url"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "type",
- "url"
- ],
- "title": "ActionSearchSource",
- "description": "A source used in the search."
- },
- "ActionType": {
- "properties": {
- "text": {
- "type": "string",
- "title": "Text"
- },
- "type": {
- "type": "string",
- "const": "type",
- "title": "Type"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "text",
- "type"
- ],
- "title": "ActionType",
- "description": "An action to type in text."
- },
- "ActionWait": {
- "properties": {
- "type": {
- "type": "string",
- "const": "wait",
- "title": "Type"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "type"
- ],
- "title": "ActionWait",
- "description": "A wait action."
- },
- "AnnotationContainerFileCitation": {
- "properties": {
- "container_id": {
- "type": "string",
- "title": "Container Id"
- },
- "end_index": {
- "type": "integer",
- "title": "End Index"
- },
- "file_id": {
- "type": "string",
- "title": "File Id"
- },
- "filename": {
- "type": "string",
- "title": "Filename"
- },
- "start_index": {
- "type": "integer",
- "title": "Start Index"
- },
- "type": {
- "type": "string",
- "const": "container_file_citation",
- "title": "Type"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "container_id",
- "end_index",
- "file_id",
- "filename",
- "start_index",
- "type"
- ],
- "title": "AnnotationContainerFileCitation",
- "description": "A citation for a container file used to generate a model response."
- },
- "AnnotationFileCitation": {
- "properties": {
- "file_id": {
- "type": "string",
- "title": "File Id"
- },
- "filename": {
- "type": "string",
- "title": "Filename"
- },
- "index": {
- "type": "integer",
- "title": "Index"
- },
- "type": {
- "type": "string",
- "const": "file_citation",
- "title": "Type"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "file_id",
- "filename",
- "index",
- "type"
- ],
- "title": "AnnotationFileCitation",
- "description": "A citation to a file."
- },
- "AnnotationFilePath": {
- "properties": {
- "file_id": {
- "type": "string",
- "title": "File Id"
- },
- "index": {
- "type": "integer",
- "title": "Index"
- },
- "type": {
- "type": "string",
- "const": "file_path",
- "title": "Type"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "file_id",
- "index",
- "type"
- ],
- "title": "AnnotationFilePath",
- "description": "A path to a file."
- },
- "AnnotationURLCitation": {
- "properties": {
- "end_index": {
- "type": "integer",
- "title": "End Index"
- },
- "start_index": {
- "type": "integer",
- "title": "Start Index"
- },
- "title": {
- "type": "string",
- "title": "Title"
- },
- "type": {
- "type": "string",
- "const": "url_citation",
- "title": "Type"
- },
- "url": {
- "type": "string",
- "title": "Url"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "end_index",
- "start_index",
- "title",
- "type",
- "url"
- ],
- "title": "AnnotationURLCitation",
- "description": "A citation for a web resource used to generate a model response."
- },
- "AnthropicContentBlock": {
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "text",
- "image",
- "tool_use",
- "tool_result"
- ],
- "title": "Type"
- },
- "text": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Text"
- },
- "source": {
- "anyOf": [
- {
- "additionalProperties": true,
- "type": "object"
- },
- {
- "type": "null"
- }
- ],
- "title": "Source"
- },
- "id": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Id"
- },
- "name": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Name"
- },
- "input": {
- "anyOf": [
- {
- "additionalProperties": true,
- "type": "object"
- },
- {
- "type": "null"
- }
- ],
- "title": "Input"
- },
- "content": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "items": {
- "additionalProperties": true,
- "type": "object"
- },
- "type": "array"
- },
- {
- "type": "null"
- }
- ],
- "title": "Content"
- },
- "is_error": {
- "anyOf": [
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ],
- "title": "Is Error"
- }
- },
- "type": "object",
- "required": [
- "type"
- ],
- "title": "AnthropicContentBlock",
- "description": "Content block in message"
- },
- "AnthropicError": {
- "properties": {
- "type": {
- "type": "string",
- "title": "Type"
- },
- "message": {
- "type": "string",
- "title": "Message"
- }
- },
- "type": "object",
- "required": [
- "type",
- "message"
- ],
- "title": "AnthropicError",
- "description": "Error structure for Anthropic API"
- },
- "AnthropicErrorResponse": {
- "properties": {
- "type": {
- "type": "string",
- "const": "error",
- "title": "Type",
- "default": "error"
- },
- "error": {
- "$ref": "#/components/schemas/AnthropicError"
- }
- },
- "type": "object",
- "required": [
- "error"
- ],
- "title": "AnthropicErrorResponse",
- "description": "Error response structure for Anthropic API"
- },
- "AnthropicMessage": {
- "properties": {
- "role": {
- "type": "string",
- "enum": [
- "user",
- "assistant"
- ],
- "title": "Role"
- },
- "content": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "items": {
- "$ref": "#/components/schemas/AnthropicContentBlock"
- },
- "type": "array"
- }
- ],
- "title": "Content"
- }
- },
- "type": "object",
- "required": [
- "role",
- "content"
- ],
- "title": "AnthropicMessage",
- "description": "Message structure"
- },
- "AnthropicMessagesRequest": {
- "properties": {
- "model": {
- "type": "string",
- "title": "Model"
- },
- "messages": {
- "items": {
- "$ref": "#/components/schemas/AnthropicMessage"
- },
- "type": "array",
- "title": "Messages"
- },
- "max_tokens": {
- "type": "integer",
- "title": "Max Tokens"
- },
- "metadata": {
- "anyOf": [
- {
- "additionalProperties": true,
- "type": "object"
- },
- {
- "type": "null"
- }
- ],
- "title": "Metadata"
- },
- "stop_sequences": {
- "anyOf": [
- {
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- {
- "type": "null"
- }
- ],
- "title": "Stop Sequences"
- },
- "stream": {
- "anyOf": [
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ],
- "title": "Stream",
- "default": false
- },
- "system": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "items": {
- "$ref": "#/components/schemas/AnthropicContentBlock"
- },
- "type": "array"
- },
- {
- "type": "null"
- }
- ],
- "title": "System"
- },
- "temperature": {
- "anyOf": [
- {
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "title": "Temperature"
- },
- "tool_choice": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/AnthropicToolChoice"
- },
- {
- "type": "null"
- }
- ]
- },
- "tools": {
- "anyOf": [
- {
- "items": {
- "$ref": "#/components/schemas/AnthropicTool"
- },
- "type": "array"
- },
- {
- "type": "null"
- }
- ],
- "title": "Tools"
- },
- "top_k": {
- "anyOf": [
- {
- "type": "integer"
- },
- {
- "type": "null"
- }
- ],
- "title": "Top K"
- },
- "top_p": {
- "anyOf": [
- {
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "title": "Top P"
- }
- },
- "type": "object",
- "required": [
- "model",
- "messages",
- "max_tokens"
- ],
- "title": "AnthropicMessagesRequest",
- "description": "Anthropic Messages API request"
- },
- "AnthropicTool": {
- "properties": {
- "name": {
- "type": "string",
- "title": "Name"
- },
- "description": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Description"
- },
- "input_schema": {
- "additionalProperties": true,
- "type": "object",
- "title": "Input Schema"
- }
- },
- "type": "object",
- "required": [
- "name",
- "input_schema"
- ],
- "title": "AnthropicTool",
- "description": "Tool definition"
- },
- "AnthropicToolChoice": {
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "auto",
- "any",
- "tool"
- ],
- "title": "Type"
- },
- "name": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Name"
- }
- },
- "type": "object",
- "required": [
- "type"
- ],
- "title": "AnthropicToolChoice",
- "description": "Tool Choice definition"
- },
- "ApplyPatchCall": {
- "properties": {
- "call_id": {
- "type": "string",
- "title": "Call Id"
- },
- "operation": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/ApplyPatchCallOperationCreateFile"
- },
- {
- "$ref": "#/components/schemas/ApplyPatchCallOperationDeleteFile"
- },
- {
- "$ref": "#/components/schemas/ApplyPatchCallOperationUpdateFile"
- }
- ],
- "title": "Operation"
- },
- "status": {
- "type": "string",
- "enum": [
- "in_progress",
- "completed"
- ],
- "title": "Status"
- },
- "type": {
- "type": "string",
- "const": "apply_patch_call",
- "title": "Type"
- },
- "id": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Id"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "call_id",
- "operation",
- "status",
- "type"
- ],
- "title": "ApplyPatchCall",
- "description": "A tool call representing a request to create, delete, or update files using diff patches."
- },
- "ApplyPatchCallOperationCreateFile": {
- "properties": {
- "diff": {
- "type": "string",
- "title": "Diff"
- },
- "path": {
- "type": "string",
- "title": "Path"
- },
- "type": {
- "type": "string",
- "const": "create_file",
- "title": "Type"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "diff",
- "path",
- "type"
- ],
- "title": "ApplyPatchCallOperationCreateFile",
- "description": "Instruction for creating a new file via the apply_patch tool."
- },
- "ApplyPatchCallOperationDeleteFile": {
- "properties": {
- "path": {
- "type": "string",
- "title": "Path"
- },
- "type": {
- "type": "string",
- "const": "delete_file",
- "title": "Type"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "path",
- "type"
- ],
- "title": "ApplyPatchCallOperationDeleteFile",
- "description": "Instruction for deleting an existing file via the apply_patch tool."
- },
- "ApplyPatchCallOperationUpdateFile": {
- "properties": {
- "diff": {
- "type": "string",
- "title": "Diff"
- },
- "path": {
- "type": "string",
- "title": "Path"
- },
- "type": {
- "type": "string",
- "const": "update_file",
- "title": "Type"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "diff",
- "path",
- "type"
- ],
- "title": "ApplyPatchCallOperationUpdateFile",
- "description": "Instruction for updating an existing file via the apply_patch tool."
- },
- "ApplyPatchCallOutput": {
- "properties": {
- "call_id": {
- "type": "string",
- "title": "Call Id"
- },
- "status": {
- "type": "string",
- "enum": [
- "completed",
- "failed"
- ],
- "title": "Status"
- },
- "type": {
- "type": "string",
- "const": "apply_patch_call_output",
- "title": "Type"
- },
- "id": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Id"
- },
- "output": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Output"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "call_id",
- "status",
- "type"
- ],
- "title": "ApplyPatchCallOutput",
- "description": "The streamed output emitted by an apply patch tool call."
- },
- "ApplyPatchTool": {
- "properties": {
- "type": {
- "type": "string",
- "const": "apply_patch",
- "title": "Type"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "type"
- ],
- "title": "ApplyPatchTool",
- "description": "Allows the assistant to create, delete, or update files using unified diffs."
- },
- "Audio": {
- "properties": {
- "id": {
- "type": "string",
- "title": "Id"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "id"
- ],
- "title": "Audio",
- "description": "Data about a previous audio response from the model.\n[Learn more](https://platform.openai.com/docs/guides/audio)."
- },
- "AudioURL": {
- "properties": {
- "url": {
- "type": "string",
- "title": "Url"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "url"
- ],
- "title": "AudioURL"
- },
- "Author": {
- "properties": {
- "role": {
- "$ref": "#/components/schemas/Role"
- },
- "name": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Name"
- }
- },
- "type": "object",
- "required": [
- "role"
- ],
- "title": "Author"
- },
- "ChatCompletionAssistantMessageParam": {
- "properties": {
- "role": {
- "type": "string",
- "const": "assistant",
- "title": "Role"
- },
- "audio": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/Audio"
- },
- {
- "type": "null"
- }
- ]
- },
- "content": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "items": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/ChatCompletionContentPartTextParam"
- },
- {
- "$ref": "#/components/schemas/ChatCompletionContentPartRefusalParam"
- }
- ]
- },
- "type": "array"
- },
- {
- "type": "null"
- }
- ],
- "title": "Content"
- },
- "function_call": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/FunctionCall"
- },
- {
- "type": "null"
- }
- ]
- },
- "name": {
- "type": "string",
- "title": "Name"
- },
- "refusal": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Refusal"
- },
- "tool_calls": {
- "items": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/ChatCompletionMessageFunctionToolCallParam"
- },
- {
- "$ref": "#/components/schemas/ChatCompletionMessageCustomToolCallParam"
- }
- ]
- },
- "type": "array",
- "title": "Tool Calls"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "role"
- ],
- "title": "ChatCompletionAssistantMessageParam",
- "description": "Messages sent by the model in response to user messages."
- },
- "ChatCompletionContentPartAudioEmbedsParam": {
- "properties": {
- "audio_embeds": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "additionalProperties": {
- "type": "string"
- },
- "type": "object"
- },
- {
- "type": "null"
- }
- ],
- "title": "Audio Embeds"
- },
- "type": {
- "type": "string",
- "const": "audio_embeds",
- "title": "Type"
- },
- "uuid": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Uuid"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "type"
- ],
- "title": "ChatCompletionContentPartAudioEmbedsParam"
- },
- "ChatCompletionContentPartAudioParam": {
- "properties": {
- "audio_url": {
- "$ref": "#/components/schemas/AudioURL"
- },
- "type": {
- "type": "string",
- "const": "audio_url",
- "title": "Type"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "audio_url",
- "type"
- ],
- "title": "ChatCompletionContentPartAudioParam"
- },
- "ChatCompletionContentPartImageEmbedsParam": {
- "properties": {
- "image_embeds": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "additionalProperties": {
- "type": "string"
- },
- "type": "object"
- },
- {
- "type": "null"
- }
- ],
- "title": "Image Embeds"
- },
- "type": {
- "type": "string",
- "const": "image_embeds",
- "title": "Type"
- },
- "uuid": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Uuid"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "type"
- ],
- "title": "ChatCompletionContentPartImageEmbedsParam"
- },
- "ChatCompletionContentPartImageParam": {
- "properties": {
- "image_url": {
- "$ref": "#/components/schemas/ImageURL"
- },
- "type": {
- "type": "string",
- "const": "image_url",
- "title": "Type"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "image_url",
- "type"
- ],
- "title": "ChatCompletionContentPartImageParam",
- "description": "Learn about [image inputs](https://platform.openai.com/docs/guides/vision)."
- },
- "ChatCompletionContentPartInputAudioParam": {
- "properties": {
- "input_audio": {
- "$ref": "#/components/schemas/InputAudio"
- },
- "type": {
- "type": "string",
- "const": "input_audio",
- "title": "Type"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "input_audio",
- "type"
- ],
- "title": "ChatCompletionContentPartInputAudioParam",
- "description": "Learn about [audio inputs](https://platform.openai.com/docs/guides/audio)."
- },
- "ChatCompletionContentPartRefusalParam": {
- "properties": {
- "refusal": {
- "type": "string",
- "title": "Refusal"
- },
- "type": {
- "type": "string",
- "const": "refusal",
- "title": "Type"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "refusal",
- "type"
- ],
- "title": "ChatCompletionContentPartRefusalParam"
- },
- "ChatCompletionContentPartTextParam": {
- "properties": {
- "text": {
- "type": "string",
- "title": "Text"
- },
- "type": {
- "type": "string",
- "const": "text",
- "title": "Type"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "text",
- "type"
- ],
- "title": "ChatCompletionContentPartTextParam",
- "description": "Learn about [text inputs](https://platform.openai.com/docs/guides/text-generation)."
- },
- "ChatCompletionContentPartVideoParam": {
- "properties": {
- "video_url": {
- "$ref": "#/components/schemas/VideoURL"
- },
- "type": {
- "type": "string",
- "const": "video_url",
- "title": "Type"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "video_url",
- "type"
- ],
- "title": "ChatCompletionContentPartVideoParam"
- },
- "ChatCompletionDeveloperMessageParam": {
- "properties": {
- "content": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "items": {
- "$ref": "#/components/schemas/ChatCompletionContentPartTextParam"
- },
- "type": "array"
- }
- ],
- "title": "Content"
- },
- "role": {
- "type": "string",
- "const": "developer",
- "title": "Role"
- },
- "name": {
- "type": "string",
- "title": "Name"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "content",
- "role"
- ],
- "title": "ChatCompletionDeveloperMessageParam",
- "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."
- },
- "ChatCompletionFunctionMessageParam": {
- "properties": {
- "content": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Content"
- },
- "name": {
- "type": "string",
- "title": "Name"
- },
- "role": {
- "type": "string",
- "const": "function",
- "title": "Role"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "content",
- "name",
- "role"
- ],
- "title": "ChatCompletionFunctionMessageParam"
- },
- "ChatCompletionFunctionToolParam": {
- "properties": {
- "function": {
- "$ref": "#/components/schemas/openai__types__shared_params__function_definition__FunctionDefinition"
- },
- "type": {
- "type": "string",
- "const": "function",
- "title": "Type"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "function",
- "type"
- ],
- "title": "ChatCompletionFunctionToolParam",
- "description": "A function tool that can be used to generate a response."
- },
- "ChatCompletionMessageCustomToolCallParam": {
- "properties": {
- "id": {
- "type": "string",
- "title": "Id"
- },
- "custom": {
- "$ref": "#/components/schemas/Custom"
- },
- "type": {
- "type": "string",
- "const": "custom",
- "title": "Type"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "id",
- "custom",
- "type"
- ],
- "title": "ChatCompletionMessageCustomToolCallParam",
- "description": "A call to a custom tool created by the model."
- },
- "ChatCompletionMessageFunctionToolCallParam": {
- "properties": {
- "id": {
- "type": "string",
- "title": "Id"
- },
- "function": {
- "$ref": "#/components/schemas/Function"
- },
- "type": {
- "type": "string",
- "const": "function",
- "title": "Type"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "id",
- "function",
- "type"
- ],
- "title": "ChatCompletionMessageFunctionToolCallParam",
- "description": "A call to a function tool created by the model."
- },
- "ChatCompletionNamedFunction": {
- "properties": {
- "name": {
- "type": "string",
- "title": "Name"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "name"
- ],
- "title": "ChatCompletionNamedFunction"
- },
- "ChatCompletionNamedToolChoiceParam": {
- "properties": {
- "function": {
- "$ref": "#/components/schemas/ChatCompletionNamedFunction"
- },
- "type": {
- "type": "string",
- "const": "function",
- "title": "Type",
- "default": "function"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "function"
- ],
- "title": "ChatCompletionNamedToolChoiceParam"
- },
- "ChatCompletionRequest": {
- "properties": {
- "messages": {
- "items": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/ChatCompletionDeveloperMessageParam"
- },
- {
- "$ref": "#/components/schemas/ChatCompletionSystemMessageParam"
- },
- {
- "$ref": "#/components/schemas/ChatCompletionUserMessageParam"
- },
- {
- "$ref": "#/components/schemas/ChatCompletionAssistantMessageParam"
- },
- {
- "$ref": "#/components/schemas/ChatCompletionToolMessageParam"
- },
- {
- "$ref": "#/components/schemas/ChatCompletionFunctionMessageParam"
- },
- {
- "$ref": "#/components/schemas/CustomChatCompletionMessageParam"
- },
- {
- "$ref": "#/components/schemas/Message"
- }
- ]
- },
- "type": "array",
- "title": "Messages"
- },
- "model": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Model"
- },
- "frequency_penalty": {
- "anyOf": [
- {
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "title": "Frequency Penalty",
- "default": 0
- },
- "logit_bias": {
- "anyOf": [
- {
- "additionalProperties": {
- "type": "number"
- },
- "type": "object"
- },
- {
- "type": "null"
- }
- ],
- "title": "Logit Bias"
- },
- "logprobs": {
- "anyOf": [
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ],
- "title": "Logprobs",
- "default": false
- },
- "top_logprobs": {
- "anyOf": [
- {
- "type": "integer"
- },
- {
- "type": "null"
- }
- ],
- "title": "Top Logprobs",
- "default": 0
- },
- "max_tokens": {
- "anyOf": [
- {
- "type": "integer"
- },
- {
- "type": "null"
- }
- ],
- "title": "Max Tokens",
- "deprecated": true
- },
- "max_completion_tokens": {
- "anyOf": [
- {
- "type": "integer"
- },
- {
- "type": "null"
- }
- ],
- "title": "Max Completion Tokens"
- },
- "n": {
- "anyOf": [
- {
- "type": "integer"
- },
- {
- "type": "null"
- }
- ],
- "title": "N",
- "default": 1
- },
- "presence_penalty": {
- "anyOf": [
- {
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "title": "Presence Penalty",
- "default": 0
- },
- "response_format": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/ResponseFormat"
- },
- {
- "$ref": "#/components/schemas/StructuralTagResponseFormat"
- },
- {
- "$ref": "#/components/schemas/LegacyStructuralTagResponseFormat"
- },
- {
- "type": "null"
- }
- ],
- "title": "Response Format"
- },
- "seed": {
- "anyOf": [
- {
- "type": "integer",
- "maximum": "9.223372036854776e+18",
- "minimum": -9223372036854776000
- },
- {
- "type": "null"
- }
- ],
- "title": "Seed"
- },
- "stop": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- {
- "type": "null"
- }
- ],
- "title": "Stop",
- "default": []
- },
- "stream": {
- "anyOf": [
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ],
- "title": "Stream",
- "default": false
- },
- "stream_options": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/StreamOptions"
- },
- {
- "type": "null"
- }
- ]
- },
- "temperature": {
- "anyOf": [
- {
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "title": "Temperature"
- },
- "top_p": {
- "anyOf": [
- {
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "title": "Top P"
- },
- "tools": {
- "anyOf": [
- {
- "items": {
- "$ref": "#/components/schemas/ChatCompletionToolsParam"
- },
- "type": "array"
- },
- {
- "type": "null"
- }
- ],
- "title": "Tools"
- },
- "tool_choice": {
- "anyOf": [
- {
- "type": "string",
- "const": "none"
- },
- {
- "type": "string",
- "const": "auto"
- },
- {
- "type": "string",
- "const": "required"
- },
- {
- "$ref": "#/components/schemas/ChatCompletionNamedToolChoiceParam"
- },
- {
- "type": "null"
- }
- ],
- "title": "Tool Choice",
- "default": "none"
- },
- "reasoning_effort": {
- "anyOf": [
- {
- "type": "string",
- "enum": [
- "low",
- "medium",
- "high"
- ]
- },
- {
- "type": "null"
- }
- ],
- "title": "Reasoning Effort"
- },
- "include_reasoning": {
- "type": "boolean",
- "title": "Include Reasoning",
- "default": true
- },
- "parallel_tool_calls": {
- "anyOf": [
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ],
- "title": "Parallel Tool Calls",
- "default": true
- },
- "user": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "User"
- },
- "use_beam_search": {
- "type": "boolean",
- "title": "Use Beam Search",
- "default": false
- },
- "top_k": {
- "anyOf": [
- {
- "type": "integer"
- },
- {
- "type": "null"
- }
- ],
- "title": "Top K"
- },
- "min_p": {
- "anyOf": [
- {
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "title": "Min P"
- },
- "repetition_penalty": {
- "anyOf": [
- {
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "title": "Repetition Penalty"
- },
- "length_penalty": {
- "type": "number",
- "title": "Length Penalty",
- "default": 1
- },
- "stop_token_ids": {
- "anyOf": [
- {
- "items": {
- "type": "integer"
- },
- "type": "array"
- },
- {
- "type": "null"
- }
- ],
- "title": "Stop Token Ids",
- "default": []
- },
- "include_stop_str_in_output": {
- "type": "boolean",
- "title": "Include Stop Str In Output",
- "default": false
- },
- "ignore_eos": {
- "type": "boolean",
- "title": "Ignore Eos",
- "default": false
- },
- "min_tokens": {
- "type": "integer",
- "title": "Min Tokens",
- "default": 0
- },
- "skip_special_tokens": {
- "type": "boolean",
- "title": "Skip Special Tokens",
- "default": true
- },
- "spaces_between_special_tokens": {
- "type": "boolean",
- "title": "Spaces Between Special Tokens",
- "default": true
- },
- "truncate_prompt_tokens": {
- "anyOf": [
- {
- "type": "integer",
- "maximum": "9.223372036854776e+18",
- "minimum": -1
- },
- {
- "type": "null"
- }
- ],
- "title": "Truncate Prompt Tokens"
- },
- "prompt_logprobs": {
- "anyOf": [
- {
- "type": "integer"
- },
- {
- "type": "null"
- }
- ],
- "title": "Prompt Logprobs"
- },
- "allowed_token_ids": {
- "anyOf": [
- {
- "items": {
- "type": "integer"
- },
- "type": "array"
- },
- {
- "type": "null"
- }
- ],
- "title": "Allowed Token Ids"
- },
- "bad_words": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "title": "Bad Words"
- },
- "echo": {
- "type": "boolean",
- "title": "Echo",
- "description": "If true, the new message will be prepended with the last message if they belong to the same role.",
- "default": false
- },
- "add_generation_prompt": {
- "type": "boolean",
- "title": "Add Generation Prompt",
- "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.",
- "default": true
- },
- "continue_final_message": {
- "type": "boolean",
- "title": "Continue Final Message",
- "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`.",
- "default": false
- },
- "add_special_tokens": {
- "type": "boolean",
- "title": "Add Special Tokens",
- "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).",
- "default": false
- },
- "documents": {
- "anyOf": [
- {
- "items": {
- "additionalProperties": {
- "type": "string"
- },
- "type": "object"
- },
- "type": "array"
- },
- {
- "type": "null"
- }
- ],
- "title": "Documents",
- "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."
- },
- "chat_template": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Chat Template",
- "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."
- },
- "chat_template_kwargs": {
- "anyOf": [
- {
- "additionalProperties": true,
- "type": "object"
- },
- {
- "type": "null"
- }
- ],
- "title": "Chat Template Kwargs",
- "description": "Additional keyword args to pass to the template renderer. Will be accessible by the chat template."
- },
- "mm_processor_kwargs": {
- "anyOf": [
- {
- "additionalProperties": true,
- "type": "object"
- },
- {
- "type": "null"
- }
- ],
- "title": "Mm Processor Kwargs",
- "description": "Additional kwargs to pass to the HF processor."
- },
- "structured_outputs": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/StructuredOutputsParams"
- },
- {
- "type": "null"
- }
- ],
- "description": "Additional kwargs for structured outputs"
- },
- "priority": {
- "type": "integer",
- "title": "Priority",
- "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.",
- "default": 0
- },
- "request_id": {
- "type": "string",
- "title": "Request Id",
- "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."
- },
- "logits_processors": {
- "anyOf": [
- {
- "items": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "$ref": "#/components/schemas/LogitsProcessorConstructor"
- }
- ]
- },
- "type": "array"
- },
- {
- "type": "null"
- }
- ],
- "title": "Logits Processors",
- "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'}}."
- },
- "return_tokens_as_token_ids": {
- "anyOf": [
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ],
- "title": "Return Tokens As Token Ids",
- "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."
- },
- "return_token_ids": {
- "anyOf": [
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ],
- "title": "Return Token Ids",
- "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."
- },
- "cache_salt": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Cache Salt",
- "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)."
- },
- "kv_transfer_params": {
- "anyOf": [
- {
- "additionalProperties": true,
- "type": "object"
- },
- {
- "type": "null"
- }
- ],
- "title": "Kv Transfer Params",
- "description": "KVTransfer parameters used for disaggregated serving."
- },
- "vllm_xargs": {
- "anyOf": [
- {
- "additionalProperties": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "integer"
- },
- {
- "type": "number"
- },
- {
- "items": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "integer"
- },
- {
- "type": "number"
- }
- ]
- },
- "type": "array"
- }
- ]
- },
- "type": "object"
- },
- {
- "type": "null"
- }
- ],
- "title": "Vllm Xargs",
- "description": "Additional request parameters with (list of) string or numeric values, used by custom extensions."
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "messages"
- ],
- "title": "ChatCompletionRequest"
- },
- "ChatCompletionSystemMessageParam": {
- "properties": {
- "content": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "items": {
- "$ref": "#/components/schemas/ChatCompletionContentPartTextParam"
- },
- "type": "array"
- }
- ],
- "title": "Content"
- },
- "role": {
- "type": "string",
- "const": "system",
- "title": "Role"
- },
- "name": {
- "type": "string",
- "title": "Name"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "content",
- "role"
- ],
- "title": "ChatCompletionSystemMessageParam",
- "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."
- },
- "ChatCompletionToolMessageParam": {
- "properties": {
- "content": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "items": {
- "$ref": "#/components/schemas/ChatCompletionContentPartTextParam"
- },
- "type": "array"
- }
- ],
- "title": "Content"
- },
- "role": {
- "type": "string",
- "const": "tool",
- "title": "Role"
- },
- "tool_call_id": {
- "type": "string",
- "title": "Tool Call Id"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "content",
- "role",
- "tool_call_id"
- ],
- "title": "ChatCompletionToolMessageParam"
- },
- "ChatCompletionToolsParam": {
- "properties": {
- "type": {
- "type": "string",
- "const": "function",
- "title": "Type",
- "default": "function"
- },
- "function": {
- "$ref": "#/components/schemas/FunctionDefinition"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "function"
- ],
- "title": "ChatCompletionToolsParam"
- },
- "ChatCompletionUserMessageParam": {
- "properties": {
- "content": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "items": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/ChatCompletionContentPartTextParam"
- },
- {
- "$ref": "#/components/schemas/ChatCompletionContentPartImageParam"
- },
- {
- "$ref": "#/components/schemas/ChatCompletionContentPartInputAudioParam"
- },
- {
- "$ref": "#/components/schemas/File"
- }
- ]
- },
- "type": "array"
- }
- ],
- "title": "Content"
- },
- "role": {
- "type": "string",
- "const": "user",
- "title": "Role"
- },
- "name": {
- "type": "string",
- "title": "Name"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "content",
- "role"
- ],
- "title": "ChatCompletionUserMessageParam",
- "description": "Messages sent by an end user, containing prompts or additional context\ninformation."
- },
- "ClassificationChatRequest": {
- "properties": {
- "model": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Model"
- },
- "messages": {
- "items": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/ChatCompletionDeveloperMessageParam"
- },
- {
- "$ref": "#/components/schemas/ChatCompletionSystemMessageParam"
- },
- {
- "$ref": "#/components/schemas/ChatCompletionUserMessageParam"
- },
- {
- "$ref": "#/components/schemas/ChatCompletionAssistantMessageParam"
- },
- {
- "$ref": "#/components/schemas/ChatCompletionToolMessageParam"
- },
- {
- "$ref": "#/components/schemas/ChatCompletionFunctionMessageParam"
- },
- {
- "$ref": "#/components/schemas/CustomChatCompletionMessageParam"
- },
- {
- "$ref": "#/components/schemas/Message"
- }
- ]
- },
- "type": "array",
- "title": "Messages"
- },
- "truncate_prompt_tokens": {
- "anyOf": [
- {
- "type": "integer",
- "minimum": -1
- },
- {
- "type": "null"
- }
- ],
- "title": "Truncate Prompt Tokens"
- },
- "user": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "User"
- },
- "add_generation_prompt": {
- "type": "boolean",
- "title": "Add Generation Prompt",
- "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.",
- "default": false
- },
- "add_special_tokens": {
- "type": "boolean",
- "title": "Add Special Tokens",
- "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).",
- "default": false
- },
- "chat_template": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Chat Template",
- "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."
- },
- "chat_template_kwargs": {
- "anyOf": [
- {
- "additionalProperties": true,
- "type": "object"
- },
- {
- "type": "null"
- }
- ],
- "title": "Chat Template Kwargs",
- "description": "Additional keyword args to pass to the template renderer. Will be accessible by the chat template."
- },
- "mm_processor_kwargs": {
- "anyOf": [
- {
- "additionalProperties": true,
- "type": "object"
- },
- {
- "type": "null"
- }
- ],
- "title": "Mm Processor Kwargs",
- "description": "Additional kwargs to pass to the HF processor."
- },
- "priority": {
- "type": "integer",
- "title": "Priority",
- "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.",
- "default": 0
- },
- "request_id": {
- "type": "string",
- "title": "Request Id",
- "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."
- },
- "softmax": {
- "anyOf": [
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ],
- "title": "Softmax",
- "description": "softmax will be deprecated, please use use_activation instead."
- },
- "activation": {
- "anyOf": [
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ],
- "title": "Activation",
- "description": "activation will be deprecated, please use use_activation instead."
- },
- "use_activation": {
- "anyOf": [
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ],
- "title": "Use Activation",
- "description": "Whether to use activation for classification outputs. Default is True."
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "messages"
- ],
- "title": "ClassificationChatRequest"
- },
- "ClassificationCompletionRequest": {
- "properties": {
- "model": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Model"
- },
- "input": {
- "anyOf": [
- {
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- {
- "type": "string"
- }
- ],
- "title": "Input"
- },
- "truncate_prompt_tokens": {
- "anyOf": [
- {
- "type": "integer",
- "minimum": -1
- },
- {
- "type": "null"
- }
- ],
- "title": "Truncate Prompt Tokens"
- },
- "user": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "User"
- },
- "priority": {
- "type": "integer",
- "title": "Priority",
- "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.",
- "default": 0
- },
- "add_special_tokens": {
- "type": "boolean",
- "title": "Add Special Tokens",
- "description": "If true (the default), special tokens (e.g. BOS) will be added to the prompt.",
- "default": true
- },
- "request_id": {
- "type": "string",
- "title": "Request Id",
- "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."
- },
- "softmax": {
- "anyOf": [
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ],
- "title": "Softmax",
- "description": "softmax will be deprecated, please use use_activation instead."
- },
- "activation": {
- "anyOf": [
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ],
- "title": "Activation",
- "description": "activation will be deprecated, please use use_activation instead."
- },
- "use_activation": {
- "anyOf": [
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ],
- "title": "Use Activation",
- "description": "Whether to use activation for classification outputs. Default is True."
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "input"
- ],
- "title": "ClassificationCompletionRequest"
- },
- "CodeInterpreter": {
- "properties": {
- "container": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "$ref": "#/components/schemas/CodeInterpreterContainerCodeInterpreterToolAuto"
- }
- ],
- "title": "Container"
- },
- "type": {
- "type": "string",
- "const": "code_interpreter",
- "title": "Type"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "container",
- "type"
- ],
- "title": "CodeInterpreter",
- "description": "A tool that runs Python code to help generate a response to a prompt."
- },
- "CodeInterpreterContainerCodeInterpreterToolAuto": {
- "properties": {
- "type": {
- "type": "string",
- "const": "auto",
- "title": "Type"
- },
- "file_ids": {
- "anyOf": [
- {
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- {
- "type": "null"
- }
- ],
- "title": "File Ids"
- },
- "memory_limit": {
- "anyOf": [
- {
- "type": "string",
- "enum": [
- "1g",
- "4g",
- "16g",
- "64g"
- ]
- },
- {
- "type": "null"
- }
- ],
- "title": "Memory Limit"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "type"
- ],
- "title": "CodeInterpreterContainerCodeInterpreterToolAuto",
- "description": "Configuration for a code interpreter container.\n\nOptionally specify the IDs of the files to run the code on."
- },
- "ComparisonFilter": {
- "properties": {
- "key": {
- "type": "string",
- "title": "Key"
- },
- "type": {
- "type": "string",
- "enum": [
- "eq",
- "ne",
- "gt",
- "gte",
- "lt",
- "lte"
- ],
- "title": "Type"
- },
- "value": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "number"
- },
- {
- "type": "boolean"
- },
- {
- "items": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "number"
- }
- ]
- },
- "type": "array"
- }
- ],
- "title": "Value"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "key",
- "type",
- "value"
- ],
- "title": "ComparisonFilter",
- "description": "A filter used to compare a specified attribute key to a given value using a defined comparison operation."
- },
- "CompletionRequest": {
- "properties": {
- "model": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Model"
- },
- "prompt": {
- "anyOf": [
- {
- "items": {
- "type": "integer"
- },
- "type": "array"
- },
- {
- "items": {
- "items": {
- "type": "integer"
- },
- "type": "array"
- },
- "type": "array"
- },
- {
- "type": "string"
- },
- {
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- {
- "type": "null"
- }
- ],
- "title": "Prompt"
- },
- "echo": {
- "anyOf": [
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ],
- "title": "Echo",
- "default": false
- },
- "frequency_penalty": {
- "anyOf": [
- {
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "title": "Frequency Penalty",
- "default": 0
- },
- "logit_bias": {
- "anyOf": [
- {
- "additionalProperties": {
- "type": "number"
- },
- "type": "object"
- },
- {
- "type": "null"
- }
- ],
- "title": "Logit Bias"
- },
- "logprobs": {
- "anyOf": [
- {
- "type": "integer"
- },
- {
- "type": "null"
- }
- ],
- "title": "Logprobs"
- },
- "max_tokens": {
- "anyOf": [
- {
- "type": "integer"
- },
- {
- "type": "null"
- }
- ],
- "title": "Max Tokens",
- "default": 16
- },
- "n": {
- "type": "integer",
- "title": "N",
- "default": 1
- },
- "presence_penalty": {
- "anyOf": [
- {
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "title": "Presence Penalty",
- "default": 0
- },
- "seed": {
- "anyOf": [
- {
- "type": "integer",
- "maximum": "9.223372036854776e+18",
- "minimum": -9223372036854776000
- },
- {
- "type": "null"
- }
- ],
- "title": "Seed"
- },
- "stop": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- {
- "type": "null"
- }
- ],
- "title": "Stop",
- "default": []
- },
- "stream": {
- "anyOf": [
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ],
- "title": "Stream",
- "default": false
- },
- "stream_options": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/StreamOptions"
- },
- {
- "type": "null"
- }
- ]
- },
- "suffix": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Suffix"
- },
- "temperature": {
- "anyOf": [
- {
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "title": "Temperature"
- },
- "top_p": {
- "anyOf": [
- {
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "title": "Top P"
- },
- "user": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "User"
- },
- "use_beam_search": {
- "type": "boolean",
- "title": "Use Beam Search",
- "default": false
- },
- "top_k": {
- "anyOf": [
- {
- "type": "integer"
- },
- {
- "type": "null"
- }
- ],
- "title": "Top K"
- },
- "min_p": {
- "anyOf": [
- {
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "title": "Min P"
- },
- "repetition_penalty": {
- "anyOf": [
- {
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "title": "Repetition Penalty"
- },
- "length_penalty": {
- "type": "number",
- "title": "Length Penalty",
- "default": 1
- },
- "stop_token_ids": {
- "anyOf": [
- {
- "items": {
- "type": "integer"
- },
- "type": "array"
- },
- {
- "type": "null"
- }
- ],
- "title": "Stop Token Ids",
- "default": []
- },
- "include_stop_str_in_output": {
- "type": "boolean",
- "title": "Include Stop Str In Output",
- "default": false
- },
- "ignore_eos": {
- "type": "boolean",
- "title": "Ignore Eos",
- "default": false
- },
- "min_tokens": {
- "type": "integer",
- "title": "Min Tokens",
- "default": 0
- },
- "skip_special_tokens": {
- "type": "boolean",
- "title": "Skip Special Tokens",
- "default": true
- },
- "spaces_between_special_tokens": {
- "type": "boolean",
- "title": "Spaces Between Special Tokens",
- "default": true
- },
- "truncate_prompt_tokens": {
- "anyOf": [
- {
- "type": "integer",
- "maximum": "9.223372036854776e+18",
- "minimum": -1
- },
- {
- "type": "null"
- }
- ],
- "title": "Truncate Prompt Tokens"
- },
- "allowed_token_ids": {
- "anyOf": [
- {
- "items": {
- "type": "integer"
- },
- "type": "array"
- },
- {
- "type": "null"
- }
- ],
- "title": "Allowed Token Ids"
- },
- "prompt_logprobs": {
- "anyOf": [
- {
- "type": "integer"
- },
- {
- "type": "null"
- }
- ],
- "title": "Prompt Logprobs"
- },
- "prompt_embeds": {
- "anyOf": [
- {
- "type": "string",
- "format": "binary"
- },
- {
- "items": {
- "type": "string",
- "format": "binary"
- },
- "type": "array"
- },
- {
- "type": "null"
- }
- ],
- "title": "Prompt Embeds"
- },
- "add_special_tokens": {
- "type": "boolean",
- "title": "Add Special Tokens",
- "description": "If true (the default), special tokens (e.g. BOS) will be added to the prompt.",
- "default": true
- },
- "response_format": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/ResponseFormat"
- },
- {
- "$ref": "#/components/schemas/StructuralTagResponseFormat"
- },
- {
- "$ref": "#/components/schemas/LegacyStructuralTagResponseFormat"
- },
- {
- "type": "null"
- }
- ],
- "title": "Response Format",
- "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."
- },
- "structured_outputs": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/StructuredOutputsParams"
- },
- {
- "type": "null"
- }
- ],
- "description": "Additional kwargs for structured outputs"
- },
- "priority": {
- "type": "integer",
- "title": "Priority",
- "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.",
- "default": 0
- },
- "request_id": {
- "type": "string",
- "title": "Request Id",
- "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."
- },
- "logits_processors": {
- "anyOf": [
- {
- "items": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "$ref": "#/components/schemas/LogitsProcessorConstructor"
- }
- ]
- },
- "type": "array"
- },
- {
- "type": "null"
- }
- ],
- "title": "Logits Processors",
- "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'}}."
- },
- "return_tokens_as_token_ids": {
- "anyOf": [
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ],
- "title": "Return Tokens As Token Ids",
- "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."
- },
- "return_token_ids": {
- "anyOf": [
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ],
- "title": "Return Token Ids",
- "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."
- },
- "cache_salt": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Cache Salt",
- "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)."
- },
- "kv_transfer_params": {
- "anyOf": [
- {
- "additionalProperties": true,
- "type": "object"
- },
- {
- "type": "null"
- }
- ],
- "title": "Kv Transfer Params",
- "description": "KVTransfer parameters used for disaggregated serving."
- },
- "vllm_xargs": {
- "anyOf": [
- {
- "additionalProperties": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "integer"
- },
- {
- "type": "number"
- }
- ]
- },
- "type": "object"
- },
- {
- "type": "null"
- }
- ],
- "title": "Vllm Xargs",
- "description": "Additional request parameters with string or numeric values, used by custom extensions."
- }
- },
- "additionalProperties": true,
- "type": "object",
- "title": "CompletionRequest"
- },
- "CompoundFilter": {
- "properties": {
- "filters": {
- "items": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/ComparisonFilter"
- },
- {}
- ]
- },
- "type": "array",
- "title": "Filters"
- },
- "type": {
- "type": "string",
- "enum": [
- "and",
- "or"
- ],
- "title": "Type"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "filters",
- "type"
- ],
- "title": "CompoundFilter",
- "description": "Combine multiple filters using `and` or `or`."
- },
- "ComputerCallOutput": {
- "properties": {
- "call_id": {
- "type": "string",
- "title": "Call Id"
- },
- "output": {
- "$ref": "#/components/schemas/ResponseComputerToolCallOutputScreenshotParam"
- },
- "type": {
- "type": "string",
- "const": "computer_call_output",
- "title": "Type"
- },
- "id": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Id"
- },
- "acknowledged_safety_checks": {
- "anyOf": [
- {
- "items": {
- "$ref": "#/components/schemas/ComputerCallOutputAcknowledgedSafetyCheck"
- },
- "type": "array"
- },
- {
- "type": "null"
- }
- ],
- "title": "Acknowledged Safety Checks"
- },
- "status": {
- "anyOf": [
- {
- "type": "string",
- "enum": [
- "in_progress",
- "completed",
- "incomplete"
- ]
- },
- {
- "type": "null"
- }
- ],
- "title": "Status"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "call_id",
- "output",
- "type"
- ],
- "title": "ComputerCallOutput",
- "description": "The output of a computer tool call."
- },
- "ComputerCallOutputAcknowledgedSafetyCheck": {
- "properties": {
- "id": {
- "type": "string",
- "title": "Id"
- },
- "code": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Code"
- },
- "message": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Message"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "id"
- ],
- "title": "ComputerCallOutputAcknowledgedSafetyCheck",
- "description": "A pending safety check for the computer call."
- },
- "ComputerTool": {
- "properties": {
- "display_height": {
- "type": "integer",
- "title": "Display Height"
- },
- "display_width": {
- "type": "integer",
- "title": "Display Width"
- },
- "environment": {
- "type": "string",
- "enum": [
- "windows",
- "mac",
- "linux",
- "ubuntu",
- "browser"
- ],
- "title": "Environment"
- },
- "type": {
- "type": "string",
- "const": "computer_use_preview",
- "title": "Type"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "display_height",
- "display_width",
- "environment",
- "type"
- ],
- "title": "ComputerTool",
- "description": "A tool that controls a virtual computer.\n\nLearn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use)."
- },
- "Content": {
- "properties": {},
- "type": "object",
- "title": "Content"
- },
- "Custom": {
- "properties": {
- "input": {
- "type": "string",
- "title": "Input"
- },
- "name": {
- "type": "string",
- "title": "Name"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "input",
- "name"
- ],
- "title": "Custom",
- "description": "The custom tool that the model called."
- },
- "CustomChatCompletionContentSimpleAudioParam": {
- "properties": {
- "audio_url": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Audio Url"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "title": "CustomChatCompletionContentSimpleAudioParam",
- "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}"
- },
- "CustomChatCompletionContentSimpleImageParam": {
- "properties": {
- "image_url": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Image Url"
- },
- "uuid": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Uuid"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "title": "CustomChatCompletionContentSimpleImageParam",
- "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}"
- },
- "CustomChatCompletionContentSimpleVideoParam": {
- "properties": {
- "video_url": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Video Url"
- },
- "uuid": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Uuid"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "title": "CustomChatCompletionContentSimpleVideoParam",
- "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}"
- },
- "CustomChatCompletionMessageParam": {
- "properties": {
- "role": {
- "type": "string",
- "title": "Role"
- },
- "content": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "items": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/ChatCompletionContentPartTextParam"
- },
- {
- "$ref": "#/components/schemas/ChatCompletionContentPartImageParam"
- },
- {
- "$ref": "#/components/schemas/ChatCompletionContentPartInputAudioParam"
- },
- {
- "$ref": "#/components/schemas/File"
- },
- {
- "$ref": "#/components/schemas/ChatCompletionContentPartAudioParam"
- },
- {
- "$ref": "#/components/schemas/ChatCompletionContentPartVideoParam"
- },
- {
- "$ref": "#/components/schemas/ChatCompletionContentPartRefusalParam"
- },
- {
- "$ref": "#/components/schemas/CustomChatCompletionContentSimpleImageParam"
- },
- {
- "$ref": "#/components/schemas/ChatCompletionContentPartImageEmbedsParam"
- },
- {
- "$ref": "#/components/schemas/ChatCompletionContentPartAudioEmbedsParam"
- },
- {
- "$ref": "#/components/schemas/CustomChatCompletionContentSimpleAudioParam"
- },
- {
- "$ref": "#/components/schemas/CustomChatCompletionContentSimpleVideoParam"
- },
- {
- "type": "string"
- },
- {
- "$ref": "#/components/schemas/CustomThinkCompletionContentParam"
- }
- ]
- },
- "type": "array"
- }
- ],
- "title": "Content"
- },
- "name": {
- "type": "string",
- "title": "Name"
- },
- "tool_call_id": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Tool Call Id"
- },
- "tool_calls": {
- "anyOf": [
- {
- "items": {
- "$ref": "#/components/schemas/ChatCompletionMessageFunctionToolCallParam"
- },
- "type": "array"
- },
- {
- "type": "null"
- }
- ],
- "title": "Tool Calls"
- },
- "reasoning": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Reasoning"
- },
- "tools": {
- "anyOf": [
- {
- "items": {
- "$ref": "#/components/schemas/ChatCompletionFunctionToolParam"
- },
- "type": "array"
- },
- {
- "type": "null"
- }
- ],
- "title": "Tools"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "role"
- ],
- "title": "CustomChatCompletionMessageParam",
- "description": "Enables custom roles in the Chat Completion API."
- },
- "CustomThinkCompletionContentParam": {
- "properties": {
- "thinking": {
- "type": "string",
- "title": "Thinking"
- },
- "closed": {
- "type": "boolean",
- "title": "Closed"
- },
- "type": {
- "type": "string",
- "const": "thinking",
- "title": "Type"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "thinking",
- "type"
- ],
- "title": "CustomThinkCompletionContentParam",
- "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}"
- },
- "CustomTool": {
- "properties": {
- "name": {
- "type": "string",
- "title": "Name"
- },
- "type": {
- "type": "string",
- "const": "custom",
- "title": "Type"
- },
- "description": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Description"
- },
- "format": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/Text"
- },
- {
- "$ref": "#/components/schemas/Grammar"
- },
- {
- "type": "null"
- }
- ],
- "title": "Format"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "name",
- "type"
- ],
- "title": "CustomTool",
- "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)"
- },
- "DetokenizeRequest": {
- "properties": {
- "model": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Model"
- },
- "tokens": {
- "items": {
- "type": "integer"
- },
- "type": "array",
- "title": "Tokens"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "tokens"
- ],
- "title": "DetokenizeRequest"
- },
- "EasyInputMessageParam": {
- "properties": {
- "content": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "items": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/ResponseInputTextParam"
- },
- {
- "$ref": "#/components/schemas/ResponseInputImageParam"
- },
- {
- "$ref": "#/components/schemas/ResponseInputFileParam"
- }
- ]
- },
- "type": "array"
- }
- ],
- "title": "Content"
- },
- "role": {
- "type": "string",
- "enum": [
- "user",
- "assistant",
- "system",
- "developer"
- ],
- "title": "Role"
- },
- "type": {
- "type": "string",
- "const": "message",
- "title": "Type"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "content",
- "role"
- ],
- "title": "EasyInputMessageParam",
- "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."
- },
- "EmbeddingChatRequest": {
- "properties": {
- "model": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Model"
- },
- "messages": {
- "items": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/ChatCompletionDeveloperMessageParam"
- },
- {
- "$ref": "#/components/schemas/ChatCompletionSystemMessageParam"
- },
- {
- "$ref": "#/components/schemas/ChatCompletionUserMessageParam"
- },
- {
- "$ref": "#/components/schemas/ChatCompletionAssistantMessageParam"
- },
- {
- "$ref": "#/components/schemas/ChatCompletionToolMessageParam"
- },
- {
- "$ref": "#/components/schemas/ChatCompletionFunctionMessageParam"
- },
- {
- "$ref": "#/components/schemas/CustomChatCompletionMessageParam"
- },
- {
- "$ref": "#/components/schemas/Message"
- }
- ]
- },
- "type": "array",
- "title": "Messages"
- },
- "encoding_format": {
- "type": "string",
- "enum": [
- "float",
- "base64",
- "bytes",
- "bytes_only"
- ],
- "title": "Encoding Format",
- "default": "float"
- },
- "dimensions": {
- "anyOf": [
- {
- "type": "integer"
- },
- {
- "type": "null"
- }
- ],
- "title": "Dimensions"
- },
- "user": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "User"
- },
- "truncate_prompt_tokens": {
- "anyOf": [
- {
- "type": "integer",
- "minimum": -1
- },
- {
- "type": "null"
- }
- ],
- "title": "Truncate Prompt Tokens"
- },
- "add_generation_prompt": {
- "type": "boolean",
- "title": "Add Generation Prompt",
- "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.",
- "default": false
- },
- "continue_final_message": {
- "type": "boolean",
- "title": "Continue Final Message",
- "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`.",
- "default": false
- },
- "add_special_tokens": {
- "type": "boolean",
- "title": "Add Special Tokens",
- "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).",
- "default": false
- },
- "chat_template": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Chat Template",
- "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."
- },
- "chat_template_kwargs": {
- "anyOf": [
- {
- "additionalProperties": true,
- "type": "object"
- },
- {
- "type": "null"
- }
- ],
- "title": "Chat Template Kwargs",
- "description": "Additional keyword args to pass to the template renderer. Will be accessible by the chat template."
- },
- "mm_processor_kwargs": {
- "anyOf": [
- {
- "additionalProperties": true,
- "type": "object"
- },
- {
- "type": "null"
- }
- ],
- "title": "Mm Processor Kwargs",
- "description": "Additional kwargs to pass to the HF processor."
- },
- "priority": {
- "type": "integer",
- "title": "Priority",
- "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.",
- "default": 0
- },
- "request_id": {
- "type": "string",
- "title": "Request Id",
- "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."
- },
- "normalize": {
- "anyOf": [
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ],
- "title": "Normalize",
- "description": "Whether to normalize the embeddings outputs. Default is True."
- },
- "embed_dtype": {
- "type": "string",
- "enum": [
- "float32",
- "float16",
- "bfloat16",
- "fp8_e4m3",
- "fp8_e5m2"
- ],
- "title": "Embed Dtype",
- "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.",
- "default": "float32"
- },
- "endianness": {
- "type": "string",
- "enum": [
- "native",
- "big",
- "little"
- ],
- "title": "Endianness",
- "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.",
- "default": "native"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "messages"
- ],
- "title": "EmbeddingChatRequest"
- },
- "EmbeddingCompletionRequest": {
- "properties": {
- "model": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Model"
- },
- "input": {
- "anyOf": [
- {
- "items": {
- "type": "integer"
- },
- "type": "array"
- },
- {
- "items": {
- "items": {
- "type": "integer"
- },
- "type": "array"
- },
- "type": "array"
- },
- {
- "type": "string"
- },
- {
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- ],
- "title": "Input"
- },
- "encoding_format": {
- "type": "string",
- "enum": [
- "float",
- "base64",
- "bytes",
- "bytes_only"
- ],
- "title": "Encoding Format",
- "default": "float"
- },
- "dimensions": {
- "anyOf": [
- {
- "type": "integer"
- },
- {
- "type": "null"
- }
- ],
- "title": "Dimensions"
- },
- "user": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "User"
- },
- "truncate_prompt_tokens": {
- "anyOf": [
- {
- "type": "integer",
- "minimum": -1
- },
- {
- "type": "null"
- }
- ],
- "title": "Truncate Prompt Tokens"
- },
- "add_special_tokens": {
- "type": "boolean",
- "title": "Add Special Tokens",
- "description": "If true (the default), special tokens (e.g. BOS) will be added to the prompt.",
- "default": true
- },
- "priority": {
- "type": "integer",
- "title": "Priority",
- "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.",
- "default": 0
- },
- "request_id": {
- "type": "string",
- "title": "Request Id",
- "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."
- },
- "normalize": {
- "anyOf": [
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ],
- "title": "Normalize",
- "description": "Whether to normalize the embeddings outputs. Default is True."
- },
- "embed_dtype": {
- "type": "string",
- "enum": [
- "float32",
- "float16",
- "bfloat16",
- "fp8_e4m3",
- "fp8_e5m2"
- ],
- "title": "Embed Dtype",
- "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.",
- "default": "float32"
- },
- "endianness": {
- "type": "string",
- "enum": [
- "native",
- "big",
- "little"
- ],
- "title": "Endianness",
- "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.",
- "default": "native"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "input"
- ],
- "title": "EmbeddingCompletionRequest"
- },
- "ErrorInfo": {
- "properties": {
- "message": {
- "type": "string",
- "title": "Message"
- },
- "type": {
- "type": "string",
- "title": "Type"
- },
- "param": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Param"
- },
- "code": {
- "type": "integer",
- "title": "Code"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "message",
- "type",
- "code"
- ],
- "title": "ErrorInfo"
- },
- "ErrorResponse": {
- "properties": {
- "error": {
- "$ref": "#/components/schemas/ErrorInfo"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "error"
- ],
- "title": "ErrorResponse"
- },
- "File": {
- "properties": {
- "file": {
- "$ref": "#/components/schemas/FileFile"
- },
- "type": {
- "type": "string",
- "const": "file",
- "title": "Type"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "file",
- "type"
- ],
- "title": "File",
- "description": "Learn about [file inputs](https://platform.openai.com/docs/guides/text) for text generation."
- },
- "FileFile": {
- "properties": {
- "file_data": {
- "type": "string",
- "title": "File Data"
- },
- "file_id": {
- "type": "string",
- "title": "File Id"
- },
- "filename": {
- "type": "string",
- "title": "Filename"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "title": "FileFile"
- },
- "FileSearchTool": {
- "properties": {
- "type": {
- "type": "string",
- "const": "file_search",
- "title": "Type"
- },
- "vector_store_ids": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "title": "Vector Store Ids"
- },
- "filters": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/ComparisonFilter"
- },
- {
- "$ref": "#/components/schemas/CompoundFilter"
- },
- {
- "type": "null"
- }
- ],
- "title": "Filters"
- },
- "max_num_results": {
- "anyOf": [
- {
- "type": "integer"
- },
- {
- "type": "null"
- }
- ],
- "title": "Max Num Results"
- },
- "ranking_options": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/RankingOptions"
- },
- {
- "type": "null"
- }
- ]
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "type",
- "vector_store_ids"
- ],
- "title": "FileSearchTool",
- "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)."
- },
- "Filters": {
- "properties": {
- "allowed_domains": {
- "anyOf": [
- {
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- {
- "type": "null"
- }
- ],
- "title": "Allowed Domains"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "title": "Filters",
- "description": "Filters for the search."
- },
- "Function": {
- "properties": {
- "arguments": {
- "type": "string",
- "title": "Arguments"
- },
- "name": {
- "type": "string",
- "title": "Name"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "arguments",
- "name"
- ],
- "title": "Function",
- "description": "The function that the model called."
- },
- "FunctionCall": {
- "properties": {
- "arguments": {
- "type": "string",
- "title": "Arguments"
- },
- "name": {
- "type": "string",
- "title": "Name"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "arguments",
- "name"
- ],
- "title": "FunctionCall",
- "description": "Deprecated and replaced by `tool_calls`.\n\nThe name and arguments of a function that should be called, as generated by the model."
- },
- "FunctionCallOutput": {
- "properties": {
- "call_id": {
- "type": "string",
- "title": "Call Id"
- },
- "output": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "items": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/ResponseInputTextContentParam"
- },
- {
- "$ref": "#/components/schemas/ResponseInputImageContentParam"
- },
- {
- "$ref": "#/components/schemas/ResponseInputFileContentParam"
- }
- ]
- },
- "type": "array"
- }
- ],
- "title": "Output"
- },
- "type": {
- "type": "string",
- "const": "function_call_output",
- "title": "Type"
- },
- "id": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Id"
- },
- "status": {
- "anyOf": [
- {
- "type": "string",
- "enum": [
- "in_progress",
- "completed",
- "incomplete"
- ]
- },
- {
- "type": "null"
- }
- ],
- "title": "Status"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "call_id",
- "output",
- "type"
- ],
- "title": "FunctionCallOutput",
- "description": "The output of a function tool call."
- },
- "FunctionDefinition": {
- "properties": {
- "name": {
- "type": "string",
- "title": "Name"
- },
- "description": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Description"
- },
- "parameters": {
- "anyOf": [
- {
- "additionalProperties": true,
- "type": "object"
- },
- {
- "type": "null"
- }
- ],
- "title": "Parameters"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "name"
- ],
- "title": "FunctionDefinition"
- },
- "FunctionShellTool": {
- "properties": {
- "type": {
- "type": "string",
- "const": "shell",
- "title": "Type"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "type"
- ],
- "title": "FunctionShellTool",
- "description": "A tool that allows the model to execute shell commands."
- },
- "FunctionTool": {
- "properties": {
- "name": {
- "type": "string",
- "title": "Name"
- },
- "parameters": {
- "anyOf": [
- {
- "additionalProperties": true,
- "type": "object"
- },
- {
- "type": "null"
- }
- ],
- "title": "Parameters"
- },
- "strict": {
- "anyOf": [
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ],
- "title": "Strict"
- },
- "type": {
- "type": "string",
- "const": "function",
- "title": "Type"
- },
- "description": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Description"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "name",
- "type"
- ],
- "title": "FunctionTool",
- "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)."
- },
- "GenerateRequest": {
- "properties": {
- "request_id": {
- "type": "string",
- "title": "Request Id",
- "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."
- },
- "token_ids": {
- "items": {
- "type": "integer"
- },
- "type": "array",
- "title": "Token Ids"
- },
- "features": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Features"
- },
- "sampling_params": {
- "properties": {
- "n": {
- "type": "integer",
- "title": "N",
- "default": 1
- },
- "presence_penalty": {
- "type": "number",
- "title": "Presence Penalty",
- "default": 0
- },
- "frequency_penalty": {
- "type": "number",
- "title": "Frequency Penalty",
- "default": 0
- },
- "repetition_penalty": {
- "type": "number",
- "title": "Repetition Penalty",
- "default": 1
- },
- "temperature": {
- "type": "number",
- "title": "Temperature",
- "default": 1
- },
- "top_p": {
- "type": "number",
- "title": "Top P",
- "default": 1
- },
- "top_k": {
- "type": "integer",
- "title": "Top K",
- "default": 0
- },
- "min_p": {
- "type": "number",
- "title": "Min P",
- "default": 0
- },
- "seed": {
- "anyOf": [
- {
- "type": "integer"
- },
- {
- "type": "null"
- }
- ],
- "title": "Seed"
- },
- "stop": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- {
- "type": "null"
- }
- ],
- "title": "Stop"
- },
- "stop_token_ids": {
- "anyOf": [
- {
- "items": {
- "type": "integer"
- },
- "type": "array"
- },
- {
- "type": "null"
- }
- ],
- "title": "Stop Token Ids"
- },
- "ignore_eos": {
- "type": "boolean",
- "title": "Ignore Eos",
- "default": false
- },
- "max_tokens": {
- "anyOf": [
- {
- "type": "integer"
- },
- {
- "type": "null"
- }
- ],
- "title": "Max Tokens",
- "default": 16
- },
- "min_tokens": {
- "type": "integer",
- "title": "Min Tokens",
- "default": 0
- },
- "logprobs": {
- "anyOf": [
- {
- "type": "integer"
- },
- {
- "type": "null"
- }
- ],
- "title": "Logprobs"
- },
- "prompt_logprobs": {
- "anyOf": [
- {
- "type": "integer"
- },
- {
- "type": "null"
- }
- ],
- "title": "Prompt Logprobs"
- },
- "flat_logprobs": {
- "type": "boolean",
- "title": "Flat Logprobs",
- "default": false
- },
- "detokenize": {
- "type": "boolean",
- "title": "Detokenize",
- "default": true
- },
- "skip_special_tokens": {
- "type": "boolean",
- "title": "Skip Special Tokens",
- "default": true
- },
- "spaces_between_special_tokens": {
- "type": "boolean",
- "title": "Spaces Between Special Tokens",
- "default": true
- },
- "logits_processors": {
- "anyOf": [
- {},
- {
- "type": "null"
- }
- ],
- "title": "Logits Processors"
- },
- "include_stop_str_in_output": {
- "type": "boolean",
- "title": "Include Stop Str In Output",
- "default": false
- },
- "truncate_prompt_tokens": {
- "anyOf": [
- {
- "type": "integer"
- },
- {
- "type": "null"
- }
- ],
- "title": "Truncate Prompt Tokens"
- },
- "output_kind": {
- "$ref": "#/components/schemas/RequestOutputKind",
- "default": 0
- },
- "skip_clone": {
- "type": "boolean",
- "title": "Skip Clone",
- "default": false
- },
- "output_text_buffer_length": {
- "type": "integer",
- "title": "Output Text Buffer Length",
- "default": 0
- },
- "_all_stop_token_ids": {
- "items": {
- "type": "integer"
- },
- "type": "array",
- "uniqueItems": true,
- "title": "All Stop Token Ids"
- },
- "structured_outputs": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/StructuredOutputsParams"
- },
- {
- "type": "null"
- }
- ]
- },
- "logit_bias": {
- "anyOf": [
- {
- "additionalProperties": {
- "type": "number"
- },
- "type": "object"
- },
- {
- "type": "null"
- }
- ],
- "title": "Logit Bias"
- },
- "allowed_token_ids": {
- "anyOf": [
- {
- "items": {
- "type": "integer"
- },
- "type": "array"
- },
- {
- "type": "null"
- }
- ],
- "title": "Allowed Token Ids"
- },
- "extra_args": {
- "anyOf": [
- {
- "additionalProperties": true,
- "type": "object"
- },
- {
- "type": "null"
- }
- ],
- "title": "Extra Args"
- },
- "bad_words": {
- "anyOf": [
- {
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- {
- "type": "null"
- }
- ],
- "title": "Bad Words"
- },
- "_bad_words_token_ids": {
- "anyOf": [
- {
- "items": {
- "items": {
- "type": "integer"
- },
- "type": "array"
- },
- "type": "array"
- },
- {
- "type": "null"
- }
- ],
- "title": "Bad Words Token Ids"
- },
- "skip_reading_prefix_cache": {
- "anyOf": [
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ],
- "title": "Skip Reading Prefix Cache"
- }
- },
- "type": "object",
- "required": [
- "n",
- "presence_penalty",
- "frequency_penalty",
- "repetition_penalty",
- "temperature",
- "top_p",
- "top_k",
- "min_p",
- "seed",
- "stop",
- "stop_token_ids",
- "ignore_eos",
- "max_tokens",
- "min_tokens",
- "logprobs",
- "prompt_logprobs",
- "flat_logprobs",
- "detokenize",
- "skip_special_tokens",
- "spaces_between_special_tokens",
- "logits_processors",
- "include_stop_str_in_output",
- "truncate_prompt_tokens",
- "output_kind",
- "skip_clone",
- "output_text_buffer_length",
- "_all_stop_token_ids",
- "structured_outputs",
- "logit_bias",
- "allowed_token_ids",
- "extra_args",
- "bad_words",
- "_bad_words_token_ids",
- "skip_reading_prefix_cache"
- ],
- "title": "Sampling Params"
- },
- "model": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Model"
- },
- "stream": {
- "anyOf": [
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ],
- "title": "Stream",
- "default": false
- },
- "stream_options": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/StreamOptions"
- },
- {
- "type": "null"
- }
- ]
- },
- "cache_salt": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Cache Salt",
- "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)."
- },
- "priority": {
- "type": "integer",
- "title": "Priority",
- "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.",
- "default": 0
- },
- "kv_transfer_params": {
- "anyOf": [
- {
- "additionalProperties": true,
- "type": "object"
- },
- {
- "type": "null"
- }
- ],
- "title": "Kv Transfer Params",
- "description": "KVTransfer parameters used for disaggregated serving."
- }
- },
- "type": "object",
- "required": [
- "token_ids",
- "sampling_params"
- ],
- "title": "GenerateRequest"
- },
- "Grammar": {
- "properties": {
- "definition": {
- "type": "string",
- "title": "Definition"
- },
- "syntax": {
- "type": "string",
- "enum": [
- "lark",
- "regex"
- ],
- "title": "Syntax"
- },
- "type": {
- "type": "string",
- "const": "grammar",
- "title": "Type"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "definition",
- "syntax",
- "type"
- ],
- "title": "Grammar",
- "description": "A grammar defined by the user."
- },
- "HTTPValidationError": {
- "properties": {
- "detail": {
- "items": {
- "$ref": "#/components/schemas/ValidationError"
- },
- "type": "array",
- "title": "Detail"
- }
- },
- "type": "object",
- "title": "HTTPValidationError"
- },
- "IOProcessorRequest": {
- "properties": {
- "model": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Model"
- },
- "priority": {
- "type": "integer",
- "title": "Priority",
- "default": 0
- },
- "data": {
- "title": "Data"
- },
- "task": {
- "type": "string",
- "enum": [
- "embed",
- "classify",
- "score",
- "token_embed",
- "token_classify",
- "plugin"
- ],
- "title": "Task",
- "default": "plugin"
- },
- "encoding_format": {
- "type": "string",
- "enum": [
- "float",
- "base64",
- "bytes",
- "bytes_only"
- ],
- "title": "Encoding Format",
- "default": "float"
- },
- "embed_dtype": {
- "type": "string",
- "enum": [
- "float32",
- "float16",
- "bfloat16",
- "fp8_e4m3",
- "fp8_e5m2"
- ],
- "title": "Embed Dtype",
- "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.",
- "default": "float32"
- },
- "endianness": {
- "type": "string",
- "enum": [
- "native",
- "big",
- "little"
- ],
- "title": "Endianness",
- "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.",
- "default": "native"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "data"
- ],
- "title": "IOProcessorRequest"
- },
- "ImageGeneration": {
- "properties": {
- "type": {
- "type": "string",
- "const": "image_generation",
- "title": "Type"
- },
- "background": {
- "anyOf": [
- {
- "type": "string",
- "enum": [
- "transparent",
- "opaque",
- "auto"
- ]
- },
- {
- "type": "null"
- }
- ],
- "title": "Background"
- },
- "input_fidelity": {
- "anyOf": [
- {
- "type": "string",
- "enum": [
- "high",
- "low"
- ]
- },
- {
- "type": "null"
- }
- ],
- "title": "Input Fidelity"
- },
- "input_image_mask": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/ImageGenerationInputImageMask"
- },
- {
- "type": "null"
- }
- ]
- },
- "model": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "string",
- "enum": [
- "gpt-image-1",
- "gpt-image-1-mini"
- ]
- },
- {
- "type": "null"
- }
- ],
- "title": "Model"
- },
- "moderation": {
- "anyOf": [
- {
- "type": "string",
- "enum": [
- "auto",
- "low"
- ]
- },
- {
- "type": "null"
- }
- ],
- "title": "Moderation"
- },
- "output_compression": {
- "anyOf": [
- {
- "type": "integer"
- },
- {
- "type": "null"
- }
- ],
- "title": "Output Compression"
- },
- "output_format": {
- "anyOf": [
- {
- "type": "string",
- "enum": [
- "png",
- "webp",
- "jpeg"
- ]
- },
- {
- "type": "null"
- }
- ],
- "title": "Output Format"
- },
- "partial_images": {
- "anyOf": [
- {
- "type": "integer"
- },
- {
- "type": "null"
- }
- ],
- "title": "Partial Images"
- },
- "quality": {
- "anyOf": [
- {
- "type": "string",
- "enum": [
- "low",
- "medium",
- "high",
- "auto"
- ]
- },
- {
- "type": "null"
- }
- ],
- "title": "Quality"
- },
- "size": {
- "anyOf": [
- {
- "type": "string",
- "enum": [
- "1024x1024",
- "1024x1536",
- "1536x1024",
- "auto"
- ]
- },
- {
- "type": "null"
- }
- ],
- "title": "Size"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "type"
- ],
- "title": "ImageGeneration",
- "description": "A tool that generates images using the GPT image models."
- },
- "ImageGenerationCall": {
- "properties": {
- "id": {
- "type": "string",
- "title": "Id"
- },
- "result": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Result"
- },
- "status": {
- "type": "string",
- "enum": [
- "in_progress",
- "completed",
- "generating",
- "failed"
- ],
- "title": "Status"
- },
- "type": {
- "type": "string",
- "const": "image_generation_call",
- "title": "Type"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "id",
- "status",
- "type"
- ],
- "title": "ImageGenerationCall",
- "description": "An image generation request made by the model."
- },
- "ImageGenerationInputImageMask": {
- "properties": {
- "file_id": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "File Id"
- },
- "image_url": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Image Url"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "title": "ImageGenerationInputImageMask",
- "description": "Optional mask for inpainting.\n\nContains `image_url`\n(string, optional) and `file_id` (string, optional)."
- },
- "ImageURL": {
- "properties": {
- "url": {
- "type": "string",
- "title": "Url"
- },
- "detail": {
- "type": "string",
- "enum": [
- "auto",
- "low",
- "high"
- ],
- "title": "Detail"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "url"
- ],
- "title": "ImageURL"
- },
- "InputAudio": {
- "properties": {
- "data": {
- "type": "string",
- "title": "Data"
- },
- "format": {
- "type": "string",
- "enum": [
- "wav",
- "mp3"
- ],
- "title": "Format"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "data",
- "format"
- ],
- "title": "InputAudio"
- },
- "ItemReference": {
- "properties": {
- "id": {
- "type": "string",
- "title": "Id"
- },
- "type": {
- "anyOf": [
- {
- "type": "string",
- "const": "item_reference"
- },
- {
- "type": "null"
- }
- ],
- "title": "Type"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "id"
- ],
- "title": "ItemReference",
- "description": "An internal identifier for an item to reference."
- },
- "JsonSchemaResponseFormat": {
- "properties": {
- "name": {
- "type": "string",
- "title": "Name"
- },
- "description": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Description"
- },
- "schema": {
- "anyOf": [
- {
- "additionalProperties": true,
- "type": "object"
- },
- {
- "type": "null"
- }
- ],
- "title": "Schema"
- },
- "strict": {
- "anyOf": [
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ],
- "title": "Strict"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "name"
- ],
- "title": "JsonSchemaResponseFormat"
- },
- "LegacyStructuralTag": {
- "properties": {
- "begin": {
- "type": "string",
- "title": "Begin"
- },
- "schema": {
- "anyOf": [
- {
- "additionalProperties": true,
- "type": "object"
- },
- {
- "type": "null"
- }
- ],
- "title": "Schema"
- },
- "end": {
- "type": "string",
- "title": "End"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "begin",
- "end"
- ],
- "title": "LegacyStructuralTag"
- },
- "LegacyStructuralTagResponseFormat": {
- "properties": {
- "type": {
- "type": "string",
- "const": "structural_tag",
- "title": "Type"
- },
- "structures": {
- "items": {
- "$ref": "#/components/schemas/LegacyStructuralTag"
- },
- "type": "array",
- "title": "Structures"
- },
- "triggers": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "title": "Triggers"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "type",
- "structures",
- "triggers"
- ],
- "title": "LegacyStructuralTagResponseFormat"
- },
- "LocalShell": {
- "properties": {
- "type": {
- "type": "string",
- "const": "local_shell",
- "title": "Type"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "type"
- ],
- "title": "LocalShell",
- "description": "A tool that allows the model to execute shell commands in a local environment."
- },
- "LocalShellCall": {
- "properties": {
- "id": {
- "type": "string",
- "title": "Id"
- },
- "action": {
- "$ref": "#/components/schemas/LocalShellCallAction"
- },
- "call_id": {
- "type": "string",
- "title": "Call Id"
- },
- "status": {
- "type": "string",
- "enum": [
- "in_progress",
- "completed",
- "incomplete"
- ],
- "title": "Status"
- },
- "type": {
- "type": "string",
- "const": "local_shell_call",
- "title": "Type"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "id",
- "action",
- "call_id",
- "status",
- "type"
- ],
- "title": "LocalShellCall",
- "description": "A tool call to run a command on the local shell."
- },
- "LocalShellCallAction": {
- "properties": {
- "command": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "title": "Command"
- },
- "env": {
- "additionalProperties": {
- "type": "string"
- },
- "type": "object",
- "title": "Env"
- },
- "type": {
- "type": "string",
- "const": "exec",
- "title": "Type"
- },
- "timeout_ms": {
- "anyOf": [
- {
- "type": "integer"
- },
- {
- "type": "null"
- }
- ],
- "title": "Timeout Ms"
- },
- "user": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "User"
- },
- "working_directory": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Working Directory"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "command",
- "env",
- "type"
- ],
- "title": "LocalShellCallAction",
- "description": "Execute a shell command on the server."
- },
- "LocalShellCallOutput": {
- "properties": {
- "id": {
- "type": "string",
- "title": "Id"
- },
- "output": {
- "type": "string",
- "title": "Output"
- },
- "type": {
- "type": "string",
- "const": "local_shell_call_output",
- "title": "Type"
- },
- "status": {
- "anyOf": [
- {
- "type": "string",
- "enum": [
- "in_progress",
- "completed",
- "incomplete"
- ]
- },
- {
- "type": "null"
- }
- ],
- "title": "Status"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "id",
- "output",
- "type"
- ],
- "title": "LocalShellCallOutput",
- "description": "The output of a local shell tool call."
- },
- "LogitsProcessorConstructor": {
- "properties": {
- "qualname": {
- "type": "string",
- "title": "Qualname"
- },
- "args": {
- "anyOf": [
- {
- "items": {},
- "type": "array"
- },
- {
- "type": "null"
- }
- ],
- "title": "Args"
- },
- "kwargs": {
- "anyOf": [
- {
- "additionalProperties": true,
- "type": "object"
- },
- {
- "type": "null"
- }
- ],
- "title": "Kwargs"
- }
- },
- "additionalProperties": false,
- "type": "object",
- "required": [
- "qualname"
- ],
- "title": "LogitsProcessorConstructor"
- },
- "Logprob": {
- "properties": {
- "token": {
- "type": "string",
- "title": "Token"
- },
- "bytes": {
- "items": {
- "type": "integer"
- },
- "type": "array",
- "title": "Bytes"
- },
- "logprob": {
- "type": "number",
- "title": "Logprob"
- },
- "top_logprobs": {
- "items": {
- "$ref": "#/components/schemas/LogprobTopLogprob"
- },
- "type": "array",
- "title": "Top Logprobs"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "token",
- "bytes",
- "logprob",
- "top_logprobs"
- ],
- "title": "Logprob",
- "description": "The log probability of a token."
- },
- "LogprobTopLogprob": {
- "properties": {
- "token": {
- "type": "string",
- "title": "Token"
- },
- "bytes": {
- "items": {
- "type": "integer"
- },
- "type": "array",
- "title": "Bytes"
- },
- "logprob": {
- "type": "number",
- "title": "Logprob"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "token",
- "bytes",
- "logprob"
- ],
- "title": "LogprobTopLogprob",
- "description": "The top log probability of a token."
- },
- "Mcp": {
- "properties": {
- "server_label": {
- "type": "string",
- "title": "Server Label"
- },
- "type": {
- "type": "string",
- "const": "mcp",
- "title": "Type"
- },
- "allowed_tools": {
- "anyOf": [
- {
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- {
- "$ref": "#/components/schemas/McpAllowedToolsMcpToolFilter"
- },
- {
- "type": "null"
- }
- ],
- "title": "Allowed Tools"
- },
- "authorization": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Authorization"
- },
- "connector_id": {
- "anyOf": [
- {
- "type": "string",
- "enum": [
- "connector_dropbox",
- "connector_gmail",
- "connector_googlecalendar",
- "connector_googledrive",
- "connector_microsoftteams",
- "connector_outlookcalendar",
- "connector_outlookemail",
- "connector_sharepoint"
- ]
- },
- {
- "type": "null"
- }
- ],
- "title": "Connector Id"
- },
- "headers": {
- "anyOf": [
- {
- "additionalProperties": {
- "type": "string"
- },
- "type": "object"
- },
- {
- "type": "null"
- }
- ],
- "title": "Headers"
- },
- "require_approval": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/McpRequireApprovalMcpToolApprovalFilter"
- },
- {
- "type": "string",
- "enum": [
- "always",
- "never"
- ]
- },
- {
- "type": "null"
- }
- ],
- "title": "Require Approval"
- },
- "server_description": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Server Description"
- },
- "server_url": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Server Url"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "server_label",
- "type"
- ],
- "title": "Mcp",
- "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)."
- },
- "McpAllowedToolsMcpToolFilter": {
- "properties": {
- "read_only": {
- "anyOf": [
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ],
- "title": "Read Only"
- },
- "tool_names": {
- "anyOf": [
- {
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- {
- "type": "null"
- }
- ],
- "title": "Tool Names"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "title": "McpAllowedToolsMcpToolFilter",
- "description": "A filter object to specify which tools are allowed."
- },
- "McpApprovalRequest": {
- "properties": {
- "id": {
- "type": "string",
- "title": "Id"
- },
- "arguments": {
- "type": "string",
- "title": "Arguments"
- },
- "name": {
- "type": "string",
- "title": "Name"
- },
- "server_label": {
- "type": "string",
- "title": "Server Label"
- },
- "type": {
- "type": "string",
- "const": "mcp_approval_request",
- "title": "Type"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "id",
- "arguments",
- "name",
- "server_label",
- "type"
- ],
- "title": "McpApprovalRequest",
- "description": "A request for human approval of a tool invocation."
- },
- "McpApprovalResponse": {
- "properties": {
- "approval_request_id": {
- "type": "string",
- "title": "Approval Request Id"
- },
- "approve": {
- "type": "boolean",
- "title": "Approve"
- },
- "type": {
- "type": "string",
- "const": "mcp_approval_response",
- "title": "Type"
- },
- "id": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Id"
- },
- "reason": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Reason"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "approval_request_id",
- "approve",
- "type"
- ],
- "title": "McpApprovalResponse",
- "description": "A response to an MCP approval request."
- },
- "McpCall": {
- "properties": {
- "id": {
- "type": "string",
- "title": "Id"
- },
- "arguments": {
- "type": "string",
- "title": "Arguments"
- },
- "name": {
- "type": "string",
- "title": "Name"
- },
- "server_label": {
- "type": "string",
- "title": "Server Label"
- },
- "type": {
- "type": "string",
- "const": "mcp_call",
- "title": "Type"
- },
- "approval_request_id": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Approval Request Id"
- },
- "error": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Error"
- },
- "output": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Output"
- },
- "status": {
- "anyOf": [
- {
- "type": "string",
- "enum": [
- "in_progress",
- "completed",
- "incomplete",
- "calling",
- "failed"
- ]
- },
- {
- "type": "null"
- }
- ],
- "title": "Status"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "id",
- "arguments",
- "name",
- "server_label",
- "type"
- ],
- "title": "McpCall",
- "description": "An invocation of a tool on an MCP server."
- },
- "McpListTools": {
- "properties": {
- "id": {
- "type": "string",
- "title": "Id"
- },
- "server_label": {
- "type": "string",
- "title": "Server Label"
- },
- "tools": {
- "items": {
- "$ref": "#/components/schemas/McpListToolsTool"
- },
- "type": "array",
- "title": "Tools"
- },
- "type": {
- "type": "string",
- "const": "mcp_list_tools",
- "title": "Type"
- },
- "error": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Error"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "id",
- "server_label",
- "tools",
- "type"
- ],
- "title": "McpListTools",
- "description": "A list of tools available on an MCP server."
- },
- "McpListToolsTool": {
- "properties": {
- "input_schema": {
- "title": "Input Schema"
- },
- "name": {
- "type": "string",
- "title": "Name"
- },
- "annotations": {
- "anyOf": [
- {},
- {
- "type": "null"
- }
- ],
- "title": "Annotations"
- },
- "description": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Description"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "input_schema",
- "name"
- ],
- "title": "McpListToolsTool",
- "description": "A tool available on an MCP server."
- },
- "McpRequireApprovalMcpToolApprovalFilter": {
- "properties": {
- "always": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/McpRequireApprovalMcpToolApprovalFilterAlways"
- },
- {
- "type": "null"
- }
- ]
- },
- "never": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/McpRequireApprovalMcpToolApprovalFilterNever"
- },
- {
- "type": "null"
- }
- ]
- }
- },
- "additionalProperties": true,
- "type": "object",
- "title": "McpRequireApprovalMcpToolApprovalFilter",
- "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."
- },
- "McpRequireApprovalMcpToolApprovalFilterAlways": {
- "properties": {
- "read_only": {
- "anyOf": [
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ],
- "title": "Read Only"
- },
- "tool_names": {
- "anyOf": [
- {
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- {
- "type": "null"
- }
- ],
- "title": "Tool Names"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "title": "McpRequireApprovalMcpToolApprovalFilterAlways",
- "description": "A filter object to specify which tools are allowed."
- },
- "McpRequireApprovalMcpToolApprovalFilterNever": {
- "properties": {
- "read_only": {
- "anyOf": [
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ],
- "title": "Read Only"
- },
- "tool_names": {
- "anyOf": [
- {
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- {
- "type": "null"
- }
- ],
- "title": "Tool Names"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "title": "McpRequireApprovalMcpToolApprovalFilterNever",
- "description": "A filter object to specify which tools are allowed."
- },
- "Message": {
- "properties": {
- "author": {
- "$ref": "#/components/schemas/Author"
- },
- "content": {
- "items": {
- "$ref": "#/components/schemas/Content"
- },
- "type": "array",
- "title": "Content"
- },
- "channel": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Channel"
- },
- "recipient": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Recipient"
- },
- "content_type": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Content Type"
- }
- },
- "type": "object",
- "required": [
- "author"
- ],
- "title": "Message"
- },
- "OperationCreateFile": {
- "properties": {
- "diff": {
- "type": "string",
- "title": "Diff"
- },
- "path": {
- "type": "string",
- "title": "Path"
- },
- "type": {
- "type": "string",
- "const": "create_file",
- "title": "Type"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "diff",
- "path",
- "type"
- ],
- "title": "OperationCreateFile",
- "description": "Instruction describing how to create a file via the apply_patch tool."
- },
- "OperationDeleteFile": {
- "properties": {
- "path": {
- "type": "string",
- "title": "Path"
- },
- "type": {
- "type": "string",
- "const": "delete_file",
- "title": "Type"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "path",
- "type"
- ],
- "title": "OperationDeleteFile",
- "description": "Instruction describing how to delete a file via the apply_patch tool."
- },
- "OperationUpdateFile": {
- "properties": {
- "diff": {
- "type": "string",
- "title": "Diff"
- },
- "path": {
- "type": "string",
- "title": "Path"
- },
- "type": {
- "type": "string",
- "const": "update_file",
- "title": "Type"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "diff",
- "path",
- "type"
- ],
- "title": "OperationUpdateFile",
- "description": "Instruction describing how to update a file via the apply_patch tool."
- },
- "OutcomeExit": {
- "properties": {
- "exit_code": {
- "type": "integer",
- "title": "Exit Code"
- },
- "type": {
- "type": "string",
- "const": "exit",
- "title": "Type"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "exit_code",
- "type"
- ],
- "title": "OutcomeExit",
- "description": "Indicates that the shell commands finished and returned an exit code."
- },
- "OutcomeTimeout": {
- "properties": {
- "type": {
- "type": "string",
- "const": "timeout",
- "title": "Type"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "type"
- ],
- "title": "OutcomeTimeout",
- "description": "Indicates that the shell call exceeded its configured time limit."
- },
- "Output": {
- "properties": {
- "outcome": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/OutputOutcomeTimeout"
- },
- {
- "$ref": "#/components/schemas/OutputOutcomeExit"
- }
- ],
- "title": "Outcome"
- },
- "stderr": {
- "type": "string",
- "title": "Stderr"
- },
- "stdout": {
- "type": "string",
- "title": "Stdout"
- },
- "created_by": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Created By"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "outcome",
- "stderr",
- "stdout"
- ],
- "title": "Output",
- "description": "The content of a shell tool call output that was emitted."
- },
- "OutputImage": {
- "properties": {
- "type": {
- "type": "string",
- "const": "image",
- "title": "Type"
- },
- "url": {
- "type": "string",
- "title": "Url"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "type",
- "url"
- ],
- "title": "OutputImage",
- "description": "The image output from the code interpreter."
- },
- "OutputLogs": {
- "properties": {
- "logs": {
- "type": "string",
- "title": "Logs"
- },
- "type": {
- "type": "string",
- "const": "logs",
- "title": "Type"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "logs",
- "type"
- ],
- "title": "OutputLogs",
- "description": "The logs output from the code interpreter."
- },
- "OutputOutcomeExit": {
- "properties": {
- "exit_code": {
- "type": "integer",
- "title": "Exit Code"
- },
- "type": {
- "type": "string",
- "const": "exit",
- "title": "Type"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "exit_code",
- "type"
- ],
- "title": "OutputOutcomeExit",
- "description": "Indicates that the shell commands finished and returned an exit code."
- },
- "OutputOutcomeTimeout": {
- "properties": {
- "type": {
- "type": "string",
- "const": "timeout",
- "title": "Type"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "type"
- ],
- "title": "OutputOutcomeTimeout",
- "description": "Indicates that the shell call exceeded its configured time limit."
- },
- "PendingSafetyCheck": {
- "properties": {
- "id": {
- "type": "string",
- "title": "Id"
- },
- "code": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Code"
- },
- "message": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Message"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "id"
- ],
- "title": "PendingSafetyCheck",
- "description": "A pending safety check for the computer call."
- },
- "PoolingChatRequest": {
- "properties": {
- "model": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Model"
- },
- "messages": {
- "items": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/ChatCompletionDeveloperMessageParam"
- },
- {
- "$ref": "#/components/schemas/ChatCompletionSystemMessageParam"
- },
- {
- "$ref": "#/components/schemas/ChatCompletionUserMessageParam"
- },
- {
- "$ref": "#/components/schemas/ChatCompletionAssistantMessageParam"
- },
- {
- "$ref": "#/components/schemas/ChatCompletionToolMessageParam"
- },
- {
- "$ref": "#/components/schemas/ChatCompletionFunctionMessageParam"
- },
- {
- "$ref": "#/components/schemas/CustomChatCompletionMessageParam"
- },
- {
- "$ref": "#/components/schemas/Message"
- }
- ]
- },
- "type": "array",
- "title": "Messages"
- },
- "encoding_format": {
- "type": "string",
- "enum": [
- "float",
- "base64",
- "bytes",
- "bytes_only"
- ],
- "title": "Encoding Format",
- "default": "float"
- },
- "dimensions": {
- "anyOf": [
- {
- "type": "integer"
- },
- {
- "type": "null"
- }
- ],
- "title": "Dimensions"
- },
- "user": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "User"
- },
- "truncate_prompt_tokens": {
- "anyOf": [
- {
- "type": "integer",
- "minimum": -1
- },
- {
- "type": "null"
- }
- ],
- "title": "Truncate Prompt Tokens"
- },
- "add_generation_prompt": {
- "type": "boolean",
- "title": "Add Generation Prompt",
- "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.",
- "default": false
- },
- "continue_final_message": {
- "type": "boolean",
- "title": "Continue Final Message",
- "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`.",
- "default": false
- },
- "add_special_tokens": {
- "type": "boolean",
- "title": "Add Special Tokens",
- "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).",
- "default": false
- },
- "chat_template": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Chat Template",
- "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."
- },
- "chat_template_kwargs": {
- "anyOf": [
- {
- "additionalProperties": true,
- "type": "object"
- },
- {
- "type": "null"
- }
- ],
- "title": "Chat Template Kwargs",
- "description": "Additional keyword args to pass to the template renderer. Will be accessible by the chat template."
- },
- "mm_processor_kwargs": {
- "anyOf": [
- {
- "additionalProperties": true,
- "type": "object"
- },
- {
- "type": "null"
- }
- ],
- "title": "Mm Processor Kwargs",
- "description": "Additional kwargs to pass to the HF processor."
- },
- "priority": {
- "type": "integer",
- "title": "Priority",
- "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.",
- "default": 0
- },
- "request_id": {
- "type": "string",
- "title": "Request Id",
- "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."
- },
- "normalize": {
- "anyOf": [
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ],
- "title": "Normalize",
- "description": "Whether to normalize the embeddings outputs. Default is True."
- },
- "embed_dtype": {
- "type": "string",
- "enum": [
- "float32",
- "float16",
- "bfloat16",
- "fp8_e4m3",
- "fp8_e5m2"
- ],
- "title": "Embed Dtype",
- "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.",
- "default": "float32"
- },
- "endianness": {
- "type": "string",
- "enum": [
- "native",
- "big",
- "little"
- ],
- "title": "Endianness",
- "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.",
- "default": "native"
- },
- "task": {
- "anyOf": [
- {
- "type": "string",
- "enum": [
- "embed",
- "classify",
- "score",
- "token_embed",
- "token_classify",
- "plugin"
- ]
- },
- {
- "type": "null"
- }
- ],
- "title": "Task"
- },
- "softmax": {
- "anyOf": [
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ],
- "title": "Softmax",
- "description": "softmax will be deprecated, please use use_activation instead."
- },
- "activation": {
- "anyOf": [
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ],
- "title": "Activation",
- "description": "activation will be deprecated, please use use_activation instead."
- },
- "use_activation": {
- "anyOf": [
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ],
- "title": "Use Activation",
- "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."
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "messages"
- ],
- "title": "PoolingChatRequest"
- },
- "PoolingCompletionRequest": {
- "properties": {
- "model": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Model"
- },
- "input": {
- "anyOf": [
- {
- "items": {
- "type": "integer"
- },
- "type": "array"
- },
- {
- "items": {
- "items": {
- "type": "integer"
- },
- "type": "array"
- },
- "type": "array"
- },
- {
- "type": "string"
- },
- {
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- ],
- "title": "Input"
- },
- "encoding_format": {
- "type": "string",
- "enum": [
- "float",
- "base64",
- "bytes",
- "bytes_only"
- ],
- "title": "Encoding Format",
- "default": "float"
- },
- "dimensions": {
- "anyOf": [
- {
- "type": "integer"
- },
- {
- "type": "null"
- }
- ],
- "title": "Dimensions"
- },
- "user": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "User"
- },
- "truncate_prompt_tokens": {
- "anyOf": [
- {
- "type": "integer",
- "minimum": -1
- },
- {
- "type": "null"
- }
- ],
- "title": "Truncate Prompt Tokens"
- },
- "add_special_tokens": {
- "type": "boolean",
- "title": "Add Special Tokens",
- "description": "If true (the default), special tokens (e.g. BOS) will be added to the prompt.",
- "default": true
- },
- "priority": {
- "type": "integer",
- "title": "Priority",
- "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.",
- "default": 0
- },
- "request_id": {
- "type": "string",
- "title": "Request Id",
- "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."
- },
- "normalize": {
- "anyOf": [
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ],
- "title": "Normalize",
- "description": "Whether to normalize the embeddings outputs. Default is True."
- },
- "embed_dtype": {
- "type": "string",
- "enum": [
- "float32",
- "float16",
- "bfloat16",
- "fp8_e4m3",
- "fp8_e5m2"
- ],
- "title": "Embed Dtype",
- "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.",
- "default": "float32"
- },
- "endianness": {
- "type": "string",
- "enum": [
- "native",
- "big",
- "little"
- ],
- "title": "Endianness",
- "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.",
- "default": "native"
- },
- "task": {
- "anyOf": [
- {
- "type": "string",
- "enum": [
- "embed",
- "classify",
- "score",
- "token_embed",
- "token_classify",
- "plugin"
- ]
- },
- {
- "type": "null"
- }
- ],
- "title": "Task"
- },
- "softmax": {
- "anyOf": [
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ],
- "title": "Softmax",
- "description": "softmax will be deprecated, please use use_activation instead."
- },
- "activation": {
- "anyOf": [
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ],
- "title": "Activation",
- "description": "activation will be deprecated, please use use_activation instead."
- },
- "use_activation": {
- "anyOf": [
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ],
- "title": "Use Activation",
- "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."
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "input"
- ],
- "title": "PoolingCompletionRequest"
- },
- "RankingOptions": {
- "properties": {
- "hybrid_search": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/RankingOptionsHybridSearch"
- },
- {
- "type": "null"
- }
- ]
- },
- "ranker": {
- "anyOf": [
- {
- "type": "string",
- "enum": [
- "auto",
- "default-2024-11-15"
- ]
- },
- {
- "type": "null"
- }
- ],
- "title": "Ranker"
- },
- "score_threshold": {
- "anyOf": [
- {
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "title": "Score Threshold"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "title": "RankingOptions",
- "description": "Ranking options for search."
- },
- "RankingOptionsHybridSearch": {
- "properties": {
- "embedding_weight": {
- "type": "number",
- "title": "Embedding Weight"
- },
- "text_weight": {
- "type": "number",
- "title": "Text Weight"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "embedding_weight",
- "text_weight"
- ],
- "title": "RankingOptionsHybridSearch",
- "description": "Weights that control how reciprocal rank fusion balances semantic embedding matches versus sparse keyword matches when hybrid search is enabled."
- },
- "Reasoning": {
- "properties": {
- "effort": {
- "anyOf": [
- {
- "type": "string",
- "enum": [
- "none",
- "minimal",
- "low",
- "medium",
- "high",
- "xhigh"
- ]
- },
- {
- "type": "null"
- }
- ],
- "title": "Effort"
- },
- "generate_summary": {
- "anyOf": [
- {
- "type": "string",
- "enum": [
- "auto",
- "concise",
- "detailed"
- ]
- },
- {
- "type": "null"
- }
- ],
- "title": "Generate Summary"
- },
- "summary": {
- "anyOf": [
- {
- "type": "string",
- "enum": [
- "auto",
- "concise",
- "detailed"
- ]
- },
- {
- "type": "null"
- }
- ],
- "title": "Summary"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "title": "Reasoning",
- "description": "**gpt-5 and o-series models only**\n\nConfiguration options for\n[reasoning models](https://platform.openai.com/docs/guides/reasoning)."
- },
- "RequestOutputKind": {
- "type": "integer",
- "enum": [
- 0,
- 1,
- 2
- ],
- "title": "RequestOutputKind"
- },
- "RerankRequest": {
- "properties": {
- "model": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Model"
- },
- "query": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "$ref": "#/components/schemas/ScoreMultiModalParam"
- }
- ],
- "title": "Query"
- },
- "documents": {
- "anyOf": [
- {
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- {
- "$ref": "#/components/schemas/ScoreMultiModalParam"
- }
- ],
- "title": "Documents"
- },
- "top_n": {
- "type": "integer",
- "title": "Top N"
- },
- "truncate_prompt_tokens": {
- "anyOf": [
- {
- "type": "integer",
- "minimum": -1
- },
- {
- "type": "null"
- }
- ],
- "title": "Truncate Prompt Tokens"
- },
- "mm_processor_kwargs": {
- "anyOf": [
- {
- "additionalProperties": true,
- "type": "object"
- },
- {
- "type": "null"
- }
- ],
- "title": "Mm Processor Kwargs",
- "description": "Additional kwargs to pass to the HF processor."
- },
- "priority": {
- "type": "integer",
- "title": "Priority",
- "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.",
- "default": 0
- },
- "softmax": {
- "anyOf": [
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ],
- "title": "Softmax",
- "description": "softmax will be deprecated, please use use_activation instead."
- },
- "activation": {
- "anyOf": [
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ],
- "title": "Activation",
- "description": "activation will be deprecated, please use use_activation instead."
- },
- "use_activation": {
- "anyOf": [
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ],
- "title": "Use Activation",
- "description": "Whether to use activation for classification outputs. Default is True."
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "query",
- "documents"
- ],
- "title": "RerankRequest"
- },
- "ResponseApplyPatchToolCall": {
- "properties": {
- "id": {
- "type": "string",
- "title": "Id"
- },
- "call_id": {
- "type": "string",
- "title": "Call Id"
- },
- "operation": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/OperationCreateFile"
- },
- {
- "$ref": "#/components/schemas/OperationDeleteFile"
- },
- {
- "$ref": "#/components/schemas/OperationUpdateFile"
- }
- ],
- "title": "Operation"
- },
- "status": {
- "type": "string",
- "enum": [
- "in_progress",
- "completed"
- ],
- "title": "Status"
- },
- "type": {
- "type": "string",
- "const": "apply_patch_call",
- "title": "Type"
- },
- "created_by": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Created By"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "id",
- "call_id",
- "operation",
- "status",
- "type"
- ],
- "title": "ResponseApplyPatchToolCall",
- "description": "A tool call that applies file diffs by creating, deleting, or updating files."
- },
- "ResponseApplyPatchToolCallOutput": {
- "properties": {
- "id": {
- "type": "string",
- "title": "Id"
- },
- "call_id": {
- "type": "string",
- "title": "Call Id"
- },
- "status": {
- "type": "string",
- "enum": [
- "completed",
- "failed"
- ],
- "title": "Status"
- },
- "type": {
- "type": "string",
- "const": "apply_patch_call_output",
- "title": "Type"
- },
- "created_by": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Created By"
- },
- "output": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Output"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "id",
- "call_id",
- "status",
- "type"
- ],
- "title": "ResponseApplyPatchToolCallOutput",
- "description": "The output emitted by an apply patch tool call."
- },
- "ResponseCodeInterpreterToolCall": {
- "properties": {
- "id": {
- "type": "string",
- "title": "Id"
- },
- "code": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Code"
- },
- "container_id": {
- "type": "string",
- "title": "Container Id"
- },
- "outputs": {
- "anyOf": [
- {
- "items": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/OutputLogs"
- },
- {
- "$ref": "#/components/schemas/OutputImage"
- }
- ]
- },
- "type": "array"
- },
- {
- "type": "null"
- }
- ],
- "title": "Outputs"
- },
- "status": {
- "type": "string",
- "enum": [
- "in_progress",
- "completed",
- "incomplete",
- "interpreting",
- "failed"
- ],
- "title": "Status"
- },
- "type": {
- "type": "string",
- "const": "code_interpreter_call",
- "title": "Type"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "id",
- "container_id",
- "status",
- "type"
- ],
- "title": "ResponseCodeInterpreterToolCall",
- "description": "A tool call to run code."
- },
- "ResponseCodeInterpreterToolCallParam": {
- "properties": {
- "id": {
- "type": "string",
- "title": "Id"
- },
- "code": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Code"
- },
- "container_id": {
- "type": "string",
- "title": "Container Id"
- },
- "outputs": {
- "anyOf": [
- {
- "items": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/OutputLogs"
- },
- {
- "$ref": "#/components/schemas/OutputImage"
- }
- ]
- },
- "type": "array"
- },
- {
- "type": "null"
- }
- ],
- "title": "Outputs"
- },
- "status": {
- "type": "string",
- "enum": [
- "in_progress",
- "completed",
- "incomplete",
- "interpreting",
- "failed"
- ],
- "title": "Status"
- },
- "type": {
- "type": "string",
- "const": "code_interpreter_call",
- "title": "Type"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "id",
- "code",
- "container_id",
- "outputs",
- "status",
- "type"
- ],
- "title": "ResponseCodeInterpreterToolCallParam",
- "description": "A tool call to run code."
- },
- "ResponseCompactionItem": {
- "properties": {
- "id": {
- "type": "string",
- "title": "Id"
- },
- "encrypted_content": {
- "type": "string",
- "title": "Encrypted Content"
- },
- "type": {
- "type": "string",
- "const": "compaction",
- "title": "Type"
- },
- "created_by": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Created By"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "id",
- "encrypted_content",
- "type"
- ],
- "title": "ResponseCompactionItem",
- "description": "A compaction item generated by the [`v1/responses/compact` API](https://platform.openai.com/docs/api-reference/responses/compact)."
- },
- "ResponseCompactionItemParamParam": {
- "properties": {
- "encrypted_content": {
- "type": "string",
- "title": "Encrypted Content"
- },
- "type": {
- "type": "string",
- "const": "compaction",
- "title": "Type"
- },
- "id": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Id"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "encrypted_content",
- "type"
- ],
- "title": "ResponseCompactionItemParamParam",
- "description": "A compaction item generated by the [`v1/responses/compact` API](https://platform.openai.com/docs/api-reference/responses/compact)."
- },
- "ResponseComputerToolCall": {
- "properties": {
- "id": {
- "type": "string",
- "title": "Id"
- },
- "action": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/ActionClick"
- },
- {
- "$ref": "#/components/schemas/ActionDoubleClick"
- },
- {
- "$ref": "#/components/schemas/ActionDrag"
- },
- {
- "$ref": "#/components/schemas/ActionKeypress"
- },
- {
- "$ref": "#/components/schemas/ActionMove"
- },
- {
- "$ref": "#/components/schemas/ActionScreenshot"
- },
- {
- "$ref": "#/components/schemas/ActionScroll"
- },
- {
- "$ref": "#/components/schemas/ActionType"
- },
- {
- "$ref": "#/components/schemas/ActionWait"
- }
- ],
- "title": "Action"
- },
- "call_id": {
- "type": "string",
- "title": "Call Id"
- },
- "pending_safety_checks": {
- "items": {
- "$ref": "#/components/schemas/PendingSafetyCheck"
- },
- "type": "array",
- "title": "Pending Safety Checks"
- },
- "status": {
- "type": "string",
- "enum": [
- "in_progress",
- "completed",
- "incomplete"
- ],
- "title": "Status"
- },
- "type": {
- "type": "string",
- "const": "computer_call",
- "title": "Type"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "id",
- "action",
- "call_id",
- "pending_safety_checks",
- "status",
- "type"
- ],
- "title": "ResponseComputerToolCall",
- "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."
- },
- "ResponseComputerToolCallOutputScreenshotParam": {
- "properties": {
- "type": {
- "type": "string",
- "const": "computer_screenshot",
- "title": "Type"
- },
- "file_id": {
- "type": "string",
- "title": "File Id"
- },
- "image_url": {
- "type": "string",
- "title": "Image Url"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "type"
- ],
- "title": "ResponseComputerToolCallOutputScreenshotParam",
- "description": "A computer screenshot image used with the computer use tool."
- },
- "ResponseComputerToolCallParam": {
- "properties": {
- "id": {
- "type": "string",
- "title": "Id"
- },
- "action": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/ActionClick"
- },
- {
- "$ref": "#/components/schemas/ActionDoubleClick"
- },
- {
- "$ref": "#/components/schemas/ActionDrag"
- },
- {
- "$ref": "#/components/schemas/ActionKeypress"
- },
- {
- "$ref": "#/components/schemas/ActionMove"
- },
- {
- "$ref": "#/components/schemas/ActionScreenshot"
- },
- {
- "$ref": "#/components/schemas/ActionScroll"
- },
- {
- "$ref": "#/components/schemas/ActionType"
- },
- {
- "$ref": "#/components/schemas/ActionWait"
- }
- ],
- "title": "Action"
- },
- "call_id": {
- "type": "string",
- "title": "Call Id"
- },
- "pending_safety_checks": {
- "items": {
- "$ref": "#/components/schemas/openai__types__responses__response_computer_tool_call_param__PendingSafetyCheck"
- },
- "type": "array",
- "title": "Pending Safety Checks"
- },
- "status": {
- "type": "string",
- "enum": [
- "in_progress",
- "completed",
- "incomplete"
- ],
- "title": "Status"
- },
- "type": {
- "type": "string",
- "const": "computer_call",
- "title": "Type"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "id",
- "action",
- "call_id",
- "pending_safety_checks",
- "status",
- "type"
- ],
- "title": "ResponseComputerToolCallParam",
- "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."
- },
- "ResponseCustomToolCall": {
- "properties": {
- "call_id": {
- "type": "string",
- "title": "Call Id"
- },
- "input": {
- "type": "string",
- "title": "Input"
- },
- "name": {
- "type": "string",
- "title": "Name"
- },
- "type": {
- "type": "string",
- "const": "custom_tool_call",
- "title": "Type"
- },
- "id": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Id"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "call_id",
- "input",
- "name",
- "type"
- ],
- "title": "ResponseCustomToolCall",
- "description": "A call to a custom tool created by the model."
- },
- "ResponseCustomToolCallOutputParam": {
- "properties": {
- "call_id": {
- "type": "string",
- "title": "Call Id"
- },
- "output": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "items": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/ResponseInputTextParam"
- },
- {
- "$ref": "#/components/schemas/ResponseInputImageParam"
- },
- {
- "$ref": "#/components/schemas/ResponseInputFileParam"
- }
- ]
- },
- "type": "array"
- }
- ],
- "title": "Output"
- },
- "type": {
- "type": "string",
- "const": "custom_tool_call_output",
- "title": "Type"
- },
- "id": {
- "type": "string",
- "title": "Id"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "call_id",
- "output",
- "type"
- ],
- "title": "ResponseCustomToolCallOutputParam",
- "description": "The output of a custom tool call from your code, being sent back to the model."
- },
- "ResponseCustomToolCallParam": {
- "properties": {
- "call_id": {
- "type": "string",
- "title": "Call Id"
- },
- "input": {
- "type": "string",
- "title": "Input"
- },
- "name": {
- "type": "string",
- "title": "Name"
- },
- "type": {
- "type": "string",
- "const": "custom_tool_call",
- "title": "Type"
- },
- "id": {
- "type": "string",
- "title": "Id"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "call_id",
- "input",
- "name",
- "type"
- ],
- "title": "ResponseCustomToolCallParam",
- "description": "A call to a custom tool created by the model."
- },
- "ResponseFileSearchToolCall": {
- "properties": {
- "id": {
- "type": "string",
- "title": "Id"
- },
- "queries": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "title": "Queries"
- },
- "status": {
- "type": "string",
- "enum": [
- "in_progress",
- "searching",
- "completed",
- "incomplete",
- "failed"
- ],
- "title": "Status"
- },
- "type": {
- "type": "string",
- "const": "file_search_call",
- "title": "Type"
- },
- "results": {
- "anyOf": [
- {
- "items": {
- "$ref": "#/components/schemas/Result"
- },
- "type": "array"
- },
- {
- "type": "null"
- }
- ],
- "title": "Results"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "id",
- "queries",
- "status",
- "type"
- ],
- "title": "ResponseFileSearchToolCall",
- "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."
- },
- "ResponseFileSearchToolCallParam": {
- "properties": {
- "id": {
- "type": "string",
- "title": "Id"
- },
- "queries": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "title": "Queries"
- },
- "status": {
- "type": "string",
- "enum": [
- "in_progress",
- "searching",
- "completed",
- "incomplete",
- "failed"
- ],
- "title": "Status"
- },
- "type": {
- "type": "string",
- "const": "file_search_call",
- "title": "Type"
- },
- "results": {
- "anyOf": [
- {
- "items": {
- "$ref": "#/components/schemas/openai__types__responses__response_file_search_tool_call_param__Result"
- },
- "type": "array"
- },
- {
- "type": "null"
- }
- ],
- "title": "Results"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "id",
- "queries",
- "status",
- "type"
- ],
- "title": "ResponseFileSearchToolCallParam",
- "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."
- },
- "ResponseFormat": {
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "text",
- "json_object",
- "json_schema"
- ],
- "title": "Type"
- },
- "json_schema": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/JsonSchemaResponseFormat"
- },
- {
- "type": "null"
- }
- ]
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "type"
- ],
- "title": "ResponseFormat"
- },
- "ResponseFormatJSONObject": {
- "properties": {
- "type": {
- "type": "string",
- "const": "json_object",
- "title": "Type"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "type"
- ],
- "title": "ResponseFormatJSONObject",
- "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."
- },
- "ResponseFormatText": {
- "properties": {
- "type": {
- "type": "string",
- "const": "text",
- "title": "Type"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "type"
- ],
- "title": "ResponseFormatText",
- "description": "Default response format. Used to generate text responses."
- },
- "ResponseFormatTextJSONSchemaConfig": {
- "properties": {
- "name": {
- "type": "string",
- "title": "Name"
- },
- "schema": {
- "additionalProperties": true,
- "type": "object",
- "title": "Schema"
- },
- "type": {
- "type": "string",
- "const": "json_schema",
- "title": "Type"
- },
- "description": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Description"
- },
- "strict": {
- "anyOf": [
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ],
- "title": "Strict"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "name",
- "schema",
- "type"
- ],
- "title": "ResponseFormatTextJSONSchemaConfig",
- "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)."
- },
- "ResponseFunctionShellCallOutputContentParam": {
- "properties": {
- "outcome": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/OutcomeTimeout"
- },
- {
- "$ref": "#/components/schemas/OutcomeExit"
- }
- ],
- "title": "Outcome"
- },
- "stderr": {
- "type": "string",
- "title": "Stderr"
- },
- "stdout": {
- "type": "string",
- "title": "Stdout"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "outcome",
- "stderr",
- "stdout"
- ],
- "title": "ResponseFunctionShellCallOutputContentParam",
- "description": "Captured stdout and stderr for a portion of a shell tool call output."
- },
- "ResponseFunctionShellToolCall": {
- "properties": {
- "id": {
- "type": "string",
- "title": "Id"
- },
- "action": {
- "$ref": "#/components/schemas/Action"
- },
- "call_id": {
- "type": "string",
- "title": "Call Id"
- },
- "status": {
- "type": "string",
- "enum": [
- "in_progress",
- "completed",
- "incomplete"
- ],
- "title": "Status"
- },
- "type": {
- "type": "string",
- "const": "shell_call",
- "title": "Type"
- },
- "created_by": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Created By"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "id",
- "action",
- "call_id",
- "status",
- "type"
- ],
- "title": "ResponseFunctionShellToolCall",
- "description": "A tool call that executes one or more shell commands in a managed environment."
- },
- "ResponseFunctionShellToolCallOutput": {
- "properties": {
- "id": {
- "type": "string",
- "title": "Id"
- },
- "call_id": {
- "type": "string",
- "title": "Call Id"
- },
- "max_output_length": {
- "anyOf": [
- {
- "type": "integer"
- },
- {
- "type": "null"
- }
- ],
- "title": "Max Output Length"
- },
- "output": {
- "items": {
- "$ref": "#/components/schemas/Output"
- },
- "type": "array",
- "title": "Output"
- },
- "status": {
- "type": "string",
- "enum": [
- "in_progress",
- "completed",
- "incomplete"
- ],
- "title": "Status"
- },
- "type": {
- "type": "string",
- "const": "shell_call_output",
- "title": "Type"
- },
- "created_by": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Created By"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "id",
- "call_id",
- "output",
- "status",
- "type"
- ],
- "title": "ResponseFunctionShellToolCallOutput",
- "description": "The output of a shell tool call that was emitted."
- },
- "ResponseFunctionToolCall": {
- "properties": {
- "arguments": {
- "type": "string",
- "title": "Arguments"
- },
- "call_id": {
- "type": "string",
- "title": "Call Id"
- },
- "name": {
- "type": "string",
- "title": "Name"
- },
- "type": {
- "type": "string",
- "const": "function_call",
- "title": "Type"
- },
- "id": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Id"
- },
- "status": {
- "anyOf": [
- {
- "type": "string",
- "enum": [
- "in_progress",
- "completed",
- "incomplete"
- ]
- },
- {
- "type": "null"
- }
- ],
- "title": "Status"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "arguments",
- "call_id",
- "name",
- "type"
- ],
- "title": "ResponseFunctionToolCall",
- "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."
- },
- "ResponseFunctionToolCallParam": {
- "properties": {
- "arguments": {
- "type": "string",
- "title": "Arguments"
- },
- "call_id": {
- "type": "string",
- "title": "Call Id"
- },
- "name": {
- "type": "string",
- "title": "Name"
- },
- "type": {
- "type": "string",
- "const": "function_call",
- "title": "Type"
- },
- "id": {
- "type": "string",
- "title": "Id"
- },
- "status": {
- "type": "string",
- "enum": [
- "in_progress",
- "completed",
- "incomplete"
- ],
- "title": "Status"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "arguments",
- "call_id",
- "name",
- "type"
- ],
- "title": "ResponseFunctionToolCallParam",
- "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."
- },
- "ResponseFunctionWebSearch": {
- "properties": {
- "id": {
- "type": "string",
- "title": "Id"
- },
- "action": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/ActionSearch"
- },
- {
- "$ref": "#/components/schemas/ActionOpenPage"
- },
- {
- "$ref": "#/components/schemas/ActionFind"
- }
- ],
- "title": "Action"
- },
- "status": {
- "type": "string",
- "enum": [
- "in_progress",
- "searching",
- "completed",
- "failed"
- ],
- "title": "Status"
- },
- "type": {
- "type": "string",
- "const": "web_search_call",
- "title": "Type"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "id",
- "action",
- "status",
- "type"
- ],
- "title": "ResponseFunctionWebSearch",
- "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."
- },
- "ResponseFunctionWebSearchParam": {
- "properties": {
- "id": {
- "type": "string",
- "title": "Id"
- },
- "action": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/openai__types__responses__response_function_web_search_param__ActionSearch"
- },
- {
- "$ref": "#/components/schemas/ActionOpenPage"
- },
- {
- "$ref": "#/components/schemas/ActionFind"
- }
- ],
- "title": "Action"
- },
- "status": {
- "type": "string",
- "enum": [
- "in_progress",
- "searching",
- "completed",
- "failed"
- ],
- "title": "Status"
- },
- "type": {
- "type": "string",
- "const": "web_search_call",
- "title": "Type"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "id",
- "action",
- "status",
- "type"
- ],
- "title": "ResponseFunctionWebSearchParam",
- "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."
- },
- "ResponseInputFile": {
- "properties": {
- "type": {
- "type": "string",
- "const": "input_file",
- "title": "Type"
- },
- "file_data": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "File Data"
- },
- "file_id": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "File Id"
- },
- "file_url": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "File Url"
- },
- "filename": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Filename"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "type"
- ],
- "title": "ResponseInputFile",
- "description": "A file input to the model."
- },
- "ResponseInputFileContentParam": {
- "properties": {
- "type": {
- "type": "string",
- "const": "input_file",
- "title": "Type"
- },
- "file_data": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "File Data"
- },
- "file_id": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "File Id"
- },
- "file_url": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "File Url"
- },
- "filename": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Filename"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "type"
- ],
- "title": "ResponseInputFileContentParam",
- "description": "A file input to the model."
- },
- "ResponseInputFileParam": {
- "properties": {
- "type": {
- "type": "string",
- "const": "input_file",
- "title": "Type"
- },
- "file_data": {
- "type": "string",
- "title": "File Data"
- },
- "file_id": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "File Id"
- },
- "file_url": {
- "type": "string",
- "title": "File Url"
- },
- "filename": {
- "type": "string",
- "title": "Filename"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "type"
- ],
- "title": "ResponseInputFileParam",
- "description": "A file input to the model."
- },
- "ResponseInputImage": {
- "properties": {
- "detail": {
- "type": "string",
- "enum": [
- "low",
- "high",
- "auto"
- ],
- "title": "Detail"
- },
- "type": {
- "type": "string",
- "const": "input_image",
- "title": "Type"
- },
- "file_id": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "File Id"
- },
- "image_url": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Image Url"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "detail",
- "type"
- ],
- "title": "ResponseInputImage",
- "description": "An image input to the model.\n\nLearn about [image inputs](https://platform.openai.com/docs/guides/vision)."
- },
- "ResponseInputImageContentParam": {
- "properties": {
- "type": {
- "type": "string",
- "const": "input_image",
- "title": "Type"
- },
- "detail": {
- "anyOf": [
- {
- "type": "string",
- "enum": [
- "low",
- "high",
- "auto"
- ]
- },
- {
- "type": "null"
- }
- ],
- "title": "Detail"
- },
- "file_id": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "File Id"
- },
- "image_url": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Image Url"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "type"
- ],
- "title": "ResponseInputImageContentParam",
- "description": "An image input to the model.\n\nLearn about [image inputs](https://platform.openai.com/docs/guides/vision)"
- },
- "ResponseInputImageParam": {
- "properties": {
- "detail": {
- "type": "string",
- "enum": [
- "low",
- "high",
- "auto"
- ],
- "title": "Detail"
- },
- "type": {
- "type": "string",
- "const": "input_image",
- "title": "Type"
- },
- "file_id": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "File Id"
- },
- "image_url": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Image Url"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "detail",
- "type"
- ],
- "title": "ResponseInputImageParam",
- "description": "An image input to the model.\n\nLearn about [image inputs](https://platform.openai.com/docs/guides/vision)."
- },
- "ResponseInputText": {
- "properties": {
- "text": {
- "type": "string",
- "title": "Text"
- },
- "type": {
- "type": "string",
- "const": "input_text",
- "title": "Type"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "text",
- "type"
- ],
- "title": "ResponseInputText",
- "description": "A text input to the model."
- },
- "ResponseInputTextContentParam": {
- "properties": {
- "text": {
- "type": "string",
- "title": "Text"
- },
- "type": {
- "type": "string",
- "const": "input_text",
- "title": "Type"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "text",
- "type"
- ],
- "title": "ResponseInputTextContentParam",
- "description": "A text input to the model."
- },
- "ResponseInputTextParam": {
- "properties": {
- "text": {
- "type": "string",
- "title": "Text"
- },
- "type": {
- "type": "string",
- "const": "input_text",
- "title": "Type"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "text",
- "type"
- ],
- "title": "ResponseInputTextParam",
- "description": "A text input to the model."
- },
- "ResponseOutputMessage": {
- "properties": {
- "id": {
- "type": "string",
- "title": "Id"
- },
- "content": {
- "items": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/ResponseOutputText"
- },
- {
- "$ref": "#/components/schemas/ResponseOutputRefusal"
- }
- ]
- },
- "type": "array",
- "title": "Content"
- },
- "role": {
- "type": "string",
- "const": "assistant",
- "title": "Role"
- },
- "status": {
- "type": "string",
- "enum": [
- "in_progress",
- "completed",
- "incomplete"
- ],
- "title": "Status"
- },
- "type": {
- "type": "string",
- "const": "message",
- "title": "Type"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "id",
- "content",
- "role",
- "status",
- "type"
- ],
- "title": "ResponseOutputMessage",
- "description": "An output message from the model."
- },
- "ResponseOutputMessageParam": {
- "properties": {
- "id": {
- "type": "string",
- "title": "Id"
- },
- "content": {
- "items": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/ResponseOutputTextParam"
- },
- {
- "$ref": "#/components/schemas/ResponseOutputRefusalParam"
- }
- ]
- },
- "type": "array",
- "title": "Content"
- },
- "role": {
- "type": "string",
- "const": "assistant",
- "title": "Role"
- },
- "status": {
- "type": "string",
- "enum": [
- "in_progress",
- "completed",
- "incomplete"
- ],
- "title": "Status"
- },
- "type": {
- "type": "string",
- "const": "message",
- "title": "Type"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "id",
- "content",
- "role",
- "status",
- "type"
- ],
- "title": "ResponseOutputMessageParam",
- "description": "An output message from the model."
- },
- "ResponseOutputRefusal": {
- "properties": {
- "refusal": {
- "type": "string",
- "title": "Refusal"
- },
- "type": {
- "type": "string",
- "const": "refusal",
- "title": "Type"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "refusal",
- "type"
- ],
- "title": "ResponseOutputRefusal",
- "description": "A refusal from the model."
- },
- "ResponseOutputRefusalParam": {
- "properties": {
- "refusal": {
- "type": "string",
- "title": "Refusal"
- },
- "type": {
- "type": "string",
- "const": "refusal",
- "title": "Type"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "refusal",
- "type"
- ],
- "title": "ResponseOutputRefusalParam",
- "description": "A refusal from the model."
- },
- "ResponseOutputText": {
- "properties": {
- "annotations": {
- "items": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/AnnotationFileCitation"
- },
- {
- "$ref": "#/components/schemas/AnnotationURLCitation"
- },
- {
- "$ref": "#/components/schemas/AnnotationContainerFileCitation"
- },
- {
- "$ref": "#/components/schemas/AnnotationFilePath"
- }
- ]
- },
- "type": "array",
- "title": "Annotations"
- },
- "text": {
- "type": "string",
- "title": "Text"
- },
- "type": {
- "type": "string",
- "const": "output_text",
- "title": "Type"
- },
- "logprobs": {
- "anyOf": [
- {
- "items": {
- "$ref": "#/components/schemas/Logprob"
- },
- "type": "array"
- },
- {
- "type": "null"
- }
- ],
- "title": "Logprobs"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "annotations",
- "text",
- "type"
- ],
- "title": "ResponseOutputText",
- "description": "A text output from the model."
- },
- "ResponseOutputTextParam": {
- "properties": {
- "annotations": {
- "items": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/AnnotationFileCitation"
- },
- {
- "$ref": "#/components/schemas/AnnotationURLCitation"
- },
- {
- "$ref": "#/components/schemas/AnnotationContainerFileCitation"
- },
- {
- "$ref": "#/components/schemas/AnnotationFilePath"
- }
- ]
- },
- "type": "array",
- "title": "Annotations"
- },
- "text": {
- "type": "string",
- "title": "Text"
- },
- "type": {
- "type": "string",
- "const": "output_text",
- "title": "Type"
- },
- "logprobs": {
- "items": {
- "$ref": "#/components/schemas/Logprob"
- },
- "type": "array",
- "title": "Logprobs"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "annotations",
- "text",
- "type"
- ],
- "title": "ResponseOutputTextParam",
- "description": "A text output from the model."
- },
- "ResponsePrompt": {
- "properties": {
- "id": {
- "type": "string",
- "title": "Id"
- },
- "variables": {
- "anyOf": [
- {
- "additionalProperties": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "$ref": "#/components/schemas/ResponseInputText"
- },
- {
- "$ref": "#/components/schemas/ResponseInputImage"
- },
- {
- "$ref": "#/components/schemas/ResponseInputFile"
- }
- ]
- },
- "type": "object"
- },
- {
- "type": "null"
- }
- ],
- "title": "Variables"
- },
- "version": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Version"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "id"
- ],
- "title": "ResponsePrompt",
- "description": "Reference to a prompt template and its variables.\n[Learn more](https://platform.openai.com/docs/guides/text?api-mode=responses#reusable-prompts)."
- },
- "ResponseReasoningItem": {
- "properties": {
- "id": {
- "type": "string",
- "title": "Id"
- },
- "summary": {
- "items": {
- "$ref": "#/components/schemas/Summary"
- },
- "type": "array",
- "title": "Summary"
- },
- "type": {
- "type": "string",
- "const": "reasoning",
- "title": "Type"
- },
- "content": {
- "anyOf": [
- {
- "items": {
- "$ref": "#/components/schemas/openai__types__responses__response_reasoning_item__Content"
- },
- "type": "array"
- },
- {
- "type": "null"
- }
- ],
- "title": "Content"
- },
- "encrypted_content": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Encrypted Content"
- },
- "status": {
- "anyOf": [
- {
- "type": "string",
- "enum": [
- "in_progress",
- "completed",
- "incomplete"
- ]
- },
- {
- "type": "null"
- }
- ],
- "title": "Status"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "id",
- "summary",
- "type"
- ],
- "title": "ResponseReasoningItem",
- "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)."
- },
- "ResponseReasoningItemParam": {
- "properties": {
- "id": {
- "type": "string",
- "title": "Id"
- },
- "summary": {
- "items": {
- "$ref": "#/components/schemas/Summary"
- },
- "type": "array",
- "title": "Summary"
- },
- "type": {
- "type": "string",
- "const": "reasoning",
- "title": "Type"
- },
- "content": {
- "items": {
- "$ref": "#/components/schemas/openai__types__responses__response_reasoning_item_param__Content"
- },
- "type": "array",
- "title": "Content"
- },
- "encrypted_content": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Encrypted Content"
- },
- "status": {
- "type": "string",
- "enum": [
- "in_progress",
- "completed",
- "incomplete"
- ],
- "title": "Status"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "id",
- "summary",
- "type"
- ],
- "title": "ResponseReasoningItemParam",
- "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)."
- },
- "ResponseTextConfig": {
- "properties": {
- "format": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/ResponseFormatText"
- },
- {
- "$ref": "#/components/schemas/ResponseFormatTextJSONSchemaConfig"
- },
- {
- "$ref": "#/components/schemas/ResponseFormatJSONObject"
- },
- {
- "type": "null"
- }
- ],
- "title": "Format"
- },
- "verbosity": {
- "anyOf": [
- {
- "type": "string",
- "enum": [
- "low",
- "medium",
- "high"
- ]
- },
- {
- "type": "null"
- }
- ],
- "title": "Verbosity"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "title": "ResponseTextConfig",
- "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)"
- },
- "ResponsesRequest": {
- "properties": {
- "background": {
- "anyOf": [
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ],
- "title": "Background",
- "default": false
- },
- "include": {
- "anyOf": [
- {
- "items": {
- "type": "string",
- "enum": [
- "code_interpreter_call.outputs",
- "computer_call_output.output.image_url",
- "file_search_call.results",
- "message.input_image.image_url",
- "message.output_text.logprobs",
- "reasoning.encrypted_content"
- ]
- },
- "type": "array"
- },
- {
- "type": "null"
- }
- ],
- "title": "Include"
- },
- "input": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "items": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/EasyInputMessageParam"
- },
- {
- "$ref": "#/components/schemas/openai__types__responses__response_input_item_param__Message"
- },
- {
- "$ref": "#/components/schemas/ResponseOutputMessageParam"
- },
- {
- "$ref": "#/components/schemas/ResponseFileSearchToolCallParam"
- },
- {
- "$ref": "#/components/schemas/ResponseComputerToolCallParam"
- },
- {
- "$ref": "#/components/schemas/ComputerCallOutput"
- },
- {
- "$ref": "#/components/schemas/ResponseFunctionWebSearchParam"
- },
- {
- "$ref": "#/components/schemas/ResponseFunctionToolCallParam"
- },
- {
- "$ref": "#/components/schemas/FunctionCallOutput"
- },
- {
- "$ref": "#/components/schemas/ResponseReasoningItemParam"
- },
- {
- "$ref": "#/components/schemas/ResponseCompactionItemParamParam"
- },
- {
- "$ref": "#/components/schemas/openai__types__responses__response_input_item_param__ImageGenerationCall"
- },
- {
- "$ref": "#/components/schemas/ResponseCodeInterpreterToolCallParam"
- },
- {
- "$ref": "#/components/schemas/openai__types__responses__response_input_item_param__LocalShellCall"
- },
- {
- "$ref": "#/components/schemas/LocalShellCallOutput"
- },
- {
- "$ref": "#/components/schemas/ShellCall"
- },
- {
- "$ref": "#/components/schemas/ShellCallOutput"
- },
- {
- "$ref": "#/components/schemas/ApplyPatchCall"
- },
- {
- "$ref": "#/components/schemas/ApplyPatchCallOutput"
- },
- {
- "$ref": "#/components/schemas/openai__types__responses__response_input_item_param__McpListTools"
- },
- {
- "$ref": "#/components/schemas/McpApprovalRequest"
- },
- {
- "$ref": "#/components/schemas/McpApprovalResponse"
- },
- {
- "$ref": "#/components/schemas/openai__types__responses__response_input_item_param__McpCall"
- },
- {
- "$ref": "#/components/schemas/ResponseCustomToolCallOutputParam"
- },
- {
- "$ref": "#/components/schemas/ResponseCustomToolCallParam"
- },
- {
- "$ref": "#/components/schemas/ItemReference"
- },
- {
- "$ref": "#/components/schemas/ResponseOutputMessage"
- },
- {
- "$ref": "#/components/schemas/ResponseFileSearchToolCall"
- },
- {
- "$ref": "#/components/schemas/ResponseFunctionToolCall"
- },
- {
- "$ref": "#/components/schemas/ResponseFunctionWebSearch"
- },
- {
- "$ref": "#/components/schemas/ResponseComputerToolCall"
- },
- {
- "$ref": "#/components/schemas/ResponseReasoningItem"
- },
- {
- "$ref": "#/components/schemas/ResponseCompactionItem"
- },
- {
- "$ref": "#/components/schemas/ImageGenerationCall"
- },
- {
- "$ref": "#/components/schemas/ResponseCodeInterpreterToolCall"
- },
- {
- "$ref": "#/components/schemas/LocalShellCall"
- },
- {
- "$ref": "#/components/schemas/ResponseFunctionShellToolCall"
- },
- {
- "$ref": "#/components/schemas/ResponseFunctionShellToolCallOutput"
- },
- {
- "$ref": "#/components/schemas/ResponseApplyPatchToolCall"
- },
- {
- "$ref": "#/components/schemas/ResponseApplyPatchToolCallOutput"
- },
- {
- "$ref": "#/components/schemas/McpCall"
- },
- {
- "$ref": "#/components/schemas/McpListTools"
- },
- {
- "$ref": "#/components/schemas/McpApprovalRequest"
- },
- {
- "$ref": "#/components/schemas/ResponseCustomToolCall"
- }
- ]
- },
- "type": "array"
- }
- ],
- "title": "Input"
- },
- "instructions": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Instructions"
- },
- "max_output_tokens": {
- "anyOf": [
- {
- "type": "integer"
- },
- {
- "type": "null"
- }
- ],
- "title": "Max Output Tokens"
- },
- "max_tool_calls": {
- "anyOf": [
- {
- "type": "integer"
- },
- {
- "type": "null"
- }
- ],
- "title": "Max Tool Calls"
- },
- "metadata": {
- "anyOf": [
- {
- "additionalProperties": {
- "type": "string"
- },
- "type": "object"
- },
- {
- "type": "null"
- }
- ],
- "title": "Metadata"
- },
- "model": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Model"
- },
- "logit_bias": {
- "anyOf": [
- {
- "additionalProperties": {
- "type": "number"
- },
- "type": "object"
- },
- {
- "type": "null"
- }
- ],
- "title": "Logit Bias"
- },
- "parallel_tool_calls": {
- "anyOf": [
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ],
- "title": "Parallel Tool Calls",
- "default": true
- },
- "previous_response_id": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Previous Response Id"
- },
- "prompt": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/ResponsePrompt"
- },
- {
- "type": "null"
- }
- ]
- },
- "reasoning": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/Reasoning"
- },
- {
- "type": "null"
- }
- ]
- },
- "service_tier": {
- "type": "string",
- "enum": [
- "auto",
- "default",
- "flex",
- "scale",
- "priority"
- ],
- "title": "Service Tier",
- "default": "auto"
- },
- "store": {
- "anyOf": [
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ],
- "title": "Store",
- "default": true
- },
- "stream": {
- "anyOf": [
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ],
- "title": "Stream",
- "default": false
- },
- "temperature": {
- "anyOf": [
- {
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "title": "Temperature"
- },
- "text": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/ResponseTextConfig"
- },
- {
- "type": "null"
- }
- ]
- },
- "tool_choice": {
- "anyOf": [
- {
- "type": "string",
- "enum": [
- "none",
- "auto",
- "required"
- ]
- },
- {
- "$ref": "#/components/schemas/ToolChoiceAllowed"
- },
- {
- "$ref": "#/components/schemas/ToolChoiceTypes"
- },
- {
- "$ref": "#/components/schemas/ToolChoiceFunction"
- },
- {
- "$ref": "#/components/schemas/ToolChoiceMcp"
- },
- {
- "$ref": "#/components/schemas/ToolChoiceCustom"
- },
- {
- "$ref": "#/components/schemas/ToolChoiceApplyPatch"
- },
- {
- "$ref": "#/components/schemas/ToolChoiceShell"
- }
- ],
- "title": "Tool Choice",
- "default": "auto"
- },
- "tools": {
- "items": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/FunctionTool"
- },
- {
- "$ref": "#/components/schemas/FileSearchTool"
- },
- {
- "$ref": "#/components/schemas/ComputerTool"
- },
- {
- "$ref": "#/components/schemas/WebSearchTool"
- },
- {
- "$ref": "#/components/schemas/Mcp"
- },
- {
- "$ref": "#/components/schemas/CodeInterpreter"
- },
- {
- "$ref": "#/components/schemas/ImageGeneration"
- },
- {
- "$ref": "#/components/schemas/LocalShell"
- },
- {
- "$ref": "#/components/schemas/FunctionShellTool"
- },
- {
- "$ref": "#/components/schemas/CustomTool"
- },
- {
- "$ref": "#/components/schemas/WebSearchPreviewTool"
- },
- {
- "$ref": "#/components/schemas/ApplyPatchTool"
- }
- ]
- },
- "type": "array",
- "title": "Tools"
- },
- "top_logprobs": {
- "anyOf": [
- {
- "type": "integer"
- },
- {
- "type": "null"
- }
- ],
- "title": "Top Logprobs",
- "default": 0
- },
- "top_p": {
- "anyOf": [
- {
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "title": "Top P"
- },
- "top_k": {
- "anyOf": [
- {
- "type": "integer"
- },
- {
- "type": "null"
- }
- ],
- "title": "Top K"
- },
- "truncation": {
- "anyOf": [
- {
- "type": "string",
- "enum": [
- "auto",
- "disabled"
- ]
- },
- {
- "type": "null"
- }
- ],
- "title": "Truncation",
- "default": "disabled"
- },
- "user": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "User"
- },
- "request_id": {
- "type": "string",
- "title": "Request Id",
- "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."
- },
- "mm_processor_kwargs": {
- "anyOf": [
- {
- "additionalProperties": true,
- "type": "object"
- },
- {
- "type": "null"
- }
- ],
- "title": "Mm Processor Kwargs",
- "description": "Additional kwargs to pass to the HF processor."
- },
- "priority": {
- "type": "integer",
- "title": "Priority",
- "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.",
- "default": 0
- },
- "cache_salt": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Cache Salt",
- "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)."
- },
- "enable_response_messages": {
- "type": "boolean",
- "title": "Enable Response Messages",
- "description": "Dictates whether or not to return messages as part of the response object. Currently only supported fornon-background and gpt-oss only. ",
- "default": false
- },
- "previous_input_messages": {
- "anyOf": [
- {
- "items": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/Message"
- },
- {
- "additionalProperties": true,
- "type": "object"
- }
- ]
- },
- "type": "array"
- },
- {
- "type": "null"
- }
- ],
- "title": "Previous Input Messages"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "input"
- ],
- "title": "ResponsesRequest"
- },
- "Result": {
- "properties": {
- "attributes": {
- "anyOf": [
- {
- "additionalProperties": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "number"
- },
- {
- "type": "boolean"
- }
- ]
- },
- "type": "object"
- },
- {
- "type": "null"
- }
- ],
- "title": "Attributes"
- },
- "file_id": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "File Id"
- },
- "filename": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Filename"
- },
- "score": {
- "anyOf": [
- {
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "title": "Score"
- },
- "text": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Text"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "title": "Result"
- },
- "Role": {
- "type": "string",
- "enum": [
- "user",
- "assistant",
- "system",
- "developer",
- "tool"
- ],
- "title": "Role",
- "description": "The role of a message author (mirrors ``chat::Role``)."
- },
- "ScoreMultiModalParam": {
- "properties": {
- "content": {
- "items": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/ChatCompletionContentPartImageParam"
- },
- {
- "$ref": "#/components/schemas/ChatCompletionContentPartImageEmbedsParam"
- },
- {
- "$ref": "#/components/schemas/ChatCompletionContentPartTextParam"
- },
- {
- "$ref": "#/components/schemas/ChatCompletionContentPartVideoParam"
- }
- ]
- },
- "type": "array",
- "title": "Content"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "content"
- ],
- "title": "ScoreMultiModalParam",
- "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"
- },
- "ScoreRequest": {
- "properties": {
- "model": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Model"
- },
- "text_1": {
- "anyOf": [
- {
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- {
- "type": "string"
- },
- {
- "$ref": "#/components/schemas/ScoreMultiModalParam"
- }
- ],
- "title": "Text 1"
- },
- "text_2": {
- "anyOf": [
- {
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- {
- "type": "string"
- },
- {
- "$ref": "#/components/schemas/ScoreMultiModalParam"
- }
- ],
- "title": "Text 2"
- },
- "truncate_prompt_tokens": {
- "anyOf": [
- {
- "type": "integer",
- "minimum": -1
- },
- {
- "type": "null"
- }
- ],
- "title": "Truncate Prompt Tokens"
- },
- "mm_processor_kwargs": {
- "anyOf": [
- {
- "additionalProperties": true,
- "type": "object"
- },
- {
- "type": "null"
- }
- ],
- "title": "Mm Processor Kwargs",
- "description": "Additional kwargs to pass to the HF processor."
- },
- "priority": {
- "type": "integer",
- "title": "Priority",
- "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.",
- "default": 0
- },
- "softmax": {
- "anyOf": [
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ],
- "title": "Softmax",
- "description": "softmax will be deprecated, please use use_activation instead."
- },
- "activation": {
- "anyOf": [
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ],
- "title": "Activation",
- "description": "activation will be deprecated, please use use_activation instead."
- },
- "use_activation": {
- "anyOf": [
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ],
- "title": "Use Activation",
- "description": "Whether to use activation for classification outputs. Default is True."
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "text_1",
- "text_2"
- ],
- "title": "ScoreRequest"
- },
- "ShellCall": {
- "properties": {
- "action": {
- "$ref": "#/components/schemas/ShellCallAction"
- },
- "call_id": {
- "type": "string",
- "title": "Call Id"
- },
- "type": {
- "type": "string",
- "const": "shell_call",
- "title": "Type"
- },
- "id": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Id"
- },
- "status": {
- "anyOf": [
- {
- "type": "string",
- "enum": [
- "in_progress",
- "completed",
- "incomplete"
- ]
- },
- {
- "type": "null"
- }
- ],
- "title": "Status"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "action",
- "call_id",
- "type"
- ],
- "title": "ShellCall",
- "description": "A tool representing a request to execute one or more shell commands."
- },
- "ShellCallAction": {
- "properties": {
- "commands": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "title": "Commands"
- },
- "max_output_length": {
- "anyOf": [
- {
- "type": "integer"
- },
- {
- "type": "null"
- }
- ],
- "title": "Max Output Length"
- },
- "timeout_ms": {
- "anyOf": [
- {
- "type": "integer"
- },
- {
- "type": "null"
- }
- ],
- "title": "Timeout Ms"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "commands"
- ],
- "title": "ShellCallAction",
- "description": "The shell commands and limits that describe how to run the tool call."
- },
- "ShellCallOutput": {
- "properties": {
- "call_id": {
- "type": "string",
- "title": "Call Id"
- },
- "output": {
- "items": {
- "$ref": "#/components/schemas/ResponseFunctionShellCallOutputContentParam"
- },
- "type": "array",
- "title": "Output"
- },
- "type": {
- "type": "string",
- "const": "shell_call_output",
- "title": "Type"
- },
- "id": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Id"
- },
- "max_output_length": {
- "anyOf": [
- {
- "type": "integer"
- },
- {
- "type": "null"
- }
- ],
- "title": "Max Output Length"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "call_id",
- "output",
- "type"
- ],
- "title": "ShellCallOutput",
- "description": "The streamed output items emitted by a shell tool call."
- },
- "StreamOptions": {
- "properties": {
- "include_usage": {
- "anyOf": [
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ],
- "title": "Include Usage",
- "default": true
- },
- "continuous_usage_stats": {
- "anyOf": [
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ],
- "title": "Continuous Usage Stats",
- "default": false
- }
- },
- "additionalProperties": true,
- "type": "object",
- "title": "StreamOptions"
- },
- "StructuralTagResponseFormat": {
- "properties": {
- "type": {
- "type": "string",
- "const": "structural_tag",
- "title": "Type"
- },
- "format": {
- "title": "Format"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "type",
- "format"
- ],
- "title": "StructuralTagResponseFormat"
- },
- "StructuredOutputsParams": {
- "properties": {
- "json": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "additionalProperties": true,
- "type": "object"
- },
- {
- "type": "null"
- }
- ],
- "title": "Json"
- },
- "regex": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Regex"
- },
- "choice": {
- "anyOf": [
- {
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- {
- "type": "null"
- }
- ],
- "title": "Choice"
- },
- "grammar": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Grammar"
- },
- "json_object": {
- "anyOf": [
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ],
- "title": "Json Object"
- },
- "disable_fallback": {
- "type": "boolean",
- "title": "Disable Fallback",
- "default": false
- },
- "disable_any_whitespace": {
- "type": "boolean",
- "title": "Disable Any Whitespace",
- "default": false
- },
- "disable_additional_properties": {
- "type": "boolean",
- "title": "Disable Additional Properties",
- "default": false
- },
- "whitespace_pattern": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Whitespace Pattern"
- },
- "structural_tag": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Structural Tag"
- },
- "_backend": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Backend"
- },
- "_backend_was_auto": {
- "type": "boolean",
- "title": "Backend Was Auto",
- "default": false
- }
- },
- "type": "object",
- "title": "StructuredOutputsParams"
- },
- "Summary": {
- "properties": {
- "text": {
- "type": "string",
- "title": "Text"
- },
- "type": {
- "type": "string",
- "const": "summary_text",
- "title": "Type"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "text",
- "type"
- ],
- "title": "Summary",
- "description": "A summary text from the model."
- },
- "Text": {
- "properties": {
- "type": {
- "type": "string",
- "const": "text",
- "title": "Type"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "type"
- ],
- "title": "Text",
- "description": "Unconstrained free-form text."
- },
- "TokenizeChatRequest": {
- "properties": {
- "model": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Model"
- },
- "messages": {
- "items": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/ChatCompletionDeveloperMessageParam"
- },
- {
- "$ref": "#/components/schemas/ChatCompletionSystemMessageParam"
- },
- {
- "$ref": "#/components/schemas/ChatCompletionUserMessageParam"
- },
- {
- "$ref": "#/components/schemas/ChatCompletionAssistantMessageParam"
- },
- {
- "$ref": "#/components/schemas/ChatCompletionToolMessageParam"
- },
- {
- "$ref": "#/components/schemas/ChatCompletionFunctionMessageParam"
- },
- {
- "$ref": "#/components/schemas/CustomChatCompletionMessageParam"
- },
- {
- "$ref": "#/components/schemas/Message"
- }
- ]
- },
- "type": "array",
- "title": "Messages"
- },
- "add_generation_prompt": {
- "type": "boolean",
- "title": "Add Generation Prompt",
- "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.",
- "default": true
- },
- "return_token_strs": {
- "anyOf": [
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ],
- "title": "Return Token Strs",
- "description": "If true, also return the token strings corresponding to the token ids.",
- "default": false
- },
- "continue_final_message": {
- "type": "boolean",
- "title": "Continue Final Message",
- "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`.",
- "default": false
- },
- "add_special_tokens": {
- "type": "boolean",
- "title": "Add Special Tokens",
- "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).",
- "default": false
- },
- "chat_template": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Chat Template",
- "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."
- },
- "chat_template_kwargs": {
- "anyOf": [
- {
- "additionalProperties": true,
- "type": "object"
- },
- {
- "type": "null"
- }
- ],
- "title": "Chat Template Kwargs",
- "description": "Additional keyword args to pass to the template renderer. Will be accessible by the chat template."
- },
- "mm_processor_kwargs": {
- "anyOf": [
- {
- "additionalProperties": true,
- "type": "object"
- },
- {
- "type": "null"
- }
- ],
- "title": "Mm Processor Kwargs",
- "description": "Additional kwargs to pass to the HF processor."
- },
- "tools": {
- "anyOf": [
- {
- "items": {
- "$ref": "#/components/schemas/ChatCompletionToolsParam"
- },
- "type": "array"
- },
- {
- "type": "null"
- }
- ],
- "title": "Tools",
- "description": "A list of tools the model may call."
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "messages"
- ],
- "title": "TokenizeChatRequest"
- },
- "TokenizeCompletionRequest": {
- "properties": {
- "model": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Model"
- },
- "prompt": {
- "type": "string",
- "title": "Prompt"
- },
- "add_special_tokens": {
- "type": "boolean",
- "title": "Add Special Tokens",
- "description": "If true (the default), special tokens (e.g. BOS) will be added to the prompt.",
- "default": true
- },
- "return_token_strs": {
- "anyOf": [
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ],
- "title": "Return Token Strs",
- "description": "If true, also return the token strings corresponding to the token ids.",
- "default": false
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "prompt"
- ],
- "title": "TokenizeCompletionRequest"
- },
- "ToolChoiceAllowed": {
- "properties": {
- "mode": {
- "type": "string",
- "enum": [
- "auto",
- "required"
- ],
- "title": "Mode"
- },
- "tools": {
- "items": {
- "additionalProperties": true,
- "type": "object"
- },
- "type": "array",
- "title": "Tools"
- },
- "type": {
- "type": "string",
- "const": "allowed_tools",
- "title": "Type"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "mode",
- "tools",
- "type"
- ],
- "title": "ToolChoiceAllowed",
- "description": "Constrains the tools available to the model to a pre-defined set."
- },
- "ToolChoiceApplyPatch": {
- "properties": {
- "type": {
- "type": "string",
- "const": "apply_patch",
- "title": "Type"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "type"
- ],
- "title": "ToolChoiceApplyPatch",
- "description": "Forces the model to call the apply_patch tool when executing a tool call."
- },
- "ToolChoiceCustom": {
- "properties": {
- "name": {
- "type": "string",
- "title": "Name"
- },
- "type": {
- "type": "string",
- "const": "custom",
- "title": "Type"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "name",
- "type"
- ],
- "title": "ToolChoiceCustom",
- "description": "Use this option to force the model to call a specific custom tool."
- },
- "ToolChoiceFunction": {
- "properties": {
- "name": {
- "type": "string",
- "title": "Name"
- },
- "type": {
- "type": "string",
- "const": "function",
- "title": "Type"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "name",
- "type"
- ],
- "title": "ToolChoiceFunction",
- "description": "Use this option to force the model to call a specific function."
- },
- "ToolChoiceMcp": {
- "properties": {
- "server_label": {
- "type": "string",
- "title": "Server Label"
- },
- "type": {
- "type": "string",
- "const": "mcp",
- "title": "Type"
- },
- "name": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Name"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "server_label",
- "type"
- ],
- "title": "ToolChoiceMcp",
- "description": "Use this option to force the model to call a specific tool on a remote MCP server."
- },
- "ToolChoiceShell": {
- "properties": {
- "type": {
- "type": "string",
- "const": "shell",
- "title": "Type"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "type"
- ],
- "title": "ToolChoiceShell",
- "description": "Forces the model to call the shell tool when a tool call is required."
- },
- "ToolChoiceTypes": {
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "file_search",
- "web_search_preview",
- "computer_use_preview",
- "web_search_preview_2025_03_11",
- "image_generation",
- "code_interpreter"
- ],
- "title": "Type"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "type"
- ],
- "title": "ToolChoiceTypes",
- "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)."
- },
- "TranscriptionRequest": {
- "properties": {
- "file": {
- "type": "string",
- "format": "binary",
- "title": "File"
- },
- "model": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Model"
- },
- "language": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Language"
- },
- "prompt": {
- "type": "string",
- "title": "Prompt",
- "default": ""
- },
- "response_format": {
- "type": "string",
- "enum": [
- "json",
- "text",
- "srt",
- "verbose_json",
- "vtt"
- ],
- "title": "Response Format",
- "default": "json"
- },
- "timestamp_granularities[]": {
- "items": {
- "type": "string",
- "enum": [
- "word",
- "segment"
- ]
- },
- "type": "array",
- "title": "Timestamp Granularities[]",
- "default": []
- },
- "stream": {
- "anyOf": [
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ],
- "title": "Stream",
- "default": false
- },
- "stream_include_usage": {
- "anyOf": [
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ],
- "title": "Stream Include Usage",
- "default": false
- },
- "stream_continuous_usage_stats": {
- "anyOf": [
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ],
- "title": "Stream Continuous Usage Stats",
- "default": false
- },
- "vllm_xargs": {
- "anyOf": [
- {
- "additionalProperties": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "integer"
- },
- {
- "type": "number"
- }
- ]
- },
- "type": "object"
- },
- {
- "type": "null"
- }
- ],
- "title": "Vllm Xargs",
- "description": "Additional request parameters with string or numeric values, used by custom extensions."
- },
- "to_language": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "To Language"
- },
- "temperature": {
- "type": "number",
- "title": "Temperature",
- "default": 0
- },
- "top_p": {
- "anyOf": [
- {
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "title": "Top P"
- },
- "top_k": {
- "anyOf": [
- {
- "type": "integer"
- },
- {
- "type": "null"
- }
- ],
- "title": "Top K"
- },
- "min_p": {
- "anyOf": [
- {
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "title": "Min P"
- },
- "seed": {
- "anyOf": [
- {
- "type": "integer",
- "maximum": "9.223372036854776e+18",
- "minimum": -9223372036854776000
- },
- {
- "type": "null"
- }
- ],
- "title": "Seed"
- },
- "frequency_penalty": {
- "anyOf": [
- {
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "title": "Frequency Penalty",
- "default": 0
- },
- "repetition_penalty": {
- "anyOf": [
- {
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "title": "Repetition Penalty"
- },
- "presence_penalty": {
- "anyOf": [
- {
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "title": "Presence Penalty",
- "default": 0
- },
- "max_completion_tokens": {
- "anyOf": [
- {
- "type": "integer"
- },
- {
- "type": "null"
- }
- ],
- "title": "Max Completion Tokens"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "file"
- ],
- "title": "TranscriptionRequest"
- },
- "TranslationRequest": {
- "properties": {
- "file": {
- "type": "string",
- "format": "binary",
- "title": "File"
- },
- "model": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Model"
- },
- "prompt": {
- "type": "string",
- "title": "Prompt",
- "default": ""
- },
- "response_format": {
- "type": "string",
- "enum": [
- "json",
- "text",
- "srt",
- "verbose_json",
- "vtt"
- ],
- "title": "Response Format",
- "default": "json"
- },
- "seed": {
- "anyOf": [
- {
- "type": "integer",
- "maximum": "9.223372036854776e+18",
- "minimum": -9223372036854776000
- },
- {
- "type": "null"
- }
- ],
- "title": "Seed"
- },
- "temperature": {
- "type": "number",
- "title": "Temperature",
- "default": 0
- },
- "language": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Language"
- },
- "to_language": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "To Language"
- },
- "stream": {
- "anyOf": [
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ],
- "title": "Stream",
- "default": false
- },
- "stream_include_usage": {
- "anyOf": [
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ],
- "title": "Stream Include Usage",
- "default": false
- },
- "stream_continuous_usage_stats": {
- "anyOf": [
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ],
- "title": "Stream Continuous Usage Stats",
- "default": false
- },
- "max_completion_tokens": {
- "anyOf": [
- {
- "type": "integer"
- },
- {
- "type": "null"
- }
- ],
- "title": "Max Completion Tokens"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "file"
- ],
- "title": "TranslationRequest"
- },
- "UserLocation": {
- "properties": {
- "type": {
- "type": "string",
- "const": "approximate",
- "title": "Type"
- },
- "city": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "City"
- },
- "country": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Country"
- },
- "region": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Region"
- },
- "timezone": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Timezone"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "type"
- ],
- "title": "UserLocation",
- "description": "The user's location."
- },
- "ValidationError": {
- "properties": {
- "loc": {
- "items": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "integer"
- }
- ]
- },
- "type": "array",
- "title": "Location"
- },
- "msg": {
- "type": "string",
- "title": "Message"
- },
- "type": {
- "type": "string",
- "title": "Error Type"
- }
- },
- "type": "object",
- "required": [
- "loc",
- "msg",
- "type"
- ],
- "title": "ValidationError"
- },
- "VideoURL": {
- "properties": {
- "url": {
- "type": "string",
- "title": "Url"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "url"
- ],
- "title": "VideoURL"
- },
- "WebSearchPreviewTool": {
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "web_search_preview",
- "web_search_preview_2025_03_11"
- ],
- "title": "Type"
- },
- "search_context_size": {
- "anyOf": [
- {
- "type": "string",
- "enum": [
- "low",
- "medium",
- "high"
- ]
- },
- {
- "type": "null"
- }
- ],
- "title": "Search Context Size"
- },
- "user_location": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/UserLocation"
- },
- {
- "type": "null"
- }
- ]
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "type"
- ],
- "title": "WebSearchPreviewTool",
- "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)."
- },
- "WebSearchTool": {
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "web_search",
- "web_search_2025_08_26"
- ],
- "title": "Type"
- },
- "filters": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/Filters"
- },
- {
- "type": "null"
- }
- ]
- },
- "search_context_size": {
- "anyOf": [
- {
- "type": "string",
- "enum": [
- "low",
- "medium",
- "high"
- ]
- },
- {
- "type": "null"
- }
- ],
- "title": "Search Context Size"
- },
- "user_location": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/openai__types__responses__web_search_tool__UserLocation"
- },
- {
- "type": "null"
- }
- ]
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "type"
- ],
- "title": "WebSearchTool",
- "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)."
- },
- "openai__types__responses__response_computer_tool_call_param__PendingSafetyCheck": {
- "properties": {
- "id": {
- "type": "string",
- "title": "Id"
- },
- "code": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Code"
- },
- "message": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Message"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "id"
- ],
- "title": "PendingSafetyCheck",
- "description": "A pending safety check for the computer call."
- },
- "openai__types__responses__response_file_search_tool_call_param__Result": {
- "properties": {
- "attributes": {
- "anyOf": [
- {
- "additionalProperties": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "number"
- },
- {
- "type": "boolean"
- }
- ]
- },
- "type": "object"
- },
- {
- "type": "null"
- }
- ],
- "title": "Attributes"
- },
- "file_id": {
- "type": "string",
- "title": "File Id"
- },
- "filename": {
- "type": "string",
- "title": "Filename"
- },
- "score": {
- "type": "number",
- "title": "Score"
- },
- "text": {
- "type": "string",
- "title": "Text"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "title": "Result"
- },
- "openai__types__responses__response_function_web_search_param__ActionSearch": {
- "properties": {
- "query": {
- "type": "string",
- "title": "Query"
- },
- "type": {
- "type": "string",
- "const": "search",
- "title": "Type"
- },
- "queries": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "title": "Queries"
- },
- "sources": {
- "items": {
- "$ref": "#/components/schemas/ActionSearchSource"
- },
- "type": "array",
- "title": "Sources"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "query",
- "type"
- ],
- "title": "ActionSearch",
- "description": "Action type \"search\" - Performs a web search query."
- },
- "openai__types__responses__response_input_item_param__ImageGenerationCall": {
- "properties": {
- "id": {
- "type": "string",
- "title": "Id"
- },
- "result": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Result"
- },
- "status": {
- "type": "string",
- "enum": [
- "in_progress",
- "completed",
- "generating",
- "failed"
- ],
- "title": "Status"
- },
- "type": {
- "type": "string",
- "const": "image_generation_call",
- "title": "Type"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "id",
- "result",
- "status",
- "type"
- ],
- "title": "ImageGenerationCall",
- "description": "An image generation request made by the model."
- },
- "openai__types__responses__response_input_item_param__LocalShellCall": {
- "properties": {
- "id": {
- "type": "string",
- "title": "Id"
- },
- "action": {
- "$ref": "#/components/schemas/openai__types__responses__response_input_item_param__LocalShellCallAction"
- },
- "call_id": {
- "type": "string",
- "title": "Call Id"
- },
- "status": {
- "type": "string",
- "enum": [
- "in_progress",
- "completed",
- "incomplete"
- ],
- "title": "Status"
- },
- "type": {
- "type": "string",
- "const": "local_shell_call",
- "title": "Type"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "id",
- "action",
- "call_id",
- "status",
- "type"
- ],
- "title": "LocalShellCall",
- "description": "A tool call to run a command on the local shell."
- },
- "openai__types__responses__response_input_item_param__LocalShellCallAction": {
- "properties": {
- "command": {
- "items": {
- "type": "string"
- },
- "type": "array",
- "title": "Command"
- },
- "env": {
- "additionalProperties": {
- "type": "string"
- },
- "type": "object",
- "title": "Env"
- },
- "type": {
- "type": "string",
- "const": "exec",
- "title": "Type"
- },
- "timeout_ms": {
- "anyOf": [
- {
- "type": "integer"
- },
- {
- "type": "null"
- }
- ],
- "title": "Timeout Ms"
- },
- "user": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "User"
- },
- "working_directory": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Working Directory"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "command",
- "env",
- "type"
- ],
- "title": "LocalShellCallAction",
- "description": "Execute a shell command on the server."
- },
- "openai__types__responses__response_input_item_param__McpCall": {
- "properties": {
- "id": {
- "type": "string",
- "title": "Id"
- },
- "arguments": {
- "type": "string",
- "title": "Arguments"
- },
- "name": {
- "type": "string",
- "title": "Name"
- },
- "server_label": {
- "type": "string",
- "title": "Server Label"
- },
- "type": {
- "type": "string",
- "const": "mcp_call",
- "title": "Type"
- },
- "approval_request_id": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Approval Request Id"
- },
- "error": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Error"
- },
- "output": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Output"
- },
- "status": {
- "type": "string",
- "enum": [
- "in_progress",
- "completed",
- "incomplete",
- "calling",
- "failed"
- ],
- "title": "Status"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "id",
- "arguments",
- "name",
- "server_label",
- "type"
- ],
- "title": "McpCall",
- "description": "An invocation of a tool on an MCP server."
- },
- "openai__types__responses__response_input_item_param__McpListTools": {
- "properties": {
- "id": {
- "type": "string",
- "title": "Id"
- },
- "server_label": {
- "type": "string",
- "title": "Server Label"
- },
- "tools": {
- "items": {
- "$ref": "#/components/schemas/openai__types__responses__response_input_item_param__McpListToolsTool"
- },
- "type": "array",
- "title": "Tools"
- },
- "type": {
- "type": "string",
- "const": "mcp_list_tools",
- "title": "Type"
- },
- "error": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Error"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "id",
- "server_label",
- "tools",
- "type"
- ],
- "title": "McpListTools",
- "description": "A list of tools available on an MCP server."
- },
- "openai__types__responses__response_input_item_param__McpListToolsTool": {
- "properties": {
- "input_schema": {
- "title": "Input Schema"
- },
- "name": {
- "type": "string",
- "title": "Name"
- },
- "annotations": {
- "anyOf": [
- {},
- {
- "type": "null"
- }
- ],
- "title": "Annotations"
- },
- "description": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Description"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "input_schema",
- "name"
- ],
- "title": "McpListToolsTool",
- "description": "A tool available on an MCP server."
- },
- "openai__types__responses__response_input_item_param__Message": {
- "properties": {
- "content": {
- "items": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/ResponseInputTextParam"
- },
- {
- "$ref": "#/components/schemas/ResponseInputImageParam"
- },
- {
- "$ref": "#/components/schemas/ResponseInputFileParam"
- }
- ]
- },
- "type": "array",
- "title": "Content"
- },
- "role": {
- "type": "string",
- "enum": [
- "user",
- "system",
- "developer"
- ],
- "title": "Role"
- },
- "status": {
- "type": "string",
- "enum": [
- "in_progress",
- "completed",
- "incomplete"
- ],
- "title": "Status"
- },
- "type": {
- "type": "string",
- "const": "message",
- "title": "Type"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "content",
- "role"
- ],
- "title": "Message",
- "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."
- },
- "openai__types__responses__response_reasoning_item__Content": {
- "properties": {
- "text": {
- "type": "string",
- "title": "Text"
- },
- "type": {
- "type": "string",
- "const": "reasoning_text",
- "title": "Type"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "text",
- "type"
- ],
- "title": "Content",
- "description": "Reasoning text from the model."
- },
- "openai__types__responses__response_reasoning_item_param__Content": {
- "properties": {
- "text": {
- "type": "string",
- "title": "Text"
- },
- "type": {
- "type": "string",
- "const": "reasoning_text",
- "title": "Type"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "text",
- "type"
- ],
- "title": "Content",
- "description": "Reasoning text from the model."
- },
- "openai__types__responses__web_search_tool__UserLocation": {
- "properties": {
- "city": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "City"
- },
- "country": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Country"
- },
- "region": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Region"
- },
- "timezone": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Timezone"
- },
- "type": {
- "anyOf": [
- {
- "type": "string",
- "const": "approximate"
- },
- {
- "type": "null"
- }
- ],
- "title": "Type"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "title": "UserLocation",
- "description": "The approximate location of the user."
- },
- "openai__types__shared_params__function_definition__FunctionDefinition": {
- "properties": {
- "name": {
- "type": "string",
- "title": "Name"
- },
- "description": {
- "type": "string",
- "title": "Description"
- },
- "parameters": {
- "additionalProperties": true,
- "type": "object",
- "title": "Parameters"
- },
- "strict": {
- "anyOf": [
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ],
- "title": "Strict"
- }
- },
- "additionalProperties": true,
- "type": "object",
- "required": [
- "name"
- ],
- "title": "FunctionDefinition"
- }
- }
- }
- }
|