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.
Версия
Происхождение
- Дайджест содержимого
- sha256:7ef1482e831edd8428703ffdd39a1bae5092b0c8912737f5df94e41daf851d5b
- Опубликовано
- 2026-11-15T08:08:58Z
- Идентичность подписи
- https://token.actions.githubusercontent.com/https://github.com/aggrega-ai/aggrega-hub/.github/workflows/catalog-publish-sign.yml@refs/heads/main
Подпись
- Официальныйapplication/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
Ссылка на эту версию
oci://hub.aggrega.ai/component/core/ai-tool/retrieval:1.0.1Параметры разработчика
Значения, которые разработчик задаёт в сущности Aggregate.
Расширяет BaseComponents#/schemas/BaseToolParameter
| Имя | Тип | По умолчанию | Обязательный | Описание |
|---|---|---|---|---|
| top_k | integer | 5 | да | — |
| side_effects | string (read_only) | read_only | да | — |
Размеры, задаваемые оператором
Размеры инфраструктуры, которые оператор настраивает для каждого окружения.
| Имя | Тип | По умолчанию | Обязательный | Описание |
|---|---|---|---|---|
| image | string | — | нет | Container image serving the lookup over HTTP. |
| port | integer (min 1024, max 65535) | 8080 | нет | 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 | — | нет | — |
| min_replicas | integer (min 0) | 0 | нет | 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 | нет | Replica ceiling the Kubernetes realization's autoscaler may reach. On Docker Compose the one container never passes it. |
| control_plane_present | boolean | false | нет | 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) | — | нет | Realization-specific overrides. Accepts any nested structure. Each Recipe documents which keys it reads. |
Контракт выходных значений
Значения, которые этот компонент публикует для потребителей через топологию uses.
| Имя | Тип | По умолчанию | Обязательный | Описание |
|---|---|---|---|---|
| host | string | — | да | 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 | — | да | 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 | — | да | 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 | — | нет | URL scheme to reach `host` and `port` over, for a consumer composing its own address rather than reading `endpoint`. |
Сокеты uses
Сокеты зависимостей, через которые подключается этот компонент. Цель каждого соединения, проведённого через сокет, должна удовлетворять его селектору меток, и каждое соединение может нести подключение в слотах, которые объявляет сокет. Обязательный слот должен заполнить каждое соединение, которое сущность Aggregate или сущность Release проводит через сокет.
target_datastore
- Селектор
- datastore.aggrega.ai/engine in (vector, semantic-memory, search)
- Внедрение
- env, file
Этот сокет не объявляет слотов подключения, поэтому соединение через него не несёт подключения.
Слоты подключения
Именованные точки привязки, в которых Feature подключается к этому компоненту. Селектор слота ограничивает, какая сущность Feature может его заполнить, а его список внедрения указывает, как могут доставляться материалы сущности Feature. Обязательный слот должен быть привязан в каждом экземпляре — подключением в самом экземпляре или в области выше него, — а конфиденциальный слот объявляется для работы с секретными материалами. Feature также может подключаться под именем, которое не объявляет ни один слот.
Слоты подключения не объявлены.
Список разрешённых самовнедрений
env, file
Связи
Типизированные рёбра к другим опубликованным сущностям и от них. Ссылка без опубликованной цели отображается как разорванное ребро, а не как ссылка.
Использует
- используетиспользует сокет «target_datastore»
datastore.aggrega.ai/engine in (vector, semantic-memory, search)
Не объявляет слотов подключения.
- $refрасширяет схему (values)
BaseComponents#/schemas/BaseToolParameter
Используется в
применяется к
реализует
реализует