Skip to content

Commit 78952cf

Browse files
lindazqlilindazqli
authored
Add files via upload
1 parent 10f39a2 commit 78952cf

File tree

3 files changed

+120
-0
lines changed

3 files changed

+120
-0
lines changed

‎samples/microsoft/python/getting-started-agents/3p-tools/PartnerContributingGuide.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# 3p Tool Partner Contributing Guide
2+
3+
## Who should read this?
4+
This contributing guide is designed for partners who want to bring their APIs as part of the **Azure AI Foundry Tool Catalog** so that customers can integrate your APIs with Azure AI Agent service through a tool to retrieve data or integrating with a workflow.
5+
6+
## Prepare your PR
7+
Your PR needs to create a new folder with the tool name and include the following information:
8+
- `README.md` (required): follow this [template](./README_template_for_parter.md) as an example and this README file will serve as public documentation for help customers set up and use the tool with your API through Azure AI Agent service
9+
- The name, logo, and description in this README file will be used in the Azure AI Foundry Portal user experience and marketing materials.
10+
- It must include how customers set up an account with your API directly and your customer support contact or website.
11+
- Customers should be able to follow this README file and successfully use the tool with Azure AI Agent service.
12+
- `sample code` (required): using at least one of the SDK below
13+
- (recommended) Python: [Azure AI Projects client library for Python | Microsoft Learn](https://learn.microsoft.com/en-us/python/api/overview/azure/ai-projects-readme?view=azure-python-preview#create-agent-with-openapi)
14+
- .NET/C#: [Azure AI Projects client library for .NET - Azure for .NET Developers | Microsoft Learn](https://learn.microsoft.com/en-us/dotnet/api/overview/azure/ai.projects-readme?view=azure-dotnet-preview)
15+
- JavaScript: [Azure AI Projects client library for JavaScript | Microsoft Learn](https://learn.microsoft.com/en-us/javascript/api/overview/azure/ai-projects-readme?view=azure-node-preview)
16+
- Requirements fot the code sample:
17+
- you should have tested the code sample works end to end with the OpenAPI spec in this PR before submitting
18+
- include the process of creating an `openApi` tool with your OpenAPI spec
19+
- for `agent creation`, provide a user-friendly name and useful instructions customized for your API
20+
- for `message creation`, provide an example of a user query that can be used with your API and expected response in comments
21+
- `OpenAPI spec` (required): the OpenAPI spec for your API
22+
- Your OpenAPI should be updated based on the requirements [here](https://learn.microsoft.com/en-us/azure/ai-services/agents/how-to/tools/openapi-spec?tabs=python&pivots=overview#authenticating-with-api-key) to support appropriate authentication method
23+
- If you require customers to update the OpenAPI spec, please provide **clear** instructions and **placeholder** on where they should update in the OpenAPI spec file and the README.file.
24+
- This OpenAPI spec will also be used in the Azure AI Foundry Portal user experience.
25+
- `media` folder (optional): if you need to include any screenshots, please add the screenshots in this folder and refer to them.
26+
27+
## Submit your PR
28+
Before you submit the PR, please double check:
29+
- you have **everything** required above ready
30+
- you have **fully** tested your code sample
31+
32+
Then, you can go ahead and create a PR. By creating a PR, you automatically agree to the Contributor License Agreement and see more details [here](../../../CONTRIBUTING.md).
33+
34+
When creating the PR, please make sure you give your PR a reviewer-friendly name. We will come back to you within 10 business days.
35+
36+
## Once your PR is approved
37+
- customers will see a folder for the tool in `main` branch
38+
- Azure AI Foundry Portal team will work to bring your tool to the Portal user experience.

‎samples/microsoft/python/getting-started-agents/3p-tools/README.md‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Connect with partner-authored tools in Azure AI Agent Service
2+
3+
## Overview
4+
The tool catalog in Azure AI Foundry portal is the hub to discover and use a wide range of tools for building AI agents with Azure AI Agent Service. The tool catalog features tools for extending your agents' abilities using hosted tools, and ones offered from partners such as Tripadvisor, and Morningstar. You can discover all tools offered by **partners** in this folder.
5+
6+
> [!IMPORTANT]
7+
> * Your use of connected non-Microsoft services is subject to the terms between you and the service provider. By connecting to a non-Microsoft service, you acknowledge that some of your data, such as prompt content, is passed to the non-Microsoft service, and/or your application might receive data from the non-Microsoft service. You're responsible for your use of non-Microsoft data.
8+
> * Using tools from tool catalog may incur usage with tool providers, review the pricing plan with your selected tool data providers.
9+
> * Code samples and OpenAPI spec are provided by partners as-is. **need help from CELA to rewrite this**
10+
11+
## Get Started
12+
1. Create an Azure AI Agent following the [documentation](https://learn.microsoft.com/en-us/azure/ai-services/agents/quickstart)
13+
14+
1. Select tools provided by our partners for your agent
15+
16+
|Tool |Description |
17+
|---------|---------|
18+
| [Tripadvisor](./Tripadvisor/README.md) | This tool lets you access Tripadvisor's useful travel platform that can, for example, provide travel guidance and reviews. |
19+
20+
1. Review the README file provided by the partner and get started!
21+
22+
## Frequently Asked Questions
23+
1. Can I set up an account through Microsoft with the tool provided by a partner?
24+
25+
No, you have to create an account with the partner directly.
26+
27+
1. I am running into issues with the code sample, how should I troubleshoot?
28+
29+
If this is an issue with Azure AI Agent service, please refer to your [support plan](https://support.microsoft.com/en-us). If this is an issue with the OpenAPI spec, code sample or authentication, please refer to the `customer support contact` provided by each partner in the README file.
30+
31+
1. I want to learn more about Azure AI Agent service, where should I go?
32+
33+
Please visit the public documentation [here](https://learn.microsoft.com/en-us/azure/ai-services/agents/)
34+

‎samples/microsoft/python/getting-started-agents/3p-tools/README_template_for_partner.md‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# <tool_name>
2+
<tool_name> will be used in Azure AI Foundry Portal experience and marketing materials.
3+
4+
Requirement:
5+
- Must exist and be written in English.
6+
- Must be unique and distinguishable from any existing tool/agent template.
7+
- Should be the name of your product or organization.
8+
- Can't be longer than 30 characters.
9+
- Can't contain the words *API*, *Tool*, *Azure AI Agent Service*, *Azure AI*, *Agent*, or any of our other Azure AI Foundry product names (for example, Document Intelligence).
10+
- Can't end in a nonalphanumeric character, including carriage return, new line, or blank space.
11+
- Good example: Tripadvisor
12+
- Bad example: Tripadvisor Tool
13+
14+
## Description
15+
<tool_description>
16+
17+
<tool_descrption> will be used in Azure AI Foundry Portal experience and marketing materials.
18+
19+
Requirement:
20+
- Ensure your description complies with the [Marketplace guidelines](https://learn.microsoft.com/en-us/legal/marketplace/certification-policies#10013-description).
21+
- Must exist and be written in English.
22+
- Must be free of grammatical and spelling errors.
23+
- Length should be within 1 sentence, under 10 words
24+
- Cannot contain *Azure AI Agent Service* or other Azure AI Foundry product names (such as Document Intelligence)
25+
- If your tool includes multiple operations, the description should cover all operations.
26+
27+
## Prerequisites
28+
<prerequisites_in_bullet_points>
29+
30+
Requirement:
31+
- Must include how to create a new account with your service
32+
- Include any other requirements to set up the account, such as uploading data, etc
33+
- Recommend including screenshots if possible to help customers understand. Store the screenshots in `media` folder
34+
35+
## Setup
36+
<setup_in_bullet_points>
37+
38+
Requirement:
39+
- If you require customers to use `connection` as authentication methods, walk customers from step by step to retrieve the secret (API key, token etc) and how to create a `customKeys` connection to store the secret
40+
- Recommend including screenshots if possible to help customers understand. Store the screenshots in `media` folder
41+
42+
## Use <tool_name>
43+
<explanation_for_using_your_code_sample>
44+
45+
## Customer Support Contact
46+
<your_customer_support_contact_or_website>
47+
48+
By providing this customer support contact or website, customers will reach out to you directly if they run into issues with the OpenAPI spec, code sample, authentication etc. Customers will reach out to Microsoft if they run into issues with Azure AI Agent service.

0 commit comments

Comments
 (0)