Cette page a été traduite automatiquement. Lire l’original en anglais.

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.

Version

1.0.01.0.1

Provenance

OfficielSigné par une identité de signature que ce catalogue reconnaît comme éditeur officiel.
Empreinte du contenu
sha256:773b2b12397c8955789224669697da50fda0b5a16df34b17427e635309d60949
Publié
2026-11-10T10:10:06Z
Identité de signature
https://token.actions.githubusercontent.com/https://github.com/aggrega-ai/aggrega-hub/.github/workflows/catalog-publish-sign.yml@refs/heads/main

Signature

  • Officielapplication/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

Référence à cette version

oci://hub.aggrega.ai/component/core/ai-tool/retrieval:1.0.0

Paramètres du développeur

Valeurs que le développeur définit dans l’Aggregate.

Étend BaseComponents#/schemas/BaseToolParameter

NomTypeValeur par défautObligatoireDescription
top_kinteger5oui—
side_effectsstring (read_only)read_onlyoui—

Dimensionnement de l’opérateur

Dimensionnement de l’infrastructure que l’opérateur ajuste pour chaque environnement.

NomTypeValeur par défautObligatoireDescription
imagestring—nonContainer image serving the lookup over HTTP.
portinteger (min 1024, max 65535)8080nonPort 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.
computeobject—non—
min_replicasinteger (min 0)0nonReplica floor. Zero is what lets the tool run no replicas between calls, which the realization reaches through its control plane.
max_replicasinteger (min 1)5nonReplica ceiling the realization's autoscaler may reach.
control_plane_presentbooleanfalsenonOperator 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.
overridesobject (open)—nonRealization-specific overrides. Accepts any nested structure. Each Recipe documents which keys it reads.

Contrat de sortie

Valeurs que ce composant publie vers les consommateurs via la topologie uses.

NomTypeValeur par défautObligatoireDescription
hoststring—ouiIn-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.
portinteger—ouiTCP 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.
endpointstring—ouiFull 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.
protocolstring—nonURL scheme to reach `host` and `port` over, for a consumer composing its own address rather than reading `endpoint`.

Sockets uses

Les sockets de dépendance par lesquels ce composant se connecte. La cible de chaque connexion câblée via un socket doit satisfaire son sélecteur d’étiquettes, et chaque connexion peut porter une attache dans les emplacements que le socket déclare. Un emplacement obligatoire doit être rempli par chaque connexion que l’Aggregate ou la Release câble via le socket.

target_datastore

Sélecteur
datastore.aggrega.ai/engine in (vector, semantic-memory, search)
Injection
env, file

Ce socket ne déclare aucun emplacement d’attache, donc une connexion qui le traverse ne porte aucune attache.

Emplacements d’attache

Points de liaison nommés auxquels une Feature s’attache à ce composant. Le sélecteur d’un emplacement restreint la Feature qui peut le remplir, et sa liste inject indique comment le matériel de la Feature peut être livré. Un emplacement obligatoire doit être lié sur chaque instance, par une attache sur l’instance ou à une portée supérieure, et un emplacement sensible est déclaré pour traiter du matériel secret. Une Feature peut aussi s’attacher sous un nom qu’aucun emplacement ne déclare.

Aucun emplacement d’attache déclaré.

Liste d’autorisation d’auto-injection

env, file

Relations

Arêtes typées vers et depuis d’autres entités publiées. Une référence sans cible publiée s’affiche comme une arête rompue plutôt que comme un lien.

Utilise

Utilisé par

Référence du concept Component →

Le catalogue Aggrega — un index ouvert de composants, de fonctionnalités, de recettes et des plugins qui en assurent le rendu.

Conçu avec le système de design partagé d’Aggrega.

Confidentialité