Component
core/ai-tool/retrieval
A read-only tool that fetches reference material by similarity, so an agent can ground an answer in the documents its store holds rather than only in what the model already holds. It declares a required socket onto a datastore whose engine serves similarity search — vector, semantic-memory or search — so the store is resolved in the topology rather than configured in a prompt. The developer sets how many matches a lookup returns, defaulting to five. Its effect is pinned read-only in its own schema. Realized on Kubernetes as a Knative Service, which admits an inbound call while the tool is running no replicas, so the tool occupies no compute between the calls that invoke it, and on Docker Compose as one service that runs while the stack runs. It publishes a host, port, endpoint and protocol, and a consumer wires to those without naming how the tool runs. The catalog pins no image, so nothing renders until the Release sets `infra.image`. The store's address reaches the tool's code under default variable names; an `inject:` block on the connection delivers instead, as variables or files, the names that code reads. The component's own `inject:` block takes `env` and `file` entries too, and one reading a value of the tool alone replaces that value's default variable name.
Version
Provenance
- Content digest
- sha256:7ef1482e831edd8428703ffdd39a1bae5092b0c8912737f5df94e41daf851d5b
- Published
- 2026-11-15T08:08:58Z
- 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:b7ee3c99e90b0cef9ef78aa4bea3b0ee531f25de58326e923fa55e69d71972e2
Reference at this version
oci://hub.aggrega.ai/component/core/ai-tool/retrieval:1.0.1Developer parameters
Values the developer sets in the Aggregate.
Extends BaseComponents#/schemas/BaseToolParameter
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
| top_k | integer | 5 | yes | — |
| side_effects | string (read_only) | read_only | yes | — |
Operator sizing
Infrastructure sizing the operator tunes per environment.
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
| image | string | — | no | Container image serving the lookup over HTTP. |
| port | integer (min 1024, max 65535) | 8080 | no | Port the tool's own container listens on. A consumer does not necessarily connect here: the realization publishes the address callers use. On Kubernetes the control plane fronting the tool routes from its own port to this one; on Docker Compose callers reach this port directly. |
| compute | object | — | no | — |
| min_replicas | integer (min 0) | 0 | no | Replica floor. On Kubernetes, zero is what lets the tool run no replicas between calls, which the realization reaches through its control plane. Docker Compose runs one container throughout and refuses a floor above one. |
| max_replicas | integer (min 1) | 5 | no | Replica ceiling the Kubernetes realization's autoscaler may reach. On Docker Compose the one container never passes it. |
| control_plane_present | boolean | false | no | Operator affirmation that Knative Serving, the control plane the Kubernetes realization needs, is installed in the target cluster. That realization halts the build unless this is set true, so a custom resource is never emitted as an orphan into a cluster that cannot reconcile it. Docker Compose involves no control plane and does not read it. |
| overrides | object (open) | — | no | Realization-specific overrides. Accepts any nested structure. Each Recipe documents which keys it reads. |
Output contract
Values this component publishes to consumers over the uses topology.
| Name | Type | Default | Required | Description |
|---|---|---|---|---|
| host | string | — | yes | Name an agent calls to fetch reference material by similarity: the tool's in-cluster DNS name on Kubernetes, its service name on the Compose network on Docker Compose. A consumer that composes its own address dials this name; one that does not reads `endpoint` instead. |
| port | integer | — | yes | TCP port the lookup is accepted on. On Kubernetes the realization fronts the tool on the control plane's own port rather than the tool container's, so a consumer reads this rather than the port an operator set; on Docker Compose it is infra.port. |
| endpoint | string | — | yes | Full base URL an agent posts a lookup to, with the host and the port already composed. It addresses the tool, not the datastore behind it, which the tool reaches over its own socket. |
| protocol | string | — | no | URL scheme to reach `host` and `port` over, for a consumer composing its own address rather than reading `endpoint`. |
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.
target_datastore
- Selector
- datastore.aggrega.ai/engine in (vector, semantic-memory, search)
- Inject
- env, file
This socket declares no attachment slots, so a connection through it carries no attachment.
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.
No attachment slots declared.
Self-inject allowlist
env, file
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
- usesuses socket «target_datastore»
datastore.aggrega.ai/engine in (vector, semantic-memory, search)
Declares no attachment slots.
- $refextends schema (values)
BaseComponents#/schemas/BaseToolParameter
Used by
applies to
implements
implements