Expand description
Curated, per-cloud model catalog for the AI gateway.
Single source of truth for which public model ids each cloud exposes, the
upstream id the gateway forwards, and the wire protocol of the model’s native
endpoint. Backs getAvailableModels() and the gateway’s /v1/models, and the
Azure controller deploys the Azure entries as named deployments at provision
time (see azure_deployments).
A model is includable only if its cloud serves it over a protocol the client SDK already speaks (OpenAI Chat Completions or Anthropic Messages), so the gateway forwards the request body untranslated.
Structs§
- Catalog
Model - One curated model: the public id an app requests, the cloud that serves it, the upstream id the gateway forwards (for Azure this is the deployment name), and the protocol of its native endpoint.
- Direct
Anthropic Model - One model served directly by Anthropic. This is separate from
CatalogModel: direct Anthropic is a provider connection, not a deployable cloud platform. - Direct
Databricks Model - One Databricks-hosted text model with an explicitly qualified upstream route.
- Direct
Open AiModel - One OpenAI model qualified through the Gateway’s direct-provider route.
- Responses
Target - Where a model sits on the bedrock-mantle Responses API.
Enums§
- Activation
- The one-time action, if any, a customer must take in the cloud provider before the gateway can invoke a model. Static per (provider, cloud), surfaced in docs and the example README. Distinct from the read-only availability observation reported by the resource heartbeat for a particular deployment.
- Client
Api - A public API accepted from an application client.
- Direct
Databricks Upstream - The one Databricks resource and protocol used for a direct model.
- Provider
Api - The provider API used for the upstream request. This is deliberately
separate from
ClientApi: an adapter may expose one client API over a different provider API, but only after that exact combination is qualified.
Constants§
- AI_
CATALOG_ REVISION - Changes whenever public model ids or their supported client APIs change. Heartbeat consumers use this to distinguish an old observation from a current catalog without duplicating the catalog in durable state.
Functions§
- azure_
deployments - The Azure predefined model deployments, as (deployment name, model name, version).
- direct_
anthropic_ models - direct_
databricks_ models - direct_
openai_ models - lookup
- The catalog model for a public id, or
Noneif it is not exposed. - models_
for - resolve
- The catalog model for a client-sent model id, accepting the Anthropic-native spellings agent CLIs actually send alongside the catalog’s public ids.
- resolve_
direct_ anthropic - resolve_
direct_ databricks - resolve_
direct_ openai - resolve_
for - The catalog model for a client-sent model id on a specific cloud. A public id can appear once per cloud (Claude serves on more than one), so resolution must scope to the binding’s cloud rather than filter a first-match lookup — the first match is another cloud’s entry whenever ids overlap.
- responses_
target - The bedrock-mantle Responses target for a public model id, or
Nonewhen the model is not servable over the Responses API.