Цю сторінку перекладено машинно. Читати англійський оригінал.

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. By default the server sends nothing to Dify's vendor: infra.telemetry_enabled turns on its usage events, update check, remote template lists and Creators Platform, and infra.marketplace_enabled its plugin marketplace, which model-provider plugins such as OpenAI's install from.

Версія

1.0.01.1.0

Походження

ОфіційнийПідписано ідентичністю підписувача, яку цей каталог визнає офіційним видавцем.
Дайджест вмісту
sha256:6cde03e895a584a1d3af008e8015aa0aefb7e52eeb6f0005dc8ccfb09107b706
Опубліковано
2026-11-15T08:08:52Z
Ідентичність підписувача
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:ac95749c5717fc491f3efac7000fb5818ddd70e0247456c9885278be4e77d06d

Посилання на цю версію

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

Параметри розробника

Значення, які розробник задає в сутності Aggregate.

Розширює BaseComponents#/schemas/BaseAgentParameter

НазваТипТипове значенняОбов’язковеОпис
vector_index_prefixstringVector_indexніName 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)10ніHighest retrieval top-k an application in this installation may request.
max_parallel_limitinteger (min 1)10ніHighest parallel-branch count a workflow in this installation may run.
max_iterationsinteger (min 1)99ніHighest iteration count an iteration node in this installation may run.
max_toolsinteger (min 1)10ніHighest number of tools an agent in this installation may be given.
indexing_max_segmentation_tokensinteger (min 1)4000ніLongest segment, in tokens, the dataset indexer produces when it splits a document.
app_definitionstring—ніAn application in Dify's own DSL, the YAML Dify exports for an application, carried verbatim. Realized by the helm and compose targets: 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.

Розміри, задані оператором

Розміри інфраструктури, які оператор налаштовує для кожного середовища.

НазваТипТипове значенняОбов’язковеОпис
portinteger (min 1024, max 65535)5001ніConsole-API and application-API listen port consumers connect to.
published_portinteger (min 1024, max 65535)—ніPort published on the host's loopback address, 127.0.0.1, on Docker Compose, forwarding to infra.port inside the container; any process on this machine can reach it there. Unset, nothing is published. Kubernetes realizations refuse it; reach the Service with kubectl port-forward, or attach core/public-ingress.
engine_versionstring1.17.0ніDify 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)INFOніLog verbosity the server emits.
external_base_urlstringніExternally 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.
console_urlstring—ніAddress a browser opens the console (core/ai-agent/dify-web) at, as scheme, host and port, for example http://127.0.0.1:3001. The server admits credentialed browser requests to its console API from this origin alone, so the console's sign-in works there, and composes the console links it hands out, such as the redirect after an OAuth sign-in, from it. A trailing / is dropped, and an address carrying any other path halts the build, since a browser sends an origin without one. Where infra.external_base_url is set too, this key decides the console's address and that one the other URLs. Unset, the console's address comes from infra.external_base_url where that is set, and otherwise is the image's own default, http://127.0.0.1:3000.
owner_emailstring—ніEmail 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.
telemetry_enabledbooleanfalseніLets the server reach Dify's vendor for its anonymous usage events (otel.dify.ai, falling back to otel.dify.cn, when first-time setup runs), the update check the console makes (updates.dify.ai), the remote application and knowledge-pipeline template lists (tmpl.dify.ai) and publishing an application to the Creators Platform (creators.dify.ai). Unset or false, nothing reaches those hosts: the templates come from the image and the update check answers with the running version. Set it on the task worker and the scheduler too, which send and schedule the daily usage event.
marketplace_enabledbooleanfalseніLets the server reach Dify's plugin marketplace (marketplace.dify.ai) to install, upgrade and look up plugins. Model-provider plugins such as OpenAI's install from the marketplace, so a Release whose applications use one sets it. Unset or false, nothing reaches that host and plugins install only from an uploaded package or from GitHub. Set it on the task worker and the scheduler too, which run the daily plugin upgrade check.
computeobject—ні—
overridesobject (open)—ніProvider-specific overrides. Accepts any nested structure. Each Recipe documents which keys it reads.

