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
 
(16 dazwischenliegende Versionen desselben Benutzers werden nicht angezeigt)
Zeile 1: Zeile 1:
{{KI-Teilsystem}}
{{KI-Teilsystem}}
{{Neu}}


Die Integration von Moodle mit OpenAI ermöglicht den Zugriff auf KI-Aktionen wie Textgenerierung, Bildgenerierung oder Zusammenfassung von Kursinhalten.   
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.   


Weitere Informationen über OpenAI finden Sie unter https://platform.openai.com.
==Voraussetzungen==
 
Für die Integration in Moodle benötigen Sie ein OpenAI-Konto mit Zugang zu einem kostenpflichtigen API-Schlüssel.  
===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.


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|32px]].
#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 > API-Schlüssel 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 organization ID: You find this in  your OpenAI account / Organization settings page ([https://platform.openai.com/account/org-settings OpenAI account]). (This is a required field for Moodle LMS 4.5.0, but will be optional from 4.5.1.)
#Klicken Sie den Button ''Instanz erstellen''.
#*Set site-wide rate limit: An optional feature to limit the number of requests that the OpenAI API Provider can receive across the entire site every hour.
#* Maximum number of site-wide requests can be configured after enable “Set site-wide rate limit”.
#*Set user rate limit: An optional feature to limit the number of AI requests each user can make to this provider each hour.
#*Maximum number of requests per user can be configured after enable “Set user rate limit”.
# In the “Actions” area you can control which available Actions are enabled and configure further Action settings.<br />


=== Configuring OpenAI API Provider actions ===
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 Actions]]
Für jede Aktion können Sie in den zugehörigen Einstellungen das Verhalten des Modells konfigurieren.
The following Action settings are available for the OpenAI Provider. 


'''Generate text:''' You can configure the following settings:  
===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:


* 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].
* 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.


*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.


 
Um eine OpenAI-Provider-Instanz zu aktivieren, gehen Sie folgendermaßen vor:
'''Summarise text:''' The required configuration is the same as for the Generate text Action.
#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]].
'''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 .