Skip to content

Commit 34757fc

Browse files
authored
Merge pull request #2083 from MicrosoftDocs/main
12/19/2024 AM Publish
2 parents f3af792 + 3befd92 commit 34757fc

File tree

117 files changed

+298
-136
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

117 files changed

+298
-136
lines changed

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -133,6 +133,8 @@ ToolOutput GetResolvedToolOutput(RequiredToolCall toolCall)
133133

134134
In the sample below we create a client and define a `toolset` which will be used to process the functions defined in `user_functions`.
135135

136+
`toolset`: When using the toolset parameter, you provide not only the function definitions and descriptions but also their implementations. The SDK will execute these functions within create_and_run_process or streaming. These functions will be invoked based on their definitions.
137+
136138
```python
137139
import os
138140
from azure.ai.projects import AIProjectClient

articles/ai-services/agents/includes/quickstart-python-openai.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,10 @@ with AIProjectClient.from_connection_string(
7070
) as project_client:
7171

7272
# Explicit type hinting for IntelliSense
73-
client: AzureOpenAI = project_client.inference.get_azure_openai_client()
73+
client: AzureOpenAI = project_client.inference.get_azure_openai_client(
74+
# The latest API version is 2024-10-01-preview
75+
api_version = os.environ.get("AZURE_OPENAI_API_VERSION"),
76+
)
7477

7578
with client:
7679
agent = client.beta.assistants.create(

articles/ai-services/computer-vision/category-taxonomy.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ titleSuffix: Azure AI services
44
description: Get the 86 categories of taxonomy for the Azure AI Vision API in Azure AI services.
55
#services: cognitive-services
66
author: PatrickFarley
7+
ms.collection: "ce-skilling-fresh-tier2, ce-skilling-ai-copilot"
78
ms.author: pafarley
89
manager: nitinme
910
ms.service: azure-ai-vision

articles/ai-services/computer-vision/computer-vision-how-to-install-containers.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ manager: nitinme
88
ms.service: azure-ai-vision
99
ms.topic: how-to
1010
ms.date: 06/26/2024
11+
ms.collection: "ce-skilling-fresh-tier2, ce-skilling-ai-copilot"
1112
ms.author: pafarley
1213
keywords: on-premises, OCR, Docker, container
1314
---
@@ -101,7 +102,7 @@ Once the container is on the [host computer](#host-computer-requirements), use t
101102

102103
Use the [docker run](https://docs.docker.com/engine/reference/commandline/run/) command to run the container. Refer to [gather required parameters](#gather-required-parameters) for details on how to get the `{ENDPOINT_URI}` and `{API_KEY}` values.
103104

104-
[Examples](computer-vision-resource-container-config.md#example-docker-run-commands) of the `docker run` command are available.
105+
[Examples](computer-vision-resource-container-config.md#example-docker-commands) of the `docker run` command are available.
105106

106107
```bash
107108
docker run --rm -it -p 5000:5000 --memory 16g --cpus 8 \
@@ -129,7 +130,7 @@ mcr.microsoft.com/azure-cognitive-services/vision/read:3.2-model-2022-04-30
129130
```
130131

131132

132-
More [examples](./computer-vision-resource-container-config.md#example-docker-run-commands) of the `docker run` command are available.
133+
More [examples](./computer-vision-resource-container-config.md#example-docker-commands) of the `docker run` command are available.
133134

134135
> [!IMPORTANT]
135136
> The `Eula`, `Billing`, and `ApiKey` options must be specified to run the container; otherwise, the container won't start. For more information, see [Billing](#billing).

articles/ai-services/computer-vision/computer-vision-resource-container-config.md

Lines changed: 21 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,20 @@
11
---
2-
title: Configure Read OCR containers - Azure AI Vision
2+
title: Configure Read containers - Azure AI Vision
33
titleSuffix: Azure AI services
4-
description: This article shows you how to configure both required and optional settings for Read OCR containers in Azure AI Vision.
4+
description: This article shows you how to configure both required and optional settings for Read optical character recognition (OCR) containers in Azure AI Vision.
55
#services: cognitive-services
66
author: aahill
77
manager: nitinme
88
ms.service: azure-ai-vision
99
ms.topic: how-to
1010
ms.date: 01/19/2024
11+
ms.collection: "ce-skilling-fresh-tier2, ce-skilling-ai-copilot"
1112
ms.author: aahi
1213
---
1314

1415
# Configure Read OCR Docker containers
1516

16-
You can configure the Azure AI Vision Read OCR container's runtime environment by using the `docker run` command arguments. This container has several required settings, along with a few optional settings. Several [examples](#example-docker-run-commands) of the command are available. The container-specific settings are the billing settings.
17+
You can configure the Azure AI Vision Read OCR container's runtime environment by using the `docker run` command arguments. This container has some required settings, along with a few optional settings. Several [examples](#example-docker-commands) of the command are available. The container-specific settings are the billing settings.
1718

1819
## Configuration settings
1920

@@ -26,18 +27,18 @@ The container also has the following container-specific configuration settings:
2627

2728
|Required|Setting|Purpose|
2829
|--|--|--|
29-
|No|ReadEngineConfig:ResultExpirationPeriod| v2.0 containers only. Result expiration period in hours. The default is 48 hours. The setting specifies when the system should clear recognition results. For example, if `resultExpirationPeriod=1`, the system clears the recognition result 1 hour after the process. If `resultExpirationPeriod=0`, the system clears the recognition result after the result is retrieved.|
30-
|No|Cache:Redis| v2.0 containers only. Enables Redis storage for storing results. A cache is *required* if multiple read OCR containers are placed behind a load balancer.|
31-
|No|Queue:RabbitMQ|v2.0 containers only. Enables RabbitMQ for dispatching tasks. The setting is useful when multiple read OCR containers are placed behind a load balancer.|
32-
|No|Queue:Azure:QueueVisibilityTimeoutInMilliseconds | v3.x containers only. The time for a message to be invisible when another worker is processing it. |
33-
|No|Storage::DocumentStore::MongoDB|v2.0 containers only. Enables MongoDB for permanent result storage. |
34-
|No|Storage:ObjectStore:AzureBlob:ConnectionString| v3.x containers only. Azure blob storage connection string. |
35-
|No|Storage:TimeToLiveInDays| v3.x containers only. Result expiration period in days. The setting specifies when the system should clear recognition results. The default is 2 days, which means any result live for longer than that period is not guaranteed to be successfully retrieved. The value is integer and it must be between 1 day to 7 days.|
36-
|No|StorageTimeToLiveInMinutes| v3.2-model-2021-09-30-preview and new containers. Result expiration period in minutes. The setting specifies when the system should clear recognition results. The default is 2 days (2880 minutes), which means any result live for longer than that period is not guaranteed to be successfully retrieved. The value is integer and it must be between 60 minutes to 7 days (10080 minutes).|
37-
|No|Task:MaxRunningTimeSpanInMinutes| v3.x containers only. Maximum running time for a single request. The default is 60 minutes. |
38-
|No|EnableSyncNTPServer| v3.x containers only, except for v3.2-model-2021-09-30-preview and newer containers. Enables the NTP server synchronization mechanism, which ensures synchronization between the system time and expected task runtime. Note that this requires external network traffic. The default is `true`. |
39-
|No|NTPServerAddress| v3.x containers only, except for v3.2-model-2021-09-30-preview and newer containers. NTP server for the time sync-up. The default is `time.windows.com`. |
40-
|No|Mounts:Shared| v3.x containers only. Local folder for storing recognition result. The default is `/share`. For running container without using Azure blob storage, we recommend mounting a volume to this folder to ensure you have enough space for the recognition results. |
30+
|No|`ReadEngineConfig:ResultExpirationPeriod`| v2.0 containers only. Result expiration period in hours. The default is 48 hours. The setting specifies when the system should clear recognition results. For example, if `resultExpirationPeriod=1`, the system clears the recognition result 1 hour after the process. If `resultExpirationPeriod=0`, the system clears the recognition result after the result is retrieved.|
31+
|No|`Cache:Redis`| v2.0 containers only. Enables Redis storage for storing results. A cache is *required* if multiple read OCR containers are placed behind a load balancer.|
32+
|No|`Queue:RabbitMQ`|v2.0 containers only. Enables RabbitMQ for dispatching tasks. The setting is useful when multiple read OCR containers are placed behind a load balancer.|
33+
|No|`Queue:Azure:QueueVisibilityTimeoutInMilliseconds` | v3.x containers only. The time for a message to be invisible when another worker is processing it. |
34+
|No|`Storage::DocumentStore::MongoDB`|v2.0 containers only. Enables MongoDB for permanent result storage. |
35+
|No|`Storage:ObjectStore:AzureBlob:ConnectionString`| v3.x containers only. Azure blob storage connection string. |
36+
|No|`Storage:TimeToLiveInDays`| v3.x containers only. Result expiration period in days. The setting specifies when the system should clear recognition results. The default is two days, which means any result that's live for longer than that period isn't guaranteed to be successfully retrieved. The value is integer and it must be between one day to seven days.|
37+
|No|`StorageTimeToLiveInMinutes`| v3.2-model-2021-09-30-preview and new containers. Result expiration period in minutes. The setting specifies when the system should clear recognition results. The default is two days (2,880 minutes), which means any result that's live for longer than that period isn't guaranteed to be successfully retrieved. The value is integer and it must be between 60 minutes to seven days (10080 minutes).|
38+
|No|`Task:MaxRunningTimeSpanInMinutes`| v3.x containers only. Maximum running time for a single request. The default is 60 minutes. |
39+
|No|`EnableSyncNTPServer`| v3.x containers only, except for v3.2-model-2021-09-30-preview and newer containers. Enables the NTP server synchronization mechanism, which ensures synchronization between the system time and expected task runtime. Note that this requires external network traffic. The default is `true`. |
40+
|No|`NTPServerAddress`| v3.x containers only, except for v3.2-model-2021-09-30-preview and newer containers. NTP server for the time sync-up. The default is `time.windows.com`. |
41+
|No|`Mounts:Shared`| v3.x containers only. Local folder for storing recognition result. The default is `/share`. For running container without using Azure blob storage, we recommend mounting a volume to this folder to ensure you have enough space for the recognition results. |
4142

4243
## ApiKey configuration setting
4344

@@ -65,7 +66,7 @@ Remember to add the `vision/<version>` routing to the endpoint URI as shown in t
6566
|--|------|-----------|-------------|
6667
|Yes| `Billing` | String | Billing endpoint URI<br><br>Example:<br>`Billing=https://westcentralus.api.cognitive.microsoft.com/vision/v3.2` |
6768

