You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/ai-services/agents/how-to/tools/openapi-spec.md
+32-4Lines changed: 32 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -27,10 +27,29 @@ automated, and scalable API integrations that enhance the capabilities and effic
27
27
describing HTTP APIs. This allows people to understand how an API works, how a sequence of APIs
28
28
work together, generate client code, create tests, apply design standards, and more. Currently, we support 3 authentication types with the OpenAPI 3.0 specified tools: `anonymous`, `API key`, `managed identity`.
29
29
30
-
## Set up
30
+
## Prerequisites
31
31
1. Ensure you've completed the prerequisites and setup steps in the [quickstart](../../quickstart.md).
32
32
33
-
1.[optional]If your OpenAPI spec requires API key, you can store your API key in a `custom keys` connection and use `connection` authentication
33
+
1. Check the OpenAPI spec for the following requirements:
34
+
1.`operationId` should only contain letters, `-` and `_`. You can modify it to meet the requirement. We recommend using descriptive name to help models efficiently decide which function to use.
35
+
36
+
## Authenticating with API Key
37
+
38
+
1. Verify that the OpenAPI spec supports API keys: it has `securitySchemes` section and has one scheme of type `apiKey". An example would be:
39
+
```json
40
+
"securitySchemes": {
41
+
"apiKeyHeader": {
42
+
"type": "apiKey",
43
+
"name": "x-api-key",
44
+
"in": "header"
45
+
}
46
+
}
47
+
```
48
+
If the security schemes include multiple schemes, we recommend keeping only one of them.
49
+
50
+
1. Remove any parameter in the OpenAPI spec that needs API key, because API key will be stored and passed through a connection, as described later in this article.
51
+
52
+
1. Create a `custom keys` connection to store your API key.
34
53
35
54
1. Go to the [Azure AI Foundry portal](https://ai.azure.com/) and select the AI Project. Click **connected resources**.
36
55
:::image type="content" source="../../media/tools/bing/project-settings-button.png" alt-text="A screenshot of the settings button for an AI project." lightbox="../../media/tools/bing/project-settings-button.png":::
@@ -46,9 +65,18 @@ work together, generate client code, create tests, apply design standards, and m
46
65
:::image type="content" source="../../media/tools/bing/api-key-connection.png" alt-text="A screenshot of the custom keys selection for the AI project." lightbox="../../media/tools/bing/api-key-connection.png":::
47
66
48
67
1. Enter the following information
49
-
-`key`: "key"
68
+
- key: `name` of your security scheme. In this example, it should be `x-api-key`
69
+
```json
70
+
"securitySchemes": {
71
+
"apiKeyHeader": {
72
+
"type": "apiKey",
73
+
"name": "x-api-key",
74
+
"in": "header"
75
+
}
76
+
}
77
+
```
50
78
- value: YOUR_API_KEY
51
-
- Connection name: `YOUR_CONNECTION_NAME` (You will use this connection name in the sample code below.)
79
+
- Connection name: YOUR_CONNECTION_NAME (You will use this connection name in the sample code below.)
52
80
- Access: you can choose either *this project only* or *shared to all projects*. Just make sure in the sample code below, the project you entered connection string for has access to this connection.
@@ -101,7 +102,7 @@ Once the container is on the [host computer](#host-computer-requirements), use t
101
102
102
103
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.
103
104
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.
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.
133
134
134
135
> [!IMPORTANT]
135
136
> 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).
Copy file name to clipboardExpand all lines: articles/ai-services/computer-vision/computer-vision-resource-container-config.md
+21-20Lines changed: 21 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,19 +1,20 @@
1
1
---
2
-
title: Configure Read OCR containers - Azure AI Vision
2
+
title: Configure Read containers - Azure AI Vision
3
3
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.
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.
17
18
18
19
## Configuration settings
19
20
@@ -26,18 +27,18 @@ The container also has the following container-specific configuration settings:
26
27
27
28
|Required|Setting|Purpose|
28
29
|--|--|--|
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. |
|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. |
|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. |
41
42
42
43
## ApiKey configuration setting
43
44
@@ -65,7 +66,7 @@ Remember to add the `vision/<version>` routing to the endpoint URI as shown in t
@@ -87,19 +88,19 @@ Use bind mounts to read and write data to and from the container. You can specif
87
88
88
89
The Azure AI Vision containers don't use input or output mounts to store training or service data.
89
90
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.
91
92
92
93
|Optional| Name | Data type | Description |
93
94
|-------|------|-----------|-------------|
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.|
95
96
|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`|
96
97
97
-
## Example docker run commands
98
+
## Example docker commands
98
99
99
100
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.
100
101
101
102
***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.
0 commit comments