Diese Seite wurde maschinell übersetzt. Englisches Original lesen.

Component

core/ai-agent/dify

The Dify API and console server — the control plane of a self-hosted Dify installation. It serves the console API the browser front end calls, the published application API, and the file endpoints, and it owns the platform's relational model: workspaces, applications, workflow definitions, datasets and the encrypted model-provider credentials. It stores that model in a PostgreSQL backend wired through the `backend` uses-socket, keeps sessions and the Celery task queue in a Redis-compatible cache wired through `cache`, and reads and writes dataset embeddings in a vector datastore wired through `vector_store`. Three sibling services complete the platform and reach it through their own sockets: code nodes execute in the sandbox wired through `sandbox`, model and tool plugins run in the plugin runtime wired through `plugin_daemon`, and outbound requests to addresses a user supplied are routed through the forward proxy wired through `ssrf_proxy`, so a workflow cannot reach a private address directly. Holds no durable state of its own — the backend, the cache and the vector datastore are the systems of record — so it renders as a stateless server. Exports its host, port and protocol to consumers via the uses topology. An application written in Dify's own export format, set as app_definition, is imported into the installation at deploy under the owner account the operator names.

Version

1.0.01.1.0

Herkunft

OffiziellSigniert von einer Signaturidentität, die dieser Katalog als offiziellen Herausgeber anerkennt.
Inhalts-Digest
sha256:9934ad23e2257de50668185805cec5cca8464cbd259c8c1be033b87b904d84d2
Veröffentlicht
2026-11-10T10:07:57Z
Signaturidentität
https://token.actions.githubusercontent.com/https://github.com/aggrega-ai/aggrega-hub/.github/workflows/catalog-publish-sign.yml@refs/heads/main

Signatur

  • Offiziellapplication/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:3b4123cad4b6844c96e70344448c245ffa5af8d97df01b59545c1919ac0684f2

Referenz zu dieser Version

oci://hub.aggrega.ai/component/core/ai-agent/dify:1.0.0

Entwicklerparameter

Werte, die der Entwickler im Aggregate festlegt.

Erweitert BaseComponents#/schemas/BaseAgentParameter

NameTypStandardwertErforderlichBeschreibung
vector_index_prefixstringVector_indexneinName prefix the platform gives the collections it creates in the wired vector datastore. Two installations sharing one datastore keep their collections apart by carrying different prefixes.
top_k_maxinteger (min 1)10neinHighest retrieval top-k an application in this installation may request.
max_parallel_limitinteger (min 1)10neinHighest parallel-branch count a workflow in this installation may run.
max_iterationsinteger (min 1)99neinHighest iteration count an iteration node in this installation may run.
max_toolsinteger (min 1)10neinHighest number of tools an agent in this installation may be given.
indexing_max_segmentation_tokensinteger (min 1)4000neinLongest segment, in tokens, the dataset indexer produces when it splits a document.
app_definitionstring—neinAn application in Dify's own DSL, the YAML Dify exports for an application, carried verbatim. Realized by the helm target: when set, a one-shot step imports it once the installation is deployed. The step performs Dify's first-time setup if it has not run, creating the owner account named by infra.owner_email with the password attached to the owner_password slot; signs in as that account; leaves an application already present under the definition's app.name as it is; and otherwise imports the definition through Dify's console import, confirming the import when Dify holds it for confirmation, as it does for a DSL version newer than the installation's. When set, infra.owner_email and the owner_password slot are required and the build halts without them. When unset, nothing is imported and no step is rendered. An Aggregate's text is evaluated as a template before it is read, so a definition carrying Dify's own {{#...#}} variable references halts the build when written into an Aggregate as it stands; supply it as a parameter the Release fills, written into this value through toJson, and it arrives as written.

Dimensionierung durch den Operator

Infrastrukturdimensionierung, die der Operator pro Umgebung anpasst.

