Skip to content

Latest commit

 

History

History
277 lines (186 loc) · 15.7 KB

functions-add-openai-text-completion.md

File metadata and controls

277 lines (186 loc) · 15.7 KB
titledescriptionms.datems.topicauthorms.authorms.collectionzone_pivot_groups
Tutorial: Add Azure OpenAI text completions to your functions in Visual Studio Code
Learn how to connect Azure Functions to OpenAI by adding an output binding to your Visual Studio Code project.
07/11/2024
tutorial
dbandaru
dbandaru
ce-skilling-ai-copilot
programming-languages-set-functions

Tutorial: Add Azure OpenAI text completion hints to your functions in Visual Studio Code

This article shows you how to use Visual Studio Code to add an HTTP endpoint to the function app you created in the previous quickstart article. When triggered, this new HTTP endpoint uses an Azure OpenAI text completion input binding to get text completion hints from your data model.

During this tutorial, you learn how to accomplish these tasks:

[!div class="checklist"]

  • Create resources in Azure OpenAI.
  • Deploy a model in the OpenAI resource.
  • Set access permissions to the model resource.
  • Enable your function app to connect to OpenAI.
  • Add OpenAI bindings to your HTTP triggered function.

1. Check prerequisites

:::zone pivot="programming-language-csharp"

2. Create your Azure OpenAI resources

The following steps show how to create an Azure OpenAI data model in the Azure portal.

  1. Sign in with your Azure subscription in the Azure portal.

  2. Select Create a resource and search for the Azure OpenAI. When you locate the service, select Create.

  3. On the Create Azure OpenAI page, provide the following information for the fields on the Basics tab:

    FieldDescription
    SubscriptionYour subscription, which has been onboarded to use Azure OpenAI.
    Resource groupThe resource group you created for the function app in the previous article. You can find this resource group name by right-clicking the function app in the Azure Resources browser, selecting properties, and then searching for the resourceGroup setting in the returned JSON resource file.
    RegionIdeally, the same location as the function app.
    NameA descriptive name for your Azure OpenAI Service resource, such as mySampleOpenAI.
    Pricing TierThe pricing tier for the resource. Currently, only the Standard tier is available for the Azure OpenAI Service. For more info on pricing visit the Azure OpenAI pricing page

    :::image type="content" source="/azure/ai-services/openai/media/create-resource/create-resource-basic-settings.png" alt-text="Screenshot that shows how to configure an Azure OpenAI resource in the Azure portal.":::

  4. Select Next twice to accept the default values for both the Network and Tags tabs. The service you create doesn't have any network restrictions, including from the internet.

  5. Select Next a final time to move to the final stage in the process: Review + submit.

  6. Confirm your configuration settings, and select Create.

    The Azure portal displays a notification when the new resource is available. Select Go to resource in the notification or search for your new Azure OpenAI resource by name.

  7. In the Azure OpenAI resource page for your new resource, select Click here to view endpoints under Essentials > Endpoints. Copy the endpoint URL and the keys. Save these values, you need them later.

Now that you have the credentials to connect to your model in Azure OpenAI, you need to set these access credentials in application settings.

3. Deploy a model

Now you can deploy a model. You can select from one of several available models in Azure OpenAI Studio.

To deploy a model, follow these steps:

  1. Sign in to Azure OpenAI Studio.

  2. Choose the subscription and the Azure OpenAI resource you created, and select Use resource.

  3. Under Management select Deployments.

  4. Select Create new deployment and configure the following fields:

    FieldDescription
    Deployment nameChoose a name carefully. The deployment name is used in your code to call the model by using the client libraries and the REST APIs, so you must save for use later on.
    Select a modelModel availability varies by region. For a list of available models per region, see Model summary table and region availability.

    [!IMPORTANT] When you access the model via the API, you need to refer to the deployment name rather than the underlying model name in API calls, which is one of the key differences between OpenAI and Azure OpenAI. OpenAI only requires the model name. Azure OpenAI always requires deployment name, even when using the model parameter. In our docs, we often have examples where deployment names are represented as identical to model names to help indicate which model works with a particular API endpoint. Ultimately your deployment names can follow whatever naming convention is best for your use case.

  5. Accept the default values for the rest of the setting and select Create.

    The deployments table shows a new entry that corresponds to your newly created model.

You now have everything you need to add Azure OpenAI-based text completion to your function app.

4. Update application settings

  1. In Visual Studio Code, open the local code project you created when you completed the previous article.

  2. In the local.settings.json file in the project root folder, update the AzureWebJobsStorage setting to UseDevelopmentStorage=true. You can skip this step if the AzureWebJobsStorage setting in local.settings.json is set to the connection string for an existing Azure Storage account instead of UseDevelopmentStorage=true.

  3. In the local.settings.json file, add these settings values:

    • AZURE_OPENAI_ENDPOINT: required by the binding extension. Set this value to the endpoint of the Azure OpenAI resource you created earlier.
    • AZURE_OPENAI_KEY: required by the binding extension. Set this value to the key for the Azure OpenAI resource.
    • CHAT_MODEL_DEPLOYMENT_NAME: used to define the input binding. Set this value to the name you chose for your model deployment.

  4. Save the file. When you deploy to Azure, you must also add these settings to your function app.

:::zone pivot="programming-language-csharp"

5. Register binding extensions

Because you're using an Azure OpenAI output binding, you must have the corresponding bindings extension installed before you run the project.

Except for HTTP and timer triggers, bindings are implemented as extension packages. To add the Azure OpenAI extension package to your project, run this dotnet add package command in the Terminal window:

