Prepare to use the AI Content Understanding REST API

Completed

Before you can use the Azure Content Understanding REST API, you need a Foundry Tools multi-services resource in your Azure subscription. You can provision this resource in the following ways:

  • Create a Foundry Tools resource in the Azure portal.
  • Create a Microsoft Foundry hub, which includes a Foundry Tools resource by default.

Tip

Creating a Microsoft Foundry hub enables you to work in a Microsoft Foundry project, in which you can use visual tools to create and manage Azure Content Understanding schemas and analyzers.

After you've provisioned a Foundry Tools resource, you need the following information to connect to the Azure Content Understanding REST API from a client application:

  • The Foundry Tools resource endpoint
  • One of the API keys associated with the endpoint.

You can obtain these values from the Azure portal, as shown in the following image:

Screenshot of the Foundry Tools settings in the Azure portal.

If you're working within a Microsoft Foundry project, you can find the endpoint and key for the associated Foundry Tools resource in the Microsoft Foundry portal, as shown in the following image:

Screenshot of the Foundry Tools settings in the Microsoft Foundry portal.

When working in a Microsoft Foundry project, you can also write code that uses the Microsoft Foundry SDK to connect to the project using Microsoft Entra ID authentication, and retrieve the connection details for the Foundry Tools resource; including the endpoint and key.

Tip

To learn more about programming with the Microsoft Foundry SDK, complete the Develop an AI app with the Microsoft Foundry SDK module.