{"id":16328681,"url":"https://github.com/XpressAI/xai-openai","last_synced_at":"2025-10-25T21:30:29.809Z","repository":{"id":154621916,"uuid":"627720689","full_name":"XpressAI/xai-openai","owner":"XpressAI","description":"OpenAI components for Xircuits","archived":false,"fork":false,"pushed_at":"2024-12-27T15:51:51.000Z","size":52,"stargazers_count":3,"open_issues_count":1,"forks_count":3,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-12-27T16:32:53.274Z","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/XpressAI.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":"2023-04-14T03:54:54.000Z","updated_at":"2024-12-20T12:42:49.000Z","dependencies_parsed_at":"2024-03-08T08:26:06.686Z","dependency_job_id":"8d4442fd-378a-43b8-9711-5610761821e5","html_url":"https://github.com/XpressAI/xai-openai","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/XpressAI%2Fxai-openai","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/XpressAI%2Fxai-openai/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/XpressAI%2Fxai-openai/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/XpressAI%2Fxai-openai/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/XpressAI","download_url":"https://codeload.github.com/XpressAI/xai-openai/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238212319,"owners_count":19434942,"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-10T23:14:27.882Z","updated_at":"2025-10-25T21:30:29.804Z","avatar_url":"https://github.com/XpressAI.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/XpressAI/xircuits/tree/master/xai_components#xircuits-component-library-list\"\u003eComponent Libraries\u003c/a\u003e •\n  \u003ca href=\"https://github.com/XpressAI/xircuits/tree/master/project-templates#xircuits-project-templates-list\"\u003eProject Templates\u003c/a\u003e\n  \u003cbr\u003e\n  \u003ca href=\"https://xircuits.io/\"\u003eDocs\u003c/a\u003e •\n  \u003ca href=\"https://xircuits.io/docs/Installation\"\u003eInstall\u003c/a\u003e •\n  \u003ca href=\"https://xircuits.io/docs/category/tutorials\"\u003eTutorials\u003c/a\u003e •\n  \u003ca href=\"https://xircuits.io/docs/category/developer-guide\"\u003eDeveloper Guides\u003c/a\u003e •\n  \u003ca href=\"https://github.com/XpressAI/xircuits/blob/master/CONTRIBUTING.md\"\u003eContribute\u003c/a\u003e •\n  \u003ca href=\"https://www.xpress.ai/blog/\"\u003eBlog\u003c/a\u003e •\n  \u003ca href=\"https://discord.com/invite/vgEg2ZtxCw\"\u003eDiscord\u003c/a\u003e\n\u003c/p\u003e\n\n\n\n\n\n\u003cp align=\"center\"\u003e\u003ci\u003eXircuits Library for OpenAI: Seamlessly integrate AI to build and deploy intelligent solutions effortlessly.\u003c/i\u003e\u003c/p\u003e\n\n\n---\n\n### Xircuits Component Library for OpenAI\n\nThis library connects OpenAI's models with Xircuits, making it easy to use features like text generation, image creation, and AI conversations.\n## Table of Contents\n\n- [Preview](#preview)\n- [Prerequisites](#prerequisites)\n- [Main Xircuits Components](#main-xircuits-components)\n- [Try the Examples](#try-the-examples)\n- [Installation](#installation)\n\n## Preview\n\n### The Example:\n\n![openai_sample](https://github.com/user-attachments/assets/1b557501-47e7-40fe-8152-65ea5e74694d)\n\n\n### The Result\n\n\u003cimg src=\"https://github.com/user-attachments/assets/d4b865b2-a37c-402e-8080-bb33f103453d\" alt=\"openai_sample_result\" /\u003e\n\n## Prerequisites\n\nBefore you begin, you will need the following:\n\n1. Python3.9+.\n2. Xircuits.\n\n## Main Xircuits Components\n\n### OpenAIAuthorize Component:\n\nSets the API key and organization for OpenAI, enabling access to its models.\n\n\u003cimg src=\"https://github.com/user-attachments/assets/fed4ddb7-f751-4497-9c9c-d229c0aea1a4\" alt=\"OpenAIAuthorize\" width=\"200\" height=\"150\" /\u003e\n\n### OpenAIGenerate Component:\n\nCreates text completions using an OpenAI model, with adjustable parameters.\n\n\u003cimg src=\"https://github.com/user-attachments/assets/889ddfbc-b62f-45d3-bade-ddb13505fc0d\" alt=\"OpenAIGenerate\" width=\"200\" height=\"150\" /\u003e\n\n### OpenAIChat Component:\n\nConducts conversations with OpenAI models, maintaining conversation history.\n\n\u003cimg src=\"https://github.com/user-attachments/assets/692e8620-8b52-42ab-8bb7-c3467c94b710\" alt=\"OpenAIChat\" width=\"200\" height=\"200\" /\u003e\n\n### OpenAIGetModels Component:\n\nFetches a list of available OpenAI models for use in workflows.\n\n### OpenAIGetModel Component:\n\nRetrieves detailed information about a specific OpenAI model.\n\n### OpenAIEdit Component:\n\nEdits input text based on specific instructions provided.\n\n### OpenAIImageCreate Component:\n\nGenerates images from text prompts using OpenAI's image models. Supports both DALL-E 2 and DALL-E 3.\n\n### OpenAIImageCreateVariation Component:\n\nCreates alternate versions of an input image using OpenAI's variation tools.\n\n### OpenAIImageEdit Component:\n\nModifies an input image based on a text prompt or a mask.\n\n### OpenAIImageInference Component:\n\nAnalyzes images using OpenAI's vision capabilities, providing text descriptions or answers to questions about images.\n\n### OpenAIAudioTranscription Component:\n\nTranscribes audio files to text using OpenAI's Whisper models.\n\n### OpenAIAudioTranslation Component:\n\nTranslates audio in any language to English text using OpenAI's Whisper models.\n\n### OpenAISpeechGeneration Component:\n\nConverts text to spoken audio using OpenAI's text-to-speech models.\n\n## Try the Examples\n\nWe have provided an example workflow to help you get started with the OpenAI component library. Give it a try and see how you can create custom OpenAI components for your applications.\n\n### OpenAI Sample\n\nThis example authorizes OpenAI access using an API key and retrieves the list of available models. The models are then printed to the console.\n\n## Installation\nTo use this component library, ensure that you have an existing [Xircuits setup](https://xircuits.io/docs/main/Installation). You can then install the OpenAI library using the [component library interface](https://xircuits.io/docs/component-library/installation#installation-using-the-xircuits-library-interface), or through the CLI using:\n\n```\nxircuits install openai\n```\nYou can also do it manually by cloning and installing it:\n```\n# base Xircuits directory  \ngit clone https://github.com/XpressAI/xai-openai xai_components/xai_openai  \npip install -r xai_components/xai_openai/requirements.txt  \n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FXpressAI%2Fxai-openai","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FXpressAI%2Fxai-openai","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FXpressAI%2Fxai-openai/lists"}