NameTypStandardwertErforderlichBeschreibung
portinteger (min 1024, max 65535)5001neinConsole-API and application-API listen port consumers connect to.
engine_versionstring1.17.0neinDify API container image tag. The worker, the scheduler and this server run the same image, so a Release moves all three together.
log_levelstring (DEBUG | INFO | WARNING | ERROR | CRITICAL)INFOneinLog verbosity the server emits.
external_base_urlstringneinExternally reachable base URL of the installation, as a browser and an API client see it — the address the ingress tier publishes. The server composes the console, application, service-API and file URLs from it, which is what makes shared links and emailed links resolve. Left empty, the server derives each URL from the incoming request, which suits an installation reached only in-cluster.
owner_emailstring—neinEmail address of the installation's owner account, read only when values.app_definition is set. The step that imports the application creates this account when it performs Dify's first-time setup, and signs in as it; on an installation whose setup has already run, it names an existing account allowed to import applications, and the password attached to the owner_password slot is that account's. Required when values.app_definition is set: the build halts when it is empty. It has no default.
computeobject—nein—
overridesobject (open)—neinProvider-specific overrides. Accepts any nested structure. Each Recipe documents which keys it reads.

Ausgabevertrag

Werte, die diese Komponente über die uses-Topologie an Konsumenten veröffentlicht.

NameTypStandardwertErforderlichBeschreibung
hoststring—jaIn-cluster DNS name of the Service fronting the console and application APIs. The front end and the workers dial this name for every piece of data they show or act on.
portinteger—jaTCP port that Service accepts API requests on. It follows the port an operator set in the Release, so a consumer reads it rather than assuming a default.
protocolstring—neinURL scheme to reach `host` and `port` over, which a consumer composes its base URL on.

uses-Sockets

Die Abhängigkeits-Sockets, über die sich diese Komponente verbindet. Das Ziel jeder über einen Socket verdrahteten Verbindung muss dessen Label-Selektor erfüllen, und jede Verbindung kann in den Slots, die der Socket deklariert, eine Anbindung tragen. Einen erforderlichen Slot muss jede Verbindung füllen, die das Aggregate oder das Release über den Socket verdrahtet.

backend

Selektor
component.aggrega.ai/category=datastore
Injektion
env

Slots, die jede Verbindung über diesen Socket füllen kann

SlotSelektorErforderlichInjektionSensibelBeschreibung
credentialfeature.aggrega.ai/kind=secretneinenvjaOptional password the server presents to the backend this connection reaches, shared with that backend. When attached, supplies the backend password via the credential subsystem; unattached, the Recipe uses the development literal `apppass`, which this catalog publishes, so every Release that leaves the slot unattached shares that password.

cache

Selektor
component.aggrega.ai/category=datastore
Injektion
env

Slots, die jede Verbindung über diesen Socket füllen kann

SlotSelektorErforderlichInjektionSensibelBeschreibung
server_cafeature.aggrega.ai/kind=secretneinfilejaOptional authority the server checks the cache's certificate against while the cache publishes protocol valkey-tls or redis-tls, where the image does not already trust the authority that signs it. Its Secret holds ca.crt. The Recipe mounts the whole Secret read-only and points the cache client and the task broker at the file. The build halts on a server_ca publishing no Secret name, and on one wired to a cache served without TLS. Fill it with core/referenced-secret.

vector_store

Selektor
datastore.aggrega.ai/engine in (vector, semantic-memory, search)
Injektion
env

Dieser Socket deklariert keine Anbindungs-Slots, daher trägt eine Verbindung über ihn keine Anbindung.

sandbox

Selektor
component.aggrega.ai/category=ai-agent
Injektion
env

Slots, die jede Verbindung über diesen Socket füllen kann

