Wir arbeiten aktuell an der Dokumentation der neuen Funktionalitäten von Moodle 5.2.

OpenAI API-Anbieter: Unterschied zwischen den Versionen

Aus MoodleDocs
Wechseln zu:Navigation, Suche
 
(10 dazwischenliegende Versionen desselben Benutzers werden nicht angezeigt)
Zeile 1: Zeile 1:
{{KI-Teilsystem}}
{{KI-Teilsystem}}
{{Neu}}
{{Übersetzen}}
Die Integration von Moodle mit OpenAI ermöglicht den Zugriff auf KI-Aktionen wie Textgenerierung, Bildgenerierung oder Zusammenfassung von Kursinhalten. 


Weitere Informationen über OpenAI finden Sie unter https://platform.openai.com.  
Die Integration von Moodle mit OpenAI ermöglicht den Zugriff auf KI-Aktionen wie Textgenerierung, Bildgenerierung oder Zusammenfassen und Erklären (ab Moodle 5.0) von Kursinhalten.  


===Voraussetzungen===
==Voraussetzungen==
Für die Integration in Moodle benötigen Sie ein OpenAI-Konto mit Zugang zu einem kostenpflichtigen API-Schlüssel. In Moodle LMS 4.5.0 sind sowohl ein OpenAI-API-Schlüssel als auch eine OpenAI-Organisations-ID erforderlich, ab Moodle 4.5.1 ist die Organisations-ID optional.
Für die Integration in Moodle benötigen Sie ein OpenAI-Konto mit Zugang zu einem kostenpflichtigen API-Schlüssel.  


