Component
core/ai-agent/openai-agents-sdk
An agent built on the OpenAI Agents SDK, run in-cluster as an application image the Release supplies. The SDK is published as a library an application is built around rather than as a server, so there is no upstream image to pin: the catalog supplies none, and until a Release sets `infra.image` the build halts naming the container image and renders nothing. Deploying it gives that application as a worker wired to a model serving the OpenAI API. The Recipe delivers the model's endpoint, its model name and the connection's credential as the variables the SDK reads, so one image runs against any such model in the catalog without an endpoint in its code. By default the SDK uploads a trace of each run to OpenAI, authenticated with the key it reads as OPENAI_API_KEY, which here is the model connection's credential whatever model it reaches. While `values.upload_traces_to_openai` is false, its default, the Recipe delivers OPENAI_AGENTS_DISABLE_TRACING=1, and that upload is off unless the application turns tracing on in its own code. Set true, the variable is not delivered and each run's traces go to OpenAI. Each tool wired into the optional `tools` socket, such as a Model Context Protocol server reached over HTTP, reaches the application under variables named for the connection's alias, its address as AGGREGA_TOOL_<ALIAS>_URL, which the application hands to the SDK in its own code. An `inject:` block on a connection delivers the names the application reads, as variables or files: on a tools connection in place of the tool's address and header, and on the model connection beside the variables the SDK reads. The component's own `inject:` block takes `env` and `file` entries.
Herkunft
- Inhalts-Digest
- sha256:5232196409373c4428858df9231c3a4b20bc092234c779f25d696ff90e0399e2
- Veröffentlicht
- 2026-11-10T10:08:34Z
- 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:f470f4fc8ed75dc089afdd392d463470e34b09bb93c0095325cbd081f22ef8d1
Referenz zu dieser Version
oci://hub.aggrega.ai/component/core/ai-agent/openai-agents-sdk:1.0.0Entwicklerparameter
Werte, die der Entwickler im Aggregate festlegt.
Erweitert BaseComponents#/schemas/BaseAgentParameter
| Name | Typ | Standardwert | Erforderlich | Beschreibung |
|---|---|---|---|---|
| upload_traces_to_openai | boolean | false | nein | Whether the SDK uploads a trace of each run to OpenAI. While false, its default, the Recipe delivers OPENAI_AGENTS_DISABLE_TRACING=1, and the SDK's trace upload to OpenAI is off unless the application turns tracing on in its own code. Set true, no such variable is delivered, and the SDK sends each run's traces to OpenAI, authenticated with the model connection's key, delivered as OPENAI_API_KEY. |
Dimensionierung durch den Operator
Infrastrukturdimensionierung, die der Operator pro Umgebung anpasst.
| Name | Typ | Standardwert | Erforderlich | Beschreibung |
|---|---|---|---|---|
| image | string | — | nein | Container image running the application built on the OpenAI Agents SDK. |
Ausgabevertrag
Werte, die diese Komponente über die uses-Topologie an Konsumenten veröffentlicht.
Keine Ausgabewerte deklariert.
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.
model
- Selektor
- component.aggrega.ai/category in (ai-model, gateway), model.aggrega.ai/api=openai
- Injektion
- env, file
Slots, die jede Verbindung über diesen Socket füllen kann
| Slot | Selektor | Erforderlich | Injektion | Sensibel | Beschreibung |
|---|---|---|---|---|---|
| credential | feature.aggrega.ai/kind=secret | nein | env | ja | Optional credential the agent presents to the model this connection reaches. When attached, the Recipe delivers it to the application as OPENAI_API_KEY (a Kubernetes secretKeyRef on helm, the inject pipe on compose); unattached, the application runs without an injected key. |
tools
- Selektor
- component.aggrega.ai/category=ai-tool, tool.aggrega.ai/transport=http
- Injektion
- env, file
Slots, die jede Verbindung über diesen Socket füllen kann
| Slot | Selektor | Erforderlich | Injektion | Sensibel | Beschreibung |
|---|---|---|---|---|---|
| credential | feature.aggrega.ai/kind=secret | nein | env | ja | Optional credential the agent presents to the tool this connection reaches, under the request header the tool publishes as credential_header: as Bearer <credential> under Authorization, and as the whole value of any other header. When attached, the Recipe delivers it as AGGREGA_TOOL_<ALIAS>_CREDENTIAL (a Kubernetes secretKeyRef on helm, the inject pipe on compose), on a connection writing an inject block too, and, on one writing none, the header as AGGREGA_TOOL_<ALIAS>_CREDENTIAL_HEADER where the tool publishes one. |
| endpoint | feature.aggrega.ai/kind=secret | nein | env | ja | Optional whole address of the tool this connection reaches, the part carrying its key included, for a server that reads its key from its own address. When attached, the Recipe delivers it as AGGREGA_TOOL_<ALIAS>_URL in place of the endpoint the tool publishes: a Kubernetes secretKeyRef on helm, so the key reaches no rendered file, and the inject pipe on compose, written as delivered. |
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.
Keine Anbindungs-Slots deklariert.
Zulassungsliste für Selbstinjektion
env, file
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
- verwendetverwendet Socket «model»
component.aggrega.ai/category in (ai-model, gateway), model.aggrega.ai/api=openai
Anbindungs-Slots: credential
core/ai-model/docker-model-runner v1.0.0 →core/ai-model/litellm v1.0.0 →core/ai-model/nvidia-api v1.0.0 →core/ai-model/nvidia-nim v1.0.0 →core/ai-model/ollama v1.0.0 →core/ai-model/openai v1.0.0 →core/ai-model/openai-compatible v1.0.0 →core/ai-model/openai-embedding v1.0.0 →core/ai-model/tei v1.0.0 →core/ai-model/tgi v1.0.0 →core/ai-model/vllm v1.0.0 →core/gateway/agentgateway v1.0.0 →core/gateway/apisix v1.0.0 →core/gateway/envoy-gateway v1.0.0 →core/gateway/higress v1.0.0 →core/gateway/kong v1.0.0 →core/gateway/kong-enterprise v1.0.0 →core/gateway/litellm v1.0.0 →core/gateway/traefik-hub v1.0.0 → - verwendetverwendet Socket «tools»
component.aggrega.ai/category=ai-tool, tool.aggrega.ai/transport=http
Anbindungs-Slots: credential, endpoint
- $referweitert Schema (values)
BaseComponents#/schemas/BaseAgentParameter
Verwendet von
verwendet Socket «runner»
verwendet Socket «api»
verwendet Socket «runner»
verwendet Socket «api»
verwendet Socket «services»
verwendet Socket «api»
verwendet Socket «services»
verwendet Socket «services»
verwendet Socket «sandbox»
verwendet Socket «plugin_daemon»
verwendet Socket «ssrf_proxy»
verwendet Socket «sandbox»
verwendet Socket «plugin_daemon»
verwendet Socket «ssrf_proxy»
verwendet Socket «api»
verwendet Socket «ssrf_proxy»
verwendet Socket «api»
verwendet Socket «api»
verwendet Socket «sandbox»
verwendet Socket «plugin_daemon»
verwendet Socket «ssrf_proxy»
verwendet Socket «sandbox»
verwendet Socket «plugin_daemon»
verwendet Socket «ssrf_proxy»
verwendet Socket «target_agent»
verwendet Socket «scrape_target»
gilt für
gilt für
gilt für
implementiert
implementiert