{"id":24055725,"url":"https://github.com/openai/openai-structured-outputs-samples","last_synced_at":"2025-05-15T17:04:59.083Z","repository":{"id":271266715,"uuid":"903991057","full_name":"openai/openai-structured-outputs-samples","owner":"openai","description":"Sample apps to help developers get started with Structured Outputs","archived":false,"fork":false,"pushed_at":"2025-01-10T16:37:50.000Z","size":8674,"stargazers_count":623,"open_issues_count":0,"forks_count":59,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-07T23:03:47.273Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/openai.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-12-16T03:25:29.000Z","updated_at":"2025-04-02T08:36:49.000Z","dependencies_parsed_at":null,"dependency_job_id":"d7554507-2d98-47f7-8d71-a1d3219ccb19","html_url":"https://github.com/openai/openai-structured-outputs-samples","commit_stats":null,"previous_names":["openai/openai-structured-outputs-samples"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openai%2Fopenai-structured-outputs-samples","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openai%2Fopenai-structured-outputs-samples/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openai%2Fopenai-structured-outputs-samples/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openai%2Fopenai-structured-outputs-samples/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/openai","download_url":"https://codeload.github.com/openai/openai-structured-outputs-samples/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254384987,"owners_count":22062422,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-01-09T04:30:14.067Z","updated_at":"2025-05-15T17:04:54.069Z","avatar_url":"https://github.com/openai.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Structured Outputs Sample Apps\n\n[![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)\n![NextJS](https://img.shields.io/badge/Built_with-NextJS-blue)\n![OpenAI API](https://img.shields.io/badge/Powered_by-OpenAI_API-orange)\n\nStructured Outputs is an OpenAI API feature that ensures responses and tool calls adhere to a defined JSON schema.\nThis makes building with our models more reliable, bridging the gap between unpredictable model outputs and deterministic workflows.\n\nThis repository contains a collection of sample apps showcasing the use of [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs).\n\nEach app demonstrates practical ways to leverage this feature to build applications with NextJS.\n\n---\n\n## Table of Contents\n\n1. [How to Use](#how-to-use)\n2. [Sample Apps](#sample-apps)\n3. [Resources](#resources)\n4. [Contributing](#contributing)\n5. [License](#license)\n\n---\n\n## How to use\n\n1. **Set Up the OpenAI API:**\n\n   - If you're new to the OpenAI API, [sign up for an account](https://platform.openai.com/signup).\n   - Follow the [Quickstart](https://platform.openai.com/docs/quickstart) to retrieve your API key.\n\n2. **Clone the Repository:**\n\n   ```bash\n   git clone https://github.com/openai/structured-outputs-samples.git\n   ```\n\n3. **Try a sample App:**\n\n   - Navigate to the sample app you want to try (`cd /\u003capp_folder\u003e`)\n   - Refer to the README of the app to run it locally.\n\n4. **Make it your own**\n\n   Explore the code, update it, and use it in your own projects or as a starting point!\n\n## Sample Apps\n\nThere are three sample apps in this repository:\n\n### [Resume Extraction](resume-extraction/README.md)\n\nThis app is a simple example of how to use Structured Outputs in model responses to display information in a structured format.\n\n![Resume Extraction Demo](./resume-extraction/public/screenshot.jpg)\n\n### [Generative UI](generative-ui/README.md)\n\nThis app focuses on generating UI components on the fly with Structured Outputs.\n\n![Generative UI Demo](./generative-ui/public/screenshot.jpg)\n\n### [Conversational Assistant](conversational-assistant/README.md)\n\nThis app is a more complex example that combines multi-turn conversations, tool calling and generative UI.\nYou can use this as a starting point to build an assistant with reliable workflows.\n\n![Conversational Assistant Demo](./conversational-assistant/public/screenshot.jpg)\n\n## Resources\n\n- To learn more about Structured Outputs, refer to the [Structured Outputs documentation](https://platform.openai.com/docs/guides/structured-outputs).\n\n- To learn about Function Calling, refer to the [Function Calling documentation](https://platform.openai.com/docs/guides/function-calling).\n\n- 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.\n\n## Contributing\n\nYou are welcome to open issues or submit PRs to improve this app, however, please note that we may not review all suggestions.\n\n## License\n\nThis project is licensed under the MIT License. See the LICENSE file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenai%2Fopenai-structured-outputs-samples","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenai%2Fopenai-structured-outputs-samples","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenai%2Fopenai-structured-outputs-samples/lists"}