Questa pagina è stata tradotta automaticamente. Leggi l’originale in inglese.

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.

Versione

1.0.01.0.1

Provenienza

UfficialeFirmato da un’identità di firma che questo catalogo riconosce come editore ufficiale.
Digest del contenuto
sha256:773b2b12397c8955789224669697da50fda0b5a16df34b17427e635309d60949
Pubblicato
2026-11-10T10:10:06Z
Identità di firma
https://token.actions.githubusercontent.com/https://github.com/aggrega-ai/aggrega-hub/.github/workflows/catalog-publish-sign.yml@refs/heads/main

Firma

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

Riferimento a questa versione

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

Parametri dello sviluppatore

Valori che lo sviluppatore imposta nell’Aggregate.

Estende BaseComponents#/schemas/BaseToolParameter

NomeTipoPredefinitoObbligatorioDescrizione
top_kinteger5sì—
side_effectsstring (read_only)read_onlysì—

Dimensionamento dell’operatore

Dimensionamento dell’infrastruttura che l’operatore regola per ogni ambiente.

NomeTipoPredefinitoObbligatorioDescrizione
imagestring—noContainer image serving the lookup over HTTP.
portinteger (min 1024, max 65535)8080noPort 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—no—
min_replicasinteger (min 0)0noReplica floor. Zero is what lets the tool run no replicas between calls, which the realization reaches through its control plane.
max_replicasinteger (min 1)5noReplica ceiling the realization's autoscaler may reach.
control_plane_presentbooleanfalsenoOperator 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)—noRealization-specific overrides. Accepts any nested structure. Each Recipe documents which keys it reads.

Contratto di output

Valori che questo componente pubblica verso i consumatori attraverso la topologia uses.

NomeTipoPredefinitoObbligatorioDescrizione
hoststring—sì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.
portinteger—sì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.
endpointstring—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.
protocolstring—noURL scheme to reach `host` and `port` over, for a consumer composing its own address rather than reading `endpoint`.

Socket uses

I socket di dipendenza attraverso cui questo componente si connette. La destinazione di ogni connessione collegata attraverso un socket deve soddisfare il suo selettore di etichette, e ogni connessione può portare un aggancio negli slot che il socket dichiara. Uno slot obbligatorio deve essere riempito da ogni connessione che l’Aggregate o la Release collega attraverso il socket.

target_datastore

Selettore
datastore.aggrega.ai/engine in (vector, semantic-memory, search)
Iniezione
env, file

Questo socket non dichiara slot di aggancio, quindi una connessione attraverso di esso non porta alcun aggancio.

Slot di aggancio

Punti di associazione con nome in cui una Feature si aggancia a questo componente. Il selettore di uno slot limita quale Feature può riempirlo e la sua lista inject indica come può essere consegnato il materiale della Feature. Uno slot obbligatorio deve essere associato su ogni istanza, da un aggancio sull’istanza o a un ambito superiore, e uno slot sensibile è dichiarato per gestire materiale segreto. Una Feature può anche agganciarsi con un nome che nessuno slot dichiara.

Nessuno slot di aggancio dichiarato.

Elenco consentito di auto-iniezione

env, file

Relazioni

Archi tipizzati da e verso altre entità pubblicate. Un riferimento senza una destinazione pubblicata viene mostrato come arco interrotto anziché come link.

Usa

Usato da

Riferimento al concetto Component →

Il catalogo Aggrega — un indice aperto di componenti, funzionalità, ricette e dei plugin che li renderizzano.

Realizzato con il design system condiviso di Aggrega.

Privacy