search
HomeBackend DevelopmentPython TutorialContributing to ORAssistant

Introduction

I was pleased after having contributed to various repositories during Hacktoberfest, but as soon as Hacktoberfest, I had this new profound excitement to contribute to more Open-Sourced Projects. I had contributed to a lot of projects that had a tech stack that included both backend and fronted, but this time around I wanted to contribute to an AI-based project, particularly something related to RAG (Retrieval Augmented Generation) as I wanted to delve into it

ORAssistant

While looking for a lot of repos based on RAG, I stumbled across a perfect open-sourced RAG tool, ORAssistant, which is again, a chatbot that responds to common questions or inquiries for a larger project.

The architecture of this tool is quite complex, I am still trying to figure out how the main query architecture operates, but this is the exciting part, learning as I contribute.

Issue

For my first issue, I picked up one of the issues where the task was to automate the feedback loop, in Leyman terms, what this entails is that an RAG app usually depends on feedback from the user to further fine-tune the response, the task was to get this feedback from the user and store it in a database and feed it back to the model itself

The architecture would look something like this

Contributing to ORAssistant

Currently, the system stores the feedback in Google Sheets, which again is not an optimized approach

This issue in itself would take around 4-5 PRs to get solved, but for the focus of this blog, I will restrict it to the first PR I have made.

First Pull Request

For the first pull request, as evident from the discussions from the issue, my task was to first get the database design set up and running. In doing so, I encountered a lot of issues

Issues faced

  • During the setup, the documentation to get the GOOGLE_SERVICE_KEY wasn't straightforward, so I had to double-check it with the maintainer and tweak a lot of settings in my personal Google account to get it up and running, the maintainers were helpful during the entire process
  • There were some inconsistencies in the backend which led to the frontend not operating correctly, but one of the good things about this project is since the backend is changing dynamically, they have a mock backend so that while the backend is being developed, the fronted doesn't suffer.

Main solution

The solution that I had proposed for this PR, revolved around the discussion of choosing the right database, after an elaborate discussion with the maintainer, we decided that it was best to use MongoDB for the project, thinking about scalability and flexibility in the fields due to the schema-less nature of MongoDB.

After making the initial design, I opened a PR, which was related to having the initial design setup for the frontend

One of the issues faced during the process of getting this merged was that it wasn't passing a test in the CI pipeline, which wasn't related to an error in my code, but because some repository secrets were not being propagated to the fork of the repository that I was working on, so the maintainer had to give me write access to the repo to get my PR merged

Further Contributions

This PR would now act as the base for further PRs that would eventually solve the entire issue. To be honest, this is one of the best projects I have worked on in a while, it is taking me about 6-7 PRs to just solve one issue, this shows how intricate and developed the project is.

I am really enjoying how my Open-Source Journey is shaping out to be.

The above is the detailed content of Contributing to ORAssistant. For more information, please follow other related articles on the PHP Chinese website!

Statement
The content of this article is voluntarily contributed by netizens, and the copyright belongs to the original author. This site does not assume corresponding legal responsibility. If you find any content suspected of plagiarism or infringement, please contact admin@php.cn
How do you append elements to a Python array?How do you append elements to a Python array?Apr 30, 2025 am 12:19 AM

InPython,youappendelementstoalistusingtheappend()method.1)Useappend()forsingleelements:my_list.append(4).2)Useextend()or =formultipleelements:my_list.extend(another_list)ormy_list =[4,5,6].3)Useinsert()forspecificpositions:my_list.insert(1,5).Beaware

How do you debug shebang-related issues?How do you debug shebang-related issues?Apr 30, 2025 am 12:17 AM

The methods to debug the shebang problem include: 1. Check the shebang line to make sure it is the first line of the script and there are no prefixed spaces; 2. Verify whether the interpreter path is correct; 3. Call the interpreter directly to run the script to isolate the shebang problem; 4. Use strace or trusts to track the system calls; 5. Check the impact of environment variables on shebang.

How do you remove elements from a Python array?How do you remove elements from a Python array?Apr 30, 2025 am 12:16 AM

Pythonlistscanbemanipulatedusingseveralmethodstoremoveelements:1)Theremove()methodremovesthefirstoccurrenceofaspecifiedvalue.2)Thepop()methodremovesandreturnsanelementatagivenindex.3)Thedelstatementcanremoveanitemorslicebyindex.4)Listcomprehensionscr

What data types can be stored in a Python list?What data types can be stored in a Python list?Apr 30, 2025 am 12:07 AM

