Skip to content

Commit fbfad62

Browse files
authored
Merge pull request #3605 from aahill/openapi-spec-2
Openapi spec updates
2 parents e4e162f + 4d51a70 commit fbfad62

File tree

3 files changed

+28
-5
lines changed

3 files changed

+28
-5
lines changed

articles/ai-services/agents/how-to/tools/openapi-spec.md

Lines changed: 28 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,14 +24,13 @@ added security, making it ideal for integrating with existing infrastructure or
2424
OpenAPI Specified tool improves your function calling experience by providing standardized,
2525
automated, and scalable API integrations that enhance the capabilities and efficiency of your agent.
2626
[OpenAPI specifications](https://spec.openapis.org/oas/latest.html) provide a formal standard for
27-
describing HTTP APIs. This allows people to understand how an API works, how a sequence of APIs
28-
work together, generate client code, create tests, apply design standards, and more. Currently, we support three authentication types with the OpenAPI 3.0 specified tools: `anonymous`, `API key`, `managed identity`.
27+
describing HTTP APIs. This allows people to understand how an API works, how a sequence of APIs works together, generate client code, create tests, apply design standards, and more. Currently, we support three authentication types with the OpenAPI 3.0 specified tools: `anonymous`, `API key`, `managed identity`.
2928

3029
### Usage support
3130

3231
|Azure AI foundry support | Python SDK | C# SDK | REST API | Basic agent setup | Standard agent setup |
3332
|---------|---------|---------|---------|---------|---------|
34-
| | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ |
33+
| ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ |
3534

3635
## Prerequisites
3736
1. Ensure you've completed the prerequisites and setup steps in the [quickstart](../../quickstart.md).
@@ -128,10 +127,34 @@ To set up authenticating with Managed Identity:
128127

129128
1. Click **Finish**.
130129

131-
1. Once the setup is done, you can continue by using the tool through the SDK or REST API. Use the tabs at the top of this article to see code samples.
130+
1. Once the setup is done, you can continue by using the tool through the Foundry Portal, SDK, or REST API. Use the tabs at the top of this article to see code samples.
132131

133-
::: zone-end
132+
## Add OpenAPI spec tool in the Azure AI Foundry portal
133+
134+
You can add the Grounding with Bing Search tool to an agent programatically using the code examples listed at the top of this article, or the [Azure AI Foundry portal](https://ai.azure.com/). If you want to use the portal:
135+
136+
1. in the **Create and debug** screen or **Agent playground**, select your agent.
137+
1. Scroll down the **Setup** pane on the right to **action**. Then select **Add**.
138+
139+
:::image type="content" source="../../media/tools/action-tools.png" alt-text="A screenshot showing the available tool categories in the Azure AI Foundry portal." lightbox="../../media/tools/action-tools.png":::
140+
141+
1. Select **OpenAPI 3.0 specified tool**.
142+
143+
:::image type="content" source="../../media/tools/action-tools-list.png" alt-text="A screenshot showing the available action tools in the Azure AI Foundry portal." lightbox="../../media/tools/action-tools-list.png":::
144+
145+
1. Give your tool a name (required) and a description (optional). The description will be used by the model to decide when and how to use the tool.
134146

147+
:::image type="content" source="../../media/tools/open-api-details.png" alt-text="A screenshot showing the openAPI tool details in the Azure AI Foundry portal." lightbox="../../media/tools/open-api-details.png":::
148+
149+
1. Click Next and select your authentication method. Choose `connection` for `API key`.
150+
1. If you choose `connection`, you need to select the custom keys connection you have created before.
151+
1. If you choose `managed identity`, you need to input the audience to get your token. An example of an audience would be `https://cognitiveservices.azure.com/` to connect to Azure AI Services. Make sure you have already set up authentication and role assignment (as described in the [section](#authenticating-with-managed-identity-microsoft-entra-id) above).
152+
153+
1. Copy and paste your OpenAPI specification in the text box.
154+
155+
1. Review and add the tool to your agent.
156+
157+
::: zone-end
135158

136159
::: zone pivot="code-example"
137160
## Step 1: Create a project client
56.6 KB
Loading
113 KB
Loading

0 commit comments

Comments
 (0)