Trang này được dịch bằng máy. Đọc bản gốc tiếng Anh.

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.

Phiên bản

1.0.01.0.1

Nguồn gốc

Chính thứcĐược ký bởi một danh tính ký mà danh mục này công nhận là nhà phát hành chính thức.
Digest nội dung
sha256:773b2b12397c8955789224669697da50fda0b5a16df34b17427e635309d60949
Đã xuất bản
2026-11-10T10:10:06Z
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:d1371a131371e967dcf30c0977070c94a008b7fcc9df38ed04eac3abde1a9aef

Tham chiếu ở phiên bản này

oci://hub.aggrega.ai/component/core/ai-tool/retrieval:1.0.0

Tham 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ênKiểuMặc địnhBắt buộcMô tả
top_kinteger5có—
side_effectsstring (read_only)read_onlycó—

Đị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ênKiểuMặc địnhBắt buộcMô tả
imagestring—khôngContainer image serving the lookup over HTTP.
portinteger (min 1024, max 65535)8080khôngPort 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.
computeobject—không—
min_replicasinteger (min 0)0khôngReplica floor. Zero is what lets the tool run no replicas between calls, which the realization reaches through its control plane.
max_replicasinteger (min 1)5khôngReplica ceiling the realization's autoscaler may reach.
control_plane_presentbooleanfalsekhôngOperator 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.
overridesobject (open)—khôngRealization-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ênKiểuMặc địnhBắt buộcMô tả
hoststring—có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.
portinteger—có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.
endpointstring—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.
protocolstring—khôngURL 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

Được sử dụng bởi

Tài liệu tham khảo khái niệm Component →

Danh mục Aggrega — chỉ mục mở gồm các thành phần, tính năng, công thức và các plugin kết xuất chúng.

Được xây dựng bằng hệ thống thiết kế dùng chung của Aggrega.

Quyền riêng tư