SlotSelektorErforderlichInjektionSensibelBeschreibung
credentialfeature.aggrega.ai/kind=secretneinenvjaOptional execution-key credential the server presents on every request to the sandbox this connection reaches. The same credential is attached to the code_execution_key slot on the sandbox, so both ends hold the same value. Unattached, the Recipe uses the pinned development literal `dify-sandbox`, suitable for evaluation only and published in this catalog, so every Release that leaves the slot unattached shares it.

plugin_daemon

Selektor
component.aggrega.ai/category=ai-agent
Injektion
env

Slots, die jede Verbindung über diesen Socket füllen kann

SlotSelektorErforderlichInjektionSensibelBeschreibung
credentialfeature.aggrega.ai/kind=secretneinenvjaOptional credential the server presents on every call it makes to the plugin runtime this connection reaches. The runtime holds the same key in its plugin_daemon_key slot and the task worker presents it on its own connection, so the credential is attached to all three or to none: attaching it to some of them leaves the rest carrying a different value, which renders cleanly and is refused when the call is made. Unattached, the Recipe uses the pinned development literal `dify-plugin-daemon-server-key`, suitable for evaluation only and published in this catalog, so every Release that leaves the slot unattached shares it.

ssrf_proxy

Selektor
component.aggrega.ai/category=ai-agent
Injektion
env

Dieser Socket deklariert keine Anbindungs-Slots, daher trägt eine Verbindung über ihn keine Anbindung.

Anbindungs-Slots

Benannte Bindungspunkte, an denen ein Feature an diese Komponente angebunden wird. Der Selektor eines Slots schränkt ein, welches Feature ihn füllen darf, und seine inject-Liste benennt, wie das Feature sein Material liefern darf. Ein erforderlicher Slot muss auf jeder Instanz gebunden sein, durch eine Anbindung an der Instanz oder in einem darüberliegenden Geltungsbereich, und ein sensibler Slot ist für den Umgang mit geheimem Material deklariert. Ein Feature kann auch unter einem Namen angebunden werden, den kein Slot deklariert.

SlotSelektorErforderlichInjektionSensibelBeschreibung
secret_keyfeature.aggrega.ai/kind=secretjaenvjaRequired application-secret credential. The server signs session cookies with it and encrypts stored model-provider credentials under it, and the task worker decrypts them with the same secret. There is no default: the build halts when nothing fills this slot.
inner_api_keyfeature.aggrega.ai/kind=secretneinenvjaOptional credential the plugin runtime presents on every call back into the server's internal API, which the server compares against its own. The server and the task worker declare this slot under the same name and the plugin runtime presents it on its connection to the server, so the credential is attached to all three or to none: attaching it to some of them leaves the rest carrying a different value, which renders cleanly and is refused when the call is made. Unattached, the Recipe uses the pinned development literal `dify-plugin-inner-api-key`, suitable for evaluation only and published in this catalog, so every Release that leaves the slot unattached shares it.
owner_passwordfeature.aggrega.ai/kind=secretneinenvjaPassword of the owner account named by infra.owner_email, read only when values.app_definition is set: the step that imports the application at deploy sets it when it performs Dify's first-time setup, and signs in with it. Required then, and the build halts when nothing fills this slot; there is no development default. The step receives it by reference, as a Kubernetes secretKeyRef to the Secret the credential publishes, so the password appears in no file the Recipe renders, and a credential publishing no Secret name and data key halts the build. Dify accepts a password of at least eight characters holding both letters and digits.

Zulassungsliste für Selbstinjektion

env

Beziehungen

Typisierte Kanten zu und von anderen veröffentlichten Entitäten. Eine Referenz ohne veröffentlichtes Ziel wird als unterbrochene Kante statt als Link dargestellt.

Verwendet

Verwendet von

Konzeptreferenz zu Component →

Der Aggrega-Katalog — ein offener Index von Komponenten, Funktionen, Rezepten und den Plugins, die sie rendern.

Erstellt mit dem gemeinsamen Aggrega-Designsystem.

Datenschutz