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.
Phiên bản
Nguồn gốc
- Digest nội dung
- sha256:7ef1482e831edd8428703ffdd39a1bae5092b0c8912737f5df94e41daf851d5b
- Đã xuất bản
- 2026-11-15T08:08:58Z
- Danh tính ký
- https://token.actions.githubusercontent.com/https://github.com/aggrega-ai/aggrega-hub/.github/workflows/catalog-publish-sign.yml@refs/heads/main
Chữ ký
- Chính thứcapplication/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
Tham chiếu ở phiên bản này
oci://hub.aggrega.ai/component/core/ai-tool/retrieval:1.0.1Tham số của nhà phát triển
Các giá trị mà nhà phát triển đặt trong Aggregate.
Mở rộng BaseComponents#/schemas/BaseToolParameter
| Tên | Kiểu | Mặc định | Bắt buộc | Mô tả |
|---|---|---|---|---|
| top_k | integer | 5 | có | — |
| side_effects | string (read_only) | read_only | có | — |
Định cỡ của người vận hành
Định cỡ hạ tầng mà người vận hành tinh chỉnh theo từng môi trường.
| Tên | Kiểu | Mặc định | Bắt buộc | Mô tả |
|---|---|---|---|---|
| image | string | — | không | Container image serving the lookup over HTTP. |
| port | integer (min 1024, max 65535) | 8080 | không | 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 | — | không | — |
| min_replicas | integer (min 0) | 0 | không | 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 | không | Replica ceiling the Kubernetes realization's autoscaler may reach. On Docker Compose the one container never passes it. |
| control_plane_present | boolean | false | không | 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) | — | không | Realization-specific overrides. Accepts any nested structure. Each Recipe documents which keys it reads. |
Hợp đồng đầu ra
Các giá trị mà thành phần này xuất bản cho bên tiêu thụ qua cấu trúc liên kết uses.
| Tên | Kiểu | Mặc định | Bắt buộc | Mô tả |
|---|---|---|---|---|
| host | string | — | có | 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 | — | có | 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 | — | có | 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 | — | không | URL scheme to reach `host` and `port` over, for a consumer composing its own address rather than reading `endpoint`. |
Các socket uses
Các socket phụ thuộc mà thành phần này kết nối qua. Đích của mọi kết nối được nối qua một socket phải thỏa mãn bộ chọn nhãn của socket đó, và mỗi kết nối có thể mang theo phần đính kèm trong các slot mà socket khai báo. Một slot bắt buộc phải được đáp ứng bởi mỗi kết nối mà Aggregate hoặc Release nối qua socket.
target_datastore
- Bộ chọn
- datastore.aggrega.ai/engine in (vector, semantic-memory, search)
- Tiêm
- env, file
Socket này không khai báo slot đính kèm nào, nên một kết nối qua nó không mang theo phần đính kèm nào.
Slot đính kèm
Các điểm liên kết có tên mà tại đó một Feature được gắn vào thành phần này. Bộ chọn của một slot giới hạn Feature nào có thể lấp đầy nó, và danh sách tiêm của slot nêu cách nội dung của Feature có thể được chuyển giao. Một slot bắt buộc phải được liên kết trên mọi thể hiện, bằng một phần đính kèm trên thể hiện đó hoặc ở một phạm vi phía trên nó, và một slot nhạy cảm được khai báo để xử lý nội dung bí mật. Một Feature cũng có thể được gắn dưới một tên mà không slot nào khai báo.
Chưa khai báo slot đính kèm nào.
Danh sách cho phép tự tiêm
env, file
Quan hệ
Các cạnh có kiểu đi tới và đi từ các thực thể đã xuất bản khác. Một tham chiếu không có đích đã xuất bản được hiển thị là một cạnh bị đứt thay vì một liên kết.
Sử dụng
- sử dụngsử dụng socket «target_datastore»
datastore.aggrega.ai/engine in (vector, semantic-memory, search)
Không khai báo slot đính kèm nào.
- $refmở rộng lược đồ (values)
BaseComponents#/schemas/BaseToolParameter
Được sử dụng bởi
áp dụng cho
triển khai
triển khai