Pythonlistscanstoreanydatatype,includingintegers,strings,floats,booleans,otherlists,anddictionaries.Thisversatilityallowsformixed-typelists,whichcanbemanagedeffectivelyusingtypechecks,typehints,andspecializedlibrarieslikenumpyforperformance.Documenti

What are some common operations that can be performed on Python lists?What are some common operations that can be performed on Python lists?Apr 30, 2025 am 12:01 AM

Pythonlistssupportnumerousoperations:1)Addingelementswithappend(),extend(),andinsert().2)Removingitemsusingremove(),pop(),andclear().3)Accessingandmodifyingwithindexingandslicing.4)Searchingandsortingwithindex(),sort(),andreverse().5)Advancedoperatio

How do you create multi-dimensional arrays using NumPy?How do you create multi-dimensional arrays using NumPy?Apr 29, 2025 am 12:27 AM

Create multi-dimensional arrays with NumPy can be achieved through the following steps: 1) Use the numpy.array() function to create an array, such as np.array([[1,2,3],[4,5,6]]) to create a 2D array; 2) Use np.zeros(), np.ones(), np.random.random() and other functions to create an array filled with specific values; 3) Understand the shape and size properties of the array to ensure that the length of the sub-array is consistent and avoid errors; 4) Use the np.reshape() function to change the shape of the array; 5) Pay attention to memory usage to ensure that the code is clear and efficient.

Explain the concept of 'broadcasting' in NumPy arrays.Explain the concept of 'broadcasting' in NumPy arrays.Apr 29, 2025 am 12:23 AM

BroadcastinginNumPyisamethodtoperformoperationsonarraysofdifferentshapesbyautomaticallyaligningthem.Itsimplifiescode,enhancesreadability,andboostsperformance.Here'showitworks:1)Smallerarraysarepaddedwithonestomatchdimensions.2)Compatibledimensionsare

Explain how to choose between lists, array.array, and NumPy arrays for data storage.Explain how to choose between lists, array.array, and NumPy arrays for data storage.Apr 29, 2025 am 12:20 AM

ForPythondatastorage,chooselistsforflexibilitywithmixeddatatypes,array.arrayformemory-efficienthomogeneousnumericaldata,andNumPyarraysforadvancednumericalcomputing.Listsareversatilebutlessefficientforlargenumericaldatasets;array.arrayoffersamiddlegro

See all articles

Hot AI Tools

Undresser.AI Undress

Undresser.AI Undress

AI-powered app for creating realistic nude photos

AI Clothes Remover

AI Clothes Remover

Online AI tool for removing clothes from photos.

Undress AI Tool

Undress AI Tool

Undress images for free

Clothoff.io

Clothoff.io

AI clothes remover

Video Face Swap

Video Face Swap

Swap faces in any video effortlessly with our completely free AI face swap tool!

Hot Tools

DVWA

DVWA

Damn Vulnerable Web App (DVWA) is a PHP/MySQL web application that is very vulnerable. Its main goals are to be an aid for security professionals to test their skills and tools in a legal environment, to help web developers better understand the process of securing web applications, and to help teachers/students teach/learn in a classroom environment Web application security. The goal of DVWA is to practice some of the most common web vulnerabilities through a simple and straightforward interface, with varying degrees of difficulty. Please note that this software

VSCode Windows 64-bit Download

VSCode Windows 64-bit Download

A free and powerful IDE editor launched by Microsoft

SublimeText3 Chinese version

SublimeText3 Chinese version

Chinese version, very easy to use

SecLists

SecLists

SecLists is the ultimate security tester's companion. It is a collection of various types of lists that are frequently used during security assessments, all in one place. SecLists helps make security testing more efficient and productive by conveniently providing all the lists a security tester might need. List types include usernames, passwords, URLs, fuzzing payloads, sensitive data patterns, web shells, and more. The tester can simply pull this repository onto a new test machine and he will have access to every type of list he needs.

mPDF

mPDF

mPDF is a PHP library that can generate PDF files from UTF-8 encoded HTML. The original author, Ian Back, wrote mPDF to output PDF files "on the fly" from his website and handle different languages. It is slower than original scripts like HTML2FPDF and produces larger files when using Unicode fonts, but supports CSS styles etc. and has a lot of enhancements. Supports almost all languages, including RTL (Arabic and Hebrew) and CJK (Chinese, Japanese and Korean). Supports nested block-level elements (such as P, DIV),