Skip to content

Commit 2566586

Browse files
authored
Merge pull request #2108 from MicrosoftDocs/main
12/23/2024 AM Publish
2 parents 6a825e5 + 8a7bf4c commit 2566586

23 files changed

+66
-66
lines changed

articles/ai-services/agents/concepts/agents.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,9 @@ Azure AI Agent Service is now available in public preview. The service makes it
2424

2525
Previously, building custom AI agents needed heavy lifting even for experienced developers. While many APIs are lightweight and powerful like Azure OpenAI's chat completions API, it's inherently stateless which means that developers had to manage conversation state and chat threads, tool integrations, retrieval documents and indexes, and execute code manually.
2626

27-
Azure AI Agents Service, as the evolution of the chat completion API and Assistants, provides a solution for these challenges. Agents support persistent automatically managed threads. This means that as a developer you no longer need to develop conversation state management systems and work around a model’s context window constraints. Agents will automatically handle the optimizations to keep the thread below the max context window of your chosen model. Once you create a thread, you can append new messages to it as users respond. Agents can also access multiple [tools](../how-to/tools/overview.md) in parallel.
27+
Azure AI Agent Service, as the evolution of the chat completion API and Assistants, provides a solution for these challenges. Agents support persistent automatically managed threads. This means that as a developer you no longer need to develop conversation state management systems and work around a model’s context window constraints. Agents will automatically handle the optimizations to keep the thread below the max context window of your chosen model. Once you create a thread, you can append new messages to it as users respond. Agents can also access multiple [tools](../how-to/tools/overview.md) in parallel.
2828

29-
Azure AI Agents Service is built on the same capabilities that power Azure OpenAI's assistants. Some possible use cases range from AI-powered product recommender, sales analyst app, coding assistant, employee Q&A chatbot, and more.
29+
Azure AI Agent Service is built on the same capabilities that power Azure OpenAI's assistants. Some possible use cases range from AI-powered product recommender, sales analyst app, coding assistant, employee Q&A chatbot, and more.
3030

3131
> [!IMPORTANT]
3232
> Retrieving untrusted data using Function Calling, Code Interpreter or File Search with file input, and agent threads functionalities could compromise the security of your agent, or the application that uses the agent.
@@ -75,7 +75,7 @@ When using the File Search tool, we recommend setting the `max_prompt_tokens` to
7575

7676
## Truncation strategy
7777

78-
You can also specify a truncation strategy to control how your thread should be rendered into the model's context window. Using a truncation strategy of type `auto` will use OpenAI's default truncation strategy. Using a truncation strategy of type `last_messages` will allow you to specify the number of the most recent messages to include in the context window.
78+
You can also specify a truncation strategy to control how your thread should be rendered into the model's context window. Using a truncation strategy of type `auto` will use Azure OpenAI's default truncation strategy. Using a truncation strategy of type `last_messages` will allow you to specify the number of the most recent messages to include in the context window.
7979

8080
## See also
8181
* Learn more about [agents](../overview.md). <!--and [File Search](../how-to/tools/file-search.md)-->

articles/ai-services/agents/concepts/model-region-support.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,11 @@ ms.custom: azure-ai-agents
1313

1414
# Models supported by Azure AI Agent Service
1515

