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
被使用
适用于
实现
实现