Component
core/ai-model/tei
Text Embeddings Inference running in-cluster as a self-hosted embedding server. A Recipe synthesizes the runtime directly: a weights-pull initContainer resolves the model pointer into a model-cache volume the serving container mounts, and a ClusterIP Service fronts the embeddings API. The model value is a deterministic pointer resolved at pod start, never fetched at compile time. Exports its host, port, endpoint, model, and protocol to consumers via the uses topology, so a consumer reaches the embedding endpoint without hardcoding it. Each Recipe publishes where Prometheus finds the server's metrics: one address as `metrics_endpoint`, or, while the Kubernetes realization runs more than one replica, the Service a scraper discovers every replica behind. At the default image tag the api_key slot's key guards them too, so while that slot is filled a scrape presents the key on its connection's `credential` slot. On a cluster running the Prometheus Operator, `core/prometheus-exporter` attached with its port set to `http` emits a ServiceMonitor for it instead.
Provenance
- Content digest
- sha256:0a2d529db9c20880518a3c4d05356e20c8581f3dfa0ca55f2f0f862abf5d80c0
- Published
- 2026-11-10T10:09:37Z
- Signing identity
- https://token.actions.githubusercontent.com/https://github.com/aggrega-ai/aggrega-hub/.github/workflows/catalog-publish-sign.yml@refs/heads/main
Signature
- Officialapplication/vnd.dev.sigstore.bundle.v0.3+json
https://token.actions.githubusercontent.com/https://github.com/aggrega-ai/aggrega-hub/.github/workflows/catalog-publish-sign.yml@refs/heads/main
sha256:d2fc51ad3907b81eaa6ef62c1a1d1b238943683a978f1c72ac9b72ca954d6cb9
Reference at this version
oci://hub.aggrega.ai/component/core/ai-model/tei:1.0.0Developer parameters
Values the developer sets in the Aggregate.
Extends BaseComponents#/schemas/BaseModelParameter
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
| pooling | string (cls | mean) | cls | no | — |
Operator sizing
Infrastructure sizing the operator tunes per environment.
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
| port | integer (min 1024, max 65535) | 8080 | no | Server listen port for the embeddings API. Most operators should omit this and let the Recipe assign the default (8080). |
| engine_version | string | cpu-1.5 | no | Text Embeddings Inference runtime image tag. Selects the image tag on the synthesized serving container only. This runtime's serving image ships no download tool, so the weights-pull container runs a separate image that the Recipe pins and this knob does not move. |
| replicas | integer (min 1) | 1 | no | Number of serving replicas. Each replica holds its own model-cache volume and pulls the weights independently. |
| min_replicas | integer (min 1) | — | no | Lower bound for the replica count when horizontal autoscaling is configured. Declared ahead of rendering — the synth recipes serve a fixed replica count and do not yet emit an autoscaler; set it to record the intended lower bound. |
| max_replicas | integer (min 1) | — | no | Upper bound for the replica count when horizontal autoscaling is configured. Declared ahead of rendering — the synth recipes serve a fixed replica count and do not yet emit an autoscaler; set it to record the intended upper bound. |
| compute | object | — | no | — |
| model_cache | object | — | no | Per-replica model-weights cache volume. Sized for the pulled model; each serving replica gets its own claim. |
| model_artifact | string | — | no | Optional OCI reference to the model weights, an alternative weights source to the Hugging Face model id in values.model. A deterministic pointer the runtime resolves at pod start; the compiler never fetches it. Declared ahead of rendering — the synth recipes resolve weights from values.model and do not yet consume this pointer. |
| overrides | object (open) | — | no | Provider-specific overrides. Accepts any nested structure. Each Recipe documents which keys it reads. |
| gpu | object | — | no | Optional GPU scheduling for the serving container. When set, the Recipe requests GPUs as the extended resource nvidia.com/gpu and, when a runtime class is named, schedules the pod under it. Requires a GPU-capable cluster and, for runtime_class, a matching RuntimeClass configured in the cluster. Omit the whole object to serve on CPU. |
Output contract
Values this component publishes to consumers over the uses topology.
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
| host | string | — | yes | In-cluster DNS name of the Service fronting the embedding server. A consumer that composes its own address dials this name; one that does not reads `endpoint` instead. |
| port | integer | — | yes | TCP port that Service accepts embedding requests on. It follows the port an operator set in the Release, so a consumer reads it rather than assuming a default. |
| endpoint | string | — | yes | Full base URL of the embeddings API, with the host, the port and the API path already composed. A consumer hands it to a client library as its base URL. |
| model | string | — | yes | Name a request must ask this server for, which is the model whose weights it loaded rather than a provider catalogue name. |
| protocol | string | — | no | URL scheme to reach `host` and `port` over, for a consumer composing its own address rather than reading `endpoint`. |
| metrics_endpoint | string | — | no | The full address Prometheus scrapes this component's metrics at — scheme, host, port and path, `http://<host>:<port>/metrics`, on the port the embeddings API is served on. At the default image tag the api_key slot's key guards it, so while that slot is filled a scrape presents the key on its connection's `credential` slot. Empty while the Kubernetes realization runs more than one replica, which then publishes `metrics_service` instead. |
| metrics_service | string | — | no | Name of the Service every replica's metrics sit behind, for a scraper that discovers each endpoint of that Service rather than scraping one address. Set by the Kubernetes realization while infra.replicas is above one, beside `metrics_service_port` and `metrics_path`; empty otherwise. |
| metrics_service_port | string | — | no | Name of the port of `metrics_service` that carries the metrics, `http`. Set and empty together with `metrics_service`. |
| metrics_path | string | — | no | Path the metrics are served at, `/metrics`, published beside `metrics_service`. Empty where the server publishes `metrics_endpoint`, which carries its own path. |
Uses sockets
The dependency sockets this component connects through. The target of every connection wired through a socket must satisfy its label selector, and each connection may carry an attachment in the slots the socket declares. A required slot is owed by each connection the Aggregate or the Release wires through the socket.
No uses sockets declared.
Attachment slots
Named binding points at which a Feature attaches to this component. A slot's selector constrains which Feature may fill it and its inject list names how the Feature's material may be delivered. A required slot must be bound on every instance, by an attachment on the instance or at a scope above it, and a sensitive slot is declared to handle secret material. A Feature may also attach under a name no slot declares.
| Slot | Selector | Required | Inject | Sensitive | Description |
|---|---|---|---|---|---|
| model_pull_token | feature.aggrega.ai/kind=secret | no | env | yes | Optional model-registry pull credential for gated model weights. When attached, the weights-pull initContainer receives it as an environment variable; unattached, weights are pulled anonymously. |
| api_key | feature.aggrega.ai/kind=secret | no | env | yes | Optional key the server requires of every caller. When attached, the Recipe delivers it as API_KEY, the variable Text Embeddings Inference reads at startup, and each request must then carry it as a bearer token in the Authorization header. The server checks this one key, so every caller must present the same key. Unattached, the server requires none. |
Self-inject allowlist
env
Relationships
Typed edges to and from other published entities. A reference with no published target renders as a broken edge rather than a link.
Uses
- $refextends schema (values)
BaseComponents#/schemas/BaseModelParameter
Used by
uses socket «model»
uses socket «model»
uses socket «model»
uses socket «model»
uses socket «model»
uses socket «model»
uses socket «model»
uses socket «model»
uses socket «model»
uses socket «model»
uses socket «model»
uses socket «model»
uses socket «model»
uses socket «model»
uses socket «model»
uses socket «model»
uses socket «model»
uses socket «model»
uses socket «model»
uses socket «model»
uses socket «model»
uses socket «model»
uses socket «model»
uses socket «model»
uses socket «model»
uses socket «model»
uses socket «model»
uses socket «model»
uses socket «model»
uses socket «model»
uses socket «model»
uses socket «model»
uses socket «model»
uses socket «target_model»
uses socket «extraction_model»
uses socket «embedding_model»
uses socket «models»
uses socket «models»
uses socket «models»
uses socket «models»
uses socket «models»
uses socket «models»
uses socket «models»
uses socket «upstream»
uses socket «models»
uses socket «forward_target»
uses socket «scrape_target»
uses socket «store»
uses socket «content_safety»
applies to
applies to
applies to
applies to
applies to
applies to
applies to
implements
implements