From c2e030c59f3b2981800bd943cdde2876e5d6a16f Mon Sep 17 00:00:00 2001 From: D-K-P <8297864+D-K-P@users.noreply.github.com> Date: Wed, 25 Jun 2025 13:06:44 +0100 Subject: [PATCH 1/3] Added openai agents sdk typescript playground docs and updated guardrails --- docs/docs.json | 20 +++--- .../openai-agent-sdk-guardrails.mdx | 11 ++- ...penai-agents-sdk-typescript-playground.mdx | 72 +++++++++++++++++++ docs/guides/introduction.mdx | 25 +++---- 4 files changed, 101 insertions(+), 27 deletions(-) create mode 100644 docs/guides/example-projects/openai-agents-sdk-typescript-playground.mdx diff --git a/docs/docs.json b/docs/docs.json index 88b0d12a1d..0e953788c0 100644 --- a/docs/docs.json +++ b/docs/docs.json @@ -325,15 +325,7 @@ } ] }, - { - "group": "Python guides", - "pages": [ - "guides/python/python-image-processing", - "guides/python/python-doc-to-markdown", - "guides/python/python-crawl4ai", - "guides/python/python-pdf-form-extractor" - ] - }, + { "group": "Example projects", "pages": [ @@ -342,6 +334,7 @@ "guides/example-projects/human-in-the-loop-workflow", "guides/example-projects/meme-generator-human-in-the-loop", "guides/example-projects/openai-agent-sdk-guardrails", + "guides/example-projects/openai-agents-sdk-typescript-playground", "guides/example-projects/realtime-csv-importer", "guides/example-projects/realtime-fal-ai", "guides/example-projects/turborepo-monorepo-prisma", @@ -349,6 +342,15 @@ "guides/example-projects/vercel-ai-sdk-image-generator" ] }, + { + "group": "Python guides", + "pages": [ + "guides/python/python-image-processing", + "guides/python/python-doc-to-markdown", + "guides/python/python-crawl4ai", + "guides/python/python-pdf-form-extractor" + ] + }, { "group": "Example tasks", "pages": [ diff --git a/docs/guides/example-projects/openai-agent-sdk-guardrails.mdx b/docs/guides/example-projects/openai-agent-sdk-guardrails.mdx index 7e1305e79d..a8bbf94af1 100644 --- a/docs/guides/example-projects/openai-agent-sdk-guardrails.mdx +++ b/docs/guides/example-projects/openai-agent-sdk-guardrails.mdx @@ -1,19 +1,18 @@ --- -title: "OpenAI Agent SDK guardrails examples" -sidebarTitle: "OpenAI Agent SDK guardrails" -description: "This example project demonstrates how to implement different types of guardrails using the OpenAI Agent SDK with Trigger.dev for AI safety and control." +title: "OpenAI Agents SDK for Python guardrails" +sidebarTitle: "OpenAI Agents SDK for Python guardrails" +description: "This example project demonstrates how to implement different types of guardrails using the OpenAI Agent SDK for Python with Trigger.dev." --- import RealtimeLearnMore from "/snippets/realtime-learn-more.mdx"; -The OpenAI Agent SDK is a Python library. - ## Overview This demo is a practical guide that demonstrates: - **Three types of AI guardrails**: Input validation, output checking, and real-time streaming monitoring -- Integration of the [OpenAI Agent SDK](https://openai.github.io/openai-agents-python/) with [Trigger.dev](https://trigger.dev) for production AI workflows +- Integration of the [OpenAI Agent SDK for Python](https://openai.github.io/openai-agents-python/) with [Trigger.dev](https://trigger.dev) for production AI workflows +- Triggering Python scripts from tasks using our [Python build extension](/config/extensions/pythonExtension) - **Educational examples** of implementing guardrails for AI safety and control mechanisms - Real-world scenarios like math tutoring agents with content validation and complexity monitoring diff --git a/docs/guides/example-projects/openai-agents-sdk-typescript-playground.mdx b/docs/guides/example-projects/openai-agents-sdk-typescript-playground.mdx new file mode 100644 index 0000000000..b6bfa6a967 --- /dev/null +++ b/docs/guides/example-projects/openai-agents-sdk-typescript-playground.mdx @@ -0,0 +1,72 @@ +--- +title: "OpenAI Agents SDK for Typescript + Trigger.dev playground" +sidebarTitle: "OpenAI Agents SDK for Typescript playground" +description: "Build production-ready AI agents with OpenAI Agents SDK for Typescript and Trigger.dev. Explore 7 examples covering streaming, multi-agent systems, and tool integration." +tag: "v4" +--- + +import RealtimeLearnMore from "/snippets/realtime-learn-more.mdx"; + + + This is a v4 project. If you are using v3 and want to upgrade, please refer to our [v4 upgrade + guide](/docs/v4-upgrade-guide). + + +## Overview + +7 production-ready patterns built with the OpenAI Agents SDK and Trigger.dev. Clone this repo to experiment with everything from basic calls to workflows with tools, streaming, guardrails, handoffs, and more. + +By combining the OpenAI Agents SDK with Trigger.dev, you can create durable agents that can be deployed to production and scaled to any size, with retries, queues, and full observability built-in. + +## Video + + + +## Tech stack + +- [Node.js](https://nodejs.org) runtime environment +- [OpenAI Agents SDK for Typescript](https://openai.github.io/openai-agents-js/) for creating and managing AI agents +- [Trigger.dev](https://trigger.dev) for task orchestration, batching, scheduling, and workflow management +- [Zod](https://zod.dev) for payload validation + +## GitHub repo + + + Click here to view the full code for this project in our examples repository on GitHub. You can + fork it and use it as a starting point for your own project. + + +## Agent tasks + +- **Basic Agent Chat**: Personality-based conversations with strategic model selection +- **Agent with Tools**: A simple agent that can call tools to get weather data +- **Streaming Agent**: Real-time content generation with progress tracking +- **Agent Handoffs**: True multi-agent collaboration using the [handoff pattern](https://openai.github.io/openai-agents-js/guides/handoffs/) where agents can dynamically transfer control to specialists +- **Parallel Agents**: Concurrent agent processing for complex analysis tasks +- **Scheduled Agent**: Time-based agent workflows for continuous monitoring +- **Agent with Guardrails**: Input guardrails for safe AI interactions + +## Relevant code + +- **[basicAgentChat.ts](https://github.com/triggerdotdev/examples/blob/main/openai-agents-sdk-with-trigger-playground/src/trigger/basicAgentChat.ts)** - Strategic model selection (GPT-4, o1-preview, o1-mini, gpt-4o-mini) mapped to personality types with Trigger.dev task orchestration +- **[agentWithTools.ts](https://github.com/triggerdotdev/examples/blob/main/openai-agents-sdk-with-trigger-playground/src/trigger/agentWithTools.ts)** - OpenAI tool calling with Zod validation integrated into Trigger.dev's retry and error handling mechanisms +- **[streamingAgent.ts](https://github.com/triggerdotdev/examples/blob/main/openai-agents-sdk-with-trigger-playground/src/trigger/streamingAgent.ts)** - Native OpenAI streaming responses with real-time progress tracking via Trigger.dev metadata +- **[scheduledAgent.ts](https://github.com/triggerdotdev/examples/blob/main/openai-agents-sdk-with-trigger-playground/src/trigger/scheduledAgent.ts)** - Cron-scheduled OpenAI agents running every 6 hours with automatic trend analysis +- **[parallelAgents.ts](https://github.com/triggerdotdev/examples/blob/main/openai-agents-sdk-with-trigger-playground/src/trigger/parallelAgents.ts)** - Concurrent OpenAI agent execution using Trigger.dev batch operations (`batch.triggerByTaskAndWait`) for scalable text analysis +- **[agentWithGuardrails.ts](https://github.com/triggerdotdev/examples/blob/main/openai-agents-sdk-with-trigger-playground/src/trigger/agentWithGuardrails.ts)** - OpenAI classification agents as input guardrails with structured validation and exception handling +- **[agentHandoff.ts](https://github.com/triggerdotdev/examples/blob/main/openai-agents-sdk-with-trigger-playground/src/trigger/agentHandoff.ts)** - OpenAI Agents SDK handoff pattern with specialist delegation orchestrated through Trigger.dev workflows + +## Learn more + +- [OpenAI Agents SDK docs](https://openai.github.io/openai-agents-js/) - learn about creating and managing AI agents +- [OpenAI Agents SDK handoffs](https://openai.github.io/openai-agents-js/guides/handoffs/) - learn about agent-to-agent delegation patterns +- [Batch triggering](/triggering#batch-trigger) - learn about parallel task execution +- [Scheduled tasks (cron)](/tasks/scheduled#scheduled-tasks-cron) - learn about cron-based task scheduling diff --git a/docs/guides/introduction.mdx b/docs/guides/introduction.mdx index 3fba744586..51fb6a8f97 100644 --- a/docs/guides/introduction.mdx +++ b/docs/guides/introduction.mdx @@ -43,18 +43,19 @@ Get set up fast using our detailed walk-through guides. Example projects are full projects with example repos you can fork and use. These are a great way of learning how to encorporate Trigger.dev into your project. -| Example project | Description | Framework | GitHub | -| :---------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------- | :-------- | :------------------------------------------------------------------------------------------------------------ | -| [Batch LLM Evaluator](/guides/example-projects/batch-llm-evaluator) | Evaluate multiple LLM models and stream the results to the frontend. | Next.js | [View the repo](https://github.com/triggerdotdev/examples/tree/main/batch-llm-evaluator) | -| [Claude thinking chatbot](/guides/example-projects/claude-thinking-chatbot) | Use Vercel's AI SDK and Anthropic's Claude 3.7 model to create a thinking chatbot. | Next.js | [View the repo](https://github.com/triggerdotdev/examples/tree/main/claude-thinking-chatbot) | -| [Human-in-the-loop workflow](/guides/example-projects/human-in-the-loop-workflow) | Create audio summaries of newspaper articles using a human-in-the-loop workflow built with ReactFlow and Trigger.dev waitpoint tokens. | Next.js | [View the repo](https://github.com/triggerdotdev/examples/tree/main/article-summary-workflow) | -| [OpenAI Agent SDK guardrails](/guides/example-projects/openai-agent-sdk-guardrails) | Use the OpenAI Agent SDK to create a guardrails system for your AI agents. | — | [View the repo](https://github.com/triggerdotdev/examples/tree/main/openai-agent-sdk-guardrails-examples) | -| [Python web crawler](/guides/python/python-crawl4ai) | Use Python, Crawl4AI and Playwright to create a headless web crawler with Trigger.dev. | — | [View the repo](https://github.com/triggerdotdev/examples/tree/main/python-crawl4ai) | -| [Realtime CSV Importer](/guides/example-projects/realtime-csv-importer) | Upload a CSV file and see the progress of the task streamed to the frontend. | Next.js | [View the repo](https://github.com/triggerdotdev/examples/tree/main/realtime-csv-importer) | -| [Realtime Fal.ai image generation](/guides/example-projects/realtime-fal-ai) | Generate an image from a prompt using Fal.ai and show the progress of the task on the frontend using Realtime. | Next.js | [View the repo](https://github.com/triggerdotdev/examples/tree/main/realtime-fal-ai-image-generation) | -| [Turborepo monorepo with Prisma](/guides/example-projects/turborepo-monorepo-prisma) | Use Prisma in a Turborepo monorepo with Trigger.dev. | Next.js | [View the repo](https://github.com/triggerdotdev/examples/tree/main/monorepos/turborepo-prisma-tasks-package) | -| [Vercel AI SDK image generator](/guides/example-projects/vercel-ai-sdk-image-generator) | Use the Vercel AI SDK to generate images from a prompt. | Next.js | [View the repo](https://github.com/triggerdotdev/examples/tree/main/vercel-ai-sdk-image-generator) | -| [Vercel AI SDK deep research agent](/guides/example-projects/vercel-ai-sdk-deep-research) | Use the Vercel AI SDK to generate comprehensive PDF reports using a deep research agent. | Next.js | [View the repo](https://github.com/triggerdotdev/examples/tree/main/vercel-ai-sdk-deep-research-agent) | +| Example project | Description | Framework | GitHub | +| :-------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------- | :-------- | :------------------------------------------------------------------------------------------------------------- | +| [Batch LLM Evaluator](/guides/example-projects/batch-llm-evaluator) | Evaluate multiple LLM models and stream the results to the frontend. | Next.js | [View the repo](https://github.com/triggerdotdev/examples/tree/main/batch-llm-evaluator) | +| [Claude thinking chatbot](/guides/example-projects/claude-thinking-chatbot) | Use Vercel's AI SDK and Anthropic's Claude 3.7 model to create a thinking chatbot. | Next.js | [View the repo](https://github.com/triggerdotdev/examples/tree/main/claude-thinking-chatbot) | +| [Human-in-the-loop workflow](/guides/example-projects/human-in-the-loop-workflow) | Create audio summaries of newspaper articles using a human-in-the-loop workflow built with ReactFlow and Trigger.dev waitpoint tokens. | Next.js | [View the repo](https://github.com/triggerdotdev/examples/tree/main/article-summary-workflow) | +| [OpenAI Agents SDK for Python guardrails](/guides/example-projects/openai-agent-sdk-guardrails) | Use the OpenAI Agents SDK for Python to create a guardrails system for your AI agents. | — | [View the repo](https://github.com/triggerdotdev/examples/tree/main/openai-agent-sdk-guardrails-examples) | +| [OpenAI Agents SDK for TypeScript playground](/guides/example-projects/openai-agents-sdk-typescript-playground) | A playground containing 7 AI agents using the OpenAI Agents SDK for TypeScript with Trigger.dev. | — | [View the repo](https://github.com/triggerdotdev/examples/tree/main/openai-agents-sdk-with-trigger-playground) | +| [Python web crawler](/guides/python/python-crawl4ai) | Use Python, Crawl4AI and Playwright to create a headless web crawler with Trigger.dev. | — | [View the repo](https://github.com/triggerdotdev/examples/tree/main/python-crawl4ai) | +| [Realtime CSV Importer](/guides/example-projects/realtime-csv-importer) | Upload a CSV file and see the progress of the task streamed to the frontend. | Next.js | [View the repo](https://github.com/triggerdotdev/examples/tree/main/realtime-csv-importer) | +| [Realtime Fal.ai image generation](/guides/example-projects/realtime-fal-ai) | Generate an image from a prompt using Fal.ai and show the progress of the task on the frontend using Realtime. | Next.js | [View the repo](https://github.com/triggerdotdev/examples/tree/main/realtime-fal-ai-image-generation) | +| [Turborepo monorepo with Prisma](/guides/example-projects/turborepo-monorepo-prisma) | Use Prisma in a Turborepo monorepo with Trigger.dev. | Next.js | [View the repo](https://github.com/triggerdotdev/examples/tree/main/monorepos/turborepo-prisma-tasks-package) | +| [Vercel AI SDK image generator](/guides/example-projects/vercel-ai-sdk-image-generator) | Use the Vercel AI SDK to generate images from a prompt. | Next.js | [View the repo](https://github.com/triggerdotdev/examples/tree/main/vercel-ai-sdk-image-generator) | +| [Vercel AI SDK deep research agent](/guides/example-projects/vercel-ai-sdk-deep-research) | Use the Vercel AI SDK to generate comprehensive PDF reports using a deep research agent. | Next.js | [View the repo](https://github.com/triggerdotdev/examples/tree/main/vercel-ai-sdk-deep-research-agent) | ## Example tasks From 35b9a652645ba52d93e722dae2aa6b3579ad94f3 Mon Sep 17 00:00:00 2001 From: D-K-P <8297864+D-K-P@users.noreply.github.com> Date: Wed, 25 Jun 2025 13:10:34 +0100 Subject: [PATCH 2/3] Removed broken link and import --- .../example-projects/openai-agent-sdk-guardrails.mdx | 2 -- .../openai-agents-sdk-typescript-playground.mdx | 7 ------- 2 files changed, 9 deletions(-) diff --git a/docs/guides/example-projects/openai-agent-sdk-guardrails.mdx b/docs/guides/example-projects/openai-agent-sdk-guardrails.mdx index a8bbf94af1..3d9350e0fe 100644 --- a/docs/guides/example-projects/openai-agent-sdk-guardrails.mdx +++ b/docs/guides/example-projects/openai-agent-sdk-guardrails.mdx @@ -4,8 +4,6 @@ sidebarTitle: "OpenAI Agents SDK for Python guardrails" description: "This example project demonstrates how to implement different types of guardrails using the OpenAI Agent SDK for Python with Trigger.dev." --- -import RealtimeLearnMore from "/snippets/realtime-learn-more.mdx"; - ## Overview This demo is a practical guide that demonstrates: diff --git a/docs/guides/example-projects/openai-agents-sdk-typescript-playground.mdx b/docs/guides/example-projects/openai-agents-sdk-typescript-playground.mdx index b6bfa6a967..531120204a 100644 --- a/docs/guides/example-projects/openai-agents-sdk-typescript-playground.mdx +++ b/docs/guides/example-projects/openai-agents-sdk-typescript-playground.mdx @@ -5,13 +5,6 @@ description: "Build production-ready AI agents with OpenAI Agents SDK for Typesc tag: "v4" --- -import RealtimeLearnMore from "/snippets/realtime-learn-more.mdx"; - - - This is a v4 project. If you are using v3 and want to upgrade, please refer to our [v4 upgrade - guide](/docs/v4-upgrade-guide). - - ## Overview 7 production-ready patterns built with the OpenAI Agents SDK and Trigger.dev. Clone this repo to experiment with everything from basic calls to workflows with tools, streaming, guardrails, handoffs, and more. From 2eedbd3d703513d927fd745097c066e3ff1aa298 Mon Sep 17 00:00:00 2001 From: D-K-P <8297864+D-K-P@users.noreply.github.com> Date: Wed, 25 Jun 2025 13:13:35 +0100 Subject: [PATCH 3/3] Typo fix --- docs/guides/introduction.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guides/introduction.mdx b/docs/guides/introduction.mdx index 51fb6a8f97..c692521216 100644 --- a/docs/guides/introduction.mdx +++ b/docs/guides/introduction.mdx @@ -41,7 +41,7 @@ Get set up fast using our detailed walk-through guides. ## Example projects -Example projects are full projects with example repos you can fork and use. These are a great way of learning how to encorporate Trigger.dev into your project. +Example projects are full projects with example repos you can fork and use. These are a great way of learning how to use Trigger.dev in your projects. | Example project | Description | Framework | GitHub | | :-------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------- | :-------- | :------------------------------------------------------------------------------------------------------------- |