{"id":13655383,"url":"https://github.com/fmanrique8/romeo-gpt","last_synced_at":"2025-04-23T17:30:34.746Z","repository":{"id":153634964,"uuid":"626990692","full_name":"fmanrique8/romeo-gpt","owner":"fmanrique8","description":"Romeo GPT is an AI assistant designed to provide a suite of services which range from document management and analysis to multifaceted AI powered query endpoints.","archived":false,"fork":false,"pushed_at":"2023-06-12T19:28:12.000Z","size":326,"stargazers_count":12,"open_issues_count":1,"forks_count":5,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-08-03T04:05:25.479Z","etag":null,"topics":["fastapi","python","redis"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fmanrique8.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","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},"funding":{"github":"fmanrique8","ko_fi":"ko-fi.com/fmanrique8"}},"created_at":"2023-04-12T15:03:22.000Z","updated_at":"2024-05-14T04:09:41.000Z","dependencies_parsed_at":null,"dependency_job_id":"17d9f091-ec95-4920-a36f-69de9e8038c0","html_url":"https://github.com/fmanrique8/romeo-gpt","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fmanrique8%2Fromeo-gpt","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fmanrique8%2Fromeo-gpt/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fmanrique8%2Fromeo-gpt/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fmanrique8%2Fromeo-gpt/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fmanrique8","download_url":"https://codeload.github.com/fmanrique8/romeo-gpt/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223931461,"owners_count":17227256,"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":["fastapi","python","redis"],"created_at":"2024-08-02T04:00:18.241Z","updated_at":"2024-11-10T08:30:15.861Z","avatar_url":"https://github.com/fmanrique8.png","language":"Python","funding_links":["https://github.com/sponsors/fmanrique8","https://ko-fi.com/ko-fi.com/fmanrique8"],"categories":["Building Applications ([home](#awesome-llm))"],"sub_categories":["Courses"],"readme":"# README.md\n\n## Romeo GPT: AI-Powered Document Analysis and Management\n\nRomeo GPT is an AI assistant designed to provide a suite of services which range from document management and analysis \nto multifaceted AI powered query endpoints. Leveraging FastAPI, Redisearch, and OpenAI's GPT-4, Romeo offers an efficient, \npowerful, and secure platform for diverse tasks such as document processing, vector-related object management, content analysis,\nand dynamic search queries.\n\n## Project Requirements and Installation\n\nTo run this project, you need to have Docker and Docker Compose installed on your machine. If you don't have them already,\nplease follow the installation guides below:\n\n- Docker installed on your system\n- Python 3.10 or later installed on your system\n- Basic understanding of FastAPI and Redis.\n\n## Environment Variables\n\nCreate a .env file in the same directory as the docker-compose.yml file with the following variables:\n\n   ```\n  OPENAI_API_KEY=\u003cyour_openai_api_key\u003e\n  REDIS_HOST=\u003cyour_redis_host\u003e\n  REDIS_PORT=\u003cyour_redis_port\u003e\n  REDIS_PASSWORD=\u003cyour_redis_password\u003e\n  GOOGLE_API_KEY=\u003cyour_google_api_key\u003e\n  GOOGLE_CSE_ID=\u003cyour_google_cse_id\u003e\n   ```\n## To set up the Google Search API keys:\n\n- First, you need to set up the proper API keys. To do this, create the GOOGLE_API_KEY in the Google Cloud Credential console. You can access the console from this link: Google Cloud Console\n\n- Then, create a GOOGLE_CSE_ID using the Programmable Search Engine. You can do this by visiting this link: Programmable Search Engine\n\n- After creating these keys, add them to the .env file.\n\n## Deploying the Application Locally\n- Navigate to the project directory containing the docker-compose.yml file.\n- Run the following command to deploy the application:\n\n   ```\n   docker-compose up --build\n   ```\nThis command will build the Docker images and start the containers.\n\n\n## Accessing the Application\nThe application will be available at:\n- FastAPI Server: http://localhost:8000\n- Redis Browser: http://localhost:8001/redis-stack/browser\n\n\n## Testing the Application\nTo test the application, you can use the FastAPI autogenerated documentation by visiting http://localhost:8000/docs. This will provide you with an interactive interface to upload documents and ask questions about the content.\n- Go to the /upload-files/ endpoint and upload your documents. The supported file formats are PDF, DOCX, and TXT.\n- Use the /create-task/ endpoint to ask a question about the uploaded documents. The AI assistant will analyze the most relevant document and provide an answer based on its content.\n\n## AI-Powered Google Search Endpoint\nRomeo GPT also includes a custom Google Search endpoint at /api/google-search/. This endpoint leverages the power of GPT-4\nto conduct informed Google searches based on the provided tasks. This adds another layer of intelligence to your queries, making them more precise and effective.\n\n\n## License\nMozilla Public License Version 2.0\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffmanrique8%2Fromeo-gpt","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffmanrique8%2Fromeo-gpt","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffmanrique8%2Fromeo-gpt/lists"}