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.
Versión
Procedencia
- Digest del contenido
- sha256:7ef1482e831edd8428703ffdd39a1bae5092b0c8912737f5df94e41daf851d5b
- Publicado
- 2026-11-15T08:08:58Z
- Identidad de firma
- https://token.actions.githubusercontent.com/https://github.com/aggrega-ai/aggrega-hub/.github/workflows/catalog-publish-sign.yml@refs/heads/main
Firma
- Oficialapplication/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
Referencia en esta versión
oci://hub.aggrega.ai/component/core/ai-tool/retrieval:1.0.1Parámetros del desarrollador
Valores que el desarrollador establece en el Aggregate.
Extiende BaseComponents#/schemas/BaseToolParameter
| Nombre | Tipo | Predeterminado | Obligatorio | Descripción |
|---|---|---|---|---|
| top_k | integer | 5 | sí | — |
| side_effects | string (read_only) | read_only | sí | — |
Dimensionamiento del operador
Dimensionamiento de la infraestructura que el operador ajusta para cada entorno.
| Nombre | Tipo | Predeterminado | Obligatorio | Descripción |
|---|---|---|---|---|
| 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. |
Contrato de salida
Valores que este componente publica para los consumidores a través de la topología uses.
| Nombre | Tipo | Predeterminado | Obligatorio | Descripción |
|---|---|---|---|---|
| host | string | — | sí | 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 | — | sí | 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 | — | sí | 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`. |
Sockets uses
Los sockets de dependencia a través de los cuales se conecta este componente. El destino de cada conexión cableada a través de un socket debe satisfacer su selector de etiquetas, y cada conexión puede llevar un acoplamiento en los slots que declara el socket. Cada conexión que el Aggregate o la Release cablea a través del socket debe llenar los slots obligatorios.
target_datastore
- Selector
- datastore.aggrega.ai/engine in (vector, semantic-memory, search)
- Inyección
- env, file
Este socket no declara slots de acoplamiento, por lo que una conexión a través de él no lleva ningún acoplamiento.
Slots de acoplamiento
Puntos de enlace con nombre en los que una Feature se acopla a este componente. El selector de un slot restringe qué Feature puede llenarlo y su lista inject indica cómo puede entregarse el material de la Feature. Un slot obligatorio debe estar enlazado en cada instancia, mediante un acoplamiento en la instancia o en un ámbito superior, y un slot sensible se declara para manejar material secreto. Una Feature también puede acoplarse con un nombre que ningún slot declara.
No se declararon slots de acoplamiento.
Lista de permitidos de autoinyección
env, file
Relaciones
Aristas tipadas hacia y desde otras entidades publicadas. Una referencia sin un destino publicado se muestra como una arista rota en lugar de como un enlace.
Usa
- usausa el socket «target_datastore»
datastore.aggrega.ai/engine in (vector, semantic-memory, search)
No declara slots de acoplamiento.
- $refextiende el esquema (values)
BaseComponents#/schemas/BaseToolParameter
Usado por
se aplica a
implementa
implementa