Azure AI API provider: Difference between revisions

From MoodleDocs
Main page ► Managing a Moodle site ► AI tools ► Azure AI API provider
AI tools
← Older editNewer edit →
VisualWikitext
mNo edit summary
No edit summary
Line 1: Line 1:
{{AI subsystem}}
{{AI subsystem}}
{{Work in progress}}
{{New features}}
{{New features}}


Moodle integration with Azure AI provides a service that lets people use advanced AI tools like generate a text, generate an image or summarise a text.
Moodle LMS’s integration with Azure AI provides access to AI Actions such as generate text, generate an image or summarise course content.


More information about Azure AI can be found at https://learn.microsoft.com/en-us/azure/ai-services/openai  
More information about Azure AI can be found at https://learn.microsoft.com/en-us/azure/ai-services/openai  


=== Requirements: ===
===Requirements:===
An active Azure account. If you don’t have one, you can create it through the [https://portal.azure.com Azure portal].  
An active Azure account. If you don’t have one, you can create it through the [https://portal.azure.com Azure portal].  


An active subscription to access [https://learn.microsoft.com/en-us/azure/ai-services/openai/ Azure AI services].
'''Ensure you have an active subscription to access''' [https://learn.microsoft.com/en-us/azure/ai-services/openai/quotas-limits '''Azure AI services''']. Obtain the API key and endpoint from the [https://portal.azure.com Azure Portal] to authenticate your requests (This is found under the "Keys and Endpoint" section of your resource.)


Ensure you have an active subscription to access Azure AI services. Obtain the API key and endpoint from the [https://portal.azure.com Azure portal] to authenticate your requests (This is found under the "Keys and Endpoint" section of your resource.)
=== Configuring Azure AI API provider===


=== Configuring Azure AI API provider ===
#Go to Site administration -> General -> AI -> AI providers
 
# Go to Site administration -> General -> AI -> AI providers
# Enable the "Azure AI API Provider" by clicking on the “Enabled” toggle.
# Enable the "Azure AI API Provider" by clicking on the “Enabled” toggle.
# Click on the "Azure AI API Provider" settings link.
#Click on the "Azure AI API Provider" settings link.
# In the “Settings” area proceed to configure the following:  
#In the “Settings” area proceed to configure the following:
#* Azure AI API key: You can get the key from your [https://portal.azure.com Azure AI account.]
#*Azure AI API key: You can find the key in your [https://portal.azure.com Azure AI account].  
#* Azure AI API endpoint:  Enter the endpoint URL for your Azure AI API, in the following format: <nowiki>https://YOUR_RESOURCE_NAME.openai.azure.com</nowiki>
#*Azure AI API endpoint:  Enter the endpoint URL for your Azure AI API, in the following format: <nowiki>https://YOUR_RESOURCE_NAME.openai.azure.com</nowiki>.
#* Set site-wide rate limit:  An optional feature to limit the number of requests that the Azure AI API Provider can receive across the entire site every hour.  
#*Set site-wide rate limit:  An optional feature to limit the number of requests that the Azure AI 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”
#*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.
#*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”
#*Maximum number of requests per user can be configured after enabling “Set user rate limit”
# In the “Actions” area you can control which available Actions are enabled and configure further Action settings.
# In the “Actions” area you can control which available Actions are enabled and configure further Action settings.


=== Configuring Azure AI API Provider Actions ===
===Configuring Azure AI API Provider Actions ===
[[File:Azure AI Actions.png|none|thumb|600x600px|Azure AI Actions]]
[[File:Azure AI Actions.png|none|thumb|600x600px|Azure AI Actions]]




The following Action settings are available for the Azure AI API Provider.  
The following Action settings are available for the Azure AI API Provider.
 
'''Generate text:''' You can configure the following settings:  
'''Generate text:''' You can configure the following settings:  


* Deployment ID:  The unique identifier assigned to a specific model deployment, which you can find in the "Deployments" section of your Azure OpenAI resource in the Azure Portal.
* Deployment ID:  The unique identifier assigned to a specific model deployment, which you can find in the "Deployments" section of your Azure OpenAI resource in the Azure Portal.
* API version; The API specific version of the API you're interacting with, you can find the latest available version under the "API Management" section of your [https://learn.microsoft.com/en-us/azure/ai-services/openai/ Azure OpenAI] resource.
* API version: The API specific version of the API you're interacting with, you can find the latest available version under the "API Management" section of your [https://learn.microsoft.com/en-us/azure/ai-services/openai/ Azure OpenAI] resource.
* System Instruction: There are default system instructions in place, but these can be customised to suit your specific needs.
* 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.  
'''Summarise text:''' The required configuration is the same as for the Generate text Action.  


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


* Deployment ID: The unique identifier assigned to the specific DALL-E model deployment, which you can find in the "Deployments" section of your Azure OpenAI resource in the Azure Portal, allowing you to generate images via [https://learn.microsoft.com/en-us/azure/ai-services/openai/reference#image-generation API requests].
* Deployment ID: The unique identifier assigned to the specific DALL-E model deployment, which you can find in the "Deployments" section of your Azure OpenAI resource in the Azure Portal, allowing you to generate images via [https://learn.microsoft.com/en-us/azure/ai-services/openai/reference#image-generation API requests].
* API version. The API specific version of the API you're interacting with, you can find the latest available version under the "API Management" section of your [https://learn.microsoft.com/en-us/azure/ai-services/openai/ Azure OpenAI] resource.
* API version. The API specific version of the API you're interacting with, you can find the latest available version under the "API Management" section of your [https://learn.microsoft.com/en-us/azure/ai-services/openai/ Azure OpenAI] resource.
*


[[File:Azure AI Provider - Generate text.png|none|thumb|600x600px|Azure AI Provider - Generate text]]
With all of the above enabled and configured, the Azure AI API 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:Azure AI Provider - Generate text.png|none|thumb|600x600px|Azure AI Provider - Generate text]]
[[File:Generate AI Image.png|none|thumb|600x600px|Azure AI Provider - Generate image]]  
With the above enabled and configured, the Azure AI API Provider can be used for 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.   
[[es:Proveedor Azure AI API]]
[[es:Proveedor Azure AI API]]

Revision as of 13:31, 18 October 2024

New feature
in Moodle 5.0!


Moodle LMS’s integration with Azure AI provides access to AI Actions such as generate text, generate an image or summarise course content.

More information about Azure AI can be found at https://learn.microsoft.com/en-us/azure/ai-services/openai

Requirements:

An active Azure account. If you don’t have one, you can create it through the Azure portal.

Ensure you have an active subscription to access Azure AI services. Obtain the API key and endpoint from the Azure Portal to authenticate your requests (This is found under the "Keys and Endpoint" section of your resource.)

Configuring Azure AI API provider

  1. Go to Site administration -> General -> AI -> AI providers
  2. Enable the "Azure AI API Provider" by clicking on the “Enabled” toggle.
  3. Click on the "Azure AI API Provider" settings link.
  4. In the “Settings” area proceed to configure the following:
    • Azure AI API key: You can find the key in your Azure AI account.
    • Azure AI API endpoint:  Enter the endpoint URL for your Azure AI API, in the following format: https://YOUR_RESOURCE_NAME.openai.azure.com.
    • Set site-wide rate limit:  An optional feature to limit the number of requests that the Azure AI 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 enabling “Set user rate limit”
  5. In the “Actions” area you can control which available Actions are enabled and configure further Action settings.

Configuring Azure AI API Provider Actions

Azure AI Actions


The following Action settings are available for the Azure AI API Provider.

Generate text: You can configure the following settings:

  • Deployment ID:  The unique identifier assigned to a specific model deployment, which you can find in the "Deployments" section of your Azure OpenAI resource in the Azure Portal.
  • API version: The API specific version of the API you're interacting with, you can find the latest available version under the "API Management" section of your Azure OpenAI resource.
  • 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:

  • Deployment ID: The unique identifier assigned to the specific DALL-E model deployment, which you can find in the "Deployments" section of your Azure OpenAI resource in the Azure Portal, allowing you to generate images via API requests.
  • API version. The API specific version of the API you're interacting with, you can find the latest available version under the "API Management" section of your Azure OpenAI resource.

With all of the above enabled and configured, the Azure AI API 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 settings.

Azure AI Provider - Generate text
Azure AI Provider - Generate image
Retrieved from "https://docs.moodle.org/500/en/index.php?title=Azure_AI_API_provider&oldid=149679"
Powered by MediaWiki