Вихідний контракт

Значення, які цей компонент публікує для споживачів через топологію uses.

НазваТипТипове значенняОбов’язковеОпис
hoststring—такIn-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—такTCP 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—ніURL scheme to reach `host` and `port` over, which a consumer composes its base URL on.

Сокети uses

Сокети залежностей, через які під’єднується цей компонент. Ціль кожного з’єднання, прокладеного через сокет, має задовольняти його селектор міток, а кожне з’єднання може нести приєднання в слотах, які оголошує сокет. Обов’язковий слот має заповнити кожне з’єднання, яке сутність Aggregate або сутність Release прокладає через сокет.

backend

Селектор
component.aggrega.ai/category=datastore
Ін’єкція
env

Слоти, які може заповнити кожне з’єднання через цей сокет

СлотСелекторОбов’язковеІн’єкціяЧутливийОпис
credentialfeature.aggrega.ai/kind=secretніenvтакOptional 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

Селектор
component.aggrega.ai/category=datastore
Ін’єкція
env

Слоти, які може заповнити кожне з’єднання через цей сокет

СлотСелекторОбов’язковеІн’єкціяЧутливийОпис
server_cafeature.aggrega.ai/kind=secretніfileтакOptional 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 helm Recipe mounts the whole Secret read-only and points the cache client and the task broker at the file; the compose Recipe refuses it, having no Secret to mount. 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

Селектор
datastore.aggrega.ai/engine in (vector, semantic-memory, search)
Ін’єкція
env

Цей сокет не оголошує слотів приєднання, тому з’єднання через нього не несе жодного приєднання.

sandbox

Селектор
component.aggrega.ai/category=ai-agent
Ін’єкція
env

Слоти, які може заповнити кожне з’єднання через цей сокет

СлотСелекторОбов’язковеІн’єкціяЧутливийОпис
credentialfeature.aggrega.ai/kind=secretніenvтакOptional 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

Селектор
component.aggrega.ai/category=ai-agent
Ін’єкція
env

Слоти, які може заповнити кожне з’єднання через цей сокет

СлотСелекторОбов’язковеІн’єкціяЧутливийОпис
credentialfeature.aggrega.ai/kind=secretніenvтакOptional 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

Селектор
component.aggrega.ai/category=ai-agent
Ін’єкція
env

Цей сокет не оголошує слотів приєднання, тому з’єднання через нього не несе жодного приєднання.

Слоти приєднання

Іменовані точки прив’язки, у яких сутність Feature приєднується до цього компонента. Селектор слота обмежує, яка сутність Feature може його заповнити, а його список inject визначає, як можна доставити матеріал сутності Feature. Обов’язковий слот має бути прив’язаний у кожному екземплярі, приєднанням в екземплярі або в області вище за нього, а чутливий слот оголошено для роботи з секретним матеріалом. Сутність Feature також може приєднатися під назвою, яку не оголошує жоден слот.

СлотСелекторОбов’язковеІн’єкціяЧутливийОпис
secret_keyfeature.aggrega.ai/kind=secretтакenvтакRequired 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=secretніenvтакOptional 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=secretніenvтакPassword 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. On helm 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; on compose it receives the value the credential delivers, written into the emitted file as delivered, so an origin written as a Compose variable reference keeps it out of the file. Dify accepts a password of at least eight characters holding both letters and digits.

Список дозволених самоін’єкцій

env

Зв’язки

Типізовані ребра до інших опублікованих сутностей і від них. Відсилання без опублікованої цілі відображається як розірване ребро, а не як посилання.

Використовує

Використовується в

Довідка про поняття Component →

Каталог Aggrega — відкритий індекс компонентів, функцій, рецептів і плагінів, які їх рендерять.

Створено на основі спільної дизайн-системи Aggrega.

Конфіденційність