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
Herkunft
- Inhalts-Digest
- sha256:7ef1482e831edd8428703ffdd39a1bae5092b0c8912737f5df94e41daf851d5b
- Veröffentlicht
- 2026-11-15T08:08:58Z
- Signaturidentität
- https://token.actions.githubusercontent.com/https://github.com/aggrega-ai/aggrega-hub/.github/workflows/catalog-publish-sign.yml@refs/heads/main
Signatur
- Offiziellapplication/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
Referenz zu dieser Version
oci://hub.aggrega.ai/component/core/ai-tool/retrieval:1.0.1Entwicklerparameter
Werte, die der Entwickler im Aggregate festlegt.
Erweitert BaseComponents#/schemas/BaseToolParameter
| Name | Typ | Standardwert | Erforderlich | Beschreibung |
|---|---|---|---|---|
| top_k | integer | 5 | ja | — |
| side_effects | string (read_only) | read_only | ja | — |
Dimensionierung durch den Operator
Infrastrukturdimensionierung, die der Operator pro Umgebung anpasst.
| Name | Typ | Standardwert | Erforderlich | Beschreibung |
|---|---|---|---|---|
| image | string | — | nein | Container image serving the lookup over HTTP. |
| port | integer (min 1024, max 65535) | 8080 | nein | 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 | — | nein | — |
| min_replicas | integer (min 0) | 0 | nein | 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 | nein | Replica ceiling the Kubernetes realization's autoscaler may reach. On Docker Compose the one container never passes it. |
| control_plane_present | boolean | false | nein | 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) | — | nein | Realization-specific overrides. Accepts any nested structure. Each Recipe documents which keys it reads. |
Ausgabevertrag
Werte, die diese Komponente über die uses-Topologie an Konsumenten veröffentlicht.
| Name | Typ | Standardwert | Erforderlich | Beschreibung |
|---|---|---|---|---|
| host | string | — | ja | 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 | — | ja | 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 | — | ja | 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 | — | nein | URL scheme to reach `host` and `port` over, for a consumer composing its own address rather than reading `endpoint`. |
uses-Sockets
Die Abhängigkeits-Sockets, über die sich diese Komponente verbindet. Das Ziel jeder über einen Socket verdrahteten Verbindung muss dessen Label-Selektor erfüllen, und jede Verbindung kann in den Slots, die der Socket deklariert, eine Anbindung tragen. Einen erforderlichen Slot muss jede Verbindung füllen, die das Aggregate oder das Release über den Socket verdrahtet.
target_datastore
- Selektor
- datastore.aggrega.ai/engine in (vector, semantic-memory, search)
- Injektion
- env, file
Dieser Socket deklariert keine Anbindungs-Slots, daher trägt eine Verbindung über ihn keine Anbindung.
Anbindungs-Slots
Benannte Bindungspunkte, an denen ein Feature an diese Komponente angebunden wird. Der Selektor eines Slots schränkt ein, welches Feature ihn füllen darf, und seine inject-Liste benennt, wie das Feature sein Material liefern darf. Ein erforderlicher Slot muss auf jeder Instanz gebunden sein, durch eine Anbindung an der Instanz oder in einem darüberliegenden Geltungsbereich, und ein sensibler Slot ist für den Umgang mit geheimem Material deklariert. Ein Feature kann auch unter einem Namen angebunden werden, den kein Slot deklariert.
Keine Anbindungs-Slots deklariert.
Zulassungsliste für Selbstinjektion
env, file
Beziehungen
Typisierte Kanten zu und von anderen veröffentlichten Entitäten. Eine Referenz ohne veröffentlichtes Ziel wird als unterbrochene Kante statt als Link dargestellt.
Verwendet
- verwendetverwendet Socket «target_datastore»
datastore.aggrega.ai/engine in (vector, semantic-memory, search)
Deklariert keine Anbindungs-Slots.
- $referweitert Schema (values)
BaseComponents#/schemas/BaseToolParameter
Verwendet von
gilt für
implementiert
implementiert