{"id":15427583,"url":"https://github.com/codingshot/rfp-ai-structured","last_synced_at":"2026-01-07T02:41:01.669Z","repository":{"id":255307450,"uuid":"849184132","full_name":"codingshot/rfp-ai-structured","owner":"codingshot","description":"Takes prompt in script. Structures output based on markdown template. ","archived":false,"fork":false,"pushed_at":"2024-08-29T06:56:26.000Z","size":8,"stargazers_count":0,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-02T05:44:44.668Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","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/codingshot.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-08-29T06:07:41.000Z","updated_at":"2024-08-29T06:56:29.000Z","dependencies_parsed_at":null,"dependency_job_id":"8dd168f3-1439-4aae-8191-1d6e51e7f59a","html_url":"https://github.com/codingshot/rfp-ai-structured","commit_stats":null,"previous_names":["codingshot/rfp-ai-structured"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codingshot%2Frfp-ai-structured","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codingshot%2Frfp-ai-structured/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codingshot%2Frfp-ai-structured/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codingshot%2Frfp-ai-structured/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/codingshot","download_url":"https://codeload.github.com/codingshot/rfp-ai-structured/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245972671,"owners_count":20702721,"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":"2024-10-01T18:00:53.492Z","updated_at":"2026-01-07T02:41:01.625Z","avatar_url":"https://github.com/codingshot.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"![image](https://github.com/user-attachments/assets/2269a3c8-920c-4ca5-a03a-9000245b8c8f)\n\nUsing Open Ai Structured Output using Markdown templates  to write RFPs\n\nCertainly! Here is a more specific example of what you might include in the `.env`, `.env.example`, and README files for the script that uses OpenAI's API to generate structured responses from a markdown template.\n\n### **`.env` File**\n\nThis file contains sensitive information and should not be committed to version control. It includes your OpenAI API key and any other configuration settings needed for the script to function.\n\n```plaintext\nOPENAI_API_KEY=your_openai_api_key_here\n```\n\n### **`.env.example` File**\n\nThis file serves as a template to show other developers what environment variables are required. It should be included in version control.\n\n```plaintext\nOPENAI_API_KEY=\n```\n\n### **README.md**\n\nHere's a README file tailored to the script described earlier:\n\n```markdown\n# Markdown Template Processor\n\nThis script processes markdown templates using OpenAI's Structured Output API to generate structured responses.\n\n## Table of Contents\n- [Installation](#installation)\n- [Usage](#usage)\n- [Environment Variables](#environment-variables)\n- [Contributing](#contributing)\n- [License](#license)\n\n## Installation\n\n1. **Clone the Repository**:\n   ```bash\n   git clone https://github.com/codingshot/rfp-ai-structured/.git\n   cd rfp-ai-structured\n   ```\n\n2. **Install Dependencies**:\n   Ensure you have Python installed. Then, install the required packages:\n   ```bash\n   pip install openai pydantic\n   ```\n\n3. **Set Up Environment Variables**:\n   - Copy the `.env.example` file to `.env`:\n     ```bash\n     cp .env.example .env\n     ```\n   - Fill in the `OPENAI_API_KEY` in the `.env` file.\n\n## Usage\n\nRun the script to process a markdown template:\n\n```bash\npython markdowntostructured.py\n```\n\n- **Markdown Template**: Modify the `markdown_template` variable in the script to change the input markdown.\n- **Response**: The script will output the structured response according to the defined schema.\n\n## Environment Variables\n\nThe script requires the following environment variables:\n\n- `OPENAI_API_KEY`: Your OpenAI API key. This is required to authenticate requests to the OpenAI API.\n\n\n# About Open AI Structured Outputs\nOpenAI's Structured Outputs feature allows developers to ensure that model-generated responses adhere to a predefined JSON schema. This capability enhances the reliability and usability of AI-generated content by guaranteeing that outputs conform to specific structural requirements, addressing common challenges in AI-powered applications.\n\nAPI Integration: Structured Outputs can be used via the OpenAI API by specifying the response_format parameter with your defined schema. This ensures that the model's output will conform to the schem\n\nhttps://blog.mlq.ai/structured-outputs-openai/\n\n## Contributing\n\n1. Fork the repository.\n2. Create a new branch (`git checkout -b feature-branch`).\n3. Commit your changes (`git commit -m 'Add new feature'`).\n4. Push to the branch (`git push origin feature-branch`).\n5. Open a pull request.\n\n## License\n\nThis project is licensed under the MIT License.\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodingshot%2Frfp-ai-structured","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcodingshot%2Frfp-ai-structured","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodingshot%2Frfp-ai-structured/lists"}