68-
## Eula setting
69+
## EULA setting
6970

7071
[!INCLUDE [Container shared configuration eula settings](../includes/cognitive-services-containers-configuration-shared-settings-eula.md)]
7172

@@ -87,19 +88,19 @@ Use bind mounts to read and write data to and from the container. You can specif
8788

8889
The Azure AI Vision containers don't use input or output mounts to store training or service data.
8990

90-
The exact syntax of the host mount location varies depending on the host operating system. Additionally, the [host computer](computer-vision-how-to-install-containers.md#host-computer-requirements)'s mount location may not be accessible due to a conflict between permissions used by the Docker service account and the host mount location permissions.
91+
The exact syntax of the host mount location varies depending on the host operating system. Additionally, the [host computer](computer-vision-how-to-install-containers.md#host-computer-requirements)'s mount location might not be accessible due to a conflict between permissions used by the Docker service account and the host mount location permissions.
9192

9293
|Optional| Name | Data type | Description |
9394
|-------|------|-----------|-------------|
94-
|Not allowed| `Input` | String | Azure AI Vision containers do not use this.|
95+
|Not allowed| `Input` | String | Azure AI Vision containers don't use this field.|
9596
|Optional| `Output` | String | The target of the output mount. The default value is `/output`. This is the location of the logs. This includes container logs. <br><br>Example:<br>`--mount type=bind,src=c:\output,target=/output`|
9697

97-
## Example docker run commands
98+
## Example docker commands
9899

99100
The following examples use the configuration settings to illustrate how to write and use `docker run` commands. Once running, the container continues to run until you [stop](computer-vision-how-to-install-containers.md#stop-the-container) it.
100101

101102
* **Line-continuation character**: The Docker commands in the following sections use the back slash, `\`, as a line continuation character. Replace or remove this based on your host operating system's requirements.
102-
* **Argument order**: Do not change the order of the arguments unless you are very familiar with Docker containers.
103+
* **Argument order**: Do not change the order of the arguments unless you're familiar with Docker containers.
103104

104105
Replace {_argument_name_} with your own values:
105106

articles/ai-services/computer-vision/concept-background-removal.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ manager: nitinme
99
ms.service: azure-ai-vision
1010
ms.topic: conceptual
1111
ms.date: 01/19/2024
12+
ms.collection: "ce-skilling-fresh-tier2, ce-skilling-ai-copilot"
1213
ms.author: pafarley
1314
---
1415

articles/ai-services/computer-vision/concept-categorizing-images.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ manager: nitinme
99
ms.service: azure-ai-vision
1010
ms.topic: conceptual
1111
ms.date: 01/19/2024
12+
ms.collection: "ce-skilling-fresh-tier2, ce-skilling-ai-copilot"
1213
ms.author: pafarley
1314
---
1415

articles/ai-services/computer-vision/concept-describe-images-40.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ manager: nitinme
99
ms.service: azure-ai-vision
1010
ms.topic: conceptual
1111
ms.date: 09/25/2024
12+
ms.collection: "ce-skilling-fresh-tier2, ce-skilling-ai-copilot"
1213
ms.author: pafarley
1314
---
1415

articles/ai-services/computer-vision/concept-describing-images.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ manager: nitinme
99
ms.service: azure-ai-vision
1010
ms.topic: conceptual
1111
ms.date: 09/25/2024
12+
ms.collection: "ce-skilling-fresh-tier2, ce-skilling-ai-copilot"
1213
ms.author: pafarley
1314
---
1415

articles/ai-services/computer-vision/concept-detecting-adult-content.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ manager: nitinme
99
ms.service: azure-ai-vision
1010
ms.topic: conceptual
1111
ms.date: 01/19/2024
12+
ms.collection: "ce-skilling-fresh-tier2, ce-skilling-ai-copilot"
1213
ms.author: pafarley
1314
---
1415

0 commit comments

Comments
 (0)