GenAI_University_Chatbot

Ein neuer generativer Ansatz zur Optimierung des Netzwerk- und Serverlasts von Websites (Universitäts -Chatbot)

Projekt eingereicht an Dr. Yanqing Zhang für künstliche Intelligenz (CS4810)

Autoren: Manish Kolla & Ritesh Dumpala

Anwendungshandbuch

Dieses Handbuch enthält Schritt-für-Schritt-Anweisungen zum Einrichten und Ausführen der Chatbot-Anwendung der Universität.

---

Hier ist die aktualisierte Version des Abschnitts der Voraussetzungen mit Schritten, um die Installationen von Python- und Visual Studio -Code zu überprüfen und gegebenenfalls zu installieren:

Voraussetzungen

Stellen Sie vor dem Ausführen der Bewerbung sicher, dass Sie Folgendes haben:

1. Python -Installation
   Die Anwendung erfordert Python. Um zu überprüfen, ob Python installiert ist, führen Sie den folgenden Befehl in Ihrem Terminal oder Eingabeaufforderung aus:

   python --version

   Wenn Python nicht installiert ist, befolgen Sie diese Schritte, um es zu installieren:

   • Laden Sie Python von der offiziellen Python -Website herunter.
   • Führen Sie das Installationsprogramm aus und überprüfen Sie das Kontrollkästchen mit der Aufschrift "Python" während des Installationsprozesses zum Pfad hinzufügen .
   • Nach der Installation wird bestätigen, dass Python durch Ausführen installiert wird:

   python --version

2. Visual Studio -Code (VS -Code)
   Visual Studio Code wird als Code -Editor für diese Anwendung empfohlen. Um zu überprüfen, ob VS -Code installiert ist, führen Sie den folgenden Befehl in Ihrem Terminal aus:

   code --version

   Wenn VS -Code nicht installiert ist, befolgen Sie diese Schritte, um es zu installieren:

   • Laden Sie das Installationsprogramm für Ihr Betriebssystem von der offiziellen VS -Code -Website herunter.
   • Führen Sie das Installationsprogramm aus und befolgen Sie die Eingabeaufforderungen, um die Installation abzuschließen.
   • Nach der Installation können Sie den VS -Code öffnen, indem Sie code im Terminal eingeben.

3. Gemini API -Schlüssel
   Der Gemini -API -Schlüssel ist für die Interaktion mit generativer KI erforderlich. Befolgen Sie diese Schritte, um einen zu erhalten:

   • Melden Sie sich beim Gemini AI Studio an.
   • Melden Sie sich mit Ihrem Konto an oder erstellen Sie eine neue.
   • Klicken Sie auf den Abschnitt API -Schlüssel und befolgen Sie die Eingabeaufforderungen.
   • Generieren Sie einen neuen API -Schlüssel und kopieren Sie ihn.
     Hinweis: Speichern Sie den Schlüssel sicher, da er in der Anwendung verwendet wird.

4. Bing -Such -API -Schlüssel
   Der Bing -Such -API -Schlüssel ist für die Integration von Websuchfunktionen erforderlich. Befolgen Sie diese Schritte, um einen zu erhalten:

   • Besuchen Sie das Microsoft Azure -Portal.
   • Melden Sie sich mit Ihrem Microsoft -Konto an oder erstellen Sie eine neue.
   • Gehen Sie, um eine Ressource zu erstellen und nach "Bing Search V7" zu suchen.
   • Richten Sie eine neue Ressource für die Bing -Suche ein und navigieren Sie zum Abschnitt Tasten und Endpunkt .
   • Kopieren Sie einen der bereitgestellten API -Schlüssel.
     Hinweis: Speichern Sie den Schlüssel sicher, da er in der Anwendung verwendet wird.

5. Erstellen Sie die Datei config.py
   Um Ihre API -Schlüssel sicher zu speichern, erstellen Sie eine config.py -Datei im Projektverzeichnis und fügen Sie den folgenden Code hinzu:

    # config.py
   GEMINI_API = "YOUR_API_KEY_HERE"
   BING_API = "YOUR_API_KEY_HERE"

   • Ersetzen Sie "YOUR_API_KEY_HERE" durch Ihren tatsächlichen Gemini -API -Schlüssel und die Bing -API -Schlüssel .
   • Speichern Sie diese Datei im selben Verzeichnis wie Ihr Hauptanwendungsskript ( app.py ).

---

Schritte zum Ausführen der Anwendung

1. Klonen Sie das Repository klonen

Verwenden Sie den folgenden Befehl, um das Repository von Ihrer Git -Hosting -Plattform (z. B. GitHub) aus zu klonen:

git clone https://github.com/manishkolla/GenAI_University_Chatbot

2. Navigieren Sie zum Projektverzeichnis

Ändern Sie Ihr Arbeitsverzeichnis in den geklonten Repository -Ordner:

 cd < project-directory >

3. Überprüfen Sie die Installation von Python und PIP

Stellen Sie sicher, dass Python und PIP auf Ihrem System installiert sind.

Um zu überprüfen, ob Python installiert ist:

python --version

oder

python3 --version

Um zu überprüfen, ob PIP installiert ist:

pip --version

Wenn einer der beiden fehlt, laden Sie die neueste Version von Python von der offiziellen Python -Website herunter und installieren Sie sie.

---

4. Erstellen und aktivieren Sie eine virtuelle Umgebung

Es wird empfohlen, eine virtuelle Umgebung zu verwenden, um Abhängigkeiten zu isolieren.

Für Fenster :

1. Erstellen Sie eine virtuelle Umgebung:

   python -m venv venv

2. Aktivieren Sie die virtuelle Umgebung:

   venv S cripts a ctivate

Für Mac/Linux :

1. Erstellen Sie eine virtuelle Umgebung:

   python3 -m venv venv

2. Aktivieren Sie die virtuelle Umgebung:

    source venv/bin/activate

---

5. Installieren Sie die erforderlichen Abhängigkeiten

Installieren Sie alle erforderlichen Python -Bibliotheken, die in der Datei der requirements.txt aufgeführt sind:

pip install -r requirements.txt

---

6. Führen Sie die Flask -Anwendung aus

Führen Sie die Flask -Anwendung mit dem folgenden Befehl aus:

python app.py

---

7. Zugriff auf die Anwendung lokal zugreifen

Sobald die Anwendung beginnt, wird eine lokale URL angezeigt (normalerweise http://127.0.0.1:5000/ ). Öffnen Sie diese URL in Ihrem Webbrowser, um auf die Anwendung zuzugreifen.

---

8. Testen Sie die Anwendung

Sie können die Anwendung testen, indem Sie über die Webschnittstelle oder API (abhängig von der Implementierung) mit ihr interagieren.

• Öffnen Sie die im Terminal gezeigte URL (z. B. http://127.0.0.1:5000/ ) in Ihrem Browser.
• Stellen Sie Fragen zu Informatik (CS) , Data Science -Abteilungen oder dem Verzeichnis . Zum Beispiel:
  • "Welche Rolle spielt die CS -Abteilung?"
  • "Können Sie Informationen über das Datenwissenschaftsprogramm bereitstellen?"
  • "Wer ist der Leiter der CS -Abteilung?"
  • "Können Sie einen Kontakt im Verzeichnis finden?"
• Die Anwendung sollte mit den relevanten Informationen antworten oder hilfreiche Antworten basierend auf der Funktionalität geben.

---

Optional: Deaktivieren Sie die virtuelle Umgebung

Deaktivieren Sie die virtuelle Umgebung mit:

deactivate