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
Asal-usul
- Digest konten
- sha256:7ef1482e831edd8428703ffdd39a1bae5092b0c8912737f5df94e41daf851d5b
- Dipublikasikan
- 2026-11-15T08:08:58Z
- Identitas penandatangan
- https://token.actions.githubusercontent.com/https://github.com/aggrega-ai/aggrega-hub/.github/workflows/catalog-publish-sign.yml@refs/heads/main
Tanda tangan
- Resmiapplication/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
Referensi pada versi ini
oci://hub.aggrega.ai/component/core/ai-tool/retrieval:1.0.1Parameter pengembang
Nilai yang ditetapkan pengembang di Aggregate.
Memperluas BaseComponents#/schemas/BaseToolParameter
| Nama | Tipe | Bawaan | Wajib | Deskripsi |
|---|---|---|---|---|
| top_k | integer | 5 | ya | — |
| side_effects | string (read_only) | read_only | ya | — |
Penentuan ukuran oleh operator
Ukuran infrastruktur yang disesuaikan operator untuk setiap lingkungan.
| Nama | Tipe | Bawaan | Wajib | Deskripsi |
|---|---|---|---|---|
| image | string | — | tidak | Container image serving the lookup over HTTP. |
| port | integer (min 1024, max 65535) | 8080 | tidak | 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 | — | tidak | — |
| min_replicas | integer (min 0) | 0 | tidak | 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 | tidak | Replica ceiling the Kubernetes realization's autoscaler may reach. On Docker Compose the one container never passes it. |
| control_plane_present | boolean | false | tidak | 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) | — | tidak | Realization-specific overrides. Accepts any nested structure. Each Recipe documents which keys it reads. |
Kontrak keluaran
Nilai yang dipublikasikan komponen ini kepada konsumen melalui topologi uses.
| Nama | Tipe | Bawaan | Wajib | Deskripsi |
|---|---|---|---|---|
| host | string | — | ya | 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 | — | ya | 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 | — | ya | 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 | — | tidak | URL scheme to reach `host` and `port` over, for a consumer composing its own address rather than reading `endpoint`. |
Soket uses
Soket dependensi yang menjadi jalur koneksi komponen ini. Target setiap koneksi yang dihubungkan melalui sebuah soket harus memenuhi selektor labelnya, dan setiap koneksi dapat membawa lampiran pada slot yang dideklarasikan soket tersebut. Slot wajib harus diisi oleh setiap koneksi yang dihubungkan oleh Aggregate atau Release melalui soket tersebut.
target_datastore
- Selektor
- datastore.aggrega.ai/engine in (vector, semantic-memory, search)
- Injeksi
- env, file
Soket ini tidak mendeklarasikan slot lampiran, sehingga koneksi melaluinya tidak membawa lampiran.
Slot lampiran
Titik pengikatan bernama tempat sebuah Feature dilampirkan ke komponen ini. Selektor sebuah slot membatasi Feature mana yang dapat mengisinya, dan daftar injeksinya menyebutkan cara materi Feature dapat dikirimkan. Slot wajib harus terikat pada setiap instans, melalui lampiran pada instans tersebut atau pada cakupan di atasnya, dan slot sensitif dideklarasikan untuk menangani materi rahasia. Sebuah Feature juga dapat dilampirkan dengan nama yang tidak dideklarasikan oleh slot mana pun.
Tidak ada slot lampiran yang dideklarasikan.
Daftar izin injeksi mandiri
env, file
Relasi
Sisi bertipe ke dan dari entitas lain yang dipublikasikan. Referensi tanpa target yang dipublikasikan ditampilkan sebagai sisi yang terputus, bukan sebagai tautan.
Menggunakan
- menggunakanmenggunakan soket «target_datastore»
datastore.aggrega.ai/engine in (vector, semantic-memory, search)
Tidak mendeklarasikan slot lampiran.
- $refmemperluas skema (values)
BaseComponents#/schemas/BaseToolParameter
Digunakan oleh
berlaku untuk
mengimplementasikan
mengimplementasikan