Esta página foi traduzida automaticamente. Ler 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 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.

Versão

1.0.01.0.1

Proveniência

OficialAssinado por uma identidade de assinatura que este catálogo reconhece como editor oficial.
Digest do conteúdo
sha256:7ef1482e831edd8428703ffdd39a1bae5092b0c8912737f5df94e41daf851d5b
Publicado
2026-11-15T08:08:58Z
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:b7ee3c99e90b0cef9ef78aa4bea3b0ee531f25de58326e923fa55e69d71972e2

Referência nesta versão

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

Parâmetros do programador

Valores que o programador define no Aggregate.

Estende BaseComponents#/schemas/BaseToolParameter

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

Dimensionamento do operador

Dimensionamento da infraestrutura que o operador ajusta por ambiente.

NomeTipoPredefiniçã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. 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—não—
min_replicasinteger (min 0)0nãoReplica 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)5nãoReplica ceiling the Kubernetes realization's autoscaler may reach. On Docker Compose the one container never passes it.
control_plane_presentbooleanfalsenãoOperator 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)—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 através da topologia uses.

NomeTipoPredefiniçãoObrigatórioDescrição
hoststring—simName 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—simTCP 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—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 através dos quais este componente se liga. O destino de cada ligação estabelecida através de um socket tem de satisfazer o respetivo seletor de etiquetas, e cada ligação pode transportar um acoplamento nos slots que o socket declara. Cada ligação que o Aggregate ou a Release estabelece através do socket tem de 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, pelo que uma ligação através dele não transporta nenhum acoplamento.

Slots de acoplamento

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

Nenhum slot de acoplamento declarado.

Lista de autorizações de autoinjeção

env, file

Relações

Arestas tipadas de e para outras entidades publicadas. Uma referência sem destino publicado é apresentada como uma aresta quebrada em vez de uma ligação.

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 partilhado do Aggrega.

Privacidade