Scale Intelligence■ Docs
Docs / The model / Model

Model.

A model: the task it decides, its kind, its address, its calibration, its state

Figure 1Modelspecified
MODELrow at platform scopenametextversiontextin one sentencetasktextkindenum:classifier|embe…for an embedderwidthcountoptionalwith no defaultaddressaddresswho serves it; the settings name the provider's key by its environment nameprovidertextwhether text sent to it leaves the platformleaves_the_platformboolthe list price the provider statesprice_per_million_prom…moneyoptionalthe list price the provider states; none for an embedderprice_per_million_comp…moneyoptionaltokenslongest_inputcountoptionalthe prefix the model expects before a query, if anyprefixtextoptionalCONTROLRESULTthrough controlsMODELSTATISTICSthrough statisticsCOSTthrough cost_per_callREADINESSthrough stateand 7 more fields on this page
Model is a row at platform scope. The drawing shows its fields and the objects that they point at.
kind
row
scope
platform
key
its name and version
store
postgres
family
models

Fields#

fieldtyperequirednote
nametextyes
versiontextyes
tasktextyesin one sentence
kindone of classifier | embedder | estimator | generator | normaliser | chunker | language head | quality head | near-duplicate method | pooling recipe | probeyes
widthcountnofor an embedder
addressaddressyeswith no default
providertextyeswho serves it; the settings name the provider’s key by its environment name
leaves_the_platformboolyeswhether text sent to it leaves the platform
price_per_million_prompt_tokensmoneynothe list price the provider states
price_per_million_completion_tokensmoneynothe list price the provider states; none for an embedder
longest_inputcountnotokens
prefixtextnothe prefix the model expects before a query, if any
licencetextno
known_examples[id]yes
controlsControlResultyes
statisticsModelStatisticsno
cost_per_callCostno
stateReadinessyes
lifeone of candidate | under test | in shadow | frozen | serving | retiredyes

Routes that use it#

No route takes or returns Model directly. The record holds it, and the objects that point at it reach it.