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.
Proveniência
- Digest do conteúdo
- sha256:5232196409373c4428858df9231c3a4b20bc092234c779f25d696ff90e0399e2
- Publicado
- 2026-11-10T10:08:34Z
- 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:f470f4fc8ed75dc089afdd392d463470e34b09bb93c0095325cbd081f22ef8d1
Referência nesta versão
oci://hub.aggrega.ai/component/core/ai-agent/openai-agents-sdk:1.0.0Parâmetros do programador
Valores que o programador define no Aggregate.
Estende BaseComponents#/schemas/BaseAgentParameter
| Nome | Tipo | Predefinição | Obrigatório | Descrição |
|---|---|---|---|---|
| upload_traces_to_openai | boolean | false | não | 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. |
Dimensionamento do operador
Dimensionamento da infraestrutura que o operador ajusta por ambiente.
| Nome | Tipo | Predefinição | Obrigatório | Descrição |
|---|---|---|---|---|
| image | string | — | não | Container image running the application built on the OpenAI Agents SDK. |
Contrato de saída
Valores que este componente publica para os consumidores através da topologia uses.
Nenhum valor de saída declarado.
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.
model
- Seletor
- component.aggrega.ai/category in (ai-model, gateway), model.aggrega.ai/api=openai
- Injeção
- env, file
Slots que cada ligação através deste socket pode preencher
| Slot | Seletor | Obrigatório | Injeção | Sensível | Descrição |
|---|---|---|---|---|---|
| credential | feature.aggrega.ai/kind=secret | não | env | sim | 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
- Seletor
- component.aggrega.ai/category=ai-tool, tool.aggrega.ai/transport=http
- Injeção
- env, file
Slots que cada ligação através deste socket pode preencher
| Slot | Seletor | Obrigatório | Injeção | Sensível | Descrição |
|---|---|---|---|---|---|
| credential | feature.aggrega.ai/kind=secret | não | env | sim | 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 | não | env | sim | 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. |
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
- usausa o socket «model»
component.aggrega.ai/category in (ai-model, gateway), model.aggrega.ai/api=openai
Slots de acoplamento: 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 → - usausa o socket «tools»
component.aggrega.ai/category=ai-tool, tool.aggrega.ai/transport=http
Slots de acoplamento: credential, endpoint
- $refestende o esquema (values)
BaseComponents#/schemas/BaseAgentParameter
Usado por
usa o socket «runner»
usa o socket «api»
usa o socket «runner»
usa o socket «api»
usa o socket «services»
usa o socket «api»
usa o socket «services»
usa o socket «services»
usa o socket «sandbox»
usa o socket «plugin_daemon»
usa o socket «ssrf_proxy»
usa o socket «sandbox»
usa o socket «plugin_daemon»
usa o socket «ssrf_proxy»
usa o socket «api»
usa o socket «ssrf_proxy»
usa o socket «api»
usa o socket «api»
usa o socket «sandbox»
usa o socket «plugin_daemon»
usa o socket «ssrf_proxy»
usa o socket «sandbox»
usa o socket «plugin_daemon»
usa o socket «ssrf_proxy»
usa o socket «target_agent»
usa o socket «scrape_target»
aplica-se a
aplica-se a
aplica-se a
implementa
implementa