Component
core/ai-tool/retrieval
A read-only tool that fetches reference material by similarity, so an agent can ground an answer in a deployment's own documents 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. 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.
Wersja
Pochodzenie
- Skrót zawartości
- sha256:773b2b12397c8955789224669697da50fda0b5a16df34b17427e635309d60949
- Opublikowano
- 2026-11-10T10:10:06Z
- Tożsamość podpisująca
- https://token.actions.githubusercontent.com/https://github.com/aggrega-ai/aggrega-hub/.github/workflows/catalog-publish-sign.yml@refs/heads/main
Podpis
- Oficjalnyapplication/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:d1371a131371e967dcf30c0977070c94a008b7fcc9df38ed04eac3abde1a9aef
Referencja w tej wersji
oci://hub.aggrega.ai/component/core/ai-tool/retrieval:1.0.0Parametry dewelopera
Wartości ustawiane przez dewelopera w encji Aggregate.
Rozszerza BaseComponents#/schemas/BaseToolParameter
| Nazwa | Typ | Wartość domyślna | Wymagane | Opis |
|---|---|---|---|---|
| top_k | integer | 5 | tak | — |
| side_effects | string (read_only) | read_only | tak | — |
Wymiarowanie przez operatora
Wymiarowanie infrastruktury, które operator dostraja dla każdego środowiska.
| Nazwa | Typ | Wartość domyślna | Wymagane | Opis |
|---|---|---|---|---|
| image | string | — | nie | Container image serving the lookup over HTTP. |
| port | integer (min 1024, max 65535) | 8080 | nie | Port the tool's own container listens on. A consumer does not necessarily connect here: the realization publishes the address callers use, and a control plane that fronts the tool routes from its own port to this one. |
| compute | object | — | nie | — |
| min_replicas | integer (min 0) | 0 | nie | Replica floor. Zero is what lets the tool run no replicas between calls, which the realization reaches through its control plane. |
| max_replicas | integer (min 1) | 5 | nie | Replica ceiling the realization's autoscaler may reach. |
| control_plane_present | boolean | false | nie | Operator affirmation that Knative Serving, the control plane the realization needs, is installed in the target cluster. The build halts unless this is set true, so a custom resource is never emitted as an orphan into a cluster that cannot reconcile it. |
| overrides | object (open) | — | nie | Realization-specific overrides. Accepts any nested structure. Each Recipe documents which keys it reads. |
Kontrakt wyjściowy
Wartości, które ten komponent publikuje konsumentom za pośrednictwem topologii uses.
| Nazwa | Typ | Wartość domyślna | Wymagane | Opis |
|---|---|---|---|---|
| host | string | — | tak | In-cluster DNS name an agent calls to fetch reference material by similarity. A consumer that composes its own address dials this name; one that does not reads `endpoint` instead. |
| port | integer | — | tak | TCP port the lookup is accepted on. 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. |
| endpoint | string | — | tak | 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 | — | nie | URL scheme to reach `host` and `port` over, for a consumer composing its own address rather than reading `endpoint`. |
Gniazda uses
Gniazda zależności, przez które łączy się ten komponent. Cel każdego połączenia poprowadzonego przez gniazdo musi spełniać jego selektor etykiet, a każde połączenie może przenosić dołączenie w slotach deklarowanych przez gniazdo. Wymagany slot musi wypełnić każde połączenie, które encja Aggregate lub encja Release prowadzi przez gniazdo.
target_datastore
- Selektor
- datastore.aggrega.ai/engine in (vector, semantic-memory, search)
- Wstrzykiwanie
- env, file
To gniazdo nie deklaruje slotów dołączania, więc połączenie przez nie nie przenosi żadnego dołączenia.
Sloty dołączania
Nazwane punkty wiązania, w których encja Feature dołącza się do tego komponentu. Selektor slotu ogranicza, która encja Feature może go wypełnić, a jego lista inject określa, jak można dostarczyć materiał encji Feature. Wymagany slot musi być powiązany w każdej instancji, przez dołączenie w instancji lub w zakresie nad nią, a slot wrażliwy jest zadeklarowany do obsługi materiału tajnego. Encja Feature może również dołączyć się pod nazwą, której nie deklaruje żaden slot.
Nie zadeklarowano slotów dołączania.
Lista dozwolonych samowstrzyknięć
env, file
Relacje
Typowane krawędzie do innych opublikowanych encji i od nich. Odwołanie bez opublikowanego celu jest renderowane jako przerwana krawędź, a nie jako łącze.
Używa
- używaużywa gniazda «target_datastore»
datastore.aggrega.ai/engine in (vector, semantic-memory, search)
Nie deklaruje slotów dołączania.
- $refrozszerza schemat (values)
BaseComponents#/schemas/BaseToolParameter
Używane przez
dotyczy
implementuje