Esta página foi traduzida automaticamente. Leia o original em inglês.

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.

Versão

1.0.01.0.1

Procedência

OficialAssinado por uma identidade de assinatura que este catálogo reconhece como publicador oficial.
Digest do conteúdo
sha256:773b2b12397c8955789224669697da50fda0b5a16df34b17427e635309d60949
Publicado
2026-11-10T10:10:06Z
Identidade de assinatura
https://token.actions.githubusercontent.com/https://github.com/aggrega-ai/aggrega-hub/.github/workflows/catalog-publish-sign.yml@refs/heads/main

Assinatura

  • Oficialapplication/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

Referência nesta versão

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

Parâmetros do desenvolvedor

Valores que o desenvolvedor define no Aggregate.

Estende BaseComponents#/schemas/BaseToolParameter

NomeTipoPadrãoObrigatórioDescrição
top_kinteger5sim—
side_effectsstring (read_only)read_onlysim—

Dimensionamento do operador

Dimensionamento de infraestrutura que o operador ajusta por ambiente.

NomeTipoPadrãoObrigatórioDescrição
imagestring—nãoContainer image serving the lookup over HTTP.
portinteger (min 1024, max 65535)8080nãoPort 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—não—
min_replicasinteger (min 0)0nãoReplica floor. Zero is what lets the tool run no replicas between calls, which the realization reaches through its control plane.
max_replicasinteger (min 1)5nãoReplica ceiling the realization's autoscaler may reach.
control_plane_presentbooleanfalsenãoOperator 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)—nãoRealization-specific overrides. Accepts any nested structure. Each Recipe documents which keys it reads.

Contrato de saída

Valores que este componente publica para os consumidores pela topologia uses.

NomeTipoPadrãoObrigatórioDescrição
hoststring—simIn-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—simTCP 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—simFull 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—nãoURL scheme to reach `host` and `port` over, for a consumer composing its own address rather than reading `endpoint`.

Sockets uses

Os sockets de dependência pelos quais este componente se conecta. O destino de cada conexão ligada por um socket deve satisfazer o seletor de rótulos dele, e cada conexão pode carregar um acoplamento nos slots que o socket declara. Cada conexão que o Aggregate ou a Release liga pelo socket deve preencher os slots obrigatórios.

target_datastore

Seletor
datastore.aggrega.ai/engine in (vector, semantic-memory, search)
Injeção
env, file

Este socket não declara slots de acoplamento, então uma conexão por ele não carrega nenhum acoplamento.

Slots de acoplamento

Pontos de vinculação nomeados nos quais uma Feature se acopla a este componente. O seletor de um slot restringe qual Feature pode preenchê-lo, e sua lista inject indica como o material da Feature pode ser entregue. Um slot obrigatório deve estar vinculado em cada instância, por um acoplamento na instância ou em um escopo acima dela, e um slot sensível é declarado para lidar com material secreto. Uma Feature também pode se acoplar com um nome que nenhum slot declara.

Nenhum slot de acoplamento declarado.

Lista de permissões de autoinjeção

env, file

Relações

Arestas tipadas de e para outras entidades publicadas. Uma referência sem destino publicado é exibida como uma aresta quebrada em vez de um link.

Usa

Usado por

Referência do conceito Component →

O catálogo Aggrega — um índice aberto de componentes, funcionalidades, receitas e dos plugins que os renderizam.

Criado com o sistema de design compartilhado do Aggrega.

Privacidade