https://github.com/openai/openai-structured-outputs-samples

Sample apps to help developers get started with Structured Outputs
https://github.com/openai/openai-structured-outputs-samples

Last synced: 7 months ago
JSON representation

Sample apps to help developers get started with Structured Outputs

• Host: GitHub
• URL: https://github.com/openai/openai-structured-outputs-samples
• Owner: openai
• License: mit
• Created: 2024-12-16T03:25:29.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2025-01-10T16:37:50.000Z (12 months ago)
• Last Synced: 2025-04-07T23:03:47.273Z (9 months ago)
• Language: TypeScript
• Size: 8.27 MB
• Stars: 623
• Watchers: 3
• Forks: 59
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Structured Outputs Sample Apps

[![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)

![NextJS](https://img.shields.io/badge/Built_with-NextJS-blue)

![OpenAI API](https://img.shields.io/badge/Powered_by-OpenAI_API-orange)

Structured Outputs is an OpenAI API feature that ensures responses and tool calls adhere to a defined JSON schema.

This makes building with our models more reliable, bridging the gap between unpredictable model outputs and deterministic workflows.

This repository contains a collection of sample apps showcasing the use of [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs).

Each app demonstrates practical ways to leverage this feature to build applications with NextJS.

---

## Table of Contents

1. [How to Use](#how-to-use)

2. [Sample Apps](#sample-apps)

3. [Resources](#resources)

4. [Contributing](#contributing)

5. [License](#license)

---

## How to use

1. **Set Up the OpenAI API:**

   - If you're new to the OpenAI API, [sign up for an account](https://platform.openai.com/signup).

   - Follow the [Quickstart](https://platform.openai.com/docs/quickstart) to retrieve your API key.

2. **Clone the Repository:**

   ```bash

   git clone https://github.com/openai/structured-outputs-samples.git

   ```

3. **Try a sample App:**

   - Navigate to the sample app you want to try (`cd /`)

   - Refer to the README of the app to run it locally.

4. **Make it your own**

   Explore the code, update it, and use it in your own projects or as a starting point!

## Sample Apps

There are three sample apps in this repository:

### [Resume Extraction](resume-extraction/README.md)

This app is a simple example of how to use Structured Outputs in model responses to display information in a structured format.

![Resume Extraction Demo](./resume-extraction/public/screenshot.jpg)

### [Generative UI](generative-ui/README.md)

This app focuses on generating UI components on the fly with Structured Outputs.

![Generative UI Demo](./generative-ui/public/screenshot.jpg)

### [Conversational Assistant](conversational-assistant/README.md)

This app is a more complex example that combines multi-turn conversations, tool calling and generative UI.

You can use this as a starting point to build an assistant with reliable workflows.

![Conversational Assistant Demo](./conversational-assistant/public/screenshot.jpg)

## Resources

- To learn more about Structured Outputs, refer to the [Structured Outputs documentation](https://platform.openai.com/docs/guides/structured-outputs).

- To learn about Function Calling, refer to the [Function Calling documentation](https://platform.openai.com/docs/guides/function-calling).

- Try the [Introduction to Structured Outputs](https://cookbook.openai.com/examples/structured_outputs_intro) cookbook to get hands-on and run code snippets in Python.

## Contributing

You are welcome to open issues or submit PRs to improve this app, however, please note that we may not review all suggestions.

## License

This project is licensed under the MIT License. See the LICENSE file for details.