VocalDocscontracts 1.65.0

ProviderListItem

A Provider descriptor with the Provider registry applied (1.10.0): an Agent may name the catalog models and, from 1.12.0, the inventory models, less disabled_models, plus added_models, while enabled is true.

An object with 25 fields.

Fields

FieldTypeRequiredDescription
added_modelsarray of AddedModelnoModels an Agent may name besides the catalog models. Added in 1.10.0: the api always sends it, and a reader treats its absence as none.
baa_availableBaaAvailabilityyes
credentialCredentialSummary or nullnoThe active platform credential of the Provider, masked, or null when none is entered and the worker uses its environment key; from 1.28.0 the newest active member of the Provider's key pool. Sent to operator readers only; absent for every other reader.
credential_modesarray of CredentialModeyesEmpty for Providers that need no credential. From 1.28.0 a Provider that lists byok accepts an Organization's own key (/v1/provider-credentials), and every descriptor of one Provider agrees on it.
data_regionsarray of stringyesOne entry per region a request may be processed in; unknown when not verified; empty for in-process Providers, which send nothing off the worker.
decisionDecisionDescriptornodecision (1.58.0): the question types and bounds the Provider answers. Omitted for every other stage.
deploymentProviderDeploymentyes
descriptor_versionintegeryesBumped on any change to this descriptor.
disabled_modelsarray of stringnoCatalog models, and from 1.12.0 inventory models, of this Provider and stage that no Agent may name. Added in 1.10.0: the api always sends it, and a reader treats its absence as none.
embedding_modelsarray of EmbeddingModelDescriptornoembeddings (1.53.0): one entry per id of models, with the space it produces. Omitted for every other stage.
enabledbooleannoFalse disables the Provider on this stage: publish refuses an Agent that names it, and admission drops it from every chain. Added in 1.10.0: the api always sends it, and a reader treats its absence as true.
implementationProviderImplementationyes
inventoryProviderInventorySummary or nullnoThe Provider inventory counts of this descriptor, or null when the inventory holds no item of the Provider and stage. Added in 1.12.0: the api always sends it, and a reader treats its absence as null.
languagesarray of LanguageTagyesLanguages declared for this stage; empty when the stage does not depend on language.
lifecycleProviderLifecycleyes
livekit_pluginLiveKitPlugin or nullyes
model_familyModelFamilynollm (1.56.0): the family of the descriptor's models, which selects a Prompt template's variant; the variant default serves a descriptor without one. Omitted for every other stage and for a mock.
modelsarray of stringyesThe model ids an Agent may name for this stage; empty for stages an Agent does not configure and for reserved descriptors.
pricing_unitPricingUnityes
providerProviderIdyes
sourceDescriptorSourceyes
stageProviderStageyes
streamingbooleannostt: recognizes a live audio stream; llm: streams tokens; tts: accepts streamed text. Omitted when not verified.
tool_callingbooleannollm: supports tool calls. Omitted when not verified.
word_timestampsbooleannostt and tts: returns word timings. Omitted when not verified.