16-
Agents are powered by a diverse set of models with different capabilities and price points. Model availability varies by region and cloud. Certain tools and capabilities require the latest models. The following models are available in the available SDKs. The following table is for pay-as-you-go. For information on Provisioned Throughput Unit (PTU) availability, see [provisioned throughput](../../openai/concepts/provisioned-throughput.md) in the OpenAI documentation. You can use [global standard models](../../openai/concepts/models.md#global-standard-model-availability) if they're supported in the regions listed here.
16+
Agents are powered by a diverse set of models with different capabilities and price points. Model availability varies by region and cloud. Certain tools and capabilities require the latest models. The following models are available in the available SDKs. The following table is for pay-as-you-go. For information on Provisioned Throughput Unit (PTU) availability, see [provisioned throughput](../../openai/concepts/provisioned-throughput.md) in the Azure OpenAI documentation. You can use [global standard models](../../openai/concepts/models.md#global-standard-model-availability) if they're supported in the regions listed here.
1717

1818
## Azure OpenAI models
1919

20-
Azure AI Agent service supports the same models as the chat completions API in Azure OpenAI, in the following regions.
20+
Azure AI Agent Service supports the same models as the chat completions API in Azure OpenAI, in the following regions.
2121

2222
| **Region** | **gpt-4o**, **2024-05-13** | **gpt-4o**, **2024-08-06** | **gpt-4o-mini**, **2024-07-18** | **gpt-4**, **0613** | **gpt-4**, **1106-Preview** | **gpt-4**, **0125-Preview** | **gpt-4**, **vision-preview** | **gpt-4**, **turbo-2024-04-09** | **gpt-4-32k**, **0613** | **gpt-35-turbo**, **0613** | **gpt-35-turbo**, **1106** | **gpt-35-turbo**, **0125** | **gpt-35-turbo-16k**, **0613** |
2323
|:--------------|:--------------------------:|:--------------------------:|:-------------------------------:|:-------------------:|:---------------------------:|:---------------------------:|:-----------------------------:|:-------------------------------:|:--------------------------:|:--------------------------:|:--------------------------:|:------------------------------:|
@@ -28,29 +28,29 @@ Azure AI Agent service supports the same models as the chat completions API in A
2828
| westus |||| - || - ||| - | - ||| - |
2929

3030

31-
## Additional models
31+
## More models
3232

33-
In addition to the supported Azure OpenAI models, you can also use the following 3rd party models with Azure AI Agent Service.
33+
The Azure AI Agent Service also supports the following models from the Azure AI Foundry model catalog.
3434

3535
* Llama 3.1-70B-instruct
3636
* Mistral-large-2407
3737
* Cohere command R+
3838

3939
To use these models, you can use Azure AI Foundry portal to make a deployment, and then reference it in your agent.
4040

41-
1. Go to the [Azure AI Foundry portal](https://ai.azure.com/) and select **Model catalog** in the left navigation menu, and scroll down to **Meta-Llama-3-70B-Instruct**. You can also find and use one of the models listed above.
41+
1. Go to the [Azure AI Foundry portal](https://ai.azure.com/) and select **Model catalog** in the left navigation menu, and scroll down to **Meta-Llama-3-70B-Instruct**. You can also find and use one of the models listed previously.
4242

4343
1. Select **Deploy**.
4444

4545
1. In the Deployment options screen that appears, select **Serverless API** with Azure AI Content Safety.
4646

4747
:::image type="content" source="../media/llama/llama-deployment.png" alt-text="An image of the llama model project selection screen.":::
4848

49-
1. Select your project and click **Subscribe and deploy**.
49+
1. Select your project and then select **Subscribe and deploy**.
5050

5151
:::image type="content" source="../media/llama/llama-deployment-2.png" alt-text="An image of the llama model deployment screen.":::
5252

53-
1. Add the serverless connection to your hub/project. The deployment name you choose will be the one you reference in your code.
53+
1. Add the serverless connection to your hub/project. The deployment name you choose is the one that you reference in your code.
5454

5555
1. When calling agent creation API, set the `models` parameter to your deployment name. For example:
5656

articles/ai-services/agents/faq.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ sections:
1919
- question: |
2020
Do you store any data used in the AI Agent Service API?
2121
answer: |
22-
Yes. Unlike Chat Completions API, Azure OpenAI AI Agent Service is a stateful API, meaning it retains data. There are two types of data stored in the AI Agent Service API:
22+
Yes. Unlike Chat Completions API, Azure AI Agent Service is a stateful API, meaning it retains data. There are two types of data stored in the AI Agent Service API:
2323
* Stateful entities: Threads, messages, and runs created during AI Agent Service use.
2424
* Files: Uploaded during AI Agent Service setup or as part of a message.
2525
- question: |
@@ -41,7 +41,7 @@ sections:
4141
- question: |
4242
Where is data stored geographically?
4343
answer: |
44-
Azure OpenAI AI Agent Service endpoints are regional, and data is stored in the same region as the endpoint. For more information, see the [Azure data residency documentation](https://azure.microsoft.com/explore/global-infrastructure/data-residency/#overview).
44+
Azure AI Agent Service endpoints are regional, and data is stored in the same region as the endpoint. For more information, see the [Azure data residency documentation](https://azure.microsoft.com/explore/global-infrastructure/data-residency/#overview).
4545
- question: |
4646
How am I charged for AI Agent Service?
4747
answer: |

articles/ai-services/agents/how-to/tools/azure-functions.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ zone_pivot_groups: selection-function-calling
1717

1818
::: zone pivot="overview"
1919

20-
The Azure AI Agents service integrates with Azure Functions, enabling you to create intelligent, event-driven applications with minimal overhead. This combination allows AI-driven workflows to leverage the scalability and flexibility of serverless computing, making it easier to build and deploy solutions that respond to real-time events or complex workflows.
20+
The Azure AI Agent Service integrates with Azure Functions, enabling you to create intelligent, event-driven applications with minimal overhead. This combination allows AI-driven workflows to leverage the scalability and flexibility of serverless computing, making it easier to build and deploy solutions that respond to real-time events or complex workflows.
2121

2222
Azure Functions provide support for triggers and bindings, which simplify how your AI Agents interact with external systems and services. Triggers determine when a function executes—such as an HTTP request, message from a queue, or a file upload to Azure Blob Storage and allows agents to act dynamically based on incoming events.
2323

@@ -31,7 +31,7 @@ Meanwhile, bindings facilitate streamlined connections to input or output data s
3131

3232
## Prepare your local environment
3333

34-
The following examples highlight how to use the Azure AI Agent service function calling where function calls are placed on a storage queue by the Agent service to be processed by an Azure Function listening to that queue.
34+
The following examples highlight how to use the Azure AI Agent Service function calling where function calls are placed on a storage queue by the Agent Service to be processed by an Azure Function listening to that queue.
3535

3636
You can find the template and code used here on [GitHub](https://github.com/Azure-Samples/azure-functions-ai-services-agent-python).
3737

@@ -136,7 +136,7 @@ Start by defining an Azure Function queue trigger function that will process fun
136136

137137
```python
138138
# Function to get the weather from an Azure Storage queue where the AI Agent will send function call information
139-
# It returns the mock weather to an output queue with the correlation id for the AI Agent service to pick up the result of the function call
139+
# It returns the mock weather to an output queue with the correlation id for the AI Agent Service to pick up the result of the function call
140140
@app.function_name(name="GetWeather")
141141
@app.queue_trigger(arg_name="msg", queue_name="input", connection="STORAGE_CONNECTION")
142142
def process_queue_message(msg: func.QueueMessage) -> None:
@@ -245,7 +245,7 @@ print(f"Created message, message ID: {message.id}")
245245

246246
# Run the agent
247247
run = project_client.agents.create_run(thread_id=thread.id, assistant_id=agent.id)
248-
# Monitor and process the run status. The function call should be placed on the input queue by the Agent service for the Azure Function to pick up when requires_action is returned
248+
# Monitor and process the run status. The function call should be placed on the input queue by the Agent Service for the Azure Function to pick up when requires_action is returned
249249
while run.status in ["queued", "in_progress", "requires_action"]:
250250
time.sleep(1)
251251
run = project_client.agents.get_run(thread_id=thread.id, run_id=run.id)

articles/ai-services/agents/how-to/tools/bing-grounding.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: 'How to use Grounding with Bing Search in Azure AI Agent service'
2+
title: 'How to use Grounding with Bing Search in Azure AI Agent Service'
33
titleSuffix: Azure OpenAI
44
description: Learn how to ground Azure AI Agents using Bing Search results.
55
services: cognitive-services
@@ -109,7 +109,7 @@ from azure.identity import DefaultAzureCredential
109109
from azure.ai.projects.models import BingGroundingTool
110110

111111

112-
# Create an Azure AI Client from a connection string, copied from your AI Studio project.
112+
# Create an Azure AI Client from a connection string, copied from your Azure AI Foundry project.
113113
# At the moment, it should be in the format "<HostName>;<AzureSubscriptionId>;<ResourceGroup>;<HubName>"
114114
# Customer needs to login to Azure subscription via Azure CLI and set the environment variables
115115

articles/ai-services/agents/how-to/tools/code-interpreter.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
title: 'How to use Azure AI Agent service Code Interpreter'
2+
title: 'How to use Azure AI Agent Service Code Interpreter'
33
titleSuffix: Azure OpenAI
4-
description: Learn how to use Azure AI Agent service Code Interpreter
4+
description: Learn how to use Azure AI Agent Service Code Interpreter
55
services: cognitive-services
66
manager: nitinme
77
ms.service: azure-ai-agent-service
@@ -13,7 +13,7 @@ ms.custom: azure-ai-agents
1313
zone_pivot_groups: selection-code-interpreter
1414
---
1515

16-
# Azure AI Agent service Code Interpreter
16+
# Azure AI Agent Service Code Interpreter
1717

1818

1919

articles/ai-services/agents/how-to/tools/file-search.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ The file search tool uses the Azure AI Search and Azure Blob Storage resources y
4545
- Vector stores get created using your connected Azure AI Search resource
4646
<br> </br>
4747

48-
For both agent setups, OpenAI handles the entire ingestion process, which includes:
48+
For both agent setups, Azure OpenAI handles the entire ingestion process, which includes:
4949
- Automatically parsing and chunking documents
5050
- Generating and storing embeddings
5151
- Utilizing both vector and keyword searches to retrieve relevant content for user queries.

articles/ai-services/agents/how-to/tools/function-calling.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: 'How to use Azure AI Agent service with function calling'
2+
title: 'How to use Azure AI Agent Service with function calling'
33
titleSuffix: Azure OpenAI
44
description: Learn how to use Azure AI Agents with function calling.
55
services: cognitive-services
@@ -142,7 +142,7 @@ from azure.identity import DefaultAzureCredential
142142
from azure.ai.projects.models import FunctionTool, ToolSet
143143
from user_functions import user_functions # user functions which can be found in a user_functions.py file.
144144

145-
# Create an Azure AI Client from a connection string, copied from your AI Studio project.
145+
# Create an Azure AI Client from a connection string, copied from your Azure AI Foundry project.
146146
# It should be in the format "<HostName>;<AzureSubscriptionId>;<ResourceGroup>;<HubName>"
147147
# Customers need to login to Azure subscription via Azure CLI and set the environment variables
148148

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: 'How to use Azure AI Agent service with OpenAPI Specified Tools'
2+
title: 'How to use Azure AI Agent Service with OpenAPI Specified Tools'
33
titleSuffix: Azure OpenAI
44
description: Learn how to use Azure AI Agents with OpenAPI Specified Tools.
55
services: cognitive-services
@@ -12,7 +12,7 @@ ms.author: aahi
1212
zone_pivot_groups: selection-function-calling
1313
ms.custom: azure-ai-agents
1414
---
15-
# How to use Azure AI Agent service with OpenAPI Specified Tools
15+
# How to use Azure AI Agent Service with OpenAPI Specified Tools
1616

1717
::: zone pivot="overview"
1818

@@ -94,7 +94,7 @@ from azure.identity import DefaultAzureCredential
9494
from azure.ai.projects.models import OpenApiTool, OpenApiAnonymousAuthDetails
9595

9696

97-
# Create an Azure AI Client from a connection string, copied from your AI Studio project.
97+
# Create an Azure AI Client from a connection string, copied from your Azure AI Foundry project.
9898
# At the moment, it should be in the format "<HostName>;<AzureSubscriptionId>;<ResourceGroup>;<HubName>"
9999
# Customer needs to login to Azure subscription via Azure CLI and set the environment variables
100100

articles/ai-services/agents/how-to/tools/overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: 'Tools available in the Azure AI Agent service'
2+
title: 'Tools available in the Azure AI Agent Service'
33
titleSuffix: Azure OpenAI
44
description: Learn about the various tools available for use by the agents you create.
55
services: cognitive-services

0 commit comments

Comments
 (0)