Beim Einrichten eines OpenAI-Kontos mit einem API-Schlüssel können zwar sowohl von kostenlosen als auch von kostenpflichtigen Konten Schlüssel generiert werden, die API-Nutzung ist jedoch auf die für das Konto verfügbaren kostenpflichtigen Tokens beschränkt: '''Der Zugriff von Moodle auf die API von OpenAI erfordert ein kostenpflichtiges Abonnement''' (z. B. Pay-as-you-go). Der Zugang, die Nutzungsbeschränkungen und die Preisstufen hängen vom verwendeten Modell ab, siehe [https://openai.com/api/pricing/ OpenAI API Pricing Page] für aktuelle Informationen.
Beim Einrichten eines OpenAI-Kontos mit einem API-Schlüssel können zwar sowohl von kostenlosen als auch von kostenpflichtigen Konten Schlüssel generiert werden, die API-Nutzung ist jedoch auf die für das Konto verfügbaren kostenpflichtigen Tokens beschränkt: '''Der Zugriff von Moodle auf die API von OpenAI erfordert ein kostenpflichtiges Abonnement''' (z. B. Pay-as-you-go). Der Zugang, die Nutzungsbeschränkungen und die Preisstufen hängen vom verwendeten Modell ab, siehe [https://openai.com/api/pricing/ OpenAI API Pricing Page] für aktuelle Informationen.


===Einstellungen für den OpenAI API-Anbieter===
==OpenAI API-Anbieter konfigurieren==
Um eine OpenAI-Provider-Instanz zu erstellen, gehen Sie folgendermaßen vor:
#Gehen Sie auf die Seite ''Website-Administration > Allgemein > KI > KI-Anbieter''.
#Gehen Sie auf die Seite ''Website-Administration > Allgemein > KI > KI-Anbieter''.
#Aktivieren Sie den OpenAI API-Anbieter durch Anklicken des Schalters [[Image:toggle.png|36px]].
#Klicken Sie auf den Button ''Neue Provider-Instanz anlegen''.
#Klicken Sie auf den Link ''Einstellungen'' des OpenAI API-Anbieters.
#Wählen Sie als ''KI-Provider-Plugin'' die Option ''OpenAI-API-Provider''. Tragen Sie einen Namen und den API-Key Ihres OpenAI Kontos ein ([https://platform.openai.com/account/api-keys OpenAI API Keys]).
#Im Abschnitt ''Einstellungen'' tragen Sie Folgendes ein:
#Bei Bedarf können Sie die OpenAI Organisations-ID von Ihrem [https://platform.openai.com/account/org-settings OpenAI Konto] eintragen.
#*''OpenAI API-Key'': Sie können den Schlüssel über Ihr OpenAI-Konto erhalten ([https://platform.openai.com/account/api-keys OpenAI API Keys]).
#Bei Bedarf setzen Sie eine systemweite Obergrenzen für Anfragen und/oder Obergrenzen für Nutzer/innen.
#*''OpenAI Organisations-ID'': Sie finden diese ID auf der gleichnamigen Seite in Ihrem OpenAI-Konto ([https://platform.openai.com/account/org-settings OpenAI Account]). In Moodle 4.5.0 ist diese Einstellung ein Pflichtfeld, ab Moodle 4.5.1 ist sie optional.
#Klicken Sie den Button ''Instanz erstellen''.
#*''Systemweite Ratenbegrenzung festlegen'': Das ist eine optionale Einstellung zur Begrenzung der Anzahl von Anfragen, die der OpenAI API-Anbieter stündlich im gesamten Moodle-System verarbeiten kann.
#* ''Maximale Anzahl von systemweiten Anfragen '': Wenn die systemweite Ratenbegrenzung aktiviert wurde, legt diese Einstellung die maximale Anzahl der Anfragen fest, die stündlich verarbeitet werden.
#*''Nutzerbezogene Ratenbegrenzung festlegen'': Das ist eine optionale Einstellung zur Begrenzung der Anzahl von Anfragen, die Nutzer/innen stündlich stellen kann.
#*''Maximale Anzahl von Anfragen pro Nutzer/in '': Wenn die nutzerbezogene Ratenbegrenzung aktiviert wurde, legt diese Einstellung die maximale Anzahl der Anfragen fest, die Nutzer/innen stündlich stellen dürfen.
# Im Abschnitt''Aktionen'' können Sie festlegen, welche Aktionen verfügbar sein sollen, und spezifische Einstellungen für die Aktionen vornehmen.


=== Aktionen konfigurieren ===
Um die OpenAI-Provider-Instanz zu konfigurieren, gehen Sie folgendermaßen vor:
#Gehen Sie auf die Seite ''Website-Administration > Allgemein > KI > KI-Anbieter''.
#Klicken Sie auf den Link ''Einstellungen'' der (eben angelegten) OpenAI-Provider-Instanz.
#Aktivieren Sie die gewünschten Aktionen nach Bedarf.


[[File:OpenAI Actions.png|none|thumb|600x600px|OpenAI Aktionen]]
Für jede Aktion können Sie in den zugehörigen Einstellungen das Verhalten des Modells konfigurieren.


Die folgenden Aktionseinstellungen sind für den OpenAI API-Anbieter verfügbar:
===Text generieren, Zusammenfassen, Erklären===
# Wählen Sie das KI-Modell. Information zu den Modellen finden Sie unter [https://platform.openai.com/docs/models OpenAI Models]. Standardmäßig ist GPT-4o als Modell ausgewählt.
# Tragen Sie den API-Endpunkt ein. Stellen Sie sicher, dass der API-Endpunkt mit dem gewählten KI-Modell kompatibel ist. Informationen dazu finden Sie unter [https://platform.openai.com/docs/models/model-endpoint-compatibility Model endpoint compatibility].
# Überprüfen und ändern Sie die Systemanweisungen nach Bedarf.
# Geben Sie die Werte für die folgenden Einstellungen ein und speichern Sie abschließend die Einstellungen:


'''Text generieren:''' Sie können die folgenden Einstellungen konfigurieren:   
* top_p - top_p (Kernel-Sampling) bestimmt, wie viele mögliche Wörter berücksichtigt werden sollen. Ein hoher Wert (z. B. 0,9) bedeutet, dass das Modell mehr Wörter berücksichtigt, wodurch der generierte Text vielfältiger wird.
* max_tokens - Die maximale Anzahl der im generierten Text verwendeten Token.
* frequency_penalty - Die Frequenzstrafe passt an, wie oft Wörter wiederholt werden. Je höher die Strafe, desto weniger Wiederholungen gibt es im generierten Text.
* presence_penalty - Die Präsenzstrafe ermutigt das Modell, neue Wörter zu verwenden, indem sie die Wahrscheinlichkeit erhöht, dass Wörter ausgewählt werden, die zuvor noch nicht verwendet wurden. Ein höherer Wert macht den generierten Text vielfältiger, während ein niedrigerer Wert mehr Wiederholungen zulässt.


* KI-Modell: Die OpenAI API wird von einer Reihe von Modellen mit unterschiedlichen Funktionalitäten und Bezahloptionen unterstützt. Mehr Informationen dazu finden Sie unter [https://platform.openai.com/docs/models OpenAI Modelle]. Standardmäßig ist die Option ''GPT-4o'' eingestellt, aber Sie können jedes andere kompatible Modell wählen. Weitere Einzelheiten finden Sie unter [https://platform.openai.com/settings/organization/limits Informationen zu den Einstellungen und Einschränkungen Ihrer Organisation].


*API-Endpunkt. Bitte stellen Sie sicher, dass Ihr API-Endpunkt mit dem ausgewählten Modell kompatibel ist. Weitere Informationen finden Sie unter [https://platform.openai.com/docs/models/model-endpoint-compatibility Kompatibilität der Modell-Endpunkte].
Um eine OpenAI-Provider-Instanz zu aktivieren, gehen Sie folgendermaßen vor:
*Systemanweisung: Es gibt standardmäßige Systemanweisungen, um das erwartete Antwortformat der KI zu steuern, aber diese können an Ihre spezifischen Bedürfnisse angepasst werden. Diese werden verwendet, um eine reibungslose Benutzererfahrung zu gewährleisten, bei der nur die angeforderte Textgeneration zurückgegeben wird, ohne Anrede, Wiederholung der Anfrage usw. Es wird daher empfohlen, diese Einstellungen nur dann zu ändern, wenn Sie sicher sind, dass die Änderung absolut notwendig ist.
#Gehen Sie auf die Seite ''Website-Administration > Allgemein > KI > KI-Anbieter''.
 
#Aktivieren Sie die OpenAI-Provider-Instanz durch Anklicken des Schalters [[Image:toggle.png|36px]].
 
'''Text zusammenfassen:''' Die erforderliche Konfiguration ist dieselbe wie für die Aktion Text generieren.
 
'''Bild generieren:''' Sie können die folgenden Einstellungen konfigurieren:
*AI-Modell: Die Standardeinstellung ist „dall-e-3“, kann aber auf jedes andere mit der Bilderzeugung kompatible Modell geändert werden.  Für weitere Details besuchen Sie bitte: [https://platform.openai.com/docs/models/dall-e DALL-E-Modelle].
*API-Endpunkt:  Bitte stellen Sie sicher, dass Ihr API-Endpunkt mit dem ausgewählten Modell kompatibel ist.
 
 
Wenn alle oben genannten Punkte aktiviert und konfiguriert sind, kann der OpenAI-Provider für alle in Ihrer Moodle-LMS-Instanz verfügbaren KI-Platzierungen verwendet werden; '''Kursassistenz''' und '''HTML-Texteditor''' Platzierungen. Vergessen Sie nicht, auch die Einstellungen für [[KI-Placements|'''KI-Placements''']] zu aktivieren und zu konfigurieren.  
The following Action settings are available for the OpenAI Provider
 
'''Generate text:''' You can configure the following settings:   
 
* AI model: OpenAI API is powered by a diverse set of models with different capabilities and price points. There is more information about at [https://platform.openai.com/docs/models OpenAI Models]. By default, the model is set to “GPT-4o”,  but this can be configured to any other compatible model. For more details, [https://platform.openai.com/settings/organization/limits see your organization's settings and limits information].
 
*API endpoint. Please ensure your API endpoint is compatible with your selected model. For more information, visit [https://platform.openai.com/docs/models/model-endpoint-compatibility Model endpoint compatibility].
*System instruction: There are default system instructions in place to help direct the expected response format from the AI, but these can be customised to suit your specific needs. These are used to ensure a smooth user experience where only the requested text generation is returned, with no salutations, repetition of the request etc. It is therefore recommended these are not modified unless you are confident the change is absolutely necessary.
 
 
'''Summarise text:''' The required configuration is the same as for the Generate text Action.
 
'''Generate image:''' You can configure the following settings:
 
*AI model: The default is set to “dall-e-3” but it can be changed to  any other image generation compatible model.  For more details, visit: [https://platform.openai.com/docs/models/dall-e DALL-E Models].
*API endpoint:  Please ensure your API endpoint is compatible with your selected model.
 
 
With all of the above enabled and configured, the OpenAI Provider can be used for all of the AI Placements available in your Moodle LMS instance; '''Course Assistance''' and '''HTML Text Editor''' Placements. Don't forget to also enable and configure [[AI placements|'''AI Placements''']] settings. [[File:Generate text in OpenAI.png|none|thumb|600x600px|OpenAI Provider - Generate text settings]]
[[File:OpenAI Provider - Generate image.png|none|thumb|600x600px|OpenAI Provider - Generate image settings]]


[[en:OpenAI API provider]]
[[en:OpenAI API provider]]

Aktuelle Version vom 18. Dezember 2025, 13:05 Uhr


Die Integration von Moodle mit OpenAI ermöglicht den Zugriff auf KI-Aktionen wie Textgenerierung, Bildgenerierung oder Zusammenfassen und Erklären (ab Moodle 5.0) von Kursinhalten.

Voraussetzungen

Für die Integration in Moodle benötigen Sie ein OpenAI-Konto mit Zugang zu einem kostenpflichtigen API-Schlüssel.

Beim Einrichten eines OpenAI-Kontos mit einem API-Schlüssel können zwar sowohl von kostenlosen als auch von kostenpflichtigen Konten Schlüssel generiert werden, die API-Nutzung ist jedoch auf die für das Konto verfügbaren kostenpflichtigen Tokens beschränkt: Der Zugriff von Moodle auf die API von OpenAI erfordert ein kostenpflichtiges Abonnement (z. B. Pay-as-you-go). Der Zugang, die Nutzungsbeschränkungen und die Preisstufen hängen vom verwendeten Modell ab, siehe OpenAI API Pricing Page für aktuelle Informationen.

OpenAI API-Anbieter konfigurieren

Um eine OpenAI-Provider-Instanz zu erstellen, gehen Sie folgendermaßen vor:

  1. Gehen Sie auf die Seite Website-Administration > Allgemein > KI > KI-Anbieter.
  2. Klicken Sie auf den Button Neue Provider-Instanz anlegen.
  3. Wählen Sie als KI-Provider-Plugin die Option OpenAI-API-Provider. Tragen Sie einen Namen und den API-Key Ihres OpenAI Kontos ein (OpenAI API Keys).
  4. Bei Bedarf können Sie die OpenAI Organisations-ID von Ihrem OpenAI Konto eintragen.
  5. Bei Bedarf setzen Sie eine systemweite Obergrenzen für Anfragen und/oder Obergrenzen für Nutzer/innen.
  6. Klicken Sie den Button Instanz erstellen.

Um die OpenAI-Provider-Instanz zu konfigurieren, gehen Sie folgendermaßen vor:

  1. Gehen Sie auf die Seite Website-Administration > Allgemein > KI > KI-Anbieter.
  2. Klicken Sie auf den Link Einstellungen der (eben angelegten) OpenAI-Provider-Instanz.
  3. Aktivieren Sie die gewünschten Aktionen nach Bedarf.

Für jede Aktion können Sie in den zugehörigen Einstellungen das Verhalten des Modells konfigurieren.

Text generieren, Zusammenfassen, Erklären

  1. Wählen Sie das KI-Modell. Information zu den Modellen finden Sie unter OpenAI Models. Standardmäßig ist GPT-4o als Modell ausgewählt.
  2. Tragen Sie den API-Endpunkt ein. Stellen Sie sicher, dass der API-Endpunkt mit dem gewählten KI-Modell kompatibel ist. Informationen dazu finden Sie unter Model endpoint compatibility.
  3. Überprüfen und ändern Sie die Systemanweisungen nach Bedarf.
  4. Geben Sie die Werte für die folgenden Einstellungen ein und speichern Sie abschließend die Einstellungen:
  • top_p - top_p (Kernel-Sampling) bestimmt, wie viele mögliche Wörter berücksichtigt werden sollen. Ein hoher Wert (z. B. 0,9) bedeutet, dass das Modell mehr Wörter berücksichtigt, wodurch der generierte Text vielfältiger wird.
  • max_tokens - Die maximale Anzahl der im generierten Text verwendeten Token.
  • frequency_penalty - Die Frequenzstrafe passt an, wie oft Wörter wiederholt werden. Je höher die Strafe, desto weniger Wiederholungen gibt es im generierten Text.
  • presence_penalty - Die Präsenzstrafe ermutigt das Modell, neue Wörter zu verwenden, indem sie die Wahrscheinlichkeit erhöht, dass Wörter ausgewählt werden, die zuvor noch nicht verwendet wurden. Ein höherer Wert macht den generierten Text vielfältiger, während ein niedrigerer Wert mehr Wiederholungen zulässt.


Um eine OpenAI-Provider-Instanz zu aktivieren, gehen Sie folgendermaßen vor:

  1. Gehen Sie auf die Seite Website-Administration > Allgemein > KI > KI-Anbieter.
  2. Aktivieren Sie die OpenAI-Provider-Instanz durch Anklicken des Schalters .