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.
Sürüm
Köken
- İçerik özeti
- sha256:773b2b12397c8955789224669697da50fda0b5a16df34b17427e635309d60949
- Yayımlanma
- 2026-11-10T10:10:06Z
- İmzalama kimliği
- https://token.actions.githubusercontent.com/https://github.com/aggrega-ai/aggrega-hub/.github/workflows/catalog-publish-sign.yml@refs/heads/main
İmza
- 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:d1371a131371e967dcf30c0977070c94a008b7fcc9df38ed04eac3abde1a9aef
Bu sürümdeki referans
oci://hub.aggrega.ai/component/core/ai-tool/retrieval:1.0.0Geliştirici parametreleri
Geliştiricinin Aggregate'te ayarladığı değerler.
BaseComponents#/schemas/BaseToolParameter öğesini genişletir
| Ad | Tip | Varsayılan | Zorunlu | Açıklama |
|---|---|---|---|---|
| top_k | integer | 5 | evet | — |
| side_effects | string (read_only) | read_only | evet | — |
Operatör boyutlandırması
Operatörün her ortam için ayarladığı altyapı boyutlandırması.
| Ad | Tip | Varsayılan | Zorunlu | Açıklama |
|---|---|---|---|---|
| image | string | — | hayır | Container image serving the lookup over HTTP. |
| port | integer (min 1024, max 65535) | 8080 | hayır | 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 | — | hayır | — |
| min_replicas | integer (min 0) | 0 | hayır | 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 | hayır | Replica ceiling the realization's autoscaler may reach. |
| control_plane_present | boolean | false | hayır | 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) | — | hayır | Realization-specific overrides. Accepts any nested structure. Each Recipe documents which keys it reads. |
Çıktı sözleşmesi
Bu bileşenin uses topolojisi üzerinden tüketicilere yayımladığı değerler.
| Ad | Tip | Varsayılan | Zorunlu | Açıklama |
|---|---|---|---|---|
| host | string | — | evet | 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 | — | evet | 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 | — | evet | 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 | — | hayır | URL scheme to reach `host` and `port` over, for a consumer composing its own address rather than reading `endpoint`. |
Uses soketleri
Bu bileşenin üzerinden bağlandığı bağımlılık soketleri. Bir soket üzerinden kurulan her bağlantının hedefi, soketin etiket seçicisini karşılamalıdır ve her bağlantı, soketin bildirdiği yuvalarda bir ek taşıyabilir. Aggregate'in veya Release'in soket üzerinden kurduğu her bağlantı, zorunlu bir yuvayı doldurmakla yükümlüdür.
target_datastore
- Seçici
- datastore.aggrega.ai/engine in (vector, semantic-memory, search)
- Enjeksiyon
- env, file
Bu soket hiçbir ekleme yuvası bildirmez, bu nedenle üzerinden geçen bir bağlantı hiçbir ek taşımaz.
Ekleme yuvaları
Bir Feature'ın bu bileşene eklendiği adlandırılmış bağlama noktaları. Bir yuvanın seçicisi, onu hangi Feature'ın doldurabileceğini sınırlar ve inject listesi, Feature'ın malzemesinin nasıl iletilebileceğini belirtir. Zorunlu bir yuva, her örnekte, örnek üzerindeki veya onun üstündeki bir kapsamdaki bir ek aracılığıyla bağlanmalıdır, hassas bir yuva ise gizli malzemeyi işlemek üzere bildirilmiştir. Bir Feature, hiçbir yuvanın bildirmediği bir ad altında da eklenebilir.
Ekleme yuvası bildirilmemiş.
Kendi kendine enjeksiyon izin listesi
env, file
İlişkiler
Diğer yayımlanmış varlıklara giden ve onlardan gelen tipli kenarlar. Yayımlanmış bir hedefi olmayan bir başvuru, bağlantı yerine kopuk bir kenar olarak gösterilir.
Kullanır
- kullanır«target_datastore» soketini kullanır
datastore.aggrega.ai/engine in (vector, semantic-memory, search)
Ekleme yuvası bildirmez.
- $refşemayı genişletir (values)
BaseComponents#/schemas/BaseToolParameter
Kullananlar
uygulanır
uygular