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 може його заповнити, а його список inject визначає, як можна доставити матеріал сутності Feature. Обов’язковий слот має бути прив’язаний у кожному екземплярі, приєднанням в екземплярі або в області вище за нього, а чутливий слот оголошено для роботи з секретним матеріалом. Сутність Feature також може приєднатися під назвою, яку не оголошує жоден слот.
Слотів приєднання не оголошено.
Список дозволених самоін’єкцій
env, file
Зв’язки
Типізовані ребра до інших опублікованих сутностей і від них. Відсилання без опублікованої цілі відображається як розірване ребро, а не як посилання.
Використовує
- використовуєвикористовує сокет «target_datastore»
datastore.aggrega.ai/engine in (vector, semantic-memory, search)
Не оголошує слотів приєднання.
- $refрозширює схему (values)
BaseComponents#/schemas/BaseToolParameter
Використовується в
застосовується до
реалізує
реалізує