OpenAI API provider

2024-10-15T19:14:49Z

Raortegar:

{{AI subsystem}}
{{Work in progress}}
{{New features}}

Moodle integration with OpenAI provides a service that lets people use advanced AI tools like generate a text, generate an image or summarize a text.

More information about OpenAI can be found on the following link https://platform.openai.com

==== Requirements: ====
An OpenAI account with access to the API key (Usage limits and pricing tiers are dependent on the level of access and the volume of queries).

==== Configuring OpenAI API provider settings ====

# Go to Admin -> General -> AI -> AI providers
# Enable the "OpenAI API Provider" by clicking on the “Enabled” toggle.
# Click on the "OpenAI API Provider" settings link.
# In the “Settings” area proceed to configure the following:
#* OpenAI API key: You can get the key from your OpenAI account / API Keys ([https://platform.openai.com/account/api-keys OpenAI API keys]).
#* OpenAI organization ID: You can get it from your OpenAI account / Organization settings page ([https://platform.openai.com/account/org-settings OpenAI account]).
#* Set site-wide rate limit: 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
#* Maximum number of requests per user can be configured after enable “Set user rate limit”
# In the “Actions” area enable all actions by clicking on their “Enabled” toggle.
.[[File:OpenAI.jpg|none|thumb|600x600px|OpenAI Dashboard]]

====Configuring OpenAI API provider actions====
[[File:OpenAI Actions.png|none|thumb|600x600px|OpenAI Actions]]
Access to the Settings link on each action to configure them.

===== 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 OpenAI models in the following link https://platform.openai.com/docs/models As default is set to “GPT-4o” but it can be change for any other compatible model, see your settings organization limits for more information (https://platform.openai.com/settings/organization/limits)

*API endpoint. Please ensure your API endpoint is compatible with your Model, see more information in the following link https://platform.openai.com/docs/models/model-endpoint-compatibility

*System instruction: There are some system instructions as default, but this can be adapted to your needs.

===== Summarise text: =====
The required configuration is the same as for the Generate text action.

===== Generate image: =====
You can configure the following settings:

*AI model: As default is set to “dall-e-3” but it can be changed for any other image generation compatible model. See more information in the following link https://platform.openai.com/docs/models/dall-e
* API endpoint: Please ensure your API endpoint is compatible with your Model.

[[File:Generate text in OpenAI.png|none|thumb|600x600px|Generate text in OpenAI]]

Now we should be able to use OpenAI provider for the AI placements available in our Moodle instance: Course Assistance and HTML Text Editor Placements. Don't forget to enable and configure [[AI placements|AI Placements]] settings.

[[es:Proveedor OpenAI API]]

AI placements

2024-10-15T19:10:18Z

Raortegar:

{{AI subsystem}}
{{Work in progress}}
{{New features}}

Placements define how and where AI actions can be used in your site. You can choose which actions are available in each placement through the settings.

By default, all AI placements are disabled. You can enable them through the AI placements page (Go to site administration -> General -> AI -> AI placements).
[[File:AI placements.png|none|thumb|600x600px|AI placements]]
Please be aware that an [[AI providers|AI provider]] should be enabled and configured before using this feature otherwise an error message will be displayed when accessing each placement settings.

=== HTML Text Editor Placement ===
Enable Generate Text and Generate Image actions by toggling the settings.

Once enabled, admin can access these options in the editor by clicking the Generate AI content icon or via the Insert menu. If both actions are enabled, options for AI Generate Text and AI Generate Image will be available.
[[File:HTML Text editor placement.png|none|thumb|600x600px]]

===== AI generate text: =====
Upon first use, users must accept the AI usage policy before the Generate Text Using AI modal is displayed, after that user can start using AI generate text tool:
[[File:GenerateText.png|none|thumb|600x600px]]

===== AI generate image: =====
Users can generate images via the Generate AI content icon or the Insert menu.
[[File:Generate Image.png|none|thumb|600x600px]]

=== Course Assistance Placement ===
To enable this feature access to “AI placements” click on the Course assistance placement toggle.
[[es:Colocaciones de IA]]