Welcome to the AI Hackathon Starter Kit! These instructions will help you get started with the cloud environment for the hackathon.
The starter kit is designed to be used with the following cloud services:
- Azure Speech Services
- Azure Text Analytics Services
- Open AI Services (You can use either openai.com or the Azure Open AI service. You don't need both.)
Once you have finished reading this guide, go back to the Getting Started page to continue.
Azure Speech Services is a cloud-based API that provides developers with access to speech-to-text and text-to-speech capabilities. The service is available in 3 different tiers: Free, Standard, and Premium. The Free tier is limited to 5,000 transactions per month, while the Standard and Premium tiers are limited to 500,000 transactions per month. For more information on the Azure Speech Services, please visit the Azure Speech Services Documentation.
- Navigate to the Azure Portal and login with your Azure account.
- Click on the Create a resource button (big plus sign) in the top left corner of the portal.
- Search for Speech and select Speech from the search results.
- Click on the Create button.
- Enter a unique name for your Speech Service resource.
- Select the Free pricing tier.
- Select the Location closest to you.
- Click on the Review + create button.
- Click on the Create button.
- Once the resource has been created, click on the Go to resource button.
- Click on the Keys and Endpoint button in the left navigation bar.
- Copy the
location
&key
of the Speech Service resource into a text editor for later. You will use it when setting up your .env file.
Azure Text Analytics Services is a cloud-based API that provides developers with access to sentiment analysis, key phrase extraction, language detection, and entity recognition capabilities. The service is available in 3 different tiers: Free, Standard, and Premium. The Free tier is limited to 5,000 transactions per month, while the Standard and Premium tiers are limited to 500,000 transactions per month. For more information on the Azure Text Analytics Services, please visit the Azure Text Analytics Services Documentation.
- Navigate to the Azure Portal and login with your Azure account.
- Click on the Create a resource button (big plus sign) in the top left corner of the portal.
- Search for Language Service and select Language Service from the search results. (Note: Language Service is different from Language Understanding Service).
- Click on the Create button. (Use th default features)
- Enter a unique name for your Language Service resource.
- Select the Free pricing tier.
- Select the Location closest to you.
- Click on the Review + create button.
- Click on the Create button.
- Once the resource has been created, click on the Go to resource button.
- Click on the Keys and Endpoint button in the left navigation bar.
- Copy the
location
,key
andendpoint
of the Language Service resource into a text editor for later. You will use it when setting up your .env file.
Azure OpenAI Service provides REST API access to OpenAI's powerful language models including the GPT-3, Codex and Embeddings model series. In addition, the new GPT-4 and ChatGPT (gpt-35-turbo) model series are now available in preview. These models can be easily adapted to your specific task including but not limited to content generation, summarization, semantic search, and natural language to code translation. Users can access the service through REST APIs, Python SDK, or web-based interface in the Azure OpenAI Studio.
Note: Currently, access to this service is granted only by application. You can apply for access to Azure OpenAI by completing the form at https://aka.ms/oai/access. Open an issue on this repo to contact us if you have an issue.
- Navigate to the Azure Portal and login with your Azure account.
- Click on the Create a resource button (big plus sign) in the top left corner of the portal.
- Follow these instructions to create an Azure OpenAI resource.
- Navigate to the Azure Open AI studio and login with your Azure account.
- Choose your Directory, Subscription and Resource where you created the service.
- Click on the Deployments navigation item in the left navigation bar.
- Click on the Create new deployment button.
- Choose the text-davinci-003 model.
- Enter a unique name for your model. (Ideally keep it
text-davinci-003
so that it's easy to find later.) - Now repeat steps 3-6 for the gpt-35-turbo model.
- If you have access to gpt4 model, repeat steps 3-6 for the gpt4 model.
- Navigate to the settings cog wheel on the top right(ish) corner of the page.
- Select Resource Settings.
- Copy the
key
,endpoint
andLocation
of the Azure Open AI Services resource into a text editor for later. You will use it when setting up your .env file.
Note: You don't need both Open AI Services and Azure Open AI Services. You can use either one.
Open AI Services is a cloud-based API that provides developers with access to a variety of AI capabilities. At the tim of writing this document, openai provides an option to "Start for free (Start experimenting with $5 in free credit that can be used during your first 3 months). See Open AI Pricing for more information.
- Navigate to the Open AI Services Portal and login or register.
- After setting up your account & billing you will be able to access the API keys.
- Copy the
key
of the Open AI Services resource into a text editor for later. You will use it when setting up your .env file.