このページは機械翻訳されています。英語の原文を読む。

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.

バージョン

1.0.01.0.1

来歴

公式このカタログが公式の公開者として認めている署名 ID によって署名されています。
コンテンツダイジェスト
sha256:7ef1482e831edd8428703ffdd39a1bae5092b0c8912737f5df94e41daf851d5b
公開日
2026-11-15T08:08:58Z
署名 ID
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_kinteger5はい—
side_effectsstring (read_only)read_onlyはい—

運用担当者によるサイジング

運用担当者が環境ごとに調整するインフラストラクチャのサイジングです。

名前型デフォルト必須説明
imagestring—いいえContainer image serving the lookup over HTTP.
portinteger (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.
computeobject—いいえ—
min_replicasinteger (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_replicasinteger (min 1)5いいえReplica ceiling the Kubernetes realization's autoscaler may reach. On Docker Compose the one container never passes it.
control_plane_presentbooleanfalseいいえ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.
overridesobject (open)—いいえRealization-specific overrides. Accepts any nested structure. Each Recipe documents which keys it reads.

出力コントラクト

このコンポーネントが uses トポロジを通じて利用側に公開する値です。

名前型デフォルト必須説明
hoststring—はい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.
portinteger—はい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.
endpointstring—はい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—いいえ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

関係

他の公開エンティティとの間の型付きエッジです。公開されたターゲットがない参照は、リンクではなく切れたエッジとして表示されます。

使用先

使用元

Component の概念リファレンス →

Aggrega カタログ — コンポーネント、機能、レシピ、およびそれらをレンダリングするプラグインのオープンなインデックスです。

共有の Aggrega デザインシステムで構築されています。

プライバシー