Skip to content

Commit 814c19a

Browse files
authored
Create openapi-spec.md
create openapi spec concept page, waiting for python code sample
1 parent 44d89b9 commit 814c19a

File tree

1 file changed

+42
-0
lines changed

1 file changed

+42
-0
lines changed
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
title: 'How to use Azure AI Agent service with OpenAPI Specified Tools'
3+
titleSuffix: Azure OpenAI
4+
description: Learn how to use Azure AI Agents with OpenAPI Specified Tools.
5+
services: cognitive-services
6+
manager: nitinme
7+
ms.service: azure
8+
ms.topic: how-to
9+
ms.date: 12/06/2024
10+
author: aahill
11+
ms.author: aahi
12+
zone_pivot_groups: selection-function-calling
13+
recommendations: false
14+
---
15+
# How to use Azure AI Agent service with OpenAPI Specified Tools
16+
17+
::: zone pivot="overview"
18+
19+
You can now connect your Azure AI Agent to an external API using an OpenAPI 3.0 specified tool,
20+
allowing for scalable interoperability with various applications. Enable your custom tools
21+
to authenticate access and connections with managed identities (Microsoft Entra ID) for
22+
added security, making it ideal for integrating with existing infrastructure or web services.
23+
24+
OpenAPI Specified tool improves your function calling experience by providing standardized,
25+
automated, and scalable API integrations that enhance the capabilities and efficiency of your agent.
26+
[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 much, much more.
29+
30+
## Set up
31+
1. Ensure you've completed the prerequisites and setup steps in the [quickstart](../../quickstart.md).
32+
33+
::: zone-end
34+
35+
::: zone pivot="code-example"
36+
## Step 1: Create an agent with OpenAPI Spec tool
37+
38+
## Step 2: Enable the OpenAPI Spec tool
39+
40+
## Step 3: Create a thread
41+
42+
## Step 4: Create a run and check the output

0 commit comments

Comments
 (0)