Cette page a été traduite automatiquement. Lire l’original en anglais.

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.

Provenance

OfficielSigné par une identité de signature que ce catalogue reconnaît comme éditeur officiel.
Empreinte du contenu
sha256:5232196409373c4428858df9231c3a4b20bc092234c779f25d696ff90e0399e2
Publié
2026-11-10T10:08:34Z
Identité de signature
https://token.actions.githubusercontent.com/https://github.com/aggrega-ai/aggrega-hub/.github/workflows/catalog-publish-sign.yml@refs/heads/main

Signature

  • Officielapplication/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

Référence à cette version

oci://hub.aggrega.ai/component/core/ai-agent/openai-agents-sdk:1.0.0

Paramètres du développeur

Valeurs que le développeur définit dans l’Aggregate.

Étend BaseComponents#/schemas/BaseAgentParameter

NomTypeValeur par défautObligatoireDescription
upload_traces_to_openaibooleanfalsenonWhether 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.

Dimensionnement de l’opérateur

Dimensionnement de l’infrastructure que l’opérateur ajuste pour chaque environnement.

NomTypeValeur par défautObligatoireDescription
imagestring—nonContainer image running the application built on the OpenAI Agents SDK.

Contrat de sortie

Valeurs que ce composant publie vers les consommateurs via la topologie uses.

Aucune valeur de sortie déclarée.

Sockets uses

Les sockets de dépendance par lesquels ce composant se connecte. La cible de chaque connexion câblée via un socket doit satisfaire son sélecteur d’étiquettes, et chaque connexion peut porter une attache dans les emplacements que le socket déclare. Un emplacement obligatoire doit être rempli par chaque connexion que l’Aggregate ou la Release câble via le socket.

model

Sélecteur
component.aggrega.ai/category in (ai-model, gateway), model.aggrega.ai/api=openai
Injection
env, file

Emplacements que chaque connexion passant par ce socket peut remplir

EmplacementSélecteurObligatoireInjectionSensibleDescription
credentialfeature.aggrega.ai/kind=secretnonenvouiOptional 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

Sélecteur
component.aggrega.ai/category=ai-tool, tool.aggrega.ai/transport=http
Injection
env, file

Emplacements que chaque connexion passant par ce socket peut remplir

EmplacementSélecteurObligatoireInjectionSensibleDescription
credentialfeature.aggrega.ai/kind=secretnonenvouiOptional 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.
endpointfeature.aggrega.ai/kind=secretnonenvouiOptional 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.

Emplacements d’attache

Points de liaison nommés auxquels une Feature s’attache à ce composant. Le sélecteur d’un emplacement restreint la Feature qui peut le remplir, et sa liste inject indique comment le matériel de la Feature peut être livré. Un emplacement obligatoire doit être lié sur chaque instance, par une attache sur l’instance ou à une portée supérieure, et un emplacement sensible est déclaré pour traiter du matériel secret. Une Feature peut aussi s’attacher sous un nom qu’aucun emplacement ne déclare.

Aucun emplacement d’attache déclaré.

Liste d’autorisation d’auto-injection

env, file

Relations

Arêtes typées vers et depuis d’autres entités publiées. Une référence sans cible publiée s’affiche comme une arête rompue plutôt que comme un lien.

Utilise

Utilisé par

Référence du concept Component →

Le catalogue Aggrega — un index ouvert de composants, de fonctionnalités, de recettes et des plugins qui en assurent le rendu.

Conçu avec le système de design partagé d’Aggrega.

Confidentialité