dotnet add package Microsoft.Azure.Functions.Worker.Extensions.OpenAI --prerelease

:::zone-end :::zone pivot="programming-language-java,programming-language-javascript,programming-language-typescript,programming-language-python,programming-language-powershell"

5. Update the extension bundle

To access the preview Azure OpenAI bindings, you must use a preview version of the extension bundle that contains this extension.

Replace the extensionBundle setting in your current host.json file with this JSON:

"extensionBundle": { "id": "Microsoft.Azure.Functions.ExtensionBundle.Preview", "version": "[4.*, 5.0.0)" }

:::zone-end Now, you can use the Azure OpenAI output binding in your project.

6. Return text completion from the model

The code you add creates a whois HTTP function endpoint in your existing project. In this function, data passed in a URL name parameter of a GET request is used to dynamically create a completion prompt. This dynamic prompt is bound to a text completion input binding, which returns a response from the model based on the prompt. The completion from the model is returned in the HTTP response. :::zone pivot="programming-language-csharp"

  1. In your existing HttpExample class file, add this using statement:

    :::code language="csharp" source="~/functions-openai-extension/samples/textcompletion/csharp-ooproc/TextCompletions.cs" range="5" :::

  2. In the same file, add this code that defines a new HTTP trigger endpoint named whois:

    [Function(nameof(WhoIs))]publicIActionResultWhoIs([HttpTrigger(AuthorizationLevel.Function,Route="whois/{name}")]HttpRequestreq,[TextCompletionInput("Who is {name}?",Model="%CHAT_MODEL_DEPLOYMENT_NAME%")]TextCompletionResponseresponse){if(!String.IsNullOrEmpty(response.Content)){returnnewOkObjectResult(response.Content);}else{returnnewNotFoundObjectResult("Something went wrong.");}}

:::zone-end
:::zone pivot="programming-language-java"

  1. Update the pom.xml project file to add this reference to the properties collection:

    :::code language="xml" source="~/functions-openai-extension/samples/textcompletion/java/pom.xml" range="18" :::

  2. In the same file, add this dependency to the dependencies collection:

    :::code language="xml" source="~/functions-openai-extension/samples/textcompletion/java/pom.xml" range="29-33" :::

  3. In the existing Function.java project file, add these import statements:

    :::code language="java" source="~/functions-openai-extension/samples/textcompletion/java/src/main/java/com/azfs/TextCompletions.java" range="19-20" :::

  4. In the same file, add this code that defines a new HTTP trigger endpoint named whois:

    :::code language="java" source="~/functions-openai-extension/samples/textcompletion/java/src/main/java/com/azfs/TextCompletions.java" range="31-46" :::

:::zone-end
:::zone pivot="programming-language-javascript"

  1. In Visual Studio Code, Press F1 and in the command palette type Azure Functions: Create Function..., select HTTP trigger, type the function name whois, and press Enter.

  2. In the new whois.js code file, replace the contents of the file with this code:

    :::code language="javascript" source="~/functions-openai-extension/samples/textcompletion/javascript/src/functions/whois.js" :::

:::zone-end
:::zone pivot="programming-language-typescript"

  1. In Visual Studio Code, Press F1 and in the command palette type Azure Functions: Create Function..., select HTTP trigger, type the function name whois, and press Enter.

  2. In the new whois.ts code file, replace the contents of the file with this code:

    :::code language="typescript" source="~/functions-openai-extension/samples/textcompletion/typescript/src/functions/whois.ts" :::

:::zone-end
:::zone pivot="programming-language-python"

  1. In the existing function_app.py project file, add this import statement:

    :::code language="python" source="~/functions-openai-extension/samples/textcompletion/python/function_app.py" range="1" :::

  2. In the same file, add this code that defines a new HTTP trigger endpoint named whois: :::code language="python" source="~/functions-openai-extension/samples/textcompletion/python/function_app.py" range="7-18" :::

:::zone-end
:::zone pivot="programming-language-powershell"

  1. In Visual Studio Code, Press F1 and in the command palette type Azure Functions: Create Function..., select HTTP trigger, type the function name whois, select Anonymous, and press Enter.

  2. Open the new whois/function.json code file and replace its contents with this code, which adds a definition for the TextCompletionResponse input binding:

    :::code language="json" source="~/functions-openai-extension/samples/textcompletion/powershell/WhoIs/function.json" :::

  3. Replace the content of the whois/run.ps1 code file with this code, which returns the input binding response:

    :::code language="powershell" source="~/functions-openai-extension/samples/textcompletion/powershell/WhoIs/run.ps1" :::

:::zone-end

7. Run the function

  1. In Visual Studio Code, Press F1 and in the command palette type Azurite: Start and press Enter to start the Azurite storage emulator.

  2. Press F5 to start the function app project and Core Tools in debug mode.

  3. With the Core Tools running, send a GET request to the whois endpoint function, with a name in the path, like this URL:

    http://localhost:7071/api/whois/<NAME>

    Replace the <NAME> string with the value you want passed to the "Who is {name}?" prompt. The <NAME> must be the URL-encoded name of a public figure, like Abraham%20Lincoln.

    The response you see is the text completion response from your Azure OpenAI model.

  4. After a response is returned, press Ctrl + C to stop Core Tools.

8. Clean up resources

In Azure, resources refer to function apps, functions, storage accounts, and so forth. They're grouped into resource groups, and you can delete everything in a group by deleting the group.

You created resources to complete these quickstarts. You could be billed for these resources, depending on your account status and service pricing. If you don't need the resources anymore, here's how to delete them:

[!INCLUDE functions-cleanup-resources-vs-code-inner.md]

Related content

close